grpc 1.42.0.pre1-arm64-darwin → 1.59.5-arm64-darwin

data/src/ruby/ext/grpc/rb_grpc.c

@@ -44,6 +44,11 @@
 #include <grpc/support/log.h>
 #include <grpc/support/time.h>
 
+#ifdef GPR_LINUX
+#include <sys/syscall.h>
+#include <unistd.h>
+#endif
+
 static VALUE grpc_rb_cTimeVal = Qnil;
 
 static rb_data_type_t grpc_rb_timespec_data_type = {
@@ -198,6 +203,7 @@ static void Init_grpc_time_consts() {
       rb_define_module_under(grpc_rb_mGrpcCore, "TimeConsts");
   grpc_rb_cTimeVal =
       rb_define_class_under(grpc_rb_mGrpcCore, "TimeSpec", rb_cObject);
+  rb_undef_alloc_func(grpc_rb_cTimeVal);
   zero_realtime = gpr_time_0(GPR_CLOCK_REALTIME);
   inf_future_realtime = gpr_inf_future(GPR_CLOCK_REALTIME);
   inf_past_realtime = gpr_inf_past(GPR_CLOCK_REALTIME);
@@ -223,20 +229,51 @@ static void Init_grpc_time_consts() {
   id_tv_nsec = rb_intern("tv_nsec");
 }
 
+static bool g_enable_fork_support;
+
+#ifdef GPR_LINUX
+static long sys_gettid() { return syscall(__NR_gettid); }
+static bool can_enable_fork_support() { return true; }
+#else
+static long sys_gettid() { return 0; }
+static bool can_enable_fork_support() { return false; }
+#endif
+
 #if GPR_WINDOWS
-static void grpc_ruby_set_init_pid(void) {}
-static bool grpc_ruby_forked_after_init(void) { return false; }
+static void grpc_ruby_basic_init(void) {}
+static bool grpc_ruby_initial_pid(void) { return true; }
+static bool grpc_ruby_initial_thread(void) { return true; }
+static void grpc_ruby_reset_init_state(void) {}
 #else
-static pid_t grpc_init_pid;
+static pid_t g_init_pid;
+static long g_init_tid;
 
-static void grpc_ruby_set_init_pid(void) {
-  GPR_ASSERT(grpc_init_pid == 0);
-  grpc_init_pid = getpid();
+static bool grpc_ruby_initial_pid(void) {
+  GPR_ASSERT(g_init_pid != 0);
+  return g_init_pid == getpid();
 }
 
-static bool grpc_ruby_forked_after_init(void) {
-  GPR_ASSERT(grpc_init_pid != 0);
-  return grpc_init_pid != getpid();
+static bool grpc_ruby_initial_thread(void) {
+  GPR_ASSERT(g_init_tid != 0);
+  return sys_gettid() == g_init_tid;
+}
+
+static void grpc_ruby_reset_init_state(void) {
+  g_init_pid = getpid();
+  g_init_tid = sys_gettid();
+}
+
+static void grpc_ruby_basic_init(void) {
+  GPR_ASSERT(g_init_pid == 0);
+  GPR_ASSERT(g_init_tid == 0);
+  grpc_ruby_reset_init_state();
+  // TODO(apolcyn): ideally, we should share logic with C-core
+  // for determining whether or not fork support is enabled, rather
+  // than parsing the environment variable ourselves.
+  const char* res = getenv("GRPC_ENABLE_FORK_SUPPORT");
+  if (res != NULL && strcmp(res, "1") == 0) {
+    g_enable_fork_support = can_enable_fork_support();
+  }
 }
 #endif
 
@@ -257,59 +294,175 @@ VALUE sym_details = Qundef;
 VALUE sym_metadata = Qundef;
 
 static gpr_once g_once_init = GPR_ONCE_INIT;
+static int64_t g_grpc_rb_prefork_pending;          // synchronized by the GIL
+static int64_t g_grpc_rb_num_fork_unsafe_threads;  // synchronized by the GIL
 
 void grpc_ruby_fork_guard() {
-  if (grpc_ruby_forked_after_init()) {
-    rb_raise(rb_eRuntimeError, "grpc cannot be used before and after forking");
+  // Check if we're using gRPC between prefork and postfork
+  gpr_once_init(&g_once_init, grpc_ruby_basic_init);
+  if (g_grpc_rb_prefork_pending) {
+    rb_raise(rb_eRuntimeError,
+             "grpc cannot be used between calls to GRPC.prefork and "
+             "GRPC.postfork_child or GRPC.postfork_parent");
+  }
+  if (!grpc_ruby_initial_pid()) {
+    if (g_enable_fork_support) {
+      // Only way we can get here is by enabling for support and forking but not
+      // calling prefork
+      rb_raise(rb_eRuntimeError,
+               "grpc is in a broken state: GRPC.prefork must be called before "
+               "calling fork from a process using grpc");
+    } else {
+      rb_raise(rb_eRuntimeError,
+               "grpc cannot be used before and after forking unless the "
+               "GRPC_ENABLE_FORK_SUPPORT env var is set to \"1\" and the "
+               "platform supports it (linux only)");
+    }
   }
 }
 
-static VALUE bg_thread_init_rb_mu = Qundef;
-static int bg_thread_init_done = 0;
+static VALUE g_bg_thread_init_rb_mu = Qundef;
+static bool g_bg_thread_init_done;
 
 static void grpc_ruby_init_threads() {
   // Avoid calling into ruby library (when creating threads here)
   // in gpr_once_init. In general, it appears to be unsafe to call
   // into the ruby library while holding a non-ruby mutex, because a gil yield
   // could end up trying to lock onto that same mutex and deadlocking.
-  rb_mutex_lock(bg_thread_init_rb_mu);
-  if (!bg_thread_init_done) {
+  gpr_log(GPR_INFO,
+          "GRPC_RUBY: grpc_ruby_init_threads g_bg_thread_init_done=%d",
+          g_bg_thread_init_done);
+  rb_mutex_lock(g_bg_thread_init_rb_mu);
+  if (!g_bg_thread_init_done) {
     grpc_rb_event_queue_thread_start();
     grpc_rb_channel_polling_thread_start();
-    bg_thread_init_done = 1;
+    g_bg_thread_init_done = true;
   }
-  rb_mutex_unlock(bg_thread_init_rb_mu);
+  rb_mutex_unlock(g_bg_thread_init_rb_mu);
 }
 
 static int64_t g_grpc_ruby_init_count;
 
 void grpc_ruby_init() {
-  gpr_once_init(&g_once_init, grpc_ruby_set_init_pid);
+  gpr_once_init(&g_once_init, grpc_ruby_basic_init);
+  grpc_ruby_fork_guard();
   grpc_init();
   grpc_ruby_init_threads();
   // (only gpr_log after logging has been initialized)
   gpr_log(GPR_DEBUG,
-          "GRPC_RUBY: grpc_ruby_init - prev g_grpc_ruby_init_count:%" PRId64,
-          g_grpc_ruby_init_count++);
+          "GRPC_RUBY: grpc_ruby_init - g_enable_fork_support=%d prev "
+          "g_grpc_ruby_init_count:%" PRId64,
+          g_enable_fork_support, g_grpc_ruby_init_count++);
+}
+
+// fork APIs, useable on linux with env var: GRPC_ENABLE_FORK_SUPPORT=1
+//
+// Must be called once and only once before forking. Must be called on the
+// same threads that gRPC was (lazy-)initialized on. One must not call
+// into the gRPC library during or after prefork has been called, until
+// the corresponding postfork_{parent,child} APIs have been called.
+static VALUE grpc_rb_prefork(VALUE self) {
+  // This might be the first time we've called into the grpc library, so make
+  // sure basic one-time initialization is taken care of. Note that if this is
+  // the case, then grpc_init() will start up c-core threads; that's OK since
+  // they will be shut down in C-core's pthread_atfork handler.
+  gpr_once_init(&g_once_init, grpc_ruby_basic_init);
+  grpc_init();
+  if (!g_enable_fork_support) {
+    rb_raise(rb_eRuntimeError,
+             "forking with gRPC/Ruby is only supported on linux with env var: "
+             "GRPC_ENABLE_FORK_SUPPORT=1");
+  }
+  if (g_grpc_rb_prefork_pending) {
+    rb_raise(rb_eRuntimeError,
+             "GRPC.prefork already called without a matching "
+             "GRPC.postfork_{parent,child}");
+  }
+  if (!grpc_ruby_initial_thread()) {
+    rb_raise(rb_eRuntimeError,
+             "GRPC.prefork and fork need to be called from the same thread "
+             "that GRPC was initialized on (GRPC lazy-initializes when when "
+             "the first GRPC object is created");
+  }
+  if (g_grpc_rb_num_fork_unsafe_threads > 0) {
+    rb_raise(
+        rb_eRuntimeError,
+        "Detected at least %ld threads actively using grpc, so it is not safe "
+        "call GRPC.prefork or fork. Note that grpc-ruby servers and "
+        "bidirectional "
+        "streams manage background threads and are not fork safe.",
+        g_grpc_rb_num_fork_unsafe_threads);
+  }
+  g_grpc_rb_prefork_pending = true;
+  rb_mutex_lock(g_bg_thread_init_rb_mu);
+  if (g_bg_thread_init_done) {
+    grpc_rb_channel_polling_thread_stop();
+    grpc_rb_event_queue_thread_stop();
+    // all ruby-level background threads joined at this point
+    g_bg_thread_init_done = false;
+  }
+  rb_mutex_unlock(g_bg_thread_init_rb_mu);
+  return Qnil;
 }
 
-void grpc_ruby_shutdown() {
-  GPR_ASSERT(g_grpc_ruby_init_count > 0);
-  if (!grpc_ruby_forked_after_init()) grpc_shutdown();
-  gpr_log(
-      GPR_DEBUG,
-      "GRPC_RUBY: grpc_ruby_shutdown - prev g_grpc_ruby_init_count:%" PRId64,
-      g_grpc_ruby_init_count--);
+static VALUE grpc_rb_postfork_child(VALUE self) {
+  if (!g_grpc_rb_prefork_pending) {
+    rb_raise(rb_eRuntimeError,
+             "GRPC::postfork_child can only be called once following a "
+             "GRPC::prefork");
+  }
+  if (grpc_ruby_initial_pid()) {
+    rb_raise(rb_eRuntimeError,
+             "GRPC.postfork_child must be called only from the child process "
+             "after a fork");
+  }
+  grpc_ruby_reset_init_state();
+  grpc_ruby_init_threads();
+  g_grpc_rb_prefork_pending = false;
+  return Qnil;
 }
 
+static VALUE grpc_rb_postfork_parent(VALUE self) {
+  // TODO(apolcyn): check calling thread vs. thread that gRPC was initialized on
+  if (!g_grpc_rb_prefork_pending) {
+    rb_raise(rb_eRuntimeError,
+             "GRPC::postfork_parent can only be called once following a "
+             "GRPC::prefork");
+  }
+  if (!grpc_ruby_initial_pid()) {
+    rb_raise(rb_eRuntimeError,
+             "GRPC.postfork_parent must be called only from the parent process "
+             "after a fork");
+  }
+  if (!grpc_ruby_initial_thread()) {
+    rb_raise(rb_eRuntimeError,
+             "GRPC.postfork_parent needs to be called from the same thread "
+             "that GRPC.prefork (and fork) was called from");
+  }
+  grpc_ruby_init_threads();
+  g_grpc_rb_prefork_pending = false;
+  return Qnil;
+}
+
+// APIs to mark fork-unsafe sections from C-extension code
+void grpc_rb_fork_unsafe_begin() { g_grpc_rb_num_fork_unsafe_threads++; }
+
+void grpc_rb_fork_unsafe_end() { g_grpc_rb_num_fork_unsafe_threads--; }
+
+// APIs to mark fork-unsafe sections from ruby code
+static VALUE grpc_rb_fork_unsafe_begin_api() { grpc_rb_fork_unsafe_begin(); }
+
+static VALUE grpc_rb_fork_unsafe_end_api() { grpc_rb_fork_unsafe_end(); }
+
+// One-time initialization
 void Init_grpc_c() {
   if (!grpc_rb_load_core()) {
     rb_raise(rb_eLoadError, "Couldn't find or load gRPC's dynamic C core");
     return;
   }
 
-  rb_global_variable(&bg_thread_init_rb_mu);
-  bg_thread_init_rb_mu = rb_mutex_new();
+  rb_global_variable(&g_bg_thread_init_rb_mu);
+  g_bg_thread_init_rb_mu = rb_mutex_new();
 
   grpc_rb_mGRPC = rb_define_module("GRPC");
   grpc_rb_mGrpcCore = rb_define_module_under(grpc_rb_mGRPC, "Core");
@@ -319,7 +472,7 @@ void Init_grpc_c() {
   sym_code = ID2SYM(rb_intern("code"));
   sym_details = ID2SYM(rb_intern("details"));
   sym_metadata = ID2SYM(rb_intern("metadata"));
-
+  // init C-defined classes
   Init_grpc_channel();
   Init_grpc_call();
   Init_grpc_call_credentials();
@@ -330,4 +483,14 @@ void Init_grpc_c() {
   Init_grpc_xds_server_credentials();
   Init_grpc_time_consts();
   Init_grpc_compression_options();
+  // define fork APIs
+  rb_define_module_function(grpc_rb_mGRPC, "prefork", grpc_rb_prefork, 0);
+  rb_define_module_function(grpc_rb_mGRPC, "postfork_child",
+                            grpc_rb_postfork_child, 0);
+  rb_define_module_function(grpc_rb_mGRPC, "postfork_parent",
+                            grpc_rb_postfork_parent, 0);
+  rb_define_module_function(grpc_rb_mGrpcCore, "fork_unsafe_begin",
+                            grpc_rb_fork_unsafe_begin_api, 0);
+  rb_define_module_function(grpc_rb_mGrpcCore, "fork_unsafe_end",
+                            grpc_rb_fork_unsafe_end_api, 0);
 }

data/src/ruby/ext/grpc/rb_grpc.h

@@ -70,8 +70,14 @@ gpr_timespec grpc_rb_time_timeval(VALUE time, int interval);
 
 void grpc_ruby_fork_guard();
 
-void grpc_ruby_init();
+/* To be called once and only once before entering code section that is
+ * definitely not fork-safe. Used in conjunction with GRPC.prefork
+ * to catch for-unsafe processes and raise errors. */
+void grpc_rb_fork_unsafe_begin();
+
+/* To be called once and only once after each grpc_rb_fork_unsafe_begin*/
+void grpc_rb_fork_unsafe_end();
 
-void grpc_ruby_shutdown();
+void grpc_ruby_init();
 
 #endif /* GRPC_RB_H_ */