third_party/marl/src/scheduler_bench.cpp

// Copyright 2020 The Marl 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
//
//     https://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 "marl_bench.h"

#include "marl/waitgroup.h"

#include "benchmark/benchmark.h"

BENCHMARK_DEFINE_F(Schedule, Empty)(benchmark::State& state) {
  run(state, [&](int numTasks) {
    for (auto _ : state) {
      for (auto i = 0; i < numTasks; i++) {
        marl::schedule([] {});
      }
    }
  });
}
BENCHMARK_REGISTER_F(Schedule, Empty)->Apply(Schedule::args);

BENCHMARK_DEFINE_F(Schedule, SomeWork)
(benchmark::State& state) {
  run(state, [&](int numTasks) {
    for (auto _ : state) {
      marl::WaitGroup wg;
      wg.add(numTasks);
      for (auto i = 0; i < numTasks; i++) {
        marl::schedule([=] {
          uint32_t value = doSomeWork(i);
          benchmark::DoNotOptimize(value);
          wg.done();
        });
      }
      wg.wait();
    }
  });
}
BENCHMARK_REGISTER_F(Schedule, SomeWork)->Apply(Schedule::args);

BENCHMARK_DEFINE_F(Schedule, MultipleForkAndJoin)(benchmark::State& state) {
  run(state, [&](int numTasks) {
    const int batchSize = std::max(1, Schedule::numThreads(state));
    for (auto _ : state) {
      marl::WaitGroup wg;
      for (int i = 0; i < numTasks; i++) {
        wg.add(1);
        marl::schedule([=] {
          // Give each task a significant amount of work so that concurrency matters.
          // If any worker performs more than one task, it will affect the results.
          int value = i;
          for (int j = 0; j < 256; ++j) {
            value = doSomeWork(value);
          }
          benchmark::DoNotOptimize(value);
          wg.done();
        });
        // Wait for completion after every batch. This simulates the fork-and-join pattern.
        if ((i + 1) % batchSize == 0) {
          wg.wait();
        }
      }
      wg.wait();
    }
  });
}

BENCHMARK_REGISTER_F(Schedule, MultipleForkAndJoin)->Apply(Schedule::args<512>);

BENCHMARK_DEFINE_F(Schedule, SomeWorkWorkerAffinityOneOf)
(benchmark::State& state) {
  marl::Scheduler::Config cfg;
  cfg.setWorkerThreadAffinityPolicy(
      marl::Thread::Affinity::Policy::oneOf(marl::Thread::Affinity::all()));
  run(state, cfg, [&](int numTasks) {
    for (auto _ : state) {
      marl::WaitGroup wg;
      wg.add(numTasks);
      for (auto i = 0; i < numTasks; i++) {
        marl::schedule([=] {
          uint32_t value = doSomeWork(i);
          benchmark::DoNotOptimize(value);
          wg.done();
        });
      }
      wg.wait();
    }
  });
}
BENCHMARK_REGISTER_F(Schedule, SomeWorkWorkerAffinityOneOf)
    ->Apply(Schedule::args);