Introduce system_information:sanity_check()

8 files changed, 403 insertions, 6 deletions

diff --git a/lib/runtime_tools/doc/specs/.gitignore b/lib/runtime_tools/doc/specs/.gitignore
new file mode 100644
index 0000000000..322eebcb06
--- /dev/null
+++ b/lib/runtime_tools/doc/specs/.gitignore
@@ -0,0 +1 @@
+specs_*.xml
diff --git a/lib/runtime_tools/doc/src/Makefile b/lib/runtime_tools/doc/src/Makefile
index 51d93df418..07c63197e9 100644
--- a/lib/runtime_tools/doc/src/Makefile
+++ b/lib/runtime_tools/doc/src/Makefile
@@ -40,7 +40,7 @@ RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN)
 # Target Specs
 # ----------------------------------------------------
 XML_APPLICATION_FILES = ref_man.xml
-XML_REF3_FILES = dbg.xml dyntrace.xml erts_alloc_config.xml
+XML_REF3_FILES = dbg.xml dyntrace.xml erts_alloc_config.xml system_information.xml
 XML_REF6_FILES = runtime_tools_app.xml
 
 XML_PART_FILES = part_notes.xml part_notes_history.xml part.xml
@@ -71,12 +71,20 @@ HTML_REF_MAN_FILE = $(HTMLDIR)/index.html
 
 TOP_PDF_FILE =  $(PDFDIR)/$(APPLICATION)-$(VSN).pdf
 
+SPECS_FILES = $(XML_REF3_FILES:%.xml=$(SPECDIR)/specs_%.xml)
+
+TOP_SPECS_FILE = specs.xml
+
 # ----------------------------------------------------
 # FLAGS 
 # ----------------------------------------------------
 XML_FLAGS += 
 DVIPS_FLAGS += 
 
+SPECS_ESRC = ../../src
+
+SPECS_FLAGS = -I../../include -I../../../kernel/src
+
 # ----------------------------------------------------
 # Targets
 # ----------------------------------------------------
diff --git a/lib/runtime_tools/doc/src/ref_man.xml b/lib/runtime_tools/doc/src/ref_man.xml
index 6017f3cdaa..25fa97896b 100644
--- a/lib/runtime_tools/doc/src/ref_man.xml
+++ b/lib/runtime_tools/doc/src/ref_man.xml
@@ -35,5 +35,6 @@
   <xi:include href="dbg.xml"/>
   <xi:include href="dyntrace.xml"/>
   <xi:include href="erts_alloc_config.xml"/>
+  <xi:include href="system_information.xml"/>
 </application>
 
