emulator: Add a fourth element in exception stacktraces

This commit is a preparation for introducing location information
(filename/line number) in stacktraces in exceptions. Currently
a stack trace looks like:

  [{Mod1,Function1,Arity1},
   .
   .
   .
   {ModN,FunctionN,ArityN}]

Add a forth element to each tuple that can be used indication
the filename and line number of the source file:

  [{Mod1,Function1,Arity1,Location1},
   .
   .
   .
   {ModN,FunctionN,ArityN,LocationN}]

In this commit, the fourth element will just be an empty list,
and we will change all code that look at or manipulate stacktraces.

5 files changed, 76 insertions, 44 deletions

diff --git a/erts/emulator/test/call_trace_SUITE.erl b/erts/emulator/test/call_trace_SUITE.erl
index 93fdc157f7..3e2bee06d1 100644
--- a/erts/emulator/test/call_trace_SUITE.erl
+++ b/erts/emulator/test/call_trace_SUITE.erl
@@ -934,6 +934,10 @@ exception_nocatch(Config) when is_list(Config) ->
     exception_nocatch().
 
 exception_nocatch() ->
+    Deep4LocThrow = get_deep_4_loc({throw,[42]}),
+    Deep4LocError = get_deep_4_loc({error,[42]}),
+    Deep4LocBadmatch = get_deep_4_loc({'=',[a,b]}),
+
     Prog = [{'_',[],[{exception_trace}]}],
     ?line 1 = erlang:trace_pattern({?MODULE,deep_1,'_'}, Prog),
     ?line 1 = erlang:trace_pattern({?MODULE,deep_2,'_'}, Prog),
@@ -959,8 +963,9 @@ exception_nocatch() ->
 			   {trace,t2,exception_from,{erlang,throw,1},
 			    {error,{nocatch,Q2}}}],
 			  exception_from, {error,{nocatch,Q2}}),
-    ?line expect({trace,T2,exit,{{nocatch,Q2},[{erlang,throw,[Q2]},
-					       {?MODULE,deep_4,1}]}}),
+    ?line expect({trace,T2,exit,{{nocatch,Q2},[{erlang,throw,[Q2],[]},
+					       {?MODULE,deep_4,1,
+						Deep4LocThrow}]}}),
     ?line Q3 = {dump,[dump,{dump}]},
     ?line T3 = 
 	exception_nocatch(?LINE, error, [Q3], 4, 
@@ -968,18 +973,29 @@ exception_nocatch() ->
 			   {trace,t3,exception_from,{erlang,error,1},
 			    {error,Q3}}],
 			  exception_from, {error,Q3}),
-    ?line expect({trace,T3,exit,{Q3,[{erlang,error,[Q3]},
-				     {?MODULE,deep_4,1}]}}),
+    ?line expect({trace,T3,exit,{Q3,[{erlang,error,[Q3],[]},
+				     {?MODULE,deep_4,1,Deep4LocError}]}}),
     ?line T4 = 
 	exception_nocatch(?LINE, '=', [17,4711], 5, [], 
 			  exception_from, {error,{badmatch,4711}}),
-    ?line expect({trace,T4,exit,{{badmatch,4711},[{?MODULE,deep_4,1}]}}),
+    ?line expect({trace,T4,exit,{{badmatch,4711},
+				 [{?MODULE,deep_4,1,Deep4LocBadmatch}]}}),
     %%
     ?line erlang:trace_pattern({?MODULE,'_','_'}, false),
     ?line erlang:trace_pattern({erlang,'_','_'}, false),
     ?line expect(),
     ?line ok.
 
+get_deep_4_loc(Arg) ->
+    try
+	deep_4(Arg),
+	?t:fail(should_not_return_to_here)
+    catch
+	_:_ ->
+	    [{?MODULE,deep_4,1,Loc0}|_] = erlang:get_stacktrace(),
+	    Loc0
+    end.
+
 exception_nocatch(Line, B, Q, N, Extra, Tag, R) ->
     ?line io:format("== Subtest: ~w", [Line]),
     ?line Go = make_ref(),
diff --git a/erts/emulator/test/exception_SUITE.erl b/erts/emulator/test/exception_SUITE.erl
index 9d6fc9521d..63aa1c94f5 100644
--- a/erts/emulator/test/exception_SUITE.erl
+++ b/erts/emulator/test/exception_SUITE.erl
@@ -141,14 +141,20 @@ pending_exit_message(Args, Expected) ->
     end,
     process_flag(trap_exit, false).
 
