Yotam Harchol | c742e20 | 2013-08-15 12:16:24 -0700 | [diff] [blame] | 1 | import errno |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 2 | import os |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 3 | import re |
| 4 | import subprocess |
| 5 | import time |
| 6 | |
Andreas Wundsam | 7cfeac3 | 2013-09-17 13:53:48 -0700 | [diff] [blame] | 7 | from generic_utils import memoize |
| 8 | import loxi_utils.loxi_utils as loxi_utils |
| 9 | import of_g |
| 10 | |
Andreas Wundsam | 2be7da5 | 2013-08-22 07:34:25 -0700 | [diff] [blame] | 11 | def erase_type_annotation(class_name): |
| 12 | m=re.match(r'(.*)<.*>', class_name) |
| 13 | if m: |
| 14 | return m.group(1) |
| 15 | else: |
| 16 | return class_name |
| 17 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 18 | def name_c_to_camel(name): |
| 19 | """ 'of_stats_reply' -> 'ofStatsReply' """ |
| 20 | name = re.sub(r'^_','', name) |
| 21 | tokens = name.split('_') |
| 22 | for i in range(1, len(tokens)): |
| 23 | tokens[i] = tokens[i].title() |
| 24 | return "".join(tokens) |
| 25 | |
| 26 | def name_c_to_caps_camel(name): |
| 27 | """ 'of_stats_reply' to 'OFStatsReply' """ |
| 28 | camel = name_c_to_camel(name.title()) |
Andreas Wundsam | 7cfeac3 | 2013-09-17 13:53:48 -0700 | [diff] [blame] | 29 | if camel.startswith('Ofp'): |
| 30 | return camel.replace('Ofp','OF',1) |
| 31 | elif camel.startswith('Of'): |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 32 | return camel.replace('Of','OF',1) |
| 33 | else: |
| 34 | return camel |
| 35 | |
Andreas Wundsam | e916d6f | 2013-07-30 11:33:58 -0700 | [diff] [blame] | 36 | java_primitive_types = set("byte char short int long".split(" ")) |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 37 | |
| 38 | ### info table about java primitive types, for casting literals in the source code |
| 39 | # { name : (signed?, length_in_bits) } |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 40 | java_primitives_info = { |
| 41 | 'byte' : (True, 8), |
| 42 | 'char' : (False, 16), |
| 43 | 'short' : (True, 16), |
| 44 | 'int' : (True, 32), |
| 45 | 'long' : (True, 64), |
| 46 | } |
| 47 | |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 48 | def format_primitive_literal(t, value): |
| 49 | """ Format a primitive numeric literal for inclusion in the |
| 50 | java source code. Takes care of casting the literal |
| 51 | apropriately for correct representation despite Java's |
| 52 | signed-craziness |
| 53 | """ |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 54 | signed, bits = java_primitives_info[t] |
| 55 | max = (1 << bits)-1 |
| 56 | if value > max: |
| 57 | raise Exception("Value %d to large for type %s" % (value, t)) |
| 58 | |
| 59 | if signed: |
| 60 | max_pos = (1 << (bits-1)) - 1 |
| 61 | |
| 62 | if value > max_pos: |
| 63 | if t == "long": |
| 64 | return str((1 << bits) - value) |
| 65 | else: |
| 66 | return "(%s) 0x%x" % (t, value) |
| 67 | else: |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 68 | return "0x%x%s" % (value, "L" if t=="long" else "") |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 69 | |
Andreas Wundsam | e916d6f | 2013-07-30 11:33:58 -0700 | [diff] [blame] | 70 | ANY = 0xFFFFFFFFFFFFFFFF |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 71 | |
| 72 | class VersionOp: |
| 73 | def __init__(self, version=ANY, read=None, write=None): |
| 74 | self.version = version |
| 75 | self.read = read |
| 76 | self.write = write |
Andreas Wundsam | e916d6f | 2013-07-30 11:33:58 -0700 | [diff] [blame] | 77 | |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 78 | def __str__(self): |
| 79 | return "[Version: %d, Read: '%s', Write: '%s']" % (self.version, self.read, self.write) |
| 80 | |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 81 | ### FIXME: This class should really be cleaned up |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 82 | class JType(object): |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 83 | """ Wrapper class to hold C to Java type conversion information. JTypes can have a 'public' |
| 84 | and or 'private' java type associated with them and can define how those types can be |
| 85 | read from and written to ChannelBuffers. |
| 86 | |
| 87 | """ |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 88 | def __init__(self, pub_type, priv_type=None, read_op=None, write_op=None): |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 89 | self.pub_type = pub_type # the type we expose externally, e.g. 'U8' |
| 90 | if priv_type is None: |
| 91 | priv_type = pub_type |
| 92 | self.priv_type = priv_type # the internal storage type |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 93 | self.ops = {} |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 94 | |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 95 | def op(self, version=ANY, read=None, write=None, pub_type=ANY): |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 96 | """ |
| 97 | define operations to be performed for reading and writing this type |
| 98 | (when read_op, write_op is called). The operations 'read' and 'write' |
| 99 | can either be strings ($name, and $version and $length will be replaced), |
| 100 | or callables (name, version and length) will be passed. |
| 101 | |
| 102 | @param version int OF version to define operation for, or ANY for all |
| 103 | @param pub_type boolean whether to define operations for the public type (True), the |
| 104 | private type(False) or both (ALL) |
| 105 | @param read read expression (either string or callable)s |
| 106 | @param write write expression (either string or callable) |
| 107 | """ |
| 108 | |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 109 | pub_types = [ pub_type ] if pub_type is not ANY else [ False, True ] |
| 110 | for pub_type in pub_types: |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 111 | self.ops[(version, pub_type)] = VersionOp(version, read, write) |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 112 | return self |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 113 | |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 114 | def format_value(self, value, pub_type=True): |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 115 | # Format a constant value of this type, for inclusion in the java source code |
| 116 | # For primitive types, takes care of casting the value appropriately, to |
| 117 | # cope with java's signedness limitation |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 118 | t = self.pub_type if pub_type else self.priv_type |
| 119 | if t in java_primitive_types: |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 120 | return format_primitive_literal(t, value) |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 121 | else: |
| 122 | return value |
Andreas Wundsam | bf1dbbd | 2013-07-30 11:07:59 -0700 | [diff] [blame] | 123 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 124 | @property |
| 125 | def public_type(self): |
| 126 | """ return the public type """ |
| 127 | return self.pub_type |
| 128 | |
| 129 | def priv(self): |
| 130 | """ return the public type """ |
| 131 | return self.priv_type |
| 132 | |
| 133 | def has_priv(self): |
| 134 | """ Is the private type different from the public one?""" |
| 135 | return self.pub_type != self.priv_type |
| 136 | |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 137 | def read_op(self, version=None, length=None, pub_type=True): |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 138 | """ return a Java stanza that reads a value of this JType from ChannelBuffer bb. |
| 139 | @param version int - OF wire version to generate expression for |
| 140 | @param pub_type boolean use this JTypes 'public' (True), or private (False) representation |
| 141 | @param length string, for operations that need it (e.g., read a list of unknown length) |
| 142 | Java expression evaluating to the byte length to be read. Defaults to the remainig |
| 143 | length of the message. |
| 144 | @return string containing generated Java expression. |
| 145 | """ |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 146 | if length is None: |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 147 | # assumes that |
| 148 | # (1) length of the message has been read to 'length' |
| 149 | # (2) readerIndex at the start of the message has been stored in 'start' |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 150 | length = "length - (bb.readerIndex() - start)"; |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 151 | |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 152 | ver = ANY if version is None else version.int_version |
| 153 | _read_op = None |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 154 | if (ver, pub_type) in self.ops: |
| 155 | _read_op = self.ops[(ver, pub_type)].read or self.ops[(ANY, pub_type)].read |
| 156 | elif (ANY, pub_type) in self.ops: |
| 157 | _read_op = self.ops[(ANY, pub_type)].read |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 158 | if _read_op is None: |
Andreas Wundsam | 951ada3 | 2013-08-01 22:05:38 -0700 | [diff] [blame] | 159 | _read_op = 'ChannelUtilsVer$version.read%s(bb)' % self.pub_type |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 160 | if callable(_read_op): |
| 161 | return _read_op(version) |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 162 | else: |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 163 | return _read_op.replace("$length", str(length)).replace("$version", version.of_version) |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 164 | |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 165 | def write_op(self, version=None, name=None, pub_type=True): |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 166 | """ return a Java stanza that writes a value of this JType contained in Java expression |
| 167 | 'name' to ChannelBuffer bb. |
| 168 | @param name string containing Java expression that evaluations to the value to be written |
| 169 | @param version int - OF wire version to generate expression for |
| 170 | @param pub_type boolean use this JTypes 'public' (True), or private (False) representation |
| 171 | @return string containing generated Java expression. |
| 172 | """ |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 173 | ver = ANY if version is None else version.int_version |
| 174 | _write_op = None |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 175 | if (ver, pub_type) in self.ops: |
| 176 | _write_op = self.ops[(ver, pub_type)].write or self.ops[(ANY, pub_type)].write |
| 177 | elif (ANY, pub_type) in self.ops: |
| 178 | _write_op = self.ops[(ANY, pub_type)].write |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 179 | if _write_op is None: |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 180 | |
Andreas Wundsam | 951ada3 | 2013-08-01 22:05:38 -0700 | [diff] [blame] | 181 | _write_op = 'ChannelUtilsVer$version.write%s(bb, $name)' % self.pub_type |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 182 | if callable(_write_op): |
| 183 | return _write_op(version, name) |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 184 | else: |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 185 | return _write_op.replace("$name", str(name)).replace("$version", version.of_version) |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 186 | |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 187 | def skip_op(self, version=None, length=None): |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 188 | """ return a java stanza that skips an instance of JType in the input ChannelBuffer 'bb'. |
| 189 | This is used in the Reader implementations for virtual classes (because after the |
| 190 | discriminator field, the concrete Reader instance will re-read all the fields) |
| 191 | Currently just delegates to read_op + throws away the result.""" |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 192 | return self.read_op(version, length) |
| 193 | |
Andreas Wundsam | e916d6f | 2013-07-30 11:33:58 -0700 | [diff] [blame] | 194 | @property |
| 195 | def is_primitive(self): |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 196 | """ return true if the pub_type is a java primitive type (and thus needs |
| 197 | special treatment, because it doesn't have methods)""" |
Andreas Wundsam | e916d6f | 2013-07-30 11:33:58 -0700 | [diff] [blame] | 198 | return self.pub_type in java_primitive_types |
| 199 | |
| 200 | @property |
| 201 | def is_array(self): |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 202 | """ return true iff the pub_type is a Java array (and thus requires special |
| 203 | treament for equals / toString etc.) """ |
Andreas Wundsam | e916d6f | 2013-07-30 11:33:58 -0700 | [diff] [blame] | 204 | return self.pub_type.endswith("[]") |
| 205 | |
| 206 | |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 207 | ##### Predefined JType mappings |
| 208 | # FIXME: This list needs to be pruned / cleaned up. Most of these are schematic. |
| 209 | |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 210 | u8 = JType('short', 'byte') \ |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 211 | .op(read='bb.readByte()', write='bb.writeByte($name)') |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 212 | u8_list = JType('List<U8>') \ |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 213 | .op(read='ChannelUtils.readList(bb, $length, U8.READER)', write='ChannelUtils.writeList(bb, $name)') |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 214 | u16 = JType('int', 'short') \ |
| 215 | .op(read='U16.f(bb.readShort())', write='bb.writeShort(U16.t($name))', pub_type=True) \ |
| 216 | .op(read='bb.readShort()', write='bb.writeShort($name)', pub_type=False) |
| 217 | u32 = JType('long', 'int') \ |
| 218 | .op(read='U32.f(bb.readInt())', write='bb.writeInt(U32.t($name))', pub_type=True) \ |
| 219 | .op(read='bb.readInt()', write='bb.writeInt($name)', pub_type=False) |
| 220 | u32_list = JType('List<U32>', 'int[]') \ |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 221 | .op(read='ChannelUtils.readList(bb, $length, U32.READER)', write='ChannelUtils.writeList(bb, $name)') |
Yotam Harchol | 5804f77 | 2013-08-21 17:35:31 -0700 | [diff] [blame] | 222 | u8obj = JType('U8', 'U8') \ |
| 223 | .op(read='U8.of(bb.readByte())', write='bb.writeByte($name.getRaw())') |
| 224 | u32obj = JType('U32', 'U32') \ |
| 225 | .op(read='U32.of(bb.readInt())', write='bb.writeInt($name.getRaw())') |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 226 | u64 = JType('U64', 'U64') \ |
Andreas Wundsam | 880a2a8 | 2013-08-22 07:55:14 -0700 | [diff] [blame] | 227 | .op(read='U64.ofRaw(bb.readLong())', write='bb.writeLong($name.getValue())') |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 228 | of_port = JType("OFPort") \ |
| 229 | .op(version=1, read="OFPort.read2Bytes(bb)", write="$name.write2Bytes(bb)") \ |
| 230 | .op(version=ANY, read="OFPort.read4Bytes(bb)", write="$name.write4Bytes(bb)") |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 231 | actions_list = JType('List<OFAction>') \ |
| 232 | .op(read='ChannelUtils.readList(bb, $length, OFActionVer$version.READER)', write='ChannelUtils.writeList(bb, $name);') |
| 233 | instructions_list = JType('List<OFInstruction>') \ |
| 234 | .op(read='ChannelUtils.readList(bb, $length, OFInstructionVer$version.READER)', \ |
| 235 | write='ChannelUtils.writeList(bb, $name)') |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 236 | buckets_list = JType('List<OFBucket>') \ |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 237 | .op(read='ChannelUtils.readList(bb, $length, OFBucketVer$version.READER)', write='ChannelUtils.writeList(bb, $name)') |
Rob Vaterlaus | 7db900a | 2013-09-17 14:18:49 -0700 | [diff] [blame] | 238 | port_desc_list = JType('List<OFPortDesc>') \ |
| 239 | .op(read='ChannelUtils.readList(bb, $length, OFPortDescVer$version.READER)', write='ChannelUtils.writeList(bb, $name)') |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 240 | port_desc = JType('OFPortDesc') \ |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 241 | .op(read='OFPortDescVer$version.READER.readFrom(bb)', \ |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 242 | write='$name.writeTo(bb)') |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 243 | packet_queue_list = JType('List<OFPacketQueue>') \ |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 244 | .op(read='ChannelUtils.readList(bb, $length, OFPacketQueueVer$version.READER)', write='ChannelUtils.writeList(bb, $name);') |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 245 | octets = JType('byte[]') \ |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 246 | .op(read='ChannelUtils.readBytes(bb, $length)', \ |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 247 | write='bb.writeBytes($name)') |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 248 | of_match = JType('Match') \ |
Andreas Wundsam | 951ada3 | 2013-08-01 22:05:38 -0700 | [diff] [blame] | 249 | .op(read='ChannelUtilsVer$version.readOFMatch(bb)', \ |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 250 | write='$name.writeTo(bb)'); |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 251 | flow_mod_cmd = JType('OFFlowModCommand', 'short') \ |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 252 | .op(version=1, read="bb.readShort()", write="bb.writeShort($name)") \ |
| 253 | .op(version=ANY, read="bb.readByte()", write="bb.writeByte($name)") |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 254 | mac_addr = JType('MacAddress') \ |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 255 | .op(read="MacAddress.read6Bytes(bb)", \ |
| 256 | write="$name.write6Bytes(bb)") |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 257 | port_name = JType('String') \ |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 258 | .op(read='ChannelUtils.readFixedLengthString(bb, 16)', \ |
| 259 | write='ChannelUtils.writeFixedLengthString(bb, $name, 16)') |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 260 | desc_str = JType('String') \ |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 261 | .op(read='ChannelUtils.readFixedLengthString(bb, 256)', \ |
| 262 | write='ChannelUtils.writeFixedLengthString(bb, $name, 256)') |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 263 | serial_num = JType('String') \ |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 264 | .op(read='ChannelUtils.readFixedLengthString(bb, 32)', \ |
| 265 | write='ChannelUtils.writeFixedLengthString(bb, $name, 32)') |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 266 | table_name = JType('String') \ |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 267 | .op(read='ChannelUtils.readFixedLengthString(bb, 32)', \ |
| 268 | write='ChannelUtils.writeFixedLengthString(bb, $name, 32)') |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 269 | ipv4 = JType("IPv4Address") \ |
| 270 | .op(read="IPv4Address.read4Bytes(bb)", \ |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 271 | write="$name.write4Bytes(bb)") |
Yotam Harchol | a289d55 | 2013-09-16 10:10:40 -0700 | [diff] [blame] | 272 | ipv6 = JType("IPv6Address") \ |
| 273 | .op(read="IPv6Address.read16Bytes(bb)", \ |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 274 | write="$name.write16Bytes(bb)") |
Andreas Wundsam | bf1dbbd | 2013-07-30 11:07:59 -0700 | [diff] [blame] | 275 | packetin_reason = JType("OFPacketInReason")\ |
| 276 | .op(read="OFPacketInReasonSerializerVer$version.readFrom(bb)", write="OFPacketInReasonSerializerVer$version.writeTo(bb, $name)") |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 277 | wildcards = JType("Wildcards")\ |
| 278 | .op(read="Wildcards.of(bb.readInt())", write="bb.writeInt($name.getInt())"); |
| 279 | transport_port = JType("TransportPort")\ |
| 280 | .op(read="TransportPort.read2Bytes(bb)", write="$name.write2Bytes(bb)") |
Yotam Harchol | c742e20 | 2013-08-15 12:16:24 -0700 | [diff] [blame] | 281 | eth_type = JType("EthType")\ |
| 282 | .op(read="EthType.read2Bytes(bb)", write="$name.write2Bytes(bb)") |
| 283 | vlan_vid = JType("VlanVid")\ |
| 284 | .op(read="VlanVid.read2Bytes(bb)", write="$name.write2Bytes(bb)") |
| 285 | vlan_pcp = JType("VlanPcp")\ |
| 286 | .op(read="VlanPcp.readByte(bb)", write="$name.writeByte(bb)") |
| 287 | ip_dscp = JType("IpDscp")\ |
| 288 | .op(read="IpDscp.readByte(bb)", write="$name.writeByte(bb)") |
| 289 | ip_ecn = JType("IpEcn")\ |
| 290 | .op(read="IpEcn.readByte(bb)", write="$name.writeByte(bb)") |
| 291 | ip_proto = JType("IpProtocol")\ |
| 292 | .op(read="IpProtocol.readByte(bb)", write="$name.writeByte(bb)") |
| 293 | icmpv4_type = JType("ICMPv4Type")\ |
| 294 | .op(read="ICMPv4Type.readByte(bb)", write="$name.writeByte(bb)") |
| 295 | icmpv4_code = JType("ICMPv4Code")\ |
| 296 | .op(read="ICMPv4Code.readByte(bb)", write="$name.writeByte(bb)") |
| 297 | arp_op = JType("ArpOpcode")\ |
| 298 | .op(read="ArpOpcode.read2Bytes(bb)", write="$name.write2Bytes(bb)") |
| 299 | ipv6_flabel = JType("IPv6FlowLabel")\ |
| 300 | .op(read="IPv6FlowLabel.read4Bytes(bb)", write="$name.write4Bytes(bb)") |
| 301 | metadata = JType("OFMetadata")\ |
| 302 | .op(read="OFMetadata.read8Bytes(bb)", write="$name.write8Bytes(bb)") |
Andreas Wundsam | 2be7da5 | 2013-08-22 07:34:25 -0700 | [diff] [blame] | 303 | oxm = JType("OFOxm<?>")\ |
| 304 | .op( read="OFOxmVer$version.READER.readFrom(bb)", |
| 305 | write="$name.writeTo(bb)") |
| 306 | oxm_list = JType("OFOxmList") \ |
| 307 | .op( |
| 308 | read= 'OFOxmList.readFrom(bb, $length, OFOxmVer$version.READER)', \ |
| 309 | write='$name.writeTo(bb)') |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 310 | meter_features = JType("OFMeterFeatures")\ |
| 311 | .op(read="OFMeterFeaturesVer$version.READER.readFrom(bb)", write="$name.writeTo(bb)") |
| 312 | |
Andreas Wundsam | 8ec3bcc | 2013-09-16 19:44:00 -0700 | [diff] [blame] | 313 | port_speed = JType("PortSpeed") |
Andreas Wundsam | 2be7da5 | 2013-08-22 07:34:25 -0700 | [diff] [blame] | 314 | boolean = JType("boolean") |
| 315 | |
| 316 | generic_t = JType("T") |
| 317 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 318 | |
| 319 | default_mtype_to_jtype_convert_map = { |
| 320 | 'uint8_t' : u8, |
| 321 | 'uint16_t' : u16, |
| 322 | 'uint32_t' : u32, |
| 323 | 'uint64_t' : u64, |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 324 | 'of_port_no_t' : of_port, |
| 325 | 'list(of_action_t)' : actions_list, |
| 326 | 'list(of_instruction_t)' : instructions_list, |
| 327 | 'list(of_bucket_t)': buckets_list, |
| 328 | 'list(of_port_desc_t)' : port_desc_list, |
| 329 | 'list(of_packet_queue_t)' : packet_queue_list, |
| 330 | 'list(of_uint32_t)' : u32_list, |
| 331 | 'list(of_uint8_t)' : u8_list, |
Andreas Wundsam | 2be7da5 | 2013-08-22 07:34:25 -0700 | [diff] [blame] | 332 | 'list(of_oxm_t)' : oxm_list, |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 333 | 'of_octets_t' : octets, |
| 334 | 'of_match_t': of_match, |
| 335 | 'of_fm_cmd_t': flow_mod_cmd, |
| 336 | 'of_mac_addr_t': mac_addr, |
| 337 | 'of_port_desc_t': port_desc, |
| 338 | 'of_desc_str_t': desc_str, |
| 339 | 'of_serial_num_t': serial_num, |
| 340 | 'of_port_name_t': port_name, |
| 341 | 'of_table_name_t': table_name, |
| 342 | 'of_ipv4_t': ipv4, |
| 343 | 'of_ipv6_t': ipv6, |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 344 | 'of_wc_bmap_t': wildcards, |
| 345 | 'of_oxm_t': oxm, |
| 346 | 'of_meter_features_t': meter_features, |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 347 | } |
| 348 | |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 349 | ## Map that defines exceptions from the standard loxi->java mapping scheme |
| 350 | # map of {<loxi_class_name> : { <loxi_member_name> : <JType instance> } } |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 351 | exceptions = { |
Yotam Harchol | c742e20 | 2013-08-15 12:16:24 -0700 | [diff] [blame] | 352 | 'of_packet_in': { 'data' : octets, 'reason': packetin_reason }, |
| 353 | 'of_oxm_tcp_src' : { 'value' : transport_port }, |
| 354 | 'of_oxm_tcp_src_masked' : { 'value' : transport_port, 'value_mask' : transport_port }, |
| 355 | 'of_oxm_tcp_dst' : { 'value' : transport_port }, |
| 356 | 'of_oxm_tcp_dst_masked' : { 'value' : transport_port, 'value_mask' : transport_port }, |
| 357 | 'of_oxm_udp_src' : { 'value' : transport_port }, |
| 358 | 'of_oxm_udp_src_masked' : { 'value' : transport_port, 'value_mask' : transport_port }, |
| 359 | 'of_oxm_udp_dst' : { 'value' : transport_port }, |
| 360 | 'of_oxm_udp_dst_masked' : { 'value' : transport_port, 'value_mask' : transport_port }, |
| 361 | 'of_oxm_sctp_src' : { 'value' : transport_port }, |
| 362 | 'of_oxm_sctp_src_masked' : { 'value' : transport_port, 'value_mask' : transport_port }, |
| 363 | 'of_oxm_sctp_dst' : { 'value' : transport_port }, |
| 364 | 'of_oxm_sctp_dst_masked' : { 'value' : transport_port, 'value_mask' : transport_port }, |
| 365 | 'of_oxm_eth_type' : { 'value' : eth_type }, |
| 366 | 'of_oxm_eth_type_masked' : { 'value' : eth_type, 'value_mask' : eth_type }, |
| 367 | 'of_oxm_vlan_vid' : { 'value' : vlan_vid }, |
| 368 | 'of_oxm_vlan_vid_masked' : { 'value' : vlan_vid, 'value_mask' : vlan_vid }, |
| 369 | 'of_oxm_vlan_pcp' : { 'value' : vlan_pcp }, |
| 370 | 'of_oxm_vlan_pcp_masked' : { 'value' : vlan_pcp, 'value_mask' : vlan_pcp }, |
| 371 | 'of_oxm_ip_dscp' : { 'value' : ip_dscp }, |
| 372 | 'of_oxm_ip_dscp_masked' : { 'value' : ip_dscp, 'value_mask' : ip_dscp }, |
| 373 | 'of_oxm_ip_ecn' : { 'value' : ip_ecn }, |
| 374 | 'of_oxm_ip_ecn_masked' : { 'value' : ip_ecn, 'value_mask' : ip_ecn }, |
| 375 | 'of_oxm_ip_proto' : { 'value' : ip_proto }, |
| 376 | 'of_oxm_ip_proto_masked' : { 'value' : ip_proto, 'value_mask' : ip_proto }, |
| 377 | 'of_oxm_icmpv4_type' : { 'value' : icmpv4_type }, |
| 378 | 'of_oxm_icmpv4_type_masked' : { 'value' : icmpv4_type, 'value_mask' : icmpv4_type }, |
| 379 | 'of_oxm_icmpv4_code' : { 'value' : icmpv4_code }, |
| 380 | 'of_oxm_icmpv4_code_masked' : { 'value' : icmpv4_code, 'value_mask' : icmpv4_code }, |
| 381 | 'of_oxm_arp_op' : { 'value' : arp_op }, |
| 382 | 'of_oxm_arp_op_masked' : { 'value' : arp_op, 'value_mask' : arp_op }, |
| 383 | 'of_oxm_arp_spa' : { 'value' : ipv4 }, |
| 384 | 'of_oxm_arp_spa_masked' : { 'value' : ipv4, 'value_mask' : ipv4 }, |
| 385 | 'of_oxm_arp_tpa' : { 'value' : ipv4 }, |
| 386 | 'of_oxm_arp_tpa_masked' : { 'value' : ipv4, 'value_mask' : ipv4 }, |
| 387 | 'of_oxm_ipv6_flabel' : { 'value' : ipv6_flabel }, |
| 388 | 'of_oxm_ipv6_flabel_masked' : { 'value' : ipv6_flabel, 'value_mask' : ipv6_flabel }, |
| 389 | 'of_oxm_metadata' : { 'value' : metadata }, |
| 390 | 'of_oxm_metadata_masked' : { 'value' : metadata, 'value_mask' : metadata }, |
Yotam Harchol | 5804f77 | 2013-08-21 17:35:31 -0700 | [diff] [blame] | 391 | |
| 392 | 'of_oxm_icmpv6_code' : { 'value' : u8obj }, |
| 393 | 'of_oxm_icmpv6_code_masked' : { 'value' : u8obj, 'value_mask' : u8obj }, |
| 394 | 'of_oxm_icmpv6_type' : { 'value' : u8obj }, |
| 395 | 'of_oxm_icmpv6_type_masked' : { 'value' : u8obj, 'value_mask' : u8obj }, |
| 396 | 'of_oxm_mpls_label' : { 'value' : u32obj }, |
| 397 | 'of_oxm_mpls_label_masked' : { 'value' : u32obj, 'value_mask' : u32obj }, |
| 398 | 'of_oxm_mpls_tc' : { 'value' : u8obj }, |
| 399 | 'of_oxm_mpls_tc_masked' : { 'value' : u8obj, 'value_mask' : u8obj }, |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 400 | } |
| 401 | |
Andreas Wundsam | 7cfeac3 | 2013-09-17 13:53:48 -0700 | [diff] [blame] | 402 | |
| 403 | @memoize |
| 404 | def enum_java_types(): |
| 405 | enum_types = {} |
| 406 | |
| 407 | for protocol in of_g.ir.values(): |
| 408 | for enum in protocol.enums: |
| 409 | java_name = name_c_to_caps_camel(re.sub(r'_t$', "", enum.name)) |
| 410 | java_type = java_name if not enum.is_bitmask else "Set<{}>".format(java_name) |
| 411 | enum_types[enum.name] = \ |
| 412 | JType(java_type)\ |
| 413 | .op(read = "{}SerializerVer$version.readFrom(bb)".format(java_name), |
| 414 | write ="{}SerializerVer$version.writeTo(bb, $name)".format(java_name)) |
| 415 | return enum_types |
| 416 | |
Andreas Wundsam | 2be7da5 | 2013-08-22 07:34:25 -0700 | [diff] [blame] | 417 | def make_match_field_jtype(sub_type_name="?"): |
| 418 | return JType("MatchField<{}>".format(sub_type_name)) |
| 419 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 420 | |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 421 | # Create a default mapping for a list type. Type defauls to List<${java_mapping_of_name}> |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 422 | def make_standard_list_jtype(c_type): |
| 423 | m = re.match(r'list\(of_([a-zA-Z_]+)_t\)', c_type) |
| 424 | if not m: |
| 425 | raise Exception("Not a recgonized standard list type declaration: %s" % c_type) |
| 426 | base_name = m.group(1) |
| 427 | java_base_name = name_c_to_caps_camel(base_name) |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 428 | |
| 429 | # read op assumes the class has a public final static field READER that implements |
| 430 | # OFMessageReader<$class> i.e., can deserialize an instance of class from a ChannelBuffer |
| 431 | # write op assumes class implements Writeable |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 432 | return JType("List<OF%s>" % java_base_name) \ |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 433 | .op( |
| 434 | read= 'ChannelUtils.readList(bb, $length, OF%sVer$version.READER)' % java_base_name, \ |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 435 | write='ChannelUtils.writeList(bb, $name)') |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 436 | |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 437 | |
Andreas Wundsam | 7cfeac3 | 2013-09-17 13:53:48 -0700 | [diff] [blame] | 438 | |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 439 | #### main entry point for conversion of LOXI types (c_types) Java types. |
| 440 | # FIXME: This badly needs a refactoring |
| 441 | |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 442 | def convert_to_jtype(obj_name, field_name, c_type): |
| 443 | """ Convert from a C type ("uint_32") to a java type ("U32") |
| 444 | and return a JType object with the size, internal type, and marshalling functions""" |
| 445 | if obj_name in exceptions and field_name in exceptions[obj_name]: |
| 446 | return exceptions[obj_name][field_name] |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 447 | elif ( obj_name == "of_header" or loxi_utils.class_is_message(obj_name)) and field_name == "type" and c_type == "uint8_t": |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 448 | return JType("OFType", 'byte') \ |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 449 | .op(read='bb.readByte()', write='bb.writeByte($name)') |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 450 | elif field_name == "type" and re.match(r'of_action.*', obj_name): |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 451 | return JType("OFActionType", 'short') \ |
Andreas Wundsam | 46d230f | 2013-08-02 22:24:06 -0700 | [diff] [blame] | 452 | .op(read='bb.readShort()', write='bb.writeShort($name)', pub_type=False)\ |
| 453 | .op(read="OFActionTypeSerializerVer$version.readFrom(bb)", write="OFActionTypeSerializerVer$version.writeTo(bb, $name)", pub_type=True) |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 454 | elif field_name == "version" and c_type == "uint8_t": |
Andreas Wundsam | 2bf357c | 2013-08-03 22:50:40 -0700 | [diff] [blame] | 455 | return JType("OFVersion", 'byte') \ |
Yotam Harchol | d7b8420 | 2013-07-26 16:08:10 -0700 | [diff] [blame] | 456 | .op(read='bb.readByte()', write='bb.writeByte($name)') |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 457 | elif c_type in default_mtype_to_jtype_convert_map: |
| 458 | return default_mtype_to_jtype_convert_map[c_type] |
| 459 | elif re.match(r'list\(of_([a-zA-Z_]+)_t\)', c_type): |
| 460 | return make_standard_list_jtype(c_type) |
Andreas Wundsam | 7cfeac3 | 2013-09-17 13:53:48 -0700 | [diff] [blame] | 461 | elif c_type in enum_java_types(): |
| 462 | return enum_java_types()[c_type] |
Andreas Wundsam | 2730346 | 2013-07-16 12:52:35 -0700 | [diff] [blame] | 463 | else: |
| 464 | print "WARN: Couldn't find java type conversion for '%s' in %s:%s" % (c_type, obj_name, field_name) |
| 465 | jtype = name_c_to_caps_camel(re.sub(r'_t$', "", c_type)) |
| 466 | return JType(jtype) |
Andreas Wundsam | d8bcedf | 2013-08-03 21:23:37 -0700 | [diff] [blame] | 467 | |
| 468 | |
| 469 | #### Enum specific wiretype definitions |
| 470 | enum_wire_types = { |
| 471 | "uint8_t": JType("byte").op(read="bb.readByte()", write="bb.writeByte($name)"), |
| 472 | "uint16_t": JType("short").op(read="bb.readShort()", write="bb.writeShort($name)"), |
| 473 | "uint32_t": JType("int").op(read="bb.readInt()", write="bb.writeInt($name)"), |
| 474 | "uint64_t": JType("long").op(read="bb.readLong()", write="bb.writeLong($name)"), |
| 475 | } |
| 476 | |
| 477 | def convert_enum_wire_type_to_jtype(wire_type): |
| 478 | return enum_wire_types[wire_type] |