VirtualBox

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

Last change on this file since 64373 was 64351, checked in by vboxsync, 8 years ago

Audio: Renamed HDA files to better reflect what they are.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 13.5 KB
Line 
1/* $Id: tstDeviceStructSize.cpp 64351 2016-10-21 11:29:03Z 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-2016 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
28#define VBOX_WITH_HGCM /* grumble */
29#define VBOX_DEVICE_STRUCT_TESTCASE
30#undef LOG_GROUP
31#include "../Bus/DevPCI.cpp"
32#undef LOG_GROUP
33#include "../Bus/DevPciIch9.cpp"
34#undef LOG_GROUP
35#include "../Graphics/DevVGA.cpp"
36#undef LOG_GROUP
37#include "../Input/DevPS2.cpp"
38#undef LOG_GROUP
39#include "../Input/PS2K.cpp"
40#undef LOG_GROUP
41#include "../Input/PS2M.cpp"
42#ifdef VBOX_WITH_E1000
43# undef LOG_GROUP
44# include "../Network/DevE1000.cpp"
45#endif
46#undef LOG_GROUP
47#include "../Network/DevPCNet.cpp"
48#ifdef VBOX_WITH_VIRTIO
49# undef LOG_GROUP
50# include "../Network/DevVirtioNet.cpp"
51#endif
52#undef LOG_GROUP
53#include "../PC/DevACPI.cpp"
54#undef LOG_GROUP
55#include "../PC/DevPIC.cpp"
56#undef LOG_GROUP
57#include "../PC/DevPit-i8254.cpp"
58#undef LOG_GROUP
59#include "../PC/DevRTC.cpp"
60# undef LOG_GROUP
61#ifdef VBOX_WITH_NEW_APIC
62# include "../../VMM/VMMR3/APIC.cpp"
63#else
64# include "../PC/DevAPIC.cpp"
65#endif
66#undef LOG_GROUP
67#ifdef VBOX_WITH_NEW_IOAPIC
68# include "../PC/DevIoApic.cpp"
69#else
70# include "../PC/DevIoApic_Old.cpp"
71#endif
72#undef LOG_GROUP
73#include "../PC/DevHPET.cpp"
74#undef LOG_GROUP
75#include "../PC/DevLPC.cpp"
76#undef LOG_GROUP
77#include "../EFI/DevSmc.cpp"
78#undef LOG_GROUP
79#include "../Storage/DevATA.cpp"
80#ifdef VBOX_WITH_USB
81# undef LOG_GROUP
82# include "../USB/DevOHCI.cpp"
83# ifdef VBOX_WITH_EHCI_IMPL
84# undef LOG_GROUP
85# include "../USB/DevEHCI.cpp"
86# endif
87# ifdef VBOX_WITH_XHCI_IMPL
88# undef LOG_GROUP
89# include "../USB/DevXHCI.cpp"
90# endif
91#endif
92#undef LOG_GROUP
93#include "../VMMDev/VMMDev.cpp"
94#undef LOG_GROUP
95#include "../Parallel/DevParallel.cpp"
96#undef LOG_GROUP
97#include "../Serial/DevSerial.cpp"
98#ifdef VBOX_WITH_AHCI
99# undef LOG_GROUP
100# include "../Storage/DevAHCI.cpp"
101#endif
102#ifdef VBOX_WITH_BUSLOGIC
103# undef LOG_GROUP
104# include "../Storage/DevBusLogic.cpp"
105#endif
106#ifdef VBOX_WITH_LSILOGIC
107# undef LOG_GROUP
108# include "../Storage/DevLsiLogicSCSI.cpp"
109#endif
110#ifdef VBOX_WITH_NVME_IMPL
111# undef LOG_GROUP
112# include "../Storage/DevNVMe.cpp"
113#endif
114
115#ifdef VBOX_WITH_PCI_PASSTHROUGH_IMPL
116# undef LOG_GROUP
117# include "../Bus/DevPciRaw.cpp"
118#endif
119
120#include <VBox/vmm/pdmaudioifs.h>
121
122# undef LOG_GROUP
123# include "../Audio/DevIchAc97.cpp"
124# undef LOG_GROUP
125# include "../Audio/DevHDA.cpp"
126
127#include <stdio.h>
128
129
130/*********************************************************************************************************************************
131* Defined Constants And Macros *
132*********************************************************************************************************************************/
133/**
134 * Checks the offset of a data member.
135 * @param type Type.
136 * @param off Correct offset.
137 * @param m Member name.
138 */
139#define CHECK_OFF(type, off, m) \
140 do { \
141 if (off != RT_OFFSETOF(type, m)) \
142 { \
143 printf("tstDeviceStructSize: error! %#010x %s Off by %d!! (off=%#x)\n", RT_OFFSETOF(type, m), #type "." #m, off - RT_OFFSETOF(type, m), off); \
144 rc++; \
145 } \
146 else \
147 printf("%#08x (%d) %s\n", RT_OFFSETOF(type, m), RT_OFFSETOF(type, m), #type "." #m); \
148 } while (0)
149
150/**
151 * Checks the size of type.
152 * @param type Type.
153 * @param size Correct size.
154 */
155#define CHECK_SIZE(type, size) \
156 do { \
157 if (size != sizeof(type)) \
158 { \
159 printf("tstDeviceStructSize: error! sizeof(%s): %#x (%d) Off by %d!!\n", #type, (int)sizeof(type), (int)sizeof(type), (int)(sizeof(type) - size)); \
160 rc++; \
161 } \
162 else \
163 printf("tstDeviceStructSize: info: sizeof(%s): %#x (%d)\n", #type, (int)sizeof(type), (int)sizeof(type)); \
164 } while (0)
165
166/**
167 * Checks the alignment of a struct member.
168 */
169#define CHECK_MEMBER_ALIGNMENT(strct, member, align) \
170 do \
171 { \
172 if (RT_OFFSETOF(strct, member) & ((align) - 1) ) \
173 { \
174 printf("tstDeviceStructSize: error! %s::%s offset=%#x (%u) expected alignment %#x, meaning %#x (%u) off\n", \
175 #strct, #member, \
176 (unsigned)RT_OFFSETOF(strct, member), \
177 (unsigned)RT_OFFSETOF(strct, member), \
178 (unsigned)(align), \
179 (unsigned)(((align) - RT_OFFSETOF(strct, member)) & ((align) - 1)), \
180 (unsigned)(((align) - RT_OFFSETOF(strct, member)) & ((align) - 1)) ); \
181 rc++; \
182 } \
183 } while (0)
184
185/**
186 * Checks that the size of a type is aligned correctly.
187 */
188#define CHECK_SIZE_ALIGNMENT(type, align) \
189 do { \
190 if (RT_ALIGN_Z(sizeof(type), (align)) != sizeof(type)) \
191 { \
192 printf("tstDeviceStructSize: error! %s size=%#x (%u), align=%#x %#x (%u) bytes off\n", \
193 #type, \
194 (unsigned)sizeof(type), \
195 (unsigned)sizeof(type), \
196 (align), \
197 (unsigned)RT_ALIGN_Z(sizeof(type), align) - (unsigned)sizeof(type), \
198 (unsigned)RT_ALIGN_Z(sizeof(type), align) - (unsigned)sizeof(type)); \
199 rc++; \
200 } \
201 } while (0)
202
203/**
204 * Checks that a internal struct padding is big enough.
205 */
206#define CHECK_PADDING(strct, member, align) \
207 do \
208 { \
209 strct *p = NULL; NOREF(p); \
210 if (sizeof(p->member.s) > sizeof(p->member.padding)) \
211 { \
212 printf("tstDeviceStructSize: error! padding of %s::%s is too small, padding=%d struct=%d correct=%d\n", #strct, #member, \
213 (int)sizeof(p->member.padding), (int)sizeof(p->member.s), (int)RT_ALIGN_Z(sizeof(p->member.s), (align))); \
214 rc++; \
215 } \
216 else if (RT_ALIGN_Z(sizeof(p->member.padding), (align)) != sizeof(p->member.padding)) \
217 { \
218 printf("tstDeviceStructSize: error! padding of %s::%s is misaligned, padding=%d correct=%d\n", #strct, #member, \
219 (int)sizeof(p->member.padding), (int)RT_ALIGN_Z(sizeof(p->member.s), (align))); \
220 rc++; \
221 } \
222 } while (0)
223
224/**
225 * Checks that a internal struct padding is big enough.
226 */
227#define CHECK_PADDING2(strct) \
228 do \
229 { \
230 strct *p = NULL; NOREF(p); \
231 if (sizeof(p->s) > sizeof(p->padding)) \
232 { \
233 printf("tstDeviceStructSize: error! padding of %s is too small, padding=%d struct=%d correct=%d\n", #strct, \
234 (int)sizeof(p->padding), (int)sizeof(p->s), (int)RT_ALIGN_Z(sizeof(p->s), 32)); \
235 rc++; \
236 } \
237 } while (0)
238
239/**
240 * Checks that a internal struct padding is big enough.
241 */
242#define CHECK_PADDING3(strct, member, pad_member) \
243 do \
244 { \
245 strct *p = NULL; NOREF(p); \
246 if (sizeof(p->member) > sizeof(p->pad_member)) \
247 { \
248 printf("tstDeviceStructSize: error! padding of %s::%s is too small, padding=%d struct=%d\n", #strct, #member, \
249 (int)sizeof(p->pad_member), (int)sizeof(p->member)); \
250 rc++; \
251 } \
252 } while (0)
253
254/**
255 * Prints the offset of a struct member.
256 */
257#define PRINT_OFFSET(strct, member) \
258 do \
259 { \
260 printf("tstDeviceStructSize: info: %s::%s offset %d sizeof %d\n", #strct, #member, (int)RT_OFFSETOF(strct, member), (int)RT_SIZEOFMEMB(strct, member)); \
261 } while (0)
262
263
264int main()
265{
266 int rc = 0;
267 printf("tstDeviceStructSize: TESTING\n");
268
269 /* Assert sanity */
270 CHECK_SIZE(uint128_t, 128/8);
271 CHECK_SIZE(int128_t, 128/8);
272 CHECK_SIZE(uint64_t, 64/8);
273 CHECK_SIZE(int64_t, 64/8);
274 CHECK_SIZE(uint32_t, 32/8);
275 CHECK_SIZE(int32_t, 32/8);
276 CHECK_SIZE(uint16_t, 16/8);
277 CHECK_SIZE(int16_t, 16/8);
278 CHECK_SIZE(uint8_t, 8/8);
279 CHECK_SIZE(int8_t, 8/8);
280
281 /* Basic alignment checks. */
282 CHECK_MEMBER_ALIGNMENT(PDMDEVINS, achInstanceData, 64);
283 CHECK_MEMBER_ALIGNMENT(PCIDEVICE, Int.s, 16);
284 CHECK_MEMBER_ALIGNMENT(PCIDEVICE, Int.s.aIORegions, 16);
285
286 /*
287 * Misc alignment checks (keep this somewhat alphabetical).
288 */
289 CHECK_MEMBER_ALIGNMENT(AHCI, lock, 8);
290 CHECK_MEMBER_ALIGNMENT(AHCIPort, StatDMA, 8);
291#ifdef VBOX_WITH_NEW_APIC
292 CHECK_MEMBER_ALIGNMENT(APICDEV, pDevInsR0, 8);
293 CHECK_MEMBER_ALIGNMENT(APICDEV, pCritSectR0, 8);
294 CHECK_MEMBER_ALIGNMENT(APICDEV, pDevInsRC, 8);
295 CHECK_MEMBER_ALIGNMENT(APICDEV, pCritSectRC, 8);
296#else
297# ifdef VBOX_WITH_STATISTICS
298 CHECK_MEMBER_ALIGNMENT(APICDeviceInfo, StatMMIOReadGC, 8);
299# endif
300#endif
301 CHECK_MEMBER_ALIGNMENT(ATADevState, cTotalSectors, 8);
302 CHECK_MEMBER_ALIGNMENT(ATADevState, StatATADMA, 8);
303 CHECK_MEMBER_ALIGNMENT(ATADevState, StatReads, 8);
304 CHECK_MEMBER_ALIGNMENT(ATACONTROLLER, lock, 8);
305 CHECK_MEMBER_ALIGNMENT(ATACONTROLLER, StatAsyncOps, 8);
306 CHECK_MEMBER_ALIGNMENT(BUSLOGIC, CritSectIntr, 8);
307#ifdef VBOX_WITH_STATISTICS
308 CHECK_MEMBER_ALIGNMENT(DEVPIC, StatSetIrqGC, 8);
309#endif
310#ifdef VBOX_WITH_E1000
311 CHECK_MEMBER_ALIGNMENT(E1KSTATE, cs, 8);
312 CHECK_MEMBER_ALIGNMENT(E1KSTATE, csRx, 8);
313 CHECK_MEMBER_ALIGNMENT(E1KSTATE, StatReceiveBytes, 8);
314#endif
315#ifdef VBOX_WITH_VIRTIO
316 CHECK_MEMBER_ALIGNMENT(VNETSTATE, StatReceiveBytes, 8);
317#endif
318 //CHECK_MEMBER_ALIGNMENT(E1KSTATE, csTx, 8);
319#ifdef VBOX_WITH_USB
320# ifdef VBOX_WITH_EHCI_IMPL
321 CHECK_MEMBER_ALIGNMENT(EHCI, RootHub, 8);
322# ifdef VBOX_WITH_STATISTICS
323 CHECK_MEMBER_ALIGNMENT(EHCI, StatCanceledIsocUrbs, 8);
324# endif
325# endif
326# ifdef VBOX_WITH_XHCI_IMPL
327 CHECK_MEMBER_ALIGNMENT(XHCI, pWorkerThread, 8);
328 CHECK_MEMBER_ALIGNMENT(XHCI, IBase, 8);
329 CHECK_MEMBER_ALIGNMENT(XHCI, MMIOBase, 8);
330 CHECK_MEMBER_ALIGNMENT(XHCI, RootHub2, 8);
331 CHECK_MEMBER_ALIGNMENT(XHCI, RootHub3, 8);
332 CHECK_MEMBER_ALIGNMENT(XHCI, cmdr_dqp, 8);
333# ifdef VBOX_WITH_STATISTICS
334 CHECK_MEMBER_ALIGNMENT(XHCI, StatCanceledIsocUrbs, 8);
335 CHECK_MEMBER_ALIGNMENT(XHCI, StatIntrsCleared, 8);
336# endif
337# endif
338#endif
339 CHECK_MEMBER_ALIGNMENT(E1KSTATE, StatReceiveBytes, 8);
340#ifdef VBOX_WITH_NEW_IOAPIC
341 CHECK_MEMBER_ALIGNMENT(IOAPIC, au64RedirTable, 8);
342# ifdef VBOX_WITH_STATISTICS
343 CHECK_MEMBER_ALIGNMENT(IOAPIC, StatMmioReadRZ, 8);
344# endif
345#else
346# ifdef VBOX_WITH_STATISTICS
347 CHECK_MEMBER_ALIGNMENT(IOAPIC, StatMMIOReadGC, 8);
348 CHECK_MEMBER_ALIGNMENT(IOAPIC, StatMMIOReadGC, 8);
349# endif
350#endif
351 CHECK_MEMBER_ALIGNMENT(LSILOGISCSI, GCPhysMMIOBase, 8);
352 CHECK_MEMBER_ALIGNMENT(LSILOGISCSI, aMessage, 8);
353 CHECK_MEMBER_ALIGNMENT(LSILOGISCSI, ReplyPostQueueCritSect, 8);
354 CHECK_MEMBER_ALIGNMENT(LSILOGISCSI, ReplyFreeQueueCritSect, 8);
355 CHECK_MEMBER_ALIGNMENT(LSILOGISCSI, uReplyFreeQueueNextEntryFreeWrite, 8);
356 CHECK_MEMBER_ALIGNMENT(LSILOGISCSI, VBoxSCSI, 8);
357#ifdef VBOX_WITH_USB
358 CHECK_MEMBER_ALIGNMENT(OHCI, RootHub, 8);
359# ifdef VBOX_WITH_STATISTICS
360 CHECK_MEMBER_ALIGNMENT(OHCI, StatCanceledIsocUrbs, 8);
361# endif
362#endif
363 CHECK_MEMBER_ALIGNMENT(PCIBUS, devices, 16);
364 CHECK_MEMBER_ALIGNMENT(PCIBUS, devices, 16);
365 CHECK_MEMBER_ALIGNMENT(PCIGLOBALS, pci_irq_levels, 16);
366 CHECK_MEMBER_ALIGNMENT(PCNETSTATE, u64LastPoll, 8);
367 CHECK_MEMBER_ALIGNMENT(PCNETSTATE, CritSect, 8);
368 CHECK_MEMBER_ALIGNMENT(PCNETSTATE, StatReceiveBytes, 8);
369#ifdef VBOX_WITH_STATISTICS
370 CHECK_MEMBER_ALIGNMENT(PCNETSTATE, StatMMIOReadRZ, 8);
371#endif
372 CHECK_MEMBER_ALIGNMENT(PITSTATE, StatPITIrq, 8);
373 CHECK_MEMBER_ALIGNMENT(SerialState, CritSect, 8);
374#ifdef VBOX_WITH_VMSVGA
375 CHECK_SIZE(VMSVGAState, RT_ALIGN_Z(sizeof(VMSVGAState), 8));
376 CHECK_MEMBER_ALIGNMENT(VGASTATE, svga, 8);
377 CHECK_MEMBER_ALIGNMENT(VGASTATE, svga.u64HostWindowId, 8);
378#endif
379 CHECK_MEMBER_ALIGNMENT(VGASTATE, cMonitors, 8);
380 CHECK_MEMBER_ALIGNMENT(VGASTATE, GCPhysVRAM, 8);
381 CHECK_MEMBER_ALIGNMENT(VGASTATE, Dev, 8);
382 CHECK_MEMBER_ALIGNMENT(VGASTATE, CritSect, 8);
383 CHECK_MEMBER_ALIGNMENT(VGASTATE, StatRZMemoryRead, 8);
384 CHECK_MEMBER_ALIGNMENT(VGASTATE, CritSectIRQ, 8);
385 CHECK_MEMBER_ALIGNMENT(VMMDevState, CritSect, 8);
386#ifdef VBOX_WITH_VIRTIO
387 CHECK_MEMBER_ALIGNMENT(VPCISTATE, cs, 8);
388 CHECK_MEMBER_ALIGNMENT(VPCISTATE, led, 4);
389 CHECK_MEMBER_ALIGNMENT(VPCISTATE, Queues, 8);
390#endif
391#ifdef VBOX_WITH_PCI_PASSTHROUGH_IMPL
392 CHECK_MEMBER_ALIGNMENT(PCIRAWSENDREQ, u.aGetRegionInfo.u64RegionSize, 8);
393#endif
394
395#ifdef VBOX_WITH_RAW_MODE
396 /*
397 * Compare HC and RC.
398 */
399 printf("tstDeviceStructSize: Comparing HC and RC...\n");
400# include "tstDeviceStructSizeRC.h"
401#endif
402
403 /*
404 * Report result.
405 */
406 if (rc)
407 printf("tstDeviceStructSize: FAILURE - %d errors\n", rc);
408 else
409 printf("tstDeviceStructSize: SUCCESS\n");
410 return rc;
411}
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