-pending({badarg, [{erlang,Bif,BifArgs},{?MODULE,Func,Arity}|_]}, Func, Args, _Code)
-  when is_atom(Bif), is_list(BifArgs), length(Args) == Arity ->
+pending({badarg,[{erlang,Bif,BifArgs,Loc1},
+		 {?MODULE,Func,Arity,Loc2}|_]},
+	Func, Args, _Code)
+  when is_atom(Bif), is_list(BifArgs), length(Args) =:= Arity,
+       is_list(Loc1), is_list(Loc2) ->
     ok;
-pending({undef,[{non_existing_module,foo,[]}|_]}, _, _, _) ->
+pending({undef,[{non_existing_module,foo,[],Loc}|_]}, _, _, _)
+  when is_list(Loc) ->
     ok;
-pending({function_clause,[{?MODULE,Func,Args}|_]}, Func, Args, _Code) ->
+pending({function_clause,[{?MODULE,Func,Args,Loc}|_]}, Func, Args, _Code)
+  when is_list(Loc) ->
     ok;
-pending({Code,[{?MODULE,Func,Arity}|_]}, Func, Args, Code) when length(Args) == Arity ->
+pending({Code,[{?MODULE,Func,Arity,Loc}|_]}, Func, Args, Code)
+  when length(Args) =:= Arity, is_list(Loc) ->
     ok;
 pending(Reason, _Function, _Args, _Code) ->
     test_server:fail({bad_exit_reason,Reason}).
@@ -255,24 +261,24 @@ stacktrace(Conf) when is_list(Conf) ->
     ?line {_,Mref} = spawn_monitor(fun() -> exit({Tag,erlang:get_stacktrace()}) end),
     ?line {Tag,[]} = receive {'DOWN',Mref,_,_,Info} -> Info end,
     V = [make_ref()|self()],
-    ?line {value2,{caught1,badarg,[{erlang,abs,[V]}|_]=St1}} =
+    ?line {value2,{caught1,badarg,[{erlang,abs,[V],_}|_]=St1}} =
 	stacktrace_1({'abs',V}, error, {value,V}),
     ?line St1 = erase(stacktrace1),
     ?line St1 = erase(stacktrace2),
     ?line St1 = erlang:get_stacktrace(),
-    ?line {caught2,{error,badarith},[{?MODULE,my_add,2}|_]=St2} =
+    ?line {caught2,{error,badarith},[{?MODULE,my_add,2,_}|_]=St2} =
 	stacktrace_1({'div',{1,0}}, error, {'add',{0,a}}),
-    ?line [{?MODULE,my_div,2}|_] = erase(stacktrace1),
+    ?line [{?MODULE,my_div,2,_}|_] = erase(stacktrace1),
     ?line St2 = erase(stacktrace2),
     ?line St2 = erlang:get_stacktrace(),
-    ?line {caught2,{error,{try_clause,V}},[{?MODULE,stacktrace_1,3}|_]=St3} =
+    ?line {caught2,{error,{try_clause,V}},[{?MODULE,stacktrace_1,3,_}|_]=St3} =
 	stacktrace_1({value,V}, error, {value,V}),
     ?line St3 = erase(stacktrace1),
     ?line St3 = erase(stacktrace2),
     ?line St3 = erlang:get_stacktrace(),
-    ?line {caught2,{throw,V},[{?MODULE,foo,1}|_]=St4} =
+    ?line {caught2,{throw,V},[{?MODULE,foo,1,_}|_]=St4} =
 	stacktrace_1({value,V}, error, {throw,V}),
-    ?line [{?MODULE,stacktrace_1,3}|_] = erase(stacktrace1),
+    ?line [{?MODULE,stacktrace_1,3,_}|_] = erase(stacktrace1),
     ?line St4 = erase(stacktrace2),
     ?line St4 = erlang:get_stacktrace(),
 
@@ -280,8 +286,8 @@ stacktrace(Conf) when is_list(Conf) ->
 	?line stacktrace_2()
     catch
 	error:{badmatch,_} ->
-	    [{?MODULE,stacktrace_2,0},
-	     {?MODULE,stacktrace,1}|_] =
+	    [{?MODULE,stacktrace_2,0,_},
+	     {?MODULE,stacktrace,1,_}|_] =
 		erlang:get_stacktrace(),
 	    ok
     end.
