Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: cluster linking WIP #12879

Closed
wants to merge 1 commit into from
Closed

feat: cluster linking WIP #12879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
87 changes: 60 additions & 27 deletions apps/emqx/src/emqx_broker.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,11 +244,22 @@ publish(Msg) when is_record(Msg, message) ->
topic => Topic
}),
[];
Msg1 = #message{topic = Topic} ->
PersistRes = persist_publish(Msg1),
route(aggre(emqx_router:match_routes(Topic)), delivery(Msg1), PersistRes)
Msg1 = #message{} ->
do_publish(Msg1);
Msgs when is_list(Msgs) -> do_publish_many(Msgs)
end.

do_publish_many([]) ->
[];
do_publish_many([Msg | T]) ->
do_publish(Msg) ++ do_publish_many(T).

do_publish(#message{topic = Topic} = Msg) ->
PersistRes = persist_publish(Msg),
{Routes, ExtRoutes} = aggre(emqx_router:match_routes(Topic)),
Routes1 = maybe_add_ext_routes(ExtRoutes, Routes, Msg),
route(Routes1, delivery(Msg), PersistRes).

persist_publish(Msg) ->
case emqx_persistent_message:persist(Msg) of
ok ->
Expand Down Expand Up @@ -311,26 +322,40 @@ do_route({To, Node}, Delivery) when Node =:= node() ->
{Node, To, dispatch(To, Delivery)};
do_route({To, Node}, Delivery) when is_atom(Node) ->
{Node, To, forward(Node, To, Delivery, emqx:get_config([rpc, mode]))};
do_route({To, {external, _} = ExtDest}, Delivery) ->
{ExtDest, To, emqx_external_broker:forward(ExtDest, Delivery)};
do_route({To, Group}, Delivery) when is_tuple(Group); is_binary(Group) ->
{share, To, emqx_shared_sub:dispatch(Group, To, Delivery)}.

aggre([]) ->
[];
{[], []};
aggre([#route{topic = To, dest = Node}]) when is_atom(Node) ->
[{To, Node}];
{[{To, Node}], []};
aggre([#route{topic = To, dest = {external, _} = ExtDest}]) ->
{[], [{To, ExtDest}]};
aggre([#route{topic = To, dest = {Group, _Node}}]) ->
[{To, Group}];
{[{To, Group}], []};
aggre(Routes) ->
aggre(Routes, false, []).

aggre([#route{topic = To, dest = Node} | Rest], Dedup, Acc) when is_atom(Node) ->
aggre(Rest, Dedup, [{To, Node} | Acc]);
aggre([#route{topic = To, dest = {Group, _Node}} | Rest], _Dedup, Acc) ->
aggre(Rest, true, [{To, Group} | Acc]);
aggre(Routes, false, {[], []}).

aggre([#route{topic = To, dest = Node} | Rest], Dedup, {Acc, ExtAcc}) when is_atom(Node) ->
aggre(Rest, Dedup, {[{To, Node} | Acc], ExtAcc});
aggre([#route{topic = To, dest = {external, _} = ExtDest} | Rest], Dedup, {Acc, ExtAcc}) ->
aggre(Rest, Dedup, {Acc, [{To, ExtDest} | ExtAcc]});
aggre([#route{topic = To, dest = {Group, _Node}} | Rest], _Dedup, {Acc, ExtAcc}) ->
aggre(Rest, true, {[{To, Group} | Acc], ExtAcc});
aggre([], false, Acc) ->
Acc;
aggre([], true, Acc) ->
lists:usort(Acc).
aggre([], true, {Acc, ExtAcc}) ->
{lists:usort(Acc), lists:usort(ExtAcc)}.

maybe_add_ext_routes([] = _ExtRoutes, Routes, _Msg) ->
Routes;
maybe_add_ext_routes(ExtRoutes, Routes, Msg) ->
case emqx_external_broker:should_route_to_external_dests(Msg) of
true -> Routes ++ ExtRoutes;
false -> Routes
end.

%% @doc Forward message to another node.
-spec forward(
Expand Down Expand Up @@ -643,19 +668,27 @@ maybe_delete_route(Topic) ->

sync_route(Action, Topic, ReplyTo) ->
EnabledOn = emqx_config:get([broker, routing, batch_sync, enable_on]),
case EnabledOn of
all ->
push_sync_route(Action, Topic, ReplyTo);
none ->
regular_sync_route(Action, Topic);
Role ->
case Role =:= mria_config:whoami() of
true ->
push_sync_route(Action, Topic, ReplyTo);
false ->
regular_sync_route(Action, Topic)
end
end.
Res =
case EnabledOn of
all ->
push_sync_route(Action, Topic, ReplyTo);
none ->
regular_sync_route(Action, Topic);
Role ->
case Role =:= mria_config:whoami() of
true ->
push_sync_route(Action, Topic, ReplyTo);
false ->
regular_sync_route(Action, Topic)
end
end,
_ = external_sync_route(Action, Topic),
Res.

external_sync_route(add, Topic) ->
emqx_external_broker:maybe_add_route(Topic);
external_sync_route(delete, Topic) ->
emqx_external_broker:maybe_delete_route(Topic).

push_sync_route(Action, Topic, Opts) ->
emqx_router_syncer:push(Action, Topic, node(), Opts).
Expand Down
117 changes: 117 additions & 0 deletions apps/emqx/src/emqx_external_broker.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
%%--------------------------------------------------------------------
%% Copyright (c) 2024 EMQ Technologies Co., Ltd. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%--------------------------------------------------------------------

-module(emqx_external_broker).

-callback forward(emqx_router:external_dest(), emqx_types:delivery()) ->
emqx_types:deliver_result().

-callback should_route_to_external_dests(emqx_types:message()) -> boolean().

-callback maybe_add_route(emqx_types:topic()) -> ok.
-callback maybe_delete_route(emqx_types:topic()) -> ok.

-export([
provider/0,
register_provider/1,
unregister_provider/1,
forward/2,
should_route_to_external_dests/1,
maybe_add_route/1,
maybe_delete_route/1
]).

-include("logger.hrl").

-define(PROVIDER, {?MODULE, external_broker}).

-define(safe_with_provider(IfRegistered, IfNotRegistered),
case persistent_term:get(?PROVIDER, undefined) of
undefined ->
IfNotRegistered;
Provider ->
try
Provider:IfRegistered
catch
Err:Reason:St ->
?SLOG(error, #{
msg => "external_broker_crashed",
provider => Provider,
callback => ?FUNCTION_NAME,
stacktrace => St,
error => Err,
reason => Reason
}),
{error, Reason}
end
end
).

%% TODO: provider API copied from emqx_external_traces,
%% but it can be moved to a common module.

%%--------------------------------------------------------------------
%% Provider API
%%--------------------------------------------------------------------

-spec register_provider(module()) -> ok | {error, term()}.
register_provider(Module) when is_atom(Module) ->
case is_valid_provider(Module) of
true ->
persistent_term:put(?PROVIDER, Module);
false ->
{error, invalid_provider}
end.

-spec unregister_provider(module()) -> ok | {error, term()}.
unregister_provider(Module) ->
case persistent_term:get(?PROVIDER, undefined) of
Module ->
persistent_term:erase(?PROVIDER),
ok;
_ ->
{error, not_registered}
end.

-spec provider() -> module() | undefined.
provider() ->
persistent_term:get(?PROVIDER, undefined).

%%--------------------------------------------------------------------
%% Broker API
%%--------------------------------------------------------------------

forward(ExternalDest, Delivery) ->
?safe_with_provider(?FUNCTION_NAME(ExternalDest, Delivery), {error, unknown_dest}).

should_route_to_external_dests(Message) ->
?safe_with_provider(?FUNCTION_NAME(Message), false).

maybe_add_route(Topic) ->
?safe_with_provider(?FUNCTION_NAME(Topic), ok).

maybe_delete_route(Topic) ->
?safe_with_provider(?FUNCTION_NAME(Topic), ok).

%%--------------------------------------------------------------------
%% Internal functions
%%--------------------------------------------------------------------

is_valid_provider(Module) ->
lists:all(
fun({F, A}) -> erlang:function_exported(Module, F, A) end,
?MODULE:behaviour_info(callbacks)
).
52 changes: 31 additions & 21 deletions apps/emqx/src/emqx_router.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,12 @@
deinit_schema/0
]).

-export_type([dest/0]).
-export_type([dest/0, external_dest/0]).
-export_type([schemavsn/0]).

-type group() :: binary().
-type dest() :: node() | {group(), node()}.
-type external_dest() :: {external, term()}.
-type dest() :: node() | {group(), node()} | external_dest().
-type schemavsn() :: v1 | v2.

%% Operation :: {add, ...} | {delete, ...}.
Expand All @@ -107,7 +108,14 @@
unused = [] :: nil()
}).

-define(node_patterns(Node), [Node, {'_', Node}]).
-define(dest_patterns(NodeOrExtDest),
case is_atom(NodeOrExtDest) of
%% node
true -> [NodeOrExtDest, {'_', NodeOrExtDest}];
%% external destination
false -> [NodeOrExtDest]
end
).

-define(UNSUPPORTED, unsupported).

Expand Down Expand Up @@ -306,14 +314,14 @@ print_routes(Topic) ->
match_routes(Topic)
).

-spec cleanup_routes(node()) -> ok.
cleanup_routes(Node) ->
cleanup_routes(get_schema_vsn(), Node).
-spec cleanup_routes(node() | external_dest()) -> ok.
cleanup_routes(NodeOrExtDest) ->
cleanup_routes(get_schema_vsn(), NodeOrExtDest).

cleanup_routes(v2, Node) ->
cleanup_routes_v2(Node);
cleanup_routes(v1, Node) ->
cleanup_routes_v1(Node).
cleanup_routes(v2, NodeOrExtDest) ->
cleanup_routes_v2(NodeOrExtDest);
cleanup_routes(v1, NodeOrExtDest) ->
cleanup_routes_v1(NodeOrExtDest).

-spec foldl_routes(fun((emqx_types:route(), Acc) -> Acc), Acc) -> Acc.
foldl_routes(FoldFun, AccIn) ->
Expand Down Expand Up @@ -430,19 +438,19 @@ has_route_v1(Topic, Dest) ->
has_route_tab_entry(Topic, Dest) ->
[] =/= ets:match(?ROUTE_TAB, #route{topic = Topic, dest = Dest}).

cleanup_routes_v1(Node) ->
cleanup_routes_v1(NodeOrExtDest) ->
?with_fallback(
lists:foreach(
fun(Pattern) ->
throw_unsupported(mria:match_delete(?ROUTE_TAB, make_route_rec_pat(Pattern)))
end,
?node_patterns(Node)
?dest_patterns(NodeOrExtDest)
),
cleanup_routes_v1_fallback(Node)
cleanup_routes_v1_fallback(NodeOrExtDest)
).

cleanup_routes_v1_fallback(Node) ->
Patterns = [make_route_rec_pat(P) || P <- ?node_patterns(Node)],
cleanup_routes_v1_fallback(NodeOrExtDest) ->
Patterns = [make_route_rec_pat(P) || P <- ?dest_patterns(NodeOrExtDest)],
mria:transaction(?ROUTE_SHARD, fun() ->
[
mnesia:delete_object(?ROUTE_TAB, Route, write)
Expand Down Expand Up @@ -525,7 +533,7 @@ has_route_v2(Topic, Dest) ->
has_route_tab_entry(Topic, Dest)
end.

cleanup_routes_v2(Node) ->
cleanup_routes_v2(NodeOrExtDest) ->
?with_fallback(
lists:foreach(
fun(Pattern) ->
Expand All @@ -537,18 +545,18 @@ cleanup_routes_v2(Node) ->
),
throw_unsupported(mria:match_delete(?ROUTE_TAB, make_route_rec_pat(Pattern)))
end,
?node_patterns(Node)
?dest_patterns(NodeOrExtDest)
),
cleanup_routes_v2_fallback(Node)
cleanup_routes_v2_fallback(NodeOrExtDest)
).

cleanup_routes_v2_fallback(Node) ->
cleanup_routes_v2_fallback(NodeOrExtDest) ->
%% NOTE
%% No point in transaction here because all the operations on filters table are dirty.
ok = ets:foldl(
fun(#routeidx{entry = K}, ok) ->
case get_dest_node(emqx_topic_index:get_id(K)) of
Node ->
NodeOrExtDest ->
mria:dirty_delete(?ROUTE_TAB_FILTERS, K);
_ ->
ok
Expand All @@ -560,7 +568,7 @@ cleanup_routes_v2_fallback(Node) ->
ok = ets:foldl(
fun(#route{dest = Dest} = Route, ok) ->
case get_dest_node(Dest) of
Node ->
NodeOrExtDest ->
mria:dirty_delete_object(?ROUTE_TAB, Route);
_ ->
ok
Expand All @@ -570,6 +578,8 @@ cleanup_routes_v2_fallback(Node) ->
?ROUTE_TAB
).

get_dest_node({external, _} = ExtDest) ->
ExtDest;
get_dest_node({_, Node}) ->
Node;
get_dest_node(Node) ->
Expand Down