diff options
Diffstat (limited to 'process.c')
| -rw-r--r-- | process.c | 2376 |
1 files changed, 1748 insertions, 628 deletions
@@ -11,88 +11,112 @@ **********************************************************************/ -#include "internal.h" -#include "ruby/io.h" -#include "ruby/thread.h" -#include "ruby/util.h" -#include "vm_core.h" +#include "ruby/internal/config.h" -#include <stdio.h> +#include "ruby/fiber/scheduler.h" + +#include <ctype.h> #include <errno.h> #include <signal.h> +#include <stdarg.h> +#include <stdio.h> +#include <time.h> + #ifdef HAVE_STDLIB_H -#include <stdlib.h> +# include <stdlib.h> #endif + #ifdef HAVE_UNISTD_H -#include <unistd.h> +# include <unistd.h> #endif + #ifdef HAVE_FCNTL_H -#include <fcntl.h> +# include <fcntl.h> #endif + #ifdef HAVE_PROCESS_H -#include <process.h> +# include <process.h> #endif -#include <time.h> -#include <ctype.h> - #ifndef EXIT_SUCCESS -#define EXIT_SUCCESS 0 +# define EXIT_SUCCESS 0 #endif + #ifndef EXIT_FAILURE -#define EXIT_FAILURE 1 +# define EXIT_FAILURE 1 #endif #ifdef HAVE_SYS_WAIT_H # include <sys/wait.h> #endif + #ifdef HAVE_SYS_RESOURCE_H # include <sys/resource.h> #endif + #ifdef HAVE_VFORK_H # include <vfork.h> #endif + #ifdef HAVE_SYS_PARAM_H # include <sys/param.h> #endif + #ifndef MAXPATHLEN # define MAXPATHLEN 1024 #endif -#include "ruby/st.h" #include <sys/stat.h> -#if defined(__native_client__) && defined(NACL_NEWLIB) -# include <sys/unistd.h> -# include "nacl/stat.h" -# include "nacl/unistd.h" -# include "nacl/resource.h" -# undef HAVE_ISSETUGID -#endif #ifdef HAVE_SYS_TIME_H -#include <sys/time.h> +# include <sys/time.h> #endif + #ifdef HAVE_SYS_TIMES_H -#include <sys/times.h> +# include <sys/times.h> #endif #ifdef HAVE_PWD_H -#include <pwd.h> +# include <pwd.h> #endif + #ifdef HAVE_GRP_H -#include <grp.h> +# include <grp.h> # ifdef __CYGWIN__ int initgroups(const char *, rb_gid_t); # endif #endif + #ifdef HAVE_SYS_ID_H -#include <sys/id.h> +# include <sys/id.h> #endif #ifdef __APPLE__ # include <mach/mach_time.h> #endif +#include "dln.h" +#include "hrtime.h" +#include "internal.h" +#include "internal/bits.h" +#include "internal/dir.h" +#include "internal/error.h" +#include "internal/eval.h" +#include "internal/hash.h" +#include "internal/numeric.h" +#include "internal/object.h" +#include "internal/process.h" +#include "internal/thread.h" +#include "internal/variable.h" +#include "internal/warnings.h" +#include "mjit.h" +#include "ruby/io.h" +#include "ruby/st.h" +#include "ruby/thread.h" +#include "ruby/util.h" +#include "vm_core.h" +#include "ruby/ractor.h" + /* define system APIs */ #ifdef _WIN32 #undef open @@ -150,23 +174,52 @@ int setregid(rb_gid_t rgid, rb_gid_t egid); #endif #endif -#define preserving_errno(stmts) \ - do {int saved_errno = errno; stmts; errno = saved_errno;} while (0) - static void check_uid_switch(void); static void check_gid_switch(void); +static int exec_async_signal_safe(const struct rb_execarg *, char *, size_t); + +VALUE rb_envtbl(void); +VALUE rb_env_to_hash(void); #if 1 #define p_uid_from_name p_uid_from_name #define p_gid_from_name p_gid_from_name #endif +#if defined(HAVE_UNISTD_H) +# if defined(HAVE_GETLOGIN_R) +# define USE_GETLOGIN_R 1 +# define GETLOGIN_R_SIZE_DEFAULT 0x100 +# define GETLOGIN_R_SIZE_LIMIT 0x1000 +# if defined(_SC_LOGIN_NAME_MAX) +# define GETLOGIN_R_SIZE_INIT sysconf(_SC_LOGIN_NAME_MAX) +# else +# define GETLOGIN_R_SIZE_INIT GETLOGIN_R_SIZE_DEFAULT +# endif +# elif defined(HAVE_GETLOGIN) +# define USE_GETLOGIN 1 +# endif +#endif + #if defined(HAVE_PWD_H) -# if defined(HAVE_GETPWNAM_R) && defined(_SC_GETPW_R_SIZE_MAX) +# if defined(HAVE_GETPWUID_R) +# define USE_GETPWUID_R 1 +# elif defined(HAVE_GETPWUID) +# define USE_GETPWUID 1 +# endif +# if defined(HAVE_GETPWNAM_R) # define USE_GETPWNAM_R 1 -# define GETPW_R_SIZE_INIT sysconf(_SC_GETPW_R_SIZE_MAX) +# elif defined(HAVE_GETPWNAM) +# define USE_GETPWNAM 1 +# endif +# if defined(HAVE_GETPWNAM_R) || defined(HAVE_GETPWUID_R) # define GETPW_R_SIZE_DEFAULT 0x1000 # define GETPW_R_SIZE_LIMIT 0x10000 +# if defined(_SC_GETPW_R_SIZE_MAX) +# define GETPW_R_SIZE_INIT sysconf(_SC_GETPW_R_SIZE_MAX) +# else +# define GETPW_R_SIZE_INIT GETPW_R_SIZE_DEFAULT +# endif # endif # ifdef USE_GETPWNAM_R # define PREPARE_GETPWNAM \ @@ -257,6 +310,7 @@ 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 @@ -265,7 +319,7 @@ static ID id_pgroup; #ifdef _WIN32 static ID id_new_pgroup; #endif -static ID id_unsetenv_others, id_chdir, id_umask, id_close_others, id_ENV; +static ID id_unsetenv_others, id_chdir, id_umask, id_close_others; static ID id_nanosecond, id_microsecond, id_millisecond, id_second; static ID id_float_microsecond, id_float_millisecond, id_float_second; static ID id_GETTIMEOFDAY_BASED_CLOCK_REALTIME, id_TIME_BASED_CLOCK_REALTIME; @@ -281,8 +335,6 @@ static ID id_CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID; static ID id_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC; #endif static ID id_hertz; -extern ID ruby_static_id_status; -#define id_status ruby_static_id_status /* execv and execl are async-signal-safe since SUSv4 (POSIX.1-2008, XPG7) */ #if defined(__sun) && !defined(_XPG7) /* Solaris 10, 9, ... */ @@ -293,12 +345,30 @@ extern ID ruby_static_id_status; #define ALWAYS_NEED_ENVP 0 #endif +static void +assert_close_on_exec(int fd) +{ +#if VM_CHECK_MODE > 0 +#if defined(HAVE_FCNTL) && defined(F_GETFD) && defined(FD_CLOEXEC) + int flags = fcntl(fd, F_GETFD); + if (flags == -1) { + static const char m[] = "reserved FD closed unexpectedly?\n"; + (void)!write(2, m, sizeof(m) - 1); + return; + } + if (flags & FD_CLOEXEC) return; + rb_bug("reserved FD did not have close-on-exec set"); +#else + rb_bug("reserved FD without close-on-exec support"); +#endif /* FD_CLOEXEC */ +#endif /* VM_CHECK_MODE */ +} + static inline int close_unless_reserved(int fd) { - /* We should not have reserved FDs at this point */ if (rb_reserved_fd_p(fd)) { /* async-signal-safe */ - rb_async_bug_errno("BUG timer thread still running", 0 /* EDOOFUS */); + assert_close_on_exec(fd); return 0; } return close(fd); /* async-signal-safe */ @@ -307,8 +377,6 @@ close_unless_reserved(int fd) /*#define DEBUG_REDIRECT*/ #if defined(DEBUG_REDIRECT) -#include <stdarg.h> - static void ttyprintf(const char *fmt, ...) { @@ -404,6 +472,30 @@ parent_redirect_close(int fd) #endif /* + * Document-module: Process + * + * The module contains several groups of functionality for handling OS processes: + * + * * Low-level property introspection and management of the current process, like + * Process.argv0, Process.pid; + * * Low-level introspection of other processes, like Process.getpgid, Process.getpriority; + * * Management of the current process: Process.abort, Process.exit, Process.daemon, etc. + * (for convenience, most of those are also available as global functions + * and module functions of Kernel); + * * Creation and management of child processes: Process.fork, Process.spawn, and + * related methods; + * * Management of low-level system clock: Process.times and Process.clock_gettime, + * which could be important for proper benchmarking and other elapsed + * time measurement tasks. + */ + +static VALUE +get_pid(void) +{ + return PIDT2NUM(getpid()); +} + +/* * call-seq: * Process.pid -> integer * @@ -414,11 +506,16 @@ parent_redirect_close(int fd) */ static VALUE -get_pid(void) +proc_get_pid(VALUE _) { - return PIDT2NUM(getpid()); + return get_pid(); } +static VALUE +get_ppid(void) +{ + return PIDT2NUM(getppid()); +} /* * call-seq: @@ -437,9 +534,9 @@ get_pid(void) */ static VALUE -get_ppid(void) +proc_get_ppid(VALUE _) { - return PIDT2NUM(getppid()); + return get_ppid(); } @@ -447,10 +544,10 @@ get_ppid(void) * * Document-class: Process::Status * - * <code>Process::Status</code> encapsulates the information on the + * Process::Status 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. + * Process::Status object. * * fork { exit 99 } #=> 26557 * Process.wait #=> 26557 @@ -467,7 +564,7 @@ get_ppid(void) * 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, + * Process::Status 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. @@ -475,19 +572,97 @@ get_ppid(void) 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 = { + .dfree = RUBY_DEFAULT_FREE, + }, + .data = NULL, + .flags = RUBY_TYPED_FREE_IMMEDIATELY, +}; + +static VALUE +rb_process_status_allocate(VALUE klass) +{ + struct rb_process_status *data = NULL; + + return TypedData_Make_Struct(klass, struct rb_process_status, &rb_process_status_type, data); +} + VALUE rb_last_status_get(void) { return GET_THREAD()->last_status; } +/* + * call-seq: + * Process.last_status -> Process::Status or nil + * + * Returns the status of the last executed child process in the + * current thread. + * + * Process.wait Process.spawn("ruby", "-e", "exit 13") + * Process.last_status #=> #<Process::Status: pid 4825 exit 13> + * + * 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) +{ + 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_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 = RTYPEDDATA_DATA(status); + if (data->pid) { + rb_ivar_set(dump, id_status, INT2NUM(data->status)); + rb_ivar_set(dump, id_pid, PIDT2NUM(data->pid)); + } + return dump; +} + +static VALUE +process_status_load(VALUE real_obj, VALUE load_obj) +{ + struct rb_process_status *data = rb_check_typeddata(real_obj, &rb_process_status_type); + VALUE status = rb_attr_get(load_obj, id_status); + VALUE pid = rb_attr_get(load_obj, id_pid); + data->pid = NIL_P(pid) ? 0 : NUM2PIDT(pid); + data->status = NIL_P(status) ? 0 : NUM2INT(status); + return real_obj; +} + void rb_last_status_set(int status, rb_pid_t pid) { - rb_thread_t *th = GET_THREAD(); - th->last_status = rb_obj_alloc(rb_cProcessStatus); - rb_ivar_set(th->last_status, id_status, INT2FIX(status)); - rb_ivar_set(th->last_status, id_pid, PIDT2NUM(pid)); + GET_THREAD()->last_status = rb_process_status_new(pid, status, 0); } void @@ -496,12 +671,25 @@ rb_last_status_clear(void) GET_THREAD()->last_status = Qnil; } +static rb_pid_t +pst_pid(VALUE pst) +{ + struct rb_process_status *data = RTYPEDDATA_DATA(pst); + return data->pid; +} + +static int +pst_status(VALUE pst) +{ + struct rb_process_status *data = RTYPEDDATA_DATA(pst); + return data->status; +} + /* * call-seq: * stat.to_i -> integer - * stat.to_int -> integer * - * Returns the bits in _stat_ as a <code>Integer</code>. Poking + * Returns the bits in _stat_ as an Integer. Poking * around in these bits is platform dependent. * * fork { exit 0xab } #=> 26566 @@ -510,12 +698,13 @@ rb_last_status_clear(void) */ static VALUE -pst_to_i(VALUE st) +pst_to_i(VALUE self) { - return rb_ivar_get(st, id_status); + int status = pst_status(self); + return RB_INT2NUM(status); } -#define PST2INT(st) NUM2INT(pst_to_i(st)) +#define PST2INT(st) pst_status(st) /* * call-seq: @@ -529,15 +718,24 @@ pst_to_i(VALUE st) */ static VALUE -pst_pid(VALUE st) +pst_pid_m(VALUE self) { - return rb_attr_get(st, id_pid); + rb_pid_t pid = pst_pid(self); + return PIDT2NUM(pid); } +static VALUE pst_message_status(VALUE str, int status); + static void pst_message(VALUE str, rb_pid_t pid, int status) { rb_str_catf(str, "pid %ld", (long)pid); + pst_message_status(str, status); +} + +static VALUE +pst_message_status(VALUE str, int status) +{ if (WIFSTOPPED(status)) { int stopsig = WSTOPSIG(status); const char *signame = ruby_signal_name(stopsig); @@ -566,6 +764,7 @@ pst_message(VALUE str, rb_pid_t pid, int status) rb_str_cat2(str, " (core dumped)"); } #endif + return str; } @@ -587,7 +786,7 @@ pst_to_s(VALUE st) int status; VALUE str; - pid = NUM2PIDT(pst_pid(st)); + pid = pst_pid(st); status = PST2INT(st); str = rb_str_buf_new(0); @@ -612,13 +811,12 @@ pst_inspect(VALUE st) { rb_pid_t pid; int status; - VALUE vpid, str; + VALUE str; - vpid = pst_pid(st); - if (NIL_P(vpid)) { + pid = pst_pid(st); + if (!pid) { return rb_sprintf("#<%s: uninitialized>", rb_class2name(CLASS_OF(st))); } - pid = NUM2PIDT(vpid); status = PST2INT(st); str = rb_sprintf("#<%s: ", rb_class2name(CLASS_OF(st))); @@ -690,9 +888,9 @@ pst_rshift(VALUE st1, VALUE st2) * call-seq: * stat.stopped? -> true or false * - * Returns +true+ if this process is stopped. This is only - * returned if the corresponding <code>wait</code> call had the - * <code>WUNTRACED</code> flag set. + * Returns +true+ if this process is stopped. This is only returned + * if the corresponding #wait call had the Process::WUNTRACED flag + * set. */ static VALUE @@ -700,10 +898,7 @@ pst_wifstopped(VALUE st) { int status = PST2INT(st); - if (WIFSTOPPED(status)) - return Qtrue; - else - return Qfalse; + return RBOOL(WIFSTOPPED(status)); } @@ -739,10 +934,7 @@ pst_wifsignaled(VALUE st) { int status = PST2INT(st); - if (WIFSIGNALED(status)) - return Qtrue; - else - return Qfalse; + return RBOOL(WIFSIGNALED(status)); } @@ -780,10 +972,7 @@ pst_wifexited(VALUE st) { int status = PST2INT(st); - if (WIFEXITED(status)) - return Qtrue; - else - return Qfalse; + return RBOOL(WIFEXITED(status)); } @@ -792,8 +981,7 @@ pst_wifexited(VALUE st) * stat.exitstatus -> integer or nil * * Returns the least significant eight bits of the return code of - * _stat_. Only available if <code>exited?</code> is - * +true+. + * _stat_. Only available if #exited? is +true+. * * fork { } #=> 26572 * Process.wait #=> 26572 @@ -822,7 +1010,7 @@ pst_wexitstatus(VALUE st) * stat.success? -> true, false or nil * * Returns +true+ if _stat_ is successful, +false+ if not. - * Returns +nil+ if <code>exited?</code> is not +true+. + * Returns +nil+ if #exited? is not +true+. */ static VALUE @@ -832,7 +1020,7 @@ pst_success_p(VALUE st) if (!WIFEXITED(status)) return Qnil; - return WEXITSTATUS(status) == EXIT_SUCCESS ? Qtrue : Qfalse; + return RBOOL(WEXITSTATUS(status) == EXIT_SUCCESS); } @@ -850,21 +1038,12 @@ pst_wcoredump(VALUE st) #ifdef WCOREDUMP int status = PST2INT(st); - if (WCOREDUMP(status)) - return Qtrue; - else - return Qfalse; + return RBOOL(WCOREDUMP(status)); #else return Qfalse; #endif } -struct waitpid_arg { - rb_pid_t pid; - int flags; - int *st; -}; - static rb_pid_t do_waitpid(rb_pid_t pid, int *st, int flags) { @@ -877,48 +1056,431 @@ do_waitpid(rb_pid_t pid, int *st, int flags) #endif } +#define WAITPID_LOCK_ONLY ((struct waitpid_state *)-1) + +struct waitpid_state { + struct 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; +}; + +int rb_sigwait_fd_get(const rb_thread_t *); +void rb_sigwait_sleep(const rb_thread_t *, int fd, const rb_hrtime_t *); +void rb_sigwait_fd_put(const rb_thread_t *, int fd); +void rb_thread_sleep_interruptible(void); + +static int +waitpid_signal(struct waitpid_state *w) +{ + if (w->ec) { /* rb_waitpid */ + rb_threadptr_interrupt(rb_ec_thread_ptr(w->ec)); + return TRUE; + } + else { /* ruby_waitpid_locked */ + if (w->cond) { + rb_native_cond_signal(w->cond); + return TRUE; + } + } + return FALSE; +} + +/* + * When a thread is done using sigwait_fd and there are other threads + * sleeping on waitpid, we must kick one of the threads out of + * rb_native_cond_wait so it can switch to rb_sigwait_sleep + */ +static void +sigwait_fd_migrate_sleeper(rb_vm_t *vm) +{ + struct waitpid_state *w = 0; + + list_for_each(&vm->waiting_pids, w, wnode) { + if (waitpid_signal(w)) return; + } + list_for_each(&vm->waiting_grps, w, wnode) { + if (waitpid_signal(w)) return; + } +} + +void +rb_sigwait_fd_migrate(rb_vm_t *vm) +{ + rb_native_mutex_lock(&vm->waitpid_lock); + sigwait_fd_migrate_sleeper(vm); + rb_native_mutex_unlock(&vm->waitpid_lock); +} + +#if RUBY_SIGCHLD +extern volatile unsigned int ruby_nocldwait; /* signal.c */ +/* called by timer thread or thread which acquired sigwait_fd */ +static void +waitpid_each(rb_vm_t *vm, struct list_head *head) +{ + struct waitpid_state *w = 0, *next; + + list_for_each_safe(head, w, next, wnode) { + rb_pid_t ret = do_waitpid(w->pid, &w->status, w->options | WNOHANG); + + if (!ret) continue; + if (ret == -1) w->errnum = errno; + + if (w->pid <= 0) { + /* when waiting for a group of processes, make sure a waiter for a + * specific pid is given that event in preference */ + struct waitpid_state *w_inner = 0, *next_inner; + list_for_each_safe(&vm->waiting_pids, w_inner, next_inner, wnode) { + if (w_inner->pid == ret) { + /* signal this one instead */ + w = w_inner; + } + } + } + + w->ret = ret; + list_del_init(&w->wnode); + waitpid_signal(w); + } +} +#else +# define ruby_nocldwait 0 +#endif + +void +ruby_waitpid_all(rb_vm_t *vm) +{ +#if RUBY_SIGCHLD + rb_native_mutex_lock(&vm->waitpid_lock); + waitpid_each(vm, &vm->waiting_pids); + waitpid_each(vm, &vm->waiting_grps); + /* emulate SA_NOCLDWAIT */ + if (list_empty(&vm->waiting_pids) && list_empty(&vm->waiting_grps)) { + while (ruby_nocldwait && do_waitpid(-1, 0, WNOHANG) > 0) + ; /* keep looping */ + } + rb_native_mutex_unlock(&vm->waitpid_lock); +#endif +} + +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 const rb_hrtime_t * +sigwait_sleep_time(void) +{ + if (SIGCHLD_LOSSY) { + static const rb_hrtime_t busy_wait = 100 * RB_HRTIME_PER_MSEC; + + return &busy_wait; + } + return 0; +} + +/* + * must be called with vm->waitpid_lock held, this is not interruptible + */ +rb_pid_t +ruby_waitpid_locked(rb_vm_t *vm, rb_pid_t pid, int *status, int options, + rb_nativethread_cond_t *cond) +{ + struct waitpid_state w; + + assert(!ruby_thread_has_gvl_p() && "must not have GVL"); + + waitpid_state_init(&w, pid, options); + if (w.pid > 0 || list_empty(&vm->waiting_pids)) + w.ret = do_waitpid(w.pid, &w.status, w.options | WNOHANG); + if (w.ret) { + if (w.ret == -1) w.errnum = errno; + } + else { + int sigwait_fd = -1; + + w.ec = 0; + list_add(w.pid > 0 ? &vm->waiting_pids : &vm->waiting_grps, &w.wnode); + do { + if (sigwait_fd < 0) + sigwait_fd = rb_sigwait_fd_get(0); + + if (sigwait_fd >= 0) { + w.cond = 0; + rb_native_mutex_unlock(&vm->waitpid_lock); + rb_sigwait_sleep(0, sigwait_fd, sigwait_sleep_time()); + rb_native_mutex_lock(&vm->waitpid_lock); + } + else { + w.cond = cond; + rb_native_cond_wait(w.cond, &vm->waitpid_lock); + } + } while (!w.ret); + list_del(&w.wnode); + + /* we're done, maybe other waitpid callers are not: */ + if (sigwait_fd >= 0) { + rb_sigwait_fd_put(0, sigwait_fd); + sigwait_fd_migrate_sleeper(vm); + } + } + if (status) { + *status = w.status; + } + if (w.ret == -1) errno = w.errnum; + return w.ret; +} + +static VALUE +waitpid_sleep(VALUE x) +{ + struct waitpid_state *w = (struct waitpid_state *)x; + + while (!w->ret) { + rb_thread_sleep_interruptible(); + } + + return Qfalse; +} + +static VALUE +waitpid_cleanup(VALUE x) +{ + struct waitpid_state *w = (struct waitpid_state *)x; + + /* + * XXX w->ret is sometimes set but list_del is still needed, here, + * Not sure why, so we unconditionally do list_del here: + */ + if (TRUE || w->ret == 0) { + rb_vm_t *vm = rb_ec_vm_ptr(w->ec); + + rb_native_mutex_lock(&vm->waitpid_lock); + list_del(&w->wnode); + rb_native_mutex_unlock(&vm->waitpid_lock); + } + + return Qfalse; +} + +static void +waitpid_wait(struct waitpid_state *w) +{ + rb_vm_t *vm = rb_ec_vm_ptr(w->ec); + int need_sleep = FALSE; + + /* + * Lock here to prevent do_waitpid from stealing work from the + * ruby_waitpid_locked done by mjit workers since mjit works + * outside of GVL + */ + rb_native_mutex_lock(&vm->waitpid_lock); + + if (w->pid > 0 || list_empty(&vm->waiting_pids)) { + w->ret = do_waitpid(w->pid, &w->status, w->options | WNOHANG); + } + + if (w->ret) { + if (w->ret == -1) w->errnum = errno; + } + else if (w->options & WNOHANG) { + } + else { + need_sleep = TRUE; + } + + if (need_sleep) { + w->cond = 0; + /* order matters, favor specified PIDs rather than -1 or 0 */ + list_add(w->pid > 0 ? &vm->waiting_pids : &vm->waiting_grps, &w->wnode); + } + + rb_native_mutex_unlock(&vm->waitpid_lock); + + if (need_sleep) { + rb_ensure(waitpid_sleep, (VALUE)w, waitpid_cleanup, (VALUE)w); + } +} + static void * -rb_waitpid_blocking(void *data) +waitpid_blocking_no_SIGCHLD(void *x) { - struct waitpid_arg *arg = data; - rb_pid_t result = do_waitpid(arg->pid, arg->st, arg->flags); - return (void *)(VALUE)result; + struct waitpid_state *w = x; + + w->ret = do_waitpid(w->pid, &w->status, w->options); + + return 0; } -static rb_pid_t -do_waitpid_nonblocking(rb_pid_t pid, int *st, int flags) +static void +waitpid_no_SIGCHLD(struct waitpid_state *w) +{ + if (w->options & WNOHANG) { + w->ret = do_waitpid(w->pid, &w->status, w->options); + } + else { + do { + rb_thread_call_without_gvl(waitpid_blocking_no_SIGCHLD, w, + RUBY_UBF_PROCESS, 0); + } while (w->ret < 0 && errno == EINTR && (RUBY_VM_CHECK_INTS(w->ec),1)); + } + if (w->ret == -1) + w->errnum = errno; +} + +VALUE +rb_process_status_wait(rb_pid_t pid, int flags) { - 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; + // We only enter the scheduler if we are "blocking": + if (!(flags & WNOHANG)) { + VALUE scheduler = rb_fiber_scheduler_current(); + VALUE result = rb_fiber_scheduler_process_wait(scheduler, pid, flags); + if (result != Qundef) return result; + } + + struct waitpid_state waitpid_state; + + waitpid_state_init(&waitpid_state, pid, flags); + waitpid_state.ec = GET_EC(); + + if (WAITPID_USE_SIGCHLD) { + waitpid_wait(&waitpid_state); + } + else { + waitpid_no_SIGCHLD(&waitpid_state); + } + + if (waitpid_state.ret == 0) return Qnil; + + if (waitpid_state.ret > 0 && ruby_nocldwait) { + waitpid_state.ret = -1; + waitpid_state.errnum = ECHILD; + } + + 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 + * + * Waits for a child process to exit and returns a Process::Status 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 + * Process::WNOHANG (do not block if no child available) + * or Process::WUNTRACED (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. + * + * Returns +nil+ if there are no child processes. + * Not available on all platforms. + * + * May invoke the scheduler hook _process_wait_. + * + * fork { exit 99 } #=> 27429 + * Process::Status.wait #=> pid 27429 exit 99 + * $? #=> nil + * + * pid = fork { sleep 3 } #=> 27440 + * Time.now #=> 2008-03-08 19:56:16 +0900 + * Process::Status.wait(pid, Process::WNOHANG) #=> nil + * Time.now #=> 2008-03-08 19:56:16 +0900 + * Process::Status.wait(pid, 0) #=> pid 27440 exit 99 + * Time.now #=> 2008-03-08 19:56:19 +0900 + * + * This is an EXPERIMENTAL FEATURE. + */ + +VALUE +rb_process_status_waitv(int argc, VALUE *argv, VALUE _) +{ + rb_check_arity(argc, 0, 2); + + rb_pid_t pid = -1; + int flags = 0; + + if (argc >= 1) { + pid = NUM2PIDT(argv[0]); + } + + if (argc >= 2) { + flags = RB_NUM2INT(argv[1]); + } + + return rb_process_status_wait(pid, flags); } rb_pid_t rb_waitpid(rb_pid_t pid, int *st, int flags) { - rb_pid_t result; + VALUE status = rb_process_status_wait(pid, flags); + if (NIL_P(status)) return 0; + + struct rb_process_status *data = RTYPEDDATA_DATA(status); + pid = data->pid; - if (flags & WNOHANG) { - result = do_waitpid(pid, st, flags); + if (st) *st = data->status; + + if (pid == -1) { + errno = data->error; } else { - while ((result = do_waitpid_nonblocking(pid, st, flags)) < 0 && - (errno == EINTR)) { - rb_thread_t *th = GET_THREAD(); - RUBY_VM_CHECK_INTS(th); - } + GET_THREAD()->last_status = status; } - if (result > 0) { - rb_last_status_set(*st, result); - } - return result; + + return pid; } +static VALUE +proc_wait(int argc, VALUE *argv) +{ + rb_pid_t pid; + int flags, status; + + flags = 0; + if (rb_check_arity(argc, 0, 2) == 0) { + pid = -1; + } + else { + VALUE vflags; + pid = NUM2PIDT(argv[0]); + if (argc == 2 && !NIL_P(vflags = argv[1])) { + flags = NUM2UINT(vflags); + } + } + + if ((pid = rb_waitpid(pid, &status, flags)) < 0) + rb_sys_fail(0); + + if (pid == 0) { + rb_last_status_clear(); + return Qnil; + } + + return PIDT2NUM(pid); +} /* [MG]:FIXME: I wasn't sure how this should be done, since ::wait() has historically been documented as if it didn't take any arguments @@ -941,7 +1503,7 @@ rb_waitpid(rb_pid_t pid, int *st, int flags) * 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 + * sets <code>$?</code> to a Process::Status object * containing information on that process. Which child it waits on * depends on the value of _pid_: * @@ -957,8 +1519,8 @@ rb_waitpid(rb_pid_t pid, int *st, int flags) * 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 + * Process::WNOHANG (do not block if no child available) + * or Process::WUNTRACED (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. * @@ -979,29 +1541,9 @@ rb_waitpid(rb_pid_t pid, int *st, int flags) */ static VALUE -proc_wait(int argc, VALUE *argv) +proc_m_wait(int c, VALUE *v, VALUE _) { - 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); + return proc_wait(c, v); } @@ -1012,7 +1554,7 @@ proc_wait(int argc, VALUE *argv) * * 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 + * exit status (a Process::Status object) of that * child. Raises a SystemCallError if there are no child processes. * * Process.fork { exit 99 } #=> 27437 @@ -1022,7 +1564,7 @@ proc_wait(int argc, VALUE *argv) */ static VALUE -proc_wait2(int argc, VALUE *argv) +proc_wait2(int argc, VALUE *argv, VALUE _) { VALUE pid = proc_wait(argc, argv); if (NIL_P(pid)) return Qnil; @@ -1036,7 +1578,7 @@ proc_wait2(int argc, VALUE *argv) * * Waits for all children, returning an array of * _pid_/_status_ pairs (where _status_ is a - * <code>Process::Status</code> object). + * Process::Status object). * * fork { sleep 0.2; exit 2 } #=> 27432 * fork { sleep 0.1; exit 1 } #=> 27433 @@ -1051,7 +1593,7 @@ proc_wait2(int argc, VALUE *argv) */ static VALUE -proc_waitall(void) +proc_waitall(VALUE _) { VALUE result; rb_pid_t pid; @@ -1111,18 +1653,17 @@ rb_detach_process(rb_pid_t pid) * 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. + * 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. Use #detach only when you do not intend to explicitly + * wait for the child to terminate. * * The waiting thread returns the exit status of the detached process - * when it terminates, so you can use <code>Thread#join</code> to + * when it terminates, so you can use Thread#join to * know the result. If specified _pid_ is not a valid child process * ID, the thread returns +nil+ immediately. * - * The waiting thread has <code>pid</code> method which returns the pid. + * The waiting thread has #pid method which returns the pid. * * In this first example, we don't reap the first child process, so * it appears as a zombie in the process status display. @@ -1137,7 +1678,7 @@ rb_detach_process(rb_pid_t pid) * * 27389 Z * - * In the next example, <code>Process::detach</code> is used to reap + * In the next example, Process::detach is used to reap * the child automatically. * * p1 = fork { sleep 0.1 } @@ -1177,6 +1718,39 @@ 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) +{ + /* 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 */ + } +} + static void before_exec(void) { @@ -1204,25 +1778,25 @@ after_exec(void) 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" +#if defined HAVE_WORKING_FORK || defined HAVE_DAEMON +static void +before_fork_ruby(void) +{ + before_exec(); +} static void -security(const char *str) +after_fork_ruby(void) { - if (rb_env_path_tainted()) { - if (rb_safe_level() > 0) { - rb_raise(rb_eSecurityError, "Insecure PATH - %s", str); - } - } + rb_threadptr_pending_interrupt_clear(GET_THREAD()); + after_exec(); } +#endif -#if defined(HAVE_WORKING_FORK) && !defined(__native_client__) +#if defined(HAVE_WORKING_FORK) /* try_with_sh and exec_with_sh should be async-signal-safe. Actually it is.*/ -#define try_with_sh(prog, argv, envp) ((saved_errno == ENOEXEC) ? exec_with_sh((prog), (argv), (envp)) : (void)0) +#define try_with_sh(err, prog, argv, envp) ((err == ENOEXEC) ? exec_with_sh((prog), (argv), (envp)) : (void)0) static void exec_with_sh(const char *prog, char **argv, char **envp) { @@ -1235,40 +1809,37 @@ exec_with_sh(const char *prog, char **argv, char **envp) } #else -#define try_with_sh(prog, argv, envp) (void)0 +#define try_with_sh(err, prog, argv, envp) (void)0 #endif /* This function should be async-signal-safe. Actually it is. */ static int proc_exec_cmd(const char *prog, VALUE argv_str, VALUE envp_str) { -#ifdef __native_client__ - rb_notimplement(); - UNREACHABLE; -#else char **argv; #ifndef _WIN32 char **envp; + int err; #endif argv = ARGVSTR2ARGV(argv_str); if (!prog) { - errno = ENOENT; - return -1; + return ENOENT; } #ifdef _WIN32 rb_w32_uaspawn(P_OVERLAY, prog, argv); + return errno; #else - envp = envp_str ? (char **)RSTRING_PTR(envp_str) : NULL; + envp = envp_str ? RB_IMEMO_TMPBUF_PTR(envp_str) : NULL; if (envp_str) execve(prog, argv, envp); /* async-signal-safe */ else execv(prog, argv); /* async-signal-safe (since SUSv4) */ - preserving_errno(try_with_sh(prog, argv, envp)); /* try_with_sh() is async-signal-safe. */ -#endif - return -1; + err = errno; + try_with_sh(err, prog, argv, envp); /* try_with_sh() is async-signal-safe. */ + return err; #endif } @@ -1276,10 +1847,6 @@ proc_exec_cmd(const char *prog, VALUE argv_str, VALUE envp_str) static int proc_exec_sh(const char *str, VALUE envp_str) { -#ifdef __native_client__ - rb_notimplement(); - UNREACHABLE; -#else const char *s; s = str; @@ -1287,15 +1854,12 @@ proc_exec_sh(const char *str, VALUE envp_str) s++; if (!*s) { - errno = ENOENT; - return -1; + return ENOENT; } #ifdef _WIN32 rb_w32_uspawn(P_OVERLAY, (char *)str, 0); - return -1; -#else -#if defined(__CYGWIN32__) +#elif defined(__CYGWIN32__) { char fbuf[MAXPATHLEN]; char *shell = dln_find_exe_r("sh", 0, fbuf, sizeof(fbuf)); @@ -1309,13 +1873,11 @@ proc_exec_sh(const char *str, VALUE envp_str) } #else if (envp_str) - execle("/bin/sh", "sh", "-c", str, (char *)NULL, (char **)RSTRING_PTR(envp_str)); /* async-signal-safe */ + execle("/bin/sh", "sh", "-c", str, (char *)NULL, RB_IMEMO_TMPBUF_PTR(envp_str)); /* async-signal-safe */ else execl("/bin/sh", "sh", "-c", str, (char *)NULL); /* async-signal-safe (since SUSv4) */ -#endif - return -1; #endif /* _WIN32 */ -#endif + return errno; } int @@ -1324,8 +1886,9 @@ rb_proc_exec(const char *str) int ret; before_exec(); ret = proc_exec_sh(str, Qfalse); - preserving_errno(after_exec()); - return ret; + after_exec(); + errno = ret; + return -1; } static void @@ -1405,7 +1968,6 @@ proc_spawn_cmd_internal(char **argv, char *prog) if (!prog) prog = argv[0]; - security(prog); prog = dln_find_exe_r(prog, 0, fbuf, sizeof(fbuf)); if (!prog) return -1; @@ -1486,7 +2048,7 @@ check_exec_redirect_fd(VALUE v, int iskey) else goto wrong; } - else if (!NIL_P(tmp = rb_check_convert_type(v, T_FILE, "IO", "to_io"))) { + else if (!NIL_P(tmp = rb_io_check_io(v))) { rb_io_t *fptr; GetOpenFile(tmp, fptr); if (fptr->tied_io_for_writing) @@ -1494,8 +2056,7 @@ check_exec_redirect_fd(VALUE v, int iskey) fd = fptr->fd; } else { - wrong: - rb_raise(rb_eArgError, "wrong exec redirect"); + goto wrong; } if (fd < 0) { rb_raise(rb_eArgError, "negative file descriptor"); @@ -1506,6 +2067,10 @@ check_exec_redirect_fd(VALUE v, int iskey) } #endif return INT2FIX(fd); + + wrong: + rb_raise(rb_eArgError, "wrong exec redirect"); + UNREACHABLE_RETURN(Qundef); } static VALUE @@ -1519,12 +2084,11 @@ check_exec_redirect1(VALUE ary, VALUE key, VALUE param) rb_ary_push(ary, hide_obj(rb_assoc_new(fd, param))); } else { - int i, n=0; + int i; for (i = 0 ; i < RARRAY_LEN(key); i++) { VALUE v = RARRAY_AREF(key, i); VALUE fd = check_exec_redirect_fd(v, !NIL_P(param)); rb_ary_push(ary, hide_obj(rb_assoc_new(fd, param))); - n++; } } return ary; @@ -1540,7 +2104,7 @@ check_exec_redirect(VALUE key, VALUE val, struct rb_execarg *eargp) switch (TYPE(val)) { case T_SYMBOL: - if (!(id = rb_check_id(&val))) goto wrong_symbol; + id = rb_check_id(&val); if (id == id_close) { param = Qnil; eargp->fd_close = check_exec_redirect1(eargp->fd_close, key, param); @@ -1558,7 +2122,6 @@ check_exec_redirect(VALUE key, VALUE val, struct rb_execarg *eargp) eargp->fd_dup2 = check_exec_redirect1(eargp->fd_dup2, key, param); } else { - wrong_symbol: rb_raise(rb_eArgError, "wrong exec redirect symbol: %"PRIsVALUE, val); } @@ -1607,7 +2170,7 @@ check_exec_redirect(VALUE key, VALUE val, struct rb_execarg *eargp) else if (RB_TYPE_P(key, T_ARRAY)) { int i; for (i = 0; i < RARRAY_LEN(key); i++) { - VALUE v = RARRAY_PTR(key)[i]; + VALUE v = RARRAY_AREF(key, i); VALUE fd = check_exec_redirect_fd(v, 1); if (FIX2INT(fd) != 1 && FIX2INT(fd) != 2) break; } @@ -1665,6 +2228,7 @@ rb_execarg_addopt_rlimit(struct rb_execarg *eargp, int rtype, VALUE val) } #endif +#define TO_BOOL(val, name) NIL_P(val) ? 0 : rb_bool_expected((val), name) int rb_execarg_addopt(VALUE execarg_obj, VALUE key, VALUE val) { @@ -1712,7 +2276,7 @@ rb_execarg_addopt(VALUE execarg_obj, VALUE key, VALUE val) rb_raise(rb_eArgError, "new_pgroup option specified twice"); } eargp->new_pgroup_given = 1; - eargp->new_pgroup_flag = RTEST(val) ? 1 : 0; + eargp->new_pgroup_flag = TO_BOOL(val, "new_pgroup"); } else #endif @@ -1721,7 +2285,7 @@ rb_execarg_addopt(VALUE execarg_obj, VALUE key, VALUE val) rb_raise(rb_eArgError, "unsetenv_others option specified twice"); } eargp->unsetenv_others_given = 1; - eargp->unsetenv_others_do = RTEST(val) ? 1 : 0; + eargp->unsetenv_others_do = TO_BOOL(val, "unsetenv_others"); } else if (id == id_chdir) { if (eargp->chdir_given) { @@ -1745,7 +2309,7 @@ rb_execarg_addopt(VALUE execarg_obj, VALUE key, VALUE val) rb_raise(rb_eArgError, "close_others option specified twice"); } eargp->close_others_given = 1; - eargp->close_others_do = RTEST(val) ? 1 : 0; + eargp->close_others_do = TO_BOOL(val, "close_others"); } else if (id == id_in) { key = INT2FIX(0); @@ -1789,6 +2353,13 @@ rb_execarg_addopt(VALUE execarg_obj, VALUE key, VALUE val) "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; } @@ -1921,7 +2492,7 @@ rb_check_exec_options(VALUE opthash, VALUE execarg_obj) { if (RHASH_EMPTY_P(opthash)) return; - st_foreach(rb_hash_tbl_raw(opthash), check_exec_options_i, (st_data_t)execarg_obj); + rb_hash_stlike_foreach(opthash, check_exec_options_i, (st_data_t)execarg_obj); } VALUE @@ -1932,7 +2503,7 @@ rb_execarg_extract_options(VALUE execarg_obj, VALUE opthash) return Qnil; args[0] = execarg_obj; args[1] = Qnil; - st_foreach(rb_hash_tbl_raw(opthash), check_exec_options_i_extract, (st_data_t)args); + rb_hash_stlike_foreach(opthash, check_exec_options_i_extract, (st_data_t)args); return args[1]; } @@ -1953,7 +2524,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 : %s", k); + rb_raise(rb_eArgError, "environment name contains a equal : %"PRIsVALUE, key); if (!NIL_P(val)) StringValueCStr(val); @@ -1976,7 +2547,7 @@ rb_check_exec_env(VALUE hash, VALUE *path) env[0] = hide_obj(rb_ary_new()); env[1] = Qfalse; - st_foreach(rb_hash_tbl_raw(hash), check_exec_env_i, (st_data_t)env); + rb_hash_stlike_foreach(hash, check_exec_env_i, (st_data_t)env); *path = env[1]; return env[0]; @@ -1987,7 +2558,6 @@ rb_check_argv(int argc, VALUE *argv) { VALUE tmp, prog; int i; - const char *name = 0; rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS); @@ -2002,14 +2572,12 @@ rb_check_argv(int argc, VALUE *argv) SafeStringValue(prog); StringValueCStr(prog); prog = rb_str_new_frozen(prog); - name = RSTRING_PTR(prog); } for (i = 0; i < argc; i++) { SafeStringValue(argv[i]); argv[i] = rb_str_new_frozen(argv[i]); StringValueCStr(argv[i]); } - security(name ? name : RSTRING_PTR(argv[0])); return prog; } @@ -2021,6 +2589,8 @@ check_hash(VALUE obj) case T_STRING: case T_ARRAY: return Qnil; + default: + break; } return rb_check_hash_type(obj); } @@ -2202,7 +2772,9 @@ rb_exec_fillarg(VALUE prog, int argc, VALUE *argv, VALUE env, VALUE opthash, VAL } } eargp->invoke.cmd.argv_buf = argv_buf; - eargp->invoke.cmd.command_name = hide_obj(rb_str_new_cstr(RSTRING_PTR(argv_buf))); + eargp->invoke.cmd.command_name = + hide_obj(rb_str_subseq(argv_buf, 0, strlen(RSTRING_PTR(argv_buf)))); + rb_enc_copy(eargp->invoke.cmd.command_name, prog); } } #endif @@ -2248,22 +2820,12 @@ rb_exec_fillarg(VALUE prog, int argc, VALUE *argv, VALUE env, VALUE opthash, VAL p += strlen(p) + 1; } rb_str_buf_cat(argv_str, (char *)&null, sizeof(null)); /* terminator for execve. */ - eargp->invoke.cmd.argv_str = argv_str; + eargp->invoke.cmd.argv_str = + rb_imemo_tmpbuf_auto_free_pointer_new_from_an_RString(argv_str); } RB_GC_GUARD(execarg_obj); } -VALUE -rb_execarg_new(int argc, const VALUE *argv, int accept_shell) -{ - VALUE execarg_obj; - struct rb_execarg *eargp; - execarg_obj = TypedData_Make_Struct(rb_cData, struct rb_execarg, &exec_arg_data_type, eargp); - hide_obj(execarg_obj); - rb_execarg_init(argc, argv, accept_shell, execarg_obj); - return execarg_obj; -} - struct rb_execarg * rb_execarg_get(VALUE execarg_obj) { @@ -2272,7 +2834,7 @@ rb_execarg_get(VALUE execarg_obj) return eargp; } -VALUE +static VALUE rb_execarg_init(int argc, const VALUE *orig_argv, int accept_shell, VALUE execarg_obj) { struct rb_execarg *eargp = rb_execarg_get(execarg_obj); @@ -2289,6 +2851,19 @@ 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) { @@ -2333,6 +2908,14 @@ open_func(void *ptr) return NULL; } +static void +rb_execarg_allocate_dup2_tmpbuf(struct rb_execarg *eargp, long len) +{ + VALUE tmpbuf = rb_imemo_tmpbuf_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) { @@ -2350,13 +2933,11 @@ rb_execarg_parent_start1(VALUE execarg_obj) VALUE param = RARRAY_AREF(elt, 1); VALUE vpath = RARRAY_AREF(param, 0); int flags = NUM2INT(RARRAY_AREF(param, 1)); - int perm = NUM2INT(RARRAY_AREF(param, 2)); + mode_t perm = NUM2MODET(RARRAY_AREF(param, 2)); VALUE fd2v = RARRAY_AREF(param, 3); int fd2; if (NIL_P(fd2v)) { struct open_struct open_data; - FilePathValue(vpath); - vpath = rb_str_encode_ospath(vpath); again: open_data.fname = vpath; open_data.oflags = flags; @@ -2387,10 +2968,7 @@ rb_execarg_parent_start1(VALUE execarg_obj) ary = eargp->fd_dup2; if (ary != Qfalse) { - size_t len = run_exec_dup2_tmpbuf_size(RARRAY_LEN(ary)); - VALUE tmpbuf = hide_obj(rb_str_new(0, len)); - rb_str_set_len(tmpbuf, len); - eargp->dup2_tmpbuf = tmpbuf; + rb_execarg_allocate_dup2_tmpbuf(eargp, RARRAY_LEN(ary)); } unsetenv_others = eargp->unsetenv_others_given && eargp->unsetenv_others_do; @@ -2402,8 +2980,7 @@ rb_execarg_parent_start1(VALUE execarg_obj) envtbl = rb_hash_new(); } else { - envtbl = rb_const_get(rb_cObject, id_ENV); - envtbl = rb_convert_type(envtbl, T_HASH, "Hash", "to_hash"); + envtbl = rb_env_to_hash(); } hide_obj(envtbl); if (envopts != Qfalse) { @@ -2426,7 +3003,7 @@ rb_execarg_parent_start1(VALUE execarg_obj) } envp_buf = rb_str_buf_new(0); hide_obj(envp_buf); - st_foreach(RHASH_TBL_RAW(envtbl), fill_envp_buf_i, (st_data_t)envp_buf); + rb_hash_stlike_foreach(envtbl, fill_envp_buf_i, (st_data_t)envp_buf); envp_str = rb_str_buf_new(sizeof(char*) * (RHASH_SIZE(envtbl) + 1)); hide_obj(envp_str); p = RSTRING_PTR(envp_buf); @@ -2437,7 +3014,8 @@ rb_execarg_parent_start1(VALUE execarg_obj) } p = NULL; rb_str_buf_cat(envp_str, (char *)&p, sizeof(p)); - eargp->envp_str = envp_str; + eargp->envp_str = + rb_imemo_tmpbuf_auto_free_pointer_new_from_an_RString(envp_str); eargp->envp_buf = envp_buf; /* @@ -2519,6 +3097,40 @@ 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); + if (mjit_enabled) mjit_finish(false); // avoid leaking resources, and do not leave files. XXX: JIT-ed handle can leak after exec error is rescued. + before_exec(); /* stop timer thread before redirects */ + + rb_protect(rb_execarg_parent_start1, execarg_obj, &state); + if (state) { + execarg_parent_end(execarg_obj); + after_exec(); /* restart timer thread */ + rb_jump_tag(state); + } + + fail_str = eargp->use_shell ? eargp->invoke.sh.shell_script : eargp->invoke.cmd.command_name; + + err = exec_async_signal_safe(eargp, errmsg, sizeof(errmsg)); + after_exec(); /* restart timer thread */ + + rb_exec_fail(eargp, err, errmsg); + RB_GC_GUARD(execarg_obj); + rb_syserr_fail_str(err, fail_str); + UNREACHABLE_RETURN(Qnil); +} + +NORETURN(static VALUE f_exec(int c, const VALUE *a, VALUE _)); + /* * call-seq: * exec([env,] command... [,options]) @@ -2537,14 +3149,15 @@ rb_execarg_fail(VALUE execarg_obj, int err, const char *errmsg) * shell expansion before being executed. * * 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. + * otherwise, <code>ENV["RUBYSHELL"]</code> or <code>ENV["COMSPEC"]</code> on + * Windows and similar. The command is passed as an argument to the + * <code>"-c"</code> switch to the shell, except in the case of +COMSPEC+. * * If the string from the first form (<code>exec("command")</code>) follows * these simple rules: * * * no meta characters - * * no shell reserved word and no special built-in + * * not starting with shell reserved word or special built-in * * Ruby invokes the command directly without shell * * You can force shell invocation by adding ";" to the string (because ";" is @@ -2570,7 +3183,7 @@ rb_execarg_fail(VALUE execarg_obj, int err, const char *errmsg) * This behavior is modified by the given +env+ and +options+ parameters. See * ::spawn for details. * - * If the command fails to execute (typically <code>Errno::ENOENT</code> when + * If the command fails to execute (typically Errno::ENOENT when * it was not found) a SystemCallError exception is raised. * * This method modifies process attributes according to given +options+ before @@ -2592,30 +3205,11 @@ rb_execarg_fail(VALUE execarg_obj, int err, const char *errmsg) * # never get here */ -VALUE -rb_f_exec(int argc, const VALUE *argv) +static VALUE +f_exec(int c, const VALUE *a, VALUE _) { - VALUE execarg_obj, fail_str; - struct rb_execarg *eargp; -#define CHILD_ERRMSG_BUFLEN 80 - char errmsg[CHILD_ERRMSG_BUFLEN] = { '\0' }; - int err; - - execarg_obj = rb_execarg_new(argc, argv, TRUE); - eargp = rb_execarg_get(execarg_obj); - before_exec(); /* stop timer thread before redirects */ - rb_execarg_parent_start(execarg_obj); - fail_str = eargp->use_shell ? eargp->invoke.sh.shell_script : eargp->invoke.cmd.command_name; - - rb_exec_async_signal_safe(eargp, errmsg, sizeof(errmsg)); - - err = errno; - after_exec(); /* restart timer thread */ - - rb_exec_fail(eargp, err, errmsg); - RB_GC_GUARD(execarg_obj); - rb_syserr_fail_str(err, fail_str); - UNREACHABLE; + rb_f_exec(c, a); + UNREACHABLE_RETURN(Qnil); } #define ERRMSG(str) do { if (errmsg && 0 < errmsg_buflen) strlcpy(errmsg, (str), errmsg_buflen); } while (0) @@ -2755,10 +3349,10 @@ run_exec_dup2(VALUE ary, VALUE tmpbuf, struct rb_execarg *sargp, char *errmsg, s long n, i; int ret; int extra_fd = -1; - struct run_exec_dup2_fd_pair *pairs = 0; + struct rb_imemo_tmpbuf_struct *buf = (void *)tmpbuf; + struct run_exec_dup2_fd_pair *pairs = (void *)buf->ptr; n = RARRAY_LEN(ary); - pairs = (struct run_exec_dup2_fd_pair *)RSTRING_PTR(tmpbuf); /* initialize oldfd and newfd: O(n) */ for (i = 0; i < n; i++) { @@ -2998,7 +3592,7 @@ save_env(struct rb_execarg *sargp) if (!sargp) return; if (sargp->env_modification == Qfalse) { - VALUE env = rb_const_get(rb_cObject, id_ENV); + VALUE env = rb_envtbl(); if (RTEST(env)) { VALUE ary = hide_obj(rb_ary_new()); rb_block_call(env, idEach, 0, 0, save_env_i, @@ -3091,7 +3685,7 @@ rb_execarg_run_options(const struct rb_execarg *eargp, struct rb_execarg *sargp, } #ifdef HAVE_WORKING_FORK - if (!eargp->close_others_given || eargp->close_others_do) { + if (eargp->close_others_do) { rb_close_before_exec(3, eargp->close_others_maxhint, eargp->redirect_fds); /* async-signal-safe */ } #endif @@ -3104,10 +3698,8 @@ rb_execarg_run_options(const struct rb_execarg *eargp, struct rb_execarg *sargp, if (eargp->chdir_given) { if (sargp) { - char *cwd = my_getcwd(); sargp->chdir_given = 1; - sargp->chdir_dir = hide_obj(rb_str_new2(cwd)); - xfree(cwd); + sargp->chdir_dir = hide_obj(rb_dir_getwd_ospath()); } if (chdir(RSTRING_PTR(eargp->chdir_dir)) == -1) { /* async-signal-safe */ ERRMSG("chdir"); @@ -3135,12 +3727,14 @@ rb_execarg_run_options(const struct rb_execarg *eargp, struct rb_execarg *sargp, if (sargp) { VALUE ary = sargp->fd_dup2; if (ary != Qfalse) { - size_t len = run_exec_dup2_tmpbuf_size(RARRAY_LEN(ary)); - VALUE tmpbuf = hide_obj(rb_str_new(0, len)); - rb_str_set_len(tmpbuf, len); - sargp->dup2_tmpbuf = tmpbuf; + rb_execarg_allocate_dup2_tmpbuf(sargp, RARRAY_LEN(ary)); } } + { + int preserve = errno; + stdfd_clear_nonblock(); + errno = preserve; + } return 0; } @@ -3149,31 +3743,38 @@ rb_execarg_run_options(const struct rb_execarg *eargp, struct rb_execarg *sargp, int rb_exec_async_signal_safe(const struct rb_execarg *eargp, char *errmsg, size_t errmsg_buflen) { + errno = exec_async_signal_safe(eargp, errmsg, errmsg_buflen); + return -1; +} + +static int +exec_async_signal_safe(const struct rb_execarg *eargp, char *errmsg, size_t errmsg_buflen) +{ #if !defined(HAVE_WORKING_FORK) struct rb_execarg sarg, *const sargp = &sarg; #else struct rb_execarg *const sargp = NULL; #endif + int err; if (rb_execarg_run_options(eargp, sargp, errmsg, errmsg_buflen) < 0) { /* hopefully async-signal-safe */ - goto failure; + return errno; } if (eargp->use_shell) { - proc_exec_sh(RSTRING_PTR(eargp->invoke.sh.shell_script), eargp->envp_str); /* async-signal-safe */ + err = proc_exec_sh(RSTRING_PTR(eargp->invoke.sh.shell_script), eargp->envp_str); /* async-signal-safe */ } else { char *abspath = NULL; if (!NIL_P(eargp->invoke.cmd.command_abspath)) abspath = RSTRING_PTR(eargp->invoke.cmd.command_abspath); - proc_exec_cmd(abspath, eargp->invoke.cmd.argv_str, eargp->envp_str); /* async-signal-safe */ + err = proc_exec_cmd(abspath, eargp->invoke.cmd.argv_str, eargp->envp_str); /* async-signal-safe */ } #if !defined(HAVE_WORKING_FORK) - preserving_errno(rb_execarg_run_options(sargp, NULL, errmsg, errmsg_buflen)); + rb_execarg_run_options(sargp, NULL, errmsg, errmsg_buflen); #endif -failure: - return -1; + return err; } #ifdef HAVE_WORKING_FORK @@ -3183,9 +3784,7 @@ 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 @@ -3243,12 +3842,19 @@ pipe_nocrash(int filedes[2], VALUE fds) #define O_BINARY 0 #endif +static VALUE +rb_thread_sleep_that_takes_VALUE_as_sole_argument(VALUE n) +{ + rb_thread_sleep(NUM2INT(n)); + return Qundef; +} + static int -handle_fork_error(int *status, int *ep, volatile int *try_gc_p) +handle_fork_error(int err, struct rb_process_status *status, int *ep, volatile int *try_gc_p) { int state = 0; - switch (errno) { + switch (err) { case ENOMEM: if ((*try_gc_p)-- > 0 && !rb_during_gc()) { rb_gc(); @@ -3264,14 +3870,16 @@ handle_fork_error(int *status, int *ep, volatile int *try_gc_p) return 0; } else { - rb_protect((VALUE (*)())rb_thread_sleep, 1, &state); - if (status) *status = state; + rb_protect(rb_thread_sleep_that_takes_VALUE_as_sole_argument, INT2FIX(1), &state); + if (status) status->status = state; if (!state) return 0; } break; } if (ep) { - preserving_errno((close(ep[0]), close(ep[1]))); + close(ep[0]); + close(ep[1]); + errno = err; } if (state && !status) rb_jump_tag(state); return -1; @@ -3325,6 +3933,12 @@ 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); } while (r < 0 && errno == EINTR); @@ -3470,16 +4084,15 @@ 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"); @@ -3491,28 +4104,14 @@ disable_child_handler_before_fork(struct child_handler_disabler_state *old) #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"); @@ -3530,26 +4129,28 @@ 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); + 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; - } + 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"); @@ -3559,24 +4160,32 @@ disable_child_handler_fork_child(struct child_handler_disabler_state *old, char } static rb_pid_t -retry_fork_async_signal_safe(int *status, int *ep, +retry_fork_async_signal_safe(struct rb_process_status *status, int *ep, int (*chfunc)(void*, char *, size_t), void *charg, - char *errmsg, size_t errmsg_buflen) + char *errmsg, size_t errmsg_buflen, + struct waitpid_state *w) { rb_pid_t pid; volatile int try_gc = 1; struct child_handler_disabler_state old; + int err; + rb_nativethread_lock_t *const volatile waitpid_lock_init = + (w && WAITPID_USE_SIGCHLD) ? &GET_VM()->waitpid_lock : 0; while (1) { + rb_nativethread_lock_t *waitpid_lock = waitpid_lock_init; prefork(); disable_child_handler_before_fork(&old); + if (waitpid_lock) { + rb_native_mutex_lock(waitpid_lock); + } #ifdef HAVE_WORKING_VFORK if (!has_privilege()) pid = vfork(); else - pid = fork(); + pid = rb_fork(); #else - pid = fork(); + pid = rb_fork(); #endif if (pid == 0) {/* fork succeed, child process */ int ret; @@ -3593,105 +4202,197 @@ retry_fork_async_signal_safe(int *status, int *ep, _exit(127); #endif } - preserving_errno(disable_child_handler_fork_parent(&old)); + err = errno; + waitpid_lock = waitpid_lock_init; + if (waitpid_lock) { + if (pid > 0 && w != WAITPID_LOCK_ONLY) { + w->pid = pid; + list_add(&GET_VM()->waiting_pids, &w->wnode); + } + rb_native_mutex_unlock(waitpid_lock); + } + disable_child_handler_fork_parent(&old); if (0 < pid) /* fork succeed, parent process */ return pid; /* fork failed */ - if (handle_fork_error(status, ep, &try_gc)) + if (handle_fork_error(err, status, ep, &try_gc)) return -1; } } -rb_pid_t -rb_fork_async_signal_safe(int *status, int (*chfunc)(void*, char *, size_t), void *charg, VALUE fds, - char *errmsg, size_t errmsg_buflen) +static rb_pid_t +fork_check_err(struct rb_process_status *status, int (*chfunc)(void*, char *, size_t), void *charg, + VALUE fds, char *errmsg, size_t errmsg_buflen, + struct rb_execarg *eargp) { rb_pid_t pid; int err; int ep[2]; int error_occurred; - if (status) *status = 0; + struct waitpid_state *w = eargp && eargp->waitpid_state ? eargp->waitpid_state : 0; + + if (status) status->status = 0; if (pipe_nocrash(ep, fds)) return -1; - pid = retry_fork_async_signal_safe(status, ep, chfunc, charg, errmsg, errmsg_buflen); - if (pid < 0) + + pid = retry_fork_async_signal_safe(status, ep, chfunc, charg, errmsg, errmsg_buflen, w); + + if (status) status->pid = pid; + + if (pid < 0) { + if (status) status->error = errno; + return pid; + } + close(ep[1]); + error_occurred = recv_child_error(ep[0], &err, errmsg, errmsg_buflen); + if (error_occurred) { if (status) { - rb_protect(proc_syswait, (VALUE)pid, status); + int state = 0; + status->error = err; + + VM_ASSERT((w == 0 || w == WAITPID_LOCK_ONLY) && + "only used by extensions"); + rb_protect(proc_syswait, (VALUE)pid, &state); + + status->status = state; } - else { + else if (!w || w == WAITPID_LOCK_ONLY) { 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 MJIT, 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; +} + static rb_pid_t -retry_fork_ruby(int *status, struct child_handler_disabler_state *old) +rb_fork_ruby2(struct rb_process_status *status) { rb_pid_t pid; - int try_gc = 1; + int try_gc = 1, err; + struct child_handler_disabler_state old; + + if (status) status->status = 0; while (1) { prefork(); + if (mjit_enabled) mjit_pause(false); // Don't leave locked mutex to child. Note: child_handler must be enabled to pause MJIT. + disable_child_handler_before_fork(&old); before_fork_ruby(); - disable_child_handler_before_fork(old); - pid = fork(); - if (pid == 0) /* fork succeed, child process */ - return pid; - preserving_errno(after_fork_ruby()); - preserving_errno(disable_child_handler_fork_parent(old)); - if (0 < pid) /* fork succeed, parent process */ + pid = rb_fork(); + err = errno; + if (status) { + status->pid = pid; + status->error = err; + } + after_fork_ruby(); + disable_child_handler_fork_parent(&old); /* yes, bad name */ + + if (mjit_enabled && pid > 0) mjit_resume(); /* child (pid == 0) is cared by rb_thread_atfork */ + + if (pid >= 0) { /* fork succeed */ + if (pid == 0) rb_thread_atfork(); return pid; + } + /* fork failed */ - if (handle_fork_error(status, NULL, &try_gc)) + if (handle_fork_error(err, status, NULL, &try_gc)) { return -1; + } } } rb_pid_t rb_fork_ruby(int *status) { - rb_pid_t pid; - struct child_handler_disabler_state old; + struct rb_process_status process_status = {0}; - if (status) *status = 0; + rb_pid_t pid = rb_fork_ruby2(&process_status); + + if (status) *status = process_status.status; - pid = retry_fork_ruby(status, &old); - if (pid < 0) - return pid; - if (!pid) { - after_fork_ruby(); - disable_child_handler_fork_parent(&old); /* yes, bad name */ - } return pid; } +rb_pid_t +rb_call_proc__fork(void) +{ + VALUE pid = rb_funcall(rb_mProcess, rb_intern("_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. + */ +VALUE +rb_proc__fork(VALUE _obj) +{ + rb_pid_t pid = rb_fork_ruby(NULL); + + if (pid == -1) { + rb_sys_fail("fork(2)"); + } + + return PIDT2NUM(pid); +} + +/* + * call-seq: * 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. + * 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 + * Kernel.exit! to avoid running any <code>at_exit</code> + * functions. The parent process should use Process.wait to collect + * the termination statuses of its children or use Process.detach 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. @@ -3707,25 +4408,21 @@ rb_f_fork(VALUE obj) { rb_pid_t pid; - switch (pid = rb_fork_ruby(NULL)) { - case 0: - rb_thread_atfork(); + pid = rb_call_proc__fork(); + + if (pid == 0) { 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; - - default: - return PIDT2NUM(pid); } + + return PIDT2NUM(pid); } #else +#define rb_proc__fork rb_f_notimplement #define rb_f_fork rb_f_notimplement #endif @@ -3752,6 +4449,7 @@ exit_status_code(VALUE status) return istatus; } +NORETURN(static VALUE rb_f_exit_bang(int argc, VALUE *argv, VALUE obj)); /* * call-seq: * Process.exit!(status=false) @@ -3776,13 +4474,13 @@ rb_f_exit_bang(int argc, VALUE *argv, VALUE obj) } _exit(istatus); - UNREACHABLE; + UNREACHABLE_RETURN(Qnil); } void rb_exit(int status) { - if (GET_THREAD()->tag) { + if (GET_EC()->tag) { VALUE args[2]; args[0] = INT2NUM(status); @@ -3792,7 +4490,23 @@ rb_exit(int status) ruby_stop(status); } +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]); + } + else { + istatus = EXIT_SUCCESS; + } + rb_exit(istatus); + + UNREACHABLE_RETURN(Qnil); +} +NORETURN(static VALUE f_exit(int c, const VALUE *a, VALUE _)); /* * call-seq: * exit(status=true) @@ -3800,7 +4514,7 @@ rb_exit(int status) * Process::exit(status=true) * * Initiates the termination of the Ruby script by raising the - * <code>SystemExit</code> exception. This exception may be caught. The + * SystemExit 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 @@ -3820,9 +4534,9 @@ rb_exit(int status) * 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). + * 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" }) @@ -3834,22 +4548,39 @@ rb_exit(int status) * in finalizer */ -VALUE -rb_f_exit(int argc, const VALUE *argv) +static VALUE +f_exit(int c, const VALUE *a, VALUE _) { - int istatus; + rb_f_exit(c, a); + UNREACHABLE_RETURN(Qnil); +} - if (rb_check_arity(argc, 0, 1) == 1) { - istatus = exit_status_code(argv[0]); +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); } else { - istatus = EXIT_SUCCESS; + 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)); } - rb_exit(istatus); - UNREACHABLE; + UNREACHABLE_RETURN(Qnil); } +NORETURN(static VALUE f_abort(int c, const VALUE *a, VALUE _)); /* * call-seq: @@ -3862,27 +4593,11 @@ rb_f_exit(int argc, const VALUE *argv) * to STDERR prior to terminating. */ -VALUE -rb_f_abort(int argc, const VALUE *argv) +static VALUE +f_abort(int c, const VALUE *a, VALUE _) { - rb_check_arity(argc, 0, 1); - if (argc == 0) { - if (!NIL_P(GET_THREAD()->errinfo)) { - ruby_error_print(); - } - rb_exit(EXIT_FAILURE); - } - else { - VALUE args[2]; - - args[1] = args[0] = argv[0]; - StringValue(args[0]); - rb_io_puts(1, args, rb_stderr); - args[0] = INT2NUM(EXIT_FAILURE); - rb_exc_raise(rb_class_new_instance(2, args, rb_eSystemExit)); - } - - UNREACHABLE; + rb_f_abort(c, a); + UNREACHABLE_RETURN(Qnil); } void @@ -3893,7 +4608,7 @@ rb_syswait(rb_pid_t pid) rb_waitpid(pid, &status, 0); } -#if !defined HAVE_WORKING_FORK && !defined HAVE_SPAWNV +#if !defined HAVE_WORKING_FORK && !defined HAVE_SPAWNV && !defined __EMSCRIPTEN__ char * rb_execarg_commandline(const struct rb_execarg *eargp, VALUE *prog) { @@ -3929,7 +4644,7 @@ rb_spawn_process(struct rb_execarg *eargp, char *errmsg, size_t errmsg_buflen) #endif #if defined HAVE_WORKING_FORK && !USE_SPAWNV - pid = rb_fork_async_signal_safe(NULL, rb_exec_atfork, eargp, eargp->redirect_fds, errmsg, errmsg_buflen); + pid = fork_check_err(eargp->status, rb_exec_atfork, eargp, eargp->redirect_fds, errmsg, errmsg_buflen, eargp); #else prog = eargp->use_shell ? eargp->invoke.sh.shell_script : eargp->invoke.cmd.command_name; @@ -3943,30 +4658,37 @@ rb_spawn_process(struct rb_execarg *eargp, char *errmsg, size_t errmsg_buflen) } # if defined HAVE_SPAWNV if (eargp->use_shell) { - pid = proc_spawn_sh(RSTRING_PTR(prog)); + pid = proc_spawn_sh(RSTRING_PTR(prog)); } else { char **argv = ARGVSTR2ARGV(eargp->invoke.cmd.argv_str); - pid = proc_spawn_cmd(argv, prog, eargp); + pid = proc_spawn_cmd(argv, prog, eargp); + } + + if (pid == -1) { + rb_last_status_set(0x7f << 8, pid); } - 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 != WAITPID_LOCK_ONLY) { + 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; }; @@ -3983,6 +4705,15 @@ static rb_pid_t rb_execarg_spawn(VALUE execarg_obj, char *errmsg, size_t errmsg_buflen) { struct spawn_args args; + struct rb_execarg *eargp = rb_execarg_get(execarg_obj); + + /* + * Prevent a race with MJIT where the compiler process where + * can hold an FD of ours in between vfork + execve + */ + if (!eargp->waitpid_state && mjit_enabled) { + eargp->waitpid_state = WAITPID_LOCK_ONLY; + } args.execarg = execarg_obj; args.errmsg.ptr = errmsg; @@ -3996,7 +4727,7 @@ rb_spawn_internal(int argc, const VALUE *argv, char *errmsg, size_t errmsg_bufle { VALUE execarg_obj; - execarg_obj = rb_execarg_new(argc, argv, TRUE); + execarg_obj = rb_execarg_new(argc, argv, TRUE, FALSE); return rb_execarg_spawn(execarg_obj, errmsg, errmsg_buflen); } @@ -4014,25 +4745,31 @@ rb_spawn(int argc, const VALUE *argv) /* * call-seq: - * system([env,] command... [,options]) -> true, false or nil + * system([env,] command... [,options], exception: false) -> true, false or nil * * Executes _command..._ in a subshell. * _command..._ is one of following forms. * - * 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) + * [<code>commandline</code>] + * command line string which is passed to the standard shell + * [<code>cmdname, arg1, ...</code>] + * command name and one or more arguments (no shell) + * [<code>[cmdname, argv0], arg1, ...</code>] + * command name, <code>argv[0]</code> and zero or more arguments (no shell) * * 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>. + * + * If the <code>exception: true</code> argument is passed, the method + * raises an exception instead of returning +false+ or +nil+. + * * The arguments are processed in the same way as - * for <code>Kernel.spawn</code>. + * for Kernel#spawn. * - * The hash arguments, env and options, are same as - * <code>exec</code> and <code>spawn</code>. - * See <code>Kernel.spawn</code> for details. + * The hash arguments, env and options, are same as #exec and #spawn. + * See Kernel#spawn for details. * * system("echo *") * system("echo", "*") @@ -4042,43 +4779,81 @@ rb_spawn(int argc, const VALUE *argv) * config.h main.rb * * * - * See <code>Kernel.exec</code> for the standard shell. + * Error handling: + * + * system("cat nonexistent.txt") + * # => false + * system("catt nonexistent.txt") + * # => nil + * + * system("cat nonexistent.txt", exception: true) + * # RuntimeError (Command failed with exit 1: cat) + * system("catt nonexistent.txt", exception: true) + * # Errno::ENOENT (No such file or directory - catt) + * + * See Kernel#exec for the standard shell. */ static VALUE -rb_f_system(int argc, VALUE *argv) +rb_f_system(int argc, VALUE *argv, VALUE _) { - rb_pid_t pid; - int status; - -#if defined(SIGCLD) && !defined(SIGCHLD) -# define SIGCHLD SIGCLD -#endif + VALUE execarg_obj = rb_execarg_new(argc, argv, TRUE, TRUE); + struct rb_execarg *eargp = rb_execarg_get(execarg_obj); -#ifdef SIGCHLD - RETSIGTYPE (*chfunc)(int); + struct rb_process_status status = {0}; + eargp->status = &status; 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) + + // 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); + if (pid > 0) { - int ret, status; - ret = rb_waitpid(pid, &status, 0); - if (ret == (rb_pid_t)-1) - rb_sys_fail("Another thread waited the process started by system()."); + VALUE status = rb_process_status_wait(pid, 0); + struct rb_process_status *data = RTYPEDDATA_DATA(status); + + // Set the last status: + rb_obj_freeze(status); + GET_THREAD()->last_status = status; + + if (data->status == EXIT_SUCCESS) { + return Qtrue; + } + + if (data->error != 0) { + if (eargp->exception) { + VALUE command = eargp->invoke.sh.shell_script; + RB_GC_GUARD(execarg_obj); + rb_syserr_fail_str(data->error, command); + } + else { + return Qnil; + } + } + else if (eargp->exception) { + VALUE command = eargp->invoke.sh.shell_script; + VALUE str = rb_str_new_cstr("Command failed with"); + rb_str_cat_cstr(pst_message_status(str, data->status), ": "); + rb_str_append(str, command); + RB_GC_GUARD(execarg_obj); + rb_exc_raise(rb_exc_new_str(rb_eRuntimeError, str)); + } + else { + return Qfalse; + } + + RB_GC_GUARD(status); } -#endif -#ifdef SIGCHLD - signal(SIGCHLD, chfunc); -#endif - if (pid < 0) { - return Qnil; + + if (eargp->exception) { + VALUE command = eargp->invoke.sh.shell_script; + RB_GC_GUARD(execarg_obj); + rb_syserr_fail_str(errno, command); + } + else { + return Qnil; } - status = PST2INT(rb_last_status_get()); - if (status == EXIT_SUCCESS) return Qtrue; - return Qfalse; } /* @@ -4098,9 +4873,9 @@ rb_f_system(int argc, VALUE *argv) * to finish. * * The parent process should - * use <code>Process.wait</code> to collect + * use Process.wait to collect * the termination status of its child or - * use <code>Process.detach</code> to register + * use Process.detach to register * disinterest in their status; * otherwise, the operating system may accumulate zombie processes. * @@ -4150,17 +4925,18 @@ rb_f_system(int argc, VALUE *argv) * 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 + * :close_others => false : 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'. + * The <code>cmdname, arg1, ...</code> 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 <code>Process.spawn 'echo', '%Path%'</code> will + * display the contents of the <tt>%Path%</tt> environment variable + * on Windows, but <code>Process.spawn 'echo', '$PATH'</code> prints + * the literal <tt>$PATH</tt>. * * If a hash is given as +env+, the environment is * updated by +env+ before <code>exec(2)</code> in the child process. @@ -4230,12 +5006,12 @@ rb_f_system(int argc, VALUE *argv) * 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>. + * The hash keys specifies a file descriptor in the child process + * started by #spawn. * :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>. + * The hash values specifies a file descriptor in the parent process + * which invokes #spawn. * :out, 1 and STDOUT specifies the standard output stream (stdout). * * In the above example, @@ -4309,7 +5085,7 @@ rb_f_system(int argc, VALUE *argv) * pid = spawn(command, :close_others=>true) # close 3,4,5,... (default) * pid = spawn(command, :close_others=>false) # don't close 3,4,5,... * - * :close_others is true by default for spawn and IO.popen. + * :close_others is false by default for spawn and IO.popen. * * Note that fds which close-on-exec flag is already set are closed * regardless of :close_others option. @@ -4346,18 +5122,18 @@ rb_f_system(int argc, VALUE *argv) * Internally, +spawn+ uses an extra file descriptor to resolve such cyclic * file descriptor mapping. * - * See <code>Kernel.exec</code> for the standard shell. + * See Kernel.exec for the standard shell. */ static VALUE -rb_f_spawn(int argc, VALUE *argv) +rb_f_spawn(int argc, VALUE *argv, VALUE _) { rb_pid_t pid; char errmsg[CHILD_ERRMSG_BUFLEN] = { '\0' }; VALUE execarg_obj, fail_str; struct rb_execarg *eargp; - execarg_obj = rb_execarg_new(argc, argv, TRUE); + execarg_obj = rb_execarg_new(argc, argv, TRUE, FALSE); eargp = rb_execarg_get(execarg_obj); fail_str = eargp->use_shell ? eargp->invoke.sh.shell_script : eargp->invoke.cmd.command_name; @@ -4383,7 +5159,7 @@ rb_f_spawn(int argc, VALUE *argv) * 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() + * thread calls Thread#run. Called without an argument, sleep() * will sleep forever. * * Time.new #=> 2008-03-08 19:56:19 +0900 @@ -4394,22 +5170,27 @@ rb_f_spawn(int argc, VALUE *argv) */ static VALUE -rb_f_sleep(int argc, VALUE *argv) +rb_f_sleep(int argc, VALUE *argv, VALUE _) { - time_t beg, end; + time_t beg = time(0); + VALUE scheduler = rb_fiber_scheduler_current(); - beg = time(0); - if (argc == 0) { - rb_thread_sleep_forever(); + if (scheduler != Qnil) { + rb_fiber_scheduler_kernel_sleepv(scheduler, argc, argv); } else { - rb_check_arity(argc, 0, 1); - rb_thread_wait_for(rb_time_interval(argv[0])); + if (argc == 0) { + rb_thread_sleep_forever(); + } + else { + rb_check_arity(argc, 0, 1); + rb_thread_wait_for(rb_time_interval(argv[0])); + } } - end = time(0) - beg; + time_t end = time(0) - beg; - return INT2FIX(end); + return TIMET2NUM(end); } @@ -4426,7 +5207,7 @@ rb_f_sleep(int argc, VALUE *argv) */ static VALUE -proc_getpgrp(void) +proc_getpgrp(VALUE _) { rb_pid_t pgrp; @@ -4455,7 +5236,7 @@ proc_getpgrp(void) */ static VALUE -proc_setpgrp(void) +proc_setpgrp(VALUE _) { /* check for posix setpgid() first; this matches the posix */ /* getpgrp() above. It appears that configure will set SETPGRP_VOID */ @@ -4537,7 +5318,7 @@ proc_setpgid(VALUE obj, VALUE pid, VALUE pgrp) * Process.getsid(Process.pid()) #=> 27422 */ static VALUE -proc_getsid(int argc, VALUE *argv) +proc_getsid(int argc, VALUE *argv, VALUE _) { rb_pid_t sid; rb_pid_t pid = 0; @@ -4571,7 +5352,7 @@ static rb_pid_t ruby_setsid(void); */ static VALUE -proc_setsid(void) +proc_setsid(VALUE _) { rb_pid_t pid; @@ -4619,9 +5400,9 @@ ruby_setsid(void) * * 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 + * of Process::PRIO_PGRP, + * Process::PRIO_USER, or + * Process::PRIO_PROCESS. _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. @@ -4653,7 +5434,7 @@ proc_getpriority(VALUE obj, VALUE which, VALUE who) * call-seq: * Process.setpriority(kind, integer, priority) -> 0 * - * See <code>Process#getpriority</code>. + * See Process.getpriority. * * Process.setpriority(Process::PRIO_USER, 0, 19) #=> 0 * Process.setpriority(Process::PRIO_PROCESS, 0, 19) #=> 0 @@ -4855,7 +5636,7 @@ rlimit_resource_type(VALUE rtype) rb_raise(rb_eArgError, "invalid resource name: % "PRIsVALUE, rtype); - UNREACHABLE; + UNREACHABLE_RETURN(-1); } static rlim_t @@ -4896,7 +5677,7 @@ rlimit_resource_value(VALUE rval) #endif rb_raise(rb_eArgError, "invalid resource value: %"PRIsVALUE, rval); - UNREACHABLE; + UNREACHABLE_RETURN((rlim_t)-1); } #endif @@ -4912,12 +5693,12 @@ rlimit_resource_value(VALUE rval) * _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>. + * a constant such as Process::RLIMIT_CORE. * 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>. + * _cur_limit_ and _max_limit_ may be Process::RLIM_INFINITY, + * Process::RLIM_SAVED_MAX or + * Process::RLIM_SAVED_CUR. * See Process.setrlimit and the system getrlimit(2) manual for details. */ @@ -4950,7 +5731,7 @@ proc_getrlimit(VALUE obj, VALUE resource) * _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>. + * a constant such as Process::RLIMIT_CORE. * The available resources are OS dependent. * Ruby may support following resources. * @@ -4973,10 +5754,10 @@ proc_getrlimit(VALUE obj, VALUE resource) * * _cur_limit_ and _max_limit_ may be * <code>:INFINITY</code>, <code>"INFINITY"</code> or - * <code>Process::RLIM_INFINITY</code>, + * Process::RLIM_INFINITY, * which means that the resource is not limited. - * They may be <code>Process::RLIM_SAVED_MAX</code>, - * <code>Process::RLIM_SAVED_CUR</code> and + * They may be Process::RLIM_SAVED_MAX, + * Process::RLIM_SAVED_CUR and * corresponding symbols and strings too. * See system setrlimit(2) manual for details. * @@ -5030,14 +5811,254 @@ check_gid_switch(void) } +#if defined(HAVE_PWD_H) +/** + * 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; + errno = 0; + while ((gle = getlogin_r(login, (getlogin_r_size_t)loginsize)) != 0) { + + if (gle == ENOTTY || gle == ENXIO || gle == ENOENT) { + 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; + } + + return maybe_result; + +# elif USE_GETLOGIN + + errno = 0; + login = getlogin(); + if (errno) { + if (errno == ENOTTY || errno == ENXIO || errno == ENOENT) { + return Qnil; + } + rb_syserr_fail(errno, "getlogin"); + } + + return login ? rb_str_new_cstr(login) : Qnil; +# endif + +#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; + } + + char *login = RSTRING_PTR(login_name); + + struct passwd *pwptr; + +# ifdef USE_GETPWNAM_R + + struct passwd pwdnm; + 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); + + int enm; + errno = 0; + while ((enm = getpwnam_r(login, &pwdnm, bufnm, bufsizenm, &pwptr)) != 0) { + + if (enm == ENOENT || enm== ESRCH || enm == EBADF || enm == EPERM) { + /* not found; non-errors */ + rb_str_resize(getpwnm_tmp, 0); + return Qnil; + } + + if (enm != ERANGE || bufsizenm >= GETPW_R_SIZE_LIMIT) { + rb_str_resize(getpwnm_tmp, 0); + rb_syserr_fail(enm, "getpwnam_r"); + } + + rb_str_modify_expand(getpwnm_tmp, bufsizenm); + bufnm = RSTRING_PTR(getpwnm_tmp); + bufsizenm = rb_str_capacity(getpwnm_tmp); + } + + if (pwptr == 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(pwptr->pw_dir); + rb_str_resize(getpwnm_tmp, 0); + return result; + +# elif USE_GETPWNAM + + errno = 0; + pwptr = getpwnam(login); + if (pwptr) { + /* found it */ + return rb_str_new_cstr(pwptr->pw_dir); + } + if (errno + /* avoid treating as errors errno values that indicate "not found" */ + && ( errno != ENOENT && errno != ESRCH && errno != EBADF && errno != EPERM)) { + rb_syserr_fail(errno, "getpwnam"); + } + + return Qnil; /* not found */ +# endif + +#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(); + + struct passwd *pwptr; + +# ifdef USE_GETPWUID_R + + struct passwd pwdid; + 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); + + int eid; + errno = 0; + while ((eid = getpwuid_r(ruid, &pwdid, bufid, bufsizeid, &pwptr)) != 0) { + + if (eid == ENOENT || eid== ESRCH || eid == EBADF || eid == EPERM) { + /* not found; non-errors */ + rb_str_resize(getpwid_tmp, 0); + return Qnil; + } + + if (eid != ERANGE || bufsizeid >= GETPW_R_SIZE_LIMIT) { + rb_str_resize(getpwid_tmp, 0); + rb_syserr_fail(eid, "getpwuid_r"); + } + + rb_str_modify_expand(getpwid_tmp, bufsizeid); + bufid = RSTRING_PTR(getpwid_tmp); + bufsizeid = rb_str_capacity(getpwid_tmp); + } + + if (pwptr == 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(pwptr->pw_dir); + rb_str_resize(getpwid_tmp, 0); + return result; + +# elif defined(USE_GETPWUID) + + errno = 0; + pwptr = getpwuid(ruid); + if (pwptr) { + /* found it */ + return rb_str_new_cstr(pwptr->pw_dir); + } + if (errno + /* avoid treating as errors errno values that indicate "not found" */ + && ( errno == ENOENT || errno == ESRCH || errno == EBADF || errno == EPERM)) { + rb_syserr_fail(errno, "getpwuid"); + } + + return Qnil; /* not found */ +# endif + +#endif /* !defined(USE_GETPWUID_R) && !defined(USE_GETPWUID) */ +} +#endif /* HAVE_PWD_H */ + + /********************************************************************* * Document-class: Process::Sys * - * The <code>Process::Sys</code> module contains UID and GID + * The Process::Sys module contains UID and GID * functions which provide direct bindings to the system calls of the * same names instead of the more-portable versions of the same - * functionality found in the <code>Process</code>, - * <code>Process::UID</code>, and <code>Process::GID</code> modules. + * functionality found in the Process, + * Process::UID, and Process::GID modules. */ #if defined(HAVE_PWD_H) @@ -5061,6 +6082,7 @@ obj2uid(VALUE id 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; @@ -5069,10 +6091,8 @@ obj2uid(VALUE id getpw_buf = RSTRING_PTR(*getpw_tmp); getpw_buf_len = rb_str_capacity(*getpw_tmp); rb_str_set_len(*getpw_tmp, getpw_buf_len); - errno = ERANGE; - /* gepwnam_r() on MacOS X doesn't set errno if buffer size is insufficient */ - while (getpwnam_r(usrname, &pwbuf, getpw_buf, getpw_buf_len, &pwptr)) { - int e = errno; + 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"); @@ -5088,7 +6108,7 @@ obj2uid(VALUE id #ifndef USE_GETPWNAM_R endpwent(); #endif - rb_raise(rb_eArgError, "can't find user for %s", usrname); + rb_raise(rb_eArgError, "can't find user for %"PRIsVALUE, id); } uid = pwptr->pw_uid; #ifndef USE_GETPWNAM_R @@ -5139,6 +6159,7 @@ obj2gid(VALUE id 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; @@ -5147,10 +6168,8 @@ obj2gid(VALUE id getgr_buf = RSTRING_PTR(*getgr_tmp); getgr_buf_len = rb_str_capacity(*getgr_tmp); rb_str_set_len(*getgr_tmp, getgr_buf_len); - errno = ERANGE; - /* gegrnam_r() on MacOS X doesn't set errno if buffer size is insufficient */ - while (getgrnam_r(grpname, &grbuf, getgr_buf, getgr_buf_len, &grptr)) { - int e = errno; + 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"); @@ -5168,7 +6187,7 @@ obj2gid(VALUE id #if !defined(USE_GETGRNAM_R) && defined(HAVE_ENDGRENT) endgrent(); #endif - rb_raise(rb_eArgError, "can't find group for %s", grpname); + rb_raise(rb_eArgError, "can't find group for %"PRIsVALUE, id); } gid = grptr->gr_gid; #if !defined(USE_GETGRNAM_R) && defined(HAVE_ENDGRENT) @@ -5386,7 +6405,7 @@ proc_setuid(VALUE obj, VALUE id) * * Document-class: Process::UID * - * The <code>Process::UID</code> module contains a collection of + * The Process::UID module contains a collection of * module functions which can be used to portably get, set, and * switch the current process's real, effective, and saved user IDs. * @@ -5660,11 +6679,9 @@ static VALUE p_sys_setregid(VALUE obj, VALUE rid, VALUE eid) { rb_gid_t rgid, egid; - PREPARE_GETGRNAM; check_gid_switch(); rgid = OBJ2GID(rid); egid = OBJ2GID(eid); - FINISH_GETGRNAM; if (setregid(rgid, egid) != 0) rb_sys_fail(0); return Qnil; } @@ -5688,12 +6705,10 @@ static VALUE p_sys_setresgid(VALUE obj, VALUE rid, VALUE eid, VALUE sid) { rb_gid_t rgid, egid, sgid; - PREPARE_GETGRNAM; check_gid_switch(); rgid = OBJ2GID(rid); egid = OBJ2GID(eid); sgid = OBJ2GID(sid); - FINISH_GETGRNAM; if (setresgid(rgid, egid, sgid) != 0) rb_sys_fail(0); return Qnil; } @@ -5841,11 +6856,24 @@ maxgroups(void) * call-seq: * Process.groups -> array * - * Get an <code>Array</code> of the gids of groups in the + * Get an Array of the group IDs in the * supplemental group access list for this process. * * Process.groups #=> [27, 6, 10, 11] * + * Note that this method is just a wrapper of getgroups(2). + * This means that the following characteristics of + * the result completely depend on your system: + * + * - the result is sorted + * - the result includes effective GIDs + * - the result does not include duplicated GIDs + * + * You can make sure to get a sorted unique GID list of + * the current process by this expression: + * + * Process.groups.uniq.sort + * */ static VALUE @@ -5884,7 +6912,7 @@ proc_getgroups(VALUE obj) * Process.groups= array -> array * * Set the supplemental group access list to the given - * <code>Array</code> of group IDs. + * Array of group IDs. * * Process.groups #=> [0, 1, 2, 3, 4, 6, 10, 11, 20, 26, 27] * Process.groups = [27, 6, 10, 11] #=> [27, 6, 10, 11] @@ -5935,7 +6963,7 @@ proc_setgroups(VALUE obj, VALUE ary) * 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 + * added to the list. Returns the resulting Array of the * gids of all the groups in the supplementary group access list. Not * available on all platforms. * @@ -5948,7 +6976,7 @@ proc_setgroups(VALUE obj, VALUE ary) static VALUE proc_initgroups(VALUE obj, VALUE uname, VALUE base_grp) { - if (initgroups(StringValuePtr(uname), OBJ2GID(base_grp)) != 0) { + if (initgroups(StringValueCStr(uname), OBJ2GID(base_grp)) != 0) { rb_sys_fail(0); } return proc_getgroups(obj); @@ -5993,7 +7021,7 @@ proc_setmaxgroups(VALUE obj, VALUE val) int ngroups_max = get_sc_ngroups_max(); if (ngroups <= 0) - rb_raise(rb_eArgError, "maxgroups %d shold be positive", ngroups); + rb_raise(rb_eArgError, "maxgroups %d should be positive", ngroups); if (ngroups > RB_MAX_GROUPS) ngroups = RB_MAX_GROUPS; @@ -6027,13 +7055,13 @@ static int rb_daemon(int nochdir, int noclose); */ static VALUE -proc_daemon(int argc, VALUE *argv) +proc_daemon(int argc, VALUE *argv, VALUE _) { int n, nochdir = FALSE, noclose = FALSE; switch (rb_check_arity(argc, 0, 2)) { - case 2: noclose = RTEST(argv[1]); - case 1: nochdir = RTEST(argv[0]); + case 2: noclose = TO_BOOL(argv[1], "noclose"); + case 1: nochdir = TO_BOOL(argv[0], "nochdir"); } prefork(); @@ -6047,17 +7075,18 @@ rb_daemon(int nochdir, int noclose) { int err = 0; #ifdef HAVE_DAEMON + if (mjit_enabled) mjit_pause(false); // Don't leave locked mutex to child. before_fork_ruby(); err = daemon(nochdir, noclose); after_fork_ruby(); - rb_thread_atfork(); + rb_thread_atfork(); /* calls mjit_resume() */ #else int n; #define fork_daemon() \ switch (rb_fork_ruby(NULL)) { \ case -1: return -1; \ - case 0: rb_thread_atfork(); break; \ + case 0: break; \ default: _exit(EXIT_SUCCESS); \ } @@ -6090,7 +7119,7 @@ rb_daemon(int nochdir, int noclose) * * Document-class: Process::GID * - * The <code>Process::GID</code> module contains a collection of + * The Process::GID module contains a collection of * module functions which can be used to portably get, set, and * switch the current process's real, effective, and saved group IDs. * @@ -6545,7 +7574,7 @@ p_gid_grant_privilege(VALUE obj, VALUE id) */ static VALUE -p_uid_exchangeable(void) +p_uid_exchangeable(VALUE _) { #if defined(HAVE_SETRESUID) return Qtrue; @@ -6607,7 +7636,7 @@ p_uid_exchange(VALUE obj) */ static VALUE -p_gid_exchangeable(void) +p_gid_exchangeable(VALUE _) { #if defined(HAVE_SETRESGID) return Qtrue; @@ -6670,7 +7699,7 @@ p_gid_exchange(VALUE obj) */ static VALUE -p_uid_have_saved_id(void) +p_uid_have_saved_id(VALUE _) { #if defined(HAVE_SETRESUID) || defined(HAVE_SETEUID) || defined(_POSIX_SAVED_IDS) return Qtrue; @@ -6682,8 +7711,9 @@ p_uid_have_saved_id(void) #if defined(HAVE_SETRESUID) || defined(HAVE_SETEUID) || defined(_POSIX_SAVED_IDS) static VALUE -p_uid_sw_ensure(rb_uid_t id) +p_uid_sw_ensure(VALUE i) { + rb_uid_t id = (rb_uid_t/* narrowing */)i; under_uid_switch = 0; id = rb_seteuid_core(id); return UIDT2NUM(id); @@ -6737,7 +7767,7 @@ p_uid_switch(VALUE obj) rb_syserr_fail(EPERM, 0); } - UNREACHABLE; + UNREACHABLE_RETURN(Qnil); } #else static VALUE @@ -6784,7 +7814,7 @@ p_uid_switch(VALUE obj) */ static VALUE -p_gid_have_saved_id(void) +p_gid_have_saved_id(VALUE _) { #if defined(HAVE_SETRESGID) || defined(HAVE_SETEGID) || defined(_POSIX_SAVED_IDS) return Qtrue; @@ -6795,8 +7825,9 @@ p_gid_have_saved_id(void) #if defined(HAVE_SETRESGID) || defined(HAVE_SETEGID) || defined(_POSIX_SAVED_IDS) static VALUE -p_gid_sw_ensure(rb_gid_t id) +p_gid_sw_ensure(VALUE i) { + rb_gid_t id = (rb_gid_t/* narrowing */)i; under_gid_switch = 0; id = rb_setegid_core(id); return GIDT2NUM(id); @@ -6850,7 +7881,7 @@ p_gid_switch(VALUE obj) rb_syserr_fail(EPERM, 0); } - UNREACHABLE; + UNREACHABLE_RETURN(Qnil); } #else static VALUE @@ -6889,27 +7920,22 @@ p_gid_switch(VALUE obj) static long get_clk_tck(void) { - long hertz = #ifdef HAVE__SC_CLK_TCK - (double)sysconf(_SC_CLK_TCK); + return sysconf(_SC_CLK_TCK); +#elif defined CLK_TCK + return CLK_TCK; +#elif defined HZ + return HZ; #else -#ifndef HZ -# ifdef CLK_TCK -# define HZ CLK_TCK -# else -# define HZ 60 -# endif -#endif /* HZ */ - HZ; + return 60; #endif - return hertz; } /* * call-seq: * Process.times -> aProcessTms * - * Returns a <code>Tms</code> structure (see <code>Process::Tms</code>) + * Returns a <code>Tms</code> structure (see Process::Tms) * that contains user and system CPU times for this process, * and also for children processes. * @@ -6920,15 +7946,26 @@ get_clk_tck(void) VALUE rb_proc_times(VALUE obj) { - const double hertz = get_clk_tck(); - struct tms buf; VALUE utime, stime, cutime, cstime, ret; +#if defined(RUSAGE_SELF) && defined(RUSAGE_CHILDREN) + struct rusage usage_s, usage_c; + + if (getrusage(RUSAGE_SELF, &usage_s) != 0 || getrusage(RUSAGE_CHILDREN, &usage_c) != 0) + rb_sys_fail("getrusage"); + utime = DBL2NUM((double)usage_s.ru_utime.tv_sec + (double)usage_s.ru_utime.tv_usec/1e6); + stime = DBL2NUM((double)usage_s.ru_stime.tv_sec + (double)usage_s.ru_stime.tv_usec/1e6); + cutime = DBL2NUM((double)usage_c.ru_utime.tv_sec + (double)usage_c.ru_utime.tv_usec/1e6); + cstime = DBL2NUM((double)usage_c.ru_stime.tv_sec + (double)usage_c.ru_stime.tv_usec/1e6); +#else + const double hertz = (double)get_clk_tck(); + struct tms buf; times(&buf); utime = DBL2NUM(buf.tms_utime / hertz); stime = DBL2NUM(buf.tms_stime / hertz); cutime = DBL2NUM(buf.tms_cutime / hertz); cstime = DBL2NUM(buf.tms_cstime / hertz); +#endif ret = rb_struct_new(rb_cProcessTms, utime, stime, cutime, cstime); RB_GC_GUARD(utime); RB_GC_GUARD(stime); @@ -6945,11 +7982,13 @@ typedef LONG_LONG timetick_int_t; #define TIMETICK_INT_MIN LLONG_MIN #define TIMETICK_INT_MAX LLONG_MAX #define TIMETICK_INT2NUM(v) LL2NUM(v) +#define MUL_OVERFLOW_TIMETICK_P(a, b) MUL_OVERFLOW_LONG_LONG_P(a, b) #else typedef long timetick_int_t; #define TIMETICK_INT_MIN LONG_MIN #define TIMETICK_INT_MAX LONG_MAX #define TIMETICK_INT2NUM(v) LONG2NUM(v) +#define MUL_OVERFLOW_TIMETICK_P(a, b) MUL_OVERFLOW_LONG_P(a, b) #endif CONSTFUNC(static timetick_int_t gcd_timetick_int(timetick_int_t, timetick_int_t)); @@ -7065,8 +8104,7 @@ timetick2integer(struct timetick *ttp, timetick_int_t t = ttp->giga_count * 1000000000 + ttp->count; for (i = 0; i < num_numerators; i++) { timetick_int_t factor = numerators[i]; - if (MUL_OVERFLOW_SIGNED_INTEGER_P(factor, t, - TIMETICK_INT_MIN, TIMETICK_INT_MAX)) + if (MUL_OVERFLOW_TIMETICK_P(factor, t)) goto generic; t *= factor; } @@ -7129,7 +8167,7 @@ make_clock_result(struct timetick *ttp, } #ifdef __APPLE__ -static mach_timebase_info_data_t * +static const mach_timebase_info_data_t * get_mach_timebase_info(void) { static mach_timebase_info_data_t sTimebaseInfo; @@ -7140,6 +8178,14 @@ 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 /* @@ -7158,9 +8204,9 @@ get_mach_timebase_info(void) * 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_REALTIME] SUSv2 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0, OpenBSD 2.1, macOS 10.12, Windows-8/Server-2012 + * [CLOCK_MONOTONIC] SUSv3 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0, OpenBSD 3.4, macOS 10.12, Windows-2000 + * [CLOCK_PROCESS_CPUTIME_ID] SUSv3 to 4, Linux 2.5.63, FreeBSD 9.3, 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 @@ -7181,6 +8227,7 @@ get_mach_timebase_info(void) * [CLOCK_UPTIME_RAW_APPROX] macOS 10.12 * [CLOCK_UPTIME_PRECISE] FreeBSD 8.1 * [CLOCK_SECOND] FreeBSD 8.1 + * [CLOCK_TAI] Linux 3.10 * * Note that SUS stands for Single Unix Specification. * SUS contains POSIX and clock_gettime is defined in the POSIX part. @@ -7268,8 +8315,8 @@ get_mach_timebase_info(void) * So the result can be interpreted differently across systems. * Time.now is recommended over CLOCK_REALTIME. */ -VALUE -rb_clock_gettime(int argc, VALUE *argv) +static VALUE +rb_clock_gettime(int argc, VALUE *argv, VALUE _) { int ret; @@ -7285,8 +8332,9 @@ rb_clock_gettime(int argc, VALUE *argv) if (SYMBOL_P(clk_id)) { /* * Non-clock_gettime clocks are provided by symbol clk_id. - * - * gettimeofday is always available on platforms supported by Ruby. + */ +#ifdef HAVE_GETTIMEOFDAY + /* * GETTIMEOFDAY_BASED_CLOCK_REALTIME is used for * CLOCK_REALTIME if clock_gettime is not available. */ @@ -7301,6 +8349,7 @@ rb_clock_gettime(int argc, VALUE *argv) denominators[num_denominators++] = 1000000000; goto success; } +#endif #define RUBY_TIME_BASED_CLOCK_REALTIME ID2SYM(id_TIME_BASED_CLOCK_REALTIME) if (clk_id == RUBY_TIME_BASED_CLOCK_REALTIME) { @@ -7393,7 +8442,7 @@ rb_clock_gettime(int argc, VALUE *argv) #ifdef __APPLE__ #define RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC ID2SYM(id_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC) if (clk_id == RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC) { - mach_timebase_info_data_t *info = get_mach_timebase_info(); + const mach_timebase_info_data_t *info = get_mach_timebase_info(); uint64_t t = mach_absolute_time(); tt.count = (int32_t)(t % 1000000000); tt.giga_count = t / 1000000000; @@ -7429,42 +8478,46 @@ rb_clock_gettime(int argc, VALUE *argv) * call-seq: * Process.clock_getres(clock_id [, unit]) -> number * - * Returns the time resolution returned by POSIX clock_getres() function. + * Returns an estimate of the resolution of a +clock_id+ using the POSIX + * <code>clock_getres()</code> function. + * + * Note the reported resolution is often inaccurate on most platforms due to + * underlying bugs for this function and therefore the reported resolution + * often differs from the actual resolution of the clock in practice. + * Inaccurate reported resolutions have been observed for various clocks including + * CLOCK_MONOTONIC and CLOCK_MONOTONIC_RAW when using Linux, macOS, BSD or AIX + * platforms, when using ARM processors, or when using virtualization. * * +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. + * +clock_id+ can be a symbol as for +Process.clock_gettime+. * * If the given +clock_id+ is not supported, Errno::EINVAL is raised. * - * +unit+ specifies a type of the return value. + * +unit+ specifies the type of the return value. * +Process.clock_getres+ accepts +unit+ as +Process.clock_gettime+. - * The default value, +:float_second+, is also same as + * The default value, +:float_second+, is also the same as * +Process.clock_gettime+. * * +Process.clock_getres+ also accepts +:hertz+ as +unit+. - * +:hertz+ means a the reciprocal of +:float_second+. + * +:hertz+ means the reciprocal of +:float_second+. * * +: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. + * the clock ticks per second for the times() function and + * CLOCKS_PER_SEC for the clock() function. * - * +Process.clock_getres(:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID, :hertz)+ + * <code>Process.clock_getres(:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID, :hertz)</code> * returns the clock ticks per second. * - * +Process.clock_getres(:CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID, :hertz)+ + * <code>Process.clock_getres(:CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID, :hertz)</code> * returns CLOCKS_PER_SEC. * * p Process.clock_getres(Process::CLOCK_MONOTONIC) * #=> 1.0e-09 * */ -VALUE -rb_clock_getres(int argc, VALUE *argv) +static VALUE +rb_clock_getres(int argc, VALUE *argv, VALUE _) { struct timetick tt; timetick_int_t numerators[2]; @@ -7532,7 +8585,7 @@ rb_clock_getres(int argc, VALUE *argv) #ifdef RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC if (clk_id == RUBY_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC) { - mach_timebase_info_data_t *info = get_mach_timebase_info(); + const mach_timebase_info_data_t *info = get_mach_timebase_info(); tt.count = 1; tt.giga_count = 0; numerators[num_numerators++] = info->numer; @@ -7567,32 +8620,88 @@ rb_clock_getres(int argc, VALUE *argv) } } +static VALUE +get_CHILD_STATUS(ID _x, VALUE *_y) +{ + return rb_last_status_get(); +} + +static VALUE +get_PROCESS_ID(ID _x, VALUE *_y) +{ + return get_pid(); +} + +/* + * call-seq: + * Process.kill(signal, pid, ...) -> integer + * + * Sends the given signal to the specified process id(s) if _pid_ is positive. + * If _pid_ is zero, _signal_ is sent to all processes whose group ID is equal + * to the group ID of the process. If _pid_ is negative, results are dependent + * on the operating system. _signal_ may be an integer signal number or + * a POSIX signal name (either with or without a +SIG+ prefix). If _signal_ is + * negative (or starts with a minus sign), kills process groups instead of + * processes. Not all signals are available on all platforms. + * The keys and values of Signal.list are known signal names and numbers, + * respectively. + * + * pid = fork do + * Signal.trap("HUP") { puts "Ouch!"; exit } + * # ... do some work ... + * end + * # ... + * Process.kill("HUP", pid) + * Process.wait + * + * <em>produces:</em> + * + * Ouch! + * + * If _signal_ is an integer but wrong for signal, Errno::EINVAL or + * RangeError will be raised. Otherwise unless _signal_ is a String + * or a Symbol, and a known signal name, ArgumentError will be + * raised. + * + * Also, Errno::ESRCH or RangeError for invalid _pid_, Errno::EPERM + * when failed because of no privilege, will be raised. In these + * cases, signals may have been sent to preceding processes. + */ + +static VALUE +proc_rb_f_kill(int c, const VALUE *v, VALUE _) +{ + return rb_f_kill(c, v); +} + VALUE rb_mProcess; -VALUE rb_mProcUID; -VALUE rb_mProcGID; -VALUE rb_mProcID_Syscall; +static VALUE rb_mProcUID; +static VALUE rb_mProcGID; +static VALUE rb_mProcID_Syscall; /* - * The <code>Process</code> module is a collection of methods used to + * The Process module is a collection of methods used to * manipulate processes. */ void InitVM_process(void) { -#undef rb_intern -#define rb_intern(str) rb_intern_const(str) - rb_define_virtual_variable("$?", rb_last_status_get, 0); - rb_define_virtual_variable("$$", get_pid, 0); - rb_define_global_function("exec", rb_f_exec, -1); + rb_define_virtual_variable("$?", get_CHILD_STATUS, 0); + rb_define_virtual_variable("$$", get_PROCESS_ID, 0); + + rb_gvar_ractor_local("$$"); + rb_gvar_ractor_local("$?"); + + rb_define_global_function("exec", f_exec, -1); rb_define_global_function("fork", rb_f_fork, 0); rb_define_global_function("exit!", rb_f_exit_bang, -1); rb_define_global_function("system", rb_f_system, -1); rb_define_global_function("spawn", rb_f_spawn, -1); rb_define_global_function("sleep", rb_f_sleep, -1); - rb_define_global_function("exit", rb_f_exit, -1); - rb_define_global_function("abort", rb_f_abort, -1); + rb_define_global_function("exit", f_exit, -1); + rb_define_global_function("abort", f_abort, -1); rb_mProcess = rb_define_module("Process"); @@ -7611,28 +8720,36 @@ InitVM_process(void) rb_define_const(rb_mProcess, "WUNTRACED", INT2FIX(0)); #endif - rb_define_singleton_method(rb_mProcess, "exec", rb_f_exec, -1); + rb_define_singleton_method(rb_mProcess, "exec", f_exec, -1); rb_define_singleton_method(rb_mProcess, "fork", rb_f_fork, 0); rb_define_singleton_method(rb_mProcess, "spawn", rb_f_spawn, -1); rb_define_singleton_method(rb_mProcess, "exit!", rb_f_exit_bang, -1); - rb_define_singleton_method(rb_mProcess, "exit", rb_f_exit, -1); - rb_define_singleton_method(rb_mProcess, "abort", rb_f_abort, -1); + rb_define_singleton_method(rb_mProcess, "exit", f_exit, -1); + rb_define_singleton_method(rb_mProcess, "abort", f_abort, -1); + rb_define_singleton_method(rb_mProcess, "last_status", proc_s_last_status, 0); + rb_define_singleton_method(rb_mProcess, "_fork", rb_proc__fork, 0); - rb_define_module_function(rb_mProcess, "kill", rb_f_kill, -1); /* in signal.c */ - rb_define_module_function(rb_mProcess, "wait", proc_wait, -1); + rb_define_module_function(rb_mProcess, "kill", proc_rb_f_kill, -1); + rb_define_module_function(rb_mProcess, "wait", proc_m_wait, -1); rb_define_module_function(rb_mProcess, "wait2", proc_wait2, -1); - rb_define_module_function(rb_mProcess, "waitpid", proc_wait, -1); + rb_define_module_function(rb_mProcess, "waitpid", proc_m_wait, -1); rb_define_module_function(rb_mProcess, "waitpid2", proc_wait2, -1); rb_define_module_function(rb_mProcess, "waitall", proc_waitall, 0); rb_define_module_function(rb_mProcess, "detach", proc_detach, 1); + /* :nodoc: */ rb_cWaiter = rb_define_class_under(rb_mProcess, "Waiter", rb_cThread); rb_undef_alloc_func(rb_cWaiter); rb_undef_method(CLASS_OF(rb_cWaiter), "new"); rb_define_method(rb_cWaiter, "pid", detach_process_pid, 0); rb_cProcessStatus = rb_define_class_under(rb_mProcess, "Status", rb_cObject); + rb_define_alloc_func(rb_cProcessStatus, rb_process_status_allocate); rb_undef_method(CLASS_OF(rb_cProcessStatus), "new"); + rb_marshal_define_compat(rb_cProcessStatus, rb_cObject, + process_status_dump, process_status_load); + + rb_define_singleton_method(rb_cProcessStatus, "wait", rb_process_status_waitv, -1); rb_define_method(rb_cProcessStatus, "==", pst_equal, 1); rb_define_method(rb_cProcessStatus, "&", pst_bitand, 1); @@ -7641,7 +8758,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, 0); + rb_define_method(rb_cProcessStatus, "pid", pst_pid_m, 0); rb_define_method(rb_cProcessStatus, "stopped?", pst_wifstopped, 0); rb_define_method(rb_cProcessStatus, "stopsig", pst_wstopsig, 0); @@ -7652,8 +8769,8 @@ InitVM_process(void) rb_define_method(rb_cProcessStatus, "success?", pst_success_p, 0); rb_define_method(rb_cProcessStatus, "coredump?", pst_wcoredump, 0); - rb_define_module_function(rb_mProcess, "pid", get_pid, 0); - rb_define_module_function(rb_mProcess, "ppid", get_ppid, 0); + rb_define_module_function(rb_mProcess, "pid", proc_get_pid, 0); + rb_define_module_function(rb_mProcess, "ppid", proc_get_ppid, 0); rb_define_module_function(rb_mProcess, "getpgrp", proc_getpgrp, 0); rb_define_module_function(rb_mProcess, "setpgrp", proc_setpgrp, 0); @@ -7933,12 +9050,16 @@ 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 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) + /* Placeholder for rusage */ rb_cProcessTms = rb_struct_define_under(rb_mProcess, "Tms", "utime", "stime", "cutime", "cstime", NULL); - rb_define_const(rb_cStruct, "Tms", rb_cProcessTms); /* for the backward compatibility */ #endif SAVED_USER_ID = geteuid(); @@ -7999,46 +9120,45 @@ InitVM_process(void) void Init_process(void) { - id_in = rb_intern("in"); - id_out = rb_intern("out"); - id_err = rb_intern("err"); - id_pid = rb_intern("pid"); - id_uid = rb_intern("uid"); - id_gid = rb_intern("gid"); - id_close = rb_intern("close"); - id_child = rb_intern("child"); + id_in = rb_intern_const("in"); + id_out = rb_intern_const("out"); + id_err = rb_intern_const("err"); + id_pid = rb_intern_const("pid"); + id_uid = rb_intern_const("uid"); + id_gid = rb_intern_const("gid"); + id_close = rb_intern_const("close"); + id_child = rb_intern_const("child"); #ifdef HAVE_SETPGID - id_pgroup = rb_intern("pgroup"); + id_pgroup = rb_intern_const("pgroup"); #endif #ifdef _WIN32 - id_new_pgroup = rb_intern("new_pgroup"); -#endif - id_unsetenv_others = rb_intern("unsetenv_others"); - id_chdir = rb_intern("chdir"); - id_umask = rb_intern("umask"); - id_close_others = rb_intern("close_others"); - id_ENV = rb_intern("ENV"); - id_nanosecond = rb_intern("nanosecond"); - id_microsecond = rb_intern("microsecond"); - id_millisecond = rb_intern("millisecond"); - id_second = rb_intern("second"); - id_float_microsecond = rb_intern("float_microsecond"); - id_float_millisecond = rb_intern("float_millisecond"); - id_float_second = rb_intern("float_second"); - id_GETTIMEOFDAY_BASED_CLOCK_REALTIME = rb_intern("GETTIMEOFDAY_BASED_CLOCK_REALTIME"); - id_TIME_BASED_CLOCK_REALTIME = rb_intern("TIME_BASED_CLOCK_REALTIME"); + id_new_pgroup = rb_intern_const("new_pgroup"); +#endif + id_unsetenv_others = rb_intern_const("unsetenv_others"); + id_chdir = rb_intern_const("chdir"); + id_umask = rb_intern_const("umask"); + id_close_others = rb_intern_const("close_others"); + id_nanosecond = rb_intern_const("nanosecond"); + id_microsecond = rb_intern_const("microsecond"); + id_millisecond = rb_intern_const("millisecond"); + id_second = rb_intern_const("second"); + id_float_microsecond = rb_intern_const("float_microsecond"); + id_float_millisecond = rb_intern_const("float_millisecond"); + id_float_second = rb_intern_const("float_second"); + id_GETTIMEOFDAY_BASED_CLOCK_REALTIME = rb_intern_const("GETTIMEOFDAY_BASED_CLOCK_REALTIME"); + id_TIME_BASED_CLOCK_REALTIME = rb_intern_const("TIME_BASED_CLOCK_REALTIME"); #ifdef HAVE_TIMES - id_TIMES_BASED_CLOCK_MONOTONIC = rb_intern("TIMES_BASED_CLOCK_MONOTONIC"); - id_TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID = rb_intern("TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID"); + id_TIMES_BASED_CLOCK_MONOTONIC = rb_intern_const("TIMES_BASED_CLOCK_MONOTONIC"); + id_TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID = rb_intern_const("TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID"); #endif #ifdef RUSAGE_SELF - id_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID = rb_intern("GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID"); + id_GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID = rb_intern_const("GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID"); #endif - id_CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID = rb_intern("CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID"); + id_CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID = rb_intern_const("CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID"); #ifdef __APPLE__ - id_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC = rb_intern("MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC"); + id_MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC = rb_intern_const("MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC"); #endif - id_hertz = rb_intern("hertz"); + id_hertz = rb_intern_const("hertz"); InitVM(process); } |