@@ -315,15 +321,15 @@ nested_stacktrace(Conf) when is_list(Conf) ->
 	nested_stacktrace_1({{value,{V,x1}},void,{V,x1}},
 			    {void,void,void}),
     ?line {caught1,
-	   [{?MODULE,my_add,2}|_],
+	   [{?MODULE,my_add,2,_}|_],
 	   value2,
-	   [{?MODULE,my_add,2}|_]} =
+	   [{?MODULE,my_add,2,_}|_]} =
 	nested_stacktrace_1({{'add',{V,x1}},error,badarith},
 			    {{value,{V,x2}},void,{V,x2}}),
     ?line {caught1,
-	   [{?MODULE,my_add,2}|_],
-	   {caught2,[{erlang,abs,[V]}|_]},
-	   [{erlang,abs,[V]}|_]} =
+	   [{?MODULE,my_add,2,_}|_],
+	   {caught2,[{erlang,abs,[V],_}|_]},
+	   [{erlang,abs,[V],_}|_]} =
 	nested_stacktrace_1({{'add',{V,x1}},error,badarith},
 			    {{'abs',V},error,badarg}),
     ok.
@@ -362,7 +368,7 @@ raise(Conf) when is_list(Conf) ->
 	end,
     ?line A = erlang:get_stacktrace(),
     ?line A = get(raise),
-    ?line [{?MODULE,my_div,2}|_] = A,
+    ?line [{?MODULE,my_div,2,_}|_] = A,
     %%
     N = 8, % Must be even
     ?line N = erlang:system_flag(backtrace_depth, N),
@@ -387,12 +393,12 @@ raise(Conf) when is_list(Conf) ->
 odd_even(N, R) when is_integer(N), N > 1 ->
     odd_even(N-1, 
 	     [if (N rem 2) == 0 ->
-		      {?MODULE,even,1};
+		      {?MODULE,even,1,[]};
 		 true ->
-		      {?MODULE,odd,1}
+		      {?MODULE,odd,1,[]}
 	      end|R]);
 odd_even(1, R) ->
-    [{?MODULE,odd,[1]}|R].
+    [{?MODULE,odd,[1],[]}|R].
 
 even(N) when is_integer(N), N > 1, (N rem 2) == 0 ->
     odd(N-1)++[N].
diff --git a/erts/emulator/test/guard_SUITE.erl b/erts/emulator/test/guard_SUITE.erl
index f41324c2cc..a5df9b59a0 100644
--- a/erts/emulator/test/guard_SUITE.erl
+++ b/erts/emulator/test/guard_SUITE.erl
@@ -421,7 +421,7 @@ try_gbif(Id, X, Y) ->
 
 try_fail_gbif(Id, X, Y) ->
     case catch guard_bif(Id, X, Y) of
