summaryrefslogtreecommitdiffstats
path: root/src/usr/sbeio/test/sbe_memregiontest.H
blob: 87cb4a0407a2f157877b322120f4ba23e86c298a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/sbeio/test/sbe_memregiontest.H $                      */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2017                             */
/* [+] International Business Machines Corp.                              */
/*                                                                        */
/*                                                                        */
/* Licensed under the Apache License, Version 2.0 (the "License");        */
/* you may not use this file except in compliance with the License.       */
/* You may obtain a copy of the License at                                */
/*                                                                        */
/*     http://www.apache.org/licenses/LICENSE-2.0                         */
/*                                                                        */
/* Unless required by applicable law or agreed to in writing, software    */
/* distributed under the License is distributed on an "AS IS" BASIS,      */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        */
/* implied. See the License for the specific language governing           */
/* permissions and limitations under the License.                         */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
#ifndef __SBE_MEMREGIONTEST_H
#define __SBE_MEMREGIONTEST_H

/**
 *  @file sbe_memregiontest.H
 *
 *  @brief Test cases for Opening/Closing SBE/HB Memory Regions
*/

#include <cxxtest/TestSuite.H>
#include <errl/errlentry.H>
#include <errl/errlmanager.H>
#include <sbeio/sbeioif.H>
#include <sbeio/sbeioreasoncodes.H>
#include <vmmconst.h>
#include <sys/mm.h>

#include "../sbe_memRegionMgr.H"

