Changeset 5667 in vbox for trunk/include

Timestamp:

Nov 11, 2007 4:28:47 AM (17 years ago)

Author:

vboxsync

Message:

Debugger interface for searching memory. Fixed a const mixup.

Location:

trunk/include/VBox

Files:

• dbgf.h (modified) (3 diffs)
• err.h (modified) (1 diff)
• pgm.h (modified) (19 diffs)

trunk/include/VBox/dbgf.h

@@ -131 +131 @@
 /** A flat address. */
 #define DBGFADDRESS_FLAGS_FLAT          3
+/** A physical address. */
+#define DBGFADDRESS_FLAGS_PHYS          4
 /** The address type mask. */
-#define DBGFADDRESS_FLAGS_TYPE_MASK     3
+#define DBGFADDRESS_FLAGS_TYPE_MASK     7
 
 /** Set if the address is valid. */
-#define DBGFADDRESS_FLAGS_VALID         RT_BIT(2)
+#define DBGFADDRESS_FLAGS_VALID         RT_BIT(3)
 
 /** The address is within the hypervisor memoary area (HMA).
  * If not set, the address can be assumed to be a guest address. */
-#define DBGFADDRESS_FLAGS_HMA           RT_BIT(3)
+#define DBGFADDRESS_FLAGS_HMA           RT_BIT(4)
 
 /** Checks if the mixed address is flat or not. */
 #define DBGFADDRESS_IS_FLAT(pAddress)    ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) == DBGFADDRESS_FLAGS_FLAT )
+/** Checks if the mixed address is flat or not. */
+#define DBGFADDRESS_IS_PHYS(pAddress)    ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) == DBGFADDRESS_FLAGS_PHYS )
 /** Checks if the mixed address is far 16:16 or not. */
 #define DBGFADDRESS_IS_FAR16(pAddress)   ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) == DBGFADDRESS_FLAGS_FAR16 )
@@ -150 +154 @@
 #define DBGFADDRESS_IS_FAR64(pAddress)   ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) == DBGFADDRESS_FLAGS_FAR64 )
 /** Checks if the mixed address is valid. */
-#define DBGFADDRESS_IS_VALID(pAddress)   ( (pAddress)->fFlags & DBGFADDRESS_FLAGS_VALID )
+#define DBGFADDRESS_IS_VALID(pAddress)   ( !!((pAddress)->fFlags & DBGFADDRESS_FLAGS_VALID) )
+/** Checks if the address is flagged as within the HMA. */
+#define DBGFADDRESS_IS_HMA(pAddress)     ( !!((pAddress)->fFlags & DBGFADDRESS_FLAGS_HMA) )
 /** @} */
 
@@ -172 +178 @@
  */
 DBGFR3DECL(void) DBGFR3AddrFromFlat(PVM pVM, PDBGFADDRESS pAddress, RTGCUINTPTR FlatPtr);
+
+/**
+ * Creates a mixed address from a guest physical address.
+ *
+ * @param   pVM         The VM handle.
+ * @param   pAddress    Where to store the mixed address.
+ * @param   PhysAddr    The guest physical address.
+ */
+DBGFR3DECL(void) DBGFR3AddrFromPhys(PVM pVM, PDBGFADDRESS pAddress, RTGCPHYS PhysAddr);
 
 /**

trunk/include/VBox/err.h

@@ -224 +224 @@
 /** The breakpoint already exists. */
 #define VINF_DBGF_BP_ALREADY_EXIST          1207
+/** The byte string was not found. */
+#define VERR_DBGF_MEM_NOT_FOUND             (-1208)
 /** @} */
 

trunk/include/VBox/pgm.h

@@ -810 +810 @@
 /**
  * Invalidates the GC page mapping TLB.
- * 
+ *
  * @param   pVM     The VM handle.
  */
@@ -817 +817 @@
 /**
  * Invalidates the ring-0 page mapping TLB.
- * 
+ *
  * @param   pVM     The VM handle.
  */
@@ -824 +824 @@
 /**
  * Invalidates the ring-3 page mapping TLB.
- * 
+ *
  * @param   pVM     The VM handle.
  */
 PDMDECL(void) PGMPhysInvalidatePageR3MapTLB(PVM pVM);
 
