Use the "new" LDT set call on Linux.
[wine] / library / loader.c
1 /*
2  * Win32 builtin dlls support
3  *
4  * Copyright 2000 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 #include "config.h"
22 #include "wine/port.h"
23
24 #include <assert.h>
25 #include <ctype.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <sys/types.h>
29 #include <unistd.h>
30 #ifdef HAVE_SYS_MMAN_H
31 #include <sys/mman.h>
32 #endif
33
34 #include "winnt.h"
35 #include "wine/library.h"
36
37 /* argc/argv for the Windows application */
38 int __wine_main_argc = 0;
39 char **__wine_main_argv = NULL;
40 WCHAR **__wine_main_wargv = NULL;
41
42 #define MAX_DLLS 100
43
44 static struct
45 {
46     const IMAGE_NT_HEADERS *nt;           /* NT header */
47     const char             *filename;     /* DLL file name */
48 } builtin_dlls[MAX_DLLS];
49
50 static int nb_dlls;
51
52 static const IMAGE_NT_HEADERS *main_exe;
53
54 static load_dll_callback_t load_dll_callback;
55
56 static const char **dll_paths;
57 static int nb_dll_paths;
58 static int dll_path_maxlen;
59 static int init_done;
60
61
62 /* build the dll load path from the WINEDLLPATH variable */
63 static void build_dll_path(void)
64 {
65     static const char * const dlldir = DLLDIR;
66     int len, count = 0;
67     char *p, *path = getenv( "WINEDLLPATH" );
68
69     init_done = 1;
70
71     if (path)
72     {
73         /* count how many path elements we need */
74         path = strdup(path);
75         p = path;
76         while (*p)
77         {
78             while (*p == ':') p++;
79             if (!*p) break;
80             count++;
81             while (*p && *p != ':') p++;
82         }
83     }
84
85     dll_paths = malloc( (count+1) * sizeof(*dll_paths) );
86
87     if (count)
88     {
89         p = path;
90         nb_dll_paths = 0;
91         while (*p)
92         {
93             while (*p == ':') *p++ = 0;
94             if (!*p) break;
95             dll_paths[nb_dll_paths] = p;
96             while (*p && *p != ':') p++;
97             if (p - dll_paths[nb_dll_paths] > dll_path_maxlen)
98                 dll_path_maxlen = p - dll_paths[nb_dll_paths];
99             nb_dll_paths++;
100         }
101     }
102
103     /* append default dll dir (if not empty) to path */
104     if ((len = strlen(dlldir)))
105     {
106         if (len > dll_path_maxlen) dll_path_maxlen = len;
107         dll_paths[nb_dll_paths++] = dlldir;
108     }
109 }
110
111 /* check if a given file can be opened */
112 inline static int file_exists( const char *name )
113 {
114     int fd = open( name, O_RDONLY );
115     if (fd != -1) close( fd );
116     return (fd != -1);
117 }
118
119 /* open a library for a given dll, searching in the dll path
120  * 'name' must be the Windows dll name (e.g. "kernel32.dll") */
121 static void *dlopen_dll( const char *name, char *error, int errorsize, int test_only )
122 {
123     int i, namelen = strlen(name);
124     char *buffer, *p;
125     void *ret = NULL;
126
127     if (!init_done) build_dll_path();
128
129     buffer = malloc( dll_path_maxlen + namelen + 5 );
130
131     /* store the name at the end of the buffer, followed by .so */
132     p = buffer + dll_path_maxlen;
133     *p++ = '/';
134     memcpy( p, name, namelen );
135     strcpy( p + namelen, ".so" );
136
137     for (i = 0; i < nb_dll_paths; i++)
138     {
139         int len = strlen(dll_paths[i]);
140         p = buffer + dll_path_maxlen - len;
141         memcpy( p, dll_paths[i], len );
142         if (test_only)  /* just test for file existence */
143         {
144             if ((ret = (void *)file_exists( p ))) break;
145         }
146         else
147         {
148             if ((ret = wine_dlopen( p, RTLD_NOW, error, errorsize ))) break;
149             if (file_exists( p )) break; /* exists but cannot be loaded, return the error */
150         }
151     }
152     free( buffer );
153     return ret;
154 }
155
156
157 /* adjust an array of pointers to make them into RVAs */
158 static inline void fixup_rva_ptrs( void *array, void *base, int count )
159 {
160     void **ptr = (void **)array;
161     while (count--)
162     {
163         if (*ptr) *ptr = (void *)((char *)*ptr - (char *)base);
164         ptr++;
165     }
166 }
167
168
169 /* fixup RVAs in the import directory */
170 static void fixup_imports( IMAGE_IMPORT_DESCRIPTOR *dir, DWORD size, void *base )
171 {
172     int count = size / sizeof(void *);
173     void **ptr = (void **)dir;
174
175     /* everything is either a pointer or a ordinal value below 0x10000 */
176     while (count--)
177     {
178         if (*ptr >= (void *)0x10000) *ptr = (void *)((char *)*ptr - (char *)base);
179         else if (*ptr) *ptr = (void *)(0x80000000 | (unsigned int)*ptr);
180         ptr++;
181     }
182 }
183
184
185 /* fixup RVAs in the resource directory */
186 static void fixup_resources( IMAGE_RESOURCE_DIRECTORY *dir, char *root, void *base )
187 {
188     IMAGE_RESOURCE_DIRECTORY_ENTRY *entry;
189     int i;
190
191     entry = (IMAGE_RESOURCE_DIRECTORY_ENTRY *)(dir + 1);
192     for (i = 0; i < dir->NumberOfNamedEntries + dir->NumberOfIdEntries; i++, entry++)
193     {
194         void *ptr = root + entry->u2.s3.OffsetToDirectory;
195         if (entry->u2.s3.DataIsDirectory) fixup_resources( ptr, root, base );
196         else
197         {
198             IMAGE_RESOURCE_DATA_ENTRY *data = ptr;
199             fixup_rva_ptrs( &data->OffsetToData, base, 1 );
200         }
201     }
202 }
203
204
205 /* map a builtin dll in memory and fixup RVAs */
206 static void *map_dll( const IMAGE_NT_HEADERS *nt_descr )
207 {
208 #ifdef HAVE_MMAP
209     IMAGE_DATA_DIRECTORY *dir;
210     IMAGE_DOS_HEADER *dos;
211     IMAGE_NT_HEADERS *nt;
212     IMAGE_SECTION_HEADER *sec;
213     BYTE *addr, *code_start, *data_start;
214     size_t page_size = getpagesize();
215     int nb_sections = 2;  /* code + data */
216
217     size_t size = (sizeof(IMAGE_DOS_HEADER)
218                    + sizeof(IMAGE_NT_HEADERS)
219                    + nb_sections * sizeof(IMAGE_SECTION_HEADER));
220
221     assert( size <= page_size );
222
223     /* module address must be aligned on 64K boundary */
224     addr = (BYTE *)((nt_descr->OptionalHeader.ImageBase + 0xffff) & ~0xffff);
225     if (wine_anon_mmap( addr, page_size, PROT_READ|PROT_WRITE, MAP_FIXED ) != addr) return NULL;
226
227     dos    = (IMAGE_DOS_HEADER *)addr;
228     nt     = (IMAGE_NT_HEADERS *)(dos + 1);
229     sec    = (IMAGE_SECTION_HEADER *)(nt + 1);
230     code_start = addr + page_size;
231
232     /* HACK! */
233     data_start = code_start + page_size;
234
235     /* Build the DOS and NT headers */
236
237     dos->e_magic  = IMAGE_DOS_SIGNATURE;
238     dos->e_lfanew = sizeof(*dos);
239
240     *nt = *nt_descr;
241
242     nt->FileHeader.NumberOfSections                = nb_sections;
243     nt->OptionalHeader.SizeOfCode                  = data_start - code_start;
244     nt->OptionalHeader.SizeOfInitializedData       = 0;
245     nt->OptionalHeader.SizeOfUninitializedData     = 0;
246     nt->OptionalHeader.ImageBase                   = (DWORD)addr;
247
248     fixup_rva_ptrs( &nt->OptionalHeader.AddressOfEntryPoint, addr, 1 );
249
250     /* Build the code section */
251
252     strcpy( sec->Name, ".text" );
253     sec->SizeOfRawData = data_start - code_start;
254     sec->Misc.VirtualSize = sec->SizeOfRawData;
255     sec->VirtualAddress   = code_start - addr;
256     sec->PointerToRawData = code_start - addr;
257     sec->Characteristics  = (IMAGE_SCN_CNT_CODE | IMAGE_SCN_MEM_EXECUTE | IMAGE_SCN_MEM_READ);
258     sec++;
259
260     /* Build the data section */
261
262     strcpy( sec->Name, ".data" );
263     sec->SizeOfRawData = 0;
264     sec->Misc.VirtualSize = sec->SizeOfRawData;
265     sec->VirtualAddress   = data_start - addr;
266     sec->PointerToRawData = data_start - addr;
267     sec->Characteristics  = (IMAGE_SCN_CNT_INITIALIZED_DATA |
268                              IMAGE_SCN_MEM_WRITE | IMAGE_SCN_MEM_READ);
269     sec++;
270
271     /* Build the import directory */
272
273     dir = &nt->OptionalHeader.DataDirectory[IMAGE_FILE_IMPORT_DIRECTORY];
274     if (dir->Size)
275     {
276         IMAGE_IMPORT_DESCRIPTOR *imports = (void *)dir->VirtualAddress;
277         fixup_rva_ptrs( &dir->VirtualAddress, addr, 1 );
278         fixup_imports( imports, dir->Size, addr );
279     }
280
281     /* Build the resource directory */
282
283     dir = &nt->OptionalHeader.DataDirectory[IMAGE_FILE_RESOURCE_DIRECTORY];
284     if (dir->Size)
285     {
286         void *ptr = (void *)dir->VirtualAddress;
287         fixup_rva_ptrs( &dir->VirtualAddress, addr, 1 );
288         fixup_resources( ptr, ptr, addr );
289     }
290
291     /* Build the export directory */
292
293     dir = &nt->OptionalHeader.DataDirectory[IMAGE_FILE_EXPORT_DIRECTORY];
294     if (dir->Size)
295     {
296         IMAGE_EXPORT_DIRECTORY *exports = (void *)dir->VirtualAddress;
297         fixup_rva_ptrs( &dir->VirtualAddress, addr, 1 );
298         fixup_rva_ptrs( (void *)exports->AddressOfFunctions, addr, exports->NumberOfFunctions );
299         fixup_rva_ptrs( (void *)exports->AddressOfNames, addr, exports->NumberOfNames );
300         fixup_rva_ptrs( &exports->Name, addr, 1 );
301         fixup_rva_ptrs( &exports->AddressOfFunctions, addr, 1 );
302         fixup_rva_ptrs( &exports->AddressOfNames, addr, 1 );
303         fixup_rva_ptrs( &exports->AddressOfNameOrdinals, addr, 1 );
304     }
305     return addr;
306 #else  /* HAVE_MMAP */
307     return NULL;
308 #endif  /* HAVE_MMAP */
309 }
310
311
312 /***********************************************************************
313  *           __wine_dll_register
314  *
315  * Register a built-in DLL descriptor.
316  */
317 void __wine_dll_register( const IMAGE_NT_HEADERS *header, const char *filename )
318 {
319     if (load_dll_callback) load_dll_callback( map_dll(header), filename );
320     else
321     {
322         if (!(header->FileHeader.Characteristics & IMAGE_FILE_DLL))
323             main_exe = header;
324         else
325         {
326             assert( nb_dlls < MAX_DLLS );
327             builtin_dlls[nb_dlls].nt = header;
328             builtin_dlls[nb_dlls].filename = filename;
329             nb_dlls++;
330         }
331     }
332 }
333
334
335 /***********************************************************************
336  *           wine_dll_set_callback
337  *
338  * Set the callback function for dll loading, and call it
339  * for all dlls that were implicitly loaded already.
340  */
341 void wine_dll_set_callback( load_dll_callback_t load )
342 {
343     int i;
344     load_dll_callback = load;
345     for (i = 0; i < nb_dlls; i++)
346     {
347         const IMAGE_NT_HEADERS *nt = builtin_dlls[i].nt;
348         if (!nt) continue;
349         builtin_dlls[i].nt = NULL;
350         load_dll_callback( map_dll(nt), builtin_dlls[i].filename );
351     }
352     nb_dlls = 0;
353     if (main_exe) load_dll_callback( map_dll(main_exe), "" );
354 }
355
356
357 /***********************************************************************
358  *           wine_dll_load
359  *
360  * Load a builtin dll.
361  */
362 void *wine_dll_load( const char *filename, char *error, int errorsize )
363 {
364     int i;
365
366     /* callback must have been set already */
367     assert( load_dll_callback );
368
369     /* check if we have it in the list */
370     /* this can happen when initializing pre-loaded dlls in wine_dll_set_callback */
371     for (i = 0; i < nb_dlls; i++)
372     {
373         if (!builtin_dlls[i].nt) continue;
374         if (!strcmp( builtin_dlls[i].filename, filename ))
375         {
376             const IMAGE_NT_HEADERS *nt = builtin_dlls[i].nt;
377             builtin_dlls[i].nt = NULL;
378             load_dll_callback( map_dll(nt), builtin_dlls[i].filename );
379             return (void *)1;
380         }
381     }
382     return dlopen_dll( filename, error, errorsize, 0 );
383 }
384
385
386 /***********************************************************************
387  *           wine_dll_unload
388  *
389  * Unload a builtin dll.
390  */
391 void wine_dll_unload( void *handle )
392 {
393     if (handle != (void *)1)
394         wine_dlclose( handle, NULL, 0 );
395 }
396
397
398 /***********************************************************************
399  *           wine_dll_load_main_exe
400  *
401  * Try to load the .so for the main exe.
402  */
403 void *wine_dll_load_main_exe( const char *name, char *error, int errorsize, int test_only )
404 {
405     return dlopen_dll( name, error, errorsize, test_only );
406 }