aboutsummaryrefslogtreecommitdiff
path: root/build-aux/extract-ofp-errors
blob: c34888fc9aad7f5676c0a4a02d2f6ff2a7b421e9 (plain)
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
#! /usr/bin/python

import sys
import os.path
import re

macros = {}

token = None
line = ""
idRe = "[a-zA-Z_][a-zA-Z_0-9]*"
tokenRe = "#?" + idRe + "|[0-9]+|."
inComment = False
inDirective = False
def getToken():
    global token
    global line
    global inComment
    global inDirective
    while True:
        line = line.lstrip()
        if line != "":
            if line.startswith("/*"):
                inComment = True
                line = line[2:]
            elif inComment:
                commentEnd = line.find("*/")
                if commentEnd < 0:
                    line = ""
                else:
                    inComment = False
                    line = line[commentEnd + 2:]
            else:
                match = re.match(tokenRe, line)
                token = match.group(0)
                line = line[len(token):]
                if token.startswith('#'):
                    inDirective = True
                elif token in macros and not inDirective:
                    line = macros[token] + line
                    continue
                return True
        elif inDirective:
            token = "$"
            inDirective = False
            return True
        else:
            global lineNumber
            line = inputFile.readline()
            lineNumber += 1
            while line.endswith("\\\n"):
                line = line[:-2] + inputFile.readline()
                lineNumber += 1
            if line == "":
                if token == None:
                    fatal("unexpected end of input")
                token = None
                return False

def fatal(msg):
    sys.stderr.write("%s:%d: error at \"%s\": %s\n" % (fileName, lineNumber, token, msg))
    sys.exit(1)

def skipDirective():
    getToken()
    while token != '$':
        getToken()

def isId(s):
    return re.match(idRe + "$", s) != None

def forceId():
    if not isId(token):
        fatal("identifier expected")

def forceInteger():
    if not re.match('[0-9]+$', token):
        fatal("integer expected")

def match(t):
    if token == t:
        getToken()
        return True
    else:
        return False

def forceMatch(t):
    if not match(t):
        fatal("%s expected" % t)

def parseTaggedName():
    assert token in ('struct', 'union')
    name = token
    getToken()
    forceId()
    name = "%s %s" % (name, token)
    getToken()
    return name

def print_enum(tag, constants, storage_class):
    print """
%(storage_class)sconst char *
%(tag)s_to_string(uint16_t value)
{
    switch (value) {\
""" % {"tag": tag,
       "bufferlen": len(tag) + 32,
       "storage_class": storage_class}
    for constant in constants:
        print "    case %s: return \"%s\";" % (constant, constant)
    print """\
    }
    return NULL;
}\
""" % {"tag": tag}

def usage():
    argv0 = os.path.basename(sys.argv[0])
    print '''\
%(argv0)s, for extracting OpenFlow error codes from header files
usage: %(argv0)s FILE [FILE...]

This program reads the header files specified on the command line and
outputs a C source file for translating OpenFlow error codes into
strings, for use as lib/ofp-errors.c in the Open vSwitch source tree.

This program is specialized for reading include/openflow/openflow.h
and include/openflow/nicira-ext.h.  It will not work on arbitrary
header files without extensions.''' % {"argv0": argv0}
    sys.exit(0)

def extract_ofp_errors(filenames):
    error_types = {}

    global fileName
    for fileName in filenames:
        global inputFile
        global lineNumber
        inputFile = open(fileName)
        lineNumber = 0
        while getToken():
            if token in ("#ifdef", "#ifndef", "#include",
                         "#endif", "#elif", "#else", '#define'):
                skipDirective()
            elif match('enum'):
                forceId()
                enum_tag = token
                getToken()

                forceMatch("{")

                constants = []
                while isId(token):
                    constants.append(token)
                    getToken()
                    if match('='):
                        while token != ',' and token != '}':
                            getToken()
                    match(',')

                forceMatch('}')

                if enum_tag == "ofp_error_type":
                    error_types = {}
                    for error_type in constants:
                        error_types[error_type] = []
                elif enum_tag == 'nx_vendor_code':
                    pass
                elif enum_tag.endswith('_code'):
                    error_type = 'OFPET_%s' % '_'.join(enum_tag.split('_')[1:-1]).upper()
                    if error_type not in error_types:
                        fatal("enum %s looks like an error code enumeration but %s is unknown" % (enum_tag, error_type))
                    error_types[error_type] += constants
            elif token in ('struct', 'union'):
                getToken()
                forceId()
                getToken()
                forceMatch('{')
                while not match('}'):
                    getToken()
            elif match('OFP_ASSERT') or match('BOOST_STATIC_ASSERT'):
                while token != ';':
                    getToken()
            else:
                fatal("parse error")
        inputFile.close()

    print "/* -*- buffer-read-only: t -*- */"
    print "#include <config.h>"
    print '#include "ofp-errors.h"'
    print "#include <inttypes.h>"
    print "#include <stdio.h>"
    for fileName in sys.argv[1:]:
        print '#include "%s"' % fileName
    print '#include "type-props.h"'

    for error_type, constants in sorted(error_types.items()):
        tag = 'ofp_%s_code' % re.sub('^OFPET_', '', error_type).lower()
        print_enum(tag, constants, "static ")
    print_enum("ofp_error_type", error_types.keys(), "")
    print """
const char *
ofp_error_code_to_string(uint16_t type, uint16_t code)
{
    switch (type) {\
"""
    for error_type in error_types:
        tag = 'ofp_%s_code' % re.sub('^OFPET_', '', error_type).lower()
        print "    case %s:" % error_type
        print "        return %s_to_string(code);" % tag
    print """\
    }
    return NULL;
}\
"""

if __name__ == '__main__':
    if '--help' in sys.argv:
        usage()
    elif len(sys.argv) < 2:
        sys.stderr.write("at least one non-option argument required; "
                         "use --help for help\n")
        sys.exit(1)
    else:
        extract_ofp_errors(sys.argv[1:])