WorkScheduler.h

// Copyright 2024, UChicago Argonne, LLC
// All Rights Reserved
// Software Name: NEML2 -- the New Engineering material Model Library, version 2
// By: Argonne National Laboratory
// OPEN SOURCE LICENSE (MIT)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#pragma once
 
#include <mutex>
#include <condition_variable>
 
#include "neml2/base/NEML2Object.h"
#include "neml2/misc/types.h"
#include "neml2/base/TracingInterface.h"
 
namespace neml2
{
class WorkScheduler : public NEML2Object, public TracingInterface
{
public:
  static OptionSet expected_options();
 
  WorkScheduler(const OptionSet & options);
 
  void schedule_work(Device &, std::size_t &);
 
  void dispatched_work(Device, std::size_t);
 
  void completed_work(Device, std::size_t);
 
  void wait_for_completion();
 
  virtual std::vector<Device> devices() const { return std::vector<Device>(); }
 
protected:
  virtual bool schedule_work_impl(Device &, std::size_t &) const = 0;
 
  virtual void dispatched_work_impl(Device, std::size_t) = 0;
 
  virtual void completed_work_impl(Device, std::size_t) = 0;
 
  virtual bool all_work_completed() const = 0;
 
  std::condition_variable _condition;
 
private:
  std::mutex _mutex;
};
} // namespace neml2