%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*- %% ex: ts=4 sw=4 et %% ------------------------------------------------------------------- %% %% rebar: Erlang Build Tools %% %% Copyright (c) 2009, 2010 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. %% ------------------------------------------------------------------- -module(rebar_erlc_compiler). -export([compile/2, compile/3, clean/2]). -include("rebar.hrl"). -include_lib("stdlib/include/erl_compile.hrl"). -define(ERLCINFO_VSN, 1). -define(ERLCINFO_FILE, "erlcinfo"). -type erlc_info_v() :: {digraph:vertex(), term()} | 'false'. -type erlc_info_e() :: {digraph:vertex(), digraph:vertex()}. -type erlc_info() :: {list(erlc_info_v()), list(erlc_info_e())}. -record(erlcinfo, { vsn = ?ERLCINFO_VSN :: pos_integer(), info = {[], []} :: erlc_info() }). -define(RE_PREFIX, "^[^._]"). %% =================================================================== %% Public API %% =================================================================== %% Supported configuration variables: %% %% * erl_opts - Erlang list of options passed to compile:file/2 %% It is also possible to specify platform specific %% options by specifying a pair or a triplet where the %% first string is a regex that is checked against the %% string %% %% OtpRelease ++ "-" ++ SysArch ++ "-" ++ Words. %% %% where %% %% OtpRelease = erlang:system_info(otp_release). %% SysArch = erlang:system_info(system_architecture). %% Words = integer_to_list(8 * %% erlang:system_info({wordsize, external})). %% %% E.g. to define HAVE_SENDFILE only on systems with %% sendfile(), to define BACKLOG on Linux/FreeBSD as 128, %% and to define 'old_inets' for R13 OTP release do: %% %% {erl_opts, [{platform_define, %% "(linux|solaris|freebsd|darwin)", %% 'HAVE_SENDFILE'}, %% {platform_define, "(linux|freebsd)", %% 'BACKLOG', 128}, %% {platform_define, "R13", %% 'old_inets'}]}. %% -spec compile(rebar_state:t(), file:name()) -> 'ok'. compile(Config, Dir) -> compile(Config, Dir, filename:join([Dir, "ebin"])). -spec compile(rebar_state:t(), file:name(), file:name()) -> 'ok'. compile(Config, Dir, OutDir) -> rebar_base_compiler:run(Config, check_files(rebar_state:get( Config, xrl_first_files, [])), filename:join(Dir, "src"), ".xrl", filename:join(Dir, "src"), ".erl", fun compile_xrl/3), rebar_base_compiler:run(Config, check_files(rebar_state:get( Config, yrl_first_files, [])), filename:join(Dir, "src"), ".yrl", filename:join(Dir, "src"), ".erl", fun compile_yrl/3), rebar_base_compiler:run(Config, check_files(rebar_state:get( Config, mib_first_files, [])), filename:join(Dir, "mibs"), ".mib", filename:join([Dir, "priv", "mibs"]), ".bin", fun compile_mib/3), doterl_compile(Config, Dir, OutDir). -spec clean(rebar_state:t(), file:filename()) -> 'ok'. clean(Config, AppDir) -> MibFiles = rebar_utils:find_files(filename:join(AppDir, "mibs"), ?RE_PREFIX".*\\.mib\$"), MIBs = [filename:rootname(filename:basename(MIB)) || MIB <- MibFiles], rebar_file_utils:delete_each( [filename:join([AppDir, "include",MIB++".hrl"]) || MIB <- MIBs]), lists:foreach(fun(F) -> ok = rebar_file_utils:rm_rf(F) end, [filename:join(AppDir, "ebin/*.beam"), filename:join(AppDir, "priv/mibs/*.bin")]), YrlFiles = rebar_utils:find_files(filename:join(AppDir, "src"), ?RE_PREFIX".*\\.[x|y]rl\$"), rebar_file_utils:delete_each( [ binary_to_list(iolist_to_binary(re:replace(F, "\\.[x|y]rl$", ".erl"))) || F <- YrlFiles ]), %% Delete the build graph, if any rebar_file_utils:rm_rf(erlcinfo_file(Config)), %% Erlang compilation is recursive, so it's possible that we have a nested %% directory structure in ebin with .beam files within. As such, we want %% to scan whatever is left in the ebin/ directory for sub-dirs which %% satisfy our criteria. BeamFiles = rebar_utils:find_files(filename:join(AppDir, "ebin"), ?RE_PREFIX".*\\.beam\$"), rebar_file_utils:delete_each(BeamFiles), lists:foreach(fun(Dir) -> delete_dir(Dir, dirs(Dir)) end, dirs(filename:join(AppDir, "ebin"))), ok. %% =================================================================== %% Internal functions %% =================================================================== -spec doterl_compile(rebar_state:t(), file:filename(), file:filename()) -> ok. doterl_compile(State, Dir, ODir) -> ErlOpts = rebar_utils:erl_opts(State), doterl_compile(State, Dir, ODir, [], ErlOpts). doterl_compile(Config, Dir, OutDir, MoreSources, ErlOpts) -> ErlFirstFilesConf = rebar_state:get(Config, erl_first_files, []), ?DEBUG("erl_opts ~p", [ErlOpts]), %% Support the src_dirs option allowing multiple directories to %% contain erlang source. This might be used, for example, should %% eunit tests be separated from the core application source. SrcDirs = [filename:join(Dir, X) || X <- proplists:get_value(src_dirs, ErlOpts, ["src"])], AllErlFiles = gather_src(SrcDirs, []) ++ MoreSources, %% Issue: rebar/rebar3#140 (fix matching based on same path + order of %% erl_first_files) ErlFirstFiles = get_erl_first_files(ErlFirstFilesConf, AllErlFiles), RestErls = [ File || File <- AllErlFiles, not lists:member(File, ErlFirstFiles) ], %% Make sure that ebin/ exists and is on the path ok = filelib:ensure_dir(filename:join(OutDir, "dummy.beam")), CurrPath = code:get_path(), true = code:add_path(filename:absname(OutDir)), OutDir1 = proplists:get_value(outdir, ErlOpts, OutDir), G = init_erlcinfo(Config, AllErlFiles), %% Split RestErls so that files which are depended on are treated %% like erl_first_files. {OtherFirstErls, OtherErls} = lists:partition( fun(F) -> Children = get_children(G, F), log_files(?FMT("Files dependent on ~s", [F]), Children), case erls(Children) of [] -> %% There are no files dependent on this file. false; _ -> %% There are some files dependent on the file. %% Thus the file has higher priority %% and should be compiled in the first place. true end end, RestErls), %% Dependencies of OtherFirstErls that must be compiled first. OtherFirstErlsDeps = lists:flatmap( fun(Erl) -> erls(get_parents(G, Erl)) end, OtherFirstErls), %% NOTE: In case the way we retrieve OtherFirstErlsDeps or merge %% it with OtherFirstErls does not result in the correct compile %% priorities, or the method in use proves to be too slow for %% certain projects, consider using a more elaborate method (maybe %% digraph_utils) or alternatively getting and compiling the .erl %% parents of an individual Source in internal_erl_compile. By not %% handling this in internal_erl_compile, we also avoid extra %% needs_compile/2 calls. FirstErls = ErlFirstFiles ++ uo_merge(OtherFirstErlsDeps, OtherFirstErls), ?DEBUG("Files to compile first: ~p", [FirstErls]), rebar_base_compiler:run( Config, FirstErls, OtherErls, fun(S, C) -> internal_erl_compile(C, Dir, S, OutDir1, ErlOpts, G) end), true = code:set_path(CurrPath), ok. %% %% Return all .erl files from a list of files %% erls(Files) -> [Erl || Erl <- Files, filename:extension(Erl) =:= ".erl"]. %% %% Return a list of erl_first_files in order as specified in rebar.config %% using the path from AllFiles. %% get_erl_first_files(FirstFiles, AllFiles) -> BaseFirstFiles = [filename:basename(F) || F <- FirstFiles], IndexedAllFiles = [{filename:basename(F), F} || F <- AllFiles ], [ proplists:get_value(FileName, IndexedAllFiles) || FileName <- BaseFirstFiles, proplists:is_defined(FileName, IndexedAllFiles) ]. %% %% Return a list without duplicates while preserving order %% ulist(L) -> ulist(L, []). ulist([H|T], Acc) -> case lists:member(H, T) of true -> ulist(T, Acc); false -> ulist(T, [H|Acc]) end; ulist([], Acc) -> lists:reverse(Acc). %% %% Merge two lists without duplicates while preserving order %% uo_merge(L1, L2) -> lists:foldl(fun(E, Acc) -> u_add_element(E, Acc) end, ulist(L1), L2). u_add_element(Elem, [Elem|_]=Set) -> Set; u_add_element(Elem, [E1|Set]) -> [E1|u_add_element(Elem, Set)]; u_add_element(Elem, []) -> [Elem]. -spec include_path(file:filename(), rebar_state:t()) -> [file:filename(), ...]. include_path(Source, Config) -> ErlOpts = rebar_state:get(Config, erl_opts, []), Dir = filename:join(rebar_utils:droplast(filename:split(filename:dirname(Source)))), lists:usort([filename:join(Dir, "include"), filename:dirname(Source)] ++ proplists:get_all_values(i, ErlOpts)). -spec needs_compile(file:filename(), file:filename(), list(), [string()]) -> boolean(). needs_compile(Source, Target, Opts, Parents) -> TargetLastMod = filelib:last_modified(Target), F = fun(I) -> source_changed(TargetLastMod, I) end, lists:any(F, [Source] ++ Parents) orelse opts_changed(Opts, Target). source_changed(TargetLastMod, I) -> TargetLastMod < filelib:last_modified(I). opts_changed(NewOpts, Target) -> case compile_info(Target) of {ok, Opts} -> lists:sort(Opts) =/= lists:sort(NewOpts); _ -> true end. compile_info(Target) -> case beam_lib:chunks(Target, [compile_info]) of {ok, {_mod, Chunks}} -> CompileInfo = proplists:get_value(compile_info, Chunks, []), {ok, proplists:get_value(options, CompileInfo, [])}; {error, beam_lib, Reason} -> ?WARN("Couldn't read debug info from ~p for reason: ~p", [Target, Reason]), {error, Reason} end. check_erlcinfo(_Config, #erlcinfo{vsn=?ERLCINFO_VSN}) -> ok; check_erlcinfo(Config, #erlcinfo{vsn=Vsn}) -> ?ABORT("~s file version is incompatible. expected: ~b got: ~b", [erlcinfo_file(Config), ?ERLCINFO_VSN, Vsn]); check_erlcinfo(Config, _) -> ?ABORT("~s file is invalid. Please delete before next run.", [erlcinfo_file(Config)]). erlcinfo_file(_Config) -> filename:join(rebar_dir:local_cache_dir(), ?ERLCINFO_FILE). init_erlcinfo(Config, Erls) -> G = restore_erlcinfo(Config), %% Get a unique list of dirs based on the source files' locations. %% This is used for finding files in sub dirs of the configured %% src_dirs. For example, src/sub_dir/foo.erl. Dirs = sets:to_list(lists:foldl( fun(Erl, Acc) -> Dir = filename:dirname(Erl), sets:add_element(Dir, Acc) end, sets:new(), Erls)), Updates = [update_erlcinfo(G, Erl, include_path(Erl, Config) ++ Dirs) || Erl <- Erls], Modified = lists:member(modified, Updates), ok = store_erlcinfo(G, Config, Modified), G. update_erlcinfo(G, Source, Dirs) -> case digraph:vertex(G, Source) of {_, LastUpdated} -> case filelib:last_modified(Source) of 0 -> %% The file doesn't exist anymore, %% erase it from the graph. %% All the edges will be erased automatically. digraph:del_vertex(G, Source), modified; LastModified when LastUpdated < LastModified -> modify_erlcinfo(G, Source, Dirs), modified; _ -> unmodified end; false -> modify_erlcinfo(G, Source, Dirs), modified end. modify_erlcinfo(G, Source, Dirs) -> {ok, Fd} = file:open(Source, [read]), Incls = parse_attrs(Fd, []), AbsIncls = expand_file_names(Incls, Dirs), ok = file:close(Fd), LastUpdated = {date(), time()}, digraph:add_vertex(G, Source, LastUpdated), lists:foreach( fun(Incl) -> update_erlcinfo(G, Incl, Dirs), digraph:add_edge(G, Source, Incl) end, AbsIncls). restore_erlcinfo(Config) -> File = erlcinfo_file(Config), G = digraph:new(), case file:read_file(File) of {ok, Data} -> try binary_to_term(Data) of Erlcinfo -> ok = check_erlcinfo(Config, Erlcinfo), #erlcinfo{info=ErlcInfo} = Erlcinfo, {Vs, Es} = ErlcInfo, lists:foreach( fun({V, LastUpdated}) -> digraph:add_vertex(G, V, LastUpdated) end, Vs), lists:foreach( fun({V1, V2}) -> digraph:add_edge(G, V1, V2) end, Es) catch error:badarg -> ?ERROR( "Failed (binary_to_term) to restore rebar info file." " Discard file.", []), ok end; _Err -> ok end, G. store_erlcinfo(_G, _Config, _Modified = false) -> ok; store_erlcinfo(G, Config, _Modified) -> Vs = lists:map( fun(V) -> digraph:vertex(G, V) end, digraph:vertices(G)), Es = lists:flatmap( fun({V, _}) -> lists:map( fun(E) -> {_, V1, V2, _} = digraph:edge(G, E), {V1, V2} end, digraph:out_edges(G, V)) end, Vs), File = erlcinfo_file(Config), ok = filelib:ensure_dir(File), Data = term_to_binary(#erlcinfo{info={Vs, Es}}, [{compressed, 9}]), file:write_file(File, Data). %% NOTE: If, for example, one of the entries in Files, refers to %% gen_server.erl, that entry will be dropped. It is dropped because %% such an entry usually refers to the beam file, and we don't pass a %% list of OTP src dirs for finding gen_server.erl's full path. Also, %% if gen_server.erl was modified, it's not rebar's task to compile a %% new version of the beam file. Therefore, it's reasonable to drop %% such entries. Also see process_attr(behaviour, Form, Includes). -spec expand_file_names([file:filename()], [file:filename()]) -> [file:filename()]. expand_file_names(Files, Dirs) -> %% We check if Files exist by itself or within the directories %% listed in Dirs. %% Return the list of files matched. lists:flatmap( fun(Incl) -> case filelib:is_regular(Incl) of true -> [Incl]; false -> lists:flatmap( fun(Dir) -> FullPath = filename:join(Dir, Incl), case filelib:is_regular(FullPath) of true -> [FullPath]; false -> [] end end, Dirs) end end, Files). -spec get_parents(rebar_digraph(), file:filename()) -> [file:filename()]. get_parents(G, Source) -> %% Return all files which the Source depends upon. digraph_utils:reachable_neighbours([Source], G). -spec get_children(rebar_digraph(), file:filename()) -> [file:filename()]. get_children(G, Source) -> %% Return all files dependent on the Source. digraph_utils:reaching_neighbours([Source], G). -spec internal_erl_compile(rebar_state:t(), file:filename(), file:filename(), file:filename(), list(), rebar_digraph()) -> 'ok' | 'skipped'. internal_erl_compile(Config, Dir, Source, OutDir, ErlOpts, G) -> %% Determine the target name and includes list by inspecting the source file Module = filename:basename(Source, ".erl"), Parents = get_parents(G, Source), log_files(?FMT("Dependencies of ~s", [Source]), Parents), %% Construct the target filename Target = filename:join([OutDir | string:tokens(Module, ".")]) ++ ".beam", ok = filelib:ensure_dir(Target), %% Construct the compile opts Opts = [{outdir, filename:dirname(Target)}] ++ ErlOpts ++ [{i, filename:join(Dir, "include")}], %% If the file needs compilation, based on last mod date of includes or %% the target case needs_compile(Source, Target, Opts, Parents) of true -> case compile:file(Source, Opts ++ [return]) of {ok, _Mod} -> ok; {ok, _Mod, Ws} -> rebar_base_compiler:ok_tuple(Config, Source, Ws); {error, Es, Ws} -> rebar_base_compiler:error_tuple(Config, Source, Es, Ws, Opts) end; false -> skipped end. -spec compile_mib(file:filename(), file:filename(), rebar_state:t()) -> 'ok'. compile_mib(Source, Target, Config) -> ok = filelib:ensure_dir(Target), ok = filelib:ensure_dir(filename:join("include", "dummy.hrl")), Opts = [{outdir, "priv/mibs"}, {i, ["priv/mibs"]}] ++ rebar_state:get(Config, mib_opts, []), case snmpc:compile(Source, Opts) of {ok, _} -> Mib = filename:rootname(Target), MibToHrlOpts = case proplists:get_value(verbosity, Opts, undefined) of undefined -> #options{specific = []}; Verbosity -> #options{specific = [{verbosity, Verbosity}]} end, ok = snmpc:mib_to_hrl(Mib, Mib, MibToHrlOpts), Hrl_filename = Mib ++ ".hrl", rebar_file_utils:mv(Hrl_filename, "include"), ok; {error, compilation_failed} -> ?FAIL end. -spec compile_xrl(file:filename(), file:filename(), rebar_state:t()) -> 'ok'. compile_xrl(Source, Target, Config) -> Opts = [{scannerfile, Target} | rebar_state:get(Config, xrl_opts, [])], compile_xrl_yrl(Config, Source, Target, Opts, leex). -spec compile_yrl(file:filename(), file:filename(), rebar_state:t()) -> 'ok'. compile_yrl(Source, Target, Config) -> Opts = [{parserfile, Target} | rebar_state:get(Config, yrl_opts, [])], compile_xrl_yrl(Config, Source, Target, Opts, yecc). -spec compile_xrl_yrl(rebar_state:t(), file:filename(), file:filename(), list(), module()) -> 'ok'. compile_xrl_yrl(Config, Source, Target, Opts, Mod) -> Dir = rebar_state:dir(Config), Opts1 = [{includefile, filename:join(Dir, I)} || {includefile, I} <- Opts, filename:pathtype(I) =:= relative], case needs_compile(Source, Target, Opts1, []) of true -> case Mod:file(Source, Opts1 ++ [{return, true}]) of {ok, _} -> ok; {ok, _Mod, Ws} -> rebar_base_compiler:ok_tuple(Config, Source, Ws); {error, Es, Ws} -> rebar_base_compiler:error_tuple(Config, Source, Es, Ws, Opts1) end; false -> skipped end. gather_src([], Srcs) -> Srcs; gather_src([Dir|Rest], Srcs) -> gather_src( Rest, Srcs ++ rebar_utils:find_files(Dir, ?RE_PREFIX".*\\.erl\$")). -spec dirs(file:filename()) -> [file:filename()]. dirs(Dir) -> [F || F <- filelib:wildcard(filename:join([Dir, "*"])), filelib:is_dir(F)]. -spec delete_dir(file:filename(), [string()]) -> 'ok' | {'error', atom()}. delete_dir(Dir, []) -> file:del_dir(Dir); delete_dir(Dir, Subdirs) -> lists:foreach(fun(D) -> delete_dir(D, dirs(D)) end, Subdirs), file:del_dir(Dir). parse_attrs(Fd, Includes) -> case io:parse_erl_form(Fd, "") of {ok, Form, _Line} -> case erl_syntax:type(Form) of attribute -> NewIncludes = process_attr(Form, Includes), parse_attrs(Fd, NewIncludes); _ -> parse_attrs(Fd, Includes) end; {eof, _} -> Includes; _Err -> parse_attrs(Fd, Includes) end. process_attr(Form, Includes) -> try AttrName = erl_syntax:atom_value(erl_syntax:attribute_name(Form)), process_attr(AttrName, Form, Includes) catch _:_ -> %% TODO: We should probably try to be more specific here %% and not suppress all errors. Includes end. process_attr(import, Form, Includes) -> case erl_syntax_lib:analyze_import_attribute(Form) of {Mod, _Funs} -> [atom_to_list(Mod) ++ ".erl"|Includes]; Mod -> [atom_to_list(Mod) ++ ".erl"|Includes] end; process_attr(file, Form, Includes) -> {File, _} = erl_syntax_lib:analyze_file_attribute(Form), [File|Includes]; process_attr(include, Form, Includes) -> [FileNode] = erl_syntax:attribute_arguments(Form), File = erl_syntax:string_value(FileNode), [File|Includes]; process_attr(include_lib, Form, Includes) -> [FileNode] = erl_syntax:attribute_arguments(Form), RawFile = erl_syntax:string_value(FileNode), File = maybe_expand_include_lib_path(RawFile), [File|Includes]; process_attr(behaviour, Form, Includes) -> [FileNode] = erl_syntax:attribute_arguments(Form), File = erl_syntax:atom_name(FileNode) ++ ".erl", [File|Includes]; process_attr(compile, Form, Includes) -> [Arg] = erl_syntax:attribute_arguments(Form), case erl_syntax:concrete(Arg) of {parse_transform, Mod} -> [atom_to_list(Mod) ++ ".erl"|Includes]; {core_transform, Mod} -> [atom_to_list(Mod) ++ ".erl"|Includes]; L when is_list(L) -> lists:foldl( fun({parse_transform, M}, Acc) -> [atom_to_list(M) ++ ".erl"|Acc]; ({core_transform, M}, Acc) -> [atom_to_list(M) ++ ".erl"|Acc]; (_, Acc) -> Acc end, Includes, L) end. %% Given the filename from an include_lib attribute, if the path %% exists, return unmodified, or else get the absolute ERL_LIBS %% path. maybe_expand_include_lib_path(File) -> case filelib:is_regular(File) of true -> File; false -> expand_include_lib_path(File) end. %% Given a path like "stdlib/include/erl_compile.hrl", return %% "OTP_INSTALL_DIR/lib/erlang/lib/stdlib-x.y.z/include/erl_compile.hrl". %% Usually a simple [Lib, SubDir, File1] = filename:split(File) should %% work, but to not crash when an unusual include_lib path is used, %% utilize more elaborate logic. expand_include_lib_path(File) -> File1 = filename:basename(File), Split = filename:split(filename:dirname(File)), Lib = hd(Split), SubDir = filename:join(tl(Split)), Dir = code:lib_dir(list_to_atom(Lib), list_to_atom(SubDir)), filename:join(Dir, File1). %% %% Ensure all files in a list are present and abort if one is missing %% -spec check_files([file:filename()]) -> [file:filename()]. check_files(FileList) -> [check_file(F) || F <- FileList]. check_file(File) -> case filelib:is_regular(File) of false -> ?ABORT("File ~p is missing, aborting\n", [File]); true -> File end. %% Print prefix followed by list of files. If the list is empty, print %% on the same line, otherwise use a separate line. log_files(Prefix, Files) -> case Files of [] -> ?DEBUG("~s: ~p", [Prefix, Files]); _ -> ?DEBUG("~s:~n~p", [Prefix, Files]) end.