#define SBE_TRACD_MRT(printf_string,args...) \
    TRACDCOMP(g_trac_sbeio,"memRegionTest: " printf_string,##args)
#define SBE_TRACF_MRT(printf_string,args...) \
    TRACFCOMP(g_trac_sbeio,"memRegionTest: " printf_string,##args)

extern trace_desc_t* g_trac_sbeio;

class SbeMemRegionTest : public CxxTest::TestSuite
{
  public:

      /**
       *  @brief Open and Close Overlapping Unsecure Memory Regions
       */
      void testSBEMemRegion1(void)
      {
          TS_TRACE(ENTER_MRK"memRegionTest1: Opening and Closing Unsecure Memory Regions");

          errlHndl_t errl = nullptr;

          // Reserve and Open Random Overlapping Memory Regions to force
          // MemRegionMgr to update regions around each other

          // Reserve the Physical Memory set aside in vmmconst.h to use
          // for this test so that the SBEIO commands will work
          uint32_t mem_buf_size = UNSECURE_MEM_REGION_SIZE_TEST;
          uint64_t mem_buf_start_addr = UNSECURE_MEM_REGION_ADDR_TEST;
          void * tmp_virtual_addr = mm_block_map(
                                        reinterpret_cast<void*>
                                           (UNSECURE_MEM_REGION_ADDR_TEST),
                                        UNSECURE_MEM_REGION_SIZE_TEST);
          assert(tmp_virtual_addr!=nullptr, "memRegionTest1: tmp_virtual_addr is nullptr");

          do
          {

          // Loop Test: Open MAX+1 to force a fail
          for (size_t i = 1; i<=SBEIO_MAX_UNSECURE_MEMORY_REGIONS+1 ; i++)
          {
              errl = SBEIO::openUnsecureMemRegion(mem_buf_start_addr +
                                                      ((i-1)*32),
                                                  16,
                                                  true); //true=Read-Write

              if (i <= SBEIO_MAX_UNSECURE_MEMORY_REGIONS)
              {
                  // Expect the open to succeed
                  if (errl)
                  {
                      TS_FAIL("memRegionTest1: Loop Test-%d: SBEIO::openUnsecureMemRegion() Failed: rc=0x%X, plid=0x%X",
                              i, ERRL_GETRC_SAFE(errl), ERRL_GETPLID_SAFE(errl));
                      break;
                  }
                  else
                  {
                      SBE_TRACD_MRT("memRegionTest1: Loop Test-%d: SBEIO::openUnsecureMemRegion() SUCCESSFUL", i);
                  }
              }
              else // i = SBEIO_MAX_UNSECURE_MEMORY_REGIONS + 1
              {
                  // Expect the open to fail with the return code
                  // SBEIO_EXCEEDS_MAXIMUM_MEM_REGIONS
                  if (ERRL_GETRC_SAFE(errl)==SBEIO::SBEIO_EXCEEDS_MAXIMUM_MEM_REGIONS)
                  {
                      SBE_TRACF_MRT("memRegionTest1: Loop Test-%d: SBEIO::openUnsecureMemRegion() Returned Expected Fail: rc=0x%X, plid=0x%X",
                              i, ERRL_GETRC_SAFE(errl), ERRL_GETPLID_SAFE(errl));
                      delete errl;
                      errl = nullptr;
                  }
                  else
                  {
                      TS_FAIL("memRegionTest1: Loop Test-%d: SBEIO::openUnsecureMemRegion() Did NOT Return Expected Fail rc=0x%X: got rc=0x%X, plid=0x%X",
                              i, SBEIO::SBEIO_EXCEEDS_MAXIMUM_MEM_REGIONS,
                              ERRL_GETRC_SAFE(errl), ERRL_GETPLID_SAFE(errl));
                      break;
                  }
              }
          }

          // Skip the rest of the testcase if we already have an error log
          if(errl)
          {
              break;
          }

          // Test 1: Open Read-Write region for front half of memory buffer
          errl = SBEIO::openUnsecureMemRegion(mem_buf_start_addr,
                                              mem_buf_size/2,
                                              true); //true=Read-Write
          if (errl)
          {
              TS_FAIL("memRegionTest1: T1: SBEIO::openUnsecureMemRegion() Failed: rc=0x%X, plid=0x%X",
                      ERRL_GETRC_SAFE(errl), ERRL_GETPLID_SAFE(errl));
              break;
          }
          else
          {
              SBE_TRACD_MRT("memRegionTest1: T1: SBEIO::openUnsecureMemRegion() SUCCESSFUL");
          }

          // Test 2: Open Overlapping Read-Only region for middle chunk of
          //   memory buffer
          errl = SBEIO::openUnsecureMemRegion(mem_buf_start_addr+mem_buf_size/4,
                                              mem_buf_size/2,
                                              false); //false=Read-Only
          if (errl)
          {
              TS_FAIL("memRegionTest1: T2: SBEIO::openUnsecureMemRegion() Failed: rc=0x%X, plid=0x%X",
                      ERRL_GETRC_SAFE(errl), ERRL_GETPLID_SAFE(errl));
              break;
          }
          else
          {
              SBE_TRACD_MRT("memRegionTest1: T2: SBEIO::openUnsecureMemRegion() SUCCESSFUL");
          }

          // Test 3: Open Overlapping Read-Write region completely enclosed by
          //   existing region
          errl = SBEIO::openUnsecureMemRegion(mem_buf_start_addr+mem_buf_size/2,
                                              mem_buf_size/8,
                                              true); //true=Read-Write
          if (errl)
          {
              TS_FAIL("memRegionTest1: T3: SBEIO::openUnsecureMemRegion() Failed: rc=0x%X, plid=0x%X",
                      ERRL_GETRC_SAFE(errl), ERRL_GETPLID_SAFE(errl));
              break;
          }
          else
          {
              SBE_TRACD_MRT("memRegionTest1: T3: SBEIO::openUnsecureMemRegion() SUCCESSFUL");
          }

          // Test 4: Open Overlapping Read-Write region that completely encloses
          //   existing regions
          errl = SBEIO::openUnsecureMemRegion(mem_buf_start_addr+mem_buf_size/8,
                                              (mem_buf_size/4) * 3,
                                              true); //true=Read-Write
          if (errl)
          {
              TS_FAIL("memRegionTest1: T4: SBEIO::openUnsecureMemRegion() Failed: rc=0x%X, plid=0x%X",
                      ERRL_GETRC_SAFE(errl), ERRL_GETPLID_SAFE(errl));
              break;
          }
          else
          {
              SBE_TRACD_MRT("memRegionTest1: T4: SBEIO::openUnsecureMemRegion() SUCCESSFUL");
          }

          // Test 5: Open Non-Overlapping Read-Only Region at the end
          //   existing regions
          errl = SBEIO::openUnsecureMemRegion(mem_buf_start_addr+(mem_buf_size/8)*7,
                                              mem_buf_size/8,
                                              false); //false=Read-Only
          if (errl)
          {
              TS_FAIL("memRegionTest1: T5: SBEIO::openUnsecureMemRegion() Failed: rc=0x%X, plid=0x%X",
                      ERRL_GETRC_SAFE(errl), ERRL_GETPLID_SAFE(errl));
              break;
          }
          else
          {
              SBE_TRACD_MRT("memRegionTest1: T5: SBEIO::openUnsecureMemRegion() SUCCESSFUL");
          }

          // Test 6: Close Single Region That Exists
          errl = SBEIO::closeUnsecureMemRegion(mem_buf_start_addr+(mem_buf_size/8)*7);
          if (errl)
          {
              TS_FAIL("memRegionTest1: T6: SBEIO::closeUnsecureMemRegion() Failed: rc=0x%X, plid=0x%X",
                      ERRL_GETRC_SAFE(errl), ERRL_GETPLID_SAFE(errl));
              break;
          }
          else
          {
              SBE_TRACD_MRT("memRegionTest1: T6: SBEIO::closeUnsecureMemRegion() SUCCESSFUL");
          }

          // Test 7: Re-Close Single Region and look for expected fail
          errl = SBEIO::closeUnsecureMemRegion(mem_buf_start_addr+(mem_buf_size/8)*7);
          if (ERRL_GETRC_SAFE(errl) == SBEIO::SBEIO_MEM_REGION_DOES_NOT_EXIST)
          {
              SBE_TRACF_MRT("memRegionTest1: T7: SBEIO::closeUnsecureMemRegion() Returned Expected Fail: rc=0x%X, plid=0x%X",
                            ERRL_GETRC_SAFE(errl), ERRL_GETPLID_SAFE(errl));
              delete errl;
              errl = nullptr;
          }
          else
          {
              TS_FAIL("memRegionTest1: T7: SBEIO::closeUnsecureMemRegion() Did NOT Return Expected Fail rc=0x%X: got rc=0x%X, plid=0x%X",
                      SBEIO::SBEIO_MEM_REGION_DOES_NOT_EXIST,
                      ERRL_GETRC_SAFE(errl), ERRL_GETPLID_SAFE(errl));
              break;
          }

          // Test 99: Close all Memory Regions
          errl = SBEIO::closeAllUnsecureMemRegions();
          if (errl)
          {
              TS_FAIL("memRegionTest1: T99: SBEIO::closeAllUnsecureMemRegions Failed: rc=0x%X, plid=0x%X",
                      ERRL_GETRC_SAFE(errl), ERRL_GETPLID_SAFE(errl));
              break;
          }
          else
          {
              SBE_TRACF_MRT("memRegionTest1: T99: Closing All Memory Regions SUCCESSFUL");
          }

          }while(0);

          // Commit any unexpected error logs
          if (errl)
          {
              errlCommit(errl, SBEIO_COMP_ID);
          }

          // Unmap the reserved memory using the virtual address
          int rc = mm_block_unmap(tmp_virtual_addr);

          if (rc)
          {
              TS_FAIL("memRegionTest1: mm_block_unmap failed with rc=%d", rc);
          }

          TS_TRACE(EXIT_MRK"memRegionTest1");
      }

};

#endif
OpenPOWER on IntegriCloud