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
273
274
275
276
277
278
279
280
281
282
|
/* $Id: tstRTR0CommonDriver.h $ */
/** @file
* IPRT R0 Testcase - Common header for the testcase drivers.
*/
/*
* Copyright (C) 2010-2019 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef IPRT_INCLUDED_SRC_testcase_tstRTR0CommonDriver_h
#define IPRT_INCLUDED_SRC_testcase_tstRTR0CommonDriver_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
/*******************************************************************************
* Header Files *
*******************************************************************************/
#include <iprt/ctype.h>
#include <iprt/string.h>
#include <VBox/sup.h>
#include "tstRTR0CommonReq.h"
/*******************************************************************************
* Global Variables *
*******************************************************************************/
/** The test handle. */
RTTEST g_hTest;
/** The test & service name. */
char g_szSrvName[64];
/** The length of the service name. */
size_t g_cchSrvName;
/** The base address of the service module. */
void *g_pvImageBase;
/**
* Initializes the test driver.
*
* This means creating a test instance (RTTEST), initializing the support
* library, and loading the service module.
*
* @returns RTEXITCODE_SUCCESS on success, appropriate exit code on failure.
* @param pszTestServiceName The name of the test and service. This
* will be used when creating the test
* instance as well as when talking with the
* kernel side of the test.
*
* The ring-0 module name will be derived from
* this + '.r0'.
*
* The service request handler function name
* will be derived by upper casing the first
* chars and appending 'SrvReqHandler'.
*
*/
RTEXITCODE RTR3TestR0CommonDriverInit(const char *pszTestServiceName)
{
/*
* Init the test.
*/
RTEXITCODE rcExit = RTTestInitAndCreate(pszTestServiceName, &g_hTest);
if (rcExit != RTEXITCODE_SUCCESS)
return rcExit;
RTTestBanner(g_hTest);
/*
* Init the globals.
*/
g_cchSrvName = strlen(pszTestServiceName);
int rc = RTStrCopy(g_szSrvName, sizeof(g_szSrvName), pszTestServiceName);
if (rc != VINF_SUCCESS)
{
RTTestFailed(g_hTest, "The test name is too long! (%zu bytes)", g_cchSrvName);
return RTTestSummaryAndDestroy(g_hTest);
}
/*
* Initialize the support driver session.
*/
PSUPDRVSESSION pSession;
rc = SUPR3Init(&pSession);
if (RT_FAILURE(rc))
{
RTTestFailed(g_hTest, "SUPR3Init failed with rc=%Rrc\n", rc);
return RTTestSummaryAndDestroy(g_hTest);
}
char szPath[RTPATH_MAX + sizeof(".r0")];
rc = RTPathExecDir(szPath, RTPATH_MAX);
if (RT_SUCCESS(rc))
rc = RTPathAppend(szPath, RTPATH_MAX, pszTestServiceName);
if (RT_SUCCESS(rc))
strcat(szPath, ".r0");
if (RT_FAILURE(rc))
{
RTTestFailed(g_hTest, "Failed constructing .r0 filename (rc=%Rrc)", rc);
return RTTestSummaryAndDestroy(g_hTest);
}
char szSrvReqHandler[sizeof(g_szSrvName) + sizeof("SrvReqHandler")];
strcpy(szSrvReqHandler, pszTestServiceName);
strcat(szSrvReqHandler, "SrvReqHandler");
for (size_t off = 0; RT_C_IS_LOWER(szSrvReqHandler[off]); off++)
szSrvReqHandler[off] = RT_C_TO_UPPER(szSrvReqHandler[off]);
rc = SUPR3LoadServiceModule(szPath, pszTestServiceName, szSrvReqHandler, &g_pvImageBase);
if (RT_FAILURE(rc))
{
RTTestFailed(g_hTest, "SUPR3LoadServiceModule(%s,%s,%s,) failed with rc=%Rrc\n",
szPath, pszTestServiceName, szSrvReqHandler, rc);
return RTTestSummaryAndDestroy(g_hTest);
}
/*
* Do the sanity checks.
*/
RTTestSub(g_hTest, "Sanity");
RTTSTR0REQ Req;
Req.Hdr.u32Magic = SUPR0SERVICEREQHDR_MAGIC;
Req.Hdr.cbReq = sizeof(Req);
memset(Req.szMsg, 0xef, sizeof(Req.szMsg));
RTTESTI_CHECK_RC(rc = SUPR3CallR0Service(g_szSrvName, g_cchSrvName, RTTSTR0REQ_SANITY_OK, 0, &Req.Hdr), VINF_SUCCESS);
if (RT_FAILURE(rc))
return RTTestSummaryAndDestroy(g_hTest);
RTTESTI_CHECK_MSG(Req.szMsg[0] == '\0', ("%s", Req.szMsg));
if (Req.szMsg[0] != '\0')
return RTTestSummaryAndDestroy(g_hTest);
Req.Hdr.u32Magic = SUPR0SERVICEREQHDR_MAGIC;
Req.Hdr.cbReq = sizeof(Req);
Req.szMsg[0] = '\0';
memset(Req.szMsg, 0xfe, sizeof(Req.szMsg));
RTTESTI_CHECK_RC(rc = SUPR3CallR0Service(g_szSrvName, g_cchSrvName, RTTSTR0REQ_SANITY_FAILURE, 0, &Req.Hdr), VINF_SUCCESS);
if (RT_FAILURE(rc))
return RTTestSummaryAndDestroy(g_hTest);
rc = !strncmp(Req.szMsg, "!42failure42", sizeof("!42failure42"));
if (rc)
{
RTTestFailed(g_hTest, "the negative sanity check failed");
return RTTestSummaryAndDestroy(g_hTest);
}
RTTestSubDone(g_hTest);
return RTEXITCODE_SUCCESS;
}
/**
* Processes the messages in the request.
*
* @returns true on success, false on failure.
* @param pReq The request.
*/
static bool rtR3TestR0ProcessMessages(PRTTSTR0REQ pReq)
{
/*
* Process the message strings.
*
* We can have multiple failures and info messages packed into szMsg. They
* are separated by a double newline. The kind of message is indicated by
* the first character, '!' means error and '?' means info message. '$' means
* the test was skipped because a feature is not supported on the host.
*/
bool fRc = true;
if (pReq->szMsg[0])
{
pReq->szMsg[sizeof(pReq->szMsg) - 1] = '\0'; /* paranoia */
char *pszNext = &pReq->szMsg[0];
do
{
char *pszCur = pszNext;
do
pszNext = strpbrk(pszNext + 1, "!?$");
while (pszNext && (pszNext[-1] != '\n' || pszNext[-2] != '\n'));
char *pszEnd = pszNext ? pszNext - 1 : strchr(pszCur, '\0');
while ( (uintptr_t)pszEnd > (uintptr_t)pszCur
&& pszEnd[-1] == '\n')
*--pszEnd = '\0';
if (*pszCur == '!')
{
RTTestFailed(g_hTest, "%s", pszCur + 1);
fRc = false;
}
else if (*pszCur == '$')
{
RTTestSkipped(g_hTest, "%s", pszCur + 1);
}
else
RTTestPrintfNl(g_hTest, RTTESTLVL_ALWAYS, "%s", pszCur + 1);
} while (pszNext);
}
return fRc;
}
/**
* Performs a simple test with an argument (@a u64Arg).
*
* @returns true on success, false on failure.
* @param uOperation The operation to perform.
* @param u64Arg 64-bit argument.
* @param pszTestFmt The sub-test name.
* @param ... Format arguments.
*/
bool RTR3TestR0SimpleTestWithArg(uint32_t uOperation, uint64_t u64Arg, const char *pszTestFmt, ...)
{
va_list va;
va_start(va, pszTestFmt);
RTTestSubV(g_hTest, pszTestFmt, va);
va_end(va);
RTTSTR0REQ Req;
Req.Hdr.u32Magic = SUPR0SERVICEREQHDR_MAGIC;
Req.Hdr.cbReq = sizeof(Req);
RT_ZERO(Req.szMsg);
int rc = SUPR3CallR0Service(g_szSrvName, g_cchSrvName, uOperation, u64Arg, &Req.Hdr);
if (RT_FAILURE(rc))
{
RTTestFailed(g_hTest, "SUPR3CallR0Service failed with rc=%Rrc", rc);
return false;
}
return rtR3TestR0ProcessMessages(&Req);
}
/**
* Performs a simple test.
*
* @returns true on success, false on failure.
* @param uOperation The operation to perform.
* @param pszTestFmt The sub-test name.
* @param ... Format arguments.
*/
bool RTR3TestR0SimpleTest(uint32_t uOperation, const char *pszTestFmt, ...)
{
va_list va;
va_start(va, pszTestFmt);
RTTestSubV(g_hTest, pszTestFmt, va);
va_end(va);
RTTSTR0REQ Req;
Req.Hdr.u32Magic = SUPR0SERVICEREQHDR_MAGIC;
Req.Hdr.cbReq = sizeof(Req);
RT_ZERO(Req.szMsg);
int rc = SUPR3CallR0Service(g_szSrvName, g_cchSrvName, uOperation, 0, &Req.Hdr);
if (RT_FAILURE(rc))
{
RTTestFailed(g_hTest, "SUPR3CallR0Service failed with rc=%Rrc", rc);
return false;
}
return rtR3TestR0ProcessMessages(&Req);
}
#endif /* !IPRT_INCLUDED_SRC_testcase_tstRTR0CommonDriver_h */
|
