Changeset 3543 for trunk/kStuff/kRdr/kRdr.c

Timestamp:

Aug 25, 2007, 8:10:29 AM (18 years ago)

Author:

bird

Message:

kRdr hacking.

Location:

trunk/kStuff/kRdr

Files:

• . (added)
• kRdr.c (copied) (copied from trunk/kStuff/kLdr/kLdrRdr.c ) (18 diffs)

trunk/kStuff/kRdr/kRdr.c

@@ -1 +1 @@
 /* $Id$ */
 /** @file
- *
- * kLdr - The Dynamic Loader, file abstraction.
- *
- * Copyright (c) 2006 knut st. osmundsen <bird-kbuild-src@anduin.net>
- *
- *
- * This file is part of kLdr.
- *
- * kLdr is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * kRdr - The File Provider.
+ */
+
+/*
+ * Copyright (c) 2006-2007 knut st. osmundsen <bird-src-spam@anduin.net>
+ *
+ * This file is part of kStuff.
+ *
+ * kStuff is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published
+ * by the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  *
- * kLdr is distributed in the hope that it will be useful,
+ * kStuff is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with kLdr; if not, write to the Free Software
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with kStuff; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
@@ -29 +29 @@
 *   Header Files                                                               *
 *******************************************************************************/
-#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)
-
+#include <k/kRdrAll.h>
+#include <k/kErrors.h>
+#include "kRdrInternal.h"
 
 
@@ -81 +38 @@
 *******************************************************************************/
 /** The list of file providers. */
-static PCKLDRRDROPS g_pRdrHead = &g_kLdrRdrFileOps;
+static PCKRDROPS g_pRdrHead = &g_kRdrFileOps;
 
 
@@ -89 +46 @@
  * @param   pAdd        The new file provider.
  */
