tools: Add handling of the -on_load() attribute to Xref

6 files changed, 99 insertions, 50 deletions

diff --git a/lib/tools/doc/src/venn2.fig b/lib/tools/doc/src/venn2.fig
index 3694c12f0c..233686a729 100644
--- a/lib/tools/doc/src/venn2.fig
+++ b/lib/tools/doc/src/venn2.fig
@@ -1,4 +1,4 @@
-#FIG 3.2
+#FIG 3.2  Produced by xfig version 3.2.5c
 Portrait
 Center
 Inches
@@ -7,34 +7,7 @@ Letter
 Single
 -2
 1200 2
-6 3392 953 5034 3329
-6 3392 953 5034 2595
-6 3392 953 5034 2595
-5 1 0 1 -1 7 0 0 -1 0.000 0 0 0 0 2652.489 1773.500 3518 1357 3613 1774 3518 2190
-5 1 0 1 -1 7 0 0 -1 0.000 0 0 0 0 6306.956 1773.000 4028 2575 3891 1774 4028 971
-5 1 0 1 -1 7 0 0 -1 0.000 0 0 0 0 2105.283 1773.000 4402 971 4538 1774 4402 2575
-1 1 0 1 -1 7 0 0 -1 0.000 1 0.0000 4214 1774 820 821 4214 1774 3659 1171
-2 1 0 1 -1 7 0 0 -1 0.000 0 0 -1 0 0 1
-	 4821 2325
-2 1 0 1 -1 7 0 0 -1 0.000 0 0 -1 0 0 2
-	 4816 1217 4816 2329
-2 1 0 1 -1 7 0 0 -1 0.000 0 0 7 0 0 2
-	 3392 1769 4816 1769
-2 1 0 1 0 0 100 0 1 0.000 0 0 -1 0 0 2
-	 4816 1982 5008 1982
--6
-2 3 0 0 0 0 101 0 5 0.000 0 0 -1 0 0 36
-	 4026 977 4011 1025 3996 1072 3981 1120 3966 1177 3954 1225
-	 3944 1272 3929 1327 3919 1412 3909 1477 3899 1540 3894 1592
-	 3894 1642 3891 1697 3889 1742 3889 1770 3394 1767 3396 1717
-	 3399 1665 3409 1610 3424 1555 3439 1502 3464 1440 3489 1390
-	 3516 1340 3551 1292 3584 1250 3631 1200 3679 1150 3731 1110
-	 3801 1065 3869 1030 3931 1005 3986 982 4009 980 4026 977
--6
-4 0 0 101 0 0 11 0.0000 4 105 525 3965 3044 X - XU\001
-4 0 0 101 0 0 11 0.0000 4 150 1110 3688 3299 exports_not_used\001
--6
-6 5850 938 7560 3329
+6 5850 938 8070 3344
 6 5884 938 7526 2580
 6 5884 938 7526 2580
 5 1 0 1 -1 7 0 0 -1 0.000 0 0 0 0 5144.489 1758.500 6010 1342 6105 1759 6010 2175
@@ -63,8 +36,8 @@ Single
 	 7019 1990 7022 1945 7027 1900 7029 1855 7029 1805 7032 1765
 	 7029 1752 7309 1757
 -6
-4 0 0 101 0 0 11 0.0000 4 135 1470 6000 3014 L * (UU + (XU - LU))\001
-4 0 0 101 0 0 11 0.0000 4 150 1800 5850 3299 locals_not_used (simplified)\001
+4 0 0 101 0 0 11 0.0000 4 180 2070 6000 3014 (L-OL) * (UU + (XU-LU))\001
+4 0 0 101 0 0 11 0.0000 4 180 2160 5850 3299 locals_not_used (simplified)\001
 -6
 6 900 900 2550 3600
 6 900 900 2550 2625
@@ -91,7 +64,34 @@ Single
 	 2330 1222 2365 1265 2402 1317 2437 1382 2477 1455 2500 1517
 	 2520 1585 2532 1645 2540 1712 2542 1780 2540 1842 2535 1907
 	 2527 1957 2517 1990 2325 1987 2330 1222
