Skip to content

Commit

Permalink
Merge branch 'HoloRin/erlexec/long-path-fix/OTP-19471' into maint
Browse files Browse the repository at this point in the history 
* HoloRin/erlexec/long-path-fix/OTP-19471:
  Null terminate PATH string when building PATH
  Fix truncation of PATH when ROOTDIR is not in PATH
  Fix tests on ts
  Remove unnecessary PATHSEP
  Add more testcases for PATHs
  Support long PATH values in erlexec
  • Loading branch information
@garazdawi
garazdawi committed Feb 5, 2025
2 parents 38b091c + 9ac7bcf commit f2c1a7b
Show file tree
Hide file tree
Showing 2 changed files with 150 additions and 51 deletions.
64 changes: 47 additions & 17 deletions erts/etc/common/erlexec.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -554,38 +554,68 @@ int main(int argc, char **argv)

if (s == NULL) {
erts_snprintf(tmpStr, sizeof(tmpStr),
"%s" PATHSEP "%s" DIRSEP "bin" PATHSEP, bindir, rootdir);
"%s" PATHSEP "%s" DIRSEP "bin", bindir, rootdir);
set_env("PATH", tmpStr);
} else if (strstr(s, rootdir) == NULL) {
erts_snprintf(tmpStr, sizeof(tmpStr),
char *pathBuf = NULL;
int pathBufLen = 0;
int path_sep_length = strlen(PATHSEP);
int dir_sep_length = strlen(DIRSEP);

pathBufLen =
strlen(bindir) + path_sep_length
+ strlen(rootdir) + dir_sep_length + strlen("bin") + path_sep_length
+ strlen(s) + 1;

pathBuf = emalloc(pathBufLen);

erts_snprintf(pathBuf, pathBufLen,
"%s" PATHSEP "%s" DIRSEP "bin" PATHSEP "%s", bindir, rootdir, s);
set_env("PATH", pathBuf);
} else {
const char *bindir_slug, *bindir_slug_index;
int bindir_slug_length;
char *pathBuf = NULL;
int pathBufLen = 0;

char *sep_index;
int sep_length = strlen(PATHSEP);
int bindir_length = strlen(bindir);
const char *in_index;
char *out_index;

erts_snprintf(tmpStr, sizeof(tmpStr), "%s" PATHSEP, bindir);
pathBufLen = strlen(s) + strlen(bindir) + strlen(PATHSEP) + 1;
pathBuf = emalloc(pathBufLen);

bindir_slug = strsave(tmpStr);
bindir_slug_length = strlen(bindir_slug);
strcpy(pathBuf, bindir);

out_index = &tmpStr[bindir_slug_length];
out_index = &pathBuf[bindir_length];
in_index = s;

while ((bindir_slug_index = strstr(in_index, bindir_slug))) {
int block_length = (bindir_slug_index - in_index);
while ((sep_index = strstr(in_index, PATHSEP))) {
int elem_length = (sep_index - in_index);

memcpy(out_index, in_index, block_length);
if (bindir_length != elem_length ||
0 != strncmp(in_index, bindir, elem_length)) {
strcpy(out_index, PATHSEP);
out_index += sep_length;
memcpy(out_index, in_index, elem_length);
out_index += elem_length;
}

in_index = bindir_slug_index + bindir_slug_length;
out_index += block_length;
in_index = sep_index + sep_length;
}
efree((void*)bindir_slug);
strcpy(out_index, in_index);
}

if (0 != strcmp(in_index, bindir)) {
strcpy(out_index, PATHSEP);
out_index += sep_length;
strcpy(out_index, in_index);
} else {
*out_index = '\0';
}

set_env("PATH", pathBuf);
efree(pathBuf);
}
free_env_val(s);
set_env("PATH", tmpStr);

i = 1;

Expand Down
137 changes: 103 additions & 34 deletions erts/test/erlexec_SUITE.erl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,19 @@

-export([args_file/1, evil_args_file/1, missing_args_file/1, env/1, args_file_env/1,
otp_7461/1, otp_7461_remote/1, argument_separation/1, argument_with_option/1,
zdbbl_dist_buf_busy_limit/1]).
zdbbl_dist_buf_busy_limit/1, long_path_env/1, long_path_env_when_rootdir_not_present/1]).

-include_lib("common_test/include/ct.hrl").
-include_lib("eunit/include/eunit.hrl").

suite() ->
[{ct_hooks,[ts_install_cth]},
{timetrap, {minutes, 1}}].

all() ->
all() ->
[args_file, evil_args_file, missing_args_file, env, args_file_env,
otp_7461, argument_separation, argument_with_option, zdbbl_dist_buf_busy_limit].
otp_7461, argument_separation, argument_with_option, zdbbl_dist_buf_busy_limit,
long_path_env, long_path_env_when_rootdir_not_present].

