Current section

Files

Jump to
ra src ra_worker.erl
Raw

src/ra_worker.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) 2017-2023 Broadcom. All Rights Reserved. The term Broadcom refers to Broadcom Inc. and/or its subsidiaries.
%%
%% @hidden
-module(ra_worker).
-behaviour(gen_server).
-include("ra.hrl").
-export([start_link/1,
queue_work/3]).
-export([init/1,
handle_call/3,
handle_cast/2,
handle_info/2,
terminate/2,
code_change/3]).
-record(state, {log_id = "" :: unicode:chardata()
}).
%%% ra worker responsible for doing background work for a ra server.
%%%
%%% this could include, writing snapshots or checkpoints or log
%%% compaction
%%%===================================================================
%%% API functions
%%%===================================================================
start_link(Config) ->
gen_server:start_link(?MODULE, Config,
[{hibernate_after, 30000}]).
queue_work(Pid, FunOrMfa, ErrFun) when is_pid(Pid) ->
gen_server:cast(Pid, {work, FunOrMfa, ErrFun}).
%%%===================================================================
%%% gen_server callbacks
%%%===================================================================
init(#{id := Id} = Config) when is_map(Config) ->
process_flag(trap_exit, true),
LogId = maps:get(friendly_name, Config,
lists:flatten(io_lib:format("~w", [Id]))),
{ok, #state{log_id = LogId}}.
handle_call(_, _From, State) ->
{reply, ok, State}.
handle_cast({work, FunOrMfa, ErrFun}, State) ->
case FunOrMfa of
{M, F, Args} ->
try erlang:apply(M, F, Args) of
_ ->
ok
catch Type:Err:Stack ->
?WARN("~ts: worker encounted error ~0p of type ~s, Stack:~n~p",
[State#state.log_id, Err, Type, Stack]),
ErrFun({Type, Err}),
ok
end;
_ when is_function(FunOrMfa) ->
try FunOrMfa() of
_ ->
ok
catch Type:Err:Stack ->
?WARN("~ts: worker encounted error ~0p of type ~s, Stack:~n~p",
[State#state.log_id, Err, Type, Stack]),
ErrFun({Type, Err})
end,
ok
end,
erlang:garbage_collect(),
%% TODO: this wont clear up the bg_work funs, fix this some day
{noreply, State}.
handle_info(_Info, State) ->
{noreply, State}.
terminate(_Reason, _State) ->
ok.
code_change(_OldVsn, State, _Extra) ->
{ok, State}.
%%%===================================================================
%%% Internal functions
%%%===================================================================