executionState.hpp

Go to the documentation of this file.

/*
 *   Copyright 2025 Huawei Technologies Co., Ltd.
 *
 * 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
 *
 *     http://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.
 */
 
#pragma once
 
#include <memory>
#include <hicr/core/definitions.hpp>
#include <hicr/core/exceptions.hpp>
#include <hicr/core/executionUnit.hpp>
 
namespace HiCR
{
 
class ExecutionState
{
  public:
 
  enum state_t
  {
    uninitialized,
 
    initialized,
 
    running,
 
    suspended,
 
    finished
  };
 
  __INLINE__ void resume()
  {
    if (_state != state_t::initialized && _state != state_t::suspended)
      HICR_THROW_RUNTIME("Attempting to resume an execution state that is not in a initialized or suspended state (State: %d).\n", _state);
 
    // Setting state as running
    _state = state_t::running;
 
    // Calling internal implementation of the suspend routine
    resumeImpl();
  }
 
  __INLINE__ void suspend()
  {
    if (_state != state_t::running) HICR_THROW_RUNTIME("Attempting to suspend an execution state that is not in a running state (State: %d).\n", _state);
 
    // Setting state as suspended
    _state = state_t::suspended;
 
    // Calling internal implementation of the suspend routine
    suspendImpl();
  }
 
  __INLINE__ bool checkFinalization()
  {
    // Calling internal implementation of the checkFinalization routine
    auto isFinished = checkFinalizationImpl();
 
    // Updating internal state
    if (isFinished == true) _state = state_t::finished;
 
    // Returning value
    return isFinished;
  }
 
  __INLINE__ state_t getState() { return _state; }
 
  ExecutionState() = delete;
 
  virtual ~ExecutionState() = default;
 
  protected:
 
  ExecutionState(const std::shared_ptr<HiCR::ExecutionUnit> &executionUnit){};
 
  virtual void resumeImpl() = 0;
 
  virtual void suspendImpl() = 0;
 
  virtual bool checkFinalizationImpl() = 0;
 
  private:
 
  state_t _state = state_t::initialized;
};
 
} // namespace HiCR