-4 0 0 101 0 0 11 0.0000 4 105 780 1331 3044 XU - X - B\001
-4 0 0 101 0 0 11 0.0000 4 150 1260 1113 3314 undefined_functions\001
+4 0 0 101 0 0 11 0.0000 4 135 825 1331 3044 XU - X - B\001
+4 0 0 101 0 0 11 0.0000 4 180 1530 1113 3314 undefined_functions\001
 4 0 0 100 0 0 10 0.0000 4 135 1005 1275 3525 (modules mode)\001
 -6
+6 3392 953 5034 3329
+6 3392 953 5034 2595
+6 3392 953 5034 2595
+5 1 0 1 -1 7 0 0 -1 0.000 0 0 0 0 2652.489 1773.500 3518 1357 3613 1774 3518 2190
+5 1 0 1 -1 7 0 0 -1 0.000 0 0 0 0 6306.956 1773.000 4028 2575 3891 1774 4028 971
+5 1 0 1 -1 7 0 0 -1 0.000 0 0 0 0 2105.283 1773.000 4402 971 4538 1774 4402 2575
+1 1 0 1 -1 7 0 0 -1 0.000 1 0.0000 4214 1774 820 821 4214 1774 3659 1171
+2 1 0 1 -1 7 0 0 -1 0.000 0 0 -1 0 0 1
+	 4821 2325
+2 1 0 1 -1 7 0 0 -1 0.000 0 0 -1 0 0 2
+	 4816 1217 4816 2329
+2 1 0 1 -1 7 0 0 -1 0.000 0 0 7 0 0 2
+	 3392 1769 4816 1769
+2 1 0 1 0 0 100 0 1 0.000 0 0 -1 0 0 2
+	 4816 1982 5008 1982
+-6
+2 3 0 0 0 0 101 0 5 0.000 0 0 -1 0 0 36
+	 4026 977 4011 1025 3996 1072 3981 1120 3966 1177 3954 1225
+	 3944 1272 3929 1327 3919 1412 3909 1477 3899 1540 3894 1592
+	 3894 1642 3891 1697 3889 1742 3889 1770 3394 1767 3396 1717
+	 3399 1665 3409 1610 3424 1555 3439 1502 3464 1440 3489 1390
+	 3516 1340 3551 1292 3584 1250 3631 1200 3679 1150 3731 1110
+	 3801 1065 3869 1030 3931 1005 3986 982 4009 980 4026 977
+-6
+4 0 0 101 0 0 11 0.0000 4 135 555 3965 3044 X - XU\001
+4 0 0 101 0 0 11 0.0000 4 180 1350 3688 3299 exports_not_used\001
+-6
diff --git a/lib/tools/doc/src/venn2.gif b/lib/tools/doc/src/venn2.gif
index 4cfea24646..bb12f4bd1f 100644
--- a/lib/tools/doc/src/venn2.gif
+++ b/lib/tools/doc/src/venn2.gif
diff --git a/lib/tools/doc/src/xref.xml b/lib/tools/doc/src/xref.xml
index 11c6fa56f6..6f833246ad 100644
--- a/lib/tools/doc/src/xref.xml
+++ b/lib/tools/doc/src/xref.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>2000</year><year>2016</year>
+      <year>2000</year><year>2017</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -347,6 +347,9 @@ represented by
       <item>Locally Used Functions (*). Functions of all modules that have
        been used in some local call.
       </item>
+      <tag><c>OL</c></tag>
+      <item>Functions with an attribute tag <c>on_load</c> (*).
+      </item>
       <tag><c>LC</c></tag>
       <item>Local Calls (*).</item>
       <tag><c>XC</c></tag>
@@ -393,6 +396,7 @@ facts about the
       <c>LU</c> and <c>XU</c> may have elements in common. Put in
        another way:</item>
       <item><c>V</c> is equal to <c>UU + XU + LU</c>.</item>
+      <item><c>OL</c> is a subset of <c>F</c>.</item>
       <item><c>E</c> is equal to <c>LC + XC</c>. Note that <c>LC</c>
        and <c>XC</c> may have elements in common, namely if some
        function is locally and externally used from one and the same
diff --git a/lib/tools/src/xref_base.erl b/lib/tools/src/xref_base.erl
index 3199b28acb..a28c6ee283 100644
--- a/lib/tools/src/xref_base.erl
+++ b/lib/tools/src/xref_base.erl
@@ -400,7 +400,9 @@ analysis(locals_not_used, functions) ->
     %% used (indirectly) from any export: "(domain EE + range EE) * L".
     %% But then we only get locals that make some calls, so we add
     %% locals that are not used at all: "L * (UU + XU - LU)".
-    "L * ((UU + XU - LU) + domain EE + range EE)";
+    %% We also need to exclude functions with the -on_load() attribute:
+    %% (L - OL) is used rather than just L.
+    "(L - OL) * ((UU + XU - LU) + domain EE + range EE)";
 analysis(exports_not_used, _) ->
     %% Local calls are not considered here. "X * UU" would do otherwise.
     "X - XU";
@@ -918,7 +920,7 @@ do_add_module(S, XMod, Unres, Data) ->
     {ok, Ms, Bad, NS}.
 
 prepare_module(_Mode = functions, XMod, Unres0, Data) ->
-    {DefAt0, LPreCAt0, XPreCAt0, LC0, XC0, X0, Attrs, Depr} = Data,
+    {DefAt0, LPreCAt0, XPreCAt0, LC0, XC0, X0, Attrs, Depr, OL0} = Data,
     %% Bad is a list of bad values of 'xref' attributes.
     {ALC0,AXC0,Bad0} = Attrs,
     FT = [tspec(func)],
@@ -935,6 +937,7 @@ prepare_module(_Mode = functions, XMod, Unres0, Data) ->
     ALC1 = xref_utils:xset(ALC0, PCA),
     UnresCalls = xref_utils:xset(Unres0, PCA),
     Unres = domain(UnresCalls),
+    OL1 = xref_utils:xset(OL0, FT),
 
     DefinedFuns = domain(DefAt),
     {AXC, ALC, Bad1, LPreCAt2, XPreCAt2} =
@@ -955,7 +958,7 @@ prepare_module(_Mode = functions, XMod, Unres0, Data) ->
     {DF1,DF_11,DF_21,DF_31,DBad} = depr_mod(Depr, X),
     {EE, ECallAt} = inter_graph(X, L, LC, XC, CallAt),
     {ok, {functions, XMod, [DefAt,L,X,LCallAt,XCallAt,CallAt,LC,XC,EE,ECallAt,
-                            DF1,DF_11,DF_21,DF_31], NoCalls, Unres},
+                            OL1,DF1,DF_11,DF_21,DF_31], NoCalls, Unres},
      DBad++Bad};
 prepare_module(_Mode = modules, XMod, _Unres, Data) ->
     {X0, I0, Depr} = Data,
@@ -967,7 +970,7 @@ prepare_module(_Mode = modules, XMod, _Unres, Data) ->
 finish_module({functions, XMod, List, NoCalls, Unres}, S) ->
     ok  = check_module(XMod, S),
     [DefAt2,L2,X2,LCallAt2,XCallAt2,CallAt2,LC2,XC2,EE2,ECallAt2,
-     DF2,DF_12,DF_22,DF_32] = pack(List),
+     OL2,DF2,DF_12,DF_22,DF_32] = pack(List),
 
     LU = range(LC2),
 
@@ -976,7 +979,7 @@ finish_module({functions, XMod, List, NoCalls, Unres}, S) ->
     M = XMod#xref_mod.name,
     MS = xref_utils:xset(M, atom),
     T = from_sets({MS,DefAt2,L2,X2,LCallAt2,XCallAt2,CallAt2,
-		   LC2,XC2,LU,EE2,ECallAt2,Unres,LPredefined,
+		   LC2,XC2,LU,EE2,ECallAt2,Unres,LPredefined,OL2,
                    DF2,DF_12,DF_22,DF_32}),
 
     NoUnres = XMod#xref_mod.no_unresolved,
@@ -1220,7 +1223,7 @@ do_set_up(S, VerboseOpt) ->
 
 %% If data has been supplied using add_module/9 (and that is the only
 %% sanctioned way), then DefAt, L, X, LCallAt, XCallAt, CallAt, XC, LC,
