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
|
%% 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 Developer of the Original Code is GoPivotal, Inc.
%% Copyright (c) 2007-2014 GoPivotal, Inc. All rights reserved.
%%
-module(rabbit_binary_generator).
-include("rabbit_framing.hrl").
-include("rabbit.hrl").
-export([build_simple_method_frame/3,
build_simple_content_frames/4,
build_heartbeat_frame/0]).
-export([generate_table/1]).
-export([check_empty_frame_size/0]).
-export([ensure_content_encoded/2, clear_encoded_content/1]).
-export([map_exception/3]).
%%----------------------------------------------------------------------------
-ifdef(use_specs).
-type(frame() :: [binary()]).
-spec(build_simple_method_frame/3 ::
(rabbit_channel:channel_number(), rabbit_framing:amqp_method_record(),
rabbit_types:protocol())
-> frame()).
-spec(build_simple_content_frames/4 ::
(rabbit_channel:channel_number(), rabbit_types:content(),
non_neg_integer(), rabbit_types:protocol())
-> [frame()]).
-spec(build_heartbeat_frame/0 :: () -> frame()).
-spec(generate_table/1 :: (rabbit_framing:amqp_table()) -> binary()).
-spec(check_empty_frame_size/0 :: () -> 'ok').
-spec(ensure_content_encoded/2 ::
(rabbit_types:content(), rabbit_types:protocol()) ->
rabbit_types:encoded_content()).
-spec(clear_encoded_content/1 ::
(rabbit_types:content()) -> rabbit_types:unencoded_content()).
-spec(map_exception/3 :: (rabbit_channel:channel_number(),
rabbit_types:amqp_error() | any(),
rabbit_types:protocol()) ->
{rabbit_channel:channel_number(),
rabbit_framing:amqp_method_record()}).
-endif.
%%----------------------------------------------------------------------------
build_simple_method_frame(ChannelInt, MethodRecord, Protocol) ->
MethodFields = Protocol:encode_method_fields(MethodRecord),
MethodName = rabbit_misc:method_record_type(MethodRecord),
{ClassId, MethodId} = Protocol:method_id(MethodName),
create_frame(1, ChannelInt, [<<ClassId:16, MethodId:16>>, MethodFields]).
build_simple_content_frames(ChannelInt, Content, FrameMax, Protocol) ->
#content{class_id = ClassId,
properties_bin = ContentPropertiesBin,
payload_fragments_rev = PayloadFragmentsRev} =
ensure_content_encoded(Content, Protocol),
{BodySize, ContentFrames} =
build_content_frames(PayloadFragmentsRev, FrameMax, ChannelInt),
HeaderFrame = create_frame(2, ChannelInt,
[<<ClassId:16, 0:16, BodySize:64>>,
ContentPropertiesBin]),
[HeaderFrame | ContentFrames].
build_content_frames(FragsRev, FrameMax, ChannelInt) ->
BodyPayloadMax = if FrameMax == 0 -> iolist_size(FragsRev);
true -> FrameMax - ?EMPTY_FRAME_SIZE
end,
build_content_frames(0, [], BodyPayloadMax, [],
lists:reverse(FragsRev), BodyPayloadMax, ChannelInt).
build_content_frames(SizeAcc, FramesAcc, _FragSizeRem, [],
[], _BodyPayloadMax, _ChannelInt) ->
{SizeAcc, lists:reverse(FramesAcc)};
build_content_frames(SizeAcc, FramesAcc, FragSizeRem, FragAcc,
Frags, BodyPayloadMax, ChannelInt)
when FragSizeRem == 0 orelse Frags == [] ->
Frame = create_frame(3, ChannelInt, lists:reverse(FragAcc)),
FrameSize = BodyPayloadMax - FragSizeRem,
build_content_frames(SizeAcc + FrameSize, [Frame | FramesAcc],
BodyPayloadMax, [], Frags, BodyPayloadMax, ChannelInt);
build_content_frames(SizeAcc, FramesAcc, FragSizeRem, FragAcc,
[Frag | Frags], BodyPayloadMax, ChannelInt) ->
Size = size(Frag),
{NewFragSizeRem, NewFragAcc, NewFrags} =
if Size == 0 -> {FragSizeRem, FragAcc, Frags};
Size =< FragSizeRem -> {FragSizeRem - Size, [Frag | FragAcc], Frags};
true -> <<Head:FragSizeRem/binary, Tail/binary>> =
Frag,
{0, [Head | FragAcc], [Tail | Frags]}
end,
build_content_frames(SizeAcc, FramesAcc, NewFragSizeRem, NewFragAcc,
NewFrags, BodyPayloadMax, ChannelInt).
build_heartbeat_frame() ->
create_frame(?FRAME_HEARTBEAT, 0, <<>>).
create_frame(TypeInt, ChannelInt, Payload) ->
[<<TypeInt:8, ChannelInt:16, (iolist_size(Payload)):32>>, Payload,
?FRAME_END].
%% table_field_to_binary supports the AMQP 0-8/0-9 standard types, S,
%% I, D, T and F, as well as the QPid extensions b, d, f, l, s, t, x,
%% and V.
table_field_to_binary({FName, T, V}) ->
[short_string_to_binary(FName) | field_value_to_binary(T, V)].
field_value_to_binary(longstr, V) -> [$S | long_string_to_binary(V)];
field_value_to_binary(signedint, V) -> [$I, <<V:32/signed>>];
field_value_to_binary(decimal, V) -> {Before, After} = V,
[$D, Before, <<After:32>>];
field_value_to_binary(timestamp, V) -> [$T, <<V:64>>];
field_value_to_binary(table, V) -> [$F | table_to_binary(V)];
field_value_to_binary(array, V) -> [$A | array_to_binary(V)];
field_value_to_binary(byte, V) -> [$b, <<V:8/signed>>];
field_value_to_binary(double, V) -> [$d, <<V:64/float>>];
field_value_to_binary(float, V) -> [$f, <<V:32/float>>];
field_value_to_binary(long, V) -> [$l, <<V:64/signed>>];
field_value_to_binary(short, V) -> [$s, <<V:16/signed>>];
field_value_to_binary(bool, V) -> [$t, if V -> 1; true -> 0 end];
field_value_to_binary(binary, V) -> [$x | long_string_to_binary(V)];
field_value_to_binary(void, _V) -> [$V].
table_to_binary(Table) when is_list(Table) ->
BinTable = generate_table_iolist(Table),
[<<(iolist_size(BinTable)):32>> | BinTable].
array_to_binary(Array) when is_list(Array) ->
BinArray = generate_array_iolist(Array),
[<<(iolist_size(BinArray)):32>> | BinArray].
generate_table(Table) when is_list(Table) ->
list_to_binary(generate_table_iolist(Table)).
generate_table_iolist(Table) ->
lists:map(fun table_field_to_binary/1, Table).
generate_array_iolist(Array) ->
lists:map(fun ({T, V}) -> field_value_to_binary(T, V) end, Array).
short_string_to_binary(String) ->
Len = string_length(String),
if Len < 256 -> [<<Len:8>>, String];
true -> exit(content_properties_shortstr_overflow)
end.
long_string_to_binary(String) ->
Len = string_length(String),
[<<Len:32>>, String].
string_length(String) when is_binary(String) -> size(String);
string_length(String) -> length(String).
check_empty_frame_size() ->
%% Intended to ensure that EMPTY_FRAME_SIZE is defined correctly.
case iolist_size(create_frame(?FRAME_BODY, 0, <<>>)) of
?EMPTY_FRAME_SIZE -> ok;
ComputedSize -> exit({incorrect_empty_frame_size,
ComputedSize, ?EMPTY_FRAME_SIZE})
end.
ensure_content_encoded(Content = #content{properties_bin = PropBin,
protocol = Protocol}, Protocol)
when PropBin =/= none ->
Content;
ensure_content_encoded(Content = #content{properties = none,
properties_bin = PropBin,
protocol = Protocol}, Protocol1)
when PropBin =/= none ->
Props = Protocol:decode_properties(Content#content.class_id, PropBin),
Content#content{properties = Props,
properties_bin = Protocol1:encode_properties(Props),
protocol = Protocol1};
ensure_content_encoded(Content = #content{properties = Props}, Protocol)
when Props =/= none ->
Content#content{properties_bin = Protocol:encode_properties(Props),
protocol = Protocol}.
clear_encoded_content(Content = #content{properties_bin = none,
protocol = none}) ->
Content;
clear_encoded_content(Content = #content{properties = none}) ->
%% Only clear when we can rebuild the properties_bin later in
%% accordance to the content record definition comment - maximum
%% one of properties and properties_bin can be 'none'
Content;
clear_encoded_content(Content = #content{}) ->
Content#content{properties_bin = none, protocol = none}.
%% NB: this function is also used by the Erlang client
map_exception(Channel, Reason, Protocol) ->
{SuggestedClose, ReplyCode, ReplyText, FailedMethod} =
lookup_amqp_exception(Reason, Protocol),
{ClassId, MethodId} = case FailedMethod of
{_, _} -> FailedMethod;
none -> {0, 0};
_ -> Protocol:method_id(FailedMethod)
end,
case SuggestedClose orelse (Channel == 0) of
true -> {0, #'connection.close'{reply_code = ReplyCode,
reply_text = ReplyText,
class_id = ClassId,
method_id = MethodId}};
false -> {Channel, #'channel.close'{reply_code = ReplyCode,
reply_text = ReplyText,
class_id = ClassId,
method_id = MethodId}}
end.
lookup_amqp_exception(#amqp_error{name = Name,
explanation = Expl,
method = Method},
Protocol) ->
{ShouldClose, Code, Text} = Protocol:lookup_amqp_exception(Name),
ExplBin = amqp_exception_explanation(Text, Expl),
{ShouldClose, Code, ExplBin, Method};
lookup_amqp_exception(Other, Protocol) ->
rabbit_log:warning("Non-AMQP exit reason '~p'~n", [Other]),
{ShouldClose, Code, Text} = Protocol:lookup_amqp_exception(internal_error),
{ShouldClose, Code, Text, none}.
amqp_exception_explanation(Text, Expl) ->
ExplBin = list_to_binary(Expl),
CompleteTextBin = <<Text/binary, " - ", ExplBin/binary>>,
if size(CompleteTextBin) > 255 -> <<CompleteTextBin:252/binary, "...">>;
true -> CompleteTextBin
end.
|