diff --git a/lib/runtime_tools/doc/src/specs.xml b/lib/runtime_tools/doc/src/specs.xml
new file mode 100644
index 0000000000..d4c3c9dfe6
--- /dev/null
+++ b/lib/runtime_tools/doc/src/specs.xml
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<specs xmlns:xi="http://www.w3.org/2001/XInclude">
+  <xi:include href="../specs/specs_system_information.xml"/>
+</specs>
diff --git a/lib/runtime_tools/doc/src/system_information.xml b/lib/runtime_tools/doc/src/system_information.xml
new file mode 100644
index 0000000000..b586334ae7
--- /dev/null
+++ b/lib/runtime_tools/doc/src/system_information.xml
@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE erlref SYSTEM "erlref.dtd">
+
+<erlref>
+  <header>
+    <copyright>
+      <year>2014</year>
+      <holder>Ericsson AB. All Rights Reserved.</holder>
+    </copyright>
+    <legalnotice>
+      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.
+    
+    </legalnotice>
+
+    <title></title>
+    <prepared></prepared>
+    <responsible></responsible>
+    <docno>1</docno>
+    <approved></approved>
+    <checked></checked>
+    <date></date>
+    <rev></rev>
+    <file>system_information.xml</file>
+  </header>
+  <module>system_information</module>
+  <modulesummary>System Information</modulesummary>
+  <description>
+    <p></p>
+  </description>
+  <funcs>
+    <func>
+      <name name="sanity_check" arity="0"/>
+      <fsummary>Perform a sanity check</fsummary>
+      <desc>
+        <p>Performs a sanity check on the system. If no issues
+	were found, <c>ok</c> is returned. If issues were
+	found, <c>{failed, <anno>Failures</anno>}</c> is
+	returned. All failures found will be part of the
+	<c><anno>Failures</anno></c> list. Currently defined
+	<c><anno>Failure</anno></c> elements in the
+	<c><anno>Failures</anno></c> list:</p>
+	<taglist>
+	  <tag><c><anno>InvalidAppFile</anno></c></tag>
+	  <item><p>An application has an invalid <c>.app</c> file. The
+	  second element identifies the application which has the
+	  invalid <c>.app</c> file.</p></item>
+	  <tag><c><anno>InvalidApplicationVersion</anno></c></tag>
+	  <item><p>An application has an invalid application version.
+	  The second element identifies the application version that
+	  is invalid.</p></item>
+	  <tag><c><anno>MissingRuntimeDependencies</anno></c></tag>
+	  <item><p>An application is missing
+	  <seealso marker="kernel:app#runtime_dependencies">runtime
+	  dependencies</seealso>. The second element identifies the
+	  application (with version) that has missing dependencies.
+	  The third element contains the missing dependencies.</p>
+	  <p>Note that this check use application versions that
+	  are loaded, or will be loaded when used. You might have
+	  application versions that satisfies all dependencies
+	  installed in the system, but if those are not loaded this
+	  check will fail. The system will of course also fail when
+	  used like this. This may happen when you have multiple 
+	  <seealso marker="doc/system_principles:versions">branched
+	  versions</seealso> of the same application installed in the
+	  system, but you do not use a
+	  <seealso marker="doc/system_principles:system_principles#BOOTSCRIPT">boot
+	  script</seealso> identifing the correct application version.</p>
+	  </item>
+	</taglist>
+	<p>Currently the sanity check is limited to verifying
+	runtime dependencies found in the <c>.app</c> files of
+	all applications. More checks will be introduced in the
+	future. This implies that the return type <em>will</em>
+	change in the future.</p>
+	<note><p>An <c>ok</c> return value only means that
+	<c>sanity_check/0</c> did not find any issues, <em>not</em>
+	that no issues exist.</p></note>
+      </desc>
+    </func>
+    <func>
+      <name name="to_file" arity="1"/>
+      <fsummary>Write miscellaneous system information to file</fsummary>
+      <desc><p>Writes  miscellaneous system information to file. This
+      information will typically be requested by the Erlang/OTP team
+      at Ericsson AB when reporting an issue.</p></desc>
+    </func>
+  </funcs>
+ </erlref>
+
diff --git a/lib/runtime_tools/src/system_information.erl b/lib/runtime_tools/src/system_information.erl
index 603b698d5e..f541d6e449 100644
--- a/lib/runtime_tools/src/system_information.erl
+++ b/lib/runtime_tools/src/system_information.erl
@@ -39,7 +39,8 @@
 	application/1, application/2,
 	environment/0, environment/1,
 	module/1, module/2,
-	modules/1
+	modules/1,
+	sanity_check/0
     ]).
 
 %% gen_server callbacks
@@ -85,9 +86,14 @@ report() -> [
 	{erts_compile_info, erlang:system_info(compile_info)},
 	{beam_dynamic_libraries, get_dynamic_libraries()},
 	{environment_erts,  os_getenv_erts_specific()},
-	{environment,       [split_env(Env) || Env <- os:getenv()]}
+	{environment,       [split_env(Env) || Env <- os:getenv()]},
+	{sanity_check,      sanity_check()}	     
     ].
 