-%% and LU are  guaranteed to be functions (with all supplied
+%% LU and OL are  guaranteed to be functions (with all supplied
 %% modules as domain (disregarding unknown modules, that is, modules
 %% not supplied but hosting unknown functions)).
 %% As a consequence, V and E are also functions. V is defined for unknown
@@ -1233,8 +1236,8 @@ do_set_up(S, VerboseOpt) ->
 do_set_up(S) when S#xref.mode =:= functions ->
     ModDictList = dict:to_list(S#xref.modules),
     [DefAt0, L, X0, LCallAt, XCallAt, CallAt, LC, XC, LU,
-     EE0, ECallAt, UC, LPredefined,
-     Mod_DF,Mod_DF_1,Mod_DF_2,Mod_DF_3] = make_families(ModDictList, 18),
+     EE0, ECallAt, UC, LPredefined, OL,
+     Mod_DF,Mod_DF_1,Mod_DF_2,Mod_DF_3] = make_families(ModDictList, 19),
 
     {XC_1, XU, XPredefined} = do_set_up_1(XC),
     LC_1 = user_family(union_of_family(LC)),
@@ -1314,13 +1317,14 @@ do_set_up(S) when S#xref.mode =:= functions ->
     UC_1 = user_family(union_of_family(UC)),
 
     ?FORMAT("DefAt ~p~n", [DefAt]),
-    ?FORMAT("U=~p~nLib=~p~nB=~p~nLU=~p~nXU=~p~nUU=~p~n", [U,Lib,B,LU,XU,UU]),
+    ?FORMAT("U=~p~nLib=~p~nB=~p~nLU=~p~nXU=~p~nUU=~p~nOL=~p~n",
+            [U,Lib,B,LU,XU,UU,OL]),
     ?FORMAT("E_1=~p~nLC_1=~p~nXC_1=~p~n", [E_1,LC_1,XC_1]),
     ?FORMAT("EE=~p~nEE_1=~p~nECallAt=~p~n", [EE, EE_1, ECallAt]),
     ?FORMAT("DF=~p~nDF_1=~p~nDF_2=~p~nDF_3=~p~n", [DF, DF_1, DF_2, DF_3]),
 
     Vs = [{'L',L}, {'X',X},{'F',F},{'U',U},{'B',B},{'UU',UU},
-	  {'XU',XU},{'LU',LU},{'V',V},{v,V},
+	  {'XU',XU},{'LU',LU},{'V',V},{v,V},{'OL',OL},
 	  {'LC',{LC,LC_1}},{'XC',{XC,XC_1}},{'E',{E,E_1}},{e,{E,E_1}},
 	  {'EE',{EE,EE_1}},{'UC',{UC,UC_1}},
 	  {'M',M},{'A',A},{'R',R},
@@ -1405,6 +1409,7 @@ var_type('U')    -> {function, vertex};
 var_type('UU')   -> {function, vertex};
 var_type('V')    -> {function, vertex};
 var_type('X')    -> {function, vertex};
+var_type('OL')   -> {function, vertex};
 var_type('XU')   -> {function, vertex};
 var_type('DF')   -> {function, vertex};
 var_type('DF_1') -> {function, vertex};
diff --git a/lib/tools/src/xref_reader.erl b/lib/tools/src/xref_reader.erl
index 88f92df35a..d28bdb78db 100644
--- a/lib/tools/src/xref_reader.erl
+++ b/lib/tools/src/xref_reader.erl
@@ -42,7 +42,8 @@
 	 %% experimental; -xref(FunEdge) is recognized.
 	 lattrs=[],            % local calls, {{mfa(),mfa()},Line}
 	 xattrs=[],            % external calls, -"-
-	 battrs=[]	       % badly formed xref attributes, term().
+	 battrs=[],	       % badly formed xref attributes, term().
+         on_load               % function name
 	 }).
 
 -include("xref.hrl").
@@ -68,15 +69,26 @@ forms([F | Fs], S) ->
 forms([], S) ->
     #xrefr{module = M, def_at = DefAt,
 	   l_call_at = LCallAt, x_call_at = XCallAt,
-	   el = LC, ex = XC, x = X, df = Depr,
+	   el = LC, ex = XC, x = X, df = Depr, on_load = OnLoad,
+	   lattrs = AL, xattrs = AX, battrs = B, unresolved = U} = S,
+    OL = case OnLoad of
+             undefined -> [];
+             F ->
+                 [{M, F, 0}]
+         end,
+    #xrefr{def_at = DefAt,
+	   l_call_at = LCallAt, x_call_at = XCallAt,
+	   el = LC, ex = XC, x = X, df = Depr, on_load = OnLoad,
 	   lattrs = AL, xattrs = AX, battrs = B, unresolved = U} = S,
     Attrs = {lists:reverse(AL), lists:reverse(AX), lists:reverse(B)},
