Packages
rabbit_common
3.12.12
4.2.1
4.2.0
retired
4.2.0-rc.1
retired
4.1.6
4.1.5
retired
4.1.5-rc.2
retired
4.1.5-rc.1
4.0.3
4.0.3-rc.1
4.0.2
4.0.2-rc.2
4.0.2-rc.1
4.0.1
4.0.0
4.0.0-rc.2
4.0.0-rc.1
3.13.7
3.13.6
3.13.5
3.13.4
3.13.3
3.13.2
3.13.2-rc.1
3.13.1
3.13.0
3.13.0-rc.6
3.13.0-rc.5
3.13.0-rc.4
3.13.0-rc.3
3.13.0-rc.2
3.13.0-rc.1
3.12.14
3.12.13
3.12.12
3.12.11
3.12.10
3.12.9
3.12.8
3.12.7
3.12.6
3.12.5
3.12.4
3.12.3
3.12.2
3.12.1
3.12.0
3.12.0-rc.4
3.12.0-rc.3
3.12.0-rc.2
3.12.0-rc.1
3.11.28
3.11.27
3.11.26
3.11.25
3.11.24
3.11.23
3.11.22
3.11.21
3.11.20
3.11.19
3.11.18
3.11.17
3.11.16
3.11.15
3.11.14
3.11.13
3.11.12
3.11.11
3.11.10
3.11.9
3.11.8
3.11.7
3.11.6
3.11.5
3.11.4
3.11.3
3.11.2
3.11.1
3.11.0
3.11.0-rc.2
3.11.0-rc.1
3.11.0-1
3.10.25
3.10.24
3.10.23
3.10.22
3.10.21
3.10.20
3.10.19
3.10.18
3.10.17
3.10.16
3.10.15
3.10.14
3.10.13
3.10.12
3.10.11
3.10.10
3.10.9
3.10.8
3.10.7
3.10.6
3.10.5
3.10.4
3.10.3
3.10.2
3.10.1
3.10.0
3.10.0-rc.6
3.10.0-rc.5
3.9.29
3.9.28
3.9.27
3.9.26
3.9.25
3.9.24
3.9.23
3.9.22
3.9.21
3.9.20
3.9.19
3.9.18
3.9.17
3.9.16
3.9.15
3.9.11
3.9.10
3.9.9
3.9.8
3.9.7
3.9.6
3.9.5
3.9.4
3.9.3
3.9.2
3.9.1
3.8.35
3.8.34
3.8.33
3.8.32
3.8.31
3.8.30
3.8.26
3.8.25
3.8.24
3.8.23
3.8.22
3.8.21
3.8.20
3.8.19
3.8.14
3.8.12-rc.3
3.8.12-rc.2
3.8.12-rc.1
3.8.11
3.8.10
3.8.10-rc.6
3.8.10-rc.5
3.8.10-rc.1
3.8.9
3.8.8
3.8.7
3.8.6
3.8.6-rc.2
3.8.6-rc.1
3.8.5
3.8.5-rc.2
3.8.5-rc.1
3.8.4
3.8.4-rc.3
3.8.4-rc.1
3.8.3
3.8.3-rc.2
3.8.3-rc.1
3.8.2
3.8.2-rc.1
3.8.1
3.8.1-rc.1
3.8.0
3.8.0-rc.3
3.8.0-rc.2
3.8.0-rc.1
3.7.28
3.7.27
3.7.27-rc.2
3.7.27-rc.1
3.7.26
3.7.25
3.7.25-rc.1
3.7.24
3.7.24-rc.2
3.7.24-rc.1
3.7.23
3.7.23-rc.1
3.7.22
3.7.22-rc.2
3.7.22-rc.1
3.7.21
3.7.20
3.7.20-rc.2
3.7.20-rc.1
3.7.19
3.7.18
3.7.18-rc.1
3.7.17
3.7.17-rc.3
3.7.17-rc.2
3.7.17-rc.1
retired
3.7.16
retired
3.7.16-rc.4
retired
3.7.16-rc.3
retired
3.7.16-rc.2
retired
3.7.16-rc.1
retired
3.7.16-beta.1
3.7.15
3.7.14
3.7.14-rc.2
3.7.14-rc.1
3.7.13
3.7.13-rc.2
3.7.13-rc.1
3.7.12
3.7.12-rc.2
3.7.12-rc.1
3.7.11
3.7.11-rc.2
3.7.11-rc.1
3.7.10-rc.4
3.7.10-rc.3
3.7.10-rc.2
3.7.10-rc.1
3.7.9
3.7.9-rc.3
3.7.9-rc.2
3.7.8
3.7.8-rc.4
3.7.8-rc.3
3.7.8-rc.2
3.7.8-rc.1
3.7.7
3.7.7-rc.2
3.7.7-rc.1
3.7.6
3.7.6-rc.2
3.7.6-rc.1
3.7.5
3.7.5-rc.1
3.7.4
3.7.4-rc.4
3.7.4-rc.3
3.7.4-rc.2
3.7.4-rc.1
3.7.3
3.7.3-rc.2
3.7.3-rc.1
3.7.2
3.7.1
3.7.0-rc.2
3.7.0-alpha.544
3.7.0-alpha.542
3.6.16
3.6.16-rc.1
3.6.15
3.6.15-rc.1
3.6.14
3.6.13
3.6.12
3.6.11
3.6.10
3.6.9
3.6.8
3.6.7
3.6.7-pre.1
3.5.6
3.5.0
3.4.0
3.3.5
3.0.2
0.0.0-rc.1
Modules shared by rabbitmq-server and rabbitmq-erlang-client
Current section
Files
Jump to
Current section
Files
src/rabbit_binary_parser.erl
%% This Source Code Form is subject to the terms of the Mozilla Public
%% License, v. 2.0. If a copy of the MPL was not distributed with this
%% file, You can obtain one at https://mozilla.org/MPL/2.0/.
%%
%% Copyright (c) 2007-2024 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. All rights reserved.
%%
-module(rabbit_binary_parser).
-include("rabbit.hrl").
-export([parse_table/1]).
-export([ensure_content_decoded/1, clear_decoded_content/1]).
-export([validate_utf8/1, assert_utf8/1]).
%%----------------------------------------------------------------------------
-spec parse_table(binary()) -> rabbit_framing:amqp_table().
-spec ensure_content_decoded
(rabbit_types:content()) ->
rabbit_types:decoded_content().
-spec clear_decoded_content
(rabbit_types:content()) ->
rabbit_types:undecoded_content().
-spec validate_utf8(binary()) -> 'ok' | 'error'.
-spec assert_utf8(binary()) -> 'ok'.
%%----------------------------------------------------------------------------
%% parse_table 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.
-define(SIMPLE_PARSE_TABLE(BType, Pattern, RType),
parse_table(<<NLen:8/unsigned, NameString:NLen/binary,
BType, Pattern, Rest/binary>>) ->
[{NameString, RType, Value} | parse_table(Rest)]).
%% Note that we try to put these in approximately the order we expect
%% to hit them, that's why the empty binary is half way through.
parse_table(<<NLen:8/unsigned, NameString:NLen/binary,
$S, VLen:32/unsigned, Value:VLen/binary, Rest/binary>>) ->
[{NameString, longstr, Value} | parse_table(Rest)];
?SIMPLE_PARSE_TABLE($T, Value:64/unsigned, timestamp);
parse_table(<<>>) ->
[];
?SIMPLE_PARSE_TABLE($b, Value:8/signed, byte);
?SIMPLE_PARSE_TABLE($B, Value:8/unsigned, unsignedbyte);
?SIMPLE_PARSE_TABLE($s, Value:16/signed, short);
?SIMPLE_PARSE_TABLE($u, Value:16/unsigned, unsignedshort);
?SIMPLE_PARSE_TABLE($I, Value:32/signed, signedint);
?SIMPLE_PARSE_TABLE($i, Value:32/unsigned, unsignedint);
?SIMPLE_PARSE_TABLE($d, Value:64/float, double);
?SIMPLE_PARSE_TABLE($f, Value:32/float, float);
%% yes, both 'l' and 'L' fields are decoded to 64-bit signed values;
%% see https://github.com/rabbitmq/rabbitmq-server/issues/1093#issuecomment-276351183,
%% https://www.rabbitmq.com/amqp-0-9-1-errata.html, and section
%% 4.2.1 of the spec for details.
?SIMPLE_PARSE_TABLE($l, Value:64/signed, long);
?SIMPLE_PARSE_TABLE($L, Value:64/signed, long);
parse_table(<<NLen:8/unsigned, NameString:NLen/binary,
$t, Value:8/unsigned, Rest/binary>>) ->
[{NameString, bool, (Value /= 0)} | parse_table(Rest)];
parse_table(<<NLen:8/unsigned, NameString:NLen/binary,
$D, Before:8/unsigned, After:32/unsigned, Rest/binary>>) ->
[{NameString, decimal, {Before, After}} | parse_table(Rest)];
parse_table(<<NLen:8/unsigned, NameString:NLen/binary,
$F, VLen:32/unsigned, Value:VLen/binary, Rest/binary>>) ->
[{NameString, table, parse_table(Value)} | parse_table(Rest)];
parse_table(<<NLen:8/unsigned, NameString:NLen/binary,
$A, VLen:32/unsigned, Value:VLen/binary, Rest/binary>>) ->
[{NameString, array, parse_array(Value)} | parse_table(Rest)];
parse_table(<<NLen:8/unsigned, NameString:NLen/binary,
$x, VLen:32/unsigned, Value:VLen/binary, Rest/binary>>) ->
[{NameString, binary, Value} | parse_table(Rest)];
parse_table(<<NLen:8/unsigned, NameString:NLen/binary,
$V, Rest/binary>>) ->
[{NameString, void, undefined} | parse_table(Rest)].
-define(SIMPLE_PARSE_ARRAY(BType, Pattern, RType),
parse_array(<<BType, Pattern, Rest/binary>>) ->
[{RType, Value} | parse_array(Rest)]).
parse_array(<<$S, VLen:32/unsigned, Value:VLen/binary, Rest/binary>>) ->
[{longstr, Value} | parse_array(Rest)];
?SIMPLE_PARSE_ARRAY($T, Value:64/unsigned, timestamp);
parse_array(<<>>) ->
[];
?SIMPLE_PARSE_ARRAY($b, Value:8/signed, byte);
?SIMPLE_PARSE_ARRAY($B, Value:8/unsigned, unsignedbyte);
?SIMPLE_PARSE_ARRAY($s, Value:16/signed, short);
?SIMPLE_PARSE_ARRAY($u, Value:16/unsigned, unsignedshort);
?SIMPLE_PARSE_ARRAY($I, Value:32/signed, signedint);
?SIMPLE_PARSE_ARRAY($i, Value:32/unsigned, unsignedint);
?SIMPLE_PARSE_ARRAY($d, Value:64/float, double);
?SIMPLE_PARSE_ARRAY($f, Value:32/float, float);
?SIMPLE_PARSE_ARRAY($l, Value:64/signed, long);
?SIMPLE_PARSE_ARRAY($L, Value:64/signed, long);
parse_array(<<$t, Value:8/unsigned, Rest/binary>>) ->
[{bool, (Value /= 0)} | parse_array(Rest)];
parse_array(<<$D, Before:8/unsigned, After:32/unsigned, Rest/binary>>) ->
[{decimal, {Before, After}} | parse_array(Rest)];
parse_array(<<$F, VLen:32/unsigned, Value:VLen/binary, Rest/binary>>) ->
[{table, parse_table(Value)} | parse_array(Rest)];
parse_array(<<$A, VLen:32/unsigned, Value:VLen/binary, Rest/binary>>) ->
[{array, parse_array(Value)} | parse_array(Rest)];
parse_array(<<$x, VLen:32/unsigned, Value:VLen/binary, Rest/binary>>) ->
[{binary, Value} | parse_array(Rest)];
parse_array(<<$V, Rest/binary>>) ->
[{void, undefined} | parse_array(Rest)].
ensure_content_decoded(Content = #content{properties = Props})
when Props =/= none ->
Content;
ensure_content_decoded(Content = #content{properties_bin = PropBin,
protocol = Protocol})
when PropBin =/= none ->
Content#content{properties = Protocol:decode_properties(
Content#content.class_id, PropBin)}.
clear_decoded_content(Content = #content{properties = none}) ->
Content;
clear_decoded_content(Content = #content{properties_bin = none}) ->
%% Only clear when we can rebuild the properties later in
%% accordance to the content record definition comment - maximum
%% one of properties and properties_bin can be 'none'
Content;
clear_decoded_content(Content = #content{}) ->
Content#content{properties = none}.
assert_utf8(B) ->
case validate_utf8(B) of
ok -> ok;
error -> rabbit_misc:protocol_error(
frame_error, "Malformed UTF-8 in shortstr", [])
end.
validate_utf8(Bin) ->
try
_ = xmerl_ucs:from_utf8(Bin),
ok
catch exit:{ucs, _} ->
error
end.