Package org.jruby.util.io

Class PopenExecutor

java.lang.Object

org.jruby.util.io.PopenExecutor

public class PopenExecutor
extends Object

Port of MRI's popen+exec logic.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	PopenExecutor.ArgvStr
static class	PopenExecutor.ExecArg
private static class	PopenExecutor.PopenArg
private static class	PopenExecutor.run_exec_dup2_fd_pair
private static final class	PopenExecutor.StringComparator

Field Summary

Fields

Modifier and Type	Field	Description
private static final byte[]	DUMMY_ARRAY
private jnr.constants.platform.Errno	errno
private static final Comparator<PopenExecutor.run_exec_dup2_fd_pair>	intcmp
private static final Comparator<PopenExecutor.run_exec_dup2_fd_pair>	intrcmp
private static final int	posix_sh_cmd_length
private static final String[]	posix_sh_cmds
static final int	SH_CHDIR_ARG_COUNT
private static final int	ST_CONTINUE
private static final int	ST_STOP

Constructor Summary

Constructors

Constructor	Description
PopenExecutor()

Method Summary

Modifier and Type	Method	Description
private static String[]	ARGVSTR2ARGV(byte[][] argv_str)
private static void	buildEnvp(Ruby runtime, PopenExecutor.ExecArg eargp, IRubyObject envtbl)
static RubyString	checkArgv(ThreadContext context, IRubyObject[] argv)
static RubyArray	checkExecEnv(ThreadContext context, RubyHash hash, PopenExecutor.ExecArg pathArg)
(package private) static IRubyObject	checkExecFds(ThreadContext context, Ruby runtime, PopenExecutor.ExecArg eargp)
(package private) static int	checkExecFds1(ThreadContext context, Ruby runtime, PopenExecutor.ExecArg eargp, RubyHash h, int maxhint, IRubyObject ary)
(package private) static void	checkExecOptions(ThreadContext context, Ruby runtime, RubyHash opthash, PopenExecutor.ExecArg eargp)
(package private) static void	checkExecRedirect(ThreadContext context, Ruby runtime, IRubyObject key, IRubyObject val, PopenExecutor.ExecArg eargp)
(package private) static RubyArray	checkExecRedirect1(Ruby runtime, RubyArray ary, IRubyObject key, IRubyObject param)
private static void	checkExecRedirectDefault(Ruby runtime, IRubyObject key, IRubyObject val, PopenExecutor.ExecArg eargp)
(package private) static IRubyObject	checkExecRedirectFd(Ruby runtime, IRubyObject v, boolean iskey)
static IRubyObject	checkPipeCommand(ThreadContext context, IRubyObject filenameOrCommand)
private static String	dlnFindExeR(Ruby runtime, String fname, IRubyObject path)
private long	DO_SPAWN(Ruby runtime, PopenExecutor.ExecArg eargp, String cmd, String[] args, String[] envp)
(package private) static int	execargAddopt(ThreadContext context, Ruby runtime, PopenExecutor.ExecArg eargp, IRubyObject key, IRubyObject val)
(package private) static IRubyObject	execargExtractOptions(ThreadContext context, Ruby runtime, PopenExecutor.ExecArg eargp, RubyHash opthash)
(package private) static void	execargFixup(ThreadContext context, Ruby runtime, PopenExecutor.ExecArg eargp)
private static RubyString	execargInit(ThreadContext context, IRubyObject[] argv, boolean accept_shell, PopenExecutor.ExecArg eargp, boolean allow_exc_opt)
static PopenExecutor.ExecArg	execargNew(ThreadContext context, IRubyObject[] argv, boolean accept_shell, boolean allow_exc_opt)
(package private) static void	execargParentStart(ThreadContext context, Ruby runtime, PopenExecutor.ExecArg eargp)
(package private) static void	execargParentStart1(ThreadContext context, Ruby runtime, PopenExecutor.ExecArg eargp)
(package private) int	execargRunOptions(ThreadContext context, Ruby runtime, PopenExecutor.ExecArg eargp, PopenExecutor.ExecArg sargp, String[] errmsg)
(package private) static void	execargSetenv(ThreadContext context, Ruby runtime, PopenExecutor.ExecArg eargp, IRubyObject env)
private static void	execFillarg(ThreadContext context, RubyString prog, IRubyObject[] argv, IRubyObject env, IRubyObject opthash, PopenExecutor.ExecArg eargp)
private static RubyString	execGetargs(ThreadContext context, IRubyObject[][] argv_p, boolean accept_shell, IRubyObject[] env_opt)
(package private) static IRubyObject	handleOptionsCommon(ThreadContext context, Ruby runtime, PopenExecutor.ExecArg eargp, RubyHash opthash, boolean raise)
(package private) static boolean	isPopenFork(Ruby runtime, RubyString prog)
static boolean	nativePopenAvailable(Ruby runtime)	Check properties and runtime state to determine whether a native popen is possible.
(package private) static ChannelFD	open_func(Ruby runtime, RubyIO.Sysopen data)
(package private) static void	parentRedirectClose(Ruby runtime, int fd)
(package private) static ChannelFD	parentRedirectOpen(Ruby runtime, RubyIO.Sysopen data)
static IRubyObject	pipeOpen(ThreadContext context, IRubyObject prog, String modestr, int fmode, IOEncodable convconfig)
private RubyIO	pipeOpen(ThreadContext context, PopenExecutor.ExecArg eargp, String modestr, int fmode, IOEncodable convconfig)
static IRubyObject	popen(ThreadContext context, IRubyObject[] argv, RubyClass klass, Block block)
private void	prepareStdioRedirects(Ruby runtime, int[] readPipe, int[] writePipe, PopenExecutor.ExecArg eargp)
(package private) long	procSpawnCmd(Ruby runtime, String[] argv, String prog, PopenExecutor.ExecArg eargp)
(package private) long	procSpawnCmdInternal(Ruby runtime, String[] argv, String prog, PopenExecutor.ExecArg eargp)
(package private) long	procSpawnSh(Ruby runtime, String str, PopenExecutor.ExecArg eargp)
private long	procSpawnSh(Ruby runtime, PopenExecutor.ExecArg eargp, String str, String[] envp)
(package private) static int	redirectCloexecDup(Ruby runtime, int oldfd)
(package private) static void	redirectClose(Ruby runtime, PopenExecutor.ExecArg eargp, int fd)
(package private) static int	redirectDup(Ruby runtime, int oldfd)
(package private) static void	redirectDup2(PopenExecutor.ExecArg eargp, int oldfd, int newfd)
(package private) static void	redirectOpen(PopenExecutor.ExecArg eargp, int fd, String pathname, int flags, int perm)
(package private) static void	run_exec_close(Ruby runtime, RubyArray ary, PopenExecutor.ExecArg eargp)
(package private) static int	run_exec_dup2(Ruby runtime, RubyArray ary, PopenExecutor.ExecArg eargp, PopenExecutor.ExecArg sargp, String[] errmsg)
(package private) static void	run_exec_dup2_child(Ruby runtime, RubyArray ary, PopenExecutor.ExecArg eargp)	Add spawn configuration for duplicating descriptors in the child
(package private) static void	run_exec_open(ThreadContext context, Ruby runtime, RubyArray<RubyArray> ary, PopenExecutor.ExecArg eargp)
(package private) static int	run_exec_pgroup(Ruby runtime, PopenExecutor.ExecArg eargp, PopenExecutor.ExecArg sargp, String[] errmsg)
(package private) static int	run_exec_rlimit(Ruby runtime, RubyArray ary, PopenExecutor.ExecArg sargp, String[] errmsg)
(package private) static int	runExecDup2TmpbufSize(int n)
(package private) static void	saveEnv(ThreadContext context, Ruby runtime, PopenExecutor.ExecArg sargp)
(package private) static int	saveRedirectFd(Ruby runtime, int fd, PopenExecutor.ExecArg sargp, String[] errmsg)
private static boolean	searchForMetaChars(RubyString prog)	Search for meta characters in the command, to know whether we should use a shell to launch.
static RubyFixnum	spawn(ThreadContext context, IRubyObject[] argv)
(package private) long	spawnProcess(ThreadContext context, Ruby runtime, PopenExecutor.ExecArg eargp, String[] errmsg)
IRubyObject	systemInternal(ThreadContext context, IRubyObject[] argv, String[] errmsg)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SH_CHDIR_ARG_COUNT

