prepareGpuKernelArguments() and launchGpuKernel() are added
[alexxy/gromacs.git] / src / gromacs / ewald / pme-timings.cu
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2016,2017,2018, 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 /*! \internal \file
37  *  \brief Implements PME GPU timing events in CUDA.
38  *
39  *  \author Aleksei Iupinov <a.yupinov@gmail.com>
40  */
41
42 #include "gmxpre.h"
43
44 #include "pme-timings.cuh"
45
46 #include "gromacs/utility/gmxassert.h"
47
48 #include "pme.cuh"
49
50 /*! \brief \internal
51  * Tells if CUDA-based performance tracking is enabled for PME.
52  *
53  * \param[in] pme            The PME data structure.
54  * \returns                  True if timings are enabled, false otherwise.
55  */
56 inline bool pme_gpu_timings_enabled(const PmeGpu *pmeGpu)
57 {
58     return pmeGpu->archSpecific->useTiming;
59 }
60
61 void pme_gpu_start_timing(const PmeGpu *pmeGpu, size_t PMEStageId)
62 {
63     if (pme_gpu_timings_enabled(pmeGpu))
64     {
65         GMX_ASSERT(PMEStageId < pmeGpu->archSpecific->timingEvents.size(), "Wrong PME GPU timing event index");
66         pmeGpu->archSpecific->timingEvents[PMEStageId].openTimingRegion(pmeGpu->archSpecific->pmeStream);
67     }
68 }
69
70 CommandEvent *pme_gpu_fetch_timing_event(const PmeGpu *pmeGpu, size_t PMEStageId)
71 {
72     CommandEvent *timingEvent = nullptr;
73     if (pme_gpu_timings_enabled(pmeGpu))
74     {
75         GMX_ASSERT(PMEStageId < pmeGpu->archSpecific->timingEvents.size(), "Wrong PME GPU timing event index");
76         timingEvent = pmeGpu->archSpecific->timingEvents[PMEStageId].fetchNextEvent();
77     }
78     return timingEvent;
79 }
80
81 void pme_gpu_stop_timing(const PmeGpu *pmeGpu, size_t PMEStageId)
82 {
83     if (pme_gpu_timings_enabled(pmeGpu))
84     {
85         GMX_ASSERT(PMEStageId < pmeGpu->archSpecific->timingEvents.size(), "Wrong PME GPU timing event index");
86         pmeGpu->archSpecific->timingEvents[PMEStageId].closeTimingRegion(pmeGpu->archSpecific->pmeStream);
87     }
88 }
89
90 void pme_gpu_get_timings(const PmeGpu *pmeGpu, gmx_wallclock_gpu_pme_t *timings)
91 {
92     if (pme_gpu_timings_enabled(pmeGpu))
93     {
94         GMX_RELEASE_ASSERT(timings, "Null GPU timing pointer");
95         for (size_t i = 0; i < pmeGpu->archSpecific->timingEvents.size(); i++)
96         {
97             timings->timing[i].t = pmeGpu->archSpecific->timingEvents[i].getTotalTime();
98             timings->timing[i].c = pmeGpu->archSpecific->timingEvents[i].getCallCount();
99         }
100     }
101 }
102
103 void pme_gpu_update_timings(const PmeGpu *pmeGpu)
104 {
105     if (pme_gpu_timings_enabled(pmeGpu))
106     {
107         for (const size_t &activeTimer : pmeGpu->archSpecific->activeTimers)
108         {
109             pmeGpu->archSpecific->timingEvents[activeTimer].getLastRangeTime();
110         }
111     }
112 }
113
114 void pme_gpu_reinit_timings(const PmeGpu *pmeGpu)
115 {
116     if (pme_gpu_timings_enabled(pmeGpu))
117     {
118         pmeGpu->archSpecific->activeTimers.clear();
119         pmeGpu->archSpecific->activeTimers.insert(gtPME_SPLINEANDSPREAD);
120         // TODO: no separate gtPME_SPLINE and gtPME_SPREAD as they are not used currently
121         if (pme_gpu_performs_FFT(pmeGpu))
122         {
123             pmeGpu->archSpecific->activeTimers.insert(gtPME_FFT_C2R);
124             pmeGpu->archSpecific->activeTimers.insert(gtPME_FFT_R2C);
125         }
126         if (pme_gpu_performs_solve(pmeGpu))
127         {
128             pmeGpu->archSpecific->activeTimers.insert(gtPME_SOLVE);
129         }
130         if (pme_gpu_performs_gather(pmeGpu))
131         {
132             pmeGpu->archSpecific->activeTimers.insert(gtPME_GATHER);
133         }
134     }
135 }
136
137 void pme_gpu_reset_timings(const PmeGpu *pmeGpu)
138 {
139     if (pme_gpu_timings_enabled(pmeGpu))
140     {
141         for (size_t i = 0; i < pmeGpu->archSpecific->timingEvents.size(); i++)
142         {
143             pmeGpu->archSpecific->timingEvents[i].reset();
144         }
145     }
146 }