blob: bcebc486232d8570525b7954bc7d2d9e9ff25824 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
// Copyright 2022 gRPC authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef GRPC_SRC_CORE_LIB_EVENT_ENGINE_FORKABLE_H
#define GRPC_SRC_CORE_LIB_EVENT_ENGINE_FORKABLE_H
#include <grpc/support/port_platform.h>
#include <memory>
#include <vector>
#include <grpc/support/log.h>
#include "src/core/lib/debug/trace.h"
namespace grpc_event_engine {
namespace experimental {
extern grpc_core::TraceFlag grpc_trace_fork;
#define GRPC_FORK_TRACE_LOG(format, ...) \
do { \
if (GRPC_TRACE_FLAG_ENABLED(grpc_trace_fork)) { \
gpr_log(GPR_DEBUG, "[fork] " format, __VA_ARGS__); \
} \
} while (0)
#define GRPC_FORK_TRACE_LOG_STRING(format) GRPC_FORK_TRACE_LOG("%s", format)
// An interface to be implemented by EventEngines that wish to have managed fork
// support. The child class must guarantee that those methods are thread-safe.
class Forkable {
public:
virtual ~Forkable() = default;
virtual void PrepareFork() = 0;
virtual void PostforkParent() = 0;
virtual void PostforkChild() = 0;
};
// ObjectGroupForkHandler is meant to be used as a static object in each
// translation unit where Forkables are created and registered with the
// ObjectGroupForkHandler. It essentially provides storage for Forkables'
// instances (as a vector of weak pointers) and helper methods that are meant to
// be invoked inside the fork handlers (see pthread_atfork(3)). The idea is to
// have different Forkables (e.g. PosixEventPoller) to store their instances
// (e.g. a PosixEventPoller object) in a single place separated from other
// Forkables (a sharded approach). Forkables need to register their pthread fork
// handlers and manage the relative ordering themselves. This object is
// thread-unsafe.
class ObjectGroupForkHandler {
public:
// Registers a Forkable with this ObjectGroupForkHandler, the Forkable must be
// created as a shared pointer.
void RegisterForkable(std::shared_ptr<Forkable> forkable,
GRPC_UNUSED void (*prepare)(void),
GRPC_UNUSED void (*parent)(void),
GRPC_UNUSED void (*child)(void));
void Prefork();
void PostforkParent();
void PostforkChild();
private:
GRPC_UNUSED bool registered_ = false;
bool is_forking_ = false;
std::vector<std::weak_ptr<Forkable> > forkables_;
};
} // namespace experimental
} // namespace grpc_event_engine
#endif // GRPC_SRC_CORE_LIB_EVENT_ENGINE_FORKABLE_H
|