Changeset 40756 in vbox for trunk/include

Timestamp:

Apr 3, 2012 2:47:33 PM (13 years ago)

Author:

vboxsync

Message:

SUP: Working on a generic tracer interface.

Location:

trunk/include/VBox

Files:

• err.h (modified) (1 diff)
• sup.h (modified) (2 diffs)

trunk/include/VBox/err.h

@@ -1620 +1620 @@
 #define VERR_SUPDRV_KERNEL_TOO_OLD_FOR_VTX          (-3703)
 /** Bad VTG magic value.  */
-#define VERR_SUPDRV_VTG_MAGIC                   (-3704)
+#define VERR_SUPDRV_VTG_MAGIC                       (-3704)
 /** Bad VTG bit count value.  */
-#define VERR_SUPDRV_VTG_BITS                    (-3705)
+#define VERR_SUPDRV_VTG_BITS                        (-3705)
 /** Bad VTG header.  */
-#define VERR_SUPDRV_VTG_BAD_HDR                 (-3706)
+#define VERR_SUPDRV_VTG_BAD_HDR                     (-3706)
 /** Bad VTG header - pointer.  */
-#define VERR_SUPDRV_VTG_BAD_HDR_PTR             (-3707)
+#define VERR_SUPDRV_VTG_BAD_HDR_PTR                 (-3707)
 /** Bad VTG header - to low value.  */
-#define VERR_SUPDRV_VTG_BAD_HDR_TOO_FEW         (-3708)
+#define VERR_SUPDRV_VTG_BAD_HDR_TOO_FEW             (-3708)
 /** Bad VTG header - to high value.  */
-#define VERR_SUPDRV_VTG_BAD_HDR_TOO_MUCH        (-3709)
+#define VERR_SUPDRV_VTG_BAD_HDR_TOO_MUCH            (-3709)
 /** Bad VTG header - size value is not a multiple of the structure size. */
-#define VERR_SUPDRV_VTG_BAD_HDR_NOT_MULTIPLE    (-3710)
+#define VERR_SUPDRV_VTG_BAD_HDR_NOT_MULTIPLE        (-3710)
 /** Bad VTG string table offset. */
-#define VERR_SUPDRV_VTG_STRTAB_OFF              (-3711)
+#define VERR_SUPDRV_VTG_STRTAB_OFF                  (-3711)
 /** Bad VTG string. */
-#define VERR_SUPDRV_VTG_BAD_STRING              (-3712)
+#define VERR_SUPDRV_VTG_BAD_STRING                  (-3712)
 /** VTG string is too long. */
-#define VERR_SUPDRV_VTG_STRING_TOO_LONG         (-3713)
+#define VERR_SUPDRV_VTG_STRING_TOO_LONG             (-3713)
 /** Bad VTG attribute value. */
-#define VERR_SUPDRV_VTG_BAD_ATTR                (-3714)
+#define VERR_SUPDRV_VTG_BAD_ATTR                    (-3714)
 /** Bad VTG provider descriptor. */
-#define VERR_SUPDRV_VTG_BAD_PROVIDER            (-3715)
+#define VERR_SUPDRV_VTG_BAD_PROVIDER                (-3715)
 /** Bad VTG probe descriptor. */
-#define VERR_SUPDRV_VTG_BAD_PROBE               (-3716)
+#define VERR_SUPDRV_VTG_BAD_PROBE                   (-3716)
 /** Bad VTG argument list descriptor. */
-#define VERR_SUPDRV_VTG_BAD_ARGLIST             (-3717)
+#define VERR_SUPDRV_VTG_BAD_ARGLIST                 (-3717)
 /** Bad VTG probe enabled data. */
-#define VERR_SUPDRV_VTG_BAD_PROBE_ENABLED       (-3718)
+#define VERR_SUPDRV_VTG_BAD_PROBE_ENABLED           (-3718)
 /** Bad VTG probe location record. */
-#define VERR_SUPDRV_VTG_BAD_PROBE_LOC           (-3719)
+#define VERR_SUPDRV_VTG_BAD_PROBE_LOC               (-3719)
 /** The VTG object for the session or image has already been registered. */
-#define VERR_SUPDRV_VTG_ALREADY_REGISTERED      (-3720)
+#define VERR_SUPDRV_VTG_ALREADY_REGISTERED          (-3720)
 /** A driver may only register one VTG object per session. */
-#define VERR_SUPDRV_VTG_ONLY_ONCE_PER_SESSION   (-3721)
+#define VERR_SUPDRV_VTG_ONLY_ONCE_PER_SESSION       (-3721)
+/** A tracer has already been registered. */
+#define VERR_SUPDRV_TRACER_ALREADY_REGISTERED       (-3722)
+/** The session has no tracer associated with it. */
+#define VERR_SUPDRV_TRACER_NOT_REGISTERED           (-3723)
 /** @} */
 

trunk/include/VBox/sup.h

@@ -1276 +1276 @@
 
 
+/** @name Tracing
+ * @{ */
+
 struct VTGOBJHDR;
