Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
Jan Tattermusch | 7897ae9 | 2017-06-07 22:57:36 +0200 | [diff] [blame] | 3 | * Copyright 2015-2016 gRPC authors. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 4 | * |
Jan Tattermusch | 7897ae9 | 2017-06-07 22:57:36 +0200 | [diff] [blame] | 5 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | * you may not use this file except in compliance with the License. |
| 7 | * You may obtain a copy of the License at |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 8 | * |
Jan Tattermusch | 7897ae9 | 2017-06-07 22:57:36 +0200 | [diff] [blame] | 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 10 | * |
Jan Tattermusch | 7897ae9 | 2017-06-07 22:57:36 +0200 | [diff] [blame] | 11 | * Unless required by applicable law or agreed to in writing, software |
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | * See the License for the specific language governing permissions and |
| 15 | * limitations under the License. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 16 | * |
| 17 | */ |
Yash Tibrewal | 37fdb73 | 2017-09-25 16:45:02 -0700 | [diff] [blame] | 18 | #include <grpc/support/port_platform.h> |
| 19 | |
Craig Tiller | 9533d04 | 2016-03-25 17:11:06 -0700 | [diff] [blame] | 20 | #include "src/core/lib/surface/completion_queue.h" |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 21 | |
Yash Tibrewal | fcd26bc | 2017-09-25 15:08:28 -0700 | [diff] [blame] | 22 | #include <inttypes.h> |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 23 | #include <stdio.h> |
| 24 | #include <string.h> |
| 25 | |
Craig Tiller | 69b093b | 2016-02-25 19:04:07 -0800 | [diff] [blame] | 26 | #include <grpc/support/alloc.h> |
| 27 | #include <grpc/support/atm.h> |
| 28 | #include <grpc/support/log.h> |
Craig Tiller | 4e41e36 | 2016-08-19 13:12:54 -0700 | [diff] [blame] | 29 | #include <grpc/support/string_util.h> |
Craig Tiller | 69b093b | 2016-02-25 19:04:07 -0800 | [diff] [blame] | 30 | #include <grpc/support/time.h> |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 31 | #include <grpc/support/tls.h> |
Craig Tiller | 69b093b | 2016-02-25 19:04:07 -0800 | [diff] [blame] | 32 | |
Craig Tiller | f1dc9c3 | 2017-09-13 14:21:27 -0700 | [diff] [blame] | 33 | #include "src/core/lib/debug/stats.h" |
Craig Tiller | 9533d04 | 2016-03-25 17:11:06 -0700 | [diff] [blame] | 34 | #include "src/core/lib/iomgr/pollset.h" |
| 35 | #include "src/core/lib/iomgr/timer.h" |
| 36 | #include "src/core/lib/profiling/timers.h" |
Sree Kuchibhotla | fe5f235 | 2017-04-18 13:46:10 -0700 | [diff] [blame] | 37 | #include "src/core/lib/support/spinlock.h" |
Craig Tiller | 9533d04 | 2016-03-25 17:11:06 -0700 | [diff] [blame] | 38 | #include "src/core/lib/support/string.h" |
| 39 | #include "src/core/lib/surface/api_trace.h" |
| 40 | #include "src/core/lib/surface/call.h" |
| 41 | #include "src/core/lib/surface/event_string.h" |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 42 | |
ncteisen | 7712c7c | 2017-07-12 23:11:27 -0700 | [diff] [blame] | 43 | grpc_tracer_flag grpc_trace_operation_failures = |
| 44 | GRPC_TRACER_INITIALIZER(false, "op_failure"); |
Craig Tiller | 4e41e36 | 2016-08-19 13:12:54 -0700 | [diff] [blame] | 45 | #ifndef NDEBUG |
ncteisen | 7712c7c | 2017-07-12 23:11:27 -0700 | [diff] [blame] | 46 | grpc_tracer_flag grpc_trace_pending_tags = |
| 47 | GRPC_TRACER_INITIALIZER(false, "pending_tags"); |
| 48 | grpc_tracer_flag grpc_trace_cq_refcount = |
| 49 | GRPC_TRACER_INITIALIZER(false, "cq_refcount"); |
Craig Tiller | 4e41e36 | 2016-08-19 13:12:54 -0700 | [diff] [blame] | 50 | #endif |
Craig Tiller | a286b04 | 2016-06-13 15:20:39 +0000 | [diff] [blame] | 51 | |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 52 | // Specifies a cq thread local cache. |
| 53 | // The first event that occurs on a thread |
| 54 | // with a cq cache will go into that cache, and |
| 55 | // will only be returned on the thread that initialized the cache. |
| 56 | // NOTE: Only one event will ever be cached. |
| 57 | GPR_TLS_DECL(g_cached_event); |
| 58 | GPR_TLS_DECL(g_cached_cq); |
| 59 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 60 | typedef struct { |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 61 | grpc_pollset_worker** worker; |
| 62 | void* tag; |
Craig Tiller | 5ddbb9d | 2015-07-29 15:58:11 -0700 | [diff] [blame] | 63 | } plucker; |
| 64 | |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 65 | typedef struct { |
Craig Tiller | 75bfb97 | 2017-04-11 17:55:12 -0700 | [diff] [blame] | 66 | bool can_get_pollset; |
Craig Tiller | 11c5832 | 2017-04-12 08:21:17 -0700 | [diff] [blame] | 67 | bool can_listen; |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 68 | size_t (*size)(void); |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 69 | void (*init)(grpc_pollset* pollset, gpr_mu** mu); |
| 70 | grpc_error* (*kick)(grpc_exec_ctx* exec_ctx, grpc_pollset* pollset, |
| 71 | grpc_pollset_worker* specific_worker); |
| 72 | grpc_error* (*work)(grpc_exec_ctx* exec_ctx, grpc_pollset* pollset, |
| 73 | grpc_pollset_worker** worker, grpc_millis deadline); |
| 74 | void (*shutdown)(grpc_exec_ctx* exec_ctx, grpc_pollset* pollset, |
| 75 | grpc_closure* closure); |
| 76 | void (*destroy)(grpc_exec_ctx* exec_ctx, grpc_pollset* pollset); |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 77 | } cq_poller_vtable; |
| 78 | |
| 79 | typedef struct non_polling_worker { |
| 80 | gpr_cv cv; |
| 81 | bool kicked; |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 82 | struct non_polling_worker* next; |
| 83 | struct non_polling_worker* prev; |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 84 | } non_polling_worker; |
| 85 | |
| 86 | typedef struct { |
| 87 | gpr_mu mu; |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 88 | non_polling_worker* root; |
| 89 | grpc_closure* shutdown; |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 90 | } non_polling_poller; |
| 91 | |
| 92 | static size_t non_polling_poller_size(void) { |
| 93 | return sizeof(non_polling_poller); |
| 94 | } |
| 95 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 96 | static void non_polling_poller_init(grpc_pollset* pollset, gpr_mu** mu) { |
| 97 | non_polling_poller* npp = (non_polling_poller*)pollset; |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 98 | gpr_mu_init(&npp->mu); |
| 99 | *mu = &npp->mu; |
| 100 | } |
| 101 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 102 | static void non_polling_poller_destroy(grpc_exec_ctx* exec_ctx, |
| 103 | grpc_pollset* pollset) { |
| 104 | non_polling_poller* npp = (non_polling_poller*)pollset; |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 105 | gpr_mu_destroy(&npp->mu); |
| 106 | } |
| 107 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 108 | static grpc_error* non_polling_poller_work(grpc_exec_ctx* exec_ctx, |
| 109 | grpc_pollset* pollset, |
| 110 | grpc_pollset_worker** worker, |
Craig Tiller | dc3998e | 2017-05-12 09:55:30 -0700 | [diff] [blame] | 111 | grpc_millis deadline) { |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 112 | non_polling_poller* npp = (non_polling_poller*)pollset; |
Craig Tiller | 75bfb97 | 2017-04-11 17:55:12 -0700 | [diff] [blame] | 113 | if (npp->shutdown) return GRPC_ERROR_NONE; |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 114 | non_polling_worker w; |
| 115 | gpr_cv_init(&w.cv); |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 116 | if (worker != nullptr) *worker = (grpc_pollset_worker*)&w; |
| 117 | if (npp->root == nullptr) { |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 118 | npp->root = w.next = w.prev = &w; |
| 119 | } else { |
| 120 | w.next = npp->root; |
| 121 | w.prev = w.next->prev; |
| 122 | w.next->prev = w.prev->next = &w; |
| 123 | } |
| 124 | w.kicked = false; |
Craig Tiller | dc3998e | 2017-05-12 09:55:30 -0700 | [diff] [blame] | 125 | gpr_timespec deadline_ts = |
Craig Tiller | c0df1c0 | 2017-07-17 16:12:33 -0700 | [diff] [blame] | 126 | grpc_millis_to_timespec(deadline, GPR_CLOCK_REALTIME); |
Craig Tiller | dc3998e | 2017-05-12 09:55:30 -0700 | [diff] [blame] | 127 | while (!npp->shutdown && !w.kicked && |
| 128 | !gpr_cv_wait(&w.cv, &npp->mu, deadline_ts)) |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 129 | ; |
Jan Tattermusch | 62a4fd3 | 2017-11-04 18:09:12 +0100 | [diff] [blame] | 130 | grpc_exec_ctx_invalidate_now(exec_ctx); |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 131 | if (&w == npp->root) { |
| 132 | npp->root = w.next; |
| 133 | if (&w == npp->root) { |
| 134 | if (npp->shutdown) { |
ncteisen | 274bbbe | 2017-06-08 14:57:11 -0700 | [diff] [blame] | 135 | GRPC_CLOSURE_SCHED(exec_ctx, npp->shutdown, GRPC_ERROR_NONE); |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 136 | } |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 137 | npp->root = nullptr; |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 138 | } |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 139 | } |
Craig Tiller | 75bfb97 | 2017-04-11 17:55:12 -0700 | [diff] [blame] | 140 | w.next->prev = w.prev; |
| 141 | w.prev->next = w.next; |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 142 | gpr_cv_destroy(&w.cv); |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 143 | if (worker != nullptr) *worker = nullptr; |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 144 | return GRPC_ERROR_NONE; |
| 145 | } |
| 146 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 147 | static grpc_error* non_polling_poller_kick( |
| 148 | grpc_exec_ctx* exec_ctx, grpc_pollset* pollset, |
| 149 | grpc_pollset_worker* specific_worker) { |
| 150 | non_polling_poller* p = (non_polling_poller*)pollset; |
Craig Tiller | be98d24 | 2017-11-10 15:26:57 -0800 | [diff] [blame] | 151 | if (specific_worker == nullptr) |
| 152 | specific_worker = (grpc_pollset_worker*)p->root; |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 153 | if (specific_worker != nullptr) { |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 154 | non_polling_worker* w = (non_polling_worker*)specific_worker; |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 155 | if (!w->kicked) { |
| 156 | w->kicked = true; |
| 157 | gpr_cv_signal(&w->cv); |
| 158 | } |
| 159 | } |
| 160 | return GRPC_ERROR_NONE; |
| 161 | } |
| 162 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 163 | static void non_polling_poller_shutdown(grpc_exec_ctx* exec_ctx, |
| 164 | grpc_pollset* pollset, |
| 165 | grpc_closure* closure) { |
| 166 | non_polling_poller* p = (non_polling_poller*)pollset; |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 167 | GPR_ASSERT(closure != nullptr); |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 168 | p->shutdown = closure; |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 169 | if (p->root == nullptr) { |
ncteisen | 274bbbe | 2017-06-08 14:57:11 -0700 | [diff] [blame] | 170 | GRPC_CLOSURE_SCHED(exec_ctx, closure, GRPC_ERROR_NONE); |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 171 | } else { |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 172 | non_polling_worker* w = p->root; |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 173 | do { |
| 174 | gpr_cv_signal(&w->cv); |
| 175 | w = w->next; |
| 176 | } while (w != p->root); |
| 177 | } |
| 178 | } |
| 179 | |
| 180 | static const cq_poller_vtable g_poller_vtable_by_poller_type[] = { |
| 181 | /* GRPC_CQ_DEFAULT_POLLING */ |
Yash Tibrewal | d8b84a2 | 2017-09-25 13:38:03 -0700 | [diff] [blame] | 182 | {true, true, grpc_pollset_size, grpc_pollset_init, grpc_pollset_kick, |
| 183 | grpc_pollset_work, grpc_pollset_shutdown, grpc_pollset_destroy}, |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 184 | /* GRPC_CQ_NON_LISTENING */ |
Yash Tibrewal | d8b84a2 | 2017-09-25 13:38:03 -0700 | [diff] [blame] | 185 | {true, false, grpc_pollset_size, grpc_pollset_init, grpc_pollset_kick, |
| 186 | grpc_pollset_work, grpc_pollset_shutdown, grpc_pollset_destroy}, |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 187 | /* GRPC_CQ_NON_POLLING */ |
Yash Tibrewal | d8b84a2 | 2017-09-25 13:38:03 -0700 | [diff] [blame] | 188 | {false, false, non_polling_poller_size, non_polling_poller_init, |
| 189 | non_polling_poller_kick, non_polling_poller_work, |
| 190 | non_polling_poller_shutdown, non_polling_poller_destroy}, |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 191 | }; |
| 192 | |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 193 | typedef struct cq_vtable { |
| 194 | grpc_cq_completion_type cq_completion_type; |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 195 | size_t data_size; |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 196 | void (*init)(void* data); |
| 197 | void (*shutdown)(grpc_exec_ctx* exec_ctx, grpc_completion_queue* cq); |
| 198 | void (*destroy)(void* data); |
| 199 | bool (*begin_op)(grpc_completion_queue* cq, void* tag); |
| 200 | void (*end_op)(grpc_exec_ctx* exec_ctx, grpc_completion_queue* cq, void* tag, |
| 201 | grpc_error* error, |
| 202 | void (*done)(grpc_exec_ctx* exec_ctx, void* done_arg, |
| 203 | grpc_cq_completion* storage), |
| 204 | void* done_arg, grpc_cq_completion* storage); |
| 205 | grpc_event (*next)(grpc_completion_queue* cq, gpr_timespec deadline, |
| 206 | void* reserved); |
| 207 | grpc_event (*pluck)(grpc_completion_queue* cq, void* tag, |
| 208 | gpr_timespec deadline, void* reserved); |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 209 | } cq_vtable; |
| 210 | |
| 211 | /* Queue that holds the cq_completion_events. Internally uses gpr_mpscq queue |
| 212 | * (a lockfree multiproducer single consumer queue). It uses a queue_lock |
| 213 | * to support multiple consumers. |
| 214 | * Only used in completion queues whose completion_type is GRPC_CQ_NEXT */ |
Sree Kuchibhotla | 078a340 | 2017-04-11 21:23:03 -0700 | [diff] [blame] | 215 | typedef struct grpc_cq_event_queue { |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 216 | /* Spinlock to serialize consumers i.e pop() operations */ |
Sree Kuchibhotla | fe5f235 | 2017-04-18 13:46:10 -0700 | [diff] [blame] | 217 | gpr_spinlock queue_lock; |
Sree Kuchibhotla | 078a340 | 2017-04-11 21:23:03 -0700 | [diff] [blame] | 218 | |
| 219 | gpr_mpscq queue; |
| 220 | |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 221 | /* A lazy counter of number of items in the queue. This is NOT atomically |
| 222 | incremented/decremented along with push/pop operations and hence is only |
| 223 | eventually consistent */ |
Sree Kuchibhotla | 078a340 | 2017-04-11 21:23:03 -0700 | [diff] [blame] | 224 | gpr_atm num_queue_items; |
| 225 | } grpc_cq_event_queue; |
| 226 | |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 227 | typedef struct cq_next_data { |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 228 | /** Completed events for completion-queues of type GRPC_CQ_NEXT */ |
Sree Kuchibhotla | 078a340 | 2017-04-11 21:23:03 -0700 | [diff] [blame] | 229 | grpc_cq_event_queue queue; |
Sree Kuchibhotla | 5461a8b | 2017-04-10 09:52:40 -0700 | [diff] [blame] | 230 | |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 231 | /** Counter of how many things have ever been queued on this completion queue |
| 232 | useful for avoiding locks to check the queue */ |
| 233 | gpr_atm things_queued_ever; |
| 234 | |
Craig Tiller | caf8ea9 | 2017-06-01 16:08:58 -0700 | [diff] [blame] | 235 | /* Number of outstanding events (+1 if not shut down) */ |
| 236 | gpr_atm pending_events; |
| 237 | |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 238 | /** 0 initially. 1 once we initiated shutdown */ |
| 239 | bool shutdown_called; |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 240 | } cq_next_data; |
| 241 | |
| 242 | typedef struct cq_pluck_data { |
| 243 | /** Completed events for completion-queues of type GRPC_CQ_PLUCK */ |
| 244 | grpc_cq_completion completed_head; |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 245 | grpc_cq_completion* completed_tail; |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 246 | |
| 247 | /** Number of pending events (+1 if we're not shutdown) */ |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 248 | gpr_atm pending_events; |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 249 | |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 250 | /** Counter of how many things have ever been queued on this completion queue |
Craig Tiller | aef3a79 | 2016-08-24 15:13:53 -0700 | [diff] [blame] | 251 | useful for avoiding locks to check the queue */ |
| 252 | gpr_atm things_queued_ever; |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 253 | |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 254 | /** 0 initially. 1 once we completed shutting */ |
| 255 | /* TODO: (sreek) This is not needed since (shutdown == 1) if and only if |
| 256 | * (pending_events == 0). So consider removing this in future and use |
| 257 | * pending_events */ |
Sree Kuchibhotla | 94aff9e | 2017-04-10 10:25:03 -0700 | [diff] [blame] | 258 | gpr_atm shutdown; |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 259 | |
| 260 | /** 0 initially. 1 once we initiated shutdown */ |
| 261 | bool shutdown_called; |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 262 | |
Craig Tiller | 5ddbb9d | 2015-07-29 15:58:11 -0700 | [diff] [blame] | 263 | int num_pluckers; |
Craig Tiller | 489df07 | 2015-08-01 16:15:45 -0700 | [diff] [blame] | 264 | plucker pluckers[GRPC_MAX_COMPLETION_QUEUE_PLUCKERS]; |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 265 | } cq_pluck_data; |
| 266 | |
| 267 | /* Completion queue structure */ |
| 268 | struct grpc_completion_queue { |
| 269 | /** Once owning_refs drops to zero, we will destroy the cq */ |
| 270 | gpr_refcount owning_refs; |
| 271 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 272 | gpr_mu* mu; |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 273 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 274 | const cq_vtable* vtable; |
| 275 | const cq_poller_vtable* poller_vtable; |
Craig Tiller | c7e1a2a | 2015-11-02 14:17:32 -0800 | [diff] [blame] | 276 | |
Craig Tiller | 4bf2928 | 2015-12-14 11:25:48 -0800 | [diff] [blame] | 277 | #ifndef NDEBUG |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 278 | void** outstanding_tags; |
Craig Tiller | 4bf2928 | 2015-12-14 11:25:48 -0800 | [diff] [blame] | 279 | size_t outstanding_tag_count; |
| 280 | size_t outstanding_tag_capacity; |
| 281 | #endif |
| 282 | |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 283 | grpc_closure pollset_shutdown_done; |
| 284 | int num_polls; |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 285 | }; |
| 286 | |
Sree Kuchibhotla | 736dd90 | 2017-04-25 18:26:53 -0700 | [diff] [blame] | 287 | /* Forward declarations */ |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 288 | static void cq_finish_shutdown_next(grpc_exec_ctx* exec_ctx, |
| 289 | grpc_completion_queue* cq); |
| 290 | static void cq_finish_shutdown_pluck(grpc_exec_ctx* exec_ctx, |
| 291 | grpc_completion_queue* cq); |
| 292 | static void cq_shutdown_next(grpc_exec_ctx* exec_ctx, |
| 293 | grpc_completion_queue* cq); |
| 294 | static void cq_shutdown_pluck(grpc_exec_ctx* exec_ctx, |
| 295 | grpc_completion_queue* cq); |
Sree Kuchibhotla | 736dd90 | 2017-04-25 18:26:53 -0700 | [diff] [blame] | 296 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 297 | static bool cq_begin_op_for_next(grpc_completion_queue* cq, void* tag); |
| 298 | static bool cq_begin_op_for_pluck(grpc_completion_queue* cq, void* tag); |
Sree Kuchibhotla | 736dd90 | 2017-04-25 18:26:53 -0700 | [diff] [blame] | 299 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 300 | static void cq_end_op_for_next(grpc_exec_ctx* exec_ctx, |
| 301 | grpc_completion_queue* cq, void* tag, |
| 302 | grpc_error* error, |
| 303 | void (*done)(grpc_exec_ctx* exec_ctx, |
| 304 | void* done_arg, |
| 305 | grpc_cq_completion* storage), |
| 306 | void* done_arg, grpc_cq_completion* storage); |
Sree Kuchibhotla | 736dd90 | 2017-04-25 18:26:53 -0700 | [diff] [blame] | 307 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 308 | static void cq_end_op_for_pluck(grpc_exec_ctx* exec_ctx, |
| 309 | grpc_completion_queue* cq, void* tag, |
| 310 | grpc_error* error, |
| 311 | void (*done)(grpc_exec_ctx* exec_ctx, |
| 312 | void* done_arg, |
| 313 | grpc_cq_completion* storage), |
| 314 | void* done_arg, grpc_cq_completion* storage); |
Sree Kuchibhotla | 736dd90 | 2017-04-25 18:26:53 -0700 | [diff] [blame] | 315 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 316 | static grpc_event cq_next(grpc_completion_queue* cq, gpr_timespec deadline, |
| 317 | void* reserved); |
Sree Kuchibhotla | 736dd90 | 2017-04-25 18:26:53 -0700 | [diff] [blame] | 318 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 319 | static grpc_event cq_pluck(grpc_completion_queue* cq, void* tag, |
| 320 | gpr_timespec deadline, void* reserved); |
Sree Kuchibhotla | 736dd90 | 2017-04-25 18:26:53 -0700 | [diff] [blame] | 321 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 322 | static void cq_init_next(void* data); |
| 323 | static void cq_init_pluck(void* data); |
| 324 | static void cq_destroy_next(void* data); |
| 325 | static void cq_destroy_pluck(void* data); |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 326 | |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 327 | /* Completion queue vtables based on the completion-type */ |
| 328 | static const cq_vtable g_cq_vtable[] = { |
| 329 | /* GRPC_CQ_NEXT */ |
Yash Tibrewal | 533d118 | 2017-09-18 10:48:22 -0700 | [diff] [blame] | 330 | {GRPC_CQ_NEXT, sizeof(cq_next_data), cq_init_next, cq_shutdown_next, |
Craig Tiller | be98d24 | 2017-11-10 15:26:57 -0800 | [diff] [blame] | 331 | cq_destroy_next, cq_begin_op_for_next, cq_end_op_for_next, cq_next, |
| 332 | nullptr}, |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 333 | /* GRPC_CQ_PLUCK */ |
Yash Tibrewal | 533d118 | 2017-09-18 10:48:22 -0700 | [diff] [blame] | 334 | {GRPC_CQ_PLUCK, sizeof(cq_pluck_data), cq_init_pluck, cq_shutdown_pluck, |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 335 | cq_destroy_pluck, cq_begin_op_for_pluck, cq_end_op_for_pluck, nullptr, |
Yash Tibrewal | 533d118 | 2017-09-18 10:48:22 -0700 | [diff] [blame] | 336 | cq_pluck}, |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 337 | }; |
| 338 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 339 | #define DATA_FROM_CQ(cq) ((void*)(cq + 1)) |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 340 | #define POLLSET_FROM_CQ(cq) \ |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 341 | ((grpc_pollset*)(cq->vtable->data_size + (char*)DATA_FROM_CQ(cq))) |
Craig Tiller | 69b093b | 2016-02-25 19:04:07 -0800 | [diff] [blame] | 342 | |
ncteisen | 7712c7c | 2017-07-12 23:11:27 -0700 | [diff] [blame] | 343 | grpc_tracer_flag grpc_cq_pluck_trace = |
| 344 | GRPC_TRACER_INITIALIZER(true, "queue_pluck"); |
| 345 | grpc_tracer_flag grpc_cq_event_timeout_trace = |
| 346 | GRPC_TRACER_INITIALIZER(true, "queue_timeout"); |
murgatroid99 | 9f6a805 | 2016-06-15 17:39:03 -0700 | [diff] [blame] | 347 | |
Craig Tiller | 84f75d4 | 2017-05-03 13:06:35 -0700 | [diff] [blame] | 348 | #define GRPC_SURFACE_TRACE_RETURNED_EVENT(cq, event) \ |
| 349 | if (GRPC_TRACER_ON(grpc_api_trace) && \ |
| 350 | (GRPC_TRACER_ON(grpc_cq_pluck_trace) || \ |
| 351 | (event)->type != GRPC_QUEUE_TIMEOUT)) { \ |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 352 | char* _ev = grpc_event_string(event); \ |
Craig Tiller | 84f75d4 | 2017-05-03 13:06:35 -0700 | [diff] [blame] | 353 | gpr_log(GPR_INFO, "RETURN_EVENT[%p]: %s", cq, _ev); \ |
| 354 | gpr_free(_ev); \ |
murgatroid99 | 9f6a805 | 2016-06-15 17:39:03 -0700 | [diff] [blame] | 355 | } |
| 356 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 357 | static void on_pollset_shutdown_done(grpc_exec_ctx* exec_ctx, void* cq, |
| 358 | grpc_error* error); |
Craig Tiller | c7e1a2a | 2015-11-02 14:17:32 -0800 | [diff] [blame] | 359 | |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 360 | void grpc_cq_global_init() { |
| 361 | gpr_tls_init(&g_cached_event); |
| 362 | gpr_tls_init(&g_cached_cq); |
| 363 | } |
| 364 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 365 | void grpc_completion_queue_thread_local_cache_init(grpc_completion_queue* cq) { |
| 366 | if ((grpc_completion_queue*)gpr_tls_get(&g_cached_cq) == nullptr) { |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 367 | gpr_tls_set(&g_cached_event, (intptr_t)0); |
| 368 | gpr_tls_set(&g_cached_cq, (intptr_t)cq); |
| 369 | } |
| 370 | } |
| 371 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 372 | int grpc_completion_queue_thread_local_cache_flush(grpc_completion_queue* cq, |
| 373 | void** tag, int* ok) { |
| 374 | grpc_cq_completion* storage = |
| 375 | (grpc_cq_completion*)gpr_tls_get(&g_cached_event); |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 376 | int ret = 0; |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 377 | if (storage != nullptr && |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 378 | (grpc_completion_queue*)gpr_tls_get(&g_cached_cq) == cq) { |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 379 | *tag = storage->tag; |
| 380 | grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT; |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 381 | *ok = (storage->next & (uintptr_t)(1)) == 1; |
Ken Payson | e153357 | 2017-11-07 11:27:02 -0800 | [diff] [blame] | 382 | storage->done(&exec_ctx, storage->done_arg, storage); |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 383 | ret = 1; |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 384 | cq_next_data* cqd = (cq_next_data*)DATA_FROM_CQ(cq); |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 385 | if (gpr_atm_full_fetch_add(&cqd->pending_events, -1) == 1) { |
| 386 | GRPC_CQ_INTERNAL_REF(cq, "shutting_down"); |
| 387 | gpr_mu_lock(cq->mu); |
| 388 | cq_finish_shutdown_next(&exec_ctx, cq); |
| 389 | gpr_mu_unlock(cq->mu); |
| 390 | GRPC_CQ_INTERNAL_UNREF(&exec_ctx, cq, "shutting_down"); |
| 391 | } |
| 392 | grpc_exec_ctx_finish(&exec_ctx); |
| 393 | } |
| 394 | gpr_tls_set(&g_cached_event, (intptr_t)0); |
| 395 | gpr_tls_set(&g_cached_cq, (intptr_t)0); |
| 396 | |
| 397 | return ret; |
| 398 | } |
| 399 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 400 | static void cq_event_queue_init(grpc_cq_event_queue* q) { |
Sree Kuchibhotla | 078a340 | 2017-04-11 21:23:03 -0700 | [diff] [blame] | 401 | gpr_mpscq_init(&q->queue); |
Sree Kuchibhotla | fe5f235 | 2017-04-18 13:46:10 -0700 | [diff] [blame] | 402 | q->queue_lock = GPR_SPINLOCK_INITIALIZER; |
Sree Kuchibhotla | 078a340 | 2017-04-11 21:23:03 -0700 | [diff] [blame] | 403 | gpr_atm_no_barrier_store(&q->num_queue_items, 0); |
| 404 | } |
| 405 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 406 | static void cq_event_queue_destroy(grpc_cq_event_queue* q) { |
Sree Kuchibhotla | 078a340 | 2017-04-11 21:23:03 -0700 | [diff] [blame] | 407 | gpr_mpscq_destroy(&q->queue); |
Sree Kuchibhotla | 078a340 | 2017-04-11 21:23:03 -0700 | [diff] [blame] | 408 | } |
| 409 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 410 | static bool cq_event_queue_push(grpc_cq_event_queue* q, grpc_cq_completion* c) { |
| 411 | gpr_mpscq_push(&q->queue, (gpr_mpscq_node*)c); |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 412 | return gpr_atm_no_barrier_fetch_add(&q->num_queue_items, 1) == 0; |
Sree Kuchibhotla | 078a340 | 2017-04-11 21:23:03 -0700 | [diff] [blame] | 413 | } |
| 414 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 415 | static grpc_cq_completion* cq_event_queue_pop(grpc_cq_event_queue* q) { |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 416 | grpc_cq_completion* c = nullptr; |
Sree Kuchibhotla | 0d0fa06 | 2017-10-03 16:04:42 -0700 | [diff] [blame] | 417 | grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT; |
| 418 | |
Sree Kuchibhotla | fe5f235 | 2017-04-18 13:46:10 -0700 | [diff] [blame] | 419 | if (gpr_spinlock_trylock(&q->queue_lock)) { |
Sree Kuchibhotla | 0d0fa06 | 2017-10-03 16:04:42 -0700 | [diff] [blame] | 420 | GRPC_STATS_INC_CQ_EV_QUEUE_TRYLOCK_SUCCESSES(&exec_ctx); |
| 421 | |
| 422 | bool is_empty = false; |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 423 | c = (grpc_cq_completion*)gpr_mpscq_pop_and_check_end(&q->queue, &is_empty); |
Sree Kuchibhotla | fe5f235 | 2017-04-18 13:46:10 -0700 | [diff] [blame] | 424 | gpr_spinlock_unlock(&q->queue_lock); |
Sree Kuchibhotla | 0d0fa06 | 2017-10-03 16:04:42 -0700 | [diff] [blame] | 425 | |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 426 | if (c == nullptr && !is_empty) { |
Sree Kuchibhotla | 0d0fa06 | 2017-10-03 16:04:42 -0700 | [diff] [blame] | 427 | GRPC_STATS_INC_CQ_EV_QUEUE_TRANSIENT_POP_FAILURES(&exec_ctx); |
| 428 | } |
Sree Kuchibhotla | 2f2175c | 2017-10-03 14:25:08 -0700 | [diff] [blame] | 429 | } else { |
Sree Kuchibhotla | 0d0fa06 | 2017-10-03 16:04:42 -0700 | [diff] [blame] | 430 | GRPC_STATS_INC_CQ_EV_QUEUE_TRYLOCK_FAILURES(&exec_ctx); |
Sree Kuchibhotla | fe5f235 | 2017-04-18 13:46:10 -0700 | [diff] [blame] | 431 | } |
| 432 | |
Sree Kuchibhotla | 0d0fa06 | 2017-10-03 16:04:42 -0700 | [diff] [blame] | 433 | grpc_exec_ctx_finish(&exec_ctx); |
| 434 | |
Sree Kuchibhotla | 078a340 | 2017-04-11 21:23:03 -0700 | [diff] [blame] | 435 | if (c) { |
| 436 | gpr_atm_no_barrier_fetch_add(&q->num_queue_items, -1); |
| 437 | } |
| 438 | |
| 439 | return c; |
| 440 | } |
| 441 | |
| 442 | /* Note: The counter is not incremented/decremented atomically with push/pop. |
| 443 | * The count is only eventually consistent */ |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 444 | static long cq_event_queue_num_items(grpc_cq_event_queue* q) { |
Sree Kuchibhotla | fe5f235 | 2017-04-18 13:46:10 -0700 | [diff] [blame] | 445 | return (long)gpr_atm_no_barrier_load(&q->num_queue_items); |
Sree Kuchibhotla | 078a340 | 2017-04-11 21:23:03 -0700 | [diff] [blame] | 446 | } |
| 447 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 448 | grpc_completion_queue* grpc_completion_queue_create_internal( |
Sree Kuchibhotla | 2abbf8a | 2017-03-21 17:31:03 -0700 | [diff] [blame] | 449 | grpc_cq_completion_type completion_type, |
| 450 | grpc_cq_polling_type polling_type) { |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 451 | grpc_completion_queue* cq; |
Craig Tiller | c7e1a2a | 2015-11-02 14:17:32 -0800 | [diff] [blame] | 452 | |
Sree Kuchibhotla | 2abbf8a | 2017-03-21 17:31:03 -0700 | [diff] [blame] | 453 | GPR_TIMER_BEGIN("grpc_completion_queue_create_internal", 0); |
Craig Tiller | c7e1a2a | 2015-11-02 14:17:32 -0800 | [diff] [blame] | 454 | |
Sree Kuchibhotla | 2abbf8a | 2017-03-21 17:31:03 -0700 | [diff] [blame] | 455 | GRPC_API_TRACE( |
| 456 | "grpc_completion_queue_create_internal(completion_type=%d, " |
| 457 | "polling_type=%d)", |
| 458 | 2, (completion_type, polling_type)); |
Craig Tiller | c7e1a2a | 2015-11-02 14:17:32 -0800 | [diff] [blame] | 459 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 460 | const cq_vtable* vtable = &g_cq_vtable[completion_type]; |
| 461 | const cq_poller_vtable* poller_vtable = |
Craig Tiller | 2f40ff4 | 2017-04-11 16:01:19 -0700 | [diff] [blame] | 462 | &g_poller_vtable_by_poller_type[polling_type]; |
| 463 | |
Craig Tiller | f1dc9c3 | 2017-09-13 14:21:27 -0700 | [diff] [blame] | 464 | grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT; |
| 465 | GRPC_STATS_INC_CQS_CREATED(&exec_ctx); |
| 466 | grpc_exec_ctx_finish(&exec_ctx); |
| 467 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 468 | cq = (grpc_completion_queue*)gpr_zalloc(sizeof(grpc_completion_queue) + |
| 469 | vtable->data_size + |
| 470 | poller_vtable->size()); |
Craig Tiller | c7e1a2a | 2015-11-02 14:17:32 -0800 | [diff] [blame] | 471 | |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 472 | cq->vtable = vtable; |
| 473 | cq->poller_vtable = poller_vtable; |
Sree Kuchibhotla | 321881d | 2017-02-27 11:25:28 -0800 | [diff] [blame] | 474 | |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 475 | /* One for destroy(), one for pollset_shutdown */ |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 476 | gpr_ref_init(&cq->owning_refs, 2); |
| 477 | |
| 478 | poller_vtable->init(POLLSET_FROM_CQ(cq), &cq->mu); |
| 479 | vtable->init(DATA_FROM_CQ(cq)); |
| 480 | |
Craig Tiller | e7183b7 | 2017-06-19 11:21:02 -0700 | [diff] [blame] | 481 | GRPC_CLOSURE_INIT(&cq->pollset_shutdown_done, on_pollset_shutdown_done, cq, |
Craig Tiller | d465456 | 2017-01-03 08:45:56 -0800 | [diff] [blame] | 482 | grpc_schedule_on_exec_ctx); |
Craig Tiller | c7e1a2a | 2015-11-02 14:17:32 -0800 | [diff] [blame] | 483 | |
Sree Kuchibhotla | 2abbf8a | 2017-03-21 17:31:03 -0700 | [diff] [blame] | 484 | GPR_TIMER_END("grpc_completion_queue_create_internal", 0); |
Craig Tiller | c7e1a2a | 2015-11-02 14:17:32 -0800 | [diff] [blame] | 485 | |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 486 | return cq; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 487 | } |
| 488 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 489 | static void cq_init_next(void* ptr) { |
| 490 | cq_next_data* cqd = (cq_next_data*)ptr; |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 491 | /* Initial count is dropped by grpc_completion_queue_shutdown */ |
Craig Tiller | caf8ea9 | 2017-06-01 16:08:58 -0700 | [diff] [blame] | 492 | gpr_atm_no_barrier_store(&cqd->pending_events, 1); |
| 493 | cqd->shutdown_called = false; |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 494 | gpr_atm_no_barrier_store(&cqd->things_queued_ever, 0); |
| 495 | cq_event_queue_init(&cqd->queue); |
| 496 | } |
| 497 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 498 | static void cq_destroy_next(void* ptr) { |
| 499 | cq_next_data* cqd = (cq_next_data*)ptr; |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 500 | GPR_ASSERT(cq_event_queue_num_items(&cqd->queue) == 0); |
| 501 | cq_event_queue_destroy(&cqd->queue); |
| 502 | } |
| 503 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 504 | static void cq_init_pluck(void* ptr) { |
| 505 | cq_pluck_data* cqd = (cq_pluck_data*)ptr; |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 506 | /* Initial count is dropped by grpc_completion_queue_shutdown */ |
| 507 | gpr_atm_no_barrier_store(&cqd->pending_events, 1); |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 508 | cqd->completed_tail = &cqd->completed_head; |
| 509 | cqd->completed_head.next = (uintptr_t)cqd->completed_tail; |
| 510 | gpr_atm_no_barrier_store(&cqd->shutdown, 0); |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 511 | cqd->shutdown_called = false; |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 512 | cqd->num_pluckers = 0; |
| 513 | gpr_atm_no_barrier_store(&cqd->things_queued_ever, 0); |
| 514 | } |
| 515 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 516 | static void cq_destroy_pluck(void* ptr) { |
| 517 | cq_pluck_data* cqd = (cq_pluck_data*)ptr; |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 518 | GPR_ASSERT(cqd->completed_head.next == (uintptr_t)&cqd->completed_head); |
| 519 | } |
| 520 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 521 | grpc_cq_completion_type grpc_get_cq_completion_type(grpc_completion_queue* cq) { |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 522 | return cq->vtable->cq_completion_type; |
Sree Kuchibhotla | 321881d | 2017-02-27 11:25:28 -0800 | [diff] [blame] | 523 | } |
| 524 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 525 | int grpc_get_cq_poll_num(grpc_completion_queue* cq) { |
Yuxuan Li | 87827e0 | 2017-05-05 14:12:42 -0700 | [diff] [blame] | 526 | int cur_num_polls; |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 527 | gpr_mu_lock(cq->mu); |
| 528 | cur_num_polls = cq->num_polls; |
| 529 | gpr_mu_unlock(cq->mu); |
Yuxuan Li | 87827e0 | 2017-05-05 14:12:42 -0700 | [diff] [blame] | 530 | return cur_num_polls; |
Yuxuan Li | 999ac15 | 2017-05-03 21:36:36 -0700 | [diff] [blame] | 531 | } |
| 532 | |
ncteisen | d39010e | 2017-06-08 17:08:07 -0700 | [diff] [blame] | 533 | #ifndef NDEBUG |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 534 | void grpc_cq_internal_ref(grpc_completion_queue* cq, const char* reason, |
| 535 | const char* file, int line) { |
ncteisen | d39010e | 2017-06-08 17:08:07 -0700 | [diff] [blame] | 536 | if (GRPC_TRACER_ON(grpc_trace_cq_refcount)) { |
Craig Tiller | 39a7327 | 2017-07-05 08:36:04 -0700 | [diff] [blame] | 537 | gpr_atm val = gpr_atm_no_barrier_load(&cq->owning_refs.count); |
ncteisen | 3bc2558 | 2017-06-09 10:35:35 -0700 | [diff] [blame] | 538 | gpr_log(file, line, GPR_LOG_SEVERITY_DEBUG, |
Craig Tiller | 39a7327 | 2017-07-05 08:36:04 -0700 | [diff] [blame] | 539 | "CQ:%p ref %" PRIdPTR " -> %" PRIdPTR " %s", cq, val, val + 1, |
ncteisen | 3bc2558 | 2017-06-09 10:35:35 -0700 | [diff] [blame] | 540 | reason); |
ncteisen | d39010e | 2017-06-08 17:08:07 -0700 | [diff] [blame] | 541 | } |
Craig Tiller | 463f237 | 2015-05-28 16:16:15 -0700 | [diff] [blame] | 542 | #else |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 543 | void grpc_cq_internal_ref(grpc_completion_queue* cq) { |
Craig Tiller | 463f237 | 2015-05-28 16:16:15 -0700 | [diff] [blame] | 544 | #endif |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 545 | gpr_ref(&cq->owning_refs); |
Craig Tiller | 5717a98 | 2015-04-27 12:01:49 -0700 | [diff] [blame] | 546 | } |
| 547 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 548 | static void on_pollset_shutdown_done(grpc_exec_ctx* exec_ctx, void* arg, |
| 549 | grpc_error* error) { |
| 550 | grpc_completion_queue* cq = (grpc_completion_queue*)arg; |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 551 | GRPC_CQ_INTERNAL_UNREF(exec_ctx, cq, "pollset_destroy"); |
Craig Tiller | 5717a98 | 2015-04-27 12:01:49 -0700 | [diff] [blame] | 552 | } |
| 553 | |
ncteisen | d39010e | 2017-06-08 17:08:07 -0700 | [diff] [blame] | 554 | #ifndef NDEBUG |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 555 | void grpc_cq_internal_unref(grpc_exec_ctx* exec_ctx, grpc_completion_queue* cq, |
| 556 | const char* reason, const char* file, int line) { |
ncteisen | d39010e | 2017-06-08 17:08:07 -0700 | [diff] [blame] | 557 | if (GRPC_TRACER_ON(grpc_trace_cq_refcount)) { |
Craig Tiller | 39a7327 | 2017-07-05 08:36:04 -0700 | [diff] [blame] | 558 | gpr_atm val = gpr_atm_no_barrier_load(&cq->owning_refs.count); |
ncteisen | 3bc2558 | 2017-06-09 10:35:35 -0700 | [diff] [blame] | 559 | gpr_log(file, line, GPR_LOG_SEVERITY_DEBUG, |
Craig Tiller | 39a7327 | 2017-07-05 08:36:04 -0700 | [diff] [blame] | 560 | "CQ:%p unref %" PRIdPTR " -> %" PRIdPTR " %s", cq, val, val - 1, |
ncteisen | 3bc2558 | 2017-06-09 10:35:35 -0700 | [diff] [blame] | 561 | reason); |
ncteisen | d39010e | 2017-06-08 17:08:07 -0700 | [diff] [blame] | 562 | } |
Craig Tiller | 463f237 | 2015-05-28 16:16:15 -0700 | [diff] [blame] | 563 | #else |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 564 | void grpc_cq_internal_unref(grpc_exec_ctx* exec_ctx, |
| 565 | grpc_completion_queue* cq) { |
Craig Tiller | 463f237 | 2015-05-28 16:16:15 -0700 | [diff] [blame] | 566 | #endif |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 567 | if (gpr_unref(&cq->owning_refs)) { |
| 568 | cq->vtable->destroy(DATA_FROM_CQ(cq)); |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 569 | cq->poller_vtable->destroy(exec_ctx, POLLSET_FROM_CQ(cq)); |
Craig Tiller | 07e8fb1 | 2017-02-09 21:36:24 -0800 | [diff] [blame] | 570 | #ifndef NDEBUG |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 571 | gpr_free(cq->outstanding_tags); |
Craig Tiller | 07e8fb1 | 2017-02-09 21:36:24 -0800 | [diff] [blame] | 572 | #endif |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 573 | gpr_free(cq); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 574 | } |
Craig Tiller | 5717a98 | 2015-04-27 12:01:49 -0700 | [diff] [blame] | 575 | } |
| 576 | |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 577 | #ifndef NDEBUG |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 578 | static void cq_check_tag(grpc_completion_queue* cq, void* tag, bool lock_cq) { |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 579 | int found = 0; |
| 580 | if (lock_cq) { |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 581 | gpr_mu_lock(cq->mu); |
Craig Tiller | cfc8ae1 | 2016-05-10 20:49:54 -0700 | [diff] [blame] | 582 | } |
Craig Tiller | ce1f19e | 2015-10-09 16:16:04 -0700 | [diff] [blame] | 583 | |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 584 | for (int i = 0; i < (int)cq->outstanding_tag_count; i++) { |
| 585 | if (cq->outstanding_tags[i] == tag) { |
| 586 | cq->outstanding_tag_count--; |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 587 | GPR_SWAP(void*, cq->outstanding_tags[i], |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 588 | cq->outstanding_tags[cq->outstanding_tag_count]); |
Craig Tiller | 4bf2928 | 2015-12-14 11:25:48 -0800 | [diff] [blame] | 589 | found = 1; |
| 590 | break; |
| 591 | } |
| 592 | } |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 593 | |
| 594 | if (lock_cq) { |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 595 | gpr_mu_unlock(cq->mu); |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 596 | } |
| 597 | |
Craig Tiller | 4bf2928 | 2015-12-14 11:25:48 -0800 | [diff] [blame] | 598 | GPR_ASSERT(found); |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 599 | } |
| 600 | #else |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 601 | static void cq_check_tag(grpc_completion_queue* cq, void* tag, bool lock_cq) {} |
Craig Tiller | 4bf2928 | 2015-12-14 11:25:48 -0800 | [diff] [blame] | 602 | #endif |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 603 | |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 604 | /* Atomically increments a counter only if the counter is not zero. Returns |
| 605 | * true if the increment was successful; false if the counter is zero */ |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 606 | static bool atm_inc_if_nonzero(gpr_atm* counter) { |
yang-g | 533fbd3 | 2017-07-13 11:39:44 -0700 | [diff] [blame] | 607 | while (true) { |
Sree Kuchibhotla | c7cebe8 | 2017-09-13 17:51:26 -0700 | [diff] [blame] | 608 | gpr_atm count = gpr_atm_acq_load(counter); |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 609 | /* If zero, we are done. If not, we must to a CAS (instead of an atomic |
| 610 | * increment) to maintain the contract: do not increment the counter if it |
| 611 | * is zero. */ |
yang-g | 533fbd3 | 2017-07-13 11:39:44 -0700 | [diff] [blame] | 612 | if (count == 0) { |
yang-g | 7d6b914 | 2017-07-13 11:48:56 -0700 | [diff] [blame] | 613 | return false; |
Sree Kuchibhotla | c7cebe8 | 2017-09-13 17:51:26 -0700 | [diff] [blame] | 614 | } else if (gpr_atm_full_cas(counter, count, count + 1)) { |
yang-g | 533fbd3 | 2017-07-13 11:39:44 -0700 | [diff] [blame] | 615 | break; |
| 616 | } |
| 617 | } |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 618 | |
yang-g | 7d6b914 | 2017-07-13 11:48:56 -0700 | [diff] [blame] | 619 | return true; |
yang-g | 533fbd3 | 2017-07-13 11:39:44 -0700 | [diff] [blame] | 620 | } |
| 621 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 622 | static bool cq_begin_op_for_next(grpc_completion_queue* cq, void* tag) { |
| 623 | cq_next_data* cqd = (cq_next_data*)DATA_FROM_CQ(cq); |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 624 | return atm_inc_if_nonzero(&cqd->pending_events); |
| 625 | } |
| 626 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 627 | static bool cq_begin_op_for_pluck(grpc_completion_queue* cq, void* tag) { |
| 628 | cq_pluck_data* cqd = (cq_pluck_data*)DATA_FROM_CQ(cq); |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 629 | return atm_inc_if_nonzero(&cqd->pending_events); |
yang-g | 533fbd3 | 2017-07-13 11:39:44 -0700 | [diff] [blame] | 630 | } |
| 631 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 632 | bool grpc_cq_begin_op(grpc_completion_queue* cq, void* tag) { |
yang-g | 533fbd3 | 2017-07-13 11:39:44 -0700 | [diff] [blame] | 633 | #ifndef NDEBUG |
| 634 | gpr_mu_lock(cq->mu); |
| 635 | if (cq->outstanding_tag_count == cq->outstanding_tag_capacity) { |
| 636 | cq->outstanding_tag_capacity = GPR_MAX(4, 2 * cq->outstanding_tag_capacity); |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 637 | cq->outstanding_tags = (void**)gpr_realloc( |
Yash Tibrewal | ca3c1c0 | 2017-09-07 22:47:16 -0700 | [diff] [blame] | 638 | cq->outstanding_tags, |
| 639 | sizeof(*cq->outstanding_tags) * cq->outstanding_tag_capacity); |
yang-g | 533fbd3 | 2017-07-13 11:39:44 -0700 | [diff] [blame] | 640 | } |
| 641 | cq->outstanding_tags[cq->outstanding_tag_count++] = tag; |
| 642 | gpr_mu_unlock(cq->mu); |
| 643 | #endif |
| 644 | return cq->vtable->begin_op(cq, tag); |
| 645 | } |
| 646 | |
Craig Tiller | 39a7327 | 2017-07-05 08:36:04 -0700 | [diff] [blame] | 647 | /* Queue a GRPC_OP_COMPLETED operation to a completion queue (with a |
| 648 | * completion |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 649 | * type of GRPC_CQ_NEXT) */ |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 650 | static void cq_end_op_for_next(grpc_exec_ctx* exec_ctx, |
| 651 | grpc_completion_queue* cq, void* tag, |
| 652 | grpc_error* error, |
| 653 | void (*done)(grpc_exec_ctx* exec_ctx, |
| 654 | void* done_arg, |
| 655 | grpc_cq_completion* storage), |
| 656 | void* done_arg, grpc_cq_completion* storage) { |
Sree Kuchibhotla | 736dd90 | 2017-04-25 18:26:53 -0700 | [diff] [blame] | 657 | GPR_TIMER_BEGIN("cq_end_op_for_next", 0); |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 658 | |
Craig Tiller | 84f75d4 | 2017-05-03 13:06:35 -0700 | [diff] [blame] | 659 | if (GRPC_TRACER_ON(grpc_api_trace) || |
| 660 | (GRPC_TRACER_ON(grpc_trace_operation_failures) && |
| 661 | error != GRPC_ERROR_NONE)) { |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 662 | const char* errmsg = grpc_error_string(error); |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 663 | GRPC_API_TRACE( |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 664 | "cq_end_op_for_next(exec_ctx=%p, cq=%p, tag=%p, error=%s, " |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 665 | "done=%p, done_arg=%p, storage=%p)", |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 666 | 7, (exec_ctx, cq, tag, errmsg, done, done_arg, storage)); |
Craig Tiller | 84f75d4 | 2017-05-03 13:06:35 -0700 | [diff] [blame] | 667 | if (GRPC_TRACER_ON(grpc_trace_operation_failures) && |
| 668 | error != GRPC_ERROR_NONE) { |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 669 | gpr_log(GPR_ERROR, "Operation failed: tag=%p, error=%s", tag, errmsg); |
Craig Tiller | 5ddbb9d | 2015-07-29 15:58:11 -0700 | [diff] [blame] | 670 | } |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 671 | } |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 672 | cq_next_data* cqd = (cq_next_data*)DATA_FROM_CQ(cq); |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 673 | int is_success = (error == GRPC_ERROR_NONE); |
| 674 | |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 675 | storage->tag = tag; |
| 676 | storage->done = done; |
| 677 | storage->done_arg = done_arg; |
Sree Kuchibhotla | 453c611 | 2017-04-11 23:25:42 -0700 | [diff] [blame] | 678 | storage->next = (uintptr_t)(is_success); |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 679 | |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 680 | cq_check_tag(cq, tag, true); /* Used in debug builds only */ |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 681 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 682 | if ((grpc_completion_queue*)gpr_tls_get(&g_cached_cq) == cq && |
| 683 | (grpc_cq_completion*)gpr_tls_get(&g_cached_event) == nullptr) { |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 684 | gpr_tls_set(&g_cached_event, (intptr_t)storage); |
| 685 | } else { |
| 686 | /* Add the completion to the queue */ |
| 687 | bool is_first = cq_event_queue_push(&cqd->queue, storage); |
| 688 | gpr_atm_no_barrier_fetch_add(&cqd->things_queued_ever, 1); |
Sree Kuchibhotla | 49d75e3 | 2017-09-15 15:25:50 -0700 | [diff] [blame] | 689 | |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 690 | /* Since we do not hold the cq lock here, it is important to do an 'acquire' |
| 691 | load here (instead of a 'no_barrier' load) to match with the release |
| 692 | store |
| 693 | (done via gpr_atm_full_fetch_add(pending_events, -1)) in cq_shutdown_next |
| 694 | */ |
| 695 | bool will_definitely_shutdown = gpr_atm_acq_load(&cqd->pending_events) == 1; |
Sree Kuchibhotla | 5461a8b | 2017-04-10 09:52:40 -0700 | [diff] [blame] | 696 | |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 697 | if (!will_definitely_shutdown) { |
| 698 | /* Only kick if this is the first item queued */ |
| 699 | if (is_first) { |
| 700 | gpr_mu_lock(cq->mu); |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 701 | grpc_error* kick_error = |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 702 | cq->poller_vtable->kick(exec_ctx, POLLSET_FROM_CQ(cq), nullptr); |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 703 | gpr_mu_unlock(cq->mu); |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 704 | |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 705 | if (kick_error != GRPC_ERROR_NONE) { |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 706 | const char* msg = grpc_error_string(kick_error); |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 707 | gpr_log(GPR_ERROR, "Kick failed: %s", msg); |
| 708 | GRPC_ERROR_UNREF(kick_error); |
| 709 | } |
Craig Tiller | 1e960fc | 2017-05-26 09:09:39 -0700 | [diff] [blame] | 710 | } |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 711 | if (gpr_atm_full_fetch_add(&cqd->pending_events, -1) == 1) { |
| 712 | GRPC_CQ_INTERNAL_REF(cq, "shutting_down"); |
| 713 | gpr_mu_lock(cq->mu); |
| 714 | cq_finish_shutdown_next(exec_ctx, cq); |
| 715 | gpr_mu_unlock(cq->mu); |
| 716 | GRPC_CQ_INTERNAL_UNREF(exec_ctx, cq, "shutting_down"); |
| 717 | } |
| 718 | } else { |
Craig Tiller | caf8ea9 | 2017-06-01 16:08:58 -0700 | [diff] [blame] | 719 | GRPC_CQ_INTERNAL_REF(cq, "shutting_down"); |
Ken Payson | 42bd87e | 2017-10-20 10:32:30 -0700 | [diff] [blame] | 720 | gpr_atm_rel_store(&cqd->pending_events, 0); |
Craig Tiller | caf8ea9 | 2017-06-01 16:08:58 -0700 | [diff] [blame] | 721 | gpr_mu_lock(cq->mu); |
| 722 | cq_finish_shutdown_next(exec_ctx, cq); |
| 723 | gpr_mu_unlock(cq->mu); |
| 724 | GRPC_CQ_INTERNAL_UNREF(exec_ctx, cq, "shutting_down"); |
| 725 | } |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 726 | } |
Craig Tiller | ce1f19e | 2015-10-09 16:16:04 -0700 | [diff] [blame] | 727 | |
Sree Kuchibhotla | 736dd90 | 2017-04-25 18:26:53 -0700 | [diff] [blame] | 728 | GPR_TIMER_END("cq_end_op_for_next", 0); |
Craig Tiller | cae4b1b | 2016-05-10 09:11:09 -0700 | [diff] [blame] | 729 | |
| 730 | GRPC_ERROR_UNREF(error); |
Craig Tiller | cce17ac | 2015-01-20 09:29:28 -0800 | [diff] [blame] | 731 | } |
| 732 | |
Craig Tiller | 39a7327 | 2017-07-05 08:36:04 -0700 | [diff] [blame] | 733 | /* Queue a GRPC_OP_COMPLETED operation to a completion queue (with a |
| 734 | * completion |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 735 | * type of GRPC_CQ_PLUCK) */ |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 736 | static void cq_end_op_for_pluck(grpc_exec_ctx* exec_ctx, |
| 737 | grpc_completion_queue* cq, void* tag, |
| 738 | grpc_error* error, |
| 739 | void (*done)(grpc_exec_ctx* exec_ctx, |
| 740 | void* done_arg, |
| 741 | grpc_cq_completion* storage), |
| 742 | void* done_arg, grpc_cq_completion* storage) { |
| 743 | cq_pluck_data* cqd = (cq_pluck_data*)DATA_FROM_CQ(cq); |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 744 | int is_success = (error == GRPC_ERROR_NONE); |
| 745 | |
Sree Kuchibhotla | 736dd90 | 2017-04-25 18:26:53 -0700 | [diff] [blame] | 746 | GPR_TIMER_BEGIN("cq_end_op_for_pluck", 0); |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 747 | |
Sree Kuchibhotla | 8ac5c6d | 2017-05-11 14:13:11 -0700 | [diff] [blame] | 748 | if (GRPC_TRACER_ON(grpc_api_trace) || |
| 749 | (GRPC_TRACER_ON(grpc_trace_operation_failures) && |
| 750 | error != GRPC_ERROR_NONE)) { |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 751 | const char* errmsg = grpc_error_string(error); |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 752 | GRPC_API_TRACE( |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 753 | "cq_end_op_for_pluck(exec_ctx=%p, cq=%p, tag=%p, error=%s, " |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 754 | "done=%p, done_arg=%p, storage=%p)", |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 755 | 7, (exec_ctx, cq, tag, errmsg, done, done_arg, storage)); |
Sree Kuchibhotla | 8ac5c6d | 2017-05-11 14:13:11 -0700 | [diff] [blame] | 756 | if (GRPC_TRACER_ON(grpc_trace_operation_failures) && |
| 757 | error != GRPC_ERROR_NONE) { |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 758 | gpr_log(GPR_ERROR, "Operation failed: tag=%p, error=%s", tag, errmsg); |
| 759 | } |
| 760 | } |
| 761 | |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 762 | storage->tag = tag; |
| 763 | storage->done = done; |
| 764 | storage->done_arg = done_arg; |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 765 | storage->next = ((uintptr_t)&cqd->completed_head) | ((uintptr_t)(is_success)); |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 766 | |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 767 | gpr_mu_lock(cq->mu); |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 768 | cq_check_tag(cq, tag, false); /* Used in debug builds only */ |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 769 | |
| 770 | /* Add to the list of completions */ |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 771 | gpr_atm_no_barrier_fetch_add(&cqd->things_queued_ever, 1); |
| 772 | cqd->completed_tail->next = |
| 773 | ((uintptr_t)storage) | (1u & (uintptr_t)cqd->completed_tail->next); |
| 774 | cqd->completed_tail = storage; |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 775 | |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 776 | if (gpr_atm_full_fetch_add(&cqd->pending_events, -1) == 1) { |
| 777 | cq_finish_shutdown_pluck(exec_ctx, cq); |
| 778 | gpr_mu_unlock(cq->mu); |
| 779 | } else { |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 780 | grpc_pollset_worker* pluck_worker = nullptr; |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 781 | for (int i = 0; i < cqd->num_pluckers; i++) { |
| 782 | if (cqd->pluckers[i].tag == tag) { |
| 783 | pluck_worker = *cqd->pluckers[i].worker; |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 784 | break; |
| 785 | } |
| 786 | } |
| 787 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 788 | grpc_error* kick_error = |
Craig Tiller | 0ff222a | 2017-09-01 09:41:43 -0700 | [diff] [blame] | 789 | cq->poller_vtable->kick(exec_ctx, POLLSET_FROM_CQ(cq), pluck_worker); |
Sree Kuchibhotla | a72d79b | 2017-04-24 19:45:20 -0700 | [diff] [blame] | 790 | |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 791 | gpr_mu_unlock(cq->mu); |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 792 | |
| 793 | if (kick_error != GRPC_ERROR_NONE) { |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 794 | const char* msg = grpc_error_string(kick_error); |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 795 | gpr_log(GPR_ERROR, "Kick failed: %s", msg); |
| 796 | |
| 797 | GRPC_ERROR_UNREF(kick_error); |
| 798 | } |
Sree Kuchibhotla | 5461a8b | 2017-04-10 09:52:40 -0700 | [diff] [blame] | 799 | } |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 800 | |
Sree Kuchibhotla | 736dd90 | 2017-04-25 18:26:53 -0700 | [diff] [blame] | 801 | GPR_TIMER_END("cq_end_op_for_pluck", 0); |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 802 | |
| 803 | GRPC_ERROR_UNREF(error); |
Sree Kuchibhotla | 5461a8b | 2017-04-10 09:52:40 -0700 | [diff] [blame] | 804 | } |
| 805 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 806 | void grpc_cq_end_op(grpc_exec_ctx* exec_ctx, grpc_completion_queue* cq, |
| 807 | void* tag, grpc_error* error, |
| 808 | void (*done)(grpc_exec_ctx* exec_ctx, void* done_arg, |
| 809 | grpc_cq_completion* storage), |
| 810 | void* done_arg, grpc_cq_completion* storage) { |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 811 | cq->vtable->end_op(exec_ctx, cq, tag, error, done, done_arg, storage); |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 812 | } |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 813 | |
Craig Tiller | 2f42fde | 2016-08-04 15:13:18 -0700 | [diff] [blame] | 814 | typedef struct { |
Craig Tiller | aef3a79 | 2016-08-24 15:13:53 -0700 | [diff] [blame] | 815 | gpr_atm last_seen_things_queued_ever; |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 816 | grpc_completion_queue* cq; |
Craig Tiller | dc3998e | 2017-05-12 09:55:30 -0700 | [diff] [blame] | 817 | grpc_millis deadline; |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 818 | grpc_cq_completion* stolen_completion; |
| 819 | void* tag; /* for pluck */ |
Craig Tiller | 2c4043b | 2016-09-05 14:50:16 -0700 | [diff] [blame] | 820 | bool first_loop; |
Craig Tiller | 2f42fde | 2016-08-04 15:13:18 -0700 | [diff] [blame] | 821 | } cq_is_finished_arg; |
| 822 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 823 | static bool cq_is_next_finished(grpc_exec_ctx* exec_ctx, void* arg) { |
| 824 | cq_is_finished_arg* a = (cq_is_finished_arg*)arg; |
| 825 | grpc_completion_queue* cq = a->cq; |
| 826 | cq_next_data* cqd = (cq_next_data*)DATA_FROM_CQ(cq); |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 827 | GPR_ASSERT(a->stolen_completion == nullptr); |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 828 | |
Craig Tiller | aef3a79 | 2016-08-24 15:13:53 -0700 | [diff] [blame] | 829 | gpr_atm current_last_seen_things_queued_ever = |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 830 | gpr_atm_no_barrier_load(&cqd->things_queued_ever); |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 831 | |
Craig Tiller | aef3a79 | 2016-08-24 15:13:53 -0700 | [diff] [blame] | 832 | if (current_last_seen_things_queued_ever != a->last_seen_things_queued_ever) { |
Craig Tiller | aef3a79 | 2016-08-24 15:13:53 -0700 | [diff] [blame] | 833 | a->last_seen_things_queued_ever = |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 834 | gpr_atm_no_barrier_load(&cqd->things_queued_ever); |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 835 | |
| 836 | /* Pop a cq_completion from the queue. Returns NULL if the queue is empty |
Craig Tiller | 39a7327 | 2017-07-05 08:36:04 -0700 | [diff] [blame] | 837 | * might return NULL in some cases even if the queue is not empty; but |
| 838 | * that |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 839 | * is ok and doesn't affect correctness. Might effect the tail latencies a |
| 840 | * bit) */ |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 841 | a->stolen_completion = cq_event_queue_pop(&cqd->queue); |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 842 | if (a->stolen_completion != nullptr) { |
Craig Tiller | aef3a79 | 2016-08-24 15:13:53 -0700 | [diff] [blame] | 843 | return true; |
Craig Tiller | 2f42fde | 2016-08-04 15:13:18 -0700 | [diff] [blame] | 844 | } |
Craig Tiller | 2f42fde | 2016-08-04 15:13:18 -0700 | [diff] [blame] | 845 | } |
Craig Tiller | dc3998e | 2017-05-12 09:55:30 -0700 | [diff] [blame] | 846 | return !a->first_loop && a->deadline < grpc_exec_ctx_now(exec_ctx); |
Craig Tiller | 2f42fde | 2016-08-04 15:13:18 -0700 | [diff] [blame] | 847 | } |
| 848 | |
Craig Tiller | 4e41e36 | 2016-08-19 13:12:54 -0700 | [diff] [blame] | 849 | #ifndef NDEBUG |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 850 | static void dump_pending_tags(grpc_completion_queue* cq) { |
Craig Tiller | 84f75d4 | 2017-05-03 13:06:35 -0700 | [diff] [blame] | 851 | if (!GRPC_TRACER_ON(grpc_trace_pending_tags)) return; |
Craig Tiller | 4e41e36 | 2016-08-19 13:12:54 -0700 | [diff] [blame] | 852 | |
| 853 | gpr_strvec v; |
| 854 | gpr_strvec_init(&v); |
| 855 | gpr_strvec_add(&v, gpr_strdup("PENDING TAGS:")); |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 856 | gpr_mu_lock(cq->mu); |
| 857 | for (size_t i = 0; i < cq->outstanding_tag_count; i++) { |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 858 | char* s; |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 859 | gpr_asprintf(&s, " %p", cq->outstanding_tags[i]); |
Craig Tiller | 4e41e36 | 2016-08-19 13:12:54 -0700 | [diff] [blame] | 860 | gpr_strvec_add(&v, s); |
| 861 | } |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 862 | gpr_mu_unlock(cq->mu); |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 863 | char* out = gpr_strvec_flatten(&v, nullptr); |
Craig Tiller | 4e41e36 | 2016-08-19 13:12:54 -0700 | [diff] [blame] | 864 | gpr_strvec_destroy(&v); |
| 865 | gpr_log(GPR_DEBUG, "%s", out); |
| 866 | gpr_free(out); |
| 867 | } |
Craig Tiller | 49c644c | 2016-08-19 13:52:23 -0700 | [diff] [blame] | 868 | #else |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 869 | static void dump_pending_tags(grpc_completion_queue* cq) {} |
Craig Tiller | 4e41e36 | 2016-08-19 13:12:54 -0700 | [diff] [blame] | 870 | #endif |
| 871 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 872 | static grpc_event cq_next(grpc_completion_queue* cq, gpr_timespec deadline, |
| 873 | void* reserved) { |
Craig Tiller | 64be9f7 | 2015-05-04 14:53:51 -0700 | [diff] [blame] | 874 | grpc_event ret; |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 875 | cq_next_data* cqd = (cq_next_data*)DATA_FROM_CQ(cq); |
Sree Kuchibhotla | 321881d | 2017-02-27 11:25:28 -0800 | [diff] [blame] | 876 | |
Craig Tiller | 0ba432d | 2015-10-09 16:57:11 -0700 | [diff] [blame] | 877 | GPR_TIMER_BEGIN("grpc_completion_queue_next", 0); |
Craig Tiller | 86253ca | 2015-10-08 13:31:02 -0700 | [diff] [blame] | 878 | |
Masood Malekghassemi | 76c3d74 | 2015-08-19 18:22:53 -0700 | [diff] [blame] | 879 | GRPC_API_TRACE( |
| 880 | "grpc_completion_queue_next(" |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 881 | "cq=%p, " |
Ken Payson | 62a6c92 | 2016-06-24 11:53:54 -0700 | [diff] [blame] | 882 | "deadline=gpr_timespec { tv_sec: %" PRId64 |
| 883 | ", tv_nsec: %d, clock_type: %d }, " |
Craig Tiller | 4de3e4f | 2015-10-05 08:55:50 -0700 | [diff] [blame] | 884 | "reserved=%p)", |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 885 | 5, |
| 886 | (cq, deadline.tv_sec, deadline.tv_nsec, (int)deadline.clock_type, |
| 887 | reserved)); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 888 | GPR_ASSERT(!reserved); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 889 | |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 890 | dump_pending_tags(cq); |
Craig Tiller | 4e41e36 | 2016-08-19 13:12:54 -0700 | [diff] [blame] | 891 | |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 892 | GRPC_CQ_INTERNAL_REF(cq, "next"); |
Sree Kuchibhotla | a72d79b | 2017-04-24 19:45:20 -0700 | [diff] [blame] | 893 | |
Craig Tiller | 9a8c3f3 | 2017-07-21 13:14:14 -0700 | [diff] [blame] | 894 | grpc_millis deadline_millis = grpc_timespec_to_millis_round_up(deadline); |
Craig Tiller | aef3a79 | 2016-08-24 15:13:53 -0700 | [diff] [blame] | 895 | cq_is_finished_arg is_finished_arg = { |
Yash Tibrewal | d8b84a2 | 2017-09-25 13:38:03 -0700 | [diff] [blame] | 896 | gpr_atm_no_barrier_load(&cqd->things_queued_ever), |
| 897 | cq, |
Craig Tiller | 5291023 | 2017-10-05 10:28:15 -0700 | [diff] [blame] | 898 | deadline_millis, |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 899 | nullptr, |
| 900 | nullptr, |
Yash Tibrewal | d8b84a2 | 2017-09-25 13:38:03 -0700 | [diff] [blame] | 901 | true}; |
Craig Tiller | 7c70b6c | 2017-01-23 07:48:42 -0800 | [diff] [blame] | 902 | grpc_exec_ctx exec_ctx = |
| 903 | GRPC_EXEC_CTX_INITIALIZER(0, cq_is_next_finished, &is_finished_arg); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 904 | for (;;) { |
Craig Tiller | fa5c621 | 2017-07-17 14:10:44 -0700 | [diff] [blame] | 905 | grpc_millis iteration_deadline = deadline_millis; |
Sree Kuchibhotla | 55d0b49 | 2017-04-12 17:33:50 -0700 | [diff] [blame] | 906 | |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 907 | if (is_finished_arg.stolen_completion != nullptr) { |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 908 | grpc_cq_completion* c = is_finished_arg.stolen_completion; |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 909 | is_finished_arg.stolen_completion = nullptr; |
Craig Tiller | 2f42fde | 2016-08-04 15:13:18 -0700 | [diff] [blame] | 910 | ret.type = GRPC_OP_COMPLETE; |
| 911 | ret.success = c->next & 1u; |
| 912 | ret.tag = c->tag; |
| 913 | c->done(&exec_ctx, c->done_arg, c); |
| 914 | break; |
| 915 | } |
Sree Kuchibhotla | 94aff9e | 2017-04-10 10:25:03 -0700 | [diff] [blame] | 916 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 917 | grpc_cq_completion* c = cq_event_queue_pop(&cqd->queue); |
Sree Kuchibhotla | 94aff9e | 2017-04-10 10:25:03 -0700 | [diff] [blame] | 918 | |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 919 | if (c != nullptr) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 920 | ret.type = GRPC_OP_COMPLETE; |
| 921 | ret.success = c->next & 1u; |
| 922 | ret.tag = c->tag; |
| 923 | c->done(&exec_ctx, c->done_arg, c); |
| 924 | break; |
Sree Kuchibhotla | 55d0b49 | 2017-04-12 17:33:50 -0700 | [diff] [blame] | 925 | } else { |
| 926 | /* If c == NULL it means either the queue is empty OR in an transient |
| 927 | inconsistent state. If it is the latter, we shold do a 0-timeout poll |
| 928 | so that the thread comes back quickly from poll to make a second |
Craig Tiller | 39a7327 | 2017-07-05 08:36:04 -0700 | [diff] [blame] | 929 | attempt at popping. Not doing this can potentially deadlock this |
Sree Kuchibhotla | a0bfba2 | 2017-07-27 15:24:04 -0700 | [diff] [blame] | 930 | thread forever (if the deadline is infinity) */ |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 931 | if (cq_event_queue_num_items(&cqd->queue) > 0) { |
Craig Tiller | fa5c621 | 2017-07-17 14:10:44 -0700 | [diff] [blame] | 932 | iteration_deadline = 0; |
Sree Kuchibhotla | 55d0b49 | 2017-04-12 17:33:50 -0700 | [diff] [blame] | 933 | } |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 934 | } |
Sree Kuchibhotla | 94aff9e | 2017-04-10 10:25:03 -0700 | [diff] [blame] | 935 | |
Sree Kuchibhotla | c7cebe8 | 2017-09-13 17:51:26 -0700 | [diff] [blame] | 936 | if (gpr_atm_acq_load(&cqd->pending_events) == 0) { |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 937 | /* Before returning, check if the queue has any items left over (since |
| 938 | gpr_mpscq_pop() can sometimes return NULL even if the queue is not |
| 939 | empty. If so, keep retrying but do not return GRPC_QUEUE_SHUTDOWN */ |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 940 | if (cq_event_queue_num_items(&cqd->queue) > 0) { |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 941 | /* Go to the beginning of the loop. No point doing a poll because |
Craig Tiller | 39a7327 | 2017-07-05 08:36:04 -0700 | [diff] [blame] | 942 | (cq->shutdown == true) is only possible when there is no pending |
Sree Kuchibhotla | a0bfba2 | 2017-07-27 15:24:04 -0700 | [diff] [blame] | 943 | work (i.e cq->pending_events == 0) and any outstanding completion |
| 944 | events should have already been queued on this cq */ |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 945 | continue; |
| 946 | } |
| 947 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 948 | memset(&ret, 0, sizeof(ret)); |
| 949 | ret.type = GRPC_QUEUE_SHUTDOWN; |
| 950 | break; |
| 951 | } |
Sree Kuchibhotla | 94aff9e | 2017-04-10 10:25:03 -0700 | [diff] [blame] | 952 | |
Craig Tiller | dc3998e | 2017-05-12 09:55:30 -0700 | [diff] [blame] | 953 | if (!is_finished_arg.first_loop && |
| 954 | grpc_exec_ctx_now(&exec_ctx) >= deadline_millis) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 955 | memset(&ret, 0, sizeof(ret)); |
| 956 | ret.type = GRPC_QUEUE_TIMEOUT; |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 957 | dump_pending_tags(cq); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 958 | break; |
| 959 | } |
Craig Tiller | 7c70b6c | 2017-01-23 07:48:42 -0800 | [diff] [blame] | 960 | |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 961 | /* The main polling work happens in grpc_pollset_work */ |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 962 | gpr_mu_lock(cq->mu); |
| 963 | cq->num_polls++; |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 964 | grpc_error* err = cq->poller_vtable->work(&exec_ctx, POLLSET_FROM_CQ(cq), |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 965 | nullptr, iteration_deadline); |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 966 | gpr_mu_unlock(cq->mu); |
Sree Kuchibhotla | d7a1b8f | 2017-04-11 19:43:07 -0700 | [diff] [blame] | 967 | |
Sree Kuchibhotla | 94aff9e | 2017-04-10 10:25:03 -0700 | [diff] [blame] | 968 | if (err != GRPC_ERROR_NONE) { |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 969 | const char* msg = grpc_error_string(err); |
Sree Kuchibhotla | 94aff9e | 2017-04-10 10:25:03 -0700 | [diff] [blame] | 970 | gpr_log(GPR_ERROR, "Completion queue next failed: %s", msg); |
| 971 | |
| 972 | GRPC_ERROR_UNREF(err); |
| 973 | memset(&ret, 0, sizeof(ret)); |
| 974 | ret.type = GRPC_QUEUE_TIMEOUT; |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 975 | dump_pending_tags(cq); |
Sree Kuchibhotla | 94aff9e | 2017-04-10 10:25:03 -0700 | [diff] [blame] | 976 | break; |
Craig Tiller | ccdea19 | 2016-02-16 08:06:46 -0800 | [diff] [blame] | 977 | } |
Craig Tiller | 2c4043b | 2016-09-05 14:50:16 -0700 | [diff] [blame] | 978 | is_finished_arg.first_loop = false; |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 979 | } |
Sree Kuchibhotla | 94aff9e | 2017-04-10 10:25:03 -0700 | [diff] [blame] | 980 | |
Craig Tiller | f809ca3 | 2017-05-26 09:45:16 -0700 | [diff] [blame] | 981 | if (cq_event_queue_num_items(&cqd->queue) > 0 && |
Sree Kuchibhotla | c7cebe8 | 2017-09-13 17:51:26 -0700 | [diff] [blame] | 982 | gpr_atm_acq_load(&cqd->pending_events) > 0) { |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 983 | gpr_mu_lock(cq->mu); |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 984 | cq->poller_vtable->kick(&exec_ctx, POLLSET_FROM_CQ(cq), nullptr); |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 985 | gpr_mu_unlock(cq->mu); |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 986 | } |
| 987 | |
Sree Kuchibhotla | a0bfba2 | 2017-07-27 15:24:04 -0700 | [diff] [blame] | 988 | GRPC_SURFACE_TRACE_RETURNED_EVENT(cq, &ret); |
| 989 | GRPC_CQ_INTERNAL_UNREF(&exec_ctx, cq, "next"); |
| 990 | grpc_exec_ctx_finish(&exec_ctx); |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 991 | GPR_ASSERT(is_finished_arg.stolen_completion == nullptr); |
Sree Kuchibhotla | a0bfba2 | 2017-07-27 15:24:04 -0700 | [diff] [blame] | 992 | |
Craig Tiller | 0ba432d | 2015-10-09 16:57:11 -0700 | [diff] [blame] | 993 | GPR_TIMER_END("grpc_completion_queue_next", 0); |
Craig Tiller | 86253ca | 2015-10-08 13:31:02 -0700 | [diff] [blame] | 994 | |
Craig Tiller | 64be9f7 | 2015-05-04 14:53:51 -0700 | [diff] [blame] | 995 | return ret; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 996 | } |
| 997 | |
Craig Tiller | caf8ea9 | 2017-06-01 16:08:58 -0700 | [diff] [blame] | 998 | /* Finishes the completion queue shutdown. This means that there are no more |
| 999 | completion events / tags expected from the completion queue |
| 1000 | - Must be called under completion queue lock |
| 1001 | - Must be called only once in completion queue's lifetime |
| 1002 | - grpc_completion_queue_shutdown() MUST have been called before calling |
| 1003 | this function */ |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1004 | static void cq_finish_shutdown_next(grpc_exec_ctx* exec_ctx, |
| 1005 | grpc_completion_queue* cq) { |
| 1006 | cq_next_data* cqd = (cq_next_data*)DATA_FROM_CQ(cq); |
Craig Tiller | caf8ea9 | 2017-06-01 16:08:58 -0700 | [diff] [blame] | 1007 | |
| 1008 | GPR_ASSERT(cqd->shutdown_called); |
| 1009 | GPR_ASSERT(gpr_atm_no_barrier_load(&cqd->pending_events) == 0); |
| 1010 | |
| 1011 | cq->poller_vtable->shutdown(exec_ctx, POLLSET_FROM_CQ(cq), |
| 1012 | &cq->pollset_shutdown_done); |
| 1013 | } |
| 1014 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1015 | static void cq_shutdown_next(grpc_exec_ctx* exec_ctx, |
| 1016 | grpc_completion_queue* cq) { |
| 1017 | cq_next_data* cqd = (cq_next_data*)DATA_FROM_CQ(cq); |
Craig Tiller | caf8ea9 | 2017-06-01 16:08:58 -0700 | [diff] [blame] | 1018 | |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 1019 | /* Need an extra ref for cq here because: |
| 1020 | * We call cq_finish_shutdown_next() below, that would call pollset shutdown. |
| 1021 | * Pollset shutdown decrements the cq ref count which can potentially destroy |
| 1022 | * the cq (if that happens to be the last ref). |
| 1023 | * Creating an extra ref here prevents the cq from getting destroyed while |
| 1024 | * this function is still active */ |
Craig Tiller | caf8ea9 | 2017-06-01 16:08:58 -0700 | [diff] [blame] | 1025 | GRPC_CQ_INTERNAL_REF(cq, "shutting_down"); |
| 1026 | gpr_mu_lock(cq->mu); |
| 1027 | if (cqd->shutdown_called) { |
| 1028 | gpr_mu_unlock(cq->mu); |
Craig Tiller | 9c070bf | 2017-07-05 14:59:53 -0700 | [diff] [blame] | 1029 | GRPC_CQ_INTERNAL_UNREF(exec_ctx, cq, "shutting_down"); |
Craig Tiller | caf8ea9 | 2017-06-01 16:08:58 -0700 | [diff] [blame] | 1030 | return; |
| 1031 | } |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 1032 | cqd->shutdown_called = true; |
Sree Kuchibhotla | 0dbfde6 | 2017-09-18 10:11:37 -0700 | [diff] [blame] | 1033 | /* Doing a full_fetch_add (i.e acq/release) here to match with |
| 1034 | * cq_begin_op_for_next and and cq_end_op_for_next functions which read/write |
| 1035 | * on this counter without necessarily holding a lock on cq */ |
Craig Tiller | caf8ea9 | 2017-06-01 16:08:58 -0700 | [diff] [blame] | 1036 | if (gpr_atm_full_fetch_add(&cqd->pending_events, -1) == 1) { |
| 1037 | cq_finish_shutdown_next(exec_ctx, cq); |
| 1038 | } |
| 1039 | gpr_mu_unlock(cq->mu); |
| 1040 | GRPC_CQ_INTERNAL_UNREF(exec_ctx, cq, "shutting_down"); |
| 1041 | } |
| 1042 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1043 | grpc_event grpc_completion_queue_next(grpc_completion_queue* cq, |
| 1044 | gpr_timespec deadline, void* reserved) { |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1045 | return cq->vtable->next(cq, deadline, reserved); |
Sree Kuchibhotla | 736dd90 | 2017-04-25 18:26:53 -0700 | [diff] [blame] | 1046 | } |
| 1047 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1048 | static int add_plucker(grpc_completion_queue* cq, void* tag, |
| 1049 | grpc_pollset_worker** worker) { |
| 1050 | cq_pluck_data* cqd = (cq_pluck_data*)DATA_FROM_CQ(cq); |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 1051 | if (cqd->num_pluckers == GRPC_MAX_COMPLETION_QUEUE_PLUCKERS) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1052 | return 0; |
| 1053 | } |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 1054 | cqd->pluckers[cqd->num_pluckers].tag = tag; |
| 1055 | cqd->pluckers[cqd->num_pluckers].worker = worker; |
| 1056 | cqd->num_pluckers++; |
Craig Tiller | 791e78a | 2015-08-01 16:20:17 -0700 | [diff] [blame] | 1057 | return 1; |
Craig Tiller | 5ddbb9d | 2015-07-29 15:58:11 -0700 | [diff] [blame] | 1058 | } |
| 1059 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1060 | static void del_plucker(grpc_completion_queue* cq, void* tag, |
| 1061 | grpc_pollset_worker** worker) { |
| 1062 | cq_pluck_data* cqd = (cq_pluck_data*)DATA_FROM_CQ(cq); |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 1063 | for (int i = 0; i < cqd->num_pluckers; i++) { |
| 1064 | if (cqd->pluckers[i].tag == tag && cqd->pluckers[i].worker == worker) { |
| 1065 | cqd->num_pluckers--; |
| 1066 | GPR_SWAP(plucker, cqd->pluckers[i], cqd->pluckers[cqd->num_pluckers]); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1067 | return; |
Craig Tiller | 5ddbb9d | 2015-07-29 15:58:11 -0700 | [diff] [blame] | 1068 | } |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1069 | } |
yang-g | b063c87 | 2015-10-07 11:40:13 -0700 | [diff] [blame] | 1070 | GPR_UNREACHABLE_CODE(return ); |
Craig Tiller | 5ddbb9d | 2015-07-29 15:58:11 -0700 | [diff] [blame] | 1071 | } |
| 1072 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1073 | static bool cq_is_pluck_finished(grpc_exec_ctx* exec_ctx, void* arg) { |
| 1074 | cq_is_finished_arg* a = (cq_is_finished_arg*)arg; |
| 1075 | grpc_completion_queue* cq = a->cq; |
| 1076 | cq_pluck_data* cqd = (cq_pluck_data*)DATA_FROM_CQ(cq); |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 1077 | |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 1078 | GPR_ASSERT(a->stolen_completion == nullptr); |
Craig Tiller | aef3a79 | 2016-08-24 15:13:53 -0700 | [diff] [blame] | 1079 | gpr_atm current_last_seen_things_queued_ever = |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 1080 | gpr_atm_no_barrier_load(&cqd->things_queued_ever); |
Craig Tiller | aef3a79 | 2016-08-24 15:13:53 -0700 | [diff] [blame] | 1081 | if (current_last_seen_things_queued_ever != a->last_seen_things_queued_ever) { |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1082 | gpr_mu_lock(cq->mu); |
Craig Tiller | aef3a79 | 2016-08-24 15:13:53 -0700 | [diff] [blame] | 1083 | a->last_seen_things_queued_ever = |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 1084 | gpr_atm_no_barrier_load(&cqd->things_queued_ever); |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1085 | grpc_cq_completion* c; |
| 1086 | grpc_cq_completion* prev = &cqd->completed_head; |
| 1087 | while ((c = (grpc_cq_completion*)(prev->next & ~(uintptr_t)1)) != |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 1088 | &cqd->completed_head) { |
Craig Tiller | aef3a79 | 2016-08-24 15:13:53 -0700 | [diff] [blame] | 1089 | if (c->tag == a->tag) { |
| 1090 | prev->next = (prev->next & (uintptr_t)1) | (c->next & ~(uintptr_t)1); |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 1091 | if (c == cqd->completed_tail) { |
| 1092 | cqd->completed_tail = prev; |
Craig Tiller | aef3a79 | 2016-08-24 15:13:53 -0700 | [diff] [blame] | 1093 | } |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1094 | gpr_mu_unlock(cq->mu); |
Craig Tiller | aef3a79 | 2016-08-24 15:13:53 -0700 | [diff] [blame] | 1095 | a->stolen_completion = c; |
| 1096 | return true; |
Craig Tiller | 2f42fde | 2016-08-04 15:13:18 -0700 | [diff] [blame] | 1097 | } |
Craig Tiller | aef3a79 | 2016-08-24 15:13:53 -0700 | [diff] [blame] | 1098 | prev = c; |
Craig Tiller | 2f42fde | 2016-08-04 15:13:18 -0700 | [diff] [blame] | 1099 | } |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1100 | gpr_mu_unlock(cq->mu); |
Craig Tiller | 2f42fde | 2016-08-04 15:13:18 -0700 | [diff] [blame] | 1101 | } |
Craig Tiller | dc3998e | 2017-05-12 09:55:30 -0700 | [diff] [blame] | 1102 | return !a->first_loop && a->deadline < grpc_exec_ctx_now(exec_ctx); |
Craig Tiller | 2f42fde | 2016-08-04 15:13:18 -0700 | [diff] [blame] | 1103 | } |
| 1104 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1105 | static grpc_event cq_pluck(grpc_completion_queue* cq, void* tag, |
| 1106 | gpr_timespec deadline, void* reserved) { |
Craig Tiller | 64be9f7 | 2015-05-04 14:53:51 -0700 | [diff] [blame] | 1107 | grpc_event ret; |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1108 | grpc_cq_completion* c; |
| 1109 | grpc_cq_completion* prev; |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 1110 | grpc_pollset_worker* worker = nullptr; |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1111 | cq_pluck_data* cqd = (cq_pluck_data*)DATA_FROM_CQ(cq); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1112 | |
Craig Tiller | 0ba432d | 2015-10-09 16:57:11 -0700 | [diff] [blame] | 1113 | GPR_TIMER_BEGIN("grpc_completion_queue_pluck", 0); |
Craig Tiller | 86253ca | 2015-10-08 13:31:02 -0700 | [diff] [blame] | 1114 | |
Craig Tiller | 84f75d4 | 2017-05-03 13:06:35 -0700 | [diff] [blame] | 1115 | if (GRPC_TRACER_ON(grpc_cq_pluck_trace)) { |
murgatroid99 | 9f6a805 | 2016-06-15 17:39:03 -0700 | [diff] [blame] | 1116 | GRPC_API_TRACE( |
| 1117 | "grpc_completion_queue_pluck(" |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1118 | "cq=%p, tag=%p, " |
murgatroid99 | b2edc6c | 2016-06-27 14:24:18 -0700 | [diff] [blame] | 1119 | "deadline=gpr_timespec { tv_sec: %" PRId64 |
| 1120 | ", tv_nsec: %d, clock_type: %d }, " |
murgatroid99 | 9f6a805 | 2016-06-15 17:39:03 -0700 | [diff] [blame] | 1121 | "reserved=%p)", |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1122 | 6, |
| 1123 | (cq, tag, deadline.tv_sec, deadline.tv_nsec, (int)deadline.clock_type, |
| 1124 | reserved)); |
murgatroid99 | 9f6a805 | 2016-06-15 17:39:03 -0700 | [diff] [blame] | 1125 | } |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1126 | GPR_ASSERT(!reserved); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1127 | |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1128 | dump_pending_tags(cq); |
Craig Tiller | 4e41e36 | 2016-08-19 13:12:54 -0700 | [diff] [blame] | 1129 | |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1130 | GRPC_CQ_INTERNAL_REF(cq, "pluck"); |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1131 | gpr_mu_lock(cq->mu); |
Craig Tiller | 9a8c3f3 | 2017-07-21 13:14:14 -0700 | [diff] [blame] | 1132 | grpc_millis deadline_millis = grpc_timespec_to_millis_round_up(deadline); |
Craig Tiller | aef3a79 | 2016-08-24 15:13:53 -0700 | [diff] [blame] | 1133 | cq_is_finished_arg is_finished_arg = { |
Yash Tibrewal | 37fdb73 | 2017-09-25 16:45:02 -0700 | [diff] [blame] | 1134 | gpr_atm_no_barrier_load(&cqd->things_queued_ever), |
| 1135 | cq, |
Craig Tiller | 5291023 | 2017-10-05 10:28:15 -0700 | [diff] [blame] | 1136 | deadline_millis, |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 1137 | nullptr, |
Yash Tibrewal | 37fdb73 | 2017-09-25 16:45:02 -0700 | [diff] [blame] | 1138 | tag, |
| 1139 | true}; |
Craig Tiller | 7c70b6c | 2017-01-23 07:48:42 -0800 | [diff] [blame] | 1140 | grpc_exec_ctx exec_ctx = |
| 1141 | GRPC_EXEC_CTX_INITIALIZER(0, cq_is_pluck_finished, &is_finished_arg); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1142 | for (;;) { |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 1143 | if (is_finished_arg.stolen_completion != nullptr) { |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1144 | gpr_mu_unlock(cq->mu); |
Craig Tiller | 5f70fc6 | 2016-08-04 16:00:00 -0700 | [diff] [blame] | 1145 | c = is_finished_arg.stolen_completion; |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 1146 | is_finished_arg.stolen_completion = nullptr; |
Craig Tiller | 2f42fde | 2016-08-04 15:13:18 -0700 | [diff] [blame] | 1147 | ret.type = GRPC_OP_COMPLETE; |
| 1148 | ret.success = c->next & 1u; |
| 1149 | ret.tag = c->tag; |
| 1150 | c->done(&exec_ctx, c->done_arg, c); |
| 1151 | break; |
| 1152 | } |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 1153 | prev = &cqd->completed_head; |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1154 | while ((c = (grpc_cq_completion*)(prev->next & ~(uintptr_t)1)) != |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 1155 | &cqd->completed_head) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1156 | if (c->tag == tag) { |
Craig Tiller | 7536af0 | 2015-12-22 13:49:30 -0800 | [diff] [blame] | 1157 | prev->next = (prev->next & (uintptr_t)1) | (c->next & ~(uintptr_t)1); |
Sree Kuchibhotla | c2134c3 | 2017-04-25 12:10:04 -0700 | [diff] [blame] | 1158 | if (c == cqd->completed_tail) { |
| 1159 | cqd->completed_tail = prev; |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1160 | } |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1161 | gpr_mu_unlock(cq->mu); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1162 | ret.type = GRPC_OP_COMPLETE; |
| 1163 | ret.success = c->next & 1u; |
| 1164 | ret.tag = c->tag; |
| 1165 | c->done(&exec_ctx, c->done_arg, c); |
| 1166 | goto done; |
| 1167 | } |
| 1168 | prev = c; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1169 | } |
Sree Kuchibhotla | 8e36845 | 2017-04-25 15:45:02 -0700 | [diff] [blame] | 1170 | if (gpr_atm_no_barrier_load(&cqd->shutdown)) { |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1171 | gpr_mu_unlock(cq->mu); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1172 | memset(&ret, 0, sizeof(ret)); |
| 1173 | ret.type = GRPC_QUEUE_SHUTDOWN; |
| 1174 | break; |
| 1175 | } |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1176 | if (!add_plucker(cq, tag, &worker)) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1177 | gpr_log(GPR_DEBUG, |
| 1178 | "Too many outstanding grpc_completion_queue_pluck calls: maximum " |
| 1179 | "is %d", |
| 1180 | GRPC_MAX_COMPLETION_QUEUE_PLUCKERS); |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1181 | gpr_mu_unlock(cq->mu); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1182 | memset(&ret, 0, sizeof(ret)); |
| 1183 | /* TODO(ctiller): should we use a different result here */ |
| 1184 | ret.type = GRPC_QUEUE_TIMEOUT; |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1185 | dump_pending_tags(cq); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1186 | break; |
| 1187 | } |
Craig Tiller | dc3998e | 2017-05-12 09:55:30 -0700 | [diff] [blame] | 1188 | if (!is_finished_arg.first_loop && |
| 1189 | grpc_exec_ctx_now(&exec_ctx) >= deadline_millis) { |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1190 | del_plucker(cq, tag, &worker); |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1191 | gpr_mu_unlock(cq->mu); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1192 | memset(&ret, 0, sizeof(ret)); |
| 1193 | ret.type = GRPC_QUEUE_TIMEOUT; |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1194 | dump_pending_tags(cq); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1195 | break; |
| 1196 | } |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1197 | cq->num_polls++; |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1198 | grpc_error* err = cq->poller_vtable->work(&exec_ctx, POLLSET_FROM_CQ(cq), |
Craig Tiller | dc3998e | 2017-05-12 09:55:30 -0700 | [diff] [blame] | 1199 | &worker, deadline_millis); |
Craig Tiller | c357179 | 2017-05-02 12:33:38 -0700 | [diff] [blame] | 1200 | if (err != GRPC_ERROR_NONE) { |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1201 | del_plucker(cq, tag, &worker); |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1202 | gpr_mu_unlock(cq->mu); |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1203 | const char* msg = grpc_error_string(err); |
Sree Kuchibhotla | 467ad20 | 2017-05-11 13:15:07 -0700 | [diff] [blame] | 1204 | gpr_log(GPR_ERROR, "Completion queue pluck failed: %s", msg); |
Craig Tiller | 7c70b6c | 2017-01-23 07:48:42 -0800 | [diff] [blame] | 1205 | |
Craig Tiller | c357179 | 2017-05-02 12:33:38 -0700 | [diff] [blame] | 1206 | GRPC_ERROR_UNREF(err); |
| 1207 | memset(&ret, 0, sizeof(ret)); |
| 1208 | ret.type = GRPC_QUEUE_TIMEOUT; |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1209 | dump_pending_tags(cq); |
Craig Tiller | c357179 | 2017-05-02 12:33:38 -0700 | [diff] [blame] | 1210 | break; |
Craig Tiller | ccdea19 | 2016-02-16 08:06:46 -0800 | [diff] [blame] | 1211 | } |
Craig Tiller | 2c4043b | 2016-09-05 14:50:16 -0700 | [diff] [blame] | 1212 | is_finished_arg.first_loop = false; |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1213 | del_plucker(cq, tag, &worker); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1214 | } |
Craig Tiller | 97fc6a3 | 2015-07-08 15:31:35 -0700 | [diff] [blame] | 1215 | done: |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1216 | GRPC_SURFACE_TRACE_RETURNED_EVENT(cq, &ret); |
| 1217 | GRPC_CQ_INTERNAL_UNREF(&exec_ctx, cq, "pluck"); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1218 | grpc_exec_ctx_finish(&exec_ctx); |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 1219 | GPR_ASSERT(is_finished_arg.stolen_completion == nullptr); |
Craig Tiller | 86253ca | 2015-10-08 13:31:02 -0700 | [diff] [blame] | 1220 | |
Craig Tiller | 0ba432d | 2015-10-09 16:57:11 -0700 | [diff] [blame] | 1221 | GPR_TIMER_END("grpc_completion_queue_pluck", 0); |
Craig Tiller | 86253ca | 2015-10-08 13:31:02 -0700 | [diff] [blame] | 1222 | |
Craig Tiller | 64be9f7 | 2015-05-04 14:53:51 -0700 | [diff] [blame] | 1223 | return ret; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1224 | } |
| 1225 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1226 | grpc_event grpc_completion_queue_pluck(grpc_completion_queue* cq, void* tag, |
| 1227 | gpr_timespec deadline, void* reserved) { |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1228 | return cq->vtable->pluck(cq, tag, deadline, reserved); |
Sree Kuchibhotla | 8ac5c6d | 2017-05-11 14:13:11 -0700 | [diff] [blame] | 1229 | } |
Sree Kuchibhotla | 736dd90 | 2017-04-25 18:26:53 -0700 | [diff] [blame] | 1230 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1231 | static void cq_finish_shutdown_pluck(grpc_exec_ctx* exec_ctx, |
| 1232 | grpc_completion_queue* cq) { |
| 1233 | cq_pluck_data* cqd = (cq_pluck_data*)DATA_FROM_CQ(cq); |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1234 | |
| 1235 | GPR_ASSERT(cqd->shutdown_called); |
| 1236 | GPR_ASSERT(!gpr_atm_no_barrier_load(&cqd->shutdown)); |
| 1237 | gpr_atm_no_barrier_store(&cqd->shutdown, 1); |
| 1238 | |
| 1239 | cq->poller_vtable->shutdown(exec_ctx, POLLSET_FROM_CQ(cq), |
| 1240 | &cq->pollset_shutdown_done); |
| 1241 | } |
| 1242 | |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 1243 | /* NOTE: This function is almost exactly identical to cq_shutdown_next() but |
| 1244 | * merging them is a bit tricky and probably not worth it */ |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1245 | static void cq_shutdown_pluck(grpc_exec_ctx* exec_ctx, |
| 1246 | grpc_completion_queue* cq) { |
| 1247 | cq_pluck_data* cqd = (cq_pluck_data*)DATA_FROM_CQ(cq); |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1248 | |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 1249 | /* Need an extra ref for cq here because: |
| 1250 | * We call cq_finish_shutdown_pluck() below, that would call pollset shutdown. |
| 1251 | * Pollset shutdown decrements the cq ref count which can potentially destroy |
| 1252 | * the cq (if that happens to be the last ref). |
| 1253 | * Creating an extra ref here prevents the cq from getting destroyed while |
| 1254 | * this function is still active */ |
| 1255 | GRPC_CQ_INTERNAL_REF(cq, "shutting_down (pluck cq)"); |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1256 | gpr_mu_lock(cq->mu); |
| 1257 | if (cqd->shutdown_called) { |
| 1258 | gpr_mu_unlock(cq->mu); |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 1259 | GRPC_CQ_INTERNAL_UNREF(exec_ctx, cq, "shutting_down (pluck cq)"); |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1260 | return; |
| 1261 | } |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 1262 | cqd->shutdown_called = true; |
| 1263 | if (gpr_atm_full_fetch_add(&cqd->pending_events, -1) == 1) { |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1264 | cq_finish_shutdown_pluck(exec_ctx, cq); |
| 1265 | } |
| 1266 | gpr_mu_unlock(cq->mu); |
Sree Kuchibhotla | cfce451 | 2017-08-02 23:30:40 -0700 | [diff] [blame] | 1267 | GRPC_CQ_INTERNAL_UNREF(exec_ctx, cq, "shutting_down (pluck cq)"); |
Sree Kuchibhotla | 8ac5c6d | 2017-05-11 14:13:11 -0700 | [diff] [blame] | 1268 | } |
| 1269 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1270 | /* Shutdown simply drops a ref that we reserved at creation time; if we drop |
| 1271 | to zero here, then enter shutdown mode and wake up any waiters */ |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1272 | void grpc_completion_queue_shutdown(grpc_completion_queue* cq) { |
Craig Tiller | f5768a6 | 2015-09-22 10:54:34 -0700 | [diff] [blame] | 1273 | grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT; |
Craig Tiller | c7e1a2a | 2015-11-02 14:17:32 -0800 | [diff] [blame] | 1274 | GPR_TIMER_BEGIN("grpc_completion_queue_shutdown", 0); |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1275 | GRPC_API_TRACE("grpc_completion_queue_shutdown(cq=%p)", 1, (cq)); |
Craig Tiller | be29085 | 2017-06-01 12:42:09 -0700 | [diff] [blame] | 1276 | cq->vtable->shutdown(&exec_ctx, cq); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 1277 | grpc_exec_ctx_finish(&exec_ctx); |
Craig Tiller | c7e1a2a | 2015-11-02 14:17:32 -0800 | [diff] [blame] | 1278 | GPR_TIMER_END("grpc_completion_queue_shutdown", 0); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1279 | } |
| 1280 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1281 | void grpc_completion_queue_destroy(grpc_completion_queue* cq) { |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1282 | GRPC_API_TRACE("grpc_completion_queue_destroy(cq=%p)", 1, (cq)); |
Craig Tiller | c7e1a2a | 2015-11-02 14:17:32 -0800 | [diff] [blame] | 1283 | GPR_TIMER_BEGIN("grpc_completion_queue_destroy", 0); |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1284 | grpc_completion_queue_shutdown(cq); |
Sree Kuchibhotla | 8ac5c6d | 2017-05-11 14:13:11 -0700 | [diff] [blame] | 1285 | |
Sree Kuchibhotla | 8ac5c6d | 2017-05-11 14:13:11 -0700 | [diff] [blame] | 1286 | grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT; |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1287 | GRPC_CQ_INTERNAL_UNREF(&exec_ctx, cq, "destroy"); |
Sree Kuchibhotla | 8ac5c6d | 2017-05-11 14:13:11 -0700 | [diff] [blame] | 1288 | grpc_exec_ctx_finish(&exec_ctx); |
Craig Tiller | c7e1a2a | 2015-11-02 14:17:32 -0800 | [diff] [blame] | 1289 | GPR_TIMER_END("grpc_completion_queue_destroy", 0); |
David Klempner | b505661 | 2015-02-24 14:22:50 -0800 | [diff] [blame] | 1290 | } |
| 1291 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1292 | grpc_pollset* grpc_cq_pollset(grpc_completion_queue* cq) { |
Craig Tiller | 4782d92 | 2017-11-10 09:53:21 -0800 | [diff] [blame] | 1293 | return cq->poller_vtable->can_get_pollset ? POLLSET_FROM_CQ(cq) : nullptr; |
Craig Tiller | 190d360 | 2015-02-18 09:23:38 -0800 | [diff] [blame] | 1294 | } |
Craig Tiller | aec96aa | 2015-04-07 14:32:15 -0700 | [diff] [blame] | 1295 | |
Craig Tiller | baa14a9 | 2017-11-03 09:09:36 -0700 | [diff] [blame] | 1296 | bool grpc_cq_can_listen(grpc_completion_queue* cq) { |
Craig Tiller | 6f0bd2c | 2017-05-26 08:15:35 -0700 | [diff] [blame] | 1297 | return cq->poller_vtable->can_listen; |
Craig Tiller | 11c5832 | 2017-04-12 08:21:17 -0700 | [diff] [blame] | 1298 | } |