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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
|
## The contents of this file are subject to the Mozilla Public License
## Version 1.1 (the "License"); you may not use this file except in
## compliance with the License. You may obtain a copy of the License at
## http://www.mozilla.org/MPL/
##
## Software distributed under the License is distributed on an "AS IS"
## basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
## License for the specific language governing rights and limitations
## under the License.
##
## The Original Code is RabbitMQ.
##
## The Initial Developers of the Original Code are LShift Ltd,
## Cohesive Financial Technologies LLC, and Rabbit Technologies Ltd.
##
## Portions created before 22-Nov-2008 00:00:00 GMT by LShift Ltd,
## Cohesive Financial Technologies LLC, or Rabbit Technologies Ltd
## are Copyright (C) 2007-2008 LShift Ltd, Cohesive Financial
## Technologies LLC, and Rabbit Technologies Ltd.
##
## Portions created by LShift Ltd are Copyright (C) 2007-2010 LShift
## Ltd. Portions created by Cohesive Financial Technologies LLC are
## Copyright (C) 2007-2010 Cohesive Financial Technologies
## LLC. Portions created by Rabbit Technologies Ltd are Copyright
## (C) 2007-2010 Rabbit Technologies Ltd.
##
## All Rights Reserved.
##
## Contributor(s): ______________________________________.
##
from __future__ import nested_scopes
import sys
sys.path.append("../rabbitmq-codegen") # in case we're next to an experimental revision
sys.path.append("codegen") # in case we're building from a distribution package
from amqp_codegen import *
import string
import re
erlangTypeMap = {
'octet': 'octet',
'shortstr': 'shortstr',
'longstr': 'longstr',
'short': 'shortint',
'long': 'longint',
'longlong': 'longlongint',
'bit': 'bit',
'table': 'table',
'timestamp': 'timestamp',
}
# Coming up with a proper encoding of AMQP tables in JSON is too much
# hassle at this stage. Given that the only default value we are
# interested in is for the empty table, we only support that.
def convertTable(d):
if len(d) == 0:
return "[]"
else: raise 'Non-empty table defaults not supported', d
erlangDefaultValueTypeConvMap = {
bool : lambda x: str(x).lower(),
str : lambda x: "<<\"" + x + "\">>",
int : lambda x: str(x),
float : lambda x: str(x),
dict: convertTable,
unicode: lambda x: "<<\"" + x.encode("utf-8") + "\">>"
}
def erlangize(s):
s = s.replace('-', '_')
s = s.replace(' ', '_')
return s
AmqpMethod.erlangName = lambda m: "'" + erlangize(m.klass.name) + '.' + erlangize(m.name) + "'"
def erlangConstantName(s):
return '_'.join(re.split('[- ]', s.upper()))
class PackedMethodBitField:
def __init__(self, index):
self.index = index
self.domain = 'bit'
self.contents = []
def extend(self, f):
self.contents.append(f)
def count(self):
return len(self.contents)
def full(self):
return self.count() == 8
def multiLineFormat(things, prologue, separator, lineSeparator, epilogue, thingsPerLine = 4):
r = [prologue]
i = 0
for t in things:
if i != 0:
if i % thingsPerLine == 0:
r += [lineSeparator]
else:
r += [separator]
r += [t]
i += 1
r += [epilogue]
return "".join(r)
def prettyType(typeName, subTypes, typesPerLine = 4):
"""Pretty print a type signature made up of many alternative subtypes"""
sTs = multiLineFormat(subTypes,
"( ", " | ", "\n | ", " )",
thingsPerLine = typesPerLine)
return "-type(%s ::\n %s)." % (typeName, sTs)
def printFileHeader():
print """%% Autogenerated code. Do not edit.
%%
%% The contents of this file are subject to the Mozilla Public License
%% Version 1.1 (the "License"); you may not use this file except in
%% compliance with the License. You may obtain a copy of the License at
%% http://www.mozilla.org/MPL/
%%
%% Software distributed under the License is distributed on an "AS IS"
%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
%% License for the specific language governing rights and limitations
%% under the License.
%%
%% The Original Code is RabbitMQ.
%%
%% The Initial Developers of the Original Code are LShift Ltd,
%% Cohesive Financial Technologies LLC, and Rabbit Technologies Ltd.
%%
%% Portions created before 22-Nov-2008 00:00:00 GMT by LShift Ltd,
%% Cohesive Financial Technologies LLC, or Rabbit Technologies Ltd
%% are Copyright (C) 2007-2008 LShift Ltd, Cohesive Financial
%% Technologies LLC, and Rabbit Technologies Ltd.
%%
%% Portions created by LShift Ltd are Copyright (C) 2007-2010 LShift
%% Ltd. Portions created by Cohesive Financial Technologies LLC are
%% Copyright (C) 2007-2010 Cohesive Financial Technologies
%% LLC. Portions created by Rabbit Technologies Ltd are Copyright
%% (C) 2007-2010 Rabbit Technologies Ltd.
%%
%% All Rights Reserved.
%%
%% Contributor(s): ______________________________________.
%%"""
def genErl(spec):
def erlType(domain):
return erlangTypeMap[spec.resolveDomain(domain)]
def fieldTypeList(fields):
return '[' + ', '.join([erlType(f.domain) for f in fields]) + ']'
def fieldNameList(fields):
return '[' + ', '.join([erlangize(f.name) for f in fields]) + ']'
def fieldTempList(fields):
return '[' + ', '.join(['F' + str(f.index) for f in fields]) + ']'
def fieldMapList(fields):
return ', '.join([erlangize(f.name) + " = F" + str(f.index) for f in fields])
def genLookupMethodName(m):
print "lookup_method_name({%d, %d}) -> %s;" % (m.klass.index, m.index, m.erlangName())
def genMethodId(m):
print "method_id(%s) -> {%d, %d};" % (m.erlangName(), m.klass.index, m.index)
def genMethodHasContent(m):
print "method_has_content(%s) -> %s;" % (m.erlangName(), str(m.hasContent).lower())
def genMethodIsSynchronous(m):
hasNoWait = "nowait" in fieldNameList(m.arguments)
if m.isSynchronous and hasNoWait:
print "is_method_synchronous(#%s{nowait = NoWait}) -> not(NoWait);" % (m.erlangName())
else:
print "is_method_synchronous(#%s{}) -> %s;" % (m.erlangName(), str(m.isSynchronous).lower())
def genMethodFieldTypes(m):
"""Not currently used - may be useful in future?"""
print "method_fieldtypes(%s) -> %s;" % (m.erlangName(), fieldTypeList(m.arguments))
def genMethodFieldNames(m):
print "method_fieldnames(%s) -> %s;" % (m.erlangName(), fieldNameList(m.arguments))
def packMethodFields(fields):
packed = []
bitfield = None
for f in fields:
if erlType(f.domain) == 'bit':
if not(bitfield) or bitfield.full():
bitfield = PackedMethodBitField(f.index)
packed.append(bitfield)
bitfield.extend(f)
else:
bitfield = None
packed.append(f)
return packed
def methodFieldFragment(f):
type = erlType(f.domain)
p = 'F' + str(f.index)
if type == 'shortstr':
return p+'Len:8/unsigned, '+p+':'+p+'Len/binary'
elif type == 'longstr':
return p+'Len:32/unsigned, '+p+':'+p+'Len/binary'
elif type == 'octet':
return p+':8/unsigned'
elif type == 'shortint':
return p+':16/unsigned'
elif type == 'longint':
return p+':32/unsigned'
elif type == 'longlongint':
return p+':64/unsigned'
elif type == 'timestamp':
return p+':64/unsigned'
elif type == 'bit':
return p+'Bits:8'
elif type == 'table':
return p+'Len:32/unsigned, '+p+'Tab:'+p+'Len/binary'
def genFieldPostprocessing(packed):
for f in packed:
type = erlType(f.domain)
if type == 'bit':
for index in range(f.count()):
print " F%d = ((F%dBits band %d) /= 0)," % \
(f.index + index,
f.index,
1 << index)
elif type == 'table':
print " F%d = rabbit_binary_parser:parse_table(F%dTab)," % \
(f.index, f.index)
elif type == 'shortstr':
print " if F%dLen > 255 -> exit(method_field_shortstr_overflow); true -> ok end," % (f.index)
else:
pass
def genMethodRecord(m):
print "method_record(%s) -> #%s{};" % (m.erlangName(), m.erlangName())
def genDecodeMethodFields(m):
packedFields = packMethodFields(m.arguments)
binaryPattern = ', '.join([methodFieldFragment(f) for f in packedFields])
if binaryPattern:
restSeparator = ', '
else:
restSeparator = ''
recordConstructorExpr = '#%s{%s}' % (m.erlangName(), fieldMapList(m.arguments))
print "decode_method_fields(%s, <<%s>>) ->" % (m.erlangName(), binaryPattern)
genFieldPostprocessing(packedFields)
print " %s;" % (recordConstructorExpr,)
def genDecodeProperties(c):
print "decode_properties(%d, PropBin) ->" % (c.index)
print " %s = rabbit_binary_parser:parse_properties(%s, PropBin)," % \
(fieldTempList(c.fields), fieldTypeList(c.fields))
print " #'P_%s'{%s};" % (erlangize(c.name), fieldMapList(c.fields))
def genFieldPreprocessing(packed):
for f in packed:
type = erlType(f.domain)
if type == 'bit':
print " F%dBits = (%s)," % \
(f.index,
' bor '.join(['(bitvalue(F%d) bsl %d)' % (x.index, x.index - f.index)
for x in f.contents]))
elif type == 'table':
print " F%dTab = rabbit_binary_generator:generate_table(F%d)," % (f.index, f.index)
print " F%dLen = size(F%dTab)," % (f.index, f.index)
elif type == 'shortstr':
print " F%dLen = size(F%d)," % (f.index, f.index)
print " if F%dLen > 255 -> exit(method_field_shortstr_overflow); true -> ok end," % (f.index)
elif type == 'longstr':
print " F%dLen = size(F%d)," % (f.index, f.index)
else:
pass
def genEncodeMethodFields(m):
packedFields = packMethodFields(m.arguments)
print "encode_method_fields(#%s{%s}) ->" % (m.erlangName(), fieldMapList(m.arguments))
genFieldPreprocessing(packedFields)
print " <<%s>>;" % (', '.join([methodFieldFragment(f) for f in packedFields]))
def genEncodeProperties(c):
print "encode_properties(#'P_%s'{%s}) ->" % (erlangize(c.name), fieldMapList(c.fields))
print " rabbit_binary_generator:encode_properties(%s, %s);" % \
(fieldTypeList(c.fields), fieldTempList(c.fields))
def messageConstantClass(cls):
# We do this because 0.8 uses "soft error" and 8.1 uses "soft-error".
return erlangConstantName(cls)
def genLookupException(c,v,cls):
mCls = messageConstantClass(cls)
if mCls == 'SOFT_ERROR': genLookupException1(c,'false')
elif mCls == 'HARD_ERROR': genLookupException1(c, 'true')
elif mCls == '': pass
else: raise 'Unknown constant class', cls
def genLookupException1(c,hardErrorBoolStr):
n = erlangConstantName(c)
print 'lookup_amqp_exception(%s) -> {%s, ?%s, <<"%s">>};' % \
(n.lower(), hardErrorBoolStr, n, n)
def genAmqpException(c,v,cls):
n = erlangConstantName(c)
print 'amqp_exception(?%s) -> %s;' % \
(n, n.lower())
methods = spec.allMethods()
printFileHeader()
module = "rabbit_framing_amqp_%d_%d" % (spec.major, spec.minor)
if spec.revision != 0:
module = "%s_%d" % (module, spec.revision)
if module == "rabbit_framing_amqp_8_0":
module = "rabbit_framing_amqp_0_8"
print "-module(%s)." % module
print """-include("rabbit_framing.hrl").
-export([lookup_method_name/1]).
-export([method_id/1]).
-export([method_has_content/1]).
-export([is_method_synchronous/1]).
-export([method_record/1]).
-export([method_fieldnames/1]).
-export([decode_method_fields/2]).
-export([decode_properties/2]).
-export([encode_method_fields/1]).
-export([encode_properties/1]).
-export([lookup_amqp_exception/1]).
-export([amqp_exception/1]).
-export([version/0]).
bitvalue(true) -> 1;
bitvalue(false) -> 0;
bitvalue(undefined) -> 0.
%% Method signatures
-ifdef(use_specs).
-spec(lookup_method_name/1 :: (amqp_method()) -> amqp_method_name()).
-spec(method_id/1 :: (amqp_method_name()) -> amqp_method()).
-spec(method_has_content/1 :: (amqp_method_name()) -> boolean()).
-spec(is_method_synchronous/1 :: (amqp_method_record()) -> boolean()).
-spec(method_record/1 :: (amqp_method_name()) -> amqp_method_record()).
-spec(method_fieldnames/1 :: (amqp_method_name()) -> [amqp_method_field_name()]).
-spec(decode_method_fields/2 :: (amqp_method_name(), binary()) -> amqp_method_record()).
-spec(decode_properties/2 :: (non_neg_integer(), binary()) -> amqp_property_record()).
-spec(encode_method_fields/1 :: (amqp_method_record()) -> binary()).
-spec(encode_properties/1 :: (amqp_method_record()) -> binary()).
-spec(lookup_amqp_exception/1 :: (amqp_exception()) -> {boolean(), amqp_exception_code(), binary()}).
-spec(amqp_exception/1 :: (amqp_exception_code()) -> amqp_exception()).
-spec(version/0 :: () -> {integer, integer, integer}).
-endif. % use_specs
"""
for m in methods: genLookupMethodName(m)
print "lookup_method_name({_ClassId, _MethodId} = Id) -> exit({unknown_method_id, Id})."
for m in methods: genMethodId(m)
print "method_id(Name) -> exit({unknown_method_name, Name})."
for m in methods: genMethodHasContent(m)
print "method_has_content(Name) -> exit({unknown_method_name, Name})."
for m in methods: genMethodIsSynchronous(m)
print "is_method_synchronous(Name) -> exit({unknown_method_name, Name})."
for m in methods: genMethodRecord(m)
print "method_record(Name) -> exit({unknown_method_name, Name})."
for m in methods: genMethodFieldNames(m)
print "method_fieldnames(Name) -> exit({unknown_method_name, Name})."
for m in methods: genDecodeMethodFields(m)
print "decode_method_fields(Name, BinaryFields) ->"
print " rabbit_misc:frame_error(Name, BinaryFields)."
for c in spec.allClasses(): genDecodeProperties(c)
print "decode_properties(ClassId, _BinaryFields) -> exit({unknown_class_id, ClassId})."
for m in methods: genEncodeMethodFields(m)
print "encode_method_fields(Record) -> exit({unknown_method_name, element(1, Record)})."
for c in spec.allClasses(): genEncodeProperties(c)
print "encode_properties(Record) -> exit({unknown_properties_record, Record})."
for (c,v,cls) in spec.constants: genLookupException(c,v,cls)
print "lookup_amqp_exception(Code) ->"
print " rabbit_log:warning(\"Unknown AMQP error code '~p'~n\", [Code]),"
print " {true, ?INTERNAL_ERROR, <<\"INTERNAL_ERROR\">>}."
for(c,v,cls) in spec.constants: genAmqpException(c,v,cls)
print "amqp_exception(_Code) -> undefined."
version = "{%d, %d, %d}" % (spec.major, spec.minor, spec.revision)
if version == '{8, 0, 0}': version = '{0, 8, 0}'
print "version() -> %s." % (version)
def genHrl(spec):
def erlType(domain):
return erlangTypeMap[spec.resolveDomain(domain)]
def fieldNameList(fields):
return ', '.join([erlangize(f.name) for f in fields])
def fieldNameListDefaults(fields):
def fillField(field):
result = erlangize(f.name)
if field.defaultvalue != None:
conv_fn = erlangDefaultValueTypeConvMap[type(field.defaultvalue)]
result += ' = ' + conv_fn(field.defaultvalue)
return result
return ', '.join([fillField(f) for f in fields])
methods = spec.allMethods()
printFileHeader()
print "-define(PROTOCOL_PORT, %d)." % (spec.port)
for (c,v,cls) in spec.constants:
print "-define(%s, %s)." % (erlangConstantName(c), v)
print "%% Method field records."
for m in methods:
print "-record(%s, {%s})." % (m.erlangName(), fieldNameListDefaults(m.arguments))
print "%% Class property records."
for c in spec.allClasses():
print "-record('P_%s', {%s})." % (erlangize(c.name), fieldNameList(c.fields))
print "-ifdef(use_specs)."
print "%% Various types"
print prettyType("amqp_method_name()",
[m.erlangName() for m in methods])
print prettyType("amqp_method()",
["{%s, %s}" % (m.klass.index, m.index) for m in methods],
6)
print prettyType("amqp_method_record()",
["#%s{}" % (m.erlangName()) for m in methods])
fieldNames = set()
for m in methods:
fieldNames.update(m.arguments)
fieldNames = [erlangize(f.name) for f in fieldNames]
print prettyType("amqp_method_field_name()",
fieldNames)
print prettyType("amqp_property_record()",
["#'P_%s'{}" % erlangize(c.name) for c in spec.allClasses()])
print prettyType("amqp_exception()",
["'%s'" % erlangConstantName(c).lower() for (c, v, cls) in spec.constants])
print prettyType("amqp_exception_code()",
["%i" % v for (c, v, cls) in spec.constants])
print "-endif. % use_specs"
def genSpec(spec):
methods = spec.allMethods()
printFileHeader()
print """% Hard-coded types
-type(amqp_field_type() ::
'longstr' | 'signedint' | 'decimal' | 'timestamp' |
'table' | 'byte' | 'double' | 'float' | 'long' |
'short' | 'bool' | 'binary' | 'void').
-type(amqp_property_type() ::
'shortstr' | 'longstr' | 'octet' | 'shortint' | 'longint' |
'longlongint' | 'timestamp' | 'bit' | 'table').
%% we could make this more precise but ultimately are limited by
%% dialyzer's lack of support for recursive types
-type(amqp_table() :: [{binary(), amqp_field_type(), any()}]).
%% TODO: make this more precise
-type(amqp_properties() :: tuple()).
-type(channel_number() :: non_neg_integer()).
-type(resource_name() :: binary()).
-type(routing_key() :: binary()).
-type(username() :: binary()).
-type(password() :: binary()).
-type(vhost() :: binary()).
-type(ctag() :: binary()).
-type(exchange_type() :: atom()).
-type(binding_key() :: binary()).
"""
print "% Auto-generated types"
classIds = set()
for m in spec.allMethods():
classIds.add(m.klass.index)
print prettyType("amqp_class_id()",
["%i" % ci for ci in classIds])
def generateErl(specPath):
genErl(AmqpSpec(specPath))
def generateHrl(specPath):
genHrl(AmqpSpec(specPath))
def generateSpec(specPath):
genSpec(AmqpSpec(specPath))
if __name__ == "__main__":
do_main_dict({"header": generateHrl,
"spec": generateSpec,
"body": generateErl})
|