2 * Win32 builtin dlls support
4 * Copyright 2000 Alexandre Julliard
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.
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.
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 #include "wine/port.h"
31 #include <sys/types.h>
32 #ifdef HAVE_SYS_MMAN_H
35 #ifdef HAVE_SYS_RESOURCE_H
36 # include <sys/resource.h>
42 #define NONAMELESSUNION
43 #define NONAMELESSSTRUCT
46 #include "wine/library.h"
49 #include <crt_externs.h>
50 #define environ (*_NSGetEnviron())
52 extern char **environ;
55 /* argc/argv for the Windows application */
56 int __wine_main_argc = 0;
57 char **__wine_main_argv = NULL;
58 WCHAR **__wine_main_wargv = NULL;
59 char **__wine_main_environ = NULL;
61 struct dll_path_context
63 unsigned int index; /* current index in the dll path list */
64 char *buffer; /* buffer used for storing path names */
65 char *name; /* start of file name part in buffer (including leading slash) */
66 int namelen; /* length of file name without .so extension */
67 int win16; /* 16-bit dll search */
74 const IMAGE_NT_HEADERS *nt; /* NT header */
75 const char *filename; /* DLL file name */
76 } builtin_dlls[MAX_DLLS];
80 static const IMAGE_NT_HEADERS *main_exe;
82 static load_dll_callback_t load_dll_callback;
84 static const char *build_dir;
85 static const char *default_dlldir;
86 static const char **dll_paths;
87 static unsigned int nb_dll_paths;
88 static int dll_path_maxlen;
90 extern void mmap_init(void);
91 extern const char *get_dlldir( const char **default_dlldir );
93 /* build the dll load path from the WINEDLLPATH variable */
94 static void build_dll_path(void)
97 char *p, *path = getenv( "WINEDLLPATH" );
98 const char *dlldir = get_dlldir( &default_dlldir );
102 /* count how many path elements we need */
107 while (*p == ':') p++;
110 while (*p && *p != ':') p++;
114 dll_paths = malloc( (count+2) * sizeof(*dll_paths) );
119 dll_path_maxlen = strlen(dlldir);
120 dll_paths[nb_dll_paths++] = dlldir;
122 else if ((build_dir = wine_get_build_dir()))
124 dll_path_maxlen = strlen(build_dir) + sizeof("/programs");
132 while (*p == ':') *p++ = 0;
134 dll_paths[nb_dll_paths] = p;
135 while (*p && *p != ':') p++;
136 if (p - dll_paths[nb_dll_paths] > dll_path_maxlen)
137 dll_path_maxlen = p - dll_paths[nb_dll_paths];
142 /* append default dll dir (if not empty) to path */
143 if ((len = strlen(default_dlldir)) > 0)
145 if (len > dll_path_maxlen) dll_path_maxlen = len;
146 dll_paths[nb_dll_paths++] = default_dlldir;
150 /* check if the library is the correct architecture */
151 /* only returns false for a valid library of the wrong arch */
152 static int check_library_arch( int fd )
155 struct /* Mach-O header */
158 unsigned int cputype;
161 if (read( fd, &header, sizeof(header) ) != sizeof(header)) return 1;
162 if (header.magic != 0xfeedface) return 1;
163 if (sizeof(void *) == sizeof(int)) return !(header.cputype >> 24);
164 else return (header.cputype >> 24) == 1; /* CPU_ARCH_ABI64 */
166 struct /* ELF header */
168 unsigned char magic[4];
171 unsigned char version;
174 if (read( fd, &header, sizeof(header) ) != sizeof(header)) return 1;
175 if (memcmp( header.magic, "\177ELF", 4 )) return 1;
176 if (header.version != 1 /* EV_CURRENT */) return 1;
177 #ifdef WORDS_BIGENDIAN
178 if (header.data != 2 /* ELFDATA2MSB */) return 1;
180 if (header.data != 1 /* ELFDATA2LSB */) return 1;
182 if (sizeof(void *) == sizeof(int)) return header.class == 1; /* ELFCLASS32 */
183 else return header.class == 2; /* ELFCLASS64 */
187 /* check if a given file can be opened */
188 static inline int file_exists( const char *name )
191 int fd = open( name, O_RDONLY );
194 ret = check_library_arch( fd );
200 static inline char *prepend( char *buffer, const char *str, size_t len )
202 return memcpy( buffer - len, str, len );
205 /* get a filename from the next entry in the dll path */
206 static char *next_dll_path( struct dll_path_context *context )
208 unsigned int index = context->index++;
209 int namelen = context->namelen;
210 char *path = context->name;
214 case 0: /* try dlls dir with subdir prefix */
215 if (namelen > 4 && !memcmp( context->name + namelen - 4, ".dll", 4 )) namelen -= 4;
216 if (!context->win16) path = prepend( path, context->name, namelen );
217 path = prepend( path, "/dlls", sizeof("/dlls") - 1 );
218 path = prepend( path, build_dir, strlen(build_dir) );
220 case 1: /* try programs dir with subdir prefix */
223 if (namelen > 4 && !memcmp( context->name + namelen - 4, ".exe", 4 )) namelen -= 4;
224 path = prepend( path, context->name, namelen );
225 path = prepend( path, "/programs", sizeof("/programs") - 1 );
226 path = prepend( path, build_dir, strlen(build_dir) );
233 if (index < nb_dll_paths)
234 return prepend( context->name, dll_paths[index], strlen( dll_paths[index] ));
241 /* get a filename from the first entry in the dll path */
242 static char *first_dll_path( const char *name, int win16, struct dll_path_context *context )
245 int namelen = strlen( name );
246 const char *ext = win16 ? "16" : ".so";
248 context->buffer = malloc( dll_path_maxlen + 2 * namelen + strlen(ext) + 3 );
249 context->index = build_dir ? 0 : 2; /* if no build dir skip all the build dir magic cases */
250 context->name = context->buffer + dll_path_maxlen + namelen + 1;
251 context->namelen = namelen + 1;
252 context->win16 = win16;
254 /* store the name at the end of the buffer, followed by extension */
257 memcpy( p, name, namelen );
258 strcpy( p + namelen, ext );
259 return next_dll_path( context );
263 /* free the dll path context created by first_dll_path */
264 static inline void free_dll_path( struct dll_path_context *context )
266 free( context->buffer );
270 /* open a library for a given dll, searching in the dll path
271 * 'name' must be the Windows dll name (e.g. "kernel32.dll") */
272 static void *dlopen_dll( const char *name, char *error, int errorsize,
273 int test_only, int *exists )
275 struct dll_path_context context;
280 for (path = first_dll_path( name, 0, &context ); path; path = next_dll_path( &context ))
282 if (!test_only && (ret = wine_dlopen( path, RTLD_NOW, error, errorsize ))) break;
283 if ((*exists = file_exists( path ))) break; /* exists but cannot be loaded, return the error */
285 free_dll_path( &context );
290 /* adjust an array of pointers to make them into RVAs */
291 static inline void fixup_rva_ptrs( void *array, BYTE *base, unsigned int count )
293 void **src = (void **)array;
294 DWORD *dst = (DWORD *)array;
297 *dst++ = *src ? (BYTE *)*src - base : 0;
302 /* fixup an array of RVAs by adding the specified delta */
303 static inline void fixup_rva_dwords( DWORD *ptr, int delta, unsigned int count )
307 if (*ptr) *ptr += delta;
313 /* fixup RVAs in the import directory */
314 static void fixup_imports( IMAGE_IMPORT_DESCRIPTOR *dir, BYTE *base, int delta )
320 fixup_rva_dwords( &dir->u.OriginalFirstThunk, delta, 1 );
321 fixup_rva_dwords( &dir->Name, delta, 1 );
322 fixup_rva_dwords( &dir->FirstThunk, delta, 1 );
323 ptr = (UINT_PTR *)(base + (dir->u.OriginalFirstThunk ? dir->u.OriginalFirstThunk : dir->FirstThunk));
326 if (!(*ptr & IMAGE_ORDINAL_FLAG)) *ptr += delta;
334 /* fixup RVAs in the export directory */
335 static void fixup_exports( IMAGE_EXPORT_DIRECTORY *dir, BYTE *base, int delta )
337 fixup_rva_dwords( &dir->Name, delta, 1 );
338 fixup_rva_dwords( &dir->AddressOfFunctions, delta, 1 );
339 fixup_rva_dwords( &dir->AddressOfNames, delta, 1 );
340 fixup_rva_dwords( &dir->AddressOfNameOrdinals, delta, 1 );
341 fixup_rva_dwords( (DWORD *)(base + dir->AddressOfNames), delta, dir->NumberOfNames );
342 fixup_rva_ptrs( (base + dir->AddressOfFunctions), base, dir->NumberOfFunctions );
346 /* fixup RVAs in the resource directory */
347 static void fixup_resources( IMAGE_RESOURCE_DIRECTORY *dir, BYTE *root, int delta )
349 IMAGE_RESOURCE_DIRECTORY_ENTRY *entry;
352 entry = (IMAGE_RESOURCE_DIRECTORY_ENTRY *)(dir + 1);
353 for (i = 0; i < dir->NumberOfNamedEntries + dir->NumberOfIdEntries; i++, entry++)
355 void *ptr = root + entry->u2.s3.OffsetToDirectory;
356 if (entry->u2.s3.DataIsDirectory) fixup_resources( ptr, root, delta );
359 IMAGE_RESOURCE_DATA_ENTRY *data = ptr;
360 fixup_rva_dwords( &data->OffsetToData, delta, 1 );
366 /* map a builtin dll in memory and fixup RVAs */
367 static void *map_dll( const IMAGE_NT_HEADERS *nt_descr )
370 IMAGE_DATA_DIRECTORY *dir;
371 IMAGE_DOS_HEADER *dos;
372 IMAGE_NT_HEADERS *nt;
373 IMAGE_SECTION_HEADER *sec;
375 DWORD code_start, data_start, data_end;
376 const size_t page_size = getpagesize();
377 const size_t page_mask = page_size - 1;
378 int delta, nb_sections = 2; /* code + data */
381 size_t size = (sizeof(IMAGE_DOS_HEADER)
382 + sizeof(IMAGE_NT_HEADERS)
383 + nb_sections * sizeof(IMAGE_SECTION_HEADER));
385 assert( size <= page_size );
387 /* module address must be aligned on 64K boundary */
388 addr = (BYTE *)((nt_descr->OptionalHeader.ImageBase + 0xffff) & ~0xffff);
389 if (wine_anon_mmap( addr, page_size, PROT_READ|PROT_WRITE, MAP_FIXED ) != addr) return NULL;
391 dos = (IMAGE_DOS_HEADER *)addr;
392 nt = (IMAGE_NT_HEADERS *)(dos + 1);
393 sec = (IMAGE_SECTION_HEADER *)(nt + 1);
395 /* Build the DOS and NT headers */
397 dos->e_magic = IMAGE_DOS_SIGNATURE;
400 dos->e_cparhdr = (sizeof(*dos)+0xf)/0x10;
402 dos->e_maxalloc = 0xffff;
405 dos->e_lfarlc = sizeof(*dos);
406 dos->e_lfanew = sizeof(*dos);
410 delta = (const BYTE *)nt_descr - addr;
411 code_start = page_size;
412 data_start = delta & ~page_mask;
413 data_end = (nt->OptionalHeader.SizeOfImage + delta + page_mask) & ~page_mask;
415 fixup_rva_ptrs( &nt->OptionalHeader.AddressOfEntryPoint, addr, 1 );
417 nt->FileHeader.NumberOfSections = nb_sections;
418 nt->OptionalHeader.BaseOfCode = code_start;
420 nt->OptionalHeader.BaseOfData = data_start;
422 nt->OptionalHeader.SizeOfCode = data_start - code_start;
423 nt->OptionalHeader.SizeOfInitializedData = data_end - data_start;
424 nt->OptionalHeader.SizeOfUninitializedData = 0;
425 nt->OptionalHeader.SizeOfImage = data_end;
426 nt->OptionalHeader.ImageBase = (ULONG_PTR)addr;
428 /* Build the code section */
430 memcpy( sec->Name, ".text", sizeof(".text") );
431 sec->SizeOfRawData = data_start - code_start;
432 sec->Misc.VirtualSize = sec->SizeOfRawData;
433 sec->VirtualAddress = code_start;
434 sec->PointerToRawData = code_start;
435 sec->Characteristics = (IMAGE_SCN_CNT_CODE | IMAGE_SCN_MEM_EXECUTE | IMAGE_SCN_MEM_READ);
438 /* Build the data section */
440 memcpy( sec->Name, ".data", sizeof(".data") );
441 sec->SizeOfRawData = data_end - data_start;
442 sec->Misc.VirtualSize = sec->SizeOfRawData;
443 sec->VirtualAddress = data_start;
444 sec->PointerToRawData = data_start;
445 sec->Characteristics = (IMAGE_SCN_CNT_INITIALIZED_DATA |
446 IMAGE_SCN_MEM_WRITE | IMAGE_SCN_MEM_READ);
449 for (i = 0; i < nt->OptionalHeader.NumberOfRvaAndSizes; i++)
450 fixup_rva_dwords( &nt->OptionalHeader.DataDirectory[i].VirtualAddress, delta, 1 );
452 /* Build the import directory */
454 dir = &nt->OptionalHeader.DataDirectory[IMAGE_FILE_IMPORT_DIRECTORY];
457 IMAGE_IMPORT_DESCRIPTOR *imports = (void *)(addr + dir->VirtualAddress);
458 fixup_imports( imports, addr, delta );
461 /* Build the resource directory */
463 dir = &nt->OptionalHeader.DataDirectory[IMAGE_FILE_RESOURCE_DIRECTORY];
466 void *ptr = (void *)(addr + dir->VirtualAddress);
467 fixup_resources( ptr, ptr, delta );
470 /* Build the export directory */
472 dir = &nt->OptionalHeader.DataDirectory[IMAGE_FILE_EXPORT_DIRECTORY];
475 IMAGE_EXPORT_DIRECTORY *exports = (void *)(addr + dir->VirtualAddress);
476 fixup_exports( exports, addr, delta );
479 #else /* HAVE_MMAP */
481 #endif /* HAVE_MMAP */
485 /***********************************************************************
486 * __wine_get_main_environment
488 * Return an environment pointer to work around lack of environ variable.
489 * Only exported on Mac OS.
491 char **__wine_get_main_environment(void)
497 /***********************************************************************
498 * __wine_dll_register
500 * Register a built-in DLL descriptor.
502 void __wine_dll_register( const IMAGE_NT_HEADERS *header, const char *filename )
504 if (load_dll_callback) load_dll_callback( map_dll(header), filename );
507 if (!(header->FileHeader.Characteristics & IMAGE_FILE_DLL))
511 assert( nb_dlls < MAX_DLLS );
512 builtin_dlls[nb_dlls].nt = header;
513 builtin_dlls[nb_dlls].filename = filename;
520 /***********************************************************************
521 * wine_dll_set_callback
523 * Set the callback function for dll loading, and call it
524 * for all dlls that were implicitly loaded already.
526 void wine_dll_set_callback( load_dll_callback_t load )
529 load_dll_callback = load;
530 for (i = 0; i < nb_dlls; i++)
532 const IMAGE_NT_HEADERS *nt = builtin_dlls[i].nt;
534 builtin_dlls[i].nt = NULL;
535 load_dll_callback( map_dll(nt), builtin_dlls[i].filename );
538 if (main_exe) load_dll_callback( map_dll(main_exe), "" );
542 /***********************************************************************
545 * Load a builtin dll.
547 void *wine_dll_load( const char *filename, char *error, int errorsize, int *file_exists )
551 /* callback must have been set already */
552 assert( load_dll_callback );
554 /* check if we have it in the list */
555 /* this can happen when initializing pre-loaded dlls in wine_dll_set_callback */
556 for (i = 0; i < nb_dlls; i++)
558 if (!builtin_dlls[i].nt) continue;
559 if (!strcmp( builtin_dlls[i].filename, filename ))
561 const IMAGE_NT_HEADERS *nt = builtin_dlls[i].nt;
562 builtin_dlls[i].nt = NULL;
563 load_dll_callback( map_dll(nt), builtin_dlls[i].filename );
568 return dlopen_dll( filename, error, errorsize, 0, file_exists );
572 /***********************************************************************
575 * Unload a builtin dll.
577 void wine_dll_unload( void *handle )
579 if (handle != (void *)1)
580 wine_dlclose( handle, NULL, 0 );
584 /***********************************************************************
585 * wine_dll_load_main_exe
587 * Try to load the .so for the main exe.
589 void *wine_dll_load_main_exe( const char *name, char *error, int errorsize,
590 int test_only, int *file_exists )
592 return dlopen_dll( name, error, errorsize, test_only, file_exists );
596 /***********************************************************************
597 * wine_dll_enum_load_path
599 * Enumerate the dll load path.
601 const char *wine_dll_enum_load_path( unsigned int index )
603 if (index >= nb_dll_paths) return NULL;
604 return dll_paths[index];
608 /***********************************************************************
611 * Retrieve the name of the 32-bit owner dll for a 16-bit dll.
612 * Return 0 if OK, -1 on error.
614 int wine_dll_get_owner( const char *name, char *buffer, int size, int *exists )
618 struct dll_path_context context;
622 for (path = first_dll_path( name, 1, &context ); path; path = next_dll_path( &context ))
624 int fd = open( path, O_RDONLY );
627 int res = read( fd, buffer, size - 1 );
628 while (res > 0 && (buffer[res-1] == '\n' || buffer[res-1] == '\r')) res--;
636 free_dll_path( &context );
641 /***********************************************************************
644 * Set a user limit to the maximum allowed value.
646 static void set_max_limit( int limit )
648 #ifdef HAVE_SETRLIMIT
649 struct rlimit rlimit;
651 if (!getrlimit( limit, &rlimit ))
653 rlimit.rlim_cur = rlimit.rlim_max;
654 if (setrlimit( limit, &rlimit ) != 0)
656 #if defined(__APPLE__) && defined(RLIMIT_NOFILE) && defined(OPEN_MAX)
657 /* On Leopard, setrlimit(RLIMIT_NOFILE, ...) fails on attempts to set
658 * rlim_cur above OPEN_MAX (even if rlim_max > OPEN_MAX). */
659 if (limit == RLIMIT_NOFILE && rlimit.rlim_cur > OPEN_MAX)
661 rlimit.rlim_cur = OPEN_MAX;
662 setrlimit( limit, &rlimit );
671 /***********************************************************************
674 * Main Wine initialisation.
676 void wine_init( int argc, char *argv[], char *error, int error_size )
678 struct dll_path_context context;
681 void (*init_func)(void);
683 /* force a few limits that are set too low on some platforms */
685 set_max_limit( RLIMIT_NOFILE );
688 set_max_limit( RLIMIT_AS );
691 wine_init_argv0_path( argv[0] );
693 __wine_main_argc = argc;
694 __wine_main_argv = argv;
695 __wine_main_environ = __wine_get_main_environment();
698 for (path = first_dll_path( "ntdll.dll", 0, &context ); path; path = next_dll_path( &context ))
700 if ((ntdll = wine_dlopen( path, RTLD_NOW, error, error_size )))
702 /* if we didn't use the default dll dir, remove it from the search path */
703 if (default_dlldir[0] && context.index < nb_dll_paths + 2) nb_dll_paths--;
707 free_dll_path( &context );
710 if (!(init_func = wine_dlsym( ntdll, "__wine_process_init", error, error_size ))) return;
716 * These functions provide wrappers around dlopen() and associated
717 * functions. They work around a bug in glibc 2.1.x where calling
718 * a dl*() function after a previous dl*() function has failed
719 * without a dlerror() call between the two will cause a crash.
720 * They all take a pointer to a buffer that
721 * will receive the error description (from dlerror()). This
722 * parameter may be NULL if the error description is not required.
729 /***********************************************************************
732 void *wine_dlopen( const char *filename, int flag, char *error, size_t errorsize )
739 /* the Mac OS loader pretends to be able to load PE files, so avoid them here */
740 unsigned char magic[2];
741 int fd = open( filename, O_RDONLY );
744 if (pread( fd, magic, 2, 0 ) == 2 && magic[0] == 'M' && magic[1] == 'Z')
746 static const char msg[] = "MZ format";
747 size_t len = min( errorsize, sizeof(msg) );
748 memcpy( error, msg, len );
756 dlerror(); dlerror();
758 if (strchr( filename, ':' ))
761 /* Solaris' brain damaged dlopen() treats ':' as a path separator */
762 realpath( filename, path );
763 ret = dlopen( path, flag | RTLD_FIRST );
767 ret = dlopen( filename, flag | RTLD_FIRST );
769 if (error && errorsize)
773 size_t len = strlen(s);
774 if (len >= errorsize) len = errorsize - 1;
775 memcpy( error, s, len );
785 static const char msg[] = "dlopen interface not detected by configure";
786 size_t len = min( errorsize, sizeof(msg) );
787 memcpy( error, msg, len );
794 /***********************************************************************
797 void *wine_dlsym( void *handle, const char *symbol, char *error, size_t errorsize )
802 dlerror(); dlerror();
803 ret = dlsym( handle, symbol );
805 if (error && errorsize)
809 size_t len = strlen(s);
810 if (len >= errorsize) len = errorsize - 1;
811 memcpy( error, s, len );
821 static const char msg[] = "dlopen interface not detected by configure";
822 size_t len = min( errorsize, sizeof(msg) );
823 memcpy( error, msg, len );
830 /***********************************************************************
833 int wine_dlclose( void *handle, char *error, size_t errorsize )
838 dlerror(); dlerror();
839 ret = dlclose( handle );
841 if (error && errorsize)
845 size_t len = strlen(s);
846 if (len >= errorsize) len = errorsize - 1;
847 memcpy( error, s, len );
857 static const char msg[] = "dlopen interface not detected by configure";
858 size_t len = min( errorsize, sizeof(msg) );
859 memcpy( error, msg, len );