From 99205ab9fb89c08ce71deb02c2fd32376b15a24c Mon Sep 17 00:00:00 2001
From: Siri Hansen <siri@erlang.org>
Date: Thu, 26 Oct 2017 15:28:48 +0200
Subject: [cdv] Display warning if heap is incomplete

---
 lib/observer/src/crashdump_viewer.erl        | 13 ++++++--
 lib/observer/test/crashdump_viewer_SUITE.erl | 47 +++++++++++++++++++++++-----
 2 files changed, 50 insertions(+), 10 deletions(-)

(limited to 'lib')

diff --git a/lib/observer/src/crashdump_viewer.erl b/lib/observer/src/crashdump_viewer.erl
index d2231ba033..40450a2873 100644
--- a/lib/observer/src/crashdump_viewer.erl
+++ b/lib/observer/src/crashdump_viewer.erl
@@ -1122,7 +1122,7 @@ get_proc_details(File,Pid,WS,DumpVsn) ->
 	    {{Stack,MsgQ,Dict},TW} =
 		case truncated_warning([{?proc,Pid}]) of
 		    [] ->
-			{expand_memory(Fd,Pid,DumpVsn),[]};
+                        expand_memory(Fd,Pid,DumpVsn);
 		    TW0 ->
 			{{[],[],[]},TW0}
 		end,
@@ -1457,7 +1457,15 @@ expand_memory(Fd,Pid,DumpVsn) ->
 		read_messages(Fd,Pid,BinAddrAdj,Dict),
 		read_dictionary(Fd,Pid,BinAddrAdj,Dict)},
     erase(fd),
-    Expanded.
+    IncompleteWarning =
+        case erase(incomplete_heap) of
+            undefined ->
+                [];
+            true ->
+                ["WARNING: This process has an incomplete heap. "
+                 "Some information might be missing."]
+        end,
+    {Expanded,IncompleteWarning}.
 
 read_literals(Fd) ->
     case lookup_index(?literals,[]) of
@@ -2784,6 +2792,7 @@ deref_ptr(Ptr, Line, BinAddrAdj, D0) ->
 	none ->
 	    case get(fd) of
 		end_of_heap ->
+                    put(incomplete_heap,true),
 		    {['#CDVIncompleteHeap'],Line,D0};
 		Fd ->
 		    case bytes(Fd) of
diff --git a/lib/observer/test/crashdump_viewer_SUITE.erl b/lib/observer/test/crashdump_viewer_SUITE.erl
index a361b8c321..02adfb6508 100644
--- a/lib/observer/test/crashdump_viewer_SUITE.erl
+++ b/lib/observer/test/crashdump_viewer_SUITE.erl
@@ -348,7 +348,7 @@ browse_file(File) ->
 
     io:format("  info read",[]),
 
-    lookat_all_pids(Procs),
+    lookat_all_pids(Procs,is_truncated(File),incomplete_allowed(File)),
     io:format("  pids ok",[]),
     lookat_all_ports(Ports),
     io:format("  ports ok",[]),
@@ -359,6 +359,21 @@ browse_file(File) ->
 
     Procs. % used as second arg to special/2
 
+is_truncated(File) ->
+    case filename:extension(File) of
+        ".trunc"++_ ->
+            true;
+        _ ->
+            false
+    end.
+
+incomplete_allowed(File) ->
+    %% Incomplete heap is allowed for native libs, since some literals
+    %% are not dumped - and for pre OTP-20 (really pre 20.2) releases,
+    %% since literals were not dumped at all then.
+    Rel = get_rel_from_dump_name(File),
+    Rel < 20 orelse test_server:is_native(lists).
+
 special(File,Procs) ->
     case filename:extension(File) of
 	".full_dist" ->
@@ -548,7 +563,7 @@ special(File,Procs) ->
 	    io:format("  process details ok",[]),
 
 	    #proc{dict=Dict} = ProcDetails,
-            io:format("~p\n", [Dict]),
+            %% io:format("~p\n", [Dict]),
             Maps = crashdump_helper:create_maps(),
             Maps = proplists:get_value(maps,Dict),
             io:format("  maps ok",[]),
@@ -568,14 +583,25 @@ verify_binaries([Bin|T1], [['#CDVBin',Offset,Size,Pos]|T2]) ->
 verify_binaries([], []) ->
     ok.
 
-lookat_all_pids([]) ->
+lookat_all_pids([],_,_) ->
     ok;
-lookat_all_pids([#proc{pid=Pid0}|Procs]) ->
+lookat_all_pids([#proc{pid=Pid0}|Procs],TruncAllowed,IncompAllowed) ->
     Pid = pid_to_list(Pid0),
-    {ok,_ProcDetails=#proc{},_ProcTW} = crashdump_viewer:proc_details(Pid),
-    {ok,_Ets,_EtsTW} = crashdump_viewer:ets_tables(Pid),
-    {ok,_Timers,_TimersTW} = crashdump_viewer:timers(Pid),
-    lookat_all_pids(Procs).
+    {ok,_ProcDetails=#proc{},ProcTW} = crashdump_viewer:proc_details(Pid),
+    {ok,_Ets,EtsTW} = crashdump_viewer:ets_tables(Pid),
+    {ok,_Timers,TimersTW} = crashdump_viewer:timers(Pid),
+    case {ProcTW,EtsTW,TimersTW} of
+        {[],[],[]} ->
+            ok;
+        {["WARNING: This process has an incomplete heap."++_],[],[]}
+          when IncompAllowed ->
+            ok;  % native libs, literals might not be included in dump
+        _ when TruncAllowed ->
+            ok; % truncated dump
+        TWs ->
+            ct:fail({unexpected_warning,TWs})
+    end,
+    lookat_all_pids(Procs,TruncAllowed,IncompAllowed).
 
 lookat_all_ports([]) ->
     ok;
@@ -814,6 +840,11 @@ dump_prefix(current) ->
 dump_prefix(Rel) ->
     lists:concat(["r",Rel,"_dump."]).
 
+get_rel_from_dump_name(File) ->
+    Name = filename:basename(File),
+    ["r"++Rel|_] = string:split(Name,"_"),
+    list_to_integer(Rel).
+
 compat_rel(current) ->
     "";
 compat_rel(Rel) ->
-- 
cgit v1.2.3