src/gromacs/gpu_utils/device_stream_sycl.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020,2021, 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 /*! \internal \file
  36  *
  37  * \brief Implements the DeviceStream for SYCL builds.
  38  *
  39  * \author Erik Lindahl <erik.lindahl@gmail.com>
  40  * \author Andrey Alekseenko <al42and@gmail.com>
  41  *
  42  * \ingroup module_gpu_utils
  43  */
  44 #include "gmxpre.h"
  45
  46 #include "gromacs/gpu_utils/device_context.h"
  47 #include "gromacs/gpu_utils/device_stream.h"
  48
  49 DeviceStream::DeviceStream(const DeviceContext& deviceContext,
  50                            DeviceStreamPriority /* priority */,
  51                            const bool useTiming)
  52 {
  53     const std::vector<cl::sycl::device> devicesInContext = deviceContext.context().get_devices();
  54     // The context is constructed to have exactly one device
  55     const cl::sycl::device device = devicesInContext[0];
  56
  57     cl::sycl::property_list propertyList = {};
  58     if (useTiming)
  59     {
  60         const bool deviceSupportsTiming = device.get_info<cl::sycl::info::device::queue_profiling>();
  61         if (deviceSupportsTiming)
  62         {
  63 #if (!GMX_SYCL_HIPSYCL)
  64             /* Support for profiling and even the `::enable_profile` property is added in
  65              * https://github.com/illuhad/hipSYCL/pull/428, which is not merged at the
  66              * time of writing */
  67             propertyList = cl::sycl::property::queue::enable_profiling();
  68 #endif
  69         }
  70     }
  71     stream_ = cl::sycl::queue(deviceContext.context(), device, propertyList);
  72 }
  73
  74 DeviceStream::~DeviceStream() = default;
  75
  76 // NOLINTNEXTLINE readability-convert-member-functions-to-static
  77 bool DeviceStream::isValid() const
  78 {
  79     return true;
  80 }
  81
  82 void DeviceStream::synchronize()
  83 {
  84     stream_.wait_and_throw();
  85 };
  86
  87 void DeviceStream::synchronize() const
  88 {
  89     /* cl::sycl::queue::wait is a non-const function. However, a lot of code in GROMACS
  90      * assumes DeviceStream is const, yet wants to synchronize with it.
  91      * The chapter "4.3.2 Common reference semantics" of SYCL 1.2.1 specification says:
  92      * > Each of the following SYCL runtime classes: [...] queue, [...] must obey the following
  93      * > statements, where T is the runtime class type:
  94      * > - T must be copy constructible and copy assignable on the host application [...].
  95      * >   Any instance of T that is constructed as a copy of another instance, via either the
  96      * >   copy constructor or copy assignment operator, must behave as-if it were the original
  97      * >   instance and as-if any action performed on it were also performed on the original
  98      * >   instance [...].
  99      * Same in chapter "4.5.3" of provisional SYCL 2020 specification (June 30, 2020).
 100      * So, we can copy-construct a new queue and wait() on it.
 101      */
 102     cl::sycl::queue(stream_).wait_and_throw();
 103 }