Remove alarm from core, implement in C++ layer only

7 files changed, 129 insertions, 199 deletions

diff --git a/src/core/lib/surface/alarm.cc b/src/core/lib/surface/alarm.cc
deleted file mode 100644
index f6ea016c33..0000000000
--- a/src/core/lib/surface/alarm.cc
+++ /dev/null
@@ -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");
-}
diff --git a/src/core/lib/surface/alarm_internal.h b/src/core/lib/surface/alarm_internal.h
deleted file mode 100644
index 99e981234d..0000000000
--- a/src/core/lib/surface/alarm_internal.h
+++ /dev/null
@@ -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 */
diff --git a/src/core/lib/surface/init.cc b/src/core/lib/surface/init.cc
index 70329b09f4..89440d7a15 100644
--- a/src/core/lib/surface/init.cc
+++ b/src/core/lib/surface/init.cc
@@ -42,7 +42,6 @@
 #include "src/core/lib/iomgr/timer_manager.h"
 #include "src/core/lib/profiling/timers.h"
 #include "src/core/lib/slice/slice_internal.h"
-#include "src/core/lib/surface/alarm_internal.h"
 #include "src/core/lib/surface/api_trace.h"
 #include "src/core/lib/surface/call.h"
 #include "src/core/lib/surface/channel_init.h"
