rocm-systems/tests/functional_tests/sync_tester.cpp

/******************************************************************************
 * 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 "sync_tester.hpp"

/******************************************************************************
 * DEVICE TEST KERNEL
 *****************************************************************************/
__global__ void SyncTest(int loop, int skip, long long int *start_time,
                         long long int *end_time, TestType type,
                         ShmemContextType ctx_type, rocshmem_team_t *teams) {
  __shared__ rocshmem_ctx_t ctx;
  int wg_id = get_flat_grid_id();

  rocshmem_wg_init();
  rocshmem_wg_ctx_create(ctx_type, &ctx);

  for (int i = 0; i < loop + skip; i++) {
    if (hipThreadIdx_x == 0 && i == skip) {
      start_time[wg_id] = wall_clock64();
    }

    __syncthreads();
    switch (type) {
      case SyncAllTestType:
        /**
        * The function `rocshmem_ctx_wg_sync_all` should be called from only
        * one group within the grid to avoid unintended behavior.
        */
        if (is_block_zero_in_grid()) {
          rocshmem_ctx_wg_sync_all(ctx);
        }
        break;
      case SyncTestType:
        rocshmem_ctx_wg_team_sync(ctx, teams[wg_id]);
        break;
      default:
        break;
    }
  }
  __syncthreads();

  if (hipThreadIdx_x == 0) {
    end_time[wg_id] = wall_clock64();
  }

  rocshmem_wg_ctx_destroy(&ctx);
  rocshmem_wg_finalize();
}

/******************************************************************************
 * HOST TESTER CLASS METHODS
 *****************************************************************************/
SyncTester::SyncTester(TesterArguments args) : Tester(args) {

  char* value{nullptr};
  if ((value = getenv("ROCSHMEM_MAX_NUM_TEAMS"))) {
    num_teams = atoi(value);
  }

  CHECK_HIP(hipMalloc(&team_sync_world_dup,
                      sizeof(rocshmem_team_t) * num_teams));
}

SyncTester::~SyncTester() {
  CHECK_HIP(hipFree(team_sync_world_dup));
}

void SyncTester::resetBuffers(uint64_t size) {}

void SyncTester::preLaunchKernel() {
  int n_pes = rocshmem_team_n_pes(ROCSHMEM_TEAM_WORLD);

  for (int team_i = 0; team_i < num_teams; team_i++) {
    team_sync_world_dup[team_i] = ROCSHMEM_TEAM_INVALID;
    rocshmem_team_split_strided(ROCSHMEM_TEAM_WORLD, 0, 1, n_pes, nullptr, 0,
                                 &team_sync_world_dup[team_i]);
    if (team_sync_world_dup[team_i] == ROCSHMEM_TEAM_INVALID) {
      printf("Team %d is invalid!\n", team_i);
      abort();
    }
  }
}

void SyncTester::launchKernel(dim3 gridSize, dim3 blockSize, int loop,
                              uint64_t size) {
  size_t shared_bytes = 0;

  int n_pes = rocshmem_team_n_pes(ROCSHMEM_TEAM_WORLD);

  hipLaunchKernelGGL(SyncTest, gridSize, blockSize, shared_bytes, stream, loop,
                     args.skip, start_time, end_time, _type, _shmem_context,
                     team_sync_world_dup);

  num_msgs = loop + args.skip;
  num_timed_msgs = loop;

  if(_type == SyncTestType) {
    num_msgs *= gridSize.x;
    num_timed_msgs *= gridSize.x;
  }
}

void SyncTester::postLaunchKernel() {
  for (int team_i = 0; team_i < num_teams; team_i++) {
    rocshmem_team_destroy(team_sync_world_dup[team_i]);
  }
}

void SyncTester::verifyResults(uint64_t size) {}