Packages
ra
2.0.3
3.1.9
3.1.8
3.1.7
3.1.6
3.1.5
3.1.4
3.1.3
3.1.2
3.1.1
3.1.0
3.0.2
3.0.1
3.0.0
3.0.0-beta.1
2.17.3
2.17.2
2.17.1
2.17.0
2.16.13
2.16.12
2.16.11
2.16.10
2.16.9
2.16.8
2.16.7
2.16.6
2.16.5
2.16.4
2.16.3
2.16.2
2.16.1
2.16.0
2.16.0-pre.12
2.16.0-pre.11
2.16.0-pre.10
2.16.0-pre.9
2.16.0-pre.8
2.16.0-pre.7
2.16.0-pre.6
2.16.0-pre.5
2.16.0-pre.4
2.16.0-pre.3
2.16.0-pre.2
2.16.0-pre.1
2.15.4
2.15.3
2.15.2
2.15.1
2.15.0
2.14.0
2.13.6
2.13.5
2.13.4
2.13.3
2.13.2
2.13.1
2.13.0
2.13.0-pre.1
2.12.0
2.11.0
2.11.0-pre.1
2.10.2-pre.2
2.10.2-pre.1
2.10.1
2.10.0
2.10.0-pre.3
2.10.0-pre.2
2.10.0-pre.1
2.9.10-pre.1
2.9.1
2.9.1-pre.2
2.9.1-pre.1
2.9.0
2.8.0
retired
2.7.3
2.7.2
2.7.1
2.7.0
2.7.0-pre.3
2.7.0-pre.2
2.7.0-pre.1
2.6.3
2.6.2
2.6.1
2.6.0-pre.1
2.5.1
2.5.1-pre.1
2.5.0
2.4.9
2.4.8
2.4.7
2.4.6
2.4.5
2.4.4
2.4.3
2.4.2
retired
2.4.1
2.4.0
2.3.0
2.2.0
2.1.0
2.0.13
2.0.12
2.0.11
2.0.10
2.0.9
2.0.8
2.0.7
2.0.6
2.0.5
2.0.4
2.0.3
2.0.2
2.0.1
2.0.0
1.1.9
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.9.6
0.9.5
0.9.4
0.9.2
0.3.3
retired
0.3.2
retired
0.3.1
retired
Raft library
Current section
Files
Jump to
Current section
Files
src/ra_system.erl
-module(ra_system).
-include("ra.hrl").
-export([
start/1,
start_default/0,
default_config/0,
derive_names/1,
store/1,
fetch/1,
fetch/2,
lookup_name/2
]).
-type names() :: #{wal := atom(),
wal_sup := atom(),
log_sup := atom(),
log_ets := atom(),
log_meta := atom(),
open_mem_tbls := atom(),
closed_mem_tbls := atom(),
segment_writer := atom(),
server_sup := atom(),
directory := atom(),
directory_rev := atom()}.
-type config() :: #{name := atom(),
names := names(),
data_dir := file:filename(),
wal_data_dir => file:filename(),
segment_max_entries => non_neg_integer(),
wal_max_size_bytes => non_neg_integer(),
wal_compute_checksums => boolean(),
wal_max_batch_size => non_neg_integer(),
wal_max_entries => non_neg_integer(),
wal_write_strategy => default | o_sync,
wal_sync_method => datasync | sync,
wal_hibernate_after => non_neg_integer(),
snapshot_chunk_size => non_neg_integer(),
receive_snapshot_timeout => non_neg_integer()
}.
-export_type([
config/0,
names/0
]).
-spec start(ra_system:config()) -> supervisor:startchild_ret().
start(#{name := Name} = Config) ->
?INFO("ra: starting system ~s", [Name]),
?DEBUG("ra: starting system ~s with config: ~p", [Name, Config]),
ra_systems_sup:start_system(Config).
-spec start_default() -> supervisor:startchild_ret().
start_default() ->
start(ra_system:default_config()).
-spec default_config() -> ra_system:config().
default_config() ->
SegmentMaxEntries = application:get_env(ra, segment_max_entries, 4096),
WalMaxSizeBytes = application:get_env(ra, wal_max_size_bytes,
?WAL_DEFAULT_MAX_SIZE_BYTES),
WalComputeChecksums = application:get_env(ra, wal_compute_checksums, true),
WalMaxBatchSize = application:get_env(ra, wal_max_batch_size,
?WAL_DEFAULT_MAX_BATCH_SIZE),
WalMaxEntries = application:get_env(ra, wal_max_entries, undefined),
WalWriteStrategy = application:get_env(ra, wal_write_strategy, default),
WalSyncMethod = application:get_env(ra, wal_sync_method, datasync),
#{name => default,
data_dir => ra_env:data_dir(),
wal_data_dir => ra_env:data_dir(),
wal_max_size_bytes => WalMaxSizeBytes,
wal_compute_checksums => WalComputeChecksums,
wal_max_batch_size => WalMaxBatchSize,
wal_max_entries => WalMaxEntries,
wal_write_strategy => WalWriteStrategy,
wal_sync_method => WalSyncMethod,
segment_max_entries => SegmentMaxEntries,
names =>
#{wal => ra_log_wal,
wal_sup => ra_log_wal_sup,
log_sup => ra_log_sup,
log_ets => ra_log_ets,
log_meta => ra_log_meta,
open_mem_tbls => ra_log_open_mem_tables,
closed_mem_tbls => ra_log_closed_mem_tables,
segment_writer => ra_log_segment_writer,
server_sup => ra_server_sup_sup,
directory => ra_directory,
directory_rev => ra_directory_reverse
}}.
derive_names(SysName) when is_atom(SysName) ->
#{wal => derive(SysName, <<"log_wal">>),
wal_sup => derive(SysName, <<"log_wal_sup">>),
log_sup => derive(SysName, <<"log_sup">>),
log_ets => derive(SysName, <<"log_ets">>),
log_meta => derive(SysName, <<"log_meta">>),
open_mem_tbls => derive(SysName, <<"log_open_mem_tables">>),
closed_mem_tbls => derive(SysName, <<"log_closed_mem_tables">>),
segment_writer => derive(SysName, <<"segment_writer">>),
server_sup => derive(SysName, <<"server_sup_sup">>),
directory => derive(SysName, <<"directory">>),
directory_rev => derive(SysName, <<"directory_reverse">>)
}.
-spec store(config()) -> ok.
store(#{name := Name} = Config) ->
persistent_term:put({'$ra_system', Name}, Config).
-spec fetch(atom()) -> config() | undefined.
fetch(Name) when is_atom(Name) ->
persistent_term:get({'$ra_system', Name}, undefined).
-spec fetch(atom(), Node :: atom()) -> config() | undefined | {badrpc, term()}.
fetch(Name, Node) when is_atom(Name) andalso is_atom(Node) ->
rpc:call(Node, persistent_term, get, [{'$ra_system', Name}, undefined]).
-spec lookup_name(atom(), atom()) ->
{ok, atom()} | {error, system_not_started}.
lookup_name(System, Key) when is_atom(System) ->
case fetch(System) of
undefined ->
{error, system_not_started};
#{names := #{Key := Name}} ->
{ok, Name}
end.
derive(N, Suff) ->
S = atom_to_binary(N, utf8),
binary_to_atom(<<"ra_", S/binary, "_", Suff/binary>>, utf8).