-    {ok, M, {DefAt, LCallAt, XCallAt, LC, XC, X, Attrs, Depr}, U}.
+    {ok, M, {DefAt, LCallAt, XCallAt, LC, XC, X, Attrs, Depr, OL}, U}.
 
 form({attribute, Line, xref, Calls}, S) -> % experimental
     #xrefr{module = M, function = Fun,
 	   lattrs = L, xattrs = X, battrs = B} = S,
     attr(Calls, erl_anno:line(Line), M, Fun, L, X, B, S);
+form({attribute, _, on_load, {F, 0}}, S) ->
+    S#xrefr{on_load = F};
 form({attribute, _Line, _Attr, _Val}, S) ->
     S;
 form({function, _, module_info, 0, _Clauses}, S) ->
diff --git a/lib/tools/test/xref_SUITE.erl b/lib/tools/test/xref_SUITE.erl
index 379a5c09ab..d651cbcfee 100644
--- a/lib/tools/test/xref_SUITE.erl
+++ b/lib/tools/test/xref_SUITE.erl
@@ -51,7 +51,7 @@
 -export([analyze/1, basic/1, md/1, q/1, variables/1, unused_locals/1]).
 
 -export([format_error/1, otp_7423/1, otp_7831/1, otp_10192/1, otp_13708/1,
-         otp_14464/1]).
+         otp_14464/1, otp_14344/1]).
 
 -import(lists, [append/2, flatten/1, keysearch/3, member/2, sort/1, usort/1]).
 
@@ -85,7 +85,7 @@ groups() ->
 
       [analyze, basic, md, q, variables, unused_locals]},
      {misc, [], [format_error, otp_7423, otp_7831, otp_10192, otp_13708,
-                 otp_14464]}].
+                 otp_14464, otp_14344]}].
 
 
 init_per_suite(Conf) when is_list(Conf) ->
@@ -2441,6 +2441,30 @@ otp_14464(Conf) when is_list(Conf) ->
     ok = file:delete(File1),
     ok = file:delete(Beam1).
 
+%% OTP-14344. -on_load() attribute.
+otp_14344(Conf) when is_list(Conf) ->
+    Dir = ?copydir,
+
+    File1 = fname(Dir, "a.erl"),
+    MFile1 = fname(Dir, "a"),
+    Beam1 = fname(Dir, "a.beam"),
+    Test1 = <<"-module(a).
+               -on_load(doit/0).
+               doit() -> ok.
+              ">>,
+    ok = file:write_file(File1, Test1),
+    {ok, a} = compile:file(File1, [debug_info,{outdir,Dir}]),
+
+    {ok, _} = xref:start(s),
+    {ok, a} = xref:add_module(s, MFile1),
+
+    {ok, [{a,doit,0}]} = xref:q(s, "OL"),
+    {ok, []} = xref:analyze(s, locals_not_used),
+
+    xref:stop(s),
+    ok = file:delete(File1),
+    ok = file:delete(Beam1).
+
 %%%
 %%% Utilities
 %%%
@@ -2515,7 +2539,8 @@ add_module(S, XMod, DefAt, X, LCallAt, XCallAt, XC, LC) ->
     Depr0 = {[], [], [], []},
     DBad = [],
     Depr = {Depr0,DBad},
-    Data = {DefAt, LCallAt, XCallAt, LC, XC, X, Attr, Depr},
+    OL = [],
+    Data = {DefAt, LCallAt, XCallAt, LC, XC, X, Attr, Depr, OL},
     Unres = [],
     {ok, _Module, _Bad, State} =
     xref_base:do_add_module(S, XMod, Unres, Data),
@@ -2596,6 +2621,9 @@ functions_mode_check(S, Info) ->
     %% UU subset F
     {ok, []} = xref:q(S, "UU - F"),
 
+    %% OL subset F
+    {ok, []} = xref:q(S, "OL - F"),
+
     %% ME = (Mod) E
     {ok, ME} = xref:q(S, "ME"),
     {ok, ME} = xref:q(S, "(Mod) E"),