Changeset 2856 for trunk/kLdr/kLdrRdr.c

Timestamp:

Nov 4, 2006, 11:19:33 PM (19 years ago)

Author:

bird

Message:

More code.

File:

• trunk/kLdr/kLdrRdr.c (modified) (8 diffs)

trunk/kLdr/kLdrRdr.c

@@ -31 +31 @@
 #include <kLdr.h>
 #include "kLdrInternal.h"
+
+
+/*******************************************************************************
+*   Defined Constants And Macros                                               *
+*******************************************************************************/
+/** @def KLDRRDR_STRICT
+ * Define KLDRRDR_STRICT to enabled strict checks in KLDRMOD. */
+#define KLDRRDR_STRICT 1
+
+/** @def KLDRRDR_ASSERT
+ * Assert that an expression is true when KLDR_STRICT is defined.
+ */
+#ifdef KLDRRDR_STRICT
+# define KLDRRDR_ASSERT(expr)  kldrHlpAssert(expr)
+#else
+# define KLDRRDR_ASSERT(expr)  do {} while (0)
+#endif
+
+/** Return / crash validation of a reader argument. */
+#define KLDRRDR_VALIDATE_EX(pRdr, rc) \
+    do  { \
+        if (    (pRdr)->u32Magic != KLDRRDR_MAGIC \
+            ||  (pRdr)->pOps == NULL \
+           )\
+        { \
+            return (rc); \
+        } \
+    } while (0)
+
+/** Return / crash validation of a reader argument. */
+#define KLDRRDR_VALIDATE(pRdr) \
+    KLDRRDR_VALIDATE_EX(pRdr, KLDR_ERR_INVALID_PARAMETER)
+
+/** Return / crash validation of a reader argument. */
+#define KLDRRDR_VALIDATE_VOID(pRdr) \
+    do  { \
+        if (    (pRdr)->u32Magic != KLDRRDR_MAGIC \
+            ||  (pRdr)->pOps == NULL \
+           )\
+        { \
+            return; \
+        } \
+    } while (0)
+
 
 
@@ -82 +126 @@
 int kLdrRdrClose(PKLDRRDR pRdr)
 {
+    KLDRRDR_VALIDATE(pRdr);
     return pRdr->pOps->pfnDestroy(pRdr);
 }
@@ -96 +141 @@
 int kLdrRdrRead(PKLDRRDR pRdr, void *pvBuf, size_t cb, off_t off)
 {
+    KLDRRDR_VALIDATE(pRdr);
     return pRdr->pOps->pfnRead(pRdr, pvBuf, cb, off);
 }
@@ -109 +155 @@
 int kLdrRdrAllMap(PKLDRRDR pRdr, const void **ppvBits)
 {
+    KLDRRDR_VALIDATE(pRdr);
     return pRdr->pOps->pfnAllMap(pRdr, ppvBits);
 }
@@ -121 +168 @@
 int kLdrRdrAllUnmap(PKLDRRDR pRdr, const void *pvBits)
 {
+    KLDRRDR_VALIDATE(pRdr);
     return pRdr->pOps->pfnAllUnmap(pRdr, pvBits);
 }
@@ -132 +180 @@
 off_t kLdrRdrSize(PKLDRRDR pRdr)
 {
+    KLDRRDR_VALIDATE(pRdr);
     return pRdr->pOps->pfnSize(pRdr);
 }
@@ -143 +192 @@
 off_t kLdrRdrTell(PKLDRRDR pRdr)
 {
+    KLDRRDR_VALIDATE(pRdr);
     return pRdr->pOps->pfnTell(pRdr);
 }
@@ -149 +199 @@
 /** Get the file name.
  *
- * @returns The file size. Returns -1 on failure.
+ * @returns The file name. Returns NULL on failure.
  * @param   pRdr        The file provider instance.
  */
 const char *kLdrRdrName(PKLDRRDR pRdr)
 {
+    KLDRRDR_VALIDATE_EX(pRdr, NULL);
     return pRdr->pOps->pfnName(pRdr);
 }
 
 
