VirtualBox

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

Last change on this file since 72056 was 71829, checked in by vboxsync, 7 years ago

DevLPC-new: Kicked off new LPC implementation. bugref:7000

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 14.6 KB
Line 
1/* $Id: tstDeviceStructSize.cpp 71829 2018-04-11 17:17:06Z 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-2017 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/PS2K.cpp"
63#undef LOG_GROUP
64#include "../Input/PS2M.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#ifdef VBOX_WITH_AHCI
114# undef LOG_GROUP
115# include "../Storage/DevAHCI.cpp"
116#endif
117#ifdef VBOX_WITH_BUSLOGIC
118# undef LOG_GROUP
119# include "../Storage/DevBusLogic.cpp"
120#endif
121#ifdef VBOX_WITH_LSILOGIC
122# undef LOG_GROUP
123# include "../Storage/DevLsiLogicSCSI.cpp"
124#endif
125#ifdef VBOX_WITH_NVME_IMPL
126# undef LOG_GROUP
127# include "../Storage/DevNVMe.cpp"
128#endif
129
130#ifdef VBOX_WITH_PCI_PASSTHROUGH_IMPL
131# undef LOG_GROUP
132# include "../Bus/DevPciRaw.cpp"
133#endif
134
135#include <VBox/vmm/pdmaudioifs.h>
136
137#undef LOG_GROUP
138#include "../Audio/DevIchAc97.cpp"
139#undef LOG_GROUP
140#include "../Audio/DevHDA.cpp"
141
142
143/* Check that important preprocessor macros didn't get redefined: */
144#if defined(DEBUG) != defined(VBOX_DEVICE_STRUCT_TESTCASE_CHECK_DEBUG)
145# error "DEBUG was modified! This may throw off structure tests."
146#endif
147#if defined(LOG_ENABLED) != defined(VBOX_DEVICE_STRUCT_TESTCASE_CHECK_LOG_ENABLED)
148# error "LOG_ENABLED was modified! This may throw off structure tests."
149#endif
150#if defined(RT_STRICT) != defined(VBOX_DEVICE_STRUCT_TESTCASE_CHECK_RT_STRICT)
151# error "RT_STRICT was modified! This may throw off structure tests."
152#endif
153#if defined(VBOX_STRICT) != defined(VBOX_DEVICE_STRUCT_TESTCASE_CHECK_VBOX_STRICT)
154# error "VBOX_STRICT was modified! This may throw off structure tests."
155#endif
156
157
158#include <stdio.h>
159
160
161/*********************************************************************************************************************************
162* Defined Constants And Macros *
163*********************************************************************************************************************************/
164/**
165 * Checks the offset of a data member.
166 * @param type Type.
167 * @param off Correct offset.
168 * @param m Member name.
169 */
170#define CHECK_OFF(type, off, m) \
171 do { \
172 if (off != RT_OFFSETOF(type, m)) \
173 { \
174 printf("tstDeviceStructSize: Error! %#010x %s Member offset wrong by %d (should be %d -- but is %d)\n", \
175 RT_OFFSETOF(type, m), #type "." #m, off - RT_OFFSETOF(type, m), off, RT_OFFSETOF(type, m)); \
176 rc++; \
177 } \
178 else \
179 printf("%#08x (%d) %s\n", RT_OFFSETOF(type, m), RT_OFFSETOF(type, m), #type "." #m); \
180 } while (0)
181
182/**
183 * Checks the size of type.
184 * @param type Type.
185 * @param size Correct size.
186 */
187#define CHECK_SIZE(type, size) \
188 do { \
189 if (size != sizeof(type)) \
190 { \
191 printf("tstDeviceStructSize: Error! sizeof(%s): %#x (%d) Size wrong by %d (should be %d -- but is %d)\n", \
192 #type, (int)sizeof(type), (int)sizeof(type), (int)sizeof(type) - (int)size, (int)size, (int)sizeof(type)); \
193 rc++; \
194 } \
195 else \
196 printf("tstDeviceStructSize: info: sizeof(%s): %#x (%d)\n", #type, (int)sizeof(type), (int)sizeof(type)); \
197 } while (0)
198
199/**
200 * Checks the alignment of a struct member.
201 */
202#define CHECK_MEMBER_ALIGNMENT(strct, member, align) \
203 do \
204 { \
205 if (RT_OFFSETOF(strct, member) & ((align) - 1) ) \
206 { \
207 printf("tstDeviceStructSize: error! %s::%s offset=%#x (%u) expected alignment %#x, meaning %#x (%u) off\n", \
208 #strct, #member, \
209 (unsigned)RT_OFFSETOF(strct, member), \
210 (unsigned)RT_OFFSETOF(strct, member), \
211 (unsigned)(align), \
212 (unsigned)(((align) - RT_OFFSETOF(strct, member)) & ((align) - 1)), \
213 (unsigned)(((align) - RT_OFFSETOF(strct, member)) & ((align) - 1)) ); \
214 rc++; \
215 } \
216 } while (0)
217
218/**
219 * Checks that the size of a type is aligned correctly.
220 */
221#define CHECK_SIZE_ALIGNMENT(type, align) \
222 do { \
223 if (RT_ALIGN_Z(sizeof(type), (align)) != sizeof(type)) \
224 { \
225 printf("tstDeviceStructSize: error! %s size=%#x (%u), align=%#x %#x (%u) bytes off\n", \
226 #type, \
227 (unsigned)sizeof(type), \
228 (unsigned)sizeof(type), \
229 (align), \
230 (unsigned)RT_ALIGN_Z(sizeof(type), align) - (unsigned)sizeof(type), \
231 (unsigned)RT_ALIGN_Z(sizeof(type), align) - (unsigned)sizeof(type)); \
232 rc++; \
233 } \
234 } while (0)
235
236/**
237 * Checks that a internal struct padding is big enough.
238 */
239#define CHECK_PADDING(strct, member, align) \
240 do \
241 { \
242 strct *p = NULL; NOREF(p); \
243 if (sizeof(p->member.s) > sizeof(p->member.padding)) \
244 { \
245 printf("tstDeviceStructSize: error! padding of %s::%s is too small, padding=%d struct=%d correct=%d\n", #strct, #member, \
246 (int)sizeof(p->member.padding), (int)sizeof(p->member.s), (int)RT_ALIGN_Z(sizeof(p->member.s), (align))); \
247 rc++; \
248 } \
249 else if (RT_ALIGN_Z(sizeof(p->member.padding), (align)) != sizeof(p->member.padding)) \
250 { \
251 printf("tstDeviceStructSize: error! padding of %s::%s is misaligned, padding=%d correct=%d\n", #strct, #member, \
252 (int)sizeof(p->member.padding), (int)RT_ALIGN_Z(sizeof(p->member.s), (align))); \
253 rc++; \
254 } \
255 } while (0)
256
257/**
258 * Checks that a internal struct padding is big enough.
259 */
260#define CHECK_PADDING2(strct) \
261 do \
262 { \
263 strct *p = NULL; NOREF(p); \
264 if (sizeof(p->s) > sizeof(p->padding)) \
265 { \
266 printf("tstDeviceStructSize: error! padding of %s is too small, padding=%d struct=%d correct=%d\n", #strct, \
267 (int)sizeof(p->padding), (int)sizeof(p->s), (int)RT_ALIGN_Z(sizeof(p->s), 32)); \
268 rc++; \
269 } \
270 } while (0)
271
272/**
273 * Checks that a internal struct padding is big enough.
274 */
275#define CHECK_PADDING3(strct, member, pad_member) \
276 do \
277 { \
278 strct *p = NULL; NOREF(p); \
279 if (sizeof(p->member) > sizeof(p->pad_member)) \
280 { \
281 printf("tstDeviceStructSize: error! padding of %s::%s is too small, padding=%d struct=%d\n", #strct, #member, \
282 (int)sizeof(p->pad_member), (int)sizeof(p->member)); \
283 rc++; \
284 } \
285 } while (0)
286
287/**
288 * Prints the offset of a struct member.
289 */
290#define PRINT_OFFSET(strct, member) \
291 do \
292 { \
293 printf("tstDeviceStructSize: info: %s::%s offset %d sizeof %d\n", #strct, #member, (int)RT_OFFSETOF(strct, member), (int)RT_SIZEOFMEMB(strct, member)); \
294 } while (0)
295
296
297int main()
298{
299 int rc = 0;
300 printf("tstDeviceStructSize: TESTING\n");
301
302 /* Assert sanity */
303 CHECK_SIZE(uint128_t, 128/8);
304 CHECK_SIZE(int128_t, 128/8);
305 CHECK_SIZE(uint64_t, 64/8);
306 CHECK_SIZE(int64_t, 64/8);
307 CHECK_SIZE(uint32_t, 32/8);
308 CHECK_SIZE(int32_t, 32/8);
309 CHECK_SIZE(uint16_t, 16/8);
310 CHECK_SIZE(int16_t, 16/8);
311 CHECK_SIZE(uint8_t, 8/8);
312 CHECK_SIZE(int8_t, 8/8);
313
314 /* Basic alignment checks. */
315 CHECK_MEMBER_ALIGNMENT(PDMDEVINS, achInstanceData, 64);
316 CHECK_MEMBER_ALIGNMENT(PDMPCIDEV, Int.s, 16);
317 CHECK_MEMBER_ALIGNMENT(PDMPCIDEV, Int.s.aIORegions, 16);
318
319 /*
320 * Misc alignment checks (keep this somewhat alphabetical).
321 */
322 CHECK_MEMBER_ALIGNMENT(AC97STATE, CritSect, 8);
323
324 CHECK_MEMBER_ALIGNMENT(AHCI, lock, 8);
325 CHECK_MEMBER_ALIGNMENT(AHCI, ahciPort[0], 8);
326
327 CHECK_MEMBER_ALIGNMENT(APICDEV, pDevInsR0, 8);
328 CHECK_MEMBER_ALIGNMENT(APICDEV, pDevInsRC, 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, StatSetIrqGC, 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# ifdef VBOX_WITH_STATISTICS
352 CHECK_MEMBER_ALIGNMENT(EHCI, StatCanceledIsocUrbs, 8);
353# endif
354# endif
355# ifdef VBOX_WITH_XHCI_IMPL
356 CHECK_MEMBER_ALIGNMENT(XHCI, pWorkerThread, 8);
357 CHECK_MEMBER_ALIGNMENT(XHCI, IBase, 8);
358 CHECK_MEMBER_ALIGNMENT(XHCI, MMIOBase, 8);
359 CHECK_MEMBER_ALIGNMENT(XHCI, RootHub2, 8);
360 CHECK_MEMBER_ALIGNMENT(XHCI, RootHub3, 8);
361 CHECK_MEMBER_ALIGNMENT(XHCI, cmdr_dqp, 8);
362# ifdef VBOX_WITH_STATISTICS
363 CHECK_MEMBER_ALIGNMENT(XHCI, StatErrorIsocUrbs, 8);
364 CHECK_MEMBER_ALIGNMENT(XHCI, StatIntrsCleared, 8);
365# endif
366# endif
367#endif
368 CHECK_MEMBER_ALIGNMENT(E1KSTATE, StatReceiveBytes, 8);
369 CHECK_MEMBER_ALIGNMENT(IOAPIC, au64RedirTable, 8);
370# ifdef VBOX_WITH_STATISTICS
371 CHECK_MEMBER_ALIGNMENT(IOAPIC, StatMmioReadRZ, 8);
372# endif
373 CHECK_MEMBER_ALIGNMENT(LSILOGISCSI, GCPhysMMIOBase, 8);
374 CHECK_MEMBER_ALIGNMENT(LSILOGISCSI, aMessage, 8);
375 CHECK_MEMBER_ALIGNMENT(LSILOGISCSI, ReplyPostQueueCritSect, 8);
376 CHECK_MEMBER_ALIGNMENT(LSILOGISCSI, ReplyFreeQueueCritSect, 8);
377 CHECK_MEMBER_ALIGNMENT(LSILOGISCSI, uReplyFreeQueueNextEntryFreeWrite, 8);
378 CHECK_MEMBER_ALIGNMENT(LSILOGISCSI, VBoxSCSI, 8);
379#ifdef VBOX_WITH_USB
380 CHECK_MEMBER_ALIGNMENT(OHCI, RootHub, 8);
381# ifdef VBOX_WITH_STATISTICS
382 CHECK_MEMBER_ALIGNMENT(OHCI, StatCanceledIsocUrbs, 8);
383# endif
384#endif
385 CHECK_MEMBER_ALIGNMENT(DEVPCIBUS, apDevices, 64);
386 CHECK_MEMBER_ALIGNMENT(DEVPCIROOT, auPciApicIrqLevels, 16);
387 CHECK_MEMBER_ALIGNMENT(DEVPCIROOT, Piix3.auPciLegacyIrqLevels, 16);
388 CHECK_MEMBER_ALIGNMENT(PCNETSTATE, u64LastPoll, 8);
389 CHECK_MEMBER_ALIGNMENT(PCNETSTATE, CritSect, 8);
390 CHECK_MEMBER_ALIGNMENT(PCNETSTATE, StatReceiveBytes, 8);
391#ifdef VBOX_WITH_STATISTICS
392 CHECK_MEMBER_ALIGNMENT(PCNETSTATE, StatMMIOReadRZ, 8);
393#endif
394 CHECK_MEMBER_ALIGNMENT(PITSTATE, StatPITIrq, 8);
395 CHECK_MEMBER_ALIGNMENT(SerialState, CritSect, 8);
396#ifdef VBOX_WITH_VMSVGA
397 CHECK_SIZE(VMSVGAState, RT_ALIGN_Z(sizeof(VMSVGAState), 8));
398 CHECK_MEMBER_ALIGNMENT(VGASTATE, svga, 8);
399 CHECK_MEMBER_ALIGNMENT(VGASTATE, svga.u64HostWindowId, 8);
400 CHECK_MEMBER_ALIGNMENT(VGASTATE, svga.au32ScratchRegion, 8);
401 CHECK_MEMBER_ALIGNMENT(VGASTATE, svga.StatRegBitsPerPixelWr, 8);
402#endif
403 CHECK_MEMBER_ALIGNMENT(VGASTATE, cMonitors, 8);
404 CHECK_MEMBER_ALIGNMENT(VGASTATE, GCPhysVRAM, 8);
405 CHECK_MEMBER_ALIGNMENT(VGASTATE, Dev, 8);
406 CHECK_MEMBER_ALIGNMENT(VGASTATE, CritSect, 8);
407 CHECK_MEMBER_ALIGNMENT(VGASTATE, StatRZMemoryRead, 8);
408 CHECK_MEMBER_ALIGNMENT(VGASTATE, CritSectIRQ, 8);
409 CHECK_MEMBER_ALIGNMENT(VMMDevState, CritSect, 8);
410#ifdef VBOX_WITH_VIRTIO
411 CHECK_MEMBER_ALIGNMENT(VPCISTATE, cs, 8);
412 CHECK_MEMBER_ALIGNMENT(VPCISTATE, led, 4);
413 CHECK_MEMBER_ALIGNMENT(VPCISTATE, Queues, 8);
414#endif
415#ifdef VBOX_WITH_PCI_PASSTHROUGH_IMPL
416 CHECK_MEMBER_ALIGNMENT(PCIRAWSENDREQ, u.aGetRegionInfo.u64RegionSize, 8);
417#endif
418
419#ifdef VBOX_WITH_RAW_MODE
420 /*
421 * Compare HC and RC.
422 */
423 printf("tstDeviceStructSize: Comparing HC and RC...\n");
424# include "tstDeviceStructSizeRC.h"
425#endif
426
427 /*
428 * Report result.
429 */
430 if (rc)
431 printf("tstDeviceStructSize: FAILURE - %d errors\n", rc);
432 else
433 printf("tstDeviceStructSize: SUCCESS\n");
434 return rc;
435}
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