| 1 | /* $Id: tstDeviceStructSize.cpp 37477 2011-06-15 17:18:33Z 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 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 <VBox/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 | #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 | #undef LOG_GROUP
|
|---|
| 58 | #include "../PC/DevIoApic.cpp"
|
|---|
| 59 | #undef LOG_GROUP
|
|---|
| 60 | #include "../PC/DevHPET.cpp"
|
|---|
| 61 | #undef LOG_GROUP
|
|---|
| 62 | #include "../PC/DevLPC.cpp"
|
|---|
| 63 | #undef LOG_GROUP
|
|---|
| 64 | #include "../PC/DevSMC.cpp"
|
|---|
| 65 | #undef LOG_GROUP
|
|---|
| 66 | #include "../Storage/DevATA.cpp"
|
|---|
| 67 | #ifdef VBOX_WITH_USB
|
|---|
| 68 | # undef LOG_GROUP
|
|---|
| 69 | # include "../USB/DevOHCI.cpp"
|
|---|
| 70 | # ifdef VBOX_WITH_EHCI
|
|---|
| 71 | # include "../USB/DevEHCI.cpp"
|
|---|
| 72 | # endif
|
|---|
| 73 | #endif
|
|---|
| 74 | #undef LOG_GROUP
|
|---|
| 75 | #include "../VMMDev/VMMDev.cpp"
|
|---|
| 76 | #undef LOG_GROUP
|
|---|
| 77 | #include "../Parallel/DevParallel.cpp"
|
|---|
| 78 | #undef LOG_GROUP
|
|---|
| 79 | #include "../Serial/DevSerial.cpp"
|
|---|
| 80 | #ifdef VBOX_WITH_AHCI
|
|---|
| 81 | # undef LOG_GROUP
|
|---|
| 82 | # include "../Storage/DevAHCI.cpp"
|
|---|
| 83 | #endif
|
|---|
| 84 | #ifdef VBOX_WITH_BUSLOGIC
|
|---|
| 85 | # undef LOG_GROUP
|
|---|
| 86 | # include "../Storage/DevBusLogic.cpp"
|
|---|
| 87 | #endif
|
|---|
| 88 | #ifdef VBOX_WITH_LSILOGIC
|
|---|
| 89 | # undef LOG_GROUP
|
|---|
| 90 | # include "../Storage/DevLsiLogicSCSI.cpp"
|
|---|
| 91 | #endif
|
|---|
| 92 |
|
|---|
| 93 | #ifdef VBOX_WITH_PCI_PASSTHROUGH
|
|---|
| 94 | # undef LOG_GROUP
|
|---|
| 95 | # include "../Bus/DevPciRaw.cpp"
|
|---|
| 96 | #endif
|
|---|
| 97 |
|
|---|
| 98 | #include <stdio.h>
|
|---|
| 99 |
|
|---|
| 100 |
|
|---|
| 101 | /*******************************************************************************
|
|---|
| 102 | * Defined Constants And Macros *
|
|---|
| 103 | *******************************************************************************/
|
|---|
| 104 | /**
|
|---|
| 105 | * Checks the offset of a data member.
|
|---|
| 106 | * @param type Type.
|
|---|
| 107 | * @param off Correct offset.
|
|---|
| 108 | * @param m Member name.
|
|---|
| 109 | */
|
|---|
| 110 | #define CHECK_OFF(type, off, m) \
|
|---|
| 111 | do { \
|
|---|
| 112 | if (off != RT_OFFSETOF(type, m)) \
|
|---|
| 113 | { \
|
|---|
| 114 | printf("tstDeviceStructSize: error! %#010x %s Off by %d!! (off=%#x)\n", RT_OFFSETOF(type, m), #type "." #m, off - RT_OFFSETOF(type, m), off); \
|
|---|
| 115 | rc++; \
|
|---|
| 116 | } \
|
|---|
| 117 | /*else */ \
|
|---|
| 118 | /*printf("%#08x %s\n", RT_OFFSETOF(type, m), #m);*/ \
|
|---|
| 119 | } while (0)
|
|---|
| 120 |
|
|---|
| 121 | /**
|
|---|
| 122 | * Checks the size of type.
|
|---|
| 123 | * @param type Type.
|
|---|
| 124 | * @param size Correct size.
|
|---|
| 125 | */
|
|---|
| 126 | #define CHECK_SIZE(type, size) \
|
|---|
| 127 | do { \
|
|---|
| 128 | if (size != sizeof(type)) \
|
|---|
| 129 | { \
|
|---|
| 130 | printf("tstDeviceStructSize: error! sizeof(%s): %#x (%d) Off by %d!!\n", #type, (int)sizeof(type), (int)sizeof(type), (int)(sizeof(type) - size)); \
|
|---|
| 131 | rc++; \
|
|---|
| 132 | } \
|
|---|
| 133 | else \
|
|---|
| 134 | printf("tstDeviceStructSize: info: sizeof(%s): %#x (%d)\n", #type, (int)sizeof(type), (int)sizeof(type)); \
|
|---|
| 135 | } while (0)
|
|---|
| 136 |
|
|---|
| 137 | /**
|
|---|
| 138 | * Checks the alignment of a struct member.
|
|---|
| 139 | */
|
|---|
| 140 | #define CHECK_MEMBER_ALIGNMENT(strct, member, align) \
|
|---|
| 141 | do \
|
|---|
| 142 | { \
|
|---|
| 143 | if (RT_OFFSETOF(strct, member) & ((align) - 1) ) \
|
|---|
| 144 | { \
|
|---|
| 145 | printf("tstDeviceStructSize: error! %s::%s offset=%#x (%u) expected alignment %x, meaning %#x (%u) off\n", \
|
|---|
| 146 | #strct, #member, \
|
|---|
| 147 | (unsigned)RT_OFFSETOF(strct, member), \
|
|---|
| 148 | (unsigned)RT_OFFSETOF(strct, member), \
|
|---|
| 149 | (unsigned)(align), \
|
|---|
| 150 | (unsigned)(((align) - RT_OFFSETOF(strct, member)) & ((align) - 1)), \
|
|---|
| 151 | (unsigned)(((align) - RT_OFFSETOF(strct, member)) & ((align) - 1)) ); \
|
|---|
| 152 | rc++; \
|
|---|
| 153 | } \
|
|---|
| 154 | } while (0)
|
|---|
| 155 |
|
|---|
| 156 | /**
|
|---|
| 157 | * Checks that the size of a type is aligned correctly.
|
|---|
| 158 | */
|
|---|
| 159 | #define CHECK_SIZE_ALIGNMENT(type, align) \
|
|---|
| 160 | do { \
|
|---|
| 161 | if (RT_ALIGN_Z(sizeof(type), (align)) != sizeof(type)) \
|
|---|
| 162 | { \
|
|---|
| 163 | printf("tstDeviceStructSize: error! %s size=%#x (%u), align=%#x %#x (%u) bytes off\n", \
|
|---|
| 164 | #type, \
|
|---|
| 165 | (unsigned)sizeof(type), \
|
|---|
| 166 | (unsigned)sizeof(type), \
|
|---|
| 167 | (align), \
|
|---|
| 168 | (unsigned)RT_ALIGN_Z(sizeof(type), align) - (unsigned)sizeof(type), \
|
|---|
| 169 | (unsigned)RT_ALIGN_Z(sizeof(type), align) - (unsigned)sizeof(type)); \
|
|---|
| 170 | rc++; \
|
|---|
| 171 | } \
|
|---|
| 172 | } while (0)
|
|---|
| 173 |
|
|---|
| 174 | /**
|
|---|
| 175 | * Checks that a internal struct padding is big enough.
|
|---|
| 176 | */
|
|---|
| 177 | #define CHECK_PADDING(strct, member, align) \
|
|---|
| 178 | do \
|
|---|
| 179 | { \
|
|---|
| 180 | strct *p = NULL; NOREF(p); \
|
|---|
| 181 | if (sizeof(p->member.s) > sizeof(p->member.padding)) \
|
|---|
| 182 | { \
|
|---|
| 183 | printf("tstDeviceStructSize: error! padding of %s::%s is too small, padding=%d struct=%d correct=%d\n", #strct, #member, \
|
|---|
| 184 | (int)sizeof(p->member.padding), (int)sizeof(p->member.s), (int)RT_ALIGN_Z(sizeof(p->member.s), (align))); \
|
|---|
| 185 | rc++; \
|
|---|
| 186 | } \
|
|---|
| 187 | else if (RT_ALIGN_Z(sizeof(p->member.padding), (align)) != sizeof(p->member.padding)) \
|
|---|
| 188 | { \
|
|---|
| 189 | printf("tstDeviceStructSize: error! padding of %s::%s is misaligned, padding=%d correct=%d\n", #strct, #member, \
|
|---|
| 190 | (int)sizeof(p->member.padding), (int)RT_ALIGN_Z(sizeof(p->member.s), (align))); \
|
|---|
| 191 | rc++; \
|
|---|
| 192 | } \
|
|---|
| 193 | } while (0)
|
|---|
| 194 |
|
|---|
| 195 | /**
|
|---|
| 196 | * Checks that a internal struct padding is big enough.
|
|---|
| 197 | */
|
|---|
| 198 | #define CHECK_PADDING2(strct) \
|
|---|
| 199 | do \
|
|---|
| 200 | { \
|
|---|
| 201 | strct *p = NULL; NOREF(p); \
|
|---|
| 202 | if (sizeof(p->s) > sizeof(p->padding)) \
|
|---|
| 203 | { \
|
|---|
| 204 | printf("tstDeviceStructSize: error! padding of %s is too small, padding=%d struct=%d correct=%d\n", #strct, \
|
|---|
| 205 | (int)sizeof(p->padding), (int)sizeof(p->s), (int)RT_ALIGN_Z(sizeof(p->s), 32)); \
|
|---|
| 206 | rc++; \
|
|---|
| 207 | } \
|
|---|
| 208 | } while (0)
|
|---|
| 209 |
|
|---|
| 210 | /**
|
|---|
| 211 | * Checks that a internal struct padding is big enough.
|
|---|
| 212 | */
|
|---|
| 213 | #define CHECK_PADDING3(strct, member, pad_member) \
|
|---|
| 214 | do \
|
|---|
| 215 | { \
|
|---|
| 216 | strct *p = NULL; NOREF(p); \
|
|---|
| 217 | if (sizeof(p->member) > sizeof(p->pad_member)) \
|
|---|
| 218 | { \
|
|---|
| 219 | printf("tstDeviceStructSize: error! padding of %s::%s is too small, padding=%d struct=%d\n", #strct, #member, \
|
|---|
| 220 | (int)sizeof(p->pad_member), (int)sizeof(p->member)); \
|
|---|
| 221 | rc++; \
|
|---|
| 222 | } \
|
|---|
| 223 | } while (0)
|
|---|
| 224 |
|
|---|
| 225 | /**
|
|---|
| 226 | * Prints the offset of a struct member.
|
|---|
| 227 | */
|
|---|
| 228 | #define PRINT_OFFSET(strct, member) \
|
|---|
| 229 | do \
|
|---|
| 230 | { \
|
|---|
| 231 | printf("tstDeviceStructSize: info: %s::%s offset %d sizeof %d\n", #strct, #member, (int)RT_OFFSETOF(strct, member), (int)RT_SIZEOFMEMB(strct, member)); \
|
|---|
| 232 | } while (0)
|
|---|
| 233 |
|
|---|
| 234 |
|
|---|
| 235 | int main()
|
|---|
| 236 | {
|
|---|
| 237 | int rc = 0;
|
|---|
| 238 | printf("tstDeviceStructSize: TESTING\n");
|
|---|
| 239 |
|
|---|
| 240 | /* Assert sanity */
|
|---|
| 241 | CHECK_SIZE(uint128_t, 128/8);
|
|---|
| 242 | CHECK_SIZE(int128_t, 128/8);
|
|---|
| 243 | CHECK_SIZE(uint64_t, 64/8);
|
|---|
| 244 | CHECK_SIZE(int64_t, 64/8);
|
|---|
| 245 | CHECK_SIZE(uint32_t, 32/8);
|
|---|
| 246 | CHECK_SIZE(int32_t, 32/8);
|
|---|
| 247 | CHECK_SIZE(uint16_t, 16/8);
|
|---|
| 248 | CHECK_SIZE(int16_t, 16/8);
|
|---|
| 249 | CHECK_SIZE(uint8_t, 8/8);
|
|---|
| 250 | CHECK_SIZE(int8_t, 8/8);
|
|---|
| 251 |
|
|---|
| 252 | /* Basic alignment checks. */
|
|---|
| 253 | CHECK_MEMBER_ALIGNMENT(PDMDEVINS, achInstanceData, 64);
|
|---|
| 254 | CHECK_MEMBER_ALIGNMENT(PCIDEVICE, Int.s, 16);
|
|---|
| 255 | CHECK_MEMBER_ALIGNMENT(PCIDEVICE, Int.s.aIORegions, 16);
|
|---|
| 256 |
|
|---|
| 257 | /*
|
|---|
| 258 | * Misc alignment checks (keep this somewhat alphabetical).
|
|---|
| 259 | */
|
|---|
| 260 | CHECK_MEMBER_ALIGNMENT(AHCI, lock, 8);
|
|---|
| 261 | CHECK_MEMBER_ALIGNMENT(AHCIPort, StatDMA, 8);
|
|---|
| 262 | CHECK_MEMBER_ALIGNMENT(AHCIATACONTROLLER, lock, 8);
|
|---|
| 263 | CHECK_MEMBER_ALIGNMENT(AHCIATACONTROLLER, StatAsyncOps, 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(DEVPARALLELSTATE, 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
|
|---|
| 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(LSILOGISCSI, ReplyPostQueueCritSect, 8);
|
|---|
| 301 | CHECK_MEMBER_ALIGNMENT(LSILOGISCSI, ReplyFreeQueueCritSect, 8);
|
|---|
| 302 | #ifdef VBOX_WITH_USB
|
|---|
| 303 | CHECK_MEMBER_ALIGNMENT(OHCI, RootHub, 8);
|
|---|
| 304 | # ifdef VBOX_WITH_STATISTICS
|
|---|
| 305 | CHECK_MEMBER_ALIGNMENT(OHCI, StatCanceledIsocUrbs, 8);
|
|---|
| 306 | # endif
|
|---|
| 307 | #endif
|
|---|
| 308 | CHECK_MEMBER_ALIGNMENT(PCIBUS, devices, 16);
|
|---|
| 309 | CHECK_MEMBER_ALIGNMENT(PCIBUS, devices, 16);
|
|---|
| 310 | CHECK_MEMBER_ALIGNMENT(PCIGLOBALS, pci_irq_levels, 16);
|
|---|
| 311 | CHECK_MEMBER_ALIGNMENT(PCNetState, u64LastPoll, 8);
|
|---|
| 312 | CHECK_MEMBER_ALIGNMENT(PCNetState, CritSect, 8);
|
|---|
| 313 | CHECK_MEMBER_ALIGNMENT(PCNetState, StatReceiveBytes, 8);
|
|---|
| 314 | #ifdef VBOX_WITH_STATISTICS
|
|---|
| 315 | CHECK_MEMBER_ALIGNMENT(PCNetState, StatMMIOReadRZ, 8);
|
|---|
| 316 | #endif
|
|---|
| 317 | CHECK_MEMBER_ALIGNMENT(PITState, StatPITIrq, 8);
|
|---|
| 318 | CHECK_MEMBER_ALIGNMENT(SerialState, CritSect, 8);
|
|---|
| 319 | CHECK_MEMBER_ALIGNMENT(VGASTATE, Dev, 8);
|
|---|
| 320 | CHECK_MEMBER_ALIGNMENT(VGASTATE, lock, 8);
|
|---|
| 321 | CHECK_MEMBER_ALIGNMENT(VGASTATE, StatRZMemoryRead, 8);
|
|---|
| 322 | CHECK_MEMBER_ALIGNMENT(VMMDevState, CritSect, 8);
|
|---|
| 323 | #ifdef VBOX_WITH_VIRTIO
|
|---|
| 324 | CHECK_MEMBER_ALIGNMENT(VPCISTATE, cs, 8);
|
|---|
| 325 | CHECK_MEMBER_ALIGNMENT(VPCISTATE, led, 4);
|
|---|
| 326 | CHECK_MEMBER_ALIGNMENT(VPCISTATE, Queues, 8);
|
|---|
| 327 | #endif
|
|---|
| 328 | #ifdef VBOX_WITH_PCI_PASSTHROUGH
|
|---|
| 329 | //CHECK_MEMBER_ALIGNMENT(PCIRAWSENDREQ, u.aGetRegionInfo.u64RegionSize, 8);
|
|---|
| 330 | #endif
|
|---|
| 331 |
|
|---|
| 332 | #ifdef VBOX_WITH_RAW_MODE
|
|---|
| 333 | /*
|
|---|
| 334 | * Compare HC and RC.
|
|---|
| 335 | */
|
|---|
| 336 | printf("tstDeviceStructSize: Comparing HC and RC...\n");
|
|---|
| 337 | # include "tstDeviceStructSizeRC.h"
|
|---|
| 338 | #endif
|
|---|
| 339 |
|
|---|
| 340 | /*
|
|---|
| 341 | * Report result.
|
|---|
| 342 | */
|
|---|
| 343 | if (rc)
|
|---|
| 344 | printf("tstDeviceStructSize: FAILURE - %d errors\n", rc);
|
|---|
| 345 | else
|
|---|
| 346 | printf("tstDeviceStructSize: SUCCESS\n");
|
|---|
| 347 | return rc;
|
|---|
| 348 | }
|
|---|