+/**
+ * Gets the page size used when mapping sections of the file.
+ *
+ * @returns The page size.
+ * @param   pRdr        The file provider instance.
+ */
+size_t  kLdrRdrPageSize(PKLDRRDR pRdr)
+{
+    KLDRRDR_VALIDATE_EX(pRdr, 0x10000);
+    return pRdr->pOps->pfnPageSize(pRdr);
+}
+
+
+/**
+ * Prepares a memory region to map file sections into.
+ *
+ * @returns 0 on success, OS specific error code on failure.
+ * @param   pRdr        The file provider instance.
+ * @param   ppv         If fFixed is set, *ppv contains the memory location which
+ *                      the region should be based at. If fFixed is clear the OS
+ *                      is free to choose the location.
+ *                      On successful return *ppv contains address of the prepared
+ *                      memory region.
+ * @param   cb          The size of the memory region to prepare.
+ * @param   fFixed      When set *ppv will contain the desired region address.
+ *
+ */
+int kLdrRdrPrepare(PKLDRRDR pRdr, void **ppv, size_t cb, unsigned fFixed)
+{
+    KLDRRDR_VALIDATE(pRdr);
+    return pRdr->pOps->pfnPrepare(pRdr, ppv, cb, fFixed);
+}
+
+
+/**
+ * Maps a section of the file into the memory region reserved by pfnPrepare.
+ *
+ * @returns 0 on success, OS specific error code on failure.
+ * @param   pRdr        The file provider instance.
+ * @param   pv          The address in the prepared region.
+ * @param   cb          The size of the memory mapping.
+ * @param   enmProt     The desired memory protection.
+ * @param   offFile     The start of the raw file bytes.
+ * @param   cbFile      The number of raw file bytes. This must be less or equal to cb.
+ */
+int kLdrRdrMap(PKLDRRDR pRdr, void *pv, size_t cb, KLDRPROT enmProt, off_t offFile, size_t cbFile)
+{
+    KLDRRDR_VALIDATE(pRdr);
+    return pRdr->pOps->pfnMap(pRdr, pv, cb, enmProt, offFile, cbFile);
+}
+
+
+/**
+ * Reloads dirty pages in mapped section.
+ *
+ * @returns 0 on success, OS specific error code on failure.
+ * @param   pRdr        The file provider instance.
+ * @param   pv          The address in the prepared region.
+ * @param   cb          The size of the memory mapping.
+ * @param   enmProt     The desired memory protection.
+ * @param   offFile     The start of the raw file bytes.
+ * @param   cbFile      The number of raw file bytes. This must be less or equal to cb.
+ */
+int kLdrRdrRefreshMap(PKLDRRDR pRdr, void *pv, size_t cb, KLDRPROT enmProt, off_t offFile, size_t cbFile)
+{
+    KLDRRDR_VALIDATE(pRdr);
+    return pRdr->pOps->pfnRefreshMap(pRdr, pv, cb, enmProt, offFile, cbFile);
+}
+
+
+/**
+ * Changes the page protection of a section mapped using pfnMap.
+ *
+ * This is typically used for applying fixups and similar.
+ *
+ * @returns 0 on success, OS specific error code on failure.
+ * @param   pRdr        The file provider instance.
+ * @param   pv          The address passed to pfnMap.
+ * @param   cb          The size passed to pfnMap.
+ * @param   enmProt     The desired memory protection.
+ */
+int kLdrRdrProtect(PKLDRRDR pRdr, void *pv, size_t cb, KLDRPROT enmProt)
+{
+    KLDRRDR_VALIDATE(pRdr);
+    return pRdr->pOps->pfnProtect(pRdr, pv, cb, enmProt);
+}
+
+
+/**
+ * Unmaps a section of the file previously mapped using pfnMap.
+ *
+ * @returns 0 on success, OS specific error code on failure.
+ * @param   pRdr        The file provider instance.
+ * @param   pv          The address passed to pfnMap.
+ * @param   cb          The size passed to pfnMap.
+ */
+int kLdrRdrUnmap(PKLDRRDR pRdr, void *pv, size_t cb)
+{
+    KLDRRDR_VALIDATE(pRdr);
+    return pRdr->pOps->pfnUnmap(pRdr, pv, cb);
+}
+
+
+/**
+ * Releases the memory region prepared by pfnPrepare().
+ *
+ * Before calling this function, all sections mapped by pfnMap must first be unmapped by calling pfnUnmap.
+ *
+ * @returns 0 on success, OS specific error code on failure.
+ * @param   pRdr        The file provider instance.
+ * @param   pv          The address of the prepared region.
+ * @param   cb          The size of the prepared region.
+ */
+int kLdrRdrUnprepare(PKLDRRDR pRdr, void *pv, size_t cb)
+{
+    KLDRRDR_VALIDATE(pRdr);
+    return pRdr->pOps->pfnUnprepare(pRdr, pv, cb);
+}
+
+
+/**
+ * We're done reading from the file but would like to keep file mappings.
+ *
+ * If the OS support closing the file handle while the file is mapped,
+ * the reader should do so.
+ *
+ * @param   pRdr        The file provider instance.
+ */
+void kLdrRdrDone(PKLDRRDR pRdr)
+{
+    KLDRRDR_VALIDATE_VOID(pRdr);
+    pRdr->pOps->pfnDone(pRdr);
+}
+