Skip to content

Commit 6a1a950

Browse files
author
Alexandru Scvortov
committed
merged default into bug22877
2 parents 245f59d + 1a655af commit 6a1a950

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+765
-539
lines changed

‎Makefile‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ SOURCE_DIR=src
1111
EBIN_DIR=ebin
1212
INCLUDE_DIR=include
1313
DOCS_DIR=docs
14-
INCLUDES=$(wildcard $(INCLUDE_DIR)/*.hrl) $(INCLUDE_DIR)/rabbit_framing.hrl $(INCLUDE_DIR)/rabbit_framing_spec.hrl
14+
INCLUDES=$(wildcard $(INCLUDE_DIR)/*.hrl) $(INCLUDE_DIR)/rabbit_framing.hrl
1515
SOURCES=$(wildcard $(SOURCE_DIR)/*.erl) $(SOURCE_DIR)/rabbit_framing.erl $(USAGES_ERL)
1616
BEAM_TARGETS=$(patsubst $(SOURCE_DIR)/%.erl, $(EBIN_DIR)/%.beam, $(SOURCES))
17-
TARGETS=$(EBIN_DIR)/rabbit.app $(INCLUDE_DIR)/rabbit_framing.hrl $(INCLUDE_DIR)/rabbit_framing_spec.hrl $(BEAM_TARGETS)
17+
TARGETS=$(EBIN_DIR)/rabbit.app $(INCLUDE_DIR)/rabbit_framing.hrl $(BEAM_TARGETS)
1818
WEB_URL=http://www.rabbitmq.com/
1919
MANPAGES=$(patsubst %.xml, %.gz, $(wildcard $(DOCS_DIR)/*.[0-9].xml))
2020
WEB_MANPAGES=$(patsubst %.xml, %.man.xml, $(wildcard $(DOCS_DIR)/*.[0-9].xml) $(DOCS_DIR)/rabbitmq-service.xml)
@@ -41,10 +41,10 @@ RABBIT_PLT=rabbit.plt
4141

4242
ifndef USE_SPECS
4343
# our type specs rely on features and bug fixes in dialyzer that are
44-
# only available in R13B01 upwards (R13B01 is eshell 5.7.2)
44+
# only available in R13B04 upwards (R13B04 is erts 5.7.5)
4545
#
4646
# NB: the test assumes that version number will only contain single digits
47-
USE_SPECS=$(shell if [ $$(erl -noshell -eval 'io:format(erlang:system_info(version)), halt().') \> "5.7.1" ]; then echo "true"; else echo "false"; fi)
47+
USE_SPECS=$(shell if [ $$(erl -noshell -eval 'io:format(erlang:system_info(version)), halt().') \> "5.7.4" ]; then echo "true"; else echo "false"; fi)
4848
endif
4949

5050
#other args: +native +"{hipe,[o3,verbose]}" -Ddebug=true +debug_info +no_strict_record_tests
@@ -102,9 +102,6 @@ $(EBIN_DIR)/%.beam:
102102
$(INCLUDE_DIR)/rabbit_framing.hrl: codegen.py $(AMQP_CODEGEN_DIR)/amqp_codegen.py $(AMQP_SPEC_JSON_FILES)
103103
$(PYTHON) codegen.py header $(AMQP_SPEC_JSON_FILES) $@
104104

105-
$(INCLUDE_DIR)/rabbit_framing_spec.hrl: codegen.py $(AMQP_CODEGEN_DIR)/amqp_codegen.py $(AMQP_SPEC_JSON_FILES)
106-
$(PYTHON) codegen.py spec $(AMQP_SPEC_JSON_FILES) $@
107-
108105
$(SOURCE_DIR)/rabbit_framing.erl: codegen.py $(AMQP_CODEGEN_DIR)/amqp_codegen.py $(AMQP_SPEC_JSON_FILES)
109106
$(PYTHON) codegen.py body $(AMQP_SPEC_JSON_FILES) $@
110107

@@ -131,7 +128,7 @@ $(BASIC_PLT): $(BEAM_TARGETS)
131128
clean:
132129
rm -f $(EBIN_DIR)/*.beam
133130
rm -f $(EBIN_DIR)/rabbit.app $(EBIN_DIR)/rabbit.boot $(EBIN_DIR)/rabbit.script $(EBIN_DIR)/rabbit.rel
134-
rm -f $(INCLUDE_DIR)/rabbit_framing.hrl $(INCLUDE_DIR)/rabbit_framing_spec.hrl $(SOURCE_DIR)/rabbit_framing.erl codegen.pyc
131+
rm -f $(INCLUDE_DIR)/rabbit_framing.hrl $(SOURCE_DIR)/rabbit_framing.erl codegen.pyc
135132
rm -f $(DOCS_DIR)/*.[0-9].gz $(DOCS_DIR)/*.man.xml $(DOCS_DIR)/*.erl $(USAGES_ERL)
136133
rm -f $(RABBIT_PLT)
137134
rm -f $(DEPS_FILE)

‎codegen.py‎

Lines changed: 64 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -332,10 +332,67 @@ def genAmqpException(c,v,cls):
332332
-export([lookup_amqp_exception/1]).
333333
-export([amqp_exception/1]).
334334
335-
bitvalue(true) -> 1;
336-
bitvalue(false) -> 0;
337-
bitvalue(undefined) -> 0.
335+
"""
336+
print "%% Various types"
337+
print "-ifdef(use_specs)."
338+
339+
print """-export_type([amqp_table/0, amqp_property_type/0, amqp_method_record/0,
340+
amqp_method_name/0, amqp_method/0, amqp_class_id/0,
341+
amqp_value/0, amqp_array/0, amqp_exception/0, amqp_property_record/0]).
342+
343+
-type(amqp_field_type() ::
344+
'longstr' | 'signedint' | 'decimal' | 'timestamp' |
345+
'table' | 'byte' | 'double' | 'float' | 'long' |
346+
'short' | 'bool' | 'binary' | 'void').
347+
-type(amqp_property_type() ::
348+
'shortstr' | 'longstr' | 'octet' | 'shortint' | 'longint' |
349+
'longlongint' | 'timestamp' | 'bit' | 'table').
350+
351+
-type(amqp_table() :: [{binary(), amqp_field_type(), amqp_value()}]).
352+
-type(amqp_array() :: [{amqp_field_type(), amqp_value()}]).
353+
-type(amqp_value() :: binary() | % longstr
354+
integer() | % signedint
355+
{non_neg_integer(), non_neg_integer()} | % decimal
356+
amqp_table() |
357+
amqp_array() |
358+
byte() | % byte
359+
float() | % double
360+
integer() | % long
361+
integer() | % short
362+
boolean() | % bool
363+
binary() | % binary
364+
'undefined' | % void
365+
non_neg_integer() % timestamp
366+
).
367+
"""
368+
369+
print prettyType("amqp_method_name()",
370+
[m.erlangName() for m in methods])
371+
print prettyType("amqp_method()",
372+
["{%s, %s}" % (m.klass.index, m.index) for m in methods],
373+
6)
374+
print prettyType("amqp_method_record()",
375+
["#%s{}" % (m.erlangName()) for m in methods])
376+
fieldNames = set()
377+
for m in methods:
378+
fieldNames.update(m.arguments)
379+
fieldNames = [erlangize(f.name) for f in fieldNames]
380+
print prettyType("amqp_method_field_name()",
381+
fieldNames)
382+
print prettyType("amqp_property_record()",
383+
["#'P_%s'{}" % erlangize(c.name) for c in spec.allClasses()])
384+
print prettyType("amqp_exception()",
385+
["'%s'" % erlangConstantName(c).lower() for (c, v, cls) in spec.constants])
386+
print prettyType("amqp_exception_code()",
387+
["%i" % v for (c, v, cls) in spec.constants])
388+
classIds = set()
389+
for m in spec.allMethods():
390+
classIds.add(m.klass.index)
391+
print prettyType("amqp_class_id()",
392+
["%i" % ci for ci in classIds])
393+
print "-endif. % use_specs"
338394

395+
print """
339396
%% Method signatures
340397
-ifdef(use_specs).
341398
-spec(lookup_method_name/1 :: (amqp_method()) -> amqp_method_name()).
@@ -351,6 +408,10 @@ def genAmqpException(c,v,cls):
351408
-spec(lookup_amqp_exception/1 :: (amqp_exception()) -> {boolean(), amqp_exception_code(), binary()}).
352409
-spec(amqp_exception/1 :: (amqp_exception_code()) -> amqp_exception()).
353410
-endif. % use_specs
411+
412+
bitvalue(true) -> 1;
413+
bitvalue(false) -> 0;
414+
bitvalue(undefined) -> 0.
354415
"""
355416
for m in methods: genLookupMethodName(m)
356417
print "lookup_method_name({_ClassId, _MethodId} = Id) -> exit({unknown_method_id, Id})."
@@ -425,75 +486,14 @@ def fillField(field):
425486
for c in spec.allClasses():
426487
print "-record('P_%s', {%s})." % (erlangize(c.name), fieldNameList(c.fields))
427488

428-
print "-ifdef(use_specs)."
429-
print "%% Various types"
430-
print prettyType("amqp_method_name()",
431-
[m.erlangName() for m in methods])
432-
print prettyType("amqp_method()",
433-
["{%s, %s}" % (m.klass.index, m.index) for m in methods],
434-
6)
435-
print prettyType("amqp_method_record()",
436-
["#%s{}" % (m.erlangName()) for m in methods])
437-
fieldNames = set()
438-
for m in methods:
439-
fieldNames.update(m.arguments)
440-
fieldNames = [erlangize(f.name) for f in fieldNames]
441-
print prettyType("amqp_method_field_name()",
442-
fieldNames)
443-
print prettyType("amqp_property_record()",
444-
["#'P_%s'{}" % erlangize(c.name) for c in spec.allClasses()])
445-
print prettyType("amqp_exception()",
446-
["'%s'" % erlangConstantName(c).lower() for (c, v, cls) in spec.constants])
447-
print prettyType("amqp_exception_code()",
448-
["%i" % v for (c, v, cls) in spec.constants])
449-
print "-endif. % use_specs"
450-
451-
def genSpec(spec):
452-
methods = spec.allMethods()
453-
454-
printFileHeader()
455-
print """% Hard-coded types
456-
-type(amqp_field_type() ::
457-
'longstr' | 'signedint' | 'decimal' | 'timestamp' |
458-
'table' | 'byte' | 'double' | 'float' | 'long' |
459-
'short' | 'bool' | 'binary' | 'void').
460-
-type(amqp_property_type() ::
461-
'shortstr' | 'longstr' | 'octet' | 'shortint' | 'longint' |
462-
'longlongint' | 'timestamp' | 'bit' | 'table').
463-
%% we could make this more precise but ultimately are limited by
464-
%% dialyzer's lack of support for recursive types
465-
-type(amqp_table() :: [{binary(), amqp_field_type(), any()}]).
466-
%% TODO: make this more precise
467-
-type(amqp_properties() :: tuple()).
468-
469-
-type(channel_number() :: non_neg_integer()).
470-
-type(resource_name() :: binary()).
471-
-type(routing_key() :: binary()).
472-
-type(username() :: binary()).
473-
-type(password() :: binary()).
474-
-type(vhost() :: binary()).
475-
-type(ctag() :: binary()).
476-
-type(exchange_type() :: atom()).
477-
-type(binding_key() :: binary()).
478-
"""
479-
print "% Auto-generated types"
480-
classIds = set()
481-
for m in spec.allMethods():
482-
classIds.add(m.klass.index)
483-
print prettyType("amqp_class_id()",
484-
["%i" % ci for ci in classIds])
485489

486490
def generateErl(specPath):
487491
genErl(AmqpSpec(specPath))
488492

489493
def generateHrl(specPath):
490494
genHrl(AmqpSpec(specPath))
491495

492-
def generateSpec(specPath):
493-
genSpec(AmqpSpec(specPath))
494-
495496
if __name__ == "__main__":
496497
do_main_dict({"header": generateHrl,
497-
"spec": generateSpec,
498498
"body": generateErl})
499499

‎include/rabbit.hrl‎

Lines changed: 0 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -68,115 +68,10 @@
6868

6969
-record(ssl_socket, {tcp, ssl}).
7070
-record(delivery, {mandatory, immediate, txn, sender, message}).
71-
7271
-record(amqp_error, {name, explanation, method = none}).
7372

7473
%%----------------------------------------------------------------------------
7574

76-
-ifdef(use_specs).
77-
78-
-include("rabbit_framing_spec.hrl").
79-
80-
-type(maybe(T) :: T | 'none').
81-
-type(erlang_node() :: atom()).
82-
-type(node_type() :: disc_only | disc | ram | unknown).
83-
-type(ssl_socket() :: #ssl_socket{}).
84-
-type(socket() :: port() | ssl_socket()).
85-
-type(thunk(T) :: fun(() -> T)).
86-
-type(info_key() :: atom()).
87-
-type(info() :: {info_key(), any()}).
88-
-type(regexp() :: binary()).
89-
-type(file_path() :: string()).
90-
91-
%% this is really an abstract type, but dialyzer does not support them
92-
-type(guid() :: binary()).
93-
-type(txn() :: guid()).
94-
-type(pkey() :: guid()).
95-
-type(r(Kind) ::
96-
#resource{virtual_host :: vhost(),
97-
kind :: Kind,
98-
name :: resource_name()}).
99-
-type(queue_name() :: r('queue')).
100-
-type(exchange_name() :: r('exchange')).
101-
-type(user() ::
102-
#user{username :: username(),
103-
password :: password()}).
104-
-type(permission() ::
105-
#permission{configure :: regexp(),
106-
write :: regexp(),
107-
read :: regexp()}).
108-
-type(amqqueue() ::
109-
#amqqueue{name :: queue_name(),
110-
durable :: boolean(),
111-
auto_delete :: boolean(),
112-
exclusive_owner :: maybe(pid()),
113-
arguments :: amqp_table(),
114-
pid :: maybe(pid())}).
115-
-type(exchange() ::
116-
#exchange{name :: exchange_name(),
117-
type :: exchange_type(),
118-
durable :: boolean(),
119-
auto_delete :: boolean(),
120-
arguments :: amqp_table()}).
121-
-type(binding() ::
122-
#binding{exchange_name :: exchange_name(),
123-
queue_name :: queue_name(),
124-
key :: binding_key()}).
125-
%% TODO: make this more precise by tying specific class_ids to
126-
%% specific properties
127-
-type(undecoded_content() ::
128-
#content{class_id :: amqp_class_id(),
129-
properties :: 'none',
130-
properties_bin :: binary(),
131-
payload_fragments_rev :: [binary()]} |
132-
#content{class_id :: amqp_class_id(),
133-
properties :: amqp_properties(),
134-
properties_bin :: 'none',
135-
payload_fragments_rev :: [binary()]}).
136-
-type(unencoded_content() :: undecoded_content()).
137-
-type(decoded_content() ::
138-
#content{class_id :: amqp_class_id(),
139-
properties :: amqp_properties(),
140-
properties_bin :: maybe(binary()),
141-
payload_fragments_rev :: [binary()]}).
142-
-type(encoded_content() ::
143-
#content{class_id :: amqp_class_id(),
144-
properties :: maybe(amqp_properties()),
145-
properties_bin :: binary(),
146-
payload_fragments_rev :: [binary()]}).
147-
-type(content() :: undecoded_content() | decoded_content()).
148-
-type(basic_message() ::
149-
#basic_message{exchange_name :: exchange_name(),
150-
routing_key :: routing_key(),
151-
content :: content(),
152-
guid :: guid(),
153-
is_persistent :: boolean()}).
154-
-type(message() :: basic_message()).
155-
-type(delivery() ::
156-
#delivery{mandatory :: boolean(),
157-
immediate :: boolean(),
158-
txn :: maybe(txn()),
159-
sender :: pid(),
160-
message :: message()}).
161-
%% this really should be an abstract type
162-
-type(msg_id() :: non_neg_integer()).
163-
-type(qmsg() :: {queue_name(), pid(), msg_id(), boolean(), message()}).
164-
-type(listener() ::
165-
#listener{node :: erlang_node(),
166-
protocol :: atom(),
167-
host :: string() | atom(),
168-
port :: non_neg_integer()}).
169-
-type(not_found() :: {'error', 'not_found'}).
170-
-type(routing_result() :: 'routed' | 'unroutable' | 'not_delivered').
171-
-type(amqp_error() ::
172-
#amqp_error{name :: atom(),
173-
explanation :: string(),
174-
method :: atom()}).
175-
176-
-endif.
177-
178-
%%----------------------------------------------------------------------------
179-
18075
-define(COPYRIGHT_MESSAGE, "Copyright (C) 2007-2010 LShift Ltd., Cohesive Financial Technologies LLC., and Rabbit Technologies Ltd.").
18176
-define(INFORMATION_MESSAGE, "Licensed under the MPL. See http://www.rabbitmq.com/").
18277
-define(ERTS_MINIMUM, "5.6.3").

‎include/rabbit_backing_queue_spec.hrl‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,26 +31,26 @@
3131

3232
-type(fetch_result() ::
3333
%% Message, IsDelivered, AckTag, Remaining_Len
34-
('empty'|{basic_message(), boolean(), ack(), non_neg_integer()})).
34+
('empty'|{rabbit_types:basic_message(), boolean(), ack(), non_neg_integer()})).
3535
-type(is_durable() :: boolean()).
3636
-type(attempt_recovery() :: boolean()).
3737
-type(purged_msg_count() :: non_neg_integer()).
3838
-type(ack_required() :: boolean()).
3939

40-
-spec(start/1 :: ([queue_name()]) -> 'ok').
41-
-spec(init/3 :: (queue_name(), is_durable(), attempt_recovery()) -> state()).
40+
-spec(start/1 :: ([rabbit_amqqueue:name()]) -> 'ok').
41+
-spec(init/3 :: (rabbit_amqqueue:name(), is_durable(), attempt_recovery()) -> state()).
4242
-spec(terminate/1 :: (state()) -> state()).
4343
-spec(delete_and_terminate/1 :: (state()) -> state()).
4444
-spec(purge/1 :: (state()) -> {purged_msg_count(), state()}).
45-
-spec(publish/2 :: (basic_message(), state()) -> state()).
45+
-spec(publish/2 :: (rabbit_types:basic_message(), state()) -> state()).
4646
-spec(publish_delivered/3 ::
47-
(ack_required(), basic_message(), state()) -> {ack(), state()}).
47+
(ack_required(), rabbit_types:basic_message(), state()) -> {ack(), state()}).
4848
-spec(fetch/2 :: (ack_required(), state()) -> {fetch_result(), state()}).
4949
-spec(ack/2 :: ([ack()], state()) -> state()).
50-
-spec(tx_publish/3 :: (txn(), basic_message(), state()) -> state()).
51-
-spec(tx_ack/3 :: (txn(), [ack()], state()) -> state()).
52-
-spec(tx_rollback/2 :: (txn(), state()) -> {[ack()], state()}).
53-
-spec(tx_commit/3 :: (txn(), fun (() -> any()), state()) -> {[ack()], state()}).
50+
-spec(tx_publish/3 :: (rabbit_types:txn(), rabbit_types:basic_message(), state()) -> state()).
51+
-spec(tx_ack/3 :: (rabbit_types:txn(), [ack()], state()) -> state()).
52+
-spec(tx_rollback/2 :: (rabbit_types:txn(), state()) -> {[ack()], state()}).
53+
-spec(tx_commit/3 :: (rabbit_types:txn(), fun (() -> any()), state()) -> {[ack()], state()}).
5454
-spec(requeue/2 :: ([ack()], state()) -> state()).
5555
-spec(len/1 :: (state()) -> non_neg_integer()).
5656
-spec(is_empty/1 :: (state()) -> boolean()).

‎include/rabbit_exchange_type_spec.hrl‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,19 @@
3131
-ifdef(use_specs).
3232

3333
-spec(description/0 :: () -> [{atom(), any()}]).
34-
-spec(publish/2 :: (exchange(), delivery()) -> {routing_result(), [pid()]}).
35-
-spec(validate/1 :: (exchange()) -> 'ok').
36-
-spec(create/1 :: (exchange()) -> 'ok').
37-
-spec(recover/2 :: (exchange(), list(binding())) -> 'ok').
38-
-spec(delete/2 :: (exchange(), list(binding())) -> 'ok').
39-
-spec(add_binding/2 :: (exchange(), binding()) -> 'ok').
40-
-spec(remove_bindings/2 :: (exchange(), list(binding())) -> 'ok').
41-
-spec(assert_args_equivalence/2 :: (exchange(), amqp_table()) -> 'ok').
34+
-spec(publish/2 :: (rabbit_types:exchange(), rabbit_types:delivery())
35+
-> {rabbit_router:routing_result(), [pid()]}).
36+
-spec(validate/1 :: (rabbit_types:exchange()) -> 'ok').
37+
-spec(create/1 :: (rabbit_types:exchange()) -> 'ok').
38+
-spec(recover/2 :: (rabbit_types:exchange(),
39+
[rabbit_types:binding()]) -> 'ok').
40+
-spec(delete/2 :: (rabbit_types:exchange(),
41+
[rabbit_types:binding()]) -> 'ok').
42+
-spec(add_binding/2 :: (rabbit_types:exchange(),
43+
rabbit_types:binding()) -> 'ok').
44+
-spec(remove_bindings/2 :: (rabbit_types:exchange(),
45+
[rabbit_types:binding()]) -> 'ok').
46+
-spec(assert_args_equivalence/2 :: (rabbit_types:exchange(),
47+
rabbit_framing:amqp_table()) -> 'ok').
4248

4349
-endif.

‎src/delegate.erl‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,9 @@
4444

4545
-ifdef(use_specs).
4646

47-
-spec(start_link/1 :: (non_neg_integer()) -> {'ok', pid()}).
48-
-spec(invoke_no_result/2 :: (pid() | [pid()], fun ((pid()) -> any())) -> 'ok').
47+
-spec(start_link/1 :: (non_neg_integer()) -> rabbit_types:ok(pid())).
48+
-spec(invoke_no_result/2 ::
49+
(pid() | [pid()], fun ((pid()) -> any())) -> 'ok').
4950
-spec(invoke/2 :: (pid() | [pid()], fun ((pid()) -> A)) -> A).
5051

5152
-spec(process_count/0 :: () -> non_neg_integer()).

0 commit comments

Comments
 (0)