-void kLdrRdrAddProvider(PKLDRRDROPS pAdd)
+void kRdrAddProvider(PKRDROPS pAdd)
 {
     pAdd->pNext = g_pRdrHead;
@@ -103 +60 @@
  * @param   pszFilename     The filename.
  */
-int kLdrRdrOpen(PPKLDRRDR ppRdr, const char *pszFilename)
+int kRdrOpen(PPKRDR ppRdr, const char *pszFilename)
 {
     int             rc = -1;
-    PCKLDRRDROPS    pCur;
+    PCKRDROPS    pCur;
     for (pCur = g_pRdrHead; pCur; pCur = pCur->pNext)
     {
@@ -124 +81 @@
  * @param   pRdr        The file provider instance.
  */
-int kLdrRdrClose(PKLDRRDR pRdr)
-{
-    KLDRRDR_VALIDATE(pRdr);
+int kRdrClose(PKRDR pRdr)
+{
+    KRDR_VALIDATE(pRdr);
     return pRdr->pOps->pfnDestroy(pRdr);
 }
@@ -139 +96 @@
  * @param   off         Where to start reading.
  */
-int kLdrRdrRead(PKLDRRDR pRdr, void *pvBuf, size_t cb, KLDRFOFF off)
-{
-    KLDRRDR_VALIDATE(pRdr);
+int kRdrRead(PKRDR pRdr, void *pvBuf, KSIZE cb, KFOFF off)
+{
+    KRDR_VALIDATE(pRdr);
     return pRdr->pOps->pfnRead(pRdr, pvBuf, cb, off);
 }
@@ -153 +110 @@
  *                      The size can be obtained using pfnSize.
  */
-int kLdrRdrAllMap(PKLDRRDR pRdr, const void **ppvBits)
-{
-    KLDRRDR_VALIDATE(pRdr);
+int kRdrAllMap(PKRDR pRdr, const void **ppvBits)
+{
+    KRDR_VALIDATE(pRdr);
     return pRdr->pOps->pfnAllMap(pRdr, ppvBits);
 }
 
 
-/** Unmap a file bits mapping obtained by KLDRRDROPS::pfnAllMap.
+/** Unmap a file bits mapping obtained by KRDROPS::pfnAllMap.
  *
  * @returns 0 on success, OS specific error code on failure.
@@ -166 +123 @@
  * @param   pvBits      The mapping address.
  */
-int kLdrRdrAllUnmap(PKLDRRDR pRdr, const void *pvBits)
-{
-    KLDRRDR_VALIDATE(pRdr);
+int kRdrAllUnmap(PKRDR pRdr, const void *pvBits)
+{
+    KRDR_VALIDATE(pRdr);
     return pRdr->pOps->pfnAllUnmap(pRdr, pvBits);
 }
@@ -178 +135 @@
  * @param   pRdr        The file provider instance.
  */
-KLDRFOFF kLdrRdrSize(PKLDRRDR pRdr)
-{
-    KLDRRDR_VALIDATE(pRdr);
+KFOFF kRdrSize(PKRDR pRdr)
+{
+    KRDR_VALIDATE(pRdr);
     return pRdr->pOps->pfnSize(pRdr);
 }
@@ -190 +147 @@
  * @param   pRdr        The file provider instance.
  */
-KLDRFOFF kLdrRdrTell(PKLDRRDR pRdr)
-{
-    KLDRRDR_VALIDATE(pRdr);
+KFOFF kRdrTell(PKRDR pRdr)
+{
+    KRDR_VALIDATE(pRdr);
     return pRdr->pOps->pfnTell(pRdr);
 }
@@ -202 +159 @@
  * @param   pRdr        The file provider instance.
  */
-const char *kLdrRdrName(PKLDRRDR pRdr)
-{
-    KLDRRDR_VALIDATE_EX(pRdr, NULL);
+const char *kRdrName(PKRDR pRdr)
+{
+    KRDR_VALIDATE_EX(pRdr, NULL);
     return pRdr->pOps->pfnName(pRdr);
 }
 
 
+/** Get the native file handle if possible.
+ *
+ * @returns The native file handle. Returns -1 if not available.
+ * @param   pRdr        The file provider instance.
+ */
+KIPTR kRdrNativeFH(PKRDR pRdr)
+{
+    KRDR_VALIDATE_EX(pRdr, -1);
+    return pRdr->pOps->pfnNativeFH(pRdr);
+}
+
+
 /**
  * Gets the page size used when mapping sections of the file.
@@ -215 +184 @@
  * @param   pRdr        The file provider instance.
  */
-size_t  kLdrRdrPageSize(PKLDRRDR pRdr)
-{
-    KLDRRDR_VALIDATE_EX(pRdr, 0x10000);
+KSIZE kRdrPageSize(PKRDR pRdr)
+{
+    KRDR_VALIDATE_EX(pRdr, 0x10000);
     return pRdr->pOps->pfnPageSize(pRdr);
 }
@@ -236 +205 @@
  * @param   fFixed      If set, the address at *ppvBase should be the base address of the mapping.
  */
-int kLdrRdrMap(PKLDRRDR pRdr, void **ppvBase, uint32_t cSegments, PCKLDRSEG paSegments, unsigned fFixed)
-{
-    KLDRRDR_VALIDATE(pRdr);
+int kRdrMap(PKRDR pRdr, void **ppvBase, KU32 cSegments, PCKLDRSEG paSegments, unsigned fFixed)
+{
+    KRDR_VALIDATE(pRdr);
     return pRdr->pOps->pfnMap(pRdr, ppvBase, cSegments, paSegments, fFixed);
 }
@@ -252 +221 @@
  * @param   paSegments  The segments thats going to be mapped.
  */
-int kLdrRdrRefresh(PKLDRRDR pRdr, void *pvBase, uint32_t cSegments, PCKLDRSEG paSegments)
-{
-    KLDRRDR_VALIDATE(pRdr);
+int kRdrRefresh(PKRDR pRdr, void *pvBase, KU32 cSegments, PCKLDRSEG paSegments)
+{
+    KRDR_VALIDATE(pRdr);
     return pRdr->pOps->pfnRefresh(pRdr, pvBase, cSegments, paSegments);
 }
@@ -273 +242 @@
  *                                  When clean the segment protection is restored.
  */
-int kLdrRdrProtect(PKLDRRDR pRdr, void *pvBase, uint32_t cSegments, PCKLDRSEG paSegments, unsigned fUnprotectOrProtect)
-{
-    KLDRRDR_VALIDATE(pRdr);
+int kRdrProtect(PKRDR pRdr, void *pvBase, KU32 cSegments, PCKLDRSEG paSegments, unsigned fUnprotectOrProtect)
+{
+    KRDR_VALIDATE(pRdr);
     return pRdr->pOps->pfnProtect(pRdr, pvBase, cSegments, paSegments, fUnprotectOrProtect);
 }
@@ -289 +258 @@
  * @param   paSegments  The segments thats going to be mapped.
  */
-int kLdrRdrUnmap(PKLDRRDR pRdr, void *pvBase, uint32_t cSegments, PCKLDRSEG paSegments)
-{
-    KLDRRDR_VALIDATE(pRdr);
+int kRdrUnmap(PKRDR pRdr, void *pvBase, KU32 cSegments, PCKLDRSEG paSegments)
+{
+    KRDR_VALIDATE(pRdr);
     return pRdr->pOps->pfnUnmap(pRdr, pvBase, cSegments, paSegments);
 }
@@ -304 +273 @@
  * @param   pRdr        The file provider instance.
  */
-void kLdrRdrDone(PKLDRRDR pRdr)
-{
-    KLDRRDR_VALIDATE_VOID(pRdr);
+void kRdrDone(PKRDR pRdr)
+{
+    KRDR_VALIDATE_VOID(pRdr);
     pRdr->pOps->pfnDone(pRdr);
 }