VirtualBox

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

Last change on this file since 72652 was 72119, checked in by vboxsync, 7 years ago

tstDeviceStructSizeRC: Add new serial port implementation

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