blob: 2a0b8917e8efd7a3a4b3f62e3d611e3373c22f10 [file] [log] [blame]
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001/*
2 *
3 * Copyright 2016, Google Inc.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met:
9 *
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following disclaimer
14 * in the documentation and/or other materials provided with the
15 * distribution.
16 * * Neither the name of Google Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 */
33
murgatroid9954070892016-08-08 17:01:18 -070034#include "src/core/lib/iomgr/port.h"
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -070035
Sree Kuchibhotla76a07952016-06-22 15:09:06 -070036/* This polling engine is only relevant on linux kernels supporting epoll() */
murgatroid99623dd4f2016-08-08 17:31:27 -070037#ifdef GRPC_LINUX_EPOLL
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -070038
Sree Kuchibhotla4c11a202016-06-06 09:23:25 -070039#include "src/core/lib/iomgr/ev_epoll_linux.h"
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -070040
41#include <assert.h>
42#include <errno.h>
43#include <poll.h>
Sree Kuchibhotla4998e302016-08-16 07:26:31 -070044#include <pthread.h>
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -070045#include <signal.h>
46#include <string.h>
47#include <sys/epoll.h>
48#include <sys/socket.h>
49#include <unistd.h>
50
51#include <grpc/support/alloc.h>
52#include <grpc/support/log.h>
53#include <grpc/support/string_util.h>
54#include <grpc/support/tls.h>
55#include <grpc/support/useful.h>
56
57#include "src/core/lib/iomgr/ev_posix.h"
58#include "src/core/lib/iomgr/iomgr_internal.h"
59#include "src/core/lib/iomgr/wakeup_fd_posix.h"
Craig Tillerb39307d2016-06-30 15:39:13 -070060#include "src/core/lib/iomgr/workqueue.h"
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -070061#include "src/core/lib/profiling/timers.h"
62#include "src/core/lib/support/block_annotate.h"
63
Sree Kuchibhotla34217242016-06-29 00:19:07 -070064/* TODO: sreek - Move this to init.c and initialize this like other tracers. */
65static int grpc_polling_trace = 0; /* Disabled by default */
Sree Kuchibhotla1e776682016-06-28 14:09:26 -070066#define GRPC_POLLING_TRACE(fmt, ...) \
67 if (grpc_polling_trace) { \
68 gpr_log(GPR_INFO, (fmt), __VA_ARGS__); \
69 }
70
Sree Kuchibhotla82d73412017-02-09 18:27:45 -080071/* Uncomment the following to enable extra checks on poll_object operations */
Sree Kuchibhotlae6f516e2016-12-08 12:20:23 -080072/* #define PO_DEBUG */
73
Sree Kuchibhotlac7be7c62016-06-09 17:08:50 -070074static int grpc_wakeup_signal = -1;
75static bool is_grpc_wakeup_signal_initialized = false;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -070076
Craig Tillerb4b8e1e2016-11-28 07:33:13 -080077/* TODO: sreek: Right now, this wakes up all pollers. In future we should make
78 * sure to wake up one polling thread (which can wake up other threads if
79 * needed) */
80static grpc_wakeup_fd global_wakeup_fd;
81
Sree Kuchibhotlac7be7c62016-06-09 17:08:50 -070082/* Implements the function defined in grpc_posix.h. This function might be
83 * called before even calling grpc_init() to set either a different signal to
84 * use. If signum == -1, then the use of signals is disabled */
85void grpc_use_signal(int signum) {
86 grpc_wakeup_signal = signum;
87 is_grpc_wakeup_signal_initialized = true;
88
89 if (grpc_wakeup_signal < 0) {
90 gpr_log(GPR_INFO,
91 "Use of signals is disabled. Epoll engine will not be used");
92 } else {
93 gpr_log(GPR_INFO, "epoll engine will be using signal: %d",
94 grpc_wakeup_signal);
95 }
96}
97
98struct polling_island;
Sree Kuchibhotla5855c472016-06-08 12:56:56 -070099
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -0800100typedef enum {
101 POLL_OBJ_FD,
102 POLL_OBJ_POLLSET,
103 POLL_OBJ_POLLSET_SET
104} poll_obj_type;
105
106typedef struct poll_obj {
Sree Kuchibhotlaa0749a62016-11-18 20:22:09 -0800107#ifdef PO_DEBUG
108 poll_obj_type obj_type;
109#endif
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -0800110 gpr_mu mu;
111 struct polling_island *pi;
112} poll_obj;
113
114const char *poll_obj_string(poll_obj_type po_type) {
115 switch (po_type) {
116 case POLL_OBJ_FD:
117 return "fd";
118 case POLL_OBJ_POLLSET:
119 return "pollset";
120 case POLL_OBJ_POLLSET_SET:
121 return "pollset_set";
122 }
123
124 GPR_UNREACHABLE_CODE(return "UNKNOWN");
125}
126
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700127/*******************************************************************************
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700128 * Fd Declarations
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700129 */
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -0800130
131#define FD_FROM_PO(po) ((grpc_fd *)(po))
132
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700133struct grpc_fd {
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -0800134 poll_obj po;
135
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700136 int fd;
137 /* refst format:
Sree Kuchibhotla5098f912016-05-31 10:58:17 -0700138 bit 0 : 1=Active / 0=Orphaned
139 bits 1-n : refcount
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700140 Ref/Unref by two to avoid altering the orphaned bit */
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700141 gpr_atm refst;
142
Sree Kuchibhotla2fc2b3e2017-02-14 10:05:14 -0800143 /* Internally stores data of type (grpc_error *). If the FD is shutdown, this
144 contains reason for shutdown (i.e a pointer to grpc_error) ORed with
145 FD_SHUTDOWN_BIT. Since address allocations are word-aligned, the lower bit
146 of (grpc_error *) addresses is guaranteed to be zero. Even if the
147 (grpc_error *), is of special types like GRPC_ERROR_NONE, GRPC_ERROR_OOM
148 etc, the lower bit is guaranteed to be zero.
149
150 Once an fd is shutdown, any pending or future read/write closures on the
151 fd should fail */
Sree Kuchibhotla99983382017-02-12 17:03:27 -0800152 gpr_atm shutdown_error;
Sree Kuchibhotla79a62332016-06-04 14:01:03 -0700153
Sree Kuchibhotla99983382017-02-12 17:03:27 -0800154 /* The fd is either closed or we relinquished control of it. In either
155 cases, this indicates that the 'fd' on this structure is no longer
156 valid */
Sree Kuchibhotla79a62332016-06-04 14:01:03 -0700157 bool orphaned;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700158
Sree Kuchibhotla99983382017-02-12 17:03:27 -0800159 /* Closures to call when the fd is readable or writable respectively. These
160 fields contain one of the following values:
161 CLOSURE_READY : The fd has an I/O event of interest but there is no
162 closure yet to execute
163
164 CLOSURE_NOT_READY : The fd has no I/O event of interest
165
Sree Kuchibhotlaa70ccb62017-02-13 23:16:52 -0800166 closure ptr : The closure to be executed when the fd has an I/O
167 event of interest
168
Sree Kuchibhotla2fc2b3e2017-02-14 10:05:14 -0800169 shutdown_error | FD_SHUTDOWN_BIT :
170 'shutdown_error' field ORed with FD_SHUTDOWN_BIT.
Sree Kuchibhotlaa70ccb62017-02-13 23:16:52 -0800171 This indicates that the fd is shutdown. Since all
172 memory allocations are word-aligned, the lower two
173 bits of the shutdown_error pointer are always 0. So
Sree Kuchibhotla2fc2b3e2017-02-14 10:05:14 -0800174 it is safe to OR these with FD_SHUTDOWN_BIT
Sree Kuchibhotla99983382017-02-12 17:03:27 -0800175
176 Valid state transitions:
177
178 <closure ptr> <-----3------ CLOSURE_NOT_READY ----1----> CLOSURE_READY
179 | | ^ | ^ | |
180 | | | | | | |
181 | +--------------4----------+ 6 +---------2---------------+ |
182 | | |
183 | v |
Sree Kuchibhotla2fc2b3e2017-02-14 10:05:14 -0800184 +-----5-------> [shutdown_error | FD_SHUTDOWN_BIT] <----7---------+
Sree Kuchibhotla99983382017-02-12 17:03:27 -0800185
186 For 1, 4 : See set_ready() function
187 For 2, 3 : See notify_on() function
188 For 5,6,7: See set_shutdown() function */
Sree Kuchibhotla82d73412017-02-09 18:27:45 -0800189 gpr_atm read_closure;
190 gpr_atm write_closure;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700191
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700192 struct grpc_fd *freelist_next;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700193 grpc_closure *on_done_closure;
194
Sree Kuchibhotla82d73412017-02-09 18:27:45 -0800195 /* The pollset that last noticed that the fd is readable. The actual type
196 * stored in this is (grpc_pollset *) */
197 gpr_atm read_notifier_pollset;
Sree Kuchibhotla5855c472016-06-08 12:56:56 -0700198
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700199 grpc_iomgr_object iomgr_object;
200};
201
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700202/* Reference counting for fds */
Sree Kuchibhotla6a295452016-06-23 15:53:10 -0700203// #define GRPC_FD_REF_COUNT_DEBUG
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700204#ifdef GRPC_FD_REF_COUNT_DEBUG
205static void fd_ref(grpc_fd *fd, const char *reason, const char *file, int line);
206static void fd_unref(grpc_fd *fd, const char *reason, const char *file,
207 int line);
208#define GRPC_FD_REF(fd, reason) fd_ref(fd, reason, __FILE__, __LINE__)
209#define GRPC_FD_UNREF(fd, reason) fd_unref(fd, reason, __FILE__, __LINE__)
210#else
211static void fd_ref(grpc_fd *fd);
212static void fd_unref(grpc_fd *fd);
213#define GRPC_FD_REF(fd, reason) fd_ref(fd)
214#define GRPC_FD_UNREF(fd, reason) fd_unref(fd)
215#endif
216
217static void fd_global_init(void);
218static void fd_global_shutdown(void);
219
Sree Kuchibhotla82d73412017-02-09 18:27:45 -0800220#define CLOSURE_NOT_READY ((gpr_atm)0)
221#define CLOSURE_READY ((gpr_atm)1)
Sree Kuchibhotlaa70ccb62017-02-13 23:16:52 -0800222
Sree Kuchibhotla2fc2b3e2017-02-14 10:05:14 -0800223#define FD_SHUTDOWN_BIT 1
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700224
225/*******************************************************************************
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700226 * Polling island Declarations
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700227 */
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700228
Craig Tillerd8a3c042016-09-09 12:42:37 -0700229#ifdef GRPC_WORKQUEUE_REFCOUNT_DEBUG
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700230
Sree Kuchibhotla6a295452016-06-23 15:53:10 -0700231#define PI_ADD_REF(p, r) pi_add_ref_dbg((p), (r), __FILE__, __LINE__)
Craig Tillerb39307d2016-06-30 15:39:13 -0700232#define PI_UNREF(exec_ctx, p, r) \
233 pi_unref_dbg((exec_ctx), (p), (r), __FILE__, __LINE__)
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700234
Craig Tillerd8a3c042016-09-09 12:42:37 -0700235#else /* defined(GRPC_WORKQUEUE_REFCOUNT_DEBUG) */
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700236
Sree Kuchibhotla6a295452016-06-23 15:53:10 -0700237#define PI_ADD_REF(p, r) pi_add_ref((p))
Craig Tillerb39307d2016-06-30 15:39:13 -0700238#define PI_UNREF(exec_ctx, p, r) pi_unref((exec_ctx), (p))
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700239
Yuchen Zeng362ac1b2016-09-13 16:01:31 -0700240#endif /* !defined(GRPC_PI_REF_COUNT_DEBUG) */
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700241
Craig Tiller460502e2016-10-13 10:02:08 -0700242/* This is also used as grpc_workqueue (by directly casing it) */
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700243typedef struct polling_island {
Craig Tiller91031da2016-12-28 15:44:25 -0800244 grpc_closure_scheduler workqueue_scheduler;
245
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700246 gpr_mu mu;
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700247 /* Ref count. Use PI_ADD_REF() and PI_UNREF() macros to increment/decrement
248 the refcount.
249 Once the ref count becomes zero, this structure is destroyed which means
250 we should ensure that there is never a scenario where a PI_ADD_REF() is
251 racing with a PI_UNREF() that just made the ref_count zero. */
Craig Tiller15007612016-07-06 09:36:16 -0700252 gpr_atm ref_count;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700253
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700254 /* Pointer to the polling_island this merged into.
255 * merged_to value is only set once in polling_island's lifetime (and that too
256 * only if the island is merged with another island). Because of this, we can
257 * use gpr_atm type here so that we can do atomic access on this and reduce
258 * lock contention on 'mu' mutex.
259 *
260 * Note that if this field is not NULL (i.e not 0), all the remaining fields
261 * (except mu and ref_count) are invalid and must be ignored. */
262 gpr_atm merged_to;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700263
Craig Tiller460502e2016-10-13 10:02:08 -0700264 /* Number of threads currently polling on this island */
Craig Tillerd8a3c042016-09-09 12:42:37 -0700265 gpr_atm poller_count;
Craig Tiller460502e2016-10-13 10:02:08 -0700266 /* Mutex guarding the read end of the workqueue (must be held to pop from
267 * workqueue_items) */
Craig Tillerd8a3c042016-09-09 12:42:37 -0700268 gpr_mu workqueue_read_mu;
Craig Tiller460502e2016-10-13 10:02:08 -0700269 /* Queue of closures to be executed */
Craig Tillerd8a3c042016-09-09 12:42:37 -0700270 gpr_mpscq workqueue_items;
Craig Tiller460502e2016-10-13 10:02:08 -0700271 /* Count of items in workqueue_items */
Craig Tillerd8a3c042016-09-09 12:42:37 -0700272 gpr_atm workqueue_item_count;
Craig Tiller460502e2016-10-13 10:02:08 -0700273 /* Wakeup fd used to wake pollers to check the contents of workqueue_items */
Craig Tillerd8a3c042016-09-09 12:42:37 -0700274 grpc_wakeup_fd workqueue_wakeup_fd;
Craig Tillerb39307d2016-06-30 15:39:13 -0700275
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700276 /* The fd of the underlying epoll set */
277 int epoll_fd;
278
279 /* The file descriptors in the epoll set */
280 size_t fd_cnt;
281 size_t fd_capacity;
282 grpc_fd **fds;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700283} polling_island;
284
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700285/*******************************************************************************
286 * Pollset Declarations
287 */
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700288struct grpc_pollset_worker {
Sree Kuchibhotla34217242016-06-29 00:19:07 -0700289 /* Thread id of this worker */
290 pthread_t pt_id;
291
292 /* Used to prevent a worker from getting kicked multiple times */
293 gpr_atm is_kicked;
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700294 struct grpc_pollset_worker *next;
295 struct grpc_pollset_worker *prev;
296};
297
298struct grpc_pollset {
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -0800299 poll_obj po;
300
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700301 grpc_pollset_worker root_worker;
302 bool kicked_without_pollers;
303
304 bool shutting_down; /* Is the pollset shutting down ? */
305 bool finish_shutdown_called; /* Is the 'finish_shutdown_locked()' called ? */
306 grpc_closure *shutdown_done; /* Called after after shutdown is complete */
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700307};
308
309/*******************************************************************************
310 * Pollset-set Declarations
311 */
312struct grpc_pollset_set {
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -0800313 poll_obj po;
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700314};
315
316/*******************************************************************************
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700317 * Common helpers
318 */
319
Craig Tillerf975f742016-07-01 14:56:27 -0700320static bool append_error(grpc_error **composite, grpc_error *error,
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700321 const char *desc) {
Craig Tillerf975f742016-07-01 14:56:27 -0700322 if (error == GRPC_ERROR_NONE) return true;
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700323 if (*composite == GRPC_ERROR_NONE) {
324 *composite = GRPC_ERROR_CREATE(desc);
325 }
326 *composite = grpc_error_add_child(*composite, error);
Craig Tillerf975f742016-07-01 14:56:27 -0700327 return false;
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700328}
329
330/*******************************************************************************
Sree Kuchibhotla24b10622016-06-08 15:20:17 -0700331 * Polling island Definitions
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700332 */
333
Sree Kuchibhotla24b10622016-06-08 15:20:17 -0700334/* The wakeup fd that is used to wake up all threads in a Polling island. This
335 is useful in the polling island merge operation where we need to wakeup all
336 the threads currently polling the smaller polling island (so that they can
337 start polling the new/merged polling island)
338
339 NOTE: This fd is initialized to be readable and MUST NOT be consumed i.e the
340 threads that woke up MUST NOT call grpc_wakeup_fd_consume_wakeup() */
341static grpc_wakeup_fd polling_island_wakeup_fd;
342
Craig Tiller2e620132016-10-10 15:27:44 -0700343/* The polling island being polled right now.
344 See comments in workqueue_maybe_wakeup for why this is tracked. */
Craig Tillerd8a3c042016-09-09 12:42:37 -0700345static __thread polling_island *g_current_thread_polling_island;
346
Craig Tillerb39307d2016-06-30 15:39:13 -0700347/* Forward declaration */
Craig Tiller2b49ea92016-07-01 13:21:27 -0700348static void polling_island_delete(grpc_exec_ctx *exec_ctx, polling_island *pi);
Craig Tiller91031da2016-12-28 15:44:25 -0800349static void workqueue_enqueue(grpc_exec_ctx *exec_ctx, grpc_closure *closure,
350 grpc_error *error);
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700351
Sree Kuchibhotlaad2c4772016-06-13 19:06:54 -0700352#ifdef GRPC_TSAN
Sree Kuchibhotla41622a82016-06-13 16:43:14 -0700353/* Currently TSAN may incorrectly flag data races between epoll_ctl and
354 epoll_wait for any grpc_fd structs that are added to the epoll set via
355 epoll_ctl and are returned (within a very short window) via epoll_wait().
356
357 To work-around this race, we establish a happens-before relation between
358 the code just-before epoll_ctl() and the code after epoll_wait() by using
359 this atomic */
360gpr_atm g_epoll_sync;
Sree Kuchibhotlaad2c4772016-06-13 19:06:54 -0700361#endif /* defined(GRPC_TSAN) */
Sree Kuchibhotla41622a82016-06-13 16:43:14 -0700362
Craig Tiller91031da2016-12-28 15:44:25 -0800363static const grpc_closure_scheduler_vtable workqueue_scheduler_vtable = {
Craig Tiller7c70b6c2017-01-23 07:48:42 -0800364 workqueue_enqueue, workqueue_enqueue, "workqueue"};
Craig Tiller91031da2016-12-28 15:44:25 -0800365
Craig Tillerb39307d2016-06-30 15:39:13 -0700366static void pi_add_ref(polling_island *pi);
367static void pi_unref(grpc_exec_ctx *exec_ctx, polling_island *pi);
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700368
Craig Tillerd8a3c042016-09-09 12:42:37 -0700369#ifdef GRPC_WORKQUEUE_REFCOUNT_DEBUG
Craig Tillera10b0b12016-09-09 16:20:07 -0700370static void pi_add_ref_dbg(polling_island *pi, const char *reason,
371 const char *file, int line) {
Craig Tiller15007612016-07-06 09:36:16 -0700372 long old_cnt = gpr_atm_acq_load(&pi->ref_count);
Sree Kuchibhotla6a295452016-06-23 15:53:10 -0700373 pi_add_ref(pi);
374 gpr_log(GPR_DEBUG, "Add ref pi: %p, old: %ld -> new:%ld (%s) - (%s, %d)",
375 (void *)pi, old_cnt, old_cnt + 1, reason, file, line);
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700376}
377
Craig Tillerb39307d2016-06-30 15:39:13 -0700378static void pi_unref_dbg(grpc_exec_ctx *exec_ctx, polling_island *pi,
Craig Tillera10b0b12016-09-09 16:20:07 -0700379 const char *reason, const char *file, int line) {
Craig Tiller15007612016-07-06 09:36:16 -0700380 long old_cnt = gpr_atm_acq_load(&pi->ref_count);
Craig Tillerb39307d2016-06-30 15:39:13 -0700381 pi_unref(exec_ctx, pi);
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700382 gpr_log(GPR_DEBUG, "Unref pi: %p, old:%ld -> new:%ld (%s) - (%s, %d)",
Sree Kuchibhotla6a295452016-06-23 15:53:10 -0700383 (void *)pi, old_cnt, (old_cnt - 1), reason, file, line);
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700384}
Craig Tillerd8a3c042016-09-09 12:42:37 -0700385
386static grpc_workqueue *workqueue_ref(grpc_workqueue *workqueue,
387 const char *file, int line,
388 const char *reason) {
389 if (workqueue != NULL) {
Craig Tillera10b0b12016-09-09 16:20:07 -0700390 pi_add_ref_dbg((polling_island *)workqueue, reason, file, line);
Craig Tillerd8a3c042016-09-09 12:42:37 -0700391 }
392 return workqueue;
393}
394
395static void workqueue_unref(grpc_exec_ctx *exec_ctx, grpc_workqueue *workqueue,
396 const char *file, int line, const char *reason) {
397 if (workqueue != NULL) {
Craig Tillera10b0b12016-09-09 16:20:07 -0700398 pi_unref_dbg(exec_ctx, (polling_island *)workqueue, reason, file, line);
Craig Tillerd8a3c042016-09-09 12:42:37 -0700399 }
400}
401#else
402static grpc_workqueue *workqueue_ref(grpc_workqueue *workqueue) {
403 if (workqueue != NULL) {
404 pi_add_ref((polling_island *)workqueue);
405 }
406 return workqueue;
407}
408
409static void workqueue_unref(grpc_exec_ctx *exec_ctx,
410 grpc_workqueue *workqueue) {
411 if (workqueue != NULL) {
412 pi_unref(exec_ctx, (polling_island *)workqueue);
413 }
414}
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700415#endif
416
Craig Tiller15007612016-07-06 09:36:16 -0700417static void pi_add_ref(polling_island *pi) {
418 gpr_atm_no_barrier_fetch_add(&pi->ref_count, 1);
419}
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700420
Craig Tillerb39307d2016-06-30 15:39:13 -0700421static void pi_unref(grpc_exec_ctx *exec_ctx, polling_island *pi) {
Craig Tillerd8a3c042016-09-09 12:42:37 -0700422 /* If ref count went to zero, delete the polling island.
Sree Kuchibhotla6a295452016-06-23 15:53:10 -0700423 Note that this deletion not be done under a lock. Once the ref count goes
424 to zero, we are guaranteed that no one else holds a reference to the
425 polling island (and that there is no racing pi_add_ref() call either).
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700426
427 Also, if we are deleting the polling island and the merged_to field is
428 non-empty, we should remove a ref to the merged_to polling island
429 */
Craig Tillerd8a3c042016-09-09 12:42:37 -0700430 if (1 == gpr_atm_full_fetch_add(&pi->ref_count, -1)) {
431 polling_island *next = (polling_island *)gpr_atm_acq_load(&pi->merged_to);
432 polling_island_delete(exec_ctx, pi);
433 if (next != NULL) {
434 PI_UNREF(exec_ctx, next, "pi_delete"); /* Recursive call */
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700435 }
436 }
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700437}
438
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700439/* The caller is expected to hold pi->mu lock before calling this function */
440static void polling_island_add_fds_locked(polling_island *pi, grpc_fd **fds,
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700441 size_t fd_count, bool add_fd_refs,
442 grpc_error **error) {
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700443 int err;
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700444 size_t i;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700445 struct epoll_event ev;
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700446 char *err_msg;
447 const char *err_desc = "polling_island_add_fds";
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700448
Sree Kuchibhotlaad2c4772016-06-13 19:06:54 -0700449#ifdef GRPC_TSAN
Sree Kuchibhotla41622a82016-06-13 16:43:14 -0700450 /* See the definition of g_epoll_sync for more context */
Sree Kuchibhotla0224dcc2016-06-22 18:04:00 -0700451 gpr_atm_rel_store(&g_epoll_sync, (gpr_atm)0);
Sree Kuchibhotlaad2c4772016-06-13 19:06:54 -0700452#endif /* defined(GRPC_TSAN) */
Sree Kuchibhotla41622a82016-06-13 16:43:14 -0700453
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700454 for (i = 0; i < fd_count; i++) {
455 ev.events = (uint32_t)(EPOLLIN | EPOLLOUT | EPOLLET);
456 ev.data.ptr = fds[i];
457 err = epoll_ctl(pi->epoll_fd, EPOLL_CTL_ADD, fds[i]->fd, &ev);
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700458
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700459 if (err < 0) {
460 if (errno != EEXIST) {
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700461 gpr_asprintf(
462 &err_msg,
463 "epoll_ctl (epoll_fd: %d) add fd: %d failed with error: %d (%s)",
464 pi->epoll_fd, fds[i]->fd, errno, strerror(errno));
465 append_error(error, GRPC_OS_ERROR(errno, err_msg), err_desc);
466 gpr_free(err_msg);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700467 }
468
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700469 continue;
470 }
471
472 if (pi->fd_cnt == pi->fd_capacity) {
473 pi->fd_capacity = GPR_MAX(pi->fd_capacity + 8, pi->fd_cnt * 3 / 2);
474 pi->fds = gpr_realloc(pi->fds, sizeof(grpc_fd *) * pi->fd_capacity);
475 }
476
477 pi->fds[pi->fd_cnt++] = fds[i];
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700478 if (add_fd_refs) {
479 GRPC_FD_REF(fds[i], "polling_island");
480 }
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700481 }
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700482}
483
Sree Kuchibhotla24b10622016-06-08 15:20:17 -0700484/* The caller is expected to hold pi->mu before calling this */
485static void polling_island_add_wakeup_fd_locked(polling_island *pi,
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700486 grpc_wakeup_fd *wakeup_fd,
487 grpc_error **error) {
Sree Kuchibhotla24b10622016-06-08 15:20:17 -0700488 struct epoll_event ev;
489 int err;
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700490 char *err_msg;
491 const char *err_desc = "polling_island_add_wakeup_fd";
Sree Kuchibhotla24b10622016-06-08 15:20:17 -0700492
493 ev.events = (uint32_t)(EPOLLIN | EPOLLET);
494 ev.data.ptr = wakeup_fd;
495 err = epoll_ctl(pi->epoll_fd, EPOLL_CTL_ADD,
496 GRPC_WAKEUP_FD_GET_READ_FD(wakeup_fd), &ev);
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700497 if (err < 0 && errno != EEXIST) {
498 gpr_asprintf(&err_msg,
499 "epoll_ctl (epoll_fd: %d) add wakeup fd: %d failed with "
500 "error: %d (%s)",
Craig Tiller1fa9ddb2016-11-28 08:19:37 -0800501 pi->epoll_fd, GRPC_WAKEUP_FD_GET_READ_FD(&global_wakeup_fd),
502 errno, strerror(errno));
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700503 append_error(error, GRPC_OS_ERROR(errno, err_msg), err_desc);
504 gpr_free(err_msg);
Sree Kuchibhotla24b10622016-06-08 15:20:17 -0700505 }
506}
507
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700508/* The caller is expected to hold pi->mu lock before calling this function */
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700509static void polling_island_remove_all_fds_locked(polling_island *pi,
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700510 bool remove_fd_refs,
511 grpc_error **error) {
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700512 int err;
513 size_t i;
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700514 char *err_msg;
515 const char *err_desc = "polling_island_remove_fds";
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700516
517 for (i = 0; i < pi->fd_cnt; i++) {
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700518 err = epoll_ctl(pi->epoll_fd, EPOLL_CTL_DEL, pi->fds[i]->fd, NULL);
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700519 if (err < 0 && errno != ENOENT) {
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700520 gpr_asprintf(&err_msg,
521 "epoll_ctl (epoll_fd: %d) delete fds[%zu]: %d failed with "
522 "error: %d (%s)",
523 pi->epoll_fd, i, pi->fds[i]->fd, errno, strerror(errno));
524 append_error(error, GRPC_OS_ERROR(errno, err_msg), err_desc);
525 gpr_free(err_msg);
Sree Kuchibhotlaad162ba2016-06-06 16:23:37 -0700526 }
527
528 if (remove_fd_refs) {
529 GRPC_FD_UNREF(pi->fds[i], "polling_island");
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700530 }
531 }
532
533 pi->fd_cnt = 0;
534}
535
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700536/* The caller is expected to hold pi->mu lock before calling this function */
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700537static void polling_island_remove_fd_locked(polling_island *pi, grpc_fd *fd,
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700538 bool is_fd_closed,
539 grpc_error **error) {
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700540 int err;
541 size_t i;
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700542 char *err_msg;
543 const char *err_desc = "polling_island_remove_fd";
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700544
Sree Kuchibhotla79a62332016-06-04 14:01:03 -0700545 /* If fd is already closed, then it would have been automatically been removed
546 from the epoll set */
547 if (!is_fd_closed) {
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700548 err = epoll_ctl(pi->epoll_fd, EPOLL_CTL_DEL, fd->fd, NULL);
549 if (err < 0 && errno != ENOENT) {
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700550 gpr_asprintf(
551 &err_msg,
552 "epoll_ctl (epoll_fd: %d) del fd: %d failed with error: %d (%s)",
553 pi->epoll_fd, fd->fd, errno, strerror(errno));
554 append_error(error, GRPC_OS_ERROR(errno, err_msg), err_desc);
555 gpr_free(err_msg);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700556 }
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700557 }
558
559 for (i = 0; i < pi->fd_cnt; i++) {
560 if (pi->fds[i] == fd) {
561 pi->fds[i] = pi->fds[--pi->fd_cnt];
Sree Kuchibhotla79a62332016-06-04 14:01:03 -0700562 GRPC_FD_UNREF(fd, "polling_island");
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700563 break;
564 }
565 }
566}
567
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700568/* Might return NULL in case of an error */
Craig Tillerb39307d2016-06-30 15:39:13 -0700569static polling_island *polling_island_create(grpc_exec_ctx *exec_ctx,
570 grpc_fd *initial_fd,
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700571 grpc_error **error) {
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700572 polling_island *pi = NULL;
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700573 const char *err_desc = "polling_island_create";
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700574
Craig Tillerb39307d2016-06-30 15:39:13 -0700575 *error = GRPC_ERROR_NONE;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700576
Craig Tillerb39307d2016-06-30 15:39:13 -0700577 pi = gpr_malloc(sizeof(*pi));
Craig Tiller91031da2016-12-28 15:44:25 -0800578 pi->workqueue_scheduler.vtable = &workqueue_scheduler_vtable;
Craig Tillerb39307d2016-06-30 15:39:13 -0700579 gpr_mu_init(&pi->mu);
580 pi->fd_cnt = 0;
581 pi->fd_capacity = 0;
582 pi->fds = NULL;
583 pi->epoll_fd = -1;
Craig Tillerd8a3c042016-09-09 12:42:37 -0700584
585 gpr_mu_init(&pi->workqueue_read_mu);
586 gpr_mpscq_init(&pi->workqueue_items);
587 gpr_atm_rel_store(&pi->workqueue_item_count, 0);
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700588
Craig Tiller15007612016-07-06 09:36:16 -0700589 gpr_atm_rel_store(&pi->ref_count, 0);
Craig Tillerd8a3c042016-09-09 12:42:37 -0700590 gpr_atm_rel_store(&pi->poller_count, 0);
Sree Kuchibhotla0224dcc2016-06-22 18:04:00 -0700591 gpr_atm_rel_store(&pi->merged_to, (gpr_atm)NULL);
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700592
Craig Tillerd8a3c042016-09-09 12:42:37 -0700593 if (!append_error(error, grpc_wakeup_fd_init(&pi->workqueue_wakeup_fd),
594 err_desc)) {
595 goto done;
596 }
597
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700598 pi->epoll_fd = epoll_create1(EPOLL_CLOEXEC);
Sree Kuchibhotla41622a82016-06-13 16:43:14 -0700599
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700600 if (pi->epoll_fd < 0) {
Craig Tillerb39307d2016-06-30 15:39:13 -0700601 append_error(error, GRPC_OS_ERROR(errno, "epoll_create1"), err_desc);
602 goto done;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700603 }
604
Craig Tillerb4b8e1e2016-11-28 07:33:13 -0800605 polling_island_add_wakeup_fd_locked(pi, &global_wakeup_fd, error);
Craig Tillerd8a3c042016-09-09 12:42:37 -0700606 polling_island_add_wakeup_fd_locked(pi, &pi->workqueue_wakeup_fd, error);
Craig Tillerb39307d2016-06-30 15:39:13 -0700607
608 if (initial_fd != NULL) {
Craig Tillerb39307d2016-06-30 15:39:13 -0700609 polling_island_add_fds_locked(pi, &initial_fd, 1, true, error);
Craig Tillerb39307d2016-06-30 15:39:13 -0700610 }
611
Craig Tillerb39307d2016-06-30 15:39:13 -0700612done:
613 if (*error != GRPC_ERROR_NONE) {
Craig Tiller0a06cd72016-07-14 13:21:24 -0700614 polling_island_delete(exec_ctx, pi);
Craig Tillerb39307d2016-06-30 15:39:13 -0700615 pi = NULL;
616 }
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700617 return pi;
618}
619
Craig Tillerb39307d2016-06-30 15:39:13 -0700620static void polling_island_delete(grpc_exec_ctx *exec_ctx, polling_island *pi) {
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700621 GPR_ASSERT(pi->fd_cnt == 0);
622
Craig Tiller0a06cd72016-07-14 13:21:24 -0700623 if (pi->epoll_fd >= 0) {
624 close(pi->epoll_fd);
625 }
Craig Tillerd8a3c042016-09-09 12:42:37 -0700626 GPR_ASSERT(gpr_atm_no_barrier_load(&pi->workqueue_item_count) == 0);
627 gpr_mu_destroy(&pi->workqueue_read_mu);
628 gpr_mpscq_destroy(&pi->workqueue_items);
Craig Tillerb39307d2016-06-30 15:39:13 -0700629 gpr_mu_destroy(&pi->mu);
Craig Tillerd8a3c042016-09-09 12:42:37 -0700630 grpc_wakeup_fd_destroy(&pi->workqueue_wakeup_fd);
Craig Tillerb39307d2016-06-30 15:39:13 -0700631 gpr_free(pi->fds);
632 gpr_free(pi);
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700633}
634
Sree Kuchibhotla229533b12016-06-21 20:42:52 -0700635/* Attempts to gets the last polling island in the linked list (liked by the
636 * 'merged_to' field). Since this does not lock the polling island, there are no
637 * guarantees that the island returned is the last island */
638static polling_island *polling_island_maybe_get_latest(polling_island *pi) {
639 polling_island *next = (polling_island *)gpr_atm_acq_load(&pi->merged_to);
640 while (next != NULL) {
641 pi = next;
642 next = (polling_island *)gpr_atm_acq_load(&pi->merged_to);
643 }
644
645 return pi;
646}
647
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700648/* Gets the lock on the *latest* polling island i.e the last polling island in
Sree Kuchibhotla229533b12016-06-21 20:42:52 -0700649 the linked list (linked by the 'merged_to' field). Call gpr_mu_unlock on the
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700650 returned polling island's mu.
651 Usage: To lock/unlock polling island "pi", do the following:
652 polling_island *pi_latest = polling_island_lock(pi);
653 ...
654 ... critical section ..
655 ...
Sree Kuchibhotla229533b12016-06-21 20:42:52 -0700656 gpr_mu_unlock(&pi_latest->mu); // NOTE: use pi_latest->mu. NOT pi->mu */
657static polling_island *polling_island_lock(polling_island *pi) {
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700658 polling_island *next = NULL;
Sree Kuchibhotla229533b12016-06-21 20:42:52 -0700659
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700660 while (true) {
661 next = (polling_island *)gpr_atm_acq_load(&pi->merged_to);
662 if (next == NULL) {
Sree Kuchibhotla229533b12016-06-21 20:42:52 -0700663 /* Looks like 'pi' is the last node in the linked list but unless we check
664 this by holding the pi->mu lock, we cannot be sure (i.e without the
665 pi->mu lock, we don't prevent island merges).
666 To be absolutely sure, check once more by holding the pi->mu lock */
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700667 gpr_mu_lock(&pi->mu);
668 next = (polling_island *)gpr_atm_acq_load(&pi->merged_to);
669 if (next == NULL) {
Sree Kuchibhotla229533b12016-06-21 20:42:52 -0700670 /* pi is infact the last node and we have the pi->mu lock. we're done */
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700671 break;
672 }
Sree Kuchibhotla229533b12016-06-21 20:42:52 -0700673
674 /* pi->merged_to is not NULL i.e pi isn't the last node anymore. pi->mu
675 * isn't the lock we are interested in. Continue traversing the list */
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700676 gpr_mu_unlock(&pi->mu);
677 }
678
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700679 pi = next;
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700680 }
681
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700682 return pi;
683}
684
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700685/* Gets the lock on the *latest* polling islands in the linked lists pointed by
686 *p and *q (and also updates *p and *q to point to the latest polling islands)
687
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700688 This function is needed because calling the following block of code to obtain
689 locks on polling islands (*p and *q) is prone to deadlocks.
690 {
Sree Kuchibhotla229533b12016-06-21 20:42:52 -0700691 polling_island_lock(*p, true);
692 polling_island_lock(*q, true);
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700693 }
694
Sree Kuchibhotla229533b12016-06-21 20:42:52 -0700695 Usage/example:
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700696 polling_island *p1;
697 polling_island *p2;
698 ..
699 polling_island_lock_pair(&p1, &p2);
700 ..
701 .. Critical section with both p1 and p2 locked
702 ..
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700703 // Release locks: Always call polling_island_unlock_pair() to release locks
704 polling_island_unlock_pair(p1, p2);
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700705*/
Sree Kuchibhotla229533b12016-06-21 20:42:52 -0700706static void polling_island_lock_pair(polling_island **p, polling_island **q) {
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700707 polling_island *pi_1 = *p;
708 polling_island *pi_2 = *q;
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700709 polling_island *next_1 = NULL;
710 polling_island *next_2 = NULL;
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700711
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700712 /* The algorithm is simple:
713 - Go to the last polling islands in the linked lists *pi_1 and *pi_2 (and
714 keep updating pi_1 and pi_2)
715 - Then obtain locks on the islands by following a lock order rule of
716 locking polling_island with lower address first
717 Special case: Before obtaining the locks, check if pi_1 and pi_2 are
718 pointing to the same island. If that is the case, we can just call
719 polling_island_lock()
720 - After obtaining both the locks, double check that the polling islands
721 are still the last polling islands in their respective linked lists
722 (this is because there might have been polling island merges before
723 we got the lock)
724 - If the polling islands are the last islands, we are done. If not,
725 release the locks and continue the process from the first step */
726 while (true) {
727 next_1 = (polling_island *)gpr_atm_acq_load(&pi_1->merged_to);
728 while (next_1 != NULL) {
729 pi_1 = next_1;
730 next_1 = (polling_island *)gpr_atm_acq_load(&pi_1->merged_to);
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700731 }
732
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700733 next_2 = (polling_island *)gpr_atm_acq_load(&pi_2->merged_to);
734 while (next_2 != NULL) {
735 pi_2 = next_2;
736 next_2 = (polling_island *)gpr_atm_acq_load(&pi_2->merged_to);
737 }
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700738
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700739 if (pi_1 == pi_2) {
740 pi_1 = pi_2 = polling_island_lock(pi_1);
741 break;
742 }
743
744 if (pi_1 < pi_2) {
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700745 gpr_mu_lock(&pi_1->mu);
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700746 gpr_mu_lock(&pi_2->mu);
747 } else {
748 gpr_mu_lock(&pi_2->mu);
749 gpr_mu_lock(&pi_1->mu);
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700750 }
751
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700752 next_1 = (polling_island *)gpr_atm_acq_load(&pi_1->merged_to);
753 next_2 = (polling_island *)gpr_atm_acq_load(&pi_2->merged_to);
754 if (next_1 == NULL && next_2 == NULL) {
755 break;
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700756 }
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700757
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700758 gpr_mu_unlock(&pi_1->mu);
759 gpr_mu_unlock(&pi_2->mu);
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700760 }
761
762 *p = pi_1;
763 *q = pi_2;
764}
765
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700766static void polling_island_unlock_pair(polling_island *p, polling_island *q) {
767 if (p == q) {
768 gpr_mu_unlock(&p->mu);
769 } else {
770 gpr_mu_unlock(&p->mu);
771 gpr_mu_unlock(&q->mu);
772 }
773}
774
Craig Tillerd8a3c042016-09-09 12:42:37 -0700775static void workqueue_maybe_wakeup(polling_island *pi) {
Craig Tiller2e620132016-10-10 15:27:44 -0700776 /* If this thread is the current poller, then it may be that it's about to
777 decrement the current poller count, so we need to look past this thread */
Craig Tillerd8a3c042016-09-09 12:42:37 -0700778 bool is_current_poller = (g_current_thread_polling_island == pi);
779 gpr_atm min_current_pollers_for_wakeup = is_current_poller ? 1 : 0;
780 gpr_atm current_pollers = gpr_atm_no_barrier_load(&pi->poller_count);
Craig Tiller2e620132016-10-10 15:27:44 -0700781 /* Only issue a wakeup if it's likely that some poller could come in and take
782 it right now. Note that since we do an anticipatory mpscq_pop every poll
783 loop, it's ok if we miss the wakeup here, as we'll get the work item when
784 the next poller enters anyway. */
785 if (current_pollers > min_current_pollers_for_wakeup) {
Craig Tillerd8a3c042016-09-09 12:42:37 -0700786 GRPC_LOG_IF_ERROR("workqueue_wakeup_fd",
787 grpc_wakeup_fd_wakeup(&pi->workqueue_wakeup_fd));
788 }
789}
790
791static void workqueue_move_items_to_parent(polling_island *q) {
792 polling_island *p = (polling_island *)gpr_atm_no_barrier_load(&q->merged_to);
793 if (p == NULL) {
794 return;
795 }
796 gpr_mu_lock(&q->workqueue_read_mu);
797 int num_added = 0;
798 while (gpr_atm_no_barrier_load(&q->workqueue_item_count) > 0) {
799 gpr_mpscq_node *n = gpr_mpscq_pop(&q->workqueue_items);
800 if (n != NULL) {
801 gpr_atm_no_barrier_fetch_add(&q->workqueue_item_count, -1);
802 gpr_atm_no_barrier_fetch_add(&p->workqueue_item_count, 1);
803 gpr_mpscq_push(&p->workqueue_items, n);
804 num_added++;
805 }
806 }
807 gpr_mu_unlock(&q->workqueue_read_mu);
808 if (num_added > 0) {
809 workqueue_maybe_wakeup(p);
810 }
811 workqueue_move_items_to_parent(p);
812}
813
Sree Kuchibhotla229533b12016-06-21 20:42:52 -0700814static polling_island *polling_island_merge(polling_island *p,
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700815 polling_island *q,
816 grpc_error **error) {
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700817 /* Get locks on both the polling islands */
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700818 polling_island_lock_pair(&p, &q);
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700819
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700820 if (p != q) {
821 /* Make sure that p points to the polling island with fewer fds than q */
822 if (p->fd_cnt > q->fd_cnt) {
823 GPR_SWAP(polling_island *, p, q);
824 }
825
826 /* Merge p with q i.e move all the fds from p (The one with fewer fds) to q
827 Note that the refcounts on the fds being moved will not change here.
828 This is why the last param in the following two functions is 'false') */
829 polling_island_add_fds_locked(q, p->fds, p->fd_cnt, false, error);
830 polling_island_remove_all_fds_locked(p, false, error);
831
832 /* Wakeup all the pollers (if any) on p so that they pickup this change */
833 polling_island_add_wakeup_fd_locked(p, &polling_island_wakeup_fd, error);
834
835 /* Add the 'merged_to' link from p --> q */
836 gpr_atm_rel_store(&p->merged_to, (gpr_atm)q);
837 PI_ADD_REF(q, "pi_merge"); /* To account for the new incoming ref from p */
Craig Tillerd8a3c042016-09-09 12:42:37 -0700838
Harvey Tuchdaa9f452016-11-21 15:42:49 -0500839 workqueue_move_items_to_parent(p);
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700840 }
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700841 /* else if p == q, nothing needs to be done */
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700842
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700843 polling_island_unlock_pair(p, q);
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700844
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -0700845 /* Return the merged polling island (Note that no merge would have happened
846 if p == q which is ok) */
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700847 return q;
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -0700848}
849
Craig Tiller91031da2016-12-28 15:44:25 -0800850static void workqueue_enqueue(grpc_exec_ctx *exec_ctx, grpc_closure *closure,
Craig Tillerd8a3c042016-09-09 12:42:37 -0700851 grpc_error *error) {
Craig Tillerd8a3c042016-09-09 12:42:37 -0700852 GPR_TIMER_BEGIN("workqueue.enqueue", 0);
Craig Tiller91031da2016-12-28 15:44:25 -0800853 grpc_workqueue *workqueue = (grpc_workqueue *)closure->scheduler;
Craig Tiller1dc5dbb2016-09-09 17:09:39 -0700854 /* take a ref to the workqueue: otherwise it can happen that whatever events
855 * this kicks off ends up destroying the workqueue before this function
856 * completes */
857 GRPC_WORKQUEUE_REF(workqueue, "enqueue");
858 polling_island *pi = (polling_island *)workqueue;
Craig Tillerd8a3c042016-09-09 12:42:37 -0700859 gpr_atm last = gpr_atm_no_barrier_fetch_add(&pi->workqueue_item_count, 1);
860 closure->error_data.error = error;
861 gpr_mpscq_push(&pi->workqueue_items, &closure->next_data.atm_next);
862 if (last == 0) {
863 workqueue_maybe_wakeup(pi);
864 }
Craig Tillerd8a3c042016-09-09 12:42:37 -0700865 workqueue_move_items_to_parent(pi);
Craig Tiller1dc5dbb2016-09-09 17:09:39 -0700866 GRPC_WORKQUEUE_UNREF(exec_ctx, workqueue, "enqueue");
867 GPR_TIMER_END("workqueue.enqueue", 0);
Craig Tillerd8a3c042016-09-09 12:42:37 -0700868}
869
Craig Tiller91031da2016-12-28 15:44:25 -0800870static grpc_closure_scheduler *workqueue_scheduler(grpc_workqueue *workqueue) {
871 polling_island *pi = (polling_island *)workqueue;
Craig Tiller801c6cc2017-01-03 08:13:13 -0800872 return workqueue == NULL ? grpc_schedule_on_exec_ctx
873 : &pi->workqueue_scheduler;
Craig Tiller91031da2016-12-28 15:44:25 -0800874}
875
Sree Kuchibhotla3131c262016-06-21 17:28:28 -0700876static grpc_error *polling_island_global_init() {
877 grpc_error *error = GRPC_ERROR_NONE;
878
Sree Kuchibhotla3131c262016-06-21 17:28:28 -0700879 error = grpc_wakeup_fd_init(&polling_island_wakeup_fd);
880 if (error == GRPC_ERROR_NONE) {
881 error = grpc_wakeup_fd_wakeup(&polling_island_wakeup_fd);
882 }
883
884 return error;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700885}
886
Sree Kuchibhotlad627c102016-06-06 15:49:32 -0700887static void polling_island_global_shutdown() {
Sree Kuchibhotla24b10622016-06-08 15:20:17 -0700888 grpc_wakeup_fd_destroy(&polling_island_wakeup_fd);
Sree Kuchibhotlad627c102016-06-06 15:49:32 -0700889}
890
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700891/*******************************************************************************
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700892 * Fd Definitions
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700893 */
894
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700895/* We need to keep a freelist not because of any concerns of malloc performance
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700896 * but instead so that implementations with multiple threads in (for example)
897 * epoll_wait deal with the race between pollset removal and incoming poll
898 * notifications.
899 *
900 * The problem is that the poller ultimately holds a reference to this
901 * object, so it is very difficult to know when is safe to free it, at least
902 * without some expensive synchronization.
903 *
904 * If we keep the object freelisted, in the worst case losing this race just
905 * becomes a spurious read notification on a reused fd.
906 */
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700907
908/* The alarm system needs to be able to wakeup 'some poller' sometimes
909 * (specifically when a new alarm needs to be triggered earlier than the next
910 * alarm 'epoch'). This wakeup_fd gives us something to alert on when such a
911 * case occurs. */
Sree Kuchibhotla9bc3d2d2016-06-06 10:27:56 -0700912
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700913static grpc_fd *fd_freelist = NULL;
914static gpr_mu fd_freelist_mu;
915
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700916#ifdef GRPC_FD_REF_COUNT_DEBUG
917#define REF_BY(fd, n, reason) ref_by(fd, n, reason, __FILE__, __LINE__)
918#define UNREF_BY(fd, n, reason) unref_by(fd, n, reason, __FILE__, __LINE__)
919static void ref_by(grpc_fd *fd, int n, const char *reason, const char *file,
920 int line) {
Sree Kuchibhotla6a295452016-06-23 15:53:10 -0700921 gpr_log(GPR_DEBUG, "FD %d %p ref %d %ld -> %ld [%s; %s:%d]", fd->fd,
922 (void *)fd, n, gpr_atm_no_barrier_load(&fd->refst),
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700923 gpr_atm_no_barrier_load(&fd->refst) + n, reason, file, line);
924#else
925#define REF_BY(fd, n, reason) ref_by(fd, n)
926#define UNREF_BY(fd, n, reason) unref_by(fd, n)
927static void ref_by(grpc_fd *fd, int n) {
928#endif
929 GPR_ASSERT(gpr_atm_no_barrier_fetch_add(&fd->refst, n) > 0);
930}
931
932#ifdef GRPC_FD_REF_COUNT_DEBUG
933static void unref_by(grpc_fd *fd, int n, const char *reason, const char *file,
934 int line) {
935 gpr_atm old;
Sree Kuchibhotla6a295452016-06-23 15:53:10 -0700936 gpr_log(GPR_DEBUG, "FD %d %p unref %d %ld -> %ld [%s; %s:%d]", fd->fd,
937 (void *)fd, n, gpr_atm_no_barrier_load(&fd->refst),
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700938 gpr_atm_no_barrier_load(&fd->refst) - n, reason, file, line);
939#else
940static void unref_by(grpc_fd *fd, int n) {
941 gpr_atm old;
942#endif
943 old = gpr_atm_full_fetch_add(&fd->refst, -n);
944 if (old == n) {
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700945 /* Add the fd to the freelist */
946 gpr_mu_lock(&fd_freelist_mu);
947 fd->freelist_next = fd_freelist;
948 fd_freelist = fd;
949 grpc_iomgr_unregister_object(&fd->iomgr_object);
Sree Kuchibhotla82d73412017-02-09 18:27:45 -0800950
Sree Kuchibhotlaa70ccb62017-02-13 23:16:52 -0800951 grpc_error *err = (grpc_error *)gpr_atm_acq_load(&fd->shutdown_error);
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -0800952 /* Clear the least significant bit if it set (in case fd was shutdown) */
953 err = (grpc_error *)((intptr_t)err & ~FD_SHUTDOWN_BIT);
Sree Kuchibhotla8b8cbed2017-02-09 21:31:27 -0800954 GRPC_ERROR_UNREF(err);
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -0700955
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700956 gpr_mu_unlock(&fd_freelist_mu);
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700957 } else {
958 GPR_ASSERT(old > n);
959 }
960}
961
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700962/* Increment refcount by two to avoid changing the orphan bit */
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700963#ifdef GRPC_FD_REF_COUNT_DEBUG
964static void fd_ref(grpc_fd *fd, const char *reason, const char *file,
965 int line) {
966 ref_by(fd, 2, reason, file, line);
967}
968
969static void fd_unref(grpc_fd *fd, const char *reason, const char *file,
970 int line) {
971 unref_by(fd, 2, reason, file, line);
972}
973#else
974static void fd_ref(grpc_fd *fd) { ref_by(fd, 2); }
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -0700975static void fd_unref(grpc_fd *fd) { unref_by(fd, 2); }
976#endif
977
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700978static void fd_global_init(void) { gpr_mu_init(&fd_freelist_mu); }
979
980static void fd_global_shutdown(void) {
981 gpr_mu_lock(&fd_freelist_mu);
982 gpr_mu_unlock(&fd_freelist_mu);
983 while (fd_freelist != NULL) {
984 grpc_fd *fd = fd_freelist;
985 fd_freelist = fd_freelist->freelist_next;
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -0800986 gpr_mu_destroy(&fd->po.mu);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -0700987 gpr_free(fd);
988 }
989 gpr_mu_destroy(&fd_freelist_mu);
990}
991
992static grpc_fd *fd_create(int fd, const char *name) {
993 grpc_fd *new_fd = NULL;
994
995 gpr_mu_lock(&fd_freelist_mu);
996 if (fd_freelist != NULL) {
997 new_fd = fd_freelist;
998 fd_freelist = fd_freelist->freelist_next;
999 }
1000 gpr_mu_unlock(&fd_freelist_mu);
1001
1002 if (new_fd == NULL) {
1003 new_fd = gpr_malloc(sizeof(grpc_fd));
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001004 gpr_mu_init(&new_fd->po.mu);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001005 }
1006
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001007 /* Note: It is not really needed to get the new_fd->po.mu lock here. If this
1008 * is a newly created fd (or an fd we got from the freelist), no one else
1009 * would be holding a lock to it anyway. */
1010 gpr_mu_lock(&new_fd->po.mu);
1011 new_fd->po.pi = NULL;
Sree Kuchibhotlaa0749a62016-11-18 20:22:09 -08001012#ifdef PO_DEBUG
1013 new_fd->po.obj_type = POLL_OBJ_FD;
1014#endif
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001015
Sree Kuchibhotla0224dcc2016-06-22 18:04:00 -07001016 gpr_atm_rel_store(&new_fd->refst, (gpr_atm)1);
Sree Kuchibhotla5855c472016-06-08 12:56:56 -07001017 new_fd->fd = fd;
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -08001018 gpr_atm_no_barrier_store(&new_fd->shutdown_error, (gpr_atm)GRPC_ERROR_NONE);
Sree Kuchibhotla5855c472016-06-08 12:56:56 -07001019 new_fd->orphaned = false;
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -08001020 gpr_atm_no_barrier_store(&new_fd->read_closure, CLOSURE_NOT_READY);
1021 gpr_atm_no_barrier_store(&new_fd->write_closure, CLOSURE_NOT_READY);
1022 gpr_atm_no_barrier_store(&new_fd->read_notifier_pollset, (gpr_atm)NULL);
Sree Kuchibhotla82d73412017-02-09 18:27:45 -08001023
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001024 new_fd->freelist_next = NULL;
1025 new_fd->on_done_closure = NULL;
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001026
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001027 gpr_mu_unlock(&new_fd->po.mu);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001028
1029 char *fd_name;
1030 gpr_asprintf(&fd_name, "%s fd=%d", name, fd);
1031 grpc_iomgr_register_object(&new_fd->iomgr_object, fd_name);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001032#ifdef GRPC_FD_REF_COUNT_DEBUG
Sree Kuchibhotla6a295452016-06-23 15:53:10 -07001033 gpr_log(GPR_DEBUG, "FD %d %p create %s", fd, (void *)new_fd, fd_name);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001034#endif
Sree Kuchibhotla6a295452016-06-23 15:53:10 -07001035 gpr_free(fd_name);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001036 return new_fd;
1037}
1038
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001039static int fd_wrapped_fd(grpc_fd *fd) {
1040 int ret_fd = -1;
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001041 gpr_mu_lock(&fd->po.mu);
Sree Kuchibhotla79a62332016-06-04 14:01:03 -07001042 if (!fd->orphaned) {
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001043 ret_fd = fd->fd;
1044 }
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001045 gpr_mu_unlock(&fd->po.mu);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001046
1047 return ret_fd;
1048}
1049
1050static void fd_orphan(grpc_exec_ctx *exec_ctx, grpc_fd *fd,
1051 grpc_closure *on_done, int *release_fd,
1052 const char *reason) {
Sree Kuchibhotla79a62332016-06-04 14:01:03 -07001053 bool is_fd_closed = false;
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001054 grpc_error *error = GRPC_ERROR_NONE;
Craig Tiller15007612016-07-06 09:36:16 -07001055 polling_island *unref_pi = NULL;
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001056
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001057 gpr_mu_lock(&fd->po.mu);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001058 fd->on_done_closure = on_done;
1059
1060 /* If release_fd is not NULL, we should be relinquishing control of the file
1061 descriptor fd->fd (but we still own the grpc_fd structure). */
Sree Kuchibhotla79a62332016-06-04 14:01:03 -07001062 if (release_fd != NULL) {
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001063 *release_fd = fd->fd;
Sree Kuchibhotla79a62332016-06-04 14:01:03 -07001064 } else {
1065 close(fd->fd);
1066 is_fd_closed = true;
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001067 }
1068
Sree Kuchibhotla79a62332016-06-04 14:01:03 -07001069 fd->orphaned = true;
1070
1071 /* Remove the active status but keep referenced. We want this grpc_fd struct
1072 to be alive (and not added to freelist) until the end of this function */
1073 REF_BY(fd, 1, reason);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001074
1075 /* Remove the fd from the polling island:
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07001076 - Get a lock on the latest polling island (i.e the last island in the
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001077 linked list pointed by fd->po.pi). This is the island that
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07001078 would actually contain the fd
1079 - Remove the fd from the latest polling island
1080 - Unlock the latest polling island
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001081 - Set fd->po.pi to NULL (but remove the ref on the polling island
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07001082 before doing this.) */
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001083 if (fd->po.pi != NULL) {
1084 polling_island *pi_latest = polling_island_lock(fd->po.pi);
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001085 polling_island_remove_fd_locked(pi_latest, fd, is_fd_closed, &error);
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07001086 gpr_mu_unlock(&pi_latest->mu);
Sree Kuchibhotla79a62332016-06-04 14:01:03 -07001087
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001088 unref_pi = fd->po.pi;
1089 fd->po.pi = NULL;
Sree Kuchibhotla88ee12f2016-06-03 19:26:48 -07001090 }
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001091
Craig Tiller91031da2016-12-28 15:44:25 -08001092 grpc_closure_sched(exec_ctx, fd->on_done_closure, GRPC_ERROR_REF(error));
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001093
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001094 gpr_mu_unlock(&fd->po.mu);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001095 UNREF_BY(fd, 2, reason); /* Drop the reference */
Craig Tiller15007612016-07-06 09:36:16 -07001096 if (unref_pi != NULL) {
Craig Tiller0a06cd72016-07-14 13:21:24 -07001097 /* Unref stale polling island here, outside the fd lock above.
1098 The polling island owns a workqueue which owns an fd, and unreffing
1099 inside the lock can cause an eventual lock loop that makes TSAN very
1100 unhappy. */
Craig Tiller15007612016-07-06 09:36:16 -07001101 PI_UNREF(exec_ctx, unref_pi, "fd_orphan");
1102 }
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001103 GRPC_LOG_IF_ERROR("fd_orphan", GRPC_ERROR_REF(error));
Yuchen Zenga0399f22016-08-04 17:52:53 -07001104 GRPC_ERROR_UNREF(error);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001105}
1106
Sree Kuchibhotla82d73412017-02-09 18:27:45 -08001107static void notify_on(grpc_exec_ctx *exec_ctx, grpc_fd *fd, gpr_atm *state,
1108 grpc_closure *closure) {
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -08001109 while (true) {
Sree Kuchibhotla91c4da32017-02-12 14:00:39 -08001110 /* Fast-path: CLOSURE_NOT_READY -> <closure> */
Sree Kuchibhotlafb7ced62017-02-15 18:31:57 -08001111 /* Also do a release-cas here so that there is a 'happen-before' established
1112 with acquire loads in set_ready() / set_shutdown() */
1113 if (gpr_atm_rel_cas(state, CLOSURE_NOT_READY, (gpr_atm)closure)) {
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -08001114 return; /* Fast-path successful. Return */
1115 }
1116
1117 /* Slowpath */
1118 gpr_atm curr = gpr_atm_acq_load(state);
1119 switch (curr) {
1120 case CLOSURE_NOT_READY: {
1121 break; /* retry */
1122 }
1123
1124 case CLOSURE_READY: {
1125 /* Change the state to CLOSURE_NOT_READY.
1126 If successful: Schedule the closure
1127 If not: Most likely the state transitioned to CLOSURE_NOT_READY.
1128 Retry the fast-path again */
1129 if (gpr_atm_rel_cas(state, CLOSURE_READY, CLOSURE_NOT_READY)) {
1130 grpc_closure_sched(exec_ctx, closure, GRPC_ERROR_NONE);
1131 return; /* Slow-path successful. Return */
Sree Kuchibhotla82d73412017-02-09 18:27:45 -08001132 }
1133
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -08001134 break; /* retry */
1135 }
1136
1137 default: {
1138 /* 'curr' is either a closure or the fd is shutdown(in which case 'curr'
1139 contains a pointer to the shutdown-error). If the fd is shutdown,
1140 schedule the closure with the shutdown error */
1141 if ((curr & FD_SHUTDOWN_BIT) > 0) {
1142 grpc_error *shutdown_err = (grpc_error *)(curr & ~FD_SHUTDOWN_BIT);
1143 grpc_closure_sched(
1144 exec_ctx, closure,
1145 GRPC_ERROR_CREATE_REFERENCING("FD Shutdown", &shutdown_err, 1));
1146 return;
Sree Kuchibhotla82d73412017-02-09 18:27:45 -08001147 }
1148
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -08001149 /* There is already a closure!. This indicates a bug in the code */
1150 gpr_log(GPR_ERROR,
1151 "notify_on called with a previous callback still pending");
1152 abort();
Sree Kuchibhotla91c4da32017-02-12 14:00:39 -08001153 }
1154 }
1155 }
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -08001156
1157 GPR_UNREACHABLE_CODE(return );
Sree Kuchibhotla91c4da32017-02-12 14:00:39 -08001158}
1159
1160static void set_shutdown(grpc_exec_ctx *exec_ctx, grpc_fd *fd, gpr_atm *state,
1161 grpc_error *shutdown_err) {
1162 /* Try the fast-path first (i.e expect the current value to be
1163 CLOSURE_NOT_READY */
1164 gpr_atm curr = CLOSURE_NOT_READY;
Sree Kuchibhotla2fc2b3e2017-02-14 10:05:14 -08001165 gpr_atm new_state = (gpr_atm)shutdown_err | FD_SHUTDOWN_BIT;
Sree Kuchibhotla91c4da32017-02-12 14:00:39 -08001166
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -08001167 while (true) {
Sree Kuchibhotlafb7ced62017-02-15 18:31:57 -08001168 if (gpr_atm_rel_cas(state, curr, new_state)) {
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -08001169 return; /* Fast-path successful. Return */
1170 }
1171
1172 /* Fallback to slowpath */
1173 curr = gpr_atm_acq_load(state);
1174 switch (curr) {
1175 case CLOSURE_READY: {
1176 break; /* retry */
1177 }
1178
1179 case CLOSURE_NOT_READY: {
1180 break; /* retry */
1181 }
1182
1183 default: {
1184 /* 'curr' is either a closure or the fd is already shutdown */
1185
1186 /* If fd is already shutdown, we are done */
1187 if ((curr & FD_SHUTDOWN_BIT) > 0) {
1188 return;
Sree Kuchibhotla91c4da32017-02-12 14:00:39 -08001189 }
1190
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -08001191 /* Fd is not shutdown. Schedule the closure and move the state to
1192 shutdown state */
1193 if (gpr_atm_rel_cas(state, curr, new_state)) {
1194 grpc_closure_sched(
1195 exec_ctx, (grpc_closure *)curr,
1196 GRPC_ERROR_CREATE_REFERENCING("FD Shutdown", &shutdown_err, 1));
1197 return;
Sree Kuchibhotla91c4da32017-02-12 14:00:39 -08001198 }
1199
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -08001200 /* 'curr' was a closure but now changed to a different state. We will
1201 have to retry */
1202 break;
Sree Kuchibhotla82d73412017-02-09 18:27:45 -08001203 }
1204 }
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001205 }
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -08001206
1207 GPR_UNREACHABLE_CODE(return );
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001208}
1209
Sree Kuchibhotla82d73412017-02-09 18:27:45 -08001210static void set_ready(grpc_exec_ctx *exec_ctx, grpc_fd *fd, gpr_atm *state) {
Sree Kuchibhotlafb7ced62017-02-15 18:31:57 -08001211 /* Try an optimistic case first (i.e assume current state is
1212 CLOSURE_NOT_READY) */
1213 if (gpr_atm_rel_cas(state, CLOSURE_NOT_READY, CLOSURE_READY)) {
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -08001214 return; /* early out */
1215 }
Sree Kuchibhotla82d73412017-02-09 18:27:45 -08001216
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -08001217 gpr_atm curr = gpr_atm_acq_load(state);
1218 switch (curr) {
1219 case CLOSURE_READY: {
1220 /* Already ready. We are done here */
1221 break;
Sree Kuchibhotla82d73412017-02-09 18:27:45 -08001222 }
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -08001223
1224 case CLOSURE_NOT_READY: {
1225 /* The state was not CLOSURE_NOT_READY when we checked initially at the
1226 beginning of this function but now it is CLOSURE_NOT_READY again.
1227 This is only possible if the state transitioned out of
1228 CLOSURE_NOT_READY to either CLOSURE_READY or <some closure> and then
1229 back to CLOSURE_NOT_READY again (i.e after we entered this function,
1230 the fd became "ready" and the necessary actions were already done).
1231 So there is no need to make the state CLOSURE_READY now */
1232 break;
1233 }
1234
1235 default: {
1236 /* 'curr' is either a closure or the fd is shutdown */
1237 if ((curr & FD_SHUTDOWN_BIT) > 0) {
1238 /* The fd is shutdown. Do nothing */
1239 } else if (gpr_atm_rel_cas(state, curr, CLOSURE_NOT_READY)) {
1240 grpc_closure_sched(exec_ctx, (grpc_closure *)curr, GRPC_ERROR_NONE);
1241 }
1242 /* else the state changed again (only possible by either a racing
1243 set_ready or set_shutdown functions. In both these cases, the closure
1244 would have been scheduled for execution. So we are done here */
1245 break;
1246 }
1247 }
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001248}
1249
Sree Kuchibhotla5855c472016-06-08 12:56:56 -07001250static grpc_pollset *fd_get_read_notifier_pollset(grpc_exec_ctx *exec_ctx,
1251 grpc_fd *fd) {
Sree Kuchibhotlafb7ced62017-02-15 18:31:57 -08001252 gpr_atm notifier = gpr_atm_acq_load(&fd->read_notifier_pollset);
Sree Kuchibhotla82d73412017-02-09 18:27:45 -08001253 return (grpc_pollset *)notifier;
Sree Kuchibhotla5855c472016-06-08 12:56:56 -07001254}
1255
Sree Kuchibhotla24b6eae2016-06-21 18:01:14 -07001256static bool fd_is_shutdown(grpc_fd *fd) {
Sree Kuchibhotla99983382017-02-12 17:03:27 -08001257 grpc_error *err = (grpc_error *)gpr_atm_acq_load(&fd->shutdown_error);
Sree Kuchibhotla61fe0942017-02-14 12:26:56 -08001258 return (((intptr_t)err & FD_SHUTDOWN_BIT) > 0);
Sree Kuchibhotla24b6eae2016-06-21 18:01:14 -07001259}
1260
Sree Kuchibhotla0100b2f2016-06-21 17:38:13 -07001261/* Might be called multiple times */
Craig Tillercda759d2017-01-27 11:37:37 -08001262static void fd_shutdown(grpc_exec_ctx *exec_ctx, grpc_fd *fd, grpc_error *why) {
Sree Kuchibhotla2fc2b3e2017-02-14 10:05:14 -08001263 /* Store the shutdown error ORed with FD_SHUTDOWN_BIT in fd->shutdown_error */
Sree Kuchibhotlafb7ced62017-02-15 18:31:57 -08001264 if (gpr_atm_rel_cas(&fd->shutdown_error, (gpr_atm)GRPC_ERROR_NONE,
Sree Kuchibhotla2fc2b3e2017-02-14 10:05:14 -08001265 (gpr_atm)why | FD_SHUTDOWN_BIT)) {
Sree Kuchibhotla0100b2f2016-06-21 17:38:13 -07001266 shutdown(fd->fd, SHUT_RDWR);
Sree Kuchibhotla82d73412017-02-09 18:27:45 -08001267
Sree Kuchibhotla91c4da32017-02-12 14:00:39 -08001268 set_shutdown(exec_ctx, fd, &fd->read_closure, why);
1269 set_shutdown(exec_ctx, fd, &fd->write_closure, why);
Craig Tillercda759d2017-01-27 11:37:37 -08001270 } else {
Sree Kuchibhotla4db8c822017-02-12 17:07:31 -08001271 /* Shutdown already called */
Craig Tillercda759d2017-01-27 11:37:37 -08001272 GRPC_ERROR_UNREF(why);
Sree Kuchibhotla0100b2f2016-06-21 17:38:13 -07001273 }
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001274}
1275
1276static void fd_notify_on_read(grpc_exec_ctx *exec_ctx, grpc_fd *fd,
1277 grpc_closure *closure) {
Sree Kuchibhotla82d73412017-02-09 18:27:45 -08001278 notify_on(exec_ctx, fd, &fd->read_closure, closure);
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001279}
1280
1281static void fd_notify_on_write(grpc_exec_ctx *exec_ctx, grpc_fd *fd,
1282 grpc_closure *closure) {
Sree Kuchibhotla82d73412017-02-09 18:27:45 -08001283 notify_on(exec_ctx, fd, &fd->write_closure, closure);
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001284}
1285
Craig Tillerd6ba6192016-06-30 15:42:41 -07001286static grpc_workqueue *fd_get_workqueue(grpc_fd *fd) {
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001287 gpr_mu_lock(&fd->po.mu);
Sree Kuchibhotla499b94b2016-11-18 14:35:47 -08001288 grpc_workqueue *workqueue =
1289 GRPC_WORKQUEUE_REF((grpc_workqueue *)fd->po.pi, "fd_get_workqueue");
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001290 gpr_mu_unlock(&fd->po.mu);
Craig Tillerd6ba6192016-06-30 15:42:41 -07001291 return workqueue;
1292}
Craig Tiller70bd4832016-06-30 14:20:46 -07001293
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001294/*******************************************************************************
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001295 * Pollset Definitions
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001296 */
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001297GPR_TLS_DECL(g_current_thread_pollset);
1298GPR_TLS_DECL(g_current_thread_worker);
Craig Tiller19196992016-06-27 18:45:56 -07001299static __thread bool g_initialized_sigmask;
1300static __thread sigset_t g_orig_sigmask;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001301
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001302static void sig_handler(int sig_num) {
Sree Kuchibhotlad627c102016-06-06 15:49:32 -07001303#ifdef GRPC_EPOLL_DEBUG
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001304 gpr_log(GPR_INFO, "Received signal %d", sig_num);
Sree Kuchibhotla9bc3d2d2016-06-06 10:27:56 -07001305#endif
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001306}
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001307
Sree Kuchibhotlac7be7c62016-06-09 17:08:50 -07001308static void poller_kick_init() { signal(grpc_wakeup_signal, sig_handler); }
Sree Kuchibhotla5855c472016-06-08 12:56:56 -07001309
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001310/* Global state management */
Sree Kuchibhotla3131c262016-06-21 17:28:28 -07001311static grpc_error *pollset_global_init(void) {
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001312 gpr_tls_init(&g_current_thread_pollset);
1313 gpr_tls_init(&g_current_thread_worker);
Sree Kuchibhotla5855c472016-06-08 12:56:56 -07001314 poller_kick_init();
Craig Tillerb4b8e1e2016-11-28 07:33:13 -08001315 return grpc_wakeup_fd_init(&global_wakeup_fd);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001316}
1317
1318static void pollset_global_shutdown(void) {
Craig Tillerb4b8e1e2016-11-28 07:33:13 -08001319 grpc_wakeup_fd_destroy(&global_wakeup_fd);
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001320 gpr_tls_destroy(&g_current_thread_pollset);
1321 gpr_tls_destroy(&g_current_thread_worker);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001322}
1323
Sree Kuchibhotla3131c262016-06-21 17:28:28 -07001324static grpc_error *pollset_worker_kick(grpc_pollset_worker *worker) {
1325 grpc_error *err = GRPC_ERROR_NONE;
Sree Kuchibhotla34217242016-06-29 00:19:07 -07001326
1327 /* Kick the worker only if it was not already kicked */
1328 if (gpr_atm_no_barrier_cas(&worker->is_kicked, (gpr_atm)0, (gpr_atm)1)) {
1329 GRPC_POLLING_TRACE(
1330 "pollset_worker_kick: Kicking worker: %p (thread id: %ld)",
1331 (void *)worker, worker->pt_id);
1332 int err_num = pthread_kill(worker->pt_id, grpc_wakeup_signal);
1333 if (err_num != 0) {
1334 err = GRPC_OS_ERROR(err_num, "pthread_kill");
1335 }
Sree Kuchibhotla3131c262016-06-21 17:28:28 -07001336 }
1337 return err;
Sree Kuchibhotla5855c472016-06-08 12:56:56 -07001338}
1339
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001340/* Return 1 if the pollset has active threads in pollset_work (pollset must
1341 * be locked) */
1342static int pollset_has_workers(grpc_pollset *p) {
1343 return p->root_worker.next != &p->root_worker;
1344}
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001345
1346static void remove_worker(grpc_pollset *p, grpc_pollset_worker *worker) {
1347 worker->prev->next = worker->next;
1348 worker->next->prev = worker->prev;
1349}
1350
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001351static grpc_pollset_worker *pop_front_worker(grpc_pollset *p) {
1352 if (pollset_has_workers(p)) {
1353 grpc_pollset_worker *w = p->root_worker.next;
1354 remove_worker(p, w);
1355 return w;
1356 } else {
1357 return NULL;
1358 }
1359}
1360
1361static void push_back_worker(grpc_pollset *p, grpc_pollset_worker *worker) {
1362 worker->next = &p->root_worker;
1363 worker->prev = worker->next->prev;
1364 worker->prev->next = worker->next->prev = worker;
1365}
1366
1367static void push_front_worker(grpc_pollset *p, grpc_pollset_worker *worker) {
1368 worker->prev = &p->root_worker;
1369 worker->next = worker->prev->next;
1370 worker->prev->next = worker->next->prev = worker;
1371}
1372
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001373/* p->mu must be held before calling this function */
Sree Kuchibhotla3131c262016-06-21 17:28:28 -07001374static grpc_error *pollset_kick(grpc_pollset *p,
1375 grpc_pollset_worker *specific_worker) {
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001376 GPR_TIMER_BEGIN("pollset_kick", 0);
Sree Kuchibhotla3131c262016-06-21 17:28:28 -07001377 grpc_error *error = GRPC_ERROR_NONE;
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001378 const char *err_desc = "Kick Failure";
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001379 grpc_pollset_worker *worker = specific_worker;
1380 if (worker != NULL) {
1381 if (worker == GRPC_POLLSET_KICK_BROADCAST) {
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001382 if (pollset_has_workers(p)) {
Sree Kuchibhotla79a62332016-06-04 14:01:03 -07001383 GPR_TIMER_BEGIN("pollset_kick.broadcast", 0);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001384 for (worker = p->root_worker.next; worker != &p->root_worker;
1385 worker = worker->next) {
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001386 if (gpr_tls_get(&g_current_thread_worker) != (intptr_t)worker) {
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001387 append_error(&error, pollset_worker_kick(worker), err_desc);
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001388 }
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001389 }
Craig Tillera218a062016-06-26 09:58:37 -07001390 GPR_TIMER_END("pollset_kick.broadcast", 0);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001391 } else {
1392 p->kicked_without_pollers = true;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001393 }
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001394 } else {
1395 GPR_TIMER_MARK("kicked_specifically", 0);
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001396 if (gpr_tls_get(&g_current_thread_worker) != (intptr_t)worker) {
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001397 append_error(&error, pollset_worker_kick(worker), err_desc);
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001398 }
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001399 }
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001400 } else if (gpr_tls_get(&g_current_thread_pollset) != (intptr_t)p) {
1401 /* Since worker == NULL, it means that we can kick "any" worker on this
1402 pollset 'p'. If 'p' happens to be the same pollset this thread is
1403 currently polling (i.e in pollset_work() function), then there is no need
1404 to kick any other worker since the current thread can just absorb the
1405 kick. This is the reason why we enter this case only when
1406 g_current_thread_pollset is != p */
1407
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001408 GPR_TIMER_MARK("kick_anonymous", 0);
1409 worker = pop_front_worker(p);
1410 if (worker != NULL) {
1411 GPR_TIMER_MARK("finally_kick", 0);
1412 push_back_worker(p, worker);
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001413 append_error(&error, pollset_worker_kick(worker), err_desc);
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001414 } else {
1415 GPR_TIMER_MARK("kicked_no_pollers", 0);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001416 p->kicked_without_pollers = true;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001417 }
1418 }
1419
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001420 GPR_TIMER_END("pollset_kick", 0);
Sree Kuchibhotla3131c262016-06-21 17:28:28 -07001421 GRPC_LOG_IF_ERROR("pollset_kick", GRPC_ERROR_REF(error));
1422 return error;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001423}
1424
Sree Kuchibhotla3131c262016-06-21 17:28:28 -07001425static grpc_error *kick_poller(void) {
Craig Tillerb4b8e1e2016-11-28 07:33:13 -08001426 return grpc_wakeup_fd_wakeup(&global_wakeup_fd);
Sree Kuchibhotla3131c262016-06-21 17:28:28 -07001427}
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001428
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001429static void pollset_init(grpc_pollset *pollset, gpr_mu **mu) {
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001430 gpr_mu_init(&pollset->po.mu);
1431 *mu = &pollset->po.mu;
1432 pollset->po.pi = NULL;
Sree Kuchibhotlaa0749a62016-11-18 20:22:09 -08001433#ifdef PO_DEBUG
1434 pollset->po.obj_type = POLL_OBJ_POLLSET;
1435#endif
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001436
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001437 pollset->root_worker.next = pollset->root_worker.prev = &pollset->root_worker;
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001438 pollset->kicked_without_pollers = false;
1439
1440 pollset->shutting_down = false;
1441 pollset->finish_shutdown_called = false;
1442 pollset->shutdown_done = NULL;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001443}
1444
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001445/* Convert a timespec to milliseconds:
1446 - Very small or negative poll times are clamped to zero to do a non-blocking
1447 poll (which becomes spin polling)
1448 - Other small values are rounded up to one millisecond
1449 - Longer than a millisecond polls are rounded up to the next nearest
1450 millisecond to avoid spinning
1451 - Infinite timeouts are converted to -1 */
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001452static int poll_deadline_to_millis_timeout(gpr_timespec deadline,
1453 gpr_timespec now) {
1454 gpr_timespec timeout;
1455 static const int64_t max_spin_polling_us = 10;
1456 if (gpr_time_cmp(deadline, gpr_inf_future(deadline.clock_type)) == 0) {
1457 return -1;
1458 }
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001459
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001460 if (gpr_time_cmp(deadline, gpr_time_add(now, gpr_time_from_micros(
1461 max_spin_polling_us,
1462 GPR_TIMESPAN))) <= 0) {
1463 return 0;
1464 }
1465 timeout = gpr_time_sub(deadline, now);
1466 return gpr_time_to_millis(gpr_time_add(
1467 timeout, gpr_time_from_nanos(GPR_NS_PER_MS - 1, GPR_TIMESPAN)));
1468}
1469
Sree Kuchibhotla5855c472016-06-08 12:56:56 -07001470static void fd_become_readable(grpc_exec_ctx *exec_ctx, grpc_fd *fd,
1471 grpc_pollset *notifier) {
Sree Kuchibhotla82d73412017-02-09 18:27:45 -08001472 set_ready(exec_ctx, fd, &fd->read_closure);
1473
Sree Kuchibhotla4db8c822017-02-12 17:07:31 -08001474 /* Note, it is possible that fd_become_readable might be called twice with
Sree Kuchibhotla4c60d0d2017-02-12 17:09:08 -08001475 different 'notifier's when an fd becomes readable and it is in two epoll
1476 sets (This can happen briefly during polling island merges). In such cases
1477 it does not really matter which notifer is set as the read_notifier_pollset
1478 (They would both point to the same polling island anyway) */
Sree Kuchibhotlafb7ced62017-02-15 18:31:57 -08001479 /* Use release store to match with acquire load in fd_get_read_notifier */
1480 gpr_atm_rel_store(&fd->read_notifier_pollset, (gpr_atm)notifier);
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001481}
1482
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001483static void fd_become_writable(grpc_exec_ctx *exec_ctx, grpc_fd *fd) {
Sree Kuchibhotla82d73412017-02-09 18:27:45 -08001484 set_ready(exec_ctx, fd, &fd->write_closure);
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001485}
1486
Craig Tillerb39307d2016-06-30 15:39:13 -07001487static void pollset_release_polling_island(grpc_exec_ctx *exec_ctx,
1488 grpc_pollset *ps, char *reason) {
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001489 if (ps->po.pi != NULL) {
1490 PI_UNREF(exec_ctx, ps->po.pi, reason);
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001491 }
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001492 ps->po.pi = NULL;
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001493}
1494
1495static void finish_shutdown_locked(grpc_exec_ctx *exec_ctx,
1496 grpc_pollset *pollset) {
1497 /* The pollset cannot have any workers if we are at this stage */
1498 GPR_ASSERT(!pollset_has_workers(pollset));
1499
1500 pollset->finish_shutdown_called = true;
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001501
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001502 /* Release the ref and set pollset->po.pi to NULL */
Craig Tillerb39307d2016-06-30 15:39:13 -07001503 pollset_release_polling_island(exec_ctx, pollset, "ps_shutdown");
Craig Tiller91031da2016-12-28 15:44:25 -08001504 grpc_closure_sched(exec_ctx, pollset->shutdown_done, GRPC_ERROR_NONE);
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001505}
1506
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001507/* pollset->po.mu lock must be held by the caller before calling this */
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001508static void pollset_shutdown(grpc_exec_ctx *exec_ctx, grpc_pollset *pollset,
1509 grpc_closure *closure) {
1510 GPR_TIMER_BEGIN("pollset_shutdown", 0);
1511 GPR_ASSERT(!pollset->shutting_down);
1512 pollset->shutting_down = true;
1513 pollset->shutdown_done = closure;
1514 pollset_kick(pollset, GRPC_POLLSET_KICK_BROADCAST);
1515
1516 /* If the pollset has any workers, we cannot call finish_shutdown_locked()
1517 because it would release the underlying polling island. In such a case, we
1518 let the last worker call finish_shutdown_locked() from pollset_work() */
1519 if (!pollset_has_workers(pollset)) {
1520 GPR_ASSERT(!pollset->finish_shutdown_called);
1521 GPR_TIMER_MARK("pollset_shutdown.finish_shutdown_locked", 0);
1522 finish_shutdown_locked(exec_ctx, pollset);
1523 }
1524 GPR_TIMER_END("pollset_shutdown", 0);
1525}
1526
1527/* pollset_shutdown is guaranteed to be called before pollset_destroy. So other
1528 * than destroying the mutexes, there is nothing special that needs to be done
1529 * here */
1530static void pollset_destroy(grpc_pollset *pollset) {
1531 GPR_ASSERT(!pollset_has_workers(pollset));
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001532 gpr_mu_destroy(&pollset->po.mu);
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001533}
1534
Craig Tiller2b49ea92016-07-01 13:21:27 -07001535static void pollset_reset(grpc_pollset *pollset) {
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001536 GPR_ASSERT(pollset->shutting_down);
1537 GPR_ASSERT(!pollset_has_workers(pollset));
1538 pollset->shutting_down = false;
1539 pollset->finish_shutdown_called = false;
1540 pollset->kicked_without_pollers = false;
1541 pollset->shutdown_done = NULL;
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001542 GPR_ASSERT(pollset->po.pi == NULL);
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001543}
1544
Craig Tillerd8a3c042016-09-09 12:42:37 -07001545static bool maybe_do_workqueue_work(grpc_exec_ctx *exec_ctx,
1546 polling_island *pi) {
1547 if (gpr_mu_trylock(&pi->workqueue_read_mu)) {
1548 gpr_mpscq_node *n = gpr_mpscq_pop(&pi->workqueue_items);
1549 gpr_mu_unlock(&pi->workqueue_read_mu);
1550 if (n != NULL) {
1551 if (gpr_atm_full_fetch_add(&pi->workqueue_item_count, -1) > 1) {
1552 workqueue_maybe_wakeup(pi);
1553 }
1554 grpc_closure *c = (grpc_closure *)n;
Craig Tiller061ef742016-12-29 10:54:09 -08001555 grpc_error *error = c->error_data.error;
1556 c->cb(exec_ctx, c->cb_arg, error);
1557 GRPC_ERROR_UNREF(error);
Craig Tillerd8a3c042016-09-09 12:42:37 -07001558 return true;
1559 } else if (gpr_atm_no_barrier_load(&pi->workqueue_item_count) > 0) {
Craig Tiller460502e2016-10-13 10:02:08 -07001560 /* n == NULL might mean there's work but it's not available to be popped
1561 * yet - try to ensure another workqueue wakes up to check shortly if so
1562 */
Craig Tillerd8a3c042016-09-09 12:42:37 -07001563 workqueue_maybe_wakeup(pi);
1564 }
1565 }
1566 return false;
1567}
1568
Craig Tiller84ea3412016-09-08 14:57:56 -07001569#define GRPC_EPOLL_MAX_EVENTS 100
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001570/* Note: sig_mask contains the signal mask to use *during* epoll_wait() */
1571static void pollset_work_and_unlock(grpc_exec_ctx *exec_ctx,
Sree Kuchibhotla1e776682016-06-28 14:09:26 -07001572 grpc_pollset *pollset,
1573 grpc_pollset_worker *worker, int timeout_ms,
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001574 sigset_t *sig_mask, grpc_error **error) {
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001575 struct epoll_event ep_ev[GRPC_EPOLL_MAX_EVENTS];
Sree Kuchibhotla88ee12f2016-06-03 19:26:48 -07001576 int epoll_fd = -1;
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001577 int ep_rv;
Sree Kuchibhotla24b10622016-06-08 15:20:17 -07001578 polling_island *pi = NULL;
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001579 char *err_msg;
1580 const char *err_desc = "pollset_work_and_unlock";
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001581 GPR_TIMER_BEGIN("pollset_work_and_unlock", 0);
1582
1583 /* We need to get the epoll_fd to wait on. The epoll_fd is in inside the
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001584 latest polling island pointed by pollset->po.pi
Sree Kuchibhotla229533b12016-06-21 20:42:52 -07001585
1586 Since epoll_fd is immutable, we can read it without obtaining the polling
1587 island lock. There is however a possibility that the polling island (from
1588 which we got the epoll_fd) got merged with another island while we are
1589 in this function. This is still okay because in such a case, we will wakeup
1590 right-away from epoll_wait() and pick up the latest polling_island the next
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001591 this function (i.e pollset_work_and_unlock()) is called */
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001592
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001593 if (pollset->po.pi == NULL) {
1594 pollset->po.pi = polling_island_create(exec_ctx, NULL, error);
1595 if (pollset->po.pi == NULL) {
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001596 GPR_TIMER_END("pollset_work_and_unlock", 0);
1597 return; /* Fatal error. We cannot continue */
1598 }
1599
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001600 PI_ADD_REF(pollset->po.pi, "ps");
Sree Kuchibhotla1e776682016-06-28 14:09:26 -07001601 GRPC_POLLING_TRACE("pollset_work: pollset: %p created new pi: %p",
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001602 (void *)pollset, (void *)pollset->po.pi);
Sree Kuchibhotla88ee12f2016-06-03 19:26:48 -07001603 }
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001604
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001605 pi = polling_island_maybe_get_latest(pollset->po.pi);
Sree Kuchibhotla24b10622016-06-08 15:20:17 -07001606 epoll_fd = pi->epoll_fd;
1607
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001608 /* Update the pollset->po.pi since the island being pointed by
1609 pollset->po.pi maybe older than the one pointed by pi) */
1610 if (pollset->po.pi != pi) {
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07001611 /* Always do PI_ADD_REF before PI_UNREF because PI_UNREF may cause the
1612 polling island to be deleted */
1613 PI_ADD_REF(pi, "ps");
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001614 PI_UNREF(exec_ctx, pollset->po.pi, "ps");
1615 pollset->po.pi = pi;
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07001616 }
Sree Kuchibhotlad627c102016-06-06 15:49:32 -07001617
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07001618 /* Add an extra ref so that the island does not get destroyed (which means
1619 the epoll_fd won't be closed) while we are are doing an epoll_wait() on the
1620 epoll_fd */
1621 PI_ADD_REF(pi, "ps_work");
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001622 gpr_mu_unlock(&pollset->po.mu);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001623
Craig Tiller460502e2016-10-13 10:02:08 -07001624 /* If we get some workqueue work to do, it might end up completing an item on
1625 the completion queue, so there's no need to poll... so we skip that and
1626 redo the complete loop to verify */
Craig Tillerd8a3c042016-09-09 12:42:37 -07001627 if (!maybe_do_workqueue_work(exec_ctx, pi)) {
1628 gpr_atm_no_barrier_fetch_add(&pi->poller_count, 1);
1629 g_current_thread_polling_island = pi;
1630
Vijay Paicef54012016-08-28 23:05:31 -07001631 GRPC_SCHEDULING_START_BLOCKING_REGION;
Sree Kuchibhotlae5012ba2016-06-06 16:01:45 -07001632 ep_rv = epoll_pwait(epoll_fd, ep_ev, GRPC_EPOLL_MAX_EVENTS, timeout_ms,
1633 sig_mask);
Vijay Paicef54012016-08-28 23:05:31 -07001634 GRPC_SCHEDULING_END_BLOCKING_REGION;
Sree Kuchibhotlae5012ba2016-06-06 16:01:45 -07001635 if (ep_rv < 0) {
1636 if (errno != EINTR) {
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001637 gpr_asprintf(&err_msg,
1638 "epoll_wait() epoll fd: %d failed with error: %d (%s)",
1639 epoll_fd, errno, strerror(errno));
1640 append_error(error, GRPC_OS_ERROR(errno, err_msg), err_desc);
Sree Kuchibhotlae5012ba2016-06-06 16:01:45 -07001641 } else {
Sree Kuchibhotla24b10622016-06-08 15:20:17 -07001642 /* We were interrupted. Save an interation by doing a zero timeout
1643 epoll_wait to see if there are any other events of interest */
Sree Kuchibhotla1e776682016-06-28 14:09:26 -07001644 GRPC_POLLING_TRACE(
1645 "pollset_work: pollset: %p, worker: %p received kick",
1646 (void *)pollset, (void *)worker);
Sree Kuchibhotlae5012ba2016-06-06 16:01:45 -07001647 ep_rv = epoll_wait(epoll_fd, ep_ev, GRPC_EPOLL_MAX_EVENTS, 0);
Sree Kuchibhotla79a62332016-06-04 14:01:03 -07001648 }
Sree Kuchibhotlae5012ba2016-06-06 16:01:45 -07001649 }
Sree Kuchibhotla79a62332016-06-04 14:01:03 -07001650
Sree Kuchibhotlaad2c4772016-06-13 19:06:54 -07001651#ifdef GRPC_TSAN
Sree Kuchibhotla41622a82016-06-13 16:43:14 -07001652 /* See the definition of g_poll_sync for more details */
1653 gpr_atm_acq_load(&g_epoll_sync);
Sree Kuchibhotlaad2c4772016-06-13 19:06:54 -07001654#endif /* defined(GRPC_TSAN) */
Sree Kuchibhotla41622a82016-06-13 16:43:14 -07001655
Sree Kuchibhotla58e58962016-06-13 00:52:56 -07001656 for (int i = 0; i < ep_rv; ++i) {
Sree Kuchibhotla24b10622016-06-08 15:20:17 -07001657 void *data_ptr = ep_ev[i].data.ptr;
Craig Tillerb4b8e1e2016-11-28 07:33:13 -08001658 if (data_ptr == &global_wakeup_fd) {
Craig Tiller1fa9ddb2016-11-28 08:19:37 -08001659 append_error(error, grpc_wakeup_fd_consume_wakeup(&global_wakeup_fd),
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001660 err_desc);
Craig Tillerd8a3c042016-09-09 12:42:37 -07001661 } else if (data_ptr == &pi->workqueue_wakeup_fd) {
Craig Tillere49959d2017-01-26 08:39:38 -08001662 append_error(error,
1663 grpc_wakeup_fd_consume_wakeup(&pi->workqueue_wakeup_fd),
Craig Tillerd8a3c042016-09-09 12:42:37 -07001664 err_desc);
1665 maybe_do_workqueue_work(exec_ctx, pi);
Sree Kuchibhotla24b10622016-06-08 15:20:17 -07001666 } else if (data_ptr == &polling_island_wakeup_fd) {
Sree Kuchibhotla1e776682016-06-28 14:09:26 -07001667 GRPC_POLLING_TRACE(
1668 "pollset_work: pollset: %p, worker: %p polling island (epoll_fd: "
1669 "%d) got merged",
1670 (void *)pollset, (void *)worker, epoll_fd);
Sree Kuchibhotla24b10622016-06-08 15:20:17 -07001671 /* This means that our polling island is merged with a different
1672 island. We do not have to do anything here since the subsequent call
1673 to the function pollset_work_and_unlock() will pick up the correct
1674 epoll_fd */
Sree Kuchibhotlae5012ba2016-06-06 16:01:45 -07001675 } else {
Sree Kuchibhotla24b10622016-06-08 15:20:17 -07001676 grpc_fd *fd = data_ptr;
1677 int cancel = ep_ev[i].events & (EPOLLERR | EPOLLHUP);
1678 int read_ev = ep_ev[i].events & (EPOLLIN | EPOLLPRI);
1679 int write_ev = ep_ev[i].events & EPOLLOUT;
Sree Kuchibhotlae5012ba2016-06-06 16:01:45 -07001680 if (read_ev || cancel) {
Sree Kuchibhotla5855c472016-06-08 12:56:56 -07001681 fd_become_readable(exec_ctx, fd, pollset);
Sree Kuchibhotlae5012ba2016-06-06 16:01:45 -07001682 }
1683 if (write_ev || cancel) {
1684 fd_become_writable(exec_ctx, fd);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001685 }
1686 }
Sree Kuchibhotlae5012ba2016-06-06 16:01:45 -07001687 }
Craig Tillerd8a3c042016-09-09 12:42:37 -07001688
1689 g_current_thread_polling_island = NULL;
1690 gpr_atm_no_barrier_fetch_add(&pi->poller_count, -1);
1691 }
Sree Kuchibhotla24b10622016-06-08 15:20:17 -07001692
1693 GPR_ASSERT(pi != NULL);
1694
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07001695 /* Before leaving, release the extra ref we added to the polling island. It
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001696 is important to use "pi" here (i.e our old copy of pollset->po.pi
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07001697 that we got before releasing the polling island lock). This is because
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001698 pollset->po.pi pointer might get udpated in other parts of the
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07001699 code when there is an island merge while we are doing epoll_wait() above */
Craig Tillerb39307d2016-06-30 15:39:13 -07001700 PI_UNREF(exec_ctx, pi, "ps_work");
Sree Kuchibhotla24b10622016-06-08 15:20:17 -07001701
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001702 GPR_TIMER_END("pollset_work_and_unlock", 0);
1703}
1704
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001705/* pollset->po.mu lock must be held by the caller before calling this.
1706 The function pollset_work() may temporarily release the lock (pollset->po.mu)
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001707 during the course of its execution but it will always re-acquire the lock and
1708 ensure that it is held by the time the function returns */
Sree Kuchibhotla3131c262016-06-21 17:28:28 -07001709static grpc_error *pollset_work(grpc_exec_ctx *exec_ctx, grpc_pollset *pollset,
1710 grpc_pollset_worker **worker_hdl,
1711 gpr_timespec now, gpr_timespec deadline) {
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001712 GPR_TIMER_BEGIN("pollset_work", 0);
Sree Kuchibhotla3131c262016-06-21 17:28:28 -07001713 grpc_error *error = GRPC_ERROR_NONE;
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001714 int timeout_ms = poll_deadline_to_millis_timeout(deadline, now);
1715
1716 sigset_t new_mask;
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001717
1718 grpc_pollset_worker worker;
1719 worker.next = worker.prev = NULL;
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001720 worker.pt_id = pthread_self();
Sree Kuchibhotla34217242016-06-29 00:19:07 -07001721 gpr_atm_no_barrier_store(&worker.is_kicked, (gpr_atm)0);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001722
1723 *worker_hdl = &worker;
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001724
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001725 gpr_tls_set(&g_current_thread_pollset, (intptr_t)pollset);
1726 gpr_tls_set(&g_current_thread_worker, (intptr_t)&worker);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001727
1728 if (pollset->kicked_without_pollers) {
1729 /* If the pollset was kicked without pollers, pretend that the current
1730 worker got the kick and skip polling. A kick indicates that there is some
1731 work that needs attention like an event on the completion queue or an
1732 alarm */
1733 GPR_TIMER_MARK("pollset_work.kicked_without_pollers", 0);
1734 pollset->kicked_without_pollers = 0;
1735 } else if (!pollset->shutting_down) {
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001736 /* We use the posix-signal with number 'grpc_wakeup_signal' for waking up
Sree Kuchibhotla34217242016-06-29 00:19:07 -07001737 (i.e 'kicking') a worker in the pollset. A 'kick' is a way to inform the
1738 worker that there is some pending work that needs immediate attention
1739 (like an event on the completion queue, or a polling island merge that
1740 results in a new epoll-fd to wait on) and that the worker should not
1741 spend time waiting in epoll_pwait().
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001742
Sree Kuchibhotla34217242016-06-29 00:19:07 -07001743 A worker can be kicked anytime from the point it is added to the pollset
1744 via push_front_worker() (or push_back_worker()) to the point it is
1745 removed via remove_worker().
1746 If the worker is kicked before/during it calls epoll_pwait(), it should
1747 immediately exit from epoll_wait(). If the worker is kicked after it
1748 returns from epoll_wait(), then nothing really needs to be done.
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001749
Sree Kuchibhotla34217242016-06-29 00:19:07 -07001750 To accomplish this, we mask 'grpc_wakeup_signal' on this thread at all
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001751 times *except* when it is in epoll_pwait(). This way, the worker never
1752 misses acting on a kick */
1753
Craig Tiller19196992016-06-27 18:45:56 -07001754 if (!g_initialized_sigmask) {
1755 sigemptyset(&new_mask);
1756 sigaddset(&new_mask, grpc_wakeup_signal);
1757 pthread_sigmask(SIG_BLOCK, &new_mask, &g_orig_sigmask);
1758 sigdelset(&g_orig_sigmask, grpc_wakeup_signal);
1759 g_initialized_sigmask = true;
1760 /* new_mask: The new thread mask which blocks 'grpc_wakeup_signal'.
1761 This is the mask used at all times *except during
1762 epoll_wait()*"
1763 g_orig_sigmask: The thread mask which allows 'grpc_wakeup_signal' and
Craig Tiller510ff692016-06-27 20:31:49 -07001764 this is the mask to use *during epoll_wait()*
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001765
Craig Tiller19196992016-06-27 18:45:56 -07001766 The new_mask is set on the worker before it is added to the pollset
Craig Tiller510ff692016-06-27 20:31:49 -07001767 (i.e before it can be kicked) */
Craig Tiller19196992016-06-27 18:45:56 -07001768 }
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001769
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001770 push_front_worker(pollset, &worker); /* Add worker to pollset */
1771
Sree Kuchibhotla1e776682016-06-28 14:09:26 -07001772 pollset_work_and_unlock(exec_ctx, pollset, &worker, timeout_ms,
1773 &g_orig_sigmask, &error);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001774 grpc_exec_ctx_flush(exec_ctx);
1775
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001776 gpr_mu_lock(&pollset->po.mu);
Sree Kuchibhotla34217242016-06-29 00:19:07 -07001777
1778 /* Note: There is no need to reset worker.is_kicked to 0 since we are no
1779 longer going to use this worker */
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001780 remove_worker(pollset, &worker);
1781 }
1782
1783 /* If we are the last worker on the pollset (i.e pollset_has_workers() is
1784 false at this point) and the pollset is shutting down, we may have to
1785 finish the shutdown process by calling finish_shutdown_locked().
1786 See pollset_shutdown() for more details.
1787
1788 Note: Continuing to access pollset here is safe; it is the caller's
1789 responsibility to not destroy a pollset when it has outstanding calls to
1790 pollset_work() */
1791 if (pollset->shutting_down && !pollset_has_workers(pollset) &&
1792 !pollset->finish_shutdown_called) {
1793 GPR_TIMER_MARK("pollset_work.finish_shutdown_locked", 0);
1794 finish_shutdown_locked(exec_ctx, pollset);
1795
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001796 gpr_mu_unlock(&pollset->po.mu);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001797 grpc_exec_ctx_flush(exec_ctx);
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001798 gpr_mu_lock(&pollset->po.mu);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001799 }
1800
1801 *worker_hdl = NULL;
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001802
Sree Kuchibhotla8e4926c2016-06-08 20:33:19 -07001803 gpr_tls_set(&g_current_thread_pollset, (intptr_t)0);
1804 gpr_tls_set(&g_current_thread_worker, (intptr_t)0);
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001805
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001806 GPR_TIMER_END("pollset_work", 0);
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001807
Sree Kuchibhotla3131c262016-06-21 17:28:28 -07001808 GRPC_LOG_IF_ERROR("pollset_work", GRPC_ERROR_REF(error));
1809 return error;
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001810}
1811
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001812static void add_poll_object(grpc_exec_ctx *exec_ctx, poll_obj *bag,
Sree Kuchibhotlaa0749a62016-11-18 20:22:09 -08001813 poll_obj_type bag_type, poll_obj *item,
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001814 poll_obj_type item_type) {
1815 GPR_TIMER_BEGIN("add_poll_object", 0);
1816
Sree Kuchibhotlaa0749a62016-11-18 20:22:09 -08001817#ifdef PO_DEBUG
1818 GPR_ASSERT(item->obj_type == item_type);
1819 GPR_ASSERT(bag->obj_type == bag_type);
1820#endif
Craig Tiller57726ca2016-09-12 11:59:45 -07001821
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001822 grpc_error *error = GRPC_ERROR_NONE;
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -07001823 polling_island *pi_new = NULL;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001824
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001825 gpr_mu_lock(&bag->mu);
1826 gpr_mu_lock(&item->mu);
1827
Craig Tiller7212c232016-07-06 13:11:09 -07001828retry:
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001829 /*
1830 * 1) If item->pi and bag->pi are both non-NULL and equal, do nothing
1831 * 2) If item->pi and bag->pi are both NULL, create a new polling island (with
1832 * a refcount of 2) and point item->pi and bag->pi to the new island
1833 * 3) If exactly one of item->pi or bag->pi is NULL, update it to point to
1834 * the other's non-NULL pi
1835 * 4) Finally if item->pi and bag-pi are non-NULL and not-equal, merge the
1836 * polling islands and update item->pi and bag->pi to point to the new
1837 * island
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001838 */
Craig Tiller8e8027b2016-07-07 10:42:09 -07001839
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001840 /* Early out if we are trying to add an 'fd' to a 'bag' but the fd is already
1841 * orphaned */
1842 if (item_type == POLL_OBJ_FD && (FD_FROM_PO(item))->orphaned) {
1843 gpr_mu_unlock(&item->mu);
1844 gpr_mu_unlock(&bag->mu);
Craig Tiller42ac6db2016-07-06 17:13:56 -07001845 return;
1846 }
1847
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001848 if (item->pi == bag->pi) {
1849 pi_new = item->pi;
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -07001850 if (pi_new == NULL) {
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001851 /* GPR_ASSERT(item->pi == bag->pi == NULL) */
Sree Kuchibhotlaa129adf2016-10-26 16:44:44 -07001852
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001853 /* If we are adding an fd to a bag (i.e pollset or pollset_set), then
1854 * we need to do some extra work to make TSAN happy */
1855 if (item_type == POLL_OBJ_FD) {
1856 /* Unlock before creating a new polling island: the polling island will
1857 create a workqueue which creates a file descriptor, and holding an fd
1858 lock here can eventually cause a loop to appear to TSAN (making it
1859 unhappy). We don't think it's a real loop (there's an epoch point
1860 where that loop possibility disappears), but the advantages of
1861 keeping TSAN happy outweigh any performance advantage we might have
1862 by keeping the lock held. */
1863 gpr_mu_unlock(&item->mu);
1864 pi_new = polling_island_create(exec_ctx, FD_FROM_PO(item), &error);
1865 gpr_mu_lock(&item->mu);
Sree Kuchibhotlaa129adf2016-10-26 16:44:44 -07001866
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001867 /* Need to reverify any assumptions made between the initial lock and
1868 getting to this branch: if they've changed, we need to throw away our
1869 work and figure things out again. */
1870 if (item->pi != NULL) {
Sree Kuchibhotla499b94b2016-11-18 14:35:47 -08001871 GRPC_POLLING_TRACE(
1872 "add_poll_object: Raced creating new polling island. pi_new: %p "
1873 "(fd: %d, %s: %p)",
1874 (void *)pi_new, FD_FROM_PO(item)->fd, poll_obj_string(bag_type),
1875 (void *)bag);
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001876 /* No need to lock 'pi_new' here since this is a new polling island
Sree Kuchibhotla499b94b2016-11-18 14:35:47 -08001877 * and no one has a reference to it yet */
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001878 polling_island_remove_all_fds_locked(pi_new, true, &error);
1879
1880 /* Ref and unref so that the polling island gets deleted during unref
1881 */
1882 PI_ADD_REF(pi_new, "dance_of_destruction");
1883 PI_UNREF(exec_ctx, pi_new, "dance_of_destruction");
1884 goto retry;
1885 }
Craig Tiller27da6422016-07-06 13:14:46 -07001886 } else {
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001887 pi_new = polling_island_create(exec_ctx, NULL, &error);
Craig Tiller7212c232016-07-06 13:11:09 -07001888 }
Sree Kuchibhotla499b94b2016-11-18 14:35:47 -08001889
1890 GRPC_POLLING_TRACE(
1891 "add_poll_object: Created new polling island. pi_new: %p (%s: %p, "
1892 "%s: %p)",
1893 (void *)pi_new, poll_obj_string(item_type), (void *)item,
1894 poll_obj_string(bag_type), (void *)bag);
1895 } else {
1896 GRPC_POLLING_TRACE(
1897 "add_poll_object: Same polling island. pi: %p (%s, %s)",
1898 (void *)pi_new, poll_obj_string(item_type),
1899 poll_obj_string(bag_type));
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001900 }
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001901 } else if (item->pi == NULL) {
1902 /* GPR_ASSERT(bag->pi != NULL) */
1903 /* Make pi_new point to latest pi*/
1904 pi_new = polling_island_lock(bag->pi);
Sree Kuchibhotla1e776682016-06-28 14:09:26 -07001905
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001906 if (item_type == POLL_OBJ_FD) {
1907 grpc_fd *fd = FD_FROM_PO(item);
1908 polling_island_add_fds_locked(pi_new, &fd, 1, true, &error);
1909 }
Sree Kuchibhotla1e776682016-06-28 14:09:26 -07001910
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001911 gpr_mu_unlock(&pi_new->mu);
Sree Kuchibhotla1e776682016-06-28 14:09:26 -07001912 GRPC_POLLING_TRACE(
Sree Kuchibhotla499b94b2016-11-18 14:35:47 -08001913 "add_poll_obj: item->pi was NULL. pi_new: %p (item(%s): %p, "
1914 "bag(%s): %p)",
1915 (void *)pi_new, poll_obj_string(item_type), (void *)item,
1916 poll_obj_string(bag_type), (void *)bag);
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001917 } else if (bag->pi == NULL) {
1918 /* GPR_ASSERT(item->pi != NULL) */
1919 /* Make pi_new to point to latest pi */
1920 pi_new = polling_island_lock(item->pi);
1921 gpr_mu_unlock(&pi_new->mu);
Sree Kuchibhotla499b94b2016-11-18 14:35:47 -08001922 GRPC_POLLING_TRACE(
1923 "add_poll_obj: bag->pi was NULL. pi_new: %p (item(%s): %p, "
1924 "bag(%s): %p)",
1925 (void *)pi_new, poll_obj_string(item_type), (void *)item,
1926 poll_obj_string(bag_type), (void *)bag);
Sree Kuchibhotla5098f912016-05-31 10:58:17 -07001927 } else {
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001928 pi_new = polling_island_merge(item->pi, bag->pi, &error);
Sree Kuchibhotla1e776682016-06-28 14:09:26 -07001929 GRPC_POLLING_TRACE(
Sree Kuchibhotla499b94b2016-11-18 14:35:47 -08001930 "add_poll_obj: polling islands merged. pi_new: %p (item(%s): %p, "
1931 "bag(%s): %p)",
1932 (void *)pi_new, poll_obj_string(item_type), (void *)item,
1933 poll_obj_string(bag_type), (void *)bag);
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001934 }
1935
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001936 /* At this point, pi_new is the polling island that both item->pi and bag->pi
1937 MUST be pointing to */
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07001938
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001939 if (item->pi != pi_new) {
1940 PI_ADD_REF(pi_new, poll_obj_string(item_type));
1941 if (item->pi != NULL) {
1942 PI_UNREF(exec_ctx, item->pi, poll_obj_string(item_type));
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07001943 }
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001944 item->pi = pi_new;
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07001945 }
1946
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001947 if (bag->pi != pi_new) {
1948 PI_ADD_REF(pi_new, poll_obj_string(bag_type));
1949 if (bag->pi != NULL) {
1950 PI_UNREF(exec_ctx, bag->pi, poll_obj_string(bag_type));
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07001951 }
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001952 bag->pi = pi_new;
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07001953 }
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001954
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001955 gpr_mu_unlock(&item->mu);
1956 gpr_mu_unlock(&bag->mu);
Craig Tiller15007612016-07-06 09:36:16 -07001957
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08001958 GRPC_LOG_IF_ERROR("add_poll_object", error);
1959 GPR_TIMER_END("add_poll_object", 0);
1960}
Craig Tiller57726ca2016-09-12 11:59:45 -07001961
Sree Kuchibhotla9442bab2016-05-20 17:54:06 -07001962static void pollset_add_fd(grpc_exec_ctx *exec_ctx, grpc_pollset *pollset,
1963 grpc_fd *fd) {
Sree Kuchibhotlaa0749a62016-11-18 20:22:09 -08001964 add_poll_object(exec_ctx, &pollset->po, POLL_OBJ_POLLSET, &fd->po,
Sree Kuchibhotla499b94b2016-11-18 14:35:47 -08001965 POLL_OBJ_FD);
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001966}
1967
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001968/*******************************************************************************
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001969 * Pollset-set Definitions
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001970 */
1971
1972static grpc_pollset_set *pollset_set_create(void) {
Sree Kuchibhotla2385fd72016-11-18 16:30:41 -08001973 grpc_pollset_set *pss = gpr_malloc(sizeof(*pss));
Sree Kuchibhotla2385fd72016-11-18 16:30:41 -08001974 gpr_mu_init(&pss->po.mu);
Sree Kuchibhotlaa0749a62016-11-18 20:22:09 -08001975 pss->po.pi = NULL;
1976#ifdef PO_DEBUG
1977 pss->po.obj_type = POLL_OBJ_POLLSET_SET;
1978#endif
Sree Kuchibhotla2385fd72016-11-18 16:30:41 -08001979 return pss;
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001980}
1981
Sree Kuchibhotla2385fd72016-11-18 16:30:41 -08001982static void pollset_set_destroy(grpc_pollset_set *pss) {
1983 gpr_mu_destroy(&pss->po.mu);
1984
1985 if (pss->po.pi != NULL) {
1986 grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
1987 PI_UNREF(&exec_ctx, pss->po.pi, "pss_destroy");
1988 grpc_exec_ctx_finish(&exec_ctx);
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001989 }
Sree Kuchibhotla2385fd72016-11-18 16:30:41 -08001990
1991 gpr_free(pss);
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07001992}
1993
Sree Kuchibhotla2385fd72016-11-18 16:30:41 -08001994static void pollset_set_add_fd(grpc_exec_ctx *exec_ctx, grpc_pollset_set *pss,
1995 grpc_fd *fd) {
Sree Kuchibhotlaa0749a62016-11-18 20:22:09 -08001996 add_poll_object(exec_ctx, &pss->po, POLL_OBJ_POLLSET_SET, &fd->po,
Sree Kuchibhotla2385fd72016-11-18 16:30:41 -08001997 POLL_OBJ_FD);
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07001998}
1999
Sree Kuchibhotla2385fd72016-11-18 16:30:41 -08002000static void pollset_set_del_fd(grpc_exec_ctx *exec_ctx, grpc_pollset_set *pss,
2001 grpc_fd *fd) {
2002 /* Nothing to do */
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07002003}
2004
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07002005static void pollset_set_add_pollset(grpc_exec_ctx *exec_ctx,
Sree Kuchibhotla2385fd72016-11-18 16:30:41 -08002006 grpc_pollset_set *pss, grpc_pollset *ps) {
Sree Kuchibhotlaa0749a62016-11-18 20:22:09 -08002007 add_poll_object(exec_ctx, &pss->po, POLL_OBJ_POLLSET_SET, &ps->po,
Sree Kuchibhotla2385fd72016-11-18 16:30:41 -08002008 POLL_OBJ_POLLSET);
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07002009}
2010
2011static void pollset_set_del_pollset(grpc_exec_ctx *exec_ctx,
Sree Kuchibhotla2385fd72016-11-18 16:30:41 -08002012 grpc_pollset_set *pss, grpc_pollset *ps) {
2013 /* Nothing to do */
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07002014}
2015
2016static void pollset_set_add_pollset_set(grpc_exec_ctx *exec_ctx,
2017 grpc_pollset_set *bag,
2018 grpc_pollset_set *item) {
Sree Kuchibhotlaa0749a62016-11-18 20:22:09 -08002019 add_poll_object(exec_ctx, &bag->po, POLL_OBJ_POLLSET_SET, &item->po,
Sree Kuchibhotla2385fd72016-11-18 16:30:41 -08002020 POLL_OBJ_POLLSET_SET);
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07002021}
2022
2023static void pollset_set_del_pollset_set(grpc_exec_ctx *exec_ctx,
2024 grpc_pollset_set *bag,
2025 grpc_pollset_set *item) {
Sree Kuchibhotla2385fd72016-11-18 16:30:41 -08002026 /* Nothing to do */
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07002027}
2028
Sree Kuchibhotla2e12db92016-06-16 16:53:59 -07002029/* Test helper functions
2030 * */
2031void *grpc_fd_get_polling_island(grpc_fd *fd) {
2032 polling_island *pi;
2033
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08002034 gpr_mu_lock(&fd->po.mu);
2035 pi = fd->po.pi;
2036 gpr_mu_unlock(&fd->po.mu);
Sree Kuchibhotla2e12db92016-06-16 16:53:59 -07002037
2038 return pi;
2039}
2040
2041void *grpc_pollset_get_polling_island(grpc_pollset *ps) {
2042 polling_island *pi;
2043
Sree Kuchibhotlaf6f33d72016-11-18 11:38:52 -08002044 gpr_mu_lock(&ps->po.mu);
2045 pi = ps->po.pi;
2046 gpr_mu_unlock(&ps->po.mu);
Sree Kuchibhotla2e12db92016-06-16 16:53:59 -07002047
2048 return pi;
2049}
2050
Sree Kuchibhotla2e12db92016-06-16 16:53:59 -07002051bool grpc_are_polling_islands_equal(void *p, void *q) {
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07002052 polling_island *p1 = p;
2053 polling_island *p2 = q;
2054
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07002055 /* Note: polling_island_lock_pair() may change p1 and p2 to point to the
2056 latest polling islands in their respective linked lists */
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07002057 polling_island_lock_pair(&p1, &p2);
Sree Kuchibhotla20d0a162016-06-23 15:14:03 -07002058 polling_island_unlock_pair(p1, p2);
Sree Kuchibhotla2f8ade02016-06-17 13:28:38 -07002059
2060 return p1 == p2;
Sree Kuchibhotla2e12db92016-06-16 16:53:59 -07002061}
2062
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07002063/*******************************************************************************
Sree Kuchibhotla0bcbd792016-06-01 15:43:03 -07002064 * Event engine binding
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07002065 */
2066
2067static void shutdown_engine(void) {
2068 fd_global_shutdown();
2069 pollset_global_shutdown();
Sree Kuchibhotlad627c102016-06-06 15:49:32 -07002070 polling_island_global_shutdown();
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07002071}
2072
2073static const grpc_event_engine_vtable vtable = {
2074 .pollset_size = sizeof(grpc_pollset),
2075
2076 .fd_create = fd_create,
2077 .fd_wrapped_fd = fd_wrapped_fd,
2078 .fd_orphan = fd_orphan,
2079 .fd_shutdown = fd_shutdown,
Sree Kuchibhotla24b6eae2016-06-21 18:01:14 -07002080 .fd_is_shutdown = fd_is_shutdown,
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07002081 .fd_notify_on_read = fd_notify_on_read,
2082 .fd_notify_on_write = fd_notify_on_write,
Sree Kuchibhotla5855c472016-06-08 12:56:56 -07002083 .fd_get_read_notifier_pollset = fd_get_read_notifier_pollset,
Craig Tiller70bd4832016-06-30 14:20:46 -07002084 .fd_get_workqueue = fd_get_workqueue,
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07002085
2086 .pollset_init = pollset_init,
2087 .pollset_shutdown = pollset_shutdown,
2088 .pollset_reset = pollset_reset,
2089 .pollset_destroy = pollset_destroy,
2090 .pollset_work = pollset_work,
2091 .pollset_kick = pollset_kick,
2092 .pollset_add_fd = pollset_add_fd,
2093
2094 .pollset_set_create = pollset_set_create,
2095 .pollset_set_destroy = pollset_set_destroy,
2096 .pollset_set_add_pollset = pollset_set_add_pollset,
2097 .pollset_set_del_pollset = pollset_set_del_pollset,
2098 .pollset_set_add_pollset_set = pollset_set_add_pollset_set,
2099 .pollset_set_del_pollset_set = pollset_set_del_pollset_set,
2100 .pollset_set_add_fd = pollset_set_add_fd,
2101 .pollset_set_del_fd = pollset_set_del_fd,
2102
2103 .kick_poller = kick_poller,
2104
Craig Tillerd8a3c042016-09-09 12:42:37 -07002105 .workqueue_ref = workqueue_ref,
2106 .workqueue_unref = workqueue_unref,
Craig Tiller91031da2016-12-28 15:44:25 -08002107 .workqueue_scheduler = workqueue_scheduler,
Craig Tillerd8a3c042016-09-09 12:42:37 -07002108
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07002109 .shutdown_engine = shutdown_engine,
2110};
2111
Sree Kuchibhotla72744022016-06-09 09:42:06 -07002112/* It is possible that GLIBC has epoll but the underlying kernel doesn't.
2113 * Create a dummy epoll_fd to make sure epoll support is available */
2114static bool is_epoll_available() {
2115 int fd = epoll_create1(EPOLL_CLOEXEC);
2116 if (fd < 0) {
2117 gpr_log(
2118 GPR_ERROR,
2119 "epoll_create1 failed with error: %d. Not using epoll polling engine",
2120 fd);
2121 return false;
2122 }
2123 close(fd);
2124 return true;
2125}
2126
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07002127const grpc_event_engine_vtable *grpc_init_epoll_linux(void) {
Sree Kuchibhotlac7be7c62016-06-09 17:08:50 -07002128 /* If use of signals is disabled, we cannot use epoll engine*/
2129 if (is_grpc_wakeup_signal_initialized && grpc_wakeup_signal < 0) {
2130 return NULL;
2131 }
2132
Ken Paysoncd7d0472016-10-11 12:24:20 -07002133 if (!grpc_has_wakeup_fd()) {
Ken Paysonbc544be2016-10-06 19:23:47 -07002134 return NULL;
2135 }
2136
Sree Kuchibhotla72744022016-06-09 09:42:06 -07002137 if (!is_epoll_available()) {
2138 return NULL;
2139 }
2140
Sree Kuchibhotlac7be7c62016-06-09 17:08:50 -07002141 if (!is_grpc_wakeup_signal_initialized) {
Sree Kuchibhotlabd48c912016-09-27 16:48:25 -07002142 grpc_use_signal(SIGRTMIN + 6);
Sree Kuchibhotlac7be7c62016-06-09 17:08:50 -07002143 }
2144
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07002145 fd_global_init();
Sree Kuchibhotla3131c262016-06-21 17:28:28 -07002146
2147 if (!GRPC_LOG_IF_ERROR("pollset_global_init", pollset_global_init())) {
2148 return NULL;
2149 }
2150
2151 if (!GRPC_LOG_IF_ERROR("polling_island_global_init",
2152 polling_island_global_init())) {
2153 return NULL;
2154 }
2155
Sree Kuchibhotlaf448c342016-05-19 10:51:24 -07002156 return &vtable;
2157}
2158
murgatroid99623dd4f2016-08-08 17:31:27 -07002159#else /* defined(GRPC_LINUX_EPOLL) */
2160#if defined(GRPC_POSIX_SOCKET)
Sree Kuchibhotla41622a82016-06-13 16:43:14 -07002161#include "src/core/lib/iomgr/ev_posix.h"
murgatroid99623dd4f2016-08-08 17:31:27 -07002162/* If GRPC_LINUX_EPOLL is not defined, it means epoll is not available. Return
Sree Kuchibhotla5855c472016-06-08 12:56:56 -07002163 * NULL */
2164const grpc_event_engine_vtable *grpc_init_epoll_linux(void) { return NULL; }
murgatroid99623dd4f2016-08-08 17:31:27 -07002165#endif /* defined(GRPC_POSIX_SOCKET) */
Sree Kuchibhotla5855c472016-06-08 12:56:56 -07002166
Sree Kuchibhotlac7be7c62016-06-09 17:08:50 -07002167void grpc_use_signal(int signum) {}
murgatroid99623dd4f2016-08-08 17:31:27 -07002168#endif /* !defined(GRPC_LINUX_EPOLL) */