-/** 
+/**
  * Page mapping lock.
- * 
- * @remarks This doesn't work in structures shared between 
+ *
+ * @remarks This doesn't work in structures shared between
  *          ring-3, ring-0 and/or GC.
  */
@@ -857 +857 @@
  * scarse resources (R0 and GC) in the mapping cache. When you're done
  * with the page, call PGMPhysReleasePageMappingLock() ASAP to release it.
- * 
- * This API will assume your intention is to write to the page, and will 
- * therefore replace shared and zero pages. If you do not intend to modify 
+ *
+ * This API will assume your intention is to write to the page, and will
+ * therefore replace shared and zero pages. If you do not intend to modify
  * the page, use the PGMPhysGCPhys2CCPtrReadOnly() API.
  *
@@ -899 +899 @@
  * @thread  Any thread.
  */
-PGMDECL(int) PGMPhysGCPhys2CCPtrReadOnly(PVM pVM, RTGCPHYS GCPhys, void * const *ppv, PPGMPAGEMAPLOCK pLock);
+PGMDECL(int) PGMPhysGCPhys2CCPtrReadOnly(PVM pVM, RTGCPHYS GCPhys, void const **ppv, PPGMPAGEMAPLOCK pLock);
 
 /**
@@ -908 +908 @@
  * with the page, call PGMPhysReleasePageMappingLock() ASAP to release it.
  *
- * This API will assume your intention is to write to the page, and will 
- * therefore replace shared and zero pages. If you do not intend to modify 
+ * This API will assume your intention is to write to the page, and will
+ * therefore replace shared and zero pages. If you do not intend to modify
  * the page, use the PGMPhysGCPtr2CCPtrReadOnly() API.
  *
@@ -953 +953 @@
  * @thread  EMT
  */
-PGMDECL(int) PGMPhysGCPtr2CCPtrReadOnly(PVM pVM, RTGCPTR GCPtr, void * const *ppv, PPGMPAGEMAPLOCK pLock);
+PGMDECL(int) PGMPhysGCPtr2CCPtrReadOnly(PVM pVM, RTGCPTR GCPtr, void const **ppv, PPGMPAGEMAPLOCK pLock);
 
 /**
  * Release the mapping of a guest page.
- * 
+ *
  * This is the counter part of PGMPhysGCPhys2CCPtr, PGMPhysGCPhys2CCPtrReadOnly
  * PGMPhysGCPtr2CCPtr and PGMPhysGCPtr2CCPtrReadOnly.
@@ -969 +969 @@
 /**
  * Checks if the lock structure is valid
- * 
+ *
  * @param   pVM         The VM handle.
  * @param   pLock       The lock structure initialized by the mapping function.
@@ -1311 +1311 @@
  * @{
  */
-/** 
+/**
  * Worker function for PGMR3PhysAllocateHandyPages and pgmPhysEnsureHandyPage.
- * 
+ *
  * @returns The following VBox status codes.
  * @retval  VINF_SUCCESS on success. FF cleared.
  * @retval  VINF_EM_NO_MEMORY if we're out of memory. The FF is set in this case.
- * 
- * @param   pVM         The VM handle.
- * 
+ *
+ * @param   pVM         The VM handle.
+ *
  * @remarks Must be called from within the PGM critical section.
  */
@@ -1325 +1325 @@
 
 /** @} */
-#endif 
+#endif
 
 
@@ -1784 +1784 @@
 /**
  * For VMMCALLHOST_PGM_MAP_CHUNK, considered internal.
- * 
+ *
  * @returns see pgmR3PhysChunkMap.
  * @param   pVM         The VM handle.
@@ -1793 +1793 @@
 /**
  * Invalidates the TLB for the ring-3 mapping cache.
- * 
+ *
  * @param   pVM         The VM handle.
  */
