Add benchmarks of closures, combiners, exec_ctx primitives

1 files changed, 341 insertions, 0 deletions

diff --git a/test/cpp/microbenchmarks/bm_closure.cc b/test/cpp/microbenchmarks/bm_closure.cc
new file mode 100644
index 0000000000..de354410e5
--- /dev/null
+++ b/test/cpp/microbenchmarks/bm_closure.cc
@@ -0,0 +1,341 @@
+/*
+ *
+ * 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.
+ *
+ */
+
+/* Test various closure related operations */
+
+#include <grpc/grpc.h>
+
+extern "C" {
+#include "src/core/lib/iomgr/closure.h"
+#include "src/core/lib/iomgr/combiner.h"
+#include "src/core/lib/iomgr/exec_ctx.h"
+}
+
+#include "third_party/benchmark/include/benchmark/benchmark.h"
+
+static class InitializeStuff {
+ public:
+  InitializeStuff() { grpc_init(); }
+  ~InitializeStuff() { grpc_shutdown(); }
+} initialize_stuff;
+
+static void BM_NoOpExecCtx(benchmark::State& state) {
+  while (state.KeepRunning()) {
+    grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+    grpc_exec_ctx_finish(&exec_ctx);
+  }
+}
+BENCHMARK(BM_NoOpExecCtx);
+
+static void BM_WellFlushed(benchmark::State& state) {
+  grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+  while (state.KeepRunning()) {
+    grpc_exec_ctx_flush(&exec_ctx);
+  }
+  grpc_exec_ctx_finish(&exec_ctx);
+}
+BENCHMARK(BM_WellFlushed);
+
+static void DoNothing(grpc_exec_ctx* exec_ctx, void* arg, grpc_error* error) {}
+
+static void BM_ClosureInitAgainstExecCtx(benchmark::State& state) {
+  grpc_closure c;
+  while (state.KeepRunning()) {
+    benchmark::DoNotOptimize(
+        grpc_closure_init(&c, DoNothing, NULL, grpc_schedule_on_exec_ctx));
+  }
+}
+BENCHMARK(BM_ClosureInitAgainstExecCtx);
+
+static void BM_ClosureInitAgainstCombiner(benchmark::State& state) {
+  grpc_combiner* combiner = grpc_combiner_create(NULL);
+  grpc_closure c;
+  grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+  while (state.KeepRunning()) {
+    benchmark::DoNotOptimize(grpc_closure_init(
+        &c, DoNothing, NULL, grpc_combiner_scheduler(combiner, false)));
+  }
+  GRPC_COMBINER_UNREF(&exec_ctx, combiner, "finished");
+  grpc_exec_ctx_finish(&exec_ctx);
+}
+BENCHMARK(BM_ClosureInitAgainstCombiner);
+
+static void BM_ClosureRunOnExecCtx(benchmark::State& state) {
+  grpc_closure c;
+  grpc_closure_init(&c, DoNothing, NULL, grpc_schedule_on_exec_ctx);
+  grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+  while (state.KeepRunning()) {
+    grpc_closure_run(&exec_ctx, &c, GRPC_ERROR_NONE);
+    grpc_exec_ctx_flush(&exec_ctx);
+  }
+  grpc_exec_ctx_finish(&exec_ctx);
+}
+BENCHMARK(BM_ClosureRunOnExecCtx);
+
+static void BM_ClosureCreateAndRun(benchmark::State& state) {
+  grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+  while (state.KeepRunning()) {
+    grpc_closure_run(&exec_ctx, grpc_closure_create(DoNothing, NULL,
+                                                    grpc_schedule_on_exec_ctx),
+                     GRPC_ERROR_NONE);
+  }
+  grpc_exec_ctx_finish(&exec_ctx);
+}
+BENCHMARK(BM_ClosureCreateAndRun);
+
+static void BM_ClosureInitAndRun(benchmark::State& state) {
+  grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+  grpc_closure c;
+  while (state.KeepRunning()) {
+    grpc_closure_run(&exec_ctx, grpc_closure_init(&c, DoNothing, NULL,
+                                                  grpc_schedule_on_exec_ctx),
+                     GRPC_ERROR_NONE);
+  }
+  grpc_exec_ctx_finish(&exec_ctx);
+}
+BENCHMARK(BM_ClosureInitAndRun);
+
+static void BM_ClosureSchedOnExecCtx(benchmark::State& state) {
+  grpc_closure c;
+  grpc_closure_init(&c, DoNothing, NULL, grpc_schedule_on_exec_ctx);
+  grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+  while (state.KeepRunning()) {
+    grpc_closure_sched(&exec_ctx, &c, GRPC_ERROR_NONE);
+    grpc_exec_ctx_flush(&exec_ctx);
+  }
+  grpc_exec_ctx_finish(&exec_ctx);
+}
+BENCHMARK(BM_ClosureSchedOnExecCtx);
+
+static void BM_ClosureSched2OnExecCtx(benchmark::State& state) {
+  grpc_closure c1;
+  grpc_closure c2;
+  grpc_closure_init(&c1, DoNothing, NULL, grpc_schedule_on_exec_ctx);
+  grpc_closure_init(&c2, DoNothing, NULL, grpc_schedule_on_exec_ctx);
+  grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+  while (state.KeepRunning()) {
+    grpc_closure_sched(&exec_ctx, &c1, GRPC_ERROR_NONE);
+    grpc_closure_sched(&exec_ctx, &c2, GRPC_ERROR_NONE);
+    grpc_exec_ctx_flush(&exec_ctx);
+  }
+  grpc_exec_ctx_finish(&exec_ctx);
+}
+BENCHMARK(BM_ClosureSched2OnExecCtx);
+
+static void BM_ClosureSched3OnExecCtx(benchmark::State& state) {
+  grpc_closure c1;
+  grpc_closure c2;
+  grpc_closure c3;
+  grpc_closure_init(&c1, DoNothing, NULL, grpc_schedule_on_exec_ctx);
+  grpc_closure_init(&c2, DoNothing, NULL, grpc_schedule_on_exec_ctx);
+  grpc_closure_init(&c3, DoNothing, NULL, grpc_schedule_on_exec_ctx);
+  grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+  while (state.KeepRunning()) {
+    grpc_closure_sched(&exec_ctx, &c1, GRPC_ERROR_NONE);
+    grpc_closure_sched(&exec_ctx, &c2, GRPC_ERROR_NONE);
+    grpc_closure_sched(&exec_ctx, &c3, GRPC_ERROR_NONE);
+    grpc_exec_ctx_flush(&exec_ctx);
+  }
+  grpc_exec_ctx_finish(&exec_ctx);
+}
+BENCHMARK(BM_ClosureSched3OnExecCtx);
+
+static void BM_ClosureSchedOnCombiner(benchmark::State& state) {
+  grpc_combiner* combiner = grpc_combiner_create(NULL);
+  grpc_closure c;
+  grpc_closure_init(&c, DoNothing, NULL,
+                    grpc_combiner_scheduler(combiner, false));
+  grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+  while (state.KeepRunning()) {
+    grpc_closure_sched(&exec_ctx, &c, GRPC_ERROR_NONE);
+    grpc_exec_ctx_flush(&exec_ctx);
+  }
+  GRPC_COMBINER_UNREF(&exec_ctx, combiner, "finished");
+  grpc_exec_ctx_finish(&exec_ctx);
+}
+BENCHMARK(BM_ClosureSchedOnCombiner);
+
+static void BM_ClosureSched2OnCombiner(benchmark::State& state) {
+  grpc_combiner* combiner = grpc_combiner_create(NULL);
+  grpc_closure c1;
+  grpc_closure c2;
+  grpc_closure_init(&c1, DoNothing, NULL,
+                    grpc_combiner_scheduler(combiner, false));
+  grpc_closure_init(&c2, DoNothing, NULL,
+                    grpc_combiner_scheduler(combiner, false));
+  grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+  while (state.KeepRunning()) {
+    grpc_closure_sched(&exec_ctx, &c1, GRPC_ERROR_NONE);
+    grpc_closure_sched(&exec_ctx, &c2, GRPC_ERROR_NONE);
+    grpc_exec_ctx_flush(&exec_ctx);
+  }
+  GRPC_COMBINER_UNREF(&exec_ctx, combiner, "finished");
+  grpc_exec_ctx_finish(&exec_ctx);
+}
+BENCHMARK(BM_ClosureSched2OnCombiner);
+
+static void BM_ClosureSched3OnCombiner(benchmark::State& state) {
+  grpc_combiner* combiner = grpc_combiner_create(NULL);
+  grpc_closure c1;
+  grpc_closure c2;
+  grpc_closure c3;
+  grpc_closure_init(&c1, DoNothing, NULL,
+                    grpc_combiner_scheduler(combiner, false));
+  grpc_closure_init(&c2, DoNothing, NULL,
+                    grpc_combiner_scheduler(combiner, false));
+  grpc_closure_init(&c3, DoNothing, NULL,
+                    grpc_combiner_scheduler(combiner, false));
+  grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+  while (state.KeepRunning()) {
+    grpc_closure_sched(&exec_ctx, &c1, GRPC_ERROR_NONE);
+    grpc_closure_sched(&exec_ctx, &c2, GRPC_ERROR_NONE);
+    grpc_closure_sched(&exec_ctx, &c3, GRPC_ERROR_NONE);
+    grpc_exec_ctx_flush(&exec_ctx);
+  }
+  GRPC_COMBINER_UNREF(&exec_ctx, combiner, "finished");
+  grpc_exec_ctx_finish(&exec_ctx);
+}
+BENCHMARK(BM_ClosureSched3OnCombiner);
+
+static void BM_ClosureSched2OnTwoCombiners(benchmark::State& state) {
+  grpc_combiner* combiner1 = grpc_combiner_create(NULL);
+  grpc_combiner* combiner2 = grpc_combiner_create(NULL);
+  grpc_closure c1;
+  grpc_closure c2;
+  grpc_closure_init(&c1, DoNothing, NULL,
+                    grpc_combiner_scheduler(combiner1, false));
+  grpc_closure_init(&c2, DoNothing, NULL,
+                    grpc_combiner_scheduler(combiner2, false));
+  grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+  while (state.KeepRunning()) {
+    grpc_closure_sched(&exec_ctx, &c1, GRPC_ERROR_NONE);
+    grpc_closure_sched(&exec_ctx, &c2, GRPC_ERROR_NONE);
+    grpc_exec_ctx_flush(&exec_ctx);
+  }
+  GRPC_COMBINER_UNREF(&exec_ctx, combiner1, "finished");
+  GRPC_COMBINER_UNREF(&exec_ctx, combiner2, "finished");
+  grpc_exec_ctx_finish(&exec_ctx);
+}
+BENCHMARK(BM_ClosureSched2OnTwoCombiners);
+
+static void BM_ClosureSched4OnTwoCombiners(benchmark::State& state) {
+  grpc_combiner* combiner1 = grpc_combiner_create(NULL);
+  grpc_combiner* combiner2 = grpc_combiner_create(NULL);
+  grpc_closure c1;
+  grpc_closure c2;
+  grpc_closure c3;
+  grpc_closure c4;
+  grpc_closure_init(&c1, DoNothing, NULL,
+                    grpc_combiner_scheduler(combiner1, false));
+  grpc_closure_init(&c2, DoNothing, NULL,
+                    grpc_combiner_scheduler(combiner2, false));
+  grpc_closure_init(&c3, DoNothing, NULL,
+                    grpc_combiner_scheduler(combiner1, false));
+  grpc_closure_init(&c4, DoNothing, NULL,
+                    grpc_combiner_scheduler(combiner2, false));
+  grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+  while (state.KeepRunning()) {
+    grpc_closure_sched(&exec_ctx, &c1, GRPC_ERROR_NONE);
+    grpc_closure_sched(&exec_ctx, &c2, GRPC_ERROR_NONE);
+    grpc_closure_sched(&exec_ctx, &c3, GRPC_ERROR_NONE);
+    grpc_closure_sched(&exec_ctx, &c4, GRPC_ERROR_NONE);
+    grpc_exec_ctx_flush(&exec_ctx);
+  }
+  GRPC_COMBINER_UNREF(&exec_ctx, combiner1, "finished");
+  GRPC_COMBINER_UNREF(&exec_ctx, combiner2, "finished");
+  grpc_exec_ctx_finish(&exec_ctx);
+}
+BENCHMARK(BM_ClosureSched4OnTwoCombiners);
+
+// Helper that continuously reschedules the same closure against something until
+// the benchmark is complete
+class Rescheduler {
+ public:
+  Rescheduler(benchmark::State& state, grpc_closure_scheduler* scheduler)
+      : state_(state) {
+    grpc_closure_init(&closure_, Step, this, scheduler);
+  }
+
+  void ScheduleFirst(grpc_exec_ctx* exec_ctx) {
+    grpc_closure_sched(exec_ctx, &closure_, GRPC_ERROR_NONE);
+  }
+
+  void ScheduleFirstAgainstDifferentScheduler(
+      grpc_exec_ctx* exec_ctx, grpc_closure_scheduler* scheduler) {
+    grpc_closure_sched(exec_ctx, grpc_closure_create(Step, this, scheduler),
+                       GRPC_ERROR_NONE);
+  }
+
+ private:
+  benchmark::State& state_;
+  grpc_closure closure_;
+
+  static void Step(grpc_exec_ctx* exec_ctx, void* arg, grpc_error* error) {
+    Rescheduler* self = static_cast<Rescheduler*>(arg);
+    if (self->state_.KeepRunning()) {
+      grpc_closure_sched(exec_ctx, &self->closure_, GRPC_ERROR_NONE);
+    }
+  }
+};
+
+static void BM_ClosureReschedOnExecCtx(benchmark::State& state) {
+  grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+  Rescheduler(state, grpc_schedule_on_exec_ctx).ScheduleFirst(&exec_ctx);
+  grpc_exec_ctx_finish(&exec_ctx);
+}
+BENCHMARK(BM_ClosureReschedOnExecCtx);
+
+static void BM_ClosureReschedOnCombiner(benchmark::State& state) {
+  grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+  grpc_combiner* combiner = grpc_combiner_create(NULL);
+  Rescheduler(state, grpc_combiner_scheduler(combiner, false))
+      .ScheduleFirst(&exec_ctx);
+  grpc_exec_ctx_flush(&exec_ctx);
+  GRPC_COMBINER_UNREF(&exec_ctx, combiner, "finished");
+  grpc_exec_ctx_finish(&exec_ctx);
+}
+BENCHMARK(BM_ClosureReschedOnCombiner);
+
+static void BM_ClosureReschedOnCombinerFinally(benchmark::State& state) {
+  grpc_exec_ctx exec_ctx = GRPC_EXEC_CTX_INIT;
+  grpc_combiner* combiner = grpc_combiner_create(NULL);
+  Rescheduler(state, grpc_combiner_finally_scheduler(combiner, false))
+      .ScheduleFirstAgainstDifferentScheduler(
+          &exec_ctx, grpc_combiner_scheduler(combiner, false));
+  grpc_exec_ctx_flush(&exec_ctx);
+  GRPC_COMBINER_UNREF(&exec_ctx, combiner, "finished");
+  grpc_exec_ctx_finish(&exec_ctx);
+}
+BENCHMARK(BM_ClosureReschedOnCombinerFinally);
+
+BENCHMARK_MAIN();