ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
Craig Tiller | 0605995 | 2015-02-18 08:34:56 -0800 | [diff] [blame] | 3 | * Copyright 2015, Google Inc. |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 4 | * All rights reserved. |
| 5 | * |
| 6 | * Redistribution and use in source and binary forms, with or without |
| 7 | * modification, are permitted provided that the following conditions are |
| 8 | * met: |
| 9 | * |
| 10 | * * Redistributions of source code must retain the above copyright |
| 11 | * notice, this list of conditions and the following disclaimer. |
| 12 | * * Redistributions in binary form must reproduce the above |
| 13 | * copyright notice, this list of conditions and the following disclaimer |
| 14 | * in the documentation and/or other materials provided with the |
| 15 | * distribution. |
| 16 | * * Neither the name of Google Inc. nor the names of its |
| 17 | * contributors may be used to endorse or promote products derived from |
| 18 | * this software without specific prior written permission. |
| 19 | * |
| 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 24 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 25 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 26 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 28 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 29 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 30 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 31 | * |
| 32 | */ |
| 33 | |
| 34 | #include "src/core/iomgr/iomgr.h" |
| 35 | |
| 36 | #include <stdlib.h> |
| 37 | |
| 38 | #include "src/core/iomgr/iomgr_internal.h" |
| 39 | #include "src/core/iomgr/alarm_internal.h" |
Craig Tiller | fa275a9 | 2015-06-01 13:55:54 -0700 | [diff] [blame] | 40 | #include "src/core/support/string.h" |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 41 | #include <grpc/support/alloc.h> |
| 42 | #include <grpc/support/log.h> |
Masood Malekghassemi | 701af60 | 2015-06-03 15:01:17 -0700 | [diff] [blame] | 43 | #include <grpc/support/string_util.h> |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 44 | #include <grpc/support/sync.h> |
Masood Malekghassemi | 701af60 | 2015-06-03 15:01:17 -0700 | [diff] [blame] | 45 | #include <grpc/support/thd.h> |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 46 | |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 47 | static gpr_mu g_mu; |
Nicolas "Pixel" Noble | ae7b45a | 2015-02-04 03:28:34 +0100 | [diff] [blame] | 48 | static gpr_cv g_rcv; |
David Garcia Quintas | 5f228f5 | 2015-05-26 19:58:50 -0700 | [diff] [blame] | 49 | static grpc_iomgr_closure *g_cbs_head = NULL; |
| 50 | static grpc_iomgr_closure *g_cbs_tail = NULL; |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 51 | static int g_shutdown; |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 52 | static gpr_event g_background_callback_executor_done; |
Craig Tiller | fa275a9 | 2015-06-01 13:55:54 -0700 | [diff] [blame] | 53 | static grpc_iomgr_object g_root_object; |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 54 | |
| 55 | /* Execute followup callbacks continuously. |
| 56 | Other threads may check in and help during pollset_work() */ |
| 57 | static void background_callback_executor(void *ignored) { |
| 58 | gpr_mu_lock(&g_mu); |
| 59 | while (!g_shutdown) { |
| 60 | gpr_timespec deadline = gpr_inf_future; |
David Garcia Quintas | 00ff7df | 2015-05-12 00:19:47 -0700 | [diff] [blame] | 61 | gpr_timespec short_deadline = |
Craig Tiller | f3756c1 | 2015-07-01 17:21:01 -0700 | [diff] [blame] | 62 | gpr_time_add(gpr_now(GPR_CLOCK_REALTIME), gpr_time_from_millis(100)); |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 63 | if (g_cbs_head) { |
David Garcia Quintas | a30020f | 2015-05-27 19:21:01 -0700 | [diff] [blame] | 64 | grpc_iomgr_closure *closure = g_cbs_head; |
| 65 | g_cbs_head = closure->next; |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 66 | if (!g_cbs_head) g_cbs_tail = NULL; |
| 67 | gpr_mu_unlock(&g_mu); |
David Garcia Quintas | a30020f | 2015-05-27 19:21:01 -0700 | [diff] [blame] | 68 | closure->cb(closure->cb_arg, closure->success); |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 69 | gpr_mu_lock(&g_mu); |
Craig Tiller | f1bff01 | 2015-07-06 11:20:50 -0700 | [diff] [blame^] | 70 | } else if (grpc_alarm_check(&g_mu, gpr_now(GPR_CLOCK_REALTIME), |
| 71 | &deadline)) { |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 72 | } else { |
David Garcia Quintas | 00ff7df | 2015-05-12 00:19:47 -0700 | [diff] [blame] | 73 | gpr_mu_unlock(&g_mu); |
| 74 | gpr_sleep_until(gpr_time_min(short_deadline, deadline)); |
| 75 | gpr_mu_lock(&g_mu); |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 76 | } |
| 77 | } |
| 78 | gpr_mu_unlock(&g_mu); |
| 79 | gpr_event_set(&g_background_callback_executor_done, (void *)1); |
| 80 | } |
| 81 | |
David Garcia Quintas | 5b984ce | 2015-05-12 16:04:28 -0700 | [diff] [blame] | 82 | void grpc_kick_poller(void) { |
| 83 | /* Empty. The background callback executor polls periodically. The activity |
| 84 | * the kicker is trying to draw the executor's attention to will be picked up |
| 85 | * either by one of the periodic wakeups or by one of the polling application |
| 86 | * threads. */ |
| 87 | } |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 88 | |
Craig Tiller | 32946d3 | 2015-01-15 11:37:30 -0800 | [diff] [blame] | 89 | void grpc_iomgr_init(void) { |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 90 | gpr_thd_id id; |
| 91 | gpr_mu_init(&g_mu); |
Nicolas "Pixel" Noble | ae7b45a | 2015-02-04 03:28:34 +0100 | [diff] [blame] | 92 | gpr_cv_init(&g_rcv); |
Craig Tiller | f3756c1 | 2015-07-01 17:21:01 -0700 | [diff] [blame] | 93 | grpc_alarm_list_init(gpr_now(GPR_CLOCK_REALTIME)); |
Craig Tiller | fa275a9 | 2015-06-01 13:55:54 -0700 | [diff] [blame] | 94 | g_root_object.next = g_root_object.prev = &g_root_object; |
| 95 | g_root_object.name = "root"; |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 96 | grpc_iomgr_platform_init(); |
| 97 | gpr_event_init(&g_background_callback_executor_done); |
| 98 | gpr_thd_new(&id, background_callback_executor, NULL, NULL); |
| 99 | } |
| 100 | |
Craig Tiller | fa275a9 | 2015-06-01 13:55:54 -0700 | [diff] [blame] | 101 | static size_t count_objects(void) { |
| 102 | grpc_iomgr_object *obj; |
| 103 | size_t n = 0; |
| 104 | for (obj = g_root_object.next; obj != &g_root_object; obj = obj->next) { |
| 105 | n++; |
| 106 | } |
| 107 | return n; |
| 108 | } |
| 109 | |
Craig Tiller | 32946d3 | 2015-01-15 11:37:30 -0800 | [diff] [blame] | 110 | void grpc_iomgr_shutdown(void) { |
Craig Tiller | fa275a9 | 2015-06-01 13:55:54 -0700 | [diff] [blame] | 111 | grpc_iomgr_object *obj; |
David Garcia Quintas | a30020f | 2015-05-27 19:21:01 -0700 | [diff] [blame] | 112 | grpc_iomgr_closure *closure; |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 113 | gpr_timespec shutdown_deadline = |
Craig Tiller | f3756c1 | 2015-07-01 17:21:01 -0700 | [diff] [blame] | 114 | gpr_time_add(gpr_now(GPR_CLOCK_REALTIME), gpr_time_from_seconds(10)); |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 115 | |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 116 | gpr_mu_lock(&g_mu); |
| 117 | g_shutdown = 1; |
Craig Tiller | 8e0b08a | 2015-06-01 17:04:17 -0700 | [diff] [blame] | 118 | while (g_cbs_head != NULL || g_root_object.next != &g_root_object) { |
| 119 | if (g_cbs_head != NULL && g_root_object.next != &g_root_object) { |
| 120 | gpr_log(GPR_DEBUG, |
| 121 | "Waiting for %d iomgr objects to be destroyed and executing " |
| 122 | "final callbacks", |
| 123 | count_objects()); |
Craig Tiller | 29f741f | 2015-05-29 12:29:43 -0700 | [diff] [blame] | 124 | } else if (g_cbs_head != NULL) { |
| 125 | gpr_log(GPR_DEBUG, "Executing final iomgr callbacks"); |
| 126 | } else { |
Craig Tiller | 8e0b08a | 2015-06-01 17:04:17 -0700 | [diff] [blame] | 127 | gpr_log(GPR_DEBUG, "Waiting for %d iomgr objects to be destroyed", |
| 128 | count_objects()); |
Craig Tiller | 29f741f | 2015-05-29 12:29:43 -0700 | [diff] [blame] | 129 | } |
Craig Tiller | fa275a9 | 2015-06-01 13:55:54 -0700 | [diff] [blame] | 130 | if (g_cbs_head) { |
| 131 | do { |
Craig Tiller | 3d67c7c | 2015-06-01 20:10:13 -0700 | [diff] [blame] | 132 | closure = g_cbs_head; |
| 133 | g_cbs_head = closure->next; |
Craig Tiller | fa275a9 | 2015-06-01 13:55:54 -0700 | [diff] [blame] | 134 | if (!g_cbs_head) g_cbs_tail = NULL; |
| 135 | gpr_mu_unlock(&g_mu); |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 136 | |
Craig Tiller | 3d67c7c | 2015-06-01 20:10:13 -0700 | [diff] [blame] | 137 | closure->cb(closure->cb_arg, 0); |
Craig Tiller | fa275a9 | 2015-06-01 13:55:54 -0700 | [diff] [blame] | 138 | gpr_mu_lock(&g_mu); |
| 139 | } while (g_cbs_head); |
| 140 | continue; |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 141 | } |
Craig Tiller | 8e0b08a | 2015-06-01 17:04:17 -0700 | [diff] [blame] | 142 | if (grpc_alarm_check(&g_mu, gpr_inf_future, NULL)) { |
| 143 | gpr_log(GPR_DEBUG, "got late alarm"); |
| 144 | continue; |
| 145 | } |
| 146 | if (g_root_object.next != &g_root_object) { |
Nicolas Noble | 8703f4d | 2015-03-23 13:52:18 -0700 | [diff] [blame] | 147 | int timeout = 0; |
Craig Tiller | 8674cb1 | 2015-06-05 07:09:25 -0700 | [diff] [blame] | 148 | gpr_timespec short_deadline = |
Craig Tiller | f3756c1 | 2015-07-01 17:21:01 -0700 | [diff] [blame] | 149 | gpr_time_add(gpr_now(GPR_CLOCK_REALTIME), gpr_time_from_millis(100)); |
Nicolas Noble | 8703f4d | 2015-03-23 13:52:18 -0700 | [diff] [blame] | 150 | while (gpr_cv_wait(&g_rcv, &g_mu, short_deadline) && g_cbs_head == NULL) { |
Craig Tiller | f3756c1 | 2015-07-01 17:21:01 -0700 | [diff] [blame] | 151 | if (gpr_time_cmp(gpr_now(GPR_CLOCK_REALTIME), shutdown_deadline) > 0) { |
Nicolas Noble | 8703f4d | 2015-03-23 13:52:18 -0700 | [diff] [blame] | 152 | timeout = 1; |
| 153 | break; |
| 154 | } |
| 155 | } |
| 156 | if (timeout) { |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 157 | gpr_log(GPR_DEBUG, |
| 158 | "Failed to free %d iomgr objects before shutdown deadline: " |
| 159 | "memory leaks are likely", |
Craig Tiller | fa275a9 | 2015-06-01 13:55:54 -0700 | [diff] [blame] | 160 | count_objects()); |
| 161 | for (obj = g_root_object.next; obj != &g_root_object; obj = obj->next) { |
| 162 | gpr_log(GPR_DEBUG, "LEAKED OBJECT: %s", obj->name); |
| 163 | } |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 164 | break; |
| 165 | } |
| 166 | } |
| 167 | } |
| 168 | gpr_mu_unlock(&g_mu); |
| 169 | |
Nicolas "Pixel" Noble | ae7b45a | 2015-02-04 03:28:34 +0100 | [diff] [blame] | 170 | grpc_kick_poller(); |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 171 | gpr_event_wait(&g_background_callback_executor_done, gpr_inf_future); |
| 172 | |
| 173 | grpc_alarm_list_shutdown(); |
Craig Tiller | 8e0b08a | 2015-06-01 17:04:17 -0700 | [diff] [blame] | 174 | |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 175 | grpc_iomgr_platform_shutdown(); |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 176 | gpr_mu_destroy(&g_mu); |
Nicolas "Pixel" Noble | ae7b45a | 2015-02-04 03:28:34 +0100 | [diff] [blame] | 177 | gpr_cv_destroy(&g_rcv); |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 178 | } |
| 179 | |
Craig Tiller | fa275a9 | 2015-06-01 13:55:54 -0700 | [diff] [blame] | 180 | void grpc_iomgr_register_object(grpc_iomgr_object *obj, const char *name) { |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 181 | gpr_mu_lock(&g_mu); |
Craig Tiller | 8e0b08a | 2015-06-01 17:04:17 -0700 | [diff] [blame] | 182 | obj->name = gpr_strdup(name); |
Craig Tiller | fa275a9 | 2015-06-01 13:55:54 -0700 | [diff] [blame] | 183 | obj->next = &g_root_object; |
| 184 | obj->prev = obj->next->prev; |
| 185 | obj->next->prev = obj->prev->next = obj; |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 186 | gpr_mu_unlock(&g_mu); |
| 187 | } |
| 188 | |
Craig Tiller | fa275a9 | 2015-06-01 13:55:54 -0700 | [diff] [blame] | 189 | void grpc_iomgr_unregister_object(grpc_iomgr_object *obj) { |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 190 | gpr_mu_lock(&g_mu); |
Craig Tiller | fa275a9 | 2015-06-01 13:55:54 -0700 | [diff] [blame] | 191 | obj->next->prev = obj->prev; |
| 192 | obj->prev->next = obj->next; |
Craig Tiller | 8e0b08a | 2015-06-01 17:04:17 -0700 | [diff] [blame] | 193 | gpr_free(obj->name); |
Craig Tiller | fa275a9 | 2015-06-01 13:55:54 -0700 | [diff] [blame] | 194 | gpr_cv_signal(&g_rcv); |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 195 | gpr_mu_unlock(&g_mu); |
| 196 | } |
| 197 | |
David Garcia Quintas | a30020f | 2015-05-27 19:21:01 -0700 | [diff] [blame] | 198 | void grpc_iomgr_closure_init(grpc_iomgr_closure *closure, grpc_iomgr_cb_func cb, |
| 199 | void *cb_arg) { |
| 200 | closure->cb = cb; |
| 201 | closure->cb_arg = cb_arg; |
David Garcia Quintas | a30020f | 2015-05-27 19:21:01 -0700 | [diff] [blame] | 202 | closure->next = NULL; |
David Garcia Quintas | 5f228f5 | 2015-05-26 19:58:50 -0700 | [diff] [blame] | 203 | } |
| 204 | |
David Garcia Quintas | a30020f | 2015-05-27 19:21:01 -0700 | [diff] [blame] | 205 | void grpc_iomgr_add_delayed_callback(grpc_iomgr_closure *closure, int success) { |
| 206 | closure->success = success; |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 207 | gpr_mu_lock(&g_mu); |
David Garcia Quintas | a30020f | 2015-05-27 19:21:01 -0700 | [diff] [blame] | 208 | closure->next = NULL; |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 209 | if (!g_cbs_tail) { |
David Garcia Quintas | a30020f | 2015-05-27 19:21:01 -0700 | [diff] [blame] | 210 | g_cbs_head = g_cbs_tail = closure; |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 211 | } else { |
David Garcia Quintas | a30020f | 2015-05-27 19:21:01 -0700 | [diff] [blame] | 212 | g_cbs_tail->next = closure; |
| 213 | g_cbs_tail = closure; |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 214 | } |
Craig Tiller | 3c1331f | 2015-06-01 13:17:15 -0700 | [diff] [blame] | 215 | if (g_shutdown) { |
| 216 | gpr_cv_signal(&g_rcv); |
| 217 | } |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 218 | gpr_mu_unlock(&g_mu); |
| 219 | } |
| 220 | |
David Garcia Quintas | a30020f | 2015-05-27 19:21:01 -0700 | [diff] [blame] | 221 | void grpc_iomgr_add_callback(grpc_iomgr_closure *closure) { |
David Garcia Quintas | 1c762bd | 2015-05-31 17:04:43 -0700 | [diff] [blame] | 222 | grpc_iomgr_add_delayed_callback(closure, 1 /* GPR_TRUE */); |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 223 | } |
| 224 | |
| 225 | int grpc_maybe_call_delayed_callbacks(gpr_mu *drop_mu, int success) { |
| 226 | int n = 0; |
| 227 | gpr_mu *retake_mu = NULL; |
David Garcia Quintas | a30020f | 2015-05-27 19:21:01 -0700 | [diff] [blame] | 228 | grpc_iomgr_closure *closure; |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 229 | for (;;) { |
| 230 | /* check for new work */ |
| 231 | if (!gpr_mu_trylock(&g_mu)) { |
| 232 | break; |
| 233 | } |
David Garcia Quintas | a30020f | 2015-05-27 19:21:01 -0700 | [diff] [blame] | 234 | closure = g_cbs_head; |
| 235 | if (!closure) { |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 236 | gpr_mu_unlock(&g_mu); |
| 237 | break; |
| 238 | } |
David Garcia Quintas | a30020f | 2015-05-27 19:21:01 -0700 | [diff] [blame] | 239 | g_cbs_head = closure->next; |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 240 | if (!g_cbs_head) g_cbs_tail = NULL; |
| 241 | gpr_mu_unlock(&g_mu); |
| 242 | /* if we have a mutex to drop, do so before executing work */ |
| 243 | if (drop_mu) { |
| 244 | gpr_mu_unlock(drop_mu); |
| 245 | retake_mu = drop_mu; |
| 246 | drop_mu = NULL; |
| 247 | } |
David Garcia Quintas | a30020f | 2015-05-27 19:21:01 -0700 | [diff] [blame] | 248 | closure->cb(closure->cb_arg, success && closure->success); |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 249 | n++; |
| 250 | } |
| 251 | if (retake_mu) { |
| 252 | gpr_mu_lock(retake_mu); |
| 253 | } |
| 254 | return n; |
Craig Tiller | 190d360 | 2015-02-18 09:23:38 -0800 | [diff] [blame] | 255 | } |