src/gromacs/gpu_utils/gpuregiontimer_sycl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35
  36 /*! \libinternal \file
  37  *  \brief Implements the GPU region timer for SYCL.
  38  *
  39  *  \author Andrey Alekseenko <al42and@gmail.com>
  40  *
  41  *  \inlibraryapi
  42  */
  43
  44 #ifndef GMX_GPU_UTILS_GPUREGIONTIMER_SYCL_H
  45 #define GMX_GPU_UTILS_GPUREGIONTIMER_SYCL_H
  46
  47 #include "gromacs/gpu_utils/devicebuffer_sycl.h"
  48 #include "gromacs/gpu_utils/gputraits.h"
  49 #include "gromacs/utility/stringutil.h"
  50
  51 #include "gpuregiontimer.h"
  52
  53 // Disabling Doxygen to avoid it having GpuRegionTimerImpl from both OpenCL and SYCL
  54 #ifndef DOXYGEN
  55
  56 /*! \libinternal \brief
  57  * The stub of SYCL implementation of the GPU code region timing.
  58  *
  59  * Does not do anything.
  60  *
  61  * \todo Implement
  62  */
  63 class GpuRegionTimerImpl
  64 {
  65 public:
  66     GpuRegionTimerImpl()  = default;
  67     ~GpuRegionTimerImpl() = default;
  68     //! No copying
  69     GpuRegionTimerImpl(const GpuRegionTimerImpl&) = delete;
  70     //! No assignment
  71     GpuRegionTimerImpl& operator=(GpuRegionTimerImpl&&) = delete;
  72     //! Moving is disabled but can be considered in the future if needed
  73     GpuRegionTimerImpl(GpuRegionTimerImpl&&) = delete;
  74
  75     /*! \brief Should be called before the region start. */
  76     inline void openTimingRegion(const DeviceStream& /*unused*/) {}
  77     /*! \brief Should be called after the region end. */
  78     inline void closeTimingRegion(const DeviceStream& /*unused*/) {}
  79     /*! \brief Returns the last measured region timespan (in milliseconds) and calls \c reset(). */
  80     // NOLINTNEXTLINE readability-convert-member-functions-to-static
  81     inline double getLastRangeTime() { return 0; }
  82     /*! \brief Resets the internal state, releasing the used handles, if any. */
  83     inline void reset() {}
  84     /*! \brief Returns a new raw timing event
  85      * for passing into individual GPU API calls
  86      * within the region if the API requires it (e.g. on OpenCL).
  87      */
  88     inline CommandEvent* fetchNextEvent() { return nullptr; }
  89 };
  90
  91 //! Short-hand for external use
  92 using GpuRegionTimer = GpuRegionTimerWrapper<GpuRegionTimerImpl>;
  93
  94 #endif // !DOXYGEN
  95
  96 #endif