public static final int SH_CHDIR_ARG_COUNT

See Also:

• Constant Field Values

errno

private jnr.constants.platform.Errno errno

ST_CONTINUE

private static final int ST_CONTINUE

See Also:

• Constant Field Values

ST_STOP

private static final int ST_STOP

See Also:

• Constant Field Values

posix_sh_cmd_length

private static final int posix_sh_cmd_length

See Also:

• Constant Field Values

posix_sh_cmds

private static final String[] posix_sh_cmds

DUMMY_ARRAY

private static final byte[] DUMMY_ARRAY

intcmp

private static final Comparator<PopenExecutor.run_exec_dup2_fd_pair> intcmp

intrcmp

private static final Comparator<PopenExecutor.run_exec_dup2_fd_pair> intrcmp

Constructor Details

PopenExecutor

public PopenExecutor()

Method Details

nativePopenAvailable

public static boolean nativePopenAvailable(Ruby runtime)

Check properties and runtime state to determine whether a native popen is possible.

Parameters:

runtime - current runtime

Returns:

true if popen can use native code, false otherwise

checkPipeCommand

public static IRubyObject checkPipeCommand(ThreadContext context,
 IRubyObject filenameOrCommand)

spawn

public static RubyFixnum spawn(ThreadContext context,
 IRubyObject[] argv)