diff --git a/src/cpp/common/alarm.cc b/src/cpp/common/alarm.cc
new file mode 100644
index 0000000000..a4c54ed8a3
--- /dev/null
+++ b/src/cpp/common/alarm.cc
@@ -0,0 +1,129 @@
+/*
+ * 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:
+  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->tag_, error,
+                            [](void* arg, grpc_cq_completion* completion) {
+                              AlarmImpl* alarm = static_cast<AlarmImpl*>(arg);
+                              alarm->Unref();
+                            },
+                            arg, &alarm->completion_);
+                      },
+                      this, grpc_schedule_on_exec_ctx);
+  }
+  ~AlarmImpl() {
+    grpc_core::ExecCtx exec_ctx;
+    if (cq_ != nullptr) {
+      GRPC_CQ_INTERNAL_UNREF(cq_, "alarm");
+    }
+  }
+  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_.Set(tag);
+    GPR_ASSERT(grpc_cq_begin_op(cq_, &tag_));
+    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:
+  class AlarmEntry : public internal::CompletionQueueTag {
+   public:
+    AlarmEntry(void* tag) : tag_(tag) {}
+    void Set(void* tag) { tag_ = tag; }
+    bool FinalizeResult(void** tag, bool* status) override {
+      *tag = tag_;
+      return true;
+    }
+
+   private:
+    void* tag_;
+  };
+
+  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_;
+  AlarmEntry 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) {
+  alarm_->Set(cq, deadline, tag);
+}
+
+Alarm::~Alarm() {
+  if (alarm_ != nullptr) {
+    alarm_->Destroy();
+  }
+}
+
+void Alarm::Cancel() { alarm_->Cancel(); }
+}  // namespace grpc
diff --git a/src/python/grpcio/grpc_core_dependencies.py b/src/python/grpcio/grpc_core_dependencies.py
index 9debb22249..1cea838df0 100644
--- a/src/python/grpcio/grpc_core_dependencies.py
+++ b/src/python/grpcio/grpc_core_dependencies.py
@@ -161,7 +161,6 @@ CORE_SOURCE_FILES = [
     'src/core/lib/slice/slice_hash_table.cc',
     'src/core/lib/slice/slice_intern.cc',
     'src/core/lib/slice/slice_string_helpers.cc',
-    'src/core/lib/surface/alarm.cc',
     'src/core/lib/surface/api_trace.cc',
     'src/core/lib/surface/byte_buffer.cc',
     'src/core/lib/surface/byte_buffer_reader.cc',
diff --git a/src/ruby/ext/grpc/rb_grpc_imports.generated.c b/src/ruby/ext/grpc/rb_grpc_imports.generated.c
index 56f1d4c93f..40fc069580 100644
--- a/src/ruby/ext/grpc/rb_grpc_imports.generated.c
+++ b/src/ruby/ext/grpc/rb_grpc_imports.generated.c
@@ -51,10 +51,6 @@ grpc_completion_queue_shutdown_type grpc_completion_queue_shutdown_import;
 grpc_completion_queue_destroy_type grpc_completion_queue_destroy_import;
 grpc_completion_queue_thread_local_cache_init_type grpc_completion_queue_thread_local_cache_init_import;
 grpc_completion_queue_thread_local_cache_flush_type grpc_completion_queue_thread_local_cache_flush_import;
-grpc_alarm_create_type grpc_alarm_create_import;
-grpc_alarm_set_type grpc_alarm_set_import;
-grpc_alarm_cancel_type grpc_alarm_cancel_import;
-grpc_alarm_destroy_type grpc_alarm_destroy_import;
 grpc_channel_check_connectivity_state_type grpc_channel_check_connectivity_state_import;
 grpc_channel_num_external_connectivity_watchers_type grpc_channel_num_external_connectivity_watchers_import;
 grpc_channel_watch_connectivity_state_type grpc_channel_watch_connectivity_state_import;
@@ -323,10 +319,6 @@ void grpc_rb_load_imports(HMODULE library) {
   grpc_completion_queue_destroy_import = (grpc_completion_queue_destroy_type) GetProcAddress(library, "grpc_completion_queue_destroy");
   grpc_completion_queue_thread_local_cache_init_import = (grpc_completion_queue_thread_local_cache_init_type) GetProcAddress(library, "grpc_completion_queue_thread_local_cache_init");
   grpc_completion_queue_thread_local_cache_flush_import = (grpc_completion_queue_thread_local_cache_flush_type) GetProcAddress(library, "grpc_completion_queue_thread_local_cache_flush");
-  grpc_alarm_create_import = (grpc_alarm_create_type) GetProcAddress(library, "grpc_alarm_create");
-  grpc_alarm_set_import = (grpc_alarm_set_type) GetProcAddress(library, "grpc_alarm_set");
-  grpc_alarm_cancel_import = (grpc_alarm_cancel_type) GetProcAddress(library, "grpc_alarm_cancel");
-  grpc_alarm_destroy_import = (grpc_alarm_destroy_type) GetProcAddress(library, "grpc_alarm_destroy");
   grpc_channel_check_connectivity_state_import = (grpc_channel_check_connectivity_state_type) GetProcAddress(library, "grpc_channel_check_connectivity_state");
   grpc_channel_num_external_connectivity_watchers_import = (grpc_channel_num_external_connectivity_watchers_type) GetProcAddress(library, "grpc_channel_num_external_connectivity_watchers");
   grpc_channel_watch_connectivity_state_import = (grpc_channel_watch_connectivity_state_type) GetProcAddress(library, "grpc_channel_watch_connectivity_state");
diff --git a/src/ruby/ext/grpc/rb_grpc_imports.generated.h b/src/ruby/ext/grpc/rb_grpc_imports.generated.h
index 6377008a3b..b18827fd19 100644
--- a/src/ruby/ext/grpc/rb_grpc_imports.generated.h
+++ b/src/ruby/ext/grpc/rb_grpc_imports.generated.h
@@ -132,18 +132,6 @@ extern grpc_completion_queue_thread_local_cache_init_type grpc_completion_queue_
 typedef int(*grpc_completion_queue_thread_local_cache_flush_type)(grpc_completion_queue* cq, void** tag, int* ok);
 extern grpc_completion_queue_thread_local_cache_flush_type grpc_completion_queue_thread_local_cache_flush_import;
 #define grpc_completion_queue_thread_local_cache_flush grpc_completion_queue_thread_local_cache_flush_import
-typedef grpc_alarm*(*grpc_alarm_create_type)(void* reserved);
-extern grpc_alarm_create_type grpc_alarm_create_import;
-#define grpc_alarm_create grpc_alarm_create_import
-typedef void(*grpc_alarm_set_type)(grpc_alarm* alarm, grpc_completion_queue* cq, gpr_timespec deadline, void* tag, void* reserved);
-extern grpc_alarm_set_type grpc_alarm_set_import;
-#define grpc_alarm_set grpc_alarm_set_import
-typedef void(*grpc_alarm_cancel_type)(grpc_alarm* alarm, void* reserved);
-extern grpc_alarm_cancel_type grpc_alarm_cancel_import;
-#define grpc_alarm_cancel grpc_alarm_cancel_import
-typedef void(*grpc_alarm_destroy_type)(grpc_alarm* alarm, void* reserved);
-extern grpc_alarm_destroy_type grpc_alarm_destroy_import;
-#define grpc_alarm_destroy grpc_alarm_destroy_import
 typedef grpc_connectivity_state(*grpc_channel_check_connectivity_state_type)(grpc_channel* channel, int try_to_connect);
 extern grpc_channel_check_connectivity_state_type grpc_channel_check_connectivity_state_import;
 #define grpc_channel_check_connectivity_state grpc_channel_check_connectivity_state_import