opr_opgrad.hip

Go to the documentation of this file.

/*
 Copyright (c) 2021-2026, The Neko Authors
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 
   * Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.
 
   * Redistributions in binary form must reproduce the above
     copyright notice, this list of conditions and the following
     disclaimer in the documentation and/or other materials provided
     with the distribution.
 
   * Neither the name of the authors nor the names of its
     contributors may be used to endorse or promote products derived
     from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
*/
 
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include <hip/hip_runtime.h>
#include <device/device_config.h>
#include <device/hip/check.h>
#include "opgrad_kernel.h"
#include "elem_block_tune.h"
 
extern "C" {
  #include <common/neko_log.h>
}
 
template < const int >
int tune_opgrad(void *ux, void *uy, void *uz, void *u,
                void *dx, void *dy, void *dz,
                void *drdx, void *dsdx, void *dtdx,
                void *drdy, void *dsdy, void *dtdy,
                void *drdz, void *dsdz, void *dtdz,
                void *w3, int *nel, int *lx, int *eb_sel, int *ch_sel,
                int *nwf_sel);
 
extern "C" {
 
  void hip_opgrad(void *ux, void *uy, void *uz, void *u,
                   void *dx, void *dy, void *dz,
                   void *drdx, void *dsdx, void *dtdx,
                   void *drdy, void *dsdy, void *dtdy,
                   void *drdz, void *dsdz, void *dtdz,
                   void *w3, int *nel, int *lx) {
 
    static int autotune[19] = { 0 };
    /* elements per block candidate chosen by the tuner */
    static int autotune_eb[19] = { 0 };
    /* chunk candidate chosen for the 1d variant */
    static int autotune_ch[19] = { 0 };
    /* wavefronts per block candidate chosen for the mfma variant */
    static int autotune_nwf[19] = { 0 };
 
    const dim3 nthrds_1d(1024, 1, 1);
    const dim3 nthrds_kstep((*lx), (*lx), 1);
    const dim3 nblcks((*nel), 1, 1);
 
#define CASE_1D(LX, C)                                                          \
    hipLaunchKernelGGL( HIP_KERNEL_NAME(                                        \
                        opgrad_kernel_1d<real, LX, NEKO_CHUNKS(LX, C)> ),       \
                        nblcks, NEKO_CHUNKS_NTHRDS(LX, C), 0,                   \
                        (hipStream_t) glb_cmd_queue,                            \
                        (real *) ux, (real *) uy, (real *) uz, (real *) u,      \
                        (real *) dx, (real *) dy, (real *) dz,                  \
                        (real *) drdx, (real *) dsdx, (real *) dtdx,            \
                        (real *) drdy, (real *) dsdy, (real *) dtdy,            \
                        (real *) drdz, (real *) dsdz, (real *) dtdz,            \
                        (real *) w3);                                           \
    HIP_CHECK(hipGetLastError());
 
/* Runtime dispatch onto the tuned chunk candidate */
#define CASE_1D_SEL(LX, SEL)                                                    \
    switch (SEL) {                                                              \
    case 0:  CASE_1D(LX, 0); break;                                             \
    case 1:  CASE_1D(LX, 1); break;                                             \
    case 2:  CASE_1D(LX, 2); break;                                             \
    default: CASE_1D(LX, 3); break;                                             \
    }
 
 
#define CASE_KSTEP(LX, C)                                                       \
    hipLaunchKernelGGL( HIP_KERNEL_NAME(                                        \
                        opgrad_kernel_kstep<real, LX, NEKO_EB(LX, C)> ),        \
                        NEKO_EB_NBLCKS(*nel, LX, C), NEKO_EB_NTHRDS(LX, C), 0,  \
                        (hipStream_t) glb_cmd_queue,                            \
                        (real *) ux, (real *) uy, (real *) uz, (real *) u,      \
                        (real *) dx, (real *) dy, (real *) dz,                  \
                        (real *) drdx, (real *) dsdx, (real *) dtdx,            \
                        (real *) drdy, (real *) dsdy, (real *) dtdy,            \
                        (real *) drdz, (real *) dsdz, (real *) dtdz,            \
                        (real *) w3, *nel);                                     \
    HIP_CHECK(hipGetLastError());
 
/* Runtime dispatch onto the tuned candidate */
#define CASE_KSTEP_SEL(LX, SEL)                                                 \
    switch (SEL) {                                                              \
    case 0:  CASE_KSTEP(LX, 0); break;                                          \
    case 1:  CASE_KSTEP(LX, 1); break;                                          \
    default: CASE_KSTEP(LX, 2); break;                                          \
    }
 
#define CASE_MFMA(LX, C)                                                        \
    hipLaunchKernelGGL( HIP_KERNEL_NAME(                                        \
                          opgrad_kernel_mfma<real, LX, NEKO_MFMA_NWF(C),        \
                                             NEKO_MFMA_TILE(C)> ),              \
                        NEKO_MFMA_NBLCKS(*nel, LX, C), NEKO_MFMA_NTHRDS(C), 0,  \
                        (hipStream_t) glb_cmd_queue,                            \
                        (real *) ux, (real *) uy, (real *) uz, (real *) u,      \
                        (real *) dx, (real *) dy, (real *) dz,                  \
                        (real *) drdx, (real *) dsdx, (real *) dtdx,            \
                        (real *) drdy, (real *) dsdy, (real *) dtdy,            \
                        (real *) drdz, (real *) dsdz, (real *) dtdz,            \
                        (real *) w3, *nel);                                     \
    HIP_CHECK(hipGetLastError());
 
/* Runtime dispatch onto the tuned candidate, which names both the wavefronts
   per block and the matrix core tile, see NEKO_MFMA_TILE in mfma_kernel.h */
#define CASE_MFMA_SEL(LX, SEL)                                                  \
    switch (SEL) {                                                              \
    case 0:  CASE_MFMA(LX, 0); break;                                           \
    case 1:  CASE_MFMA(LX, 1); break;                                           \
    case 2:  CASE_MFMA(LX, 2); break;                                           \
    case 3:  CASE_MFMA(LX, 3); break;                                           \
    case 4:  CASE_MFMA(LX, 4); break;                                           \
    case 5:  CASE_MFMA(LX, 5); break;                                           \
    case 6:  CASE_MFMA(LX, 6); break;                                           \
    case 7:  CASE_MFMA(LX, 7); break;                                           \
    case 8:  CASE_MFMA(LX, 8); break;                                           \
    default: CASE_MFMA(LX, 9); break;                                           \
    }
 
/* The switch above has to name every candidate, see the note in ax_helm.hip:
   a candidate reaching the default arm launches one geometry's grid at
   another geometry's kernel. */
static_assert(NEKO_MFMA_CANDIDATES == 10,
              "CASE_MFMA_SEL does not cover the candidate space");
 
#define CASE(LX)                                                                \
    case LX:                                                                    \
      if(autotune[LX] == 0 ) {                                                  \
        autotune[LX]=tune_opgrad<LX>(ux, uy, uz, u,                             \
                                     dx, dy, dz,                                \
                                     drdx, dsdx, dtdx,                          \
                                     drdy, dsdy, dtdy,                          \
                                     drdz, dsdz, dtdz,                          \
                                     w3, nel, lx, &autotune_eb[LX],             \
                                     &autotune_ch[LX],                          \
                                     &autotune_nwf[LX]);                        \
      } else if (autotune[LX] == 1 ) {                                          \
        CASE_1D_SEL(LX, autotune_ch[LX]);                                       \
      } else if (autotune[LX] == 2 ) {                                          \
        CASE_KSTEP_SEL(LX, autotune_eb[LX]);                                    \
      } else if (autotune[LX] == 3 ) {                                          \
        CASE_MFMA_SEL(LX, autotune_nwf[LX]);                                    \
      }                                                                         \
      break
 
    switch(*lx) {
      CASE(2);
      CASE(3);
      CASE(4);
      CASE(5);
      CASE(6);
      CASE(7);
      CASE(8);
      CASE(9);
      CASE(10);
      CASE(11);
      CASE(12);
      CASE(13);
      CASE(14);
      CASE(15);
      CASE(16);
      CASE(17);
      CASE(18);
    default:
      {
        fprintf(stderr, __FILE__ ": size not supported: %d\n", *lx);
        exit(1);
      }
    }
  }
}
 
template < const int LX >
int tune_opgrad(void *ux, void *uy, void *uz, void *u,
                void *dx, void *dy, void *dz,
                void *drdx, void *dsdx, void *dtdx,
                void *drdy, void *dsdy, void *dtdy,
                void *drdz, void *dsdz, void *dtdz,
                void *w3, int *nel, int *lx, int *eb_sel, int *ch_sel,
                int *nwf_sel) {
  hipEvent_t start,stop;
  float time1[NEKO_CHUNKS_CANDIDATES];
  int best1 = 0;
  float time2[NEKO_EB_CANDIDATES];
  float time3[NEKO_MFMA_CANDIDATES];
  int best3 = 0;
  const int rounds = neko_tune_rounds();
  const int iters = neko_tune_iters();
  /* Candidates of the kstep sweep, one -- the unblocked shape -- when the
     elements per block sweep is off */
  const int eb_cand = neko_eb_sweep() ? NEKO_EB_CANDIDATES : 1;
  /* Geometry pinned by each formulation's own variable, -1 to sweep it */
  const int ch_pin = neko_chunks_pin();
  const int eb_pin = neko_eb_pin();
  /* Candidates of the matrix core sweep, see neko_mfma_candidates() */
  const int mfma_cand = neko_mfma_candidates();
  /* Both matrix core dimensions, pinned by their own variables or -1 */
  const int nwf_pin = neko_mfma_pin();
  /* Formulation pinned by NEKO_AUTOTUNE, as the identifier this returns */
  int strat = 0;
  /* Hardware capability, which the explicit NEKO_AUTOTUNE=MFMA pin needs */
  const bool mfma = mfma_lx_supported<LX>() && hip_have_mfma();
  int best = 0;
  int retval;
 
  for (int c = 0; c < NEKO_EB_CANDIDATES; c++) {
    time2[c] = NEKO_TUNE_INIT;
  }
  for (int c = 0; c < NEKO_CHUNKS_CANDIDATES; c++) {
    time1[c] = NEKO_TUNE_INIT;
  }
  for (int c = 0; c < NEKO_MFMA_CANDIDATES; c++) {
    time3[c] = NEKO_TUNE_INIT;
  }
 
  const dim3 nthrds_1d(1024, 1, 1);
  const dim3 nthrds_kstep((*lx), (*lx), 1);
  const dim3 nblcks((*nel), 1, 1);
  const hipStream_t stream = (hipStream_t) glb_cmd_queue;
 
  char *env_value = NULL;
  char neko_log_buf[80];
 
  env_value=getenv("NEKO_AUTOTUNE");
 
  sprintf(neko_log_buf, "Autotune opgrad (lx: %d)", *lx);
  log_section(neko_log_buf);
 
  *eb_sel = 0;
  *ch_sel = 0;
  *nwf_sel = 0;
 
  /*
   * NEKO_AUTOTUNE names a formulation, and that is all it does: the sweep
   * below is narrowed to that one kernel family, but its geometry -- the
   * chunk size, the elements per block, the wavefronts per block -- is still
   * measured candidate against candidate. A formulation this build or this
   * device does not have is reported and ignored, leaving the full sweep.
   */
  if(env_value) {
    if( !strcmp(env_value,"1D") ) {
      strat = 1;
    } else if( !strcmp(env_value,"KSTEP") ) {
      strat = 2;
    } else if( !strcmp(env_value,"MFMA") ) {
      if (mfma) {
        strat = 3;
      } else {
        sprintf(neko_log_buf, "MFMA strategy not available for this config");
        log_error(neko_log_buf);
      }
    } else {
       sprintf(neko_log_buf, "Invalid value set for NEKO_AUTOTUNE");
       log_error(neko_log_buf);
    }
  }
 
  /* Geometry of the pinned formulation, if its own variable fixes that too.
     Both pinned leaves nothing to measure, so the kernel is launched once and
     reported, which is what pinning has always done */
  const int pin = (strat == 1) ? ch_pin : (strat == 2) ? eb_pin :
                  (strat == 3) ? nwf_pin : -1;
 
  if (pin >= 0) {
    switch (strat) {
    case 1:
      *ch_sel = pin;
      CASE_1D_SEL(LX, pin);
      sprintf(neko_log_buf, "Set by env   : 1 (1D, %d chunk)",
              NEKO_CHUNKS_SEL(LX, pin));
      break;
    case 2:
      *eb_sel = pin;
      CASE_KSTEP_SEL(LX, pin);
      sprintf(neko_log_buf, "Set by env   : 2 (KSTEP, %d elem/block)",
              NEKO_EB_SEL(LX, pin));
      break;
    default:
      *nwf_sel = pin;
      CASE_MFMA_SEL(LX, pin);
      sprintf(neko_log_buf, "Set by env   : 3 (MFMA %s, %d wf, %d elem/blk)",
              mfma_tile_name(pin), NEKO_MFMA_NWF(pin), NEKO_MFMA_EB(LX, pin));
      break;
    }
    log_message(neko_log_buf);
    log_end_section();
    return strat;
  }
 
  if (strat) {
    sprintf(neko_log_buf, "Set by env   : %d (%s)", strat, env_value);
    log_message(neko_log_buf);
  }
 
  /* Formulations the sweep considers, see NEKO_TUNE_FOR(). NEKO_MFMA_TUNE
     keeps the matrix core variant out of an unpinned sweep, but naming it
     explicitly still measures it */
  const bool try_1d = (strat == 0 || strat == 1);
  const bool try_kstep = (strat == 0 || strat == 2);
  const bool try_mfma = mfma && ((strat == 3) ||
                                 (strat == 0 && neko_mfma_sweep()));
 
  HIP_CHECK(hipEventCreate(&start));
  HIP_CHECK(hipEventCreate(&stop));
 
  /* Verify every candidate against the reference formulation on a synthetic
     input before anything is timed, see neko_tune_verify_begin() in
     elem_block_tune.h. A candidate that does not reproduce it is reported
     and dropped from the comparison below. */
  neko_tune_rej_t rej1 = {{0}}, rej2 = {{0}}, rej3 = {{0}};
  {
    neko_tune_verify_t vf;
    real *vouts[] = { (real *) ux, (real *) uy, (real *) uz };
    void **vins[] = { &u };
    if (neko_tune_verify_begin(&vf, vouts, 3, vins, 1,
                               (*nel) * LX * LX * LX, stream)) {
      sprintf(neko_log_buf, "Verify       : rel tol %.1e, synthetic input",
              vf.tol);
      log_message(neko_log_buf);
      CASE_1D_SEL(LX, 0);
      neko_tune_verify_ref(&vf, stream);
      NEKO_TUNE_FOR(c, try_1d, ch_pin, NEKO_CHUNKS_CANDIDATES) {
        NEKO_TUNE_VERIFY_CAND(vf, rej1, CASE_1D_SEL, LX, c, "1D");
      }
      NEKO_TUNE_FOR(c, try_kstep, eb_pin, eb_cand) {
        NEKO_TUNE_VERIFY_CAND(vf, rej2, CASE_KSTEP_SEL, LX, c, "KSTEP");
      }
      NEKO_TUNE_FOR(c, try_mfma, nwf_pin, mfma_cand) {
        NEKO_TUNE_VERIFY_CAND(vf, rej3, CASE_MFMA_SEL, LX, c, "MFMA");
      }
      neko_tune_verify_end(&vf, stream);
    } else {
      sprintf(neko_log_buf, "Verify       : %s", neko_tune_verify_on() ?
              "skipped, no memory for it" : "off (NEKO_TUNE_VERIFY=0)");
      log_message(neko_log_buf);
    }
  }
 
  /* Warm every variant before timing anything: each specialisation has to be
     resident and the clocks at steady state, or whichever is timed first is
     measured on a colder part */
  for (int i = 0; i < NEKO_TUNE_WARMUP; i++) {
    NEKO_TUNE_FOR(c, try_1d, ch_pin, NEKO_CHUNKS_CANDIDATES) {
      CASE_1D_SEL(LX, c);
    }
    NEKO_TUNE_FOR(c, try_kstep, eb_pin, eb_cand) {
      CASE_KSTEP_SEL(LX, c);
    }
    NEKO_TUNE_FOR(c, try_mfma, nwf_pin, mfma_cand) {
      CASE_MFMA_SEL(LX, c);
    }
  }
 
  /* Interleaved rounds, best time per variant */
  for (int r = 0; r < rounds; r++) {
    NEKO_TUNE_FOR(c, try_1d, ch_pin, NEKO_CHUNKS_CANDIDATES) {
      NEKO_TUNE_TIME(time1, CASE_1D_SEL, LX, c, iters);
    }
    NEKO_TUNE_FOR(c, try_kstep, eb_pin, eb_cand) {
      NEKO_TUNE_TIME(time2, CASE_KSTEP_SEL, LX, c, iters);
    }
    NEKO_TUNE_FOR(c, try_mfma, nwf_pin, mfma_cand) {
      NEKO_TUNE_TIME(time3, CASE_MFMA_SEL, LX, c, iters);
    }
  }
 
  /* Candidates the verification pass rejected drop out here, after the
     timing, so the sweep's own bookkeeping is untouched */
  NEKO_TUNE_APPLY_REJ(time1, rej1, NEKO_CHUNKS_CANDIDATES);
  NEKO_TUNE_APPLY_REJ(time2, rej2, NEKO_EB_CANDIDATES);
  NEKO_TUNE_APPLY_REJ(time3, rej3, NEKO_MFMA_CANDIDATES);
 
  NEKO_TUNE_LOG(LX, time1, time2);
  NEKO_TUNE_LOG_MFMA(LX, time3);
 
  NEKO_TUNE_BEST(time1, best1, NEKO_CHUNKS_CANDIDATES);
  NEKO_TUNE_BEST(time2, best, NEKO_EB_CANDIDATES);
  NEKO_TUNE_BEST(time3, best3, NEKO_MFMA_CANDIDATES);
  *eb_sel = best;
  *ch_sel = best1;
  *nwf_sel = best3;
 
  if (time1[best1] < time2[best]) {
    retval = 1;
  } else {
    retval = 2;
  }
 
  /* The mfma variant joins the comparison only where it exists, its
     candidates are left at NEKO_TUNE_INIT otherwise */
  if (time3[best3] < ((retval == 1) ? time1[best1] : time2[best])) {
    retval = 3;
  }
 
  /* Leave the chosen kernel's output in place: the tuner stands in for a real
     evaluation and the variants do not sum in the same order */
  if (retval == 1) {
    CASE_1D_SEL(LX, best1);
  } else if (retval == 2) {
    CASE_KSTEP_SEL(LX, best);
  } else {
    CASE_MFMA_SEL(LX, best3);
  }
 
  if (retval == 1) {
    sprintf(neko_log_buf, "Chose        : 1 (1D, %d chunk)",
            NEKO_CHUNKS_SEL(LX, best1));
  } else if (retval == 2) {
    sprintf(neko_log_buf, "Chose        : 2 (KSTEP, %d elem/block)",
            NEKO_EB_SEL(LX, best));
  } else {
    sprintf(neko_log_buf, "Chose        : 3 (MFMA %s, %d wf, %d elem/blk)",
            mfma_tile_name(best3), NEKO_MFMA_NWF(best3),
            NEKO_MFMA_EB(LX, best3));
  }
  log_message(neko_log_buf);
  log_end_section();
  return retval;
}