Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 1 | import os |
| 2 | import errno |
| 3 | import re |
| 4 | import subprocess |
| 5 | import time |
| 6 | |
| 7 | def name_c_to_camel(name): |
| 8 | """ 'of_stats_reply' -> 'ofStatsReply' """ |
| 9 | name = re.sub(r'^_','', name) |
| 10 | tokens = name.split('_') |
| 11 | for i in range(1, len(tokens)): |
| 12 | tokens[i] = tokens[i].title() |
| 13 | return "".join(tokens) |
| 14 | |
| 15 | def name_c_to_caps_camel(name): |
| 16 | """ 'of_stats_reply' to 'OFStatsReply' """ |
| 17 | camel = name_c_to_camel(name.title()) |
| 18 | if camel.startswith('Of'): |
| 19 | return camel.replace('Of','OF',1) |
| 20 | else: |
| 21 | return camel |
| 22 | |
| 23 | |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 24 | ANY = 0xFFFFFFFFFFFFFFFF |
| 25 | |
| 26 | |
| 27 | class VersionOp: |
| 28 | def __init__(self, version=ANY, read=None, write=None): |
| 29 | self.version = version |
| 30 | self.read = read |
| 31 | self.write = write |
| 32 | |
| 33 | def __str__(self): |
| 34 | return "[Version: %d, Read: '%s', Write: '%s']" % (self.version, self.read, self.write) |
| 35 | |
| 36 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 37 | class JType(object): |
| 38 | """ Wrapper class to hold C to Java type conversion information """ |
| 39 | def __init__(self, pub_type, priv_type=None, size=None, read_op=None, write_op=None): |
| 40 | self.pub_type = pub_type # the type we expose externally, e.g. 'U8' |
| 41 | if priv_type is None: |
| 42 | priv_type = pub_type |
| 43 | self.priv_type = priv_type # the internal storage type |
| 44 | self.size = size # bytes on the wire; None == variable length or hard to calc |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 45 | self.ops = {} |
| 46 | # if read_op is None: |
| 47 | # read_op = 'ChannelUtils.read%s(bb)' % self.pub_type |
| 48 | # if write_op is None: |
| 49 | # write_op = 'ChannelUtils.write%s(bb, $name)' % self.pub_type |
| 50 | # self._read_op = read_op |
| 51 | # self._write_op = write_op |
| 52 | |
| 53 | def op(self, version=ANY, read=None, write=None): |
| 54 | self.ops[version] = VersionOp(version, read, write) |
| 55 | return self |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 56 | |
| 57 | @property |
| 58 | def public_type(self): |
| 59 | """ return the public type """ |
| 60 | return self.pub_type |
| 61 | |
| 62 | def priv(self): |
| 63 | """ return the public type """ |
| 64 | return self.priv_type |
| 65 | |
| 66 | def has_priv(self): |
| 67 | """ Is the private type different from the public one?""" |
| 68 | return self.pub_type != self.priv_type |
| 69 | |
| 70 | def read_op(self, version=None, length=None): |
| 71 | if length is None: |
| 72 | length = "length - bb.readerIndex()"; |
| 73 | |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 74 | ver = ANY if version is None else version.int_version |
| 75 | _read_op = None |
| 76 | if ver in self.ops: |
| 77 | _read_op = self.ops[ver].read or self.ops[ANY].read |
| 78 | elif ANY in self.ops: |
| 79 | _read_op = self.ops[ANY].read |
| 80 | if _read_op is None: |
| 81 | _read_op = 'ChannelUtils.read%s(bb)' % self.pub_type |
| 82 | if callable(_read_op): |
| 83 | return _read_op(version) |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 84 | else: |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 85 | return _read_op.replace("$length", str(length)).replace("$version", version.of_version) |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 86 | |
| 87 | def write_op(self, version=None, name=None): |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 88 | ver = ANY if version is None else version.int_version |
| 89 | _write_op = None |
| 90 | if ver in self.ops: |
| 91 | _write_op = self.ops[ver].write or self.ops[ANY].write |
| 92 | elif ANY in self.ops: |
| 93 | _write_op = self.ops[ANY].write |
| 94 | if _write_op is None: |
| 95 | _write_op = 'ChannelUtils.write%s(bb, $name)' % self.pub_type |
| 96 | if callable(_write_op): |
| 97 | return _write_op(version, name) |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 98 | else: |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 99 | return _write_op.replace("$name", str(name)).replace("$version", version.of_version) |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 100 | |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 101 | hello_elem_list = JType("List<OFHelloElement>") \ |
| 102 | .op(read='ChannelUtils.readHelloElementList(bb)', write='ChannelUtils.writeHelloElementList(bb)') |
| 103 | u8 = JType('byte', size=1) \ |
| 104 | .op(read='bb.readByte()', write='bb.writeByte($name)') |
| 105 | u8_list = JType('List<U8>', size=1) \ |
| 106 | .op(read='bb.readByte()', write='bb.writeByte($name)') |
| 107 | u16 = JType('int', 'int', size=2) \ |
| 108 | .op(read='U16.f(bb.readShort())', write='bb.writeShort(U16.t($name))') |
| 109 | u32 = JType('int', 'int', size=4) \ |
| 110 | .op(read='bb.readInt()', write='bb.writeInt($name)') |
| 111 | u32_list = JType('List<U32>', 'int[]', size=4) \ |
| 112 | .op(read='bb.readInt()', write='bb.writeInt($name)') |
| 113 | u64 = JType('U64', 'U64', size=8) \ |
| 114 | .op(read='U64.of(bb.readLong())', write='bb.writeLong($name.getValue())') |
| 115 | of_port = JType("OFPort") \ |
| 116 | .op(version=1, read="OFPort.read2Bytes(bb)", write="$name.write2Bytes(bb)") \ |
| 117 | .op(version=ANY, read="OFPort.read4Bytes(bb)", write="$name.write4Bytes(bb)") |
| 118 | one_byte_array = JType('byte[]', size=1) \ |
| 119 | .op(read='ChannelUtils.readBytes(bb, 1)', write='ChannelUtils.writeBytes(bb, $name)') |
| 120 | two_byte_array = JType('byte[]', size=2) \ |
| 121 | .op(read='ChannelUtils.readBytes(bb, 2)', write='ChannelUtils.writeBytes(bb, $name)') |
| 122 | three_byte_array = JType('byte[]', size=3) \ |
| 123 | .op(read='ChannelUtils.readBytes(bb, 3)', write='ChannelUtils.writeBytes(bb, $name)') |
| 124 | four_byte_array = JType('byte[]', size=4) \ |
| 125 | .op(read='ChannelUtils.readBytes(bb, 4)', write='ChannelUtils.writeBytes(bb, $name)') |
| 126 | five_byte_array = JType('byte[]', size=5) \ |
| 127 | .op(read='ChannelUtils.readBytes(bb, 5)', write='ChannelUtils.writeBytes(bb, $name)') |
| 128 | six_byte_array = JType('byte[]', size=6) \ |
| 129 | .op(read='ChannelUtils.readBytes(bb, 6)', write='ChannelUtils.writeBytes(bb, $name)') |
| 130 | seven_byte_array = JType('byte[]', size=7) \ |
| 131 | .op(read='ChannelUtils.readBytes(bb, 7)', write='ChannelUtils.writeBytes(bb, $name)') |
| 132 | actions_list = JType('List<OFAction>', size='ChannelUtils.calcListSize($name)') \ |
| 133 | .op(read='ChannelUtils.readActionsList(bb, $length)', write='ChannelUtils.writeActionsList(bb, $name);') |
| 134 | instructions_list = JType('List<OFInstruction>', size='ChannelUtils.calcListSize($name)') \ |
| 135 | .op(read='ChannelUtils.readInstructionsList(bb, $length)', \ |
| 136 | write='ChannelUtils.writeList(bb, $name)') |
| 137 | buckets_list = JType('List<OFBucket>', size='ChannelUtils.calcListSize($name)') \ |
| 138 | .op(read='ChannelUtils.readBucketList(bb, $length)', \ |
| 139 | write='ChannelUtils.writeList(bb, $name)') |
| 140 | port_desc_list = JType('List<OFPhysicalPort>', size='ChannelUtils.calcListSize($name)') \ |
| 141 | .op(read='ChannelUtils.readPhysicalPortList(bb, $length)', \ |
| 142 | write='ChannelUtils.writeList(bb, $name)') |
| 143 | port_desc = JType('OFPortDesc', size='$name.getLength()') \ |
| 144 | .op(read='null; // TODO OFPortDescVer$version.READER.read(bb)', \ |
| 145 | write='$name.writeTo(bb)') |
| 146 | packet_queue_list = JType('List<OFPacketQueue>', size='ChannelUtils.calcListSize($name)') \ |
| 147 | .op(read='ChannelUtils.readPacketQueueList(bb, $length)', \ |
| 148 | write='ChannelUtils.writeList(bb, $name)') |
| 149 | octets = JType('byte[]', size="$length") \ |
| 150 | .op(read='ChannelUtils.readBytes(bb, $length)', \ |
| 151 | write='bb.writeBytes($name)') |
| 152 | of_match = JType('Match', size="$name.getLength()") \ |
| 153 | .op(read='ChannelUtils.readOFMatch(bb)', \ |
| 154 | write='ChannelUtils.writeOFMatch(bb, $name)') |
| 155 | flow_mod_cmd = JType('OFFlowModCommand', 'short', size="$name.getLength()") \ |
| 156 | .op(version=1, read="bb.readShort()", write="bb.writeShort($name)") \ |
| 157 | .op(version=ANY, read="bb.readByte()", write="bb.writeByte($name)") |
| 158 | mac_addr = JType('MacAddress', 'byte[]', size=6) \ |
| 159 | .op(read="MacAddress.read6Bytes(bb)", \ |
| 160 | write="$name.write6Bytes(bb)") |
| 161 | port_name = JType('String', size=16) \ |
| 162 | .op(read='ChannelUtils.readFixedLengthString(bb, 16)', \ |
| 163 | write='ChannelUtils.writeFixedLengthString(bb, $name, 16)') |
| 164 | desc_str = JType('String', size=256) \ |
| 165 | .op(read='ChannelUtils.readFixedLengthString(bb, 256)', \ |
| 166 | write='ChannelUtils.writeFixedLengthString(bb, $name, 256)') |
| 167 | serial_num = JType('String', size=32) \ |
| 168 | .op(read='ChannelUtils.readFixedLengthString(bb, 32)', \ |
| 169 | write='ChannelUtils.writeFixedLengthString(bb, $name, 32)') |
| 170 | table_name = JType('String', size=32) \ |
| 171 | .op(read='ChannelUtils.readFixedLengthString(bb, 32)', \ |
| 172 | write='ChannelUtils.writeFixedLengthString(bb, $name, 32)') |
| 173 | ipv4 = JType("IPv4") \ |
| 174 | .op(read="IPv4.read4Bytes(bb)", \ |
| 175 | write="$name.write4Bytes(bb)") |
| 176 | ipv6 = JType("IPv6") \ |
| 177 | .op(read="IPv6.read16Bytes(bb)", \ |
| 178 | write="$name.write16Bytes(bb)") |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 179 | |
| 180 | default_mtype_to_jtype_convert_map = { |
| 181 | 'uint8_t' : u8, |
| 182 | 'uint16_t' : u16, |
| 183 | 'uint32_t' : u32, |
| 184 | 'uint64_t' : u64, |
| 185 | 'uint8_t[1]' : one_byte_array, |
| 186 | 'uint8_t[2]' : two_byte_array, |
| 187 | 'uint8_t[3]' : three_byte_array, |
| 188 | 'uint8_t[4]' : four_byte_array, |
| 189 | 'uint8_t[5]' : five_byte_array, |
| 190 | 'uint8_t[6]' : six_byte_array, |
| 191 | 'uint8_t[7]' : seven_byte_array, |
| 192 | 'of_port_no_t' : of_port, |
| 193 | 'list(of_action_t)' : actions_list, |
| 194 | 'list(of_instruction_t)' : instructions_list, |
| 195 | 'list(of_bucket_t)': buckets_list, |
| 196 | 'list(of_port_desc_t)' : port_desc_list, |
| 197 | 'list(of_packet_queue_t)' : packet_queue_list, |
| 198 | 'list(of_uint32_t)' : u32_list, |
| 199 | 'list(of_uint8_t)' : u8_list, |
| 200 | 'of_octets_t' : octets, |
| 201 | 'of_match_t': of_match, |
| 202 | 'of_fm_cmd_t': flow_mod_cmd, |
| 203 | 'of_mac_addr_t': mac_addr, |
| 204 | 'of_port_desc_t': port_desc, |
| 205 | 'of_desc_str_t': desc_str, |
| 206 | 'of_serial_num_t': serial_num, |
| 207 | 'of_port_name_t': port_name, |
| 208 | 'of_table_name_t': table_name, |
| 209 | 'of_ipv4_t': ipv4, |
| 210 | 'of_ipv6_t': ipv6, |
| 211 | 'of_wc_bmap_t': JType("Wildcards") |
| 212 | } |
| 213 | |
| 214 | ## This is where we drop in special case handling for certain types |
| 215 | exceptions = { |
| 216 | 'OFPacketIn': { |
| 217 | 'data' : octets |
| 218 | }, |
| 219 | } |
| 220 | |
| 221 | |
| 222 | def make_standard_list_jtype(c_type): |
| 223 | m = re.match(r'list\(of_([a-zA-Z_]+)_t\)', c_type) |
| 224 | if not m: |
| 225 | raise Exception("Not a recgonized standard list type declaration: %s" % c_type) |
| 226 | base_name = m.group(1) |
| 227 | java_base_name = name_c_to_caps_camel(base_name) |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 228 | return JType("List<OF%s>" % java_base_name) \ |
| 229 | .op(read='ChannelUtils.read%sList(bb)' % java_base_name, \ |
| 230 | write='ChannelUtils.write%sList(bb, $name)' % java_base_name) |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 231 | |
| 232 | def convert_to_jtype(obj_name, field_name, c_type): |
| 233 | """ Convert from a C type ("uint_32") to a java type ("U32") |
| 234 | and return a JType object with the size, internal type, and marshalling functions""" |
| 235 | if obj_name in exceptions and field_name in exceptions[obj_name]: |
| 236 | return exceptions[obj_name][field_name] |
| 237 | elif field_name == "type" and c_type == "uint8_t": |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 238 | return JType("OFType", 'byte', size=1) \ |
| 239 | .op(read='bb.readByte()', write='bb.writeByte($name)') |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 240 | elif field_name == "type" and re.match(r'of_action.*', obj_name): |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 241 | return JType("OFActionType", 'short', size=2) \ |
| 242 | .op(read='bb.readShort()', write='bb.writeShort($name)') |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 243 | elif field_name == "version" and c_type == "uint8_t": |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 244 | return JType("OFVersion", 'byte', size=1) \ |
| 245 | .op(read='bb.readByte()', write='bb.writeByte($name)') |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 246 | elif c_type in default_mtype_to_jtype_convert_map: |
| 247 | return default_mtype_to_jtype_convert_map[c_type] |
| 248 | elif re.match(r'list\(of_([a-zA-Z_]+)_t\)', c_type): |
| 249 | return make_standard_list_jtype(c_type) |
| 250 | else: |
| 251 | print "WARN: Couldn't find java type conversion for '%s' in %s:%s" % (c_type, obj_name, field_name) |
| 252 | jtype = name_c_to_caps_camel(re.sub(r'_t$', "", c_type)) |
| 253 | return JType(jtype) |