StaticHybridScheduler.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 "neml2/dispatchers/WorkScheduler.h"
 
namespace neml2
{
class StaticHybridScheduler : public WorkScheduler
{
public:
  struct DeviceStatus
  {
    DeviceStatus(Device device, std::size_t batch_size, std::size_t capacity, double priority)
      : device(device),
        batch_size(batch_size),
        capacity(capacity),
        priority(priority)
    {
    }
 
    Device device;
    std::size_t batch_size;
    std::size_t capacity;
    double priority;
    std::size_t load = 0;
  };

  static OptionSet expected_options();

  StaticHybridScheduler(const OptionSet & options);

  void setup() override;

  void set_availability_calculator(std::function<double(const DeviceStatus &)>);
 
  const std::vector<DeviceStatus> & status() const { return _devices; }
 
  std::vector<Device> devices() const override { return _available_devices; }
 
protected:
  bool schedule_work_impl(Device &, std::size_t &) const override;
  void dispatched_work_impl(Device, std::size_t) override;
  void completed_work_impl(Device, std::size_t) override;
  bool all_work_completed() const override;
 
private:
  std::vector<Device> _available_devices;

  bool _cpu = false;

  bool _cuda = false;

  std::vector<DeviceStatus> _devices;

  std::function<double(const DeviceStatus &)> _custom_availability_calculator;
};
} // namespace neml2