Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 1 | // |
| 2 | // Copyright 2016, Google Inc. |
| 3 | // All rights reserved. |
| 4 | // |
| 5 | // Redistribution and use in source and binary forms, with or without |
| 6 | // modification, are permitted provided that the following conditions are |
| 7 | // met: |
| 8 | // |
| 9 | // * Redistributions of source code must retain the above copyright |
| 10 | // notice, this list of conditions and the following disclaimer. |
| 11 | // * Redistributions in binary form must reproduce the above |
| 12 | // copyright notice, this list of conditions and the following disclaimer |
| 13 | // in the documentation and/or other materials provided with the |
| 14 | // distribution. |
| 15 | // * Neither the name of Google Inc. nor the names of its |
| 16 | // contributors may be used to endorse or promote products derived from |
| 17 | // this software without specific prior written permission. |
| 18 | // |
| 19 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 20 | // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 21 | // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 22 | // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 23 | // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 24 | // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 25 | // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 26 | // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 27 | // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 28 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 29 | // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 30 | // |
| 31 | |
Craig Tiller | 3be7dd0 | 2017-04-03 14:30:03 -0700 | [diff] [blame] | 32 | #include "src/core/ext/filters/deadline/deadline_filter.h" |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 33 | |
| 34 | #include <stdbool.h> |
| 35 | #include <string.h> |
| 36 | |
Mark D. Roth | f28763c | 2016-09-14 15:18:40 -0700 | [diff] [blame] | 37 | #include <grpc/support/alloc.h> |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 38 | #include <grpc/support/log.h> |
Mark D. Roth | 1bbe6cb | 2016-08-31 08:33:37 -0700 | [diff] [blame] | 39 | #include <grpc/support/sync.h> |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 40 | #include <grpc/support/time.h> |
| 41 | |
Craig Tiller | 3be7dd0 | 2017-04-03 14:30:03 -0700 | [diff] [blame] | 42 | #include "src/core/lib/channel/channel_stack_builder.h" |
Mark D. Roth | f28763c | 2016-09-14 15:18:40 -0700 | [diff] [blame] | 43 | #include "src/core/lib/iomgr/exec_ctx.h" |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 44 | #include "src/core/lib/iomgr/timer.h" |
Craig Tiller | a59c16c | 2016-10-31 07:25:01 -0700 | [diff] [blame] | 45 | #include "src/core/lib/slice/slice_internal.h" |
Craig Tiller | 3be7dd0 | 2017-04-03 14:30:03 -0700 | [diff] [blame] | 46 | #include "src/core/lib/surface/channel_init.h" |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 47 | |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 48 | // |
| 49 | // grpc_deadline_state |
| 50 | // |
| 51 | |
| 52 | // Timer callback. |
Mark D. Roth | 932b10c | 2016-09-09 08:44:30 -0700 | [diff] [blame] | 53 | static void timer_callback(grpc_exec_ctx* exec_ctx, void* arg, |
| 54 | grpc_error* error) { |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 55 | grpc_call_element* elem = arg; |
| 56 | grpc_deadline_state* deadline_state = elem->call_data; |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 57 | if (error != GRPC_ERROR_CANCELLED) { |
Craig Tiller | 7c70b6c | 2017-01-23 07:48:42 -0800 | [diff] [blame] | 58 | grpc_call_element_signal_error( |
| 59 | exec_ctx, elem, |
ncteisen | 4b36a3d | 2017-03-13 19:08:06 -0700 | [diff] [blame] | 60 | grpc_error_set_int( |
| 61 | GRPC_ERROR_CREATE_FROM_STATIC_STRING("Deadline Exceeded"), |
| 62 | GRPC_ERROR_INT_GRPC_STATUS, GRPC_STATUS_DEADLINE_EXCEEDED)); |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 63 | } |
| 64 | GRPC_CALL_STACK_UNREF(exec_ctx, deadline_state->call_stack, "deadline_timer"); |
| 65 | } |
| 66 | |
| 67 | // Starts the deadline timer. |
Mark D. Roth | 932b10c | 2016-09-09 08:44:30 -0700 | [diff] [blame] | 68 | static void start_timer_if_needed(grpc_exec_ctx* exec_ctx, |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 69 | grpc_call_element* elem, |
| 70 | gpr_timespec deadline) { |
Craig Tiller | 4447c2c | 2017-02-16 12:35:13 -0800 | [diff] [blame] | 71 | deadline = gpr_convert_clock_type(deadline, GPR_CLOCK_MONOTONIC); |
Craig Tiller | 0a77de8 | 2017-02-16 12:39:33 -0800 | [diff] [blame] | 72 | if (gpr_time_cmp(deadline, gpr_inf_future(GPR_CLOCK_MONOTONIC)) == 0) { |
Craig Tiller | 4447c2c | 2017-02-16 12:35:13 -0800 | [diff] [blame] | 73 | return; |
| 74 | } |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 75 | grpc_deadline_state* deadline_state = elem->call_data; |
Craig Tiller | c84886b | 2017-02-16 13:10:38 -0800 | [diff] [blame] | 76 | grpc_deadline_timer_state cur_state; |
| 77 | grpc_closure* closure = NULL; |
| 78 | retry: |
| 79 | cur_state = |
| 80 | (grpc_deadline_timer_state)gpr_atm_acq_load(&deadline_state->timer_state); |
| 81 | switch (cur_state) { |
| 82 | case GRPC_DEADLINE_STATE_PENDING: |
Craig Tiller | ac942f4 | 2017-02-22 09:13:14 -0800 | [diff] [blame] | 83 | // Note: We do not start the timer if there is already a timer |
Craig Tiller | c84886b | 2017-02-16 13:10:38 -0800 | [diff] [blame] | 84 | return; |
| 85 | case GRPC_DEADLINE_STATE_FINISHED: |
| 86 | if (gpr_atm_rel_cas(&deadline_state->timer_state, |
| 87 | GRPC_DEADLINE_STATE_FINISHED, |
| 88 | GRPC_DEADLINE_STATE_PENDING)) { |
Craig Tiller | ac942f4 | 2017-02-22 09:13:14 -0800 | [diff] [blame] | 89 | // If we've already created and destroyed a timer, we always create a |
| 90 | // new closure: we have no other guarantee that the inlined closure is |
| 91 | // not in use (it may hold a pending call to timer_callback) |
Craig Tiller | c84886b | 2017-02-16 13:10:38 -0800 | [diff] [blame] | 92 | closure = grpc_closure_create(timer_callback, elem, |
| 93 | grpc_schedule_on_exec_ctx); |
| 94 | } else { |
| 95 | goto retry; |
Craig Tiller | 4447c2c | 2017-02-16 12:35:13 -0800 | [diff] [blame] | 96 | } |
Craig Tiller | c84886b | 2017-02-16 13:10:38 -0800 | [diff] [blame] | 97 | break; |
| 98 | case GRPC_DEADLINE_STATE_INITIAL: |
| 99 | if (gpr_atm_rel_cas(&deadline_state->timer_state, |
| 100 | GRPC_DEADLINE_STATE_INITIAL, |
| 101 | GRPC_DEADLINE_STATE_PENDING)) { |
| 102 | closure = |
| 103 | grpc_closure_init(&deadline_state->timer_callback, timer_callback, |
| 104 | elem, grpc_schedule_on_exec_ctx); |
| 105 | } else { |
| 106 | goto retry; |
| 107 | } |
| 108 | break; |
Craig Tiller | 4447c2c | 2017-02-16 12:35:13 -0800 | [diff] [blame] | 109 | } |
Craig Tiller | c84886b | 2017-02-16 13:10:38 -0800 | [diff] [blame] | 110 | GPR_ASSERT(closure); |
Craig Tiller | ac942f4 | 2017-02-22 09:13:14 -0800 | [diff] [blame] | 111 | GRPC_CALL_STACK_REF(deadline_state->call_stack, "deadline_timer"); |
Craig Tiller | c84886b | 2017-02-16 13:10:38 -0800 | [diff] [blame] | 112 | grpc_timer_init(exec_ctx, &deadline_state->timer, deadline, closure, |
| 113 | gpr_now(GPR_CLOCK_MONOTONIC)); |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 114 | } |
| 115 | |
| 116 | // Cancels the deadline timer. |
Mark D. Roth | e40dd29 | 2016-10-05 14:58:37 -0700 | [diff] [blame] | 117 | static void cancel_timer_if_needed(grpc_exec_ctx* exec_ctx, |
| 118 | grpc_deadline_state* deadline_state) { |
Craig Tiller | ac942f4 | 2017-02-22 09:13:14 -0800 | [diff] [blame] | 119 | if (gpr_atm_rel_cas(&deadline_state->timer_state, GRPC_DEADLINE_STATE_PENDING, |
| 120 | GRPC_DEADLINE_STATE_FINISHED)) { |
Craig Tiller | c84886b | 2017-02-16 13:10:38 -0800 | [diff] [blame] | 121 | grpc_timer_cancel(exec_ctx, &deadline_state->timer); |
Craig Tiller | ac942f4 | 2017-02-22 09:13:14 -0800 | [diff] [blame] | 122 | } else { |
| 123 | // timer was either in STATE_INITAL (nothing to cancel) |
| 124 | // OR in STATE_FINISHED (again nothing to cancel) |
Craig Tiller | 4447c2c | 2017-02-16 12:35:13 -0800 | [diff] [blame] | 125 | } |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 126 | } |
| 127 | |
| 128 | // Callback run when the call is complete. |
Mark D. Roth | 932b10c | 2016-09-09 08:44:30 -0700 | [diff] [blame] | 129 | static void on_complete(grpc_exec_ctx* exec_ctx, void* arg, grpc_error* error) { |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 130 | grpc_deadline_state* deadline_state = arg; |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 131 | cancel_timer_if_needed(exec_ctx, deadline_state); |
| 132 | // Invoke the next callback. |
Craig Tiller | c84886b | 2017-02-16 13:10:38 -0800 | [diff] [blame] | 133 | grpc_closure_run(exec_ctx, deadline_state->next_on_complete, |
| 134 | GRPC_ERROR_REF(error)); |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 135 | } |
| 136 | |
| 137 | // Inject our own on_complete callback into op. |
| 138 | static void inject_on_complete_cb(grpc_deadline_state* deadline_state, |
Craig Tiller | a0f3abd | 2017-03-31 15:42:16 -0700 | [diff] [blame] | 139 | grpc_transport_stream_op_batch* op) { |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 140 | deadline_state->next_on_complete = op->on_complete; |
Craig Tiller | 91031da | 2016-12-28 15:44:25 -0800 | [diff] [blame] | 141 | grpc_closure_init(&deadline_state->on_complete, on_complete, deadline_state, |
| 142 | grpc_schedule_on_exec_ctx); |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 143 | op->on_complete = &deadline_state->on_complete; |
| 144 | } |
| 145 | |
Mark D. Roth | f28763c | 2016-09-14 15:18:40 -0700 | [diff] [blame] | 146 | // Callback and associated state for starting the timer after call stack |
| 147 | // initialization has been completed. |
| 148 | struct start_timer_after_init_state { |
| 149 | grpc_call_element* elem; |
| 150 | gpr_timespec deadline; |
| 151 | grpc_closure closure; |
| 152 | }; |
| 153 | static void start_timer_after_init(grpc_exec_ctx* exec_ctx, void* arg, |
| 154 | grpc_error* error) { |
| 155 | struct start_timer_after_init_state* state = arg; |
| 156 | start_timer_if_needed(exec_ctx, state->elem, state->deadline); |
| 157 | gpr_free(state); |
| 158 | } |
| 159 | |
Craig Tiller | 71d6ce6 | 2017-04-06 09:10:09 -0700 | [diff] [blame^] | 160 | void grpc_deadline_state_init(grpc_exec_ctx* exec_ctx, grpc_call_element* elem, |
| 161 | grpc_call_stack* call_stack, |
| 162 | gpr_timespec deadline) { |
| 163 | grpc_deadline_state* deadline_state = elem->call_data; |
| 164 | deadline_state->call_stack = call_stack; |
Mark D. Roth | f28763c | 2016-09-14 15:18:40 -0700 | [diff] [blame] | 165 | // Deadline will always be infinite on servers, so the timer will only be |
| 166 | // set on clients with a finite deadline. |
Mark D. Roth | e40dd29 | 2016-10-05 14:58:37 -0700 | [diff] [blame] | 167 | deadline = gpr_convert_clock_type(deadline, GPR_CLOCK_MONOTONIC); |
Mark D. Roth | f28763c | 2016-09-14 15:18:40 -0700 | [diff] [blame] | 168 | if (gpr_time_cmp(deadline, gpr_inf_future(GPR_CLOCK_MONOTONIC)) != 0) { |
| 169 | // When the deadline passes, we indicate the failure by sending down |
| 170 | // an op with cancel_error set. However, we can't send down any ops |
| 171 | // until after the call stack is fully initialized. If we start the |
| 172 | // timer here, we have no guarantee that the timer won't pop before |
| 173 | // call stack initialization is finished. To avoid that problem, we |
| 174 | // create a closure to start the timer, and we schedule that closure |
| 175 | // to be run after call stack initialization is done. |
| 176 | struct start_timer_after_init_state* state = gpr_malloc(sizeof(*state)); |
| 177 | state->elem = elem; |
| 178 | state->deadline = deadline; |
Craig Tiller | 91031da | 2016-12-28 15:44:25 -0800 | [diff] [blame] | 179 | grpc_closure_init(&state->closure, start_timer_after_init, state, |
| 180 | grpc_schedule_on_exec_ctx); |
| 181 | grpc_closure_sched(exec_ctx, &state->closure, GRPC_ERROR_NONE); |
Mark D. Roth | f28763c | 2016-09-14 15:18:40 -0700 | [diff] [blame] | 182 | } |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 183 | } |
| 184 | |
Craig Tiller | 71d6ce6 | 2017-04-06 09:10:09 -0700 | [diff] [blame^] | 185 | void grpc_deadline_state_destroy(grpc_exec_ctx* exec_ctx, |
| 186 | grpc_call_element* elem) { |
| 187 | grpc_deadline_state* deadline_state = elem->call_data; |
| 188 | cancel_timer_if_needed(exec_ctx, deadline_state); |
| 189 | } |
| 190 | |
Mark D. Roth | e40dd29 | 2016-10-05 14:58:37 -0700 | [diff] [blame] | 191 | void grpc_deadline_state_reset(grpc_exec_ctx* exec_ctx, grpc_call_element* elem, |
| 192 | gpr_timespec new_deadline) { |
Mark D. Roth | f28763c | 2016-09-14 15:18:40 -0700 | [diff] [blame] | 193 | grpc_deadline_state* deadline_state = elem->call_data; |
Craig Tiller | 4447c2c | 2017-02-16 12:35:13 -0800 | [diff] [blame] | 194 | cancel_timer_if_needed(exec_ctx, deadline_state); |
| 195 | start_timer_if_needed(exec_ctx, elem, new_deadline); |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 196 | } |
| 197 | |
Craig Tiller | a0f3abd | 2017-03-31 15:42:16 -0700 | [diff] [blame] | 198 | void grpc_deadline_state_client_start_transport_stream_op_batch( |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 199 | grpc_exec_ctx* exec_ctx, grpc_call_element* elem, |
Craig Tiller | a0f3abd | 2017-03-31 15:42:16 -0700 | [diff] [blame] | 200 | grpc_transport_stream_op_batch* op) { |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 201 | grpc_deadline_state* deadline_state = elem->call_data; |
Craig Tiller | 759965c | 2017-03-02 08:50:18 -0800 | [diff] [blame] | 202 | if (op->cancel_stream) { |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 203 | cancel_timer_if_needed(exec_ctx, deadline_state); |
| 204 | } else { |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 205 | // Make sure we know when the call is complete, so that we can cancel |
| 206 | // the timer. |
Craig Tiller | 759965c | 2017-03-02 08:50:18 -0800 | [diff] [blame] | 207 | if (op->recv_trailing_metadata) { |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 208 | inject_on_complete_cb(deadline_state, op); |
| 209 | } |
| 210 | } |
| 211 | } |
| 212 | |
| 213 | // |
| 214 | // filter code |
| 215 | // |
| 216 | |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 217 | // Constructor for channel_data. Used for both client and server filters. |
Mark D. Roth | 5e2566e | 2016-11-18 10:53:13 -0800 | [diff] [blame] | 218 | static grpc_error* init_channel_elem(grpc_exec_ctx* exec_ctx, |
| 219 | grpc_channel_element* elem, |
| 220 | grpc_channel_element_args* args) { |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 221 | GPR_ASSERT(!args->is_last); |
Mark D. Roth | 5e2566e | 2016-11-18 10:53:13 -0800 | [diff] [blame] | 222 | return GRPC_ERROR_NONE; |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 223 | } |
| 224 | |
| 225 | // Destructor for channel_data. Used for both client and server filters. |
| 226 | static void destroy_channel_elem(grpc_exec_ctx* exec_ctx, |
Mark D. Roth | 932b10c | 2016-09-09 08:44:30 -0700 | [diff] [blame] | 227 | grpc_channel_element* elem) {} |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 228 | |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 229 | // Call data used for both client and server filter. |
| 230 | typedef struct base_call_data { |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 231 | grpc_deadline_state deadline_state; |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 232 | } base_call_data; |
| 233 | |
| 234 | // Additional call data used only for the server filter. |
| 235 | typedef struct server_call_data { |
| 236 | base_call_data base; // Must be first. |
| 237 | // The closure for receiving initial metadata. |
| 238 | grpc_closure recv_initial_metadata_ready; |
| 239 | // Received initial metadata batch. |
| 240 | grpc_metadata_batch* recv_initial_metadata; |
| 241 | // The original recv_initial_metadata_ready closure, which we chain to |
| 242 | // after our own closure is invoked. |
| 243 | grpc_closure* next_recv_initial_metadata_ready; |
| 244 | } server_call_data; |
| 245 | |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 246 | // Constructor for call_data. Used for both client and server filters. |
Mark D. Roth | 932b10c | 2016-09-09 08:44:30 -0700 | [diff] [blame] | 247 | static grpc_error* init_call_elem(grpc_exec_ctx* exec_ctx, |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 248 | grpc_call_element* elem, |
Craig Tiller | c52ba3a | 2017-02-15 22:57:43 -0800 | [diff] [blame] | 249 | const grpc_call_element_args* args) { |
Craig Tiller | 71d6ce6 | 2017-04-06 09:10:09 -0700 | [diff] [blame^] | 250 | grpc_deadline_state_init(exec_ctx, elem, args->call_stack, args->deadline); |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 251 | return GRPC_ERROR_NONE; |
| 252 | } |
| 253 | |
| 254 | // Destructor for call_data. Used for both client and server filters. |
| 255 | static void destroy_call_elem(grpc_exec_ctx* exec_ctx, grpc_call_element* elem, |
| 256 | const grpc_call_final_info* final_info, |
Craig Tiller | e7a1702 | 2017-03-13 10:20:38 -0700 | [diff] [blame] | 257 | grpc_closure* ignored) { |
Mark D. Roth | f28763c | 2016-09-14 15:18:40 -0700 | [diff] [blame] | 258 | grpc_deadline_state_destroy(exec_ctx, elem); |
Mark D. Roth | d2b4533 | 2016-08-26 11:18:00 -0700 | [diff] [blame] | 259 | } |
| 260 | |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 261 | // Method for starting a call op for client filter. |
Craig Tiller | e1b51da | 2017-03-31 15:44:33 -0700 | [diff] [blame] | 262 | static void client_start_transport_stream_op_batch( |
| 263 | grpc_exec_ctx* exec_ctx, grpc_call_element* elem, |
| 264 | grpc_transport_stream_op_batch* op) { |
| 265 | grpc_deadline_state_client_start_transport_stream_op_batch(exec_ctx, elem, |
| 266 | op); |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 267 | // Chain to next filter. |
| 268 | grpc_call_next_op(exec_ctx, elem, op); |
| 269 | } |
| 270 | |
| 271 | // Callback for receiving initial metadata on the server. |
Mark D. Roth | 932b10c | 2016-09-09 08:44:30 -0700 | [diff] [blame] | 272 | static void recv_initial_metadata_ready(grpc_exec_ctx* exec_ctx, void* arg, |
| 273 | grpc_error* error) { |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 274 | grpc_call_element* elem = arg; |
| 275 | server_call_data* calld = elem->call_data; |
| 276 | // Get deadline from metadata and start the timer if needed. |
Mark D. Roth | 932b10c | 2016-09-09 08:44:30 -0700 | [diff] [blame] | 277 | start_timer_if_needed(exec_ctx, elem, calld->recv_initial_metadata->deadline); |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 278 | // Invoke the next callback. |
| 279 | calld->next_recv_initial_metadata_ready->cb( |
| 280 | exec_ctx, calld->next_recv_initial_metadata_ready->cb_arg, error); |
| 281 | } |
| 282 | |
| 283 | // Method for starting a call op for server filter. |
Craig Tiller | e1b51da | 2017-03-31 15:44:33 -0700 | [diff] [blame] | 284 | static void server_start_transport_stream_op_batch( |
| 285 | grpc_exec_ctx* exec_ctx, grpc_call_element* elem, |
| 286 | grpc_transport_stream_op_batch* op) { |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 287 | server_call_data* calld = elem->call_data; |
Craig Tiller | 759965c | 2017-03-02 08:50:18 -0800 | [diff] [blame] | 288 | if (op->cancel_stream) { |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 289 | cancel_timer_if_needed(exec_ctx, &calld->base.deadline_state); |
Mark D. Roth | 1bbe6cb | 2016-08-31 08:33:37 -0700 | [diff] [blame] | 290 | } else { |
| 291 | // If we're receiving initial metadata, we need to get the deadline |
| 292 | // from the recv_initial_metadata_ready callback. So we inject our |
| 293 | // own callback into that hook. |
Craig Tiller | 759965c | 2017-03-02 08:50:18 -0800 | [diff] [blame] | 294 | if (op->recv_initial_metadata) { |
| 295 | calld->next_recv_initial_metadata_ready = |
| 296 | op->payload->recv_initial_metadata.recv_initial_metadata_ready; |
| 297 | calld->recv_initial_metadata = |
| 298 | op->payload->recv_initial_metadata.recv_initial_metadata; |
Mark D. Roth | 1bbe6cb | 2016-08-31 08:33:37 -0700 | [diff] [blame] | 299 | grpc_closure_init(&calld->recv_initial_metadata_ready, |
Craig Tiller | 91031da | 2016-12-28 15:44:25 -0800 | [diff] [blame] | 300 | recv_initial_metadata_ready, elem, |
| 301 | grpc_schedule_on_exec_ctx); |
Craig Tiller | 759965c | 2017-03-02 08:50:18 -0800 | [diff] [blame] | 302 | op->payload->recv_initial_metadata.recv_initial_metadata_ready = |
| 303 | &calld->recv_initial_metadata_ready; |
Mark D. Roth | 1bbe6cb | 2016-08-31 08:33:37 -0700 | [diff] [blame] | 304 | } |
| 305 | // Make sure we know when the call is complete, so that we can cancel |
| 306 | // the timer. |
| 307 | // Note that we trigger this on recv_trailing_metadata, even though |
| 308 | // the client never sends trailing metadata, because this is the |
| 309 | // hook that tells us when the call is complete on the server side. |
Craig Tiller | 759965c | 2017-03-02 08:50:18 -0800 | [diff] [blame] | 310 | if (op->recv_trailing_metadata) { |
Mark D. Roth | 72f6da8 | 2016-09-02 13:42:38 -0700 | [diff] [blame] | 311 | inject_on_complete_cb(&calld->base.deadline_state, op); |
Mark D. Roth | 1bbe6cb | 2016-08-31 08:33:37 -0700 | [diff] [blame] | 312 | } |
Mark D. Roth | d2b4533 | 2016-08-26 11:18:00 -0700 | [diff] [blame] | 313 | } |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 314 | // Chain to next filter. |
| 315 | grpc_call_next_op(exec_ctx, elem, op); |
| 316 | } |
| 317 | |
| 318 | const grpc_channel_filter grpc_client_deadline_filter = { |
Craig Tiller | a0f3abd | 2017-03-31 15:42:16 -0700 | [diff] [blame] | 319 | client_start_transport_stream_op_batch, |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 320 | grpc_channel_next_op, |
| 321 | sizeof(base_call_data), |
| 322 | init_call_elem, |
| 323 | grpc_call_stack_ignore_set_pollset_or_pollset_set, |
| 324 | destroy_call_elem, |
Mark D. Roth | b3405f0a | 2016-09-09 08:46:28 -0700 | [diff] [blame] | 325 | 0, // sizeof(channel_data) |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 326 | init_channel_elem, |
| 327 | destroy_channel_elem, |
| 328 | grpc_call_next_get_peer, |
Mark D. Roth | b2d2488 | 2016-10-27 15:44:07 -0700 | [diff] [blame] | 329 | grpc_channel_next_get_info, |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 330 | "deadline", |
| 331 | }; |
| 332 | |
| 333 | const grpc_channel_filter grpc_server_deadline_filter = { |
Craig Tiller | a0f3abd | 2017-03-31 15:42:16 -0700 | [diff] [blame] | 334 | server_start_transport_stream_op_batch, |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 335 | grpc_channel_next_op, |
| 336 | sizeof(server_call_data), |
| 337 | init_call_elem, |
| 338 | grpc_call_stack_ignore_set_pollset_or_pollset_set, |
| 339 | destroy_call_elem, |
Mark D. Roth | b3405f0a | 2016-09-09 08:46:28 -0700 | [diff] [blame] | 340 | 0, // sizeof(channel_data) |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 341 | init_channel_elem, |
| 342 | destroy_channel_elem, |
| 343 | grpc_call_next_get_peer, |
Mark D. Roth | b2d2488 | 2016-10-27 15:44:07 -0700 | [diff] [blame] | 344 | grpc_channel_next_get_info, |
Mark D. Roth | 14c072c | 2016-08-26 08:31:34 -0700 | [diff] [blame] | 345 | "deadline", |
| 346 | }; |
Craig Tiller | 3be7dd0 | 2017-04-03 14:30:03 -0700 | [diff] [blame] | 347 | |
| 348 | bool grpc_deadline_checking_enabled(const grpc_channel_args* channel_args) { |
| 349 | bool enable = !grpc_channel_args_want_minimal_stack(channel_args); |
| 350 | const grpc_arg* a = |
| 351 | grpc_channel_args_find(channel_args, GRPC_ARG_ENABLE_DEADLINE_CHECKS); |
| 352 | if (a != NULL && a->type == GRPC_ARG_INTEGER && a->value.integer != 0) { |
| 353 | enable = true; |
| 354 | } |
| 355 | return enable; |
| 356 | } |
| 357 | |
| 358 | static bool maybe_add_deadline_filter(grpc_exec_ctx* exec_ctx, |
| 359 | grpc_channel_stack_builder* builder, |
| 360 | void* arg) { |
| 361 | return grpc_deadline_checking_enabled( |
| 362 | grpc_channel_stack_builder_get_channel_arguments(builder)) |
| 363 | ? grpc_channel_stack_builder_prepend_filter(builder, arg, NULL, |
| 364 | NULL) |
| 365 | : true; |
| 366 | } |
| 367 | |
| 368 | void grpc_deadline_filter_init(void) { |
| 369 | grpc_channel_init_register_stage( |
| 370 | GRPC_CLIENT_DIRECT_CHANNEL, GRPC_CHANNEL_INIT_BUILTIN_PRIORITY, |
| 371 | maybe_add_deadline_filter, (void*)&grpc_client_deadline_filter); |
| 372 | grpc_channel_init_register_stage( |
| 373 | GRPC_SERVER_CHANNEL, GRPC_CHANNEL_INIT_BUILTIN_PRIORITY, |
| 374 | maybe_add_deadline_filter, (void*)&grpc_server_deadline_filter); |
| 375 | } |
| 376 | |
| 377 | void grpc_deadline_filter_shutdown(void) {} |