Add system information aggregate

1 files changed, 458 insertions, 0 deletions

diff --git a/lib/runtime_tools/src/system_information.erl b/lib/runtime_tools/src/system_information.erl
new file mode 100644
index 0000000000..5b7afda8f6
--- /dev/null
+++ b/lib/runtime_tools/src/system_information.erl
@@ -0,0 +1,458 @@
+%% %CopyrightBegin%
+%% 
+%% Copyright Ericsson AB 2013. All Rights Reserved.
+%% 
+%% The contents of this file are subject to the Erlang Public License,
+%% Version 1.1, (the "License"); you may not use this file except in
+%% compliance with the License. You should have received a copy of the
+%% Erlang Public License along with this software. If not, it can be
+%% retrieved online at http://www.erlang.org/.
+%% 
+%% Software distributed under the License is distributed on an "AS IS"
+%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+%% the License for the specific language governing rights and limitations
+%% under the License.
+%% 
+%% %CopyrightEnd%
+%%
+
+
+%% The main purpose of system_information is to aggregate all information
+%% deemed useful for investigation, i.e. system_information:report/0.
+
+%% The server and all other utilities surrounding this is for inspecting
+%% reported values. Functions will be added to this as time goes by.
+
+-module(system_information).
+-behaviour(gen_server).
+
+%% API
+-export([
+	report/0,
+	from_file/1,
+	to_file/1,
+	code/0,
+	get_value/2
+    ]).
+-export([
+	start/0, stop/0,
+	load_report/0, load_report/2,
+	applications/0, applications/1,
+	application/1, application/2,
+	environment/0, environment/1,
+	module/1, module/2
+    ]).
+
+%% gen_server callbacks
+-export([
+	init/1,
+	handle_call/3,
+	handle_cast/2,
+	handle_info/2,
+	terminate/2,
+	code_change/3
+    ]).
+
+-define(SERVER, ?MODULE).
+
+%% change version if parsing of file changes
+-define(REPORT_FILE_VSN, "1.0").
+
+-record(state, {
+	report
+    }).
+
+%%===================================================================
+%% API
+%%===================================================================
+
+start() ->
+    gen_server:start({local, ?SERVER}, ?MODULE, [], []).
+
+stop() ->
+    gen_server:call(?SERVER, stop).
+
+load_report() -> load_report(data, report()).
+
+load_report(file, File)   -> load_report(data, from_file(File));
+load_report(data, Report) ->
+    start(), gen_server:call(?SERVER, {load_report, Report}).
+
+report() -> [
+	{init_arguments,    init:get_arguments()},
+	{code_paths,        code:get_path()},
+	{code,              code()},
+	{system_info,       erlang_system_info()},
+	{erts_compile_info, erlang:system_info(compile_info)},
+	{environment_erts,  os_getenv_erts_specific()},
+	{environment,       [split_env(Env) || Env <- os:getenv()]}
+    ].
+
+to_file(File) ->
+    file:write_file(File, iolist_to_binary([
+		io_lib:format("{system_information_version, ~p}.~n", [
+			?REPORT_FILE_VSN
+		    ]),
+		io_lib:format("{system_information, ~p}.~n", [
+			report()
+		    ])
+	    ])).
+
+from_file(File) ->
+    case file:consult(File) of
+	{ok, Data} ->
+	    case get_value([system_information_version], Data) of
+		?REPORT_FILE_VSN ->
+		    get_value([system_information], Data);
+		Vsn ->
+		    erlang:error({unknown_version, Vsn})
+	    end;
+	_ ->
+	    erlang:error(bad_report_file)
+    end.
+
+applications() -> applications([]).
+applications(Opts) when is_list(Opts) ->
+    gen_server:call(?SERVER, {applications, Opts}).
+
+application(App) when is_atom(App) -> application(App, []).
+application(App, Opts) when is_atom(App), is_list(Opts) ->
+    gen_server:call(?SERVER, {application, App, Opts}).
+
+environment() -> environment([]).
+environment(Opts) when is_list(Opts) ->
+    gen_server:call(?SERVER, {environment, Opts}).
+
+module(M) when is_atom(M) -> module(M, []).
+module(M, Opts) when is_atom(M), is_list(Opts) ->
+    gen_server:call(?SERVER, {module, M, Opts}).
+
+
+%%===================================================================
+%% gen_server callbacks
+%%===================================================================
+
+init([]) ->
+    {ok, #state{}}.
+
+handle_call(stop, _From, S) ->
+    {stop, normal, ok, S};
+
+handle_call({load_report, Report}, _From, S) ->
+    Version = get_value([system_info, system_version], Report),
+    io:format("Loaded report from system version: ~s~n", [Version]),
+    {reply, ok, S#state{ report = Report }};
+
+handle_call(_Req, _From, #state{ report = undefined } = S) ->
+    {reply, {error, report_not_loaded}, S};
+
+handle_call({applications, Opts}, _From, #state{ report = Report } = S) ->
+    ok = print_applications(get_value([code], Report), Opts),
+    {reply, ok, S};
+
+handle_call({application, App, Opts}, _From, #state{ report = Report } = S) ->
+    Data = get_value([App], [AppInfo||{application, AppInfo}<-get_value([code], Report)]),
+    ok = print_application({App, Data}, Opts),
+    {reply, ok, S};
+
+
+handle_call({environment, Opts}, _From, #state{ report = Report } = S) ->
+    Choices = case proplists:get_bool(full, Opts) of
+	true  -> [environment];
+	false -> [environment_erts]
+    end,
+    ok = print_environments(get_value(Choices, Report), Opts),
+    {reply, ok, S};
+
+
+handle_call({module, M, Opts}, _From, #state{ report = Report } = S) ->
+    Mods = find_modules_from_code(M, get_value([code], Report)),
+    print_modules_from_code(M, Mods, Opts),
+    {reply, ok, S};
+
+
+handle_call(_Request, _From, State) ->
+    {reply, ok, State}.
+
+handle_cast(_Msg, State) ->
+    {noreply, State}.
+
+handle_info(_Info, State) ->
+    {noreply, State}.
+
+terminate(_Reason, _State) ->
+    ok.
+
+code_change(_OldVsn, State, _Extra) ->
+    {ok, State}.
+
+%%===================================================================
+%% Internal functions
+%%===================================================================
+
+%% handle report values
+
+get_value([], Data) -> Data;
+get_value([K|Ks], Data) ->
+    get_value(Ks, proplists:get_value(K, Data, [])).
+
+find_modules_from_code(M, [{code, Info}|Codes]) ->
+    case find_modules(M, get_value([modules], Info)) of
+	[]   -> find_modules_from_code(M, Codes);
+	Mods ->
+	    Path = get_value([path], Info),
+	    [{Path, Mods}|find_modules_from_code(M, Codes)]
+    end;
+find_modules_from_code(M, [{application, {App, Info}}|Codes]) ->
+    case find_modules(M, get_value([modules], Info)) of
+	[]   -> find_modules_from_code(M, Codes);
+	Mods ->
+	    Path = get_value([path], Info),
+	    Vsn  = get_value([vsn], Info),
+	    [{App, Vsn, Path, Mods}|find_modules_from_code(M, Codes)]
+    end;
+find_modules_from_code(_, []) -> [].
+
+find_modules(M, [{M, _}=Info|Ms]) -> [Info|find_modules(M,Ms)];
+find_modules(M, [_|Ms]) -> find_modules(M, Ms);
+find_modules(_, []) -> [].
+
+%% print information
+
+print_applications([{application, App}|Apps], Opts) ->
+    print_application(App, Opts),
+    print_applications(Apps, Opts);
+print_applications([{code,_}|Apps], Opts) ->
+    print_applications(Apps, Opts);
+print_applications([], _) ->
+    ok.
+
+print_application({App, Info}, Opts) ->
+    Vsn = get_value([vsn], Info),
+    io:format(" * ~w-~s~n", [App, Vsn]),
+    case proplists:get_bool(full, Opts) of
+	true ->
+	    _ = [ begin
+			print_module(Minfo)
+		end || Minfo <- get_value([modules], Info) ],
+	    ok;
+	false ->
+	    ok
+    end.
+
+print_environments([Env|Envs],Opts) ->
+    print_environment(Env,Opts),
+    print_environments(Envs,Opts);
+print_environments([],_) ->
+    ok.
+
+print_environment({_Key, false},_) -> ok;
+print_environment({Key, Value},_) ->
+    io:format(" - ~s = ~s~n", [Key, Value]).
+
+print_modules_from_code(M, [Info|Ms], Opts) ->
+    print_module_from_code(M, Info),
+    case proplists:get_bool(full, Opts) of
+	true  -> print_modules_from_code(M, Ms, Opts);
+	false -> ok
+    end;
+print_modules_from_code(_, [], _) ->
+    ok.
+
+print_module_from_code(M, {Path, [{M,ModInfo}]}) ->
+    io:format(" from path \"~s\" (no application):~n", [Path]),
+    io:format("     - compiler: ~s~n", [get_value([compiler], ModInfo)]),
+    io:format("     -      md5: ~s~n", [get_value([md5], ModInfo)]),
+    io:format("     -   native: ~w~n", [get_value([native], ModInfo)]),
+    io:format("     -   loaded: ~w~n", [get_value([loaded], ModInfo)]),
+    ok;
+print_module_from_code(M, {App,Vsn,Path,[{M,ModInfo}]}) ->
+    io:format(" from path \"~s\" (~w-~s):~n", [Path,App,Vsn]),
+    io:format("     - compiler: ~s~n", [get_value([compiler], ModInfo)]),
+    io:format("     -      md5: ~s~n", [get_value([md5], ModInfo)]),
+    io:format("     -   native: ~w~n", [get_value([native], ModInfo)]),
+    io:format("     -   loaded: ~w~n", [get_value([loaded], ModInfo)]),
+    ok.
+
+print_module({Mod, ModInfo}) ->
+    io:format("   - ~w:~n", [Mod]),
+    io:format("     - compiler: ~s~n", [get_value([compiler], ModInfo)]),
+    io:format("     -      md5: ~s~n", [get_value([md5], ModInfo)]),
+    io:format("     -   native: ~w~n", [get_value([native], ModInfo)]),
+    io:format("     -   loaded: ~w~n", [get_value([loaded], ModInfo)]),
+    ok.
+
+
+
+%% get useful information from erlang:system_info/1
+
+erlang_system_info() ->
+    erlang_system_info([
+	    allocator,
+	    check_io,
+	    otp_release,
+	    port_limit,
+	    process_limit,
+	    % procs,  % not needed
+	    smp_support,
+	    system_version,
+	    system_architecture,
+	    threads,
+	    thread_pool_size,
+	    {wordsize,internal},
+	    {wordsize,external},
+	    {cpu_topology, defined},
+	    {cpu_topology, detected},
+	    scheduler_bind_type,
+	    scheduler_bindings,
+	    compat_rel,
+	    schedulers_state,
+	    build_type,
+	    logical_processors,
+	    logical_processors_online,
+	    logical_processors_available,
+	    driver_version,
+	    emu_args,
+	    ethread_info,
+	    beam_jump_table,
+	    taints
+	]).
+
+erlang_system_info([]) -> [];
+erlang_system_info([Type|Types]) ->
+    [{Type, erlang:system_info(Type)}|erlang_system_info(Types)].
+
+
+%% get known useful erts environment
+
+os_getenv_erts_specific() -> 
+    os_getenv_erts_specific([
+	    "BINDIR",
+	    "DIALYZER_EMULATOR",
+	    "CERL_DETACHED_PROG",
+	    "EMU",
+	    "ERL_CONSOLE_MODE",
+	    "ERL_CRASH_DUMP",
+	    "ERL_CRASH_DUMP_NICE",
+	    "ERL_CRASH_DUMP_SECONDS",
+	    "ERL_EPMD_PORT",
+	    "ERL_EMULATOR_DLL",
+	    "ERL_FULLSWEEP_AFTER",
+	    "ERL_LIBS",
+	    "ERL_MALLOC_LIB",
+	    "ERL_MAX_PORTS",
+	    "ERL_MAX_ETS_TABLES",
+	    "ERL_NO_VFORK",
+	    "ERL_NO_KERNEL_POLL",
+	    "ERL_THREAD_POOL_SIZE",
+	    "ERLC_EMULATOR",
+	    "ESCRIPT_EMULATOR",
+	    "HOME",
+	    "HOMEDRIVE",
+	    "HOMEPATH",
+	    "LANG",
+	    "LC_ALL",
+	    "LC_CTYPE",
+	    "PATH",
+	    "PROGNAME",
+	    "RELDIR",
+	    "ROOTDIR",
+	    "TERM",
+	    %"VALGRIND_LOG_XML",
+
+	    %% heart
+	    "COMSPEC",
+	    "HEART_COMMAND",
+
+	    %% run_erl
+	    "RUN_ERL_LOG_ALIVE_MINUTES",
+	    "RUN_ERL_LOG_ACTIVITY_MINUTES",
+	    "RUN_ERL_LOG_ALIVE_FORMAT",
+	    "RUN_ERL_LOG_ALIVE_IN_UTC",
+	    "RUN_ERL_LOG_GENERATIONS",
+	    "RUN_ERL_LOG_MAXSIZE",
+	    "RUN_ERL_DISABLE_FLOWCNTRL",
+
+	    %% driver getenv
+	    "CALLER_DRV_USE_OUTPUTV",
+	    "ERL_INET_GETHOST_DEBUG",
+	    "ERL_EFILE_THREAD_SHORT_CIRCUIT",
+	    "ERL_WINDOW_TITLE",
+	    "ERL_ABORT_ON_FAILURE",
+	    "TTYSL_DEBUG_LOG"
+	]).
+
+os_getenv_erts_specific([]) -> [];
+os_getenv_erts_specific([Key|Keys]) ->
+    [{Key, os:getenv(Key)}|os_getenv_erts_specific(Keys)].
+
+split_env(Env) ->
+    split_env(Env, []).
+
+split_env([$=|Vs], Key) -> {lists:reverse(Key), Vs};
+split_env([I|Vs], Key)  -> split_env(Vs, [I|Key]);
+split_env([], KV)       -> lists:reverse(KV). % should not happen.
+
+%% get applications
+
+code() ->
+    % order is important
+    get_code_from_paths(code:get_path()).
+
+get_code_from_paths([]) -> [];
+get_code_from_paths([Path|Paths]) ->
+    case is_application_path(Path) of
+	true -> 
+	    [{application, get_application_from_path(Path)}|get_code_from_paths(Paths)];
+	false ->
+	    [{code, [
+			{path,    Path},
+			{modules, get_modules_from_path(Path)}
+		    ]}|get_code_from_paths(Paths)]
+    end.
+
+is_application_path(Path) ->
+    case filelib:wildcard(filename:join(Path, "*.app")) of
+	[] -> false;
+	_  -> true
+    end.
+
+get_application_from_path(Path) ->
+    [Appfile|_] = filelib:wildcard(filename:join(Path, "*.app")),
+    case file:consult(Appfile) of
+	{ok, [{application, App, Info}]} ->
+	    {App, [
+		    {description, proplists:get_value(description, Info, [])},
+		    {vsn,         proplists:get_value(vsn, Info, [])},
+		    {path,        Path},
+		    {modules,     get_modules_from_path(Path)}
+		]}
+    end.
+
+get_modules_from_path(Path) ->
+    [ 
+	begin
+		{ok,{Mod, Md5}} = beam_lib:md5(Beam),
+		Loaded = case code:is_loaded(Mod) of
+		    false -> false;
+		    _     -> true
+		end,
+		{Mod, [
+			{loaded, Loaded},
+			{native, code:is_module_native(Mod)},
+			{compiler, get_compiler_version(Beam)},
+			{md5, hexstring(Md5)}
+		    ]}
+	end || Beam <- filelib:wildcard(filename:join(Path, "*.beam"))
+    ].
+
+hexstring(Bin) when is_binary(Bin) ->
+    lists:flatten([io_lib:format("~2.16.0b", [V]) || <<V>> <= Bin]).
+
+get_compiler_version(B) ->
+    {ok, Bin} = file:read_file(B),
+    case beam_lib:chunks(Bin, [compile_info]) of
+	{ok,{_,[{compile_info, Info}]}} ->
+	    proplists:get_value(version, Info);
+	_ -> undefined
+    end.