src/ipc: IPC folder refactor

mv ipc_policy.{hpp,cpp} into a separate folder as a start for the standalone IPC conduit. Unit tests and functional tests pass on the developmpent system.
2024-07-25 07:33:41 -07:00
parent a3c338c310
commit 1183006e20
8 changed files with 40 additions and 10 deletions
@@ -0,0 +1,30 @@
+###############################################################################
+# 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.
+###############################################################################
+
+###############################################################################
+# ADD ROCSHMEM TARGET FOR FILES IN CURRENT DIRECTORY
+###############################################################################
+target_sources(
+  ${PROJECT_NAME}
+  PRIVATE
+    ipc_policy.cpp
+)
@@ -0,0 +1,125 @@
+/******************************************************************************
+ * 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.
+ *****************************************************************************/
+
+#include "ipc_policy.hpp"
+
+#include <mpi.h>
+
+#include "config.h"  // NOLINT(build/include_subdir)
+#include "../backend_bc.hpp"
+#include "../context_incl.hpp"
+#include "../util.hpp"
+
+namespace rocshmem {
+
+__host__ void IpcOnImpl::ipcHostInit(int my_pe, const HEAP_BASES_T &heap_bases,
+                                     MPI_Comm thread_comm) {
+  /*
+   * Create an MPI communicator that deals only with local processes.
+   */
+  MPI_Comm shmcomm;
+  MPI_Comm_split_type(thread_comm, MPI_COMM_TYPE_SHARED, 0, MPI_INFO_NULL,
+                      &shmcomm);
+
+  /*
+   * Figure out how many local process there are.
+   */
+  int Shm_size;
+  MPI_Comm_size(shmcomm, &Shm_size);
+  shm_size = Shm_size;
+
+  /*
+   * Figure out how this process' rank among local processes.
+   */
+  int shm_rank;
+  MPI_Comm_rank(shmcomm, &shm_rank);
+
+  /*
+   * Allocate a host-side c-array to hold the IPC handles.
+   */
+  void *ipc_mem_handle_uncast = malloc(shm_size * sizeof(hipIpcMemHandle_t));
+  hipIpcMemHandle_t *vec_ipc_handle =
+      reinterpret_cast<hipIpcMemHandle_t *>(ipc_mem_handle_uncast);
+
+  /*
+   * Call into the hip runtime to get an IPC handle for my symmetric
+   * heap and store that IPC handle into the host-side c-array which was
+   * just allocated.
+   */
+  char *base_heap = heap_bases[my_pe];
+  CHECK_HIP(hipIpcGetMemHandle(&vec_ipc_handle[shm_rank], base_heap));
+
+  /*
+   * Do an all-to-all exchange with each local processing element to
+   * share the symmetric heap IPC handles.
+   */
+  MPI_Allgather(MPI_IN_PLACE, sizeof(hipIpcMemHandle_t), MPI_CHAR,
+                vec_ipc_handle, sizeof(hipIpcMemHandle_t), MPI_CHAR, shmcomm);
+
+  /*
+   * Allocate device-side array to hold the IPC symmetric heap base
+   * addresses.
+   */
+  char **ipc_base;
+  CHECK_HIP(hipMalloc(reinterpret_cast<void **>(&ipc_base),
+                      shm_size * sizeof(char **)));
+
+  /*
+   * For all local processing elements, initialize the device-side array
+   * with the IPC symmetric heap base addresses.
+   */
+  for (size_t i = 0; i < shm_size; i++) {
+    if (i != shm_rank) {
+      void **ipc_base_uncast = reinterpret_cast<void **>(&ipc_base[i]);
+      CHECK_HIP(hipIpcOpenMemHandle(ipc_base_uncast, vec_ipc_handle[i],
+                                    hipIpcMemLazyEnablePeerAccess));
+      // TODO(bpotter): add some error checking here if happens to fail
+    } else {
+      ipc_base[i] = base_heap;
+    }
+  }
+
+  /*
+   * Set member variables used by subsequent method calls.
+   */
+  ipc_bases = ipc_base;
+
+  /*
+   * Free the host-side memory used to exchange the symmetric heap base
+   * addresses.
+   */
+  free(vec_ipc_handle);
+}
+
+__device__ void IpcOnImpl::ipcCopy(void *dst, void *src, size_t size) {
+  memcpy(dst, src, size);
+}
+
+__device__ void IpcOnImpl::ipcCopy_wave(void *dst, void *src, size_t size) {
+  memcpy_wave(dst, src, size);
+}
+
+__device__ void IpcOnImpl::ipcCopy_wg(void *dst, void *src, size_t size) {
+  memcpy_wg(dst, src, size);
+}
+
+}  // namespace rocshmem
@@ -0,0 +1,166 @@
+/******************************************************************************
+ * 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_IPC_POLICY_HPP_
+#define LIBRARY_SRC_IPC_POLICY_HPP_
+
+#include <hip/hip_runtime.h>
+#include <mpi.h>
+
+#include <atomic>
+#include <vector>
+
+#include "config.h"  // NOLINT(build/include_subdir)
+#include "../memory/hip_allocator.hpp"
+#include "../util.hpp"
+
+namespace rocshmem {
+
+class Backend;
+class Context;
+
+class IpcOnImpl {
+  using HEAP_BASES_T = std::vector<char *, StdAllocatorHIP<char *>>;
+
+ public:
+  uint32_t shm_size{0};
+
+  char **ipc_bases{nullptr};
+
+  __host__ void ipcHostInit(int my_pe, const HEAP_BASES_T &heap_bases,
+                            MPI_Comm thread_comm);
+
+  __device__ bool isIpcAvailable(int my_pe, int target_pe) {
+    return my_pe / shm_size == target_pe / shm_size;
+  }
+  __device__ void ipcGpuInit(Backend *gpu_backend, Context *ctx, int thread_id);
+
+  __device__ void ipcCopy(void *dst, void *src, size_t size);
+
+  __device__ void ipcCopy_wg(void *dst, void *src, size_t size);
+
+  __device__ void ipcCopy_wave(void *dst, void *src, size_t size);
+
+  __device__ void ipcFence() { __threadfence(); }
+
+  template <typename T>
+  __device__ T ipcAMOFetchAdd(T *val, T value) {
+    return __hip_atomic_fetch_add(val, value, __ATOMIC_RELAXED,
+                                  __HIP_MEMORY_SCOPE_AGENT);
+  }
+
+  template <typename T>
+  __device__ T ipcAMOFetchCas(T *val, T cond, T value) {
+    __hip_atomic_compare_exchange_strong(val, &cond, value, __ATOMIC_RELAXED,
+                                         __ATOMIC_RELAXED,
+                                         __HIP_MEMORY_SCOPE_AGENT);
+    return cond;
+  }
+
+  template <typename T>
+  __device__ void ipcAMOAdd(T *val, T value) {
+    __hip_atomic_fetch_add(val, value, __ATOMIC_RELAXED,
+                           __HIP_MEMORY_SCOPE_AGENT);
+  }
+
+  template <typename T>
+  __device__ void ipcAMOCas(T *val, T cond, T value) {
+    __hip_atomic_compare_exchange_strong(val, &cond, value, __ATOMIC_RELAXED,
+                                         __ATOMIC_RELAXED,
+                                         __HIP_MEMORY_SCOPE_AGENT);
+  }
+
+  template <typename T>
+  __device__ void ipcAMOSet(T *val, T value) {
+    __hip_atomic_store(val, value, __ATOMIC_RELAXED, __HIP_MEMORY_SCOPE_AGENT);
+  }
+
+  __device__ void zero_byte_read(int pe) {
+    int local_pe = pe % shm_size;
+    uint32_t *pe_ipc_base = reinterpret_cast<uint32_t *>(ipc_bases[local_pe]);
+    volatile uint32_t read_value = __hip_atomic_load(
+        pe_ipc_base, __ATOMIC_SEQ_CST, __HIP_MEMORY_SCOPE_SYSTEM);
+  }
+};
+
+// clang-format off
+NOWARN(-Wunused-parameter,
+class IpcOffImpl {
+  using HEAP_BASES_T = std::vector<char *, StdAllocatorHIP<char *>>;
+
+ public:
+  uint32_t shm_size{0};
+
+  char **ipc_bases{nullptr};
+
+  __host__ void ipcHostInit(int my_pe, const HEAP_BASES_T &heap_bases,
+                            MPI_Comm thread_comm) {}
+
+  __device__ bool isIpcAvailable(int my_pe, int target_pe) { return false; }
+
+  __device__ void ipcGpuInit(Backend *roc_shmem_handle, Context *ctx,
+                             int thread_id) {}
+
+  __device__ void ipcCopy(void *dst, void *src, size_t size) {}
+
+  __device__ void ipcCopy_wg(void *dst, void *src, size_t size) {}
+
+  __device__ void ipcCopy_wave(void *dst, void *src, size_t size) {}
+
+  __device__ void ipcFence() {}
+
+  template <typename T>
+  __device__ T ipcAMOFetchAdd(T *val, T value) {
+    return T();
+  }
+
+  template <typename T>
+  __device__ T ipcAMOFetchCas(T *val, T cond, T value) {
+    return T();
+  }
+
+  template <typename T>
+  __device__ void ipcAMOAdd(T *val, T value) {}
+
+  template <typename T>
+  __device__ void ipcAMOSet(T *val, T value) {}
+
+  template <typename T>
+  __device__ void ipcAMOCas(T *val, T cond, T value) {}
+
+  __device__ void zero_byte_read(int pe) {}
+};
+)
+// clang-format on
+
+/*
+ * Select which one of our IPC policies to use at compile time.
+ */
+#ifdef USE_IPC
+typedef IpcOnImpl IpcImpl;
+#else
+typedef IpcOffImpl IpcImpl;
+#endif
+
+}  // namespace rocshmem
+
+#endif  // LIBRARY_SRC_IPC_POLICY_HPP_