tstHelp.h revision 0107e9a80c70ff76c98fea679ce570ff244d2f82
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/* $Id$ */
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/** @file
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * VMM testcase - Helper stuff.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig */
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/*
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Copyright (C) 2006-2011 Oracle Corporation
75da45714b471969a6eb41b469237d51d1ed92beMark Craig *
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * This file is part of VirtualBox Open Source Edition (OSE), as
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * available from http://www.virtualbox.org. This file is free software;
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * you can redistribute it and/or modify it under the terms of the GNU
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * General Public License (GPL) as published by the Free Software
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Foundation, in version 2 as it comes in the "COPYING" file of the
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig */
7bf512aea50c834dc9c3ef5a0a228059fcc753a5jenkins
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#ifndef ___tstHelp_h
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#define ___tstHelp_h
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#include <VBox/cdefs.h>
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#include <VBox/vmm/cpum.h>
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
7bf512aea50c834dc9c3ef5a0a228059fcc753a5jenkinsRT_C_DECLS_BEGIN
75da45714b471969a6eb41b469237d51d1ed92beMark Craigvoid tstDumpCtx(PCPUMCTX pCtx, const char *pszComment);
75da45714b471969a6eb41b469237d51d1ed92beMark CraigRT_C_DECLS_END
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/**
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Checks the offset of a data member.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @param type Type.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @param off Correct offset.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @param m Member name.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig */
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#define CHECK_OFF(type, off, m) \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig do { \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig if (off != RT_OFFSETOF(type, m)) \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig { \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig printf("error! %#010x %s Off by %d!! (expected off=%#x)\n", \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig RT_OFFSETOF(type, m), #type "." #m, off - RT_OFFSETOF(type, m), (int)off); \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig rc++; \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig } \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig /*else */ \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig /*printf("%#08x %s\n", RT_OFFSETOF(type, m), #m);*/ \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig } while (0)
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/**
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Checks the size of type.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @param type Type.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @param size Correct size.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig */
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#define CHECK_SIZE(type, size) \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig do { \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig if (size != sizeof(type)) \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig { \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig printf("error! sizeof(%s): %#x (%d) Off by %d!! (expected %#x)\n", \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig #type, (int)sizeof(type), (int)sizeof(type), (int)(sizeof(type) - size), (int)size); \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig rc++; \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig } \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig else \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig printf("info: sizeof(%s): %#x (%d)\n", #type, (int)sizeof(type), (int)sizeof(type)); \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig } while (0)
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/**
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Checks the alignment of a struct member.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig */
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#define CHECK_MEMBER_ALIGNMENT(strct, member, align) \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig do \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig { \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig if (RT_OFFSETOF(strct, member) & ((align) - 1) ) \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig { \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig printf("error! %s::%s offset=%#x (%u) expected alignment %#x, meaning %#x (%u) off\n", \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig #strct, #member, \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig (unsigned)RT_OFFSETOF(strct, member), \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig (unsigned)RT_OFFSETOF(strct, member), \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig (unsigned)(align), \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig (unsigned)(((align) - RT_OFFSETOF(strct, member)) & ((align) - 1)), \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig (unsigned)(((align) - RT_OFFSETOF(strct, member)) & ((align) - 1)) ); \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig rc++; \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig } \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig } while (0)
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/**
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Checks that the size of a type is aligned correctly.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig */
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#define CHECK_SIZE_ALIGNMENT(type, align) \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig do { \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig if (RT_ALIGN_Z(sizeof(type), (align)) != sizeof(type)) \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig { \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig printf("error! %s size=%#x (%u), align=%#x %#x (%u) bytes off\n", \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig #type, \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig (unsigned)sizeof(type), \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig (unsigned)sizeof(type), \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig (align), \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig (unsigned)RT_ALIGN_Z(sizeof(type), align) - (unsigned)sizeof(type), \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig (unsigned)RT_ALIGN_Z(sizeof(type), align) - (unsigned)sizeof(type)); \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig rc++; \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig } \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig } while (0)
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/**
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Checks that a internal struct padding is big enough.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig */
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#define CHECK_PADDING(strct, member, align) \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig do \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig { \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig strct *p = NULL; NOREF(p); \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig if (sizeof(p->member.s) > sizeof(p->member.padding)) \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig { \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig printf("error! padding of %s::%s is too small, padding=%d struct=%d correct=%d\n", #strct, #member, \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig (int)sizeof(p->member.padding), (int)sizeof(p->member.s), (int)RT_ALIGN_Z(sizeof(p->member.s), (align))); \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig rc++; \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig } \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig else if (RT_ALIGN_Z(sizeof(p->member.padding), (align)) != sizeof(p->member.padding)) \
7bf512aea50c834dc9c3ef5a0a228059fcc753a5jenkins { \
7bf512aea50c834dc9c3ef5a0a228059fcc753a5jenkins printf("error! padding of %s::%s is misaligned, padding=%d correct=%d\n", #strct, #member, \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig (int)sizeof(p->member.padding), (int)RT_ALIGN_Z(sizeof(p->member.s), (align))); \
7bf512aea50c834dc9c3ef5a0a228059fcc753a5jenkins rc++; \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig } \
7bf512aea50c834dc9c3ef5a0a228059fcc753a5jenkins } while (0)
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/**
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Checks that a internal struct padding is big enough.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig */
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#define CHECK_PADDING2(strct) \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig do \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig { \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig strct *p = NULL; NOREF(p); \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig if (sizeof(p->s) > sizeof(p->padding)) \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig { \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig printf("error! padding of %s is too small, padding=%d struct=%d correct=%d\n", #strct, \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig (int)sizeof(p->padding), (int)sizeof(p->s), (int)RT_ALIGN_Z(sizeof(p->s), 64)); \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig rc++; \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig } \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig } while (0)
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/**
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Checks that a internal struct padding is big enough.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig */
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#define CHECK_PADDING3(strct, member, pad_member) \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig do \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig { \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig strct *p = NULL; NOREF(p); \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig if (sizeof(p->member) > sizeof(p->pad_member)) \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig { \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig printf("error! padding of %s::%s is too small, padding=%d struct=%d\n", #strct, #member, \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig (int)sizeof(p->pad_member), (int)sizeof(p->member)); \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig rc++; \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig } \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig } while (0)
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/**
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Checks that an expression is true.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig */
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#define CHECK_EXPR(expr) \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig do \
75da45714b471969a6eb41b469237d51d1ed92beMark Craig { \
if (!(expr)) \
{ \
printf("error! '%s' failed! (line %d)\n", #expr, __LINE__); \
rc++; \
} \
} while (0)
#endif