include/module.h

   1 /*
   2  * Module definitions
   3  *
   4  * Copyright 1995 Alexandre Julliard
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #ifndef __WINE_MODULE_H
  22 #define __WINE_MODULE_H
  23
  24 #include <stdarg.h>
  25 #include <windef.h>
  26 #include <winbase.h>
  27 #include <winreg.h>
  28 #include <wine/windef16.h>
  29 #include <wine/winbase16.h>
  30 #include <winternl.h>
  31
  32   /* In-memory module structure. See 'Windows Internals' p. 219 */
  33 typedef struct _NE_MODULE
  34 {
  35     WORD    magic;            /* 00 'NE' signature */
  36     WORD    count;            /* 02 Usage count */
  37     WORD    entry_table;      /* 04 Near ptr to entry table */
  38     HMODULE16  next;          /* 06 Selector to next module */
  39     WORD    dgroup_entry;     /* 08 Near ptr to segment entry for DGROUP */
  40     WORD    fileinfo;         /* 0a Near ptr to file info (OFSTRUCT) */
  41     WORD    flags;            /* 0c Module flags */
  42     WORD    dgroup;           /* 0e Logical segment for DGROUP */
  43     WORD    heap_size;        /* 10 Initial heap size */
  44     WORD    stack_size;       /* 12 Initial stack size */
  45     WORD    ip;               /* 14 Initial ip */
  46     WORD    cs;               /* 16 Initial cs (logical segment) */
  47     WORD    sp;               /* 18 Initial stack pointer */
  48     WORD    ss;               /* 1a Initial ss (logical segment) */
  49     WORD    seg_count;        /* 1c Number of segments in segment table */
  50     WORD    modref_count;     /* 1e Number of module references */
  51     WORD    nrname_size;      /* 20 Size of non-resident names table */
  52     WORD    seg_table;        /* 22 Near ptr to segment table */
  53     WORD    res_table;        /* 24 Near ptr to resource table */
  54     WORD    name_table;       /* 26 Near ptr to resident names table */
  55     WORD    modref_table;     /* 28 Near ptr to module reference table */
  56     WORD    import_table;     /* 2a Near ptr to imported names table */
  57     DWORD   nrname_fpos;      /* 2c File offset of non-resident names table */
  58     WORD    moveable_entries; /* 30 Number of moveable entries in entry table*/
  59     WORD    alignment;        /* 32 Alignment shift count */
  60     WORD    truetype;         /* 34 Set to 2 if TrueType font */
  61     BYTE    os_flags;         /* 36 Operating system flags */
  62     BYTE    misc_flags;       /* 37 Misc. flags */
  63     HANDLE16   dlls_to_init;  /* 38 List of DLLs to initialize */
  64     HANDLE16   nrname_handle; /* 3a Handle to non-resident name table */
  65     WORD    min_swap_area;    /* 3c Min. swap area size */
  66     WORD    expected_version; /* 3e Expected Windows version */
  67     /* From here, these are extra fields not present in normal Windows */
  68     HMODULE  module32;      /* 40 PE module handle for Win32 modules */
  69     HMODULE16  self;          /* 44 Handle for this module */
  70     WORD    self_loading_sel; /* 46 Selector used for self-loading apps. */
  71     LPVOID  hRsrcMap;         /* HRSRC 16->32 map (for 32-bit modules) */
  72     HANDLE  fd;               /* handle to the binary file */
  73 } NE_MODULE;
  74
  75
  76 typedef struct {
  77     BYTE type;
  78     BYTE flags;
  79     BYTE segnum;
  80     WORD offs WINE_PACKED;
  81 } ET_ENTRY;
  82
  83 typedef struct {
  84     WORD first; /* ordinal */
  85     WORD last; /* ordinal */
  86     WORD next; /* bundle */
  87 } ET_BUNDLE;
  88
  89
  90   /* In-memory segment table */
  91 typedef struct
  92 {
  93     WORD      filepos;   /* Position in file, in sectors */
  94     WORD      size;      /* Segment size on disk */
  95     WORD      flags;     /* Segment flags */
  96     WORD      minsize;   /* Min. size of segment in memory */
  97     HANDLE16  hSeg;      /* Selector or handle (selector - 1) */
  98                          /* of segment in memory */
  99 } SEGTABLEENTRY;
 100
 101
 102   /* Self-loading modules contain this structure in their first segment */
 103
 104 #include <pshpack1.h>
 105
 106 typedef struct
 107 {
 108     WORD      version;       /* Must be "A0" (0x3041) */
 109     WORD      reserved;
 110     FARPROC16 BootApp;       /* startup procedure */
 111     FARPROC16 LoadAppSeg;    /* procedure to load a segment */
 112     FARPROC16 reserved2;
 113     FARPROC16 MyAlloc;       /* memory allocation procedure,
 114                               * wine must write this field */
 115     FARPROC16 EntryAddrProc;
 116     FARPROC16 ExitProc;      /* exit procedure */
 117     WORD      reserved3[4];
 118     FARPROC16 SetOwner;      /* Set Owner procedure, exported by wine */
 119 } SELFLOADHEADER;
 120
 121 typedef struct
 122 {
 123     LPSTR lpEnvAddress;
 124     LPSTR lpCmdLine;
 125     UINT16 *lpCmdShow;
 126     DWORD dwReserved;
 127 } LOADPARAMS;
 128
 129 #include <poppack.h>
 130
 131 /* internal representation of 32bit modules. per process. */
 132 typedef struct _wine_modref
 133 {
 134         void                *dlhandle;  /* handle returned by dlopen() */
 135         LDR_MODULE           ldr;
 136
 137         int                     nDeps;
 138         struct _wine_modref     **deps;
 139
 140         char                    *filename;
 141         char                    *modname;
 142         char                    *short_filename;
 143         char                    *short_modname;
 144
 145     char data[1];  /* space for storing filename and short_filename */
 146 } WINE_MODREF;
 147
 148 /* Resource types */
 149
 150 #define NE_SEG_TABLE(pModule) \
 151     ((SEGTABLEENTRY *)((char *)(pModule) + (pModule)->seg_table))
 152
 153 #define NE_MODULE_TABLE(pModule) \
 154     ((WORD *)((char *)(pModule) + (pModule)->modref_table))
 155
 156 #define NE_MODULE_NAME(pModule) \
 157     (((OFSTRUCT *)((char*)(pModule) + (pModule)->fileinfo))->szPathName)
 158
 159
 160 enum loadorder_type
 161 {
 162     LOADORDER_INVALID = 0, /* Must be 0 */
 163     LOADORDER_DLL,         /* Native DLLs */
 164     LOADORDER_BI,          /* Built-in modules */
 165     LOADORDER_NTYPES
 166 };
 167
 168 /* return values for MODULE_GetBinaryType */
 169 enum binary_type
 170 {
 171     BINARY_UNKNOWN,
 172     BINARY_PE_EXE,
 173     BINARY_PE_DLL,
 174     BINARY_WIN16,
 175     BINARY_OS216,
 176     BINARY_DOS,
 177     BINARY_UNIX_EXE,
 178     BINARY_UNIX_LIB
 179 };
 180
 181 /* module.c */
 182 extern NTSTATUS MODULE_DllProcessAttach( WINE_MODREF *wm, LPVOID lpReserved );
 183 extern NTSTATUS MODULE_DllThreadAttach( LPVOID lpReserved );
 184 extern enum binary_type MODULE_GetBinaryType( HANDLE hfile );
 185 extern FARPROC16 WINAPI WIN32_GetProcAddress16( HMODULE hmodule, LPCSTR name );
 186 extern void MODULE_WalkModref( DWORD id );
 187
 188 /* loader/ne/module.c */
 189 extern NE_MODULE *NE_GetPtr( HMODULE16 hModule );
 190 extern void NE_DumpModule( HMODULE16 hModule );
 191 extern void NE_WalkModules(void);
 192 extern void NE_InitResourceHandler( NE_MODULE *pModule );
 193 extern void NE_RegisterModule( NE_MODULE *pModule );
 194 extern WORD NE_GetOrdinal( HMODULE16 hModule, const char *name );
 195 extern FARPROC16 WINAPI NE_GetEntryPoint( HMODULE16 hModule, WORD ordinal );
 196 extern FARPROC16 NE_GetEntryPointEx( HMODULE16 hModule, WORD ordinal, BOOL16 snoop );
 197 extern BOOL16 NE_SetEntryPoint( HMODULE16 hModule, WORD ordinal, WORD offset );
 198 extern HANDLE NE_OpenFile( NE_MODULE *pModule );
 199 extern DWORD NE_StartTask(void);
 200
 201 /* loader/ne/resource.c */
 202 extern HGLOBAL16 WINAPI NE_DefResourceHandler(HGLOBAL16,HMODULE16,HRSRC16);
 203
 204 /* loader/ne/segment.c */
 205 extern BOOL NE_LoadSegment( NE_MODULE *pModule, WORD segnum );
 206 extern BOOL NE_LoadAllSegments( NE_MODULE *pModule );
 207 extern BOOL NE_CreateSegment( NE_MODULE *pModule, int segnum );
 208 extern BOOL NE_CreateAllSegments( NE_MODULE *pModule );
 209 extern HINSTANCE16 NE_GetInstance( NE_MODULE *pModule );
 210 extern void NE_InitializeDLLs( HMODULE16 hModule );
 211 extern void NE_DllProcessAttach( HMODULE16 hModule );
 212 extern void NE_CallUserSignalProc( HMODULE16 hModule, UINT16 code );
 213
 214 /* loader/pe_resource.c */
 215 extern HRSRC PE_FindResourceW(HMODULE,LPCWSTR,LPCWSTR);
 216 extern HRSRC PE_FindResourceExW(HMODULE,LPCWSTR,LPCWSTR,WORD);
 217
 218 /* loader/loadorder.c */
 219 extern BOOL MODULE_GetBuiltinPath( const char *libname, const char *ext, char *filename, UINT size );
 220 extern void MODULE_GetLoadOrder( enum loadorder_type plo[], const char *path, BOOL win32 );
 221 extern void MODULE_AddLoadOrderOption( const char *option );
 222
 223 /* relay32/builtin.c */
 224 extern HMODULE BUILTIN32_LoadExeModule( HMODULE main );
 225
 226 #endif  /* __WINE_MODULE_H */