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: |
Rich Lane | da11f8b | 2013-06-19 15:53:25 -0700 | [diff] [blame] | 70 | self.${m.name} = ${py_gen.oftype.gen_init_expr(m.oftype)} |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 71 | :: #endfor |
| 72 | |
| 73 | def pack(self): |
| 74 | packed = [] |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 75 | :: include('_pack.py', ofclass=ofclass) |
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}() |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 82 | :: include('_unpack.py', ofclass=ofclass) |
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 | |
| 125 | :: # TODO fix for OF 1.1+ |
| 126 | def parse_flow_mod(buf): |
| 127 | if len(buf) < 56 + 2: |
| 128 | raise loxi.ProtocolError("message too short") |
| 129 | cmd, = struct.unpack_from("!H", buf, 56) |
| 130 | if cmd in flow_mod_parsers: |
| 131 | return flow_mod_parsers[cmd](buf) |
| 132 | else: |
| 133 | raise loxi.ProtocolError("unexpected flow mod cmd %u" % cmd) |
| 134 | |
Rich Lane | 3f07597 | 2013-03-15 22:56:29 -0700 | [diff] [blame] | 135 | :: if version < of_g.VERSION_1_3: |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 136 | def parse_stats_reply(buf): |
| 137 | if len(buf) < 8 + 2: |
| 138 | raise loxi.ProtocolError("message too short") |
| 139 | stats_type, = struct.unpack_from("!H", buf, 8) |
| 140 | if stats_type in stats_reply_parsers: |
| 141 | return stats_reply_parsers[stats_type](buf) |
| 142 | else: |
| 143 | raise loxi.ProtocolError("unexpected stats type %u" % stats_type) |
| 144 | |
| 145 | def parse_stats_request(buf): |
| 146 | if len(buf) < 8 + 2: |
| 147 | raise loxi.ProtocolError("message too short") |
| 148 | stats_type, = struct.unpack_from("!H", buf, 8) |
| 149 | if stats_type in stats_request_parsers: |
| 150 | return stats_request_parsers[stats_type](buf) |
| 151 | else: |
| 152 | raise loxi.ProtocolError("unexpected stats type %u" % stats_type) |
Rich Lane | 3f07597 | 2013-03-15 22:56:29 -0700 | [diff] [blame] | 153 | :: else: |
| 154 | def parse_multipart_reply(buf): |
| 155 | if len(buf) < 8 + 2: |
| 156 | raise loxi.ProtocolError("message too short") |
| 157 | multipart_type, = struct.unpack_from("!H", buf, 8) |
| 158 | if multipart_type in multipart_reply_parsers: |
| 159 | return multipart_reply_parsers[multipart_type](buf) |
| 160 | else: |
| 161 | raise loxi.ProtocolError("unexpected multipart type %u" % multipart_type) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 162 | |
Rich Lane | 3f07597 | 2013-03-15 22:56:29 -0700 | [diff] [blame] | 163 | def parse_multipart_request(buf): |
| 164 | if len(buf) < 8 + 2: |
| 165 | raise loxi.ProtocolError("message too short") |
| 166 | multipart_type, = struct.unpack_from("!H", buf, 8) |
| 167 | if multipart_type in multipart_request_parsers: |
| 168 | return multipart_request_parsers[multipart_type](buf) |
| 169 | else: |
| 170 | raise loxi.ProtocolError("unexpected multipart type %u" % multipart_type) |
| 171 | :: #endif |
| 172 | |
| 173 | :: if version == of_g.VERSION_1_0: |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 174 | def parse_vendor(buf): |
Rich Lane | 3f07597 | 2013-03-15 22:56:29 -0700 | [diff] [blame] | 175 | :: else: |
| 176 | def parse_experimenter(buf): |
| 177 | :: #endif |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 178 | if len(buf) < 16: |
| 179 | raise loxi.ProtocolError("experimenter message too short") |
| 180 | |
| 181 | experimenter, = struct.unpack_from("!L", buf, 8) |
| 182 | if experimenter == 0x005c16c7: # Big Switch Networks |
| 183 | subtype, = struct.unpack_from("!L", buf, 12) |
| 184 | elif experimenter == 0x00002320: # Nicira |
| 185 | subtype, = struct.unpack_from("!L", buf, 12) |
| 186 | else: |
| 187 | raise loxi.ProtocolError("unexpected experimenter id %#x" % experimenter) |
| 188 | |
| 189 | if subtype in experimenter_parsers[experimenter]: |
| 190 | return experimenter_parsers[experimenter][subtype](buf) |
| 191 | else: |
| 192 | raise loxi.ProtocolError("unexpected experimenter %#x subtype %#x" % (experimenter, subtype)) |
| 193 | |
| 194 | parsers = { |
| 195 | :: sort_key = lambda x: x.type_members[1].value |
| 196 | :: msgtype_groups = itertools.groupby(sorted(ofclasses, key=sort_key), sort_key) |
| 197 | :: for (k, v) in msgtype_groups: |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 198 | :: k = util.constant_for_value(version, "ofp_type", k) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 199 | :: v = list(v) |
| 200 | :: if len(v) == 1: |
| 201 | ${k} : ${v[0].pyname}.unpack, |
| 202 | :: else: |
| 203 | ${k} : parse_${k[11:].lower()}, |
| 204 | :: #endif |
| 205 | :: #endfor |
| 206 | } |
| 207 | |
| 208 | flow_mod_parsers = { |
| 209 | const.OFPFC_ADD : flow_add.unpack, |
| 210 | const.OFPFC_MODIFY : flow_modify.unpack, |
| 211 | const.OFPFC_MODIFY_STRICT : flow_modify_strict.unpack, |
| 212 | const.OFPFC_DELETE : flow_delete.unpack, |
| 213 | const.OFPFC_DELETE_STRICT : flow_delete_strict.unpack, |
| 214 | } |
| 215 | |
Rich Lane | 3f07597 | 2013-03-15 22:56:29 -0700 | [diff] [blame] | 216 | :: if version < of_g.VERSION_1_3: |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 217 | stats_reply_parsers = { |
| 218 | const.OFPST_DESC : desc_stats_reply.unpack, |
| 219 | const.OFPST_FLOW : flow_stats_reply.unpack, |
| 220 | const.OFPST_AGGREGATE : aggregate_stats_reply.unpack, |
| 221 | const.OFPST_TABLE : table_stats_reply.unpack, |
| 222 | const.OFPST_PORT : port_stats_reply.unpack, |
| 223 | const.OFPST_QUEUE : queue_stats_reply.unpack, |
Rich Lane | a22233e | 2013-04-25 13:18:41 -0700 | [diff] [blame] | 224 | :: if version < of_g.VERSION_1_1: |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 225 | const.OFPST_VENDOR : experimenter_stats_reply.unpack, |
Rich Lane | a22233e | 2013-04-25 13:18:41 -0700 | [diff] [blame] | 226 | :: else: |
| 227 | const.OFPST_EXPERIMENTER : experimenter_stats_reply.unpack, |
| 228 | :: #endif |
Rich Lane | 5edb555 | 2013-05-07 18:49:29 -0700 | [diff] [blame] | 229 | :: if version >= of_g.VERSION_1_1: |
| 230 | const.OFPST_GROUP : group_stats_reply.unpack, |
| 231 | const.OFPST_GROUP_DESC : group_desc_stats_reply.unpack, |
| 232 | :: #endif |
| 233 | :: if version >= of_g.VERSION_1_2: |
| 234 | const.OFPST_GROUP_FEATURES : group_features_stats_reply.unpack, |
| 235 | :: #endif |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 236 | } |
| 237 | |
| 238 | stats_request_parsers = { |
| 239 | const.OFPST_DESC : desc_stats_request.unpack, |
| 240 | const.OFPST_FLOW : flow_stats_request.unpack, |
| 241 | const.OFPST_AGGREGATE : aggregate_stats_request.unpack, |
| 242 | const.OFPST_TABLE : table_stats_request.unpack, |
| 243 | const.OFPST_PORT : port_stats_request.unpack, |
| 244 | const.OFPST_QUEUE : queue_stats_request.unpack, |
Rich Lane | a22233e | 2013-04-25 13:18:41 -0700 | [diff] [blame] | 245 | :: if version < of_g.VERSION_1_1: |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 246 | const.OFPST_VENDOR : experimenter_stats_request.unpack, |
Rich Lane | a22233e | 2013-04-25 13:18:41 -0700 | [diff] [blame] | 247 | :: else: |
| 248 | const.OFPST_EXPERIMENTER : experimenter_stats_request.unpack, |
| 249 | :: #endif |
Rich Lane | 5edb555 | 2013-05-07 18:49:29 -0700 | [diff] [blame] | 250 | :: if version >= of_g.VERSION_1_1: |
| 251 | const.OFPST_GROUP : group_stats_request.unpack, |
| 252 | const.OFPST_GROUP_DESC : group_desc_stats_request.unpack, |
| 253 | :: #endif |
| 254 | :: if version >= of_g.VERSION_1_2: |
| 255 | const.OFPST_GROUP_FEATURES : group_features_stats_request.unpack, |
| 256 | :: #endif |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 257 | } |
Rich Lane | 3f07597 | 2013-03-15 22:56:29 -0700 | [diff] [blame] | 258 | :: else: |
Rich Lane | 5edb555 | 2013-05-07 18:49:29 -0700 | [diff] [blame] | 259 | # TODO OF 1.3 multipart messages |
Rich Lane | 3f07597 | 2013-03-15 22:56:29 -0700 | [diff] [blame] | 260 | :: #endif |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 261 | |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 262 | :: 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] | 263 | :: sort_key = lambda x: x.type_members[2].value |
| 264 | :: experimenter_ofclasses.sort(key=sort_key) |
| 265 | :: grouped = itertools.groupby(experimenter_ofclasses, sort_key) |
| 266 | experimenter_parsers = { |
| 267 | :: for (experimenter, v) in grouped: |
| 268 | ${experimenter} : { |
| 269 | :: for ofclass in v: |
| 270 | ${ofclass.type_members[3].value}: ${ofclass.pyname}.unpack, |
| 271 | :: #endfor |
| 272 | }, |
| 273 | :: #endfor |
| 274 | } |