%% @hidden -module(ra_log). -compile([inline_list_funcs]). -export([init/1, close/1, append/2, write/2, append_sync/2, write_sync/2, take/3, last_index_term/1, set_last_index/2, handle_event/2, last_written/1, fetch/2, fetch_term/2, next_index/1, snapshot_state/1, set_snapshot_state/2, install_snapshot/3, recover_snapshot/1, snapshot_index_term/1, update_release_cursor/5, can_write/1, exists/2, overview/1, %% config write_config/2, read_config/1, delete_everything/1, release_resources/2 ]). -include("ra.hrl"). -define(METRICS_CACHE_POS, 2). -define(METRICS_OPEN_MEM_TBL_POS, 3). -define(METRICS_CLOSED_MEM_TBL_POS, 4). -define(METRICS_SEGMENT_POS, 5). -define(DEFAULT_RESEND_WINDOW_SEC, 20). -define(SNAPSHOT_INTERVAL, 4096). -define(LOG_APPEND_TIMEOUT, 5000). -type ra_meta_key() :: atom(). -type segment_ref() :: {From :: ra_index(), To :: ra_index(), File :: string()}. -type event_body() :: {written, {From :: ra_index(), To :: ra_index(), ToTerm :: ra_term()}} | {segments, ets:tid(), [segment_ref()]} | {resend_write, ra_index()} | {snapshot_written, ra_idxterm()}. -type event() :: {ra_log_event, event_body()}. -type effect() :: {delete_snapshot, Dir :: file:filename(), ra_idxterm()}. %% logs can have effects too so that they can be coordinated with other state %% such as avoiding to delete old snapshots whilst they are still being %% replicated -type effects() :: [effect() | ra_snapshot:effect()]. -record(?MODULE, {uid :: ra_uid(), log_id :: unicode:chardata(), directory :: file:filename(), snapshot_interval = ?SNAPSHOT_INTERVAL :: non_neg_integer(), snapshot_module :: module(), resend_window_seconds = ?DEFAULT_RESEND_WINDOW_SEC :: integer(), wal :: atom(), % registered name %% mutable data below first_index = -1 :: ra_index(), last_index = -1 :: -1 | ra_index(), last_term = 0 :: ra_term(), last_written_index_term = {0, 0} :: ra_idxterm(), segment_refs = [] :: [segment_ref()], open_segments = ra_flru:new(5, fun flru_handler/1) :: ra_flru:state(), snapshot_state :: ra_snapshot:state(), % if this is set a snapshot write is in progress for the % index specified cache = #{} :: #{ra_index() => {ra_term(), log_entry()}}, last_resend_time :: maybe(integer()) }). -opaque state() :: #?MODULE{}. -type ra_log_init_args() :: #{uid := ra_uid(), log_id => unicode:chardata(), data_dir => string(), wal => atom(), snapshot_interval => non_neg_integer(), resend_window => integer(), max_open_segments => non_neg_integer(), snapshot_module => module()}. -export_type([state/0, ra_log_init_args/0, ra_meta_key/0, segment_ref/0, event/0, event_body/0, effect/0 ]). -spec init(ra_log_init_args()) -> state(). init(#{uid := UId} = Conf) -> %% overriding the data_dir is only here for test compatibility %% as it needs to match what the segment writer has it makes no real %% sense to make it independently configurable Dir = case Conf of #{data_dir := D} -> D; _ -> ra_env:server_data_dir(UId) end, MaxOpen = maps:get(max_open_segments, Conf, 5), SnapModule = maps:get(snapshot_module, Conf, ?DEFAULT_SNAPSHOT_MODULE), Wal = maps:get(wal, Conf, ra_log_wal), %% this has to be patched by ra_server LogId = maps:get(log_id, Conf, UId), ResendWindow = maps:get(resend_window, Conf, ?DEFAULT_RESEND_WINDOW_SEC), SnapInterval = maps:get(snapshot_interval, Conf, ?SNAPSHOT_INTERVAL), SnapshotsDir = filename:join(Dir, "snapshots"), %% ensure directories are there ok = ra_lib:make_dir(Dir), ok = ra_lib:make_dir(SnapshotsDir), % initialise metrics for this server true = ets:insert(ra_log_metrics, {UId, 0, 0, 0, 0}), SnapshotState = ra_snapshot:init(UId, SnapModule, SnapshotsDir), {SnapIdx, SnapTerm} = case ra_snapshot:current(SnapshotState) of undefined -> {-1, -1}; Curr -> Curr end, % recover current range and any references to segments % this queries the segment writer and thus blocks until any % segments it is currently processed have been finished {{FirstIdx, LastIdx0}, SegRefs} = case recover_range(UId, SnapIdx) of {undefined, SRs} -> {{-1, -1}, SRs}; R -> R end, % recover last snapshot file %% assert there is no gap between the snapshot %% and the first index in the log case (FirstIdx - SnapIdx) > 1 of true -> exit({corrupt_log, gap_between_snapshot_and_first_index, {SnapIdx, FirstIdx}}); false -> ok end, State000 = #?MODULE{directory = Dir, uid = UId, log_id = LogId, first_index = max(SnapIdx + 1, FirstIdx), last_index = max(SnapIdx, LastIdx0), segment_refs = SegRefs, snapshot_state = SnapshotState, snapshot_interval = SnapInterval, wal = Wal, open_segments = ra_flru:new(MaxOpen, fun flru_handler/1), resend_window_seconds = ResendWindow, snapshot_module = SnapModule}, LastIdx = State000#?MODULE.last_index, % recover the last term {LastTerm0, State00} = case LastIdx of SnapIdx -> {SnapTerm, State000}; -1 -> {0, State000}; LI -> fetch_term(LI, State000) end, LastTerm = ra_lib:default(LastTerm0, -1), State0 = State00#?MODULE{last_term = LastTerm, last_written_index_term = {LastIdx, LastTerm}}, % initialized with a default 0 index 0 term dummy value % and an empty meta data map State = maybe_append_first_entry(State0), ?DEBUG("~s: ra_log:init recovered last_index_term ~w" " first index ~b~n", [State#?MODULE.log_id, last_index_term(State), State#?MODULE.first_index]), delete_segments(SnapIdx, State). -spec close(state()) -> ok. close(#?MODULE{uid = UId, open_segments = OpenSegs}) -> % deliberately ignoring return value % close all open segments _ = ra_flru:evict_all(OpenSegs), %% delete ra_log_metrics record catch ets:delete(ra_log_metrics, UId), %% inserted in ra_snapshot but it doesn't havea terminate callback so %% deleting ets table here catch ets:delete(ra_log_snapshot_state, UId), ok. -spec append(Entry :: log_entry(), State :: state()) -> state() | no_return(). append(Entry, #?MODULE{last_index = LastIdx} = State0) when element(1, Entry) =:= LastIdx + 1 -> wal_write(State0, Entry); append({Idx, _, _}, #?MODULE{last_index = LastIdx}) -> Msg = lists:flatten(io_lib:format("tried writing ~b - expected ~b", [Idx, LastIdx+1])), exit({integrity_error, Msg}). -spec write(Entries :: [log_entry()], State :: state()) -> {ok, state()} | {error, {integrity_error, term()} | wal_down}. write([{FstIdx, _, _} = First | Rest] = Entries, #?MODULE{last_index = LastIdx, snapshot_state = SnapState} = State00) when FstIdx =< LastIdx + 1 andalso FstIdx >= 0 -> case ra_snapshot:current(SnapState) of {SnapIdx, _} when FstIdx =:= SnapIdx + 1 -> % it is the next entry after a snapshot % we need to tell the wal to truncate as we % are not going to receive any entries prior to the snapshot State0 = wal_truncate_write(State00, First), % write the rest normally % TODO: batch api for wal write_entries(Rest, State0); _ -> write_entries(Entries, State00) end; write([], State) -> {ok, State}; write([{Idx, _, _} | _], #?MODULE{uid = UId, last_index = LastIdx}) -> Msg = lists:flatten(io_lib:format("~p: ra_log:write/2 " "tried writing ~b - expected ~b", [UId, Idx, LastIdx+1])), {error, {integrity_error, Msg}}. -spec take(ra_index(), non_neg_integer(), state()) -> {[log_entry()], state()}. take(Start, Num, #?MODULE{uid = UId, first_index = FirstIdx, last_index = LastIdx} = State) when Start >= FirstIdx andalso Start =< LastIdx -> % 0. Check that the request isn't outside of first_index and last_index % 1. Check the local cache for any unflushed entries, carry reminders % 2. Check ra_log_open_mem_tables % 3. Check ra_log_closed_mem_tables in turn % 4. Check on disk segments in turn case cache_take(Start, Num, State) of {Entries, MetricOps0, undefined} -> ok = update_metrics(UId, MetricOps0), {Entries, State}; {Entries0, MetricOps0, Rem0} -> case open_mem_tbl_take(UId, Rem0, MetricOps0, Entries0) of {Entries1, MetricOps, undefined} -> ok = update_metrics(UId, MetricOps), {Entries1, State}; {Entries1, MetricOps1, Rem1} -> case closed_mem_tbl_take(UId, Rem1, MetricOps1, Entries1) of {Entries2, MetricOps, undefined} -> ok = update_metrics(UId, MetricOps), {Entries2, State}; {Entries2, MetricOps2, {S, E} = Rem2} -> case catch segment_take(State, Rem2, Entries2) of {Open, undefined, Entries} -> MOp = {?METRICS_SEGMENT_POS, E - S + 1}, ok = update_metrics(UId, [MOp | MetricOps2]), {Entries, State#?MODULE{open_segments = Open}} end end end end; take(_, _, State) -> {[], State}. -spec last_index_term(state()) -> ra_idxterm(). last_index_term(#?MODULE{last_index = LastIdx, last_term = LastTerm}) -> {LastIdx, LastTerm}. -spec last_written(state()) -> ra_idxterm(). last_written(#?MODULE{last_written_index_term = LWTI}) -> LWTI. %% forces the last index and last written index back to a prior index -spec set_last_index(ra_index(), state()) -> {ok, state()} | {not_found, state()}. set_last_index(Idx, #?MODULE{last_written_index_term = {LWIdx0, _}} = State0) -> case fetch_term(Idx, State0) of {undefined, State} -> {not_found, State}; {Term, State1} -> LWIdx = min(Idx, LWIdx0), {LWTerm, State2} = fetch_term(LWIdx, State1), %% this should always be found but still assert just in case true = LWTerm =/= undefined, {ok, State2#?MODULE{last_index = Idx, last_term = Term, last_written_index_term = {LWIdx, LWTerm}}} end. -spec handle_event(event_body(), state()) -> {state(), [effect()]}. handle_event({written, {FromIdx, ToIdx, Term}}, #?MODULE{last_written_index_term = {LastWrittenIdx0, LastWrittenTerm0}, snapshot_state = SnapState} = State0) when FromIdx =< LastWrittenIdx0 + 1 -> MaybeCurrent = ra_snapshot:current(SnapState), % We need to ignore any written events for the same index % but in a prior term if we do not we may end up confirming % to a leader writes that have not yet % been fully flushed case fetch_term(ToIdx, State0) of {Term, State} when is_integer(Term) -> % this case truncation shouldn't be too expensive as the cache % only contains the unflushed window of entries typically less than % 10ms worth of entries truncate_cache(FromIdx, ToIdx, State#?MODULE{last_written_index_term = {ToIdx, Term}}, []); {undefined, State} when FromIdx =< element(1, MaybeCurrent ) -> % A snapshot happened before the written event came in % This can only happen on a leader when consensus is achieved by % followers returning appending the entry and the leader committing % and processing a snapshot before the written event comes in. % ensure last_written_index_term does not go backwards LastWrittenIdxTerm = {max(LastWrittenIdx0, ToIdx), max(LastWrittenTerm0, Term)}, {State#?MODULE{last_written_index_term = LastWrittenIdxTerm}, []}; {_X, State} -> ?DEBUG("~s: written event did not find term ~b for index ~b " "found ~w", [State#?MODULE.log_id, Term, ToIdx, _X]), {State, []} end; handle_event({written, {FromIdx, _, _}}, %% ToIdx, Term #?MODULE{log_id = LogId, last_written_index_term = {LastWrittenIdx, _}} = State0) when FromIdx > LastWrittenIdx + 1 -> % leaving a gap is not ok - resend from cache Expected = LastWrittenIdx + 1, ?DEBUG("~s: ra_log: written gap detected at ~b expected ~b!", [LogId, FromIdx, Expected]), {resend_from(Expected, State0), []}; handle_event({segments, Tid, NewSegs}, #?MODULE{uid = UId, open_segments = Open0, segment_refs = SegmentRefs} = State0) -> ClosedTables = closed_mem_tables(UId), Active = lists:takewhile(fun ({_, _, _, _, T}) -> T =/= Tid end, ClosedTables), % not fast but we rarely should have more than one or two closed tables % at any time Obsolete = ClosedTables -- Active, TidsToDelete = [begin %% first delete the entry in the closed table lookup true = ets:delete_object(ra_log_closed_mem_tables, ClosedTbl), T end || {_, _, _, _, T} = ClosedTbl <- Obsolete], ok = ra_log_ets:delete_tables(TidsToDelete), %% check if any of the updated segrefs refer to open segments %% we close these segments so that they can be re-opened with updated %% indexes if needed Open = lists:foldl(fun ({_, _, F}, Acc0) -> case ra_flru:evict(F, Acc0) of {_, Acc} -> Acc; error -> Acc0 end end, Open0, SegmentRefs), % compact seg ref list so that only the latest range for a segment % file has an entry {State0#?MODULE{segment_refs = compact_seg_refs(NewSegs ++ SegmentRefs), open_segments = Open}, []}; handle_event({snapshot_written, {Idx, _} = Snap}, #?MODULE{snapshot_state = SnapState0} = State0) -> % delete any segments outside of first_index State = delete_segments(Idx, State0), SnapState = ra_snapshot:complete_snapshot(Snap, SnapState0), %% delete old snapshot files %% This is done as an effect %% so that if an old snapshot is still being replicated %% the cleanup can be delayed until it is safe Effects = [{delete_snapshot, ra_snapshot:directory(SnapState), ra_snapshot:current(SnapState0)}], %% do not set last written index here as the snapshot may %% be for a past index {State#?MODULE{first_index = Idx + 1, snapshot_state = SnapState}, Effects}; handle_event({resend_write, Idx}, State) -> % resend missing entries from cache. % The assumption is they are available in the cache {resend_from(Idx, State), []}. -spec next_index(state()) -> ra_index(). next_index(#?MODULE{last_index = LastIdx}) -> LastIdx + 1. -spec fetch(ra_index(), state()) -> {maybe(log_entry()), state()}. fetch(Idx, State0) -> case take(Idx, 1, State0) of {[], State} -> {undefined, State}; {[Entry], State} -> {Entry, State} end. -spec fetch_term(ra_index(), state()) -> {maybe(ra_term()), state()}. fetch_term(Idx, #?MODULE{last_index = LastIdx, first_index = FirstIdx} = State0) when Idx < FirstIdx orelse Idx > LastIdx -> {undefined, State0}; fetch_term(Idx, #?MODULE{cache = Cache, uid = UId} = State0) -> case Cache of #{Idx := {Term, _}} -> {Term, State0}; _ -> case ets:lookup(ra_log_open_mem_tables, UId) of [{_, From, To, Tid}] when Idx >= From andalso Idx =< To -> Term = ets:lookup_element(Tid, Idx, 2), {Term, State0}; _ -> case closed_mem_table_term_query(Idx, UId) of undefined -> segment_term_query(Idx, State0); Term -> {Term, State0} end end end. -spec snapshot_state(State :: state()) -> ra_snapshot:state(). snapshot_state(State) -> State#?MODULE.?FUNCTION_NAME. -spec set_snapshot_state(ra_snapshot:state(), state()) -> state(). set_snapshot_state(SnapState, State) -> State#?MODULE{snapshot_state = SnapState}. -spec install_snapshot(ra_idxterm(), ra_snapshot:state(), state()) -> state(). install_snapshot({Idx, _} = IdxTerm, SnapState, State0) -> State = delete_segments(Idx, State0), State#?MODULE{snapshot_state = SnapState, first_index = Idx + 1, last_index = Idx, last_written_index_term = IdxTerm}. -spec recover_snapshot(State :: state()) -> maybe({ra_snapshot:meta(), term()}). recover_snapshot(#?MODULE{snapshot_state = SnapState}) -> case ra_snapshot:recover(SnapState) of {ok, Meta, MacState} -> {Meta, MacState}; {error, no_current_snapshot} -> undefined end. -spec snapshot_index_term(State :: state()) -> maybe(ra_idxterm()). snapshot_index_term(#?MODULE{snapshot_state = SS}) -> ra_snapshot:current(SS). -spec update_release_cursor(Idx :: ra_index(), Cluster :: ra_cluster(), MacVersion :: ra_machine:version(), MacState :: term(), State :: state()) -> {state(), effects()}. update_release_cursor(Idx, Cluster, MacVersion, MacState, #?MODULE{snapshot_state = SnapState} = State) -> case ra_snapshot:pending(SnapState) of undefined -> update_release_cursor0(Idx, Cluster, MacVersion, MacState, State); _ -> % if a snapshot is in progress don't even evaluate {State, []} end. update_release_cursor0(Idx, Cluster, MacVersion, MacState, #?MODULE{segment_refs = SegRefs, snapshot_state = SnapState, snapshot_interval = SnapInter} = State0) -> ClusterServerIds = maps:keys(Cluster), SnapLimit = case ra_snapshot:current(SnapState) of undefined -> SnapInter; {I, _} -> I + SnapInter end, Meta = #{index => Idx, cluster => ClusterServerIds, machine_version => MacVersion}, % The release cursor index is the last entry _not_ contributing % to the current state. I.e. the last entry that can be discarded. % Check here if any segments can be release. case lists:any(fun({_, To, _}) when To =< Idx -> true; (_) -> false end, SegRefs) of true -> % segments can be cleared up % take a snapshot at the release_cursor % TODO: here we use the current cluster configuration in % the snapshot, % _not_ the configuration at the snapshot point. % Given cluster changes % are applied as they are received I cannot think of any scenarios % where this can cause a problem. That said there may % well be :dragons: here. % The MacState is a reference to the state at % the release_cursor point. % It can be some dehydrated form of the state itself % or a reference for external storage (e.g. ETS table) case fetch_term(Idx, State0) of {undefined, _} -> exit({term_not_found_for_index, Idx}); {Term, State} -> write_snapshot(Meta#{term => Term}, MacState, State) end; false when Idx > SnapLimit -> %% periodically take snapshots event if segments cannot be cleared %% up case fetch_term(Idx, State0) of {undefined, State} -> {State, []}; {Term, State} -> write_snapshot(Meta#{term => Term}, MacState, State) end; false -> {State0, []} end. -spec append_sync(Entry :: log_entry(), State :: state()) -> state() | no_return(). append_sync({Idx, Term, _} = Entry, Log0) -> Log = append(Entry, Log0), await_written_idx(Idx, Term, Log). -spec write_sync(Entries :: [log_entry()], State :: state()) -> {ok, state()} | {error, {integrity_error, term()} | wal_down}. write_sync(Entries, Log0) -> {Idx, Term, _} = lists:last(Entries), case ra_log:write(Entries, Log0) of {ok, Log} -> {ok, await_written_idx(Idx, Term, Log)}; {error, _} = Err -> Err end. -spec can_write(state()) -> boolean(). can_write(#?MODULE{wal = Wal}) -> undefined =/= whereis(Wal). -spec exists(ra_idxterm(), state()) -> {boolean(), state()}. exists({Idx, Term}, Log0) -> case fetch_term(Idx, Log0) of {Term, Log} when is_integer(Term) -> {true, Log}; {_, Log} -> {false, Log} end. -spec overview(state()) -> map(). overview(#?MODULE{last_index = LastIndex, last_written_index_term = LWIT, segment_refs = Segs, snapshot_state = SnapshotState, open_segments = OpenSegs}) -> #{type => ?MODULE, last_index => LastIndex, last_written_index_term => LWIT, num_segments => length(Segs), open_segments => ra_flru:size(OpenSegs), snapshot_index => case ra_snapshot:current(SnapshotState) of undefined -> undefined; {I, _} -> I end }. -spec write_config(ra_server:config(), state()) -> ok. write_config(Config0, #?MODULE{directory = Dir}) -> ConfigPath = filename:join(Dir, "config"), % clean config of potentially unserialisable data Config = maps:without([parent], Config0), ok = ra_lib:write_file(ConfigPath, list_to_binary(io_lib:format("~p.", [Config]))), ok. read_config(Dir) -> ConfigPath = filename:join(Dir, "config"), case filelib:is_file(ConfigPath) of true -> {ok, [C]} = file:consult(ConfigPath), {ok, C}; false -> not_found end. -spec delete_everything(state()) -> ok. delete_everything(#?MODULE{directory = Dir} = Log) -> _ = close(Log), try ra_lib:recursive_delete(Dir) of ok -> ok catch _:_ = Err -> ?WARN("ra_log:delete_everything/1 failed to delete " "directory ~s~n Error: ~p~n", [Dir, Err]) end, ok. -spec release_resources(non_neg_integer(), state()) -> state(). release_resources(MaxOpenSegments, #?MODULE{open_segments = OpenSegs} = State) -> % close all open segments % deliberately ignoring return value _ = ra_flru:evict_all(OpenSegs), %% open a new segment with the new max open segment value State#?MODULE{open_segments = ra_flru:new(MaxOpenSegments, fun flru_handler/1)}. %%% Local functions %% deletes all segments where the last index is lower or equal to %% the Idx argumement delete_segments(Idx, #?MODULE{log_id = LogId, uid = UId, open_segments = OpenSegs0, segment_refs = SegRefs0} = State0) -> case lists:partition(fun({_, To, _}) when To > Idx -> true; (_) -> false end, SegRefs0) of {_, []} -> State0; {Active, [Pivot | _] = Obsolete} -> ObsoleteKeys = [element(3, O) || O <- Obsolete], % close any open segments OpenSegs = lists:foldl(fun (K, OS0) -> case ra_flru:evict(K, OS0) of {_, OS} -> OS; error -> OS0 end end, OpenSegs0, ObsoleteKeys), ok = ra_log_segment_writer:truncate_segments(UId, Pivot), ?DEBUG("~s: ~b obsolete segments at ~b - remaining: ~b", [LogId, length(ObsoleteKeys), Idx, length(Active)]), State0#?MODULE{open_segments = OpenSegs, segment_refs = Active} end. wal_truncate_write(#?MODULE{uid = UId, cache = Cache, wal = Wal} = State, {Idx, Term, Data}) -> % this is the next write after a snapshot was taken or received % we need to indicate to the WAL that this may be a non-contiguous write % and that prior entries should be considered stale ok = ra_log_wal:truncate_write({UId, self()}, Wal, Idx, Term, Data), State#?MODULE{last_index = Idx, last_term = Term, cache = Cache#{Idx => {Term, Data}}}. wal_write(#?MODULE{uid = UId, cache = Cache, wal = Wal} = State, {Idx, Term, Data}) -> case ra_log_wal:write({UId, self()}, Wal, Idx, Term, Data) of ok -> State#?MODULE{last_index = Idx, last_term = Term, cache = Cache#{Idx => {Term, Data}}}; {error, wal_down} -> exit(wal_down) end. wal_write_batch(#?MODULE{uid = UId, cache = Cache0, wal = Wal} = State, Entries) -> WriterId = {UId, self()}, {WalCommands, Cache} = lists:foldl(fun ({Idx, Term, Data}, {WC, C0}) -> WalC = {append, WriterId, Idx, Term, Data}, {[WalC | WC], C0#{Idx => {Term, Data}}} end, {[], Cache0}, Entries), [{_, _, LastIdx, LastTerm, _} | _] = WalCommands, case ra_log_wal:write_batch(Wal, lists:reverse(WalCommands)) of ok -> State#?MODULE{last_index = LastIdx, last_term = LastTerm, cache = Cache}; {error, wal_down} -> exit(wal_down) end. truncate_cache(FromIdx, ToIdx, #?MODULE{cache = Cache0, last_index = LastIdx} = State, Effects) -> Cache = case ToIdx - FromIdx < LastIdx - ToIdx of true -> %% if the range to be deleted is smaller than the %% remaining range truncate the cache by removing entries cache_without(FromIdx, ToIdx, Cache0); false -> %% if there are fewer entries left than to be removed %% extract the remaning entries cache_with(ToIdx + 1, LastIdx, Cache0, #{}) end, {State#?MODULE{cache = Cache}, Effects}. cache_with(FromIdx, ToIdx, _, Cache) when FromIdx > ToIdx -> Cache; cache_with(From, To, Source, Cache) -> cache_with(From + 1, To, Source, Cache#{From => maps:get(From, Source)}). cache_without(Idx, Idx, Cache) -> maps:remove(Idx, Cache); cache_without(FromIdx, ToIdx, Cache) -> cache_without(FromIdx + 1, ToIdx, maps:remove(FromIdx, Cache)). update_metrics(Id, Ops) -> _ = ets:update_counter(ra_log_metrics, Id, Ops), ok. open_mem_tbl_take(Id, {Start0, End}, MetricOps, Acc0) -> case ets:lookup(ra_log_open_mem_tables, Id) of [{_, TStart, TEnd, Tid}] -> {Entries, Count, Rem} = mem_tbl_take({Start0, End}, TStart, TEnd, Tid, 0, Acc0), {Entries, [{?METRICS_OPEN_MEM_TBL_POS, Count} | MetricOps], Rem}; [] -> {Acc0, MetricOps, {Start0, End}} end. closed_mem_tbl_take(Id, {Start0, End}, MetricOps, Acc0) -> case closed_mem_tables(Id) of [] -> {Acc0, MetricOps, {Start0, End}}; Tables -> {Entries, Count, Rem} = lists:foldl(fun({_, _, TblSt, TblEnd, Tid}, {Ac, Count, Range}) -> mem_tbl_take(Range, TblSt, TblEnd, Tid, Count, Ac) end, {Acc0, 0, {Start0, End}}, Tables), {Entries, [{?METRICS_CLOSED_MEM_TBL_POS, Count} | MetricOps], Rem} end. closed_mem_table_term_query(Idx, Id) -> case closed_mem_tables(Id) of [] -> undefined; Tables -> closed_mem_table_term_query0(Idx, Tables) end. closed_mem_table_term_query0(_Idx, []) -> undefined; closed_mem_table_term_query0(Idx, [{_, _, From, To, Tid} | _Tail]) when Idx >= From andalso Idx =< To -> ets:lookup_element(Tid, Idx, 2); closed_mem_table_term_query0(Idx, [_ | Tail]) -> closed_mem_table_term_query0(Idx, Tail). closed_mem_tables(Id) -> case ets:lookup(ra_log_closed_mem_tables, Id) of [] -> []; Tables -> lists:sort(fun (A, B) -> element(2, A) > element(2, B) end, Tables) end. mem_tbl_take(undefined, _TblStart, _TblEnd, _Tid, Count, Acc0) -> {Acc0, Count, undefined}; mem_tbl_take({_Start0, End} = Range, TblStart, _TblEnd, _Tid, Count, Acc0) when TblStart > End -> % optimisation to bypass request that has no overlap {Acc0, Count, Range}; mem_tbl_take({Start0, End}, TblStart, TblEnd, Tid, Count, Acc0) when TblEnd >= End -> Start = max(TblStart, Start0), Entries = lookup_range(Tid, Start, End, Acc0), Remainder = case Start =:= Start0 of true -> % the range was fully covered by the mem table undefined; false -> {Start0, Start-1} end, {Entries, Count + (End - Start + 1), Remainder}. lookup_range(Tid, Start, Start, Acc) -> [Entry] = ets:lookup(Tid, Start), [Entry | Acc]; lookup_range(Tid, Start, End, Acc) when End > Start -> [Entry] = ets:lookup(Tid, End), lookup_range(Tid, Start, End-1, [Entry | Acc]). segment_take(#?MODULE{segment_refs = SegRefs, open_segments = OpenSegs, directory = Dir}, Range, Entries0) -> lists:foldl( fun(_, {_, undefined, _} = Acc) -> %% we're done reading throw(Acc); ({From, _, _}, {_, {_, End}, _} = Acc) when From > End -> Acc; ({From, To, Fn}, {Open0, {Start0, End}, E0}) when To >= End -> {Seg, Open} = case ra_flru:fetch(Fn, Open0) of {ok, S, Open1} -> {S, Open1}; error -> AbsFn = filename:join(Dir, Fn), case ra_log_segment:open(AbsFn, #{mode => read}) of {ok, S} -> {S, ra_flru:insert(Fn, S, Open0)}; {error, Err} -> exit({ra_log_failed_to_open_segment, Err, AbsFn}) end end, % actual start point cannot be prior to first segment % index Start = max(Start0, From), Num = End - Start + 1, Entries = ra_log_segment:read_cons(Seg, Start, Num, fun binary_to_term/1, E0), Rem = case Start of Start0 -> undefined; _ -> {Start0, Start-1} end, {Open, Rem, Entries} end, {OpenSegs, Range, Entries0}, SegRefs). segment_term_query(Idx, #?MODULE{segment_refs = SegRefs, directory = Dir, open_segments = OpenSegs} = State) -> {Result, Open} = segment_term_query0(Idx, SegRefs, OpenSegs, Dir), {Result, State#?MODULE{open_segments = Open}}. segment_term_query0(Idx, [{From, To, Filename} | _], Open0, Dir) when Idx >= From andalso Idx =< To -> case ra_flru:fetch(Filename, Open0) of {ok, Seg, Open} -> Term = ra_log_segment:term_query(Seg, Idx), {Term, Open}; error -> AbsFn = filename:join(Dir, Filename), {ok, Seg} = ra_log_segment:open(AbsFn, #{mode => read}), Term = ra_log_segment:term_query(Seg, Idx), {Term, ra_flru:insert(Filename, Seg, Open0)} end; segment_term_query0(Idx, [_ | Tail], Open, Dir) -> segment_term_query0(Idx, Tail, Open, Dir); segment_term_query0(_Idx, [], Open, _) -> {undefined, Open}. cache_take(Start, Num, #?MODULE{cache = Cache, last_index = LastIdx}) -> Highest = min(LastIdx, Start + Num - 1), % cache needs to be queried in reverse to ensure % we can bail out when an item is not found case cache_take0(Highest, Start, Cache, []) of [] -> {[], [], {Start, Highest}}; [Last | _] = Entries when element(1, Last) =:= Start -> % there is no remainder - everything was in the cache {Entries, [{?METRICS_CACHE_POS, Highest - Start + 1}], undefined}; [Last | _] = Entries -> LastEntryIdx = element(1, Last), {Entries, [{?METRICS_CACHE_POS, LastIdx - Start + 1}], {Start, LastEntryIdx - 1}} end. cache_take0(Next, Last, _Cache, Acc) when Next < Last -> Acc; cache_take0(Next, Last, Cache, Acc) -> case Cache of #{Next := Entry} -> cache_take0(Next-1, Last, Cache, [erlang:insert_element(1, Entry, Next) | Acc]); _ -> Acc end. maybe_append_first_entry(State0 = #?MODULE{last_index = -1}) -> State = append({0, 0, undefined}, State0), receive {ra_log_event, {written, {0, 0, 0}}} -> ok end, State#?MODULE{first_index = 0, last_written_index_term = {0, 0}}; maybe_append_first_entry(State) -> State. resend_from(Idx, #?MODULE{uid = UId} = State0) -> try resend_from0(Idx, State0) of State -> State catch exit:wal_down -> ?WARN("~s: ra_log: resending from ~b failed with wal_down", [UId, Idx]), State0 end. resend_from0(Idx, #?MODULE{last_index = LastIdx, last_resend_time = undefined, cache = Cache} = State) -> ?DEBUG("~s: ra_log: resending from ~b to ~b", [State#?MODULE.log_id, Idx, LastIdx]), lists:foldl(fun (I, Acc) -> X = maps:get(I, Cache), wal_write(Acc, erlang:insert_element(1, X, I)) end, State#?MODULE{last_resend_time = erlang:system_time(seconds)}, % TODO: replace with recursive function lists:seq(Idx, LastIdx)); resend_from0(Idx, #?MODULE{last_resend_time = LastResend, resend_window_seconds = ResendWindow} = State) -> case erlang:system_time(seconds) > LastResend + ResendWindow of true -> % it has been more than a minute since last resend % ok to try again resend_from(Idx, State#?MODULE{last_resend_time = undefined}); false -> State end. compact_seg_refs(SegRefs) -> lists:reverse( lists:foldl(fun ({_, _, File} = S, Acc) -> case lists:any(fun({_, _, F}) when F =:= File -> true; (_) -> false end, Acc) of true -> Acc; false -> [S | Acc] end end, [], SegRefs)). verify_entries(_, []) -> ok; verify_entries(Idx, [{NextIdx, _, _} | Tail]) when Idx + 1 == NextIdx -> verify_entries(NextIdx, Tail); verify_entries(Idx, Tail) -> Msg = io_lib:format("ra_log:verify_entries/2 " "tried writing ~p - expected ~b", [Tail, Idx+1]), {error, {integrity_error, lists:flatten(Msg)}}. write_entries([], State) -> {ok, State}; write_entries([{FstIdx, _, _} | Rest] = Entries, State0) -> %% TODO: verify and build up wal commands in one iteration case verify_entries(FstIdx, Rest) of ok -> try {ok, wal_write_batch(State0, Entries)} catch exit:wal_down -> {error, wal_down} end; Error -> Error end. write_snapshot(Meta, MacRef, #?MODULE{snapshot_state = SnapState0} = State) -> {SnapState, Effects} = ra_snapshot:begin_snapshot(Meta, MacRef, SnapState0), {State#?MODULE{snapshot_state = SnapState}, Effects}. flru_handler({_, Seg}) -> _ = ra_log_segment:close(Seg), ok. recover_range(UId, _SnapIdx) -> % 0. check open mem_tables (this assumes wal has finished recovering % which means it is essential that ra_servers are part of the same % supervision tree % 1. check closed mem_tables to extend OpenRanges = case ets:lookup(ra_log_open_mem_tables, UId) of [] -> []; [{UId, First, Last, _}] -> [{First, Last}] end, ClosedRanges = [{F, L} || {_, _, F, L, _} <- closed_mem_tables(UId)], % 2. check segments SegFiles = ra_log_segment_writer:my_segments(UId), SegRefs = lists:foldl( fun (S, Acc) -> {ok, Seg} = ra_log_segment:open(S, #{mode => read}), %% if a server recovered when a segment had been opened %% but never had any entries written the segref would be %% undefined case ra_log_segment:segref(Seg) of undefined -> ok = ra_log_segment:close(Seg), Acc; SegRef -> ok = ra_log_segment:close(Seg), [SegRef | Acc] end end, [], SegFiles), SegRanges = [{F, L} || {F, L, _} <- SegRefs], Ranges = OpenRanges ++ ClosedRanges ++ SegRanges, {pick_range(Ranges, undefined), SegRefs}. % picks the current range from a sorted (newest to oldest) list of ranges pick_range([], Res) -> Res; pick_range([H | Tail], undefined) -> pick_range(Tail, H); pick_range([{Fst, _Lst} | Tail], {CurFst, CurLst}) -> pick_range(Tail, {min(Fst, CurFst), CurLst}). %% TODO: implent synchronous writes using gen_batch_server:call/3 await_written_idx(Idx, Term, Log0) -> receive {ra_log_event, {written, {_, Idx, Term}} = Evt} -> {Log, _} = handle_event(Evt, Log0), Log; {ra_log_event, {written, _} = Evt} -> {Log, _} = handle_event(Evt, Log0), await_written_idx(Idx, Term, Log) after ?LOG_APPEND_TIMEOUT -> throw(ra_log_append_timeout) end. %%%% TESTS -ifdef(TEST). -include_lib("eunit/include/eunit.hrl"). compact_seg_refs_test() -> % {From, To, File} Refs = [{10, 100, "2"}, {10, 75, "2"}, {10, 50, "2"}, {1, 9, "1"}], [{10, 100, "2"}, {1, 9, "1"}] = compact_seg_refs(Refs), ok. cache_take0_test() -> Cache = #{1 => {a}, 2 => {b}, 3 => {c}}, State = #?MODULE{cache = Cache, last_index = 3, first_index = 1}, % no remainder {[{2, b}], _, undefined} = cache_take(2, 1, State), {[{2, b}, {3, c}], _, undefined} = cache_take(2, 2, State), {[{1, a}, {2, b}, {3, c}], _, undefined} = cache_take(1, 3, State), % small remainder {[{3, c}], _, {1, 2}} = cache_take(1, 3, State#?MODULE{cache = #{3 => {c}}}), {[], _, {1, 3}} = cache_take(1, 3, State#?MODULE{cache = #{4 => {d}}}), ok. open_mem_tbl_take_test() -> _ = ets:new(ra_log_open_mem_tables, [named_table]), Tid = ets:new(test_id, []), true = ets:insert(ra_log_open_mem_tables, {test_id, 3, 7, Tid}), Entries = [{3, 2, "3"}, {4, 2, "4"}, {5, 2, "5"}, {6, 2, "6"}, {7, 2, "7"}], % seed the mem table [ets:insert(Tid, E) || E <- Entries], {Entries, _, undefined} = open_mem_tbl_take(test_id, {3, 7}, [], []), EntriesPlus8 = Entries ++ [{8, 2, "8"}], {EntriesPlus8, _, {1, 2}} = open_mem_tbl_take(test_id, {1, 7}, [], [{8, 2, "8"}]), {[{6, 2, "6"}], _, undefined} = open_mem_tbl_take(test_id, {6, 6}, [], []), {[], _, {1, 2}} = open_mem_tbl_take(test_id, {1, 2}, [], []), ets:delete(Tid), ets:delete(ra_log_open_mem_tables), ok. closed_mem_tbl_take_test() -> _ = ets:new(ra_log_closed_mem_tables, [named_table, bag]), Tid1 = ets:new(test_id, []), Tid2 = ets:new(test_id, []), M1 = erlang:unique_integer([monotonic, positive]), M2 = erlang:unique_integer([monotonic, positive]), true = ets:insert(ra_log_closed_mem_tables, {test_id, M1, 5, 7, Tid1}), true = ets:insert(ra_log_closed_mem_tables, {test_id, M2, 8, 10, Tid2}), Entries1 = [{5, 2, "5"}, {6, 2, "6"}, {7, 2, "7"}], Entries2 = [{8, 2, "8"}, {9, 2, "9"}, {10, 2, "10"}], % seed the mem tables [ets:insert(Tid1, E) || E <- Entries1], [ets:insert(Tid2, E) || E <- Entries2], {Entries1, _, undefined} = closed_mem_tbl_take(test_id, {5, 7}, [], []), {Entries2, _, undefined} = closed_mem_tbl_take(test_id, {8, 10}, [], []), {[{9, 2, "9"}], _, undefined} = closed_mem_tbl_take(test_id, {9, 9}, [], []), ok. pick_range_test() -> Ranges1 = [{76, 90}, {50, 75}, {1, 100}], {1, 90} = pick_range(Ranges1, undefined), Ranges2 = [{76, 110}, {50, 75}, {1, 49}], {1, 110} = pick_range(Ranges2, undefined), Ranges3 = [{25, 30}, {25, 35}, {1, 50}], {1, 30} = pick_range(Ranges3, undefined), ok. -endif.