+-spec to_file(FileName) -> ok | {error, Reason} when
+      FileName :: file:name_all(),
+      Reason :: file:posix() | badarg | terminated | system_limit.
+
 to_file(File) ->
     file:write_file(File, iolist_to_binary([
 		io_lib:format("{system_information_version, ~p}.~n", [
@@ -130,6 +136,27 @@ module(M, Opts) when is_atom(M), is_list(Opts) ->
 modules(Opt) when is_atom(Opt) ->
     gen_server:call(?SERVER, {modules, Opt}).
 
+
+-spec sanity_check() -> ok | {failed, Failures} when
+      Application :: atom(),
+      ApplicationVersion :: string(),
+      MissingRuntimeDependencies :: {missing_runtime_dependencies,
+				     ApplicationVersion,
+				     [ApplicationVersion]},
+      InvalidApplicationVersion :: {invalid_application_version,
+				    ApplicationVersion},
+      InvalidAppFile :: {invalid_app_file, Application},
+      Failure :: MissingRuntimeDependencies
+	       | InvalidApplicationVersion
+	       | InvalidAppFile,
+      Failures :: [Failure].
+
+sanity_check() ->
+    case check_runtime_dependencies() of
+	[] -> ok;
+	Issues -> {failed, Issues}
+    end.
+
 %%===================================================================
 %% gen_server callbacks
 %%===================================================================
@@ -457,6 +484,8 @@ get_application_from_path(Path) ->
 		    {description, proplists:get_value(description, Info, [])},
 		    {vsn,         proplists:get_value(vsn, Info, [])},
 		    {path,        Path},
+		    {runtime_dependencies,
+		     proplists:get_value(runtime_dependencies, Info, [])},
 		    {modules,     get_modules_from_path(Path)}
 		]}
     end.
@@ -552,3 +581,252 @@ get_beam_name() ->
 	Value -> Value
     end,
     Beam ++ Type ++ Flavor.
+
+%% Check runtime dependencies...
+
+vsnstr2vsn(VsnStr) ->
+    list_to_tuple(lists:map(fun (Part) ->
+				    list_to_integer(Part)
+			    end,
+			    string:tokens(VsnStr, "."))).
+
+rtdepstrs2rtdeps([]) ->
+    [];
+rtdepstrs2rtdeps([RTDep | RTDeps]) ->
+    [AppStr, VsnStr] = string:tokens(RTDep, "-"),
+    [{list_to_atom(AppStr), vsnstr2vsn(VsnStr)} | rtdepstrs2rtdeps(RTDeps)].
+
+build_app_table([], AppTab) ->
+    AppTab;
+build_app_table([App | Apps], AppTab0) ->
+    AppTab1 = try
+		  %% We may have multiple application versions installed
+		  %% of the same application! It is therefore important
+		  %% to look up the application version that actually will
+		  %% be used via code server.
+		  AppFile = code:where_is_file(atom_to_list(App) ++ ".app"),
+		  {ok, [{application, App, Info}]} = file:consult(AppFile),
+		  VsnStr = proplists:get_value(vsn, Info),
+		  Vsn = vsnstr2vsn(VsnStr),
+		  RTDepStrs = proplists:get_value(runtime_dependencies,
+						  Info, []),
+		  RTDeps = rtdepstrs2rtdeps(RTDepStrs),
+		  gb_trees:insert(App, {Vsn, RTDeps}, AppTab0)
+	      catch
+		  _ : _ ->
+		      AppTab0
+	      end,
+    build_app_table(Apps, AppTab1).
+
+meets_min_req(Vsn, Vsn) ->
+    true;
+meets_min_req({X}, VsnReq) ->
+    meets_min_req({X, 0, 0}, VsnReq);
+meets_min_req({X, Y}, VsnReq) ->
+    meets_min_req({X, Y, 0}, VsnReq);
+meets_min_req(Vsn, {X}) ->
+    meets_min_req(Vsn, {X, 0, 0});
+meets_min_req(Vsn, {X, Y}) ->
+    meets_min_req(Vsn, {X, Y, 0});
+meets_min_req({X, _Y, _Z}, {XReq, _YReq, _ZReq}) when X > XReq ->
+    true;
+meets_min_req({X, Y, _Z}, {X, YReq, _ZReq}) when Y > YReq ->
+    true;
+meets_min_req({X, Y, Z}, {X, Y, ZReq}) when Z > ZReq ->
+    true;
+meets_min_req({_X, _Y, _Z}, {_XReq, _YReq, _ZReq}) ->
+    false;
+meets_min_req(Vsn, VsnReq) ->
+    gp_meets_min_req(mk_gp_vsn_list(Vsn), mk_gp_vsn_list(VsnReq)).
+
+gp_meets_min_req([X, Y, Z | _Vs], [X, Y, Z]) ->
+    true;
+gp_meets_min_req([X, Y, Z | _Vs], [XReq, YReq, ZReq]) ->
+    meets_min_req({X, Y, Z}, {XReq, YReq, ZReq});
+gp_meets_min_req([X, Y, Z | Vs], [X, Y, Z | VReqs]) ->
+    gp_meets_min_req_tail(Vs, VReqs);
+gp_meets_min_req(_Vsn, _VReq) ->
+    %% Versions on different version branches, i.e., the minimum
+    %% required functionality is not included in Vsn.
+    false.
+
+gp_meets_min_req_tail([V | Vs], [V | VReqs]) ->
+    gp_meets_min_req_tail(Vs, VReqs);
+gp_meets_min_req_tail([], []) ->
+    true;
+gp_meets_min_req_tail([_V | _Vs], []) ->
+    true;
+gp_meets_min_req_tail([V | _Vs], [VReq]) when V > VReq ->
+    true;
+gp_meets_min_req_tail(_Vs, _VReqs) ->
+    %% Versions on different version branches, i.e., the minimum
+    %% required functionality is not included in Vsn.
+    false.
+
+mk_gp_vsn_list(Vsn) ->
+    [X, Y, Z | Tail] = tuple_to_list(Vsn),
+    [X, Y, Z | remove_trailing_zeroes(Tail)].
+
+remove_trailing_zeroes([]) ->
+    [];
+remove_trailing_zeroes([0 | Vs]) ->
+    case remove_trailing_zeroes(Vs) of
+	[] -> [];
+	NewVs -> [0 | NewVs]
+    end;
+remove_trailing_zeroes([V | Vs]) ->
+    [V | remove_trailing_zeroes(Vs)].
+
+mk_app_vsn_str({App, Vsn}) ->
+    mk_app_vsn_str(App, Vsn).
+
+mk_app_vsn_str(App, Vsn) ->
+    VsnList = tuple_to_list(Vsn),
+    lists:flatten([atom_to_list(App),
+		   $-,
+		   integer_to_list(hd(VsnList)),
+		   lists:map(fun (Part) ->
+				     [$., integer_to_list(Part)]
+			     end, tl(VsnList))]).
+
+otp_17_0_vsns_orddict() ->
+    [{asn1,{3,0}},
+     {common_test,{1,8}},
+     {compiler,{5,0}},
+     {cosEvent,{2,1,15}},
+     {cosEventDomain,{1,1,14}},
+     {cosFileTransfer,{1,1,16}},
+     {cosNotification,{1,1,21}},
+     {cosProperty,{1,1,17}},
+     {cosTime,{1,1,14}},
+     {cosTransactions,{1,2,14}},
+     {crypto,{3,3}},
+     {debugger,{4,0}},
+     {dialyzer,{2,7}},
+     {diameter,{1,6}},
+     {edoc,{0,7,13}},
+     {eldap,{1,0,3}},
+     {erl_docgen,{0,3,5}},
+     {erl_interface,{3,7,16}},
+     {erts,{6,0}},
+     {et,{1,5}},
+     {eunit,{2,2,7}},
+     {gs,{1,5,16}},
+     {hipe,{3,10,3}},
+     {ic,{4,3,5}},
+     {inets,{5,10}},
+     {jinterface,{1,5,9}},
+     {kernel,{3,0}},
+     {megaco,{3,17,1}},
+     {mnesia,{4,12}},
+     {observer,{2,0}},
+     {odbc,{2,10,20}},
+     {orber,{3,6,27}},
+     {os_mon,{2,2,15}},
+     {ose,{1,0}},
+     {otp_mibs,{1,0,9}},
+     {parsetools,{2,0,11}},
+     {percept,{0,8,9}},
+     {public_key,{0,22}},
+     {reltool,{0,6,5}},
+     {runtime_tools,{1,8,14}},
+     {sasl,{2,4}},
+     {snmp,{4,25,1}},
+     {ssh,{3,0,1}},
+     {ssl,{5,3,4}},
+     {stdlib,{2,0}},
+     {syntax_tools,{1,6,14}},
+     {test_server,{3,7}},
+     {tools,{2,6,14}},
+     {typer,{0,9,6}},
+     {webtool,{0,8,10}},
+     {wx,{1,2}},
+     {xmerl,{1,3,7}}].
+
+otp_17_0_vsns_tab() ->
+    gb_trees:from_orddict(otp_17_0_vsns_orddict()).
+
+check_runtime_dependency({App, DepVsn}, AppTab) ->
+    case gb_trees:lookup(App, AppTab) of
+	none ->
+	    false;
+	{value, {Vsn, _}} ->
+	    meets_min_req(Vsn, DepVsn)
+    end.
+
+check_runtime_dependencies(App, AppTab, OtpMinVsnTab) ->
+    case gb_trees:lookup(App, AppTab) of
+	none ->
+	    [{invalid_app_file, App}];
+	{value, {Vsn, RTDeps}} ->
+	    RTD = case lists:foldl(
+			 fun (RTDep, Acc) ->
+				 case check_runtime_dependency(RTDep, AppTab) of
+				     true ->
+					 Acc;
+				     false ->
+					 [mk_app_vsn_str(RTDep) | Acc]
+				 end
+			 end,
+			 [],
+			 RTDeps) of
+		      [] ->
+			  [];
+		      MissingDeps ->
+			  [{missing_runtime_dependencies,
+			    mk_app_vsn_str(App, Vsn),
+			    MissingDeps}]
+		  end,
+	    case gb_trees:lookup(App, OtpMinVsnTab) of
+		none ->
+		    RTD;
+		{value, MinVsn} ->
+		    case meets_min_req(Vsn, MinVsn) of
+			true ->
+			    RTD;
+			false ->
+			    [{invalid_application_version,
+			      mk_app_vsn_str(App, Vsn)} | RTD]
+		    end
+	    end
+    end.
+
+app_file_to_app(AF) ->
+    list_to_atom(filename:basename(AF, ".app")).
+
+get_apps() ->
+    get_apps(code:get_path(), []).
+
+get_apps([], Apps) ->
+    lists:usort(Apps);
+get_apps([Path|Paths], Apps) ->
+    case filelib:wildcard(filename:join(Path, "*.app")) of
+	[] ->
+	    %% Not app or invalid app
+	    get_apps(Paths, Apps);
+	[AppFile] ->
+	    get_apps(Paths, [app_file_to_app(AppFile) | Apps]);
+	[_AppFile| _] = AppFiles ->
+	    %% Strange with multple .app files... Lets put them
+	    %% all in the list and see what we get...
+	    lists:map(fun (AF) ->
+			      app_file_to_app(AF)
+		      end, AppFiles) ++ Apps
+    end.
+
+check_runtime_dependencies() ->
+    OtpMinVsnTab = otp_17_0_vsns_tab(),
+    Apps = get_apps(),
+    AppTab = build_app_table(Apps, gb_trees:empty()),
+    lists:foldl(fun (App, Acc) ->
+			case check_runtime_dependencies(App,
+							AppTab,
+							OtpMinVsnTab) of
+			    [] -> Acc;
+			    Issues -> Issues ++ Acc
+			end
+		end,
+		[],
+		Apps).
+
+%% End of runtime dependency checks
diff --git a/lib/runtime_tools/test/system_information_SUITE.erl b/lib/runtime_tools/test/system_information_SUITE.erl
index fb9455a30f..53d20060e7 100644
--- a/lib/runtime_tools/test/system_information_SUITE.erl
+++ b/lib/runtime_tools/test/system_information_SUITE.erl
@@ -33,6 +33,7 @@
 	api_report/1,
 	api_to_file/1,
 	api_from_file/1,
+	sanity_check/1,
 	%% server
 	api_start_stop/1,
 	validate_server_interface/1
@@ -84,7 +85,8 @@ all() -> [
 	api_to_file,
 	api_from_file,
 	api_start_stop,
-	validate_server_interface
+	validate_server_interface,
+	sanity_check
     ].
 
 
@@ -262,6 +264,9 @@ validate_server_interface(Config) ->
     ok = system_information:stop(),
     ok.
 
+sanity_check(Config) when is_list(Config) ->
+    ok = system_information:sanity_check().
+
 
 %% aux
 
@@ -288,7 +293,8 @@ validate_report(Report) ->
 	    erts_compile_info,
 	    beam_dynamic_libraries,
 	    environment_erts,
-	    environment
+	    environment,
+	    sanity_check
 	], Report).
 
 ensure_report_keys([], _) -> ok;
diff --git a/lib/runtime_tools/test/system_information_SUITE_data/information_test_report.dat b/lib/runtime_tools/test/system_information_SUITE_data/information_test_report.dat
index 0900eadd4a..18938372a3 100644
--- a/lib/runtime_tools/test/system_information_SUITE_data/information_test_report.dat
+++ b/lib/runtime_tools/test/system_information_SUITE_data/information_test_report.dat
@@ -9870,4 +9870,5 @@
                  {"MANPATH",
                   "/usr/local/man:/usr/share/man:/usr/X11R6/man:/opt/gnome/share/man"},
                  {"LESSKEY","/etc/lesskey.bin"},
-                 {"LC_PAPER","sv_SE.UTF-8"}]}]}.
+                 {"LC_PAPER","sv_SE.UTF-8"}]},
+		{sanity_check,ok}]}.