+
+/**
+ * Tracer data associated with a provider.
+ */
+typedef union SUPDRVTRACERDATA
+{
+    /** Generic */
+    uint64_t                    au64[2];
+
+    /** DTrace data. */
+    struct
+    {
+        /** Provider ID. */
+        uintptr_t               idProvider;
+        /** The number of trace points. */
+        uint32_t volatile       cTracepoints;
+    } DTrace;
+} SUPDRVTRACERDATA;
+/** Pointer to the tracer data associated with a provider. */
+typedef SUPDRVTRACERDATA *PSUPDRVTRACERDATA;
+
+/**
+ * Support driver tracepoint provider core.
+ */
+typedef struct SUPDRVVDTPROVIDERCORE
+{
+    /** The tracer data member. */
+    SUPDRVTRACERDATA            TracerData;
+    /** The provider descriptor. */
+    struct VTGDESCPROVIDER     *pDesc;
+    /** The VTG header. */
+    struct VTGOBJHDR           *pHdr;
+    /** Pointer to the provider name (a copy that's always available). */
+    const char                 *pszName;
+} SUPDRVVDTPROVIDERCORE;
+/** Pointer to a tracepoint provider core structure. */
+typedef SUPDRVVDTPROVIDERCORE *PSUPDRVVDTPROVIDERCORE;
+
+
+/** Pointer to a tracer registration record. */
+typedef struct SUPDRVTRACERREG const *PCSUPDRVTRACERREG;
+/**
+ * Support driver tracer registration record.
+ */
+typedef struct SUPDRVTRACERREG
+{
+    /** Magic value (SUPDRVTRACERREG_MAGIC). */
+    uint32_t                    u32Magic;
+    /** Version (SUPDRVTRACERREG_VERSION). */
+    uint32_t                    u32Version;
+
+    DECLR0CALLBACKMEMBER(int,   pfnTodo1, (PCSUPDRVTRACERREG pThis));
+    DECLR0CALLBACKMEMBER(int,   pfnTodo2, (PCSUPDRVTRACERREG pThis));
+    DECLR0CALLBACKMEMBER(int,   pfnTodo3, (PCSUPDRVTRACERREG pThis));
+    DECLR0CALLBACKMEMBER(int,   pfnTodo4, (PCSUPDRVTRACERREG pThis));
+    DECLR0CALLBACKMEMBER(int,   pfnTodo5, (PCSUPDRVTRACERREG pThis));
+
+    /**
+     * Registers a provider.
+     *
+     * @returns VBox status code.
+     * @param   pThis           Pointer to the registration record.
+     * @param   pCore           The provider core data.
+     */
+    DECLR0CALLBACKMEMBER(int,   pfnRegisterProvider, (PCSUPDRVTRACERREG pThis, PSUPDRVVDTPROVIDERCORE pCore));
+
+    /**
+     * Attempts to deregisters a provider.
+     *
+     * @returns VINF_SUCCESS or VERR_TRY_AGAIN.  If the latter, the provider
+     *          should be made as harmless as possible before returning as the
+     *          VTG object and associated code will be unloaded upon return.
+     *
+     * @param   pThis           Pointer to the registration record.
+     * @param   pCore           The provider core data.
+     */
+    DECLR0CALLBACKMEMBER(int,   pfnDeregisterProvider, (PCSUPDRVTRACERREG pThis, PSUPDRVVDTPROVIDERCORE pCore));
+
+    /**
+     * Make another attempt at unregister a busy provider.
+     *
+     * @returns VINF_SUCCESS or VERR_TRY_AGAIN.
+     * @param   pThis           Pointer to the registration record.
+     * @param   pCore           The provider core data.
+     */
+    DECLR0CALLBACKMEMBER(int,   pfnDeregisterZombieProvider, (PCSUPDRVTRACERREG pThis, PSUPDRVVDTPROVIDERCORE pCore));
+
+    /** End marker (SUPDRVTRACERREG_MAGIC). */
+    uintptr_t                   uEndMagic;
+} SUPDRVTRACERREG;
+
+/** Tracer magic (Kenny Garrett). */
+#define SUPDRVTRACERREG_MAGIC   UINT32_C(0x19601009)
+/** Tracer registration structure version. */
+#define SUPDRVTRACERREG_VERSION RT_MAKE_U32(0, 1)
+
+/** Pointer to a trace helper structure. */
+typedef struct SUPDRVTRACERHLP const *PCSUPDRVTRACERHLP;
+/**
+ * Helper structure.
+ */
+typedef struct SUPDRVTRACERHLP
+{
+    /** The structure version (SUPDRVTRACERHLP_VERSION). */
+    uintptr_t                   uVersion;
+
+    /** @todo ... */
+
+    /** End marker (SUPDRVTRACERHLP_VERSION) */
+    uintptr_t                   uEndVersion;
+} SUPDRVTRACERHLP;
+/** Tracer helper structure version. */
+#define SUPDRVTRACERHLP_VERSION RT_MAKE_U32(0, 1)
+
 SUPR0DECL(int)  SUPR0VtgRegisterDrv(PSUPDRVSESSION pSession, struct VTGOBJHDR *pVtgHdr, const char *pszName);
 SUPR0DECL(void) SUPR0VtgDeregisterDrv(PSUPDRVSESSION pSession);
@@ -1282 +1399 @@
                                   uintptr_t uArg3, uintptr_t uArg4);
 SUPR0DECL(int)  SUPR0VtgRegisterModule(void *hMod, struct VTGOBJHDR *pVtgHdr);
+/** @}  */
+
 
 /**