Changeset 2829 for trunk/kLdr/kLdr.h

Timestamp:

Oct 23, 2006, 7:04:04 PM (19 years ago)

Author:

bird

Message:

Mapping prototypes.

File:

• trunk/kLdr/kLdr.h (modified) (3 diffs)

trunk/kLdr/kLdr.h

@@ -53 +53 @@
  * @{ */
 
+typedef enum KLDRPROT
+{
+    /** The usual invalid 0. */
+    KLDRPROT_INVALID = 0,
+    /** No access (page not present). */
+    KLDRPROT_NOACCESS,
+    /** Read only. */
+    KLDRPROT_READONLY,
+    /** Read & write. */
+    KLDRPROT_READWRITE,
+    /** Read & copy on write. */
+    KLDRPROT_WRITECOPY,
+    /** Execute only. */
+    KLDRPROT_EXECUTE,
+    /** Execute & read. */
+    KLDRPROT_EXECUTE_READONLY,
+    /** Execute, read & write. */
+    KLDRPROT_EXECUTE_READWRITE,
+    /** Execute, read & copy on write. */
+    KLDRPROT_EXECUTE_WRITECOPY,
+    /** The usual end value. (exclusive) */
+    KLDRPROT_END,
+    /** Blow the type up to 32-bits. */
+    KLDRPROT_32BIT_HACK = 0x7fffffff
+} KLDRPROT;
+
+
 /** Pointer to a file provider instance core. */
 typedef struct KLDRRDR *PKLDRRDR;
@@ -106 +133 @@
      */
     int     (* pfnAllUnmap)(PKLDRRDR pRdr, const void *pvBits);
-/** @todo generic mmap/MapViewOfFile */
     /** Get the file size.
      *
@@ -125 +151 @@
      */
     const char * (* pfnName)(PKLDRRDR 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     (* pfnPrepare)(PKLDRRDR pRdr, void **ppv, size_t cb, unsigned 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     (* pfnMap)(PKLDRRDR pRdr, void *pv, size_t cb, KLDRPROT enmProt, off_t offFile, size_t 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     (* pfnProtect)(PKLDRRDR pRdr, void *pv, size_t cb, KLDRPROT 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     (* pfnUnmap)(PKLDRRDR pRdr, void *pv, size_t 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     (* pfnUnprepare)(PKLDRRDR pRdr, void *pv, size_t 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    (* pfnDone)(PKLDRRDR pRdr);
+    /** The usual non-zero dummy that makes sure we've initialized all members. */
+    uint32_t u32Dummy;
 } KLDRRDROPS;
 /** Pointer to file provider operations. */