Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: 096e56d61c
Fetching contributors…

Cannot retrieve contributors at this time

437 lines (387 sloc) 16.683 kb
%% -*- 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.
%% -------------------------------------------------------------------
-module(rebar_port_compiler).
-export([compile/2,
clean/2,
setup_env/1]).
-include("rebar.hrl").
%% ===================================================================
%% Public API
%% ===================================================================
%% Supported configuration variables:
%%
%% * port_sources - Erlang list of files and/or wildcard strings to be
%% compiled. Platform specific sources can be specified
%% by enclosing a string in a tuple of the form
%% {Regex, String} wherein Regex is a regular expression
%% that is checked against the system architecture.
%%
%% * so_specs - Erlang list of tuples of the form
%% {"priv/so_name.so", ["c_src/object_file_name.o"]}
%% useful for building multiple *.so files.
%%
%% * port_envs - Erlang list of key/value pairs which will control
%% the environment when running the compiler and linker.
%%
%% By default, the following variables
%% are defined:
%% CC - C compiler
%% CXX - C++ compiler
%% CFLAGS - C compiler
%% CXXFLAGS - C++ compiler
%% LDFLAGS - Link flags
%% ERL_CFLAGS - default -I paths for erts and ei
%% ERL_LDFLAGS - default -L and -lerl_interface -lei
%% DRV_CFLAGS - flags that will be used for compiling the driver
%% DRV_LDFLAGS - flags that will be used for linking the driver
%%
%% Note that if you wish to extend (vs. replace) these variables,
%% you MUST include a shell-style reference in your definition.
%% e.g. to extend CFLAGS, do something like:
%%
%% {port_envs, [{"CFLAGS", "$CFLAGS -MyOtherOptions"}]}
%%
%% It is also possible to specify platform specific options
%% by specifying a tripletwhere the first string is a regex
%% that is checked against erlang's system architecture string.
%% e.g. to specify a CFLAG that only applies to x86_64 on linux
%% do:
%%
%% {port_envs, [{"x86_64.*-linux", "CFLAGS",
%% "$CFLAGS -X86Options"}]}
%%
%% * port_pre_script - Tuple which specifies a pre-compilation script to run,
%% and a filename that exists as a result of the script
%% running.
%%
%% * port_cleanup_script - String that specifies a script to run during cleanup.
%% Use this to remove files/directories created by
%% port_pre_script.
%%
compile(Config, AppFile) ->
%% Compose list of sources from config file -- defaults to c_src/*.c
Sources = expand_sources(rebar_config:get_list(Config, port_sources,
["c_src/*.c"]), []),
case Sources of
[] ->
ok;
_ ->
Env = setup_env(Config),
%% One or more files are available for building.
%% Run the pre-compile hook, if necessary.
ok = run_precompile_hook(Config, Env),
%% Compile each of the sources
{NewBins, ExistingBins} = compile_each(Sources, Config, Env,
[], []),
%% Construct the driver name and make sure priv/ exists
SoSpecs = so_specs(Config, AppFile, NewBins ++ ExistingBins),
?INFO("Using specs ~p\n", [SoSpecs]),
lists:foreach(fun({SoName,_}) ->
ok = filelib:ensure_dir(SoName)
end, SoSpecs),
%% Only relink if necessary, given the SoName
%% and list of new binaries
lists:foreach(
fun({SoName,Bins}) ->
AllBins = [sets:from_list(Bins), sets:from_list(NewBins)],
Intersection = sets:intersection(AllBins),
case needs_link(SoName, sets:to_list(Intersection)) of
true ->
rebar_utils:sh(
?FMT("$CC ~s $LDFLAGS $DRV_LDFLAGS -o ~s",
[string:join(Bins, " "), SoName]),
[{env, Env}]);
false ->
?INFO("Skipping relink of ~s\n", [SoName]),
ok
end
end, SoSpecs)
end.
clean(Config, AppFile) ->
%% Build a list of sources so as to derive all the bins we generated
Sources = expand_sources(rebar_config:get_list(Config, port_sources,
["c_src/*.c"]), []),
rebar_file_utils:delete_each([source_to_bin(S) || S <- Sources]),
%% Delete the .so file
ExtractSoName = fun({SoName, _}) -> SoName end,
rebar_file_utils:delete_each([ExtractSoName(S)
|| S <- so_specs(Config, AppFile,
expand_objects(Sources))]),
%% Run the cleanup script, if it exists
run_cleanup_hook(Config).
setup_env(Config) ->
%% Extract environment values from the config (if specified) and
%% merge with the default for this operating system. This enables
%% max flexibility for users.
DefaultEnvs = filter_envs(default_env(), []),
PortEnvs = rebar_config:get_list(Config, port_envs, []),
OverrideEnvs = filter_envs(PortEnvs, []),
RawEnv = DefaultEnvs ++ OverrideEnvs ++ os_env(),
expand_vars_loop(merge_each_var(RawEnv, [])).
%% ===================================================================
%% Internal functions
%% ===================================================================
expand_sources([], Acc) ->
Acc;
expand_sources([{ArchRegex, Spec} | Rest], Acc) ->
case rebar_utils:is_arch(ArchRegex) of
true ->
Acc2 = filelib:wildcard(Spec) ++ Acc,
expand_sources(Rest, Acc2);
false ->
expand_sources(Rest, Acc)
end;
expand_sources([Spec | Rest], Acc) ->
Acc2 = filelib:wildcard(Spec) ++ Acc,
expand_sources(Rest, Acc2).
expand_objects(Sources) ->
[filename:join([filename:dirname(F), filename:basename(F) ++ ".o"])
|| F <- Sources].
run_precompile_hook(Config, Env) ->
case rebar_config:get(Config, port_pre_script, undefined) of
undefined ->
ok;
{Script, BypassFileName} ->
?DEPRECATED(port_pre_script,
{pre_hooks, [{compile, "script"}]},
"in a future build of rebar"),
case filelib:is_regular(BypassFileName) of
false ->
?CONSOLE("Running ~s\n", [Script]),
{ok, _} = rebar_utils:sh(Script, [{env, Env}]),
ok;
true ->
?INFO("~s exists; not running ~s\n",
[BypassFileName, Script])
end
end.
run_cleanup_hook(Config) ->
case rebar_config:get(Config, port_cleanup_script, undefined) of
undefined ->
ok;
Script ->
?DEPRECATED(port_cleanup_script,
{post_hooks, [{clean, "script"}]},
"in a future build of rebar"),
?CONSOLE("Running ~s\n", [Script]),
{ok, _} = rebar_utils:sh(Script, []),
ok
end.
compile_each([], _Config, _Env, NewBins, ExistingBins) ->
{lists:reverse(NewBins), lists:reverse(ExistingBins)};
compile_each([Source | Rest], Config, Env, NewBins, ExistingBins) ->
Ext = filename:extension(Source),
Bin = filename:rootname(Source, Ext) ++ ".o",
case needs_compile(Source, Bin) of
true ->
?CONSOLE("Compiling ~s\n", [Source]),
case compiler(Ext) of
"$CC" ->
rebar_utils:sh(?FMT("$CC -c $CFLAGS $DRV_CFLAGS ~s -o ~s",
[Source, Bin]), [{env, Env}]);
"$CXX" ->
rebar_utils:sh(
?FMT("$CXX -c $CXXFLAGS $DRV_CFLAGS ~s -o ~s",
[Source, Bin]), [{env, Env}])
end,
compile_each(Rest, Config, Env, [Bin | NewBins], ExistingBins);
false ->
?INFO("Skipping ~s\n", [Source]),
compile_each(Rest, Config, Env, NewBins, [Bin | ExistingBins])
end.
needs_compile(Source, Bin) ->
%% TODO: Generate depends using gcc -MM so we can also
%% check for include changes
filelib:last_modified(Bin) < filelib:last_modified(Source).
needs_link(SoName, []) ->
filelib:last_modified(SoName) == 0;
needs_link(SoName, NewBins) ->
MaxLastMod = lists:max([filelib:last_modified(B) || B <- NewBins]),
case filelib:last_modified(SoName) of
0 ->
?DEBUG("Last mod is 0 on ~s\n", [SoName]),
true;
Other ->
?DEBUG("Checking ~p >= ~p\n", [MaxLastMod, Other]),
MaxLastMod >= Other
end.
%%
%% Choose a compiler variable, based on a provided extension
%%
compiler(".cc") -> "$CXX";
compiler(".cp") -> "$CXX";
compiler(".cxx") -> "$CXX";
compiler(".cpp") -> "$CXX";
compiler(".CPP") -> "$CXX";
compiler(".c++") -> "$CXX";
compiler(".C") -> "$CXX";
compiler(_) -> "$CC".
%%
%% Given a list of {Key, Value} environment variables, where Key may be defined
%% multiple times, walk the list and expand each self-reference so that we
%% end with a list of each variable singly-defined.
%%
merge_each_var([], Vars) ->
Vars;
merge_each_var([{Key, Value} | Rest], Vars) ->
Evalue = case orddict:find(Key, Vars) of
error ->
%% Nothing yet defined for this key/value.
%% Expand any self-references as blank.
expand_env_variable(Value, Key, "");
{ok, Value0} ->
%% Use previous definition in expansion
expand_env_variable(Value, Key, Value0)
end,
merge_each_var(Rest, orddict:store(Key, Evalue, Vars)).
%%
%% Give a unique list of {Key, Value} environment variables, expand each one
%% for every other key until no further expansions are possible.
%%
expand_vars_loop(Vars) ->
expand_vars_loop(Vars, 10).
expand_vars_loop(_, 0) ->
?ABORT("Max. expansion reached for ENV vars!\n", []);
expand_vars_loop(Vars0, Count) ->
Vars = lists:foldl(fun({Key, Value}, Acc) ->
expand_vars(Key, Value, Acc)
end,
Vars0, Vars0),
case orddict:from_list(Vars) of
Vars0 ->
Vars0;
_ ->
expand_vars_loop(Vars, Count-1)
end.
%%
%% Expand all OTHER references to a given K/V pair
%%
expand_vars(Key, Value, Vars) ->
lists:foldl(
fun({AKey, AValue}, Acc) ->
NewValue = case AKey of
Key ->
AValue;
_ ->
expand_env_variable(AValue, Key, Value)
end,
[{AKey, NewValue} | Acc]
end,
[], Vars).
%%
%% Given env. variable FOO we want to expand all references to
%% it in InStr. References can have two forms: $FOO and ${FOO}
%%
expand_env_variable(InStr, VarName, VarValue) ->
R1 = re:replace(InStr, "\\\$" ++ VarName, VarValue),
re:replace(R1, "\\\${" ++ VarName ++ "}", VarValue, [{return, list}]).
%%
%% Filter a list of env vars such that only those which match the provided
%% architecture regex (or do not have a regex) are returned.
%%
filter_envs([], Acc) ->
lists:reverse(Acc);
filter_envs([{ArchRegex, Key, Value} | Rest], Acc) ->
case rebar_utils:is_arch(ArchRegex) of
true ->
filter_envs(Rest, [{Key, Value} | Acc]);
false ->
filter_envs(Rest, Acc)
end;
filter_envs([{Key, Value} | Rest], Acc) ->
filter_envs(Rest, [{Key, Value} | Acc]).
erts_dir() ->
lists:concat([code:root_dir(), "/erts-", erlang:system_info(version)]).
os_env() ->
Os = [list_to_tuple(re:split(S, "=", [{return, list}, {parts, 2}])) ||
S <- os:getenv()],
lists:keydelete([],1,Os). %% Remove Windows current disk and path
default_env() ->
[
{"CC", "cc"},
{"CXX", "c++"},
{"ERL_CFLAGS", lists:concat([" -I", code:lib_dir(erl_interface, include),
" -I", filename:join(erts_dir(), "include"),
" "])},
{"ERL_LDFLAGS", lists:concat([" -L", code:lib_dir(erl_interface, lib),
" -lerl_interface -lei"])},
{"DRV_CFLAGS", "-g -Wall -fPIC $ERL_CFLAGS"},
{"DRV_LDFLAGS", "-shared $ERL_LDFLAGS"},
{"darwin", "DRV_LDFLAGS",
"-bundle -flat_namespace -undefined suppress $ERL_LDFLAGS"},
{"ERLANG_ARCH", integer_to_list(8 * erlang:system_info(wordsize))},
{"ERLANG_TARGET", rebar_utils:get_arch()},
{"solaris.*-64$", "CFLAGS", "-D_REENTRANT -m64"}, % Solaris specific flags
{"solaris.*-64$", "CXXFLAGS", "-D_REENTRANT -m64"},
{"solaris.*-64$", "LDFLAGS", "-m64"},
{"darwin9.*-64$", "CFLAGS", "-m64"}, % OS X Leopard flags for 64-bit
{"darwin9.*-64$", "CXXFLAGS", "-m64"},
{"darwin9.*-64$", "LDFLAGS", "-arch x86_64"},
{"darwin10.*-32", "CFLAGS", "-m32"}, % OS X Snow Leopard flags for 32-bit
{"darwin10.*-32", "CXXFLAGS", "-m32"},
{"darwin10.*-32", "LDFLAGS", "-arch i386"}
].
source_to_bin(Source) ->
Ext = filename:extension(Source),
filename:rootname(Source, Ext) ++ ".o".
so_specs(Config, AppFile, Bins) ->
Specs = make_so_specs(Config, AppFile, Bins),
case os:type() of
{win32, nt} ->
[switch_so_to_dll(SoSpec) || SoSpec <- Specs];
_ ->
Specs
end.
switch_so_to_dll(Orig = {Name, Spec}) ->
case filename:extension(Name) of
".so" ->
{filename:rootname(Name, ".so") ++ ".dll", Spec};
_ ->
%% Not a .so; leave it
Orig
end.
make_so_specs(Config, AppFile, Bins) ->
case rebar_config:get(Config, so_specs, undefined) of
undefined ->
%% New form of so_specs is not provided. See if the old form
%% of {so_name} is available instead
Dir = "priv",
SoName = case rebar_config:get(Config, so_name, undefined) of
undefined ->
%% Ok, neither old nor new form is available. Use
%% the app name and generate a sensible default.
AppName = rebar_app_utils:app_name(AppFile),
filename:join(Dir,
lists:concat([AppName, "_drv.so"]));
AName ->
%% Old form is available -- use it
filename:join(Dir, AName)
end,
[{SoName, Bins}];
SoSpecs ->
SoSpecs
end.
Jump to Line
Something went wrong with that request. Please try again.