init_per_suite(Config) ->
[{suite_erl_flags, save_env()} | Config].
Expand Down Expand Up @@ -108,9 +110,9 @@ loop_ping(_,0) ->
loop_ping(Node,N) ->
case net_adm:ping(Node) of
pang ->
receive
receive
after 500 ->
ok
ok
end,
loop_ping(Node, N-1);
pong ->
Expand Down Expand Up @@ -147,7 +149,7 @@ argument_with_option(Config) when is_list(Config) ->
ok
end
end,

[begin
MissingCheck(CmdLine,"-",""),

Expand All @@ -172,7 +174,7 @@ argument_with_option(Config) when is_list(Config) ->
end || CmdLine <- EmuSingle],

ErlDouble = ["env"],

[begin
MissingCheck(CmdLine,"-",""),
MissingCheck(CmdLine,"-"," a"),
Expand Down Expand Up @@ -354,16 +356,16 @@ args_file_env(Config) when is_list(Config) ->
ok.

%% Make sure "erl -detached" survives when parent process group gets killed
otp_7461(Config) when is_list(Config) ->
otp_7461(Config) when is_list(Config) ->
case os:type() of
{unix,_} ->
{NetStarted, _} = net_kernel:start([test_server, shortnames]),
try
net_kernel:monitor_nodes(true),
register(otp_7461, self()),
register(otp_7461, self()),

otp_7461_do(Config)
after
otp_7461_do(Config)
after
catch unregister(otp_7461),
catch net_kernel:monitor_nodes(false),
case NetStarted of
Expand All @@ -374,7 +376,7 @@ otp_7461(Config) when is_list(Config) ->
_ ->
{skip,"Only on Unix."}
end.

otp_7461_do(Config) ->
io:format("alive=~p node=~p\n",[is_alive(), node()]),
TestProg = filename:join([proplists:get_value(data_dir, Config), "erlexec_tests"]),
Expand All @@ -384,40 +386,40 @@ otp_7461_do(Config) ->
" -setcookie " ++ atom_to_list(erlang:get_cookie()) ++
" -pa " ++ filename:dirname(code:which(?MODULE)) ++
" -s erlexec_SUITE otp_7461_remote init " ++ atom_to_list(node()),

%% otp_7461 --------> erlexec_tests.c --------> cerl -detached
%% open_port fork+exec

io:format("spawn port prog ~p\n",[Cmd]),
Port = open_port({spawn, Cmd}, [eof]),
io:format("Wait for node to connect...\n",[]),

io:format("Wait for node to connect...\n",[]),
{nodeup, Slave} = receive Msg -> Msg
after 20*1000 -> timeout end,
io:format("Node alive: ~p\n", [Slave]),

pong = net_adm:ping(Slave),
io:format("Ping ok towards ~p\n", [Slave]),

Port ! { self(), {command, "K"}}, % Kill child process group
{Port, {data, "K"}} = receive Msg2 -> Msg2 end,
port_close(Port),

%% Now the actual test. Detached node should still be alive.
pong = net_adm:ping(Slave),
io:format("Ping still ok towards ~p\n", [Slave]),

%% Halt node
rpc:cast(Slave, ?MODULE, otp_7461_remote, [[halt, self()]]),

{nodedown, Slave} = receive
Msg3 -> Msg3
after 20*1000 -> timeout
end,
io:format("Node dead: ~p\n", [Slave]),
ok.


%% Executed on slave node
otp_7461_remote([init, Master]) ->
io:format("otp_7461_remote(init,~p) at ~p\n",[Master, node()]),
Expand All @@ -442,7 +444,72 @@ zdbbl_dist_buf_busy_limit(Config) when is_list(Config) ->
LimB = rpc:call(SName,erlang,system_info,[dist_buf_busy_limit]),
ok = cleanup_node(SNameS, 10),
ok.


long_path_env(Config) when is_list(Config) ->
BinPath = os:getenv("BINDIR"),
ActualPath = os:getenv("PATH"),

PathComponents = string:split(ActualPath, pathsep(), all),
ActualPathNoBinPath = path_var_join(lists:filter(fun (Path) ->
Path =/= BinPath
end, PathComponents)),
ct:log("BINDIR: ~ts", [BinPath]),
ct:log("PATH: ~ts", [ActualPath]),

LongPath = lists:flatten(lists:duplicate(10240, "x")),
{ok, [[PName]]} = init:get_argument(progname),
Cmd = PName ++ " -noshell -eval 'io:format(\"~ts\", [os:getenv(\"PATH\")]),erlang:halt()'",

compare_erl_path(Cmd, BinPath, ActualPath),
compare_erl_path(Cmd, BinPath, path_var_join([ActualPath, LongPath])),
compare_erl_path(Cmd, BinPath, path_var_join([ActualPath, LongPath, BinPath])),
compare_erl_path(Cmd, BinPath, path_var_join([BinPath, ActualPath, LongPath])),
compare_erl_path(Cmd, BinPath, path_var_join([BinPath, ActualPath, LongPath, BinPath])),

Output = compare_erl_path(Cmd, BinPath, path_var_join([ActualPathNoBinPath, LongPath])),
?assertEqual(string:find(Output, LongPath), LongPath),

ok.

long_path_env_when_rootdir_not_present(Config) when is_list(Config) ->
BinPath = os:getenv("BINDIR"),
RootPath = os:getenv("ROOTDIR"),
RootPathWithBin = filename:join(RootPath, "bin"),
ActualPath = os:getenv("PATH"),
LongPathLength = 10240,

LongPath = lists:flatten(lists:duplicate(LongPathLength, "x")),
{ok, [[PName]]} = init:get_argument(progname),
Cmd = "\"" ++ filename:join(RootPathWithBin, PName) ++ "\"" ++ " -noshell -eval 'io:format(\"~ts\", [os:getenv(\"PATH\")]),erlang:halt()'",

PathComponents = string:split(ActualPath, pathsep(), all),
ActualPathNoRoot = path_var_join(lists:filter(fun (Path) ->
(Path =/= RootPathWithBin) and (Path =/= (RootPathWithBin ++ "/")) and (Path =/= BinPath)
end, PathComponents)),

os:putenv("PATH", path_var_join([ActualPathNoRoot, LongPath, LongPath])),
Output = os:cmd(Cmd),

?assertEqual(string:length(string:find(Output, LongPath ++ pathsep() ++ LongPath)), (LongPathLength * 2) + string:length(pathsep())),
ok.

compare_erl_path(Cmd, BinPath, Path) ->
os:putenv("PATH", Path),
Output = os:cmd(Cmd),
% BinPath is at the front of PATH and nowhere else
?assertEqual(string:find(Output, BinPath ++ ":"), Output),
?assertEqual(string:find(Output, ":" ++ BinPath), nomatch),
Output.

pathsep() ->
case os:type() of
{win32, _} -> ";";
_ -> ":"
end.

path_var_join(Paths) ->
lists:concat(lists:join(pathsep(), Paths)).


%%
%% Utils
Expand All @@ -452,29 +519,31 @@ save_env() ->
{erl_flags,
os:getenv("ERL_AFLAGS"),
os:getenv("ERL_FLAGS"),
os:getenv("ERL_"++erlang:system_info(otp_release)++"_FLAGS"),
os:getenv("ERL_ZFLAGS")}.
os:getenv("ERL_" ++ erlang:system_info(otp_release) ++ "_FLAGS"),
os:getenv("ERL_ZFLAGS"),
os:getenv("PATH")}.

restore_env(EVar, false) when is_list(EVar) ->
restore_env(EVar, "");
restore_env(EVar, "") when is_list(EVar) ->
case os:getenv(EVar) of
false -> ok;
"" -> ok;
" " -> ok;
_ -> os:putenv(EVar, " ")
false -> ok;
"" -> ok;
" " -> ok;
_ -> os:putenv(EVar, " ")
end;
restore_env(EVar, Value) when is_list(EVar), is_list(Value) ->
case os:getenv(EVar) of
Value -> ok;
_ -> os:putenv(EVar, Value)
Value -> ok;
_ -> os:putenv(EVar, Value)
end.

restore_env({erl_flags, AFlgs, Flgs, RFlgs, ZFlgs}) ->
restore_env({erl_flags, AFlgs, Flgs, RFlgs, ZFlgs, Path}) ->
restore_env("ERL_AFLAGS", AFlgs),
restore_env("ERL_FLAGS", Flgs),
restore_env("ERL_"++erlang:system_info(otp_release)++"_FLAGS", RFlgs),
restore_env("ERL_"++erlang:system_info(otp_release) ++ "_FLAGS", RFlgs),
restore_env("ERL_ZFLAGS", ZFlgs),
restore_env("PATH", Path),
ok.

privfile(Name, Config) ->
Expand Down Expand Up @@ -544,7 +613,7 @@ split_emu_clt([A|As], Emu, Misc, Extra, misc = Type) ->

split_emu_clt([A|As], Emu, Misc, Extra, extra = Type) ->
split_emu_clt(As, Emu, Misc, [A|Extra], Type).


get_nodename(T) ->
atom_to_list(T)
Expand Down

0 comments on commit f2c1a7b

Please sign in to comment.