VirtualBox

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

Last change on this file since 26430 was 26308, checked in by vboxsync, 15 years ago

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