systemInternal

public IRubyObject systemInternal(ThreadContext context,
 IRubyObject[] argv,
 String[] errmsg)

spawnProcess

long spawnProcess(ThreadContext context,
 Ruby runtime,
 PopenExecutor.ExecArg eargp,
 String[] errmsg)

procSpawnCmdInternal

long procSpawnCmdInternal(Ruby runtime,
 String[] argv,
 String prog,
 PopenExecutor.ExecArg eargp)

procSpawnCmd

long procSpawnCmd(Ruby runtime,
 String[] argv,
 String prog,
 PopenExecutor.ExecArg eargp)

procSpawnSh

long procSpawnSh(Ruby runtime,
 String str,
 PopenExecutor.ExecArg eargp)

pipeOpen

public static IRubyObject pipeOpen(ThreadContext context,
 IRubyObject prog,
 String modestr,
 int fmode,
 IOEncodable convconfig)

popen

public static IRubyObject popen(ThreadContext context,
 IRubyObject[] argv,
 RubyClass klass,
 Block block)

execargSetenv

static void execargSetenv(ThreadContext context,
 Ruby runtime,
 PopenExecutor.ExecArg eargp,
 IRubyObject env)

checkExecEnv

public static RubyArray checkExecEnv(ThreadContext context,
 RubyHash hash,
 PopenExecutor.ExecArg pathArg)

execargExtractOptions

static IRubyObject execargExtractOptions(ThreadContext context,
 Ruby runtime,
 PopenExecutor.ExecArg eargp,
 RubyHash opthash)

checkExecOptions

static void checkExecOptions(ThreadContext context,
 Ruby runtime,
 RubyHash opthash,
 PopenExecutor.ExecArg eargp)

handleOptionsCommon

static IRubyObject handleOptionsCommon(ThreadContext context,
 Ruby runtime,
 PopenExecutor.ExecArg eargp,
 RubyHash opthash,
 boolean raise)

isPopenFork

static boolean isPopenFork(Ruby runtime,
 RubyString prog)

DO_SPAWN

private long DO_SPAWN(Ruby runtime,
 PopenExecutor.ExecArg eargp,
 String cmd,
 String[] args,
 String[] envp)

procSpawnSh

private long procSpawnSh(Ruby runtime,
 PopenExecutor.ExecArg eargp,
 String str,
 String[] envp)

ARGVSTR2ARGV

private static String[] ARGVSTR2ARGV(byte[][] argv_str)

pipeOpen

private RubyIO pipeOpen(ThreadContext context,
 PopenExecutor.ExecArg eargp,
 String modestr,
 int fmode,
 IOEncodable convconfig)

prepareStdioRedirects

private void prepareStdioRedirects(Ruby runtime,
 int[] readPipe,
 int[] writePipe,
 PopenExecutor.ExecArg eargp)

run_exec_pgroup

static int run_exec_pgroup(Ruby runtime,
 PopenExecutor.ExecArg eargp,
 PopenExecutor.ExecArg sargp,
 String[] errmsg)

run_exec_rlimit

static int run_exec_rlimit(Ruby runtime,
 RubyArray ary,
 PopenExecutor.ExecArg sargp,
 String[] errmsg)

saveEnv

static void saveEnv(ThreadContext context,
 Ruby runtime,
 PopenExecutor.ExecArg sargp)

run_exec_dup2

static int run_exec_dup2(Ruby runtime,
 RubyArray ary,
 PopenExecutor.ExecArg eargp,
 PopenExecutor.ExecArg sargp,
 String[] errmsg)

redirectDup

static int redirectDup(Ruby runtime,
 int oldfd)

redirectCloexecDup

static int redirectCloexecDup(Ruby runtime,
 int oldfd)

redirectDup2

static void redirectDup2(PopenExecutor.ExecArg eargp,
 int oldfd,
 int newfd)

redirectClose

static void redirectClose(Ruby runtime,
 PopenExecutor.ExecArg eargp,
 int fd)

redirectOpen

static void redirectOpen(PopenExecutor.ExecArg eargp,
 int fd,
 String pathname,
 int flags,
 int perm)

saveRedirectFd

