mirror of https://github.com/grpc/grpc.git
Merge pull request #14015 from vjpai/alarm
Remove alarm from core, implement in C++ layer onlypull/14295/head
Vijay Pai
7 years ago
committed by
GitHub
commit
e5b0a50416
33 changed files with 225 additions and 599 deletions
@ -1,137 +0,0 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2015 gRPC authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
* |
||||
*/ |
||||
#include <grpc/support/port_platform.h> |
||||
|
||||
#include <inttypes.h> |
||||
|
||||
#include "src/core/lib/surface/alarm_internal.h" |
||||
|
||||
#include <grpc/grpc.h> |
||||
#include <grpc/support/alloc.h> |
||||
#include <grpc/support/log.h> |
||||
#include "src/core/lib/iomgr/timer.h" |
||||
#include "src/core/lib/surface/completion_queue.h" |
||||
|
||||
grpc_core::DebugOnlyTraceFlag grpc_trace_alarm_refcount(false, |
||||
"alarm_refcount"); |
||||
|
||||
struct grpc_alarm { |
||||
gpr_refcount refs; |
||||
grpc_timer alarm; |
||||
grpc_closure on_alarm; |
||||
grpc_cq_completion completion; |
||||
/** completion queue where events about this alarm will be posted */ |
||||
grpc_completion_queue* cq; |
||||
/** user supplied tag */ |
||||
void* tag; |
||||
}; |
||||
|
||||
static void alarm_ref(grpc_alarm* alarm) { gpr_ref(&alarm->refs); } |
||||
|
||||
static void alarm_unref(grpc_alarm* alarm) { |
||||
if (gpr_unref(&alarm->refs)) { |
||||
grpc_core::ExecCtx exec_ctx; |
||||
if (alarm->cq != nullptr) { |
||||
GRPC_CQ_INTERNAL_UNREF(alarm->cq, "alarm"); |
||||
} |
||||
|
||||
gpr_free(alarm); |
||||
} |
||||
} |
||||
|
||||
#ifndef NDEBUG |
||||
static void alarm_ref_dbg(grpc_alarm* alarm, const char* reason, |
||||
const char* file, int line) { |
||||
if (grpc_trace_alarm_refcount.enabled()) { |
||||
gpr_atm val = gpr_atm_no_barrier_load(&alarm->refs.count); |
||||
gpr_log(file, line, GPR_LOG_SEVERITY_DEBUG, |
||||
"Alarm:%p ref %" PRIdPTR " -> %" PRIdPTR " %s", alarm, val, |
||||
val + 1, reason); |
||||
} |
||||
|
||||
alarm_ref(alarm); |
||||
} |
||||
|
||||
static void alarm_unref_dbg(grpc_alarm* alarm, const char* reason, |
||||
const char* file, int line) { |
||||
if (grpc_trace_alarm_refcount.enabled()) { |
||||
gpr_atm val = gpr_atm_no_barrier_load(&alarm->refs.count); |
||||
gpr_log(file, line, GPR_LOG_SEVERITY_DEBUG, |
||||
"Alarm:%p Unref %" PRIdPTR " -> %" PRIdPTR " %s", alarm, val, |
||||
val - 1, reason); |
||||
} |
||||
|
||||
alarm_unref(alarm); |
||||
} |
||||
#endif |
||||
|
||||
static void alarm_end_completion(void* arg, grpc_cq_completion* c) { |
||||
grpc_alarm* alarm = (grpc_alarm*)arg; |
||||
GRPC_ALARM_UNREF(alarm, "dequeue-end-op"); |
||||
} |
||||
|
||||
static void alarm_cb(void* arg, grpc_error* error) { |
||||
grpc_alarm* alarm = (grpc_alarm*)arg; |
||||
|
||||
/* We are queuing an op on completion queue. This means, the alarm's structure
|
||||
cannot be destroyed until the op is dequeued. Adding an extra ref |
||||
here and unref'ing when the op is dequeued will achieve this */ |
||||
GRPC_ALARM_REF(alarm, "queue-end-op"); |
||||
grpc_cq_end_op(alarm->cq, alarm->tag, error, alarm_end_completion, |
||||
(void*)alarm, &alarm->completion); |
||||
} |
||||
|
||||
grpc_alarm* grpc_alarm_create(void* reserved) { |
||||
grpc_alarm* alarm = (grpc_alarm*)gpr_malloc(sizeof(grpc_alarm)); |
||||
|
||||
#ifndef NDEBUG |
||||
if (grpc_trace_alarm_refcount.enabled()) { |
||||
gpr_log(GPR_DEBUG, "Alarm:%p created (ref: 1)", alarm); |
||||
} |
||||
#endif |
||||
|
||||
gpr_ref_init(&alarm->refs, 1); |
||||
grpc_timer_init_unset(&alarm->alarm); |
||||
alarm->cq = nullptr; |
||||
GRPC_CLOSURE_INIT(&alarm->on_alarm, alarm_cb, alarm, |
||||
grpc_schedule_on_exec_ctx); |
||||
return alarm; |
||||
} |
||||
|
||||
void grpc_alarm_set(grpc_alarm* alarm, grpc_completion_queue* cq, |
||||
gpr_timespec deadline, void* tag, void* reserved) { |
||||
grpc_core::ExecCtx exec_ctx; |
||||
|
||||
GRPC_CQ_INTERNAL_REF(cq, "alarm"); |
||||
alarm->cq = cq; |
||||
alarm->tag = tag; |
||||
|
||||
GPR_ASSERT(grpc_cq_begin_op(cq, tag)); |
||||
grpc_timer_init(&alarm->alarm, grpc_timespec_to_millis_round_up(deadline), |
||||
&alarm->on_alarm); |
||||
} |
||||
|
||||
void grpc_alarm_cancel(grpc_alarm* alarm, void* reserved) { |
||||
grpc_core::ExecCtx exec_ctx; |
||||
grpc_timer_cancel(&alarm->alarm); |
||||
} |
||||
|
||||
void grpc_alarm_destroy(grpc_alarm* alarm, void* reserved) { |
||||
grpc_alarm_cancel(alarm, reserved); |
||||
GRPC_ALARM_UNREF(alarm, "alarm_destroy"); |
||||
} |
||||
@ -1,40 +0,0 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2015-2017 gRPC authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
* |
||||
*/ |
||||
|
||||
#ifndef GRPC_CORE_LIB_SURFACE_ALARM_INTERNAL_H |
||||
#define GRPC_CORE_LIB_SURFACE_ALARM_INTERNAL_H |
||||
|
||||
#include <grpc/support/log.h> |
||||
#include "src/core/lib/debug/trace.h" |
||||
|
||||
extern grpc_core::DebugOnlyTraceFlag grpc_trace_alarm_refcount; |
||||
|
||||
#ifndef NDEBUG |
||||
|
||||
#define GRPC_ALARM_REF(a, reason) alarm_ref_dbg(a, reason, __FILE__, __LINE__) |
||||
#define GRPC_ALARM_UNREF(a, reason) \ |
||||
alarm_unref_dbg(a, reason, __FILE__, __LINE__) |
||||
|
||||
#else /* !defined(NDEBUG) */ |
||||
|
||||
#define GRPC_ALARM_REF(a, reason) alarm_ref(a) |
||||
#define GRPC_ALARM_UNREF(a, reason) alarm_unref(a) |
||||
|
||||
#endif /* defined(NDEBUG) */ |
||||
|
||||
#endif /* GRPC_CORE_LIB_SURFACE_ALARM_INTERNAL_H */ |
||||
@ -0,0 +1,123 @@ |
||||
/*
|
||||
* Copyright 2018 gRPC authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
* |
||||
*/ |
||||
|
||||
#include <grpc++/alarm.h> |
||||
|
||||
#include <memory> |
||||
|
||||
#include <grpc++/completion_queue.h> |
||||
#include <grpc++/impl/grpc_library.h> |
||||
#include <grpc++/support/time.h> |
||||
#include <grpc/support/log.h> |
||||
#include <grpc/support/port_platform.h> |
||||
#include "src/core/lib/iomgr/exec_ctx.h" |
||||
#include "src/core/lib/iomgr/timer.h" |
||||
#include "src/core/lib/surface/completion_queue.h" |
||||
|
||||
#include <grpc/support/log.h> |
||||
#include "src/core/lib/debug/trace.h" |
||||
|
||||
namespace grpc { |
||||
|
||||
namespace internal { |
||||
class AlarmImpl : public CompletionQueueTag { |
||||
public: |
||||
AlarmImpl() : cq_(nullptr), tag_(nullptr) { |
||||
gpr_ref_init(&refs_, 1); |
||||
grpc_timer_init_unset(&timer_); |
||||
GRPC_CLOSURE_INIT(&on_alarm_, |
||||
[](void* arg, grpc_error* error) { |
||||
// queue the op on the completion queue
|
||||
AlarmImpl* alarm = static_cast<AlarmImpl*>(arg); |
||||
alarm->Ref(); |
||||
grpc_cq_end_op( |
||||
alarm->cq_, alarm, error, |
||||
[](void* arg, grpc_cq_completion* completion) {}, |
||||
arg, &alarm->completion_); |
||||
}, |
||||
this, grpc_schedule_on_exec_ctx); |
||||
} |
||||
~AlarmImpl() { |
||||
grpc_core::ExecCtx exec_ctx; |
||||
if (cq_ != nullptr) { |
||||
GRPC_CQ_INTERNAL_UNREF(cq_, "alarm"); |
||||
} |
||||
} |
||||
bool FinalizeResult(void** tag, bool* status) override { |
||||
*tag = tag_; |
||||
Unref(); |
||||
return true; |
||||
} |
||||
void Set(CompletionQueue* cq, gpr_timespec deadline, void* tag) { |
||||
grpc_core::ExecCtx exec_ctx; |
||||
GRPC_CQ_INTERNAL_REF(cq->cq(), "alarm"); |
||||
cq_ = cq->cq(); |
||||
tag_ = tag; |
||||
GPR_ASSERT(grpc_cq_begin_op(cq_, this)); |
||||
grpc_timer_init(&timer_, grpc_timespec_to_millis_round_up(deadline), |
||||
&on_alarm_); |
||||
} |
||||
void Cancel() { |
||||
grpc_core::ExecCtx exec_ctx; |
||||
grpc_timer_cancel(&timer_); |
||||
} |
||||
void Destroy() { |
||||
Cancel(); |
||||
Unref(); |
||||
} |
||||
|
||||
private: |
||||
void Ref() { gpr_ref(&refs_); } |
||||
void Unref() { |
||||
if (gpr_unref(&refs_)) { |
||||
delete this; |
||||
} |
||||
} |
||||
|
||||
grpc_timer timer_; |
||||
gpr_refcount refs_; |
||||
grpc_closure on_alarm_; |
||||
grpc_cq_completion completion_; |
||||
// completion queue where events about this alarm will be posted
|
||||
grpc_completion_queue* cq_; |
||||
void* tag_; |
||||
}; |
||||
} // namespace internal
|
||||
|
||||
static internal::GrpcLibraryInitializer g_gli_initializer; |
||||
|
||||
Alarm::Alarm() : alarm_(new internal::AlarmImpl()) { |
||||
g_gli_initializer.summon(); |
||||
} |
||||
|
||||
void Alarm::SetInternal(CompletionQueue* cq, gpr_timespec deadline, void* tag) { |
||||
// Note that we know that alarm_ is actually an internal::AlarmImpl
|
||||
// but we declared it as the base pointer to avoid a forward declaration
|
||||
// or exposing core data structures in the C++ public headers.
|
||||
// Thus it is safe to use a static_cast to the subclass here, and the
|
||||
// C++ style guide allows us to do so in this case
|
||||
static_cast<internal::AlarmImpl*>(alarm_)->Set(cq, deadline, tag); |
||||
} |
||||
|
||||
Alarm::~Alarm() { |
||||
if (alarm_ != nullptr) { |
||||
static_cast<internal::AlarmImpl*>(alarm_)->Destroy(); |
||||
} |
||||
} |
||||
|
||||
void Alarm::Cancel() { static_cast<internal::AlarmImpl*>(alarm_)->Cancel(); } |
||||
} // namespace grpc
|
||||
@ -1,116 +0,0 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2015 gRPC authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
* |
||||
*/ |
||||
|
||||
#include <grpc/grpc.h> |
||||
#include <grpc/support/alloc.h> |
||||
#include <grpc/support/log.h> |
||||
#include <grpc/support/time.h> |
||||
#include <grpc/support/useful.h> |
||||
#include "test/core/util/test_config.h" |
||||
|
||||
#define LOG_TEST(x) gpr_log(GPR_INFO, "%s", x) |
||||
|
||||
static void* create_test_tag(void) { |
||||
static intptr_t i = 0; |
||||
return (void*)(++i); |
||||
} |
||||
|
||||
/* helper for tests to shutdown correctly and tersely */ |
||||
static void shutdown_and_destroy(grpc_completion_queue* cc) { |
||||
grpc_event ev; |
||||
grpc_completion_queue_shutdown(cc); |
||||
/* By the time grpc_completion_queue_shutdown runs, the cq's internal
|
||||
pending event counter might not have been updated yet by a previous |
||||
cq_end_op_for_next (which releases a completed event first and only later |
||||
updates the pending event counter), so we can't rely on a no-polling |
||||
cq_next to never return GRPC_QUEUE_TIMEOUT. Using a deadline in the future |
||||
solves the problem. See https://github.com/grpc/grpc/issues/13693.
|
||||
*/ |
||||
ev = grpc_completion_queue_next(cc, grpc_timeout_seconds_to_deadline(2), |
||||
nullptr); |
||||
GPR_ASSERT(ev.type == GRPC_QUEUE_SHUTDOWN); |
||||
grpc_completion_queue_destroy(cc); |
||||
} |
||||
|
||||
static void test_alarm(void) { |
||||
grpc_completion_queue* cc; |
||||
|
||||
LOG_TEST("test_alarm"); |
||||
cc = grpc_completion_queue_create_for_next(nullptr); |
||||
{ |
||||
/* regular expiry */ |
||||
grpc_event ev; |
||||
void* tag = create_test_tag(); |
||||
grpc_alarm* alarm = grpc_alarm_create(nullptr); |
||||
grpc_alarm_set(alarm, cc, grpc_timeout_seconds_to_deadline(1), tag, |
||||
nullptr); |
||||
|
||||
ev = grpc_completion_queue_next(cc, grpc_timeout_seconds_to_deadline(2), |
||||
nullptr); |
||||
GPR_ASSERT(ev.type == GRPC_OP_COMPLETE); |
||||
GPR_ASSERT(ev.tag == tag); |
||||
GPR_ASSERT(ev.success); |
||||
grpc_alarm_destroy(alarm, nullptr); |
||||
} |
||||
{ |
||||
/* cancellation */ |
||||
grpc_event ev; |
||||
void* tag = create_test_tag(); |
||||
grpc_alarm* alarm = grpc_alarm_create(nullptr); |
||||
grpc_alarm_set(alarm, cc, grpc_timeout_seconds_to_deadline(2), tag, |
||||
nullptr); |
||||
|
||||
grpc_alarm_cancel(alarm, nullptr); |
||||
ev = grpc_completion_queue_next(cc, grpc_timeout_seconds_to_deadline(1), |
||||
nullptr); |
||||
GPR_ASSERT(ev.type == GRPC_OP_COMPLETE); |
||||
GPR_ASSERT(ev.tag == tag); |
||||
GPR_ASSERT(ev.success == 0); |
||||
grpc_alarm_destroy(alarm, nullptr); |
||||
} |
||||
{ |
||||
/* alarm_destroy before cq_next */ |
||||
grpc_event ev; |
||||
void* tag = create_test_tag(); |
||||
grpc_alarm* alarm = grpc_alarm_create(nullptr); |
||||
grpc_alarm_set(alarm, cc, grpc_timeout_seconds_to_deadline(2), tag, |
||||
nullptr); |
||||
|
||||
grpc_alarm_destroy(alarm, nullptr); |
||||
ev = grpc_completion_queue_next(cc, grpc_timeout_seconds_to_deadline(1), |
||||
nullptr); |
||||
GPR_ASSERT(ev.type == GRPC_OP_COMPLETE); |
||||
GPR_ASSERT(ev.tag == tag); |
||||
GPR_ASSERT(ev.success == 0); |
||||
} |
||||
{ |
||||
/* alarm_destroy before set */ |
||||
grpc_alarm* alarm = grpc_alarm_create(nullptr); |
||||
grpc_alarm_destroy(alarm, nullptr); |
||||
} |
||||
|
||||
shutdown_and_destroy(cc); |
||||
} |
||||
|
||||
int main(int argc, char** argv) { |
||||
grpc_test_init(argc, argv); |
||||
grpc_init(); |
||||
test_alarm(); |
||||
grpc_shutdown(); |
||||
return 0; |
||||
} |
||||
Loading…
Reference in new issue