AimRT/_deps/libunifex-src/test/async_scope_test.cpp

/*
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * Licensed under the Apache License Version 2.0 with LLVM Exceptions
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *   https://llvm.org/LICENSE.txt
 *
 * 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 <unifex/async_scope.hpp>

#include <unifex/just_from.hpp>
#include <unifex/let_value_with.hpp>
#include <unifex/scope_guard.hpp>
#include <unifex/sequence.hpp>
#include <unifex/single_thread_context.hpp>
#include <unifex/sync_wait.hpp>
#include <unifex/then.hpp>

#include <gtest/gtest.h>

#include <array>
#include <atomic>

using unifex::async_manual_reset_event;
using unifex::async_scope;
using unifex::connect;
using unifex::get_scheduler;
using unifex::get_stop_token;
using unifex::just_from;
using unifex::let_value_with;
using unifex::schedule;
using unifex::scope_guard;
using unifex::sequence;
using unifex::single_thread_context;
using unifex::start;
using unifex::sync_wait;
using unifex::tag_t;
using unifex::then;

struct signal_on_destruction {
  async_manual_reset_event* destroyed_;
  signal_on_destruction(async_manual_reset_event* destroyed) noexcept
    : destroyed_(destroyed)
  {}
  signal_on_destruction(signal_on_destruction&& other) noexcept
    : destroyed_(std::exchange(other.destroyed_, nullptr))
  {}
  ~signal_on_destruction() {
    if (destroyed_)
      destroyed_->set();
  }
};

struct async_scope_test : testing::Test {
  async_scope scope;
  single_thread_context thread;

  void spawn_work_after_cleanup() {
    sync_wait(scope.cleanup());

    async_manual_reset_event destroyed;
    bool executed = false;

    scope.spawn_on(
        thread.get_scheduler(),
        let_value_with(
          [&, tmp = signal_on_destruction{&destroyed}]() noexcept {
            executed = true;
            return 42;
          },
          [&](auto&) noexcept {
            return just_from([&]() noexcept {
              executed = true;
            });
          }));

    sync_wait(destroyed.async_wait());

    EXPECT_FALSE(executed);
  }

  void expect_work_to_run() {
    async_manual_reset_event evt;

    scope.spawn_on(
      thread.get_scheduler(),
      just_from([&]() noexcept {
        evt.set();
      }));

    // we'll hang here if the above work doesn't start
    sync_wait(evt.async_wait());
  }

  void expect_work_to_run_call_on() {
    async_manual_reset_event evt;

    scope.spawn_call_on(
      thread.get_scheduler(),
      [&]() noexcept { evt.set(); });

    // we'll hang here if the above work doesn't start
    sync_wait(evt.async_wait());
  }
};

TEST_F(async_scope_test, spawning_after_cleaning_up_destroys_the_sender) {
  spawn_work_after_cleanup();
}

TEST_F(async_scope_test, cleanup_is_idempotent) {
  sync_wait(scope.cleanup());

  spawn_work_after_cleanup();
}

TEST_F(async_scope_test, spawning_work_makes_it_run) {
  expect_work_to_run();

  sync_wait(scope.cleanup());
}

TEST_F(async_scope_test, spawning_work_makes_it_run_with_lambda) {
  expect_work_to_run_call_on();

  sync_wait(scope.cleanup());
}

TEST_F(async_scope_test, scope_not_stopped_until_cleanup_is_started) {
  auto cleanup = scope.cleanup();

  expect_work_to_run();

  sync_wait(std::move(cleanup));
}

TEST_F(async_scope_test, work_spawned_in_correct_context) {
  async_manual_reset_event evt;
  std::thread::id id;
  scope.spawn_on(
      thread.get_scheduler(),
      just_from([&]{
        id = std::this_thread::get_id();
        evt.set();
      }));
  sync_wait(evt.async_wait());
  sync_wait(scope.cleanup());
  EXPECT_EQ(id, thread.get_thread_id());
  EXPECT_NE(id, std::this_thread::get_id());
}

TEST_F(async_scope_test, lots_of_threads_works) {
#if !defined(UNIFEX_TEST_LIMIT_ASYNC_SCOPE_THREADS)
  constexpr int maxCount = 1'000;
#else
  constexpr int maxCount = UNIFEX_TEST_LIMIT_ASYNC_SCOPE_THREADS;
#endif

  std::array<single_thread_context, maxCount> threads;

  async_manual_reset_event evt1, evt2, evt3;
  std::atomic<int> count{0};

  struct decr {
    decr(std::atomic<int>& count, async_manual_reset_event& evt) noexcept
        : count_(&count),
          evt_(&evt) {
    }

    decr(decr&& other) = delete;

    ~decr() {
      UNIFEX_ASSERT(evt_->ready());
      count_->fetch_sub(1, std::memory_order_relaxed);
    }

    std::atomic<int>* count_;
    async_manual_reset_event* evt_;
  };

  for (auto& thread : threads) {
    // Spawn maxCount jobs that are all waiting on unique threads to spawn a
    // job each that increments count and then waits. The last job to increment
    // count will unblock the waiting jobs, so the group will then race to tear
    // themselves down.  On tear-down, decrement count again so that it can be
    // expected to be zero once everything's done.
    //
    // This should stress-test job submission and cancellation.
    scope.spawn_on(
      thread.get_scheduler(),
      then(
        evt1.async_wait(),
        [&]() noexcept {
          scope.spawn_on(
              thread.get_scheduler(),
              let_value_with(
                [&] { return decr{count, evt3}; },
                [&](decr&) noexcept {
                  return sequence(
                      just_from(
                        [&]() noexcept {
                          auto prev = count.fetch_add(1, std::memory_order_relaxed);
                          if (prev + 1 == maxCount) {
                            evt2.set();
                          }
                        }),
                      evt3.async_wait());
                }));
            }));
  }

  // launch the race to spawn work
  evt1.set();

  // wait until count has been incremented to maxCount
  sync_wait(evt2.async_wait());

  EXPECT_EQ(count.load(std::memory_order_relaxed), maxCount);

  // launch the race to tear down
  evt3.set();

  // wait for everyone to finish tearing down
  sync_wait(scope.cleanup());

  EXPECT_EQ(count.load(std::memory_order_relaxed), 0);
}