2 * Module/Library loadorder
4 * Copyright 1999 Bertho Stultiens
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include "wine/port.h"
33 #include "wine/debug.h"
35 WINE_DEFAULT_DEBUG_CHANNEL(module
);
37 #define LOADORDER_ALLOC_CLUSTER 32 /* Allocate with 32 entries at a time */
39 typedef struct module_loadorder
41 const char *modulename
;
42 enum loadorder_type loadorder
[LOADORDER_NTYPES
];
49 module_loadorder_t
*order
;
52 /* default load-order if nothing specified */
53 /* the list must remain sorted by dll name */
54 static module_loadorder_t default_order_list
[] =
56 { "display", { LOADORDER_BI
, 0, 0, 0 } },
57 { "gdi.exe", { LOADORDER_BI
, 0, 0, 0 } },
58 { "gdi32", { LOADORDER_BI
, 0, 0, 0 } },
59 { "glide2x", { LOADORDER_SO
, LOADORDER_DLL
, 0, 0 } },
60 { "glide3x", { LOADORDER_SO
, LOADORDER_DLL
, 0, 0 } },
61 { "icmp", { LOADORDER_BI
, 0, 0, 0 } },
62 { "kernel", { LOADORDER_BI
, 0, 0, 0 } },
63 { "kernel32", { LOADORDER_BI
, 0, 0, 0 } },
64 { "keyboard", { LOADORDER_BI
, 0, 0, 0 } },
65 { "krnl386.exe", { LOADORDER_BI
, 0, 0, 0 } },
66 { "mmsystem", { LOADORDER_BI
, 0, 0, 0 } },
67 { "mouse", { LOADORDER_BI
, 0, 0, 0 } },
68 { "ntdll", { LOADORDER_BI
, 0, 0, 0 } },
69 { "odbc32", { LOADORDER_BI
, 0, 0, 0 } },
70 { "system", { LOADORDER_BI
, 0, 0, 0 } },
71 { "toolhelp", { LOADORDER_BI
, 0, 0, 0 } },
72 { "ttydrv", { LOADORDER_BI
, 0, 0, 0 } },
73 { "user.exe", { LOADORDER_BI
, 0, 0, 0 } },
74 { "user32", { LOADORDER_BI
, 0, 0, 0 } },
75 { "w32skrnl", { LOADORDER_BI
, 0, 0, 0 } },
76 { "winaspi", { LOADORDER_BI
, 0, 0, 0 } },
77 { "windebug", { LOADORDER_DLL
, LOADORDER_BI
, 0, 0 } },
78 { "winedos", { LOADORDER_BI
, 0, 0, 0 } },
79 { "wineps", { LOADORDER_BI
, 0, 0, 0 } },
80 { "wing", { LOADORDER_BI
, 0, 0, 0 } },
81 { "winmm", { LOADORDER_BI
, 0, 0, 0 } },
82 { "winsock", { LOADORDER_BI
, 0, 0, 0 } },
83 { "wnaspi32", { LOADORDER_BI
, 0, 0, 0 } },
84 { "wow32", { LOADORDER_BI
, 0, 0, 0 } },
85 { "wprocs", { LOADORDER_BI
, 0, 0, 0 } },
86 { "ws2_32", { LOADORDER_BI
, 0, 0, 0 } },
87 { "wsock32", { LOADORDER_BI
, 0, 0, 0 } },
88 { "x11drv", { LOADORDER_BI
, 0, 0, 0 } }
91 static const struct loadorder_list default_list
=
93 sizeof(default_order_list
)/sizeof(default_order_list
[0]),
94 sizeof(default_order_list
)/sizeof(default_order_list
[0]),
98 /* default if nothing else specified */
99 static const enum loadorder_type default_loadorder
[LOADORDER_NTYPES
] =
101 LOADORDER_BI
, LOADORDER_DLL
, 0, 0
104 static struct loadorder_list cmdline_list
;
107 /***************************************************************************
108 * cmp_sort_func (internal, static)
110 * Sorting and comparing function used in sort and search of loadorder
113 static int cmp_sort_func(const void *s1
, const void *s2
)
115 return FILE_strcasecmp(((module_loadorder_t
*)s1
)->modulename
,
116 ((module_loadorder_t
*)s2
)->modulename
);
120 /***************************************************************************
121 * get_tok (internal, static)
123 * strtok wrapper for non-destructive buffer writing.
124 * NOTE: strtok is not reentrant and therefore this code is neither.
126 static char *get_tok(const char *str
, const char *delim
)
128 static char *buf
= NULL
;
136 HeapFree(GetProcessHeap(), 0, buf
);
142 buf
= HeapAlloc(GetProcessHeap(), 0, strlen(str
)+1);
144 cptr
= strtok(buf
, delim
);
148 cptr
= strtok(NULL
, delim
);
153 HeapFree(GetProcessHeap(), 0, buf
);
160 /***************************************************************************
163 * Return the base name of a file name (i.e. remove the path components).
165 static const char *get_basename( const char *name
)
169 if (name
[0] && name
[1] == ':') name
+= 2; /* strip drive specification */
170 if ((ptr
= strrchr( name
, '\\' ))) name
= ptr
+ 1;
171 if ((ptr
= strrchr( name
, '/' ))) name
= ptr
+ 1;
176 /***************************************************************************
179 * Return a loadorder in printable form.
181 static const char *debugstr_loadorder( enum loadorder_type lo
[] )
184 char buffer
[LOADORDER_NTYPES
*3+1];
187 for(i
= 0; i
< LOADORDER_NTYPES
; i
++)
189 if (lo
[i
] == LOADORDER_INVALID
) break;
192 case LOADORDER_DLL
: strcat( buffer
, "n," ); break;
193 case LOADORDER_SO
: strcat( buffer
, "s," ); break;
194 case LOADORDER_BI
: strcat( buffer
, "b," ); break;
195 default: strcat( buffer
, "?," ); break;
198 if (buffer
[0]) buffer
[strlen(buffer
)-1] = 0;
199 return debugstr_a(buffer
);
203 /***************************************************************************
204 * ParseLoadOrder (internal, static)
206 * Parses the loadorder options from the configuration and puts it into
209 static BOOL
ParseLoadOrder(char *order
, enum loadorder_type lo
[])
215 cptr
= get_tok(order
, ", \t");
218 enum loadorder_type type
= LOADORDER_INVALID
;
220 if(n
>= LOADORDER_NTYPES
-1)
222 ERR("More than existing %d module-types specified, rest ignored\n", LOADORDER_NTYPES
-1);
228 case 'N': /* Native */
229 case 'n': type
= LOADORDER_DLL
; break;
231 case 'E': /* Elfdll */
233 if (!warn
++) MESSAGE("Load order 'elfdll' no longer supported, ignored\n");
236 case 's': type
= LOADORDER_SO
; break;
238 case 'B': /* Builtin */
239 case 'b': type
= LOADORDER_BI
; break;
242 ERR("Invalid load order module-type '%s', ignored\n", cptr
);
245 if(type
!= LOADORDER_INVALID
) lo
[n
++] = type
;
246 cptr
= get_tok(NULL
, ", \t");
248 lo
[n
] = LOADORDER_INVALID
;
253 /***************************************************************************
254 * AddLoadOrder (internal, static)
256 * Adds an entry in the list of command-line overrides.
258 static BOOL
AddLoadOrder(module_loadorder_t
*plo
)
262 /* TRACE(module, "'%s' -> %08lx\n", plo->modulename, *(DWORD *)(plo->loadorder)); */
264 for(i
= 0; i
< cmdline_list
.count
; i
++)
266 if(!cmp_sort_func(plo
, &cmdline_list
.order
[i
] ))
268 /* replace existing option */
269 memcpy( cmdline_list
.order
[i
].loadorder
, plo
->loadorder
, sizeof(plo
->loadorder
));
274 if (i
>= cmdline_list
.alloc
)
276 /* No space in current array, make it larger */
277 cmdline_list
.alloc
+= LOADORDER_ALLOC_CLUSTER
;
278 cmdline_list
.order
= HeapReAlloc(GetProcessHeap(), 0, cmdline_list
.order
,
279 cmdline_list
.alloc
* sizeof(module_loadorder_t
));
280 if(!cmdline_list
.order
)
282 MESSAGE("Virtual memory exhausted\n");
286 memcpy(cmdline_list
.order
[i
].loadorder
, plo
->loadorder
, sizeof(plo
->loadorder
));
287 cmdline_list
.order
[i
].modulename
= HeapAlloc(GetProcessHeap(), 0, strlen(plo
->modulename
)+1);
288 strcpy( (char *)cmdline_list
.order
[i
].modulename
, plo
->modulename
);
289 cmdline_list
.count
++;
294 /***************************************************************************
295 * AddLoadOrderSet (internal, static)
297 * Adds a set of entries in the list of command-line overrides from the key parameter.
299 static BOOL
AddLoadOrderSet(char *key
, char *order
)
301 module_loadorder_t ldo
;
304 /* Parse the loadorder before the rest because strtok is not reentrant */
305 if(!ParseLoadOrder(order
, ldo
.loadorder
))
308 cptr
= get_tok(key
, ", \t");
311 char *ext
= strrchr(cptr
, '.');
312 if(ext
&& !FILE_strcasecmp( ext
, ".dll" )) *ext
= 0;
313 ldo
.modulename
= cptr
;
314 if(!AddLoadOrder(&ldo
)) return FALSE
;
315 cptr
= get_tok(NULL
, ", \t");
321 /***************************************************************************
322 * MODULE_AddLoadOrderOption
324 * The commandline option is in the form:
325 * name[,name,...]=native[,b,...]
327 void MODULE_AddLoadOrderOption( const char *option
)
329 char *value
, *key
= HeapAlloc(GetProcessHeap(), 0, strlen(option
)+1);
331 strcpy( key
, option
);
332 if (!(value
= strchr(key
, '='))) goto error
;
335 TRACE("Commandline override '%s' = '%s'\n", key
, value
);
337 if (!AddLoadOrderSet(key
, value
)) goto error
;
338 HeapFree(GetProcessHeap(), 0, key
);
340 /* sort the array for quick lookup */
341 qsort(cmdline_list
.order
, cmdline_list
.count
, sizeof(cmdline_list
.order
[0]), cmp_sort_func
);
345 MESSAGE( "Syntax: -dll name[,name[,...]]={native|so|builtin}[,{n|s|b}[,...]]\n"
346 " - 'name' is the name of any dll without extension\n"
347 " - the order of loading (native, so and builtin) can be abbreviated\n"
348 " with the first letter\n"
349 " - the option can be specified multiple times\n"
351 " -dll comdlg32,commdlg=n -dll shell,shell32=b\n" );
356 /***************************************************************************
357 * get_list_load_order
359 * Get the load order for a given module from the command-line or
362 static BOOL
get_list_load_order( const char *module
, const struct loadorder_list
*list
,
363 enum loadorder_type lo
[] )
365 module_loadorder_t tmp
, *res
= NULL
;
367 tmp
.modulename
= module
;
368 /* some bsearch implementations (Solaris) are buggy when the number of items is 0 */
369 if (list
->count
&& (res
= bsearch(&tmp
, list
->order
, list
->count
, sizeof(list
->order
[0]), cmp_sort_func
)))
370 memcpy( lo
, res
->loadorder
, sizeof(res
->loadorder
) );
371 return (res
!= NULL
);
375 /***************************************************************************
378 * Open the registry key to the app-specific DllOverrides list.
380 static HKEY
open_app_key( const char *module
)
382 OBJECT_ATTRIBUTES attr
;
383 UNICODE_STRING nameW
;
385 char buffer
[MAX_PATH
+16], *appname
;
386 static const WCHAR AppDefaultsW
[] = {'M','a','c','h','i','n','e','\\',
387 'S','o','f','t','w','a','r','e','\\',
388 'W','i','n','e','\\',
389 'W','i','n','e','\\',
390 'C','o','n','f','i','g','\\',
391 'A','p','p','D','e','f','a','u','l','t','s',0};
393 if (!GetModuleFileNameA( 0, buffer
, MAX_PATH
))
395 WARN( "could not get module file name loading %s\n", module
);
398 appname
= (char *)get_basename( buffer
);
400 TRACE( "searching '%s' in AppDefaults\\%s\\DllOverrides\n", module
, appname
);
402 attr
.Length
= sizeof(attr
);
403 attr
.RootDirectory
= 0;
404 attr
.ObjectName
= &nameW
;
406 attr
.SecurityDescriptor
= NULL
;
407 attr
.SecurityQualityOfService
= NULL
;
408 RtlInitUnicodeString( &nameW
, AppDefaultsW
);
410 if (NtOpenKey( &hkey
, KEY_ALL_ACCESS
, &attr
)) return 0;
411 attr
.RootDirectory
= hkey
;
413 /* open AppDefaults\\appname\\DllOverrides key */
414 strcat( appname
, "\\DllOverrides" );
415 RtlCreateUnicodeStringFromAsciiz( &nameW
, appname
);
416 if (NtOpenKey( &appkey
, KEY_ALL_ACCESS
, &attr
)) appkey
= 0;
417 RtlFreeUnicodeString( &nameW
);
423 /***************************************************************************
426 * Load the registry loadorder value for a given module.
428 static BOOL
get_registry_value( HKEY hkey
, const char *module
, enum loadorder_type lo
[] )
430 UNICODE_STRING valueW
;
435 RtlCreateUnicodeStringFromAsciiz( &valueW
, module
);
437 if ((ret
= !NtQueryValueKey( hkey
, &valueW
, KeyValuePartialInformation
,
438 buffer
, sizeof(buffer
), &count
)))
441 WCHAR
*str
= (WCHAR
*)((KEY_VALUE_PARTIAL_INFORMATION
*)buffer
)->Data
;
445 enum loadorder_type type
= LOADORDER_INVALID
;
447 while (*str
== ',' || isspaceW(*str
)) str
++;
450 switch(tolowerW(*str
))
452 case 'n': type
= LOADORDER_DLL
; break;
453 case 's': type
= LOADORDER_SO
; break;
454 case 'b': type
= LOADORDER_BI
; break;
455 case 0: break; /* end of string */
457 ERR("Invalid load order module-type %s, ignored\n", debugstr_w(str
));
460 if (type
!= LOADORDER_INVALID
)
462 for (i
= 0; i
< n
; i
++) if (lo
[i
] == type
) break; /* already specified */
463 if (i
== n
) lo
[n
++] = type
;
465 while (*str
&& *str
!= ',' && !isspaceW(*str
)) str
++;
467 lo
[n
] = LOADORDER_INVALID
;
469 RtlFreeUnicodeString( &valueW
);
474 /***************************************************************************
475 * MODULE_GetBuiltinPath
477 * Get the path of a builtin module when the native file does not exist.
479 BOOL
MODULE_GetBuiltinPath( const char *libname
, const char *ext
, char *filename
, UINT size
)
483 UINT len
= GetSystemDirectoryA( filename
, size
);
485 if (FILE_contains_path( libname
))
489 /* if the library name contains a path and can not be found,
491 * exception: if the path is the system directory, proceed,
492 * so that modules which are not PE modules can be loaded.
493 * If the library name does not contain a path and can not
494 * be found, assume the system directory is meant */
496 if (strlen(libname
) >= size
) return FALSE
; /* too long */
497 if (strchr( libname
, '/' )) /* need to convert slashes */
499 if (!(tmp
= HeapAlloc( GetProcessHeap(), 0, strlen(libname
)+1 ))) return FALSE
;
500 strcpy( tmp
, libname
);
501 for (p
= tmp
; *p
; p
++) if (*p
== '/') *p
= '\\';
503 else tmp
= (char *)libname
;
505 if (!FILE_strncasecmp( filename
, tmp
, len
) && tmp
[len
] == '\\')
507 strcpy( filename
, tmp
);
510 if (tmp
!= libname
) HeapFree( GetProcessHeap(), 0, tmp
);
511 if (!ret
) return FALSE
;
515 if (strlen(libname
) >= size
- len
- 1) return FALSE
;
516 filename
[len
] = '\\';
517 strcpy( filename
+len
+1, libname
);
520 /* if the filename doesn't have an extension, append the default */
521 if (!(p
= strrchr( filename
, '.')) || strchr( p
, '/' ) || strchr( p
, '\\'))
523 if (strlen(filename
) + strlen(ext
) >= size
) return FALSE
;
524 strcat( filename
, ext
);
530 /***************************************************************************
531 * MODULE_GetLoadOrder (internal)
533 * Locate the loadorder of a module.
534 * Any path is stripped from the path-argument and so are the extension
535 * '.dll' and '.exe'. A lookup in the table can yield an override for
536 * the specific dll. Otherwise the default load order is returned.
538 void MODULE_GetLoadOrder( enum loadorder_type loadorder
[], const char *path
, BOOL win32
)
540 static const WCHAR DllOverridesW
[] = {'M','a','c','h','i','n','e','\\',
541 'S','o','f','t','w','a','r','e','\\',
542 'W','i','n','e','\\',
543 'W','i','n','e','\\',
544 'C','o','n','f','i','g','\\',
545 'D','l','l','O','v','e','r','r','i','d','e','s',0};
547 static HKEY std_key
= (HKEY
)-1; /* key to standard section, cached */
549 char *module
, *basename
;
552 TRACE("looking for %s\n", path
);
554 loadorder
[0] = LOADORDER_INVALID
; /* in case something bad happens below */
556 /* Strip path information for 16 bit modules or if the module
557 * resides in the system directory */
560 path
= get_basename( path
);
561 if (BUILTIN_IsPresent(path
))
563 TRACE( "forcing loadorder to builtin for %s\n", debugstr_a(path
) );
564 /* force builtin loadorder since the dll is already in memory */
565 loadorder
[0] = LOADORDER_BI
;
566 loadorder
[1] = LOADORDER_INVALID
;
572 char sysdir
[MAX_PATH
+1];
573 if (!GetSystemDirectoryA( sysdir
, MAX_PATH
)) return;
574 if (!FILE_strncasecmp( sysdir
, path
, strlen (sysdir
) ))
576 path
+= strlen(sysdir
);
577 while (*path
== '\\' || *path
== '/') path
++;
581 if (!(len
= strlen(path
))) return;
582 if (!(module
= HeapAlloc( GetProcessHeap(), 0, len
+ 2 ))) return;
583 strcpy( module
+1, path
); /* reserve module[0] for the wildcard char */
587 char *ext
= module
+ 1 + len
- 4;
588 if (!FILE_strcasecmp( ext
, ".dll" )) *ext
= 0;
591 /* check command-line first */
592 if (get_list_load_order( module
+1, &cmdline_list
, loadorder
))
594 TRACE( "got cmdline %s for %s\n",
595 debugstr_loadorder(loadorder
), debugstr_a(path
) );
599 /* then explicit module name in AppDefaults */
600 app_key
= open_app_key( module
+1 );
601 if (app_key
&& get_registry_value( app_key
, module
+1, loadorder
))
603 TRACE( "got app defaults %s for %s\n",
604 debugstr_loadorder(loadorder
), debugstr_a(path
) );
608 /* then explicit module name in standard section */
609 if (std_key
== (HKEY
)-1)
611 OBJECT_ATTRIBUTES attr
;
612 UNICODE_STRING nameW
;
614 attr
.Length
= sizeof(attr
);
615 attr
.RootDirectory
= 0;
616 attr
.ObjectName
= &nameW
;
618 attr
.SecurityDescriptor
= NULL
;
619 attr
.SecurityQualityOfService
= NULL
;
620 RtlInitUnicodeString( &nameW
, DllOverridesW
);
622 if (NtOpenKey( &std_key
, KEY_ALL_ACCESS
, &attr
)) std_key
= 0;
625 if (std_key
&& get_registry_value( std_key
, module
+1, loadorder
))
627 TRACE( "got standard entry %s for %s\n",
628 debugstr_loadorder(loadorder
), debugstr_a(path
) );
632 /* then module basename preceded by '*' in AppDefaults */
633 basename
= (char *)get_basename( module
+1 );
635 if (app_key
&& get_registry_value( app_key
, basename
-1, loadorder
))
637 TRACE( "got app defaults basename %s for %s\n",
638 debugstr_loadorder(loadorder
), debugstr_a(path
) );
642 /* then module name preceded by '*' in standard section */
643 if (std_key
&& get_registry_value( std_key
, basename
-1, loadorder
))
645 TRACE( "got standard base name %s for %s\n",
646 debugstr_loadorder(loadorder
), debugstr_a(path
) );
650 /* then base name matching compiled-in defaults */
651 if (get_list_load_order( basename
, &default_list
, loadorder
))
653 TRACE( "got compiled-in default %s for %s\n",
654 debugstr_loadorder(loadorder
), debugstr_a(path
) );
658 if (basename
== module
+1)
660 /* then wildcard entry in AppDefaults (only if no explicit path) */
661 if (app_key
&& get_registry_value( app_key
, "*", loadorder
))
663 TRACE( "got app defaults wildcard %s for %s\n",
664 debugstr_loadorder(loadorder
), debugstr_a(path
) );
668 /* then wildcard entry in standard section (only if no explicit path) */
669 if (std_key
&& get_registry_value( std_key
, "*", loadorder
))
671 TRACE( "got standard wildcard %s for %s\n",
672 debugstr_loadorder(loadorder
), debugstr_a(path
) );
677 /* and last the hard-coded default */
678 memcpy( loadorder
, default_loadorder
, sizeof(default_loadorder
) );
679 TRACE( "got hardcoded default %s for %s\n",
680 debugstr_loadorder(loadorder
), debugstr_a(path
) );
684 if (app_key
) NtClose( app_key
);
685 HeapFree( GetProcessHeap(), 0, module
);