| %% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*- |
| %% ex: ts=4 sw=4 et |
| %% ------------------------------------------------------------------- |
| %% |
| %% rebar: Erlang Build Tools |
| %% |
| %% Copyright (c) 2009 Dave Smith (dizzyd@dizzyd.com) |
| %% |
| %% Permission is hereby granted, free of charge, to any person obtaining a copy |
| %% of this software and associated documentation files (the "Software"), to deal |
| %% in the Software without restriction, including without limitation the rights |
| %% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| %% copies of the Software, and to permit persons to whom the Software is |
| %% furnished to do so, subject to the following conditions: |
| %% |
| %% The above copyright notice and this permission notice shall be included in |
| %% all copies or substantial portions of the Software. |
| %% |
| %% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| %% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| %% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| %% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| %% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| %% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| %% THE SOFTWARE. |
| %% |
| %% ------------------------------------------------------------------- |
| |
| %% ------------------------------------------------------------------- |
| %% This module borrows heavily from http://github.com/etnt/exrefcheck project as |
| %% written by Torbjorn Tornkvist <tobbe@kreditor.se>, Daniel Luna |
| %% <daniel@lunas.se> and others. |
| %% ------------------------------------------------------------------- |
| -module(rebar_xref). |
| |
| -include("rebar.hrl"). |
| |
| -export([xref/2]). |
| |
| %% for internal use only |
| -export([info/2]). |
| |
| -dialyzer({no_opaque, find_function_source/4}). |
| |
| %% =================================================================== |
| %% Public API |
| %% =================================================================== |
| |
| xref(Config, _) -> |
| %% Spin up xref |
| {ok, _} = xref:start(xref), |
| ok = xref:set_library_path(xref, code_path(Config)), |
| |
| xref:set_default(xref, [{warnings, |
| rebar_config:get(Config, xref_warnings, false)}, |
| {verbose, rebar_log:is_verbose(Config)}]), |
| |
| {ok, _} = xref:add_directory(xref, "ebin"), |
| |
| %% Save the code path prior to doing anything |
| OrigPath = code:get_path(), |
| true = code:add_path(rebar_utils:ebin_dir()), |
| |
| %% Add extra paths to code path to, for example, be used |
| %% when behaviour modules are defined. |
| lists:foreach(fun(P) -> true = code:add_path(P) end, |
| rebar_config:get(Config, xref_extra_paths, [])), |
| |
| %% Get list of xref checks we want to run |
| ConfXrefChecks = rebar_config:get(Config, xref_checks, |
| [exports_not_used, |
| undefined_function_calls]), |
| |
| SupportedXrefs = [undefined_function_calls, undefined_functions, |
| locals_not_used, exports_not_used, |
| deprecated_function_calls, deprecated_functions], |
| |
| XrefChecks = sets:to_list(sets:intersection( |
| sets:from_list(SupportedXrefs), |
| sets:from_list(ConfXrefChecks))), |
| |
| %% Run xref checks |
| XrefNoWarn = xref_checks(XrefChecks), |
| |
| %% Run custom queries |
| QueryChecks = rebar_config:get(Config, xref_queries, []), |
| QueryNoWarn = lists:all(fun check_query/1, QueryChecks), |
| |
| %% Restore the original code path |
| true = rebar_utils:cleanup_code_path(OrigPath), |
| |
| %% Stop xref |
| stopped = xref:stop(xref), |
| |
| case lists:member(false, [XrefNoWarn, QueryNoWarn]) of |
| true -> |
| case rebar_config:get_xconf(Config, keep_going, false) of |
| false -> |
| ?FAIL; |
| true -> |
| ok |
| end; |
| false -> |
| ok |
| end. |
| |
| %% =================================================================== |
| %% Internal functions |
| %% =================================================================== |
| |
| info(help, xref) -> |
| ?CONSOLE( |
| "Run cross reference analysis.~n" |
| "~n" |
| "Valid rebar.config options:~n" |
| " ~p~n" |
| " ~p~n" |
| " ~p~n" |
| " ~p~n", |
| [ |
| {xref_warnings, false}, |
| {xref_extra_paths,[]}, |
| {xref_checks, [undefined_function_calls, undefined_functions, |
| locals_not_used, exports_not_used, |
| deprecated_function_calls, deprecated_functions]}, |
| {xref_queries, |
| [{"(xc - uc) || (xu - x - b" |
| " - (\"mod\":\".*foo\"/\"4\"))",[]}]} |
| ]). |
| |
| xref_checks(XrefChecks) -> |
| XrefWarnCount = lists:foldl(fun run_xref_check/2, 0, XrefChecks), |
| XrefWarnCount =:= 0. |
| |
| run_xref_check(XrefCheck, Acc) -> |
| {ok, Results} = xref:analyze(xref, XrefCheck), |
| FilteredResults =filter_xref_results(XrefCheck, Results), |
| lists:foreach(fun(Res) -> |
| display_xref_result(XrefCheck, Res) |
| end, |
| FilteredResults), |
| Acc + length(FilteredResults). |
| |
| check_query({Query, Value}) -> |
| {ok, Answer} = xref:q(xref, Query), |
| case Answer =:= Value of |
| false -> |
| ?CONSOLE("Query ~s~n answer ~p~n did not match ~p~n", |
| [Query, Answer, Value]), |
| false; |
| _ -> |
| true |
| end. |
| |
| code_path(Config) -> |
| %% Slight hack to ensure that sub_dirs get properly included |
| %% in code path for xref -- otherwise one gets a lot of undefined |
| %% functions, even though those functions are present as part |
| %% of compilation. H/t to @dluna. Long term we should tie more |
| %% properly into the overall compile code path if possible. |
| BaseDir = rebar_utils:base_dir(Config), |
| [P || P <- code:get_path() ++ |
| rebar_config:get(Config, xref_extra_paths, []) ++ |
| [filename:join(BaseDir, filename:join(SubDir, "ebin")) |
| || SubDir <- rebar_config:get(Config, sub_dirs, [])], |
| filelib:is_dir(P)]. |
| |
| %% |
| %% Ignore behaviour functions, and explicitly marked functions |
| %% |
| %% Functions can be ignored by using |
| %% -ignore_xref([{F, A}, {M, F, A}...]). |
| |
| get_xref_ignorelist(Mod, XrefCheck) -> |
| %% Get ignore_xref attribute and combine them in one list |
| Attributes = |
| try |
| Mod:module_info(attributes) |
| catch |
| _Class:_Error -> [] |
| end, |
| |
| IgnoreXref = keyall(ignore_xref, Attributes), |
| |
| BehaviourCallbacks = get_behaviour_callbacks(XrefCheck, Attributes), |
| |
| %% And create a flat {M,F,A} list |
| lists:foldl( |
| fun({F, A}, Acc) -> [{Mod,F,A} | Acc]; |
| ({M, F, A}, Acc) -> [{M,F,A} | Acc] |
| end, [], lists:flatten([IgnoreXref, BehaviourCallbacks])). |
| |
| keyall(Key, List) -> |
| lists:flatmap(fun({K, L}) when Key =:= K -> L; (_) -> [] end, List). |
| |
| get_behaviour_callbacks(exports_not_used, Attributes) -> |
| [B:behaviour_info(callbacks) || |
| B <- keyall(behaviour, Attributes) ++ keyall(behavior, Attributes)]; |
| get_behaviour_callbacks(_XrefCheck, _Attributes) -> |
| []. |
| |
| parse_xref_result({_, MFAt}) -> MFAt; |
| parse_xref_result(MFAt) -> MFAt. |
| |
| filter_xref_results(XrefCheck, XrefResults) -> |
| SearchModules = lists:usort( |
| lists:map( |
| fun({Mt,_Ft,_At}) -> Mt; |
| ({{Ms,_Fs,_As},{_Mt,_Ft,_At}}) -> Ms; |
| (_) -> undefined |
| end, XrefResults)), |
| |
| Ignores = lists:flatmap(fun(Module) -> |
| get_xref_ignorelist(Module, XrefCheck) |
| end, SearchModules), |
| |
| [Result || Result <- XrefResults, |
| not lists:member(parse_xref_result(Result), Ignores)]. |
| |
| display_xref_result(Type, XrefResult) -> |
| { Source, SMFA, TMFA } = case XrefResult of |
| {MFASource, MFATarget} -> |
| {format_mfa_source(MFASource), |
| format_mfa(MFASource), |
| format_mfa(MFATarget)}; |
| MFATarget -> |
| {format_mfa_source(MFATarget), |
| format_mfa(MFATarget), |
| undefined} |
| end, |
| case Type of |
| undefined_function_calls -> |
| ?CONSOLE("~sWarning: ~s calls undefined function ~s (Xref)\n", |
| [Source, SMFA, TMFA]); |
| undefined_functions -> |
| ?CONSOLE("~sWarning: ~s is undefined function (Xref)\n", |
| [Source, SMFA]); |
| locals_not_used -> |
| ?CONSOLE("~sWarning: ~s is unused local function (Xref)\n", |
| [Source, SMFA]); |
| exports_not_used -> |
| ?CONSOLE("~sWarning: ~s is unused export (Xref)\n", |
| [Source, SMFA]); |
| deprecated_function_calls -> |
| ?CONSOLE("~sWarning: ~s calls deprecated function ~s (Xref)\n", |
| [Source, SMFA, TMFA]); |
| deprecated_functions -> |
| ?CONSOLE("~sWarning: ~s is deprecated function (Xref)\n", |
| [Source, SMFA]); |
| Other -> |
| ?CONSOLE("~sWarning: ~s - ~s xref check: ~s (Xref)\n", |
| [Source, SMFA, TMFA, Other]) |
| end. |
| |
| format_mfa({M, F, A}) -> |
| ?FMT("~s:~s/~w", [M, F, A]). |
| |
| format_mfa_source(MFA) -> |
| case find_mfa_source(MFA) of |
| {module_not_found, function_not_found} -> ""; |
| {Source, function_not_found} -> ?FMT("~s: ", [Source]); |
| {Source, Line} -> ?FMT("~s:~w: ", [Source, Line]) |
| end. |
| |
| %% |
| %% Extract an element from a tuple, or undefined if N > tuple size |
| %% |
| safe_element(N, Tuple) -> |
| case catch(element(N, Tuple)) of |
| {'EXIT', {badarg, _}} -> |
| undefined; |
| Value -> |
| Value |
| end. |
| |
| %% |
| %% Given a MFA, find the file and LOC where it's defined. Note that |
| %% xref doesn't work if there is no abstract_code, so we can avoid |
| %% being too paranoid here. |
| %% |
| find_mfa_source({M, F, A}) -> |
| case code:get_object_code(M) of |
| error -> {module_not_found, function_not_found}; |
| {M, Bin, _} -> find_function_source(M,F,A,Bin) |
| end. |
| |
| find_function_source(M, F, A, Bin) -> |
| AbstractCode = beam_lib:chunks(Bin, [abstract_code]), |
| {ok, {M, [{abstract_code, {raw_abstract_v1, Code}}]}} = AbstractCode, |
| %% Extract the original source filename from the abstract code |
| [{attribute, 1, file, {Source, _}} | _] = Code, |
| %% Extract the line number for a given function def |
| Fn = [E || E <- Code, |
| safe_element(1, E) == function, |
| safe_element(3, E) == F, |
| safe_element(4, E) == A], |
| case Fn of |
| [{function, Line, F, _, _}] -> {Source, Line}; |
| %% do not crash if functions are exported, even though they |
| %% are not in the source. |
| %% parameterized modules add new/1 and instance/1 for example. |
| [] -> {Source, function_not_found} |
| end. |
