/******************************************************************************
 * Copyright (c) 2024 Advanced Micro Devices, Inc. All rights reserved.
 *
 * 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.
 *****************************************************************************/

#ifndef LIBRARY_SRC_REVERSE_OFFLOAD_BACKEND_PROXY_HPP_
#define LIBRARY_SRC_REVERSE_OFFLOAD_BACKEND_PROXY_HPP_

#include <atomic>

#include "../device_proxy.hpp"
#include "../stats.hpp"
#include "queue.hpp"

namespace rocshmem {

struct BackendRegister {
  ROStats *profiler{nullptr};
  std::atomic<bool> worker_thread_exit{false};
  bool *needs_quiet{nullptr};
  bool *needs_blocking{nullptr};
  HdpPolicy *hdp_policy{nullptr};
  WindowInfo **heap_window_info{nullptr};
  SymmetricHeap *heap_ptr{nullptr};
};

template <typename ALLOCATOR>
class BackendProxy {
  using ProxyT = DeviceProxy<ALLOCATOR, BackendRegister>;

 public:
  /*
   * Placement new the memory which is allocated by proxy_
   */
  BackendProxy(size_t num_elems = 1) : proxy_{num_elems} {
    new (proxy_.get()) BackendRegister();
  }

  /*
   * Since placement new is called in the constructor, then
   * delete must be called manually.
   */
  ~BackendProxy() { proxy_.get()->~BackendRegister(); }

  /*
   * @brief Provide access to the memory referenced by the proxy
   */
  __host__ __device__ BackendRegister *get() { return proxy_.get(); }

 private:
  /*
   * @brief Memory managed by the lifetime of this object
   */
  ProxyT proxy_{};
};

using BackendProxyT = BackendProxy<HIPHostAllocator>;

}  // namespace rocshmem

#endif  // LIBRARY_SRC_REVERSE_OFFLOAD_BACKEND_PROXY_HPP_