mirror of https://github.com/grpc/grpc.git
Sree Kuchibhotla
8 years ago
commit
1e088b4219
179 changed files with 5968 additions and 702 deletions
@ -0,0 +1,70 @@ |
|||||||
|
/*
|
||||||
|
* |
||||||
|
* Copyright 2016, 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 GRPCXX_RESOURCE_QUOTA_H |
||||||
|
#define GRPCXX_RESOURCE_QUOTA_H |
||||||
|
|
||||||
|
struct grpc_resource_quota; |
||||||
|
|
||||||
|
#include <grpc++/impl/codegen/config.h> |
||||||
|
|
||||||
|
namespace grpc { |
||||||
|
|
||||||
|
/// ResourceQuota represents a bound on memory usage by the gRPC library.
|
||||||
|
/// A ResourceQuota can be attached to a server (via ServerBuilder), or a client
|
||||||
|
/// channel (via ChannelArguments). gRPC will attempt to keep memory used by
|
||||||
|
/// all attached entities below the ResourceQuota bound.
|
||||||
|
class ResourceQuota GRPC_FINAL { |
||||||
|
public: |
||||||
|
explicit ResourceQuota(const grpc::string& name); |
||||||
|
ResourceQuota(); |
||||||
|
~ResourceQuota(); |
||||||
|
|
||||||
|
/// Resize this ResourceQuota to a new size. If new_size is smaller than the
|
||||||
|
/// current size of the pool, memory usage will be monotonically decreased
|
||||||
|
/// until it falls under new_size. No time bound is given for this to occur
|
||||||
|
/// however.
|
||||||
|
ResourceQuota& Resize(size_t new_size); |
||||||
|
|
||||||
|
grpc_resource_quota* c_resource_quota() const { return impl_; } |
||||||
|
|
||||||
|
private: |
||||||
|
ResourceQuota(const ResourceQuota& rhs); |
||||||
|
ResourceQuota& operator=(const ResourceQuota& rhs); |
||||||
|
|
||||||
|
grpc_resource_quota* const impl_; |
||||||
|
}; |
||||||
|
|
||||||
|
} // namespace grpc
|
||||||
|
|
||||||
|
#endif // GRPCXX_RESOURCE_QUOTA_H
|
||||||
@ -0,0 +1,714 @@ |
|||||||
|
/*
|
||||||
|
* |
||||||
|
* Copyright 2016, 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/iomgr/resource_quota.h" |
||||||
|
|
||||||
|
#include <string.h> |
||||||
|
|
||||||
|
#include <grpc/support/alloc.h> |
||||||
|
#include <grpc/support/log.h> |
||||||
|
#include <grpc/support/string_util.h> |
||||||
|
#include <grpc/support/useful.h> |
||||||
|
|
||||||
|
#include "src/core/lib/iomgr/combiner.h" |
||||||
|
|
||||||
|
int grpc_resource_quota_trace = 0; |
||||||
|
|
||||||
|
struct grpc_resource_quota { |
||||||
|
/* refcount */ |
||||||
|
gpr_refcount refs; |
||||||
|
|
||||||
|
/* Master combiner lock: all activity on a quota executes under this combiner
|
||||||
|
* (so no mutex is needed for this data structure) |
||||||
|
*/ |
||||||
|
grpc_combiner *combiner; |
||||||
|
/* Size of the resource quota */ |
||||||
|
int64_t size; |
||||||
|
/* Amount of free memory in the resource quota */ |
||||||
|
int64_t free_pool; |
||||||
|
|
||||||
|
/* Has rq_step been scheduled to occur? */ |
||||||
|
bool step_scheduled; |
||||||
|
/* Are we currently reclaiming memory */ |
||||||
|
bool reclaiming; |
||||||
|
/* Closure around rq_step */ |
||||||
|
grpc_closure rq_step_closure; |
||||||
|
/* Closure around rq_reclamation_done */ |
||||||
|
grpc_closure rq_reclamation_done_closure; |
||||||
|
|
||||||
|
/* Roots of all resource user lists */ |
||||||
|
grpc_resource_user *roots[GRPC_RULIST_COUNT]; |
||||||
|
|
||||||
|
char *name; |
||||||
|
}; |
||||||
|
|
||||||
|
/*******************************************************************************
|
||||||
|
* list management |
||||||
|
*/ |
||||||
|
|
||||||
|
static void rulist_add_head(grpc_resource_user *resource_user, |
||||||
|
grpc_rulist list) { |
||||||
|
grpc_resource_quota *resource_quota = resource_user->resource_quota; |
||||||
|
grpc_resource_user **root = &resource_quota->roots[list]; |
||||||
|
if (*root == NULL) { |
||||||
|
*root = resource_user; |
||||||
|
resource_user->links[list].next = resource_user->links[list].prev = |
||||||
|
resource_user; |
||||||
|
} else { |
||||||
|
resource_user->links[list].next = *root; |
||||||
|
resource_user->links[list].prev = (*root)->links[list].prev; |
||||||
|
resource_user->links[list].next->links[list].prev = |
||||||
|
resource_user->links[list].prev->links[list].next = resource_user; |
||||||
|
*root = resource_user; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
static void rulist_add_tail(grpc_resource_user *resource_user, |
||||||
|
grpc_rulist list) { |
||||||
|
grpc_resource_quota *resource_quota = resource_user->resource_quota; |
||||||
|
grpc_resource_user **root = &resource_quota->roots[list]; |
||||||
|
if (*root == NULL) { |
||||||
|
*root = resource_user; |
||||||
|
resource_user->links[list].next = resource_user->links[list].prev = |
||||||
|
resource_user; |
||||||
|
} else { |
||||||
|
resource_user->links[list].next = (*root)->links[list].next; |
||||||
|
resource_user->links[list].prev = *root; |
||||||
|
resource_user->links[list].next->links[list].prev = |
||||||
|
resource_user->links[list].prev->links[list].next = resource_user; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
static bool rulist_empty(grpc_resource_quota *resource_quota, |
||||||
|
grpc_rulist list) { |
||||||
|
return resource_quota->roots[list] == NULL; |
||||||
|
} |
||||||
|
|
||||||
|
static grpc_resource_user *rulist_pop_head(grpc_resource_quota *resource_quota, |
||||||
|
grpc_rulist list) { |
||||||
|
grpc_resource_user **root = &resource_quota->roots[list]; |
||||||
|
grpc_resource_user *resource_user = *root; |
||||||
|
if (resource_user == NULL) { |
||||||
|
return NULL; |
||||||
|
} |
||||||
|
if (resource_user->links[list].next == resource_user) { |
||||||
|
*root = NULL; |
||||||
|
} else { |
||||||
|
resource_user->links[list].next->links[list].prev = |
||||||
|
resource_user->links[list].prev; |
||||||
|
resource_user->links[list].prev->links[list].next = |
||||||
|
resource_user->links[list].next; |
||||||
|
*root = resource_user->links[list].next; |
||||||
|
} |
||||||
|
resource_user->links[list].next = resource_user->links[list].prev = NULL; |
||||||
|
return resource_user; |
||||||
|
} |
||||||
|
|
||||||
|
static void rulist_remove(grpc_resource_user *resource_user, grpc_rulist list) { |
||||||
|
if (resource_user->links[list].next == NULL) return; |
||||||
|
grpc_resource_quota *resource_quota = resource_user->resource_quota; |
||||||
|
if (resource_quota->roots[list] == resource_user) { |
||||||
|
resource_quota->roots[list] = resource_user->links[list].next; |
||||||
|
if (resource_quota->roots[list] == resource_user) { |
||||||
|
resource_quota->roots[list] = NULL; |
||||||
|
} |
||||||
|
} |
||||||
|
resource_user->links[list].next->links[list].prev = |
||||||
|
resource_user->links[list].prev; |
||||||
|
resource_user->links[list].prev->links[list].next = |
||||||
|
resource_user->links[list].next; |
||||||
|
} |
||||||
|
|
||||||
|
/*******************************************************************************
|
||||||
|
* resource quota state machine |
||||||
|
*/ |
||||||
|
|
||||||
|
static bool rq_alloc(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_quota *resource_quota); |
||||||
|
static bool rq_reclaim_from_per_user_free_pool( |
||||||
|
grpc_exec_ctx *exec_ctx, grpc_resource_quota *resource_quota); |
||||||
|
static bool rq_reclaim(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_quota *resource_quota, bool destructive); |
||||||
|
|
||||||
|
static void rq_step(grpc_exec_ctx *exec_ctx, void *rq, grpc_error *error) { |
||||||
|
grpc_resource_quota *resource_quota = rq; |
||||||
|
resource_quota->step_scheduled = false; |
||||||
|
do { |
||||||
|
if (rq_alloc(exec_ctx, resource_quota)) goto done; |
||||||
|
} while (rq_reclaim_from_per_user_free_pool(exec_ctx, resource_quota)); |
||||||
|
rq_reclaim(exec_ctx, resource_quota, false) || |
||||||
|
rq_reclaim(exec_ctx, resource_quota, true); |
||||||
|
done: |
||||||
|
grpc_resource_quota_internal_unref(exec_ctx, resource_quota); |
||||||
|
} |
||||||
|
|
||||||
|
static void rq_step_sched(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_quota *resource_quota) { |
||||||
|
if (resource_quota->step_scheduled) return; |
||||||
|
resource_quota->step_scheduled = true; |
||||||
|
grpc_resource_quota_internal_ref(resource_quota); |
||||||
|
grpc_combiner_execute_finally(exec_ctx, resource_quota->combiner, |
||||||
|
&resource_quota->rq_step_closure, |
||||||
|
GRPC_ERROR_NONE, false); |
||||||
|
} |
||||||
|
|
||||||
|
/* returns true if all allocations are completed */ |
||||||
|
static bool rq_alloc(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_quota *resource_quota) { |
||||||
|
grpc_resource_user *resource_user; |
||||||
|
while ((resource_user = rulist_pop_head(resource_quota, |
||||||
|
GRPC_RULIST_AWAITING_ALLOCATION))) { |
||||||
|
gpr_mu_lock(&resource_user->mu); |
||||||
|
if (resource_user->free_pool < 0 && |
||||||
|
-resource_user->free_pool <= resource_quota->free_pool) { |
||||||
|
int64_t amt = -resource_user->free_pool; |
||||||
|
resource_user->free_pool = 0; |
||||||
|
resource_quota->free_pool -= amt; |
||||||
|
if (grpc_resource_quota_trace) { |
||||||
|
gpr_log(GPR_DEBUG, "RQ %s %s: grant alloc %" PRId64 |
||||||
|
" bytes; rq_free_pool -> %" PRId64, |
||||||
|
resource_quota->name, resource_user->name, amt, |
||||||
|
resource_quota->free_pool); |
||||||
|
} |
||||||
|
} else if (grpc_resource_quota_trace && resource_user->free_pool >= 0) { |
||||||
|
gpr_log(GPR_DEBUG, "RQ %s %s: discard already satisfied alloc request", |
||||||
|
resource_quota->name, resource_user->name); |
||||||
|
} |
||||||
|
if (resource_user->free_pool >= 0) { |
||||||
|
resource_user->allocating = false; |
||||||
|
grpc_exec_ctx_enqueue_list(exec_ctx, &resource_user->on_allocated, NULL); |
||||||
|
gpr_mu_unlock(&resource_user->mu); |
||||||
|
} else { |
||||||
|
rulist_add_head(resource_user, GRPC_RULIST_AWAITING_ALLOCATION); |
||||||
|
gpr_mu_unlock(&resource_user->mu); |
||||||
|
return false; |
||||||
|
} |
||||||
|
} |
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
/* returns true if any memory could be reclaimed from buffers */ |
||||||
|
static bool rq_reclaim_from_per_user_free_pool( |
||||||
|
grpc_exec_ctx *exec_ctx, grpc_resource_quota *resource_quota) { |
||||||
|
grpc_resource_user *resource_user; |
||||||
|
while ((resource_user = rulist_pop_head(resource_quota, |
||||||
|
GRPC_RULIST_NON_EMPTY_FREE_POOL))) { |
||||||
|
gpr_mu_lock(&resource_user->mu); |
||||||
|
if (resource_user->free_pool > 0) { |
||||||
|
int64_t amt = resource_user->free_pool; |
||||||
|
resource_user->free_pool = 0; |
||||||
|
resource_quota->free_pool += amt; |
||||||
|
if (grpc_resource_quota_trace) { |
||||||
|
gpr_log(GPR_DEBUG, "RQ %s %s: reclaim_from_per_user_free_pool %" PRId64 |
||||||
|
" bytes; rq_free_pool -> %" PRId64, |
||||||
|
resource_quota->name, resource_user->name, amt, |
||||||
|
resource_quota->free_pool); |
||||||
|
} |
||||||
|
gpr_mu_unlock(&resource_user->mu); |
||||||
|
return true; |
||||||
|
} else { |
||||||
|
gpr_mu_unlock(&resource_user->mu); |
||||||
|
} |
||||||
|
} |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
/* returns true if reclamation is proceeding */ |
||||||
|
static bool rq_reclaim(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_quota *resource_quota, bool destructive) { |
||||||
|
if (resource_quota->reclaiming) return true; |
||||||
|
grpc_rulist list = destructive ? GRPC_RULIST_RECLAIMER_DESTRUCTIVE |
||||||
|
: GRPC_RULIST_RECLAIMER_BENIGN; |
||||||
|
grpc_resource_user *resource_user = rulist_pop_head(resource_quota, list); |
||||||
|
if (resource_user == NULL) return false; |
||||||
|
if (grpc_resource_quota_trace) { |
||||||
|
gpr_log(GPR_DEBUG, "RQ %s %s: initiate %s reclamation", |
||||||
|
resource_quota->name, resource_user->name, |
||||||
|
destructive ? "destructive" : "benign"); |
||||||
|
} |
||||||
|
resource_quota->reclaiming = true; |
||||||
|
grpc_resource_quota_internal_ref(resource_quota); |
||||||
|
grpc_closure *c = resource_user->reclaimers[destructive]; |
||||||
|
resource_user->reclaimers[destructive] = NULL; |
||||||
|
grpc_closure_run(exec_ctx, c, GRPC_ERROR_NONE); |
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
/*******************************************************************************
|
||||||
|
* ru_slice: a slice implementation that is backed by a grpc_resource_user |
||||||
|
*/ |
||||||
|
|
||||||
|
typedef struct { |
||||||
|
gpr_slice_refcount base; |
||||||
|
gpr_refcount refs; |
||||||
|
grpc_resource_user *resource_user; |
||||||
|
size_t size; |
||||||
|
} ru_slice_refcount; |
||||||
|
|
||||||
|
static void ru_slice_ref(void *p) { |
||||||
|
ru_slice_refcount *rc = p; |
||||||
|
gpr_ref(&rc->refs); |
||||||
|
} |
||||||
|
|
||||||
|
static void ru_slice_unref(void *p) { |
||||||
|
ru_slice_refcount *rc = p; |
||||||
|
if (gpr_unref(&rc->refs)) { |
||||||
|
/* TODO(ctiller): this is dangerous, but I think safe for now:
|
||||||
|
we have no guarantee here that we're at a safe point for creating an |
||||||
|
execution context, but we have no way of writing this code otherwise. |
||||||
|
In the future: consider lifting gpr_slice to grpc, and offering an |
||||||
|
internal_{ref,unref} pair that is execution context aware. |
||||||
|
Alternatively, |
||||||
|
make exec_ctx be thread local and 'do the right thing' (whatever that |
||||||
|
is) |
||||||
|
if NULL */ |
||||||
|
grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT; |
||||||
|
grpc_resource_user_free(&exec_ctx, rc->resource_user, rc->size); |
||||||
|
grpc_exec_ctx_finish(&exec_ctx); |
||||||
|
gpr_free(rc); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
static gpr_slice ru_slice_create(grpc_resource_user *resource_user, |
||||||
|
size_t size) { |
||||||
|
ru_slice_refcount *rc = gpr_malloc(sizeof(ru_slice_refcount) + size); |
||||||
|
rc->base.ref = ru_slice_ref; |
||||||
|
rc->base.unref = ru_slice_unref; |
||||||
|
gpr_ref_init(&rc->refs, 1); |
||||||
|
rc->resource_user = resource_user; |
||||||
|
rc->size = size; |
||||||
|
gpr_slice slice; |
||||||
|
slice.refcount = &rc->base; |
||||||
|
slice.data.refcounted.bytes = (uint8_t *)(rc + 1); |
||||||
|
slice.data.refcounted.length = size; |
||||||
|
return slice; |
||||||
|
} |
||||||
|
|
||||||
|
/*******************************************************************************
|
||||||
|
* grpc_resource_quota internal implementation: resource user manipulation under |
||||||
|
* the combiner |
||||||
|
*/ |
||||||
|
|
||||||
|
static void ru_allocate(grpc_exec_ctx *exec_ctx, void *ru, grpc_error *error) { |
||||||
|
grpc_resource_user *resource_user = ru; |
||||||
|
if (rulist_empty(resource_user->resource_quota, |
||||||
|
GRPC_RULIST_AWAITING_ALLOCATION)) { |
||||||
|
rq_step_sched(exec_ctx, resource_user->resource_quota); |
||||||
|
} |
||||||
|
rulist_add_tail(resource_user, GRPC_RULIST_AWAITING_ALLOCATION); |
||||||
|
} |
||||||
|
|
||||||
|
static void ru_add_to_free_pool(grpc_exec_ctx *exec_ctx, void *ru, |
||||||
|
grpc_error *error) { |
||||||
|
grpc_resource_user *resource_user = ru; |
||||||
|
if (!rulist_empty(resource_user->resource_quota, |
||||||
|
GRPC_RULIST_AWAITING_ALLOCATION) && |
||||||
|
rulist_empty(resource_user->resource_quota, |
||||||
|
GRPC_RULIST_NON_EMPTY_FREE_POOL)) { |
||||||
|
rq_step_sched(exec_ctx, resource_user->resource_quota); |
||||||
|
} |
||||||
|
rulist_add_tail(resource_user, GRPC_RULIST_NON_EMPTY_FREE_POOL); |
||||||
|
} |
||||||
|
|
||||||
|
static void ru_post_benign_reclaimer(grpc_exec_ctx *exec_ctx, void *ru, |
||||||
|
grpc_error *error) { |
||||||
|
grpc_resource_user *resource_user = ru; |
||||||
|
if (!rulist_empty(resource_user->resource_quota, |
||||||
|
GRPC_RULIST_AWAITING_ALLOCATION) && |
||||||
|
rulist_empty(resource_user->resource_quota, |
||||||
|
GRPC_RULIST_NON_EMPTY_FREE_POOL) && |
||||||
|
rulist_empty(resource_user->resource_quota, |
||||||
|
GRPC_RULIST_RECLAIMER_BENIGN)) { |
||||||
|
rq_step_sched(exec_ctx, resource_user->resource_quota); |
||||||
|
} |
||||||
|
rulist_add_tail(resource_user, GRPC_RULIST_RECLAIMER_BENIGN); |
||||||
|
} |
||||||
|
|
||||||
|
static void ru_post_destructive_reclaimer(grpc_exec_ctx *exec_ctx, void *ru, |
||||||
|
grpc_error *error) { |
||||||
|
grpc_resource_user *resource_user = ru; |
||||||
|
if (!rulist_empty(resource_user->resource_quota, |
||||||
|
GRPC_RULIST_AWAITING_ALLOCATION) && |
||||||
|
rulist_empty(resource_user->resource_quota, |
||||||
|
GRPC_RULIST_NON_EMPTY_FREE_POOL) && |
||||||
|
rulist_empty(resource_user->resource_quota, |
||||||
|
GRPC_RULIST_RECLAIMER_BENIGN) && |
||||||
|
rulist_empty(resource_user->resource_quota, |
||||||
|
GRPC_RULIST_RECLAIMER_DESTRUCTIVE)) { |
||||||
|
rq_step_sched(exec_ctx, resource_user->resource_quota); |
||||||
|
} |
||||||
|
rulist_add_tail(resource_user, GRPC_RULIST_RECLAIMER_DESTRUCTIVE); |
||||||
|
} |
||||||
|
|
||||||
|
static void ru_destroy(grpc_exec_ctx *exec_ctx, void *ru, grpc_error *error) { |
||||||
|
grpc_resource_user *resource_user = ru; |
||||||
|
GPR_ASSERT(resource_user->allocated == 0); |
||||||
|
for (int i = 0; i < GRPC_RULIST_COUNT; i++) { |
||||||
|
rulist_remove(resource_user, (grpc_rulist)i); |
||||||
|
} |
||||||
|
grpc_exec_ctx_sched(exec_ctx, resource_user->reclaimers[0], |
||||||
|
GRPC_ERROR_CANCELLED, NULL); |
||||||
|
grpc_exec_ctx_sched(exec_ctx, resource_user->reclaimers[1], |
||||||
|
GRPC_ERROR_CANCELLED, NULL); |
||||||
|
grpc_exec_ctx_sched(exec_ctx, (grpc_closure *)gpr_atm_no_barrier_load( |
||||||
|
&resource_user->on_done_destroy_closure), |
||||||
|
GRPC_ERROR_NONE, NULL); |
||||||
|
if (resource_user->free_pool != 0) { |
||||||
|
resource_user->resource_quota->free_pool += resource_user->free_pool; |
||||||
|
rq_step_sched(exec_ctx, resource_user->resource_quota); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
static void ru_allocated_slices(grpc_exec_ctx *exec_ctx, void *arg, |
||||||
|
grpc_error *error) { |
||||||
|
grpc_resource_user_slice_allocator *slice_allocator = arg; |
||||||
|
if (error == GRPC_ERROR_NONE) { |
||||||
|
for (size_t i = 0; i < slice_allocator->count; i++) { |
||||||
|
gpr_slice_buffer_add_indexed( |
||||||
|
slice_allocator->dest, ru_slice_create(slice_allocator->resource_user, |
||||||
|
slice_allocator->length)); |
||||||
|
} |
||||||
|
} |
||||||
|
grpc_closure_run(exec_ctx, &slice_allocator->on_done, GRPC_ERROR_REF(error)); |
||||||
|
} |
||||||
|
|
||||||
|
/*******************************************************************************
|
||||||
|
* grpc_resource_quota internal implementation: quota manipulation under the |
||||||
|
* combiner |
||||||
|
*/ |
||||||
|
|
||||||
|
typedef struct { |
||||||
|
int64_t size; |
||||||
|
grpc_resource_quota *resource_quota; |
||||||
|
grpc_closure closure; |
||||||
|
} rq_resize_args; |
||||||
|
|
||||||
|
static void rq_resize(grpc_exec_ctx *exec_ctx, void *args, grpc_error *error) { |
||||||
|
rq_resize_args *a = args; |
||||||
|
int64_t delta = a->size - a->resource_quota->size; |
||||||
|
a->resource_quota->size += delta; |
||||||
|
a->resource_quota->free_pool += delta; |
||||||
|
rq_step_sched(exec_ctx, a->resource_quota); |
||||||
|
grpc_resource_quota_internal_unref(exec_ctx, a->resource_quota); |
||||||
|
gpr_free(a); |
||||||
|
} |
||||||
|
|
||||||
|
static void rq_reclamation_done(grpc_exec_ctx *exec_ctx, void *rq, |
||||||
|
grpc_error *error) { |
||||||
|
grpc_resource_quota *resource_quota = rq; |
||||||
|
resource_quota->reclaiming = false; |
||||||
|
rq_step_sched(exec_ctx, resource_quota); |
||||||
|
grpc_resource_quota_internal_unref(exec_ctx, resource_quota); |
||||||
|
} |
||||||
|
|
||||||
|
/*******************************************************************************
|
||||||
|
* grpc_resource_quota api |
||||||
|
*/ |
||||||
|
|
||||||
|
/* Public API */ |
||||||
|
grpc_resource_quota *grpc_resource_quota_create(const char *name) { |
||||||
|
grpc_resource_quota *resource_quota = gpr_malloc(sizeof(*resource_quota)); |
||||||
|
gpr_ref_init(&resource_quota->refs, 1); |
||||||
|
resource_quota->combiner = grpc_combiner_create(NULL); |
||||||
|
resource_quota->free_pool = INT64_MAX; |
||||||
|
resource_quota->size = INT64_MAX; |
||||||
|
resource_quota->step_scheduled = false; |
||||||
|
resource_quota->reclaiming = false; |
||||||
|
if (name != NULL) { |
||||||
|
resource_quota->name = gpr_strdup(name); |
||||||
|
} else { |
||||||
|
gpr_asprintf(&resource_quota->name, "anonymous_pool_%" PRIxPTR, |
||||||
|
(intptr_t)resource_quota); |
||||||
|
} |
||||||
|
grpc_closure_init(&resource_quota->rq_step_closure, rq_step, resource_quota); |
||||||
|
grpc_closure_init(&resource_quota->rq_reclamation_done_closure, |
||||||
|
rq_reclamation_done, resource_quota); |
||||||
|
for (int i = 0; i < GRPC_RULIST_COUNT; i++) { |
||||||
|
resource_quota->roots[i] = NULL; |
||||||
|
} |
||||||
|
return resource_quota; |
||||||
|
} |
||||||
|
|
||||||
|
void grpc_resource_quota_internal_unref(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_quota *resource_quota) { |
||||||
|
if (gpr_unref(&resource_quota->refs)) { |
||||||
|
grpc_combiner_destroy(exec_ctx, resource_quota->combiner); |
||||||
|
gpr_free(resource_quota->name); |
||||||
|
gpr_free(resource_quota); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
/* Public API */ |
||||||
|
void grpc_resource_quota_unref(grpc_resource_quota *resource_quota) { |
||||||
|
grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT; |
||||||
|
grpc_resource_quota_internal_unref(&exec_ctx, resource_quota); |
||||||
|
grpc_exec_ctx_finish(&exec_ctx); |
||||||
|
} |
||||||
|
|
||||||
|
grpc_resource_quota *grpc_resource_quota_internal_ref( |
||||||
|
grpc_resource_quota *resource_quota) { |
||||||
|
gpr_ref(&resource_quota->refs); |
||||||
|
return resource_quota; |
||||||
|
} |
||||||
|
|
||||||
|
/* Public API */ |
||||||
|
void grpc_resource_quota_ref(grpc_resource_quota *resource_quota) { |
||||||
|
grpc_resource_quota_internal_ref(resource_quota); |
||||||
|
} |
||||||
|
|
||||||
|
/* Public API */ |
||||||
|
void grpc_resource_quota_resize(grpc_resource_quota *resource_quota, |
||||||
|
size_t size) { |
||||||
|
grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT; |
||||||
|
rq_resize_args *a = gpr_malloc(sizeof(*a)); |
||||||
|
a->resource_quota = grpc_resource_quota_internal_ref(resource_quota); |
||||||
|
a->size = (int64_t)size; |
||||||
|
grpc_closure_init(&a->closure, rq_resize, a); |
||||||
|
grpc_combiner_execute(&exec_ctx, resource_quota->combiner, &a->closure, |
||||||
|
GRPC_ERROR_NONE, false); |
||||||
|
grpc_exec_ctx_finish(&exec_ctx); |
||||||
|
} |
||||||
|
|
||||||
|
/*******************************************************************************
|
||||||
|
* grpc_resource_user channel args api |
||||||
|
*/ |
||||||
|
|
||||||
|
grpc_resource_quota *grpc_resource_quota_from_channel_args( |
||||||
|
const grpc_channel_args *channel_args) { |
||||||
|
for (size_t i = 0; i < channel_args->num_args; i++) { |
||||||
|
if (0 == strcmp(channel_args->args[i].key, GRPC_ARG_RESOURCE_QUOTA)) { |
||||||
|
if (channel_args->args[i].type == GRPC_ARG_POINTER) { |
||||||
|
return grpc_resource_quota_internal_ref( |
||||||
|
channel_args->args[i].value.pointer.p); |
||||||
|
} else { |
||||||
|
gpr_log(GPR_DEBUG, GRPC_ARG_RESOURCE_QUOTA " should be a pointer"); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
return grpc_resource_quota_create(NULL); |
||||||
|
} |
||||||
|
|
||||||
|
static void *rq_copy(void *rq) { |
||||||
|
grpc_resource_quota_ref(rq); |
||||||
|
return rq; |
||||||
|
} |
||||||
|
|
||||||
|
static void rq_destroy(void *rq) { grpc_resource_quota_unref(rq); } |
||||||
|
|
||||||
|
static int rq_cmp(void *a, void *b) { return GPR_ICMP(a, b); } |
||||||
|
|
||||||
|
const grpc_arg_pointer_vtable *grpc_resource_quota_arg_vtable(void) { |
||||||
|
static const grpc_arg_pointer_vtable vtable = {rq_copy, rq_destroy, rq_cmp}; |
||||||
|
return &vtable; |
||||||
|
} |
||||||
|
|
||||||
|
/*******************************************************************************
|
||||||
|
* grpc_resource_user api |
||||||
|
*/ |
||||||
|
|
||||||
|
void grpc_resource_user_init(grpc_resource_user *resource_user, |
||||||
|
grpc_resource_quota *resource_quota, |
||||||
|
const char *name) { |
||||||
|
resource_user->resource_quota = |
||||||
|
grpc_resource_quota_internal_ref(resource_quota); |
||||||
|
grpc_closure_init(&resource_user->allocate_closure, &ru_allocate, |
||||||
|
resource_user); |
||||||
|
grpc_closure_init(&resource_user->add_to_free_pool_closure, |
||||||
|
&ru_add_to_free_pool, resource_user); |
||||||
|
grpc_closure_init(&resource_user->post_reclaimer_closure[0], |
||||||
|
&ru_post_benign_reclaimer, resource_user); |
||||||
|
grpc_closure_init(&resource_user->post_reclaimer_closure[1], |
||||||
|
&ru_post_destructive_reclaimer, resource_user); |
||||||
|
grpc_closure_init(&resource_user->destroy_closure, &ru_destroy, |
||||||
|
resource_user); |
||||||
|
gpr_mu_init(&resource_user->mu); |
||||||
|
resource_user->allocated = 0; |
||||||
|
resource_user->free_pool = 0; |
||||||
|
grpc_closure_list_init(&resource_user->on_allocated); |
||||||
|
resource_user->allocating = false; |
||||||
|
resource_user->added_to_free_pool = false; |
||||||
|
gpr_atm_no_barrier_store(&resource_user->on_done_destroy_closure, 0); |
||||||
|
resource_user->reclaimers[0] = NULL; |
||||||
|
resource_user->reclaimers[1] = NULL; |
||||||
|
for (int i = 0; i < GRPC_RULIST_COUNT; i++) { |
||||||
|
resource_user->links[i].next = resource_user->links[i].prev = NULL; |
||||||
|
} |
||||||
|
if (name != NULL) { |
||||||
|
resource_user->name = gpr_strdup(name); |
||||||
|
} else { |
||||||
|
gpr_asprintf(&resource_user->name, "anonymous_resource_user_%" PRIxPTR, |
||||||
|
(intptr_t)resource_user); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
void grpc_resource_user_shutdown(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_user *resource_user, |
||||||
|
grpc_closure *on_done) { |
||||||
|
gpr_mu_lock(&resource_user->mu); |
||||||
|
GPR_ASSERT(gpr_atm_no_barrier_load(&resource_user->on_done_destroy_closure) == |
||||||
|
0); |
||||||
|
gpr_atm_no_barrier_store(&resource_user->on_done_destroy_closure, |
||||||
|
(gpr_atm)on_done); |
||||||
|
if (resource_user->allocated == 0) { |
||||||
|
grpc_combiner_execute(exec_ctx, resource_user->resource_quota->combiner, |
||||||
|
&resource_user->destroy_closure, GRPC_ERROR_NONE, |
||||||
|
false); |
||||||
|
} |
||||||
|
gpr_mu_unlock(&resource_user->mu); |
||||||
|
} |
||||||
|
|
||||||
|
void grpc_resource_user_destroy(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_user *resource_user) { |
||||||
|
grpc_resource_quota_internal_unref(exec_ctx, resource_user->resource_quota); |
||||||
|
gpr_mu_destroy(&resource_user->mu); |
||||||
|
gpr_free(resource_user->name); |
||||||
|
} |
||||||
|
|
||||||
|
void grpc_resource_user_alloc(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_user *resource_user, size_t size, |
||||||
|
grpc_closure *optional_on_done) { |
||||||
|
gpr_mu_lock(&resource_user->mu); |
||||||
|
grpc_closure *on_done_destroy = (grpc_closure *)gpr_atm_no_barrier_load( |
||||||
|
&resource_user->on_done_destroy_closure); |
||||||
|
if (on_done_destroy != NULL) { |
||||||
|
/* already shutdown */ |
||||||
|
if (grpc_resource_quota_trace) { |
||||||
|
gpr_log(GPR_DEBUG, "RQ %s %s: alloc %" PRIdPTR " after shutdown", |
||||||
|
resource_user->resource_quota->name, resource_user->name, size); |
||||||
|
} |
||||||
|
grpc_exec_ctx_sched( |
||||||
|
exec_ctx, optional_on_done, |
||||||
|
GRPC_ERROR_CREATE("Buffer pool user is already shutdown"), NULL); |
||||||
|
gpr_mu_unlock(&resource_user->mu); |
||||||
|
return; |
||||||
|
} |
||||||
|
resource_user->allocated += (int64_t)size; |
||||||
|
resource_user->free_pool -= (int64_t)size; |
||||||
|
if (grpc_resource_quota_trace) { |
||||||
|
gpr_log(GPR_DEBUG, "RQ %s %s: alloc %" PRIdPTR "; allocated -> %" PRId64 |
||||||
|
", free_pool -> %" PRId64, |
||||||
|
resource_user->resource_quota->name, resource_user->name, size, |
||||||
|
resource_user->allocated, resource_user->free_pool); |
||||||
|
} |
||||||
|
if (resource_user->free_pool < 0) { |
||||||
|
grpc_closure_list_append(&resource_user->on_allocated, optional_on_done, |
||||||
|
GRPC_ERROR_NONE); |
||||||
|
if (!resource_user->allocating) { |
||||||
|
resource_user->allocating = true; |
||||||
|
grpc_combiner_execute(exec_ctx, resource_user->resource_quota->combiner, |
||||||
|
&resource_user->allocate_closure, GRPC_ERROR_NONE, |
||||||
|
false); |
||||||
|
} |
||||||
|
} else { |
||||||
|
grpc_exec_ctx_sched(exec_ctx, optional_on_done, GRPC_ERROR_NONE, NULL); |
||||||
|
} |
||||||
|
gpr_mu_unlock(&resource_user->mu); |
||||||
|
} |
||||||
|
|
||||||
|
void grpc_resource_user_free(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_user *resource_user, size_t size) { |
||||||
|
gpr_mu_lock(&resource_user->mu); |
||||||
|
GPR_ASSERT(resource_user->allocated >= (int64_t)size); |
||||||
|
bool was_zero_or_negative = resource_user->free_pool <= 0; |
||||||
|
resource_user->free_pool += (int64_t)size; |
||||||
|
resource_user->allocated -= (int64_t)size; |
||||||
|
if (grpc_resource_quota_trace) { |
||||||
|
gpr_log(GPR_DEBUG, "RQ %s %s: free %" PRIdPTR "; allocated -> %" PRId64 |
||||||
|
", free_pool -> %" PRId64, |
||||||
|
resource_user->resource_quota->name, resource_user->name, size, |
||||||
|
resource_user->allocated, resource_user->free_pool); |
||||||
|
} |
||||||
|
bool is_bigger_than_zero = resource_user->free_pool > 0; |
||||||
|
if (is_bigger_than_zero && was_zero_or_negative && |
||||||
|
!resource_user->added_to_free_pool) { |
||||||
|
resource_user->added_to_free_pool = true; |
||||||
|
grpc_combiner_execute(exec_ctx, resource_user->resource_quota->combiner, |
||||||
|
&resource_user->add_to_free_pool_closure, |
||||||
|
GRPC_ERROR_NONE, false); |
||||||
|
} |
||||||
|
grpc_closure *on_done_destroy = (grpc_closure *)gpr_atm_no_barrier_load( |
||||||
|
&resource_user->on_done_destroy_closure); |
||||||
|
if (on_done_destroy != NULL && resource_user->allocated == 0) { |
||||||
|
grpc_combiner_execute(exec_ctx, resource_user->resource_quota->combiner, |
||||||
|
&resource_user->destroy_closure, GRPC_ERROR_NONE, |
||||||
|
false); |
||||||
|
} |
||||||
|
gpr_mu_unlock(&resource_user->mu); |
||||||
|
} |
||||||
|
|
||||||
|
void grpc_resource_user_post_reclaimer(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_user *resource_user, |
||||||
|
bool destructive, |
||||||
|
grpc_closure *closure) { |
||||||
|
if (gpr_atm_acq_load(&resource_user->on_done_destroy_closure) == 0) { |
||||||
|
GPR_ASSERT(resource_user->reclaimers[destructive] == NULL); |
||||||
|
resource_user->reclaimers[destructive] = closure; |
||||||
|
grpc_combiner_execute(exec_ctx, resource_user->resource_quota->combiner, |
||||||
|
&resource_user->post_reclaimer_closure[destructive], |
||||||
|
GRPC_ERROR_NONE, false); |
||||||
|
} else { |
||||||
|
grpc_exec_ctx_sched(exec_ctx, closure, GRPC_ERROR_CANCELLED, NULL); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
void grpc_resource_user_finish_reclamation(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_user *resource_user) { |
||||||
|
if (grpc_resource_quota_trace) { |
||||||
|
gpr_log(GPR_DEBUG, "RQ %s %s: reclamation complete", |
||||||
|
resource_user->resource_quota->name, resource_user->name); |
||||||
|
} |
||||||
|
grpc_combiner_execute( |
||||||
|
exec_ctx, resource_user->resource_quota->combiner, |
||||||
|
&resource_user->resource_quota->rq_reclamation_done_closure, |
||||||
|
GRPC_ERROR_NONE, false); |
||||||
|
} |
||||||
|
|
||||||
|
void grpc_resource_user_slice_allocator_init( |
||||||
|
grpc_resource_user_slice_allocator *slice_allocator, |
||||||
|
grpc_resource_user *resource_user, grpc_iomgr_cb_func cb, void *p) { |
||||||
|
grpc_closure_init(&slice_allocator->on_allocated, ru_allocated_slices, |
||||||
|
slice_allocator); |
||||||
|
grpc_closure_init(&slice_allocator->on_done, cb, p); |
||||||
|
slice_allocator->resource_user = resource_user; |
||||||
|
} |
||||||
|
|
||||||
|
void grpc_resource_user_alloc_slices( |
||||||
|
grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_user_slice_allocator *slice_allocator, size_t length, |
||||||
|
size_t count, gpr_slice_buffer *dest) { |
||||||
|
slice_allocator->length = length; |
||||||
|
slice_allocator->count = count; |
||||||
|
slice_allocator->dest = dest; |
||||||
|
grpc_resource_user_alloc(exec_ctx, slice_allocator->resource_user, |
||||||
|
count * length, &slice_allocator->on_allocated); |
||||||
|
} |
||||||
@ -0,0 +1,224 @@ |
|||||||
|
/*
|
||||||
|
* |
||||||
|
* Copyright 2016, 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_IOMGR_RESOURCE_QUOTA_H |
||||||
|
#define GRPC_CORE_LIB_IOMGR_RESOURCE_QUOTA_H |
||||||
|
|
||||||
|
#include <grpc/grpc.h> |
||||||
|
|
||||||
|
#include "src/core/lib/iomgr/exec_ctx.h" |
||||||
|
|
||||||
|
/** \file Tracks resource usage against a pool.
|
||||||
|
|
||||||
|
The current implementation tracks only memory usage, but in the future |
||||||
|
this may be extended to (for example) threads and file descriptors. |
||||||
|
|
||||||
|
A grpc_resource_quota represents the pooled resources, and |
||||||
|
grpc_resource_user instances attach to the quota and consume those |
||||||
|
resources. They also offer a vector for reclamation: if we become |
||||||
|
resource constrained, grpc_resource_user instances are asked (in turn) to |
||||||
|
free up whatever they can so that the system as a whole can make progress. |
||||||
|
|
||||||
|
There are three kinds of reclamation that take place, in order of increasing |
||||||
|
invasiveness: |
||||||
|
- an internal reclamation, where cached resource at the resource user level |
||||||
|
is returned to the quota |
||||||
|
- a benign reclamation phase, whereby resources that are in use but are not |
||||||
|
helping anything make progress are reclaimed |
||||||
|
- a destructive reclamation, whereby resources that are helping something |
||||||
|
make progress may be enacted so that at least one part of the system can |
||||||
|
complete. |
||||||
|
|
||||||
|
Only one reclamation will be outstanding for a given quota at a given time. |
||||||
|
On each reclamation attempt, the kinds of reclamation are tried in order of |
||||||
|
increasing invasiveness, stopping at the first one that succeeds. Thus, on a |
||||||
|
given reclamation attempt, if internal and benign reclamation both fail, it |
||||||
|
will wind up doing a destructive reclamation. However, the next reclamation |
||||||
|
attempt may then be able to get what it needs via internal or benign |
||||||
|
reclamation, due to resources that may have been freed up by the destructive |
||||||
|
reclamation in the previous attempt. |
||||||
|
|
||||||
|
Future work will be to expose the current resource pressure so that back |
||||||
|
pressure can be applied to avoid reclamation phases starting. |
||||||
|
|
||||||
|
Resource users own references to resource quotas, and resource quotas |
||||||
|
maintain lists of users (which users arrange to leave before they are |
||||||
|
destroyed) */ |
||||||
|
|
||||||
|
extern int grpc_resource_quota_trace; |
||||||
|
|
||||||
|
grpc_resource_quota *grpc_resource_quota_internal_ref( |
||||||
|
grpc_resource_quota *resource_quota); |
||||||
|
void grpc_resource_quota_internal_unref(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_quota *resource_quota); |
||||||
|
grpc_resource_quota *grpc_resource_quota_from_channel_args( |
||||||
|
const grpc_channel_args *channel_args); |
||||||
|
|
||||||
|
/* Resource users are kept in (potentially) several intrusive linked lists
|
||||||
|
at once. These are the list names. */ |
||||||
|
typedef enum { |
||||||
|
/* Resource users that are waiting for an allocation */ |
||||||
|
GRPC_RULIST_AWAITING_ALLOCATION, |
||||||
|
/* Resource users that have free memory available for internal reclamation */ |
||||||
|
GRPC_RULIST_NON_EMPTY_FREE_POOL, |
||||||
|
/* Resource users that have published a benign reclamation is available */ |
||||||
|
GRPC_RULIST_RECLAIMER_BENIGN, |
||||||
|
/* Resource users that have published a destructive reclamation is
|
||||||
|
available */ |
||||||
|
GRPC_RULIST_RECLAIMER_DESTRUCTIVE, |
||||||
|
/* Number of lists: must be last */ |
||||||
|
GRPC_RULIST_COUNT |
||||||
|
} grpc_rulist; |
||||||
|
|
||||||
|
typedef struct grpc_resource_user grpc_resource_user; |
||||||
|
|
||||||
|
/* Internal linked list pointers for a resource user */ |
||||||
|
typedef struct { |
||||||
|
grpc_resource_user *next; |
||||||
|
grpc_resource_user *prev; |
||||||
|
} grpc_resource_user_link; |
||||||
|
|
||||||
|
struct grpc_resource_user { |
||||||
|
/* The quota this resource user consumes from */ |
||||||
|
grpc_resource_quota *resource_quota; |
||||||
|
|
||||||
|
/* Closure to schedule an allocation under the resource quota combiner lock */ |
||||||
|
grpc_closure allocate_closure; |
||||||
|
/* Closure to publish a non empty free pool under the resource quota combiner
|
||||||
|
lock */ |
||||||
|
grpc_closure add_to_free_pool_closure; |
||||||
|
|
||||||
|
gpr_mu mu; |
||||||
|
/* Total allocated memory outstanding by this resource user in bytes;
|
||||||
|
always positive */ |
||||||
|
int64_t allocated; |
||||||
|
/* The amount of memory (in bytes) this user has cached for its own use: to
|
||||||
|
avoid quota contention, each resource user can keep some memory in |
||||||
|
addition to what it is immediately using (e.g., for caching), and the quota |
||||||
|
can pull it back under memory pressure. |
||||||
|
This value can become negative if more memory has been requested than |
||||||
|
existed in the free pool, at which point the quota is consulted to bring |
||||||
|
this value non-negative (asynchronously). */ |
||||||
|
int64_t free_pool; |
||||||
|
/* A list of closures to call once free_pool becomes non-negative - ie when
|
||||||
|
all outstanding allocations have been granted. */ |
||||||
|
grpc_closure_list on_allocated; |
||||||
|
/* True if we are currently trying to allocate from the quota, false if not */ |
||||||
|
bool allocating; |
||||||
|
/* True if we are currently trying to add ourselves to the non-free quota
|
||||||
|
list, false otherwise */ |
||||||
|
bool added_to_free_pool; |
||||||
|
|
||||||
|
/* Reclaimers: index 0 is the benign reclaimer, 1 is the destructive reclaimer
|
||||||
|
*/ |
||||||
|
grpc_closure *reclaimers[2]; |
||||||
|
/* Trampoline closures to finish reclamation and re-enter the quota combiner
|
||||||
|
lock */ |
||||||
|
grpc_closure post_reclaimer_closure[2]; |
||||||
|
|
||||||
|
/* Closure to execute under the quota combiner to de-register and shutdown the
|
||||||
|
resource user */ |
||||||
|
grpc_closure destroy_closure; |
||||||
|
/* User supplied closure to call once the user has finished shutting down AND
|
||||||
|
all outstanding allocations have been freed. Real type is grpc_closure*, |
||||||
|
but it's stored as an atomic to avoid a mutex on some fast paths. */ |
||||||
|
gpr_atm on_done_destroy_closure; |
||||||
|
|
||||||
|
/* Links in the various grpc_rulist lists */ |
||||||
|
grpc_resource_user_link links[GRPC_RULIST_COUNT]; |
||||||
|
|
||||||
|
/* The name of this resource user, for debugging/tracing */ |
||||||
|
char *name; |
||||||
|
}; |
||||||
|
|
||||||
|
void grpc_resource_user_init(grpc_resource_user *resource_user, |
||||||
|
grpc_resource_quota *resource_quota, |
||||||
|
const char *name); |
||||||
|
void grpc_resource_user_shutdown(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_user *resource_user, |
||||||
|
grpc_closure *on_done); |
||||||
|
void grpc_resource_user_destroy(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_user *resource_user); |
||||||
|
|
||||||
|
/* Allocate from the resource user (and its quota).
|
||||||
|
If optional_on_done is NULL, then allocate immediately. This may push the |
||||||
|
quota over-limit, at which point reclamation will kick in. |
||||||
|
If optional_on_done is non-NULL, it will be scheduled when the allocation has |
||||||
|
been granted by the quota. */ |
||||||
|
void grpc_resource_user_alloc(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_user *resource_user, size_t size, |
||||||
|
grpc_closure *optional_on_done); |
||||||
|
/* Release memory back to the quota */ |
||||||
|
void grpc_resource_user_free(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_user *resource_user, size_t size); |
||||||
|
/* Post a memory reclaimer to the resource user. Only one benign and one
|
||||||
|
destructive reclaimer can be posted at once. When executed, the reclaimer |
||||||
|
MUST call grpc_resource_user_finish_reclamation before it completes, to |
||||||
|
return control to the resource quota. */ |
||||||
|
void grpc_resource_user_post_reclaimer(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_user *resource_user, |
||||||
|
bool destructive, grpc_closure *closure); |
||||||
|
/* Finish a reclamation step */ |
||||||
|
void grpc_resource_user_finish_reclamation(grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_user *resource_user); |
||||||
|
|
||||||
|
/* Helper to allocate slices from a resource user */ |
||||||
|
typedef struct grpc_resource_user_slice_allocator { |
||||||
|
/* Closure for when a resource user allocation completes */ |
||||||
|
grpc_closure on_allocated; |
||||||
|
/* Closure to call when slices have been allocated */ |
||||||
|
grpc_closure on_done; |
||||||
|
/* Length of slices to allocate on the current request */ |
||||||
|
size_t length; |
||||||
|
/* Number of slices to allocate on the current request */ |
||||||
|
size_t count; |
||||||
|
/* Destination for slices to allocate on the current request */ |
||||||
|
gpr_slice_buffer *dest; |
||||||
|
/* Parent resource user */ |
||||||
|
grpc_resource_user *resource_user; |
||||||
|
} grpc_resource_user_slice_allocator; |
||||||
|
|
||||||
|
/* Initialize a slice allocator.
|
||||||
|
When an allocation is completed, calls \a cb with arg \p. */ |
||||||
|
void grpc_resource_user_slice_allocator_init( |
||||||
|
grpc_resource_user_slice_allocator *slice_allocator, |
||||||
|
grpc_resource_user *resource_user, grpc_iomgr_cb_func cb, void *p); |
||||||
|
|
||||||
|
/* Allocate \a count slices of length \a length into \a dest. Only one request
|
||||||
|
can be outstanding at a time. */ |
||||||
|
void grpc_resource_user_alloc_slices( |
||||||
|
grpc_exec_ctx *exec_ctx, |
||||||
|
grpc_resource_user_slice_allocator *slice_allocator, size_t length, |
||||||
|
size_t count, gpr_slice_buffer *dest); |
||||||
|
|
||||||
|
#endif /* GRPC_CORE_LIB_IOMGR_RESOURCE_QUOTA_H */ |
||||||
@ -0,0 +1,45 @@ |
|||||||
|
/*
|
||||||
|
* |
||||||
|
* Copyright 2015, 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_IOMGR_TCP_CLIENT_POSIX_H |
||||||
|
#define GRPC_CORE_LIB_IOMGR_TCP_CLIENT_POSIX_H |
||||||
|
|
||||||
|
#include "src/core/lib/iomgr/endpoint.h" |
||||||
|
#include "src/core/lib/iomgr/ev_posix.h" |
||||||
|
#include "src/core/lib/iomgr/tcp_client.h" |
||||||
|
|
||||||
|
grpc_endpoint *grpc_tcp_client_create_from_fd( |
||||||
|
grpc_exec_ctx *exec_ctx, grpc_fd *fd, const grpc_channel_args *channel_args, |
||||||
|
const char *addr_str); |
||||||
|
|
||||||
|
#endif /* GRPC_CORE_LIB_IOMGR_TCP_CLIENT_POSIX_H */ |
||||||
@ -0,0 +1,51 @@ |
|||||||
|
/*
|
||||||
|
* |
||||||
|
* Copyright 2016, 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 <grpc++/resource_quota.h> |
||||||
|
#include <grpc/grpc.h> |
||||||
|
|
||||||
|
namespace grpc { |
||||||
|
|
||||||
|
ResourceQuota::ResourceQuota() : impl_(grpc_resource_quota_create(nullptr)) {} |
||||||
|
|
||||||
|
ResourceQuota::ResourceQuota(const grpc::string& name) |
||||||
|
: impl_(grpc_resource_quota_create(name.c_str())) {} |
||||||
|
|
||||||
|
ResourceQuota::~ResourceQuota() { grpc_resource_quota_unref(impl_); } |
||||||
|
|
||||||
|
ResourceQuota& ResourceQuota::Resize(size_t new_size) { |
||||||
|
grpc_resource_quota_resize(impl_, new_size); |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
} // namespace grpc
|
||||||
@ -0,0 +1,37 @@ |
|||||||
|
|
||||||
|
// Copyright 2016, 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. |
||||||
|
|
||||||
|
syntax = "proto2"; |
||||||
|
|
||||||
|
package grpc.testing.proto2; |
||||||
|
|
||||||
|
message EmptyWithExtensions { |
||||||
|
extensions 100 to 999; |
||||||
|
} |
||||||
@ -0,0 +1,43 @@ |
|||||||
|
// Copyright 2016, 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. |
||||||
|
|
||||||
|
syntax = "proto2"; |
||||||
|
|
||||||
|
import "src/proto/grpc/testing/proto2/empty2.proto"; |
||||||
|
|
||||||
|
package grpc.testing.proto2; |
||||||
|
|
||||||
|
// Fill emptiness with music. |
||||||
|
extend grpc.testing.proto2.EmptyWithExtensions { |
||||||
|
optional int64 Deadmau5 = 124; |
||||||
|
optional float Madeon = 125; |
||||||
|
optional string AboveAndBeyond = 126; |
||||||
|
optional bool Tycho = 127; |
||||||
|
optional fixed64 Pendulum = 128; |
||||||
|
} |
||||||
@ -1 +1,3 @@ |
|||||||
gens/ |
gens/ |
||||||
|
*_pb2.py |
||||||
|
*_pb2_grpc.py |
||||||
|
|||||||
@ -0,0 +1,5 @@ |
|||||||
|
*.proto |
||||||
|
*_pb2.py |
||||||
|
build/ |
||||||
|
grpcio_reflection.egg-info/ |
||||||
|
dist/ |
||||||
@ -0,0 +1,30 @@ |
|||||||
|
# Copyright 2016, 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. |
||||||
|
|
||||||
|
__import__('pkg_resources').declare_namespace(__name__) |
||||||
@ -0,0 +1,29 @@ |
|||||||
|
# Copyright 2016, 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. |
||||||
|
|
||||||
@ -0,0 +1,29 @@ |
|||||||
|
# Copyright 2016, 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. |
||||||
|
|
||||||
@ -0,0 +1,143 @@ |
|||||||
|
# Copyright 2016, 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. |
||||||
|
|
||||||
|
"""Reference implementation for reflection in gRPC Python.""" |
||||||
|
|
||||||
|
import threading |
||||||
|
|
||||||
|
import grpc |
||||||
|
from google.protobuf import descriptor_pb2 |
||||||
|
from google.protobuf import descriptor_pool |
||||||
|
|
||||||
|
from grpc.reflection.v1alpha import reflection_pb2 |
||||||
|
|
||||||
|
_POOL = descriptor_pool.Default() |
||||||
|
|
||||||
|
def _not_found_error(): |
||||||
|
return reflection_pb2.ServerReflectionResponse( |
||||||
|
error_response=reflection_pb2.ErrorResponse( |
||||||
|
error_code=grpc.StatusCode.NOT_FOUND.value[0], |
||||||
|
error_message=grpc.StatusCode.NOT_FOUND.value[1].encode(), |
||||||
|
) |
||||||
|
) |
||||||
|
|
||||||
|
def _file_descriptor_response(descriptor): |
||||||
|
proto = descriptor_pb2.FileDescriptorProto() |
||||||
|
descriptor.CopyToProto(proto) |
||||||
|
serialized_proto = proto.SerializeToString() |
||||||
|
return reflection_pb2.ServerReflectionResponse( |
||||||
|
file_descriptor_response=reflection_pb2.FileDescriptorResponse( |
||||||
|
file_descriptor_proto=(serialized_proto,) |
||||||
|
), |
||||||
|
) |
||||||
|
|
||||||
|
|
||||||
|
class ReflectionServicer(reflection_pb2.ServerReflectionServicer): |
||||||
|
"""Servicer handling RPCs for service statuses.""" |
||||||
|
|
||||||
|
def __init__(self, service_names, pool=None): |
||||||
|
"""Constructor. |
||||||
|
|
||||||
|
Args: |
||||||
|
service_names: Iterable of fully-qualified service names available. |
||||||
|
""" |
||||||
|
self._service_names = list(service_names) |
||||||
|
self._pool = _POOL if pool is None else pool |
||||||
|
|
||||||
|
def _file_by_filename(self, filename): |
||||||
|
try: |
||||||
|
descriptor = self._pool.FindFileByName(filename) |
||||||
|
except KeyError: |
||||||
|
return _not_found_error() |
||||||
|
else: |
||||||
|
return _file_descriptor_response(descriptor) |
||||||
|
|
||||||
|
def _file_containing_symbol(self, fully_qualified_name): |
||||||
|
try: |
||||||
|
descriptor = self._pool.FindFileContainingSymbol(fully_qualified_name) |
||||||
|
except KeyError: |
||||||
|
return _not_found_error() |
||||||
|
else: |
||||||
|
return _file_descriptor_response(descriptor) |
||||||
|
|
||||||
|
def _file_containing_extension(containing_type, extension_number): |
||||||
|
# TODO(atash) Python protobuf currently doesn't support querying extensions. |
||||||
|
# https://github.com/google/protobuf/issues/2248 |
||||||
|
return reflection_pb2.ServerReflectionResponse( |
||||||
|
error_response=reflection_pb2.ErrorResponse( |
||||||
|
error_code=grpc.StatusCode.UNIMPLEMENTED.value[0], |
||||||
|
error_message=grpc.StatusCode.UNIMPLMENTED.value[1].encode(), |
||||||
|
) |
||||||
|
) |
||||||
|
|
||||||
|
def _extension_numbers_of_type(fully_qualified_name): |
||||||
|
# TODO(atash) We're allowed to leave this unsupported according to the |
||||||
|
# protocol, but we should still eventually implement it. Hits the same issue |
||||||
|
# as `_file_containing_extension`, however. |
||||||
|
# https://github.com/google/protobuf/issues/2248 |
||||||
|
return reflection_pb2.ServerReflectionResponse( |
||||||
|
error_response=reflection_pb2.ErrorResponse( |
||||||
|
error_code=grpc.StatusCode.UNIMPLEMENTED.value[0], |
||||||
|
error_message=grpc.StatusCode.UNIMPLMENTED.value[1].encode(), |
||||||
|
) |
||||||
|
) |
||||||
|
|
||||||
|
def _list_services(self): |
||||||
|
return reflection_pb2.ServerReflectionResponse( |
||||||
|
list_services_response=reflection_pb2.ListServiceResponse( |
||||||
|
service=[ |
||||||
|
reflection_pb2.ServiceResponse(name=service_name) |
||||||
|
for service_name in self._service_names |
||||||
|
] |
||||||
|
) |
||||||
|
) |
||||||
|
|
||||||
|
def ServerReflectionInfo(self, request_iterator, context): |
||||||
|
for request in request_iterator: |
||||||
|
if request.HasField('file_by_filename'): |
||||||
|
yield self._file_by_filename(request.file_by_filename) |
||||||
|
elif request.HasField('file_containing_symbol'): |
||||||
|
yield self._file_containing_symbol(request.file_containing_symbol) |
||||||
|
elif request.HasField('file_containing_extension'): |
||||||
|
yield self._file_containing_extension( |
||||||
|
request.file_containing_extension.containing_type, |
||||||
|
request.file_containing_extension.extension_number) |
||||||
|
elif request.HasField('all_extension_numbers_of_type'): |
||||||
|
yield _all_extension_numbers_of_type( |
||||||
|
request.all_extension_numbers_of_type) |
||||||
|
elif request.HasField('list_services'): |
||||||
|
yield self._list_services() |
||||||
|
else: |
||||||
|
yield reflection_pb2.ServerReflectionResponse( |
||||||
|
error_response=reflection_pb2.ErrorResponse( |
||||||
|
error_code=grpc.StatusCode.INVALID_ARGUMENT.value[0], |
||||||
|
error_message=grpc.StatusCode.INVALID_ARGUMENT.value[1].encode(), |
||||||
|
) |
||||||
|
) |
||||||
|
|
||||||
@ -0,0 +1,32 @@ |
|||||||
|
# Copyright 2016, 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. |
||||||
|
|
||||||
|
# AUTO-GENERATED FROM `$REPO_ROOT/templates/src/python/grpcio_reflection/grpc_version.py.template`!!! |
||||||
|
|
||||||
|
VERSION='1.1.0.dev0' |
||||||
@ -0,0 +1,78 @@ |
|||||||
|
# Copyright 2016, 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. |
||||||
|
|
||||||
|
"""Provides distutils command classes for the GRPC Python setup process.""" |
||||||
|
|
||||||
|
import os |
||||||
|
import shutil |
||||||
|
|
||||||
|
import setuptools |
||||||
|
|
||||||
|
ROOT_DIR = os.path.abspath(os.path.dirname(os.path.abspath(__file__))) |
||||||
|
HEALTH_PROTO = os.path.join(ROOT_DIR, '../../proto/grpc/reflection/v1alpha/reflection.proto') |
||||||
|
|
||||||
|
|
||||||
|
class CopyProtoModules(setuptools.Command): |
||||||
|
"""Command to copy proto modules from grpc/src/proto.""" |
||||||
|
|
||||||
|
description = '' |
||||||
|
user_options = [] |
||||||
|
|
||||||
|
def initialize_options(self): |
||||||
|
pass |
||||||
|
|
||||||
|
def finalize_options(self): |
||||||
|
pass |
||||||
|
|
||||||
|
def run(self): |
||||||
|
if os.path.isfile(HEALTH_PROTO): |
||||||
|
shutil.copyfile( |
||||||
|
HEALTH_PROTO, |
||||||
|
os.path.join(ROOT_DIR, 'grpc/reflection/v1alpha/reflection.proto')) |
||||||
|
|
||||||
|
|
||||||
|
class BuildPackageProtos(setuptools.Command): |
||||||
|
"""Command to generate project *_pb2.py modules from proto files.""" |
||||||
|
|
||||||
|
description = 'build grpc protobuf modules' |
||||||
|
user_options = [] |
||||||
|
|
||||||
|
def initialize_options(self): |
||||||
|
pass |
||||||
|
|
||||||
|
def finalize_options(self): |
||||||
|
pass |
||||||
|
|
||||||
|
def run(self): |
||||||
|
# due to limitations of the proto generator, we require that only *one* |
||||||
|
# directory is provided as an 'include' directory. We assume it's the '' key |
||||||
|
# to `self.distribution.package_dir` (and get a key error if it's not |
||||||
|
# there). |
||||||
|
from grpc.tools import command |
||||||
|
command.build_package_protos(self.distribution.package_dir['']) |
||||||
@ -0,0 +1,73 @@ |
|||||||
|
# Copyright 2016, 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. |
||||||
|
|
||||||
|
"""Setup module for the GRPC Python package's optional reflection.""" |
||||||
|
|
||||||
|
import os |
||||||
|
import sys |
||||||
|
|
||||||
|
import setuptools |
||||||
|
|
||||||
|
# Ensure we're in the proper directory whether or not we're being used by pip. |
||||||
|
os.chdir(os.path.dirname(os.path.abspath(__file__))) |
||||||
|
|
||||||
|
# Break import-style to ensure we can actually find our commands module. |
||||||
|
import reflection_commands |
||||||
|
import grpc_version |
||||||
|
|
||||||
|
PACKAGE_DIRECTORIES = { |
||||||
|
'': '.', |
||||||
|
} |
||||||
|
|
||||||
|
SETUP_REQUIRES = ( |
||||||
|
'grpcio-tools>={version}'.format(version=grpc_version.VERSION), |
||||||
|
) |
||||||
|
|
||||||
|
INSTALL_REQUIRES = ( |
||||||
|
'protobuf>=3.0.0', |
||||||
|
'grpcio>={version}'.format(version=grpc_version.VERSION), |
||||||
|
) |
||||||
|
|
||||||
|
COMMAND_CLASS = { |
||||||
|
# Run preprocess from the repository *before* doing any packaging! |
||||||
|
'preprocess': reflection_commands.CopyProtoModules, |
||||||
|
'build_package_protos': reflection_commands.BuildPackageProtos, |
||||||
|
} |
||||||
|
|
||||||
|
setuptools.setup( |
||||||
|
name='grpcio-reflection', |
||||||
|
version=grpc_version.VERSION, |
||||||
|
license='3-clause BSD', |
||||||
|
package_dir=PACKAGE_DIRECTORIES, |
||||||
|
packages=setuptools.find_packages('.'), |
||||||
|
namespace_packages=['grpc'], |
||||||
|
install_requires=INSTALL_REQUIRES, |
||||||
|
setup_requires=SETUP_REQUIRES, |
||||||
|
cmdclass=COMMAND_CLASS |
||||||
|
) |
||||||
@ -0,0 +1,28 @@ |
|||||||
|
# Copyright 2016, 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. |
||||||
@ -0,0 +1,185 @@ |
|||||||
|
# Copyright 2016, 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. |
||||||
|
|
||||||
|
"""Tests of grpc.reflection.v1alpha.reflection.""" |
||||||
|
|
||||||
|
import unittest |
||||||
|
|
||||||
|
import grpc |
||||||
|
from grpc.framework.foundation import logging_pool |
||||||
|
from grpc.reflection.v1alpha import reflection |
||||||
|
from grpc.reflection.v1alpha import reflection_pb2 |
||||||
|
|
||||||
|
from google.protobuf import descriptor_pool |
||||||
|
from google.protobuf import descriptor_pb2 |
||||||
|
|
||||||
|
from src.proto.grpc.testing.proto2 import empty2_extensions_pb2 |
||||||
|
from src.proto.grpc.testing import empty_pb2 |
||||||
|
from tests.unit.framework.common import test_constants |
||||||
|
|
||||||
|
_EMPTY_PROTO_FILE_NAME = 'src/proto/grpc/testing/empty.proto' |
||||||
|
_EMPTY_PROTO_SYMBOL_NAME = 'grpc.testing.Empty' |
||||||
|
_SERVICE_NAMES = ( |
||||||
|
'Angstrom', 'Bohr', 'Curie', 'Dyson', 'Einstein', 'Feynman', 'Galilei') |
||||||
|
|
||||||
|
def _file_descriptor_to_proto(descriptor): |
||||||
|
proto = descriptor_pb2.FileDescriptorProto() |
||||||
|
descriptor.CopyToProto(proto) |
||||||
|
return proto.SerializeToString() |
||||||
|
|
||||||
|
class ReflectionServicerTest(unittest.TestCase): |
||||||
|
|
||||||
|
def setUp(self): |
||||||
|
servicer = reflection.ReflectionServicer(service_names=_SERVICE_NAMES) |
||||||
|
server_pool = logging_pool.pool(test_constants.THREAD_CONCURRENCY) |
||||||
|
self._server = grpc.server(server_pool) |
||||||
|
port = self._server.add_insecure_port('[::]:0') |
||||||
|
reflection_pb2.add_ServerReflectionServicer_to_server(servicer, self._server) |
||||||
|
self._server.start() |
||||||
|
|
||||||
|
channel = grpc.insecure_channel('localhost:%d' % port) |
||||||
|
self._stub = reflection_pb2.ServerReflectionStub(channel) |
||||||
|
|
||||||
|
def testFileByName(self): |
||||||
|
requests = ( |
||||||
|
reflection_pb2.ServerReflectionRequest( |
||||||
|
file_by_filename=_EMPTY_PROTO_FILE_NAME |
||||||
|
), |
||||||
|
reflection_pb2.ServerReflectionRequest( |
||||||
|
file_by_filename='i-donut-exist' |
||||||
|
), |
||||||
|
) |
||||||
|
responses = tuple(self._stub.ServerReflectionInfo(requests)) |
||||||
|
expected_responses = ( |
||||||
|
reflection_pb2.ServerReflectionResponse( |
||||||
|
valid_host='', |
||||||
|
file_descriptor_response=reflection_pb2.FileDescriptorResponse( |
||||||
|
file_descriptor_proto=( |
||||||
|
_file_descriptor_to_proto(empty_pb2.DESCRIPTOR), |
||||||
|
) |
||||||
|
) |
||||||
|
), |
||||||
|
reflection_pb2.ServerReflectionResponse( |
||||||
|
valid_host='', |
||||||
|
error_response=reflection_pb2.ErrorResponse( |
||||||
|
error_code=grpc.StatusCode.NOT_FOUND.value[0], |
||||||
|
error_message=grpc.StatusCode.NOT_FOUND.value[1].encode(), |
||||||
|
) |
||||||
|
), |
||||||
|
) |
||||||
|
self.assertEqual(expected_responses, responses) |
||||||
|
|
||||||
|
def testFileBySymbol(self): |
||||||
|
requests = ( |
||||||
|
reflection_pb2.ServerReflectionRequest( |
||||||
|
file_containing_symbol=_EMPTY_PROTO_SYMBOL_NAME |
||||||
|
), |
||||||
|
reflection_pb2.ServerReflectionRequest( |
||||||
|
file_containing_symbol='i.donut.exist.co.uk.org.net.me.name.foo' |
||||||
|
), |
||||||
|
) |
||||||
|
responses = tuple(self._stub.ServerReflectionInfo(requests)) |
||||||
|
expected_responses = ( |
||||||
|
reflection_pb2.ServerReflectionResponse( |
||||||
|
valid_host='', |
||||||
|
file_descriptor_response=reflection_pb2.FileDescriptorResponse( |
||||||
|
file_descriptor_proto=( |
||||||
|
_file_descriptor_to_proto(empty_pb2.DESCRIPTOR), |
||||||
|
) |
||||||
|
) |
||||||
|
), |
||||||
|
reflection_pb2.ServerReflectionResponse( |
||||||
|
valid_host='', |
||||||
|
error_response=reflection_pb2.ErrorResponse( |
||||||
|
error_code=grpc.StatusCode.NOT_FOUND.value[0], |
||||||
|
error_message=grpc.StatusCode.NOT_FOUND.value[1].encode(), |
||||||
|
) |
||||||
|
), |
||||||
|
) |
||||||
|
self.assertEqual(expected_responses, responses) |
||||||
|
|
||||||
|
@unittest.skip('TODO(atash): implement file-containing-extension reflection ' |
||||||
|
'(see https://github.com/google/protobuf/issues/2248)') |
||||||
|
def testFileContainingExtension(self): |
||||||
|
requests = ( |
||||||
|
reflection_pb2.ServerReflectionRequest( |
||||||
|
file_containing_extension=reflection_pb2.ExtensionRequest( |
||||||
|
containing_type='grpc.testing.proto2.Empty', |
||||||
|
extension_number=125, |
||||||
|
), |
||||||
|
), |
||||||
|
reflection_pb2.ServerReflectionRequest( |
||||||
|
file_containing_extension=reflection_pb2.ExtensionRequest( |
||||||
|
containing_type='i.donut.exist.co.uk.org.net.me.name.foo', |
||||||
|
extension_number=55, |
||||||
|
), |
||||||
|
), |
||||||
|
) |
||||||
|
responses = tuple(self._stub.ServerReflectionInfo(requests)) |
||||||
|
expected_responses = ( |
||||||
|
reflection_pb2.ServerReflectionResponse( |
||||||
|
valid_host='', |
||||||
|
file_descriptor_response=reflection_pb2.FileDescriptorResponse( |
||||||
|
file_descriptor_proto=( |
||||||
|
_file_descriptor_to_proto(empty_extensions_pb2.DESCRIPTOR), |
||||||
|
) |
||||||
|
) |
||||||
|
), |
||||||
|
reflection_pb2.ServerReflectionResponse( |
||||||
|
valid_host='', |
||||||
|
error_response=reflection_pb2.ErrorResponse( |
||||||
|
error_code=grpc.StatusCode.NOT_FOUND.value[0], |
||||||
|
error_message=grpc.StatusCode.NOT_FOUND.value[1].encode(), |
||||||
|
) |
||||||
|
), |
||||||
|
) |
||||||
|
self.assertEqual(expected_responses, responses) |
||||||
|
|
||||||
|
def testListServices(self): |
||||||
|
requests = ( |
||||||
|
reflection_pb2.ServerReflectionRequest( |
||||||
|
list_services='', |
||||||
|
), |
||||||
|
) |
||||||
|
responses = tuple(self._stub.ServerReflectionInfo(requests)) |
||||||
|
expected_responses = ( |
||||||
|
reflection_pb2.ServerReflectionResponse( |
||||||
|
valid_host='', |
||||||
|
list_services_response=reflection_pb2.ListServiceResponse( |
||||||
|
service=tuple( |
||||||
|
reflection_pb2.ServiceResponse(name=name) |
||||||
|
for name in _SERVICE_NAMES |
||||||
|
) |
||||||
|
) |
||||||
|
), |
||||||
|
) |
||||||
|
self.assertEqual(expected_responses, responses) |
||||||
|
|
||||||
|
if __name__ == '__main__': |
||||||
|
unittest.main(verbosity=2) |
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue