OSModule.h

Go to the documentation of this file.

#ifndef _DOLPHIN_OSMODULE_H_
#define _DOLPHIN_OSMODULE_H_
 
#include <dolphin/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define OS_MODULE_VERSION 3
typedef struct OSModuleHeader OSModuleHeader;
 
typedef u32 OSModuleID;
typedef struct OSModuleQueue OSModuleQueue;
typedef struct OSModuleLink OSModuleLink;
typedef struct OSModuleInfo OSModuleInfo;
typedef struct OSSectionInfo OSSectionInfo;
typedef struct OSImportInfo OSImportInfo;
typedef struct OSRel OSRel;
 
struct OSModuleQueue {
    OSModuleInfo* head;
    OSModuleInfo* tail;
};
struct OSModuleQueue {…};
 
struct OSModuleLink {
    OSModuleInfo* next;
    OSModuleInfo* prev;
};
struct OSModuleLink {…};
 
struct OSModuleInfo {
    OSModuleID id;         // unique identifier for the module
    OSModuleLink link;     // doubly linked list of modules
    u32 numSections;       // # of sections
    u32 sectionInfoOffset; // offset to section info table
    u32 nameOffset;        // offset to module name
    u32 nameSize;          // size of module name
    u32 version;           // version number
};
struct OSModuleInfo {…};
 
struct OSModuleHeader {
    // CAUTION: info must be the 1st member
    OSModuleInfo info;
 
    // OS_MODULE_VERSION == 1
    u32 bssSize; // total size of bss sections in bytes
    u32 relOffset;
    u32 impOffset;
    u32 impSize;          // size in bytes
    u8 prologSection;     // section # for prolog function
    u8 epilogSection;     // section # for epilog function
    u8 unresolvedSection; // section # for unresolved function
    u8 bssSection;        // section # for bss section (set at run-time)
    u32 prolog;           // prolog function offset
    u32 epilog;           // epilog function offset
    u32 unresolved;       // unresolved function offset
 
    // OS_MODULE_VERSION == 2
#if (2 <= OS_MODULE_VERSION)
    u32 align;    // module alignment constraint
    u32 bssAlign; // bss alignment constraint
#endif
 
    // OS_MODULE_VERSION == 3
#if (3 <= OS_MODULE_VERSION)
    u32 fixSize;
#endif
};
struct OSModuleHeader {…};
 
#define OSGetSectionInfo(module) ((OSSectionInfo*)(((OSModuleInfo*)(module))->sectionInfoOffset))
 
struct OSSectionInfo {
    u32 offset;
    u32 size;
};
struct OSSectionInfo {…};
 
// OSSectionInfo.offset bit
#define OS_SECTIONINFO_EXEC 0x1
#define OS_SECTIONINFO_OFFSET(offset) ((offset) & ~0x1)
 
struct OSImportInfo {
    OSModuleID id; // external module id
    u32 offset;    // offset to OSRel instructions
};
struct OSImportInfo {…};
 
struct OSRel {
    u16 offset; // byte offset from the previous entry
    u8 type;
    u8 section;
    u32 addend;
};
struct OSRel {…};
 
#define R_DOLPHIN_NOP 201     //  C9h current offset += OSRel.offset
#define R_DOLPHIN_SECTION 202 //  CAh current section = OSRel.section
#define R_DOLPHIN_END 203     //  CBh
#define R_DOLPHIN_MRKREF 204  //  CCh
 
void OSSetStringTable(void* stringTable);
BOOL OSLink(OSModuleInfo* newModule, void* bss);
 
#if (3 <= OS_MODULE_VERSION)
BOOL OSLinkFixed(OSModuleInfo* newModule, void* bss);
#endif
 
BOOL OSUnlink(OSModuleInfo* oldModule);
 
OSModuleInfo* OSSearchModule(void* ptr, u32* section, u32* offset);
 
// debugger notification
void OSNotifyLink(OSModuleInfo* module);
void OSNotifyUnlink(OSModuleInfo* module);
 
#ifdef __cplusplus
}
#endif
 
#endif