diff options
Diffstat (limited to 'process.c')
| -rw-r--r-- | process.c | 6413 |
1 files changed, 4079 insertions, 2334 deletions
@@ -11,88 +11,114 @@ **********************************************************************/ -#include "internal.h" -#include "ruby/io.h" -#include "ruby/thread.h" -#include "ruby/util.h" -#include "vm_core.h" +#include "ruby/internal/config.h" -#include <stdio.h> +#include "ruby/fiber/scheduler.h" + +#include <ctype.h> #include <errno.h> #include <signal.h> +#include <stdarg.h> +#include <stdio.h> +#include <time.h> + #ifdef HAVE_STDLIB_H -#include <stdlib.h> +# include <stdlib.h> #endif + #ifdef HAVE_UNISTD_H -#include <unistd.h> +# include <unistd.h> #endif + #ifdef HAVE_FCNTL_H -#include <fcntl.h> +# include <fcntl.h> #endif + #ifdef HAVE_PROCESS_H -#include <process.h> +# include <process.h> #endif -#include <time.h> -#include <ctype.h> - #ifndef EXIT_SUCCESS -#define EXIT_SUCCESS 0 +# define EXIT_SUCCESS 0 #endif + #ifndef EXIT_FAILURE -#define EXIT_FAILURE 1 +# define EXIT_FAILURE 1 #endif #ifdef HAVE_SYS_WAIT_H # include <sys/wait.h> #endif + #ifdef HAVE_SYS_RESOURCE_H # include <sys/resource.h> #endif + #ifdef HAVE_VFORK_H # include <vfork.h> #endif + #ifdef HAVE_SYS_PARAM_H # include <sys/param.h> #endif + #ifndef MAXPATHLEN # define MAXPATHLEN 1024 #endif -#include "ruby/st.h" #include <sys/stat.h> -#if defined(__native_client__) && defined(NACL_NEWLIB) -# include <sys/unistd.h> -# include "nacl/stat.h" -# include "nacl/unistd.h" -# include "nacl/resource.h" -# undef HAVE_ISSETUGID -#endif #ifdef HAVE_SYS_TIME_H -#include <sys/time.h> +# include <sys/time.h> #endif + #ifdef HAVE_SYS_TIMES_H -#include <sys/times.h> +# include <sys/times.h> #endif #ifdef HAVE_PWD_H -#include <pwd.h> +# include <pwd.h> #endif + #ifdef HAVE_GRP_H -#include <grp.h> +# include <grp.h> # ifdef __CYGWIN__ int initgroups(const char *, rb_gid_t); # endif #endif + #ifdef HAVE_SYS_ID_H -#include <sys/id.h> +# include <sys/id.h> #endif #ifdef __APPLE__ # include <mach/mach_time.h> #endif +#include "dln.h" +#include "hrtime.h" +#include "internal.h" +#include "internal/bits.h" +#include "internal/dir.h" +#include "internal/error.h" +#include "internal/eval.h" +#include "internal/hash.h" +#include "internal/io.h" +#include "internal/numeric.h" +#include "internal/object.h" +#include "internal/process.h" +#include "internal/thread.h" +#include "internal/variable.h" +#include "internal/warnings.h" +#include "ruby/io.h" +#include "ruby/st.h" +#include "ruby/thread.h" +#include "ruby/util.h" +#include "ractor_core.h" +#include "vm_core.h" +#include "vm_sync.h" +#include "ruby/ractor.h" + /* define system APIs */ #ifdef _WIN32 #undef open @@ -100,6 +126,12 @@ int initgroups(const char *, rb_gid_t); #endif #if defined(HAVE_TIMES) || defined(_WIN32) +/********************************************************************* + * + * Document-class: Process::Tms + * + * Placeholder for rusage + */ static VALUE rb_cProcessTms; #endif @@ -150,29 +182,58 @@ int setregid(rb_gid_t rgid, rb_gid_t egid); #endif #endif -#define preserving_errno(stmts) \ - do {int saved_errno = errno; stmts; errno = saved_errno;} while (0) - static void check_uid_switch(void); static void check_gid_switch(void); +static int exec_async_signal_safe(const struct rb_execarg *, char *, size_t); + +VALUE rb_envtbl(void); +VALUE rb_env_to_hash(void); #if 1 #define p_uid_from_name p_uid_from_name #define p_gid_from_name p_gid_from_name #endif +#if defined(HAVE_UNISTD_H) +# if defined(HAVE_GETLOGIN_R) +# define USE_GETLOGIN_R 1 +# define GETLOGIN_R_SIZE_DEFAULT 0x100 +# define GETLOGIN_R_SIZE_LIMIT 0x1000 +# if defined(_SC_LOGIN_NAME_MAX) +# define GETLOGIN_R_SIZE_INIT sysconf(_SC_LOGIN_NAME_MAX) +# else +# define GETLOGIN_R_SIZE_INIT GETLOGIN_R_SIZE_DEFAULT +# endif +# elif defined(HAVE_GETLOGIN) +# define USE_GETLOGIN 1 +# endif +#endif + #if defined(HAVE_PWD_H) -# if defined(HAVE_GETPWNAM_R) && defined(_SC_GETPW_R_SIZE_MAX) +# if defined(HAVE_GETPWUID_R) +# define USE_GETPWUID_R 1 +# elif defined(HAVE_GETPWUID) +# define USE_GETPWUID 1 +# endif +# if defined(HAVE_GETPWNAM_R) # define USE_GETPWNAM_R 1 -# define GETPW_R_SIZE_INIT sysconf(_SC_GETPW_R_SIZE_MAX) +# elif defined(HAVE_GETPWNAM) +# define USE_GETPWNAM 1 +# endif +# if defined(HAVE_GETPWNAM_R) || defined(HAVE_GETPWUID_R) # define GETPW_R_SIZE_DEFAULT 0x1000 # define GETPW_R_SIZE_LIMIT 0x10000 +# if defined(_SC_GETPW_R_SIZE_MAX) +# define GETPW_R_SIZE_INIT sysconf(_SC_GETPW_R_SIZE_MAX) +# else +# define GETPW_R_SIZE_INIT GETPW_R_SIZE_DEFAULT +# endif # endif # ifdef USE_GETPWNAM_R # define PREPARE_GETPWNAM \ VALUE getpw_buf = 0 # define FINISH_GETPWNAM \ - ALLOCV_END(getpw_buf) + (getpw_buf ? (void)rb_str_resize(getpw_buf, 0) : (void)0) # define OBJ2UID1(id) obj2uid((id), &getpw_buf) # define OBJ2UID(id) obj2uid0(id) static rb_uid_t obj2uid(VALUE id, VALUE *getpw_buf); @@ -214,7 +275,7 @@ static rb_uid_t obj2uid(VALUE id); # define PREPARE_GETGRNAM \ VALUE getgr_buf = 0 # define FINISH_GETGRNAM \ - ALLOCV_END(getgr_buf) + (getgr_buf ? (void)rb_str_resize(getgr_buf, 0) : (void)0) # define OBJ2GID1(id) obj2gid((id), &getgr_buf) # define OBJ2GID(id) obj2gid0(id) static rb_gid_t obj2gid(VALUE id, VALUE *getgr_buf); @@ -253,7 +314,11 @@ typedef unsigned long unsigned_clock_t; #elif defined(HAVE_LONG_LONG) && SIZEOF_CLOCK_T == SIZEOF_LONG_LONG typedef unsigned LONG_LONG unsigned_clock_t; #endif +#ifndef HAVE_SIG_T +typedef void (*sig_t) (int); +#endif +#define id_exception idException static ID id_in, id_out, id_err, id_pid, id_uid, id_gid; static ID id_close, id_child; #ifdef HAVE_SETPGID @@ -262,10 +327,26 @@ static ID id_pgroup; #ifdef _WIN32 static ID id_new_pgroup; #endif -static ID id_unsetenv_others, id_chdir, id_umask, id_close_others, id_ENV; +static ID id_unsetenv_others, id_chdir, id_umask, id_close_others; static ID id_nanosecond, id_microsecond, id_millisecond, id_second; static ID id_float_microsecond, id_float_millisecond, id_float_second; static ID id_GETTIMEOFDAY_BASED_CLOCK_REALTIME, id_TIME_BASED_CLOCK_REALTIME; +#ifdef CLOCK_REALTIME +static ID id_CLOCK_REALTIME; +# define RUBY_CLOCK_REALTIME ID2SYM(id_CLOCK_REALTIME) +#endif +#ifdef CLOCK_MONOTONIC +static ID id_CLOCK_MONOTONIC; +# define RUBY_CLOCK_MONOTONIC ID2SYM(id_CLOCK_MONOTONIC) +#endif +#ifdef CLOCK_PROCESS_CPUTIME_ID +static ID id_CLOCK_PROCESS_CPUTIME_ID; +# define RUBY_CLOCK_PROCESS_CPUTIME_ID ID2SYM(id_CLOCK_PROCESS_CPUTIME_ID) +#endif +#ifdef CLOCK_THREAD_CPUTIME_ID +static ID id_CLOCK_THREAD_CPUTIME_ID; +# define RUBY_CLOCK_THREAD_CPUTIME_ID ID2SYM(id_CLOCK_THREAD_CPUTIME_ID) +#endif #ifdef HAVE_TIMES static ID id_TIMES_BASED_CLOCK_MONOTONIC; static ID id_TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID; @@ -276,10 +357,11 @@ static ID id_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID; static ID id_CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID; #ifdef __APPLE__ static ID id_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC; +# define RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC ID2SYM(id_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC) #endif static ID id_hertz; -extern ID ruby_static_id_status; -#define id_status ruby_static_id_status + +static rb_pid_t cached_pid; /* execv and execl are async-signal-safe since SUSv4 (POSIX.1-2008, XPG7) */ #if defined(__sun) && !defined(_XPG7) /* Solaris 10, 9, ... */ @@ -290,12 +372,30 @@ extern ID ruby_static_id_status; #define ALWAYS_NEED_ENVP 0 #endif +static void +assert_close_on_exec(int fd) +{ +#if VM_CHECK_MODE > 0 +#if defined(HAVE_FCNTL) && defined(F_GETFD) && defined(FD_CLOEXEC) + int flags = fcntl(fd, F_GETFD); + if (flags == -1) { + static const char m[] = "reserved FD closed unexpectedly?\n"; + (void)!write(2, m, sizeof(m) - 1); + return; + } + if (flags & FD_CLOEXEC) return; + rb_bug("reserved FD did not have close-on-exec set"); +#else + rb_bug("reserved FD without close-on-exec support"); +#endif /* FD_CLOEXEC */ +#endif /* VM_CHECK_MODE */ +} + static inline int close_unless_reserved(int fd) { - /* We should not have reserved FDs at this point */ if (rb_reserved_fd_p(fd)) { /* async-signal-safe */ - rb_async_bug_errno("BUG timer thread still running", 0 /* EDOOFUS */); + assert_close_on_exec(fd); return 0; } return close(fd); /* async-signal-safe */ @@ -304,8 +404,6 @@ close_unless_reserved(int fd) /*#define DEBUG_REDIRECT*/ #if defined(DEBUG_REDIRECT) -#include <stdarg.h> - static void ttyprintf(const char *fmt, ...) { @@ -400,43 +498,67 @@ parent_redirect_close(int fd) #define parent_redirect_close(fd) close_unless_reserved(fd) #endif +static VALUE +get_pid(void) +{ + if (UNLIKELY(!cached_pid)) { /* 0 is not a valid pid */ + cached_pid = getpid(); + } + /* pid should be likely POSFIXABLE() */ + return PIDT2NUM(cached_pid); +} + +#if defined HAVE_WORKING_FORK || defined HAVE_DAEMON +static void +clear_pid_cache(void) +{ + cached_pid = 0; +} +#endif + /* * call-seq: - * Process.pid -> fixnum + * Process.pid -> integer + * + * Returns the process ID of the current process: * - * Returns the process id of this process. Not available on all - * platforms. + * Process.pid # => 15668 * - * Process.pid #=> 27415 */ static VALUE -get_pid(void) +proc_get_pid(VALUE _) { - return PIDT2NUM(getpid()); + return get_pid(); } +static VALUE +get_ppid(void) +{ + return PIDT2NUM(getppid()); +} /* * call-seq: - * Process.ppid -> fixnum + * Process.ppid -> integer + * + * Returns the process ID of the parent of the current process: * - * Returns the process id of the parent of this process. Returns - * untrustworthy value on Win32/64. Not available on all platforms. + * puts "Pid is #{Process.pid}." + * fork { puts "Parent pid is #{Process.ppid}." } * - * puts "I am #{Process.pid}" - * Process.fork { puts "Dad is #{Process.ppid}" } + * Output: * - * <em>produces:</em> + * Pid is 271290. + * Parent pid is 271290. * - * I am 27417 - * Dad is 27417 + * May not return a trustworthy value on certain platforms. */ static VALUE -get_ppid(void) +proc_get_ppid(VALUE _) { - return PIDT2NUM(getppid()); + return get_ppid(); } @@ -444,136 +566,242 @@ get_ppid(void) * * Document-class: Process::Status * - * <code>Process::Status</code> encapsulates the information on the - * status of a running or terminated system process. The built-in - * variable <code>$?</code> is either +nil+ or a - * <code>Process::Status</code> object. - * - * fork { exit 99 } #=> 26557 - * Process.wait #=> 26557 - * $?.class #=> Process::Status - * $?.to_i #=> 25344 - * $? >> 8 #=> 99 - * $?.stopped? #=> false - * $?.exited? #=> true - * $?.exitstatus #=> 99 - * - * Posix systems record information on processes using a 16-bit - * integer. The lower bits record the process status (stopped, - * exited, signaled) and the upper bits possibly contain additional - * information (for example the program's return code in the case of - * exited processes). Pre Ruby 1.8, these bits were exposed directly - * to the Ruby program. Ruby now encapsulates these in a - * <code>Process::Status</code> object. To maximize compatibility, - * however, these objects retain a bit-oriented interface. In the - * descriptions that follow, when we talk about the integer value of - * _stat_, we're referring to this 16 bit value. + * A Process::Status contains information about a system process. + * + * Thread-local variable <tt>$?</tt> is initially +nil+. + * Some methods assign to it a Process::Status object + * that represents a system process (either running or terminated): + * + * `ruby -e "exit 99"` + * stat = $? # => #<Process::Status: pid 1262862 exit 99> + * stat.class # => Process::Status + * stat.to_i # => 25344 + * stat.stopped? # => false + * stat.exited? # => true + * stat.exitstatus # => 99 + * */ static VALUE rb_cProcessStatus; +struct rb_process_status { + rb_pid_t pid; + int status; + int error; +}; + +static const rb_data_type_t rb_process_status_type = { + .wrap_struct_name = "Process::Status", + .function = { + .dmark = NULL, + .dfree = RUBY_DEFAULT_FREE, + .dsize = NULL, + }, + .flags = RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED | RUBY_TYPED_EMBEDDABLE, +}; + +static VALUE +rb_process_status_allocate(VALUE klass) +{ + struct rb_process_status *data; + return TypedData_Make_Struct(klass, struct rb_process_status, &rb_process_status_type, data); +} + VALUE rb_last_status_get(void) { return GET_THREAD()->last_status; } +/* + * call-seq: + * Process.last_status -> Process::Status or nil + * + * Returns a Process::Status object representing the most recently exited + * child process in the current thread, or +nil+ if none: + * + * Process.spawn('ruby', '-e', 'exit 13') + * Process.wait + * Process.last_status # => #<Process::Status: pid 14396 exit 13> + * + * Process.spawn('ruby', '-e', 'exit 14') + * Process.wait + * Process.last_status # => #<Process::Status: pid 4692 exit 14> + * + * Process.spawn('ruby', '-e', 'exit 15') + * # 'exit 15' has not been reaped by #wait. + * Process.last_status # => #<Process::Status: pid 4692 exit 14> + * Process.wait + * Process.last_status # => #<Process::Status: pid 1380 exit 15> + * + */ +static VALUE +proc_s_last_status(VALUE mod) +{ + return rb_last_status_get(); +} + +VALUE +rb_process_status_new(rb_pid_t pid, int status, int error) +{ + VALUE last_status = rb_process_status_allocate(rb_cProcessStatus); + struct rb_process_status *data = RTYPEDDATA_GET_DATA(last_status); + data->pid = pid; + data->status = status; + data->error = error; + + rb_obj_freeze(last_status); + return last_status; +} + +static VALUE +process_status_dump(VALUE status) +{ + VALUE dump = rb_class_new_instance(0, 0, rb_cObject); + struct rb_process_status *data; + TypedData_Get_Struct(status, struct rb_process_status, &rb_process_status_type, data); + if (data->pid) { + rb_ivar_set(dump, id_status, INT2NUM(data->status)); + rb_ivar_set(dump, id_pid, PIDT2NUM(data->pid)); + } + return dump; +} + +static VALUE +process_status_load(VALUE real_obj, VALUE load_obj) +{ + struct rb_process_status *data = rb_check_typeddata(real_obj, &rb_process_status_type); + VALUE status = rb_attr_get(load_obj, id_status); + VALUE pid = rb_attr_get(load_obj, id_pid); + data->pid = NIL_P(pid) ? 0 : NUM2PIDT(pid); + data->status = NIL_P(status) ? 0 : NUM2INT(status); + return real_obj; +} + void rb_last_status_set(int status, rb_pid_t pid) { - rb_thread_t *th = GET_THREAD(); - th->last_status = rb_obj_alloc(rb_cProcessStatus); - rb_ivar_set(th->last_status, id_status, INT2FIX(status)); - rb_ivar_set(th->last_status, id_pid, PIDT2NUM(pid)); + GET_THREAD()->last_status = rb_process_status_new(pid, status, 0); +} + +static void +last_status_clear(rb_thread_t *th) +{ + th->last_status = Qnil; } void rb_last_status_clear(void) { - GET_THREAD()->last_status = Qnil; + last_status_clear(GET_THREAD()); +} + +static rb_pid_t +pst_pid(VALUE status) +{ + struct rb_process_status *data; + TypedData_Get_Struct(status, struct rb_process_status, &rb_process_status_type, data); + return data->pid; +} + +static int +pst_status(VALUE status) +{ + struct rb_process_status *data; + TypedData_Get_Struct(status, struct rb_process_status, &rb_process_status_type, data); + return data->status; } /* * call-seq: - * stat.to_i -> fixnum - * stat.to_int -> fixnum + * to_i -> integer * - * Returns the bits in _stat_ as a <code>Fixnum</code>. Poking - * around in these bits is platform dependent. + * Returns the system-dependent integer status of +self+: * - * fork { exit 0xab } #=> 26566 - * Process.wait #=> 26566 - * sprintf('%04x', $?.to_i) #=> "ab00" + * `cat /nop` + * $?.to_i # => 256 */ static VALUE -pst_to_i(VALUE st) +pst_to_i(VALUE self) { - return rb_ivar_get(st, id_status); + int status = pst_status(self); + return RB_INT2NUM(status); } -#define PST2INT(st) NUM2INT(pst_to_i(st)) +#define PST2INT(st) pst_status(st) /* * call-seq: - * stat.pid -> fixnum + * pid -> integer + * + * Returns the process ID of the process: * - * Returns the process ID that this status object represents. + * system("false") + * $?.pid # => 1247002 * - * fork { exit } #=> 26569 - * Process.wait #=> 26569 - * $?.pid #=> 26569 */ static VALUE -pst_pid(VALUE st) +pst_pid_m(VALUE self) { - return rb_attr_get(st, id_pid); + rb_pid_t pid = pst_pid(self); + return PIDT2NUM(pid); } +static VALUE pst_message_status(VALUE str, int status); + static void pst_message(VALUE str, rb_pid_t pid, int status) { rb_str_catf(str, "pid %ld", (long)pid); + pst_message_status(str, status); +} + +static VALUE +pst_message_status(VALUE str, int status) +{ if (WIFSTOPPED(status)) { - int stopsig = WSTOPSIG(status); - const char *signame = ruby_signal_name(stopsig); - if (signame) { - rb_str_catf(str, " stopped SIG%s (signal %d)", signame, stopsig); - } - else { - rb_str_catf(str, " stopped signal %d", stopsig); - } + int stopsig = WSTOPSIG(status); + const char *signame = ruby_signal_name(stopsig); + if (signame) { + rb_str_catf(str, " stopped SIG%s (signal %d)", signame, stopsig); + } + else { + rb_str_catf(str, " stopped signal %d", stopsig); + } } if (WIFSIGNALED(status)) { - int termsig = WTERMSIG(status); - const char *signame = ruby_signal_name(termsig); - if (signame) { - rb_str_catf(str, " SIG%s (signal %d)", signame, termsig); - } - else { - rb_str_catf(str, " signal %d", termsig); - } + int termsig = WTERMSIG(status); + const char *signame = ruby_signal_name(termsig); + if (signame) { + rb_str_catf(str, " SIG%s (signal %d)", signame, termsig); + } + else { + rb_str_catf(str, " signal %d", termsig); + } } if (WIFEXITED(status)) { - rb_str_catf(str, " exit %d", WEXITSTATUS(status)); + rb_str_catf(str, " exit %d", WEXITSTATUS(status)); } #ifdef WCOREDUMP if (WCOREDUMP(status)) { - rb_str_cat2(str, " (core dumped)"); + rb_str_cat2(str, " (core dumped)"); } #endif + return str; } /* * call-seq: - * stat.to_s -> string + * to_s -> string * - * Show pid and exit status as a string. + * Returns a string representation of +self+: + * + * `cat /nop` + * $?.to_s # => "pid 1262141 exit 1" * - * system("false") - * p $?.to_s #=> "pid 12766 exit 1" * */ @@ -584,7 +812,7 @@ pst_to_s(VALUE st) int status; VALUE str; - pid = NUM2PIDT(pst_pid(st)); + pid = pst_pid(st); status = PST2INT(st); str = rb_str_buf_new(0); @@ -595,12 +823,12 @@ pst_to_s(VALUE st) /* * call-seq: - * stat.inspect -> string + * inspect -> string * - * Override the inspection method. + * Returns a string representation of +self+: * * system("false") - * p $?.inspect #=> "#<Process::Status: pid 12861 exit 1>" + * $?.inspect # => "#<Process::Status: pid 1303494 exit 1>" * */ @@ -609,13 +837,12 @@ pst_inspect(VALUE st) { rb_pid_t pid; int status; - VALUE vpid, str; + VALUE str; - vpid = pst_pid(st); - if (NIL_P(vpid)) { + pid = pst_pid(st); + if (!pid) { return rb_sprintf("#<%s: uninitialized>", rb_class2name(CLASS_OF(st))); } - pid = NUM2PIDT(vpid); status = PST2INT(st); str = rb_sprintf("#<%s: ", rb_class2name(CLASS_OF(st))); @@ -627,10 +854,15 @@ pst_inspect(VALUE st) /* * call-seq: - * stat == other -> true or false + * stat == other -> true or false + * + * Returns whether the value of #to_i == +other+: + * + * `cat /nop` + * stat = $? # => #<Process::Status: pid 1170366 exit 1> + * sprintf('%x', stat.to_i) # => "100" + * stat == 0x100 # => true * - * Returns +true+ if the integer value of _stat_ - * equals <em>other</em>. */ static VALUE @@ -643,53 +875,11 @@ pst_equal(VALUE st1, VALUE st2) /* * call-seq: - * stat & num -> fixnum - * - * Logical AND of the bits in _stat_ with <em>num</em>. - * - * fork { exit 0x37 } - * Process.wait - * sprintf('%04x', $?.to_i) #=> "3700" - * sprintf('%04x', $? & 0x1e00) #=> "1600" - */ - -static VALUE -pst_bitand(VALUE st1, VALUE st2) -{ - int status = PST2INT(st1) & NUM2INT(st2); - - return INT2NUM(status); -} - - -/* - * call-seq: - * stat >> num -> fixnum - * - * Shift the bits in _stat_ right <em>num</em> places. - * - * fork { exit 99 } #=> 26563 - * Process.wait #=> 26563 - * $?.to_i #=> 25344 - * $? >> 8 #=> 99 - */ - -static VALUE -pst_rshift(VALUE st1, VALUE st2) -{ - int status = PST2INT(st1) >> NUM2INT(st2); - - return INT2NUM(status); -} - - -/* - * call-seq: - * stat.stopped? -> true or false + * stopped? -> true or false * - * Returns +true+ if this process is stopped. This is only - * returned if the corresponding <code>wait</code> call had the - * <code>WUNTRACED</code> flag set. + * Returns +true+ if this process is stopped, + * and if the corresponding #wait call had the Process::WUNTRACED flag set, + * +false+ otherwise. */ static VALUE @@ -697,19 +887,16 @@ pst_wifstopped(VALUE st) { int status = PST2INT(st); - if (WIFSTOPPED(status)) - return Qtrue; - else - return Qfalse; + return RBOOL(WIFSTOPPED(status)); } /* * call-seq: - * stat.stopsig -> fixnum or nil + * stopsig -> integer or nil * - * Returns the number of the signal that caused _stat_ to stop - * (or +nil+ if self is not stopped). + * Returns the number of the signal that caused the process to stop, + * or +nil+ if the process is not stopped. */ static VALUE @@ -718,17 +905,17 @@ pst_wstopsig(VALUE st) int status = PST2INT(st); if (WIFSTOPPED(status)) - return INT2NUM(WSTOPSIG(status)); + return INT2NUM(WSTOPSIG(status)); return Qnil; } /* * call-seq: - * stat.signaled? -> true or false + * signaled? -> true or false * - * Returns +true+ if _stat_ terminated because of - * an uncaught signal. + * Returns +true+ if the process terminated because of an uncaught signal, + * +false+ otherwise. */ static VALUE @@ -736,20 +923,16 @@ pst_wifsignaled(VALUE st) { int status = PST2INT(st); - if (WIFSIGNALED(status)) - return Qtrue; - else - return Qfalse; + return RBOOL(WIFSIGNALED(status)); } /* * call-seq: - * stat.termsig -> fixnum or nil + * termsig -> integer or nil * - * Returns the number of the signal that caused _stat_ to - * terminate (or +nil+ if self was not terminated by an - * uncaught signal). + * Returns the number of the signal that caused the process to terminate + * or +nil+ if the process was not terminated by an uncaught signal. */ static VALUE @@ -758,18 +941,18 @@ pst_wtermsig(VALUE st) int status = PST2INT(st); if (WIFSIGNALED(status)) - return INT2NUM(WTERMSIG(status)); + return INT2NUM(WTERMSIG(status)); return Qnil; } /* * call-seq: - * stat.exited? -> true or false + * exited? -> true or false * - * Returns +true+ if _stat_ exited normally (for - * example using an <code>exit()</code> call or finishing the - * program). + * Returns +true+ if the process exited normally + * (for example using an <code>exit()</code> call or finishing the + * program), +false+ if not. */ static VALUE @@ -777,30 +960,21 @@ pst_wifexited(VALUE st) { int status = PST2INT(st); - if (WIFEXITED(status)) - return Qtrue; - else - return Qfalse; + return RBOOL(WIFEXITED(status)); } /* * call-seq: - * stat.exitstatus -> fixnum or nil + * exitstatus -> integer or nil * - * Returns the least significant eight bits of the return code of - * _stat_. Only available if <code>exited?</code> is - * +true+. + * Returns the least significant eight bits of the return code + * of the process if it has exited; + * +nil+ otherwise: * - * fork { } #=> 26572 - * Process.wait #=> 26572 - * $?.exited? #=> true - * $?.exitstatus #=> 0 + * `exit 99` + * $?.exitstatus # => 99 * - * fork { exit 99 } #=> 26573 - * Process.wait #=> 26573 - * $?.exited? #=> true - * $?.exitstatus #=> 99 */ static VALUE @@ -809,17 +983,21 @@ pst_wexitstatus(VALUE st) int status = PST2INT(st); if (WIFEXITED(status)) - return INT2NUM(WEXITSTATUS(status)); + return INT2NUM(WEXITSTATUS(status)); return Qnil; } /* * call-seq: - * stat.success? -> true, false or nil + * success? -> true, false, or nil + * + * Returns: + * + * - +true+ if the process has completed successfully and exited. + * - +false+ if the process has completed unsuccessfully and exited. + * - +nil+ if the process has not exited. * - * Returns +true+ if _stat_ is successful, +false+ if not. - * Returns +nil+ if <code>exited?</code> is not +true+. */ static VALUE @@ -828,17 +1006,19 @@ pst_success_p(VALUE st) int status = PST2INT(st); if (!WIFEXITED(status)) - return Qnil; - return WEXITSTATUS(status) == EXIT_SUCCESS ? Qtrue : Qfalse; + return Qnil; + return RBOOL(WEXITSTATUS(status) == EXIT_SUCCESS); } /* * call-seq: - * stat.coredump? -> true or false + * coredump? -> true or false + * + * Returns +true+ if the process generated a coredump + * when it terminated, +false+ if not. * - * Returns +true+ if _stat_ generated a coredump - * when it terminated. Not available on all platforms. + * Not available on all platforms. */ static VALUE @@ -847,21 +1027,12 @@ pst_wcoredump(VALUE st) #ifdef WCOREDUMP int status = PST2INT(st); - if (WCOREDUMP(status)) - return Qtrue; - else - return Qfalse; + return RBOOL(WCOREDUMP(status)); #else return Qfalse; #endif } -struct waitpid_arg { - rb_pid_t pid; - int flags; - int *st; -}; - static rb_pid_t do_waitpid(rb_pid_t pid, int *st, int flags) { @@ -874,48 +1045,174 @@ do_waitpid(rb_pid_t pid, int *st, int flags) #endif } +struct waitpid_state { + struct ccan_list_node wnode; + rb_execution_context_t *ec; + rb_nativethread_cond_t *cond; + rb_pid_t ret; + rb_pid_t pid; + int status; + int options; + int errnum; +}; + +static void +waitpid_state_init(struct waitpid_state *w, rb_pid_t pid, int options) +{ + w->ret = 0; + w->pid = pid; + w->options = options; + w->errnum = 0; + w->status = 0; +} + static void * -rb_waitpid_blocking(void *data) +waitpid_blocking_no_SIGCHLD(void *x) { - struct waitpid_arg *arg = data; - rb_pid_t result = do_waitpid(arg->pid, arg->st, arg->flags); - return (void *)(VALUE)result; + struct waitpid_state *w = x; + + w->ret = do_waitpid(w->pid, &w->status, w->options); + + return 0; } -static rb_pid_t -do_waitpid_nonblocking(rb_pid_t pid, int *st, int flags) +static void +waitpid_no_SIGCHLD(struct waitpid_state *w) +{ + if (w->options & WNOHANG) { + w->ret = do_waitpid(w->pid, &w->status, w->options); + } + else { + do { + rb_thread_call_without_gvl(waitpid_blocking_no_SIGCHLD, w, RUBY_UBF_PROCESS, 0); + } while (w->ret < 0 && errno == EINTR && (RUBY_VM_CHECK_INTS(w->ec),1)); + } + if (w->ret == -1) + w->errnum = errno; +} + +VALUE +rb_process_status_wait(rb_pid_t pid, int flags) +{ + // We only enter the scheduler if we are "blocking": + if (!(flags & WNOHANG)) { + VALUE scheduler = rb_fiber_scheduler_current(); + if (scheduler != Qnil) { + VALUE result = rb_fiber_scheduler_process_wait(scheduler, pid, flags); + if (!UNDEF_P(result)) return result; + } + } + + struct waitpid_state waitpid_state; + + waitpid_state_init(&waitpid_state, pid, flags); + waitpid_state.ec = GET_EC(); + + waitpid_no_SIGCHLD(&waitpid_state); + + if (waitpid_state.ret == 0) return Qnil; + + return rb_process_status_new(waitpid_state.ret, waitpid_state.status, waitpid_state.errnum); +} + +/* + * call-seq: + * Process::Status.wait(pid = -1, flags = 0) -> Process::Status + * + * Like Process.wait, but returns a Process::Status object + * (instead of an integer pid or nil); + * see Process.wait for the values of +pid+ and +flags+. + * + * If there are child processes, + * waits for a child process to exit and returns a Process::Status object + * containing information on that process; + * sets thread-local variable <tt>$?</tt>: + * + * Process.spawn('cat /nop') # => 1155880 + * Process::Status.wait # => #<Process::Status: pid 1155880 exit 1> + * $? # => #<Process::Status: pid 1155508 exit 1> + * + * If there is no child process, + * returns an "empty" Process::Status object + * that does not represent an actual process; + * does not set thread-local variable <tt>$?</tt>: + * + * Process::Status.wait # => #<Process::Status: pid -1 exit 0> + * $? # => #<Process::Status: pid 1155508 exit 1> # Unchanged. + * + * May invoke the scheduler hook Fiber::Scheduler#process_wait. + * + * Not available on all platforms. + */ + +static VALUE +rb_process_status_waitv(int argc, VALUE *argv, VALUE _) { - void *result; - struct waitpid_arg arg; - arg.pid = pid; - arg.st = st; - arg.flags = flags; - result = rb_thread_call_without_gvl(rb_waitpid_blocking, &arg, - RUBY_UBF_PROCESS, 0); - return (rb_pid_t)(VALUE)result; + rb_check_arity(argc, 0, 2); + + rb_pid_t pid = -1; + int flags = 0; + + if (argc >= 1) { + pid = NUM2PIDT(argv[0]); + } + + if (argc >= 2) { + flags = RB_NUM2INT(argv[1]); + } + + return rb_process_status_wait(pid, flags); } rb_pid_t rb_waitpid(rb_pid_t pid, int *st, int flags) { - rb_pid_t result; + VALUE status = rb_process_status_wait(pid, flags); + if (NIL_P(status)) return 0; + + struct rb_process_status *data = rb_check_typeddata(status, &rb_process_status_type); + pid = data->pid; + + if (st) *st = data->status; - if (flags & WNOHANG) { - result = do_waitpid(pid, st, flags); + if (pid == -1) { + errno = data->error; } else { - while ((result = do_waitpid_nonblocking(pid, st, flags)) < 0 && - (errno == EINTR)) { - rb_thread_t *th = GET_THREAD(); - RUBY_VM_CHECK_INTS(th); - } - } - if (result > 0) { - rb_last_status_set(*st, result); + GET_THREAD()->last_status = status; } - return result; + + return pid; } +static VALUE +proc_wait(int argc, VALUE *argv) +{ + rb_pid_t pid; + int flags, status; + + flags = 0; + if (rb_check_arity(argc, 0, 2) == 0) { + pid = -1; + } + else { + VALUE vflags; + pid = NUM2PIDT(argv[0]); + if (argc == 2 && !NIL_P(vflags = argv[1])) { + flags = NUM2UINT(vflags); + } + } + + if ((pid = rb_waitpid(pid, &status, flags)) < 0) + rb_sys_fail(0); + + if (pid == 0) { + rb_last_status_clear(); + return Qnil; + } + + return PIDT2NUM(pid); +} /* [MG]:FIXME: I wasn't sure how this should be done, since ::wait() has historically been documented as if it didn't take any arguments @@ -933,94 +1230,159 @@ rb_waitpid(rb_pid_t pid, int *st, int flags) /* * call-seq: - * Process.wait() -> fixnum - * Process.wait(pid=-1, flags=0) -> fixnum - * Process.waitpid(pid=-1, flags=0) -> fixnum - * - * Waits for a child process to exit, returns its process id, and - * sets <code>$?</code> to a <code>Process::Status</code> object - * containing information on that process. Which child it waits on - * depends on the value of _pid_: - * - * > 0:: Waits for the child whose process ID equals _pid_. - * - * 0:: Waits for any child whose process group ID equals that of the - * calling process. - * - * -1:: Waits for any child process (the default if no _pid_ is - * given). - * - * < -1:: Waits for any child whose process group ID equals the absolute - * value of _pid_. - * - * The _flags_ argument may be a logical or of the flag values - * <code>Process::WNOHANG</code> (do not block if no child available) - * or <code>Process::WUNTRACED</code> (return stopped children that - * haven't been reported). Not all flags are available on all - * platforms, but a flag value of zero will work on all platforms. - * - * Calling this method raises a SystemCallError if there are no child - * processes. Not available on all platforms. - * - * include Process - * fork { exit 99 } #=> 27429 - * wait #=> 27429 - * $?.exitstatus #=> 99 - * - * pid = fork { sleep 3 } #=> 27440 - * Time.now #=> 2008-03-08 19:56:16 +0900 - * waitpid(pid, Process::WNOHANG) #=> nil - * Time.now #=> 2008-03-08 19:56:16 +0900 - * waitpid(pid, 0) #=> 27440 - * Time.now #=> 2008-03-08 19:56:19 +0900 + * Process.wait(pid = -1, flags = 0) -> integer + * + * Waits for a suitable child process to exit, returns its process ID, + * and sets <tt>$?</tt> to a Process::Status object + * containing information on that process. + * Which child it waits for depends on the value of the given +pid+: + * + * - Positive integer: Waits for the child process whose process ID is +pid+: + * + * pid0 = Process.spawn('ruby', '-e', 'exit 13') # => 230866 + * pid1 = Process.spawn('ruby', '-e', 'exit 14') # => 230891 + * Process.wait(pid0) # => 230866 + * $? # => #<Process::Status: pid 230866 exit 13> + * Process.wait(pid1) # => 230891 + * $? # => #<Process::Status: pid 230891 exit 14> + * Process.wait(pid0) # Raises Errno::ECHILD + * + * - <tt>0</tt>: Waits for any child process whose group ID + * is the same as that of the current process: + * + * parent_pgpid = Process.getpgid(Process.pid) + * puts "Parent process group ID is #{parent_pgpid}." + * child0_pid = fork do + * puts "Child 0 pid is #{Process.pid}" + * child0_pgid = Process.getpgid(Process.pid) + * puts "Child 0 process group ID is #{child0_pgid} (same as parent's)." + * end + * child1_pid = fork do + * puts "Child 1 pid is #{Process.pid}" + * Process.setpgid(0, Process.pid) + * child1_pgid = Process.getpgid(Process.pid) + * puts "Child 1 process group ID is #{child1_pgid} (different from parent's)." + * end + * retrieved_pid = Process.wait(0) + * puts "Process.wait(0) returned pid #{retrieved_pid}, which is child 0 pid." + * begin + * Process.wait(0) + * rescue Errno::ECHILD => x + * puts "Raised #{x.class}, because child 1 process group ID differs from parent process group ID." + * end + * + * Output: + * + * Parent process group ID is 225764. + * Child 0 pid is 225788 + * Child 0 process group ID is 225764 (same as parent's). + * Child 1 pid is 225789 + * Child 1 process group ID is 225789 (different from parent's). + * Process.wait(0) returned pid 225788, which is child 0 pid. + * Raised Errno::ECHILD, because child 1 process group ID differs from parent process group ID. + * + * - <tt>-1</tt> (default): Waits for any child process: + * + * parent_pgpid = Process.getpgid(Process.pid) + * puts "Parent process group ID is #{parent_pgpid}." + * child0_pid = fork do + * puts "Child 0 pid is #{Process.pid}" + * child0_pgid = Process.getpgid(Process.pid) + * puts "Child 0 process group ID is #{child0_pgid} (same as parent's)." + * end + * child1_pid = fork do + * puts "Child 1 pid is #{Process.pid}" + * Process.setpgid(0, Process.pid) + * child1_pgid = Process.getpgid(Process.pid) + * puts "Child 1 process group ID is #{child1_pgid} (different from parent's)." + * sleep 3 # To force child 1 to exit later than child 0 exit. + * end + * child_pids = [child0_pid, child1_pid] + * retrieved_pid = Process.wait(-1) + * puts child_pids.include?(retrieved_pid) + * retrieved_pid = Process.wait(-1) + * puts child_pids.include?(retrieved_pid) + * + * Output: + * + * Parent process group ID is 228736. + * Child 0 pid is 228758 + * Child 0 process group ID is 228736 (same as parent's). + * Child 1 pid is 228759 + * Child 1 process group ID is 228759 (different from parent's). + * true + * true + * + * - Less than <tt>-1</tt>: Waits for any child whose process group ID is <tt>-pid</tt>: + * + * parent_pgpid = Process.getpgid(Process.pid) + * puts "Parent process group ID is #{parent_pgpid}." + * child0_pid = fork do + * puts "Child 0 pid is #{Process.pid}" + * child0_pgid = Process.getpgid(Process.pid) + * puts "Child 0 process group ID is #{child0_pgid} (same as parent's)." + * end + * child1_pid = fork do + * puts "Child 1 pid is #{Process.pid}" + * Process.setpgid(0, Process.pid) + * child1_pgid = Process.getpgid(Process.pid) + * puts "Child 1 process group ID is #{child1_pgid} (different from parent's)." + * end + * sleep 1 + * retrieved_pid = Process.wait(-child1_pid) + * puts "Process.wait(-child1_pid) returned pid #{retrieved_pid}, which is child 1 pid." + * begin + * Process.wait(-child1_pid) + * rescue Errno::ECHILD => x + * puts "Raised #{x.class}, because there's no longer a child with process group id #{child1_pid}." + * end + * + * Output: + * + * Parent process group ID is 230083. + * Child 0 pid is 230108 + * Child 0 process group ID is 230083 (same as parent's). + * Child 1 pid is 230109 + * Child 1 process group ID is 230109 (different from parent's). + * Process.wait(-child1_pid) returned pid 230109, which is child 1 pid. + * Raised Errno::ECHILD, because there's no longer a child with process group id 230109. + * + * Argument +flags+ should be given as one of the following constants, + * or as the logical OR of both: + * + * - Process::WNOHANG: Does not block if no child process is available. + * - Process::WUNTRACED: May return a stopped child process, even if not yet reported. + * + * Not all flags are available on all platforms. + * + * Raises Errno::ECHILD if there is no suitable child process. + * + * Not available on all platforms. + * + * Process.waitpid is an alias for Process.wait. */ - static VALUE -proc_wait(int argc, VALUE *argv) +proc_m_wait(int c, VALUE *v, VALUE _) { - VALUE vpid, vflags; - rb_pid_t pid; - int flags, status; - - flags = 0; - if (argc == 0) { - pid = -1; - } - else { - rb_scan_args(argc, argv, "02", &vpid, &vflags); - pid = NUM2PIDT(vpid); - if (argc == 2 && !NIL_P(vflags)) { - flags = NUM2UINT(vflags); - } - } - if ((pid = rb_waitpid(pid, &status, flags)) < 0) - rb_sys_fail(0); - if (pid == 0) { - rb_last_status_clear(); - return Qnil; - } - return PIDT2NUM(pid); + return proc_wait(c, v); } - /* * call-seq: - * Process.wait2(pid=-1, flags=0) -> [pid, status] - * Process.waitpid2(pid=-1, flags=0) -> [pid, status] - * - * Waits for a child process to exit (see Process::waitpid for exact - * semantics) and returns an array containing the process id and the - * exit status (a <code>Process::Status</code> object) of that - * child. Raises a SystemCallError if there are no child processes. - * - * Process.fork { exit 99 } #=> 27437 - * pid, status = Process.wait2 - * pid #=> 27437 - * status.exitstatus #=> 99 + * Process.wait2(pid = -1, flags = 0) -> [pid, status] + * + * Like Process.waitpid, but returns an array + * containing the child process +pid+ and Process::Status +status+: + * + * pid = Process.spawn('ruby', '-e', 'exit 13') # => 309581 + * Process.wait2(pid) + * # => [309581, #<Process::Status: pid 309581 exit 13>] + * + * Process.waitpid2 is an alias for Process.wait2. */ static VALUE -proc_wait2(int argc, VALUE *argv) +proc_wait2(int argc, VALUE *argv, VALUE _) { VALUE pid = proc_wait(argc, argv); if (NIL_P(pid)) return Qnil; @@ -1030,26 +1392,21 @@ proc_wait2(int argc, VALUE *argv) /* * call-seq: - * Process.waitall -> [ [pid1,status1], ...] - * - * Waits for all children, returning an array of - * _pid_/_status_ pairs (where _status_ is a - * <code>Process::Status</code> object). + * Process.waitall -> array * - * fork { sleep 0.2; exit 2 } #=> 27432 - * fork { sleep 0.1; exit 1 } #=> 27433 - * fork { exit 0 } #=> 27434 - * p Process.waitall + * Waits for all children, returns an array of 2-element arrays; + * each subarray contains the integer pid and Process::Status status + * for one of the reaped child processes: * - * <em>produces</em>: + * pid0 = Process.spawn('ruby', '-e', 'exit 13') # => 325470 + * pid1 = Process.spawn('ruby', '-e', 'exit 14') # => 325495 + * Process.waitall + * # => [[325470, #<Process::Status: pid 325470 exit 13>], [325495, #<Process::Status: pid 325495 exit 14>]] * - * [[30982, #<Process::Status: pid 30982 exit 0>], - * [30979, #<Process::Status: pid 30979 exit 1>], - * [30976, #<Process::Status: pid 30976 exit 2>]] */ static VALUE -proc_waitall(void) +proc_waitall(VALUE _) { VALUE result; rb_pid_t pid; @@ -1059,13 +1416,14 @@ proc_waitall(void) rb_last_status_clear(); for (pid = -1;;) { - pid = rb_waitpid(-1, &status, 0); - if (pid == -1) { - if (errno == ECHILD) - break; - rb_sys_fail(0); - } - rb_ary_push(result, rb_assoc_new(PIDT2NUM(pid), rb_last_status_get())); + pid = rb_waitpid(-1, &status, 0); + if (pid == -1) { + int e = errno; + if (e == ECHILD) + break; + rb_syserr_fail(e, 0); + } + rb_ary_push(result, rb_assoc_new(PIDT2NUM(pid), rb_last_status_get())); } return result; } @@ -1085,7 +1443,7 @@ detach_process_watcher(void *arg) int status; while ((cpid = rb_waitpid(pid, &status, 0)) == 0) { - /* wait while alive */ + /* wait while alive */ } return rb_last_status_get(); } @@ -1102,49 +1460,41 @@ rb_detach_process(rb_pid_t pid) /* * call-seq: - * Process.detach(pid) -> thread + * Process.detach(pid) -> thread + * + * Avoids the potential for a child process to become a + * {zombie process}[https://en.wikipedia.org/wiki/Zombie_process]. + * Process.detach prevents this by setting up a separate Ruby thread + * whose sole job is to reap the status of the process _pid_ when it terminates. * - * Some operating systems retain the status of terminated child - * processes until the parent collects that status (normally using - * some variant of <code>wait()</code>). If the parent never collects - * this status, the child stays around as a <em>zombie</em> process. - * <code>Process::detach</code> prevents this by setting up a - * separate Ruby thread whose sole job is to reap the status of the - * process _pid_ when it terminates. Use <code>detach</code> - * only when you do not intend to explicitly wait for the child to - * terminate. + * This method is needed only when the parent process will never wait + * for the child process. * - * The waiting thread returns the exit status of the detached process - * when it terminates, so you can use <code>Thread#join</code> to - * know the result. If specified _pid_ is not a valid child process - * ID, the thread returns +nil+ immediately. + * This example does not reap the second child process; + * that process appears as a zombie in the process status (+ps+) output: * - * The waiting thread has <code>pid</code> method which returns the pid. + * pid = Process.spawn('ruby', '-e', 'exit 13') # => 312691 + * sleep(1) + * # Find zombies. + * system("ps -ho pid,state -p #{pid}") * - * In this first example, we don't reap the first child process, so - * it appears as a zombie in the process status display. + * Output: * - * p1 = fork { sleep 0.1 } - * p2 = fork { sleep 0.2 } - * Process.waitpid(p2) - * sleep 2 - * system("ps -ho pid,state -p #{p1}") + * 312716 Z * - * <em>produces:</em> + * This example also does not reap the second child process, + * but it does detach the process so that it does not become a zombie: * - * 27389 Z + * pid = Process.spawn('ruby', '-e', 'exit 13') # => 313213 + * thread = Process.detach(pid) + * sleep(1) + * # => #<Process::Waiter:0x00007f038f48b838 run> + * system("ps -ho pid,state -p #{pid}") # Finds no zombies. * - * In the next example, <code>Process::detach</code> is used to reap - * the child automatically. + * The waiting thread can return the pid of the detached child process: * - * p1 = fork { sleep 0.1 } - * p2 = fork { sleep 0.2 } - * Process.detach(p1) - * Process.waitpid(p2) - * sleep 2 - * system("ps -ho pid,state -p #{p1}") + * thread.join.pid # => 313262 * - * <em>(produces no output)</em> */ static VALUE @@ -1174,52 +1524,93 @@ before_exec_non_async_signal_safe(void) rb_thread_stop_timer_thread(); } +#define WRITE_CONST(fd, str) (void)(write((fd),(str),sizeof(str)-1)<0) +#ifdef _WIN32 +int rb_w32_set_nonblock2(int fd, int nonblock); +#endif + +static int +set_blocking(int fd) +{ +#ifdef _WIN32 + return rb_w32_set_nonblock2(fd, 0); +#elif defined(F_GETFL) && defined(F_SETFL) + int fl = fcntl(fd, F_GETFL); /* async-signal-safe */ + + /* EBADF ought to be possible */ + if (fl == -1) return fl; + if (fl & O_NONBLOCK) { + fl &= ~O_NONBLOCK; + return fcntl(fd, F_SETFL, fl); + } + return 0; +#endif +} + static void -before_exec(void) +stdfd_clear_nonblock(void) { - before_exec_non_async_signal_safe(); - before_exec_async_signal_safe(); + /* many programs cannot deal with non-blocking stdin/stdout/stderr */ + int fd; + for (fd = 0; fd < 3; fd++) { + (void)set_blocking(fd); /* can't do much about errors anyhow */ + } } -/* This function should be async-signal-safe. Actually it is. */ static void -after_exec_async_signal_safe(void) +before_exec(void) { + before_exec_non_async_signal_safe(); + before_exec_async_signal_safe(); } static void -after_exec_non_async_signal_safe(void) +after_exec(void) { rb_thread_reset_timer_thread(); rb_thread_start_timer_thread(); } +#if defined HAVE_WORKING_FORK || defined HAVE_DAEMON static void -after_exec(void) +before_fork_ruby(void) { - after_exec_async_signal_safe(); - after_exec_non_async_signal_safe(); + before_exec(); + rb_gc_before_fork(); } -#define before_fork_ruby() before_exec() -#define after_fork_ruby() (rb_threadptr_pending_interrupt_clear(GET_THREAD()), after_exec()) - -#include "dln.h" - static void -security(const char *str) +after_fork_ruby(rb_pid_t pid) { - if (rb_env_path_tainted()) { - if (rb_safe_level() > 0) { - rb_raise(rb_eSecurityError, "Insecure PATH - %s", str); - } + rb_gc_after_fork(pid); + + if (pid == 0) { + // child + clear_pid_cache(); + rb_thread_atfork(); + } + else { + // parent + after_exec(); } } +#endif + +#if defined(HAVE_WORKING_FORK) -#if defined(HAVE_WORKING_FORK) && !defined(__native_client__) +COMPILER_WARNING_PUSH +#if __has_warning("-Wdeprecated-declarations") || RBIMPL_COMPILER_IS(GCC) +COMPILER_WARNING_IGNORED(-Wdeprecated-declarations) +#endif +static inline rb_pid_t +rb_fork(void) +{ + return fork(); +} +COMPILER_WARNING_POP /* try_with_sh and exec_with_sh should be async-signal-safe. Actually it is.*/ -#define try_with_sh(prog, argv, envp) ((saved_errno == ENOEXEC) ? exec_with_sh((prog), (argv), (envp)) : (void)0) +#define try_with_sh(err, prog, argv, envp) ((err == ENOEXEC) ? exec_with_sh((prog), (argv), (envp)) : (void)0) static void exec_with_sh(const char *prog, char **argv, char **envp) { @@ -1232,34 +1623,37 @@ exec_with_sh(const char *prog, char **argv, char **envp) } #else -#define try_with_sh(prog, argv, envp) (void)0 +#define try_with_sh(err, prog, argv, envp) (void)0 #endif /* This function should be async-signal-safe. Actually it is. */ static int proc_exec_cmd(const char *prog, VALUE argv_str, VALUE envp_str) { -#ifdef __native_client__ - rb_notimplement(); - UNREACHABLE; -#else char **argv; +#ifndef _WIN32 char **envp; + int err; +#endif argv = ARGVSTR2ARGV(argv_str); if (!prog) { - errno = ENOENT; - return -1; + return ENOENT; } - envp = envp_str ? (char **)RSTRING_PTR(envp_str) : NULL; +#ifdef _WIN32 + rb_w32_uaspawn(P_OVERLAY, prog, argv); + return errno; +#else + envp = envp_str ? RB_IMEMO_TMPBUF_PTR(envp_str) : NULL; if (envp_str) execve(prog, argv, envp); /* async-signal-safe */ else execv(prog, argv); /* async-signal-safe (since SUSv4) */ - preserving_errno(try_with_sh(prog, argv, envp)); /* try_with_sh() is async-signal-safe. */ - return -1; + err = errno; + try_with_sh(err, prog, argv, envp); /* try_with_sh() is async-signal-safe. */ + return err; #endif } @@ -1267,26 +1661,19 @@ proc_exec_cmd(const char *prog, VALUE argv_str, VALUE envp_str) static int proc_exec_sh(const char *str, VALUE envp_str) { -#ifdef __native_client__ - rb_notimplement(); - UNREACHABLE; -#else const char *s; s = str; while (*s == ' ' || *s == '\t' || *s == '\n') - s++; + s++; if (!*s) { - errno = ENOENT; - return -1; + return ENOENT; } #ifdef _WIN32 rb_w32_uspawn(P_OVERLAY, (char *)str, 0); - return -1; -#else -#if defined(__CYGWIN32__) +#elif defined(__CYGWIN32__) { char fbuf[MAXPATHLEN]; char *shell = dln_find_exe_r("sh", 0, fbuf, sizeof(fbuf)); @@ -1300,13 +1687,11 @@ proc_exec_sh(const char *str, VALUE envp_str) } #else if (envp_str) - execle("/bin/sh", "sh", "-c", str, (char *)NULL, (char **)RSTRING_PTR(envp_str)); /* async-signal-safe */ + execle("/bin/sh", "sh", "-c", str, (char *)NULL, RB_IMEMO_TMPBUF_PTR(envp_str)); /* async-signal-safe */ else execl("/bin/sh", "sh", "-c", str, (char *)NULL); /* async-signal-safe (since SUSv4) */ -#endif - return -1; #endif /* _WIN32 */ -#endif + return errno; } int @@ -1315,8 +1700,9 @@ rb_proc_exec(const char *str) int ret; before_exec(); ret = proc_exec_sh(str, Qfalse); - preserving_errno(after_exec()); - return ret; + after_exec(); + errno = ret; + return -1; } static void @@ -1341,6 +1727,7 @@ mark_exec_arg(void *ptr) rb_gc_mark(eargp->fd_open); rb_gc_mark(eargp->fd_dup2_child); rb_gc_mark(eargp->env_modification); + rb_gc_mark(eargp->path_env); rb_gc_mark(eargp->chdir_dir); } @@ -1353,7 +1740,7 @@ memsize_exec_arg(const void *ptr) static const rb_data_type_t exec_arg_data_type = { "exec_arg", {mark_exec_arg, RUBY_TYPED_DEFAULT_FREE, memsize_exec_arg}, - 0, 0, RUBY_TYPED_FREE_IMMEDIATELY + 0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_EMBEDDABLE }; #ifdef _WIN32 @@ -1394,20 +1781,19 @@ proc_spawn_cmd_internal(char **argv, char *prog) rb_pid_t status; if (!prog) - prog = argv[0]; - security(prog); + prog = argv[0]; prog = dln_find_exe_r(prog, 0, fbuf, sizeof(fbuf)); if (!prog) - return -1; + return -1; before_exec(); status = spawnv(P_NOWAIT, prog, (const char **)argv); if (status == -1 && errno == ENOEXEC) { - *argv = (char *)prog; - *--argv = (char *)"sh"; - status = spawnv(P_NOWAIT, "/bin/sh", (const char **)argv); - after_exec(); - if (status == -1) errno = ENOEXEC; + *argv = (char *)prog; + *--argv = (char *)"sh"; + status = spawnv(P_NOWAIT, "/bin/sh", (const char **)argv); + after_exec(); + if (status == -1) errno = ENOEXEC; } return status; } @@ -1420,13 +1806,13 @@ proc_spawn_cmd(char **argv, VALUE prog, struct rb_execarg *eargp) if (argv[0]) { #if defined(_WIN32) - DWORD flags = 0; - if (eargp->new_pgroup_given && eargp->new_pgroup_flag) { - flags = CREATE_NEW_PROCESS_GROUP; - } - pid = rb_w32_uaspawn_flags(P_NOWAIT, prog ? RSTRING_PTR(prog) : 0, argv, flags); + DWORD flags = 0; + if (eargp->new_pgroup_given && eargp->new_pgroup_flag) { + flags = CREATE_NEW_PROCESS_GROUP; + } + pid = rb_w32_uaspawn_flags(P_NOWAIT, prog ? RSTRING_PTR(prog) : 0, argv, flags); #else - pid = proc_spawn_cmd_internal(argv, prog ? RSTRING_PTR(prog) : 0); + pid = proc_spawn_cmd_internal(argv, prog ? RSTRING_PTR(prog) : 0); #endif } return pid; @@ -1476,7 +1862,7 @@ check_exec_redirect_fd(VALUE v, int iskey) else goto wrong; } - else if (!NIL_P(tmp = rb_check_convert_type(v, T_FILE, "IO", "to_io"))) { + else if (!NIL_P(tmp = rb_io_check_io(v))) { rb_io_t *fptr; GetOpenFile(tmp, fptr); if (fptr->tied_io_for_writing) @@ -1484,8 +1870,7 @@ check_exec_redirect_fd(VALUE v, int iskey) fd = fptr->fd; } else { - wrong: - rb_raise(rb_eArgError, "wrong exec redirect"); + goto wrong; } if (fd < 0) { rb_raise(rb_eArgError, "negative file descriptor"); @@ -1496,6 +1881,10 @@ check_exec_redirect_fd(VALUE v, int iskey) } #endif return INT2FIX(fd); + + wrong: + rb_raise(rb_eArgError, "wrong exec redirect"); + UNREACHABLE_RETURN(Qundef); } static VALUE @@ -1509,12 +1898,11 @@ check_exec_redirect1(VALUE ary, VALUE key, VALUE param) rb_ary_push(ary, hide_obj(rb_assoc_new(fd, param))); } else { - int i, n=0; + int i; for (i = 0 ; i < RARRAY_LEN(key); i++) { VALUE v = RARRAY_AREF(key, i); VALUE fd = check_exec_redirect_fd(v, !NIL_P(param)); rb_ary_push(ary, hide_obj(rb_assoc_new(fd, param))); - n++; } } return ary; @@ -1530,7 +1918,7 @@ check_exec_redirect(VALUE key, VALUE val, struct rb_execarg *eargp) switch (TYPE(val)) { case T_SYMBOL: - if (!(id = rb_check_id(&val))) goto wrong_symbol; + id = rb_check_id(&val); if (id == id_close) { param = Qnil; eargp->fd_close = check_exec_redirect1(eargp->fd_close, key, param); @@ -1548,7 +1936,6 @@ check_exec_redirect(VALUE key, VALUE val, struct rb_execarg *eargp) eargp->fd_dup2 = check_exec_redirect1(eargp->fd_dup2, key, param); } else { - wrong_symbol: rb_raise(rb_eArgError, "wrong exec redirect symbol: %"PRIsVALUE, val); } @@ -1595,18 +1982,18 @@ check_exec_redirect(VALUE key, VALUE val, struct rb_execarg *eargp) if (FIXNUM_P(key) && (FIX2INT(key) == 1 || FIX2INT(key) == 2)) flags = INT2NUM(O_WRONLY|O_CREAT|O_TRUNC); else if (RB_TYPE_P(key, T_ARRAY)) { - int i; - for (i = 0; i < RARRAY_LEN(key); i++) { - VALUE v = RARRAY_PTR(key)[i]; - VALUE fd = check_exec_redirect_fd(v, 1); - if (FIX2INT(fd) != 1 && FIX2INT(fd) != 2) break; - } - if (i == RARRAY_LEN(key)) - flags = INT2NUM(O_WRONLY|O_CREAT|O_TRUNC); - else - flags = INT2NUM(O_RDONLY); - } - else + int i; + for (i = 0; i < RARRAY_LEN(key); i++) { + VALUE v = RARRAY_AREF(key, i); + VALUE fd = check_exec_redirect_fd(v, 1); + if (FIX2INT(fd) != 1 && FIX2INT(fd) != 2) break; + } + if (i == RARRAY_LEN(key)) + flags = INT2NUM(O_WRONLY|O_CREAT|O_TRUNC); + else + flags = INT2NUM(O_RDONLY); + } + else flags = INT2NUM(O_RDONLY); perm = INT2FIX(0644); param = hide_obj(rb_ary_new3(4, hide_obj(EXPORT_DUP(path)), @@ -1615,30 +2002,66 @@ check_exec_redirect(VALUE key, VALUE val, struct rb_execarg *eargp) break; default: - tmp = val; - val = rb_io_check_io(tmp); - if (!NIL_P(val)) goto io; + tmp = val; + val = rb_io_check_io(tmp); + if (!NIL_P(val)) goto io; rb_raise(rb_eArgError, "wrong exec redirect action"); } } #if defined(HAVE_SETRLIMIT) && defined(NUM2RLIM) -static int rlimit_type_by_lname(const char *name); +static int rlimit_type_by_sym(VALUE key); + +static void +rb_execarg_addopt_rlimit(struct rb_execarg *eargp, int rtype, VALUE val) +{ + VALUE ary = eargp->rlimit_limits; + VALUE tmp, softlim, hardlim; + if (eargp->rlimit_limits == Qfalse) + ary = eargp->rlimit_limits = hide_obj(rb_ary_new()); + else + ary = eargp->rlimit_limits; + tmp = rb_check_array_type(val); + if (!NIL_P(tmp)) { + if (RARRAY_LEN(tmp) == 1) + softlim = hardlim = rb_to_int(rb_ary_entry(tmp, 0)); + else if (RARRAY_LEN(tmp) == 2) { + softlim = rb_to_int(rb_ary_entry(tmp, 0)); + hardlim = rb_to_int(rb_ary_entry(tmp, 1)); + } + else { + rb_raise(rb_eArgError, "wrong exec rlimit option"); + } + } + else { + softlim = hardlim = rb_to_int(val); + } + tmp = hide_obj(rb_ary_new3(3, INT2NUM(rtype), softlim, hardlim)); + rb_ary_push(ary, tmp); +} #endif +#define TO_BOOL(val, name) (NIL_P(val) ? 0 : rb_bool_expected((val), name, TRUE)) int rb_execarg_addopt(VALUE execarg_obj, VALUE key, VALUE val) { struct rb_execarg *eargp = rb_execarg_get(execarg_obj); ID id; -#if defined(HAVE_SETRLIMIT) && defined(NUM2RLIM) - int rtype; -#endif switch (TYPE(key)) { case T_SYMBOL: +#if defined(HAVE_SETRLIMIT) && defined(NUM2RLIM) + { + int rtype = rlimit_type_by_sym(key); + if (rtype != -1) { + rb_execarg_addopt_rlimit(eargp, rtype, val); + RB_GC_GUARD(execarg_obj); + return ST_CONTINUE; + } + } +#endif if (!(id = rb_check_id(&key))) return ST_STOP; #ifdef HAVE_SETPGID if (id == id_pgroup) { @@ -1667,36 +2090,7 @@ rb_execarg_addopt(VALUE execarg_obj, VALUE key, VALUE val) rb_raise(rb_eArgError, "new_pgroup option specified twice"); } eargp->new_pgroup_given = 1; - eargp->new_pgroup_flag = RTEST(val) ? 1 : 0; - } - else -#endif -#if defined(HAVE_SETRLIMIT) && defined(NUM2RLIM) - if (strncmp("rlimit_", rb_id2name(id), 7) == 0 && - (rtype = rlimit_type_by_lname(rb_id2name(id)+7)) != -1) { - VALUE ary = eargp->rlimit_limits; - VALUE tmp, softlim, hardlim; - if (eargp->rlimit_limits == Qfalse) - ary = eargp->rlimit_limits = hide_obj(rb_ary_new()); - else - ary = eargp->rlimit_limits; - tmp = rb_check_array_type(val); - if (!NIL_P(tmp)) { - if (RARRAY_LEN(tmp) == 1) - softlim = hardlim = rb_to_int(rb_ary_entry(tmp, 0)); - else if (RARRAY_LEN(tmp) == 2) { - softlim = rb_to_int(rb_ary_entry(tmp, 0)); - hardlim = rb_to_int(rb_ary_entry(tmp, 1)); - } - else { - rb_raise(rb_eArgError, "wrong exec rlimit option"); - } - } - else { - softlim = hardlim = rb_to_int(val); - } - tmp = hide_obj(rb_ary_new3(3, INT2NUM(rtype), softlim, hardlim)); - rb_ary_push(ary, tmp); + eargp->new_pgroup_flag = TO_BOOL(val, "new_pgroup"); } else #endif @@ -1705,18 +2099,19 @@ rb_execarg_addopt(VALUE execarg_obj, VALUE key, VALUE val) rb_raise(rb_eArgError, "unsetenv_others option specified twice"); } eargp->unsetenv_others_given = 1; - eargp->unsetenv_others_do = RTEST(val) ? 1 : 0; + eargp->unsetenv_others_do = TO_BOOL(val, "unsetenv_others"); } else if (id == id_chdir) { if (eargp->chdir_given) { rb_raise(rb_eArgError, "chdir option specified twice"); } FilePathValue(val); + val = rb_str_encode_ospath(val); eargp->chdir_given = 1; eargp->chdir_dir = hide_obj(EXPORT_DUP(val)); } else if (id == id_umask) { - mode_t cmask = NUM2MODET(val); + mode_t cmask = NUM2MODET(val); if (eargp->umask_given) { rb_raise(rb_eArgError, "umask option specified twice"); } @@ -1728,7 +2123,7 @@ rb_execarg_addopt(VALUE execarg_obj, VALUE key, VALUE val) rb_raise(rb_eArgError, "close_others option specified twice"); } eargp->close_others_given = 1; - eargp->close_others_do = RTEST(val) ? 1 : 0; + eargp->close_others_do = TO_BOOL(val, "close_others"); } else if (id == id_in) { key = INT2FIX(0); @@ -1742,38 +2137,45 @@ rb_execarg_addopt(VALUE execarg_obj, VALUE key, VALUE val) key = INT2FIX(2); goto redirect; } - else if (id == id_uid) { + else if (id == id_uid) { #ifdef HAVE_SETUID - if (eargp->uid_given) { - rb_raise(rb_eArgError, "uid option specified twice"); - } - check_uid_switch(); - { - eargp->uid = OBJ2UID(val); - eargp->uid_given = 1; - } + if (eargp->uid_given) { + rb_raise(rb_eArgError, "uid option specified twice"); + } + check_uid_switch(); + { + eargp->uid = OBJ2UID(val); + eargp->uid_given = 1; + } #else - rb_raise(rb_eNotImpError, - "uid option is unimplemented on this machine"); + rb_raise(rb_eNotImpError, + "uid option is unimplemented on this machine"); #endif - } - else if (id == id_gid) { + } + else if (id == id_gid) { #ifdef HAVE_SETGID - if (eargp->gid_given) { - rb_raise(rb_eArgError, "gid option specified twice"); - } - check_gid_switch(); - { - eargp->gid = OBJ2GID(val); - eargp->gid_given = 1; - } + if (eargp->gid_given) { + rb_raise(rb_eArgError, "gid option specified twice"); + } + check_gid_switch(); + { + eargp->gid = OBJ2GID(val); + eargp->gid_given = 1; + } #else - rb_raise(rb_eNotImpError, - "gid option is unimplemented on this machine"); + rb_raise(rb_eNotImpError, + "gid option is unimplemented on this machine"); #endif - } + } + else if (id == id_exception) { + if (eargp->exception_given) { + rb_raise(rb_eArgError, "exception option specified twice"); + } + eargp->exception_given = 1; + eargp->exception = TO_BOOL(val, "exception"); + } else { - return ST_STOP; + return ST_STOP; } break; @@ -1785,7 +2187,7 @@ redirect: break; default: - return ST_STOP; + return ST_STOP; } RB_GC_GUARD(execarg_obj); @@ -1799,10 +2201,10 @@ check_exec_options_i(st_data_t st_key, st_data_t st_val, st_data_t arg) VALUE val = (VALUE)st_val; VALUE execarg_obj = (VALUE)arg; if (rb_execarg_addopt(execarg_obj, key, val) != ST_CONTINUE) { - if (SYMBOL_P(key)) - rb_raise(rb_eArgError, "wrong exec option symbol: %"PRIsVALUE, - key); - rb_raise(rb_eArgError, "wrong exec option"); + if (SYMBOL_P(key)) + rb_raise(rb_eArgError, "wrong exec option symbol: % "PRIsVALUE, + key); + rb_raise(rb_eArgError, "wrong exec option"); } return ST_CONTINUE; } @@ -1815,9 +2217,9 @@ check_exec_options_i_extract(st_data_t st_key, st_data_t st_val, st_data_t arg) VALUE *args = (VALUE *)arg; VALUE execarg_obj = args[0]; if (rb_execarg_addopt(execarg_obj, key, val) != ST_CONTINUE) { - VALUE nonopts = args[1]; - if (NIL_P(nonopts)) args[1] = nonopts = rb_hash_new(); - rb_hash_aset(nonopts, key, val); + VALUE nonopts = args[1]; + if (NIL_P(nonopts)) args[1] = nonopts = rb_hash_new(); + rb_hash_aset(nonopts, key, val); } return ST_CONTINUE; } @@ -1904,7 +2306,7 @@ rb_check_exec_options(VALUE opthash, VALUE execarg_obj) { if (RHASH_EMPTY_P(opthash)) return; - st_foreach(rb_hash_tbl_raw(opthash), check_exec_options_i, (st_data_t)execarg_obj); + rb_hash_stlike_foreach(opthash, check_exec_options_i, (st_data_t)execarg_obj); } VALUE @@ -1915,21 +2317,28 @@ rb_execarg_extract_options(VALUE execarg_obj, VALUE opthash) return Qnil; args[0] = execarg_obj; args[1] = Qnil; - st_foreach(rb_hash_tbl_raw(opthash), check_exec_options_i_extract, (st_data_t)args); + rb_hash_stlike_foreach(opthash, check_exec_options_i_extract, (st_data_t)args); return args[1]; } +#ifdef ENV_IGNORECASE +#define ENVMATCH(s1, s2) (STRCASECMP((s1), (s2)) == 0) +#else +#define ENVMATCH(n1, n2) (strcmp((n1), (n2)) == 0) +#endif + static int check_exec_env_i(st_data_t st_key, st_data_t st_val, st_data_t arg) { VALUE key = (VALUE)st_key; VALUE val = (VALUE)st_val; - VALUE env = (VALUE)arg; + VALUE env = ((VALUE *)arg)[0]; + VALUE *path = &((VALUE *)arg)[1]; char *k; k = StringValueCStr(key); if (strchr(k, '=')) - rb_raise(rb_eArgError, "environment name contains a equal : %s", k); + rb_raise(rb_eArgError, "environment name contains a equal : %"PRIsVALUE, key); if (!NIL_P(val)) StringValueCStr(val); @@ -1937,20 +2346,25 @@ check_exec_env_i(st_data_t st_key, st_data_t st_val, st_data_t arg) key = EXPORT_STR(key); if (!NIL_P(val)) val = EXPORT_STR(val); + if (ENVMATCH(k, PATH_ENV)) { + *path = val; + } rb_ary_push(env, hide_obj(rb_assoc_new(key, val))); return ST_CONTINUE; } static VALUE -rb_check_exec_env(VALUE hash) +rb_check_exec_env(VALUE hash, VALUE *path) { - VALUE env; + VALUE env[2]; - env = hide_obj(rb_ary_new()); - st_foreach(rb_hash_tbl_raw(hash), check_exec_env_i, (st_data_t)env); + env[0] = hide_obj(rb_ary_new()); + env[1] = Qfalse; + rb_hash_stlike_foreach(hash, check_exec_env_i, (st_data_t)env); + *path = env[1]; - return env; + return env[0]; } static VALUE @@ -1958,39 +2372,50 @@ rb_check_argv(int argc, VALUE *argv) { VALUE tmp, prog; int i; - const char *name = 0; rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS); prog = 0; tmp = rb_check_array_type(argv[0]); if (!NIL_P(tmp)) { - if (RARRAY_LEN(tmp) != 2) { - rb_raise(rb_eArgError, "wrong first argument"); - } - prog = RARRAY_AREF(tmp, 0); - argv[0] = RARRAY_AREF(tmp, 1); - SafeStringValue(prog); - StringValueCStr(prog); - prog = rb_str_new_frozen(prog); - name = RSTRING_PTR(prog); + if (RARRAY_LEN(tmp) != 2) { + rb_raise(rb_eArgError, "wrong first argument"); + } + prog = RARRAY_AREF(tmp, 0); + argv[0] = RARRAY_AREF(tmp, 1); + StringValue(prog); + StringValueCStr(prog); + prog = rb_str_new_frozen(prog); } for (i = 0; i < argc; i++) { - SafeStringValue(argv[i]); - argv[i] = rb_str_new_frozen(argv[i]); - StringValueCStr(argv[i]); + StringValue(argv[i]); + argv[i] = rb_str_new_frozen(argv[i]); + StringValueCStr(argv[i]); } - security(name ? name : RSTRING_PTR(argv[0])); return prog; } static VALUE +check_hash(VALUE obj) +{ + if (RB_SPECIAL_CONST_P(obj)) return Qnil; + switch (RB_BUILTIN_TYPE(obj)) { + case T_STRING: + case T_ARRAY: + return Qnil; + default: + break; + } + return rb_check_hash_type(obj); +} + +static VALUE rb_exec_getargs(int *argc_p, VALUE **argv_p, int accept_shell, VALUE *env_ret, VALUE *opthash_ret) { VALUE hash, prog; if (0 < *argc_p) { - hash = rb_check_hash_type((*argv_p)[*argc_p-1]); + hash = check_hash((*argv_p)[*argc_p-1]); if (!NIL_P(hash)) { *opthash_ret = hash; (*argc_p)--; @@ -1998,7 +2423,7 @@ rb_exec_getargs(int *argc_p, VALUE **argv_p, int accept_shell, VALUE *env_ret, V } if (0 < *argc_p) { - hash = rb_check_hash_type((*argv_p)[0]); + hash = check_hash((*argv_p)[0]); if (!NIL_P(hash)) { *env_ret = hash; (*argc_p)--; @@ -2044,7 +2469,7 @@ rb_exec_fillarg(VALUE prog, int argc, VALUE *argv, VALUE env, VALUE opthash, VAL rb_check_exec_options(opthash, execarg_obj); } if (!NIL_P(env)) { - env = rb_check_exec_env(env); + env = rb_check_exec_env(env, &eargp->path_env); eargp->env_modification = env; } @@ -2057,39 +2482,39 @@ rb_exec_fillarg(VALUE prog, int argc, VALUE *argv, VALUE env, VALUE opthash, VAL #ifndef _WIN32 if (eargp->use_shell) { - static const char posix_sh_cmds[][9] = { - "!", /* reserved */ - ".", /* special built-in */ - ":", /* special built-in */ - "break", /* special built-in */ - "case", /* reserved */ - "continue", /* special built-in */ - "do", /* reserved */ - "done", /* reserved */ - "elif", /* reserved */ - "else", /* reserved */ - "esac", /* reserved */ - "eval", /* special built-in */ - "exec", /* special built-in */ - "exit", /* special built-in */ - "export", /* special built-in */ - "fi", /* reserved */ - "for", /* reserved */ - "if", /* reserved */ - "in", /* reserved */ - "readonly", /* special built-in */ - "return", /* special built-in */ - "set", /* special built-in */ - "shift", /* special built-in */ - "then", /* reserved */ - "times", /* special built-in */ - "trap", /* special built-in */ - "unset", /* special built-in */ - "until", /* reserved */ - "while", /* reserved */ - }; - const char *p; - struct string_part first = {0, 0}; + static const char posix_sh_cmds[][9] = { + "!", /* reserved */ + ".", /* special built-in */ + ":", /* special built-in */ + "break", /* special built-in */ + "case", /* reserved */ + "continue", /* special built-in */ + "do", /* reserved */ + "done", /* reserved */ + "elif", /* reserved */ + "else", /* reserved */ + "esac", /* reserved */ + "eval", /* special built-in */ + "exec", /* special built-in */ + "exit", /* special built-in */ + "export", /* special built-in */ + "fi", /* reserved */ + "for", /* reserved */ + "if", /* reserved */ + "in", /* reserved */ + "readonly", /* special built-in */ + "return", /* special built-in */ + "set", /* special built-in */ + "shift", /* special built-in */ + "then", /* reserved */ + "times", /* special built-in */ + "trap", /* special built-in */ + "unset", /* special built-in */ + "until", /* reserved */ + "while", /* reserved */ + }; + const char *p; + struct string_part first = {0, 0}; int has_meta = 0; /* * meta characters: @@ -2116,32 +2541,32 @@ rb_exec_fillarg(VALUE prog, int argc, VALUE *argv, VALUE env, VALUE opthash, VAL * % (used in Parameter Expansion) */ for (p = RSTRING_PTR(prog); *p; p++) { - if (*p == ' ' || *p == '\t') { - if (first.ptr && !first.len) first.len = p - first.ptr; - } - else { - if (!first.ptr) first.ptr = p; - } + if (*p == ' ' || *p == '\t') { + if (first.ptr && !first.len) first.len = p - first.ptr; + } + else { + if (!first.ptr) first.ptr = p; + } if (!has_meta && strchr("*?{}[]<>()~&|\\$;'`\"\n#", *p)) has_meta = 1; - if (!first.len) { - if (*p == '=') { - has_meta = 1; - } - else if (*p == '/') { - first.len = 0x100; /* longer than any posix_sh_cmds */ - } - } - if (has_meta) + if (!first.len) { + if (*p == '=') { + has_meta = 1; + } + else if (*p == '/') { + first.len = 0x100; /* longer than any posix_sh_cmds */ + } + } + if (has_meta) break; } - if (!has_meta && first.ptr) { - if (!first.len) first.len = p - first.ptr; - if (first.len > 0 && first.len <= sizeof(posix_sh_cmds[0]) && - bsearch(&first, posix_sh_cmds, numberof(posix_sh_cmds), sizeof(posix_sh_cmds[0]), compare_posix_sh)) - has_meta = 1; - } - if (!has_meta) { + if (!has_meta && first.ptr) { + if (!first.len) first.len = p - first.ptr; + if (first.len > 0 && first.len <= sizeof(posix_sh_cmds[0]) && + bsearch(&first, posix_sh_cmds, numberof(posix_sh_cmds), sizeof(posix_sh_cmds[0]), compare_posix_sh)) + has_meta = 1; + } + if (!has_meta) { /* avoid shell since no shell meta character found. */ eargp->use_shell = 0; } @@ -2153,7 +2578,7 @@ rb_exec_fillarg(VALUE prog, int argc, VALUE *argv, VALUE env, VALUE opthash, VAL while (*p == ' ' || *p == '\t') p++; if (*p) { - const char *w = p; + const char *w = p; while (*p && *p != ' ' && *p != '\t') p++; rb_str_buf_cat(argv_buf, w, p-w); @@ -2161,18 +2586,23 @@ rb_exec_fillarg(VALUE prog, int argc, VALUE *argv, VALUE env, VALUE opthash, VAL } } eargp->invoke.cmd.argv_buf = argv_buf; - eargp->invoke.cmd.command_name = hide_obj(rb_str_new_cstr(RSTRING_PTR(argv_buf))); + eargp->invoke.cmd.command_name = + hide_obj(rb_str_subseq(argv_buf, 0, strlen(RSTRING_PTR(argv_buf)))); + rb_enc_copy(eargp->invoke.cmd.command_name, prog); } } #endif if (!eargp->use_shell) { - const char *abspath; - abspath = dln_find_exe_r(RSTRING_PTR(eargp->invoke.cmd.command_name), 0, fbuf, sizeof(fbuf)); - if (abspath) - eargp->invoke.cmd.command_abspath = rb_str_new_cstr(abspath); - else - eargp->invoke.cmd.command_abspath = Qnil; + const char *abspath; + const char *path_env = 0; + if (RTEST(eargp->path_env)) path_env = RSTRING_PTR(eargp->path_env); + abspath = dln_find_exe_r(RSTRING_PTR(eargp->invoke.cmd.command_name), + path_env, fbuf, sizeof(fbuf)); + if (abspath) + eargp->invoke.cmd.command_abspath = rb_str_new_cstr(abspath); + else + eargp->invoke.cmd.command_abspath = Qnil; } if (!eargp->use_shell && !eargp->invoke.cmd.argv_buf) { @@ -2181,13 +2611,13 @@ rb_exec_fillarg(VALUE prog, int argc, VALUE *argv, VALUE env, VALUE opthash, VAL argv_buf = rb_str_buf_new(0); hide_obj(argv_buf); for (i = 0; i < argc; i++) { - VALUE arg = argv[i]; - const char *s = StringValueCStr(arg); + VALUE arg = argv[i]; + const char *s = StringValueCStr(arg); #ifdef DEFAULT_PROCESS_ENCODING - arg = EXPORT_STR(arg); - s = RSTRING_PTR(arg); + arg = EXPORT_STR(arg); + s = RSTRING_PTR(arg); #endif - rb_str_buf_cat(argv_buf, s, RSTRING_LEN(arg) + 1); /* include '\0' */ + rb_str_buf_cat(argv_buf, s, RSTRING_LEN(arg) + 1); /* include '\0' */ } eargp->invoke.cmd.argv_buf = argv_buf; } @@ -2204,22 +2634,12 @@ rb_exec_fillarg(VALUE prog, int argc, VALUE *argv, VALUE env, VALUE opthash, VAL p += strlen(p) + 1; } rb_str_buf_cat(argv_str, (char *)&null, sizeof(null)); /* terminator for execve. */ - eargp->invoke.cmd.argv_str = argv_str; + eargp->invoke.cmd.argv_str = + rb_imemo_tmpbuf_new_from_an_RString(argv_str); } RB_GC_GUARD(execarg_obj); } -VALUE -rb_execarg_new(int argc, const VALUE *argv, int accept_shell) -{ - VALUE execarg_obj; - struct rb_execarg *eargp; - execarg_obj = TypedData_Make_Struct(rb_cData, struct rb_execarg, &exec_arg_data_type, eargp); - hide_obj(execarg_obj); - rb_execarg_init(argc, argv, accept_shell, execarg_obj); - return execarg_obj; -} - struct rb_execarg * rb_execarg_get(VALUE execarg_obj) { @@ -2228,7 +2648,7 @@ rb_execarg_get(VALUE execarg_obj) return eargp; } -VALUE +static VALUE rb_execarg_init(int argc, const VALUE *orig_argv, int accept_shell, VALUE execarg_obj) { struct rb_execarg *eargp = rb_execarg_get(execarg_obj); @@ -2245,12 +2665,26 @@ rb_execarg_init(int argc, const VALUE *orig_argv, int accept_shell, VALUE execar return ret; } +VALUE +rb_execarg_new(int argc, const VALUE *argv, int accept_shell, int allow_exc_opt) +{ + VALUE execarg_obj; + struct rb_execarg *eargp; + execarg_obj = TypedData_Make_Struct(0, struct rb_execarg, &exec_arg_data_type, eargp); + rb_execarg_init(argc, argv, accept_shell, execarg_obj); + if (!allow_exc_opt && eargp->exception_given) { + rb_raise(rb_eArgError, "exception option is not allowed"); + } + return execarg_obj; +} + void rb_execarg_setenv(VALUE execarg_obj, VALUE env) { struct rb_execarg *eargp = rb_execarg_get(execarg_obj); - env = !NIL_P(env) ? rb_check_exec_env(env) : Qfalse; + env = !NIL_P(env) ? rb_check_exec_env(env, &eargp->path_env) : Qfalse; eargp->env_modification = env; + RB_GC_GUARD(execarg_obj); } static int @@ -2289,6 +2723,14 @@ open_func(void *ptr) return NULL; } +static void +rb_execarg_allocate_dup2_tmpbuf(struct rb_execarg *eargp, long len) +{ + VALUE tmpbuf = rb_imemo_tmpbuf_new(); + rb_imemo_tmpbuf_set_ptr(tmpbuf, ruby_xmalloc(run_exec_dup2_tmpbuf_size(len))); + eargp->dup2_tmpbuf = tmpbuf; +} + static VALUE rb_execarg_parent_start1(VALUE execarg_obj) { @@ -2306,12 +2748,11 @@ rb_execarg_parent_start1(VALUE execarg_obj) VALUE param = RARRAY_AREF(elt, 1); VALUE vpath = RARRAY_AREF(param, 0); int flags = NUM2INT(RARRAY_AREF(param, 1)); - int perm = NUM2INT(RARRAY_AREF(param, 2)); + mode_t perm = NUM2MODET(RARRAY_AREF(param, 2)); VALUE fd2v = RARRAY_AREF(param, 3); int fd2; if (NIL_P(fd2v)) { struct open_struct open_data; - FilePathValue(vpath); again: open_data.fname = vpath; open_data.oflags = flags; @@ -2342,10 +2783,7 @@ rb_execarg_parent_start1(VALUE execarg_obj) ary = eargp->fd_dup2; if (ary != Qfalse) { - size_t len = run_exec_dup2_tmpbuf_size(RARRAY_LEN(ary)); - VALUE tmpbuf = hide_obj(rb_str_new(0, len)); - rb_str_set_len(tmpbuf, len); - eargp->dup2_tmpbuf = tmpbuf; + rb_execarg_allocate_dup2_tmpbuf(eargp, RARRAY_LEN(ary)); } unsetenv_others = eargp->unsetenv_others_given && eargp->unsetenv_others_do; @@ -2357,31 +2795,30 @@ rb_execarg_parent_start1(VALUE execarg_obj) envtbl = rb_hash_new(); } else { - envtbl = rb_const_get(rb_cObject, id_ENV); - envtbl = rb_convert_type(envtbl, T_HASH, "Hash", "to_hash"); + envtbl = rb_env_to_hash(); } hide_obj(envtbl); if (envopts != Qfalse) { - st_table *stenv = RHASH_TBL_RAW(envtbl); + st_table *stenv = RHASH_TBL_RAW(envtbl); long i; for (i = 0; i < RARRAY_LEN(envopts); i++) { VALUE pair = RARRAY_AREF(envopts, i); VALUE key = RARRAY_AREF(pair, 0); VALUE val = RARRAY_AREF(pair, 1); if (NIL_P(val)) { - st_data_t stkey = (st_data_t)key; - st_delete(stenv, &stkey, NULL); + st_data_t stkey = (st_data_t)key; + st_delete(stenv, &stkey, NULL); } else { - st_insert(stenv, (st_data_t)key, (st_data_t)val); - RB_OBJ_WRITTEN(envtbl, Qundef, key); - RB_OBJ_WRITTEN(envtbl, Qundef, val); + st_insert(stenv, (st_data_t)key, (st_data_t)val); + RB_OBJ_WRITTEN(envtbl, Qundef, key); + RB_OBJ_WRITTEN(envtbl, Qundef, val); } } } envp_buf = rb_str_buf_new(0); hide_obj(envp_buf); - st_foreach(RHASH_TBL_RAW(envtbl), fill_envp_buf_i, (st_data_t)envp_buf); + rb_hash_stlike_foreach(envtbl, fill_envp_buf_i, (st_data_t)envp_buf); envp_str = rb_str_buf_new(sizeof(char*) * (RHASH_SIZE(envtbl) + 1)); hide_obj(envp_str); p = RSTRING_PTR(envp_buf); @@ -2392,7 +2829,8 @@ rb_execarg_parent_start1(VALUE execarg_obj) } p = NULL; rb_str_buf_cat(envp_str, (char *)&p, sizeof(p)); - eargp->envp_str = envp_str; + eargp->envp_str = + rb_imemo_tmpbuf_new_from_an_RString(envp_str); eargp->envp_buf = envp_buf; /* @@ -2444,6 +2882,7 @@ execarg_parent_end(VALUE execarg_obj) } errno = err; + RB_GC_GUARD(execarg_obj); return execarg_obj; } @@ -2459,7 +2898,7 @@ rb_exec_fail(struct rb_execarg *eargp, int err, const char *errmsg) { if (!errmsg || !*errmsg) return; if (strcmp(errmsg, "chdir") == 0) { - rb_sys_fail_str(eargp->chdir_dir); + rb_sys_fail_str(eargp->chdir_dir); } rb_sys_fail(errmsg); } @@ -2474,108 +2913,142 @@ rb_execarg_fail(VALUE execarg_obj, int err, const char *errmsg) } #endif +VALUE +rb_f_exec(int argc, const VALUE *argv) +{ + VALUE execarg_obj, fail_str; + struct rb_execarg *eargp; +#define CHILD_ERRMSG_BUFLEN 80 + char errmsg[CHILD_ERRMSG_BUFLEN] = { '\0' }; + int err, state; + + execarg_obj = rb_execarg_new(argc, argv, TRUE, FALSE); + eargp = rb_execarg_get(execarg_obj); + before_exec(); /* stop timer thread before redirects */ + + rb_protect(rb_execarg_parent_start1, execarg_obj, &state); + if (state) { + execarg_parent_end(execarg_obj); + after_exec(); /* restart timer thread */ + rb_jump_tag(state); + } + + fail_str = eargp->use_shell ? eargp->invoke.sh.shell_script : eargp->invoke.cmd.command_name; + + err = exec_async_signal_safe(eargp, errmsg, sizeof(errmsg)); + after_exec(); /* restart timer thread */ + + rb_exec_fail(eargp, err, errmsg); + RB_GC_GUARD(execarg_obj); + rb_syserr_fail_str(err, fail_str); + UNREACHABLE_RETURN(Qnil); +} + +NORETURN(static VALUE f_exec(int c, const VALUE *a, VALUE _)); + /* * call-seq: - * exec([env,] command... [,options]) + * exec([env, ] command_line, options = {}) + * exec([env, ] exe_path, *args, options = {}) + * + * Replaces the current process by doing one of the following: + * + * - Passing string +command_line+ to the shell. + * - Invoking the executable at +exe_path+. + * + * This method has potential security vulnerabilities if called with untrusted input; + * see {Command Injection}[rdoc-ref:security/command_injection.rdoc]. + * + * The new process is created using the + * {exec system call}[https://pubs.opengroup.org/onlinepubs/9699919799.2018edition/functions/execve.html]; + * it may inherit some of its environment from the calling program + * (possibly including open file descriptors). * - * Replaces the current process by running the given external _command_, which - * can take one of the following forms: + * Argument +env+, if given, is a hash that affects +ENV+ for the new process; + * see {Execution Environment}[rdoc-ref:Process@Execution+Environment]. * - * [<code>exec(commandline)</code>] - * command line string which is passed to the standard shell - * [<code>exec(cmdname, arg1, ...)</code>] - * command name and one or more arguments (no shell) - * [<code>exec([cmdname, argv0], arg1, ...)</code>] - * command name, argv[0] and zero or more arguments (no shell) + * Argument +options+ is a hash of options for the new process; + * see {Execution Options}[rdoc-ref:Process@Execution+Options]. * - * In the first form, the string is taken as a command line that is subject to - * shell expansion before being executed. + * The first required argument is one of the following: * - * The standard shell always means <code>"/bin/sh"</code> on Unix-like systems, - * same as <code>ENV["RUBYSHELL"]</code> - * (or <code>ENV["COMSPEC"]</code> on Windows NT series), and similar. + * - +command_line+ if it is a string, + * and if it begins with a shell reserved word or special built-in, + * or if it contains one or more meta characters. + * - +exe_path+ otherwise. * - * If the string from the first form (<code>exec("command")</code>) follows - * these simple rules: + * <b>Argument +command_line+</b> * - * * no meta characters - * * no shell reserved word and no special built-in - * * Ruby invokes the command directly without shell + * \String argument +command_line+ is a command line to be passed to a shell; + * it must begin with a shell reserved word, begin with a special built-in, + * or contain meta characters: * - * You can force shell invocation by adding ";" to the string (because ";" is - * a meta character). + * exec('if true; then echo "Foo"; fi') # Shell reserved word. + * exec('exit') # Built-in. + * exec('date > date.tmp') # Contains meta character. * - * Note that this behavior is observable by pid obtained - * (return value of spawn() and IO#pid for IO.popen) is the pid of the invoked - * command, not shell. + * The command line may also contain arguments and options for the command: * - * In the second form (<code>exec("command1", "arg1", ...)</code>), the first - * is taken as a command name and the rest are passed as parameters to command - * with no shell expansion. + * exec('echo "Foo"') * - * In the third form (<code>exec(["command", "argv0"], "arg1", ...)</code>), - * starting a two-element array at the beginning of the command, the first - * element is the command to be executed, and the second argument is used as - * the <code>argv[0]</code> value, which may show up in process listings. + * Output: * - * In order to execute the command, one of the <code>exec(2)</code> system - * calls are used, so the running command may inherit some of the environment - * of the original program (including open file descriptors). + * Foo * - * This behavior is modified by the given +env+ and +options+ parameters. See - * ::spawn for details. + * See {Execution Shell}[rdoc-ref:Process@Execution+Shell] for details about the shell. * - * If the command fails to execute (typically <code>Errno::ENOENT</code> when - * it was not found) a SystemCallError exception is raised. + * Raises an exception if the new process could not execute. * - * This method modifies process attributes according to given +options+ before - * <code>exec(2)</code> system call. See ::spawn for more details about the - * given +options+. + * <b>Argument +exe_path+</b> * - * The modified attributes may be retained when <code>exec(2)</code> system - * call fails. + * Argument +exe_path+ is one of the following: * - * For example, hard resource limits are not restorable. + * - The string path to an executable to be called. + * - A 2-element array containing the path to an executable + * and the string to be used as the name of the executing process. * - * Consider to create a child process using ::spawn or Kernel#system if this - * is not acceptable. + * Example: * - * exec "echo *" # echoes list of files in current directory - * # never get here + * exec('/usr/bin/date') * - * exec "echo", "*" # echoes an asterisk - * # never get here + * Output: + * + * Sat Aug 26 09:38:00 AM CDT 2023 + * + * Ruby invokes the executable directly. + * This form does not use the shell; + * see {Arguments args}[rdoc-ref:Process@Arguments+args] for caveats. + * + * exec('doesnt_exist') # Raises Errno::ENOENT + * + * If one or more +args+ is given, each is an argument or option + * to be passed to the executable: + * + * exec('echo', 'C*') + * exec('echo', 'hello', 'world') + * + * Output: + * + * C* + * hello world + * + * Raises an exception if the new process could not execute. */ -VALUE -rb_f_exec(int argc, const VALUE *argv) +static VALUE +f_exec(int c, const VALUE *a, VALUE _) { - VALUE execarg_obj, fail_str; - struct rb_execarg *eargp; -#define CHILD_ERRMSG_BUFLEN 80 - char errmsg[CHILD_ERRMSG_BUFLEN] = { '\0' }; - int err; - - execarg_obj = rb_execarg_new(argc, argv, TRUE); - eargp = rb_execarg_get(execarg_obj); - before_exec(); /* stop timer thread before redirects */ - rb_execarg_parent_start(execarg_obj); - fail_str = eargp->use_shell ? eargp->invoke.sh.shell_script : eargp->invoke.cmd.command_name; - - rb_exec_async_signal_safe(eargp, errmsg, sizeof(errmsg)); - - err = errno; - after_exec(); /* restart timer thread */ - - rb_exec_fail(eargp, err, errmsg); - RB_GC_GUARD(execarg_obj); - rb_syserr_fail_str(err, fail_str); - return Qnil; /* dummy */ + rb_f_exec(c, a); + UNREACHABLE_RETURN(Qnil); } -#define ERRMSG(str) do { if (errmsg && 0 < errmsg_buflen) strlcpy(errmsg, (str), errmsg_buflen); } while (0) -#define ERRMSG1(str, a) do { if (errmsg && 0 < errmsg_buflen) snprintf(errmsg, errmsg_buflen, (str), (a)); } while (0) -#define ERRMSG2(str, a, b) do { if (errmsg && 0 < errmsg_buflen) snprintf(errmsg, errmsg_buflen, (str), (a), (b)); } while (0) +#define ERRMSG(str) \ + ((errmsg && 0 < errmsg_buflen) ? \ + (void)strlcpy(errmsg, (str), errmsg_buflen) : (void)0) + +#define ERRMSG_FMT(...) \ + ((errmsg && 0 < errmsg_buflen) ? \ + (void)snprintf(errmsg, errmsg_buflen, __VA_ARGS__) : (void)0) static int fd_get_cloexec(int fd, char *errmsg, size_t errmsg_buflen); static int fd_set_cloexec(int fd, char *errmsg, size_t errmsg_buflen); @@ -2599,10 +3072,10 @@ save_redirect_fd(int fd, struct rb_execarg *sargp, char *errmsg, size_t errmsg_b newary = hide_obj(rb_ary_new()); sargp->fd_dup2 = newary; } - cloexec = fd_get_cloexec(fd, errmsg, errmsg_buflen); - redirection = hide_obj(rb_assoc_new(INT2FIX(fd), INT2FIX(save_fd))); - if (cloexec) rb_ary_push(redirection, Qtrue); - rb_ary_push(newary, redirection); + cloexec = fd_get_cloexec(fd, errmsg, errmsg_buflen); + redirection = hide_obj(rb_assoc_new(INT2FIX(fd), INT2FIX(save_fd))); + if (cloexec) rb_ary_push(redirection, Qtrue); + rb_ary_push(newary, redirection); newary = sargp->fd_close; if (newary == Qfalse) { @@ -2710,10 +3183,10 @@ run_exec_dup2(VALUE ary, VALUE tmpbuf, struct rb_execarg *sargp, char *errmsg, s long n, i; int ret; int extra_fd = -1; - struct run_exec_dup2_fd_pair *pairs = 0; + struct rb_imemo_tmpbuf_struct *buf = (void *)tmpbuf; + struct run_exec_dup2_fd_pair *pairs = (void *)buf->ptr; n = RARRAY_LEN(ary); - pairs = (struct run_exec_dup2_fd_pair *)RSTRING_PTR(tmpbuf); /* initialize oldfd and newfd: O(n) */ for (i = 0; i < n; i++) { @@ -2759,10 +3232,10 @@ run_exec_dup2(VALUE ary, VALUE tmpbuf, struct rb_execarg *sargp, char *errmsg, s ERRMSG("dup2"); goto fail; } - if (pairs[j].cloexec && - fd_set_cloexec(pairs[j].newfd, errmsg, errmsg_buflen)) { - goto fail; - } + if (pairs[j].cloexec && + fd_set_cloexec(pairs[j].newfd, errmsg, errmsg_buflen)) { + goto fail; + } rb_update_max_fd(pairs[j].newfd); /* async-signal-safe but don't need to call it in a child process. */ pairs[j].oldfd = -1; j = pairs[j].older_index; @@ -2788,6 +3261,14 @@ run_exec_dup2(VALUE ary, VALUE tmpbuf, struct rb_execarg *sargp, char *errmsg, s ERRMSG("dup"); goto fail; } + // without this, kqueue timer_th.event_fd fails with a reserved FD did not have close-on-exec + // in #assert_close_on_exec because the FD_CLOEXEC is not dup'd by default + if (fd_get_cloexec(pairs[i].oldfd, errmsg, errmsg_buflen)) { + if (fd_set_cloexec(extra_fd, errmsg, errmsg_buflen)) { + close(extra_fd); + goto fail; + } + } rb_update_max_fd(extra_fd); } else { @@ -2953,7 +3434,7 @@ save_env(struct rb_execarg *sargp) if (!sargp) return; if (sargp->env_modification == Qfalse) { - VALUE env = rb_const_get(rb_cObject, id_ENV); + VALUE env = rb_envtbl(); if (RTEST(env)) { VALUE ary = hide_obj(rb_ary_new()); rb_block_call(env, idEach, 0, 0, save_env_i, @@ -2966,6 +3447,11 @@ save_env(struct rb_execarg *sargp) } #endif +#ifdef _WIN32 +#undef chdir +#define chdir(p) rb_w32_uchdir(p) +#endif + /* This function should be async-signal-safe when sargp is NULL. Hopefully it is. */ int rb_execarg_run_options(const struct rb_execarg *eargp, struct rb_execarg *sargp, char *errmsg, size_t errmsg_buflen) @@ -3041,7 +3527,7 @@ rb_execarg_run_options(const struct rb_execarg *eargp, struct rb_execarg *sargp, } #ifdef HAVE_WORKING_FORK - if (!eargp->close_others_given || eargp->close_others_do) { + if (eargp->close_others_do) { rb_close_before_exec(3, eargp->close_others_maxhint, eargp->redirect_fds); /* async-signal-safe */ } #endif @@ -3054,10 +3540,8 @@ rb_execarg_run_options(const struct rb_execarg *eargp, struct rb_execarg *sargp, if (eargp->chdir_given) { if (sargp) { - char *cwd = my_getcwd(); sargp->chdir_given = 1; - sargp->chdir_dir = hide_obj(rb_str_new2(cwd)); - xfree(cwd); + sargp->chdir_dir = hide_obj(rb_dir_getwd_ospath()); } if (chdir(RSTRING_PTR(eargp->chdir_dir)) == -1) { /* async-signal-safe */ ERRMSG("chdir"); @@ -3067,30 +3551,32 @@ rb_execarg_run_options(const struct rb_execarg *eargp, struct rb_execarg *sargp, #ifdef HAVE_SETGID if (eargp->gid_given) { - if (setgid(eargp->gid) < 0) { - ERRMSG("setgid"); - return -1; - } + if (setgid(eargp->gid) < 0) { + ERRMSG("setgid"); + return -1; + } } #endif #ifdef HAVE_SETUID if (eargp->uid_given) { - if (setuid(eargp->uid) < 0) { - ERRMSG("setuid"); - return -1; - } + if (setuid(eargp->uid) < 0) { + ERRMSG("setuid"); + return -1; + } } #endif if (sargp) { VALUE ary = sargp->fd_dup2; if (ary != Qfalse) { - size_t len = run_exec_dup2_tmpbuf_size(RARRAY_LEN(ary)); - VALUE tmpbuf = hide_obj(rb_str_new(0, len)); - rb_str_set_len(tmpbuf, len); - sargp->dup2_tmpbuf = tmpbuf; + rb_execarg_allocate_dup2_tmpbuf(sargp, RARRAY_LEN(ary)); } } + { + int preserve = errno; + stdfd_clear_nonblock(); + errno = preserve; + } return 0; } @@ -3099,31 +3585,38 @@ rb_execarg_run_options(const struct rb_execarg *eargp, struct rb_execarg *sargp, int rb_exec_async_signal_safe(const struct rb_execarg *eargp, char *errmsg, size_t errmsg_buflen) { + errno = exec_async_signal_safe(eargp, errmsg, errmsg_buflen); + return -1; +} + +static int +exec_async_signal_safe(const struct rb_execarg *eargp, char *errmsg, size_t errmsg_buflen) +{ #if !defined(HAVE_WORKING_FORK) struct rb_execarg sarg, *const sargp = &sarg; #else struct rb_execarg *const sargp = NULL; #endif + int err; if (rb_execarg_run_options(eargp, sargp, errmsg, errmsg_buflen) < 0) { /* hopefully async-signal-safe */ - goto failure; + return errno; } if (eargp->use_shell) { - proc_exec_sh(RSTRING_PTR(eargp->invoke.sh.shell_script), eargp->envp_str); /* async-signal-safe */ + err = proc_exec_sh(RSTRING_PTR(eargp->invoke.sh.shell_script), eargp->envp_str); /* async-signal-safe */ } else { - char *abspath = NULL; - if (!NIL_P(eargp->invoke.cmd.command_abspath)) - abspath = RSTRING_PTR(eargp->invoke.cmd.command_abspath); - proc_exec_cmd(abspath, eargp->invoke.cmd.argv_str, eargp->envp_str); /* async-signal-safe */ + char *abspath = NULL; + if (!NIL_P(eargp->invoke.cmd.command_abspath)) + abspath = RSTRING_PTR(eargp->invoke.cmd.command_abspath); + err = proc_exec_cmd(abspath, eargp->invoke.cmd.argv_str, eargp->envp_str); /* async-signal-safe */ } #if !defined(HAVE_WORKING_FORK) - preserving_errno(rb_execarg_run_options(sargp, NULL, errmsg, errmsg_buflen)); + rb_execarg_run_options(sargp, NULL, errmsg, errmsg_buflen); #endif -failure: - return -1; + return err; } #ifdef HAVE_WORKING_FORK @@ -3133,19 +3626,13 @@ rb_exec_atfork(void* arg, char *errmsg, size_t errmsg_buflen) { return rb_exec_async_signal_safe(arg, errmsg, errmsg_buflen); /* hopefully async-signal-safe */ } -#endif -#ifdef HAVE_WORKING_FORK -#if SIZEOF_INT == SIZEOF_LONG -#define proc_syswait (VALUE (*)(VALUE))rb_syswait -#else static VALUE proc_syswait(VALUE pid) { - rb_syswait((int)pid); + rb_syswait((rb_pid_t)pid); return Qnil; } -#endif static int move_fds_to_avoid_crash(int *fdp, int n, VALUE fds) @@ -3193,12 +3680,19 @@ pipe_nocrash(int filedes[2], VALUE fds) #define O_BINARY 0 #endif +static VALUE +rb_thread_sleep_that_takes_VALUE_as_sole_argument(VALUE n) +{ + rb_thread_sleep(NUM2INT(n)); + return Qundef; +} + static int -handle_fork_error(int *status, int *ep, volatile int *try_gc_p) +handle_fork_error(int err, struct rb_process_status *status, int *ep, volatile int *try_gc_p) { int state = 0; - switch (errno) { + switch (err) { case ENOMEM: if ((*try_gc_p)-- > 0 && !rb_during_gc()) { rb_gc(); @@ -3214,23 +3708,25 @@ handle_fork_error(int *status, int *ep, volatile int *try_gc_p) return 0; } else { - rb_protect((VALUE (*)())rb_thread_sleep, 1, &state); - if (status) *status = state; + rb_protect(rb_thread_sleep_that_takes_VALUE_as_sole_argument, INT2FIX(1), &state); + if (status) status->status = state; if (!state) return 0; } break; } if (ep) { - preserving_errno((close(ep[0]), close(ep[1]))); + close(ep[0]); + close(ep[1]); + errno = err; } if (state && !status) rb_jump_tag(state); return -1; } #define prefork() ( \ - rb_io_flush(rb_stdout), \ - rb_io_flush(rb_stderr) \ - ) + rb_io_flush(rb_stdout), \ + rb_io_flush(rb_stderr) \ + ) /* * Forks child process, and returns the process ID in the parent @@ -3264,7 +3760,7 @@ write_retry(int fd, const void *buf, size_t len) ssize_t w; do { - w = write(fd, buf, len); + w = write(fd, buf, len); } while (w < 0 && errno == EINTR); return w; @@ -3275,8 +3771,14 @@ read_retry(int fd, void *buf, size_t len) { ssize_t r; + if (set_blocking(fd) != 0) { +#ifndef _WIN32 + rb_async_bug_errno("set_blocking failed reading child error", errno); +#endif + } + do { - r = read(fd, buf, len); + r = read(fd, buf, len); } while (r < 0 && errno == EINTR); return r; @@ -3329,7 +3831,7 @@ getresuid(rb_uid_t *ruid, rb_uid_t *euid, rb_uid_t *suid) *euid = geteuid(); ret = getuidx(ID_SAVED); if (ret == (rb_uid_t)-1) - return -1; + return -1; *suid = ret; return 0; } @@ -3347,7 +3849,7 @@ getresgid(rb_gid_t *rgid, rb_gid_t *egid, rb_gid_t *sgid) *egid = getegid(); ret = getgidx(ID_SAVED); if (ret == (rb_gid_t)-1) - return -1; + return -1; *sgid = ret; return 0; } @@ -3374,7 +3876,7 @@ has_privilege(void) #if defined HAVE_ISSETUGID if (issetugid()) - return 1; + return 1; #endif #ifdef HAVE_GETRESUID @@ -3420,56 +3922,37 @@ has_privilege(void) struct child_handler_disabler_state { sigset_t sigmask; - int cancelstate; }; static void disable_child_handler_before_fork(struct child_handler_disabler_state *old) { +#ifdef HAVE_PTHREAD_SIGMASK int ret; sigset_t all; -#ifdef HAVE_PTHREAD_SIGMASK ret = sigfillset(&all); if (ret == -1) rb_sys_fail("sigfillset"); ret = pthread_sigmask(SIG_SETMASK, &all, &old->sigmask); /* not async-signal-safe */ if (ret != 0) { - errno = ret; - rb_sys_fail("pthread_sigmask"); + rb_syserr_fail(ret, "pthread_sigmask"); } #else # pragma GCC warning "pthread_sigmask on fork is not available. potentially dangerous" #endif - -#ifdef PTHREAD_CANCEL_DISABLE - ret = pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old->cancelstate); - if (ret != 0) { - errno = ret; - rb_sys_fail("pthread_setcancelstate"); - } -#endif } static void disable_child_handler_fork_parent(struct child_handler_disabler_state *old) { +#ifdef HAVE_PTHREAD_SIGMASK int ret; -#ifdef PTHREAD_CANCEL_DISABLE - ret = pthread_setcancelstate(old->cancelstate, NULL); - if (ret != 0) { - errno = ret; - rb_sys_fail("pthread_setcancelstate"); - } -#endif - -#ifdef HAVE_PTHREAD_SIGMASK ret = pthread_sigmask(SIG_SETMASK, &old->sigmask, NULL); /* not async-signal-safe */ if (ret != 0) { - errno = ret; - rb_sys_fail("pthread_sigmask"); + rb_syserr_fail(ret, "pthread_sigmask"); } #else # pragma GCC warning "pthread_sigmask on fork is not available. potentially dangerous" @@ -3482,67 +3965,30 @@ disable_child_handler_fork_child(struct child_handler_disabler_state *old, char { int sig; int ret; -#ifdef POSIX_SIGNAL - struct sigaction act, oact; - - act.sa_handler = SIG_DFL; - act.sa_flags = 0; - ret = sigemptyset(&act.sa_mask); /* async-signal-safe */ - if (ret == -1) { - ERRMSG("sigemptyset"); - return -1; - } -#else - sig_t handler; -#endif for (sig = 1; sig < NSIG; sig++) { - int reset = 0; + sig_t handler = signal(sig, SIG_DFL); + + if (handler == SIG_ERR && errno == EINVAL) { + continue; /* Ignore invalid signal number */ + } + if (handler == SIG_ERR) { + ERRMSG("signal to obtain old action"); + return -1; + } #ifdef SIGPIPE - if (sig == SIGPIPE) - reset = 1; -#endif - if (!reset) { -#ifdef POSIX_SIGNAL - ret = sigaction(sig, NULL, &oact); /* async-signal-safe */ - if (ret == -1 && errno == EINVAL) { - continue; /* Ignore invalid signal number. */ - } - if (ret == -1) { - ERRMSG("sigaction to obtain old action"); - return -1; - } - reset = (oact.sa_flags & SA_SIGINFO) || - (oact.sa_handler != SIG_IGN && oact.sa_handler != SIG_DFL); -#else - handler = signal(sig, SIG_DFL); - if (handler == SIG_ERR && errno == EINVAL) { - continue; /* Ignore invalid signal number */ - } - if (handler == SIG_ERR) { - ERRMSG("signal to obtain old action"); - return -1; - } - reset = (handler != SIG_IGN && handler != SIG_DFL); -#endif + if (sig == SIGPIPE) { + continue; } - if (reset) { -#ifdef POSIX_SIGNAL - ret = sigaction(sig, &act, NULL); /* async-signal-safe */ - if (ret == -1) { - ERRMSG("sigaction to set default action"); - return -1; - } -#else - handler = signal(sig, handler); - if (handler == SIG_ERR) { - ERRMSG("signal to set default action"); - return -1; - } #endif + /* it will be reset to SIG_DFL at execve time, instead */ + if (handler == SIG_IGN) { + signal(sig, SIG_IGN); } } + /* non-Ruby child process, ensure cmake can see SIGCHLD */ + sigemptyset(&old->sigmask); ret = sigprocmask(SIG_SETMASK, &old->sigmask, NULL); /* async-signal-safe */ if (ret != 0) { ERRMSG("sigprocmask"); @@ -3552,24 +3998,29 @@ disable_child_handler_fork_child(struct child_handler_disabler_state *old, char } static rb_pid_t -retry_fork_async_signal_safe(int *status, int *ep, +retry_fork_async_signal_safe(struct rb_process_status *status, int *ep, int (*chfunc)(void*, char *, size_t), void *charg, - char *errmsg, size_t errmsg_buflen) + char *errmsg, size_t errmsg_buflen, + struct waitpid_state *w) { rb_pid_t pid; volatile int try_gc = 1; struct child_handler_disabler_state old; + int err; while (1) { prefork(); disable_child_handler_before_fork(&old); -#ifdef HAVE_WORKING_VFORK + + // Older versions of ASAN does not work with vfork + // See https://github.com/google/sanitizers/issues/925 +#if defined(HAVE_WORKING_VFORK) && !defined(RUBY_ASAN_ENABLED) if (!has_privilege()) pid = vfork(); else - pid = fork(); + pid = rb_fork(); #else - pid = fork(); + pid = rb_fork(); #endif if (pid == 0) {/* fork succeed, child process */ int ret; @@ -3586,109 +4037,247 @@ retry_fork_async_signal_safe(int *status, int *ep, _exit(127); #endif } - preserving_errno(disable_child_handler_fork_parent(&old)); + err = errno; + disable_child_handler_fork_parent(&old); if (0 < pid) /* fork succeed, parent process */ return pid; /* fork failed */ - if (handle_fork_error(status, ep, &try_gc)) + if (handle_fork_error(err, status, ep, &try_gc)) return -1; } } -rb_pid_t -rb_fork_async_signal_safe(int *status, int (*chfunc)(void*, char *, size_t), void *charg, VALUE fds, - char *errmsg, size_t errmsg_buflen) +static rb_pid_t +fork_check_err(struct rb_process_status *status, int (*chfunc)(void*, char *, size_t), void *charg, + VALUE fds, char *errmsg, size_t errmsg_buflen, + struct rb_execarg *eargp) { rb_pid_t pid; int err; int ep[2]; int error_occurred; - if (status) *status = 0; + struct waitpid_state *w = eargp && eargp->waitpid_state ? eargp->waitpid_state : 0; + + if (status) status->status = 0; if (pipe_nocrash(ep, fds)) return -1; - pid = retry_fork_async_signal_safe(status, ep, chfunc, charg, errmsg, errmsg_buflen); - if (pid < 0) + + pid = retry_fork_async_signal_safe(status, ep, chfunc, charg, errmsg, errmsg_buflen, w); + + if (status) status->pid = pid; + + if (pid < 0) { + if (status) status->error = errno; + return pid; + } + close(ep[1]); + error_occurred = recv_child_error(ep[0], &err, errmsg, errmsg_buflen); + if (error_occurred) { if (status) { - rb_protect(proc_syswait, (VALUE)pid, status); + int state = 0; + status->error = err; + + VM_ASSERT((w == 0) && "only used by extensions"); + rb_protect(proc_syswait, (VALUE)pid, &state); + + status->status = state; } - else { + else if (!w) { rb_syswait(pid); } + errno = err; return -1; } + return pid; } -static rb_pid_t -retry_fork_ruby(int *status) +/* + * The "async_signal_safe" name is a lie, but it is used by pty.c and + * maybe other exts. fork() is not async-signal-safe due to pthread_atfork + * and future POSIX revisions will remove it from a list of signal-safe + * functions. rb_waitpid is not async-signal-safe. + * For our purposes, we do not need async-signal-safety, here + */ +rb_pid_t +rb_fork_async_signal_safe(int *status, + int (*chfunc)(void*, char *, size_t), void *charg, + VALUE fds, char *errmsg, size_t errmsg_buflen) { - rb_pid_t pid; - int try_gc = 1; + struct rb_process_status process_status; - while (1) { - prefork(); - before_fork_ruby(); - pid = fork(); - if (pid == 0) /* fork succeed, child process */ - return pid; - preserving_errno(after_fork_ruby()); - if (0 < pid) /* fork succeed, parent process */ - return pid; - /* fork failed */ - if (handle_fork_error(status, NULL, &try_gc)) - return -1; + rb_pid_t result = fork_check_err(&process_status, chfunc, charg, fds, errmsg, errmsg_buflen, 0); + + if (status) { + *status = process_status.status; } + + return result; } rb_pid_t rb_fork_ruby(int *status) { + if (UNLIKELY(!rb_ractor_main_p())) { + rb_raise(rb_eRactorIsolationError, "can not fork from non-main Ractors"); + } + + struct rb_process_status child = {.status = 0}; rb_pid_t pid; + int try_gc = 1, err = 0; + struct child_handler_disabler_state old; + + do { + prefork(); - if (status) *status = 0; + before_fork_ruby(); + rb_thread_acquire_fork_lock(); + disable_child_handler_before_fork(&old); - pid = retry_fork_ruby(status); - if (pid < 0) - return pid; - if (!pid) { - after_fork_ruby(); + RB_VM_LOCKING() { + child.pid = pid = rb_fork(); + child.error = err = errno; + } + + disable_child_handler_fork_parent(&old); /* yes, bad name */ + if ( +#if defined(__FreeBSD__) + pid != 0 && +#endif + true) { + rb_thread_release_fork_lock(); + } + if (pid == 0) { + rb_thread_reset_fork_lock(); + } + after_fork_ruby(pid); + + /* repeat while fork failed but retryable */ + } while (pid < 0 && handle_fork_error(err, &child, NULL, &try_gc) == 0); + + if (status) *status = child.status; + + return pid; +} + +static rb_pid_t +proc_fork_pid(void) +{ + rb_pid_t pid = rb_fork_ruby(NULL); + + if (pid == -1) { + rb_sys_fail("fork(2)"); } + return pid; } +rb_pid_t +rb_call_proc__fork(void) +{ + ID id__fork; + CONST_ID(id__fork, "_fork"); + if (rb_method_basic_definition_p(CLASS_OF(rb_mProcess), id__fork)) { + return proc_fork_pid(); + } + else { + VALUE pid = rb_funcall(rb_mProcess, id__fork, 0); + return NUM2PIDT(pid); + } +} #endif #if defined(HAVE_WORKING_FORK) && !defined(CANNOT_FORK_WITH_PTHREAD) /* * call-seq: - * Kernel.fork [{ block }] -> fixnum or nil - * Process.fork [{ block }] -> fixnum or nil - * - * Creates a subprocess. If a block is specified, that block is run - * in the subprocess, and the subprocess terminates with a status of - * zero. Otherwise, the +fork+ call returns twice, once in - * the parent, returning the process ID of the child, and once in - * the child, returning _nil_. The child process can exit using - * <code>Kernel.exit!</code> to avoid running any - * <code>at_exit</code> functions. The parent process should - * use <code>Process.wait</code> to collect the termination statuses - * of its children or use <code>Process.detach</code> to register - * disinterest in their status; otherwise, the operating system - * may accumulate zombie processes. - * - * The thread calling fork is the only thread in the created child process. - * fork doesn't copy other threads. - * - * If fork is not usable, Process.respond_to?(:fork) returns false. - * - * Note that fork(2) is not available on some platforms like Windows and NetBSD 4. - * Therefore you should use spawn() instead of fork(). + * Process._fork -> integer + * + * An internal API for fork. Do not call this method directly. + * Currently, this is called via Kernel#fork, Process.fork, and + * IO.popen with <tt>"-"</tt>. + * + * This method is not for casual code but for application monitoring + * libraries. You can add custom code before and after fork events + * by overriding this method. + * + * Note: Process.daemon may be implemented using fork(2) BUT does not go + * through this method. + * Thus, depending on your reason to hook into this method, you + * may also want to hook into that one. + * See {this issue}[https://bugs.ruby-lang.org/issues/18911] for a + * more detailed discussion of this. + */ +VALUE +rb_proc__fork(VALUE _obj) +{ + rb_pid_t pid = proc_fork_pid(); + return PIDT2NUM(pid); +} + +/* + * call-seq: + * Process.fork { ... } -> integer or nil + * Process.fork -> integer or nil + * + * Creates a child process. + * + * With a block given, runs the block in the child process; + * on block exit, the child terminates with a status of zero: + * + * puts "Before the fork: #{Process.pid}" + * fork do + * puts "In the child process: #{Process.pid}" + * end # => 382141 + * puts "After the fork: #{Process.pid}" + * + * Output: + * + * Before the fork: 420496 + * After the fork: 420496 + * In the child process: 420520 + * + * With no block given, the +fork+ call returns twice: + * + * - Once in the parent process, returning the pid of the child process. + * - Once in the child process, returning +nil+. + * + * Example: + * + * puts "This is the first line before the fork (pid #{Process.pid})" + * puts fork + * puts "This is the second line after the fork (pid #{Process.pid})" + * + * Output: + * + * This is the first line before the fork (pid 420199) + * 420223 + * This is the second line after the fork (pid 420199) + * + * This is the second line after the fork (pid 420223) + * + * In either case, the child process may exit using + * Kernel.exit! to avoid the call to Kernel#at_exit. + * + * To avoid zombie processes, the parent process should call either: + * + * - Process.wait, to collect the termination statuses of its children. + * - Process.detach, to register disinterest in their status. + * + * The thread calling +fork+ is the only thread in the created child process; + * +fork+ doesn't copy other threads. + * + * Note that method +fork+ is available on some platforms, + * but not on others: + * + * Process.respond_to?(:fork) # => true # Would be false on some. + * + * If not, you may use ::spawn instead of +fork+. */ static VALUE @@ -3696,26 +4285,21 @@ rb_f_fork(VALUE obj) { rb_pid_t pid; - switch (pid = rb_fork_ruby(NULL)) { - case 0: - rb_thread_atfork(); - if (rb_block_given_p()) { - int status; - - rb_protect(rb_yield, Qundef, &status); - ruby_stop(status); - } - return Qnil; - - case -1: - rb_sys_fail("fork(2)"); - return Qnil; + pid = rb_call_proc__fork(); - default: - return PIDT2NUM(pid); + if (pid == 0) { + if (rb_block_given_p()) { + int status; + rb_protect(rb_yield, Qundef, &status); + ruby_stop(status); + } + return Qnil; } + + return PIDT2NUM(pid); } #else +#define rb_proc__fork rb_f_notimplement #define rb_f_fork rb_f_notimplement #endif @@ -3726,155 +4310,183 @@ exit_status_code(VALUE status) switch (status) { case Qtrue: - istatus = EXIT_SUCCESS; - break; + istatus = EXIT_SUCCESS; + break; case Qfalse: - istatus = EXIT_FAILURE; - break; + istatus = EXIT_FAILURE; + break; default: - istatus = NUM2INT(status); + istatus = NUM2INT(status); #if EXIT_SUCCESS != 0 - if (istatus == 0) - istatus = EXIT_SUCCESS; + if (istatus == 0) + istatus = EXIT_SUCCESS; #endif - break; + break; } return istatus; } +NORETURN(static VALUE rb_f_exit_bang(int argc, VALUE *argv, VALUE obj)); /* * call-seq: - * Process.exit!(status=false) + * exit!(status = false) + * Process.exit!(status = false) * - * Exits the process immediately. No exit handlers are - * run. <em>status</em> is returned to the underlying system as the - * exit status. + * Exits the process immediately; no exit handlers are called. + * Returns exit status +status+ to the underlying operating system. * * Process.exit!(true) + * + * Values +true+ and +false+ for argument +status+ + * indicate, respectively, success and failure; + * The meanings of integer values are system-dependent. + * */ static VALUE rb_f_exit_bang(int argc, VALUE *argv, VALUE obj) { - VALUE status; int istatus; - if (argc > 0 && rb_scan_args(argc, argv, "01", &status) == 1) { - istatus = exit_status_code(status); + if (rb_check_arity(argc, 0, 1) == 1) { + istatus = exit_status_code(argv[0]); } else { - istatus = EXIT_FAILURE; + istatus = EXIT_FAILURE; } _exit(istatus); - UNREACHABLE; + UNREACHABLE_RETURN(Qnil); } void rb_exit(int status) { - if (GET_THREAD()->tag) { - VALUE args[2]; + if (GET_EC()->tag) { + VALUE args[2]; - args[0] = INT2NUM(status); - args[1] = rb_str_new2("exit"); - rb_exc_raise(rb_class_new_instance(2, args, rb_eSystemExit)); + args[0] = INT2NUM(status); + args[1] = rb_str_new2("exit"); + rb_exc_raise(rb_class_new_instance(2, args, rb_eSystemExit)); } ruby_stop(status); } - -/* - * call-seq: - * exit(status=true) - * Kernel::exit(status=true) - * Process::exit(status=true) - * - * Initiates the termination of the Ruby script by raising the - * <code>SystemExit</code> exception. This exception may be caught. The - * optional parameter is used to return a status code to the invoking - * environment. - * +true+ and +FALSE+ of _status_ means success and failure - * respectively. The interpretation of other integer values are - * system dependent. - * - * begin - * exit - * puts "never get here" - * rescue SystemExit - * puts "rescued a SystemExit exception" - * end - * puts "after begin block" - * - * <em>produces:</em> - * - * rescued a SystemExit exception - * after begin block - * - * Just prior to termination, Ruby executes any <code>at_exit</code> functions - * (see Kernel::at_exit) and runs any object finalizers (see - * ObjectSpace::define_finalizer). - * - * at_exit { puts "at_exit function" } - * ObjectSpace.define_finalizer("string", proc { puts "in finalizer" }) - * exit - * - * <em>produces:</em> - * - * at_exit function - * in finalizer - */ - VALUE rb_f_exit(int argc, const VALUE *argv) { - VALUE status; int istatus; - if (argc > 0 && rb_scan_args(argc, argv, "01", &status) == 1) { - istatus = exit_status_code(status); + if (rb_check_arity(argc, 0, 1) == 1) { + istatus = exit_status_code(argv[0]); } else { - istatus = EXIT_SUCCESS; + istatus = EXIT_SUCCESS; } rb_exit(istatus); - UNREACHABLE; + UNREACHABLE_RETURN(Qnil); } - +NORETURN(static VALUE f_exit(int c, const VALUE *a, VALUE _)); /* * call-seq: - * abort - * Kernel::abort([msg]) - * Process::abort([msg]) + * exit(status = true) + * Process.exit(status = true) + * + * Initiates termination of the Ruby script by raising SystemExit; + * the exception may be caught. + * Returns exit status +status+ to the underlying operating system. + * + * Values +true+ and +false+ for argument +status+ + * indicate, respectively, success and failure; + * The meanings of integer values are system-dependent. + * + * Example: + * + * begin + * exit + * puts 'Never get here.' + * rescue SystemExit + * puts 'Rescued a SystemExit exception.' + * end + * puts 'After begin block.' + * + * Output: + * + * Rescued a SystemExit exception. + * After begin block. + * + * Just prior to final termination, + * Ruby executes any at-exit procedures (see Kernel::at_exit) + * and any object finalizers (see ObjectSpace::define_finalizer). + * + * Example: + * + * at_exit { puts 'In at_exit function.' } + * ObjectSpace.define_finalizer('string', proc { puts 'In finalizer.' }) + * exit + * + * Output: + * + * In at_exit function. + * In finalizer. * - * Terminate execution immediately, effectively by calling - * <code>Kernel.exit(false)</code>. If _msg_ is given, it is written - * to STDERR prior to terminating. */ +static VALUE +f_exit(int c, const VALUE *a, VALUE _) +{ + rb_f_exit(c, a); + UNREACHABLE_RETURN(Qnil); +} + VALUE rb_f_abort(int argc, const VALUE *argv) { rb_check_arity(argc, 0, 1); if (argc == 0) { - if (!NIL_P(GET_THREAD()->errinfo)) { - ruby_error_print(); - } - rb_exit(EXIT_FAILURE); + rb_execution_context_t *ec = GET_EC(); + VALUE errinfo = rb_ec_get_errinfo(ec); + if (!NIL_P(errinfo)) { + rb_ec_error_print(ec, errinfo); + } + rb_exit(EXIT_FAILURE); } else { - VALUE args[2]; + VALUE args[2]; - args[1] = args[0] = argv[0]; - StringValue(args[0]); - rb_io_puts(1, args, rb_stderr); - args[0] = INT2NUM(EXIT_FAILURE); - rb_exc_raise(rb_class_new_instance(2, args, rb_eSystemExit)); + args[1] = args[0] = argv[0]; + StringValue(args[0]); + rb_io_puts(1, args, rb_ractor_stderr()); + args[0] = INT2NUM(EXIT_FAILURE); + rb_exc_raise(rb_class_new_instance(2, args, rb_eSystemExit)); } - UNREACHABLE; + UNREACHABLE_RETURN(Qnil); +} + +NORETURN(static VALUE f_abort(int c, const VALUE *a, VALUE _)); + +/* + * call-seq: + * abort + * Process.abort(msg = nil) + * + * Terminates execution immediately, effectively by calling + * <tt>Kernel.exit(false)</tt>. + * + * If string argument +msg+ is given, + * it is written to STDERR prior to termination; + * otherwise, if an exception was raised, + * prints its message and backtrace. + */ + +static VALUE +f_abort(int c, const VALUE *a, VALUE _) +{ + rb_f_abort(c, a); + UNREACHABLE_RETURN(Qnil); } void @@ -3885,6 +4497,29 @@ rb_syswait(rb_pid_t pid) rb_waitpid(pid, &status, 0); } +#if !defined HAVE_WORKING_FORK && !defined HAVE_SPAWNV && !defined __EMSCRIPTEN__ +char * +rb_execarg_commandline(const struct rb_execarg *eargp, VALUE *prog) +{ + VALUE cmd = *prog; + if (eargp && !eargp->use_shell) { + VALUE str = eargp->invoke.cmd.argv_str; + VALUE buf = eargp->invoke.cmd.argv_buf; + char *p, **argv = ARGVSTR2ARGV(str); + long i, argc = ARGVSTR2ARGC(str); + const char *start = RSTRING_PTR(buf); + cmd = rb_str_new(start, RSTRING_LEN(buf)); + p = RSTRING_PTR(cmd); + for (i = 1; i < argc; ++i) { + p[argv[i] - start - 1] = ' '; + } + *prog = cmd; + return p; + } + return StringValueCStr(*prog); +} +#endif + static rb_pid_t rb_spawn_process(struct rb_execarg *eargp, char *errmsg, size_t errmsg_buflen) { @@ -3892,10 +4527,13 @@ rb_spawn_process(struct rb_execarg *eargp, char *errmsg, size_t errmsg_buflen) #if !defined HAVE_WORKING_FORK || USE_SPAWNV VALUE prog; struct rb_execarg sarg; +# if !defined HAVE_SPAWNV + int status; +# endif #endif #if defined HAVE_WORKING_FORK && !USE_SPAWNV - pid = rb_fork_async_signal_safe(NULL, rb_exec_atfork, eargp, eargp->redirect_fds, errmsg, errmsg_buflen); + pid = fork_check_err(eargp->status, rb_exec_atfork, eargp, eargp->redirect_fds, errmsg, errmsg_buflen, eargp); #else prog = eargp->use_shell ? eargp->invoke.sh.shell_script : eargp->invoke.cmd.command_name; @@ -3909,35 +4547,37 @@ rb_spawn_process(struct rb_execarg *eargp, char *errmsg, size_t errmsg_buflen) } # if defined HAVE_SPAWNV if (eargp->use_shell) { - pid = proc_spawn_sh(RSTRING_PTR(prog)); + pid = proc_spawn_sh(RSTRING_PTR(prog)); } else { char **argv = ARGVSTR2ARGV(eargp->invoke.cmd.argv_str); - pid = proc_spawn_cmd(argv, prog, eargp); + pid = proc_spawn_cmd(argv, prog, eargp); } - if (pid == -1) - rb_last_status_set(0x7f << 8, 0); -# else - if (!eargp->use_shell) { - char **argv = ARGVSTR2ARGV(eargp->invoke.cmd.argv_str); - int argc = ARGVSTR2ARGC(eargp->invoke.cmd.argv_str); - prog = rb_ary_join(rb_ary_new4(argc, argv), rb_str_new2(" ")); + + if (pid == -1) { + rb_last_status_set(0x7f << 8, pid); } - status = system(StringValuePtr(prog)); - rb_last_status_set((status & 0xff) << 8, 0); +# else + status = system(rb_execarg_commandline(eargp, &prog)); pid = 1; /* dummy */ + rb_last_status_set((status & 0xff) << 8, pid); # endif + if (eargp->waitpid_state) { + eargp->waitpid_state->pid = pid; + } + rb_execarg_run_options(&sarg, NULL, errmsg, errmsg_buflen); #endif + return pid; } struct spawn_args { VALUE execarg; struct { - char *ptr; - size_t buflen; + char *ptr; + size_t buflen; } errmsg; }; @@ -3945,11 +4585,16 @@ static VALUE do_spawn_process(VALUE arg) { struct spawn_args *argp = (struct spawn_args *)arg; + rb_execarg_parent_start1(argp->execarg); - return (VALUE)rb_spawn_process(DATA_PTR(argp->execarg), - argp->errmsg.ptr, argp->errmsg.buflen); + + return (VALUE)rb_spawn_process(rb_execarg_get(argp->execarg), + argp->errmsg.ptr, argp->errmsg.buflen); } +NOINLINE(static rb_pid_t + rb_execarg_spawn(VALUE execarg_obj, char *errmsg, size_t errmsg_buflen)); + static rb_pid_t rb_execarg_spawn(VALUE execarg_obj, char *errmsg, size_t errmsg_buflen) { @@ -3958,8 +4603,10 @@ rb_execarg_spawn(VALUE execarg_obj, char *errmsg, size_t errmsg_buflen) args.execarg = execarg_obj; args.errmsg.ptr = errmsg; args.errmsg.buflen = errmsg_buflen; - return (rb_pid_t)rb_ensure(do_spawn_process, (VALUE)&args, - execarg_parent_end, execarg_obj); + + rb_pid_t r = (rb_pid_t)rb_ensure(do_spawn_process, (VALUE)&args, + execarg_parent_end, execarg_obj); + return r; } static rb_pid_t @@ -3967,7 +4614,7 @@ rb_spawn_internal(int argc, const VALUE *argv, char *errmsg, size_t errmsg_bufle { VALUE execarg_obj; - execarg_obj = rb_execarg_new(argc, argv, TRUE); + execarg_obj = rb_execarg_new(argc, argv, TRUE, FALSE); return rb_execarg_spawn(execarg_obj, errmsg, errmsg_buflen); } @@ -3985,360 +4632,306 @@ rb_spawn(int argc, const VALUE *argv) /* * call-seq: - * system([env,] command... [,options]) -> true, false or nil + * system([env, ] command_line, options = {}, exception: false) -> true, false, or nil + * system([env, ] exe_path, *args, options = {}, exception: false) -> true, false, or nil + * + * Creates a new child process by doing one of the following + * in that process: + * + * - Passing string +command_line+ to the shell. + * - Invoking the executable at +exe_path+. + * + * This method has potential security vulnerabilities if called with untrusted input; + * see {Command Injection}[rdoc-ref:security/command_injection.rdoc]. + * + * Returns: + * + * - +true+ if the command exits with status zero. + * - +false+ if the exit status is a non-zero integer. + * - +nil+ if the command could not execute. + * + * Raises an exception (instead of returning +false+ or +nil+) + * if keyword argument +exception+ is set to +true+. + * + * Assigns the command's error status to <tt>$?</tt>. + * + * The new process is created using the + * {system system call}[https://pubs.opengroup.org/onlinepubs/9699919799.2018edition/functions/system.html]; + * it may inherit some of its environment from the calling program + * (possibly including open file descriptors). + * + * Argument +env+, if given, is a hash that affects +ENV+ for the new process; + * see {Execution Environment}[rdoc-ref:Process@Execution+Environment]. + * + * Argument +options+ is a hash of options for the new process; + * see {Execution Options}[rdoc-ref:Process@Execution+Options]. + * + * The first required argument is one of the following: * - * Executes _command..._ in a subshell. - * _command..._ is one of following forms. + * - +command_line+ if it is a string, + * and if it begins with a shell reserved word or special built-in, + * or if it contains one or more meta characters. + * - +exe_path+ otherwise. * - * commandline : command line string which is passed to the standard shell - * cmdname, arg1, ... : command name and one or more arguments (no shell) - * [cmdname, argv0], arg1, ... : command name, argv[0] and zero or more arguments (no shell) + * <b>Argument +command_line+</b> * - * system returns +true+ if the command gives zero exit status, - * +false+ for non zero exit status. - * Returns +nil+ if command execution fails. - * An error status is available in <code>$?</code>. - * The arguments are processed in the same way as - * for <code>Kernel.spawn</code>. + * \String argument +command_line+ is a command line to be passed to a shell; + * it must begin with a shell reserved word, begin with a special built-in, + * or contain meta characters: * - * The hash arguments, env and options, are same as - * <code>exec</code> and <code>spawn</code>. - * See <code>Kernel.spawn</code> for details. + * system('if true; then echo "Foo"; fi') # => true # Shell reserved word. + * system('exit') # => true # Built-in. + * system('date > /tmp/date.tmp') # => true # Contains meta character. + * system('date > /nop/date.tmp') # => false + * system('date > /nop/date.tmp', exception: true) # Raises RuntimeError. * - * system("echo *") - * system("echo", "*") + * Assigns the command's error status to <tt>$?</tt>: * - * <em>produces:</em> + * system('exit') # => true # Built-in. + * $? # => #<Process::Status: pid 640610 exit 0> + * system('date > /nop/date.tmp') # => false + * $? # => #<Process::Status: pid 640742 exit 2> * - * config.h main.rb - * * + * The command line may also contain arguments and options for the command: * - * See <code>Kernel.exec</code> for the standard shell. + * system('echo "Foo"') # => true + * + * Output: + * + * Foo + * + * See {Execution Shell}[rdoc-ref:Process@Execution+Shell] for details about the shell. + * + * Raises an exception if the new process could not execute. + * + * <b>Argument +exe_path+</b> + * + * Argument +exe_path+ is one of the following: + * + * - The string path to an executable to be called. + * - A 2-element array containing the path to an executable + * and the string to be used as the name of the executing process. + * + * Example: + * + * system('/usr/bin/date') # => true # Path to date on Unix-style system. + * system('foo') # => nil # Command failed. + * + * Output: + * + * Mon Aug 28 11:43:10 AM CDT 2023 + * + * Assigns the command's error status to <tt>$?</tt>: + * + * system('/usr/bin/date') # => true + * $? # => #<Process::Status: pid 645605 exit 0> + * system('foo') # => nil + * $? # => #<Process::Status: pid 645608 exit 127> + * + * Ruby invokes the executable directly. + * This form does not use the shell; + * see {Arguments args}[rdoc-ref:Process@Arguments+args] for caveats. + * + * system('doesnt_exist') # => nil + * + * If one or more +args+ is given, each is an argument or option + * to be passed to the executable: + * + * system('echo', 'C*') # => true + * system('echo', 'hello', 'world') # => true + * + * Output: + * + * C* + * hello world + * + * Raises an exception if the new process could not execute. */ static VALUE -rb_f_system(int argc, VALUE *argv) +rb_f_system(int argc, VALUE *argv, VALUE _) { - rb_pid_t pid; - int status; + rb_thread_t *th = GET_THREAD(); + VALUE execarg_obj = rb_execarg_new(argc, argv, TRUE, TRUE); + struct rb_execarg *eargp = rb_execarg_get(execarg_obj); -#if defined(SIGCLD) && !defined(SIGCHLD) -# define SIGCHLD SIGCLD -#endif + struct rb_process_status status = {0}; + eargp->status = &status; -#ifdef SIGCHLD - RETSIGTYPE (*chfunc)(int); + last_status_clear(th); + + // This function can set the thread's last status. + // May be different from waitpid_state.pid on exec failure. + rb_pid_t pid = rb_execarg_spawn(execarg_obj, 0, 0); - rb_last_status_clear(); - chfunc = signal(SIGCHLD, SIG_DFL); -#endif - pid = rb_spawn_internal(argc, argv, NULL, 0); -#if defined(HAVE_WORKING_FORK) || defined(HAVE_SPAWNV) if (pid > 0) { - int ret, status; - ret = rb_waitpid(pid, &status, 0); - if (ret == (rb_pid_t)-1) - rb_sys_fail("Another thread waited the process started by system()."); + VALUE status = rb_process_status_wait(pid, 0); + struct rb_process_status *data = rb_check_typeddata(status, &rb_process_status_type); + // Set the last status: + rb_obj_freeze(status); + th->last_status = status; + + if (data->status == EXIT_SUCCESS) { + return Qtrue; + } + + if (data->error != 0) { + if (eargp->exception) { + VALUE command = eargp->invoke.sh.shell_script; + RB_GC_GUARD(execarg_obj); + rb_syserr_fail_str(data->error, command); + } + else { + return Qnil; + } + } + else if (eargp->exception) { + VALUE command = eargp->invoke.sh.shell_script; + VALUE str = rb_str_new_cstr("Command failed with"); + rb_str_cat_cstr(pst_message_status(str, data->status), ": "); + rb_str_append(str, command); + RB_GC_GUARD(execarg_obj); + rb_exc_raise(rb_exc_new_str(rb_eRuntimeError, str)); + } + else { + return Qfalse; + } + + RB_GC_GUARD(status); } -#endif -#ifdef SIGCHLD - signal(SIGCHLD, chfunc); -#endif - if (pid < 0) { - return Qnil; + + if (eargp->exception) { + VALUE command = eargp->invoke.sh.shell_script; + RB_GC_GUARD(execarg_obj); + rb_syserr_fail_str(errno, command); + } + else { + return Qnil; } - status = PST2INT(rb_last_status_get()); - if (status == EXIT_SUCCESS) return Qtrue; - return Qfalse; } /* * call-seq: - * spawn([env,] command... [,options]) -> pid - * Process.spawn([env,] command... [,options]) -> pid - * - * spawn executes specified command and return its pid. - * - * pid = spawn("tar xf ruby-2.0.0-p195.tar.bz2") - * Process.wait pid - * - * pid = spawn(RbConfig.ruby, "-eputs'Hello, world!'") - * Process.wait pid - * - * This method is similar to Kernel#system but it doesn't wait for the command - * to finish. - * - * The parent process should - * use <code>Process.wait</code> to collect - * the termination status of its child or - * use <code>Process.detach</code> to register - * disinterest in their status; - * otherwise, the operating system may accumulate zombie processes. - * - * spawn has bunch of options to specify process attributes: - * - * env: hash - * name => val : set the environment variable - * name => nil : unset the environment variable - * - * the keys and the values except for +nil+ must be strings. - * command...: - * commandline : command line string which is passed to the standard shell - * cmdname, arg1, ... : command name and one or more arguments (This form does not use the shell. See below for caveats.) - * [cmdname, argv0], arg1, ... : command name, argv[0] and zero or more arguments (no shell) - * options: hash - * clearing environment variables: - * :unsetenv_others => true : clear environment variables except specified by env - * :unsetenv_others => false : don't clear (default) - * process group: - * :pgroup => true or 0 : make a new process group - * :pgroup => pgid : join the specified process group - * :pgroup => nil : don't change the process group (default) - * create new process group: Windows only - * :new_pgroup => true : the new process is the root process of a new process group - * :new_pgroup => false : don't create a new process group (default) - * resource limit: resourcename is core, cpu, data, etc. See Process.setrlimit. - * :rlimit_resourcename => limit - * :rlimit_resourcename => [cur_limit, max_limit] - * umask: - * :umask => int - * redirection: - * key: - * FD : single file descriptor in child process - * [FD, FD, ...] : multiple file descriptor in child process - * value: - * FD : redirect to the file descriptor in parent process - * string : redirect to file with open(string, "r" or "w") - * [string] : redirect to file with open(string, File::RDONLY) - * [string, open_mode] : redirect to file with open(string, open_mode, 0644) - * [string, open_mode, perm] : redirect to file with open(string, open_mode, perm) - * [:child, FD] : redirect to the redirected file descriptor - * :close : close the file descriptor in child process - * FD is one of follows - * :in : the file descriptor 0 which is the standard input - * :out : the file descriptor 1 which is the standard output - * :err : the file descriptor 2 which is the standard error - * integer : the file descriptor of specified the integer - * io : the file descriptor specified as io.fileno - * file descriptor inheritance: close non-redirected non-standard fds (3, 4, 5, ...) or not - * :close_others => true : don't inherit - * current directory: - * :chdir => str - * - * The 'cmdname, arg1, ...' form does not use the shell. However, - * on different OSes, different things are provided as built-in - * commands. An example of this is 'echo', which is a built-in - * on Windows, but is a normal program on Linux and Mac OS X. - * This means that `Process.spawn 'echo', '%Path%'` will display - * the contents of the `%Path%` environment variable on Windows, - * but `Process.spawn 'echo', '$PATH'` prints the literal '$PATH'. - * - * If a hash is given as +env+, the environment is - * updated by +env+ before <code>exec(2)</code> in the child process. - * If a pair in +env+ has nil as the value, the variable is deleted. - * - * # set FOO as BAR and unset BAZ. - * pid = spawn({"FOO"=>"BAR", "BAZ"=>nil}, command) - * - * If a hash is given as +options+, - * it specifies - * process group, - * create new process group, - * resource limit, - * current directory, - * umask and - * redirects for the child process. - * Also, it can be specified to clear environment variables. - * - * The <code>:unsetenv_others</code> key in +options+ specifies - * to clear environment variables, other than specified by +env+. - * - * pid = spawn(command, :unsetenv_others=>true) # no environment variable - * pid = spawn({"FOO"=>"BAR"}, command, :unsetenv_others=>true) # FOO only - * - * The <code>:pgroup</code> key in +options+ specifies a process group. - * The corresponding value should be true, zero, a positive integer, or nil. - * true and zero cause the process to be a process leader of a new process group. - * A non-zero positive integer causes the process to join the provided process group. - * The default value, nil, causes the process to remain in the same process group. - * - * pid = spawn(command, :pgroup=>true) # process leader - * pid = spawn(command, :pgroup=>10) # belongs to the process group 10 - * - * The <code>:new_pgroup</code> key in +options+ specifies to pass - * +CREATE_NEW_PROCESS_GROUP+ flag to <code>CreateProcessW()</code> that is - * Windows API. This option is only for Windows. - * true means the new process is the root process of the new process group. - * The new process has CTRL+C disabled. This flag is necessary for - * <code>Process.kill(:SIGINT, pid)</code> on the subprocess. - * :new_pgroup is false by default. - * - * pid = spawn(command, :new_pgroup=>true) # new process group - * pid = spawn(command, :new_pgroup=>false) # same process group - * - * The <code>:rlimit_</code><em>foo</em> key specifies a resource limit. - * <em>foo</em> should be one of resource types such as <code>core</code>. - * The corresponding value should be an integer or an array which have one or - * two integers: same as cur_limit and max_limit arguments for - * Process.setrlimit. - * - * cur, max = Process.getrlimit(:CORE) - * pid = spawn(command, :rlimit_core=>[0,max]) # disable core temporary. - * pid = spawn(command, :rlimit_core=>max) # enable core dump - * pid = spawn(command, :rlimit_core=>0) # never dump core. - * - * The <code>:umask</code> key in +options+ specifies the umask. - * - * pid = spawn(command, :umask=>077) - * - * The :in, :out, :err, a fixnum, an IO and an array key specifies a redirection. - * The redirection maps a file descriptor in the child process. - * - * For example, stderr can be merged into stdout as follows: - * - * pid = spawn(command, :err=>:out) - * pid = spawn(command, 2=>1) - * pid = spawn(command, STDERR=>:out) - * pid = spawn(command, STDERR=>STDOUT) - * - * The hash keys specifies a file descriptor - * in the child process started by <code>spawn</code>. - * :err, 2 and STDERR specifies the standard error stream (stderr). - * - * The hash values specifies a file descriptor - * in the parent process which invokes <code>spawn</code>. - * :out, 1 and STDOUT specifies the standard output stream (stdout). - * - * In the above example, - * the standard output in the child process is not specified. - * So it is inherited from the parent process. - * - * The standard input stream (stdin) can be specified by :in, 0 and STDIN. - * - * A filename can be specified as a hash value. - * - * pid = spawn(command, :in=>"/dev/null") # read mode - * pid = spawn(command, :out=>"/dev/null") # write mode - * pid = spawn(command, :err=>"log") # write mode - * pid = spawn(command, [:out, :err]=>"/dev/null") # write mode - * pid = spawn(command, 3=>"/dev/null") # read mode + * spawn([env, ] command_line, options = {}) -> pid + * spawn([env, ] exe_path, *args, options = {}) -> pid + * + * Creates a new child process by doing one of the following + * in that process: + * + * - Passing string +command_line+ to the shell. + * - Invoking the executable at +exe_path+. + * + * This method has potential security vulnerabilities if called with untrusted input; + * see {Command Injection}[rdoc-ref:security/command_injection.rdoc]. + * + * Returns the process ID (pid) of the new process, + * without waiting for it to complete. * - * For stdout and stderr (and combination of them), - * it is opened in write mode. - * Otherwise read mode is used. + * To avoid zombie processes, the parent process should call either: * - * For specifying flags and permission of file creation explicitly, - * an array is used instead. + * - Process.wait, to collect the termination statuses of its children. + * - Process.detach, to register disinterest in their status. * - * pid = spawn(command, :in=>["file"]) # read mode is assumed - * pid = spawn(command, :in=>["file", "r"]) - * pid = spawn(command, :out=>["log", "w"]) # 0644 assumed - * pid = spawn(command, :out=>["log", "w", 0600]) - * pid = spawn(command, :out=>["log", File::WRONLY|File::EXCL|File::CREAT, 0600]) + * The new process is created using the + * {exec system call}[https://pubs.opengroup.org/onlinepubs/9699919799.2018edition/functions/execve.html]; + * it may inherit some of its environment from the calling program + * (possibly including open file descriptors). * - * The array specifies a filename, flags and permission. - * The flags can be a string or an integer. - * If the flags is omitted or nil, File::RDONLY is assumed. - * The permission should be an integer. - * If the permission is omitted or nil, 0644 is assumed. + * Argument +env+, if given, is a hash that affects +ENV+ for the new process; + * see {Execution Environment}[rdoc-ref:Process@Execution+Environment]. * - * If an array of IOs and integers are specified as a hash key, - * all the elements are redirected. + * Argument +options+ is a hash of options for the new process; + * see {Execution Options}[rdoc-ref:Process@Execution+Options]. * - * # stdout and stderr is redirected to log file. - * # The file "log" is opened just once. - * pid = spawn(command, [:out, :err]=>["log", "w"]) + * The first required argument is one of the following: * - * Another way to merge multiple file descriptors is [:child, fd]. - * \[:child, fd] means the file descriptor in the child process. - * This is different from fd. - * For example, :err=>:out means redirecting child stderr to parent stdout. - * But :err=>[:child, :out] means redirecting child stderr to child stdout. - * They differ if stdout is redirected in the child process as follows. + * - +command_line+ if it is a string, + * and if it begins with a shell reserved word or special built-in, + * or if it contains one or more meta characters. + * - +exe_path+ otherwise. * - * # stdout and stderr is redirected to log file. - * # The file "log" is opened just once. - * pid = spawn(command, :out=>["log", "w"], :err=>[:child, :out]) + * <b>Argument +command_line+</b> * - * \[:child, :out] can be used to merge stderr into stdout in IO.popen. - * In this case, IO.popen redirects stdout to a pipe in the child process - * and [:child, :out] refers the redirected stdout. + * \String argument +command_line+ is a command line to be passed to a shell; + * it must begin with a shell reserved word, begin with a special built-in, + * or contain meta characters: * - * io = IO.popen(["sh", "-c", "echo out; echo err >&2", :err=>[:child, :out]]) - * p io.read #=> "out\nerr\n" + * spawn('if true; then echo "Foo"; fi') # => 798847 # Shell reserved word. + * Process.wait # => 798847 + * spawn('exit') # => 798848 # Built-in. + * Process.wait # => 798848 + * spawn('date > /tmp/date.tmp') # => 798879 # Contains meta character. + * Process.wait # => 798849 + * spawn('date > /nop/date.tmp') # => 798882 # Issues error message. + * Process.wait # => 798882 * - * The <code>:chdir</code> key in +options+ specifies the current directory. + * The command line may also contain arguments and options for the command: * - * pid = spawn(command, :chdir=>"/var/tmp") + * spawn('echo "Foo"') # => 799031 + * Process.wait # => 799031 * - * spawn closes all non-standard unspecified descriptors by default. - * The "standard" descriptors are 0, 1 and 2. - * This behavior is specified by :close_others option. - * :close_others doesn't affect the standard descriptors which are - * closed only if :close is specified explicitly. + * Output: * - * pid = spawn(command, :close_others=>true) # close 3,4,5,... (default) - * pid = spawn(command, :close_others=>false) # don't close 3,4,5,... + * Foo * - * :close_others is true by default for spawn and IO.popen. + * See {Execution Shell}[rdoc-ref:Process@Execution+Shell] for details about the shell. * - * Note that fds which close-on-exec flag is already set are closed - * regardless of :close_others option. + * Raises an exception if the new process could not execute. * - * So IO.pipe and spawn can be used as IO.popen. + * <b>Argument +exe_path+</b> * - * # similar to r = IO.popen(command) - * r, w = IO.pipe - * pid = spawn(command, :out=>w) # r, w is closed in the child process. - * w.close + * Argument +exe_path+ is one of the following: * - * :close is specified as a hash value to close a fd individually. + * - The string path to an executable to be called. + * - A 2-element array containing the path to an executable to be called, + * and the string to be used as the name of the executing process. * - * f = open(foo) - * system(command, f=>:close) # don't inherit f. + * spawn('/usr/bin/date') # Path to date on Unix-style system. + * Process.wait * - * If a file descriptor need to be inherited, - * io=>io can be used. + * Output: * - * # valgrind has --log-fd option for log destination. - * # log_w=>log_w indicates log_w.fileno inherits to child process. - * log_r, log_w = IO.pipe - * pid = spawn("valgrind", "--log-fd=#{log_w.fileno}", "echo", "a", log_w=>log_w) - * log_w.close - * p log_r.read + * Mon Aug 28 11:43:10 AM CDT 2023 * - * It is also possible to exchange file descriptors. + * Ruby invokes the executable directly. + * This form does not use the shell; + * see {Arguments args}[rdoc-ref:Process@Arguments+args] for caveats. * - * pid = spawn(command, :out=>:err, :err=>:out) + * If one or more +args+ is given, each is an argument or option + * to be passed to the executable: * - * The hash keys specify file descriptors in the child process. - * The hash values specifies file descriptors in the parent process. - * So the above specifies exchanging stdout and stderr. - * Internally, +spawn+ uses an extra file descriptor to resolve such cyclic - * file descriptor mapping. + * spawn('echo', 'C*') # => 799392 + * Process.wait # => 799392 + * spawn('echo', 'hello', 'world') # => 799393 + * Process.wait # => 799393 * - * See <code>Kernel.exec</code> for the standard shell. + * Output: + * + * C* + * hello world + * + * Raises an exception if the new process could not execute. */ static VALUE -rb_f_spawn(int argc, VALUE *argv) +rb_f_spawn(int argc, VALUE *argv, VALUE _) { rb_pid_t pid; char errmsg[CHILD_ERRMSG_BUFLEN] = { '\0' }; VALUE execarg_obj, fail_str; struct rb_execarg *eargp; - execarg_obj = rb_execarg_new(argc, argv, TRUE); + execarg_obj = rb_execarg_new(argc, argv, TRUE, FALSE); eargp = rb_execarg_get(execarg_obj); fail_str = eargp->use_shell ? eargp->invoke.sh.shell_script : eargp->invoke.cmd.command_name; pid = rb_execarg_spawn(execarg_obj, errmsg, sizeof(errmsg)); if (pid == -1) { - int err = errno; - rb_exec_fail(eargp, err, errmsg); - RB_GC_GUARD(execarg_obj); - rb_syserr_fail_str(err, fail_str); + int err = errno; + rb_exec_fail(eargp, err, errmsg); + RB_GC_GUARD(execarg_obj); + rb_syserr_fail_str(err, fail_str); } #if defined(HAVE_WORKING_FORK) || defined(HAVE_SPAWNV) return PIDT2NUM(pid); @@ -4349,55 +4942,59 @@ rb_f_spawn(int argc, VALUE *argv) /* * call-seq: - * sleep([duration]) -> fixnum - * - * Suspends the current thread for _duration_ seconds (which may be any number, - * including a +Float+ with fractional seconds). Returns the actual number of - * seconds slept (rounded), which may be less than that asked for if another - * thread calls <code>Thread#run</code>. Called without an argument, sleep() - * will sleep forever. - * - * Time.new #=> 2008-03-08 19:56:19 +0900 - * sleep 1.2 #=> 1 - * Time.new #=> 2008-03-08 19:56:20 +0900 - * sleep 1.9 #=> 2 - * Time.new #=> 2008-03-08 19:56:22 +0900 + * sleep(secs = nil) -> slept_secs + * + * Suspends execution of the current thread for the number of seconds + * specified by numeric argument +secs+, or forever if +secs+ is +nil+; + * returns the integer number of seconds suspended (rounded). + * + * Time.new # => 2008-03-08 19:56:19 +0900 + * sleep 1.2 # => 1 + * Time.new # => 2008-03-08 19:56:20 +0900 + * sleep 1.9 # => 2 + * Time.new # => 2008-03-08 19:56:22 +0900 + * */ static VALUE -rb_f_sleep(int argc, VALUE *argv) +rb_f_sleep(int argc, VALUE *argv, VALUE _) { - time_t beg, end; + time_t beg = time(0); + VALUE scheduler = rb_fiber_scheduler_current(); - beg = time(0); - if (argc == 0) { - rb_thread_sleep_forever(); + if (scheduler != Qnil) { + rb_fiber_scheduler_kernel_sleepv(scheduler, argc, argv); } else { - rb_check_arity(argc, 0, 1); - rb_thread_wait_for(rb_time_interval(argv[0])); + if (argc == 0 || (argc == 1 && NIL_P(argv[0]))) { + rb_thread_sleep_forever(); + } + else { + rb_check_arity(argc, 0, 1); + rb_thread_wait_for(rb_time_interval(argv[0])); + } } - end = time(0) - beg; + time_t end = time(0) - beg; - return INT2FIX(end); + return TIMET2NUM(end); } #if (defined(HAVE_GETPGRP) && defined(GETPGRP_VOID)) || defined(HAVE_GETPGID) /* * call-seq: - * Process.getpgrp -> integer + * Process.getpgrp -> integer * - * Returns the process group ID for this process. Not available on - * all platforms. + * Returns the process group ID for the current process: + * + * Process.getpgid(0) # => 25527 + * Process.getpgrp # => 25527 * - * Process.getpgid(0) #=> 25527 - * Process.getpgrp #=> 25527 */ static VALUE -proc_getpgrp(void) +proc_getpgrp(VALUE _) { rb_pid_t pgrp; @@ -4419,14 +5016,15 @@ proc_getpgrp(void) #if defined(HAVE_SETPGID) || (defined(HAVE_SETPGRP) && defined(SETPGRP_VOID)) /* * call-seq: - * Process.setpgrp -> 0 + * Process.setpgrp -> 0 + * + * Equivalent to <tt>setpgid(0, 0)</tt>. * - * Equivalent to <code>setpgid(0,0)</code>. Not available on all - * platforms. + * Not available on all platforms. */ static VALUE -proc_setpgrp(void) +proc_setpgrp(VALUE _) { /* check for posix setpgid() first; this matches the posix */ /* getpgrp() above. It appears that configure will set SETPGRP_VOID */ @@ -4447,12 +5045,13 @@ proc_setpgrp(void) #if defined(HAVE_GETPGID) /* * call-seq: - * Process.getpgid(pid) -> integer + * Process.getpgid(pid) -> integer * - * Returns the process group ID for the given process id. Not - * available on all platforms. + * Returns the process group ID for the given process ID +pid+: + * + * Process.getpgid(Process.ppid) # => 25527 * - * Process.getpgid(Process.ppid()) #=> 25527 + * Not available on all platforms. */ static VALUE @@ -4472,10 +5071,12 @@ proc_getpgid(VALUE obj, VALUE pid) #ifdef HAVE_SETPGID /* * call-seq: - * Process.setpgid(pid, integer) -> 0 + * Process.setpgid(pid, pgid) -> 0 + * + * Sets the process group ID for the process given by process ID +pid+ + * to +pgid+. * - * Sets the process group ID of _pid_ (0 indicates this - * process) to <em>integer</em>. Not available on all platforms. + * Not available on all platforms. */ static VALUE @@ -4497,28 +5098,27 @@ proc_setpgid(VALUE obj, VALUE pid, VALUE pgrp) #ifdef HAVE_GETSID /* * call-seq: - * Process.getsid() -> integer - * Process.getsid(pid) -> integer + * Process.getsid(pid = nil) -> integer + * + * Returns the session ID of the given process ID +pid+, + * or of the current process if not given: * - * Returns the session ID for for the given process id. If not give, - * return current process sid. Not available on all platforms. + * Process.getsid # => 27422 + * Process.getsid(0) # => 27422 + * Process.getsid(Process.pid()) # => 27422 * - * Process.getsid() #=> 27422 - * Process.getsid(0) #=> 27422 - * Process.getsid(Process.pid()) #=> 27422 + * Not available on all platforms. */ static VALUE -proc_getsid(int argc, VALUE *argv) +proc_getsid(int argc, VALUE *argv, VALUE _) { rb_pid_t sid; - VALUE pid; - - rb_scan_args(argc, argv, "01", &pid); + rb_pid_t pid = 0; - if (NIL_P(pid)) - pid = INT2FIX(0); + if (rb_check_arity(argc, 0, 1) == 1 && !NIL_P(argv[0])) + pid = NUM2PIDT(argv[0]); - sid = getsid(NUM2PIDT(pid)); + sid = getsid(pid); if (sid < 0) rb_sys_fail(0); return PIDT2NUM(sid); } @@ -4534,17 +5134,19 @@ static rb_pid_t ruby_setsid(void); #endif /* * call-seq: - * Process.setsid -> fixnum + * Process.setsid -> integer * - * Establishes this process as a new session and process group - * leader, with no controlling tty. Returns the session id. Not - * available on all platforms. + * Establishes the current process as a new session and process group leader, + * with no controlling tty; + * returns the session ID: * - * Process.setsid #=> 27422 + * Process.setsid # => 27422 + * + * Not available on all platforms. */ static VALUE -proc_setsid(void) +proc_setsid(VALUE _) { rb_pid_t pid; @@ -4559,7 +5161,7 @@ static rb_pid_t ruby_setsid(void) { rb_pid_t pid; - int ret; + int ret, fd; pid = getpid(); #if defined(SETPGRP_VOID) @@ -4574,8 +5176,8 @@ ruby_setsid(void) if ((fd = rb_cloexec_open("/dev/tty", O_RDWR, 0)) >= 0) { rb_update_max_fd(fd); - ioctl(fd, TIOCNOTTY, NULL); - close(fd); + ioctl(fd, TIOCNOTTY, NULL); + close(fd); } return pid; } @@ -4588,19 +5190,26 @@ ruby_setsid(void) #ifdef HAVE_GETPRIORITY /* * call-seq: - * Process.getpriority(kind, integer) -> fixnum - * - * Gets the scheduling priority for specified process, process group, - * or user. <em>kind</em> indicates the kind of entity to find: one - * of <code>Process::PRIO_PGRP</code>, - * <code>Process::PRIO_USER</code>, or - * <code>Process::PRIO_PROCESS</code>. _integer_ is an id - * indicating the particular process, process group, or user (an id - * of 0 means _current_). Lower priorities are more favorable - * for scheduling. Not available on all platforms. - * - * Process.getpriority(Process::PRIO_USER, 0) #=> 19 - * Process.getpriority(Process::PRIO_PROCESS, 0) #=> 19 + * Process.getpriority(kind, id) -> integer + * + * Returns the scheduling priority for specified process, process group, + * or user. + * + * Argument +kind+ is one of: + * + * - Process::PRIO_PROCESS: return priority for process. + * - Process::PRIO_PGRP: return priority for process group. + * - Process::PRIO_USER: return priority for user. + * + * Argument +id+ is the ID for the process, process group, or user; + * zero specified the current ID for +kind+. + * + * Examples: + * + * Process.getpriority(Process::PRIO_USER, 0) # => 19 + * Process.getpriority(Process::PRIO_PROCESS, 0) # => 19 + * + * Not available on all platforms. */ static VALUE @@ -4624,14 +5233,18 @@ proc_getpriority(VALUE obj, VALUE which, VALUE who) #ifdef HAVE_GETPRIORITY /* * call-seq: - * Process.setpriority(kind, integer, priority) -> 0 + * Process.setpriority(kind, integer, priority) -> 0 * - * See <code>Process#getpriority</code>. + * See Process.getpriority. * - * Process.setpriority(Process::PRIO_USER, 0, 19) #=> 0 - * Process.setpriority(Process::PRIO_PROCESS, 0, 19) #=> 0 - * Process.getpriority(Process::PRIO_USER, 0) #=> 19 - * Process.getpriority(Process::PRIO_PROCESS, 0) #=> 19 + * Examples: + * + * Process.setpriority(Process::PRIO_USER, 0, 19) # => 0 + * Process.setpriority(Process::PRIO_PROCESS, 0, 19) # => 0 + * Process.getpriority(Process::PRIO_USER, 0) # => 19 + * Process.getpriority(Process::PRIO_PROCESS, 0) # => 19 + * + * Not available on all platforms. */ static VALUE @@ -4644,7 +5257,7 @@ proc_setpriority(VALUE obj, VALUE which, VALUE who, VALUE prio) iprio = NUM2INT(prio); if (setpriority(iwhich, iwho, iprio) < 0) - rb_sys_fail(0); + rb_sys_fail(0); return INT2FIX(0); } #else @@ -4653,13 +5266,13 @@ proc_setpriority(VALUE obj, VALUE which, VALUE who, VALUE prio) #if defined(HAVE_SETRLIMIT) && defined(NUM2RLIM) static int -rlimit_resource_name2int(const char *name, int casetype) +rlimit_resource_name2int(const char *name, long len, int casetype) { int resource; const char *p; #define RESCHECK(r) \ do { \ - if (STRCASECMP(name, #r) == 0) { \ + if (len == rb_strlen_lit(#r) && STRCASECMP(name, #r) == 0) { \ resource = RLIMIT_##r; \ goto found; \ } \ @@ -4709,6 +5322,9 @@ rlimit_resource_name2int(const char *name, int casetype) #ifdef RLIMIT_NPROC RESCHECK(NPROC); #endif +#ifdef RLIMIT_NPTS + RESCHECK(NPTS); +#endif #ifdef RLIMIT_NICE RESCHECK(NICE); #endif @@ -4762,28 +5378,48 @@ rlimit_resource_name2int(const char *name, int casetype) } static int -rlimit_type_by_hname(const char *name) +rlimit_type_by_hname(const char *name, long len) { - return rlimit_resource_name2int(name, 0); + return rlimit_resource_name2int(name, len, 0); } static int -rlimit_type_by_lname(const char *name) +rlimit_type_by_lname(const char *name, long len) { - return rlimit_resource_name2int(name, 1); + return rlimit_resource_name2int(name, len, 1); +} + +static int +rlimit_type_by_sym(VALUE key) +{ + VALUE name = rb_sym2str(key); + const char *rname = RSTRING_PTR(name); + long len = RSTRING_LEN(name); + int rtype = -1; + static const char prefix[] = "rlimit_"; + enum {prefix_len = sizeof(prefix)-1}; + + if (len > prefix_len && strncmp(prefix, rname, prefix_len) == 0) { + rtype = rlimit_type_by_lname(rname + prefix_len, len - prefix_len); + } + + RB_GC_GUARD(key); + return rtype; } static int rlimit_resource_type(VALUE rtype) { const char *name; + long len; VALUE v; int r; switch (TYPE(rtype)) { case T_SYMBOL: - v = rb_sym2str(rtype); - name = RSTRING_PTR(v); + v = rb_sym2str(rtype); + name = RSTRING_PTR(v); + len = RSTRING_LEN(v); break; default: @@ -4792,6 +5428,7 @@ rlimit_resource_type(VALUE rtype) rtype = v; case T_STRING: name = StringValueCStr(rtype); + len = RSTRING_LEN(rtype); break; } /* fall through */ @@ -4801,13 +5438,13 @@ rlimit_resource_type(VALUE rtype) return NUM2INT(rtype); } - r = rlimit_type_by_hname(name); + r = rlimit_type_by_hname(name, len); if (r != -1) return r; - rb_raise(rb_eArgError, "invalid resource name: %"PRIsVALUE, rtype); + rb_raise(rb_eArgError, "invalid resource name: % "PRIsVALUE, rtype); - UNREACHABLE; + UNREACHABLE_RETURN(-1); } static rlim_t @@ -4818,8 +5455,8 @@ rlimit_resource_value(VALUE rval) switch (TYPE(rval)) { case T_SYMBOL: - v = rb_sym2str(rval); - name = RSTRING_PTR(v); + v = rb_sym2str(rval); + name = RSTRING_PTR(v); break; default: @@ -4848,29 +5485,31 @@ rlimit_resource_value(VALUE rval) #endif rb_raise(rb_eArgError, "invalid resource value: %"PRIsVALUE, rval); - UNREACHABLE; + UNREACHABLE_RETURN((rlim_t)-1); } #endif #if defined(HAVE_GETRLIMIT) && defined(RLIM2NUM) /* * call-seq: - * Process.getrlimit(resource) -> [cur_limit, max_limit] - * - * Gets the resource limit of the process. - * _cur_limit_ means current (soft) limit and - * _max_limit_ means maximum (hard) limit. - * - * _resource_ indicates the kind of resource to limit. - * It is specified as a symbol such as <code>:CORE</code>, - * a string such as <code>"CORE"</code> or - * a constant such as <code>Process::RLIMIT_CORE</code>. - * See Process.setrlimit for details. - * - * _cur_limit_ and _max_limit_ may be <code>Process::RLIM_INFINITY</code>, - * <code>Process::RLIM_SAVED_MAX</code> or - * <code>Process::RLIM_SAVED_CUR</code>. - * See Process.setrlimit and the system getrlimit(2) manual for details. + * Process.getrlimit(resource) -> [cur_limit, max_limit] + * + * Returns a 2-element array of the current (soft) limit + * and maximum (hard) limit for the given +resource+. + * + * Argument +resource+ specifies the resource whose limits are to be returned; + * see Process.setrlimit. + * + * Each of the returned values +cur_limit+ and +max_limit+ is an integer; + * see Process.setrlimit. + * + * Example: + * + * Process.getrlimit(:CORE) # => [0, 18446744073709551615] + * + * See Process.setrlimit. + * + * Not available on all platforms. */ static VALUE @@ -4879,7 +5518,7 @@ proc_getrlimit(VALUE obj, VALUE resource) struct rlimit rlim; if (getrlimit(rlimit_resource_type(resource), &rlim) < 0) { - rb_sys_fail("getrlimit"); + rb_sys_fail("getrlimit"); } return rb_assoc_new(RLIM2NUM(rlim.rlim_cur), RLIM2NUM(rlim.rlim_max)); } @@ -4890,53 +5529,54 @@ proc_getrlimit(VALUE obj, VALUE resource) #if defined(HAVE_SETRLIMIT) && defined(NUM2RLIM) /* * call-seq: - * Process.setrlimit(resource, cur_limit, max_limit) -> nil - * Process.setrlimit(resource, cur_limit) -> nil - * - * Sets the resource limit of the process. - * _cur_limit_ means current (soft) limit and - * _max_limit_ means maximum (hard) limit. - * - * If _max_limit_ is not given, _cur_limit_ is used. - * - * _resource_ indicates the kind of resource to limit. - * It should be a symbol such as <code>:CORE</code>, - * a string such as <code>"CORE"</code> or - * a constant such as <code>Process::RLIMIT_CORE</code>. - * The available resources are OS dependent. - * Ruby may support following resources. - * - * [AS] total available memory (bytes) (SUSv3, NetBSD, FreeBSD, OpenBSD but 4.4BSD-Lite) - * [CORE] core size (bytes) (SUSv3) - * [CPU] CPU time (seconds) (SUSv3) - * [DATA] data segment (bytes) (SUSv3) - * [FSIZE] file size (bytes) (SUSv3) - * [MEMLOCK] total size for mlock(2) (bytes) (4.4BSD, GNU/Linux) - * [MSGQUEUE] allocation for POSIX message queues (bytes) (GNU/Linux) - * [NICE] ceiling on process's nice(2) value (number) (GNU/Linux) - * [NOFILE] file descriptors (number) (SUSv3) - * [NPROC] number of processes for the user (number) (4.4BSD, GNU/Linux) - * [RSS] resident memory size (bytes) (4.2BSD, GNU/Linux) - * [RTPRIO] ceiling on the process's real-time priority (number) (GNU/Linux) - * [RTTIME] CPU time for real-time process (us) (GNU/Linux) - * [SBSIZE] all socket buffers (bytes) (NetBSD, FreeBSD) - * [SIGPENDING] number of queued signals allowed (signals) (GNU/Linux) - * [STACK] stack size (bytes) (SUSv3) - * - * _cur_limit_ and _max_limit_ may be - * <code>:INFINITY</code>, <code>"INFINITY"</code> or - * <code>Process::RLIM_INFINITY</code>, - * which means that the resource is not limited. - * They may be <code>Process::RLIM_SAVED_MAX</code>, - * <code>Process::RLIM_SAVED_CUR</code> and - * corresponding symbols and strings too. - * See system setrlimit(2) manual for details. - * - * The following example raises the soft limit of core size to - * the hard limit to try to make core dump possible. + * Process.setrlimit(resource, cur_limit, max_limit = cur_limit) -> nil + * + * Sets limits for the current process for the given +resource+ + * to +cur_limit+ (soft limit) and +max_limit+ (hard limit); + * returns +nil+. + * + * Argument +resource+ specifies the resource whose limits are to be set; + * the argument may be given as a symbol, as a string, or as a constant + * beginning with <tt>Process::RLIMIT_</tt> + * (e.g., +:CORE+, <tt>'CORE'</tt>, or <tt>Process::RLIMIT_CORE</tt>. + * + * The resources available and supported are system-dependent, + * and may include (here expressed as symbols): + * + * - +:AS+: Total available memory (bytes) (SUSv3, NetBSD, FreeBSD, OpenBSD except 4.4BSD-Lite). + * - +:CORE+: Core size (bytes) (SUSv3). + * - +:CPU+: CPU time (seconds) (SUSv3). + * - +:DATA+: Data segment (bytes) (SUSv3). + * - +:FSIZE+: File size (bytes) (SUSv3). + * - +:MEMLOCK+: Total size for mlock(2) (bytes) (4.4BSD, GNU/Linux). + * - +:MSGQUEUE+: Allocation for POSIX message queues (bytes) (GNU/Linux). + * - +:NICE+: Ceiling on process's nice(2) value (number) (GNU/Linux). + * - +:NOFILE+: File descriptors (number) (SUSv3). + * - +:NPROC+: Number of processes for the user (number) (4.4BSD, GNU/Linux). + * - +:NPTS+: Number of pseudo terminals (number) (FreeBSD). + * - +:RSS+: Resident memory size (bytes) (4.2BSD, GNU/Linux). + * - +:RTPRIO+: Ceiling on the process's real-time priority (number) (GNU/Linux). + * - +:RTTIME+: CPU time for real-time process (us) (GNU/Linux). + * - +:SBSIZE+: All socket buffers (bytes) (NetBSD, FreeBSD). + * - +:SIGPENDING+: Number of queued signals allowed (signals) (GNU/Linux). + * - +:STACK+: Stack size (bytes) (SUSv3). + * + * Arguments +cur_limit+ and +max_limit+ may be: + * + * - Integers (+max_limit+ should not be smaller than +cur_limit+). + * - Symbol +:SAVED_MAX+, string <tt>'SAVED_MAX'</tt>, + * or constant <tt>Process::RLIM_SAVED_MAX</tt>: saved maximum limit. + * - Symbol +:SAVED_CUR+, string <tt>'SAVED_CUR'</tt>, + * or constant <tt>Process::RLIM_SAVED_CUR</tt>: saved current limit. + * - Symbol +:INFINITY+, string <tt>'INFINITY'</tt>, + * or constant <tt>Process::RLIM_INFINITY</tt>: no limit on resource. + * + * This example raises the soft limit of core size to + * the hard limit to try to make core dump possible: * * Process.setrlimit(:CORE, Process.getrlimit(:CORE)[1]) * + * Not available on all platforms. */ static VALUE @@ -4945,15 +5585,17 @@ proc_setrlimit(int argc, VALUE *argv, VALUE obj) VALUE resource, rlim_cur, rlim_max; struct rlimit rlim; - rb_scan_args(argc, argv, "21", &resource, &rlim_cur, &rlim_max); - if (rlim_max == Qnil) + rb_check_arity(argc, 2, 3); + resource = argv[0]; + rlim_cur = argv[1]; + if (argc < 3 || NIL_P(rlim_max = argv[2])) rlim_max = rlim_cur; rlim.rlim_cur = rlimit_resource_value(rlim_cur); rlim.rlim_max = rlimit_resource_value(rlim_max); if (setrlimit(rlimit_resource_type(resource), &rlim) < 0) { - rb_sys_fail("setrlimit"); + rb_sys_fail("setrlimit"); } return Qnil; } @@ -4966,7 +5608,7 @@ static void check_uid_switch(void) { if (under_uid_switch) { - rb_raise(rb_eRuntimeError, "can't handle UID while evaluating block given to Process::UID.switch method"); + rb_raise(rb_eRuntimeError, "can't handle UID while evaluating block given to Process::UID.switch method"); } } @@ -4975,26 +5617,321 @@ static void check_gid_switch(void) { if (under_gid_switch) { - rb_raise(rb_eRuntimeError, "can't handle GID while evaluating block given to Process::UID.switch method"); + rb_raise(rb_eRuntimeError, "can't handle GID while evaluating block given to Process::UID.switch method"); + } +} + + +#if defined(HAVE_PWD_H) +static inline bool +login_not_found(int err) +{ + return (err == ENOTTY || err == ENXIO || err == ENOENT); +} + +/** + * Best-effort attempt to obtain the name of the login user, if any, + * associated with the process. Processes not descended from login(1) (or + * similar) may not have a logged-in user; returns Qnil in that case. + */ +VALUE +rb_getlogin(void) +{ +# if !defined(USE_GETLOGIN_R) && !defined(USE_GETLOGIN) + return Qnil; +# else + char MAYBE_UNUSED(*login) = NULL; + +# ifdef USE_GETLOGIN_R + +# if defined(__FreeBSD__) + typedef int getlogin_r_size_t; +# else + typedef size_t getlogin_r_size_t; +# endif + + long loginsize = GETLOGIN_R_SIZE_INIT; /* maybe -1 */ + + if (loginsize < 0) + loginsize = GETLOGIN_R_SIZE_DEFAULT; + + VALUE maybe_result = rb_str_buf_new(loginsize); + + login = RSTRING_PTR(maybe_result); + loginsize = rb_str_capacity(maybe_result); + rb_str_set_len(maybe_result, loginsize); + + int gle; + while ((gle = getlogin_r(login, (getlogin_r_size_t)loginsize)) != 0) { + if (login_not_found(gle)) { + rb_str_resize(maybe_result, 0); + return Qnil; + } + + if (gle != ERANGE || loginsize >= GETLOGIN_R_SIZE_LIMIT) { + rb_str_resize(maybe_result, 0); + rb_syserr_fail(gle, "getlogin_r"); + } + + rb_str_modify_expand(maybe_result, loginsize); + login = RSTRING_PTR(maybe_result); + loginsize = rb_str_capacity(maybe_result); + } + + if (login == NULL) { + rb_str_resize(maybe_result, 0); + return Qnil; + } + + rb_str_set_len(maybe_result, strlen(login)); + return maybe_result; + +# elif defined(USE_GETLOGIN) + + errno = 0; + login = getlogin(); + int err = errno; + if (err) { + if (login_not_found(err)) { + return Qnil; + } + rb_syserr_fail(err, "getlogin"); + } + + return login ? rb_str_new_cstr(login) : Qnil; +# endif + +#endif +} + +/* avoid treating as errors errno values that indicate "not found" */ +static inline bool +pwd_not_found(int err) +{ + switch (err) { + case 0: + case ENOENT: + case ESRCH: + case EBADF: + case EPERM: + return true; + default: + return false; + } +} + +# if defined(USE_GETPWNAM_R) +struct getpwnam_r_args { + const char *login; + char *buf; + size_t bufsize; + struct passwd *result; + struct passwd pwstore; +}; + +# define GETPWNAM_R_ARGS(login_, buf_, bufsize_) (struct getpwnam_r_args) \ + {.login = login_, .buf = buf_, .bufsize = bufsize_, .result = NULL} + +static void * +nogvl_getpwnam_r(void *args) +{ + struct getpwnam_r_args *arg = args; + return (void *)(VALUE)getpwnam_r(arg->login, &arg->pwstore, arg->buf, arg->bufsize, &arg->result); +} +# endif + +VALUE +rb_getpwdirnam_for_login(VALUE login_name) +{ +#if !defined(USE_GETPWNAM_R) && !defined(USE_GETPWNAM) + return Qnil; +#else + + if (NIL_P(login_name)) { + /* nothing to do; no name with which to query the password database */ + return Qnil; + } + + const char *login = RSTRING_PTR(login_name); + + +# ifdef USE_GETPWNAM_R + + char *bufnm; + long bufsizenm = GETPW_R_SIZE_INIT; /* maybe -1 */ + + if (bufsizenm < 0) + bufsizenm = GETPW_R_SIZE_DEFAULT; + + VALUE getpwnm_tmp = rb_str_tmp_new(bufsizenm); + + bufnm = RSTRING_PTR(getpwnm_tmp); + bufsizenm = rb_str_capacity(getpwnm_tmp); + rb_str_set_len(getpwnm_tmp, bufsizenm); + struct getpwnam_r_args args = GETPWNAM_R_ARGS(login, bufnm, (size_t)bufsizenm); + + int enm; + while ((enm = IO_WITHOUT_GVL_INT(nogvl_getpwnam_r, &args)) != 0) { + if (pwd_not_found(enm)) { + rb_str_resize(getpwnm_tmp, 0); + return Qnil; + } + + if (enm != ERANGE || args.bufsize >= GETPW_R_SIZE_LIMIT) { + rb_str_resize(getpwnm_tmp, 0); + rb_syserr_fail(enm, "getpwnam_r"); + } + + rb_str_modify_expand(getpwnm_tmp, (long)args.bufsize); + args.buf = RSTRING_PTR(getpwnm_tmp); + args.bufsize = (size_t)rb_str_capacity(getpwnm_tmp); + } + + if (args.result == NULL) { + /* no record in the password database for the login name */ + rb_str_resize(getpwnm_tmp, 0); + return Qnil; + } + + /* found it */ + VALUE result = rb_str_new_cstr(args.result->pw_dir); + rb_str_resize(getpwnm_tmp, 0); + return result; + +# elif defined(USE_GETPWNAM) + + struct passwd *pwptr; + errno = 0; + if (!(pwptr = getpwnam(login))) { + int err = errno; + + if (pwd_not_found(err)) { + return Qnil; + } + + rb_syserr_fail(err, "getpwnam"); } + + /* found it */ + return rb_str_new_cstr(pwptr->pw_dir); +# endif + +#endif } +# if defined(USE_GETPWUID_R) +struct getpwuid_r_args { + uid_t uid; + char *buf; + size_t bufsize; + struct passwd *result; + struct passwd pwstore; +}; + +# define GETPWUID_R_ARGS(uid_, buf_, bufsize_) (struct getpwuid_r_args) \ + {.uid = uid_, .buf = buf_, .bufsize = bufsize_, .result = NULL} + +static void * +nogvl_getpwuid_r(void *args) +{ + struct getpwuid_r_args *arg = args; + return (void *)(VALUE)getpwuid_r(arg->uid, &arg->pwstore, arg->buf, arg->bufsize, &arg->result); +} +# endif + +/** + * Look up the user's dflt home dir in the password db, by uid. + */ +VALUE +rb_getpwdiruid(void) +{ +# if !defined(USE_GETPWUID_R) && !defined(USE_GETPWUID) + /* Should never happen... </famous-last-words> */ + return Qnil; +# else + uid_t ruid = getuid(); + +# ifdef USE_GETPWUID_R + + char *bufid; + long bufsizeid = GETPW_R_SIZE_INIT; /* maybe -1 */ + + if (bufsizeid < 0) + bufsizeid = GETPW_R_SIZE_DEFAULT; + + VALUE getpwid_tmp = rb_str_tmp_new(bufsizeid); + + bufid = RSTRING_PTR(getpwid_tmp); + bufsizeid = rb_str_capacity(getpwid_tmp); + rb_str_set_len(getpwid_tmp, bufsizeid); + struct getpwuid_r_args args = GETPWUID_R_ARGS(ruid, bufid, (size_t)bufsizeid); + + int eid; + while ((eid = IO_WITHOUT_GVL_INT(nogvl_getpwuid_r, &args)) != 0) { + if (pwd_not_found(eid)) { + rb_str_resize(getpwid_tmp, 0); + return Qnil; + } + + if (eid != ERANGE || args.bufsize >= GETPW_R_SIZE_LIMIT) { + rb_str_resize(getpwid_tmp, 0); + rb_syserr_fail(eid, "getpwuid_r"); + } + + rb_str_modify_expand(getpwid_tmp, (long)args.bufsize); + args.buf = RSTRING_PTR(getpwid_tmp); + args.bufsize = (size_t)rb_str_capacity(getpwid_tmp); + } + + if (args.result == NULL) { + /* no record in the password database for the uid */ + rb_str_resize(getpwid_tmp, 0); + return Qnil; + } + + /* found it */ + VALUE result = rb_str_new_cstr(args.result->pw_dir); + rb_str_resize(getpwid_tmp, 0); + return result; + +# elif defined(USE_GETPWUID) + + struct passwd *pwptr; + errno = 0; + if (!(pwptr = getpwuid(ruid))) { + int err = errno; + + if (pwd_not_found(err)) { + return Qnil; + } + + rb_syserr_fail(err, "getpwuid"); + } + + /* found it */ + return rb_str_new_cstr(pwptr->pw_dir); +# endif + +#endif /* !defined(USE_GETPWUID_R) && !defined(USE_GETPWUID) */ +} +#endif /* HAVE_PWD_H */ + /********************************************************************* * Document-class: Process::Sys * - * The <code>Process::Sys</code> module contains UID and GID + * The Process::Sys module contains UID and GID * functions which provide direct bindings to the system calls of the * same names instead of the more-portable versions of the same - * functionality found in the <code>Process</code>, - * <code>Process::UID</code>, and <code>Process::GID</code> modules. + * functionality found in the +Process+, + * Process::UID, and Process::GID modules. */ #if defined(HAVE_PWD_H) static rb_uid_t obj2uid(VALUE id # ifdef USE_GETPWNAM_R - , VALUE *getpw_tmp + , VALUE *getpw_tmp # endif ) { @@ -5002,47 +5939,48 @@ obj2uid(VALUE id VALUE tmp; if (FIXNUM_P(id) || NIL_P(tmp = rb_check_string_type(id))) { - uid = NUM2UIDT(id); + uid = NUM2UIDT(id); } else { - const char *usrname = StringValueCStr(id); - struct passwd *pwptr; + const char *usrname = StringValueCStr(id); + struct passwd *pwptr; #ifdef USE_GETPWNAM_R - struct passwd pwbuf; - char *getpw_buf; - long getpw_buf_len; - if (!*getpw_tmp) { - getpw_buf_len = GETPW_R_SIZE_INIT; - if (getpw_buf_len < 0) getpw_buf_len = GETPW_R_SIZE_DEFAULT; - getpw_buf = rb_alloc_tmp_buffer(getpw_tmp, getpw_buf_len); - } - else { - getpw_buf = RSTRING_PTR(*getpw_tmp); - getpw_buf_len = rb_str_capacity(*getpw_tmp); - } - errno = ERANGE; - /* gepwnam_r() on MacOS X doesn't set errno if buffer size is insufficient */ - while (getpwnam_r(usrname, &pwbuf, getpw_buf, getpw_buf_len, &pwptr)) { - if (errno != ERANGE || getpw_buf_len >= GETPW_R_SIZE_LIMIT) { - rb_free_tmp_buffer(getpw_tmp); - rb_sys_fail("getpwnam_r"); - } - rb_str_modify_expand(*getpw_tmp, getpw_buf_len); - getpw_buf = RSTRING_PTR(*getpw_tmp); - getpw_buf_len = rb_str_capacity(*getpw_tmp); - } + char *getpw_buf; + long getpw_buf_len; + int e; + if (!*getpw_tmp) { + getpw_buf_len = GETPW_R_SIZE_INIT; + if (getpw_buf_len < 0) getpw_buf_len = GETPW_R_SIZE_DEFAULT; + *getpw_tmp = rb_str_tmp_new(getpw_buf_len); + } + getpw_buf = RSTRING_PTR(*getpw_tmp); + getpw_buf_len = rb_str_capacity(*getpw_tmp); + rb_str_set_len(*getpw_tmp, getpw_buf_len); + errno = 0; + struct getpwnam_r_args args = GETPWNAM_R_ARGS((char *)usrname, getpw_buf, (size_t)getpw_buf_len); + + while ((e = IO_WITHOUT_GVL_INT(nogvl_getpwnam_r, &args)) != 0) { + if (e != ERANGE || args.bufsize >= GETPW_R_SIZE_LIMIT) { + rb_str_resize(*getpw_tmp, 0); + rb_syserr_fail(e, "getpwnam_r"); + } + rb_str_modify_expand(*getpw_tmp, (long)args.bufsize); + args.buf = RSTRING_PTR(*getpw_tmp); + args.bufsize = (size_t)rb_str_capacity(*getpw_tmp); + } + pwptr = args.result; #else - pwptr = getpwnam(usrname); + pwptr = getpwnam(usrname); #endif - if (!pwptr) { + if (!pwptr) { #ifndef USE_GETPWNAM_R - endpwent(); + endpwent(); #endif - rb_raise(rb_eArgError, "can't find user for %s", usrname); - } - uid = pwptr->pw_uid; + rb_raise(rb_eArgError, "can't find user for %"PRIsVALUE, id); + } + uid = pwptr->pw_uid; #ifndef USE_GETPWNAM_R - endpwent(); + endpwent(); #endif } return uid; @@ -5069,10 +6007,30 @@ p_uid_from_name(VALUE self, VALUE id) #endif #if defined(HAVE_GRP_H) +# if defined(USE_GETGRNAM_R) +struct getgrnam_r_args { + const char *name; + char *buf; + size_t bufsize; + struct group *result; + struct group grp; +}; + +# define GETGRNAM_R_ARGS(name_, buf_, bufsize_) (struct getgrnam_r_args) \ + {.name = name_, .buf = buf_, .bufsize = bufsize_, .result = NULL} + +static void * +nogvl_getgrnam_r(void *args) +{ + struct getgrnam_r_args *arg = args; + return (void *)(VALUE)getgrnam_r(arg->name, &arg->grp, arg->buf, arg->bufsize, &arg->result); +} +# endif + static rb_gid_t obj2gid(VALUE id # ifdef USE_GETGRNAM_R - , VALUE *getgr_tmp + , VALUE *getgr_tmp # endif ) { @@ -5080,49 +6038,50 @@ obj2gid(VALUE id VALUE tmp; if (FIXNUM_P(id) || NIL_P(tmp = rb_check_string_type(id))) { - gid = NUM2GIDT(id); + gid = NUM2GIDT(id); } else { - const char *grpname = StringValueCStr(id); - struct group *grptr; + const char *grpname = StringValueCStr(id); + struct group *grptr; #ifdef USE_GETGRNAM_R - struct group grbuf; - char *getgr_buf; - long getgr_buf_len; - if (!*getgr_tmp) { - getgr_buf_len = GETGR_R_SIZE_INIT; - if (getgr_buf_len < 0) getgr_buf_len = GETGR_R_SIZE_DEFAULT; - getgr_buf = rb_alloc_tmp_buffer(getgr_tmp, getgr_buf_len); - } - else { - getgr_buf = RSTRING_PTR(*getgr_tmp); - getgr_buf_len = rb_str_capacity(*getgr_tmp); - } - errno = ERANGE; - /* gegrnam_r() on MacOS X doesn't set errno if buffer size is insufficient */ - while (getgrnam_r(grpname, &grbuf, getgr_buf, getgr_buf_len, &grptr)) { - if (errno != ERANGE || getgr_buf_len >= GETGR_R_SIZE_LIMIT) { - rb_free_tmp_buffer(getgr_tmp); - rb_sys_fail("getgrnam_r"); - } - rb_str_modify_expand(*getgr_tmp, getgr_buf_len); - getgr_buf = RSTRING_PTR(*getgr_tmp); - getgr_buf_len = rb_str_capacity(*getgr_tmp); - } + char *getgr_buf; + long getgr_buf_len; + int e; + if (!*getgr_tmp) { + getgr_buf_len = GETGR_R_SIZE_INIT; + if (getgr_buf_len < 0) getgr_buf_len = GETGR_R_SIZE_DEFAULT; + *getgr_tmp = rb_str_tmp_new(getgr_buf_len); + } + getgr_buf = RSTRING_PTR(*getgr_tmp); + getgr_buf_len = rb_str_capacity(*getgr_tmp); + rb_str_set_len(*getgr_tmp, getgr_buf_len); + errno = 0; + struct getgrnam_r_args args = GETGRNAM_R_ARGS(grpname, getgr_buf, (size_t)getgr_buf_len); + + while ((e = IO_WITHOUT_GVL_INT(nogvl_getgrnam_r, &args)) != 0) { + if (e != ERANGE || args.bufsize >= GETGR_R_SIZE_LIMIT) { + rb_str_resize(*getgr_tmp, 0); + rb_syserr_fail(e, "getgrnam_r"); + } + rb_str_modify_expand(*getgr_tmp, (long)args.bufsize); + args.buf = RSTRING_PTR(*getgr_tmp); + args.bufsize = (size_t)rb_str_capacity(*getgr_tmp); + } + grptr = args.result; #elif defined(HAVE_GETGRNAM) - grptr = getgrnam(grpname); + grptr = getgrnam(grpname); #else - grptr = NULL; + grptr = NULL; #endif - if (!grptr) { + if (!grptr) { #if !defined(USE_GETGRNAM_R) && defined(HAVE_ENDGRENT) - endgrent(); + endgrent(); #endif - rb_raise(rb_eArgError, "can't find group for %s", grpname); - } - gid = grptr->gr_gid; + rb_raise(rb_eArgError, "can't find group for %"PRIsVALUE, id); + } + gid = grptr->gr_gid; #if !defined(USE_GETGRNAM_R) && defined(HAVE_ENDGRENT) - endgrent(); + endgrent(); #endif } return gid; @@ -5275,13 +6234,14 @@ p_sys_setresuid(VALUE obj, VALUE rid, VALUE eid, VALUE sid) /* * call-seq: - * Process.uid -> fixnum - * Process::UID.rid -> fixnum - * Process::Sys.getuid -> fixnum + * Process.uid -> integer + * Process::UID.rid -> integer + * Process::Sys.getuid -> integer + * + * Returns the (real) user ID of the current process. * - * Returns the (real) user ID of this process. + * Process.uid # => 1000 * - * Process.uid #=> 501 */ static VALUE @@ -5295,10 +6255,13 @@ proc_getuid(VALUE obj) #if defined(HAVE_SETRESUID) || defined(HAVE_SETREUID) || defined(HAVE_SETRUID) || defined(HAVE_SETUID) /* * call-seq: - * Process.uid= user -> numeric + * Process.uid = new_uid -> new_uid + * + * Sets the (user) user ID for the current process to +new_uid+: * - * Sets the (user) user ID for this process. Not available on all - * platforms. + * Process.uid = 1000 # => 1000 + * + * Not available on all platforms. */ static VALUE @@ -5317,12 +6280,12 @@ proc_setuid(VALUE obj, VALUE id) if (setruid(uid) < 0) rb_sys_fail(0); #elif defined HAVE_SETUID { - if (geteuid() == uid) { - if (setuid(uid) < 0) rb_sys_fail(0); - } - else { - rb_notimplement(); - } + if (geteuid() == uid) { + if (setuid(uid) < 0) rb_sys_fail(0); + } + else { + rb_notimplement(); + } } #endif return id; @@ -5336,7 +6299,7 @@ proc_setuid(VALUE obj, VALUE id) * * Document-class: Process::UID * - * The <code>Process::UID</code> module contains a collection of + * The Process::UID module contains a collection of * module functions which can be used to portably get, set, and * switch the current process's real, effective, and saved user IDs. * @@ -5349,11 +6312,11 @@ int setreuid(rb_uid_t ruid, rb_uid_t euid) { if (ruid != (rb_uid_t)-1 && ruid != getuid()) { - if (euid == (rb_uid_t)-1) euid = geteuid(); - if (setuid(ruid) < 0) return -1; + if (euid == (rb_uid_t)-1) euid = geteuid(); + if (setuid(ruid) < 0) return -1; } if (euid != (rb_uid_t)-1 && euid != geteuid()) { - if (seteuid(euid) < 0) return -1; + if (seteuid(euid) < 0) return -1; } return 0; } @@ -5361,7 +6324,7 @@ setreuid(rb_uid_t ruid, rb_uid_t euid) /* * call-seq: - * Process::UID.change_privilege(user) -> fixnum + * Process::UID.change_privilege(user) -> integer * * Change the current process's real and effective user ID to that * specified by _user_. Returns the new user ID. Not @@ -5383,148 +6346,144 @@ p_uid_change_privilege(VALUE obj, VALUE id) if (geteuid() == 0) { /* root-user */ #if defined(HAVE_SETRESUID) - if (setresuid(uid, uid, uid) < 0) rb_sys_fail(0); - SAVED_USER_ID = uid; + if (setresuid(uid, uid, uid) < 0) rb_sys_fail(0); + SAVED_USER_ID = uid; #elif defined(HAVE_SETUID) - if (setuid(uid) < 0) rb_sys_fail(0); - SAVED_USER_ID = uid; + if (setuid(uid) < 0) rb_sys_fail(0); + SAVED_USER_ID = uid; #elif defined(HAVE_SETREUID) && !defined(OBSOLETE_SETREUID) - if (getuid() == uid) { - if (SAVED_USER_ID == uid) { - if (setreuid(-1, uid) < 0) rb_sys_fail(0); - } - else { - if (uid == 0) { /* (r,e,s) == (root, root, x) */ - if (setreuid(-1, SAVED_USER_ID) < 0) rb_sys_fail(0); - if (setreuid(SAVED_USER_ID, 0) < 0) rb_sys_fail(0); - SAVED_USER_ID = 0; /* (r,e,s) == (x, root, root) */ - if (setreuid(uid, uid) < 0) rb_sys_fail(0); - SAVED_USER_ID = uid; - } - else { - if (setreuid(0, -1) < 0) rb_sys_fail(0); - SAVED_USER_ID = 0; - if (setreuid(uid, uid) < 0) rb_sys_fail(0); - SAVED_USER_ID = uid; - } - } - } - else { - if (setreuid(uid, uid) < 0) rb_sys_fail(0); - SAVED_USER_ID = uid; - } + if (getuid() == uid) { + if (SAVED_USER_ID == uid) { + if (setreuid(-1, uid) < 0) rb_sys_fail(0); + } + else { + if (uid == 0) { /* (r,e,s) == (root, root, x) */ + if (setreuid(-1, SAVED_USER_ID) < 0) rb_sys_fail(0); + if (setreuid(SAVED_USER_ID, 0) < 0) rb_sys_fail(0); + SAVED_USER_ID = 0; /* (r,e,s) == (x, root, root) */ + if (setreuid(uid, uid) < 0) rb_sys_fail(0); + SAVED_USER_ID = uid; + } + else { + if (setreuid(0, -1) < 0) rb_sys_fail(0); + SAVED_USER_ID = 0; + if (setreuid(uid, uid) < 0) rb_sys_fail(0); + SAVED_USER_ID = uid; + } + } + } + else { + if (setreuid(uid, uid) < 0) rb_sys_fail(0); + SAVED_USER_ID = uid; + } #elif defined(HAVE_SETRUID) && defined(HAVE_SETEUID) - if (getuid() == uid) { - if (SAVED_USER_ID == uid) { - if (seteuid(uid) < 0) rb_sys_fail(0); - } - else { - if (uid == 0) { - if (setruid(SAVED_USER_ID) < 0) rb_sys_fail(0); - SAVED_USER_ID = 0; - if (setruid(0) < 0) rb_sys_fail(0); - } - else { - if (setruid(0) < 0) rb_sys_fail(0); - SAVED_USER_ID = 0; - if (seteuid(uid) < 0) rb_sys_fail(0); - if (setruid(uid) < 0) rb_sys_fail(0); - SAVED_USER_ID = uid; - } - } - } - else { - if (seteuid(uid) < 0) rb_sys_fail(0); - if (setruid(uid) < 0) rb_sys_fail(0); - SAVED_USER_ID = uid; - } + if (getuid() == uid) { + if (SAVED_USER_ID == uid) { + if (seteuid(uid) < 0) rb_sys_fail(0); + } + else { + if (uid == 0) { + if (setruid(SAVED_USER_ID) < 0) rb_sys_fail(0); + SAVED_USER_ID = 0; + if (setruid(0) < 0) rb_sys_fail(0); + } + else { + if (setruid(0) < 0) rb_sys_fail(0); + SAVED_USER_ID = 0; + if (seteuid(uid) < 0) rb_sys_fail(0); + if (setruid(uid) < 0) rb_sys_fail(0); + SAVED_USER_ID = uid; + } + } + } + else { + if (seteuid(uid) < 0) rb_sys_fail(0); + if (setruid(uid) < 0) rb_sys_fail(0); + SAVED_USER_ID = uid; + } #else - (void)uid; - rb_notimplement(); + (void)uid; + rb_notimplement(); #endif } else { /* unprivileged user */ #if defined(HAVE_SETRESUID) - if (setresuid((getuid() == uid)? (rb_uid_t)-1: uid, - (geteuid() == uid)? (rb_uid_t)-1: uid, - (SAVED_USER_ID == uid)? (rb_uid_t)-1: uid) < 0) rb_sys_fail(0); - SAVED_USER_ID = uid; + if (setresuid((getuid() == uid)? (rb_uid_t)-1: uid, + (geteuid() == uid)? (rb_uid_t)-1: uid, + (SAVED_USER_ID == uid)? (rb_uid_t)-1: uid) < 0) rb_sys_fail(0); + SAVED_USER_ID = uid; #elif defined(HAVE_SETREUID) && !defined(OBSOLETE_SETREUID) - if (SAVED_USER_ID == uid) { - if (setreuid((getuid() == uid)? (rb_uid_t)-1: uid, - (geteuid() == uid)? (rb_uid_t)-1: uid) < 0) - rb_sys_fail(0); - } - else if (getuid() != uid) { - if (setreuid(uid, (geteuid() == uid)? (rb_uid_t)-1: uid) < 0) - rb_sys_fail(0); - SAVED_USER_ID = uid; - } - else if (/* getuid() == uid && */ geteuid() != uid) { - if (setreuid(geteuid(), uid) < 0) rb_sys_fail(0); - SAVED_USER_ID = uid; - if (setreuid(uid, -1) < 0) rb_sys_fail(0); - } - else { /* getuid() == uid && geteuid() == uid */ - if (setreuid(-1, SAVED_USER_ID) < 0) rb_sys_fail(0); - if (setreuid(SAVED_USER_ID, uid) < 0) rb_sys_fail(0); - SAVED_USER_ID = uid; - if (setreuid(uid, -1) < 0) rb_sys_fail(0); - } + if (SAVED_USER_ID == uid) { + if (setreuid((getuid() == uid)? (rb_uid_t)-1: uid, + (geteuid() == uid)? (rb_uid_t)-1: uid) < 0) + rb_sys_fail(0); + } + else if (getuid() != uid) { + if (setreuid(uid, (geteuid() == uid)? (rb_uid_t)-1: uid) < 0) + rb_sys_fail(0); + SAVED_USER_ID = uid; + } + else if (/* getuid() == uid && */ geteuid() != uid) { + if (setreuid(geteuid(), uid) < 0) rb_sys_fail(0); + SAVED_USER_ID = uid; + if (setreuid(uid, -1) < 0) rb_sys_fail(0); + } + else { /* getuid() == uid && geteuid() == uid */ + if (setreuid(-1, SAVED_USER_ID) < 0) rb_sys_fail(0); + if (setreuid(SAVED_USER_ID, uid) < 0) rb_sys_fail(0); + SAVED_USER_ID = uid; + if (setreuid(uid, -1) < 0) rb_sys_fail(0); + } #elif defined(HAVE_SETRUID) && defined(HAVE_SETEUID) - if (SAVED_USER_ID == uid) { - if (geteuid() != uid && seteuid(uid) < 0) rb_sys_fail(0); - if (getuid() != uid && setruid(uid) < 0) rb_sys_fail(0); - } - else if (/* SAVED_USER_ID != uid && */ geteuid() == uid) { - if (getuid() != uid) { - if (setruid(uid) < 0) rb_sys_fail(0); - SAVED_USER_ID = uid; - } - else { - if (setruid(SAVED_USER_ID) < 0) rb_sys_fail(0); - SAVED_USER_ID = uid; - if (setruid(uid) < 0) rb_sys_fail(0); - } - } - else if (/* geteuid() != uid && */ getuid() == uid) { - if (seteuid(uid) < 0) rb_sys_fail(0); - if (setruid(SAVED_USER_ID) < 0) rb_sys_fail(0); - SAVED_USER_ID = uid; - if (setruid(uid) < 0) rb_sys_fail(0); - } - else { - errno = EPERM; - rb_sys_fail(0); - } + if (SAVED_USER_ID == uid) { + if (geteuid() != uid && seteuid(uid) < 0) rb_sys_fail(0); + if (getuid() != uid && setruid(uid) < 0) rb_sys_fail(0); + } + else if (/* SAVED_USER_ID != uid && */ geteuid() == uid) { + if (getuid() != uid) { + if (setruid(uid) < 0) rb_sys_fail(0); + SAVED_USER_ID = uid; + } + else { + if (setruid(SAVED_USER_ID) < 0) rb_sys_fail(0); + SAVED_USER_ID = uid; + if (setruid(uid) < 0) rb_sys_fail(0); + } + } + else if (/* geteuid() != uid && */ getuid() == uid) { + if (seteuid(uid) < 0) rb_sys_fail(0); + if (setruid(SAVED_USER_ID) < 0) rb_sys_fail(0); + SAVED_USER_ID = uid; + if (setruid(uid) < 0) rb_sys_fail(0); + } + else { + rb_syserr_fail(EPERM, 0); + } #elif defined HAVE_44BSD_SETUID - if (getuid() == uid) { - /* (r,e,s)==(uid,?,?) ==> (uid,uid,uid) */ - if (setuid(uid) < 0) rb_sys_fail(0); - SAVED_USER_ID = uid; - } - else { - errno = EPERM; - rb_sys_fail(0); - } + if (getuid() == uid) { + /* (r,e,s)==(uid,?,?) ==> (uid,uid,uid) */ + if (setuid(uid) < 0) rb_sys_fail(0); + SAVED_USER_ID = uid; + } + else { + rb_syserr_fail(EPERM, 0); + } #elif defined HAVE_SETEUID - if (getuid() == uid && SAVED_USER_ID == uid) { - if (seteuid(uid) < 0) rb_sys_fail(0); - } - else { - errno = EPERM; - rb_sys_fail(0); - } + if (getuid() == uid && SAVED_USER_ID == uid) { + if (seteuid(uid) < 0) rb_sys_fail(0); + } + else { + rb_syserr_fail(EPERM, 0); + } #elif defined HAVE_SETUID - if (getuid() == uid && SAVED_USER_ID == uid) { - if (setuid(uid) < 0) rb_sys_fail(0); - } - else { - errno = EPERM; - rb_sys_fail(0); - } + if (getuid() == uid && SAVED_USER_ID == uid) { + if (setuid(uid) < 0) rb_sys_fail(0); + } + else { + rb_syserr_fail(EPERM, 0); + } #else - rb_notimplement(); + rb_notimplement(); #endif } return id; @@ -5614,11 +6573,9 @@ static VALUE p_sys_setregid(VALUE obj, VALUE rid, VALUE eid) { rb_gid_t rgid, egid; - PREPARE_GETGRNAM; check_gid_switch(); rgid = OBJ2GID(rid); egid = OBJ2GID(eid); - FINISH_GETGRNAM; if (setregid(rgid, egid) != 0) rb_sys_fail(0); return Qnil; } @@ -5642,12 +6599,10 @@ static VALUE p_sys_setresgid(VALUE obj, VALUE rid, VALUE eid, VALUE sid) { rb_gid_t rgid, egid, sgid; - PREPARE_GETGRNAM; check_gid_switch(); rgid = OBJ2GID(rid); egid = OBJ2GID(eid); sgid = OBJ2GID(sid); - FINISH_GETGRNAM; if (setresgid(rgid, egid, sgid) != 0) rb_sys_fail(0); return Qnil; } @@ -5672,12 +6627,7 @@ p_sys_setresgid(VALUE obj, VALUE rid, VALUE eid, VALUE sid) static VALUE p_sys_issetugid(VALUE obj) { - if (issetugid()) { - return Qtrue; - } - else { - return Qfalse; - } + return RBOOL(issetugid()); } #else #define p_sys_issetugid rb_f_notimplement @@ -5686,13 +6636,14 @@ p_sys_issetugid(VALUE obj) /* * call-seq: - * Process.gid -> fixnum - * Process::GID.rid -> fixnum - * Process::Sys.getgid -> fixnum + * Process.gid -> integer + * Process::GID.rid -> integer + * Process::Sys.getgid -> integer + * + * Returns the (real) group ID for the current process: * - * Returns the (real) group ID for this process. + * Process.gid # => 1000 * - * Process.gid #=> 500 */ static VALUE @@ -5706,9 +6657,12 @@ proc_getgid(VALUE obj) #if defined(HAVE_SETRESGID) || defined(HAVE_SETREGID) || defined(HAVE_SETRGID) || defined(HAVE_SETGID) /* * call-seq: - * Process.gid= fixnum -> fixnum + * Process.gid = new_gid -> new_gid + * + * Sets the group ID for the current process to +new_gid+: + * + * Process.gid = 1000 # => 1000 * - * Sets the group ID for this process. */ static VALUE @@ -5727,12 +6681,12 @@ proc_setgid(VALUE obj, VALUE id) if (setrgid(gid) < 0) rb_sys_fail(0); #elif defined HAVE_SETGID { - if (getegid() == gid) { - if (setgid(gid) < 0) rb_sys_fail(0); - } - else { - rb_notimplement(); - } + if (getegid() == gid) { + if (setgid(gid) < 0) rb_sys_fail(0); + } + else { + rb_notimplement(); + } } #endif return GIDT2NUM(gid); @@ -5760,7 +6714,6 @@ proc_setgid(VALUE obj, VALUE id) * Darwin (Mac OS X) 16 * Sun Solaris 7,8,9,10 16 * Sun Solaris 11 / OpenSolaris 1024 - * HP-UX 20 * Windows 1015 */ static int _maxgroups = -1; @@ -5779,9 +6732,9 @@ static int maxgroups(void) { if (_maxgroups < 0) { - _maxgroups = get_sc_ngroups_max(); - if (_maxgroups < 0) - _maxgroups = RB_MAX_GROUPS; + _maxgroups = get_sc_ngroups_max(); + if (_maxgroups < 0) + _maxgroups = RB_MAX_GROUPS; } return _maxgroups; @@ -5793,12 +6746,23 @@ maxgroups(void) #ifdef HAVE_GETGROUPS /* * call-seq: - * Process.groups -> array + * Process.groups -> array + * + * Returns an array of the group IDs + * in the supplemental group access list for the current process: + * + * Process.groups # => [4, 24, 27, 30, 46, 122, 135, 136, 1000] + * + * These properties of the returned array are system-dependent: * - * Get an <code>Array</code> of the gids of groups in the - * supplemental group access list for this process. + * - Whether (and how) the array is sorted. + * - Whether the array includes effective group IDs. + * - Whether the array includes duplicate group IDs. + * - Whether the array size exceeds the value of Process.maxgroups. * - * Process.groups #=> [27, 6, 10, 11] + * Use this call to get a sorted and unique array: + * + * Process.groups.uniq.sort * */ @@ -5811,17 +6775,17 @@ proc_getgroups(VALUE obj) ngroups = getgroups(0, NULL); if (ngroups == -1) - rb_sys_fail(0); + rb_sys_fail(0); groups = ALLOCV_N(rb_gid_t, tmp, ngroups); ngroups = getgroups(ngroups, groups); if (ngroups == -1) - rb_sys_fail(0); + rb_sys_fail(0); ary = rb_ary_new(); for (i = 0; i < ngroups; i++) - rb_ary_push(ary, GIDT2NUM(groups[i])); + rb_ary_push(ary, GIDT2NUM(groups[i])); ALLOCV_END(tmp); @@ -5835,14 +6799,14 @@ proc_getgroups(VALUE obj) #ifdef HAVE_SETGROUPS /* * call-seq: - * Process.groups= array -> array + * Process.groups = new_groups -> new_groups * - * Set the supplemental group access list to the given - * <code>Array</code> of group IDs. + * Sets the supplemental group access list to the given + * array of group IDs. * - * Process.groups #=> [0, 1, 2, 3, 4, 6, 10, 11, 20, 26, 27] - * Process.groups = [27, 6, 10, 11] #=> [27, 6, 10, 11] - * Process.groups #=> [27, 6, 10, 11] + * Process.groups # => [0, 1, 2, 3, 4, 6, 10, 11, 20, 26, 27] + * Process.groups = [27, 6, 10, 11] # => [27, 6, 10, 11] + * Process.groups # => [27, 6, 10, 11] * */ @@ -5858,19 +6822,19 @@ proc_setgroups(VALUE obj, VALUE ary) ngroups = RARRAY_LENINT(ary); if (ngroups > maxgroups()) - rb_raise(rb_eArgError, "too many groups, %d max", maxgroups()); + rb_raise(rb_eArgError, "too many groups, %d max", maxgroups()); groups = ALLOCV_N(rb_gid_t, tmp, ngroups); for (i = 0; i < ngroups; i++) { - VALUE g = RARRAY_AREF(ary, i); + VALUE g = RARRAY_AREF(ary, i); - groups[i] = OBJ2GID1(g); + groups[i] = OBJ2GID1(g); } FINISH_GETGRNAM; if (setgroups(ngroups, groups) == -1) /* ngroups <= maxgroups */ - rb_sys_fail(0); + rb_sys_fail(0); ALLOCV_END(tmp); @@ -5884,26 +6848,28 @@ proc_setgroups(VALUE obj, VALUE ary) #ifdef HAVE_INITGROUPS /* * call-seq: - * Process.initgroups(username, gid) -> array + * Process.initgroups(username, gid) -> array * - * Initializes the supplemental group access list by reading the - * system group database and using all groups of which the given user - * is a member. The group with the specified <em>gid</em> is also - * added to the list. Returns the resulting <code>Array</code> of the - * gids of all the groups in the supplementary group access list. Not - * available on all platforms. + * Sets the supplemental group access list; + * the new list includes: + * + * - The group IDs of those groups to which the user given by +username+ belongs. + * - The group ID +gid+. * - * Process.groups #=> [0, 1, 2, 3, 4, 6, 10, 11, 20, 26, 27] - * Process.initgroups( "mgranger", 30 ) #=> [30, 6, 10, 11] - * Process.groups #=> [30, 6, 10, 11] + * Example: * + * Process.groups # => [0, 1, 2, 3, 4, 6, 10, 11, 20, 26, 27] + * Process.initgroups('me', 30) # => [30, 6, 10, 11] + * Process.groups # => [30, 6, 10, 11] + * + * Not available on all platforms. */ static VALUE proc_initgroups(VALUE obj, VALUE uname, VALUE base_grp) { - if (initgroups(StringValuePtr(uname), OBJ2GID(base_grp)) != 0) { - rb_sys_fail(0); + if (initgroups(StringValueCStr(uname), OBJ2GID(base_grp)) != 0) { + rb_sys_fail(0); } return proc_getgroups(obj); } @@ -5914,12 +6880,13 @@ proc_initgroups(VALUE obj, VALUE uname, VALUE base_grp) #if defined(_SC_NGROUPS_MAX) || defined(NGROUPS_MAX) /* * call-seq: - * Process.maxgroups -> fixnum + * Process.maxgroups -> integer + * + * Returns the maximum number of group IDs allowed + * in the supplemental group access list: * - * Returns the maximum number of gids allowed in the supplemental - * group access list. + * Process.maxgroups # => 32 * - * Process.maxgroups #=> 32 */ static VALUE @@ -5934,10 +6901,10 @@ proc_getmaxgroups(VALUE obj) #ifdef HAVE_SETGROUPS /* * call-seq: - * Process.maxgroups= fixnum -> fixnum + * Process.maxgroups = new_max -> new_max * - * Sets the maximum number of gids allowed in the supplemental group - * access list. + * Sets the maximum number of group IDs allowed + * in the supplemental group access list. */ static VALUE @@ -5947,13 +6914,13 @@ proc_setmaxgroups(VALUE obj, VALUE val) int ngroups_max = get_sc_ngroups_max(); if (ngroups <= 0) - rb_raise(rb_eArgError, "maxgroups %d shold be positive", ngroups); + rb_raise(rb_eArgError, "maxgroups %d should be positive", ngroups); if (ngroups > RB_MAX_GROUPS) - ngroups = RB_MAX_GROUPS; + ngroups = RB_MAX_GROUPS; if (ngroups_max > 0 && ngroups > ngroups_max) - ngroups = ngroups_max; + ngroups = ngroups_max; _maxgroups = ngroups; @@ -5968,32 +6935,42 @@ static int rb_daemon(int nochdir, int noclose); /* * call-seq: - * Process.daemon() -> 0 - * Process.daemon(nochdir=nil,noclose=nil) -> 0 - * - * Detach the process from controlling terminal and run in - * the background as system daemon. Unless the argument - * nochdir is true (i.e. non false), it changes the current - * working directory to the root ("/"). Unless the argument - * noclose is true, daemon() will redirect standard input, - * standard output and standard error to /dev/null. - * Return zero on success, or raise one of Errno::*. + * Process.daemon(nochdir = nil, noclose = nil) -> 0 + * + * Detaches the current process from its controlling terminal + * and runs it in the background as system daemon; + * returns zero. + * + * By default: + * + * - Changes the current working directory to the root directory. + * - Redirects $stdin, $stdout, and $stderr to the null device. + * + * If optional argument +nochdir+ is +true+, + * does not change the current working directory. + * + * If optional argument +noclose+ is +true+, + * does not redirect $stdin, $stdout, or $stderr. */ static VALUE -proc_daemon(int argc, VALUE *argv) +proc_daemon(int argc, VALUE *argv, VALUE _) { - VALUE nochdir, noclose; - int n; + int n, nochdir = FALSE, noclose = FALSE; - rb_scan_args(argc, argv, "02", &nochdir, &noclose); + switch (rb_check_arity(argc, 0, 2)) { + case 2: noclose = TO_BOOL(argv[1], "noclose"); + case 1: nochdir = TO_BOOL(argv[0], "nochdir"); + } prefork(); - n = rb_daemon(RTEST(nochdir), RTEST(noclose)); + n = rb_daemon(nochdir, noclose); if (n < 0) rb_sys_fail("daemon"); return INT2FIX(n); } +extern const char ruby_null_device[]; + static int rb_daemon(int nochdir, int noclose) { @@ -6001,35 +6978,29 @@ rb_daemon(int nochdir, int noclose) #ifdef HAVE_DAEMON before_fork_ruby(); err = daemon(nochdir, noclose); - after_fork_ruby(); - rb_thread_atfork(); + after_fork_ruby(0); #else int n; -#define fork_daemon() \ - switch (rb_fork_ruby(NULL)) { \ - case -1: return -1; \ - case 0: rb_thread_atfork(); break; \ - default: _exit(EXIT_SUCCESS); \ + switch (rb_fork_ruby(NULL)) { + case -1: return -1; + case 0: break; + default: _exit(EXIT_SUCCESS); } - fork_daemon(); - - if (setsid() < 0) return -1; - - /* must not be process-leader */ - fork_daemon(); + /* ignore EPERM which means already being process-leader */ + if (setsid() < 0) (void)0; if (!nochdir) - err = chdir("/"); + err = chdir("/"); - if (!noclose && (n = rb_cloexec_open("/dev/null", O_RDWR, 0)) != -1) { + if (!noclose && (n = rb_cloexec_open(ruby_null_device, O_RDWR, 0)) != -1) { rb_update_max_fd(n); - (void)dup2(n, 0); - (void)dup2(n, 1); - (void)dup2(n, 2); - if (n > 2) - (void)close (n); + (void)dup2(n, 0); + (void)dup2(n, 1); + (void)dup2(n, 2); + if (n > 2) + (void)close (n); } #endif return err; @@ -6042,7 +7013,7 @@ rb_daemon(int nochdir, int noclose) * * Document-class: Process::GID * - * The <code>Process::GID</code> module contains a collection of + * The Process::GID module contains a collection of * module functions which can be used to portably get, set, and * switch the current process's real, effective, and saved group IDs. * @@ -6055,11 +7026,11 @@ int setregid(rb_gid_t rgid, rb_gid_t egid) { if (rgid != (rb_gid_t)-1 && rgid != getgid()) { - if (egid == (rb_gid_t)-1) egid = getegid(); - if (setgid(rgid) < 0) return -1; + if (egid == (rb_gid_t)-1) egid = getegid(); + if (setgid(rgid) < 0) return -1; } if (egid != (rb_gid_t)-1 && egid != getegid()) { - if (setegid(egid) < 0) return -1; + if (setegid(egid) < 0) return -1; } return 0; } @@ -6067,7 +7038,7 @@ setregid(rb_gid_t rgid, rb_gid_t egid) /* * call-seq: - * Process::GID.change_privilege(group) -> fixnum + * Process::GID.change_privilege(group) -> integer * * Change the current process's real and effective group ID to that * specified by _group_. Returns the new group ID. Not @@ -6089,149 +7060,145 @@ p_gid_change_privilege(VALUE obj, VALUE id) if (geteuid() == 0) { /* root-user */ #if defined(HAVE_SETRESGID) - if (setresgid(gid, gid, gid) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = gid; + if (setresgid(gid, gid, gid) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = gid; #elif defined HAVE_SETGID - if (setgid(gid) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = gid; + if (setgid(gid) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = gid; #elif defined(HAVE_SETREGID) && !defined(OBSOLETE_SETREGID) - if (getgid() == gid) { - if (SAVED_GROUP_ID == gid) { - if (setregid(-1, gid) < 0) rb_sys_fail(0); - } - else { - if (gid == 0) { /* (r,e,s) == (root, y, x) */ - if (setregid(-1, SAVED_GROUP_ID) < 0) rb_sys_fail(0); - if (setregid(SAVED_GROUP_ID, 0) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = 0; /* (r,e,s) == (x, root, root) */ - if (setregid(gid, gid) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = gid; - } - else { /* (r,e,s) == (z, y, x) */ - if (setregid(0, 0) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = 0; - if (setregid(gid, gid) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = gid; - } - } - } - else { - if (setregid(gid, gid) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = gid; - } + if (getgid() == gid) { + if (SAVED_GROUP_ID == gid) { + if (setregid(-1, gid) < 0) rb_sys_fail(0); + } + else { + if (gid == 0) { /* (r,e,s) == (root, y, x) */ + if (setregid(-1, SAVED_GROUP_ID) < 0) rb_sys_fail(0); + if (setregid(SAVED_GROUP_ID, 0) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = 0; /* (r,e,s) == (x, root, root) */ + if (setregid(gid, gid) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = gid; + } + else { /* (r,e,s) == (z, y, x) */ + if (setregid(0, 0) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = 0; + if (setregid(gid, gid) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = gid; + } + } + } + else { + if (setregid(gid, gid) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = gid; + } #elif defined(HAVE_SETRGID) && defined (HAVE_SETEGID) - if (getgid() == gid) { - if (SAVED_GROUP_ID == gid) { - if (setegid(gid) < 0) rb_sys_fail(0); - } - else { - if (gid == 0) { - if (setegid(gid) < 0) rb_sys_fail(0); - if (setrgid(SAVED_GROUP_ID) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = 0; - if (setrgid(0) < 0) rb_sys_fail(0); - } - else { - if (setrgid(0) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = 0; - if (setegid(gid) < 0) rb_sys_fail(0); - if (setrgid(gid) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = gid; - } - } - } - else { - if (setegid(gid) < 0) rb_sys_fail(0); - if (setrgid(gid) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = gid; - } + if (getgid() == gid) { + if (SAVED_GROUP_ID == gid) { + if (setegid(gid) < 0) rb_sys_fail(0); + } + else { + if (gid == 0) { + if (setegid(gid) < 0) rb_sys_fail(0); + if (setrgid(SAVED_GROUP_ID) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = 0; + if (setrgid(0) < 0) rb_sys_fail(0); + } + else { + if (setrgid(0) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = 0; + if (setegid(gid) < 0) rb_sys_fail(0); + if (setrgid(gid) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = gid; + } + } + } + else { + if (setegid(gid) < 0) rb_sys_fail(0); + if (setrgid(gid) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = gid; + } #else - rb_notimplement(); + rb_notimplement(); #endif } else { /* unprivileged user */ #if defined(HAVE_SETRESGID) - if (setresgid((getgid() == gid)? (rb_gid_t)-1: gid, - (getegid() == gid)? (rb_gid_t)-1: gid, - (SAVED_GROUP_ID == gid)? (rb_gid_t)-1: gid) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = gid; + if (setresgid((getgid() == gid)? (rb_gid_t)-1: gid, + (getegid() == gid)? (rb_gid_t)-1: gid, + (SAVED_GROUP_ID == gid)? (rb_gid_t)-1: gid) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = gid; #elif defined(HAVE_SETREGID) && !defined(OBSOLETE_SETREGID) - if (SAVED_GROUP_ID == gid) { - if (setregid((getgid() == gid)? (rb_uid_t)-1: gid, - (getegid() == gid)? (rb_uid_t)-1: gid) < 0) - rb_sys_fail(0); - } - else if (getgid() != gid) { - if (setregid(gid, (getegid() == gid)? (rb_uid_t)-1: gid) < 0) - rb_sys_fail(0); - SAVED_GROUP_ID = gid; - } - else if (/* getgid() == gid && */ getegid() != gid) { - if (setregid(getegid(), gid) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = gid; - if (setregid(gid, -1) < 0) rb_sys_fail(0); - } - else { /* getgid() == gid && getegid() == gid */ - if (setregid(-1, SAVED_GROUP_ID) < 0) rb_sys_fail(0); - if (setregid(SAVED_GROUP_ID, gid) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = gid; - if (setregid(gid, -1) < 0) rb_sys_fail(0); - } + if (SAVED_GROUP_ID == gid) { + if (setregid((getgid() == gid)? (rb_uid_t)-1: gid, + (getegid() == gid)? (rb_uid_t)-1: gid) < 0) + rb_sys_fail(0); + } + else if (getgid() != gid) { + if (setregid(gid, (getegid() == gid)? (rb_uid_t)-1: gid) < 0) + rb_sys_fail(0); + SAVED_GROUP_ID = gid; + } + else if (/* getgid() == gid && */ getegid() != gid) { + if (setregid(getegid(), gid) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = gid; + if (setregid(gid, -1) < 0) rb_sys_fail(0); + } + else { /* getgid() == gid && getegid() == gid */ + if (setregid(-1, SAVED_GROUP_ID) < 0) rb_sys_fail(0); + if (setregid(SAVED_GROUP_ID, gid) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = gid; + if (setregid(gid, -1) < 0) rb_sys_fail(0); + } #elif defined(HAVE_SETRGID) && defined(HAVE_SETEGID) - if (SAVED_GROUP_ID == gid) { - if (getegid() != gid && setegid(gid) < 0) rb_sys_fail(0); - if (getgid() != gid && setrgid(gid) < 0) rb_sys_fail(0); - } - else if (/* SAVED_GROUP_ID != gid && */ getegid() == gid) { - if (getgid() != gid) { - if (setrgid(gid) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = gid; - } - else { - if (setrgid(SAVED_GROUP_ID) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = gid; - if (setrgid(gid) < 0) rb_sys_fail(0); - } - } - else if (/* getegid() != gid && */ getgid() == gid) { - if (setegid(gid) < 0) rb_sys_fail(0); - if (setrgid(SAVED_GROUP_ID) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = gid; - if (setrgid(gid) < 0) rb_sys_fail(0); - } - else { - errno = EPERM; - rb_sys_fail(0); - } + if (SAVED_GROUP_ID == gid) { + if (getegid() != gid && setegid(gid) < 0) rb_sys_fail(0); + if (getgid() != gid && setrgid(gid) < 0) rb_sys_fail(0); + } + else if (/* SAVED_GROUP_ID != gid && */ getegid() == gid) { + if (getgid() != gid) { + if (setrgid(gid) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = gid; + } + else { + if (setrgid(SAVED_GROUP_ID) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = gid; + if (setrgid(gid) < 0) rb_sys_fail(0); + } + } + else if (/* getegid() != gid && */ getgid() == gid) { + if (setegid(gid) < 0) rb_sys_fail(0); + if (setrgid(SAVED_GROUP_ID) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = gid; + if (setrgid(gid) < 0) rb_sys_fail(0); + } + else { + rb_syserr_fail(EPERM, 0); + } #elif defined HAVE_44BSD_SETGID - if (getgid() == gid) { - /* (r,e,s)==(gid,?,?) ==> (gid,gid,gid) */ - if (setgid(gid) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = gid; - } - else { - errno = EPERM; - rb_sys_fail(0); - } + if (getgid() == gid) { + /* (r,e,s)==(gid,?,?) ==> (gid,gid,gid) */ + if (setgid(gid) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = gid; + } + else { + rb_syserr_fail(EPERM, 0); + } #elif defined HAVE_SETEGID - if (getgid() == gid && SAVED_GROUP_ID == gid) { - if (setegid(gid) < 0) rb_sys_fail(0); - } - else { - errno = EPERM; - rb_sys_fail(0); - } + if (getgid() == gid && SAVED_GROUP_ID == gid) { + if (setegid(gid) < 0) rb_sys_fail(0); + } + else { + rb_syserr_fail(EPERM, 0); + } #elif defined HAVE_SETGID - if (getgid() == gid && SAVED_GROUP_ID == gid) { - if (setgid(gid) < 0) rb_sys_fail(0); - } - else { - errno = EPERM; - rb_sys_fail(0); - } + if (getgid() == gid && SAVED_GROUP_ID == gid) { + if (setgid(gid) < 0) rb_sys_fail(0); + } + else { + rb_syserr_fail(EPERM, 0); + } #else - (void)gid; - rb_notimplement(); + (void)gid; + rb_notimplement(); #endif } return id; @@ -6240,13 +7207,14 @@ p_gid_change_privilege(VALUE obj, VALUE id) /* * call-seq: - * Process.euid -> fixnum - * Process::UID.eid -> fixnum - * Process::Sys.geteuid -> fixnum + * Process.euid -> integer + * Process::UID.eid -> integer + * Process::Sys.geteuid -> integer * - * Returns the effective user ID for this process. + * Returns the effective user ID for the current process. + * + * Process.euid # => 501 * - * Process.euid #=> 501 */ static VALUE @@ -6268,10 +7236,10 @@ proc_seteuid(rb_uid_t uid) if (seteuid(uid) < 0) rb_sys_fail(0); #elif defined HAVE_SETUID if (uid == getuid()) { - if (setuid(uid) < 0) rb_sys_fail(0); + if (setuid(uid) < 0) rb_sys_fail(0); } else { - rb_notimplement(); + rb_notimplement(); } #else rb_notimplement(); @@ -6282,10 +7250,11 @@ proc_seteuid(rb_uid_t uid) #if defined(HAVE_SETRESUID) || defined(HAVE_SETREUID) || defined(HAVE_SETEUID) || defined(HAVE_SETUID) /* * call-seq: - * Process.euid= user + * Process.euid = new_euid -> new_euid + * + * Sets the effective user ID for the current process. * - * Sets the effective user ID for this process. Not available on all - * platforms. + * Not available on all platforms. */ static VALUE @@ -6314,18 +7283,18 @@ rb_seteuid_core(rb_uid_t euid) #if defined(HAVE_SETRESUID) if (uid != euid) { - if (setresuid(-1,euid,euid) < 0) rb_sys_fail(0); - SAVED_USER_ID = euid; + if (setresuid(-1,euid,euid) < 0) rb_sys_fail(0); + SAVED_USER_ID = euid; } else { - if (setresuid(-1,euid,-1) < 0) rb_sys_fail(0); + if (setresuid(-1,euid,-1) < 0) rb_sys_fail(0); } #elif defined(HAVE_SETREUID) && !defined(OBSOLETE_SETREUID) if (setreuid(-1, euid) < 0) rb_sys_fail(0); if (uid != euid) { - if (setreuid(euid,uid) < 0) rb_sys_fail(0); - if (setreuid(uid,euid) < 0) rb_sys_fail(0); - SAVED_USER_ID = euid; + if (setreuid(euid,uid) < 0) rb_sys_fail(0); + if (setreuid(uid,euid) < 0) rb_sys_fail(0); + SAVED_USER_ID = euid; } #elif defined HAVE_SETEUID if (seteuid(euid) < 0) rb_sys_fail(0); @@ -6341,8 +7310,8 @@ rb_seteuid_core(rb_uid_t euid) /* * call-seq: - * Process::UID.grant_privilege(user) -> fixnum - * Process::UID.eid= user -> fixnum + * Process::UID.grant_privilege(user) -> integer + * Process::UID.eid= user -> integer * * Set the effective user ID, and if possible, the saved user ID of * the process to the given _user_. Returns the new @@ -6363,14 +7332,15 @@ p_uid_grant_privilege(VALUE obj, VALUE id) /* * call-seq: - * Process.egid -> fixnum - * Process::GID.eid -> fixnum - * Process::Sys.geteid -> fixnum + * Process.egid -> integer + * Process::GID.eid -> integer + * Process::Sys.geteid -> integer * - * Returns the effective group ID for this process. Not available on - * all platforms. + * Returns the effective group ID for the current process: * - * Process.egid #=> 500 + * Process.egid # => 500 + * + * Not available on all platforms. */ static VALUE @@ -6384,10 +7354,11 @@ proc_getegid(VALUE obj) #if defined(HAVE_SETRESGID) || defined(HAVE_SETREGID) || defined(HAVE_SETEGID) || defined(HAVE_SETGID) || defined(_POSIX_SAVED_IDS) /* * call-seq: - * Process.egid = fixnum -> fixnum + * Process.egid = new_egid -> new_egid + * + * Sets the effective group ID for the current process. * - * Sets the effective group ID for this process. Not available on all - * platforms. + * Not available on all platforms. */ static VALUE @@ -6411,10 +7382,10 @@ proc_setegid(VALUE obj, VALUE egid) if (setegid(gid) < 0) rb_sys_fail(0); #elif defined HAVE_SETGID if (gid == getgid()) { - if (setgid(gid) < 0) rb_sys_fail(0); + if (setgid(gid) < 0) rb_sys_fail(0); } else { - rb_notimplement(); + rb_notimplement(); } #else rb_notimplement(); @@ -6444,18 +7415,18 @@ rb_setegid_core(rb_gid_t egid) #if defined(HAVE_SETRESGID) if (gid != egid) { - if (setresgid(-1,egid,egid) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = egid; + if (setresgid(-1,egid,egid) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = egid; } else { - if (setresgid(-1,egid,-1) < 0) rb_sys_fail(0); + if (setresgid(-1,egid,-1) < 0) rb_sys_fail(0); } #elif defined(HAVE_SETREGID) && !defined(OBSOLETE_SETREGID) if (setregid(-1, egid) < 0) rb_sys_fail(0); if (gid != egid) { - if (setregid(egid,gid) < 0) rb_sys_fail(0); - if (setregid(gid,egid) < 0) rb_sys_fail(0); - SAVED_GROUP_ID = egid; + if (setregid(egid,gid) < 0) rb_sys_fail(0); + if (setregid(gid,egid) < 0) rb_sys_fail(0); + SAVED_GROUP_ID = egid; } #elif defined HAVE_SETEGID if (setegid(egid) < 0) rb_sys_fail(0); @@ -6471,8 +7442,8 @@ rb_setegid_core(rb_gid_t egid) /* * call-seq: - * Process::GID.grant_privilege(group) -> fixnum - * Process::GID.eid = group -> fixnum + * Process::GID.grant_privilege(group) -> integer + * Process::GID.eid = group -> integer * * Set the effective group ID, and if possible, the saved group ID of * the process to the given _group_. Returns the new @@ -6501,7 +7472,7 @@ p_gid_grant_privilege(VALUE obj, VALUE id) */ static VALUE -p_uid_exchangeable(void) +p_uid_exchangeable(VALUE _) { #if defined(HAVE_SETRESUID) return Qtrue; @@ -6515,7 +7486,7 @@ p_uid_exchangeable(void) /* * call-seq: - * Process::UID.re_exchange -> fixnum + * Process::UID.re_exchange -> integer * * Exchange real and effective user IDs and return the new effective * user ID. Not available on all platforms. @@ -6563,7 +7534,7 @@ p_uid_exchange(VALUE obj) */ static VALUE -p_gid_exchangeable(void) +p_gid_exchangeable(VALUE _) { #if defined(HAVE_SETRESGID) return Qtrue; @@ -6577,7 +7548,7 @@ p_gid_exchangeable(void) /* * call-seq: - * Process::GID.re_exchange -> fixnum + * Process::GID.re_exchange -> integer * * Exchange real and effective group IDs and return the new effective * group ID. Not available on all platforms. @@ -6626,7 +7597,7 @@ p_gid_exchange(VALUE obj) */ static VALUE -p_uid_have_saved_id(void) +p_uid_have_saved_id(VALUE _) { #if defined(HAVE_SETRESUID) || defined(HAVE_SETEUID) || defined(_POSIX_SAVED_IDS) return Qtrue; @@ -6638,8 +7609,9 @@ p_uid_have_saved_id(void) #if defined(HAVE_SETRESUID) || defined(HAVE_SETEUID) || defined(_POSIX_SAVED_IDS) static VALUE -p_uid_sw_ensure(rb_uid_t id) +p_uid_sw_ensure(VALUE i) { + rb_uid_t id = (rb_uid_t/* narrowing */)i; under_uid_switch = 0; id = rb_seteuid_core(id); return UIDT2NUM(id); @@ -6648,7 +7620,7 @@ p_uid_sw_ensure(rb_uid_t id) /* * call-seq: - * Process::UID.switch -> fixnum + * Process::UID.switch -> integer * Process::UID.switch {|| block} -> object * * Switch the effective and real user IDs of the current process. If @@ -6670,31 +7642,30 @@ p_uid_switch(VALUE obj) euid = geteuid(); if (uid != euid) { - proc_seteuid(uid); - if (rb_block_given_p()) { - under_uid_switch = 1; - return rb_ensure(rb_yield, Qnil, p_uid_sw_ensure, SAVED_USER_ID); - } - else { - return UIDT2NUM(euid); - } + proc_seteuid(uid); + if (rb_block_given_p()) { + under_uid_switch = 1; + return rb_ensure(rb_yield, Qnil, p_uid_sw_ensure, SAVED_USER_ID); + } + else { + return UIDT2NUM(euid); + } } else if (euid != SAVED_USER_ID) { - proc_seteuid(SAVED_USER_ID); - if (rb_block_given_p()) { - under_uid_switch = 1; - return rb_ensure(rb_yield, Qnil, p_uid_sw_ensure, euid); - } - else { - return UIDT2NUM(uid); - } + proc_seteuid(SAVED_USER_ID); + if (rb_block_given_p()) { + under_uid_switch = 1; + return rb_ensure(rb_yield, Qnil, p_uid_sw_ensure, euid); + } + else { + return UIDT2NUM(uid); + } } else { - errno = EPERM; - rb_sys_fail(0); + rb_syserr_fail(EPERM, 0); } - UNREACHABLE; + UNREACHABLE_RETURN(Qnil); } #else static VALUE @@ -6715,16 +7686,15 @@ p_uid_switch(VALUE obj) euid = geteuid(); if (uid == euid) { - errno = EPERM; - rb_sys_fail(0); + rb_syserr_fail(EPERM, 0); } p_uid_exchange(obj); if (rb_block_given_p()) { - under_uid_switch = 1; - return rb_ensure(rb_yield, Qnil, p_uid_sw_ensure, obj); + under_uid_switch = 1; + return rb_ensure(rb_yield, Qnil, p_uid_sw_ensure, obj); } else { - return UIDT2NUM(euid); + return UIDT2NUM(euid); } } #endif @@ -6742,7 +7712,7 @@ p_uid_switch(VALUE obj) */ static VALUE -p_gid_have_saved_id(void) +p_gid_have_saved_id(VALUE _) { #if defined(HAVE_SETRESGID) || defined(HAVE_SETEGID) || defined(_POSIX_SAVED_IDS) return Qtrue; @@ -6753,8 +7723,9 @@ p_gid_have_saved_id(void) #if defined(HAVE_SETRESGID) || defined(HAVE_SETEGID) || defined(_POSIX_SAVED_IDS) static VALUE -p_gid_sw_ensure(rb_gid_t id) +p_gid_sw_ensure(VALUE i) { + rb_gid_t id = (rb_gid_t/* narrowing */)i; under_gid_switch = 0; id = rb_setegid_core(id); return GIDT2NUM(id); @@ -6763,7 +7734,7 @@ p_gid_sw_ensure(rb_gid_t id) /* * call-seq: - * Process::GID.switch -> fixnum + * Process::GID.switch -> integer * Process::GID.switch {|| block} -> object * * Switch the effective and real group IDs of the current process. If @@ -6785,31 +7756,30 @@ p_gid_switch(VALUE obj) egid = getegid(); if (gid != egid) { - proc_setegid(obj, GIDT2NUM(gid)); - if (rb_block_given_p()) { - under_gid_switch = 1; - return rb_ensure(rb_yield, Qnil, p_gid_sw_ensure, SAVED_GROUP_ID); - } - else { - return GIDT2NUM(egid); - } + proc_setegid(obj, GIDT2NUM(gid)); + if (rb_block_given_p()) { + under_gid_switch = 1; + return rb_ensure(rb_yield, Qnil, p_gid_sw_ensure, SAVED_GROUP_ID); + } + else { + return GIDT2NUM(egid); + } } else if (egid != SAVED_GROUP_ID) { - proc_setegid(obj, GIDT2NUM(SAVED_GROUP_ID)); - if (rb_block_given_p()) { - under_gid_switch = 1; - return rb_ensure(rb_yield, Qnil, p_gid_sw_ensure, egid); - } - else { - return GIDT2NUM(gid); - } + proc_setegid(obj, GIDT2NUM(SAVED_GROUP_ID)); + if (rb_block_given_p()) { + under_gid_switch = 1; + return rb_ensure(rb_yield, Qnil, p_gid_sw_ensure, egid); + } + else { + return GIDT2NUM(gid); + } } else { - errno = EPERM; - rb_sys_fail(0); + rb_syserr_fail(EPERM, 0); } - UNREACHABLE; + UNREACHABLE_RETURN(Qnil); } #else static VALUE @@ -6830,16 +7800,15 @@ p_gid_switch(VALUE obj) egid = getegid(); if (gid == egid) { - errno = EPERM; - rb_sys_fail(0); + rb_syserr_fail(EPERM, 0); } p_gid_exchange(obj); if (rb_block_given_p()) { - under_gid_switch = 1; - return rb_ensure(rb_yield, Qnil, p_gid_sw_ensure, obj); + under_gid_switch = 1; + return rb_ensure(rb_yield, Qnil, p_gid_sw_ensure, obj); } else { - return GIDT2NUM(egid); + return GIDT2NUM(egid); } } #endif @@ -6849,46 +7818,53 @@ p_gid_switch(VALUE obj) static long get_clk_tck(void) { - long hertz = #ifdef HAVE__SC_CLK_TCK - (double)sysconf(_SC_CLK_TCK); + return sysconf(_SC_CLK_TCK); +#elif defined CLK_TCK + return CLK_TCK; +#elif defined HZ + return HZ; #else -#ifndef HZ -# ifdef CLK_TCK -# define HZ CLK_TCK -# else -# define HZ 60 -# endif -#endif /* HZ */ - HZ; + return 60; #endif - return hertz; } /* * call-seq: - * Process.times -> aProcessTms + * Process.times -> process_tms + * + * Returns a Process::Tms structure that contains user and system CPU times + * for the current process, and for its children processes: * - * Returns a <code>Tms</code> structure (see <code>Process::Tms</code>) - * that contains user and system CPU times for this process, - * and also for children processes. + * Process.times + * # => #<struct Process::Tms utime=55.122118, stime=35.533068, cutime=0.0, cstime=0.002846> * - * t = Process.times - * [ t.utime, t.stime, t.cutime, t.cstime ] #=> [0.0, 0.02, 0.00, 0.00] + * The precision is platform-defined. */ VALUE rb_proc_times(VALUE obj) { - const double hertz = get_clk_tck(); - struct tms buf; VALUE utime, stime, cutime, cstime, ret; +#if defined(RUSAGE_SELF) && defined(RUSAGE_CHILDREN) + struct rusage usage_s, usage_c; + + if (getrusage(RUSAGE_SELF, &usage_s) != 0 || getrusage(RUSAGE_CHILDREN, &usage_c) != 0) + rb_sys_fail("getrusage"); + utime = DBL2NUM((double)usage_s.ru_utime.tv_sec + (double)usage_s.ru_utime.tv_usec/1e6); + stime = DBL2NUM((double)usage_s.ru_stime.tv_sec + (double)usage_s.ru_stime.tv_usec/1e6); + cutime = DBL2NUM((double)usage_c.ru_utime.tv_sec + (double)usage_c.ru_utime.tv_usec/1e6); + cstime = DBL2NUM((double)usage_c.ru_stime.tv_sec + (double)usage_c.ru_stime.tv_usec/1e6); +#else + const double hertz = (double)get_clk_tck(); + struct tms buf; times(&buf); utime = DBL2NUM(buf.tms_utime / hertz); stime = DBL2NUM(buf.tms_stime / hertz); cutime = DBL2NUM(buf.tms_cutime / hertz); cstime = DBL2NUM(buf.tms_cstime / hertz); +#endif ret = rb_struct_new(rb_cProcessTms, utime, stime, cutime, cstime); RB_GC_GUARD(utime); RB_GC_GUARD(stime); @@ -6905,13 +7881,16 @@ typedef LONG_LONG timetick_int_t; #define TIMETICK_INT_MIN LLONG_MIN #define TIMETICK_INT_MAX LLONG_MAX #define TIMETICK_INT2NUM(v) LL2NUM(v) +#define MUL_OVERFLOW_TIMETICK_P(a, b) MUL_OVERFLOW_LONG_LONG_P(a, b) #else typedef long timetick_int_t; #define TIMETICK_INT_MIN LONG_MIN #define TIMETICK_INT_MAX LONG_MAX #define TIMETICK_INT2NUM(v) LONG2NUM(v) +#define MUL_OVERFLOW_TIMETICK_P(a, b) MUL_OVERFLOW_LONG_P(a, b) #endif +CONSTFUNC(static timetick_int_t gcd_timetick_int(timetick_int_t, timetick_int_t)); static timetick_int_t gcd_timetick_int(timetick_int_t a, timetick_int_t b) { @@ -7024,8 +8003,7 @@ timetick2integer(struct timetick *ttp, timetick_int_t t = ttp->giga_count * 1000000000 + ttp->count; for (i = 0; i < num_numerators; i++) { timetick_int_t factor = numerators[i]; - if (MUL_OVERFLOW_SIGNED_INTEGER_P(factor, t, - TIMETICK_INT_MIN, TIMETICK_INT_MAX)) + if (MUL_OVERFLOW_TIMETICK_P(factor, t)) goto generic; t *= factor; } @@ -7088,7 +8066,7 @@ make_clock_result(struct timetick *ttp, } #ifdef __APPLE__ -static mach_timebase_info_data_t * +static const mach_timebase_info_data_t * get_mach_timebase_info(void) { static mach_timebase_info_data_t sTimebaseInfo; @@ -7099,135 +8077,195 @@ get_mach_timebase_info(void) return &sTimebaseInfo; } + +double +ruby_real_ms_time(void) +{ + const mach_timebase_info_data_t *info = get_mach_timebase_info(); + uint64_t t = mach_absolute_time(); + return (double)t * info->numer / info->denom / 1e6; +} #endif +#if defined(NUM2CLOCKID) +# define NUMERIC_CLOCKID 1 +#else +# define NUMERIC_CLOCKID 0 +# define NUM2CLOCKID(x) 0 +#endif + +#define clock_failed(name, err, arg) do { \ + int clock_error = (err); \ + rb_syserr_fail_str(clock_error, rb_sprintf("clock_" name "(%+"PRIsVALUE")", (arg))); \ + } while (0) + /* * call-seq: - * Process.clock_gettime(clock_id [, unit]) -> number - * - * Returns a time returned by POSIX clock_gettime() function. - * - * p Process.clock_gettime(Process::CLOCK_MONOTONIC) - * #=> 896053.968060096 - * - * +clock_id+ specifies a kind of clock. - * It is specifed as a constant which begins with <code>Process::CLOCK_</code> - * such as Process::CLOCK_REALTIME and Process::CLOCK_MONOTONIC. - * - * The supported constants depends on OS and version. - * Ruby provides following types of +clock_id+ if available. - * - * [CLOCK_REALTIME] SUSv2 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0, OpenBSD 2.1 - * [CLOCK_MONOTONIC] SUSv3 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0, OpenBSD 3.4 - * [CLOCK_PROCESS_CPUTIME_ID] SUSv3 to 4, Linux 2.5.63, OpenBSD 5.4 - * [CLOCK_THREAD_CPUTIME_ID] SUSv3 to 4, Linux 2.5.63, FreeBSD 7.1, OpenBSD 5.4 - * [CLOCK_VIRTUAL] FreeBSD 3.0, OpenBSD 2.1 - * [CLOCK_PROF] FreeBSD 3.0, OpenBSD 2.1 - * [CLOCK_REALTIME_FAST] FreeBSD 8.1 - * [CLOCK_REALTIME_PRECISE] FreeBSD 8.1 - * [CLOCK_REALTIME_COARSE] Linux 2.6.32 - * [CLOCK_REALTIME_ALARM] Linux 3.0 - * [CLOCK_MONOTONIC_FAST] FreeBSD 8.1 - * [CLOCK_MONOTONIC_PRECISE] FreeBSD 8.1 - * [CLOCK_MONOTONIC_COARSE] Linux 2.6.32 - * [CLOCK_MONOTONIC_RAW] Linux 2.6.28 - * [CLOCK_BOOTTIME] Linux 2.6.39 - * [CLOCK_BOOTTIME_ALARM] Linux 3.0 - * [CLOCK_UPTIME] FreeBSD 7.0, OpenBSD 5.5 - * [CLOCK_UPTIME_FAST] FreeBSD 8.1 - * [CLOCK_UPTIME_PRECISE] FreeBSD 8.1 - * [CLOCK_SECOND] FreeBSD 8.1 + * Process.clock_gettime(clock_id, unit = :float_second) -> number + * + * Returns a clock time as determined by POSIX function + * {clock_gettime()}[https://man7.org/linux/man-pages/man3/clock_gettime.3.html]: + * + * Process.clock_gettime(:CLOCK_PROCESS_CPUTIME_ID) # => 198.650379677 + * + * Argument +clock_id+ should be a symbol or a constant that specifies + * the clock whose time is to be returned; + * see below. + * + * Optional argument +unit+ should be a symbol that specifies + * the unit to be used in the returned clock time; + * see below. + * + * <b>Argument +clock_id+</b> + * + * Argument +clock_id+ specifies the clock whose time is to be returned; + * it may be a constant such as <tt>Process::CLOCK_REALTIME</tt>, + * or a symbol shorthand such as +:CLOCK_REALTIME+. + * + * The supported clocks depend on the underlying operating system; + * this method supports the following clocks on the indicated platforms + * (raises Errno::EINVAL if called with an unsupported clock): + * + * - +:CLOCK_BOOTTIME+: Linux 2.6.39. + * - +:CLOCK_BOOTTIME_ALARM+: Linux 3.0. + * - +:CLOCK_MONOTONIC+: SUSv3 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0, OpenBSD 3.4, macOS 10.12, Windows-2000. + * - +:CLOCK_MONOTONIC_COARSE+: Linux 2.6.32. + * - +:CLOCK_MONOTONIC_FAST+: FreeBSD 8.1. + * - +:CLOCK_MONOTONIC_PRECISE+: FreeBSD 8.1. + * - +:CLOCK_MONOTONIC_RAW+: Linux 2.6.28, macOS 10.12. + * - +:CLOCK_MONOTONIC_RAW_APPROX+: macOS 10.12. + * - +:CLOCK_PROCESS_CPUTIME_ID+: SUSv3 to 4, Linux 2.5.63, FreeBSD 9.3, OpenBSD 5.4, macOS 10.12. + * - +:CLOCK_PROF+: FreeBSD 3.0, OpenBSD 2.1. + * - +:CLOCK_REALTIME+: SUSv2 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0, OpenBSD 2.1, macOS 10.12, Windows-8/Server-2012. + * Time.now is recommended over +:CLOCK_REALTIME:. + * - +:CLOCK_REALTIME_ALARM+: Linux 3.0. + * - +:CLOCK_REALTIME_COARSE+: Linux 2.6.32. + * - +:CLOCK_REALTIME_FAST+: FreeBSD 8.1. + * - +:CLOCK_REALTIME_PRECISE+: FreeBSD 8.1. + * - +:CLOCK_SECOND+: FreeBSD 8.1. + * - +:CLOCK_TAI+: Linux 3.10. + * - +:CLOCK_THREAD_CPUTIME_ID+: SUSv3 to 4, Linux 2.5.63, FreeBSD 7.1, OpenBSD 5.4, macOS 10.12. + * - +:CLOCK_UPTIME+: FreeBSD 7.0, OpenBSD 5.5. + * - +:CLOCK_UPTIME_FAST+: FreeBSD 8.1. + * - +:CLOCK_UPTIME_PRECISE+: FreeBSD 8.1. + * - +:CLOCK_UPTIME_RAW+: macOS 10.12. + * - +:CLOCK_UPTIME_RAW_APPROX+: macOS 10.12. + * - +:CLOCK_VIRTUAL+: FreeBSD 3.0, OpenBSD 2.1. * * Note that SUS stands for Single Unix Specification. * SUS contains POSIX and clock_gettime is defined in the POSIX part. - * SUS defines CLOCK_REALTIME mandatory but - * CLOCK_MONOTONIC, CLOCK_PROCESS_CPUTIME_ID and CLOCK_THREAD_CPUTIME_ID are optional. - * - * Also, several symbols are accepted as +clock_id+. - * There are emulations for clock_gettime(). - * - * For example, Process::CLOCK_REALTIME is defined as - * +:GETTIMEOFDAY_BASED_CLOCK_REALTIME+ when clock_gettime() is not available. - * - * Emulations for +CLOCK_REALTIME+: - * [:GETTIMEOFDAY_BASED_CLOCK_REALTIME] - * Use gettimeofday() defined by SUS. - * (SUSv4 obsoleted it, though.) - * The resolution is 1 microsecond. - * [:TIME_BASED_CLOCK_REALTIME] - * Use time() defined by ISO C. - * The resolution is 1 second. - * - * Emulations for +CLOCK_MONOTONIC+: - * [:MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC] - * Use mach_absolute_time(), available on Darwin. - * The resolution is CPU dependent. - * [:TIMES_BASED_CLOCK_MONOTONIC] - * Use the result value of times() defined by POSIX. - * POSIX defines it as "times() shall return the elapsed real time, in clock ticks, since an arbitrary point in the past (for example, system start-up time)". - * For example, GNU/Linux returns a value based on jiffies and it is monotonic. - * However, 4.4BSD uses gettimeofday() and it is not monotonic. - * (FreeBSD uses clock_gettime(CLOCK_MONOTONIC) instead, though.) - * The resolution is the clock tick. - * "getconf CLK_TCK" command shows the clock ticks per second. - * (The clock ticks per second is defined by HZ macro in older systems.) - * If it is 100 and clock_t is 32 bits integer type, the resolution is 10 millisecond and - * cannot represent over 497 days. - * - * Emulations for +CLOCK_PROCESS_CPUTIME_ID+: - * [:GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID] - * Use getrusage() defined by SUS. - * getrusage() is used with RUSAGE_SELF to obtain the time only for - * the calling process (excluding the time for child processes). - * The result is addition of user time (ru_utime) and system time (ru_stime). - * The resolution is 1 microsecond. - * [:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID] - * Use times() defined by POSIX. - * The result is addition of user time (tms_utime) and system time (tms_stime). - * tms_cutime and tms_cstime are ignored to exclude the time for child processes. - * The resolution is the clock tick. - * "getconf CLK_TCK" command shows the clock ticks per second. - * (The clock ticks per second is defined by HZ macro in older systems.) - * If it is 100, the resolution is 10 millisecond. - * [:CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID] - * Use clock() defined by ISO C. - * The resolution is 1/CLOCKS_PER_SEC. - * CLOCKS_PER_SEC is the C-level macro defined by time.h. - * SUS defines CLOCKS_PER_SEC is 1000000. - * Non-Unix systems may define it a different value, though. - * If CLOCKS_PER_SEC is 1000000 as SUS, the resolution is 1 microsecond. - * If CLOCKS_PER_SEC is 1000000 and clock_t is 32 bits integer type, it cannot represent over 72 minutes. - * - * If the given +clock_id+ is not supported, Errno::EINVAL is raised. - * - * +unit+ specifies a type of the return value. - * - * [:float_second] number of seconds as a float (default) - * [:float_millisecond] number of milliseconds as a float - * [:float_microsecond] number of microseconds as a float - * [:second] number of seconds as an integer - * [:millisecond] number of milliseconds as an integer - * [:microsecond] number of microseconds as an integer - * [:nanosecond] number of nanoseconds as an integer + * SUS defines +:CLOCK_REALTIME+ as mandatory but + * +:CLOCK_MONOTONIC+, +:CLOCK_PROCESS_CPUTIME_ID+, + * and +:CLOCK_THREAD_CPUTIME_ID+ are optional. + * + * Certain emulations are used when the given +clock_id+ + * is not supported directly: + * + * - Emulations for +:CLOCK_REALTIME+: + * + * - +:GETTIMEOFDAY_BASED_CLOCK_REALTIME+: + * Use gettimeofday() defined by SUS (deprecated in SUSv4). + * The resolution is 1 microsecond. + * - +:TIME_BASED_CLOCK_REALTIME+: + * Use time() defined by ISO C. + * The resolution is 1 second. + * + * - Emulations for +:CLOCK_MONOTONIC+: + * + * - +:MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC+: + * Use mach_absolute_time(), available on Darwin. + * The resolution is CPU dependent. + * - +:TIMES_BASED_CLOCK_MONOTONIC+: + * Use the result value of times() defined by POSIX, thus: + * >>> + * Upon successful completion, times() shall return the elapsed real time, + * in clock ticks, since an arbitrary point in the past + * (for example, system start-up time). + * + * For example, GNU/Linux returns a value based on jiffies and it is monotonic. + * However, 4.4BSD uses gettimeofday() and it is not monotonic. + * (FreeBSD uses +:CLOCK_MONOTONIC+ instead, though.) + * + * The resolution is the clock tick. + * "getconf CLK_TCK" command shows the clock ticks per second. + * (The clock ticks-per-second is defined by HZ macro in older systems.) + * If it is 100 and clock_t is 32 bits integer type, + * the resolution is 10 millisecond and cannot represent over 497 days. + * + * - Emulations for +:CLOCK_PROCESS_CPUTIME_ID+: + * + * - +:GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID+: + * Use getrusage() defined by SUS. + * getrusage() is used with RUSAGE_SELF to obtain the time only for + * the calling process (excluding the time for child processes). + * The result is addition of user time (ru_utime) and system time (ru_stime). + * The resolution is 1 microsecond. + * - +:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID+: + * Use times() defined by POSIX. + * The result is addition of user time (tms_utime) and system time (tms_stime). + * tms_cutime and tms_cstime are ignored to exclude the time for child processes. + * The resolution is the clock tick. + * "getconf CLK_TCK" command shows the clock ticks per second. + * (The clock ticks per second is defined by HZ macro in older systems.) + * If it is 100, the resolution is 10 millisecond. + * - +:CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID+: + * Use clock() defined by ISO C. + * The resolution is <tt>1/CLOCKS_PER_SEC</tt>. + * +CLOCKS_PER_SEC+ is the C-level macro defined by time.h. + * SUS defines +CLOCKS_PER_SEC+ as 1000000; + * other systems may define it differently. + * If +CLOCKS_PER_SEC+ is 1000000 (as in SUS), + * the resolution is 1 microsecond. + * If +CLOCKS_PER_SEC+ is 1000000 and clock_t is a 32-bit integer type, + * it cannot represent over 72 minutes. + * + * <b>Argument +unit+</b> + * + * Optional argument +unit+ (default +:float_second+) + * specifies the unit for the returned value. + * + * - +:float_microsecond+: Number of microseconds as a float. + * - +:float_millisecond+: Number of milliseconds as a float. + * - +:float_second+: Number of seconds as a float. + * - +:microsecond+: Number of microseconds as an integer. + * - +:millisecond+: Number of milliseconds as an integer. + * - +:nanosecond+: Number of nanoseconds as an integer. + * - +:second+: Number of seconds as an integer. + * + * Examples: + * + * Process.clock_gettime(:CLOCK_PROCESS_CPUTIME_ID, :float_microsecond) + * # => 203605054.825 + * Process.clock_gettime(:CLOCK_PROCESS_CPUTIME_ID, :float_millisecond) + * # => 203643.696848 + * Process.clock_gettime(:CLOCK_PROCESS_CPUTIME_ID, :float_second) + * # => 203.762181929 + * Process.clock_gettime(:CLOCK_PROCESS_CPUTIME_ID, :microsecond) + * # => 204123212 + * Process.clock_gettime(:CLOCK_PROCESS_CPUTIME_ID, :millisecond) + * # => 204298 + * Process.clock_gettime(:CLOCK_PROCESS_CPUTIME_ID, :nanosecond) + * # => 204602286036 + * Process.clock_gettime(:CLOCK_PROCESS_CPUTIME_ID, :second) + * # => 204 * * The underlying function, clock_gettime(), returns a number of nanoseconds. * Float object (IEEE 754 double) is not enough to represent - * the return value for CLOCK_REALTIME. - * If the exact nanoseconds value is required, use +:nanoseconds+ as the +unit+. + * the return value for +:CLOCK_REALTIME+. + * If the exact nanoseconds value is required, use +:nanosecond+ as the +unit+. * - * The origin (zero) of the returned value varies. - * For example, system start up time, process start up time, the Epoch, etc. + * The origin (time zero) of the returned value is system-dependent, + * and may be, for example, system start up time, + * process start up time, the Epoch, etc. * - * The origin in CLOCK_REALTIME is defined as the Epoch - * (1970-01-01 00:00:00 UTC). - * But some systems count leap seconds and others doesn't. - * So the result can be interpreted differently across systems. - * Time.now is recommended over CLOCK_REALTIME. + * The origin in +:CLOCK_REALTIME+ is defined as the Epoch: + * <tt>1970-01-01 00:00:00 UTC</tt>; + * some systems count leap seconds and others don't, + * so the result may vary across systems. */ -VALUE -rb_clock_gettime(int argc, VALUE *argv) +static VALUE +rb_clock_gettime(int argc, VALUE *argv, VALUE _) { - VALUE clk_id, unit; int ret; struct timetick tt; @@ -7236,13 +8274,46 @@ rb_clock_gettime(int argc, VALUE *argv) int num_numerators = 0; int num_denominators = 0; - rb_scan_args(argc, argv, "11", &clk_id, &unit); + VALUE unit = (rb_check_arity(argc, 1, 2) == 2) ? argv[1] : Qnil; + VALUE clk_id = argv[0]; +#ifdef HAVE_CLOCK_GETTIME + clockid_t c; +#endif if (SYMBOL_P(clk_id)) { +#ifdef CLOCK_REALTIME + if (clk_id == RUBY_CLOCK_REALTIME) { + c = CLOCK_REALTIME; + goto gettime; + } +#endif + +#ifdef CLOCK_MONOTONIC + if (clk_id == RUBY_CLOCK_MONOTONIC) { + c = CLOCK_MONOTONIC; + goto gettime; + } +#endif + +#ifdef CLOCK_PROCESS_CPUTIME_ID + if (clk_id == RUBY_CLOCK_PROCESS_CPUTIME_ID) { + c = CLOCK_PROCESS_CPUTIME_ID; + goto gettime; + } +#endif + +#ifdef CLOCK_THREAD_CPUTIME_ID + if (clk_id == RUBY_CLOCK_THREAD_CPUTIME_ID) { + c = CLOCK_THREAD_CPUTIME_ID; + goto gettime; + } +#endif + /* * Non-clock_gettime clocks are provided by symbol clk_id. - * - * gettimeofday is always available on platforms supported by Ruby. + */ +#ifdef HAVE_GETTIMEOFDAY + /* * GETTIMEOFDAY_BASED_CLOCK_REALTIME is used for * CLOCK_REALTIME if clock_gettime is not available. */ @@ -7257,6 +8328,7 @@ rb_clock_gettime(int argc, VALUE *argv) denominators[num_denominators++] = 1000000000; goto success; } +#endif #define RUBY_TIME_BASED_CLOCK_REALTIME ID2SYM(id_TIME_BASED_CLOCK_REALTIME) if (clk_id == RUBY_TIME_BASED_CLOCK_REALTIME) { @@ -7347,9 +8419,8 @@ rb_clock_gettime(int argc, VALUE *argv) } #ifdef __APPLE__ -#define RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC ID2SYM(id_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC) if (clk_id == RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC) { - mach_timebase_info_data_t *info = get_mach_timebase_info(); + const mach_timebase_info_data_t *info = get_mach_timebase_info(); uint64_t t = mach_absolute_time(); tt.count = (int32_t)(t % 1000000000); tt.giga_count = t / 1000000000; @@ -7360,23 +8431,24 @@ rb_clock_gettime(int argc, VALUE *argv) } #endif } - else { + else if (NUMERIC_CLOCKID) { #if defined(HAVE_CLOCK_GETTIME) struct timespec ts; - clockid_t c; c = NUM2CLOCKID(clk_id); + gettime: ret = clock_gettime(c, &ts); if (ret == -1) - rb_sys_fail("clock_gettime"); + clock_failed("gettime", errno, clk_id); tt.count = (int32_t)ts.tv_nsec; tt.giga_count = ts.tv_sec; denominators[num_denominators++] = 1000000000; goto success; #endif } - /* EINVAL emulates clock_gettime behavior when clock_id is invalid. */ - errno = EINVAL; - rb_sys_fail(0); + else { + rb_unexpected_type(clk_id, T_SYMBOL); + } + clock_failed("gettime", EINVAL, clk_id); success: return make_clock_result(&tt, numerators, num_numerators, denominators, num_denominators, unit); @@ -7384,56 +8456,86 @@ rb_clock_gettime(int argc, VALUE *argv) /* * call-seq: - * Process.clock_getres(clock_id [, unit]) -> number - * - * Returns the time resolution returned by POSIX clock_getres() function. - * - * +clock_id+ specifies a kind of clock. - * See the document of +Process.clock_gettime+ for details. + * Process.clock_getres(clock_id, unit = :float_second) -> number * - * +clock_id+ can be a symbol as +Process.clock_gettime+. - * However the result may not be accurate. - * For example, +Process.clock_getres(:GETTIMEOFDAY_BASED_CLOCK_REALTIME)+ - * returns 1.0e-06 which means 1 microsecond, but actual resolution can be more coarse. + * Returns a clock resolution as determined by POSIX function + * {clock_getres()}[https://man7.org/linux/man-pages/man3/clock_getres.3.html]: * - * If the given +clock_id+ is not supported, Errno::EINVAL is raised. + * Process.clock_getres(:CLOCK_REALTIME) # => 1.0e-09 * - * +unit+ specifies a type of the return value. - * +Process.clock_getres+ accepts +unit+ as +Process.clock_gettime+. - * The default value, +:float_second+, is also same as - * +Process.clock_gettime+. + * See Process.clock_gettime for the values of +clock_id+ and +unit+. * - * +Process.clock_getres+ also accepts +:hertz+ as +unit+. - * +:hertz+ means a the reciprocal of +:float_second+. + * Examples: * - * +:hertz+ can be used to obtain the exact value of - * the clock ticks per second for times() function and - * CLOCKS_PER_SEC for clock() function. + * Process.clock_getres(:CLOCK_PROCESS_CPUTIME_ID, :float_microsecond) # => 0.001 + * Process.clock_getres(:CLOCK_PROCESS_CPUTIME_ID, :float_millisecond) # => 1.0e-06 + * Process.clock_getres(:CLOCK_PROCESS_CPUTIME_ID, :float_second) # => 1.0e-09 + * Process.clock_getres(:CLOCK_PROCESS_CPUTIME_ID, :microsecond) # => 0 + * Process.clock_getres(:CLOCK_PROCESS_CPUTIME_ID, :millisecond) # => 0 + * Process.clock_getres(:CLOCK_PROCESS_CPUTIME_ID, :nanosecond) # => 1 + * Process.clock_getres(:CLOCK_PROCESS_CPUTIME_ID, :second) # => 0 * - * +Process.clock_getres(:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID, :hertz)+ - * returns the clock ticks per second. + * In addition to the values for +unit+ supported in Process.clock_gettime, + * this method supports +:hertz+, the integer number of clock ticks per second + * (which is the reciprocal of +:float_second+): * - * +Process.clock_getres(:CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID, :hertz)+ - * returns CLOCKS_PER_SEC. - * - * p Process.clock_getres(Process::CLOCK_MONOTONIC) - * #=> 1.0e-09 + * Process.clock_getres(:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID, :hertz) # => 100.0 + * Process.clock_getres(:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID, :float_second) # => 0.01 * + * <b>Accuracy</b>: + * Note that the returned resolution may be inaccurate on some platforms + * due to underlying bugs. + * Inaccurate resolutions have been reported for various clocks including + * +:CLOCK_MONOTONIC+ and +:CLOCK_MONOTONIC_RAW+ + * on Linux, macOS, BSD or AIX platforms, when using ARM processors, + * or when using virtualization. */ -VALUE -rb_clock_getres(int argc, VALUE *argv) +static VALUE +rb_clock_getres(int argc, VALUE *argv, VALUE _) { - VALUE clk_id, unit; + int ret; struct timetick tt; timetick_int_t numerators[2]; timetick_int_t denominators[2]; int num_numerators = 0; int num_denominators = 0; +#ifdef HAVE_CLOCK_GETRES + clockid_t c; +#endif - rb_scan_args(argc, argv, "11", &clk_id, &unit); + VALUE unit = (rb_check_arity(argc, 1, 2) == 2) ? argv[1] : Qnil; + VALUE clk_id = argv[0]; if (SYMBOL_P(clk_id)) { +#ifdef CLOCK_REALTIME + if (clk_id == RUBY_CLOCK_REALTIME) { + c = CLOCK_REALTIME; + goto getres; + } +#endif + +#ifdef CLOCK_MONOTONIC + if (clk_id == RUBY_CLOCK_MONOTONIC) { + c = CLOCK_MONOTONIC; + goto getres; + } +#endif + +#ifdef CLOCK_PROCESS_CPUTIME_ID + if (clk_id == RUBY_CLOCK_PROCESS_CPUTIME_ID) { + c = CLOCK_PROCESS_CPUTIME_ID; + goto getres; + } +#endif + +#ifdef CLOCK_THREAD_CPUTIME_ID + if (clk_id == RUBY_CLOCK_THREAD_CPUTIME_ID) { + c = CLOCK_THREAD_CPUTIME_ID; + goto getres; + } +#endif + #ifdef RUBY_GETTIMEOFDAY_BASED_CLOCK_REALTIME if (clk_id == RUBY_GETTIMEOFDAY_BASED_CLOCK_REALTIME) { tt.giga_count = 0; @@ -7490,7 +8592,7 @@ rb_clock_getres(int argc, VALUE *argv) #ifdef RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC if (clk_id == RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC) { - mach_timebase_info_data_t *info = get_mach_timebase_info(); + const mach_timebase_info_data_t *info = get_mach_timebase_info(); tt.count = 1; tt.giga_count = 0; numerators[num_numerators++] = info->numer; @@ -7500,22 +8602,24 @@ rb_clock_getres(int argc, VALUE *argv) } #endif } - else { + else if (NUMERIC_CLOCKID) { #if defined(HAVE_CLOCK_GETRES) struct timespec ts; - clockid_t c = NUM2CLOCKID(clk_id); - int ret = clock_getres(c, &ts); + c = NUM2CLOCKID(clk_id); + getres: + ret = clock_getres(c, &ts); if (ret == -1) - rb_sys_fail("clock_getres"); + clock_failed("getres", errno, clk_id); tt.count = (int32_t)ts.tv_nsec; tt.giga_count = ts.tv_sec; denominators[num_denominators++] = 1000000000; goto success; #endif } - /* EINVAL emulates clock_getres behavior when clock_id is invalid. */ - errno = EINVAL; - rb_sys_fail(0); + else { + rb_unexpected_type(clk_id, T_SYMBOL); + } + clock_failed("getres", EINVAL, clk_id); success: if (unit == ID2SYM(id_hertz)) { @@ -7526,32 +8630,578 @@ rb_clock_getres(int argc, VALUE *argv) } } +static VALUE +get_CHILD_STATUS(ID _x, VALUE *_y) +{ + return rb_last_status_get(); +} + +static VALUE +get_PROCESS_ID(ID _x, VALUE *_y) +{ + return get_pid(); +} + +/* + * call-seq: + * Process.kill(signal, *ids) -> count + * + * Sends a signal to each process specified by +ids+ + * (which must specify at least one ID); + * returns the count of signals sent. + * + * For each given +id+, if +id+ is: + * + * - Positive, sends the signal to the process whose process ID is +id+. + * - Zero, send the signal to all processes in the current process group. + * - Negative, sends the signal to a system-dependent collection of processes. + * + * Argument +signal+ specifies the signal to be sent; + * the argument may be: + * + * - An integer signal number: e.g., +-29+, +0+, +29+. + * - A signal name (string), with or without leading <tt>'SIG'</tt>, + * and with or without a further prefixed minus sign (<tt>'-'</tt>): + * e.g.: + * + * - <tt>'SIGPOLL'</tt>. + * - <tt>'POLL'</tt>, + * - <tt>'-SIGPOLL'</tt>. + * - <tt>'-POLL'</tt>. + * + * - A signal symbol, with or without leading <tt>'SIG'</tt>, + * and with or without a further prefixed minus sign (<tt>'-'</tt>): + * e.g.: + * + * - +:SIGPOLL+. + * - +:POLL+. + * - <tt>:'-SIGPOLL'</tt>. + * - <tt>:'-POLL'</tt>. + * + * If +signal+ is: + * + * - A non-negative integer, or a signal name or symbol + * without prefixed <tt>'-'</tt>, + * each process with process ID +id+ is signalled. + * - A negative integer, or a signal name or symbol + * with prefixed <tt>'-'</tt>, + * each process group with group ID +id+ is signalled. + * + * Use method Signal.list to see which signals are supported + * by Ruby on the underlying platform; + * the method returns a hash of the string names + * and non-negative integer values of the supported signals. + * The size and content of the returned hash varies widely + * among platforms. + * + * Additionally, signal +0+ is useful to determine if the process exists. + * + * Example: + * + * pid = fork do + * Signal.trap('HUP') { puts 'Ouch!'; exit } + * # ... do some work ... + * end + * # ... + * Process.kill('HUP', pid) + * Process.wait + * + * Output: + * + * Ouch! + * + * Exceptions: + * + * - Raises Errno::EINVAL or RangeError if +signal+ is an integer + * but invalid. + * - Raises ArgumentError if +signal+ is a string or symbol + * but invalid. + * - Raises Errno::ESRCH or RangeError if one of +ids+ is invalid. + * - Raises Errno::EPERM if needed permissions are not in force. + * + * In the last two cases, signals may have been sent to some processes. + */ + +static VALUE +proc_rb_f_kill(int c, const VALUE *v, VALUE _) +{ + return rb_f_kill(c, v); +} + VALUE rb_mProcess; -VALUE rb_mProcUID; -VALUE rb_mProcGID; -VALUE rb_mProcID_Syscall; +static VALUE rb_mProcUID; +static VALUE rb_mProcGID; +static VALUE rb_mProcID_Syscall; +/* + * call-seq: + * Process.warmup -> true + * + * Notify the Ruby virtual machine that the boot sequence is finished, + * and that now is a good time to optimize the application. This is useful + * for long running applications. + * + * This method is expected to be called at the end of the application boot. + * If the application is deployed using a pre-forking model, +Process.warmup+ + * should be called in the original process before the first fork. + * + * The actual optimizations performed are entirely implementation specific + * and may change in the future without notice. + * + * On CRuby, +Process.warmup+: + * + * * Performs a major GC. + * * Compacts the heap. + * * Promotes all surviving objects to the old generation. + * * Precomputes the coderange of all strings. + * * Frees all empty heap pages and increments the allocatable pages counter + * by the number of pages freed. + * * Invoke +malloc_trim+ if available to free empty malloc pages. + */ + +static VALUE +proc_warmup(VALUE _) +{ + RB_VM_LOCKING() { + rb_gc_prepare_heap(); + } + return Qtrue; +} /* - * The <code>Process</code> module is a collection of methods used to - * manipulate processes. + * Document-module: Process + * + * Module +Process+ represents a process in the underlying operating system. + * Its methods support management of the current process and its child processes. + * + * == Process Creation + * + * Each of the following methods executes a given command in a new process or subshell, + * or multiple commands in new processes and/or subshells. + * The choice of process or subshell depends on the form of the command; + * see {Argument command_line or exe_path}[rdoc-ref:Process@Argument+command_line+or+exe_path]. + * + * - Process.spawn, Kernel#spawn: Executes the command; + * returns the new pid without waiting for completion. + * - Process.exec: Replaces the current process by executing the command. + * + * In addition: + * + * - Method Kernel#system executes a given command-line (string) in a subshell; + * returns +true+, +false+, or +nil+. + * - Method Kernel#` executes a given command-line (string) in a subshell; + * returns its $stdout string. + * - Module Open3 supports creating child processes + * with access to their $stdin, $stdout, and $stderr streams. + * + * === Execution Environment + * + * Optional leading argument +env+ is a hash of name/value pairs, + * where each name is a string and each value is a string or +nil+; + * each name/value pair is added to ENV in the new process. + * + * Process.spawn( 'ruby -e "p ENV[\"Foo\"]"') + * Process.spawn({'Foo' => '0'}, 'ruby -e "p ENV[\"Foo\"]"') + * + * Output: + * + * "0" + * + * The effect is usually similar to that of calling ENV#update with argument +env+, + * where each named environment variable is created or updated + * (if the value is non-+nil+), + * or deleted (if the value is +nil+). + * + * However, some modifications to the calling process may remain + * if the new process fails. + * For example, hard resource limits are not restored. + * + * === Argument +command_line+ or +exe_path+ + * + * The required string argument is one of the following: + * + * - +command_line+ if it begins with a shell reserved word or special built-in, + * or if it contains one or more meta characters. + * - +exe_path+ otherwise. + * + * ==== Argument +command_line+ + * + * \String argument +command_line+ is a command line to be passed to a shell; + * it must begin with a shell reserved word, begin with a special built-in, + * or contain meta characters: + * + * system('if true; then echo "Foo"; fi') # => true # Shell reserved word. + * system('exit') # => true # Built-in. + * system('date > /tmp/date.tmp') # => true # Contains meta character. + * system('date > /nop/date.tmp') # => false + * system('date > /nop/date.tmp', exception: true) # Raises RuntimeError. + * + * The command line may also contain arguments and options for the command: + * + * system('echo "Foo"') # => true + * + * Output: + * + * Foo + * + * See {Execution Shell}[rdoc-ref:Process@Execution+Shell] for details about the shell. + * + * ==== Argument +exe_path+ + * + * Argument +exe_path+ is one of the following: + * + * - The string path to an executable file to be called: + * + * Example: + * + * system('/usr/bin/date') # => true # Path to date on Unix-style system. + * system('foo') # => nil # Command execlution failed. + * + * Output: + * + * Thu Aug 31 10:06:48 AM CDT 2023 + * + * A path or command name containing spaces without arguments cannot + * be distinguished from +command_line+ above, so you must quote or + * escape the entire command name using a shell in platform + * dependent manner, or use the array form below. + * + * If +exe_path+ does not contain any path separator, an executable + * file is searched from directories specified with the +PATH+ + * environment variable. What the word "executable" means here is + * depending on platforms. + * + * Even if the file considered "executable", its content may not be + * in proper executable format. In that case, Ruby tries to run it + * by using <tt>/bin/sh</tt> on a Unix-like system, like system(3) + * does. + * + * File.write('shell_command', 'echo $SHELL', perm: 0o755) + * system('./shell_command') # prints "/bin/sh" or something. + * + * - A 2-element array containing the path to an executable + * and the string to be used as the name of the executing process: + * + * Example: + * + * pid = spawn(['sleep', 'Hello!'], '1') # 2-element array. + * p `ps -p #{pid} -o command=` + * + * Output: + * + * "Hello! 1\n" + * + * === Arguments +args+ + * + * If +command_line+ does not contain shell meta characters except for + * spaces and tabs, or +exe_path+ is given, Ruby invokes the + * executable directly. This form does not use the shell: + * + * spawn("doesnt_exist") # Raises Errno::ENOENT + * spawn("doesnt_exist", "\n") # Raises Errno::ENOENT + * + * spawn("doesnt_exist\n") # => false + * # sh: 1: doesnot_exist: not found + * + * The error message is from a shell and would vary depending on your + * system. + * + * If one or more +args+ is given after +exe_path+, each is an + * argument or option to be passed to the executable: + * + * Example: + * + * system('echo', '<', 'C*', '|', '$SHELL', '>') # => true + * + * Output: + * + * < C* | $SHELL > + * + * However, there are exceptions on Windows. See {Execution Shell on + * Windows}[rdoc-ref:Process@Execution+Shell+on+Windows]. + * + * If you want to invoke a path containing spaces with no arguments + * without shell, you will need to use a 2-element array +exe_path+. + * + * Example: + * + * path = '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome' + * spawn(path) # Raises Errno::ENOENT; No such file or directory - /Applications/Google + * spawn([path] * 2) + * + * === Execution Options + * + * Optional trailing argument +options+ is a hash of execution options. + * + * ==== Working Directory (+:chdir+) + * + * By default, the working directory for the new process is the same as + * that of the current process: + * + * Dir.chdir('/var') + * Process.spawn('ruby -e "puts Dir.pwd"') + * + * Output: + * + * /var + * + * Use option +:chdir+ to set the working directory for the new process: + * + * Process.spawn('ruby -e "puts Dir.pwd"', {chdir: '/tmp'}) + * + * Output: + * + * /tmp + * + * The working directory of the current process is not changed: + * + * Dir.pwd # => "/var" + * + * ==== \File Redirection (\File Descriptor) + * + * Use execution options for file redirection in the new process. + * + * The key for such an option may be an integer file descriptor (fd), + * specifying a source, + * or an array of fds, specifying multiple sources. + * + * An integer source fd may be specified as: + * + * - _n_: Specifies file descriptor _n_. + * + * There are these shorthand symbols for fds: + * + * - +:in+: Specifies file descriptor 0 (STDIN). + * - +:out+: Specifies file descriptor 1 (STDOUT). + * - +:err+: Specifies file descriptor 2 (STDERR). + * + * The value given with a source is one of: + * + * - _n_: + * Redirects to fd _n_ in the parent process. + * - +filepath+: + * Redirects from or to the file at +filepath+ via <tt>open(filepath, mode, 0644)</tt>, + * where +mode+ is <tt>'r'</tt> for source +:in+, + * or <tt>'w'</tt> for source +:out+ or +:err+. + * - <tt>[filepath]</tt>: + * Redirects from the file at +filepath+ via <tt>open(filepath, 'r', 0644)</tt>. + * - <tt>[filepath, mode]</tt>: + * Redirects from or to the file at +filepath+ via <tt>open(filepath, mode, 0644)</tt>. + * - <tt>[filepath, mode, perm]</tt>: + * Redirects from or to the file at +filepath+ via <tt>open(filepath, mode, perm)</tt>. + * - <tt>[:child, fd]</tt>: + * Redirects to the redirected +fd+. + * - +:close+: Closes the file descriptor in child process. + * + * See {Access Modes}[rdoc-ref:File@Access+Modes] + * and {File Permissions}[rdoc-ref:File@File+Permissions]. + * + * ==== Environment Variables (+:unsetenv_others+) + * + * By default, the new process inherits environment variables + * from the parent process; + * use execution option key +:unsetenv_others+ with value +true+ + * to clear environment variables in the new process. + * + * Any changes specified by execution option +env+ are made after the new process + * inherits or clears its environment variables; + * see {Execution Environment}[rdoc-ref:Process@Execution+Environment]. + * + * ==== \File-Creation Access (+:umask+) + * + * Use execution option +:umask+ to set the file-creation access + * for the new process; + * see {Access Modes}[rdoc-ref:File@Access+Modes]: + * + * command = 'ruby -e "puts sprintf(\"0%o\", File.umask)"' + * options = {:umask => 0644} + * Process.spawn(command, options) + * + * Output: + * + * 0644 + * + * ==== Process Groups (+:pgroup+ and +:new_pgroup+) + * + * By default, the new process belongs to the same + * {process group}[https://en.wikipedia.org/wiki/Process_group] + * as the parent process. + * + * To specify a different process group. + * use execution option +:pgroup+ with one of the following values: + * + * - +true+: Create a new process group for the new process. + * - _pgid_: Create the new process in the process group + * whose id is _pgid_. + * + * On Windows only, use execution option +:new_pgroup+ with value +true+ + * to create a new process group for the new process. + * + * ==== Resource Limits + * + * Use execution options to set resource limits. + * + * The keys for these options are symbols of the form + * <tt>:rlimit_<i>resource_name</i></tt>, + * where _resource_name_ is the downcased form of one of the string + * resource names described at method Process.setrlimit. + * For example, key +:rlimit_cpu+ corresponds to resource limit <tt>'CPU'</tt>. + * + * The value for such as key is one of: + * + * - An integer, specifying both the current and maximum limits. + * - A 2-element array of integers, specifying the current and maximum limits. + * + * ==== \File Descriptor Inheritance + * + * By default, the new process inherits file descriptors from the parent process. + * + * Use execution option <tt>:close_others => true</tt> to modify that inheritance + * by closing non-standard fds (3 and greater) that are not otherwise redirected. + * + * === Execution Shell + * + * On a Unix-like system, the shell invoked is <tt>/bin/sh</tt>; + * the entire string +command_line+ is passed as an argument + * to {shell option -c}[https://pubs.opengroup.org/onlinepubs/9699919799.2018edition/utilities/sh.html]. + * + * The shell performs normal shell expansion on the command line: + * + * Example: + * + * system('echo $SHELL: C*') # => true + * + * Output: + * + * /bin/bash: CONTRIBUTING.md COPYING COPYING.ja + * + * ==== Execution Shell on Windows + * + * On Windows, the shell invoked is determined by environment variable + * +RUBYSHELL+, if defined, or +COMSPEC+ otherwise; the entire string + * +command_line+ is passed as an argument to <tt>-c</tt> option for + * +RUBYSHELL+, as well as <tt>/bin/sh</tt>, and {/c + * option}[https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/cmd] + * for +COMSPEC+. The shell is invoked automatically in the following + * cases: + * + * - The command is a built-in of +cmd.exe+, such as +echo+. + * - The executable file is a batch file; its name ends with +.bat+ or + * +.cmd+. + * + * Note that the command will still be invoked as +command_line+ form + * even when called in +exe_path+ form, because +cmd.exe+ does not + * accept a script name like <tt>/bin/sh</tt> does but only works with + * <tt>/c</tt> option. + * + * The standard shell +cmd.exe+ performs environment variable + * expansion but does not have globbing functionality: + * + * Example: + * + * system("echo %COMSPEC%: C*")' # => true + * + * Output: + * + * C:\WINDOWS\system32\cmd.exe: C* + * + * == What's Here + * + * === Current-Process Getters + * + * - ::argv0: Returns the process name as a frozen string. + * - ::egid: Returns the effective group ID. + * - ::euid: Returns the effective user ID. + * - ::getpgrp: Return the process group ID. + * - ::getrlimit: Returns the resource limit. + * - ::gid: Returns the (real) group ID. + * - ::pid: Returns the process ID. + * - ::ppid: Returns the process ID of the parent process. + * - ::uid: Returns the (real) user ID. + * + * === Current-Process Setters + * + * - ::egid=: Sets the effective group ID. + * - ::euid=: Sets the effective user ID. + * - ::gid=: Sets the (real) group ID. + * - ::setproctitle: Sets the process title. + * - ::setpgrp: Sets the process group ID of the process to zero. + * - ::setrlimit: Sets a resource limit. + * - ::setsid: Establishes the process as a new session and process group leader, + * with no controlling tty. + * - ::uid=: Sets the user ID. + * + * === Current-Process Execution + * + * - ::abort: Immediately terminates the process. + * - ::daemon: Detaches the process from its controlling terminal + * and continues running it in the background as system daemon. + * - ::exec: Replaces the process by running a given external command. + * - ::exit: Initiates process termination by raising exception SystemExit + * (which may be caught). + * - ::exit!: Immediately exits the process. + * - ::warmup: Notifies the Ruby virtual machine that the boot sequence + * for the application is completed, + * and that the VM may begin optimizing the application. + * + * === Child Processes + * + * - ::detach: Guards against a child process becoming a zombie. + * - ::fork: Creates a child process. + * - ::kill: Sends a given signal to processes. + * - ::spawn: Creates a child process. + * - ::wait, ::waitpid: Waits for a child process to exit; returns its process ID. + * - ::wait2, ::waitpid2: Waits for a child process to exit; returns its process ID and status. + * - ::waitall: Waits for all child processes to exit; + * returns their process IDs and statuses. + * + * === Process Groups + * + * - ::getpgid: Returns the process group ID for a process. + * - ::getpriority: Returns the scheduling priority + * for a process, process group, or user. + * - ::getsid: Returns the session ID for a process. + * - ::groups: Returns an array of the group IDs + * in the supplemental group access list for this process. + * - ::groups=: Sets the supplemental group access list + * to the given array of group IDs. + * - ::initgroups: Initializes the supplemental group access list. + * - ::last_status: Returns the status of the last executed child process + * in the current thread. + * - ::maxgroups: Returns the maximum number of group IDs allowed + * in the supplemental group access list. + * - ::maxgroups=: Sets the maximum number of group IDs allowed + * in the supplemental group access list. + * - ::setpgid: Sets the process group ID of a process. + * - ::setpriority: Sets the scheduling priority + * for a process, process group, or user. + * + * === Timing + * + * - ::clock_getres: Returns the resolution of a system clock. + * - ::clock_gettime: Returns the time from a system clock. + * - ::times: Returns a Process::Tms object containing times + * for the current process and its child processes. + * */ void InitVM_process(void) { -#undef rb_intern -#define rb_intern(str) rb_intern_const(str) - rb_define_virtual_variable("$?", rb_last_status_get, 0); - rb_define_virtual_variable("$$", get_pid, 0); - rb_define_global_function("exec", rb_f_exec, -1); + rb_define_virtual_variable("$?", get_CHILD_STATUS, 0); + rb_define_virtual_variable("$$", get_PROCESS_ID, 0); + + rb_gvar_ractor_local("$$"); + rb_gvar_ractor_local("$?"); + + rb_define_global_function("exec", f_exec, -1); rb_define_global_function("fork", rb_f_fork, 0); rb_define_global_function("exit!", rb_f_exit_bang, -1); rb_define_global_function("system", rb_f_system, -1); rb_define_global_function("spawn", rb_f_spawn, -1); rb_define_global_function("sleep", rb_f_sleep, -1); - rb_define_global_function("exit", rb_f_exit, -1); - rb_define_global_function("abort", rb_f_abort, -1); + rb_define_global_function("exit", f_exit, -1); + rb_define_global_function("abort", f_abort, -1); rb_mProcess = rb_define_module("Process"); @@ -7570,37 +9220,43 @@ InitVM_process(void) rb_define_const(rb_mProcess, "WUNTRACED", INT2FIX(0)); #endif - rb_define_singleton_method(rb_mProcess, "exec", rb_f_exec, -1); + rb_define_singleton_method(rb_mProcess, "exec", f_exec, -1); rb_define_singleton_method(rb_mProcess, "fork", rb_f_fork, 0); rb_define_singleton_method(rb_mProcess, "spawn", rb_f_spawn, -1); rb_define_singleton_method(rb_mProcess, "exit!", rb_f_exit_bang, -1); - rb_define_singleton_method(rb_mProcess, "exit", rb_f_exit, -1); - rb_define_singleton_method(rb_mProcess, "abort", rb_f_abort, -1); + rb_define_singleton_method(rb_mProcess, "exit", f_exit, -1); + rb_define_singleton_method(rb_mProcess, "abort", f_abort, -1); + rb_define_singleton_method(rb_mProcess, "last_status", proc_s_last_status, 0); + rb_define_singleton_method(rb_mProcess, "_fork", rb_proc__fork, 0); - rb_define_module_function(rb_mProcess, "kill", rb_f_kill, -1); /* in signal.c */ - rb_define_module_function(rb_mProcess, "wait", proc_wait, -1); + rb_define_module_function(rb_mProcess, "kill", proc_rb_f_kill, -1); + rb_define_module_function(rb_mProcess, "wait", proc_m_wait, -1); rb_define_module_function(rb_mProcess, "wait2", proc_wait2, -1); - rb_define_module_function(rb_mProcess, "waitpid", proc_wait, -1); + rb_define_module_function(rb_mProcess, "waitpid", proc_m_wait, -1); rb_define_module_function(rb_mProcess, "waitpid2", proc_wait2, -1); rb_define_module_function(rb_mProcess, "waitall", proc_waitall, 0); rb_define_module_function(rb_mProcess, "detach", proc_detach, 1); + /* :nodoc: */ rb_cWaiter = rb_define_class_under(rb_mProcess, "Waiter", rb_cThread); rb_undef_alloc_func(rb_cWaiter); rb_undef_method(CLASS_OF(rb_cWaiter), "new"); rb_define_method(rb_cWaiter, "pid", detach_process_pid, 0); rb_cProcessStatus = rb_define_class_under(rb_mProcess, "Status", rb_cObject); + rb_define_alloc_func(rb_cProcessStatus, rb_process_status_allocate); rb_undef_method(CLASS_OF(rb_cProcessStatus), "new"); + rb_marshal_define_compat(rb_cProcessStatus, rb_cObject, + process_status_dump, process_status_load); + + rb_define_singleton_method(rb_cProcessStatus, "wait", rb_process_status_waitv, -1); rb_define_method(rb_cProcessStatus, "==", pst_equal, 1); - rb_define_method(rb_cProcessStatus, "&", pst_bitand, 1); - rb_define_method(rb_cProcessStatus, ">>", pst_rshift, 1); rb_define_method(rb_cProcessStatus, "to_i", pst_to_i, 0); rb_define_method(rb_cProcessStatus, "to_s", pst_to_s, 0); rb_define_method(rb_cProcessStatus, "inspect", pst_inspect, 0); - rb_define_method(rb_cProcessStatus, "pid", pst_pid, 0); + rb_define_method(rb_cProcessStatus, "pid", pst_pid_m, 0); rb_define_method(rb_cProcessStatus, "stopped?", pst_wifstopped, 0); rb_define_method(rb_cProcessStatus, "stopsig", pst_wstopsig, 0); @@ -7611,8 +9267,8 @@ InitVM_process(void) rb_define_method(rb_cProcessStatus, "success?", pst_success_p, 0); rb_define_method(rb_cProcessStatus, "coredump?", pst_wcoredump, 0); - rb_define_module_function(rb_mProcess, "pid", get_pid, 0); - rb_define_module_function(rb_mProcess, "ppid", get_ppid, 0); + rb_define_module_function(rb_mProcess, "pid", proc_get_pid, 0); + rb_define_module_function(rb_mProcess, "ppid", proc_get_ppid, 0); rb_define_module_function(rb_mProcess, "getpgrp", proc_getpgrp, 0); rb_define_module_function(rb_mProcess, "setpgrp", proc_setpgrp, 0); @@ -7625,6 +9281,8 @@ InitVM_process(void) rb_define_module_function(rb_mProcess, "getpriority", proc_getpriority, 2); rb_define_module_function(rb_mProcess, "setpriority", proc_setpriority, 3); + rb_define_module_function(rb_mProcess, "warmup", proc_warmup, 0); + #ifdef HAVE_GETPRIORITY /* see Process.setpriority */ rb_define_const(rb_mProcess, "PRIO_PROCESS", INT2FIX(PRIO_PROCESS)); @@ -7640,20 +9298,20 @@ InitVM_process(void) { VALUE inf = RLIM2NUM(RLIM_INFINITY); #ifdef RLIM_SAVED_MAX - { - VALUE v = RLIM_INFINITY == RLIM_SAVED_MAX ? inf : RLIM2NUM(RLIM_SAVED_MAX); - /* see Process.setrlimit */ - rb_define_const(rb_mProcess, "RLIM_SAVED_MAX", v); - } + { + VALUE v = RLIM_INFINITY == RLIM_SAVED_MAX ? inf : RLIM2NUM(RLIM_SAVED_MAX); + /* see Process.setrlimit */ + rb_define_const(rb_mProcess, "RLIM_SAVED_MAX", v); + } #endif - /* see Process.setrlimit */ + /* see Process.setrlimit */ rb_define_const(rb_mProcess, "RLIM_INFINITY", inf); #ifdef RLIM_SAVED_CUR - { - VALUE v = RLIM_INFINITY == RLIM_SAVED_CUR ? inf : RLIM2NUM(RLIM_SAVED_CUR); - /* see Process.setrlimit */ - rb_define_const(rb_mProcess, "RLIM_SAVED_CUR", v); - } + { + VALUE v = RLIM_INFINITY == RLIM_SAVED_CUR ? inf : RLIM2NUM(RLIM_SAVED_CUR); + /* see Process.setrlimit */ + rb_define_const(rb_mProcess, "RLIM_SAVED_CUR", v); + } #endif } #ifdef RLIMIT_AS @@ -7729,6 +9387,14 @@ InitVM_process(void) */ rb_define_const(rb_mProcess, "RLIMIT_NPROC", INT2FIX(RLIMIT_NPROC)); #endif +#ifdef RLIMIT_NPTS + /* The maximum number of pseudo-terminals that can be created for the + * real user ID of the calling process. + * + * see the system getrlimit(2) manual for details. + */ + rb_define_const(rb_mProcess, "RLIMIT_NPTS", INT2FIX(RLIMIT_NPTS)); +#endif #ifdef RLIMIT_RSS /* Specifies the limit (in pages) of the process's resident set. * @@ -7791,78 +9457,145 @@ InitVM_process(void) rb_define_module_function(rb_mProcess, "times", rb_proc_times, 0); -#ifdef CLOCK_REALTIME - rb_define_const(rb_mProcess, "CLOCK_REALTIME", CLOCKID2NUM(CLOCK_REALTIME)); +#if defined(RUBY_CLOCK_REALTIME) #elif defined(RUBY_GETTIMEOFDAY_BASED_CLOCK_REALTIME) - rb_define_const(rb_mProcess, "CLOCK_REALTIME", RUBY_GETTIMEOFDAY_BASED_CLOCK_REALTIME); +# define RUBY_CLOCK_REALTIME RUBY_GETTIMEOFDAY_BASED_CLOCK_REALTIME +#elif defined(RUBY_TIME_BASED_CLOCK_REALTIME) +# define RUBY_CLOCK_REALTIME RUBY_TIME_BASED_CLOCK_REALTIME #endif -#ifdef CLOCK_MONOTONIC - rb_define_const(rb_mProcess, "CLOCK_MONOTONIC", CLOCKID2NUM(CLOCK_MONOTONIC)); +#if defined(CLOCK_REALTIME) && defined(CLOCKID2NUM) + /* see Process.clock_gettime */ + rb_define_const(rb_mProcess, "CLOCK_REALTIME", CLOCKID2NUM(CLOCK_REALTIME)); +#elif defined(RUBY_CLOCK_REALTIME) + rb_define_const(rb_mProcess, "CLOCK_REALTIME", RUBY_CLOCK_REALTIME); +#endif + +#if defined(RUBY_CLOCK_MONOTONIC) #elif defined(RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC) - rb_define_const(rb_mProcess, "CLOCK_MONOTONIC", RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC); +# define RUBY_CLOCK_MONOTONIC RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC #endif -#ifdef CLOCK_PROCESS_CPUTIME_ID - rb_define_const(rb_mProcess, "CLOCK_PROCESS_CPUTIME_ID", CLOCKID2NUM(CLOCK_PROCESS_CPUTIME_ID)); +#if defined(CLOCK_MONOTONIC) && defined(CLOCKID2NUM) + /* see Process.clock_gettime */ + rb_define_const(rb_mProcess, "CLOCK_MONOTONIC", CLOCKID2NUM(CLOCK_MONOTONIC)); +#elif defined(RUBY_CLOCK_MONOTONIC) + rb_define_const(rb_mProcess, "CLOCK_MONOTONIC", RUBY_CLOCK_MONOTONIC); +#endif + +#if defined(RUBY_CLOCK_PROCESS_CPUTIME_ID) #elif defined(RUBY_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID) - rb_define_const(rb_mProcess, "CLOCK_PROCESS_CPUTIME_ID", RUBY_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID); +# define RUBY_CLOCK_PROCESS_CPUTIME_ID RUBY_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID #endif -#ifdef CLOCK_THREAD_CPUTIME_ID +#if defined(CLOCK_PROCESS_CPUTIME_ID) && defined(CLOCKID2NUM) + /* see Process.clock_gettime */ + rb_define_const(rb_mProcess, "CLOCK_PROCESS_CPUTIME_ID", CLOCKID2NUM(CLOCK_PROCESS_CPUTIME_ID)); +#elif defined(RUBY_CLOCK_PROCESS_CPUTIME_ID) + rb_define_const(rb_mProcess, "CLOCK_PROCESS_CPUTIME_ID", RUBY_CLOCK_PROCESS_CPUTIME_ID); +#endif + +#if defined(CLOCK_THREAD_CPUTIME_ID) && defined(CLOCKID2NUM) + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_THREAD_CPUTIME_ID", CLOCKID2NUM(CLOCK_THREAD_CPUTIME_ID)); +#elif defined(RUBY_CLOCK_THREAD_CPUTIME_ID) + rb_define_const(rb_mProcess, "CLOCK_THREAD_CPUTIME_ID", RUBY_CLOCK_THREAD_CPUTIME_ID); #endif + +#ifdef CLOCKID2NUM #ifdef CLOCK_VIRTUAL + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_VIRTUAL", CLOCKID2NUM(CLOCK_VIRTUAL)); #endif #ifdef CLOCK_PROF + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_PROF", CLOCKID2NUM(CLOCK_PROF)); #endif #ifdef CLOCK_REALTIME_FAST + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_REALTIME_FAST", CLOCKID2NUM(CLOCK_REALTIME_FAST)); #endif #ifdef CLOCK_REALTIME_PRECISE + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_REALTIME_PRECISE", CLOCKID2NUM(CLOCK_REALTIME_PRECISE)); #endif #ifdef CLOCK_REALTIME_COARSE + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_REALTIME_COARSE", CLOCKID2NUM(CLOCK_REALTIME_COARSE)); #endif #ifdef CLOCK_REALTIME_ALARM + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_REALTIME_ALARM", CLOCKID2NUM(CLOCK_REALTIME_ALARM)); #endif #ifdef CLOCK_MONOTONIC_FAST + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_MONOTONIC_FAST", CLOCKID2NUM(CLOCK_MONOTONIC_FAST)); #endif #ifdef CLOCK_MONOTONIC_PRECISE + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_MONOTONIC_PRECISE", CLOCKID2NUM(CLOCK_MONOTONIC_PRECISE)); #endif #ifdef CLOCK_MONOTONIC_RAW + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_MONOTONIC_RAW", CLOCKID2NUM(CLOCK_MONOTONIC_RAW)); #endif +#ifdef CLOCK_MONOTONIC_RAW_APPROX + /* see Process.clock_gettime */ + rb_define_const(rb_mProcess, "CLOCK_MONOTONIC_RAW_APPROX", CLOCKID2NUM(CLOCK_MONOTONIC_RAW_APPROX)); +#endif #ifdef CLOCK_MONOTONIC_COARSE + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_MONOTONIC_COARSE", CLOCKID2NUM(CLOCK_MONOTONIC_COARSE)); #endif #ifdef CLOCK_BOOTTIME + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_BOOTTIME", CLOCKID2NUM(CLOCK_BOOTTIME)); #endif #ifdef CLOCK_BOOTTIME_ALARM + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_BOOTTIME_ALARM", CLOCKID2NUM(CLOCK_BOOTTIME_ALARM)); #endif #ifdef CLOCK_UPTIME + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_UPTIME", CLOCKID2NUM(CLOCK_UPTIME)); #endif #ifdef CLOCK_UPTIME_FAST + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_UPTIME_FAST", CLOCKID2NUM(CLOCK_UPTIME_FAST)); #endif #ifdef CLOCK_UPTIME_PRECISE + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_UPTIME_PRECISE", CLOCKID2NUM(CLOCK_UPTIME_PRECISE)); #endif +#ifdef CLOCK_UPTIME_RAW + /* see Process.clock_gettime */ + rb_define_const(rb_mProcess, "CLOCK_UPTIME_RAW", CLOCKID2NUM(CLOCK_UPTIME_RAW)); +#endif +#ifdef CLOCK_UPTIME_RAW_APPROX + /* see Process.clock_gettime */ + rb_define_const(rb_mProcess, "CLOCK_UPTIME_RAW_APPROX", CLOCKID2NUM(CLOCK_UPTIME_RAW_APPROX)); +#endif #ifdef CLOCK_SECOND + /* see Process.clock_gettime */ rb_define_const(rb_mProcess, "CLOCK_SECOND", CLOCKID2NUM(CLOCK_SECOND)); #endif +#ifdef CLOCK_TAI + /* see Process.clock_gettime */ + rb_define_const(rb_mProcess, "CLOCK_TAI", CLOCKID2NUM(CLOCK_TAI)); +#endif +#endif rb_define_module_function(rb_mProcess, "clock_gettime", rb_clock_gettime, -1); rb_define_module_function(rb_mProcess, "clock_getres", rb_clock_getres, -1); #if defined(HAVE_TIMES) || defined(_WIN32) rb_cProcessTms = rb_struct_define_under(rb_mProcess, "Tms", "utime", "stime", "cutime", "cstime", NULL); - rb_define_const(rb_cStruct, "Tms", rb_cProcessTms); /* for the backward compatibility */ +#if 0 /* for RDoc */ + /* user time used in this process */ + rb_define_attr(rb_cProcessTms, "utime", TRUE, TRUE); + /* system time used in this process */ + rb_define_attr(rb_cProcessTms, "stime", TRUE, TRUE); + /* user time used in the child processes */ + rb_define_attr(rb_cProcessTms, "cutime", TRUE, TRUE); + /* system time used in the child processes */ + rb_define_attr(rb_cProcessTms, "cstime", TRUE, TRUE); +#endif #endif SAVED_USER_ID = geteuid(); @@ -7923,46 +9656,58 @@ InitVM_process(void) void Init_process(void) { - id_in = rb_intern("in"); - id_out = rb_intern("out"); - id_err = rb_intern("err"); - id_pid = rb_intern("pid"); - id_uid = rb_intern("uid"); - id_gid = rb_intern("gid"); - id_close = rb_intern("close"); - id_child = rb_intern("child"); +#define define_id(name) id_##name = rb_intern_const(#name) + define_id(in); + define_id(out); + define_id(err); + define_id(pid); + define_id(uid); + define_id(gid); + define_id(close); + define_id(child); #ifdef HAVE_SETPGID - id_pgroup = rb_intern("pgroup"); + define_id(pgroup); #endif #ifdef _WIN32 - id_new_pgroup = rb_intern("new_pgroup"); -#endif - id_unsetenv_others = rb_intern("unsetenv_others"); - id_chdir = rb_intern("chdir"); - id_umask = rb_intern("umask"); - id_close_others = rb_intern("close_others"); - id_ENV = rb_intern("ENV"); - id_nanosecond = rb_intern("nanosecond"); - id_microsecond = rb_intern("microsecond"); - id_millisecond = rb_intern("millisecond"); - id_second = rb_intern("second"); - id_float_microsecond = rb_intern("float_microsecond"); - id_float_millisecond = rb_intern("float_millisecond"); - id_float_second = rb_intern("float_second"); - id_GETTIMEOFDAY_BASED_CLOCK_REALTIME = rb_intern("GETTIMEOFDAY_BASED_CLOCK_REALTIME"); - id_TIME_BASED_CLOCK_REALTIME = rb_intern("TIME_BASED_CLOCK_REALTIME"); + define_id(new_pgroup); +#endif + define_id(unsetenv_others); + define_id(chdir); + define_id(umask); + define_id(close_others); + define_id(nanosecond); + define_id(microsecond); + define_id(millisecond); + define_id(second); + define_id(float_microsecond); + define_id(float_millisecond); + define_id(float_second); + define_id(GETTIMEOFDAY_BASED_CLOCK_REALTIME); + define_id(TIME_BASED_CLOCK_REALTIME); +#ifdef CLOCK_REALTIME + define_id(CLOCK_REALTIME); +#endif +#ifdef CLOCK_MONOTONIC + define_id(CLOCK_MONOTONIC); +#endif +#ifdef CLOCK_PROCESS_CPUTIME_ID + define_id(CLOCK_PROCESS_CPUTIME_ID); +#endif +#ifdef CLOCK_THREAD_CPUTIME_ID + define_id(CLOCK_THREAD_CPUTIME_ID); +#endif #ifdef HAVE_TIMES - id_TIMES_BASED_CLOCK_MONOTONIC = rb_intern("TIMES_BASED_CLOCK_MONOTONIC"); - id_TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID = rb_intern("TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID"); + define_id(TIMES_BASED_CLOCK_MONOTONIC); + define_id(TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID); #endif #ifdef RUSAGE_SELF - id_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID = rb_intern("GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID"); + define_id(GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID); #endif - id_CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID = rb_intern("CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID"); + define_id(CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID); #ifdef __APPLE__ - id_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC = rb_intern("MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC"); + define_id(MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC); #endif - id_hertz = rb_intern("hertz"); + define_id(hertz); InitVM(process); } |