Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 1 | :: # Copyright 2013, Big Switch Networks, Inc. |
| 2 | :: # |
| 3 | :: # LoxiGen is licensed under the Eclipse Public License, version 1.0 (EPL), with |
| 4 | :: # the following special exception: |
| 5 | :: # |
| 6 | :: # LOXI Exception |
| 7 | :: # |
| 8 | :: # As a special exception to the terms of the EPL, you may distribute libraries |
| 9 | :: # generated by LoxiGen (LoxiGen Libraries) under the terms of your choice, provided |
| 10 | :: # that copyright and licensing notices generated by LoxiGen are not altered or removed |
| 11 | :: # from the LoxiGen Libraries and the notice provided below is (i) included in |
| 12 | :: # the LoxiGen Libraries, if distributed in source code form and (ii) included in any |
| 13 | :: # documentation for the LoxiGen Libraries, if distributed in binary form. |
| 14 | :: # |
| 15 | :: # Notice: "Copyright 2013, Big Switch Networks, Inc. This library was generated by the LoxiGen Compiler." |
| 16 | :: # |
| 17 | :: # You may not use this file except in compliance with the EPL or LOXI Exception. You may obtain |
| 18 | :: # a copy of the EPL at: |
| 19 | :: # |
| 20 | :: # http::: #www.eclipse.org/legal/epl-v10.html |
| 21 | :: # |
| 22 | :: # Unless required by applicable law or agreed to in writing, software |
| 23 | :: # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 24 | :: # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 25 | :: # EPL for the specific language governing permissions and limitations |
| 26 | :: # under the EPL. |
| 27 | :: |
| 28 | :: import itertools |
Rich Lane | 3f07597 | 2013-03-15 22:56:29 -0700 | [diff] [blame] | 29 | :: import of_g |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 30 | :: import py_gen.util as util |
Rich Lane | da11f8b | 2013-06-19 15:53:25 -0700 | [diff] [blame] | 31 | :: import py_gen.oftype |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 32 | :: include('_copyright.py') |
| 33 | |
| 34 | :: include('_autogen.py') |
| 35 | |
| 36 | import struct |
| 37 | import loxi |
| 38 | import const |
| 39 | import common |
| 40 | import action # for unpack_list |
Rich Lane | ed4f906 | 2013-05-02 17:05:03 -0700 | [diff] [blame] | 41 | :: if version >= 2: |
| 42 | import instruction # for unpack_list |
| 43 | :: #endif |
Rich Lane | d82c0a6 | 2013-05-02 15:40:35 -0700 | [diff] [blame] | 44 | :: if version >= 4: |
| 45 | import meter_band # for unpack_list |
| 46 | :: #endif |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 47 | import util |
Rich Lane | 15cbe84 | 2013-04-26 16:04:11 -0700 | [diff] [blame] | 48 | import loxi.generic_util |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 49 | |
| 50 | class Message(object): |
| 51 | version = const.OFP_VERSION |
| 52 | type = None # override in subclass |
| 53 | xid = None |
| 54 | |
| 55 | :: for ofclass in ofclasses: |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 56 | :: from loxi_ir import * |
| 57 | :: normal_members = [m for m in ofclass.members if type(m) == OFDataMember] |
| 58 | :: type_members = [m for m in ofclass.members if type(m) == OFTypeMember] |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 59 | class ${ofclass.pyname}(Message): |
Rich Lane | 8ca3b77 | 2013-04-30 13:36:55 -0700 | [diff] [blame] | 60 | :: for m in type_members: |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 61 | ${m.name} = ${m.value} |
| 62 | :: #endfor |
| 63 | |
Rich Lane | 8ca3b77 | 2013-04-30 13:36:55 -0700 | [diff] [blame] | 64 | def __init__(self, ${', '.join(["%s=None" % m.name for m in normal_members])}): |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 65 | self.xid = xid |
Rich Lane | 8ca3b77 | 2013-04-30 13:36:55 -0700 | [diff] [blame] | 66 | :: for m in [x for x in normal_members if x.name != 'xid']: |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 67 | if ${m.name} != None: |
| 68 | self.${m.name} = ${m.name} |
| 69 | else: |
Andreas Wundsam | 69ecfdc | 2013-09-17 13:50:12 -0700 | [diff] [blame] | 70 | self.${m.name} = ${py_gen.oftype.gen_init_expr(m.oftype, version=version)} |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 71 | :: #endfor |
| 72 | |
| 73 | def pack(self): |
| 74 | packed = [] |
Andreas Wundsam | 69ecfdc | 2013-09-17 13:50:12 -0700 | [diff] [blame] | 75 | :: include('_pack.py', ofclass=ofclass, version=version) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 76 | return ''.join(packed) |
| 77 | |
| 78 | @staticmethod |
| 79 | def unpack(buf): |
| 80 | if len(buf) < 8: raise loxi.ProtocolError("buffer too short to contain an OpenFlow message") |
| 81 | obj = ${ofclass.pyname}() |
Andreas Wundsam | 69ecfdc | 2013-09-17 13:50:12 -0700 | [diff] [blame] | 82 | :: include('_unpack.py', ofclass=ofclass, version=version) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 83 | return obj |
| 84 | |
| 85 | def __eq__(self, other): |
| 86 | if type(self) != type(other): return False |
| 87 | if self.version != other.version: return False |
| 88 | if self.type != other.type: return False |
Rich Lane | 8ca3b77 | 2013-04-30 13:36:55 -0700 | [diff] [blame] | 89 | :: for m in normal_members: |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 90 | if self.${m.name} != other.${m.name}: return False |
| 91 | :: #endfor |
| 92 | return True |
| 93 | |
| 94 | def __ne__(self, other): |
| 95 | return not self.__eq__(other) |
| 96 | |
| 97 | def __str__(self): |
| 98 | return self.show() |
| 99 | |
| 100 | def show(self): |
| 101 | import loxi.pp |
| 102 | return loxi.pp.pp(self) |
| 103 | |
| 104 | def pretty_print(self, q): |
| 105 | :: include('_pretty_print.py', ofclass=ofclass) |
| 106 | |
| 107 | :: #endfor |
| 108 | |
| 109 | def parse_header(buf): |
| 110 | if len(buf) < 8: |
| 111 | raise loxi.ProtocolError("too short to be an OpenFlow message") |
| 112 | return struct.unpack_from("!BBHL", buf) |
| 113 | |
| 114 | def parse_message(buf): |
| 115 | msg_ver, msg_type, msg_len, msg_xid = parse_header(buf) |
Rich Lane | 1c5db11 | 2013-06-14 00:00:54 -0700 | [diff] [blame] | 116 | if msg_ver != const.OFP_VERSION and msg_type != const.OFPT_HELLO: |
| 117 | raise loxi.ProtocolError("wrong OpenFlow version (expected %d, got %d)" % (const.OFP_VERSION, msg_ver)) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 118 | if len(buf) != msg_len: |
| 119 | raise loxi.ProtocolError("incorrect message size") |
| 120 | if msg_type in parsers: |
| 121 | return parsers[msg_type](buf) |
| 122 | else: |
| 123 | raise loxi.ProtocolError("unexpected message type") |
| 124 | |
Rob Vaterlaus | feee371 | 2013-09-30 11:24:19 -0700 | [diff] [blame] | 125 | def parse_error(buf): |
| 126 | if len(buf) < 8 + 2: |
| 127 | raise loxi.ProtocolError("message too short") |
| 128 | err_type, = struct.unpack_from("!H", buf, 8) |
| 129 | if err_type in error_msg_parsers: |
| 130 | return error_msg_parsers[err_type](buf) |
| 131 | else: |
Rob Vaterlaus | b5e8c83 | 2013-10-04 12:50:23 -0700 | [diff] [blame^] | 132 | raise loxi.ProtocolError("unexpected error type %u" % err_type) |
Rob Vaterlaus | feee371 | 2013-09-30 11:24:19 -0700 | [diff] [blame] | 133 | |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 134 | def parse_flow_mod(buf): |
Rich Lane | efa5400 | 2013-06-14 07:26:27 -0700 | [diff] [blame] | 135 | :: if version == 1: |
| 136 | :: offset = 57 |
| 137 | :: elif version >= 2: |
| 138 | :: offset = 25 |
| 139 | :: #endif |
| 140 | if len(buf) < ${offset} + 1: |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 141 | raise loxi.ProtocolError("message too short") |
Rich Lane | efa5400 | 2013-06-14 07:26:27 -0700 | [diff] [blame] | 142 | # Technically uint16_t for OF 1.0 |
| 143 | cmd, = struct.unpack_from("!B", buf, ${offset}) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 144 | if cmd in flow_mod_parsers: |
| 145 | return flow_mod_parsers[cmd](buf) |
| 146 | else: |
| 147 | raise loxi.ProtocolError("unexpected flow mod cmd %u" % cmd) |
| 148 | |
| 149 | def parse_stats_reply(buf): |
| 150 | if len(buf) < 8 + 2: |
| 151 | raise loxi.ProtocolError("message too short") |
| 152 | stats_type, = struct.unpack_from("!H", buf, 8) |
| 153 | if stats_type in stats_reply_parsers: |
| 154 | return stats_reply_parsers[stats_type](buf) |
| 155 | else: |
| 156 | raise loxi.ProtocolError("unexpected stats type %u" % stats_type) |
| 157 | |
| 158 | def parse_stats_request(buf): |
| 159 | if len(buf) < 8 + 2: |
| 160 | raise loxi.ProtocolError("message too short") |
| 161 | stats_type, = struct.unpack_from("!H", buf, 8) |
| 162 | if stats_type in stats_request_parsers: |
| 163 | return stats_request_parsers[stats_type](buf) |
| 164 | else: |
| 165 | raise loxi.ProtocolError("unexpected stats type %u" % stats_type) |
| 166 | |
Rich Lane | 3f07597 | 2013-03-15 22:56:29 -0700 | [diff] [blame] | 167 | def parse_experimenter(buf): |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 168 | if len(buf) < 16: |
| 169 | raise loxi.ProtocolError("experimenter message too short") |
| 170 | |
| 171 | experimenter, = struct.unpack_from("!L", buf, 8) |
| 172 | if experimenter == 0x005c16c7: # Big Switch Networks |
| 173 | subtype, = struct.unpack_from("!L", buf, 12) |
| 174 | elif experimenter == 0x00002320: # Nicira |
| 175 | subtype, = struct.unpack_from("!L", buf, 12) |
| 176 | else: |
| 177 | raise loxi.ProtocolError("unexpected experimenter id %#x" % experimenter) |
| 178 | |
| 179 | if subtype in experimenter_parsers[experimenter]: |
| 180 | return experimenter_parsers[experimenter][subtype](buf) |
| 181 | else: |
| 182 | raise loxi.ProtocolError("unexpected experimenter %#x subtype %#x" % (experimenter, subtype)) |
| 183 | |
| 184 | parsers = { |
| 185 | :: sort_key = lambda x: x.type_members[1].value |
| 186 | :: msgtype_groups = itertools.groupby(sorted(ofclasses, key=sort_key), sort_key) |
| 187 | :: for (k, v) in msgtype_groups: |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 188 | :: k = util.constant_for_value(version, "ofp_type", k) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 189 | :: v = list(v) |
| 190 | :: if len(v) == 1: |
| 191 | ${k} : ${v[0].pyname}.unpack, |
| 192 | :: else: |
| 193 | ${k} : parse_${k[11:].lower()}, |
| 194 | :: #endif |
| 195 | :: #endfor |
| 196 | } |
| 197 | |
Rob Vaterlaus | feee371 | 2013-09-30 11:24:19 -0700 | [diff] [blame] | 198 | error_msg_parsers = { |
| 199 | const.OFPET_HELLO_FAILED : hello_failed_error_msg.unpack, |
| 200 | const.OFPET_BAD_REQUEST : bad_request_error_msg.unpack, |
| 201 | const.OFPET_BAD_ACTION : bad_action_error_msg.unpack, |
| 202 | const.OFPET_FLOW_MOD_FAILED : flow_mod_failed_error_msg.unpack, |
| 203 | const.OFPET_PORT_MOD_FAILED : port_mod_failed_error_msg.unpack, |
| 204 | const.OFPET_QUEUE_OP_FAILED : queue_op_failed_error_msg.unpack, |
| 205 | :: if version >= of_g.VERSION_1_1: |
| 206 | const.OFPET_BAD_INSTRUCTION : bad_instruction_error_msg.unpack, |
| 207 | const.OFPET_BAD_MATCH : bad_match_error_msg.unpack, |
| 208 | const.OFPET_GROUP_MOD_FAILED : group_mod_failed_error_msg.unpack, |
| 209 | const.OFPET_TABLE_MOD_FAILED : table_mod_failed_error_msg.unpack, |
| 210 | const.OFPET_SWITCH_CONFIG_FAILED : switch_config_failed_error_msg.unpack, |
| 211 | :: #endif |
| 212 | :: if version >= of_g.VERSION_1_2: |
| 213 | const.OFPET_ROLE_REQUEST_FAILED : role_request_failed_error_msg.unpack, |
| 214 | const.OFPET_EXPERIMENTER : experimenter_error_msg.unpack, |
| 215 | :: #endif |
| 216 | :: if version >= of_g.VERSION_1_3: |
| 217 | const.OFPET_METER_MOD_FAILED : meter_mod_failed_error_msg.unpack, |
| 218 | const.OFPET_TABLE_FEATURES_FAILED : table_features_failed_error_msg.unpack, |
| 219 | :: #endif |
| 220 | } |
| 221 | |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 222 | flow_mod_parsers = { |
| 223 | const.OFPFC_ADD : flow_add.unpack, |
| 224 | const.OFPFC_MODIFY : flow_modify.unpack, |
| 225 | const.OFPFC_MODIFY_STRICT : flow_modify_strict.unpack, |
| 226 | const.OFPFC_DELETE : flow_delete.unpack, |
| 227 | const.OFPFC_DELETE_STRICT : flow_delete_strict.unpack, |
| 228 | } |
| 229 | |
| 230 | stats_reply_parsers = { |
| 231 | const.OFPST_DESC : desc_stats_reply.unpack, |
| 232 | const.OFPST_FLOW : flow_stats_reply.unpack, |
| 233 | const.OFPST_AGGREGATE : aggregate_stats_reply.unpack, |
| 234 | const.OFPST_TABLE : table_stats_reply.unpack, |
| 235 | const.OFPST_PORT : port_stats_reply.unpack, |
| 236 | const.OFPST_QUEUE : queue_stats_reply.unpack, |
Rich Lane | 5edb555 | 2013-05-07 18:49:29 -0700 | [diff] [blame] | 237 | :: if version >= of_g.VERSION_1_1: |
| 238 | const.OFPST_GROUP : group_stats_reply.unpack, |
| 239 | const.OFPST_GROUP_DESC : group_desc_stats_reply.unpack, |
| 240 | :: #endif |
| 241 | :: if version >= of_g.VERSION_1_2: |
| 242 | const.OFPST_GROUP_FEATURES : group_features_stats_reply.unpack, |
| 243 | :: #endif |
Rob Vaterlaus | feee371 | 2013-09-30 11:24:19 -0700 | [diff] [blame] | 244 | :: if version >= of_g.VERSION_1_3: |
| 245 | const.OFPST_METER : meter_stats_reply.unpack, |
| 246 | const.OFPST_METER_CONFIG : meter_config_stats_reply.unpack, |
| 247 | const.OFPST_METER_FEATURES : meter_features_stats_reply.unpack, |
| 248 | const.OFPST_TABLE_FEATURES : table_features_stats_reply.unpack, |
| 249 | const.OFPST_PORT_DESC : port_desc_stats_reply.unpack, |
| 250 | :: #endif |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 251 | } |
| 252 | |
| 253 | stats_request_parsers = { |
| 254 | const.OFPST_DESC : desc_stats_request.unpack, |
| 255 | const.OFPST_FLOW : flow_stats_request.unpack, |
| 256 | const.OFPST_AGGREGATE : aggregate_stats_request.unpack, |
| 257 | const.OFPST_TABLE : table_stats_request.unpack, |
| 258 | const.OFPST_PORT : port_stats_request.unpack, |
| 259 | const.OFPST_QUEUE : queue_stats_request.unpack, |
Rich Lane | 5edb555 | 2013-05-07 18:49:29 -0700 | [diff] [blame] | 260 | :: if version >= of_g.VERSION_1_1: |
| 261 | const.OFPST_GROUP : group_stats_request.unpack, |
| 262 | const.OFPST_GROUP_DESC : group_desc_stats_request.unpack, |
| 263 | :: #endif |
| 264 | :: if version >= of_g.VERSION_1_2: |
| 265 | const.OFPST_GROUP_FEATURES : group_features_stats_request.unpack, |
| 266 | :: #endif |
Rob Vaterlaus | feee371 | 2013-09-30 11:24:19 -0700 | [diff] [blame] | 267 | :: if version >= of_g.VERSION_1_3: |
| 268 | const.OFPST_METER : meter_stats_request.unpack, |
| 269 | const.OFPST_METER_CONFIG : meter_config_stats_request.unpack, |
| 270 | const.OFPST_METER_FEATURES : meter_features_stats_request.unpack, |
| 271 | const.OFPST_TABLE_FEATURES : table_features_stats_request.unpack, |
| 272 | const.OFPST_PORT_DESC : port_desc_stats_request.unpack, |
Rich Lane | 3f07597 | 2013-03-15 22:56:29 -0700 | [diff] [blame] | 273 | :: #endif |
Rob Vaterlaus | feee371 | 2013-09-30 11:24:19 -0700 | [diff] [blame] | 274 | } |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 275 | |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 276 | :: experimenter_ofclasses = [x for x in ofclasses if x.type_members[1].value == 4] |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 277 | :: sort_key = lambda x: x.type_members[2].value |
| 278 | :: experimenter_ofclasses.sort(key=sort_key) |
| 279 | :: grouped = itertools.groupby(experimenter_ofclasses, sort_key) |
| 280 | experimenter_parsers = { |
| 281 | :: for (experimenter, v) in grouped: |
| 282 | ${experimenter} : { |
| 283 | :: for ofclass in v: |
| 284 | ${ofclass.type_members[3].value}: ${ofclass.pyname}.unpack, |
| 285 | :: #endfor |
| 286 | }, |
| 287 | :: #endfor |
| 288 | } |