static int saveRedirectFd(Ruby runtime,
 int fd,
 PopenExecutor.ExecArg sargp,
 String[] errmsg)

execargRunOptions

int execargRunOptions(ThreadContext context,
 Ruby runtime,
 PopenExecutor.ExecArg eargp,
 PopenExecutor.ExecArg sargp,
 String[] errmsg)

run_exec_close

static void run_exec_close(Ruby runtime,
 RubyArray ary,
 PopenExecutor.ExecArg eargp)

run_exec_open

static void run_exec_open(ThreadContext context,
 Ruby runtime,
 RubyArray<RubyArray> ary,
 PopenExecutor.ExecArg eargp)

run_exec_dup2_child

static void run_exec_dup2_child(Ruby runtime,
 RubyArray ary,
 PopenExecutor.ExecArg eargp)

Add spawn configuration for duplicating descriptors in the child

runExecDup2TmpbufSize

static int runExecDup2TmpbufSize(int n)

execargFixup

static void execargFixup(ThreadContext context,
 Ruby runtime,
 PopenExecutor.ExecArg eargp)

execargParentStart

static void execargParentStart(ThreadContext context,
 Ruby runtime,
 PopenExecutor.ExecArg eargp)

execargParentStart1

static void execargParentStart1(ThreadContext context,
 Ruby runtime,
 PopenExecutor.ExecArg eargp)

open_func

static ChannelFD open_func(Ruby runtime,
 RubyIO.Sysopen data)

parentRedirectOpen

static ChannelFD parentRedirectOpen(Ruby runtime,
 RubyIO.Sysopen data)

parentRedirectClose

static void parentRedirectClose(Ruby runtime,
 int fd)

buildEnvp

private static void buildEnvp(Ruby runtime,
 PopenExecutor.ExecArg eargp,
 IRubyObject envtbl)

checkExecFds1

static int checkExecFds1(ThreadContext context,
 Ruby runtime,
 PopenExecutor.ExecArg eargp,
 RubyHash h,
 int maxhint,
 IRubyObject ary)

checkExecFds

static IRubyObject checkExecFds(ThreadContext context,
 Ruby runtime,
 PopenExecutor.ExecArg eargp)

execargAddopt

static int execargAddopt(ThreadContext context,
 Ruby runtime,
 PopenExecutor.ExecArg eargp,
 IRubyObject key,
 IRubyObject val)

checkExecRedirect

static void checkExecRedirect(ThreadContext context,
 Ruby runtime,
 IRubyObject key,
 IRubyObject val,
 PopenExecutor.ExecArg eargp)

checkExecRedirectDefault

private static void checkExecRedirectDefault(Ruby runtime,
 IRubyObject key,
 IRubyObject val,
 PopenExecutor.ExecArg eargp)

checkExecRedirectFd

static IRubyObject checkExecRedirectFd(Ruby runtime,
 IRubyObject v,
 boolean iskey)

checkExecRedirect1

static RubyArray checkExecRedirect1(Ruby runtime,
 RubyArray ary,
 IRubyObject key,
 IRubyObject param)

execargNew

public static PopenExecutor.ExecArg execargNew(ThreadContext context,
 IRubyObject[] argv,
 boolean accept_shell,
 boolean allow_exc_opt)

execargInit

private static RubyString execargInit(ThreadContext context,
 IRubyObject[] argv,
 boolean accept_shell,
 PopenExecutor.ExecArg eargp,
 boolean allow_exc_opt)

execGetargs

private static RubyString execGetargs(ThreadContext context,
 IRubyObject[][] argv_p,
 boolean accept_shell,
 IRubyObject[] env_opt)

checkArgv

public static RubyString checkArgv(ThreadContext context,
 IRubyObject[] argv)

execFillarg

private static void execFillarg(ThreadContext context,
 RubyString prog,
 IRubyObject[] argv,
 IRubyObject env,
 IRubyObject opthash,
 PopenExecutor.ExecArg eargp)

searchForMetaChars

private static boolean searchForMetaChars(RubyString prog)

Search for meta characters in the command, to know whether we should use a shell to launch. meta characters: * Pathname Expansion ? Pathname Expansion {} Grouping Commands [] Pathname Expansion <> Redirection () Grouping Commands ~ Tilde Expansion & AND Lists, Asynchronous Lists | OR Lists, Pipelines \ Escape Character $ Parameter Expansion ; Sequential Lists ' Single-Quotes ` Command Substitution " Double-Quotes \n Lists # Comment = Assignment preceding command name % (used in Parameter Expansion)

dlnFindExeR

private static String dlnFindExeR(Ruby runtime,
 String fname,
 IRubyObject path)