Packages
rabbit_common
3.11.9
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
Security advisory:
This version has known vulnerabilities.
View advisories
Current section
Files
Jump to
Current section
Files
src/rabbit_control_misc.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-2023 VMware, Inc. or its affiliates. All rights reserved.
%%
-module(rabbit_control_misc).
-export([emitting_map/4, emitting_map/5, emitting_map_with_exit_handler/4,
emitting_map_with_exit_handler/5, wait_for_info_messages/6,
spawn_emitter_caller/7, await_emitters_termination/1,
print_cmd_result/2]).
-spec emitting_map(pid(), reference(), fun(), list()) -> 'ok'.
-spec emitting_map(pid(), reference(), fun(), list(), atom()) -> 'ok'.
-spec emitting_map_with_exit_handler
(pid(), reference(), fun(), list()) -> 'ok'.
-spec emitting_map_with_exit_handler
(pid(), reference(), fun(), list(), 'continue') -> 'ok'.
-type fold_fun() :: fun((Item :: term(), AccIn :: term()) -> AccOut :: term()).
-spec wait_for_info_messages(pid(), reference(), fold_fun(), InitialAcc, timeout(), non_neg_integer()) -> OK | Err when
InitialAcc :: term(), Acc :: term(), OK :: {ok, Acc}, Err :: {error, term()}.
-spec spawn_emitter_caller(node(), module(), atom(), [term()], reference(), pid(), timeout()) -> 'ok'.
-spec await_emitters_termination([pid()]) -> 'ok'.
-spec print_cmd_result(atom(), term()) -> 'ok'.
emitting_map(AggregatorPid, Ref, Fun, List) ->
emitting_map(AggregatorPid, Ref, Fun, List, continue),
AggregatorPid ! {Ref, finished},
ok.
emitting_map(AggregatorPid, Ref, Fun, List, continue) ->
_ = emitting_map0(AggregatorPid, Ref, Fun, List, fun step/4),
ok.
emitting_map_with_exit_handler(AggregatorPid, Ref, Fun, List) ->
emitting_map_with_exit_handler(AggregatorPid, Ref, Fun, List, continue),
AggregatorPid ! {Ref, finished},
ok.
emitting_map_with_exit_handler(AggregatorPid, Ref, Fun, List, continue) ->
_ = emitting_map0(AggregatorPid, Ref, Fun, List, fun step_with_exit_handler/4),
ok.
emitting_map0(AggregatorPid, Ref, Fun, List, StepFun) ->
[StepFun(AggregatorPid, Ref, Fun, Item) || Item <- List].
step(AggregatorPid, Ref, Fun, Item) ->
AggregatorPid ! {Ref, Fun(Item), continue},
ok.
step_with_exit_handler(AggregatorPid, Ref, Fun, Item) ->
Noop = make_ref(),
case rabbit_misc:with_exit_handler(
fun () -> Noop end,
fun () -> Fun(Item) end) of
Noop ->
ok;
Res ->
AggregatorPid ! {Ref, Res, continue},
ok
end.
%% Invokes RPC for async info collection in separate (but linked to
%% the caller) process. Separate process waits for RPC to finish and
%% in case of errors sends them in wait_for_info_messages/5-compatible
%% form to aggregator process. Calling process is then expected to
%% do blocking call of wait_for_info_messages/5.
%%
%% Remote function MUST use calls to emitting_map/4 (and other
%% emitting_map's) to properly deliver requested information to an
%% aggregator process.
%%
%% If for performance reasons several parallel emitting_map's need to
%% be run, remote function MUST NOT return until all this
%% emitting_map's are done. And during all this time remote RPC
%% process MUST be linked to emitting
%% processes. await_emitters_termination/1 helper can be used as a
%% last statement of remote function to ensure this behaviour.
spawn_emitter_caller(Node, Mod, Fun, Args, Ref, Pid, Timeout) ->
_ = spawn_monitor(
fun () ->
case rpc_call_emitter(Node, Mod, Fun, Args, Ref, Pid, Timeout) of
{error, _} = Error ->
Pid ! {Ref, error, Error};
{bad_argument, _} = Error ->
Pid ! {Ref, error, Error};
{badrpc, _} = Error ->
Pid ! {Ref, error, Error};
_ ->
ok
end
end),
ok.
rpc_call_emitter(Node, Mod, Fun, Args, Ref, Pid, Timeout) ->
rabbit_misc:rpc_call(Node, Mod, Fun, Args++[Ref, Pid], Timeout).
%% Aggregator process expects correct numbers of explicits ACKs about
%% finished emission process. While everything is linked, we still
%% need somehow to wait for termination of all emitters before
%% returning from RPC call - otherwise links will be just broken with
%% reason 'normal' and we can miss some errors, and subsequently
%% hang.
await_emitters_termination(Pids) ->
Monitors = [erlang:monitor(process, Pid) || Pid <- Pids],
collect_monitors(Monitors).
collect_monitors([]) ->
ok;
collect_monitors([Monitor|Rest]) ->
receive
{'DOWN', Monitor, process, _Pid, normal} ->
collect_monitors(Rest);
{'DOWN', Monitor, process, _Pid, noproc} ->
%% There is a link and a monitor to a process. Matching
%% this clause means that process has gracefully
%% terminated even before we've started monitoring.
collect_monitors(Rest);
{'DOWN', _, process, Pid, Reason} when Reason =/= normal,
Reason =/= noproc ->
exit({emitter_exit, Pid, Reason})
end.
%% Wait for result of one or more calls to emitting_map-family
%% functions.
%%
%% Number of expected acknowledgments is specified by ChunkCount
%% argument. Most common usage will be with ChunkCount equals to
%% number of live nodes, but it's not mandatory - thus more generic
%% name of 'ChunkCount' was chosen.
wait_for_info_messages(Pid, Ref, Fun, Acc0, Timeout, ChunkCount) ->
_ = notify_if_timeout(Pid, Ref, Timeout),
wait_for_info_messages(Ref, Fun, Acc0, ChunkCount).
wait_for_info_messages(Ref, Fun, Acc0, ChunksLeft) ->
receive
{Ref, finished} when ChunksLeft =:= 1 ->
{ok, Acc0};
{Ref, finished} ->
wait_for_info_messages(Ref, Fun, Acc0, ChunksLeft - 1);
{Ref, {timeout, T}} ->
exit({error, {timeout, (T / 1000)}});
{Ref, []} ->
wait_for_info_messages(Ref, Fun, Acc0, ChunksLeft);
{Ref, Result, continue} ->
wait_for_info_messages(Ref, Fun, Fun(Result, Acc0), ChunksLeft);
{Ref, error, Error} ->
{error, simplify_emission_error(Error)};
{'DOWN', _MRef, process, _Pid, normal} ->
wait_for_info_messages(Ref, Fun, Acc0, ChunksLeft);
{'DOWN', _MRef, process, _Pid, Reason} ->
{error, simplify_emission_error(Reason)};
_Msg ->
wait_for_info_messages(Ref, Fun, Acc0, ChunksLeft)
end.
simplify_emission_error({badrpc, {'EXIT', {{nocatch, EmissionError}, _Stacktrace}}}) ->
EmissionError;
simplify_emission_error({{nocatch, EmissionError}, _Stacktrace}) ->
EmissionError;
simplify_emission_error({error, _} = Error) ->
Error;
simplify_emission_error({bad_argument, _} = Error) ->
Error;
simplify_emission_error(Anything) ->
{error, Anything}.
notify_if_timeout(_, _, infinity) ->
ok;
notify_if_timeout(Pid, Ref, Timeout) ->
erlang:send_after(Timeout, Pid, {Ref, {timeout, Timeout}}).
print_cmd_result(authenticate_user, _Result) -> io:format("Success~n");
print_cmd_result(join_cluster, already_member) -> io:format("The node is already a member of this cluster~n").