Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 1 | /* |
| 2 | * |
| 3 | * Copyright 2015, Google Inc. |
| 4 | * All rights reserved. |
| 5 | * |
| 6 | * Redistribution and use in source and binary forms, with or without |
| 7 | * modification, are permitted provided that the following conditions are |
| 8 | * met: |
| 9 | * |
| 10 | * * Redistributions of source code must retain the above copyright |
| 11 | * notice, this list of conditions and the following disclaimer. |
| 12 | * * Redistributions in binary form must reproduce the above |
| 13 | * copyright notice, this list of conditions and the following disclaimer |
| 14 | * in the documentation and/or other materials provided with the |
| 15 | * distribution. |
| 16 | * * Neither the name of Google Inc. nor the names of its |
| 17 | * contributors may be used to endorse or promote products derived from |
| 18 | * this software without specific prior written permission. |
| 19 | * |
| 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 24 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 25 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 26 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 28 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 29 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 30 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 31 | * |
| 32 | */ |
| 33 | |
| 34 | #include "src/core/surface/channel.h" |
| 35 | |
| 36 | #include <grpc/support/alloc.h> |
| 37 | #include <grpc/support/log.h> |
| 38 | |
| 39 | #include "src/core/channel/client_channel.h" |
David Garcia Quintas | 7b1bd2c | 2015-10-05 18:22:10 -0700 | [diff] [blame] | 40 | #include "src/core/channel/client_uchannel.h" |
David Garcia Quintas | f747bbc | 2015-10-04 23:09:47 -0700 | [diff] [blame] | 41 | #include "src/core/iomgr/timer.h" |
Masood Malekghassemi | 76c3d74 | 2015-08-19 18:22:53 -0700 | [diff] [blame] | 42 | #include "src/core/surface/api_trace.h" |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 43 | #include "src/core/surface/completion_queue.h" |
| 44 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 45 | grpc_connectivity_state grpc_channel_check_connectivity_state( |
| 46 | grpc_channel *channel, int try_to_connect) { |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 47 | /* forward through to the underlying client channel */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 48 | grpc_channel_element *client_channel_elem = |
| 49 | grpc_channel_stack_last_element(grpc_channel_get_channel_stack(channel)); |
Craig Tiller | f5768a6 | 2015-09-22 10:54:34 -0700 | [diff] [blame] | 50 | grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT; |
Craig Tiller | 000cd8f | 2015-09-18 07:20:29 -0700 | [diff] [blame] | 51 | grpc_connectivity_state state; |
Masood Malekghassemi | 76c3d74 | 2015-08-19 18:22:53 -0700 | [diff] [blame] | 52 | GRPC_API_TRACE( |
Craig Tiller | 4de3e4f | 2015-10-05 08:55:50 -0700 | [diff] [blame] | 53 | "grpc_channel_check_connectivity_state(channel=%p, try_to_connect=%d)", 2, |
| 54 | (channel, try_to_connect)); |
David Garcia Quintas | 7b1bd2c | 2015-10-05 18:22:10 -0700 | [diff] [blame] | 55 | if (client_channel_elem->filter == &grpc_client_channel_filter) { |
| 56 | state = grpc_client_channel_check_connectivity_state( |
| 57 | &exec_ctx, client_channel_elem, try_to_connect); |
Craig Tiller | 6301038 | 2015-09-24 15:00:58 -0700 | [diff] [blame] | 58 | grpc_exec_ctx_finish(&exec_ctx); |
David Garcia Quintas | 7b1bd2c | 2015-10-05 18:22:10 -0700 | [diff] [blame] | 59 | return state; |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 60 | } |
David Garcia Quintas | 7b1bd2c | 2015-10-05 18:22:10 -0700 | [diff] [blame] | 61 | if (client_channel_elem->filter == &grpc_client_uchannel_filter) { |
| 62 | state = grpc_client_uchannel_check_connectivity_state( |
| 63 | &exec_ctx, client_channel_elem, try_to_connect); |
| 64 | grpc_exec_ctx_finish(&exec_ctx); |
| 65 | return state; |
| 66 | } |
| 67 | gpr_log(GPR_ERROR, |
| 68 | "grpc_channel_check_connectivity_state called on something that is " |
| 69 | "not a (u)client channel, but '%s'", |
| 70 | client_channel_elem->filter->name); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 71 | grpc_exec_ctx_finish(&exec_ctx); |
David Garcia Quintas | 7b1bd2c | 2015-10-05 18:22:10 -0700 | [diff] [blame] | 72 | return GRPC_CHANNEL_FATAL_FAILURE; |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 73 | } |
| 74 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 75 | typedef enum { |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 76 | WAITING, |
| 77 | CALLING_BACK, |
| 78 | CALLING_BACK_AND_FINISHED, |
| 79 | CALLED_BACK |
| 80 | } callback_phase; |
| 81 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 82 | typedef struct { |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 83 | gpr_mu mu; |
| 84 | callback_phase phase; |
| 85 | int success; |
Craig Tiller | 3382511 | 2015-09-18 07:44:19 -0700 | [diff] [blame] | 86 | grpc_closure on_complete; |
David Garcia Quintas | f747bbc | 2015-10-04 23:09:47 -0700 | [diff] [blame] | 87 | grpc_timer alarm; |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 88 | grpc_connectivity_state state; |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 89 | grpc_completion_queue *cq; |
| 90 | grpc_cq_completion completion_storage; |
Craig Tiller | 1ada6ad | 2015-07-16 16:19:14 -0700 | [diff] [blame] | 91 | grpc_channel *channel; |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 92 | void *tag; |
| 93 | } state_watcher; |
| 94 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 95 | static void delete_state_watcher(grpc_exec_ctx *exec_ctx, state_watcher *w) { |
David Garcia Quintas | 7b1bd2c | 2015-10-05 18:22:10 -0700 | [diff] [blame] | 96 | grpc_channel_element *client_channel_elem = grpc_channel_stack_last_element( |
| 97 | grpc_channel_get_channel_stack(w->channel)); |
| 98 | if (client_channel_elem->filter == &grpc_client_channel_filter) { |
| 99 | GRPC_CHANNEL_INTERNAL_UNREF(exec_ctx, w->channel, |
| 100 | "watch_channel_connectivity"); |
| 101 | } else if (client_channel_elem->filter == &grpc_client_uchannel_filter) { |
| 102 | GRPC_CHANNEL_INTERNAL_UNREF(exec_ctx, w->channel, |
| 103 | "watch_uchannel_connectivity"); |
| 104 | } else { |
| 105 | abort(); |
| 106 | } |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 107 | gpr_mu_destroy(&w->mu); |
| 108 | gpr_free(w); |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 109 | } |
| 110 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 111 | static void finished_completion(grpc_exec_ctx *exec_ctx, void *pw, |
| 112 | grpc_cq_completion *ignored) { |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 113 | int delete = 0; |
| 114 | state_watcher *w = pw; |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 115 | gpr_mu_lock(&w->mu); |
| 116 | switch (w->phase) { |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 117 | case WAITING: |
| 118 | case CALLED_BACK: |
yang-g | b063c87 | 2015-10-07 11:40:13 -0700 | [diff] [blame] | 119 | GPR_UNREACHABLE_CODE(return ); |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 120 | case CALLING_BACK: |
| 121 | w->phase = CALLED_BACK; |
| 122 | break; |
| 123 | case CALLING_BACK_AND_FINISHED: |
| 124 | delete = 1; |
| 125 | break; |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 126 | } |
| 127 | gpr_mu_unlock(&w->mu); |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 128 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 129 | if (delete) { |
| 130 | delete_state_watcher(exec_ctx, w); |
| 131 | } |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 132 | } |
| 133 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 134 | static void partly_done(grpc_exec_ctx *exec_ctx, state_watcher *w, |
| 135 | int due_to_completion) { |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 136 | int delete = 0; |
| 137 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 138 | if (due_to_completion) { |
David Garcia Quintas | f747bbc | 2015-10-04 23:09:47 -0700 | [diff] [blame] | 139 | grpc_timer_cancel(exec_ctx, &w->alarm); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 140 | } |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 141 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 142 | gpr_mu_lock(&w->mu); |
Craig Tiller | 7b43561 | 2015-11-24 08:15:05 -0800 | [diff] [blame] | 143 | if (due_to_completion) { |
| 144 | w->success = 1; |
| 145 | } |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 146 | switch (w->phase) { |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 147 | case WAITING: |
| 148 | w->phase = CALLING_BACK; |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 149 | grpc_cq_end_op(exec_ctx, w->cq, w->tag, w->success, finished_completion, |
| 150 | w, &w->completion_storage); |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 151 | break; |
| 152 | case CALLING_BACK: |
| 153 | w->phase = CALLING_BACK_AND_FINISHED; |
| 154 | break; |
| 155 | case CALLING_BACK_AND_FINISHED: |
yang-g | b063c87 | 2015-10-07 11:40:13 -0700 | [diff] [blame] | 156 | GPR_UNREACHABLE_CODE(return ); |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 157 | case CALLED_BACK: |
| 158 | delete = 1; |
| 159 | break; |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 160 | } |
| 161 | gpr_mu_unlock(&w->mu); |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 162 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 163 | if (delete) { |
| 164 | delete_state_watcher(exec_ctx, w); |
| 165 | } |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 166 | } |
| 167 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 168 | static void watch_complete(grpc_exec_ctx *exec_ctx, void *pw, int success) { |
| 169 | partly_done(exec_ctx, pw, 1); |
Craig Tiller | dfff1b8 | 2015-09-21 14:39:57 -0700 | [diff] [blame] | 170 | } |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 171 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 172 | static void timeout_complete(grpc_exec_ctx *exec_ctx, void *pw, int success) { |
| 173 | partly_done(exec_ctx, pw, 0); |
Craig Tiller | dfff1b8 | 2015-09-21 14:39:57 -0700 | [diff] [blame] | 174 | } |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 175 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 176 | void grpc_channel_watch_connectivity_state( |
| 177 | grpc_channel *channel, grpc_connectivity_state last_observed_state, |
| 178 | gpr_timespec deadline, grpc_completion_queue *cq, void *tag) { |
| 179 | grpc_channel_element *client_channel_elem = |
| 180 | grpc_channel_stack_last_element(grpc_channel_get_channel_stack(channel)); |
Craig Tiller | f5768a6 | 2015-09-22 10:54:34 -0700 | [diff] [blame] | 181 | grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT; |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 182 | state_watcher *w = gpr_malloc(sizeof(*w)); |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 183 | |
Masood Malekghassemi | 76c3d74 | 2015-08-19 18:22:53 -0700 | [diff] [blame] | 184 | GRPC_API_TRACE( |
| 185 | "grpc_channel_watch_connectivity_state(" |
Craig Tiller | 4de3e4f | 2015-10-05 08:55:50 -0700 | [diff] [blame] | 186 | "channel=%p, last_observed_state=%d, " |
Jan Tattermusch | 8808637 | 2015-12-10 10:54:12 -0800 | [diff] [blame] | 187 | "deadline=gpr_timespec { tv_sec: %lld, tv_nsec: %d, clock_type: %d }, " |
Craig Tiller | 4de3e4f | 2015-10-05 08:55:50 -0700 | [diff] [blame] | 188 | "cq=%p, tag=%p)", |
Jan Tattermusch | 8808637 | 2015-12-10 10:54:12 -0800 | [diff] [blame] | 189 | 7, (channel, (int)last_observed_state, (long long)deadline.tv_sec, |
| 190 | (int)deadline.tv_nsec, (int)deadline.clock_type, cq, tag)); |
Masood Malekghassemi | 76c3d74 | 2015-08-19 18:22:53 -0700 | [diff] [blame] | 191 | |
Craig Tiller | 4bf2928 | 2015-12-14 11:25:48 -0800 | [diff] [blame] | 192 | grpc_cq_begin_op(cq, tag); |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 193 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 194 | gpr_mu_init(&w->mu); |
| 195 | grpc_closure_init(&w->on_complete, watch_complete, w); |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 196 | w->phase = WAITING; |
| 197 | w->state = last_observed_state; |
| 198 | w->success = 0; |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 199 | w->cq = cq; |
| 200 | w->tag = tag; |
Craig Tiller | 1ada6ad | 2015-07-16 16:19:14 -0700 | [diff] [blame] | 201 | w->channel = channel; |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 202 | |
David Garcia Quintas | f747bbc | 2015-10-04 23:09:47 -0700 | [diff] [blame] | 203 | grpc_timer_init(&exec_ctx, &w->alarm, |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 204 | gpr_convert_clock_type(deadline, GPR_CLOCK_MONOTONIC), |
| 205 | timeout_complete, w, gpr_now(GPR_CLOCK_MONOTONIC)); |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 206 | |
David Garcia Quintas | 7b1bd2c | 2015-10-05 18:22:10 -0700 | [diff] [blame] | 207 | if (client_channel_elem->filter == &grpc_client_channel_filter) { |
| 208 | GRPC_CHANNEL_INTERNAL_REF(channel, "watch_channel_connectivity"); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 209 | grpc_client_channel_watch_connectivity_state(&exec_ctx, client_channel_elem, |
Craig Tiller | 7b43561 | 2015-11-24 08:15:05 -0800 | [diff] [blame] | 210 | grpc_cq_pollset(cq), &w->state, |
| 211 | &w->on_complete); |
David Garcia Quintas | 7b1bd2c | 2015-10-05 18:22:10 -0700 | [diff] [blame] | 212 | } else if (client_channel_elem->filter == &grpc_client_uchannel_filter) { |
| 213 | GRPC_CHANNEL_INTERNAL_REF(channel, "watch_uchannel_connectivity"); |
David Garcia Quintas | 7b1bd2c | 2015-10-05 18:22:10 -0700 | [diff] [blame] | 214 | grpc_client_uchannel_watch_connectivity_state( |
Craig Tiller | 7b43561 | 2015-11-24 08:15:05 -0800 | [diff] [blame] | 215 | &exec_ctx, client_channel_elem, grpc_cq_pollset(cq), &w->state, |
| 216 | &w->on_complete); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 217 | } |
Craig Tiller | 000cd8f | 2015-09-18 07:20:29 -0700 | [diff] [blame] | 218 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 219 | grpc_exec_ctx_finish(&exec_ctx); |
Craig Tiller | 48cb07c | 2015-07-15 16:16:15 -0700 | [diff] [blame] | 220 | } |