VirtualBox

source: vbox/trunk/src/VBox/Devices/testcase/tstDeviceStructSize.cpp@ 82170

Last change on this file since 82170 was 82170, checked in by vboxsync, 5 years ago

Devices: PS2K.cpp -> DevPS2K.cpp; PS2M.cpp -> DevPS2M.cpp; PS2Dev.h -> DevPS2.h. bugref:9218

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 14.4 KB
Line 
1/* $Id: tstDeviceStructSize.cpp 82170 2019-11-25 12:22:23Z vboxsync $ */
2/** @file
3 * tstDeviceStructSize - testcase for check structure sizes/alignment
4 * and to verify that HC and RC uses the same
5 * representation of the structures.
6 */
7
8/*
9 * Copyright (C) 2006-2019 Oracle Corporation
10 *
11 * This file is part of VirtualBox Open Source Edition (OSE), as
12 * available from http://www.virtualbox.org. This file is free software;
13 * you can redistribute it and/or modify it under the terms of the GNU
14 * General Public License (GPL) as published by the Free Software
15 * Foundation, in version 2 as it comes in the "COPYING" file of the
16 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
17 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
18 */
19
20
21/*********************************************************************************************************************************
22* Header Files *
23*********************************************************************************************************************************/
24#include <VBox/types.h>
25#include <iprt/x86.h>
26
27#define VBOX_WITH_HGCM /* grumble */
28#define VBOX_DEVICE_STRUCT_TESTCASE
29
30/* Check that important preprocessor macros does not get redefined: */
31#include <VBox/cdefs.h>
32#include <VBox/log.h>
33#ifdef DEBUG
34# define VBOX_DEVICE_STRUCT_TESTCASE_CHECK_DEBUG
35#else
36# undef VBOX_DEVICE_STRUCT_TESTCASE_CHECK_DEBUG
37#endif
38#ifdef LOG_ENABLED
39# define VBOX_DEVICE_STRUCT_TESTCASE_CHECK_LOG_ENABLED
40#else
41# undef VBOX_DEVICE_STRUCT_TESTCASE_CHECK_LOG_ENABLED
42#endif
43#ifdef VBOX_STRICT
44# define VBOX_DEVICE_STRUCT_TESTCASE_CHECK_VBOX_STRICT
45#else
46# undef VBOX_DEVICE_STRUCT_TESTCASE_CHECK_VBOX_STRICT
47#endif
48#ifdef RT_STRICT
49# define VBOX_DEVICE_STRUCT_TESTCASE_CHECK_RT_STRICT
50#else
51# undef VBOX_DEVICE_STRUCT_TESTCASE_CHECK_RT_STRICT
52#endif
53
54/* The structures we're checking: */
55#undef LOG_GROUP
56#include "../Bus/DevPciInternal.h"
57#undef LOG_GROUP
58#include "../Graphics/DevVGA.cpp"
59#undef LOG_GROUP
60#include "../Input/DevPS2.cpp"
61#undef LOG_GROUP
62#include "../Input/DevPS2K.cpp"
63#undef LOG_GROUP
64#include "../Input/DevPS2M.cpp"
65#ifdef VBOX_WITH_E1000
66# undef LOG_GROUP
67# include "../Network/DevE1000.cpp"
68#endif
69#undef LOG_GROUP
70#include "../Network/DevPCNet.cpp"
71#ifdef VBOX_WITH_VIRTIO
72# undef LOG_GROUP
73# include "../Network/DevVirtioNet.cpp"
74#endif
75#undef LOG_GROUP
76#include "../PC/DevACPI.cpp"
77#undef LOG_GROUP
78#include "../PC/DevPIC.cpp"
79#undef LOG_GROUP
80#include "../PC/DevPit-i8254.cpp"
81#undef LOG_GROUP
82#include "../PC/DevRTC.cpp"
83# undef LOG_GROUP
84# include "../../VMM/VMMR3/APIC.cpp"
85#undef LOG_GROUP
86#include "../PC/DevIoApic.cpp"
87#undef LOG_GROUP
88#include "../PC/DevHPET.cpp"
89#undef LOG_GROUP
90#include "../PC/DevDMA.cpp"
91#undef LOG_GROUP
92#include "../EFI/DevSmc.cpp"
93#undef LOG_GROUP
94#include "../Storage/DevATA.cpp"
95#ifdef VBOX_WITH_USB
96# undef LOG_GROUP
97# include "../USB/DevOHCI.cpp"
98# ifdef VBOX_WITH_EHCI_IMPL
99# undef LOG_GROUP
100# include "../USB/DevEHCI.cpp"
101# endif
102# ifdef VBOX_WITH_XHCI_IMPL
103# undef LOG_GROUP
104# include "../USB/DevXHCI.cpp"
105# endif
106#endif
107#undef LOG_GROUP
108#include "../VMMDev/VMMDev.cpp"
109#undef LOG_GROUP
110#include "../Parallel/DevParallel.cpp"
111#undef LOG_GROUP
112#include "../Serial/DevSerial.cpp"
113#undef LOG_GROUP
114#include "../Serial/DevOxPcie958.cpp"
115#ifdef VBOX_WITH_AHCI
116# undef LOG_GROUP
117# include "../Storage/DevAHCI.cpp"
118#endif
119#ifdef VBOX_WITH_BUSLOGIC
120# undef LOG_GROUP
121# include "../Storage/DevBusLogic.cpp"
122#endif
123#ifdef VBOX_WITH_LSILOGIC
124# undef LOG_GROUP
125# include "../Storage/DevLsiLogicSCSI.cpp"
126#endif
127#ifdef VBOX_WITH_NVME_IMPL
128# undef LOG_GROUP
129# include "../Storage/DevNVMe.cpp"
130#endif
131
132#ifdef VBOX_WITH_PCI_PASSTHROUGH_IMPL
133# undef LOG_GROUP
134# include "../Bus/DevPciRaw.cpp"
135#endif
136
137#include <VBox/vmm/pdmaudioifs.h>
138
139#undef LOG_GROUP
140#include "../Audio/DevIchAc97.cpp"
141#undef LOG_GROUP
142#include "../Audio/DevHDA.cpp"
143
144
145/* Check that important preprocessor macros didn't get redefined: */
146#if defined(DEBUG) != defined(VBOX_DEVICE_STRUCT_TESTCASE_CHECK_DEBUG)
147# error "DEBUG was modified! This may throw off structure tests."
148#endif
149#if defined(LOG_ENABLED) != defined(VBOX_DEVICE_STRUCT_TESTCASE_CHECK_LOG_ENABLED)
150# error "LOG_ENABLED was modified! This may throw off structure tests."
151#endif
152#if defined(RT_STRICT) != defined(VBOX_DEVICE_STRUCT_TESTCASE_CHECK_RT_STRICT)
153# error "RT_STRICT was modified! This may throw off structure tests."
154#endif
155#if defined(VBOX_STRICT) != defined(VBOX_DEVICE_STRUCT_TESTCASE_CHECK_VBOX_STRICT)
156# error "VBOX_STRICT was modified! This may throw off structure tests."
157#endif
158
159
160#include <stdio.h>
161
162
163/*********************************************************************************************************************************
164* Defined Constants And Macros *
165*********************************************************************************************************************************/
166/**
167 * Checks the offset of a data member.
168 * @param type Type.
169 * @param off Correct offset.
170 * @param m Member name.
171 */
172#define CHECK_OFF(type, off, m) \
173 do { \
174 if (off != RT_OFFSETOF(type, m)) \
175 { \
176 printf("tstDeviceStructSize: Error! %#010x %s Member offset wrong by %d (should be %d -- but is %d)\n", \
177 RT_OFFSETOF(type, m), #type "." #m, off - RT_OFFSETOF(type, m), off, RT_OFFSETOF(type, m)); \
178 rc++; \
179 } \
180 else \
181 printf("%#08x (%d) %s\n", RT_OFFSETOF(type, m), RT_OFFSETOF(type, m), #type "." #m); \
182 } while (0)
183
184/**
185 * Checks the size of type.
186 * @param type Type.
187 * @param size Correct size.
188 */
189#define CHECK_SIZE(type, size) \
190 do { \
191 if (size != sizeof(type)) \
192 { \
193 printf("tstDeviceStructSize: Error! sizeof(%s): %#x (%d) Size wrong by %d (should be %d -- but is %d)\n", \
194 #type, (int)sizeof(type), (int)sizeof(type), (int)sizeof(type) - (int)size, (int)size, (int)sizeof(type)); \
195 rc++; \
196 } \
197 else \
198 printf("tstDeviceStructSize: info: sizeof(%s): %#x (%d)\n", #type, (int)sizeof(type), (int)sizeof(type)); \
199 } while (0)
200
201/**
202 * Checks the alignment of a struct member.
203 */
204#define CHECK_MEMBER_ALIGNMENT(strct, member, align) \
205 do \
206 { \
207 if (RT_OFFSETOF(strct, member) & ((align) - 1) ) \
208 { \
209 printf("tstDeviceStructSize: error! %s::%s offset=%#x (%u) expected alignment %#x, meaning %#x (%u) off\n", \
210 #strct, #member, \
211 (unsigned)RT_OFFSETOF(strct, member), \
212 (unsigned)RT_OFFSETOF(strct, member), \
213 (unsigned)(align), \
214 (unsigned)(((align) - RT_OFFSETOF(strct, member)) & ((align) - 1)), \
215 (unsigned)(((align) - RT_OFFSETOF(strct, member)) & ((align) - 1)) ); \
216 rc++; \
217 } \
218 } while (0)
219
220/**
221 * Checks that the size of a type is aligned correctly.
222 */
223#define CHECK_SIZE_ALIGNMENT(type, align) \
224 do { \
225 if (RT_ALIGN_Z(sizeof(type), (align)) != sizeof(type)) \
226 { \
227 printf("tstDeviceStructSize: error! %s size=%#x (%u), align=%#x %#x (%u) bytes off\n", \
228 #type, \
229 (unsigned)sizeof(type), \
230 (unsigned)sizeof(type), \
231 (align), \
232 (unsigned)RT_ALIGN_Z(sizeof(type), align) - (unsigned)sizeof(type), \
233 (unsigned)RT_ALIGN_Z(sizeof(type), align) - (unsigned)sizeof(type)); \
234 rc++; \
235 } \
236 } while (0)
237
238/**
239 * Checks that a internal struct padding is big enough.
240 */
241#define CHECK_PADDING(strct, member, align) \
242 do \
243 { \
244 strct *p = NULL; NOREF(p); \
245 if (sizeof(p->member.s) > sizeof(p->member.padding)) \
246 { \
247 printf("tstDeviceStructSize: error! padding of %s::%s is too small, padding=%d struct=%d correct=%d\n", #strct, #member, \
248 (int)sizeof(p->member.padding), (int)sizeof(p->member.s), (int)RT_ALIGN_Z(sizeof(p->member.s), (align))); \
249 rc++; \
250 } \
251 else if (RT_ALIGN_Z(sizeof(p->member.padding), (align)) != sizeof(p->member.padding)) \
252 { \
253 printf("tstDeviceStructSize: error! padding of %s::%s is misaligned, padding=%d correct=%d\n", #strct, #member, \
254 (int)sizeof(p->member.padding), (int)RT_ALIGN_Z(sizeof(p->member.s), (align))); \
255 rc++; \
256 } \
257 } while (0)
258
259/**
260 * Checks that a internal struct padding is big enough.
261 */
262#define CHECK_PADDING2(strct) \
263 do \
264 { \
265 strct *p = NULL; NOREF(p); \
266 if (sizeof(p->s) > sizeof(p->padding)) \
267 { \
268 printf("tstDeviceStructSize: error! padding of %s is too small, padding=%d struct=%d correct=%d\n", #strct, \
269 (int)sizeof(p->padding), (int)sizeof(p->s), (int)RT_ALIGN_Z(sizeof(p->s), 32)); \
270 rc++; \
271 } \
272 } while (0)
273
274/**
275 * Checks that a internal struct padding is big enough.
276 */
277#define CHECK_PADDING3(strct, member, pad_member) \
278 do \
279 { \
280 strct *p = NULL; NOREF(p); \
281 if (sizeof(p->member) > sizeof(p->pad_member)) \
282 { \
283 printf("tstDeviceStructSize: error! padding of %s::%s is too small, padding=%d struct=%d\n", #strct, #member, \
284 (int)sizeof(p->pad_member), (int)sizeof(p->member)); \
285 rc++; \
286 } \
287 } while (0)
288
289/**
290 * Prints the offset of a struct member.
291 */
292#define PRINT_OFFSET(strct, member) \
293 do \
294 { \
295 printf("tstDeviceStructSize: info: %s::%s offset %d sizeof %d\n", #strct, #member, (int)RT_OFFSETOF(strct, member), (int)RT_SIZEOFMEMB(strct, member)); \
296 } while (0)
297
298
299int main()
300{
301 int rc = 0;
302 printf("tstDeviceStructSize: TESTING\n");
303
304 /* Assert sanity */
305 CHECK_SIZE(uint128_t, 128/8);
306 CHECK_SIZE(int128_t, 128/8);
307 CHECK_SIZE(uint64_t, 64/8);
308 CHECK_SIZE(int64_t, 64/8);
309 CHECK_SIZE(uint32_t, 32/8);
310 CHECK_SIZE(int32_t, 32/8);
311 CHECK_SIZE(uint16_t, 16/8);
312 CHECK_SIZE(int16_t, 16/8);
313 CHECK_SIZE(uint8_t, 8/8);
314 CHECK_SIZE(int8_t, 8/8);
315
316 /* Basic alignment checks. */
317 CHECK_MEMBER_ALIGNMENT(PDMDEVINS, achInstanceData, 64);
318 CHECK_MEMBER_ALIGNMENT(PDMPCIDEV, Int.s, 16);
319 CHECK_MEMBER_ALIGNMENT(PDMPCIDEV, Int.s.aIORegions, 16);
320
321 /*
322 * Misc alignment checks (keep this somewhat alphabetical).
323 */
324 CHECK_MEMBER_ALIGNMENT(AC97STATE, CritSect, 8);
325
326 CHECK_MEMBER_ALIGNMENT(AHCI, lock, 8);
327 CHECK_MEMBER_ALIGNMENT(AHCI, aPorts[0], 8);
328 CHECK_MEMBER_ALIGNMENT(AHCIR3, aPorts[0], 8);
329
330 CHECK_MEMBER_ALIGNMENT(ATADEVSTATE, cTotalSectors, 8);
331 CHECK_MEMBER_ALIGNMENT(ATADEVSTATE, StatATADMA, 8);
332 CHECK_MEMBER_ALIGNMENT(ATADEVSTATE, StatReads, 8);
333 CHECK_MEMBER_ALIGNMENT(ATACONTROLLER, lock, 8);
334 CHECK_MEMBER_ALIGNMENT(ATACONTROLLER, StatAsyncOps, 8);
335 CHECK_MEMBER_ALIGNMENT(BUSLOGIC, CritSectIntr, 8);
336#ifdef VBOX_WITH_STATISTICS
337 CHECK_MEMBER_ALIGNMENT(DEVPIC, StatSetIrqRZ, 8);
338#endif
339#ifdef VBOX_WITH_E1000
340 CHECK_MEMBER_ALIGNMENT(E1KSTATE, cs, 8);
341 CHECK_MEMBER_ALIGNMENT(E1KSTATE, csRx, 8);
342 CHECK_MEMBER_ALIGNMENT(E1KSTATE, StatReceiveBytes, 8);
343#endif
344#ifdef VBOX_WITH_VIRTIO
345 CHECK_MEMBER_ALIGNMENT(VNETSTATE, StatReceiveBytes, 8);
346#endif
347 //CHECK_MEMBER_ALIGNMENT(E1KSTATE, csTx, 8);
348#ifdef VBOX_WITH_USB
349# ifdef VBOX_WITH_EHCI_IMPL
350 CHECK_MEMBER_ALIGNMENT(EHCI, RootHub, 8);
351# endif
352# ifdef VBOX_WITH_XHCI_IMPL
353 CHECK_MEMBER_ALIGNMENT(XHCI, aPorts, 8);
354 CHECK_MEMBER_ALIGNMENT(XHCI, aInterrupters, 8);
355 CHECK_MEMBER_ALIGNMENT(XHCI, aInterrupters[0].lock, 8);
356 CHECK_MEMBER_ALIGNMENT(XHCI, aInterrupters[1].lock, 8);
357 CHECK_MEMBER_ALIGNMENT(XHCI, cmdr_dqp, 8);
358 CHECK_MEMBER_ALIGNMENT(XHCI, hMmio, 8);
359# ifdef VBOX_WITH_STATISTICS
360 CHECK_MEMBER_ALIGNMENT(XHCI, StatErrorIsocUrbs, 8);
361 CHECK_MEMBER_ALIGNMENT(XHCI, StatIntrsCleared, 8);
362# endif
363# endif
364#endif
365 CHECK_MEMBER_ALIGNMENT(E1KSTATE, StatReceiveBytes, 8);
366 CHECK_MEMBER_ALIGNMENT(IOAPIC, au64RedirTable, 8);
367# ifdef VBOX_WITH_STATISTICS
368 CHECK_MEMBER_ALIGNMENT(IOAPIC, StatMmioReadRZ, 8);
369# endif
370 CHECK_MEMBER_ALIGNMENT(LSILOGICSCSI, aMessage, 8);
371 CHECK_MEMBER_ALIGNMENT(LSILOGICSCSI, ReplyPostQueueCritSect, 8);
372 CHECK_MEMBER_ALIGNMENT(LSILOGICSCSI, ReplyFreeQueueCritSect, 8);
373 CHECK_MEMBER_ALIGNMENT(LSILOGICSCSI, uReplyFreeQueueNextEntryFreeWrite, 8);
374 CHECK_MEMBER_ALIGNMENT(LSILOGICSCSICC, VBoxSCSI, 8);
375#ifdef VBOX_WITH_USB
376 CHECK_MEMBER_ALIGNMENT(OHCI, RootHub, 8);
377# ifdef VBOX_WITH_STATISTICS
378 CHECK_MEMBER_ALIGNMENT(OHCI, StatCanceledIsocUrbs, 8);
379# endif
380#endif
381 CHECK_MEMBER_ALIGNMENT(DEVPCIBUS, apDevices, 64);
382 CHECK_MEMBER_ALIGNMENT(DEVPCIROOT, auPciApicIrqLevels, 16);
383 CHECK_MEMBER_ALIGNMENT(DEVPCIROOT, Piix3.auPciLegacyIrqLevels, 16);
384 CHECK_MEMBER_ALIGNMENT(PCNETSTATE, u64LastPoll, 8);
385 CHECK_MEMBER_ALIGNMENT(PCNETSTATE, CritSect, 8);
386 CHECK_MEMBER_ALIGNMENT(PCNETSTATE, StatReceiveBytes, 8);
387#ifdef VBOX_WITH_STATISTICS
388 CHECK_MEMBER_ALIGNMENT(PCNETSTATE, StatMMIOReadRZ, 8);
389#endif
390 CHECK_MEMBER_ALIGNMENT(PITSTATE, StatPITIrq, 8);
391 CHECK_MEMBER_ALIGNMENT(DEVSERIAL, UartCore, 8);
392 CHECK_MEMBER_ALIGNMENT(UARTCORE, CritSect, 8);
393#ifdef VBOX_WITH_VMSVGA
394 CHECK_SIZE(VMSVGAState, RT_ALIGN_Z(sizeof(VMSVGAState), 8));
395 CHECK_MEMBER_ALIGNMENT(VGASTATE, svga, 8);
396 CHECK_MEMBER_ALIGNMENT(VGASTATE, svga.au32ScratchRegion, 8);
397 CHECK_MEMBER_ALIGNMENT(VGASTATE, svga.StatRegBitsPerPixelWr, 8);
398#endif
399 CHECK_MEMBER_ALIGNMENT(VGASTATE, cMonitors, 8);
400 CHECK_MEMBER_ALIGNMENT(VGASTATE, GCPhysVRAM, 8);
401 CHECK_MEMBER_ALIGNMENT(VGASTATE, CritSect, 8);
402 CHECK_MEMBER_ALIGNMENT(VGASTATE, StatRZMemoryRead, 8);
403 CHECK_MEMBER_ALIGNMENT(VGASTATE, CritSectIRQ, 8);
404 CHECK_MEMBER_ALIGNMENT(VMMDEV, CritSect, 8);
405#ifdef VBOX_WITH_VIRTIO
406 CHECK_MEMBER_ALIGNMENT(VPCISTATE, cs, 8);
407 CHECK_MEMBER_ALIGNMENT(VPCISTATE, led, 4);
408 CHECK_MEMBER_ALIGNMENT(VPCISTATE, Queues, 8);
409#endif
410#ifdef VBOX_WITH_PCI_PASSTHROUGH_IMPL
411 CHECK_MEMBER_ALIGNMENT(PCIRAWSENDREQ, u.aGetRegionInfo.u64RegionSize, 8);
412#endif
413
414#ifdef VBOX_WITH_RAW_MODE
415 /*
416 * Compare HC and RC.
417 */
418 printf("tstDeviceStructSize: Comparing HC and RC...\n");
419# include "tstDeviceStructSizeRC.h"
420#endif
421
422 /*
423 * Report result.
424 */
425 if (rc)
426 printf("tstDeviceStructSize: FAILURE - %d errors\n", rc);
427 else
428 printf("tstDeviceStructSize: SUCCESS\n");
429 return rc;
430}
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette