tstDeviceStructSize.cpp revision 804f38dc60de88705f57b964b11e0bf17768e47c
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * tstDeviceStructSize - testcase for check structure sizes/alignment
9b5a120b694c2603a7a3dccbd6cc519164943b17vboxsync * and to verify that HC and RC uses the same
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * representation of the structures.
e64031e20c39650a7bc902a3e1aba613b9415deevboxsync * Copyright (C) 2006-2010 Oracle Corporation
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * available from http://www.virtualbox.org. This file is free software;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * you can redistribute it and/or modify it under the terms of the GNU
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * General Public License (GPL) as published by the Free Software
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync/*******************************************************************************
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync* Header Files *
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync*******************************************************************************/
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync#include "../PC/DevPIC.cpp"
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync#include "../PC/DevRTC.cpp"
0d9f0399d4356c471af5e68c30b51c73f7909487vboxsync#include "../PC/DevLPC.cpp"
0d9f0399d4356c471af5e68c30b51c73f7909487vboxsync#include "../PC/DevSMC.cpp"
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync# include "../USB/DevOHCI.cpp"
9d58ed91e29fc16c33e0e8f0530a1b8c58b98462vboxsync# include "../USB/DevEHCI.cpp"
342d1c2e846281e0bcbde2e97218273216b3fb32vboxsync# include "../Bus/DevPciRaw.cpp"
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync/*******************************************************************************
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync* Defined Constants And Macros *
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync*******************************************************************************/
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Checks the offset of a data member.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * @param type Type.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * @param off Correct offset.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * @param m Member name.
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync printf("tstDeviceStructSize: error! %#010x %s Off by %d!! (off=%#x)\n", RT_OFFSETOF(type, m), #type "." #m, off - RT_OFFSETOF(type, m), off); \
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync /*else */ \
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync /*printf("%#08x %s\n", RT_OFFSETOF(type, m), #m);*/ \
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync } while (0)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Checks the size of type.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * @param type Type.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * @param size Correct size.
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync printf("tstDeviceStructSize: error! sizeof(%s): %#x (%d) Off by %d!!\n", #type, (int)sizeof(type), (int)sizeof(type), (int)(sizeof(type) - size)); \
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync printf("tstDeviceStructSize: info: sizeof(%s): %#x (%d)\n", #type, (int)sizeof(type), (int)sizeof(type)); \
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync } while (0)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Checks the alignment of a struct member.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync#define CHECK_MEMBER_ALIGNMENT(strct, member, align) \
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync printf("tstDeviceStructSize: error! %s::%s offset=%#x (%u) expected alignment %x, meaning %#x (%u) off\n", \
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync (unsigned)(align), \
73a750ff6ce8ed53244049d291856a1eea296654vboxsync (unsigned)(((align) - RT_OFFSETOF(strct, member)) & ((align) - 1)), \
73a750ff6ce8ed53244049d291856a1eea296654vboxsync (unsigned)(((align) - RT_OFFSETOF(strct, member)) & ((align) - 1)) ); \
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync } while (0)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Checks that the size of a type is aligned correctly.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync if (RT_ALIGN_Z(sizeof(type), (align)) != sizeof(type)) \
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync printf("tstDeviceStructSize: error! %s size=%#x (%u), align=%#x %#x (%u) bytes off\n", \
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync (unsigned)sizeof(type), \
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync (unsigned)sizeof(type), \
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync (unsigned)RT_ALIGN_Z(sizeof(type), align) - (unsigned)sizeof(type), \
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync (unsigned)RT_ALIGN_Z(sizeof(type), align) - (unsigned)sizeof(type)); \
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync } while (0)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Checks that a internal struct padding is big enough.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync if (sizeof(p->member.s) > sizeof(p->member.padding)) \
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync printf("tstDeviceStructSize: error! padding of %s::%s is too small, padding=%d struct=%d correct=%d\n", #strct, #member, \
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync (int)sizeof(p->member.padding), (int)sizeof(p->member.s), (int)RT_ALIGN_Z(sizeof(p->member.s), (align))); \
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync else if (RT_ALIGN_Z(sizeof(p->member.padding), (align)) != sizeof(p->member.padding)) \
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync printf("tstDeviceStructSize: error! padding of %s::%s is misaligned, padding=%d correct=%d\n", #strct, #member, \
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync (int)sizeof(p->member.padding), (int)RT_ALIGN_Z(sizeof(p->member.s), (align))); \
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync } while (0)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Checks that a internal struct padding is big enough.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync if (sizeof(p->s) > sizeof(p->padding)) \
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync printf("tstDeviceStructSize: error! padding of %s is too small, padding=%d struct=%d correct=%d\n", #strct, \
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync (int)sizeof(p->padding), (int)sizeof(p->s), (int)RT_ALIGN_Z(sizeof(p->s), 32)); \
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync } while (0)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Checks that a internal struct padding is big enough.
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync printf("tstDeviceStructSize: error! padding of %s::%s is too small, padding=%d struct=%d\n", #strct, #member, \
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync (int)sizeof(p->pad_member), (int)sizeof(p->member)); \
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync } while (0)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Prints the offset of a struct member.
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync printf("tstDeviceStructSize: info: %s::%s offset %d sizeof %d\n", #strct, #member, (int)RT_OFFSETOF(strct, member), (int)RT_SIZEOFMEMB(strct, member)); \
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync } while (0)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync /* Assert sanity */
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync /* Basic alignment checks. */
6a762861f4545ff60f0cb6e4d0a947793adc2f74vboxsync CHECK_MEMBER_ALIGNMENT(PDMDEVINS, achInstanceData, 64);
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync CHECK_MEMBER_ALIGNMENT(PCIDEVICE, Int.s.aIORegions, 16);
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync * Misc alignment checks (keep this somewhat alphabetical).
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync CHECK_MEMBER_ALIGNMENT(AHCIATACONTROLLER, lock, 8);
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync CHECK_MEMBER_ALIGNMENT(AHCIATACONTROLLER, StatAsyncOps, 8);
337640774b62333151a0c5cc6407afcb25d93a37vboxsync CHECK_MEMBER_ALIGNMENT(APICDeviceInfo, StatMMIOReadGC, 8);
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync CHECK_MEMBER_ALIGNMENT(ATADevState, cTotalSectors, 8);
dccbbd8ec5b45b567312112e7edd5c7130d56262vboxsync CHECK_MEMBER_ALIGNMENT(ATADevState, StatATADMA, 8);
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync CHECK_MEMBER_ALIGNMENT(ATACONTROLLER, StatAsyncOps, 8);
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync CHECK_MEMBER_ALIGNMENT(DEVPARALLELSTATE, CritSect, 8);
ae9f3922b0becc4f4b4fca43422314700a4ed8a7vboxsync CHECK_MEMBER_ALIGNMENT(E1KSTATE, StatReceiveBytes, 8);
625f0ce802a913c7685bc8ae837583bea69ebf8avboxsync CHECK_MEMBER_ALIGNMENT(VNETSTATE, StatReceiveBytes, 8);
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync //CHECK_MEMBER_ALIGNMENT(E1KSTATE, csTx, 8);
dfff275f489de72e78be4fb4fbc3a2780f0ee2aavboxsync CHECK_MEMBER_ALIGNMENT(EHCI, StatCanceledIsocUrbs, 8);
587f936a5f1c792ede2dcb60a7769780a3487c6fvboxsync CHECK_MEMBER_ALIGNMENT(E1KSTATE, StatReceiveBytes, 8);
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync CHECK_MEMBER_ALIGNMENT(IOAPICState, StatMMIOReadGC, 8);
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync CHECK_MEMBER_ALIGNMENT(IOAPICState, StatMMIOReadGC, 8);
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync CHECK_MEMBER_ALIGNMENT(LSILOGISCSI, ReplyPostQueueCritSect, 8);
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync CHECK_MEMBER_ALIGNMENT(LSILOGISCSI, ReplyFreeQueueCritSect, 8);
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync CHECK_MEMBER_ALIGNMENT(OHCI, StatCanceledIsocUrbs, 8);
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync CHECK_MEMBER_ALIGNMENT(PCIGLOBALS, pci_irq_levels, 16);
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync CHECK_MEMBER_ALIGNMENT(PCNetState, u64LastPoll, 8);
ae9f3922b0becc4f4b4fca43422314700a4ed8a7vboxsync CHECK_MEMBER_ALIGNMENT(PCNetState, StatReceiveBytes, 8);
ae9f3922b0becc4f4b4fca43422314700a4ed8a7vboxsync CHECK_MEMBER_ALIGNMENT(PCNetState, StatMMIOReadRZ, 8);
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync CHECK_MEMBER_ALIGNMENT(VGASTATE, StatRZMemoryRead, 8);
804f38dc60de88705f57b964b11e0bf17768e47cvboxsync //CHECK_MEMBER_ALIGNMENT(PCIRAWSENDREQ, u.aGetRegionInfo.u64RegionSize, 8);
9b5a120b694c2603a7a3dccbd6cc519164943b17vboxsync * Compare HC and RC.
9b5a120b694c2603a7a3dccbd6cc519164943b17vboxsync printf("tstDeviceStructSize: Comparing HC and RC...\n");
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Report result.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync printf("tstDeviceStructSize: FAILURE - %d errors\n", rc);