src/core/lib/iomgr/fork_posix.cc

   1 /*
   2  *
   3  * Copyright 2017 gRPC authors.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  */
  18
  19 #include <grpc/support/port_platform.h>
  20
  21 #include "src/core/lib/iomgr/port.h"
  22
  23 #ifdef GRPC_POSIX_FORK
  24
  25 #include <string.h>
  26
  27 #include <grpc/fork.h>
  28 #include <grpc/grpc.h>
  29 #include <grpc/support/log.h>
  30
  31 #include "src/core/lib/gprpp/fork.h"
  32 #include "src/core/lib/gprpp/thd.h"
  33 #include "src/core/lib/iomgr/ev_posix.h"
  34 #include "src/core/lib/iomgr/executor.h"
  35 #include "src/core/lib/iomgr/timer_manager.h"
  36 #include "src/core/lib/iomgr/wakeup_fd_posix.h"
  37
  38 /*
  39  * NOTE: FORKING IS NOT GENERALLY SUPPORTED, THIS IS ONLY INTENDED TO WORK
  40  *       AROUND VERY SPECIFIC USE CASES.
  41  */
  42
  43 namespace {
  44 bool skipped_handler = true;
  45 bool registered_handlers = false;
  46 }  // namespace
  47
  48 void grpc_prefork() {
  49   skipped_handler = true;
  50   // This  may be called after core shuts down, so verify initialized before
  51   // instantiating an ExecCtx.
  52   if (!grpc_is_initialized()) {
  53     return;
  54   }
  55   grpc_core::ExecCtx exec_ctx;
  56   if (!grpc_core::Fork::Enabled()) {
  57     gpr_log(GPR_ERROR,
  58             "Fork support not enabled; try running with the "
  59             "environment variable GRPC_ENABLE_FORK_SUPPORT=1");
  60     return;
  61   }
  62   if (strcmp(grpc_get_poll_strategy_name(), "epoll1") != 0 &&
  63       strcmp(grpc_get_poll_strategy_name(), "poll") != 0) {
  64     gpr_log(GPR_INFO,
  65             "Fork support is only compatible with the epoll1 and poll polling "
  66             "strategies");
  67   }
  68   if (!grpc_core::Fork::BlockExecCtx()) {
  69     gpr_log(GPR_INFO,
  70             "Other threads are currently calling into gRPC, skipping fork() "
  71             "handlers");
  72     return;
  73   }
  74   grpc_timer_manager_set_threading(false);
  75   grpc_core::Executor::SetThreadingAll(false);
  76   grpc_core::ExecCtx::Get()->Flush();
  77   grpc_core::Fork::AwaitThreads();
  78   skipped_handler = false;
  79 }
  80
  81 void grpc_postfork_parent() {
  82   if (!skipped_handler) {
  83     grpc_core::Fork::AllowExecCtx();
  84     grpc_core::ExecCtx exec_ctx;
  85     grpc_timer_manager_set_threading(true);
  86     grpc_core::Executor::SetThreadingAll(true);
  87   }
  88 }
  89
  90 void grpc_postfork_child() {
  91   if (!skipped_handler) {
  92     grpc_core::Fork::AllowExecCtx();
  93     grpc_core::ExecCtx exec_ctx;
  94     grpc_core::Fork::child_postfork_func reset_polling_engine =
  95         grpc_core::Fork::GetResetChildPollingEngineFunc();
  96     if (reset_polling_engine != nullptr) {
  97       reset_polling_engine();
  98     }
  99     grpc_timer_manager_set_threading(true);
 100     grpc_core::Executor::SetThreadingAll(true);
 101   }
 102 }
 103
 104 void grpc_fork_handlers_auto_register() {
 105   if (grpc_core::Fork::Enabled() & !registered_handlers) {
 106 #ifdef GRPC_POSIX_FORK_ALLOW_PTHREAD_ATFORK
 107     pthread_atfork(grpc_prefork, grpc_postfork_parent, grpc_postfork_child);
 108     registered_handlers = true;
 109 #endif  // GRPC_POSIX_FORK_ALLOW_PTHREAD_ATFORK
 110   }
 111 }
 112
 113 #endif  // GRPC_POSIX_FORK