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
|
# C generation
import datetime
import os
import time
datestring = datetime.datetime.utcfromtimestamp(
int(os.environ.get('SOURCE_DATE_EPOCH', time.time())))
input_filename = 'inputfil'
top_boilerplate = '''\
/*
* VLIB API definitions {datestring}
* Input file: {input_filename}
* Automatically generated: please edit the input file NOT this file!
*/
#include <stdbool.h>
#if defined(vl_msg_id)||defined(vl_union_id) \\
|| defined(vl_printfun) ||defined(vl_endianfun) \\
|| defined(vl_api_version)||defined(vl_typedefs) \\
|| defined(vl_msg_name)||defined(vl_msg_name_crc_list) \\
|| defined(vl_api_version_tuple)
/* ok, something was selected */
#else
#warning no content included from {input_filename}
#endif
#define VL_API_PACKED(x) x __attribute__ ((packed))
'''
bottom_boilerplate = '''\
/****** API CRC (whole file) *****/
#ifdef vl_api_version
vl_api_version({input_filename}, {file_crc:#08x})
#endif
'''
def msg_ids(s):
output = '''\
/****** Message ID / handler enum ******/
#ifdef vl_msg_id
'''
for t in s['Define']:
output += "vl_msg_id(VL_API_%s, vl_api_%s_t_handler)\n" % \
(t.name.upper(), t.name)
output += "#endif"
return output
def msg_names(s):
output = '''\
/****** Message names ******/
#ifdef vl_msg_name
'''
for t in s['Define']:
dont_trace = 0 if t.dont_trace else 1
output += "vl_msg_name(vl_api_%s_t, %d)\n" % (t.name, dont_trace)
output += "#endif"
return output
def msg_name_crc_list(s, suffix):
output = '''\
/****** Message name, crc list ******/
#ifdef vl_msg_name_crc_list
'''
output += "#define foreach_vl_msg_name_crc_%s " % suffix
for t in s['Define']:
output += "\\\n_(VL_API_%s, %s, %08x) " % \
(t.name.upper(), t.name, t.crc)
output += "\n#endif"
return output
def duplicate_wrapper_head(name):
s = "#ifndef _vl_api_defined_%s\n" % name
s += "#define _vl_api_defined_%s\n" % name
return s
def duplicate_wrapper_tail():
return '#endif\n\n'
def api2c(fieldtype):
mappingtable = {'string': 'vl_api_string_t', }
if fieldtype in mappingtable:
return mappingtable[fieldtype]
return fieldtype
def typedefs(objs, filename):
name = filename.replace('.', '_')
output = '''\
/****** Typedefs ******/
#ifdef vl_typedefs
#ifndef included_{module}
#define included_{module}
'''
output = output.format(module=name)
for o in objs:
tname = o.__class__.__name__
output += duplicate_wrapper_head(o.name)
if tname == 'Using':
if 'length' in o.alias:
output += 'typedef %s vl_api_%s_t[%s];\n' % (o.alias['type'], o.name, o.alias['length'])
else:
output += 'typedef %s vl_api_%s_t;\n' % (o.alias['type'], o.name)
elif tname == 'Enum':
if o.enumtype == 'u32':
output += "typedef enum {\n"
else:
output += "typedef enum __attribute__((__packed__)) {\n"
for b in o.block:
output += " %s = %s,\n" % (b[0], b[1])
output += '} vl_api_%s_t;\n' % o.name
if o.enumtype != 'u32':
size1 = 'sizeof(vl_api_%s_t)' % o.name
size2 = 'sizeof(%s)' % o.enumtype
err_str = 'size of API enum %s is wrong' % o.name
output += 'STATIC_ASSERT(%s == %s, "%s");\n' % (size1, size2, err_str)
else:
if tname == 'Union':
output += "typedef VL_API_PACKED(union _vl_api_%s {\n" % o.name
else:
output += "typedef VL_API_PACKED(struct _vl_api_%s {\n" % o.name
for b in o.block:
if b.type == 'Field':
output += " %s %s;\n" % (api2c(b.fieldtype), b.fieldname)
elif b.type == 'Array':
if b.lengthfield:
output += " %s %s[0];\n" % (api2c(b.fieldtype), b.fieldname)
else:
# Fixed length strings decay to nul terminated u8
if b.fieldtype == 'string':
if b.modern_vla:
output += ' {} {};\n'.format(api2c(b.fieldtype), b.fieldname)
else:
output += ' u8 {}[{}];\n'.format(b.fieldname, b.length)
else:
output += " %s %s[%s];\n" % (api2c(b.fieldtype), b.fieldname,
b.length)
else:
raise ValueError("Error in processing array type %s" % b)
output += '}) vl_api_%s_t;\n' % o.name
output += duplicate_wrapper_tail()
output += "\n#endif"
output += "\n#endif\n\n"
return output
format_strings = {'u8': '%u',
'i8': '%d',
'u16': '%u',
'i16': '%d',
'u32': '%u',
'i32': '%ld',
'u64': '%llu',
'i64': '%llu',
'f64': '%.2f', }
def printfun(objs):
output = '''\
/****** Print functions *****/
#ifdef vl_printfun
#ifdef LP64
#define _uword_fmt \"%lld\"
#define _uword_cast (long long)
#else
#define _uword_fmt \"%ld\"
#define _uword_cast long
#endif
'''
for t in objs:
if t.__class__.__name__ == 'Enum':
continue
if t.manual_print:
output += "/***** manual: vl_api_%s_t_print *****/\n\n" % t.name
continue
output += duplicate_wrapper_head(t.name + '_t_print')
output += "static inline void *vl_api_%s_t_print (vl_api_%s_t *a," % \
(t.name, t.name)
output += "void *handle)\n{\n"
output += " vl_print(handle, \"vl_api_%s_t:\\n\");\n" % t.name
for o in t.block:
if o.type != 'Field':
continue
if o.fieldtype in format_strings:
output += " vl_print(handle, \"%s: %s\\n\", a->%s);\n" % \
(o.fieldname, format_strings[o.fieldtype],
o.fieldname)
output += ' return handle;\n'
output += '}\n\n'
output += duplicate_wrapper_tail()
output += "\n#endif /* vl_printfun */\n"
return output
endian_strings = {
'u16': 'clib_net_to_host_u16',
'u32': 'clib_net_to_host_u32',
'u64': 'clib_net_to_host_u64',
'i16': 'clib_net_to_host_i16',
'i32': 'clib_net_to_host_i32',
'i64': 'clib_net_to_host_i64',
'f64': 'clib_net_to_host_f64',
}
def endianfun(objs):
output = '''\
/****** Endian swap functions *****/\n\
#ifdef vl_endianfun
#undef clib_net_to_host_uword
#ifdef LP64
#define clib_net_to_host_uword clib_net_to_host_u64
#else
#define clib_net_to_host_uword clib_net_to_host_u32
#endif
'''
for t in objs:
if t.__class__.__name__ == 'Enum':
continue
if t.manual_endian:
output += "/***** manual: vl_api_%s_t_endian *****/\n\n" % t.name
continue
output += duplicate_wrapper_head(t.name + '_t_endian')
output += "static inline void vl_api_%s_t_endian (vl_api_%s_t *a)" % \
(t.name, t.name)
output += "\n{\n"
for o in t.block:
if o.type != 'Field':
continue
if o.fieldtype in endian_strings:
output += " a->%s = %s(a->%s);\n" % \
(o.fieldname, endian_strings[o.fieldtype], o.fieldname)
else:
output += " /* a->%s = a->%s (no-op) */\n" % \
(o.fieldname, o.fieldname)
output += '}\n\n'
output += duplicate_wrapper_tail()
output += "\n#endif /* vl_endianfun */\n\n"
return output
def version_tuple(s, module):
output = '''\
/****** Version tuple *****/
#ifdef vl_api_version_tuple
'''
if 'version' in s['Option']:
v = s['Option']['version']
(major, minor, patch) = v.split('.')
output += "vl_api_version_tuple(%s, %s, %s, %s)\n" % \
(module, major, minor, patch)
output += "\n#endif /* vl_api_version_tuple */\n\n"
return output
#
# Plugin entry point
#
def run(input_filename, s):
basename = os.path.basename(input_filename)
filename, file_extension = os.path.splitext(basename)
output = top_boilerplate.format(datestring=datestring,
input_filename=basename)
output += msg_ids(s)
output += msg_names(s)
output += msg_name_crc_list(s, filename)
output += typedefs(s['types'] + s['Define'], filename + file_extension)
output += printfun(s['types'] + s['Define'])
output += endianfun(s['types'] + s['Define'])
output += version_tuple(s, basename)
output += bottom_boilerplate.format(input_filename=basename,
file_crc=s['file_crc'])
return output
|
