VMMTracing.h revision 2b01734ae56c7cdf9be61267c3cdb46344637bfa
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync/* $Id$ */
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync/** @file
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync * VBoxVMM - Trace point macros for the VMM.
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync */
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync/*
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync * Copyright (C) 2012 Oracle Corporation
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync *
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync * available from http://www.virtualbox.org. This file is free software;
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync * you can redistribute it and/or modify it under the terms of the GNU
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync * General Public License (GPL) as published by the Free Software
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync */
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync#ifndef ___VMMTracing_h___
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync#define ___VMMTracing_h___
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync/*******************************************************************************
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync* Header Files *
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync*******************************************************************************/
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync#ifdef DOXYGEN_RUNNING
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# undef VBOX_WITH_DTRACE
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# undef VBOX_WITH_DTRACE_R3
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# undef VBOX_WITH_DTRACE_R0
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# undef VBOX_WITH_DTRACE_RC
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define DBGFTRACE_ENABLED
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync#endif
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync#include <VBox/vmm/dbgftrace.h>
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync/*******************************************************************************
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync* Defined Constants And Macros *
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync*******************************************************************************/
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync/** Gets the trace buffer handle from a VMCPU pointer. */
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync#define VMCPU_TO_HTB(a_pVCpu) ((a_pVCpu)->CTX_SUFF(pVM)->CTX_SUFF(hTraceBuf))
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync/** Gets the trace buffer handle from a VMCPU pointer. */
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync#define VM_TO_HTB(a_pVM) ((a_pVM)->CTX_SUFF(hTraceBuf))
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync/** Macro wrapper for trace points that are disabled by default. */
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync#define TP_COND_VMCPU(a_pVCpu, a_TraceStmt) \
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync do { \
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync if (RT_UNLIKELY((a_pVCpu)->fTracingEnabled)) \
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync { \
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync RTTRACEBUF const hTB = (a_pVCpu)->CTX_SUFF(pVM)->CTX_SUFF(hTraceBuf); \
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync a_TraceStmt; \
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync } \
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync } while (0)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync/** @name Ring-3 trace points.
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync * @{
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync */
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync#ifdef IN_RING3
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# ifdef VBOX_WITH_DTRACE_R3
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# include "VBoxVMM-dtrace.h"
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# elif defined(DBGFTRACE_ENABLED)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_STATE_CHANGED(a_pVCpu, a_enmOldState, a_enmNewState, a_rc) \
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync TP_COND_VMCPU(a_pVCpu, RTTraceBufAddMsgF(hTB, "em-state-changed %d -> %d (rc=%d)", a_enmOldState, a_enmNewState, a_rc))
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_STATE_UNCHANGED(a_pVCpu, a_enmState, a_rc) \
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync TP_COND_VMCPU(a_pVCpu, RTTraceBufAddMsgF(hTB, "em-state-unchanged %d (rc=%d)", a_enmState, a_rc))
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_RAW_RUN_PRE(a_pVCpu, a_pCtx) \
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync TP_COND_VMCPU(a_pVCpu, RTTraceBufAddMsgF(hTB, "em-raw-pre %04x:%08llx", (a_pCtx)->cs, (a_pCtx)->rip))
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_RAW_RUN_RET(a_pVCpu, a_pCtx, a_rc) \
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync TP_COND_VMCPU(a_pVCpu, RTTraceBufAddMsgF(hTB, "em-raw-ret %04x:%08llx rc=%d", (a_pCtx)->cs, (a_pCtx)->rip, (a_rc)))
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_FF_HIGH(a_pVCpu, a_fGlobal, a_fLocal, a_rc) \
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync TP_COND_VMCPU(a_pVCpu, RTTraceBufAddMsgF(hTB, "em-ff-high vm=%#x cpu=%#x rc=%d", (a_fGlobal), (a_fLocal), (a_rc)))
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_FF_ALL(a_pVCpu, a_fGlobal, a_fLocal, a_rc) \
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync TP_COND_VMCPU(a_pVCpu, RTTraceBufAddMsgF(hTB, "em-ff-all vm=%#x cpu=%#x rc=%d", (a_fGlobal), (a_fLocal), (a_rc)))
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_FF_ALL_RET(a_pVCpu, a_rc) \
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync TP_COND_VMCPU(a_pVCpu, RTTraceBufAddMsgF(hTB, "em-ff-all-ret %d", (a_rc)))
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_FF_RAW(a_pVCpu, a_fGlobal, a_fLocal) \
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync TP_COND_VMCPU(a_pVCpu, RTTraceBufAddMsgF(hTB, "em-ff-raw vm=%#x cpu=%#x", (a_fGlobal), (a_fLocal)))
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_FF_RAW_RET(a_pVCpu, a_rc) \
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync TP_COND_VMCPU(a_pVCpu, RTTraceBufAddMsgF(hTB, "em-ff-raw-ret %d", (a_rc)))
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# else
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_STATE_CHANGED(a_pVCpu, a_enmOldState, a_enmNewState, a_rc) do { } while (0)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_STATE_UNCHANGED(a_pVCpu, a_enmState, a_rc) do { } while (0)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_RAW_RUN_PRE(a_pVCpu, a_pCtx) do { } while (0)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_RAW_RUN_RET(a_pVCpu, a_pCtx, a_rc) do { } while (0)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_FF_HIGH(a_pVCpu, a_fGlobal, a_fLocal, a_rc) do { } while (0)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_FF_ALL(a_pVCpu, a_fGlobal, a_fLocal, a_rc) do { } while (0)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_FF_ALL_RET(a_pVCpu, a_rc) do { } while (0)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_FF_RAW(a_pVCpu, a_fGlobal, a_fLocal) do { } while (0)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# define VBOXVMM_EM_FF_RAW_RET(a_pVCpu, a_rc) do { } while (0)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# endif
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync#endif /* IN_RING3 */
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync/** @} */
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync/** @name Ring-0 trace points.
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync * @{
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync */
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync#ifdef IN_RING0
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# ifdef VBOX_WITH_DTRACE_R0
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# include "VBoxVMMR0-dtrace.h"
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# elif defined(DBGFTRACE_ENABLED)
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# else
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync# endif
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync#endif /* IN_RING0*/
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync/** @} */
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync/** @} */
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync#endif
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync
1b33c96954667ba382fa595baf7b31290bfdd517vboxsync