mirror of https://github.com/grpc/grpc.git
Craig Tiller
8 years ago
commit
5aebfa0af1
39 changed files with 2539 additions and 168 deletions
@ -0,0 +1,386 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2017, Google Inc. |
||||
* All rights reserved. |
||||
* |
||||
* Redistribution and use in source and binary forms, with or without |
||||
* modification, are permitted provided that the following conditions are |
||||
* met: |
||||
* |
||||
* * Redistributions of source code must retain the above copyright |
||||
* notice, this list of conditions and the following disclaimer. |
||||
* * Redistributions in binary form must reproduce the above |
||||
* copyright notice, this list of conditions and the following disclaimer |
||||
* in the documentation and/or other materials provided with the |
||||
* distribution. |
||||
* * Neither the name of Google Inc. nor the names of its |
||||
* contributors may be used to endorse or promote products derived from |
||||
* this software without specific prior written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
* |
||||
*/ |
||||
|
||||
#include "src/core/lib/channel/message_size_filter.h" |
||||
|
||||
#include <limits.h> |
||||
#include <string.h> |
||||
|
||||
#include "src/core/lib/channel/channel_args.h" |
||||
#include "src/core/lib/iomgr/timer.h" |
||||
#include "src/core/lib/transport/http2_errors.h" |
||||
#include "src/core/lib/transport/service_config.h" |
||||
|
||||
#define DEFAULT_MAX_CONNECTION_AGE_MS INT_MAX |
||||
#define DEFAULT_MAX_CONNECTION_AGE_GRACE_MS INT_MAX |
||||
#define DEFAULT_MAX_CONNECTION_IDLE_MS INT_MAX |
||||
|
||||
typedef struct channel_data { |
||||
/* We take a reference to the channel stack for the timer callback */ |
||||
grpc_channel_stack* channel_stack; |
||||
/* Guards access to max_age_timer, max_age_timer_pending, max_age_grace_timer
|
||||
and max_age_grace_timer_pending */ |
||||
gpr_mu max_age_timer_mu; |
||||
/* True if the max_age timer callback is currently pending */ |
||||
bool max_age_timer_pending; |
||||
/* True if the max_age_grace timer callback is currently pending */ |
||||
bool max_age_grace_timer_pending; |
||||
/* The timer for checking if the channel has reached its max age */ |
||||
grpc_timer max_age_timer; |
||||
/* The timer for checking if the max-aged channel has uesed up the grace
|
||||
period */ |
||||
grpc_timer max_age_grace_timer; |
||||
/* The timer for checking if the channel's idle duration reaches
|
||||
max_connection_idle */ |
||||
grpc_timer max_idle_timer; |
||||
/* Allowed max time a channel may have no outstanding rpcs */ |
||||
gpr_timespec max_connection_idle; |
||||
/* Allowed max time a channel may exist */ |
||||
gpr_timespec max_connection_age; |
||||
/* Allowed grace period after the channel reaches its max age */ |
||||
gpr_timespec max_connection_age_grace; |
||||
/* Closure to run when the channel's idle duration reaches max_connection_idle
|
||||
and should be closed gracefully */ |
||||
grpc_closure close_max_idle_channel; |
||||
/* Closure to run when the channel reaches its max age and should be closed
|
||||
gracefully */ |
||||
grpc_closure close_max_age_channel; |
||||
/* Closure to run the channel uses up its max age grace time and should be
|
||||
closed forcibly */ |
||||
grpc_closure force_close_max_age_channel; |
||||
/* Closure to run when the init fo channel stack is done and the max_idle
|
||||
timer should be started */ |
||||
grpc_closure start_max_idle_timer_after_init; |
||||
/* Closure to run when the init fo channel stack is done and the max_age timer
|
||||
should be started */ |
||||
grpc_closure start_max_age_timer_after_init; |
||||
/* Closure to run when the goaway op is finished and the max_age_timer */ |
||||
grpc_closure start_max_age_grace_timer_after_goaway_op; |
||||
/* Closure to run when the channel connectivity state changes */ |
||||
grpc_closure channel_connectivity_changed; |
||||
/* Records the current connectivity state */ |
||||
grpc_connectivity_state connectivity_state; |
||||
/* Number of active calls */ |
||||
gpr_atm call_count; |
||||
} channel_data; |
||||
|
||||
/* Increase the nubmer of active calls. Before the increasement, if there are no
|
||||
calls, the max_idle_timer should be cancelled. */ |
||||
static void increase_call_count(grpc_exec_ctx* exec_ctx, channel_data* chand) { |
||||
if (gpr_atm_full_fetch_add(&chand->call_count, 1) == 0) { |
||||
grpc_timer_cancel(exec_ctx, &chand->max_idle_timer); |
||||
} |
||||
} |
||||
|
||||
/* Decrease the nubmer of active calls. After the decrement, if there are no
|
||||
calls, the max_idle_timer should be started. */ |
||||
static void decrease_call_count(grpc_exec_ctx* exec_ctx, channel_data* chand) { |
||||
if (gpr_atm_full_fetch_add(&chand->call_count, -1) == 1) { |
||||
GRPC_CHANNEL_STACK_REF(chand->channel_stack, "max_age max_idle_timer"); |
||||
grpc_timer_init( |
||||
exec_ctx, &chand->max_idle_timer, |
||||
gpr_time_add(gpr_now(GPR_CLOCK_MONOTONIC), chand->max_connection_idle), |
||||
&chand->close_max_idle_channel, gpr_now(GPR_CLOCK_MONOTONIC)); |
||||
} |
||||
} |
||||
|
||||
static void start_max_idle_timer_after_init(grpc_exec_ctx* exec_ctx, void* arg, |
||||
grpc_error* error) { |
||||
channel_data* chand = arg; |
||||
/* Decrease call_count. If there are no active calls at this time,
|
||||
max_idle_timer will start here. If the number of active calls is not 0, |
||||
max_idle_timer will start after all the active calls end. */ |
||||
decrease_call_count(exec_ctx, chand); |
||||
GRPC_CHANNEL_STACK_UNREF(exec_ctx, chand->channel_stack, |
||||
"max_age start_max_idle_timer_after_init"); |
||||
} |
||||
|
||||
static void start_max_age_timer_after_init(grpc_exec_ctx* exec_ctx, void* arg, |
||||
grpc_error* error) { |
||||
channel_data* chand = arg; |
||||
gpr_mu_lock(&chand->max_age_timer_mu); |
||||
chand->max_age_timer_pending = true; |
||||
GRPC_CHANNEL_STACK_REF(chand->channel_stack, "max_age max_age_timer"); |
||||
grpc_timer_init( |
||||
exec_ctx, &chand->max_age_timer, |
||||
gpr_time_add(gpr_now(GPR_CLOCK_MONOTONIC), chand->max_connection_age), |
||||
&chand->close_max_age_channel, gpr_now(GPR_CLOCK_MONOTONIC)); |
||||
gpr_mu_unlock(&chand->max_age_timer_mu); |
||||
grpc_transport_op* op = grpc_make_transport_op(NULL); |
||||
op->on_connectivity_state_change = &chand->channel_connectivity_changed, |
||||
op->connectivity_state = &chand->connectivity_state; |
||||
grpc_channel_next_op(exec_ctx, |
||||
grpc_channel_stack_element(chand->channel_stack, 0), op); |
||||
GRPC_CHANNEL_STACK_UNREF(exec_ctx, chand->channel_stack, |
||||
"max_age start_max_age_timer_after_init"); |
||||
} |
||||
|
||||
static void start_max_age_grace_timer_after_goaway_op(grpc_exec_ctx* exec_ctx, |
||||
void* arg, |
||||
grpc_error* error) { |
||||
channel_data* chand = arg; |
||||
gpr_mu_lock(&chand->max_age_timer_mu); |
||||
chand->max_age_grace_timer_pending = true; |
||||
GRPC_CHANNEL_STACK_REF(chand->channel_stack, "max_age max_age_grace_timer"); |
||||
grpc_timer_init(exec_ctx, &chand->max_age_grace_timer, |
||||
gpr_time_add(gpr_now(GPR_CLOCK_MONOTONIC), |
||||
chand->max_connection_age_grace), |
||||
&chand->force_close_max_age_channel, |
||||
gpr_now(GPR_CLOCK_MONOTONIC)); |
||||
gpr_mu_unlock(&chand->max_age_timer_mu); |
||||
GRPC_CHANNEL_STACK_UNREF(exec_ctx, chand->channel_stack, |
||||
"max_age start_max_age_grace_timer_after_goaway_op"); |
||||
} |
||||
|
||||
static void close_max_idle_channel(grpc_exec_ctx* exec_ctx, void* arg, |
||||
grpc_error* error) { |
||||
channel_data* chand = arg; |
||||
gpr_atm_no_barrier_fetch_add(&chand->call_count, 1); |
||||
if (error == GRPC_ERROR_NONE) { |
||||
grpc_transport_op* op = grpc_make_transport_op(NULL); |
||||
op->goaway_error = |
||||
grpc_error_set_int(GRPC_ERROR_CREATE_FROM_STATIC_STRING("max_idle"), |
||||
GRPC_ERROR_INT_HTTP2_ERROR, GRPC_HTTP2_NO_ERROR); |
||||
grpc_channel_element* elem = |
||||
grpc_channel_stack_element(chand->channel_stack, 0); |
||||
elem->filter->start_transport_op(exec_ctx, elem, op); |
||||
} else if (error != GRPC_ERROR_CANCELLED) { |
||||
GRPC_LOG_IF_ERROR("close_max_idle_channel", error); |
||||
} |
||||
GRPC_CHANNEL_STACK_UNREF(exec_ctx, chand->channel_stack, |
||||
"max_age max_idle_timer"); |
||||
} |
||||
|
||||
static void close_max_age_channel(grpc_exec_ctx* exec_ctx, void* arg, |
||||
grpc_error* error) { |
||||
channel_data* chand = arg; |
||||
gpr_mu_lock(&chand->max_age_timer_mu); |
||||
chand->max_age_timer_pending = false; |
||||
gpr_mu_unlock(&chand->max_age_timer_mu); |
||||
if (error == GRPC_ERROR_NONE) { |
||||
GRPC_CHANNEL_STACK_REF(chand->channel_stack, |
||||
"max_age start_max_age_grace_timer_after_goaway_op"); |
||||
grpc_transport_op* op = grpc_make_transport_op( |
||||
&chand->start_max_age_grace_timer_after_goaway_op); |
||||
op->goaway_error = |
||||
grpc_error_set_int(GRPC_ERROR_CREATE_FROM_STATIC_STRING("max_age"), |
||||
GRPC_ERROR_INT_HTTP2_ERROR, GRPC_HTTP2_NO_ERROR); |
||||
grpc_channel_element* elem = |
||||
grpc_channel_stack_element(chand->channel_stack, 0); |
||||
elem->filter->start_transport_op(exec_ctx, elem, op); |
||||
} else if (error != GRPC_ERROR_CANCELLED) { |
||||
GRPC_LOG_IF_ERROR("close_max_age_channel", error); |
||||
} |
||||
GRPC_CHANNEL_STACK_UNREF(exec_ctx, chand->channel_stack, |
||||
"max_age max_age_timer"); |
||||
} |
||||
|
||||
static void force_close_max_age_channel(grpc_exec_ctx* exec_ctx, void* arg, |
||||
grpc_error* error) { |
||||
channel_data* chand = arg; |
||||
gpr_mu_lock(&chand->max_age_timer_mu); |
||||
chand->max_age_grace_timer_pending = false; |
||||
gpr_mu_unlock(&chand->max_age_timer_mu); |
||||
if (error == GRPC_ERROR_NONE) { |
||||
grpc_transport_op* op = grpc_make_transport_op(NULL); |
||||
op->disconnect_with_error = |
||||
GRPC_ERROR_CREATE_FROM_STATIC_STRING("Channel reaches max age"); |
||||
grpc_channel_element* elem = |
||||
grpc_channel_stack_element(chand->channel_stack, 0); |
||||
elem->filter->start_transport_op(exec_ctx, elem, op); |
||||
} else if (error != GRPC_ERROR_CANCELLED) { |
||||
GRPC_LOG_IF_ERROR("force_close_max_age_channel", error); |
||||
} |
||||
GRPC_CHANNEL_STACK_UNREF(exec_ctx, chand->channel_stack, |
||||
"max_age max_age_grace_timer"); |
||||
} |
||||
|
||||
static void channel_connectivity_changed(grpc_exec_ctx* exec_ctx, void* arg, |
||||
grpc_error* error) { |
||||
channel_data* chand = arg; |
||||
if (chand->connectivity_state != GRPC_CHANNEL_SHUTDOWN) { |
||||
grpc_transport_op* op = grpc_make_transport_op(NULL); |
||||
op->on_connectivity_state_change = &chand->channel_connectivity_changed, |
||||
op->connectivity_state = &chand->connectivity_state; |
||||
grpc_channel_next_op( |
||||
exec_ctx, grpc_channel_stack_element(chand->channel_stack, 0), op); |
||||
} else { |
||||
gpr_mu_lock(&chand->max_age_timer_mu); |
||||
if (chand->max_age_timer_pending) { |
||||
grpc_timer_cancel(exec_ctx, &chand->max_age_timer); |
||||
chand->max_age_timer_pending = false; |
||||
} |
||||
if (chand->max_age_grace_timer_pending) { |
||||
grpc_timer_cancel(exec_ctx, &chand->max_age_grace_timer); |
||||
chand->max_age_grace_timer_pending = false; |
||||
} |
||||
gpr_mu_unlock(&chand->max_age_timer_mu); |
||||
/* If there are no active calls, this increasement will cancel
|
||||
max_idle_timer, and prevent max_idle_timer from being started in the |
||||
future. */ |
||||
increase_call_count(exec_ctx, chand); |
||||
} |
||||
} |
||||
|
||||
/* Constructor for call_data. */ |
||||
static grpc_error* init_call_elem(grpc_exec_ctx* exec_ctx, |
||||
grpc_call_element* elem, |
||||
const grpc_call_element_args* args) { |
||||
channel_data* chand = elem->channel_data; |
||||
increase_call_count(exec_ctx, chand); |
||||
return GRPC_ERROR_NONE; |
||||
} |
||||
|
||||
/* Destructor for call_data. */ |
||||
static void destroy_call_elem(grpc_exec_ctx* exec_ctx, grpc_call_element* elem, |
||||
const grpc_call_final_info* final_info, |
||||
grpc_closure* ignored) { |
||||
channel_data* chand = elem->channel_data; |
||||
decrease_call_count(exec_ctx, chand); |
||||
} |
||||
|
||||
/* Constructor for channel_data. */ |
||||
static grpc_error* init_channel_elem(grpc_exec_ctx* exec_ctx, |
||||
grpc_channel_element* elem, |
||||
grpc_channel_element_args* args) { |
||||
channel_data* chand = elem->channel_data; |
||||
gpr_mu_init(&chand->max_age_timer_mu); |
||||
chand->max_age_timer_pending = false; |
||||
chand->max_age_grace_timer_pending = false; |
||||
chand->channel_stack = args->channel_stack; |
||||
chand->max_connection_age = |
||||
DEFAULT_MAX_CONNECTION_AGE_MS == INT_MAX |
||||
? gpr_inf_future(GPR_TIMESPAN) |
||||
: gpr_time_from_millis(DEFAULT_MAX_CONNECTION_AGE_MS, GPR_TIMESPAN); |
||||
chand->max_connection_age_grace = |
||||
DEFAULT_MAX_CONNECTION_AGE_GRACE_MS == INT_MAX |
||||
? gpr_inf_future(GPR_TIMESPAN) |
||||
: gpr_time_from_millis(DEFAULT_MAX_CONNECTION_AGE_GRACE_MS, |
||||
GPR_TIMESPAN); |
||||
chand->max_connection_idle = |
||||
DEFAULT_MAX_CONNECTION_IDLE_MS == INT_MAX |
||||
? gpr_inf_future(GPR_TIMESPAN) |
||||
: gpr_time_from_millis(DEFAULT_MAX_CONNECTION_IDLE_MS, GPR_TIMESPAN); |
||||
for (size_t i = 0; i < args->channel_args->num_args; ++i) { |
||||
if (0 == strcmp(args->channel_args->args[i].key, |
||||
GRPC_ARG_MAX_CONNECTION_AGE_MS)) { |
||||
const int value = grpc_channel_arg_get_integer( |
||||
&args->channel_args->args[i], |
||||
(grpc_integer_options){DEFAULT_MAX_CONNECTION_AGE_MS, 1, INT_MAX}); |
||||
chand->max_connection_age = |
||||
value == INT_MAX ? gpr_inf_future(GPR_TIMESPAN) |
||||
: gpr_time_from_millis(value, GPR_TIMESPAN); |
||||
} else if (0 == strcmp(args->channel_args->args[i].key, |
||||
GRPC_ARG_MAX_CONNECTION_AGE_GRACE_MS)) { |
||||
const int value = grpc_channel_arg_get_integer( |
||||
&args->channel_args->args[i], |
||||
(grpc_integer_options){DEFAULT_MAX_CONNECTION_AGE_GRACE_MS, 0, |
||||
INT_MAX}); |
||||
chand->max_connection_age_grace = |
||||
value == INT_MAX ? gpr_inf_future(GPR_TIMESPAN) |
||||
: gpr_time_from_millis(value, GPR_TIMESPAN); |
||||
} else if (0 == strcmp(args->channel_args->args[i].key, |
||||
GRPC_ARG_MAX_CONNECTION_IDLE_MS)) { |
||||
const int value = grpc_channel_arg_get_integer( |
||||
&args->channel_args->args[i], |
||||
(grpc_integer_options){DEFAULT_MAX_CONNECTION_IDLE_MS, 1, INT_MAX}); |
||||
chand->max_connection_idle = |
||||
value == INT_MAX ? gpr_inf_future(GPR_TIMESPAN) |
||||
: gpr_time_from_millis(value, GPR_TIMESPAN); |
||||
} |
||||
} |
||||
grpc_closure_init(&chand->close_max_idle_channel, close_max_idle_channel, |
||||
chand, grpc_schedule_on_exec_ctx); |
||||
grpc_closure_init(&chand->close_max_age_channel, close_max_age_channel, chand, |
||||
grpc_schedule_on_exec_ctx); |
||||
grpc_closure_init(&chand->force_close_max_age_channel, |
||||
force_close_max_age_channel, chand, |
||||
grpc_schedule_on_exec_ctx); |
||||
grpc_closure_init(&chand->start_max_idle_timer_after_init, |
||||
start_max_idle_timer_after_init, chand, |
||||
grpc_schedule_on_exec_ctx); |
||||
grpc_closure_init(&chand->start_max_age_timer_after_init, |
||||
start_max_age_timer_after_init, chand, |
||||
grpc_schedule_on_exec_ctx); |
||||
grpc_closure_init(&chand->start_max_age_grace_timer_after_goaway_op, |
||||
start_max_age_grace_timer_after_goaway_op, chand, |
||||
grpc_schedule_on_exec_ctx); |
||||
grpc_closure_init(&chand->channel_connectivity_changed, |
||||
channel_connectivity_changed, chand, |
||||
grpc_schedule_on_exec_ctx); |
||||
|
||||
if (gpr_time_cmp(chand->max_connection_age, gpr_inf_future(GPR_TIMESPAN)) != |
||||
0) { |
||||
/* When the channel reaches its max age, we send down an op with
|
||||
goaway_error set. However, we can't send down any ops until after the |
||||
channel stack is fully initialized. If we start the timer here, we have |
||||
no guarantee that the timer won't pop before channel stack initialization |
||||
is finished. To avoid that problem, we create a closure to start the |
||||
timer, and we schedule that closure to be run after call stack |
||||
initialization is done. */ |
||||
GRPC_CHANNEL_STACK_REF(chand->channel_stack, |
||||
"max_age start_max_age_timer_after_init"); |
||||
grpc_closure_sched(exec_ctx, &chand->start_max_age_timer_after_init, |
||||
GRPC_ERROR_NONE); |
||||
} |
||||
|
||||
/* Initialize the number of calls as 1, so that the max_idle_timer will not
|
||||
start until start_max_idle_timer_after_init is invoked. */ |
||||
gpr_atm_rel_store(&chand->call_count, 1); |
||||
if (gpr_time_cmp(chand->max_connection_idle, gpr_inf_future(GPR_TIMESPAN)) != |
||||
0) { |
||||
GRPC_CHANNEL_STACK_REF(chand->channel_stack, |
||||
"max_age start_max_idle_timer_after_init"); |
||||
grpc_closure_sched(exec_ctx, &chand->start_max_idle_timer_after_init, |
||||
GRPC_ERROR_NONE); |
||||
} |
||||
return GRPC_ERROR_NONE; |
||||
} |
||||
|
||||
/* Destructor for channel_data. */ |
||||
static void destroy_channel_elem(grpc_exec_ctx* exec_ctx, |
||||
grpc_channel_element* elem) {} |
||||
|
||||
const grpc_channel_filter grpc_max_age_filter = { |
||||
grpc_call_next_op, |
||||
grpc_channel_next_op, |
||||
0, /* sizeof_call_data */ |
||||
init_call_elem, |
||||
grpc_call_stack_ignore_set_pollset_or_pollset_set, |
||||
destroy_call_elem, |
||||
sizeof(channel_data), |
||||
init_channel_elem, |
||||
destroy_channel_elem, |
||||
grpc_call_next_get_peer, |
||||
grpc_channel_next_get_info, |
||||
"max_age"}; |
||||
@ -0,0 +1,39 @@ |
||||
//
|
||||
// Copyright 2017, Google Inc.
|
||||
// All rights reserved.
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without
|
||||
// modification, are permitted provided that the following conditions are
|
||||
// met:
|
||||
//
|
||||
// * Redistributions of source code must retain the above copyright
|
||||
// notice, this list of conditions and the following disclaimer.
|
||||
// * Redistributions in binary form must reproduce the above
|
||||
// copyright notice, this list of conditions and the following disclaimer
|
||||
// in the documentation and/or other materials provided with the
|
||||
// distribution.
|
||||
// * Neither the name of Google Inc. nor the names of its
|
||||
// contributors may be used to endorse or promote products derived from
|
||||
// this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
//
|
||||
|
||||
#ifndef GRPC_CORE_LIB_CHANNEL_MAX_AGE_FILTER_H |
||||
#define GRPC_CORE_LIB_CHANNEL_MAX_AGE_FILTER_H |
||||
|
||||
#include "src/core/lib/channel/channel_stack.h" |
||||
|
||||
extern const grpc_channel_filter grpc_max_age_filter; |
||||
|
||||
#endif /* GRPC_CORE_LIB_CHANNEL_MAX_AGE_FILTER_H */ |
||||
@ -0,0 +1,380 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2017, Google Inc. |
||||
* All rights reserved. |
||||
* |
||||
* Redistribution and use in source and binary forms, with or without |
||||
* modification, are permitted provided that the following conditions are |
||||
* met: |
||||
* |
||||
* * Redistributions of source code must retain the above copyright |
||||
* notice, this list of conditions and the following disclaimer. |
||||
* * Redistributions in binary form must reproduce the above |
||||
* copyright notice, this list of conditions and the following disclaimer |
||||
* in the documentation and/or other materials provided with the |
||||
* distribution. |
||||
* * Neither the name of Google Inc. nor the names of its |
||||
* contributors may be used to endorse or promote products derived from |
||||
* this software without specific prior written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
* |
||||
*/ |
||||
|
||||
#include "test/core/end2end/end2end_tests.h" |
||||
|
||||
#include <limits.h> |
||||
#include <string.h> |
||||
|
||||
#include <grpc/support/log.h> |
||||
#include <grpc/support/sync.h> |
||||
#include <grpc/support/time.h> |
||||
#include <grpc/support/useful.h> |
||||
|
||||
#include "test/core/end2end/cq_verifier.h" |
||||
|
||||
#define MAX_CONNECTION_AGE_MS 500 |
||||
#define MAX_CONNECTION_AGE_GRACE_MS 1000 |
||||
#define MAX_CONNECTION_IDLE_MS 9999 |
||||
|
||||
#define CALL_DEADLINE_S 10 |
||||
/* The amount of time we wait for the connection to time out, but after it the
|
||||
connection should not use up its grace period. It should be a number between |
||||
MAX_CONNECTION_AGE_MS and MAX_CONNECTION_AGE_MS + |
||||
MAX_CONNECTION_AGE_GRACE_MS */ |
||||
#define CQ_MAX_CONNECTION_AGE_WAIT_TIME_S 1 |
||||
/* The amount of time we wait after the connection reaches its max age, it
|
||||
should be shorter than CALL_DEADLINE_S - CQ_MAX_CONNECTION_AGE_WAIT_TIME_S */ |
||||
#define CQ_MAX_CONNECTION_AGE_GRACE_WAIT_TIME_S 2 |
||||
/* The grace period for the test to observe the channel shutdown process */ |
||||
#define IMMEDIATE_SHUTDOWN_GRACE_TIME_MS 300 |
||||
|
||||
static void *tag(intptr_t t) { return (void *)t; } |
||||
|
||||
static void drain_cq(grpc_completion_queue *cq) { |
||||
grpc_event ev; |
||||
do { |
||||
ev = grpc_completion_queue_next(cq, grpc_timeout_seconds_to_deadline(5), |
||||
NULL); |
||||
} while (ev.type != GRPC_QUEUE_SHUTDOWN); |
||||
} |
||||
|
||||
static void shutdown_server(grpc_end2end_test_fixture *f) { |
||||
if (!f->server) return; |
||||
grpc_server_destroy(f->server); |
||||
f->server = NULL; |
||||
} |
||||
|
||||
static void shutdown_client(grpc_end2end_test_fixture *f) { |
||||
if (!f->client) return; |
||||
grpc_channel_destroy(f->client); |
||||
f->client = NULL; |
||||
} |
||||
|
||||
static void end_test(grpc_end2end_test_fixture *f) { |
||||
shutdown_server(f); |
||||
shutdown_client(f); |
||||
|
||||
grpc_completion_queue_shutdown(f->cq); |
||||
drain_cq(f->cq); |
||||
grpc_completion_queue_destroy(f->cq); |
||||
} |
||||
|
||||
static void test_max_age_forcibly_close(grpc_end2end_test_config config) { |
||||
grpc_end2end_test_fixture f = config.create_fixture(NULL, NULL); |
||||
cq_verifier *cqv = cq_verifier_create(f.cq); |
||||
grpc_arg server_a[] = {{.type = GRPC_ARG_INTEGER, |
||||
.key = GRPC_ARG_MAX_CONNECTION_AGE_MS, |
||||
.value.integer = MAX_CONNECTION_AGE_MS}, |
||||
{.type = GRPC_ARG_INTEGER, |
||||
.key = GRPC_ARG_MAX_CONNECTION_AGE_GRACE_MS, |
||||
.value.integer = MAX_CONNECTION_AGE_GRACE_MS}, |
||||
{.type = GRPC_ARG_INTEGER, |
||||
.key = GRPC_ARG_MAX_CONNECTION_IDLE_MS, |
||||
.value.integer = MAX_CONNECTION_IDLE_MS}}; |
||||
grpc_channel_args server_args = {.num_args = GPR_ARRAY_SIZE(server_a), |
||||
.args = server_a}; |
||||
|
||||
config.init_client(&f, NULL); |
||||
config.init_server(&f, &server_args); |
||||
|
||||
grpc_call *c; |
||||
grpc_call *s; |
||||
gpr_timespec deadline = grpc_timeout_seconds_to_deadline(CALL_DEADLINE_S); |
||||
grpc_op ops[6]; |
||||
grpc_op *op; |
||||
grpc_metadata_array initial_metadata_recv; |
||||
grpc_metadata_array trailing_metadata_recv; |
||||
grpc_metadata_array request_metadata_recv; |
||||
grpc_call_details call_details; |
||||
grpc_status_code status; |
||||
grpc_call_error error; |
||||
grpc_slice details; |
||||
int was_cancelled = 2; |
||||
|
||||
c = grpc_channel_create_call( |
||||
f.client, NULL, GRPC_PROPAGATE_DEFAULTS, f.cq, |
||||
grpc_slice_from_static_string("/foo"), |
||||
get_host_override_slice("foo.test.google.fr:1234", config), deadline, |
||||
NULL); |
||||
GPR_ASSERT(c); |
||||
|
||||
grpc_metadata_array_init(&initial_metadata_recv); |
||||
grpc_metadata_array_init(&trailing_metadata_recv); |
||||
grpc_metadata_array_init(&request_metadata_recv); |
||||
grpc_call_details_init(&call_details); |
||||
|
||||
memset(ops, 0, sizeof(ops)); |
||||
op = ops; |
||||
op->op = GRPC_OP_SEND_INITIAL_METADATA; |
||||
op->data.send_initial_metadata.count = 0; |
||||
op->data.send_initial_metadata.metadata = NULL; |
||||
op->flags = 0; |
||||
op->reserved = NULL; |
||||
op++; |
||||
op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT; |
||||
op->flags = 0; |
||||
op->reserved = NULL; |
||||
op++; |
||||
op->op = GRPC_OP_RECV_INITIAL_METADATA; |
||||
op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv; |
||||
op->flags = 0; |
||||
op->reserved = NULL; |
||||
op++; |
||||
op->op = GRPC_OP_RECV_STATUS_ON_CLIENT; |
||||
op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv; |
||||
op->data.recv_status_on_client.status = &status; |
||||
op->data.recv_status_on_client.status_details = &details; |
||||
op->flags = 0; |
||||
op->reserved = NULL; |
||||
op++; |
||||
error = grpc_call_start_batch(c, ops, (size_t)(op - ops), tag(1), NULL); |
||||
GPR_ASSERT(GRPC_CALL_OK == error); |
||||
|
||||
error = |
||||
grpc_server_request_call(f.server, &s, &call_details, |
||||
&request_metadata_recv, f.cq, f.cq, tag(101)); |
||||
GPR_ASSERT(GRPC_CALL_OK == error); |
||||
CQ_EXPECT_COMPLETION(cqv, tag(101), true); |
||||
cq_verify(cqv); |
||||
|
||||
gpr_timespec expect_shutdown_time = grpc_timeout_milliseconds_to_deadline( |
||||
MAX_CONNECTION_AGE_MS + MAX_CONNECTION_AGE_GRACE_MS + |
||||
IMMEDIATE_SHUTDOWN_GRACE_TIME_MS); |
||||
|
||||
/* Wait for the channel to reach its max age */ |
||||
cq_verify_empty_timeout(cqv, CQ_MAX_CONNECTION_AGE_WAIT_TIME_S); |
||||
|
||||
/* After the channel reaches its max age, we still do nothing here. And wait
|
||||
for it to use up its max age grace period. */ |
||||
CQ_EXPECT_COMPLETION(cqv, tag(1), true); |
||||
cq_verify(cqv); |
||||
|
||||
gpr_timespec channel_shutdown_time = gpr_now(GPR_CLOCK_MONOTONIC); |
||||
GPR_ASSERT(gpr_time_cmp(channel_shutdown_time, expect_shutdown_time) < 0); |
||||
|
||||
memset(ops, 0, sizeof(ops)); |
||||
op = ops; |
||||
op->op = GRPC_OP_SEND_INITIAL_METADATA; |
||||
op->data.send_initial_metadata.count = 0; |
||||
op->flags = 0; |
||||
op->reserved = NULL; |
||||
op++; |
||||
op->op = GRPC_OP_SEND_STATUS_FROM_SERVER; |
||||
op->data.send_status_from_server.trailing_metadata_count = 0; |
||||
op->data.send_status_from_server.status = GRPC_STATUS_UNIMPLEMENTED; |
||||
grpc_slice status_details = grpc_slice_from_static_string("xyz"); |
||||
op->data.send_status_from_server.status_details = &status_details; |
||||
op->flags = 0; |
||||
op->reserved = NULL; |
||||
op++; |
||||
op->op = GRPC_OP_RECV_CLOSE_ON_SERVER; |
||||
op->data.recv_close_on_server.cancelled = &was_cancelled; |
||||
op->flags = 0; |
||||
op->reserved = NULL; |
||||
op++; |
||||
error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(102), NULL); |
||||
GPR_ASSERT(GRPC_CALL_OK == error); |
||||
CQ_EXPECT_COMPLETION(cqv, tag(102), true); |
||||
cq_verify(cqv); |
||||
|
||||
grpc_server_shutdown_and_notify(f.server, f.cq, tag(0xdead)); |
||||
CQ_EXPECT_COMPLETION(cqv, tag(0xdead), true); |
||||
cq_verify(cqv); |
||||
|
||||
grpc_call_destroy(s); |
||||
|
||||
/* The connection should be closed immediately after the max age grace period,
|
||||
the in-progress RPC should fail. */ |
||||
GPR_ASSERT(status == GRPC_STATUS_UNAVAILABLE); |
||||
GPR_ASSERT(0 == grpc_slice_str_cmp(details, "Endpoint read failed")); |
||||
GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo")); |
||||
validate_host_override_string("foo.test.google.fr:1234", call_details.host, |
||||
config); |
||||
GPR_ASSERT(was_cancelled == 1); |
||||
|
||||
grpc_slice_unref(details); |
||||
grpc_metadata_array_destroy(&initial_metadata_recv); |
||||
grpc_metadata_array_destroy(&trailing_metadata_recv); |
||||
grpc_metadata_array_destroy(&request_metadata_recv); |
||||
grpc_call_details_destroy(&call_details); |
||||
grpc_call_destroy(c); |
||||
cq_verifier_destroy(cqv); |
||||
end_test(&f); |
||||
config.tear_down_data(&f); |
||||
} |
||||
|
||||
static void test_max_age_gracefully_close(grpc_end2end_test_config config) { |
||||
grpc_end2end_test_fixture f = config.create_fixture(NULL, NULL); |
||||
cq_verifier *cqv = cq_verifier_create(f.cq); |
||||
grpc_arg server_a[] = {{.type = GRPC_ARG_INTEGER, |
||||
.key = GRPC_ARG_MAX_CONNECTION_AGE_MS, |
||||
.value.integer = MAX_CONNECTION_AGE_MS}, |
||||
{.type = GRPC_ARG_INTEGER, |
||||
.key = GRPC_ARG_MAX_CONNECTION_AGE_GRACE_MS, |
||||
.value.integer = INT_MAX}, |
||||
{.type = GRPC_ARG_INTEGER, |
||||
.key = GRPC_ARG_MAX_CONNECTION_IDLE_MS, |
||||
.value.integer = MAX_CONNECTION_IDLE_MS}}; |
||||
grpc_channel_args server_args = {.num_args = GPR_ARRAY_SIZE(server_a), |
||||
.args = server_a}; |
||||
|
||||
config.init_client(&f, NULL); |
||||
config.init_server(&f, &server_args); |
||||
|
||||
grpc_call *c; |
||||
grpc_call *s; |
||||
gpr_timespec deadline = grpc_timeout_seconds_to_deadline(CALL_DEADLINE_S); |
||||
grpc_op ops[6]; |
||||
grpc_op *op; |
||||
grpc_metadata_array initial_metadata_recv; |
||||
grpc_metadata_array trailing_metadata_recv; |
||||
grpc_metadata_array request_metadata_recv; |
||||
grpc_call_details call_details; |
||||
grpc_status_code status; |
||||
grpc_call_error error; |
||||
grpc_slice details; |
||||
int was_cancelled = 2; |
||||
|
||||
c = grpc_channel_create_call( |
||||
f.client, NULL, GRPC_PROPAGATE_DEFAULTS, f.cq, |
||||
grpc_slice_from_static_string("/foo"), |
||||
get_host_override_slice("foo.test.google.fr:1234", config), deadline, |
||||
NULL); |
||||
GPR_ASSERT(c); |
||||
|
||||
grpc_metadata_array_init(&initial_metadata_recv); |
||||
grpc_metadata_array_init(&trailing_metadata_recv); |
||||
grpc_metadata_array_init(&request_metadata_recv); |
||||
grpc_call_details_init(&call_details); |
||||
|
||||
memset(ops, 0, sizeof(ops)); |
||||
op = ops; |
||||
op->op = GRPC_OP_SEND_INITIAL_METADATA; |
||||
op->data.send_initial_metadata.count = 0; |
||||
op->data.send_initial_metadata.metadata = NULL; |
||||
op->flags = 0; |
||||
op->reserved = NULL; |
||||
op++; |
||||
op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT; |
||||
op->flags = 0; |
||||
op->reserved = NULL; |
||||
op++; |
||||
op->op = GRPC_OP_RECV_INITIAL_METADATA; |
||||
op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv; |
||||
op->flags = 0; |
||||
op->reserved = NULL; |
||||
op++; |
||||
op->op = GRPC_OP_RECV_STATUS_ON_CLIENT; |
||||
op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv; |
||||
op->data.recv_status_on_client.status = &status; |
||||
op->data.recv_status_on_client.status_details = &details; |
||||
op->flags = 0; |
||||
op->reserved = NULL; |
||||
op++; |
||||
error = grpc_call_start_batch(c, ops, (size_t)(op - ops), tag(1), NULL); |
||||
GPR_ASSERT(GRPC_CALL_OK == error); |
||||
|
||||
error = |
||||
grpc_server_request_call(f.server, &s, &call_details, |
||||
&request_metadata_recv, f.cq, f.cq, tag(101)); |
||||
GPR_ASSERT(GRPC_CALL_OK == error); |
||||
CQ_EXPECT_COMPLETION(cqv, tag(101), true); |
||||
cq_verify(cqv); |
||||
|
||||
/* Wait for the channel to reach its max age */ |
||||
cq_verify_empty_timeout(cqv, CQ_MAX_CONNECTION_AGE_WAIT_TIME_S); |
||||
|
||||
/* The connection is shutting down gracefully. In-progress rpc should not be
|
||||
closed, hence the completion queue should see nothing here. */ |
||||
cq_verify_empty_timeout(cqv, CQ_MAX_CONNECTION_AGE_GRACE_WAIT_TIME_S); |
||||
|
||||
memset(ops, 0, sizeof(ops)); |
||||
op = ops; |
||||
op->op = GRPC_OP_SEND_INITIAL_METADATA; |
||||
op->data.send_initial_metadata.count = 0; |
||||
op->flags = 0; |
||||
op->reserved = NULL; |
||||
op++; |
||||
op->op = GRPC_OP_SEND_STATUS_FROM_SERVER; |
||||
op->data.send_status_from_server.trailing_metadata_count = 0; |
||||
op->data.send_status_from_server.status = GRPC_STATUS_UNIMPLEMENTED; |
||||
grpc_slice status_details = grpc_slice_from_static_string("xyz"); |
||||
op->data.send_status_from_server.status_details = &status_details; |
||||
op->flags = 0; |
||||
op->reserved = NULL; |
||||
op++; |
||||
op->op = GRPC_OP_RECV_CLOSE_ON_SERVER; |
||||
op->data.recv_close_on_server.cancelled = &was_cancelled; |
||||
op->flags = 0; |
||||
op->reserved = NULL; |
||||
op++; |
||||
error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(102), NULL); |
||||
GPR_ASSERT(GRPC_CALL_OK == error); |
||||
|
||||
CQ_EXPECT_COMPLETION(cqv, tag(102), true); |
||||
CQ_EXPECT_COMPLETION(cqv, tag(1), true); |
||||
cq_verify(cqv); |
||||
|
||||
grpc_server_shutdown_and_notify(f.server, f.cq, tag(0xdead)); |
||||
CQ_EXPECT_COMPLETION(cqv, tag(0xdead), true); |
||||
cq_verify(cqv); |
||||
|
||||
grpc_call_destroy(s); |
||||
|
||||
/* The connection is closed gracefully with goaway, the rpc should still be
|
||||
completed. */ |
||||
GPR_ASSERT(status == GRPC_STATUS_UNIMPLEMENTED); |
||||
GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz")); |
||||
GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo")); |
||||
validate_host_override_string("foo.test.google.fr:1234", call_details.host, |
||||
config); |
||||
GPR_ASSERT(was_cancelled == 1); |
||||
|
||||
grpc_slice_unref(details); |
||||
grpc_metadata_array_destroy(&initial_metadata_recv); |
||||
grpc_metadata_array_destroy(&trailing_metadata_recv); |
||||
grpc_metadata_array_destroy(&request_metadata_recv); |
||||
grpc_call_details_destroy(&call_details); |
||||
grpc_call_destroy(c); |
||||
cq_verifier_destroy(cqv); |
||||
end_test(&f); |
||||
config.tear_down_data(&f); |
||||
} |
||||
|
||||
void max_connection_age(grpc_end2end_test_config config) { |
||||
test_max_age_forcibly_close(config); |
||||
test_max_age_gracefully_close(config); |
||||
} |
||||
|
||||
void max_connection_age_pre_init(void) {} |
||||
@ -0,0 +1,117 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2017, Google Inc. |
||||
* All rights reserved. |
||||
* |
||||
* Redistribution and use in source and binary forms, with or without |
||||
* modification, are permitted provided that the following conditions are |
||||
* met: |
||||
* |
||||
* * Redistributions of source code must retain the above copyright |
||||
* notice, this list of conditions and the following disclaimer. |
||||
* * Redistributions in binary form must reproduce the above |
||||
* copyright notice, this list of conditions and the following disclaimer |
||||
* in the documentation and/or other materials provided with the |
||||
* distribution. |
||||
* * Neither the name of Google Inc. nor the names of its |
||||
* contributors may be used to endorse or promote products derived from |
||||
* this software without specific prior written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
* |
||||
*/ |
||||
|
||||
#include "test/core/end2end/end2end_tests.h" |
||||
|
||||
#include <limits.h> |
||||
#include <string.h> |
||||
|
||||
#include <grpc/support/log.h> |
||||
#include <grpc/support/sync.h> |
||||
#include <grpc/support/time.h> |
||||
#include <grpc/support/useful.h> |
||||
|
||||
#include "test/core/end2end/cq_verifier.h" |
||||
|
||||
#define MAX_CONNECTION_IDLE_MS 500 |
||||
#define MAX_CONNECTION_AGE_MS 9999 |
||||
|
||||
static void *tag(intptr_t t) { return (void *)t; } |
||||
|
||||
static void test_max_connection_idle(grpc_end2end_test_config config) { |
||||
grpc_end2end_test_fixture f = config.create_fixture(NULL, NULL); |
||||
grpc_connectivity_state state = GRPC_CHANNEL_IDLE; |
||||
cq_verifier *cqv = cq_verifier_create(f.cq); |
||||
|
||||
grpc_arg client_a[] = {{.type = GRPC_ARG_INTEGER, |
||||
.key = "grpc.testing.fixed_reconnect_backoff_ms", |
||||
.value.integer = 1000}}; |
||||
grpc_arg server_a[] = {{.type = GRPC_ARG_INTEGER, |
||||
.key = GRPC_ARG_MAX_CONNECTION_IDLE_MS, |
||||
.value.integer = MAX_CONNECTION_IDLE_MS}, |
||||
{.type = GRPC_ARG_INTEGER, |
||||
.key = GRPC_ARG_MAX_CONNECTION_AGE_MS, |
||||
.value.integer = MAX_CONNECTION_AGE_MS}}; |
||||
grpc_channel_args client_args = {.num_args = GPR_ARRAY_SIZE(client_a), |
||||
.args = client_a}; |
||||
grpc_channel_args server_args = {.num_args = GPR_ARRAY_SIZE(server_a), |
||||
.args = server_a}; |
||||
|
||||
config.init_client(&f, &client_args); |
||||
config.init_server(&f, &server_args); |
||||
|
||||
/* check that we're still in idle, and start connecting */ |
||||
GPR_ASSERT(grpc_channel_check_connectivity_state(f.client, 1) == |
||||
GRPC_CHANNEL_IDLE); |
||||
/* we'll go through some set of transitions (some might be missed), until
|
||||
READY is reached */ |
||||
while (state != GRPC_CHANNEL_READY) { |
||||
grpc_channel_watch_connectivity_state( |
||||
f.client, state, grpc_timeout_seconds_to_deadline(3), f.cq, tag(99)); |
||||
CQ_EXPECT_COMPLETION(cqv, tag(99), 1); |
||||
cq_verify(cqv); |
||||
state = grpc_channel_check_connectivity_state(f.client, 0); |
||||
GPR_ASSERT(state == GRPC_CHANNEL_READY || |
||||
state == GRPC_CHANNEL_CONNECTING || |
||||
state == GRPC_CHANNEL_TRANSIENT_FAILURE); |
||||
} |
||||
|
||||
/* wait for the channel to reach its maximum idle time */ |
||||
grpc_channel_watch_connectivity_state( |
||||
f.client, GRPC_CHANNEL_READY, |
||||
grpc_timeout_milliseconds_to_deadline(MAX_CONNECTION_IDLE_MS + 500), f.cq, |
||||
tag(99)); |
||||
CQ_EXPECT_COMPLETION(cqv, tag(99), 1); |
||||
cq_verify(cqv); |
||||
state = grpc_channel_check_connectivity_state(f.client, 0); |
||||
GPR_ASSERT(state == GRPC_CHANNEL_TRANSIENT_FAILURE || |
||||
state == GRPC_CHANNEL_CONNECTING || state == GRPC_CHANNEL_IDLE); |
||||
|
||||
grpc_server_shutdown_and_notify(f.server, f.cq, tag(0xdead)); |
||||
CQ_EXPECT_COMPLETION(cqv, tag(0xdead), 1); |
||||
cq_verify(cqv); |
||||
|
||||
grpc_server_destroy(f.server); |
||||
grpc_channel_destroy(f.client); |
||||
grpc_completion_queue_shutdown(f.cq); |
||||
grpc_completion_queue_destroy(f.cq); |
||||
config.tear_down_data(&f); |
||||
|
||||
cq_verifier_destroy(cqv); |
||||
} |
||||
|
||||
void max_connection_idle(grpc_end2end_test_config config) { |
||||
test_max_connection_idle(config); |
||||
} |
||||
|
||||
void max_connection_idle_pre_init(void) {} |
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,106 @@ |
||||
# Overview of performance test suite, with steps for manual runs: |
||||
|
||||
For design of the tests, see |
||||
http://www.grpc.io/docs/guides/benchmarking.html. |
||||
|
||||
## Pre-reqs for running these manually: |
||||
In general the benchmark workers and driver build scripts expect |
||||
[linux_performance_worker_init.sh](../../gce/linux_performance_worker_init.sh) to have been ran already. |
||||
|
||||
### To run benchmarks locally: |
||||
* From the grpc repo root, start the |
||||
[run_performance_tests.py](../run_performance_tests.py) runner script. |
||||
|
||||
### On remote machines, to start the driver and workers manually: |
||||
The [run_performance_test.py](../run_performance_tests.py) top-level runner script can also |
||||
be used with remote machines, but for e.g., profiling the server, |
||||
it might be useful to run workers manually. |
||||
|
||||
1. You'll need a "driver" and separate "worker" machines. |
||||
For example, you might use one GCE "driver" machine and 3 other |
||||
GCE "worker" machines that are in the same zone. |
||||
|
||||
2. Connect to each worker machine and start up a benchmark worker with a "driver_port". |
||||
* For example, to start the grpc-go benchmark worker: |
||||
[grpc-go worker main.go](https://github.com/grpc/grpc-go/blob/master/benchmark/worker/main.go) --driver_port <driver_port> |
||||
|
||||
#### Comands to start workers in different languages: |
||||
* Note that these commands are what the top-level |
||||
[run_performance_test.py](../run_performance_tests.py) script uses to |
||||
build and run different workers through the |
||||
[build_performance.sh](./build_performance.sh) script and "run worker" |
||||
scripts (such as the [run_worker_java.sh](./run_worker_java.sh)). |
||||
|
||||
##### Running benchmark workers for C-core wrapped languages (C++, Python, C#, Node, Ruby): |
||||
* These are more simple since they all live in the main grpc repo. |
||||
|
||||
``` |
||||
$ cd <grpc_repo_root> |
||||
$ tools/run_tests/performance/build_performance.sh |
||||
$ tools/run_tests/performance/run_worker_<language>.sh |
||||
``` |
||||
|
||||
* Note that there is one "run_worker" script per language, e.g., |
||||
[run_worker_csharp.sh](./run_worker_csharp.sh) for c#. |
||||
|
||||
##### Running benchmark workers for gRPC-Java: |
||||
* You'll need the [grpc-java](https://github.com/grpc/grpc-java) repo. |
||||
|
||||
``` |
||||
$ cd <grpc-java-repo> |
||||
$ ./gradlew -PskipCodegen=true :grpc-benchmarks:installDist |
||||
$ benchmarks/build/install/grpc-benchmarks/bin/benchmark_worker --driver_port <driver_port> |
||||
``` |
||||
|
||||
##### Running benchmark workers for gRPC-Go: |
||||
* You'll need the [grpc-go repo](https://github.com/grpc/grpc-go) |
||||
|
||||
``` |
||||
$ cd <grpc-go-repo>/benchmark/worker && go install |
||||
$ # if profiling, it might be helpful to turn off inlining by building with "-gcflags=-l" |
||||
$ $GOPATH/bin/worker --driver_port <driver_port> |
||||
``` |
||||
|
||||
#### Build the driver: |
||||
* Connect to the driver machine (if using a remote driver) and from the grpc repo root: |
||||
``` |
||||
$ tools/run_tests/performance/build_performance.sh |
||||
``` |
||||
|
||||
#### Run the driver: |
||||
1. Get the 'scenario_json' relevant for the scenario to run. Note that "scenario |
||||
json" configs are generated from [scenario_config.py](./scenario_config.py). |
||||
The [driver](../../../test/cpp/qps/qps_json_driver.cc) takes a list of these configs as a json string of the form: `{scenario: <json_list_of_scenarios> }` |
||||
in its `--scenarios_json` command argument. |
||||
One quick way to get a valid json string to pass to the driver is by running |
||||
the [run_performance_tests.py](./run_performance_tests.py) locally and copying the logged scenario json command arg. |
||||
|
||||
2. From the grpc repo root: |
||||
|
||||
* Set `QPS_WORKERS` environment variable to a comma separated list of worker |
||||
machines. Note that the driver will start the "benchmark server" on the first |
||||
entry in the list, and the rest will be told to run as clients against the |
||||
benchmark server. |
||||
|
||||
Example running and profiling of go benchmark server: |
||||
``` |
||||
$ export QPS_WORKERS=<host1>:<10000>,<host2>,10000,<host3>:10000 |
||||
$ bins/opt/qps_json_driver --scenario_json='<scenario_json_scenario_config_string>' |
||||
``` |
||||
|
||||
### Example profiling commands |
||||
|
||||
While running the benchmark, a profiler can be attached to the server. |
||||
|
||||
Example to count syscalls in grpc-go server during a benchmark: |
||||
* Connect to server machine and run: |
||||
``` |
||||
$ netstat -tulpn | grep <driver_port> # to get pid of worker |
||||
$ perf stat -p <worker_pid> -e syscalls:sys_enter_write # stop after test complete |
||||
``` |
||||
|
||||
Example memory profile of grpc-go server, with `go tools pprof`: |
||||
* After a run is done on the server, see its alloc profile with: |
||||
``` |
||||
$ go tool pprof --text --alloc_space http://localhost:<pprof_port>/debug/heap |
||||
``` |
||||
Loading…
Reference in new issue