Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -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 | |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 28 | # Prototype of an Intermediate Object model for the java code generator |
| 29 | # A lot of this stuff could/should probably be merged with the python utilities |
| 30 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 31 | import collections |
| 32 | from collections import namedtuple, defaultdict |
| 33 | import logging |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 34 | import os |
| 35 | import pdb |
| 36 | import re |
| 37 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 38 | from generic_utils import find, memoize, OrderedSet |
| 39 | import of_g |
| 40 | from loxi_ir import * |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 41 | import loxi_front_end.type_maps as type_maps |
| 42 | import loxi_utils.loxi_utils as utils |
| 43 | import py_gen.util as py_utils |
| 44 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 45 | import java_gen.java_type as java_type |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 46 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 47 | class JavaModel(object): |
| 48 | write_blacklist = defaultdict(lambda: set(), OFOxm=set(('typeLen',))) |
| 49 | virtual_interfaces = set(['OFOxm' ]) |
| 50 | |
| 51 | @property |
| 52 | @memoize |
| 53 | def versions(self): |
| 54 | return OrderedSet( JavaOFVersion(raw_version) for raw_version in of_g.target_version_list ) |
| 55 | |
| 56 | @property |
| 57 | @memoize |
| 58 | def interfaces(self): |
| 59 | version_map_per_class = collections.defaultdict(lambda: {}) |
| 60 | |
| 61 | for raw_version, of_protocol in of_g.ir.items(): |
| 62 | jversion = JavaOFVersion(of_protocol.wire_version) |
| 63 | |
| 64 | for of_class in of_protocol.classes: |
| 65 | version_map_per_class[of_class.name][jversion] = of_class |
| 66 | |
| 67 | interfaces = [] |
| 68 | for class_name, version_map in version_map_per_class.items(): |
| 69 | interfaces.append(JavaOFInterface(class_name, version_map)) |
| 70 | |
| 71 | return interfaces |
| 72 | |
| 73 | @property |
| 74 | @memoize |
| 75 | def enums(self): |
| 76 | enum_entry_version_value_map = collections.defaultdict(lambda: collections.defaultdict(lambda: collections.OrderedDict())) |
| 77 | |
| 78 | for version in self.versions: |
| 79 | of_protocol = of_g.ir[version.int_version] |
| 80 | for enum in of_protocol.enums: |
| 81 | for entry_name, entry_value in enum.values: |
| 82 | enum_entry_version_value_map[enum.name][entry_name][version] = entry_value |
| 83 | |
| 84 | enums = [ JavaEnum(name, entry_version_value_map) for name, entry_version_value_map |
| 85 | in enum_entry_version_value_map.items() ] |
| 86 | |
| 87 | return enums |
| 88 | |
| 89 | @memoize |
| 90 | def enum_by_name(self, name): |
| 91 | try: |
| 92 | return find(self.enums, lambda e: e.name == name) |
| 93 | except KeyError: |
| 94 | raise KeyError("Could not find enum with name %s" % name) |
| 95 | |
| 96 | model = JavaModel() |
| 97 | |
| 98 | ####################################################################### |
| 99 | ### OFVersion |
| 100 | ####################################################################### |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 101 | |
| 102 | class JavaOFVersion(object): |
| 103 | """ Models a version of OpenFlow. contains methods to convert the internal |
| 104 | Loxi version to a java constant / a string """ |
| 105 | def __init__(self, int_version): |
| 106 | self.int_version = int(int_version) |
| 107 | |
| 108 | @property |
| 109 | def of_version(self): |
| 110 | return "1" + str(int(self.int_version) - 1) |
| 111 | |
| 112 | @property |
| 113 | def constant_version(self): |
| 114 | return "OF_" + self.of_version |
| 115 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 116 | def __repr__(self): |
| 117 | return "JavaOFVersion(%d)" % self.int_version |
| 118 | |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 119 | def __str__(self): |
| 120 | return of_g.param_version_names[self.int_version] |
| 121 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 122 | def __hash__(self): |
| 123 | return hash(self.int_version) |
| 124 | |
| 125 | def __eq__(self, other): |
| 126 | if other is None or type(self) != type(other): |
| 127 | return False |
| 128 | return (self.int_version,) == (other.int_version,) |
| 129 | |
| 130 | ####################################################################### |
| 131 | ### Interface |
| 132 | ####################################################################### |
| 133 | |
| 134 | class JavaOFInterface(object): |
| 135 | """ Models an OpenFlow Message class for the purpose of the java class. |
| 136 | Version agnostic, in contrast to the loxi_ir python model. |
| 137 | """ |
| 138 | def __init__(self, c_name, version_map): |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 139 | self.c_name = c_name |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 140 | self.version_map = version_map |
| 141 | self.name = java_type.name_c_to_caps_camel(c_name) |
| 142 | self.builder_name = self.name + "Builder" |
| 143 | self.constant_name = c_name.upper().replace("OF_", "") |
| 144 | |
| 145 | pck_suffix, parent_interface = self.class_info() |
| 146 | self.package = "org.openflow.protocol.%s" % pck_suffix if pck_suffix else "org.openflow.protocol" |
| 147 | if self.name != parent_interface: |
| 148 | self.parent_interface = parent_interface |
| 149 | else: |
| 150 | self.parent_interface = None |
| 151 | |
| 152 | def class_info(self): |
Yotam Harchol | 161a5d5 | 2013-07-25 17:17:48 -0700 | [diff] [blame] | 153 | if re.match(r'OFFlow(Add|Modify(Strict)?|Delete(Strict)?)$', self.name): |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 154 | return ("", "OFFlowMod") |
| 155 | elif utils.class_is_message(self.c_name): |
| 156 | return ("", "OFMessage") |
| 157 | elif utils.class_is_action(self.c_name): |
| 158 | return ("action", "OFAction") |
| 159 | elif utils.class_is_oxm(self.c_name): |
| 160 | return ("oxm", "OFOxm") |
| 161 | elif utils.class_is_instruction(self.c_name): |
| 162 | return ("instruction", "OFInstruction") |
| 163 | elif utils.class_is_meter_band(self.c_name): |
| 164 | return ("meterband", "OFMeterBand") |
| 165 | else: |
| 166 | return ("", None) |
| 167 | |
| 168 | @property |
| 169 | @memoize |
| 170 | def members(self): |
| 171 | all_versions = [] |
| 172 | member_map = collections.OrderedDict() |
| 173 | |
| 174 | for (version, of_class) in self.version_map.items(): |
| 175 | for of_member in of_class.members: |
| 176 | if isinstance(of_member, OFLengthMember) or \ |
| 177 | isinstance(of_member, OFFieldLengthMember) or \ |
| 178 | isinstance(of_member, OFPadMember): |
| 179 | continue |
| 180 | if of_member.name not in member_map: |
| 181 | member_map[of_member.name] = JavaMember.for_of_member(self, of_member) |
| 182 | |
| 183 | return member_map.values() |
| 184 | |
| 185 | @property |
| 186 | @memoize |
| 187 | def is_virtual(self): |
| 188 | return self.name in model.virtual_interfaces |
| 189 | |
| 190 | @property |
| 191 | @memoize |
| 192 | def all_versions(self): |
| 193 | return self.version_map.keys() |
| 194 | |
| 195 | def versioned_class(self, version): |
| 196 | return JavaOFClass(self, version, self.version_map[version]) |
| 197 | |
| 198 | @property |
| 199 | @memoize |
| 200 | def versioned_classes(self): |
| 201 | if self.is_virtual: |
| 202 | return [] |
| 203 | else: |
| 204 | return [ self.versioned_class(version) for version in self.all_versions ] |
| 205 | |
| 206 | ####################################################################### |
| 207 | ### (Versioned) Classes |
| 208 | ####################################################################### |
| 209 | |
| 210 | class JavaOFClass(object): |
| 211 | """ Models an OpenFlow Message class for the purpose of the java class. |
Andreas Wundsam | d40ddbf | 2013-07-25 15:40:47 -0700 | [diff] [blame] | 212 | Version specific child of a JavaOFInterface |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 213 | """ |
| 214 | def __init__(self, interface, version, ir_class): |
| 215 | self.interface = interface |
| 216 | self.ir_class = ir_class |
| 217 | self.c_name = self.ir_class.name |
| 218 | self.version = version |
| 219 | self.constant_name = self.c_name.upper().replace("OF_", "") |
| 220 | self.package = "org.openflow.protocol.ver%s" % version.of_version |
Andreas Wundsam | e916d6f | 2013-07-30 11:33:58 -0700 | [diff] [blame] | 221 | self.generated = False |
| 222 | |
| 223 | @property |
| 224 | @memoize |
| 225 | def unit_test(self): |
| 226 | return JavaUnitTest(self) |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 227 | |
| 228 | @property |
| 229 | def name(self): |
| 230 | return "%sVer%s" % (self.interface.name, self.version.of_version) |
| 231 | |
| 232 | @property |
| 233 | def length(self): |
| 234 | if self.is_fixed_length: |
| 235 | return self.min_length |
| 236 | else: |
| 237 | raise Exception("No fixed length for class %s, version %s" % (self.name, self.version)) |
| 238 | |
| 239 | @property |
| 240 | def min_length(self): |
| 241 | id_tuple = (self.ir_class.name, self.version.int_version) |
| 242 | return of_g.base_length[id_tuple] if id_tuple in of_g.base_length else -1 |
| 243 | |
| 244 | @property |
| 245 | def is_fixed_length(self): |
| 246 | return (self.ir_class.name, self.version.int_version) in of_g.is_fixed_length |
| 247 | |
| 248 | def all_properties(self): |
| 249 | return self.interface.members |
| 250 | |
| 251 | def get_member(self, name): |
| 252 | for m in self.members: |
| 253 | if m.name == name: |
| 254 | return m |
| 255 | |
| 256 | @property |
| 257 | @memoize |
| 258 | def data_members(self): |
| 259 | return [ prop for prop in self.members if prop.is_data ] |
| 260 | |
| 261 | @property |
| 262 | @memoize |
| 263 | def fixed_value_members(self): |
| 264 | return [ prop for prop in self.members if prop.is_fixed_value ] |
| 265 | |
| 266 | @property |
| 267 | @memoize |
| 268 | def public_members(self): |
| 269 | return [ prop for prop in self.members if prop.is_public ] |
| 270 | |
| 271 | @property |
| 272 | @memoize |
| 273 | def members(self): |
| 274 | members = [ JavaMember.for_of_member(self, of_member) for of_member in self.ir_class.members ] |
| 275 | return members |
| 276 | |
| 277 | def all_versions(self): |
| 278 | return [ JavaOFVersion(int_version) |
| 279 | for int_version in of_g.unified[self.c_name] |
| 280 | if int_version != 'union' and int_version != 'object_id' ] |
| 281 | |
| 282 | def version_is_inherited(self, version): |
| 283 | return 'use_version' in of_g.unified[self.ir_class.name][version.int_version] |
| 284 | |
| 285 | def inherited_from(self, version): |
| 286 | return JavaOFVersion(of_g.unified[self.ir_class.name][version.int_version]['use_version']) |
| 287 | |
| 288 | @property |
| 289 | def is_virtual(self): |
| 290 | return type_maps.class_is_virtual(self.c_name) |
| 291 | |
| 292 | @property |
| 293 | def is_extension(self): |
| 294 | return type_maps.message_is_extension(self.c_name, -1) |
| 295 | |
| 296 | ####################################################################### |
| 297 | ### Member |
| 298 | ####################################################################### |
| 299 | |
| 300 | |
| 301 | class JavaMember(object): |
| 302 | """ Models a property (member) of an openflow class. """ |
| 303 | def __init__(self, msg, name, java_type, member): |
| 304 | self.msg = msg |
| 305 | self.name = name |
| 306 | self.java_type = java_type |
| 307 | self.member = member |
| 308 | self.c_name = self.member.name if(hasattr(self.member, "name")) else "" |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 309 | |
| 310 | @property |
| 311 | def title_name(self): |
| 312 | return self.name[0].upper() + self.name[1:] |
| 313 | |
| 314 | @property |
| 315 | def constant_name(self): |
| 316 | return self.c_name.upper() |
| 317 | |
| 318 | @property |
| 319 | def default_name(self): |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 320 | if self.is_fixed_value: |
| 321 | return self.constant_name |
| 322 | else: |
| 323 | return "DEFAULT_"+self.constant_name |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 324 | |
| 325 | @property |
| 326 | def default_value(self): |
| 327 | java_type = self.java_type.public_type; |
| 328 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 329 | if self.is_fixed_value: |
| 330 | return self.enum_value |
| 331 | elif re.match(r'List.*', java_type): |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 332 | return "Collections.emptyList()" |
| 333 | elif java_type == "boolean": |
| 334 | return "false"; |
| 335 | elif java_type in ("byte", "char", "short", "int", "long"): |
| 336 | return "({0}) 0".format(java_type); |
| 337 | else: |
| 338 | return "null"; |
| 339 | |
| 340 | @property |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 341 | def enum_value(self): |
| 342 | if self.name == "version": |
| 343 | return "OFVersion.%s" % self.msg.version.constant_version |
| 344 | |
| 345 | java_type = self.java_type.public_type; |
| 346 | try: |
| 347 | global model |
| 348 | enum = model.enum_by_name(java_type) |
| 349 | entry = enum.entry_by_version_value(self.msg.version, self.value) |
| 350 | return "%s.%s" % ( enum.name, entry.name) |
| 351 | except KeyError, e: |
| 352 | print e.message |
| 353 | return self.value |
| 354 | |
| 355 | @property |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 356 | def is_pad(self): |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 357 | return isinstance(self.member, OFPadMember) |
| 358 | |
| 359 | def is_type_value(self, version=None): |
| 360 | if(version==None): |
| 361 | return any(self.is_type_value(version) for version in self.msg.all_versions) |
| 362 | try: |
| 363 | return self.c_name in get_type_values(self.msg.c_name, version.int_version) |
| 364 | except: |
| 365 | return False |
| 366 | |
| 367 | @property |
| 368 | def is_field_length_value(self): |
| 369 | return isinstance(self.member, OFFieldLengthMember) |
| 370 | |
| 371 | @property |
| 372 | def is_length_value(self): |
| 373 | return isinstance(self.member, OFLengthMember) |
| 374 | |
| 375 | @property |
| 376 | def is_public(self): |
| 377 | return not (self.is_pad or self.is_length_value) |
| 378 | |
| 379 | @property |
| 380 | def is_data(self): |
| 381 | return isinstance(self.member, OFDataMember) and self.name != "version" |
| 382 | |
| 383 | @property |
| 384 | def is_fixed_value(self): |
| 385 | return hasattr(self.member, "value") or self.name == "version" \ |
| 386 | or ( self.name == "length" and self.msg.is_fixed_length) \ |
| 387 | or ( self.name == "len" and self.msg.is_fixed_length) |
| 388 | |
| 389 | @property |
| 390 | def value(self): |
| 391 | if self.name == "version": |
| 392 | return self.msg.version.int_version |
| 393 | elif self.name == "length" or self.name == "len": |
| 394 | return self.msg.length |
| 395 | elif self.java_type.public_type in ("int", "short", "byte") and self.member.value > 100: |
| 396 | return "0x%x" % self.member.value |
| 397 | else: |
| 398 | return self.member.value |
| 399 | |
| 400 | @property |
| 401 | def is_writeable(self): |
| 402 | return self.is_data and not self.name in model.write_blacklist[self.msg.name] |
| 403 | |
| 404 | def get_type_value_info(self, version): |
| 405 | return get_type_values(msg.c_name, version.int_version)[self.c_name] |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 406 | |
| 407 | @property |
| 408 | def length(self): |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 409 | if hasattr(self.member, "length"): |
| 410 | return self.member.length |
| 411 | else: |
| 412 | count, base = utils.type_dec_to_count_base(self.member.type) |
| 413 | return of_g.of_base_types[base]['bytes'] * count |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 414 | |
| 415 | @staticmethod |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 416 | def for_of_member(java_class, member): |
| 417 | if isinstance(member, OFPadMember): |
| 418 | return JavaMember(None, "", None, member) |
| 419 | else: |
| 420 | if member.name == 'len': |
| 421 | name = 'length' |
| 422 | else: |
| 423 | name = java_type.name_c_to_camel(member.name) |
| 424 | j_type = java_type.convert_to_jtype(java_class.c_name, member.name, member.oftype) |
| 425 | return JavaMember(java_class, name, j_type, member) |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 426 | |
| 427 | @property |
| 428 | def is_universal(self): |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 429 | if not self.msg.c_name in of_g.unified: |
| 430 | print("%s not self.unified" % self.msg.c_name) |
| 431 | return False |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 432 | for version in of_g.unified[self.msg.c_name]: |
| 433 | if version == 'union' or version =='object_id': |
| 434 | continue |
| 435 | if 'use_version' in of_g.unified[self.msg.c_name][version]: |
| 436 | continue |
| 437 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 438 | if not self.member.name in (f['name'] for f in of_g.unified[self.msg.c_name][version]['members']): |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 439 | return False |
| 440 | return True |
| 441 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 442 | def __hash__(self): |
| 443 | return hash(self.name) |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 444 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 445 | def __eq__(self, other): |
| 446 | if other is None or type(self) != type(other): |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 447 | return False |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 448 | return (self.name,) == (other.name,) |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 449 | |
Andreas Wundsam | e916d6f | 2013-07-30 11:33:58 -0700 | [diff] [blame] | 450 | |
| 451 | ####################################################################### |
| 452 | ### Unit Test |
| 453 | ####################################################################### |
| 454 | |
| 455 | class JavaUnitTest(object): |
| 456 | def __init__(self, java_class): |
| 457 | self.java_class = java_class |
| 458 | self.data_file_name = "of{version}/{name}.data".format(version=java_class.version.of_version, |
| 459 | name=java_class.c_name[3:]) |
| 460 | @property |
| 461 | def package(self): |
| 462 | return self.java_class.package |
| 463 | |
| 464 | @property |
| 465 | def name(self): |
| 466 | return self.java_class.name + "Test" |
| 467 | |
| 468 | @property |
| 469 | def has_test_data(self): |
| 470 | return test_data.exists(self.data_file_name) |
| 471 | |
| 472 | @property |
| 473 | @memoize |
| 474 | def test_data(self): |
| 475 | return test_data.read(self.data_file_name) |
| 476 | |
| 477 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 478 | ####################################################################### |
| 479 | ### Enums |
| 480 | ####################################################################### |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 481 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 482 | class JavaEnum(object): |
| 483 | def __init__(self, c_name, entry_version_value_map): |
| 484 | self.c_name = c_name |
| 485 | self.name = "OF" + java_type.name_c_to_caps_camel("_".join(c_name.split("_")[1:])) |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 486 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 487 | # Port_features has constants that start with digits |
| 488 | self.name_prefix = "PF_" if self.name == "OFPortFeatures" else "" |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 489 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 490 | self.entries = [ JavaEnumEntry(self, name, version_value_map) |
| 491 | for (name, version_value_map) in entry_version_value_map.items() ] |
| 492 | self.package = "org.openflow.protocol" |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 493 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 494 | @memoize |
| 495 | def entry_by_name(self, name): |
Andreas Wundsam | 40e14f7 | 2013-05-06 14:49:08 -0700 | [diff] [blame] | 496 | try: |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 497 | return find(self.entries, lambda e: e.name == name) |
| 498 | except KeyError: |
| 499 | raise KeyError("Enum %s: no entry with name %s" % (self.name, name)) |
| 500 | |
| 501 | @memoize |
| 502 | def entry_by_c_name(self, name): |
| 503 | try: |
| 504 | return find(self.entries, lambda e: e.c_name == name) |
| 505 | except KeyError: |
| 506 | raise KeyError("Enum %s: no entry with c_name %s" % (self.name, name)) |
| 507 | |
| 508 | @memoize |
| 509 | def entry_by_version_value(self, version, value): |
| 510 | try: |
| 511 | return find(self.entries, lambda e: e.values[version] == value if version in e.values else False ) |
| 512 | except KeyError: |
| 513 | raise KeyError("Enum %s: no entry with version %s, value %s" % (self.name, version, value)) |
| 514 | |
| 515 | # values: Map JavaVersion->Value |
| 516 | class JavaEnumEntry(object): |
| 517 | def __init__(self, enum, name, values): |
| 518 | self.name = enum.name_prefix + "_".join(name.split("_")[1:]).upper() |
| 519 | self.values = values |
| 520 | |
| 521 | def value(self, version): |
| 522 | res = self.version_value_map[version] |
| 523 | return res |
| 524 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 525 | def all_values(self, versions, not_present=None): |
| 526 | return [ self.values[version] if version in self.values else not_present for version in versions ] |