misc: Merged release-staging-v19.0.0.0 into develop
[gem5.git] / src / gpu-compute / local_memory_pipeline.hh
1 /*
2 * Copyright (c) 2014-2015 Advanced Micro Devices, Inc.
3 * All rights reserved.
4 *
5 * For use for simulation and test purposes only
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 *
10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 *
13 * 2. Redistributions in binary form must reproduce the above copyright notice,
14 * this list of conditions and the following disclaimer in the documentation
15 * and/or other materials provided with the distribution.
16 *
17 * 3. Neither the name of the copyright holder nor the names of its
18 * contributors may be used to endorse or promote products derived from this
19 * software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 #ifndef __LOCAL_MEMORY_PIPELINE_HH__
35 #define __LOCAL_MEMORY_PIPELINE_HH__
36
37 #include <queue>
38 #include <string>
39
40 #include "gpu-compute/misc.hh"
41 #include "params/ComputeUnit.hh"
42 #include "sim/stats.hh"
43
44 /*
45 * @file local_memory_pipeline.hh
46 *
47 * The local memory pipeline issues newly created local memory packets
48 * from pipeline to the LDS. This stage also retires previously issued
49 * loads and stores that have returned from the LDS.
50 */
51
52 class ComputeUnit;
53 class Wavefront;
54
55 class LocalMemPipeline
56 {
57 public:
58 LocalMemPipeline(const ComputeUnitParams *params);
59 void init(ComputeUnit *cu);
60 void exec();
61
62 std::queue<GPUDynInstPtr> &getLMReqFIFO() { return lmIssuedRequests; }
63 std::queue<GPUDynInstPtr> &getLMRespFIFO() { return lmReturnedRequests; }
64
65 bool
66 isLMRespFIFOWrRdy() const
67 {
68 return lmReturnedRequests.size() < lmQueueSize;
69 }
70
71 bool
72 isLMReqFIFOWrRdy(uint32_t pendReqs=0) const
73 {
74 return (lmIssuedRequests.size() + pendReqs) < lmQueueSize;
75 }
76
77 const std::string& name() const { return _name; }
78 void regStats();
79
80 void
81 incLoadVRFBankConflictCycles(int num_cycles)
82 {
83 loadVrfBankConflictCycles += num_cycles;
84 }
85
86 private:
87 ComputeUnit *computeUnit;
88 std::string _name;
89 int lmQueueSize;
90 Stats::Scalar loadVrfBankConflictCycles;
91 // Local Memory Request Fifo: all shared memory requests
92 // are issued to this FIFO from the memory pipelines
93 std::queue<GPUDynInstPtr> lmIssuedRequests;
94
95 // Local Memory Response Fifo: all responses of shared memory
96 // requests are sent to this FIFO from LDS
97 std::queue<GPUDynInstPtr> lmReturnedRequests;
98 };
99
100 #endif // __LOCAL_MEMORY_PIPELINE_HH__