diff options
Diffstat (limited to 'process.c')
| -rw-r--r-- | process.c | 6082 |
1 files changed, 2161 insertions, 3921 deletions
@@ -11,114 +11,81 @@ **********************************************************************/ -#include "ruby/internal/config.h" - -#include "ruby/fiber/scheduler.h" +#include "internal.h" +#include "ruby/io.h" +#include "ruby/thread.h" +#include "ruby/util.h" +#include "vm_core.h" -#include <ctype.h> +#include <stdio.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> #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 "rjit.h" -#include "ruby/io.h" -#include "ruby/st.h" -#include "ruby/thread.h" -#include "ruby/util.h" -#include "vm_core.h" -#include "vm_sync.h" -#include "ruby/ractor.h" - /* define system APIs */ #ifdef _WIN32 #undef open @@ -126,12 +93,6 @@ 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 @@ -186,48 +147,17 @@ 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_GETPWUID_R) -# define USE_GETPWUID_R 1 -# elif defined(HAVE_GETPWUID) -# define USE_GETPWUID 1 -# endif -# if defined(HAVE_GETPWNAM_R) +# if defined(HAVE_GETPWNAM_R) && defined(_SC_GETPW_R_SIZE_MAX) # define USE_GETPWNAM_R 1 -# elif defined(HAVE_GETPWNAM) -# define USE_GETPWNAM 1 -# endif -# if defined(HAVE_GETPWNAM_R) || defined(HAVE_GETPWUID_R) +# define GETPW_R_SIZE_INIT sysconf(_SC_GETPW_R_SIZE_MAX) # 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 \ @@ -318,7 +248,6 @@ typedef unsigned LONG_LONG unsigned_clock_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 @@ -327,26 +256,10 @@ static ID id_pgroup; #ifdef _WIN32 static ID id_new_pgroup; #endif -static ID id_unsetenv_others, id_chdir, id_umask, id_close_others; +static ID id_unsetenv_others, id_chdir, id_umask, id_close_others, id_ENV; 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; @@ -357,11 +270,10 @@ 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; - -static rb_pid_t cached_pid; +extern ID ruby_static_id_status; +#define id_status ruby_static_id_status /* execv and execl are async-signal-safe since SUSv4 (POSIX.1-2008, XPG7) */ #if defined(__sun) && !defined(_XPG7) /* Solaris 10, 9, ... */ @@ -372,30 +284,12 @@ static rb_pid_t cached_pid; #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 */ - assert_close_on_exec(fd); + rb_async_bug_errno("BUG timer thread still running", 0 /* EDOOFUS */); return 0; } return close(fd); /* async-signal-safe */ @@ -404,6 +298,8 @@ close_unless_reserved(int fd) /*#define DEBUG_REDIRECT*/ #if defined(DEBUG_REDIRECT) +#include <stdarg.h> + static void ttyprintf(const char *fmt, ...) { @@ -498,67 +394,43 @@ 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 -> integer - * - * Returns the process ID of the current process: + * Process.pid -> integer * - * Process.pid # => 15668 + * Returns the process id of this process. Not available on all + * platforms. * + * Process.pid #=> 27415 */ static VALUE -proc_get_pid(VALUE _) +get_pid(void) { - return get_pid(); + return PIDT2NUM(getpid()); } -static VALUE -get_ppid(void) -{ - return PIDT2NUM(getppid()); -} /* * call-seq: - * Process.ppid -> integer - * - * Returns the process ID of the parent of the current process: + * Process.ppid -> integer * - * puts "Pid is #{Process.pid}." - * fork { puts "Parent pid is #{Process.ppid}." } + * Returns the process id of the parent of this process. Returns + * untrustworthy value on Win32/64. Not available on all platforms. * - * Output: + * puts "I am #{Process.pid}" + * Process.fork { puts "Dad is #{Process.ppid}" } * - * Pid is 271290. - * Parent pid is 271290. + * <em>produces:</em> * - * May not return a trustworthy value on certain platforms. + * I am 27417 + * Dad is 27417 */ static VALUE -proc_get_ppid(VALUE _) +get_ppid(void) { - return get_ppid(); + return PIDT2NUM(getppid()); } @@ -566,47 +438,34 @@ proc_get_ppid(VALUE _) * * Document-class: Process::Status * - * 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 - * + * <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. */ 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) { @@ -615,25 +474,18 @@ rb_last_status_get(void) /* * 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.last_status -> Process::Status or nil * - * Process.spawn('ruby', '-e', 'exit 13') - * Process.wait - * Process.last_status # => #<Process::Status: pid 14396 exit 13> + * Returns the status of the last executed child process in the + * current thread. * - * Process.spawn('ruby', '-e', 'exit 14') - * Process.wait - * Process.last_status # => #<Process::Status: pid 4692 exit 14> + * Process.wait Process.spawn("ruby", "-e", "exit 13") + * Process.last_status #=> #<Process::Status: pid 4825 exit 13> * - * 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> + * If no child process has ever been executed in the current + * thread, this returns +nil+. * + * Process.last_status #=> nil */ static VALUE proc_s_last_status(VALUE mod) @@ -641,167 +493,102 @@ 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) { - GET_THREAD()->last_status = rb_process_status_new(pid, status, 0); -} - -static void -last_status_clear(rb_thread_t *th) -{ - th->last_status = Qnil; + 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)); } void rb_last_status_clear(void) { - 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; + GET_THREAD()->last_status = Qnil; } /* * call-seq: - * to_i -> integer + * stat.to_i -> integer + * stat.to_int -> integer * - * Returns the system-dependent integer status of +self+: + * Returns the bits in _stat_ as a <code>Integer</code>. Poking + * around in these bits is platform dependent. * - * `cat /nop` - * $?.to_i # => 256 + * fork { exit 0xab } #=> 26566 + * Process.wait #=> 26566 + * sprintf('%04x', $?.to_i) #=> "ab00" */ static VALUE -pst_to_i(VALUE self) +pst_to_i(VALUE st) { - int status = pst_status(self); - return RB_INT2NUM(status); + return rb_ivar_get(st, id_status); } -#define PST2INT(st) pst_status(st) +#define PST2INT(st) NUM2INT(pst_to_i(st)) /* * call-seq: - * pid -> integer + * stat.pid -> integer * - * Returns the process ID of the process: - * - * system("false") - * $?.pid # => 1247002 + * Returns the process ID that this status object represents. * + * fork { exit } #=> 26569 + * Process.wait #=> 26569 + * $?.pid #=> 26569 */ static VALUE -pst_pid_m(VALUE self) +pst_pid(VALUE st) { - rb_pid_t pid = pst_pid(self); - return PIDT2NUM(pid); + return rb_attr_get(st, id_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: - * to_s -> string - * - * Returns a string representation of +self+: + * stat.to_s -> string * - * `cat /nop` - * $?.to_s # => "pid 1262141 exit 1" + * Show pid and exit status as a string. * + * system("false") + * p $?.to_s #=> "pid 12766 exit 1" * */ @@ -812,7 +599,7 @@ pst_to_s(VALUE st) int status; VALUE str; - pid = pst_pid(st); + pid = NUM2PIDT(pst_pid(st)); status = PST2INT(st); str = rb_str_buf_new(0); @@ -823,12 +610,12 @@ pst_to_s(VALUE st) /* * call-seq: - * inspect -> string + * stat.inspect -> string * - * Returns a string representation of +self+: + * Override the inspection method. * * system("false") - * $?.inspect # => "#<Process::Status: pid 1303494 exit 1>" + * p $?.inspect #=> "#<Process::Status: pid 12861 exit 1>" * */ @@ -837,12 +624,13 @@ pst_inspect(VALUE st) { rb_pid_t pid; int status; - VALUE str; + VALUE vpid, str; - pid = pst_pid(st); - if (!pid) { + vpid = pst_pid(st); + if (NIL_P(vpid)) { 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))); @@ -854,15 +642,10 @@ pst_inspect(VALUE st) /* * call-seq: - * 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 + * stat == other -> true or false * + * Returns +true+ if the integer value of _stat_ + * equals <em>other</em>. */ static VALUE @@ -875,53 +658,20 @@ pst_equal(VALUE st1, VALUE st2) /* * call-seq: - * stat & mask -> integer - * - * This method is deprecated as #to_i value is system-specific; use - * predicate methods like #exited? or #stopped?, or getters like #exitstatus - * or #stopsig. + * stat & num -> integer * - * Returns the logical AND of the value of #to_i with +mask+: + * Logical AND of the bits in _stat_ with <em>num</em>. * - * `cat /nop` - * stat = $? # => #<Process::Status: pid 1155508 exit 1> - * sprintf('%x', stat.to_i) # => "100" - * stat & 0x00 # => 0 - * - * ArgumentError is raised if +mask+ is negative. + * 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); - int mask = NUM2INT(st2); - - if (mask < 0) { - rb_raise(rb_eArgError, "negative mask value: %d", mask); - } -#define WARN_SUGGEST(suggest) \ - rb_warn_deprecated_to_remove_at(3.5, "Process::Status#&", suggest) - - switch (mask) { - case 0x80: - WARN_SUGGEST("Process::Status#coredump?"); - break; - case 0x7f: - WARN_SUGGEST("Process::Status#signaled? or Process::Status#termsig"); - break; - case 0xff: - WARN_SUGGEST("Process::Status#exited?, Process::Status#stopped? or Process::Status#coredump?"); - break; - case 0xff00: - WARN_SUGGEST("Process::Status#exitstatus or Process::Status#stopsig"); - break; - default: - WARN_SUGGEST("other Process::Status predicates"); - break; - } -#undef WARN_SUGGEST - status &= mask; + int status = PST2INT(st1) & NUM2INT(st2); return INT2NUM(status); } @@ -929,48 +679,20 @@ pst_bitand(VALUE st1, VALUE st2) /* * call-seq: - * stat >> places -> integer - * - * This method is deprecated as #to_i value is system-specific; use - * predicate methods like #exited? or #stopped?, or getters like #exitstatus - * or #stopsig. + * stat >> num -> integer * - * Returns the value of #to_i, shifted +places+ to the right: + * Shift the bits in _stat_ right <em>num</em> places. * - * `cat /nop` - * stat = $? # => #<Process::Status: pid 1155508 exit 1> - * stat.to_i # => 256 - * stat >> 1 # => 128 - * stat >> 2 # => 64 - * - * ArgumentError is raised if +places+ is negative. + * fork { exit 99 } #=> 26563 + * Process.wait #=> 26563 + * $?.to_i #=> 25344 + * $? >> 8 #=> 99 */ static VALUE pst_rshift(VALUE st1, VALUE st2) { - int status = PST2INT(st1); - int places = NUM2INT(st2); - - if (places < 0) { - rb_raise(rb_eArgError, "negative shift value: %d", places); - } -#define WARN_SUGGEST(suggest) \ - rb_warn_deprecated_to_remove_at(3.5, "Process::Status#>>", suggest) - - switch (places) { - case 7: - WARN_SUGGEST("Process::Status#coredump?"); - break; - case 8: - WARN_SUGGEST("Process::Status#exitstatus or Process::Status#stopsig"); - break; - default: - WARN_SUGGEST("other Process::Status attributes"); - break; - } -#undef WARN_SUGGEST - status >>= places; + int status = PST2INT(st1) >> NUM2INT(st2); return INT2NUM(status); } @@ -978,11 +700,11 @@ pst_rshift(VALUE st1, VALUE st2) /* * call-seq: - * stopped? -> true or false + * stat.stopped? -> true or false * - * Returns +true+ if this process is stopped, - * and if the corresponding #wait call had the Process::WUNTRACED flag set, - * +false+ otherwise. + * 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. */ static VALUE @@ -990,16 +712,19 @@ pst_wifstopped(VALUE st) { int status = PST2INT(st); - return RBOOL(WIFSTOPPED(status)); + if (WIFSTOPPED(status)) + return Qtrue; + else + return Qfalse; } /* * call-seq: - * stopsig -> integer or nil + * stat.stopsig -> integer or nil * - * Returns the number of the signal that caused the process to stop, - * or +nil+ if the process is not stopped. + * Returns the number of the signal that caused _stat_ to stop + * (or +nil+ if self is not stopped). */ static VALUE @@ -1008,17 +733,17 @@ pst_wstopsig(VALUE st) int status = PST2INT(st); if (WIFSTOPPED(status)) - return INT2NUM(WSTOPSIG(status)); + return INT2NUM(WSTOPSIG(status)); return Qnil; } /* * call-seq: - * signaled? -> true or false + * stat.signaled? -> true or false * - * Returns +true+ if the process terminated because of an uncaught signal, - * +false+ otherwise. + * Returns +true+ if _stat_ terminated because of + * an uncaught signal. */ static VALUE @@ -1026,16 +751,20 @@ pst_wifsignaled(VALUE st) { int status = PST2INT(st); - return RBOOL(WIFSIGNALED(status)); + if (WIFSIGNALED(status)) + return Qtrue; + else + return Qfalse; } /* * call-seq: - * termsig -> integer or nil + * stat.termsig -> integer or nil * - * Returns the number of the signal that caused the process to terminate - * or +nil+ if the process was not terminated by an uncaught signal. + * Returns the number of the signal that caused _stat_ to + * terminate (or +nil+ if self was not terminated by an + * uncaught signal). */ static VALUE @@ -1044,18 +773,18 @@ pst_wtermsig(VALUE st) int status = PST2INT(st); if (WIFSIGNALED(status)) - return INT2NUM(WTERMSIG(status)); + return INT2NUM(WTERMSIG(status)); return Qnil; } /* * call-seq: - * exited? -> true or false + * stat.exited? -> true or false * - * Returns +true+ if the process exited normally - * (for example using an <code>exit()</code> call or finishing the - * program), +false+ if not. + * Returns +true+ if _stat_ exited normally (for + * example using an <code>exit()</code> call or finishing the + * program). */ static VALUE @@ -1063,21 +792,30 @@ pst_wifexited(VALUE st) { int status = PST2INT(st); - return RBOOL(WIFEXITED(status)); + if (WIFEXITED(status)) + return Qtrue; + else + return Qfalse; } /* * call-seq: - * exitstatus -> integer or nil + * stat.exitstatus -> integer or nil * - * Returns the least significant eight bits of the return code - * of the process if it has exited; - * +nil+ otherwise: + * Returns the least significant eight bits of the return code of + * _stat_. Only available if <code>exited?</code> is + * +true+. * - * `exit 99` - * $?.exitstatus # => 99 + * fork { } #=> 26572 + * Process.wait #=> 26572 + * $?.exited? #=> true + * $?.exitstatus #=> 0 * + * fork { exit 99 } #=> 26573 + * Process.wait #=> 26573 + * $?.exited? #=> true + * $?.exitstatus #=> 99 */ static VALUE @@ -1086,21 +824,17 @@ pst_wexitstatus(VALUE st) int status = PST2INT(st); if (WIFEXITED(status)) - return INT2NUM(WEXITSTATUS(status)); + return INT2NUM(WEXITSTATUS(status)); return Qnil; } /* * call-seq: - * 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. + * stat.success? -> true, false or nil * + * Returns +true+ if _stat_ is successful, +false+ if not. + * Returns +nil+ if <code>exited?</code> is not +true+. */ static VALUE @@ -1109,19 +843,17 @@ pst_success_p(VALUE st) int status = PST2INT(st); if (!WIFEXITED(status)) - return Qnil; - return RBOOL(WEXITSTATUS(status) == EXIT_SUCCESS); + return Qnil; + return WEXITSTATUS(status) == EXIT_SUCCESS ? Qtrue : Qfalse; } /* * call-seq: - * coredump? -> true or false - * - * Returns +true+ if the process generated a coredump - * when it terminated, +false+ if not. + * stat.coredump? -> true or false * - * Not available on all platforms. + * Returns +true+ if _stat_ generated a coredump + * when it terminated. Not available on all platforms. */ static VALUE @@ -1130,12 +862,21 @@ pst_wcoredump(VALUE st) #ifdef WCOREDUMP int status = PST2INT(st); - return RBOOL(WCOREDUMP(status)); + if (WCOREDUMP(status)) + return Qtrue; + else + return Qfalse; #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) { @@ -1148,175 +889,48 @@ 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 * -waitpid_blocking_no_SIGCHLD(void *x) -{ - struct waitpid_state *w = x; - - w->ret = do_waitpid(w->pid, &w->status, w->options); - - return 0; -} - -static void -waitpid_no_SIGCHLD(struct waitpid_state *w) +rb_waitpid_blocking(void *data) { - 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; + struct waitpid_arg *arg = data; + rb_pid_t result = do_waitpid(arg->pid, arg->st, arg->flags); + return (void *)(VALUE)result; } -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 _) +static rb_pid_t +do_waitpid_nonblocking(rb_pid_t pid, int *st, int flags) { - 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); + 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_pid_t rb_waitpid(rb_pid_t pid, int *st, int flags) { - 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 (pid == -1) { - errno = data->error; - } - else { - GET_THREAD()->last_status = status; - } - - return pid; -} - -static VALUE -proc_wait(int argc, VALUE *argv) -{ - rb_pid_t pid; - int flags, status; + rb_pid_t result; - flags = 0; - if (rb_check_arity(argc, 0, 2) == 0) { - pid = -1; + if (flags & WNOHANG) { + result = do_waitpid(pid, st, flags); } else { - VALUE vflags; - pid = NUM2PIDT(argv[0]); - if (argc == 2 && !NIL_P(vflags = argv[1])) { - flags = NUM2UINT(vflags); - } + while ((result = do_waitpid_nonblocking(pid, st, flags)) < 0 && + (errno == EINTR)) { + RUBY_VM_CHECK_INTS(GET_EC()); + } } - - if ((pid = rb_waitpid(pid, &status, flags)) < 0) - rb_sys_fail(0); - - if (pid == 0) { - rb_last_status_clear(); - return Qnil; + if (result > 0) { + rb_last_status_set(*st, result); } - - return PIDT2NUM(pid); + return result; } + /* [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 despite the fact that it's just an alias for ::waitpid(). The way I @@ -1333,159 +947,93 @@ proc_wait(int argc, VALUE *argv) /* * call-seq: - * 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. + * Process.wait() -> integer + * Process.wait(pid=-1, flags=0) -> integer + * Process.waitpid(pid=-1, flags=0) -> integer + * + * 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 */ + static VALUE -proc_m_wait(int c, VALUE *v, VALUE _) +proc_wait(int argc, VALUE *argv) { - return proc_wait(c, v); + 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); } + /* * call-seq: - * 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. + * 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 */ static VALUE -proc_wait2(int argc, VALUE *argv, VALUE _) +proc_wait2(int argc, VALUE *argv) { VALUE pid = proc_wait(argc, argv); if (NIL_P(pid)) return Qnil; @@ -1495,21 +1043,26 @@ proc_wait2(int argc, VALUE *argv, VALUE _) /* * call-seq: - * Process.waitall -> array + * Process.waitall -> [ [pid1,status1], ...] * - * 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: + * Waits for all children, returning an array of + * _pid_/_status_ pairs (where _status_ is a + * <code>Process::Status</code> object). * - * 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>]] + * fork { sleep 0.2; exit 2 } #=> 27432 + * fork { sleep 0.1; exit 1 } #=> 27433 + * fork { exit 0 } #=> 27434 + * p Process.waitall * + * <em>produces</em>: + * + * [[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(VALUE _) +proc_waitall(void) { VALUE result; rb_pid_t pid; @@ -1519,14 +1072,14 @@ proc_waitall(VALUE _) rb_last_status_clear(); for (pid = -1;;) { - 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())); + 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; } @@ -1546,7 +1099,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(); } @@ -1563,41 +1116,49 @@ 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: - * - * thread.join.pid # => 313262 + * 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}") * + * <em>(produces no output)</em> */ static VALUE @@ -1627,91 +1188,50 @@ 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 -stdfd_clear_nonblock(void) +before_exec(void) { - /* 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 */ - } + before_exec_non_async_signal_safe(); + before_exec_async_signal_safe(); } +/* This function should be async-signal-safe. Actually it is. */ static void -before_exec(void) +after_exec_async_signal_safe(void) { - before_exec_non_async_signal_safe(); - before_exec_async_signal_safe(); } static void -after_exec(void) +after_exec_non_async_signal_safe(void) { rb_thread_reset_timer_thread(); rb_thread_start_timer_thread(); } -#if defined HAVE_WORKING_FORK || defined HAVE_DAEMON static void -before_fork_ruby(void) +after_exec(void) { - rb_gc_before_fork(); - before_exec(); + after_exec_async_signal_safe(); + after_exec_non_async_signal_safe(); } +#define before_fork_ruby() before_exec() +#define after_fork_ruby() (rb_threadptr_pending_interrupt_clear(GET_THREAD()), after_exec()) + +#include "dln.h" + static void -after_fork_ruby(rb_pid_t pid) +security(const char *str) { - rb_gc_after_fork(pid); - - if (pid == 0) { - // child - clear_pid_cache(); - rb_thread_atfork(); - } - else { - // parent - after_exec(); + if (rb_env_path_tainted()) { + if (rb_safe_level() > 0) { + rb_raise(rb_eSecurityError, "Insecure PATH - %s", str); + } } } -#endif #if defined(HAVE_WORKING_FORK) -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(err, prog, argv, envp) ((err == ENOEXEC) ? exec_with_sh((prog), (argv), (envp)) : (void)0) static void @@ -1726,7 +1246,7 @@ exec_with_sh(const char *prog, char **argv, char **envp) } #else -#define try_with_sh(err, prog, argv, envp) (void)0 +#define try_with_sh(prog, argv, envp) (void)0 #endif /* This function should be async-signal-safe. Actually it is. */ @@ -1742,14 +1262,14 @@ proc_exec_cmd(const char *prog, VALUE argv_str, VALUE envp_str) argv = ARGVSTR2ARGV(argv_str); if (!prog) { - return ENOENT; + return ENOENT; } #ifdef _WIN32 rb_w32_uaspawn(P_OVERLAY, prog, argv); return errno; #else - envp = envp_str ? RB_IMEMO_TMPBUF_PTR(envp_str) : NULL; + envp = envp_str ? (char **)RSTRING_PTR(envp_str) : NULL; if (envp_str) execve(prog, argv, envp); /* async-signal-safe */ else @@ -1768,7 +1288,7 @@ proc_exec_sh(const char *str, VALUE envp_str) s = str; while (*s == ' ' || *s == '\t' || *s == '\n') - s++; + s++; if (!*s) { return ENOENT; @@ -1790,7 +1310,7 @@ proc_exec_sh(const char *str, VALUE envp_str) } #else if (envp_str) - execle("/bin/sh", "sh", "-c", str, (char *)NULL, RB_IMEMO_TMPBUF_PTR(envp_str)); /* async-signal-safe */ + execle("/bin/sh", "sh", "-c", str, (char *)NULL, (char **)RSTRING_PTR(envp_str)); /* async-signal-safe */ else execl("/bin/sh", "sh", "-c", str, (char *)NULL); /* async-signal-safe (since SUSv4) */ #endif /* _WIN32 */ @@ -1843,7 +1363,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 | RUBY_TYPED_EMBEDDABLE + 0, 0, RUBY_TYPED_FREE_IMMEDIATELY }; #ifdef _WIN32 @@ -1884,19 +1404,20 @@ proc_spawn_cmd_internal(char **argv, char *prog) rb_pid_t status; if (!prog) - prog = argv[0]; + prog = argv[0]; + security(prog); 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; } @@ -1909,13 +1430,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; @@ -1965,7 +1486,7 @@ check_exec_redirect_fd(VALUE v, int iskey) else goto wrong; } - else if (!NIL_P(tmp = rb_io_check_io(v))) { + else if (!NIL_P(tmp = rb_check_convert_type_with_id(v, T_FILE, "IO", idTo_io))) { rb_io_t *fptr; GetOpenFile(tmp, fptr); if (fptr->tied_io_for_writing) @@ -1973,7 +1494,8 @@ check_exec_redirect_fd(VALUE v, int iskey) fd = fptr->fd; } else { - goto wrong; + wrong: + rb_raise(rb_eArgError, "wrong exec redirect"); } if (fd < 0) { rb_raise(rb_eArgError, "negative file descriptor"); @@ -1984,10 +1506,6 @@ 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 @@ -2001,11 +1519,12 @@ check_exec_redirect1(VALUE ary, VALUE key, VALUE param) rb_ary_push(ary, hide_obj(rb_assoc_new(fd, param))); } else { - int i; + int i, n=0; 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; @@ -2021,7 +1540,7 @@ check_exec_redirect(VALUE key, VALUE val, struct rb_execarg *eargp) switch (TYPE(val)) { case T_SYMBOL: - id = rb_check_id(&val); + if (!(id = rb_check_id(&val))) goto wrong_symbol; if (id == id_close) { param = Qnil; eargp->fd_close = check_exec_redirect1(eargp->fd_close, key, param); @@ -2039,6 +1558,7 @@ 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); } @@ -2085,18 +1605,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_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 + 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 flags = INT2NUM(O_RDONLY); perm = INT2FIX(0644); param = hide_obj(rb_ary_new3(4, hide_obj(EXPORT_DUP(path)), @@ -2105,9 +1625,9 @@ 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"); } @@ -2122,30 +1642,29 @@ 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()); + ary = eargp->rlimit_limits = hide_obj(rb_ary_new()); else - ary = eargp->rlimit_limits; + 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"); - } + 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); + 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) { @@ -2193,7 +1712,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 = TO_BOOL(val, "new_pgroup"); + eargp->new_pgroup_flag = RTEST(val) ? 1 : 0; } else #endif @@ -2202,19 +1721,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 = TO_BOOL(val, "unsetenv_others"); + eargp->unsetenv_others_do = RTEST(val) ? 1 : 0; } 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); + 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"); } @@ -2226,7 +1745,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 = TO_BOOL(val, "close_others"); + eargp->close_others_do = RTEST(val) ? 1 : 0; } else if (id == id_in) { key = INT2FIX(0); @@ -2240,45 +1759,38 @@ 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; @@ -2290,7 +1802,7 @@ redirect: break; default: - return ST_STOP; + return ST_STOP; } RB_GC_GUARD(execarg_obj); @@ -2304,10 +1816,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; } @@ -2320,9 +1832,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; } @@ -2409,7 +1921,7 @@ rb_check_exec_options(VALUE opthash, VALUE execarg_obj) { if (RHASH_EMPTY_P(opthash)) return; - rb_hash_stlike_foreach(opthash, check_exec_options_i, (st_data_t)execarg_obj); + st_foreach(rb_hash_tbl_raw(opthash), check_exec_options_i, (st_data_t)execarg_obj); } VALUE @@ -2420,7 +1932,7 @@ rb_execarg_extract_options(VALUE execarg_obj, VALUE opthash) return Qnil; args[0] = execarg_obj; args[1] = Qnil; - rb_hash_stlike_foreach(opthash, check_exec_options_i_extract, (st_data_t)args); + st_foreach(rb_hash_tbl_raw(opthash), check_exec_options_i_extract, (st_data_t)args); return args[1]; } @@ -2441,7 +1953,7 @@ check_exec_env_i(st_data_t st_key, st_data_t st_val, st_data_t arg) k = StringValueCStr(key); if (strchr(k, '=')) - rb_raise(rb_eArgError, "environment name contains a equal : %"PRIsVALUE, key); + rb_raise(rb_eArgError, "environment name contains a equal : %s", k); if (!NIL_P(val)) StringValueCStr(val); @@ -2450,7 +1962,7 @@ check_exec_env_i(st_data_t st_key, st_data_t st_val, st_data_t arg) if (!NIL_P(val)) val = EXPORT_STR(val); if (ENVMATCH(k, PATH_ENV)) { - *path = val; + *path = val; } rb_ary_push(env, hide_obj(rb_assoc_new(key, val))); @@ -2464,7 +1976,7 @@ rb_check_exec_env(VALUE hash, VALUE *path) env[0] = hide_obj(rb_ary_new()); env[1] = Qfalse; - rb_hash_stlike_foreach(hash, check_exec_env_i, (st_data_t)env); + st_foreach(rb_hash_tbl_raw(hash), check_exec_env_i, (st_data_t)env); *path = env[1]; return env[0]; @@ -2475,26 +1987,29 @@ 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); - StringValue(prog); - StringValueCStr(prog); - prog = rb_str_new_frozen(prog); + 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); } for (i = 0; i < argc; i++) { - StringValue(argv[i]); - argv[i] = rb_str_new_frozen(argv[i]); - StringValueCStr(argv[i]); + SafeStringValue(argv[i]); + argv[i] = rb_str_new_frozen(argv[i]); + StringValueCStr(argv[i]); } + security(name ? name : RSTRING_PTR(argv[0])); return prog; } @@ -2505,9 +2020,7 @@ check_hash(VALUE obj) switch (RB_BUILTIN_TYPE(obj)) { case T_STRING: case T_ARRAY: - return Qnil; - default: - break; + return Qnil; } return rb_check_hash_type(obj); } @@ -2585,39 +2098,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: @@ -2644,32 +2157,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; } @@ -2681,7 +2194,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); @@ -2689,23 +2202,21 @@ 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_subseq(argv_buf, 0, strlen(RSTRING_PTR(argv_buf)))); - rb_enc_copy(eargp->invoke.cmd.command_name, prog); + eargp->invoke.cmd.command_name = hide_obj(rb_str_new_cstr(RSTRING_PTR(argv_buf))); } } #endif if (!eargp->use_shell) { - 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; + 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) { @@ -2714,13 +2225,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; } @@ -2737,12 +2248,21 @@ 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 = - rb_imemo_tmpbuf_auto_free_pointer_new_from_an_RString(argv_str); + eargp->invoke.cmd.argv_str = 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(0, struct rb_execarg, &exec_arg_data_type, eargp); + rb_execarg_init(argc, argv, accept_shell, execarg_obj); + return execarg_obj; +} + struct rb_execarg * rb_execarg_get(VALUE execarg_obj) { @@ -2751,7 +2271,7 @@ rb_execarg_get(VALUE execarg_obj) return eargp; } -static VALUE +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); @@ -2768,26 +2288,12 @@ 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, &eargp->path_env) : Qfalse; eargp->env_modification = env; - RB_GC_GUARD(execarg_obj); } static int @@ -2826,14 +2332,6 @@ open_func(void *ptr) return NULL; } -static void -rb_execarg_allocate_dup2_tmpbuf(struct rb_execarg *eargp, long len) -{ - VALUE tmpbuf = rb_imemo_tmpbuf_auto_free_pointer(); - 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) { @@ -2851,11 +2349,13 @@ 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)); - mode_t perm = NUM2MODET(RARRAY_AREF(param, 2)); + int perm = NUM2INT(RARRAY_AREF(param, 2)); VALUE fd2v = RARRAY_AREF(param, 3); int fd2; if (NIL_P(fd2v)) { struct open_struct open_data; + FilePathValue(vpath); + vpath = rb_str_encode_ospath(vpath); again: open_data.fname = vpath; open_data.oflags = flags; @@ -2886,7 +2386,10 @@ rb_execarg_parent_start1(VALUE execarg_obj) ary = eargp->fd_dup2; if (ary != Qfalse) { - rb_execarg_allocate_dup2_tmpbuf(eargp, RARRAY_LEN(ary)); + 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; } unsetenv_others = eargp->unsetenv_others_given && eargp->unsetenv_others_do; @@ -2898,30 +2401,31 @@ rb_execarg_parent_start1(VALUE execarg_obj) envtbl = rb_hash_new(); } else { - envtbl = rb_env_to_hash(); + envtbl = rb_const_get(rb_cObject, id_ENV); + envtbl = rb_to_hash_type(envtbl); } 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); - rb_hash_stlike_foreach(envtbl, fill_envp_buf_i, (st_data_t)envp_buf); + st_foreach(RHASH_TBL_RAW(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); @@ -2932,8 +2436,7 @@ rb_execarg_parent_start1(VALUE execarg_obj) } p = NULL; rb_str_buf_cat(envp_str, (char *)&p, sizeof(p)); - eargp->envp_str = - rb_imemo_tmpbuf_auto_free_pointer_new_from_an_RString(envp_str); + eargp->envp_str = envp_str; eargp->envp_buf = envp_buf; /* @@ -2985,7 +2488,6 @@ execarg_parent_end(VALUE execarg_obj) } errno = err; - RB_GC_GUARD(execarg_obj); return execarg_obj; } @@ -3001,7 +2503,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); } @@ -3016,142 +2518,106 @@ 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_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: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). - * - * 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: - * - * - +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. - * - * <b>Argument +command_line+</b> + * exec([env,] command... [,options]) * - * \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: + * Replaces the current process by running the given external _command_, which + * can take one of the following forms: * - * exec('if true; then echo "Foo"; fi') # Shell reserved word. - * exec('exit') # Built-in. - * exec('date > date.tmp') # Contains meta character. + * [<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) * - * The command line may also contain arguments and options for the command: + * In the first form, the string is taken as a command line that is subject to + * shell expansion before being executed. * - * exec('echo "Foo"') + * 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. * - * Output: + * If the string from the first form (<code>exec("command")</code>) follows + * these simple rules: * - * Foo + * * no meta characters + * * no shell reserved word and no special built-in + * * Ruby invokes the command directly without shell * - * See {Execution Shell}[rdoc-ref:Process@Execution+Shell] for details about the shell. + * You can force shell invocation by adding ";" to the string (because ";" is + * a meta character). * - * Raises an exception if the new process could not execute. + * 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. * - * <b>Argument +exe_path+</b> + * 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. * - * Argument +exe_path+ is one of the following: + * 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. * - * - 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. + * 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). * - * Example: + * This behavior is modified by the given +env+ and +options+ parameters. See + * ::spawn for details. * - * exec('/usr/bin/date') + * If the command fails to execute (typically <code>Errno::ENOENT</code> when + * it was not found) a SystemCallError exception is raised. * - * Output: + * 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+. * - * Sat Aug 26 09:38:00 AM CDT 2023 + * The modified attributes may be retained when <code>exec(2)</code> system + * call fails. * - * Ruby invokes the executable directly. - * This form does not use the shell; - * see {Arguments args}[rdoc-ref:Process@Arguments+args] for caveats. + * For example, hard resource limits are not restorable. * - * exec('doesnt_exist') # Raises Errno::ENOENT + * Consider to create a child process using ::spawn or Kernel#system if this + * is not acceptable. * - * If one or more +args+ is given, each is an argument or option - * to be passed to the executable: + * exec "echo *" # echoes list of files in current directory + * # never get here * - * exec('echo', 'C*') - * exec('echo', 'hello', 'world') - * - * Output: - * - * C* - * hello world - * - * Raises an exception if the new process could not execute. + * exec "echo", "*" # echoes an asterisk + * # never get here */ -static VALUE -f_exec(int c, const VALUE *a, VALUE _) +VALUE +rb_f_exec(int argc, const VALUE *argv) { - rb_f_exec(c, a); - UNREACHABLE_RETURN(Qnil); -} + 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; -#define ERRMSG(str) \ - ((errmsg && 0 < errmsg_buflen) ? \ - (void)strlcpy(errmsg, (str), errmsg_buflen) : (void)0) + 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; +} -#define ERRMSG_FMT(...) \ - ((errmsg && 0 < errmsg_buflen) ? \ - (void)snprintf(errmsg, errmsg_buflen, __VA_ARGS__) : (void)0) +#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) 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); @@ -3175,10 +2641,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) { @@ -3286,10 +2752,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 rb_imemo_tmpbuf_struct *buf = (void *)tmpbuf; - struct run_exec_dup2_fd_pair *pairs = (void *)buf->ptr; + struct run_exec_dup2_fd_pair *pairs = 0; 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++) { @@ -3335,10 +2801,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; @@ -3364,14 +2830,6 @@ 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 { @@ -3537,7 +2995,7 @@ save_env(struct rb_execarg *sargp) if (!sargp) return; if (sargp->env_modification == Qfalse) { - VALUE env = rb_envtbl(); + VALUE env = rb_const_get(rb_cObject, id_ENV); if (RTEST(env)) { VALUE ary = hide_obj(rb_ary_new()); rb_block_call(env, idEach, 0, 0, save_env_i, @@ -3630,7 +3088,7 @@ rb_execarg_run_options(const struct rb_execarg *eargp, struct rb_execarg *sargp, } #ifdef HAVE_WORKING_FORK - if (eargp->close_others_do) { + if (!eargp->close_others_given || eargp->close_others_do) { rb_close_before_exec(3, eargp->close_others_maxhint, eargp->redirect_fds); /* async-signal-safe */ } #endif @@ -3643,8 +3101,10 @@ rb_execarg_run_options(const struct rb_execarg *eargp, struct rb_execarg *sargp, if (eargp->chdir_given) { if (sargp) { + char *cwd = ruby_getcwd(); sargp->chdir_given = 1; - sargp->chdir_dir = hide_obj(rb_dir_getwd_ospath()); + sargp->chdir_dir = hide_obj(rb_str_new2(cwd)); + xfree(cwd); } if (chdir(RSTRING_PTR(eargp->chdir_dir)) == -1) { /* async-signal-safe */ ERRMSG("chdir"); @@ -3654,32 +3114,30 @@ 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) { - rb_execarg_allocate_dup2_tmpbuf(sargp, RARRAY_LEN(ary)); + 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; } } - { - int preserve = errno; - stdfd_clear_nonblock(); - errno = preserve; - } return 0; } @@ -3703,17 +3161,17 @@ exec_async_signal_safe(const struct rb_execarg *eargp, char *errmsg, size_t errm int err; if (rb_execarg_run_options(eargp, sargp, errmsg, errmsg_buflen) < 0) { /* hopefully async-signal-safe */ - return errno; + return errno; } if (eargp->use_shell) { - err = 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); - err = 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) rb_execarg_run_options(sargp, NULL, errmsg, errmsg_buflen); @@ -3729,13 +3187,19 @@ 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((rb_pid_t)pid); + rb_syswait((int)pid); return Qnil; } +#endif static int move_fds_to_avoid_crash(int *fdp, int n, VALUE fds) @@ -3783,15 +3247,8 @@ 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 err, struct rb_process_status *status, int *ep, volatile int *try_gc_p) +handle_fork_error(int err, int *status, int *ep, volatile int *try_gc_p) { int state = 0; @@ -3811,25 +3268,25 @@ handle_fork_error(int err, struct rb_process_status *status, int *ep, volatile i return 0; } else { - rb_protect(rb_thread_sleep_that_takes_VALUE_as_sole_argument, INT2FIX(1), &state); - if (status) status->status = state; + rb_protect((VALUE (*)())rb_thread_sleep, 1, &state); + if (status) *status = state; if (!state) return 0; } break; } if (ep) { - close(ep[0]); - close(ep[1]); - errno = err; + 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 @@ -3863,7 +3320,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; @@ -3874,14 +3331,8 @@ 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; @@ -3934,7 +3385,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; } @@ -3952,7 +3403,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; } @@ -3979,7 +3430,7 @@ has_privilege(void) #if defined HAVE_ISSETUGID if (issetugid()) - return 1; + return 1; #endif #ifdef HAVE_GETRESUID @@ -4025,37 +3476,52 @@ 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) { - rb_syserr_fail(ret, "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) { + rb_syserr_fail(ret, "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) { + rb_syserr_fail(ret, "pthread_setcancelstate"); + } +#endif + +#ifdef HAVE_PTHREAD_SIGMASK ret = pthread_sigmask(SIG_SETMASK, &old->sigmask, NULL); /* not async-signal-safe */ if (ret != 0) { - rb_syserr_fail(ret, "pthread_sigmask"); + rb_syserr_fail(ret, "pthread_sigmask"); } #else # pragma GCC warning "pthread_sigmask on fork is not available. potentially dangerous" @@ -4070,28 +3536,26 @@ disable_child_handler_fork_child(struct child_handler_disabler_state *old, char int ret; for (sig = 1; sig < NSIG; sig++) { - 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; - } + 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) { - continue; - } + if (sig == SIGPIPE) { + continue; + } #endif - /* it will be reset to SIG_DFL at execve time, instead */ - if (handler == SIG_IGN) { - signal(sig, SIG_IGN); - } + /* 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"); @@ -4101,10 +3565,9 @@ disable_child_handler_fork_child(struct child_handler_disabler_state *old, char } static rb_pid_t -retry_fork_async_signal_safe(struct rb_process_status *status, int *ep, +retry_fork_async_signal_safe(int *status, int *ep, int (*chfunc)(void*, char *, size_t), void *charg, - char *errmsg, size_t errmsg_buflen, - struct waitpid_state *w) + char *errmsg, size_t errmsg_buflen) { rb_pid_t pid; volatile int try_gc = 1; @@ -4118,9 +3581,9 @@ retry_fork_async_signal_safe(struct rb_process_status *status, int *ep, if (!has_privilege()) pid = vfork(); else - pid = rb_fork(); + pid = fork(); #else - pid = rb_fork(); + pid = fork(); #endif if (pid == 0) {/* fork succeed, child process */ int ret; @@ -4137,241 +3600,98 @@ retry_fork_async_signal_safe(struct rb_process_status *status, int *ep, _exit(127); #endif } - err = 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(err, status, ep, &try_gc)) + if (handle_fork_error(err, status, ep, &try_gc)) return -1; } } -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 +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 err; int ep[2]; int error_occurred; - struct waitpid_state *w = eargp && eargp->waitpid_state ? eargp->waitpid_state : 0; - - if (status) status->status = 0; + if (status) *status = 0; if (pipe_nocrash(ep, fds)) return -1; - - 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; - + pid = retry_fork_async_signal_safe(status, ep, chfunc, charg, errmsg, errmsg_buflen); + if (pid < 0) return pid; - } - close(ep[1]); - error_occurred = recv_child_error(ep[0], &err, errmsg, errmsg_buflen); - if (error_occurred) { if (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; + rb_protect(proc_syswait, (VALUE)pid, status); } - else if (!w) { + else { rb_syswait(pid); } - errno = err; return -1; } - return pid; } -/* - * 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 since RJIT, either. - * 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) -{ - struct rb_process_status process_status; - - 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) { - struct rb_process_status child = {.status = 0}; rb_pid_t pid; int try_gc = 1, err; struct child_handler_disabler_state old; - do { - prefork(); - - before_fork_ruby(); - rb_thread_acquire_fork_lock(); - disable_child_handler_before_fork(&old); - - 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; -} + if (status) *status = 0; -static rb_pid_t -proc_fork_pid(void) -{ - rb_pid_t pid = rb_fork_ruby(NULL); - - if (pid == -1) { - rb_sys_fail("fork(2)"); + while (1) { + prefork(); + disable_child_handler_before_fork(&old); + before_fork_ruby(); + pid = fork(); + err = errno; + after_fork_ruby(); + disable_child_handler_fork_parent(&old); /* yes, bad name */ + if (pid >= 0) /* fork succeed */ + return pid; + /* fork failed */ + if (handle_fork_error(err, status, NULL, &try_gc)) + return -1; } - - 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: - * 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+. + * Kernel.fork [{ block }] -> integer or nil + * Process.fork [{ block }] -> integer 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(). */ static VALUE @@ -4379,21 +3699,25 @@ rb_f_fork(VALUE obj) { rb_pid_t pid; - pid = rb_call_proc__fork(); + 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; - if (pid == 0) { - if (rb_block_given_p()) { - int status; - rb_protect(rb_yield, Qundef, &status); - ruby_stop(status); - } - return Qnil; + default: + return PIDT2NUM(pid); } - - return PIDT2NUM(pid); } #else -#define rb_proc__fork rb_f_notimplement #define rb_f_fork rb_f_notimplement #endif @@ -4404,37 +3728,31 @@ 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: - * exit!(status = false) - * Process.exit!(status = false) + * Process.exit!(status=false) * - * Exits the process immediately; no exit handlers are called. - * Returns exit status +status+ to the underlying operating system. + * Exits the process immediately. No exit handlers are + * run. <em>status</em> is returned to the underlying system as the + * exit status. * * 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 @@ -4443,144 +3761,122 @@ rb_f_exit_bang(int argc, VALUE *argv, VALUE obj) int istatus; if (rb_check_arity(argc, 0, 1) == 1) { - istatus = exit_status_code(argv[0]); + istatus = exit_status_code(argv[0]); } else { - istatus = EXIT_FAILURE; + istatus = EXIT_FAILURE; } _exit(istatus); - UNREACHABLE_RETURN(Qnil); + UNREACHABLE; } void rb_exit(int status) { if (GET_EC()->tag) { - VALUE args[2]; + 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) { int istatus; if (rb_check_arity(argc, 0, 1) == 1) { - istatus = exit_status_code(argv[0]); + istatus = exit_status_code(argv[0]); } else { - istatus = EXIT_SUCCESS; + istatus = EXIT_SUCCESS; } rb_exit(istatus); - UNREACHABLE_RETURN(Qnil); + UNREACHABLE; } -NORETURN(static VALUE f_exit(int c, const VALUE *a, VALUE _)); + /* * call-seq: - * 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. + * abort + * Kernel::abort([msg]) + * Process.abort([msg]) * + * 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) { - 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); + rb_execution_context_t *ec = GET_EC(); + VALUE errinfo = ec->errinfo; + 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_ractor_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_stderr); + args[0] = INT2NUM(EXIT_FAILURE); + rb_exc_raise(rb_class_new_instance(2, args, rb_eSystemExit)); } - 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); + UNREACHABLE; } void @@ -4591,24 +3887,24 @@ rb_syswait(rb_pid_t pid) rb_waitpid(pid, &status, 0); } -#if !defined HAVE_WORKING_FORK && !defined HAVE_SPAWNV && !defined __EMSCRIPTEN__ +#if !defined HAVE_WORKING_FORK && !defined HAVE_SPAWNV 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; + 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); } @@ -4627,7 +3923,7 @@ rb_spawn_process(struct rb_execarg *eargp, char *errmsg, size_t errmsg_buflen) #endif #if defined HAVE_WORKING_FORK && !USE_SPAWNV - pid = fork_check_err(eargp->status, rb_exec_atfork, eargp, eargp->redirect_fds, errmsg, errmsg_buflen, eargp); + pid = rb_fork_async_signal_safe(NULL, rb_exec_atfork, eargp, eargp->redirect_fds, errmsg, errmsg_buflen); #else prog = eargp->use_shell ? eargp->invoke.sh.shell_script : eargp->invoke.cmd.command_name; @@ -4641,37 +3937,30 @@ 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); - } - - if (pid == -1) { - rb_last_status_set(0x7f << 8, pid); + pid = proc_spawn_cmd(argv, prog, eargp); } + if (pid == -1) + rb_last_status_set(0x7f << 8, 0); # else status = system(rb_execarg_commandline(eargp, &prog)); + rb_last_status_set((status & 0xff) << 8, 0); 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; }; @@ -4679,16 +3968,11 @@ 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(rb_execarg_get(argp->execarg), - argp->errmsg.ptr, argp->errmsg.buflen); + return (VALUE)rb_spawn_process(DATA_PTR(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) { @@ -4697,10 +3981,8 @@ 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; - - rb_pid_t r = (rb_pid_t)rb_ensure(do_spawn_process, (VALUE)&args, - execarg_parent_end, execarg_obj); - return r; + return (rb_pid_t)rb_ensure(do_spawn_process, (VALUE)&args, + execarg_parent_end, execarg_obj); } static rb_pid_t @@ -4708,7 +3990,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, FALSE); + execarg_obj = rb_execarg_new(argc, argv, TRUE); return rb_execarg_spawn(execarg_obj, errmsg, errmsg_buflen); } @@ -4726,306 +4008,360 @@ rb_spawn(int argc, const VALUE *argv) /* * call-seq: - * 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: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: - * - * - +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. - * - * <b>Argument +command_line+</b> - * - * \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. - * - * Assigns the command's error status to <tt>$?</tt>: - * - * system('exit') # => true # Built-in. - * $? # => #<Process::Status: pid 640610 exit 0> - * system('date > /nop/date.tmp') # => false - * $? # => #<Process::Status: pid 640742 exit 2> - * - * 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. - * - * Raises an exception if the new process could not execute. - * - * <b>Argument +exe_path+</b> + * system([env,] command... [,options]) -> true, false or nil * - * Argument +exe_path+ is one of the following: + * Executes _command..._ in a subshell. + * _command..._ is one of following forms. * - * - 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. + * 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) * - * Example: + * 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>. * - * system('/usr/bin/date') # => true # Path to date on Unix-style system. - * system('foo') # => nil # Command failed. + * The hash arguments, env and options, are same as + * <code>exec</code> and <code>spawn</code>. + * See <code>Kernel.spawn</code> for details. * - * Output: + * system("echo *") + * system("echo", "*") * - * Mon Aug 28 11:43:10 AM CDT 2023 + * <em>produces:</em> * - * Assigns the command's error status to <tt>$?</tt>: + * config.h main.rb + * * * - * 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. + * See <code>Kernel.exec</code> for the standard shell. */ static VALUE -rb_f_system(int argc, VALUE *argv, VALUE _) +rb_f_system(int argc, VALUE *argv) { - 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); - - struct rb_process_status status = {0}; - eargp->status = &status; + rb_pid_t pid; + int status; - last_status_clear(th); +#if defined(SIGCLD) && !defined(SIGCHLD) +# define SIGCHLD SIGCLD +#endif - // 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); +#ifdef SIGCHLD + RETSIGTYPE (*chfunc)(int); + 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) { - 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); - } - - if (eargp->exception) { - VALUE command = eargp->invoke.sh.shell_script; - RB_GC_GUARD(execarg_obj); - rb_syserr_fail_str(errno, command); + 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()."); } - else { - return Qnil; +#endif +#ifdef SIGCHLD + signal(SIGCHLD, chfunc); +#endif + if (pid < 0) { + return Qnil; } + status = PST2INT(rb_last_status_get()); + if (status == EXIT_SUCCESS) return Qtrue; + return Qfalse; } /* * call-seq: - * 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:command_injection.rdoc]. - * - * Returns the process ID (pid) of the new process, - * without waiting for it to complete. - * - * 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. + * 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, an integer, 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 * - * 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). + * For stdout and stderr (and combination of them), + * it is opened in write mode. + * Otherwise read mode is used. * - * Argument +env+, if given, is a hash that affects +ENV+ for the new process; - * see {Execution Environment}[rdoc-ref:Process@Execution+Environment]. + * For specifying flags and permission of file creation explicitly, + * an array is used instead. * - * Argument +options+ is a hash of options for the new process; - * see {Execution Options}[rdoc-ref:Process@Execution+Options]. + * 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 first required argument is one of the following: + * 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. * - * - +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 an array of IOs and integers are specified as a hash key, + * all the elements are redirected. * - * <b>Argument +command_line+</b> + * # stdout and stderr is redirected to log file. + * # The file "log" is opened just once. + * pid = spawn(command, [:out, :err]=>["log", "w"]) * - * \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: + * 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. * - * 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 + * # stdout and stderr is redirected to log file. + * # The file "log" is opened just once. + * pid = spawn(command, :out=>["log", "w"], :err=>[:child, :out]) * - * The command line may also contain arguments and options for the command: + * \[: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. * - * spawn('echo "Foo"') # => 799031 - * Process.wait # => 799031 + * io = IO.popen(["sh", "-c", "echo out; echo err >&2", :err=>[:child, :out]]) + * p io.read #=> "out\nerr\n" * - * Output: + * The <code>:chdir</code> key in +options+ specifies the current directory. * - * Foo + * pid = spawn(command, :chdir=>"/var/tmp") * - * See {Execution Shell}[rdoc-ref:Process@Execution+Shell] for details about the shell. + * 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. * - * Raises an exception if the new process could not execute. + * pid = spawn(command, :close_others=>true) # close 3,4,5,... (default) + * pid = spawn(command, :close_others=>false) # don't close 3,4,5,... * - * <b>Argument +exe_path+</b> + * :close_others is true by default for spawn and IO.popen. * - * Argument +exe_path+ is one of the following: + * Note that fds which close-on-exec flag is already set are closed + * regardless of :close_others option. * - * - 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. + * So IO.pipe and spawn can be used as IO.popen. * - * spawn('/usr/bin/date') # Path to date on Unix-style system. - * Process.wait + * # 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 * - * Output: + * :close is specified as a hash value to close a fd individually. * - * Mon Aug 28 11:43:10 AM CDT 2023 + * f = open(foo) + * system(command, f=>:close) # don't inherit f. * - * Ruby invokes the executable directly. - * This form does not use the shell; - * see {Arguments args}[rdoc-ref:Process@Arguments+args] for caveats. + * If a file descriptor need to be inherited, + * io=>io can be used. * - * If one or more +args+ is given, each is an argument or option - * to be passed to the executable: + * # 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 * - * spawn('echo', 'C*') # => 799392 - * Process.wait # => 799392 - * spawn('echo', 'hello', 'world') # => 799393 - * Process.wait # => 799393 + * It is also possible to exchange file descriptors. * - * Output: + * pid = spawn(command, :out=>:err, :err=>:out) * - * C* - * hello world + * 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. * - * Raises an exception if the new process could not execute. + * See <code>Kernel.exec</code> for the standard shell. */ static VALUE -rb_f_spawn(int argc, VALUE *argv, VALUE _) +rb_f_spawn(int argc, VALUE *argv) { 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, FALSE); + execarg_obj = rb_execarg_new(argc, argv, TRUE); 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); @@ -5036,59 +4372,55 @@ rb_f_spawn(int argc, VALUE *argv, VALUE _) /* * call-seq: - * 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 - * + * sleep([duration]) -> integer + * + * 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 */ static VALUE -rb_f_sleep(int argc, VALUE *argv, VALUE _) +rb_f_sleep(int argc, VALUE *argv) { - time_t beg = time(0); - VALUE scheduler = rb_fiber_scheduler_current(); + time_t beg, end; - if (scheduler != Qnil) { - rb_fiber_scheduler_kernel_sleepv(scheduler, argc, argv); + beg = time(0); + if (argc == 0) { + rb_thread_sleep_forever(); } else { - 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])); - } + rb_check_arity(argc, 0, 1); + rb_thread_wait_for(rb_time_interval(argv[0])); } - time_t end = time(0) - beg; + end = time(0) - beg; - return TIMET2NUM(end); + return INT2FIX(end); } #if (defined(HAVE_GETPGRP) && defined(GETPGRP_VOID)) || defined(HAVE_GETPGID) /* * call-seq: - * Process.getpgrp -> integer - * - * Returns the process group ID for the current process: + * Process.getpgrp -> integer * - * Process.getpgid(0) # => 25527 - * Process.getpgrp # => 25527 + * Returns the process group ID for this process. Not available on + * all platforms. * + * Process.getpgid(0) #=> 25527 + * Process.getpgrp #=> 25527 */ static VALUE -proc_getpgrp(VALUE _) +proc_getpgrp(void) { rb_pid_t pgrp; @@ -5110,15 +4442,14 @@ proc_getpgrp(VALUE _) #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>. - * - * Not available on all platforms. + * Equivalent to <code>setpgid(0,0)</code>. Not available on all + * platforms. */ static VALUE -proc_setpgrp(VALUE _) +proc_setpgrp(void) { /* check for posix setpgid() first; this matches the posix */ /* getpgrp() above. It appears that configure will set SETPGRP_VOID */ @@ -5139,13 +4470,12 @@ proc_setpgrp(VALUE _) #if defined(HAVE_GETPGID) /* * call-seq: - * Process.getpgid(pid) -> integer + * Process.getpgid(pid) -> integer * - * Returns the process group ID for the given process ID +pid+: - * - * Process.getpgid(Process.ppid) # => 25527 + * Returns the process group ID for the given process id. Not + * available on all platforms. * - * Not available on all platforms. + * Process.getpgid(Process.ppid()) #=> 25527 */ static VALUE @@ -5165,12 +4495,10 @@ proc_getpgid(VALUE obj, VALUE pid) #ifdef HAVE_SETPGID /* * call-seq: - * Process.setpgid(pid, pgid) -> 0 - * - * Sets the process group ID for the process given by process ID +pid+ - * to +pgid+. + * Process.setpgid(pid, integer) -> 0 * - * Not available on all platforms. + * Sets the process group ID of _pid_ (0 indicates this + * process) to <em>integer</em>. Not available on all platforms. */ static VALUE @@ -5192,25 +4520,24 @@ proc_setpgid(VALUE obj, VALUE pid, VALUE pgrp) #ifdef HAVE_GETSID /* * call-seq: - * Process.getsid(pid = nil) -> integer - * - * Returns the session ID of the given process ID +pid+, - * or of the current process if not given: + * Process.getsid() -> integer + * Process.getsid(pid) -> integer * - * Process.getsid # => 27422 - * Process.getsid(0) # => 27422 - * Process.getsid(Process.pid()) # => 27422 + * Returns the session ID for the given process id. If not given, + * return current process sid. Not available on all platforms. * - * Not available on all platforms. + * Process.getsid() #=> 27422 + * Process.getsid(0) #=> 27422 + * Process.getsid(Process.pid()) #=> 27422 */ static VALUE -proc_getsid(int argc, VALUE *argv, VALUE _) +proc_getsid(int argc, VALUE *argv) { rb_pid_t sid; rb_pid_t pid = 0; if (rb_check_arity(argc, 0, 1) == 1 && !NIL_P(argv[0])) - pid = NUM2PIDT(argv[0]); + pid = NUM2PIDT(argv[0]); sid = getsid(pid); if (sid < 0) rb_sys_fail(0); @@ -5228,19 +4555,17 @@ static rb_pid_t ruby_setsid(void); #endif /* * call-seq: - * Process.setsid -> integer - * - * Establishes the current process as a new session and process group leader, - * with no controlling tty; - * returns the session ID: + * Process.setsid -> integer * - * Process.setsid # => 27422 + * Establishes this process as a new session and process group + * leader, with no controlling tty. Returns the session id. Not + * available on all platforms. * - * Not available on all platforms. + * Process.setsid #=> 27422 */ static VALUE -proc_setsid(VALUE _) +proc_setsid(void) { rb_pid_t pid; @@ -5255,7 +4580,7 @@ static rb_pid_t ruby_setsid(void) { rb_pid_t pid; - int ret, fd; + int ret; pid = getpid(); #if defined(SETPGRP_VOID) @@ -5270,8 +4595,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; } @@ -5284,26 +4609,19 @@ ruby_setsid(void) #ifdef HAVE_GETPRIORITY /* * call-seq: - * 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. + * Process.getpriority(kind, integer) -> integer + * + * 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 */ static VALUE @@ -5327,18 +4645,14 @@ proc_getpriority(VALUE obj, VALUE which, VALUE who) #ifdef HAVE_GETPRIORITY /* * call-seq: - * Process.setpriority(kind, integer, priority) -> 0 - * - * See Process.getpriority. - * - * Examples: + * Process.setpriority(kind, integer, priority) -> 0 * - * 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 + * See <code>Process#getpriority</code>. * - * Not available on all platforms. + * 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 */ static VALUE @@ -5351,7 +4665,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 @@ -5416,9 +4730,6 @@ rlimit_resource_name2int(const char *name, long len, int casetype) #ifdef RLIMIT_NPROC RESCHECK(NPROC); #endif -#ifdef RLIMIT_NPTS - RESCHECK(NPTS); -#endif #ifdef RLIMIT_NICE RESCHECK(NICE); #endif @@ -5494,7 +4805,7 @@ rlimit_type_by_sym(VALUE key) 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); + rtype = rlimit_type_by_lname(rname + prefix_len, len - prefix_len); } RB_GC_GUARD(key); @@ -5511,9 +4822,9 @@ rlimit_resource_type(VALUE rtype) switch (TYPE(rtype)) { case T_SYMBOL: - v = rb_sym2str(rtype); - name = RSTRING_PTR(v); - len = RSTRING_LEN(v); + v = rb_sym2str(rtype); + name = RSTRING_PTR(v); + len = RSTRING_LEN(v); break; default: @@ -5522,7 +4833,7 @@ rlimit_resource_type(VALUE rtype) rtype = v; case T_STRING: name = StringValueCStr(rtype); - len = RSTRING_LEN(rtype); + len = RSTRING_LEN(rtype); break; } /* fall through */ @@ -5538,7 +4849,7 @@ rlimit_resource_type(VALUE rtype) rb_raise(rb_eArgError, "invalid resource name: % "PRIsVALUE, rtype); - UNREACHABLE_RETURN(-1); + UNREACHABLE; } static rlim_t @@ -5549,8 +4860,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: @@ -5579,31 +4890,29 @@ rlimit_resource_value(VALUE rval) #endif rb_raise(rb_eArgError, "invalid resource value: %"PRIsVALUE, rval); - UNREACHABLE_RETURN((rlim_t)-1); + UNREACHABLE; } #endif #if defined(HAVE_GETRLIMIT) && defined(RLIM2NUM) /* * call-seq: - * 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. + * 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. */ static VALUE @@ -5612,7 +4921,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)); } @@ -5623,54 +4932,53 @@ proc_getrlimit(VALUE obj, VALUE resource) #if defined(HAVE_SETRLIMIT) && defined(NUM2RLIM) /* * call-seq: - * 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(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(:CORE, Process.getrlimit(:CORE)[1]) * - * Not available on all platforms. */ static VALUE @@ -5689,7 +4997,7 @@ proc_setrlimit(int argc, VALUE *argv, VALUE obj) 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; } @@ -5702,7 +5010,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"); } } @@ -5711,321 +5019,26 @@ 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"); - } -} - - -#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"); + rb_raise(rb_eRuntimeError, "can't handle GID while evaluating block given to Process::UID.switch method"); } - - /* 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 Process::Sys module contains UID and GID + * The <code>Process::Sys</code> 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 Process, - * Process::UID, and Process::GID modules. + * functionality found in the <code>Process</code>, + * <code>Process::UID</code>, and <code>Process::GID</code> modules. */ #if defined(HAVE_PWD_H) static rb_uid_t obj2uid(VALUE id # ifdef USE_GETPWNAM_R - , VALUE *getpw_tmp + , VALUE *getpw_tmp # endif ) { @@ -6033,48 +5046,46 @@ 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 - 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; + struct passwd pwbuf; + 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; + while ((e = getpwnam_r(usrname, &pwbuf, getpw_buf, getpw_buf_len, &pwptr)) != 0) { + if (e != ERANGE || getpw_buf_len >= GETPW_R_SIZE_LIMIT) { + rb_str_resize(*getpw_tmp, 0); + rb_syserr_fail(e, "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); + } #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 %"PRIsVALUE, id); - } - uid = pwptr->pw_uid; + rb_raise(rb_eArgError, "can't find user for %s", usrname); + } + uid = pwptr->pw_uid; #ifndef USE_GETPWNAM_R - endpwent(); + endpwent(); #endif } return uid; @@ -6101,30 +5112,10 @@ 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 ) { @@ -6132,50 +5123,48 @@ 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 - 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; + struct group grbuf; + 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; + while ((e = getgrnam_r(grpname, &grbuf, getgr_buf, getgr_buf_len, &grptr)) != 0) { + if (e != ERANGE || getgr_buf_len >= GETGR_R_SIZE_LIMIT) { + rb_str_resize(*getgr_tmp, 0); + rb_syserr_fail(e, "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); + } #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 %"PRIsVALUE, id); - } - gid = grptr->gr_gid; + rb_raise(rb_eArgError, "can't find group for %s", grpname); + } + gid = grptr->gr_gid; #if !defined(USE_GETGRNAM_R) && defined(HAVE_ENDGRENT) - endgrent(); + endgrent(); #endif } return gid; @@ -6328,14 +5317,13 @@ p_sys_setresuid(VALUE obj, VALUE rid, VALUE eid, VALUE sid) /* * call-seq: - * Process.uid -> integer - * Process::UID.rid -> integer - * Process::Sys.getuid -> integer - * - * Returns the (real) user ID of the current process. + * Process.uid -> integer + * Process::UID.rid -> integer + * Process::Sys.getuid -> integer * - * Process.uid # => 1000 + * Returns the (real) user ID of this process. * + * Process.uid #=> 501 */ static VALUE @@ -6349,13 +5337,10 @@ proc_getuid(VALUE obj) #if defined(HAVE_SETRESUID) || defined(HAVE_SETREUID) || defined(HAVE_SETRUID) || defined(HAVE_SETUID) /* * call-seq: - * Process.uid = new_uid -> new_uid + * Process.uid= user -> numeric * - * Sets the (user) user ID for the current process to +new_uid+: - * - * Process.uid = 1000 # => 1000 - * - * Not available on all platforms. + * Sets the (user) user ID for this process. Not available on all + * platforms. */ static VALUE @@ -6374,12 +5359,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; @@ -6393,7 +5378,7 @@ proc_setuid(VALUE obj, VALUE id) * * Document-class: Process::UID * - * The Process::UID module contains a collection of + * The <code>Process::UID</code> 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. * @@ -6406,11 +5391,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; } @@ -6440,144 +5425,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 { - rb_syserr_fail(EPERM, 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 { - rb_syserr_fail(EPERM, 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 { - rb_syserr_fail(EPERM, 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 { - rb_syserr_fail(EPERM, 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; @@ -6667,9 +5652,11 @@ 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; } @@ -6693,10 +5680,12 @@ 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; } @@ -6721,7 +5710,12 @@ p_sys_setresgid(VALUE obj, VALUE rid, VALUE eid, VALUE sid) static VALUE p_sys_issetugid(VALUE obj) { - return RBOOL(issetugid()); + if (issetugid()) { + return Qtrue; + } + else { + return Qfalse; + } } #else #define p_sys_issetugid rb_f_notimplement @@ -6730,14 +5724,13 @@ p_sys_issetugid(VALUE obj) /* * call-seq: - * Process.gid -> integer - * Process::GID.rid -> integer - * Process::Sys.getgid -> integer - * - * Returns the (real) group ID for the current process: + * Process.gid -> integer + * Process::GID.rid -> integer + * Process::Sys.getgid -> integer * - * Process.gid # => 1000 + * Returns the (real) group ID for this process. * + * Process.gid #=> 500 */ static VALUE @@ -6751,12 +5744,9 @@ proc_getgid(VALUE obj) #if defined(HAVE_SETRESGID) || defined(HAVE_SETREGID) || defined(HAVE_SETRGID) || defined(HAVE_SETGID) /* * call-seq: - * Process.gid = new_gid -> new_gid - * - * Sets the group ID for the current process to +new_gid+: - * - * Process.gid = 1000 # => 1000 + * Process.gid= integer -> integer * + * Sets the group ID for this process. */ static VALUE @@ -6775,12 +5765,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); @@ -6808,6 +5798,7 @@ 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; @@ -6826,9 +5817,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; @@ -6840,23 +5831,12 @@ maxgroups(void) #ifdef HAVE_GETGROUPS /* * call-seq: - * 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: + * Process.groups -> array * - * - 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. + * Get an <code>Array</code> of the gids of groups in the + * supplemental group access list for this process. * - * Use this call to get a sorted and unique array: - * - * Process.groups.uniq.sort + * Process.groups #=> [27, 6, 10, 11] * */ @@ -6869,17 +5849,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); @@ -6893,14 +5873,14 @@ proc_getgroups(VALUE obj) #ifdef HAVE_SETGROUPS /* * call-seq: - * Process.groups = new_groups -> new_groups + * Process.groups= array -> array * - * Sets the supplemental group access list to the given - * array of group IDs. + * Set the supplemental group access list to the given + * <code>Array</code> 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] * */ @@ -6916,19 +5896,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); @@ -6942,28 +5922,26 @@ proc_setgroups(VALUE obj, VALUE ary) #ifdef HAVE_INITGROUPS /* * call-seq: - * Process.initgroups(username, gid) -> array - * - * 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.initgroups(username, gid) -> array * - * Example: + * 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. * - * 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] + * 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] * - * Not available on all platforms. */ static VALUE proc_initgroups(VALUE obj, VALUE uname, VALUE base_grp) { if (initgroups(StringValueCStr(uname), OBJ2GID(base_grp)) != 0) { - rb_sys_fail(0); + rb_sys_fail(0); } return proc_getgroups(obj); } @@ -6974,13 +5952,12 @@ proc_initgroups(VALUE obj, VALUE uname, VALUE base_grp) #if defined(_SC_NGROUPS_MAX) || defined(NGROUPS_MAX) /* * call-seq: - * Process.maxgroups -> integer + * Process.maxgroups -> integer * - * Returns the maximum number of group IDs allowed - * in the supplemental group access list: - * - * Process.maxgroups # => 32 + * Returns the maximum number of gids allowed in the supplemental + * group access list. * + * Process.maxgroups #=> 32 */ static VALUE @@ -6995,10 +5972,10 @@ proc_getmaxgroups(VALUE obj) #ifdef HAVE_SETGROUPS /* * call-seq: - * Process.maxgroups = new_max -> new_max + * Process.maxgroups= integer -> integer * - * Sets the maximum number of group IDs allowed - * in the supplemental group access list. + * Sets the maximum number of gids allowed in the supplemental group + * access list. */ static VALUE @@ -7008,13 +5985,13 @@ proc_setmaxgroups(VALUE obj, VALUE val) int ngroups_max = get_sc_ngroups_max(); if (ngroups <= 0) - rb_raise(rb_eArgError, "maxgroups %d should be positive", ngroups); + rb_raise(rb_eArgError, "maxgroups %d shold 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; @@ -7029,32 +6006,26 @@ static int rb_daemon(int nochdir, int noclose); /* * call-seq: - * 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. + * 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::*. */ static VALUE -proc_daemon(int argc, VALUE *argv, VALUE _) +proc_daemon(int argc, VALUE *argv) { int n, nochdir = FALSE, noclose = FALSE; switch (rb_check_arity(argc, 0, 2)) { - case 2: noclose = TO_BOOL(argv[1], "noclose"); - case 1: nochdir = TO_BOOL(argv[0], "nochdir"); + case 2: noclose = RTEST(argv[1]); + case 1: nochdir = RTEST(argv[0]); } prefork(); @@ -7063,8 +6034,6 @@ proc_daemon(int argc, VALUE *argv, VALUE _) return INT2FIX(n); } -extern const char ruby_null_device[]; - static int rb_daemon(int nochdir, int noclose) { @@ -7072,29 +6041,35 @@ rb_daemon(int nochdir, int noclose) #ifdef HAVE_DAEMON before_fork_ruby(); err = daemon(nochdir, noclose); - after_fork_ruby(0); + after_fork_ruby(); + rb_thread_atfork(); #else int n; - switch (rb_fork_ruby(NULL)) { - case -1: return -1; - case 0: break; - default: _exit(EXIT_SUCCESS); +#define fork_daemon() \ + switch (rb_fork_ruby(NULL)) { \ + case -1: return -1; \ + case 0: rb_thread_atfork(); break; \ + default: _exit(EXIT_SUCCESS); \ } - /* ignore EPERM which means already being process-leader */ - if (setsid() < 0) (void)0; + fork_daemon(); + + if (setsid() < 0) return -1; + + /* must not be process-leader */ + fork_daemon(); if (!nochdir) - err = chdir("/"); + err = chdir("/"); - if (!noclose && (n = rb_cloexec_open(ruby_null_device, O_RDWR, 0)) != -1) { + if (!noclose && (n = rb_cloexec_open("/dev/null", 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; @@ -7107,7 +6082,7 @@ rb_daemon(int nochdir, int noclose) * * Document-class: Process::GID * - * The Process::GID module contains a collection of + * The <code>Process::GID</code> 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. * @@ -7120,11 +6095,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; } @@ -7154,145 +6129,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 { - rb_syserr_fail(EPERM, 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 { - rb_syserr_fail(EPERM, 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 { - rb_syserr_fail(EPERM, 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 { - rb_syserr_fail(EPERM, 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; @@ -7301,14 +6276,13 @@ p_gid_change_privilege(VALUE obj, VALUE id) /* * call-seq: - * Process.euid -> integer - * Process::UID.eid -> integer - * Process::Sys.geteuid -> integer - * - * Returns the effective user ID for the current process. + * Process.euid -> integer + * Process::UID.eid -> integer + * Process::Sys.geteuid -> integer * - * Process.euid # => 501 + * Returns the effective user ID for this process. * + * Process.euid #=> 501 */ static VALUE @@ -7330,10 +6304,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(); @@ -7344,11 +6318,10 @@ proc_seteuid(rb_uid_t uid) #if defined(HAVE_SETRESUID) || defined(HAVE_SETREUID) || defined(HAVE_SETEUID) || defined(HAVE_SETUID) /* * call-seq: - * Process.euid = new_euid -> new_euid - * - * Sets the effective user ID for the current process. + * Process.euid= user * - * Not available on all platforms. + * Sets the effective user ID for this process. Not available on all + * platforms. */ static VALUE @@ -7377,18 +6350,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); @@ -7426,15 +6399,14 @@ p_uid_grant_privilege(VALUE obj, VALUE id) /* * call-seq: - * Process.egid -> integer - * Process::GID.eid -> integer - * Process::Sys.geteid -> integer - * - * Returns the effective group ID for the current process: + * Process.egid -> integer + * Process::GID.eid -> integer + * Process::Sys.geteid -> integer * - * Process.egid # => 500 + * Returns the effective group ID for this process. Not available on + * all platforms. * - * Not available on all platforms. + * Process.egid #=> 500 */ static VALUE @@ -7448,11 +6420,10 @@ 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 = new_egid -> new_egid - * - * Sets the effective group ID for the current process. + * Process.egid = integer -> integer * - * Not available on all platforms. + * Sets the effective group ID for this process. Not available on all + * platforms. */ static VALUE @@ -7476,10 +6447,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(); @@ -7509,18 +6480,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); @@ -7566,7 +6537,7 @@ p_gid_grant_privilege(VALUE obj, VALUE id) */ static VALUE -p_uid_exchangeable(VALUE _) +p_uid_exchangeable(void) { #if defined(HAVE_SETRESUID) return Qtrue; @@ -7628,7 +6599,7 @@ p_uid_exchange(VALUE obj) */ static VALUE -p_gid_exchangeable(VALUE _) +p_gid_exchangeable(void) { #if defined(HAVE_SETRESGID) return Qtrue; @@ -7691,7 +6662,7 @@ p_gid_exchange(VALUE obj) */ static VALUE -p_uid_have_saved_id(VALUE _) +p_uid_have_saved_id(void) { #if defined(HAVE_SETRESUID) || defined(HAVE_SETEUID) || defined(_POSIX_SAVED_IDS) return Qtrue; @@ -7703,9 +6674,8 @@ p_uid_have_saved_id(VALUE _) #if defined(HAVE_SETRESUID) || defined(HAVE_SETEUID) || defined(_POSIX_SAVED_IDS) static VALUE -p_uid_sw_ensure(VALUE i) +p_uid_sw_ensure(rb_uid_t id) { - rb_uid_t id = (rb_uid_t/* narrowing */)i; under_uid_switch = 0; id = rb_seteuid_core(id); return UIDT2NUM(id); @@ -7736,30 +6706,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 { - rb_syserr_fail(EPERM, 0); + rb_syserr_fail(EPERM, 0); } - UNREACHABLE_RETURN(Qnil); + UNREACHABLE; } #else static VALUE @@ -7780,15 +6750,15 @@ p_uid_switch(VALUE obj) euid = geteuid(); if (uid == euid) { - rb_syserr_fail(EPERM, 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 @@ -7806,7 +6776,7 @@ p_uid_switch(VALUE obj) */ static VALUE -p_gid_have_saved_id(VALUE _) +p_gid_have_saved_id(void) { #if defined(HAVE_SETRESGID) || defined(HAVE_SETEGID) || defined(_POSIX_SAVED_IDS) return Qtrue; @@ -7817,9 +6787,8 @@ p_gid_have_saved_id(VALUE _) #if defined(HAVE_SETRESGID) || defined(HAVE_SETEGID) || defined(_POSIX_SAVED_IDS) static VALUE -p_gid_sw_ensure(VALUE i) +p_gid_sw_ensure(rb_gid_t id) { - rb_gid_t id = (rb_gid_t/* narrowing */)i; under_gid_switch = 0; id = rb_setegid_core(id); return GIDT2NUM(id); @@ -7850,30 +6819,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 { - rb_syserr_fail(EPERM, 0); + rb_syserr_fail(EPERM, 0); } - UNREACHABLE_RETURN(Qnil); + UNREACHABLE; } #else static VALUE @@ -7894,15 +6863,15 @@ p_gid_switch(VALUE obj) egid = getegid(); if (gid == egid) { - rb_syserr_fail(EPERM, 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 @@ -7912,28 +6881,32 @@ p_gid_switch(VALUE obj) static long get_clk_tck(void) { + long hertz = #ifdef HAVE__SC_CLK_TCK - return sysconf(_SC_CLK_TCK); -#elif defined CLK_TCK - return CLK_TCK; -#elif defined HZ - return HZ; + (double)sysconf(_SC_CLK_TCK); #else - return 60; +#ifndef HZ +# ifdef CLK_TCK +# define HZ CLK_TCK +# else +# define HZ 60 +# endif +#endif /* HZ */ + HZ; #endif + return hertz; } /* * call-seq: - * 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: + * Process.times -> aProcessTms * - * Process.times - * # => #<struct Process::Tms utime=55.122118, stime=35.533068, cutime=0.0, cstime=0.002846> + * 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. * - * The precision is platform-defined. + * t = Process.times + * [ t.utime, t.stime, t.cutime, t.cstime ] #=> [0.0, 0.02, 0.00, 0.00] */ VALUE @@ -7944,13 +6917,13 @@ rb_proc_times(VALUE obj) struct rusage usage_s, usage_c; if (getrusage(RUSAGE_SELF, &usage_s) != 0 || getrusage(RUSAGE_CHILDREN, &usage_c) != 0) - rb_sys_fail("getrusage"); + 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(); + const double hertz = get_clk_tck(); struct tms buf; times(&buf); @@ -8160,7 +7133,7 @@ make_clock_result(struct timetick *ttp, } #ifdef __APPLE__ -static const mach_timebase_info_data_t * +static mach_timebase_info_data_t * get_mach_timebase_info(void) { static mach_timebase_info_data_t sTimebaseInfo; @@ -8171,194 +7144,136 @@ 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 = :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. + * 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 specified 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, macOS 10.12 + * [CLOCK_MONOTONIC] SUSv3 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0, OpenBSD 3.4, macOS 10.12 + * [CLOCK_PROCESS_CPUTIME_ID] SUSv3 to 4, Linux 2.5.63, OpenBSD 5.4, macOS 10.12 + * [CLOCK_THREAD_CPUTIME_ID] SUSv3 to 4, Linux 2.5.63, FreeBSD 7.1, OpenBSD 5.4, macOS 10.12 + * [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, macOS 10.12 + * [CLOCK_MONOTONIC_RAW_APPROX] macOS 10.12 + * [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_RAW] macOS 10.12 + * [CLOCK_UPTIME_RAW_APPROX] macOS 10.12 + * [CLOCK_UPTIME_PRECISE] FreeBSD 8.1 + * [CLOCK_SECOND] FreeBSD 8.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+ 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 + * 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 * * 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 +:nanosecond+ as the +unit+. + * the return value for CLOCK_REALTIME. + * If the exact nanoseconds value is required, use +:nanoseconds+ as the +unit+. * - * 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 (zero) of the returned value varies. + * For example, system start up time, process start up time, the Epoch, etc. * - * 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. + * 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. */ -static VALUE -rb_clock_gettime(int argc, VALUE *argv, VALUE _) +VALUE +rb_clock_gettime(int argc, VALUE *argv) { int ret; @@ -8370,44 +7285,12 @@ rb_clock_gettime(int argc, VALUE *argv, VALUE _) 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. - */ -#ifdef HAVE_GETTIMEOFDAY - /* + * + * gettimeofday is always available on platforms supported by Ruby. * GETTIMEOFDAY_BASED_CLOCK_REALTIME is used for * CLOCK_REALTIME if clock_gettime is not available. */ @@ -8422,7 +7305,6 @@ rb_clock_gettime(int argc, VALUE *argv, VALUE _) 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) { @@ -8513,8 +7395,9 @@ rb_clock_gettime(int argc, VALUE *argv, VALUE _) } #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) { - const mach_timebase_info_data_t *info = get_mach_timebase_info(); + 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; @@ -8525,24 +7408,22 @@ rb_clock_gettime(int argc, VALUE *argv, VALUE _) } #endif } - else if (NUMERIC_CLOCKID) { + else { #if defined(HAVE_CLOCK_GETTIME) struct timespec ts; + clockid_t c; c = NUM2CLOCKID(clk_id); - gettime: ret = clock_gettime(c, &ts); if (ret == -1) - clock_failed("gettime", errno, clk_id); + rb_sys_fail("clock_gettime"); tt.count = (int32_t)ts.tv_nsec; tt.giga_count = ts.tv_sec; denominators[num_denominators++] = 1000000000; goto success; #endif } - else { - rb_unexpected_type(clk_id, T_SYMBOL); - } - clock_failed("gettime", EINVAL, clk_id); + /* EINVAL emulates clock_gettime behavior when clock_id is invalid. */ + rb_syserr_fail(EINVAL, 0); success: return make_clock_result(&tt, numerators, num_numerators, denominators, num_denominators, unit); @@ -8550,86 +7431,55 @@ rb_clock_gettime(int argc, VALUE *argv, VALUE _) /* * call-seq: - * Process.clock_getres(clock_id, unit = :float_second) -> number + * 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. + * + * +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. * - * 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 + * p Process.clock_getres(Process::CLOCK_MONOTONIC) + * #=> 1.0e-09 * - * <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. */ -static VALUE -rb_clock_getres(int argc, VALUE *argv, VALUE _) +VALUE +rb_clock_getres(int argc, VALUE *argv) { - 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 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; @@ -8686,7 +7536,7 @@ rb_clock_getres(int argc, VALUE *argv, VALUE _) #ifdef RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC if (clk_id == RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC) { - const mach_timebase_info_data_t *info = get_mach_timebase_info(); + mach_timebase_info_data_t *info = get_mach_timebase_info(); tt.count = 1; tt.giga_count = 0; numerators[num_numerators++] = info->numer; @@ -8696,24 +7546,21 @@ rb_clock_getres(int argc, VALUE *argv, VALUE _) } #endif } - else if (NUMERIC_CLOCKID) { + else { #if defined(HAVE_CLOCK_GETRES) struct timespec ts; - c = NUM2CLOCKID(clk_id); - getres: - ret = clock_getres(c, &ts); + clockid_t c = NUM2CLOCKID(clk_id); + int ret = clock_getres(c, &ts); if (ret == -1) - clock_failed("getres", errno, clk_id); + rb_sys_fail("clock_getres"); tt.count = (int32_t)ts.tv_nsec; tt.giga_count = ts.tv_sec; denominators[num_denominators++] = 1000000000; goto success; #endif } - else { - rb_unexpected_type(clk_id, T_SYMBOL); - } - clock_failed("getres", EINVAL, clk_id); + /* EINVAL emulates clock_getres behavior when clock_id is invalid. */ + rb_syserr_fail(EINVAL, 0); success: if (unit == ID2SYM(id_hertz)) { @@ -8724,578 +7571,32 @@ rb_clock_getres(int argc, VALUE *argv, VALUE _) } } -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; -static VALUE rb_mProcUID; -static VALUE rb_mProcGID; -static VALUE rb_mProcID_Syscall; +VALUE rb_mProcUID; +VALUE rb_mProcGID; +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_LOCK_ENTER(); - rb_gc_prepare_heap(); - RB_VM_LOCK_LEAVE(); - return Qtrue; -} /* - * 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. - * + * The <code>Process</code> module is a collection of methods used to + * manipulate processes. */ void InitVM_process(void) { - 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); +#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_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", f_exit, -1); - rb_define_global_function("abort", f_abort, -1); + rb_define_global_function("exit", rb_f_exit, -1); + rb_define_global_function("abort", rb_f_abort, -1); rb_mProcess = rb_define_module("Process"); @@ -9314,36 +7615,29 @@ InitVM_process(void) rb_define_const(rb_mProcess, "WUNTRACED", INT2FIX(0)); #endif - rb_define_singleton_method(rb_mProcess, "exec", f_exec, -1); + rb_define_singleton_method(rb_mProcess, "exec", rb_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", f_exit, -1); - rb_define_singleton_method(rb_mProcess, "abort", f_abort, -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, "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", proc_rb_f_kill, -1); - rb_define_module_function(rb_mProcess, "wait", proc_m_wait, -1); + 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, "wait2", proc_wait2, -1); - rb_define_module_function(rb_mProcess, "waitpid", proc_m_wait, -1); + rb_define_module_function(rb_mProcess, "waitpid", proc_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); @@ -9352,7 +7646,7 @@ InitVM_process(void) 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_m, 0); + rb_define_method(rb_cProcessStatus, "pid", pst_pid, 0); rb_define_method(rb_cProcessStatus, "stopped?", pst_wifstopped, 0); rb_define_method(rb_cProcessStatus, "stopsig", pst_wstopsig, 0); @@ -9363,8 +7657,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", proc_get_pid, 0); - rb_define_module_function(rb_mProcess, "ppid", proc_get_ppid, 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, "getpgrp", proc_getpgrp, 0); rb_define_module_function(rb_mProcess, "setpgrp", proc_setpgrp, 0); @@ -9377,8 +7671,6 @@ 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)); @@ -9394,20 +7686,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 @@ -9483,14 +7775,6 @@ 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. * @@ -9553,49 +7837,31 @@ InitVM_process(void) rb_define_module_function(rb_mProcess, "times", rb_proc_times, 0); -#if defined(RUBY_CLOCK_REALTIME) -#elif defined(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 -#if defined(CLOCK_REALTIME) && defined(CLOCKID2NUM) +#ifdef CLOCK_REALTIME /* 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) -# define RUBY_CLOCK_MONOTONIC RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC +#elif defined(RUBY_GETTIMEOFDAY_BASED_CLOCK_REALTIME) + /* see Process.clock_gettime */ + rb_define_const(rb_mProcess, "CLOCK_REALTIME", RUBY_GETTIMEOFDAY_BASED_CLOCK_REALTIME); #endif -#if defined(CLOCK_MONOTONIC) && defined(CLOCKID2NUM) +#ifdef CLOCK_MONOTONIC /* 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) -# define RUBY_CLOCK_PROCESS_CPUTIME_ID RUBY_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID +#elif defined(RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC) + /* see Process.clock_gettime */ + rb_define_const(rb_mProcess, "CLOCK_MONOTONIC", RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC); #endif -#if defined(CLOCK_PROCESS_CPUTIME_ID) && defined(CLOCKID2NUM) +#ifdef CLOCK_PROCESS_CPUTIME_ID /* 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); +#elif defined(RUBY_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID) + /* see Process.clock_gettime */ + rb_define_const(rb_mProcess, "CLOCK_PROCESS_CPUTIME_ID", RUBY_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID); #endif - -#if defined(CLOCK_THREAD_CPUTIME_ID) && defined(CLOCKID2NUM) +#ifdef CLOCK_THREAD_CPUTIME_ID /* 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)); @@ -9672,26 +7938,12 @@ InitVM_process(void) /* 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); -#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 + rb_define_const(rb_cStruct, "Tms", rb_cProcessTms); /* for the backward compatibility */ #endif SAVED_USER_ID = geteuid(); @@ -9752,58 +8004,46 @@ InitVM_process(void) void Init_process(void) { -#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); + 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"); #ifdef HAVE_SETPGID - define_id(pgroup); + id_pgroup = rb_intern("pgroup"); #endif #ifdef _WIN32 - 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 + 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"); #ifdef HAVE_TIMES - define_id(TIMES_BASED_CLOCK_MONOTONIC); - define_id(TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID); + 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"); #endif #ifdef RUSAGE_SELF - define_id(GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID); + id_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID = rb_intern("GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID"); #endif - define_id(CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID); + id_CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID = rb_intern("CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID"); #ifdef __APPLE__ - define_id(MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC); + id_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC = rb_intern("MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC"); #endif - define_id(hertz); + id_hertz = rb_intern("hertz"); InitVM(process); } |