VirtualBox

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

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

Copyright year updates by scm.

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