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 "windef.h"
  25 #include "winbase.h"
  26 #include "wine/windef16.h"
  27 #include "wine/winbase16.h"
  28
  29   /* In-memory module structure. See 'Windows Internals' p. 219 */
  30 typedef struct _NE_MODULE
  31 {
  32     WORD    magic;            /* 00 'NE' signature */
  33     WORD    count;            /* 02 Usage count */
  34     WORD    entry_table;      /* 04 Near ptr to entry table */
  35     HMODULE16  next;          /* 06 Selector to next module */
  36     WORD    dgroup_entry;     /* 08 Near ptr to segment entry for DGROUP */
  37     WORD    fileinfo;         /* 0a Near ptr to file info (OFSTRUCT) */
  38     WORD    flags;            /* 0c Module flags */
  39     WORD    dgroup;           /* 0e Logical segment for DGROUP */
  40     WORD    heap_size;        /* 10 Initial heap size */
  41     WORD    stack_size;       /* 12 Initial stack size */
  42     WORD    ip;               /* 14 Initial ip */
  43     WORD    cs;               /* 16 Initial cs (logical segment) */
  44     WORD    sp;               /* 18 Initial stack pointer */
  45     WORD    ss;               /* 1a Initial ss (logical segment) */
  46     WORD    seg_count;        /* 1c Number of segments in segment table */
  47     WORD    modref_count;     /* 1e Number of module references */
  48     WORD    nrname_size;      /* 20 Size of non-resident names table */
  49     WORD    seg_table;        /* 22 Near ptr to segment table */
  50     WORD    res_table;        /* 24 Near ptr to resource table */
  51     WORD    name_table;       /* 26 Near ptr to resident names table */
  52     WORD    modref_table;     /* 28 Near ptr to module reference table */
  53     WORD    import_table;     /* 2a Near ptr to imported names table */
  54     DWORD   nrname_fpos;      /* 2c File offset of non-resident names table */
  55     WORD    moveable_entries; /* 30 Number of moveable entries in entry table*/
  56     WORD    alignment;        /* 32 Alignment shift count */
  57     WORD    truetype;         /* 34 Set to 2 if TrueType font */
  58     BYTE    os_flags;         /* 36 Operating system flags */
  59     BYTE    misc_flags;       /* 37 Misc. flags */
  60     HANDLE16   dlls_to_init;  /* 38 List of DLLs to initialize */
  61     HANDLE16   nrname_handle; /* 3a Handle to non-resident name table */
  62     WORD    min_swap_area;    /* 3c Min. swap area size */
  63     WORD    expected_version; /* 3e Expected Windows version */
  64     /* From here, these are extra fields not present in normal Windows */
  65     HMODULE  module32;      /* 40 PE module handle for Win32 modules */
  66     HMODULE16  self;          /* 44 Handle for this module */
  67     WORD    self_loading_sel; /* 46 Selector used for self-loading apps. */
  68     LPVOID  hRsrcMap;         /* HRSRC 16->32 map (for 32-bit modules) */
  69 } NE_MODULE;
  70
  71
  72 typedef struct {
  73     BYTE type;
  74     BYTE flags;
  75     BYTE segnum;
  76     WORD offs WINE_PACKED;
  77 } ET_ENTRY;
  78
  79 typedef struct {
  80     WORD first; /* ordinal */
  81     WORD last; /* ordinal */
  82     WORD next; /* bundle */
  83 } ET_BUNDLE;
  84
  85
  86   /* In-memory segment table */
  87 typedef struct
  88 {
  89     WORD      filepos;   /* Position in file, in sectors */
  90     WORD      size;      /* Segment size on disk */
  91     WORD      flags;     /* Segment flags */
  92     WORD      minsize;   /* Min. size of segment in memory */
  93     HANDLE16  hSeg;      /* Selector or handle (selector - 1) */
  94                          /* of segment in memory */
  95 } SEGTABLEENTRY;
  96
  97
  98   /* Self-loading modules contain this structure in their first segment */
  99
 100 #include "pshpack1.h"
 101
 102 typedef struct
 103 {
 104     WORD      version;       /* Must be "A0" (0x3041) */
 105     WORD      reserved;
 106     FARPROC16 BootApp;       /* startup procedure */
 107     FARPROC16 LoadAppSeg;    /* procedure to load a segment */
 108     FARPROC16 reserved2;
 109     FARPROC16 MyAlloc;       /* memory allocation procedure,
 110                               * wine must write this field */
 111     FARPROC16 EntryAddrProc;
 112     FARPROC16 ExitProc;      /* exit procedure */
 113     WORD      reserved3[4];
 114     FARPROC16 SetOwner;      /* Set Owner procedure, exported by wine */
 115 } SELFLOADHEADER;
 116
 117 typedef struct
 118 {
 119     LPSTR lpEnvAddress;
 120     LPSTR lpCmdLine;
 121     UINT16 *lpCmdShow;
 122     DWORD dwReserved;
 123 } LOADPARAMS;
 124
 125 #include "poppack.h"
 126
 127 /* internal representation of 32bit modules. per process. */
 128 typedef struct _wine_modref
 129 {
 130         struct _wine_modref *next;
 131         struct _wine_modref *prev;
 132         HMODULE              module;
 133         HMODULE16            hDummyMod; /* Win16 dummy module */
 134         void                *dlhandle;  /* handle returned by dlopen() */
 135         int                  tlsindex;  /* TLS index or -1 if none */
 136
 137         FARPROC            (*find_export)( struct _wine_modref *wm, LPCSTR func, BOOL snoop );
 138
 139         int                     nDeps;
 140         struct _wine_modref     **deps;
 141
 142         int                     flags;
 143         int                     refCount;
 144
 145         char                    *filename;
 146         char                    *modname;
 147         char                    *short_filename;
 148         char                    *short_modname;
 149
 150     char data[1];  /* space for storing filename and short_filename */
 151 } WINE_MODREF;
 152
 153 #define WINE_MODREF_INTERNAL              0x00000001
 154 #define WINE_MODREF_NO_DLL_CALLS          0x00000002
 155 #define WINE_MODREF_PROCESS_ATTACHED      0x00000004
 156 #define WINE_MODREF_DONT_RESOLVE_REFS     0x00000020
 157 #define WINE_MODREF_MARKER                0x80000000
 158
 159 extern WINE_MODREF *MODULE_modref_list;
 160
 161 /* Resource types */
 162
 163 #define NE_SEG_TABLE(pModule) \
 164     ((SEGTABLEENTRY *)((char *)(pModule) + (pModule)->seg_table))
 165
 166 #define NE_MODULE_TABLE(pModule) \
 167     ((WORD *)((char *)(pModule) + (pModule)->modref_table))
 168
 169 #define NE_MODULE_NAME(pModule) \
 170     (((OFSTRUCT *)((char*)(pModule) + (pModule)->fileinfo))->szPathName)
 171
 172 #define PE_HEADER(module) \
 173     ((IMAGE_NT_HEADERS*)((LPBYTE)(module) + \
 174                          (((IMAGE_DOS_HEADER*)(module))->e_lfanew)))
 175
 176 #define PE_SECTIONS(module) \
 177     ((IMAGE_SECTION_HEADER*)((LPBYTE)&PE_HEADER(module)->OptionalHeader + \
 178                            PE_HEADER(module)->FileHeader.SizeOfOptionalHeader))
 179
 180 enum loadorder_type
 181 {
 182     LOADORDER_INVALID = 0, /* Must be 0 */
 183     LOADORDER_DLL,         /* Native DLLs */
 184     LOADORDER_SO,          /* Native .so libraries */
 185     LOADORDER_BI,          /* Built-in modules */
 186     LOADORDER_NTYPES
 187 };
 188
 189 /* module.c */
 190 extern WINE_MODREF *MODULE_AllocModRef( HMODULE hModule, LPCSTR filename );
 191 extern FARPROC MODULE_GetProcAddress( HMODULE hModule, LPCSTR function, BOOL snoop );
 192 extern BOOL MODULE_DllProcessAttach( WINE_MODREF *wm, LPVOID lpReserved );
 193 extern void MODULE_DllProcessDetach( BOOL bForceDetach, LPVOID lpReserved );
 194 extern void MODULE_DllThreadAttach( LPVOID lpReserved );
 195 extern void MODULE_DllThreadDetach( LPVOID lpReserved );
 196 extern WINE_MODREF *MODULE_LoadLibraryExA( LPCSTR libname, HFILE hfile, DWORD flags );
 197 extern BOOL MODULE_FreeLibrary( WINE_MODREF *wm );
 198 extern WINE_MODREF *MODULE_FindModule( LPCSTR path );
 199 extern HMODULE16 MODULE_CreateDummyModule( LPCSTR filename, HMODULE module32 );
 200 extern FARPROC16 WINAPI WIN32_GetProcAddress16( HMODULE hmodule, LPCSTR name );
 201 extern SEGPTR WINAPI HasGPHandler16( SEGPTR address );
 202 extern void MODULE_WalkModref( DWORD id );
 203
 204 /* loader/ne/module.c */
 205 extern NE_MODULE *NE_GetPtr( HMODULE16 hModule );
 206 extern void NE_DumpModule( HMODULE16 hModule );
 207 extern void NE_WalkModules(void);
 208 extern void NE_RegisterModule( NE_MODULE *pModule );
 209 extern WORD NE_GetOrdinal( HMODULE16 hModule, const char *name );
 210 extern FARPROC16 WINAPI NE_GetEntryPoint( HMODULE16 hModule, WORD ordinal );
 211 extern FARPROC16 NE_GetEntryPointEx( HMODULE16 hModule, WORD ordinal, BOOL16 snoop );
 212 extern BOOL16 NE_SetEntryPoint( HMODULE16 hModule, WORD ordinal, WORD offset );
 213 extern HANDLE NE_OpenFile( NE_MODULE *pModule );
 214 extern DWORD NE_StartTask(void);
 215
 216 /* loader/ne/resource.c */
 217 extern HGLOBAL16 WINAPI NE_DefResourceHandler(HGLOBAL16,HMODULE16,HRSRC16);
 218 extern BOOL NE_InitResourceHandler( HMODULE16 hModule );
 219 extern HRSRC16 NE_FindResource( NE_MODULE *pModule, LPCSTR name, LPCSTR type );
 220 extern DWORD NE_SizeofResource( NE_MODULE *pModule, HRSRC16 hRsrc );
 221 extern HGLOBAL16 NE_LoadResource( NE_MODULE *pModule, HRSRC16 hRsrc );
 222 extern BOOL16 NE_FreeResource( NE_MODULE *pModule, HGLOBAL16 handle );
 223 extern NE_TYPEINFO *NE_FindTypeSection( LPBYTE pResTab, NE_TYPEINFO *pTypeInfo, LPCSTR typeId );
 224 extern NE_NAMEINFO *NE_FindResourceFromType( LPBYTE pResTab, NE_TYPEINFO *pTypeInfo, LPCSTR resId );
 225
 226 /* loader/ne/segment.c */
 227 extern BOOL NE_LoadSegment( NE_MODULE *pModule, WORD segnum );
 228 extern BOOL NE_LoadAllSegments( NE_MODULE *pModule );
 229 extern BOOL NE_CreateSegment( NE_MODULE *pModule, int segnum );
 230 extern BOOL NE_CreateAllSegments( NE_MODULE *pModule );
 231 extern HINSTANCE16 NE_GetInstance( NE_MODULE *pModule );
 232 extern void NE_InitializeDLLs( HMODULE16 hModule );
 233 extern void NE_DllProcessAttach( HMODULE16 hModule );
 234
 235 /* loader/ne/convert.c */
 236 HGLOBAL16 NE_LoadPEResource( NE_MODULE *pModule, WORD type, LPVOID bits, DWORD size );
 237
 238 /* loader/pe_resource.c */
 239 extern HRSRC PE_FindResourceW(HMODULE,LPCWSTR,LPCWSTR);
 240 extern HRSRC PE_FindResourceExW(HMODULE,LPCWSTR,LPCWSTR,WORD);
 241 extern DWORD PE_SizeofResource(HRSRC);
 242 extern HGLOBAL PE_LoadResource(HMODULE,HRSRC);
 243
 244 /* loader/pe_image.c */
 245 extern WINE_MODREF *PE_LoadLibraryExA(LPCSTR, DWORD);
 246 extern HMODULE PE_LoadImage( HANDLE hFile, LPCSTR filename, DWORD flags );
 247 extern WINE_MODREF *PE_CreateModule( HMODULE hModule, LPCSTR filename,
 248                                      DWORD flags, HANDLE hFile, BOOL builtin );
 249 extern void PE_InitTls(void);
 250 extern BOOL PE_InitDLL( HMODULE module, DWORD type, LPVOID lpReserved );
 251 extern DWORD PE_fixup_imports(WINE_MODREF *wm);
 252
 253 /* loader/loadorder.c */
 254 extern void MODULE_InitLoadOrder(void);
 255 extern void MODULE_GetLoadOrder( enum loadorder_type plo[], const char *path, BOOL win32 );
 256 extern void MODULE_AddLoadOrderOption( const char *option );
 257
 258 /* loader/elf.c */
 259 extern WINE_MODREF *ELF_LoadLibraryExA( LPCSTR libname, DWORD flags);
 260
 261 /* relay32/builtin.c */
 262 extern WINE_MODREF *BUILTIN32_LoadLibraryExA(LPCSTR name, DWORD flags);
 263 extern HMODULE BUILTIN32_LoadExeModule( HMODULE main );
 264 extern void *BUILTIN32_dlopen( const char *name );
 265 extern int BUILTIN32_dlclose( void *handle );
 266
 267 /* USER signal proc flags and codes */
 268 /* See PROCESS_CallUserSignalProc for comments */
 269 #define USIG_FLAGS_WIN32          0x0001
 270 #define USIG_FLAGS_GUI            0x0002
 271 #define USIG_FLAGS_FEEDBACK       0x0004
 272 #define USIG_FLAGS_FAULT          0x0008
 273
 274 #define USIG_DLL_UNLOAD_WIN16     0x0001
 275 #define USIG_DLL_UNLOAD_WIN32     0x0002
 276 #define USIG_FAULT_DIALOG_PUSH    0x0003
 277 #define USIG_FAULT_DIALOG_POP     0x0004
 278 #define USIG_DLL_UNLOAD_ORPHANS   0x0005
 279 #define USIG_THREAD_INIT          0x0010
 280 #define USIG_THREAD_EXIT          0x0020
 281 #define USIG_PROCESS_CREATE       0x0100
 282 #define USIG_PROCESS_INIT         0x0200
 283 #define USIG_PROCESS_EXIT         0x0300
 284 #define USIG_PROCESS_DESTROY      0x0400
 285 #define USIG_PROCESS_RUNNING      0x0500
 286 #define USIG_PROCESS_LOADED       0x0600
 287
 288 /* scheduler/process.c */
 289 extern void PROCESS_CallUserSignalProc( UINT uCode, HMODULE16 hModule );
 290 extern BOOL PROCESS_Create( HANDLE hFile, LPCSTR filename, LPSTR cmd_line, LPCSTR env,
 291                             LPSECURITY_ATTRIBUTES psa, LPSECURITY_ATTRIBUTES tsa,
 292                             BOOL inherit, DWORD flags,
 293                             STARTUPINFOA *startup, PROCESS_INFORMATION *info,
 294                             LPCSTR lpCurrentDirectory );
 295
 296 #endif  /* __WINE_MODULE_H */