1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
|
#! /usr/bin/python
import sys
import os.path
import re
line = ""
# Maps from user-friendly version number to its protocol encoding.
VERSION = {"1.0": 0x01,
"1.1": 0x02,
"1.2": 0x03,
"1.3": 0x04,
"1.4": 0x05,
"1.5": 0x06}
NX_VENDOR_ID = 0x00002320
OFPT_VENDOR = 4
OFPT10_STATS_REQUEST = 16
OFPT10_STATS_REPLY = 17
OFPT11_STATS_REQUEST = 18
OFPT11_STATS_REPLY = 19
OFPST_VENDOR = 0xffff
def decode_version_range(range):
if range in VERSION:
return (VERSION[range], VERSION[range])
elif range.endswith('+'):
return (VERSION[range[:-1]], max(VERSION.values()))
elif range == '<all>':
return (0x01, 0xff)
else:
a, b = re.match(r'^([^-]+)-([^-]+)$', range).groups()
return (VERSION[a], VERSION[b])
def get_line():
global line
global line_number
line = input_file.readline()
line_number += 1
if line == "":
fatal("unexpected end of input")
n_errors = 0
def error(msg):
global n_errors
sys.stderr.write("%s:%d: %s\n" % (file_name, line_number, msg))
n_errors += 1
def fatal(msg):
error(msg)
sys.exit(1)
def usage():
argv0 = os.path.basename(sys.argv[0])
print '''\
%(argv0)s, for extracting OpenFlow message types from header files
usage: %(argv0)s INPUT OUTPUT
where INPUT is the name of the input header file
and OUTPUT is the output file name.
Despite OUTPUT, the output is written to stdout, and the OUTPUT argument
only controls #line directives in the output.\
''' % {"argv0": argv0}
sys.exit(0)
def make_sizeof(s):
m = re.match(r'(.*) up to (.*)', s)
if m:
struct, member = m.groups()
return "offsetof(%s, %s)" % (struct, member)
else:
return "sizeof(%s)" % s
def extract_ofp_msgs(output_file_name):
raw_types = []
all_hdrs = {}
all_raws = {}
all_raws_order = []
while True:
get_line()
if re.match('enum ofpraw', line):
break
while True:
get_line()
first_line_number = line_number
here = '%s:%d' % (file_name, line_number)
if (line.startswith('/*')
or line.startswith(' *')
or not line
or line.isspace()):
continue
elif re.match('}', line):
break
if not line.lstrip().startswith('/*'):
fatal("unexpected syntax between ofpraw types")
comment = line.lstrip()[2:].strip()
while not comment.endswith('*/'):
get_line()
if line.startswith('/*') or not line or line.isspace():
fatal("unexpected syntax within error")
comment += ' %s' % line.lstrip('* \t').rstrip(' \t\r\n')
comment = comment[:-2].rstrip()
m = re.match(r'([A-Z]+) ([-.+\d]+|<all>) \((\d+)\): ([^.]+)\.$', comment)
if not m:
fatal("unexpected syntax between messages")
type_, versions, number, contents = m.groups()
number = int(number)
get_line()
m = re.match('\s+(?:OFPRAW_%s)(\d*)_([A-Z0-9_]+),?$' % type_,
line)
if not m:
fatal("syntax error expecting OFPRAW_ enum")
vinfix, name = m.groups()
rawname = 'OFPRAW_%s%s_%s' % (type_, vinfix, name)
min_version, max_version = decode_version_range(versions)
human_name = '%s_%s' % (type_, name)
if type_.endswith('ST'):
if rawname.endswith('_REQUEST'):
human_name = human_name[:-8] + " request"
elif rawname.endswith('_REPLY'):
human_name = human_name[:-6] + " reply"
else:
fatal("%s messages are statistics but %s doesn't end "
"in _REQUEST or _REPLY" % (type_, rawname))
these_hdrs = []
for version in range(min_version, max_version + 1):
if type_ == 'OFPT':
if number == OFPT_VENDOR:
fatal("OFPT (%d) is used for vendor extensions"
% number)
elif (version == VERSION["1.0"]
and (number == OFPT10_STATS_REQUEST
or number == OFPT10_STATS_REPLY)):
fatal("OFPT 1.0 (%d) is used for stats messages"
% number)
elif (version != VERSION["1.0"]
and (number == OFPT11_STATS_REQUEST
or number == OFPT11_STATS_REPLY)):
fatal("OFPT 1.1+ (%d) is used for stats messages"
% number)
hdrs = (version, number, 0, 0, 0)
elif type_ == 'OFPST' and name.endswith('_REQUEST'):
if version == VERSION["1.0"]:
hdrs = (version, OFPT10_STATS_REQUEST, number, 0, 0)
else:
hdrs = (version, OFPT11_STATS_REQUEST, number, 0, 0)
elif type_ == 'OFPST' and name.endswith('_REPLY'):
if version == VERSION["1.0"]:
hdrs = (version, OFPT10_STATS_REPLY, number, 0, 0)
else:
hdrs = (version, OFPT11_STATS_REPLY, number, 0, 0)
elif type_ == 'NXT':
hdrs = (version, OFPT_VENDOR, 0, NX_VENDOR_ID, number)
elif type_ == 'NXST' and name.endswith('_REQUEST'):
if version == VERSION["1.0"]:
hdrs = (version, OFPT10_STATS_REQUEST, OFPST_VENDOR,
NX_VENDOR_ID, number)
else:
hdrs = (version, OFPT11_STATS_REQUEST, OFPST_VENDOR,
NX_VENDOR_ID, number)
elif type_ == 'NXST' and name.endswith('_REPLY'):
if version == VERSION["1.0"]:
hdrs = (version, OFPT10_STATS_REPLY, OFPST_VENDOR,
NX_VENDOR_ID, number)
else:
hdrs = (version, OFPT11_STATS_REPLY, OFPST_VENDOR,
NX_VENDOR_ID, number)
else:
fatal("type '%s' unknown" % type_)
if hdrs in all_hdrs:
error("Duplicate message definition for %s." % str(hdrs))
sys.stderr.write("%s: Here is the location "
"of the previous definition.\n"
% (all_hdrs[hdrs]))
all_hdrs[hdrs] = here
these_hdrs.append(hdrs)
extra_multiple = '0'
if contents == 'void':
min_body = '0'
else:
min_body_elem = []
for c in [s.strip() for s in contents.split(",")]:
if c.endswith('[]'):
if extra_multiple == '0':
extra_multiple = make_sizeof(c[:-2])
else:
error("Cannot have multiple [] elements")
else:
min_body_elem.append(c)
if min_body_elem:
min_body = " + ".join([make_sizeof(s)
for s in min_body_elem])
else:
if extra_multiple == '0':
error("Must specify contents (use 'void' if empty)")
min_body = 0
if rawname in all_raws:
fatal("%s: Duplicate name" % rawname)
all_raws[rawname] = {"hdrs": these_hdrs,
"min_version": min_version,
"max_version": max_version,
"min_body": min_body,
"extra_multiple": extra_multiple,
"type": type_,
"human_name": human_name,
"line": first_line_number}
all_raws_order.append(rawname)
continue
while True:
get_line()
if re.match('enum ofptype', line):
break
while True:
get_line()
if re.match(r'\s*/?\*', line) or line.isspace():
continue
elif re.match('}', line):
break
if not re.match(r'\s*OFPTYPE_.*/\*', line):
fatal("unexpected syntax between OFPTYPE_ definitions")
syntax = line.strip()
while not syntax.endswith('*/'):
get_line()
if not line.strip().startswith('*'):
fatal("unexpected syntax within OFPTYPE_ definition")
syntax += ' %s' % line.strip().lstrip('* \t')
syntax = syntax.strip()
m = re.match(r'(OFPTYPE_[A-Z0-9_]+),\s*/\* (.*) \*/', syntax)
if not m:
fatal("syntax error in OFPTYPE_ definition")
ofptype, raws_ = m.groups()
raws = [s.rstrip('.') for s in raws_.split()]
for raw in raws:
if not re.match('OFPRAW_[A-Z0-9_]+$', raw):
fatal("%s: invalid OFPRAW_* name syntax" % raw)
if raw not in all_raws:
fatal("%s: not a declared OFPRAW_* name" % raw)
if "ofptype" in all_raws[raw]:
fatal("%s: already part of %s"
% (raw, all_raws[raw]["ofptype"]))
all_raws[raw]["ofptype"] = ofptype
input_file.close()
if n_errors:
sys.exit(1)
output = []
output.append("/* Generated automatically; do not modify! "
"-*- buffer-read-only: t -*- */")
output.append("")
for raw in all_raws_order:
r = all_raws[raw]
output.append("static struct raw_instance %s_instances[] = {"
% raw.lower())
for hdrs in r['hdrs']:
output.append(" { {0, NULL}, {%d, %d, %d, 0x%x, %d}, %s, 0 },"
% (hdrs + (raw,)))
output.append("};")
output.append("")
output.append("static struct raw_info raw_infos[] = {")
for raw in all_raws_order:
r = all_raws[raw]
if "ofptype" not in r:
error("%s: no defined OFPTYPE_" % raw)
continue
output.append(" {")
output.append(" %s_instances," % raw.lower())
output.append(" %d, %d," % (r["min_version"], r["max_version"]))
output.append("#line %s \"%s\"" % (r["line"], file_name))
output.append(" %s," % r["min_body"])
output.append("#line %s \"%s\"" % (r["line"], file_name))
output.append(" %s," % r["extra_multiple"])
output.append("#line %s \"%s\"" % (len(output) + 2, output_file_name))
output.append(" %s," % r["ofptype"])
output.append(" \"%s\"," % r["human_name"])
output.append(" },")
if r['type'].endswith("ST"):
for hdrs in r['hdrs']:
op_hdrs = list(hdrs)
if hdrs[0] == VERSION["1.0"]:
if hdrs[1] == OFPT10_STATS_REQUEST:
op_hdrs[1] = OFPT10_STATS_REPLY
elif hdrs[1] == OFPT10_STATS_REPLY:
op_hdrs[1] = OFPT10_STATS_REQUEST
else:
assert False
else:
if hdrs[1] == OFPT11_STATS_REQUEST:
op_hdrs[1] = OFPT11_STATS_REPLY
elif hdrs[1] == OFPT11_STATS_REPLY:
op_hdrs[1] = OFPT11_STATS_REQUEST
else:
assert False
if tuple(op_hdrs) not in all_hdrs:
if r["human_name"].endswith("request"):
fatal("%s has no corresponding reply"
% r["human_name"])
else:
fatal("%s has no corresponding request"
% r["human_name"])
output.append("};")
if n_errors:
sys.exit(1)
return output
if __name__ == '__main__':
if '--help' in sys.argv:
usage()
elif len(sys.argv) != 3:
sys.stderr.write("exactly one non-option arguments required; "
"use --help for help\n")
sys.exit(1)
else:
global file_name
global input_file
global line_number
file_name = sys.argv[1]
input_file = open(file_name)
line_number = 0
for line in extract_ofp_msgs(sys.argv[2]):
print line
|