@@ -1800 +1800 @@
 /**
  * Response to VM_FF_PGM_NEED_HANDY_PAGES and VMMCALLHOST_PGM_ALLOCATE_HANDY_PAGES.
- * 
+ *
  * @returns VBox status code.
  * @retval  VINF_SUCCESS on success. FF cleared.
  * @retval  VINF_EM_NO_MEMORY if we're out of memory. The FF is not cleared in this case.
- * 
+ *
  * @param   pVM         The VM handle.
  */
@@ -1819 +1819 @@
 
 /**
- * Converts a HC pointer to a GC physical address. 
- * 
+ * Converts a HC pointer to a GC physical address.
+ *
  * Only for the debugger.
  *
@@ -1826 +1826 @@
  * @retval  VINF_SUCCESS on success, *pGCPhys is set.
  * @retval  VERR_INVALID_POINTER if the pointer is not within the GC physical memory.
- * 
+ *
  * @param   pVM     The VM handle.
  * @param   HCPtr   The HC pointer to convert.
@@ -1840 +1840 @@
  * @retval  VERR_PGM_PHYS_PAGE_RESERVED it it's a valid GC physical page but has no physical backing.
  * @retval  VERR_INVALID_POINTER if the pointer is not within the GC physical memory.
- * 
+ *
  * @param   pVM     The VM handle.
  * @param   HCPtr   The HC pointer to convert.
@@ -1849 +1849 @@
 /**
  * Converts a HC physical address to a GC physical address.
- * 
+ *
  * Only for the debugger.
  *
@@ -1855 +1855 @@
  * @retval  VINF_SUCCESS on success, *pGCPhys is set.
  * @retval  VERR_INVALID_POINTER if the HC physical address is not within the GC physical memory.
- * 
+ *
  * @param   pVM     The VM handle.
  * @param   HCPhys  The HC physical address to convert.
@@ -1862 +1862 @@
 PGMR3DECL(int) PGMR3DbgHCPhys2GCPhys(PVM pVM, RTHCPHYS HCPhys, PRTGCPHYS pGCPhys);
 
+/**
+ * Scans guest physical memory for a byte string.
+ *
+ * Only for the debugger.
+ *
+ * @returns VBox status codes:
+ * @retval  VINF_SUCCESS and *pGCPtrHit on success.
+ * @retval  VERR_DBGF_MEM_NOT_FOUND if not found.
+ * @retval  VERR_INVALID_POINTER if any of the pointer arguments are invalid.
+ * @retval  VERR_INVALID_ARGUMENT if any other arguments are invalid.
+ *
+ * @param   pVM             Pointer to the shared VM structure.
+ * @param   GCPhys          Where to start searching.
+ * @param   cbRange         The number of bytes to search. Max 256 bytes.
+ * @param   pabNeedle       The byte string to search for.
+ * @param   cbNeedle        The length of the byte string.
+ * @param   pGCPhysHit      Where to store the address of the first occurence on success.
+ */
+PDMR3DECL(int) PGMR3DbgScanPhysical(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cbRange, const uint8_t *pabNeedle, size_t cbNeedle, PRTGCPHYS pGCPhysHit);
+
+/**
+ * Scans virtual memory for a byte string.
+ *
+ * Only for the debugger.
+ *
+ * @returns VBox status codes:
+ * @retval  VINF_SUCCESS and *pGCPtrHit on success.
+ * @retval  VERR_DBGF_MEM_NOT_FOUND if not found.
+ * @retval  VERR_INVALID_POINTER if any of the pointer arguments are invalid.
+ * @retval  VERR_INVALID_ARGUMENT if any other arguments are invalid.
+ *
+ * @param   pVM             Pointer to the shared VM structure.
+ * @param   GCPtr           Where to start searching.
+ * @param   cbRange         The number of bytes to search. Max 256 bytes.
+ * @param   pabNeedle       The byte string to search for.
+ * @param   cbNeedle        The length of the byte string.
+ * @param   pGCPtrHit       Where to store the address of the first occurence on success.
+ */
+PDMR3DECL(int) PGMR3DbgScanVirtual(PVM pVM, RTGCUINTPTR GCPtr, RTGCUINTPTR cbRange, const uint8_t *pabNeedle, size_t cbNeedle, PRTGCUINTPTR pGCPhysHit);
+
 /** @} */