2 * Module/Library loadorder
4 * Copyright 1999 Bertho Stultiens
16 #include "loadorder.h"
20 #include "debugtools.h"
22 DEFAULT_DEBUG_CHANNEL(module
);
24 #define LOADORDER_ALLOC_CLUSTER 32 /* Allocate with 32 entries at a time */
26 typedef struct module_loadorder
28 const char *modulename
;
29 enum loadorder_type loadorder
[LOADORDER_NTYPES
];
36 module_loadorder_t
*order
;
39 /* default load-order if nothing specified */
40 /* the list must remain sorted by dll name */
41 static module_loadorder_t default_order_list
[] =
43 { "display", { LOADORDER_BI
, 0, 0, 0 } },
44 { "gdi", { LOADORDER_BI
, 0, 0, 0 } },
45 { "gdi32", { LOADORDER_BI
, 0, 0, 0 } },
46 { "glide2x", { LOADORDER_SO
, LOADORDER_DLL
, 0, 0 } },
47 { "glide3x", { LOADORDER_SO
, LOADORDER_DLL
, 0, 0 } },
48 { "icmp", { LOADORDER_BI
, 0, 0, 0 } },
49 { "kernel", { LOADORDER_BI
, 0, 0, 0 } },
50 { "kernel32", { LOADORDER_BI
, 0, 0, 0 } },
51 { "keyboard", { LOADORDER_BI
, 0, 0, 0 } },
52 { "krnl386", { LOADORDER_BI
, 0, 0, 0 } },
53 { "mmsystem", { LOADORDER_BI
, 0, 0, 0 } },
54 { "mouse", { LOADORDER_BI
, 0, 0, 0 } },
55 { "ntdll", { LOADORDER_BI
, 0, 0, 0 } },
56 { "odbc32", { LOADORDER_BI
, 0, 0, 0 } },
57 { "system", { LOADORDER_BI
, 0, 0, 0 } },
58 { "toolhelp", { LOADORDER_BI
, 0, 0, 0 } },
59 { "ttydrv", { LOADORDER_BI
, 0, 0, 0 } },
60 { "user", { LOADORDER_BI
, 0, 0, 0 } },
61 { "user32", { LOADORDER_BI
, 0, 0, 0 } },
62 { "w32skrnl", { LOADORDER_BI
, 0, 0, 0 } },
63 { "winaspi", { LOADORDER_BI
, 0, 0, 0 } },
64 { "windebug", { LOADORDER_DLL
, LOADORDER_BI
, 0, 0 } },
65 { "winedos", { LOADORDER_BI
, 0, 0, 0 } },
66 { "wineps", { LOADORDER_BI
, 0, 0, 0 } },
67 { "wing", { LOADORDER_BI
, 0, 0, 0 } },
68 { "winmm", { LOADORDER_BI
, 0, 0, 0 } },
69 { "winsock", { LOADORDER_BI
, 0, 0, 0 } },
70 { "wnaspi32", { LOADORDER_BI
, 0, 0, 0 } },
71 { "wow32", { LOADORDER_BI
, 0, 0, 0 } },
72 { "wprocs", { LOADORDER_BI
, 0, 0, 0 } },
73 { "ws2_32", { LOADORDER_BI
, 0, 0, 0 } },
74 { "wsock32", { LOADORDER_BI
, 0, 0, 0 } },
75 { "x11drv", { LOADORDER_BI
, 0, 0, 0 } }
78 static const struct loadorder_list default_list
=
80 sizeof(default_order_list
)/sizeof(default_order_list
[0]),
81 sizeof(default_order_list
)/sizeof(default_order_list
[0]),
85 static struct loadorder_list cmdline_list
;
88 /***************************************************************************
89 * cmp_sort_func (internal, static)
91 * Sorting and comparing function used in sort and search of loadorder
94 static int cmp_sort_func(const void *s1
, const void *s2
)
96 return FILE_strcasecmp(((module_loadorder_t
*)s1
)->modulename
,
97 ((module_loadorder_t
*)s2
)->modulename
);
101 /***************************************************************************
102 * get_tok (internal, static)
104 * strtok wrapper for non-destructive buffer writing.
105 * NOTE: strtok is not reentrant and therefore this code is neither.
107 static char *get_tok(const char *str
, const char *delim
)
109 static char *buf
= NULL
;
117 HeapFree(GetProcessHeap(), 0, buf
);
123 buf
= HEAP_strdupA(GetProcessHeap(), 0, str
);
124 cptr
= strtok(buf
, delim
);
128 cptr
= strtok(NULL
, delim
);
133 HeapFree(GetProcessHeap(), 0, buf
);
140 /***************************************************************************
141 * ParseLoadOrder (internal, static)
143 * Parses the loadorder options from the configuration and puts it into
146 static BOOL
ParseLoadOrder(char *order
, enum loadorder_type lo
[])
152 cptr
= get_tok(order
, ", \t");
155 enum loadorder_type type
= LOADORDER_INVALID
;
157 if(n
>= LOADORDER_NTYPES
-1)
159 ERR("More than existing %d module-types specified, rest ignored\n", LOADORDER_NTYPES
-1);
165 case 'N': /* Native */
166 case 'n': type
= LOADORDER_DLL
; break;
168 case 'E': /* Elfdll */
170 if (!warn
++) MESSAGE("Load order 'elfdll' no longer supported, ignored\n");
173 case 's': type
= LOADORDER_SO
; break;
175 case 'B': /* Builtin */
176 case 'b': type
= LOADORDER_BI
; break;
179 ERR("Invalid load order module-type '%s', ignored\n", cptr
);
182 if(type
!= LOADORDER_INVALID
) lo
[n
++] = type
;
183 cptr
= get_tok(NULL
, ", \t");
185 lo
[n
] = LOADORDER_INVALID
;
190 /***************************************************************************
191 * AddLoadOrder (internal, static)
193 * Adds an entry in the list of command-line overrides.
195 static BOOL
AddLoadOrder(module_loadorder_t
*plo
)
199 /* TRACE(module, "'%s' -> %08lx\n", plo->modulename, *(DWORD *)(plo->loadorder)); */
201 for(i
= 0; i
< cmdline_list
.count
; i
++)
203 if(!cmp_sort_func(plo
, &cmdline_list
.order
[i
] ))
205 /* replace existing option */
206 memcpy( cmdline_list
.order
[i
].loadorder
, plo
->loadorder
, sizeof(plo
->loadorder
));
211 if (i
>= cmdline_list
.alloc
)
213 /* No space in current array, make it larger */
214 cmdline_list
.alloc
+= LOADORDER_ALLOC_CLUSTER
;
215 cmdline_list
.order
= HeapReAlloc(GetProcessHeap(), 0, cmdline_list
.order
,
216 cmdline_list
.alloc
* sizeof(module_loadorder_t
));
217 if(!cmdline_list
.order
)
219 MESSAGE("Virtual memory exhausted\n");
223 memcpy(cmdline_list
.order
[i
].loadorder
, plo
->loadorder
, sizeof(plo
->loadorder
));
224 cmdline_list
.order
[i
].modulename
= HEAP_strdupA(GetProcessHeap(), 0, plo
->modulename
);
225 cmdline_list
.count
++;
230 /***************************************************************************
231 * AddLoadOrderSet (internal, static)
233 * Adds a set of entries in the list of command-line overrides from the key parameter.
235 static BOOL
AddLoadOrderSet(char *key
, char *order
)
237 module_loadorder_t ldo
;
240 /* Parse the loadorder before the rest because strtok is not reentrant */
241 if(!ParseLoadOrder(order
, ldo
.loadorder
))
244 cptr
= get_tok(key
, ", \t");
247 char *ext
= strrchr(cptr
, '.');
250 if(strlen(ext
) == 4 &&
251 (!FILE_strcasecmp(ext
, ".dll") || !FILE_strcasecmp(ext
, ".exe")))
252 MESSAGE("Warning: Loadorder override '%s' contains an extension and might not be found during lookup\n", cptr
);
255 ldo
.modulename
= cptr
;
256 if(!AddLoadOrder(&ldo
)) return FALSE
;
257 cptr
= get_tok(NULL
, ", \t");
263 /***************************************************************************
264 * MODULE_AddLoadOrderOption
266 * The commandline option is in the form:
267 * name[,name,...]=native[,b,...]
269 void MODULE_AddLoadOrderOption( const char *option
)
271 char *key
= HEAP_strdupA(GetProcessHeap(), 0, option
);
272 char *value
= strchr(key
, '=');
274 if (!value
) goto error
;
277 TRACE("Commandline override '%s' = '%s'\n", key
, value
);
279 if (!AddLoadOrderSet(key
, value
)) goto error
;
280 HeapFree(GetProcessHeap(), 0, key
);
282 /* sort the array for quick lookup */
283 qsort(cmdline_list
.order
, cmdline_list
.count
, sizeof(cmdline_list
.order
[0]), cmp_sort_func
);
287 MESSAGE( "Syntax: -dll name[,name[,...]]={native|so|builtin}[,{n|s|b}[,...]]\n"
288 " - 'name' is the name of any dll without extension\n"
289 " - the order of loading (native, so and builtin) can be abbreviated\n"
290 " with the first letter\n"
291 " - the option can be specified multiple times\n"
293 " -dll comdlg32,commdlg=n -dll shell,shell32=b\n" );
298 /***************************************************************************
301 * Set individual registry keys for a multiple dll specification
302 * Helper for MODULE_InitLoadOrder().
304 inline static void set_registry_keys( HKEY hkey
, char *module
, const char *buffer
)
307 char *p
= get_tok( module
, ", \t" );
309 TRACE( "converting \"%s\" = \"%s\"\n", module
, buffer
);
312 MESSAGE( "Warning: setting multiple modules in a single DllOverrides entry is no longer\n"
313 "recommended. It is suggested that you rewrite the configuration file entry:\n\n"
314 "\"%s\" = \"%s\"\n\n"
315 "into something like:\n\n", module
, buffer
);
318 if (!warn
) MESSAGE( "\"%s\" = \"%s\"\n", p
, buffer
);
319 /* only set it if not existing already */
320 if (RegQueryValueExA( hkey
, p
, 0, NULL
, NULL
, NULL
) == ERROR_FILE_NOT_FOUND
)
321 RegSetValueExA( hkey
, p
, 0, REG_SZ
, buffer
, strlen(buffer
)+1 );
322 p
= get_tok( NULL
, ", \t" );
324 if (!warn
) MESSAGE( "\n" );
329 /***************************************************************************
330 * MODULE_InitLoadOrder
332 * Convert entries containing multiple dll names (old syntax) to the
333 * new one dll module per entry syntax
335 void MODULE_InitLoadOrder(void)
343 if (RegOpenKeyA( HKEY_LOCAL_MACHINE
, "Software\\Wine\\Wine\\Config\\DllOverrides", &hkey
))
348 DWORD type
, count
= sizeof(buffer
), name_len
= sizeof(module
);
350 if (RegEnumValueA( hkey
, index
, module
, &name_len
, NULL
, &type
, buffer
, &count
)) break;
352 while (isspace(*p
)) p
++;
353 p
+= strcspn( p
, ", \t" );
354 while (isspace(*p
)) p
++;
357 RegDeleteValueA( hkey
, module
);
358 set_registry_keys( hkey
, module
, buffer
);
366 /***************************************************************************
367 * get_list_load_order
369 * Get the load order for a given module from the command-line or
372 static BOOL
get_list_load_order( const char *module
, const struct loadorder_list
*list
,
373 enum loadorder_type lo
[] )
375 module_loadorder_t tmp
, *res
;
377 tmp
.modulename
= module
;
378 if ((res
= bsearch(&tmp
, list
->order
, list
->count
, sizeof(list
->order
[0]), cmp_sort_func
)))
379 memcpy( lo
, res
->loadorder
, sizeof(res
->loadorder
) );
380 return (res
!= NULL
);
384 /***************************************************************************
387 * Get the load order for a given module from the app-specific DllOverrides list.
388 * Also look for default '*' key if no module key found.
390 static BOOL
get_app_load_order( const char *module
, enum loadorder_type lo
[], BOOL
*got_default
)
393 DWORD count
, type
, res
;
394 char buffer
[MAX_PATH
+16], *appname
, *p
;
396 if (!GetModuleFileName16( GetCurrentTask(), buffer
, MAX_PATH
) &&
397 !GetModuleFileNameA( 0, buffer
, MAX_PATH
))
399 WARN( "could not get module file name loading %s\n", module
);
403 if ((p
= strrchr( appname
, '/' ))) appname
= p
+ 1;
404 if ((p
= strrchr( appname
, '\\' ))) appname
= p
+ 1;
406 TRACE( "searching '%s' in AppDefaults\\%s\\DllOverrides\n", module
, appname
);
408 if (RegOpenKeyA( HKEY_LOCAL_MACHINE
, "Software\\Wine\\Wine\\Config\\AppDefaults", &hkey
))
411 /* open AppDefaults\\appname\\DllOverrides key */
412 strcat( appname
, "\\DllOverrides" );
413 res
= RegOpenKeyA( hkey
, appname
, &appkey
);
415 if (res
) return FALSE
;
417 count
= sizeof(buffer
);
418 if ((res
= RegQueryValueExA( appkey
, module
, NULL
, &type
, buffer
, &count
)))
420 if (!(res
= RegQueryValueExA( appkey
, "*", NULL
, &type
, buffer
, &count
)))
423 else TRACE( "got app loadorder '%s' for '%s'\n", buffer
, module
);
424 RegCloseKey( appkey
);
425 if (res
) return FALSE
;
426 return ParseLoadOrder( buffer
, lo
);
430 /***************************************************************************
431 * get_standard_load_order
433 * Get the load order for a given module from the main DllOverrides list
434 * Also look for default '*' key if no module key found.
436 static BOOL
get_standard_load_order( const char *module
, enum loadorder_type lo
[],
440 DWORD count
, type
, res
;
443 if (RegOpenKeyA( HKEY_LOCAL_MACHINE
, "Software\\Wine\\Wine\\Config\\DllOverrides", &hkey
))
446 count
= sizeof(buffer
);
447 if ((res
= RegQueryValueExA( hkey
, module
, NULL
, &type
, buffer
, &count
)))
449 if (!(res
= RegQueryValueExA( hkey
, "*", NULL
, &type
, buffer
, &count
)))
452 else TRACE( "got standard loadorder '%s' for '%s'\n", buffer
, module
);
454 if (res
) return FALSE
;
455 return ParseLoadOrder( buffer
, lo
);
459 /***************************************************************************
460 * get_default_load_order
462 * Get the default load order if nothing specified for a given dll.
464 static void get_default_load_order( enum loadorder_type lo
[] )
467 static enum loadorder_type default_loadorder
[LOADORDER_NTYPES
];
475 if (!(res
= RegOpenKeyA( HKEY_LOCAL_MACHINE
,
476 "Software\\Wine\\Wine\\Config\\DllDefaults", &hkey
)))
478 DWORD type
, count
= sizeof(buffer
);
480 res
= RegQueryValueExA( hkey
, "DefaultLoadOrder", NULL
, &type
, buffer
, &count
);
483 if (res
) strcpy( buffer
, "n,b,s" );
484 ParseLoadOrder( buffer
, default_loadorder
);
486 TRACE( "got default loadorder '%s'\n", buffer
);
488 memcpy( lo
, default_loadorder
, sizeof(default_loadorder
) );
492 /***************************************************************************
493 * MODULE_GetLoadOrder (internal)
495 * Locate the loadorder of a module.
496 * Any path is stripped from the path-argument and so are the extension
497 * '.dll' and '.exe'. A lookup in the table can yield an override for
498 * the specific dll. Otherwise the default load order is returned.
500 void MODULE_GetLoadOrder( enum loadorder_type loadorder
[], const char *path
, BOOL win32
)
503 char sysdir
[MAX_PATH
+1];
507 BOOL got_app_default
= FALSE
, got_std_default
= FALSE
;
508 enum loadorder_type lo_default
[LOADORDER_NTYPES
];
510 TRACE("looking for %s\n", path
);
512 if ( ! GetSystemDirectoryA ( sysdir
, MAX_PATH
) ) goto done
;
514 /* Strip path information for 16 bit modules or if the module
515 resides in the system directory */
516 if ( !win32
|| !FILE_strncasecmp ( sysdir
, path
, strlen (sysdir
) ) )
519 cptr
= strrchr(path
, '\\');
521 name
= strrchr(path
, '/');
523 name
= strrchr(cptr
, '/');
526 name
= cptr
? cptr
+1 : (char *)path
;
530 if((cptr
= strchr(name
, ':')) != NULL
) /* Also strip drive if in format 'C:MODULE.DLL' */
537 if(len
>= sizeof(fname
) || len
<= 0)
539 WARN("Path '%s' -> '%s' reduces to zilch or just too large...\n", path
, name
);
544 if(len
>= 4 && (!FILE_strcasecmp(fname
+len
-4, ".dll") || !FILE_strcasecmp(fname
+len
-4, ".exe")))
547 /* check command-line first */
548 if (get_list_load_order( fname
, &cmdline_list
, loadorder
)) return;
550 /* then app-specific config */
551 if (get_app_load_order( fname
, loadorder
, &got_app_default
))
553 if (!got_app_default
) return;
554 /* save the default value for later on */
555 memcpy( lo_default
, loadorder
, sizeof(lo_default
) );
558 /* then standard config */
559 if (get_standard_load_order( fname
, loadorder
, &got_std_default
))
561 if (!got_std_default
) return;
562 /* save the default value for later on */
563 if (!got_app_default
) memcpy( lo_default
, loadorder
, sizeof(lo_default
) );
566 /* then compiled-in defaults */
567 if (get_list_load_order( fname
, &default_list
, loadorder
)) return;
570 /* last, return the default */
571 if (got_app_default
|| got_std_default
)
572 memcpy( loadorder
, lo_default
, sizeof(lo_default
) );
574 get_default_load_order( loadorder
);