VirtualBox

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

Last change on this file since 44528 was 44528, checked in by vboxsync, 12 years ago

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