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