xref: /aosp_15_r20/external/gmmlib/Source/GmmLib/ULT/GmmGen12CachePolicyULT.cpp (revision 35ffd701415c9e32e53136d61a677a8d0a8fc4a5)
1 /*==============================================================================
2 Copyright(c) 2019 Intel Corporation
3 
4 Permission is hereby granted, free of charge, to any person obtaining a
5 copy of this software and associated documentation files(the "Software"),
6 to deal in the Software without restriction, including without limitation
7 the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 and / or sell copies of the Software, and to permit persons to whom the
9 Software is furnished to do so, subject to the following conditions:
10 
11 The above copyright notice and this permission notice shall be included
12 in all copies or substantial portions of the Software.
13 
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 OTHER DEALINGS IN THE SOFTWARE.
21 ============================================================================*/
22 
23 #include "GmmGen12CachePolicyULT.h"
24 
25 using namespace std;
26 
27 /////////////////////////////////////////////////////////////////////////////////////
28 /// Sets up common environment for Cache Policy fixture tests. this is called once per
29 /// test case before executing all tests under resource fixture test case.
30 /// It also calls SetupTestCase from CommonULT to initialize global context and others.
31 ///
32 /////////////////////////////////////////////////////////////////////////////////////
SetUpTestCase()33 void CTestGen12CachePolicy::SetUpTestCase()
34 {
35     GfxPlatform.eProductFamily    = IGFX_TIGERLAKE_LP;
36     GfxPlatform.eRenderCoreFamily = IGFX_GEN12_CORE;
37 
38     AllocateAdapterInfo();
39 
40     pGfxAdapterInfo->SystemInfo.L3CacheSizeInKb = 3072;
41 
42     const_cast<SKU_FEATURE_TABLE &>(pGfxAdapterInfo->SkuTable).FtrEDram     = false;
43     const_cast<SKU_FEATURE_TABLE &>(pGfxAdapterInfo->SkuTable).FtrLLCBypass = 0;
44 
45     CommonULT::SetUpTestCase();
46 
47     printf("%s\n", __FUNCTION__);
48 }
49 
50 /////////////////////////////////////////////////////////////////////////////////////
51 /// cleans up once all the tests finish execution.  It also calls TearDownTestCase
52 /// from CommonULT to destroy global context and others.
53 ///
54 /////////////////////////////////////////////////////////////////////////////////////
TearDownTestCase()55 void CTestGen12CachePolicy::TearDownTestCase()
56 {
57     printf("%s\n", __FUNCTION__);
58 
59     CommonULT::TearDownTestCase();
60 }
61 
CheckL3CachePolicy()62 void CTestGen12CachePolicy::CheckL3CachePolicy()
63 {
64     const uint32_t L3_WB_CACHEABLE = 0x3;
65     const uint32_t L3_UNCACHEABLE  = 0x1;
66 
67     // Check Usage MOCS index against MOCS settings
68     for(uint32_t Usage = GMM_RESOURCE_USAGE_UNKNOWN; Usage < GMM_RESOURCE_USAGE_MAX; Usage++)
69     {
70         GMM_CACHE_POLICY_ELEMENT     ClientRequest   = pGmmULTClientContext->GetCachePolicyElement((GMM_RESOURCE_USAGE_TYPE)Usage);
71         uint32_t                     AssignedMocsIdx = ClientRequest.MemoryObjectOverride.Gen12.Index;
72         GMM_CACHE_POLICY_TBL_ELEMENT Mocs            = pGmmULTClientContext->GetCachePolicyTlbElement(AssignedMocsIdx);
73 
74         //printf("Usage: %d --> Index: [%d]\n", Usage, AssignedMocsIdx);
75 
76         EXPECT_EQ(0, Mocs.L3.ESC) << "Usage# " << Usage << ": ESC is non-zero";
77         EXPECT_EQ(0, Mocs.L3.SCC) << "Usage# " << Usage << ": SCC is non-zero";
78         EXPECT_EQ(0, Mocs.L3.Reserved) << "Usage# " << Usage << ": Reserved field is non-zero";
79 
80         // Check if Mocs Index is not greater than GMM_MAX_NUMBER_MOCS_INDEXES
81         EXPECT_GT(GMM_MAX_NUMBER_MOCS_INDEXES, AssignedMocsIdx) << "Usage# " << Usage << ": MOCS Index greater than MAX allowed (63)";
82 
83         if(ClientRequest.L3Eviction == 0x2) //63
84         {
85             if((GMM_RESOURCE_USAGE_TYPE)Usage == GMM_RESOURCE_USAGE_L3_EVICTION)
86             {
87                 EXPECT_EQ(AssignedMocsIdx, 63) << "Usage# " << Usage << ": Incorrect Index for L3Eviction type# " << ClientRequest.L3Eviction;
88                 EXPECT_EQ(0, ClientRequest.L3) << "Usage# " << Usage << ": Incorrect L3 cacheability for L3Eviction type# " << ClientRequest.L3Eviction;
89             }
90             else
91             {
92                 EXPECT_NE(AssignedMocsIdx, 63) << "Usage# " << Usage << ": Incorrect Index for L3Eviction type# " << ClientRequest.L3Eviction;
93                 EXPECT_EQ(1, ClientRequest.L3) << "Usage# " << Usage << ": Incorrect L3 cacheability for L3Eviction type# " << ClientRequest.L3Eviction;
94             }
95         }
96         else if(ClientRequest.L3Eviction == 0x3) //61
97         {
98             EXPECT_EQ(AssignedMocsIdx, 61) << "Usage# " << Usage << ": Incorrect Index for L3Eviction type# " << ClientRequest.L3Eviction;
99             EXPECT_EQ(1, ClientRequest.L3) << "Usage# " << Usage << ": Incorrect L3 cacheability for L3Eviction type# " << ClientRequest.L3Eviction;
100         }
101         else if(Usage == GMM_RESOURCE_USAGE_CCS) //60
102         {
103             EXPECT_EQ(AssignedMocsIdx, 60) << "Usage# " << Usage << ": Incorrect Index for CCS";
104             EXPECT_EQ(0, ClientRequest.L3) << "Usage# " << Usage << ": Incorrect L3 cacheability for CCS";
105         }
106         else if(Usage == GMM_RESOURCE_USAGE_MOCS_62) //62
107         {
108             EXPECT_EQ(AssignedMocsIdx, 62) << "Usage# " << Usage << ": Incorrect Index for MOCS_62";
109             EXPECT_EQ(0, ClientRequest.L3) << "Usage# " << Usage << ": Incorrect L3 cacheability for MOCS#62";
110         }
111         // Check of assigned Index setting is appropriate for HDCL1 setting
112         else if(ClientRequest.HDCL1)
113         {
114             EXPECT_GE(AssignedMocsIdx, GMM_GEN10_HDCL1_MOCS_INDEX_START) << "Usage# " << Usage << ": Incorrect Index for HDCL1 setting";
115         }
116         else
117         {
118             EXPECT_LT(AssignedMocsIdx, GMM_GEN10_HDCL1_MOCS_INDEX_START) << "Usage# " << Usage << ": Incorrect Index for HDCL1 setting";
119         }
120 
121         if(ClientRequest.L3)
122         {
123             EXPECT_EQ(L3_WB_CACHEABLE, Mocs.L3.Cacheability) << "Usage# " << Usage << ": Incorrect L3 cachebility setting";
124         }
125         else
126         {
127             EXPECT_EQ(L3_UNCACHEABLE, Mocs.L3.Cacheability) << "Usage# " << Usage << ": Incorrect L3 cachebility setting";
128         }
129     }
130 }
131 
132 
TEST_F(CTestGen12CachePolicy,TestL3CachePolicy)133 TEST_F(CTestGen12CachePolicy, TestL3CachePolicy)
134 {
135     CheckL3CachePolicy();
136 }
137 
138 
CheckLlcEdramCachePolicy()139 void CTestGen12CachePolicy::CheckLlcEdramCachePolicy()
140 {
141     const uint32_t TargetCache_LLC = 1;
142 
143     const uint32_t LeCC_UNCACHEABLE    = 0x0;
144     const uint32_t LeCC_WC_UNCACHEABLE = 0x1;
145     const uint32_t LeCC_WB_CACHEABLE   = 0x3;
146     const uint32_t LeCC_WT_CACHEABLE   = 0x2;
147 
148     // Check Usage MOCS index against MOCS settings
149     for(uint32_t Usage = GMM_RESOURCE_USAGE_UNKNOWN; Usage < GMM_RESOURCE_USAGE_MAX; Usage++)
150     {
151         GMM_CACHE_POLICY_ELEMENT     ClientRequest   = pGmmULTClientContext->GetCachePolicyElement((GMM_RESOURCE_USAGE_TYPE)Usage);
152         uint32_t                        AssignedMocsIdx = ClientRequest.MemoryObjectOverride.Gen12.Index;
153         GMM_CACHE_POLICY_TBL_ELEMENT Mocs            = pGmmULTClientContext->GetCachePolicyTlbElement(AssignedMocsIdx);
154 
155         // Check for unused fields
156         EXPECT_EQ(0, Mocs.LeCC.AOM) << "Usage# " << Usage << ": AOM is non-zero";
157         EXPECT_EQ(0, Mocs.LeCC.CoS) << "Usage# " << Usage << ": CoS is non-zero";
158         EXPECT_EQ(0, Mocs.LeCC.PFM) << "Usage# " << Usage << ": PFM is non-zero";
159         EXPECT_EQ(0, Mocs.LeCC.SCC) << "Usage# " << Usage << ": SCC is non-zero";
160         // SCF field might be set for LKF/Gen12+ platforms;
161         EXPECT_EQ(0, Mocs.LeCC.SCF & !const_cast<SKU_FEATURE_TABLE &>(pGfxAdapterInfo->SkuTable).FtrLLCBypass) << "Usage# " << Usage << ": SCF is non-zero";
162         EXPECT_EQ(0, Mocs.LeCC.ESC) << "Usage# " << Usage << ": ESC is non-zero";
163         EXPECT_EQ(0, Mocs.LeCC.Reserved) << "Usage# " << Usage << ": Reserved field is non-zero";
164 
165         // Check for age
166         EXPECT_EQ(ClientRequest.AGE, Mocs.LeCC.LRUM) << "Usage# " << Usage << ": Incorrect AGE settings";
167 
168         // Check for Snoop Setting
169         EXPECT_EQ(ClientRequest.SSO, Mocs.LeCC.SelfSnoop) << "Usage# " << Usage << ": Self Snoop is non-zero";
170 
171         // Check if Mocs Index is not greater than GMM_MAX_NUMBER_MOCS_INDEXES
172         EXPECT_GT(GMM_MAX_NUMBER_MOCS_INDEXES, AssignedMocsIdx) << "Usage# " << Usage << ": MOCS Index greater than MAX allowed (63)";
173 
174         if(ClientRequest.L3Eviction == 0x2) //63
175         {
176             GMM_CACHE_POLICY_ELEMENT MOCS63 = pGmmULTClientContext->GetCachePolicyElement(GMM_RESOURCE_USAGE_L3_EVICTION);
177             if((GMM_RESOURCE_USAGE_TYPE)Usage == GMM_RESOURCE_USAGE_L3_EVICTION)
178             {
179                 EXPECT_EQ(AssignedMocsIdx, 63) << "Usage# " << Usage << ": Incorrect Index for L3Eviction type# " << ClientRequest.L3Eviction;
180             }
181             else
182             {
183                 MOCS63.L3 = 1; //Override L3 to test , since Hw forces it to L3-uncached
184                 EXPECT_NE(AssignedMocsIdx, 63) << "Usage# " << Usage << ": Incorrect Index for L3Eviction type# " << ClientRequest.L3Eviction;
185                 EXPECT_EQ(MOCS63.Value, ClientRequest.Value) << "Usage# " << Usage << ": Incorrect usage for L3Eviction type# " << ClientRequest.L3Eviction;
186             }
187         }
188         else if(ClientRequest.L3Eviction == 0x3) //61
189         {
190             GMM_CACHE_POLICY_ELEMENT MOCS61 = pGmmULTClientContext->GetCachePolicyElement(GMM_RESOURCE_USAGE_L3_EVICTION_SPECIAL);
191             EXPECT_EQ(AssignedMocsIdx, 61) << "Usage# " << Usage << ": Incorrect Index for L3Eviction type# " << ClientRequest.L3Eviction;
192             EXPECT_EQ(0, ClientRequest.LLC) << "Usage# " << Usage << ": Incorrect LLC cacheability for L3Eviction type# " << ClientRequest.L3Eviction;
193             EXPECT_EQ(MOCS61.Value, ClientRequest.Value) << "Usage# " << Usage << ": Incorrect usage for L3Eviction type# " << ClientRequest.L3Eviction;
194         }
195         else if(Usage == GMM_RESOURCE_USAGE_CCS) //60
196         {
197             EXPECT_EQ(AssignedMocsIdx, 60) << "Usage# " << Usage << ": Incorrect Index for CCS";
198         }
199         else if(Usage == GMM_RESOURCE_USAGE_MOCS_62) //62
200         {
201             EXPECT_EQ(AssignedMocsIdx, 62) << "Usage# " << Usage << ": Incorrect Index for MOCS_62";
202         }
203         // Check of assigned Index setting is appropriate for HDCL1 setting
204         else if(ClientRequest.HDCL1)
205         {
206             EXPECT_GE(AssignedMocsIdx, GMM_GEN10_HDCL1_MOCS_INDEX_START) << "Usage# " << Usage << ": Incorrect Index for HDCL1 setting";
207         }
208         else
209         {
210             EXPECT_LT(AssignedMocsIdx, GMM_GEN10_HDCL1_MOCS_INDEX_START) << "Usage# " << Usage << ": Incorrect Index for HDCL1 setting";
211         }
212 
213         if(!ClientRequest.LLC && !ClientRequest.ELLC) // Uncached
214         {
215             EXPECT_EQ(LeCC_WC_UNCACHEABLE, Mocs.LeCC.Cacheability) << "Usage# " << Usage << ": Incorrect LLC/eDRAM cachebility setting";
216         }
217         else
218         {
219             if(ClientRequest.LLC) // LLC only
220             {
221                 EXPECT_EQ(TargetCache_LLC, Mocs.LeCC.TargetCache) << "Usage# " << Usage << ": Incorrect target cache setting";
222 
223                 EXPECT_EQ(LeCC_WB_CACHEABLE, Mocs.LeCC.Cacheability) << "Usage# " << Usage << ": Incorrect LLC cachebility setting";
224             }
225             else
226             {
227                 EXPECT_EQ(TargetCache_LLC, Mocs.LeCC.TargetCache) << "Usage# " << Usage << ": Incorrect target cache setting";
228 
229                 EXPECT_EQ(LeCC_WC_UNCACHEABLE, Mocs.LeCC.Cacheability) << "Usage# " << Usage << ": Incorrect LLC cachebility setting";
230             }
231         }
232     }
233 }
234 
TEST_F(CTestGen12CachePolicy,TestLlcEdramCachePolicy)235 TEST_F(CTestGen12CachePolicy, TestLlcEdramCachePolicy)
236 {
237     CheckLlcEdramCachePolicy();
238 }
239