-	{'EXIT', {function_clause,[{?MODULE,guard_bif,[Id,X,Y]}|_]}} ->
+	{'EXIT',{function_clause,[{?MODULE,guard_bif,[Id,X,Y],_}|_]}} ->
 	    io:format("guard_bif(~p, ~p, ~p) -- ok", [Id,X,Y]);
 	Other ->
 	    ?line ok = io:format("guard_bif(~p, ~p, ~p) -- bad result: ~p\n",
@@ -493,9 +493,9 @@ type_tests(Test, [Type|T], Allowed) ->
 	    end;
 	false ->
 	    case catch type_test(Test, Value) of
-		{'EXIT', {function_clause, {?MODULE,type_test,[Test,Value]}}} ->
-		    ok;
-		{'EXIT', {function_clause,[{?MODULE,type_test,[Test,Value]}|_]}} ->
+		{'EXIT',{function_clause,
+			 [{?MODULE,type_test,[Test,Value],Loc}|_]}}
+		when is_list(Loc) ->
 		    ok;
 		{'EXIT',Other} ->
 		    ?line test_server:fail({unexpected_error_reason,Other});
diff --git a/erts/emulator/test/process_SUITE.erl b/erts/emulator/test/process_SUITE.erl
index f68e712268..5641489f5c 100644
--- a/erts/emulator/test/process_SUITE.erl
+++ b/erts/emulator/test/process_SUITE.erl
@@ -258,7 +258,9 @@ trap_exit_badarg() ->
     ?line Pid = fun_spawn(fun() -> bad_guy(kb_128()) end),
     ?line Garbage = kb_128(),
     ?line receive
-	      {'EXIT', Pid, {badarg,[{erlang,abs,[Garbage]},{?MODULE,bad_guy,1}|_]}} ->
+	      {'EXIT',Pid,{badarg,[{erlang,abs,[Garbage],Loc1},
+				   {?MODULE,bad_guy,1,Loc2}|_]}}
+	      when is_list(Loc1), is_list(Loc2) ->
 		  ok;
 	      Other ->
 		  ?line ok = io:format("Bad EXIT message: ~P", [Other, 30]),
diff --git a/erts/emulator/test/trace_local_SUITE.erl b/erts/emulator/test/trace_local_SUITE.erl
index 091e960610..32e2a98e3c 100644
--- a/erts/emulator/test/trace_local_SUITE.erl
+++ b/erts/emulator/test/trace_local_SUITE.erl
@@ -767,8 +767,8 @@ exception_test(Opts, Func0, Args0) ->
 	end,
     
     ?line R1 = exc_slave(ExcOpts, Func, Args),
-    ?line Stack2 = [{?MODULE,exc_top,3},{?MODULE,slave,2}],
-    ?line Stack3 = [{?MODULE,exc,2}|Stack2],
+    ?line Stack2 = [{?MODULE,exc_top,3,[]},{?MODULE,slave,2,[]}],
+    ?line Stack3 = [{?MODULE,exc,2,[]}|Stack2],
     ?line Rs = 
 	case x_exc_top(ExcOpts, Func, Args) of % Emulation
 	    {crash,{Reason,Stack}}=R when is_list(Stack) ->
@@ -789,21 +789,29 @@ exception_test(Opts, Func0, Args0) ->
 	  end,
     ?line expect({nm}).
 
-exception_validate(R1, [R2|Rs]) ->
+exception_validate(R0, Rs0) ->
+    R = clean_location(R0),
+    Rs = [clean_location(E) || E <- Rs0],
+    exception_validate_1(R, Rs).
+
+exception_validate_1(R1, [R2|Rs]) ->
     case [R1|R2] of
 	[R|R] ->
 	    ok;
-	[{crash,{badarg,[{lists,reverse,[L1a,L1b]}|T]}}|
-	 {crash,{badarg,[{lists,reverse,[L2a,L2b]}|T]}}] ->
+	[{crash,{badarg,[{lists,reverse,[L1a,L1b],_}|T]}}|
+	 {crash,{badarg,[{lists,reverse,[L2a,L2b],_}|T]}}] ->
 	    same({crash,{badarg,[{lists,reverse,
-				  [lists:reverse(L1b, L1a),[]]}|T]}},
+				  [lists:reverse(L1b, L1a),[]],[]}|T]}},
 		 {crash,{badarg,[{lists,reverse,
-				  [lists:reverse(L2b, L2a),[]]}|T]}});
+				  [lists:reverse(L2b, L2a),[]],[]}|T]}});
 	_ when is_list(Rs), Rs =/= [] ->
 	    exception_validate(R1, Rs)
     end.
 
-
+clean_location({crash,{Reason,Stk0}}) ->
+    Stk = [{M,F,A,[]} || {M,F,A,_} <- Stk0],
+    {crash,{Reason,Stk}};
+clean_location(Term) -> Term.
 
 %%% Tracee target functions %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%
@@ -1057,10 +1065,10 @@ x_exc_exception(_Rtt, M, F, _, Arity, CR) ->
 x_exc_stacktrace() ->
     x_exc_stacktrace(erlang:get_stacktrace()).
 %% Truncate stacktrace to below exc/2
-x_exc_stacktrace([{?MODULE,x_exc,4}|_]) -> [];
-x_exc_stacktrace([{?MODULE,x_exc_func,4}|_]) -> [];
-x_exc_stacktrace([{?MODULE,x_exc_body,4}|_]) -> [];
-x_exc_stacktrace([{?MODULE,exc,2}|_]) -> [];
+x_exc_stacktrace([{?MODULE,x_exc,4,_}|_]) -> [];
+x_exc_stacktrace([{?MODULE,x_exc_func,4,_}|_]) -> [];
+x_exc_stacktrace([{?MODULE,x_exc_body,4,_}|_]) -> [];
+x_exc_stacktrace([{?MODULE,exc,2,_}|_]) -> [];
 x_exc_stacktrace([H|T]) ->
     [H|x_exc_stacktrace(T)].