2 * Module/Library loadorder
4 * Copyright 1999 Bertho Stultiens
14 #include "loadorder.h"
19 #include "debugtools.h"
21 DEFAULT_DEBUG_CHANNEL(module
)
24 /* #define DEBUG_LOADORDER */
26 #define LOADORDER_ALLOC_CLUSTER 32 /* Allocate with 32 entries at a time */
28 static module_loadorder_t default_loadorder
;
29 static module_loadorder_t
*module_loadorder
= NULL
;
30 static int nmodule_loadorder
= 0;
31 static int nmodule_loadorder_alloc
= 0;
33 static struct tagDllOverride
{
35 } DefaultDllOverrides
[] = {
36 {"kernel32,gdi32,user32", "builtin"},
37 {"krnl386,gdi,user", "builtin"},
38 {"toolhelp", "builtin"},
39 {"comdlg32,commdlg", "elfdll,builtin,native"},
40 {"version,ver", "elfdll,builtin,native"},
41 {"shell32,shell", "builtin,native"},
42 {"shlwapi", "native,builtin"},
43 {"lz32,lzexpand", "builtin,native"},
44 {"commctrl,comctl32", "builtin,native"},
45 {"wsock32,winsock", "builtin"},
46 {"advapi32,crtdll,ntdll", "builtin,native"},
47 {"mpr,winspool.drv", "builtin,native"},
48 {"ddraw,dinput,dsound", "builtin,native"},
49 {"winmm, mmsystem", "builtin"},
50 {"msvideo, msvfw32", "builtin, native"},
51 {"mcicda.drv, mciseq.drv", "builtin, native"},
52 {"mciwave.drv", "builtin, native"},
53 {"mciavi.drv, mcianim.drv", "native, builtin"},
54 {"msacm.drv, midimap.drv", "builtin, native"},
55 {"w32skrnl", "builtin"},
56 {"wnaspi32,wow32", "builtin"},
57 {"system,display,wprocs ", "builtin"},
58 {"wineps", "builtin"},
59 /* we have to use libglide2x.so instead of glide2x.dll ... */
60 {"glide2x", "so,native"},
64 /***************************************************************************
65 * cmp_sort_func (internal, static)
67 * Sorting and comparing function used in sort and search of loadorder
70 static int cmp_sort_func(const void *s1
, const void *s2
)
72 return strcasecmp(((module_loadorder_t
*)s1
)->modulename
, ((module_loadorder_t
*)s2
)->modulename
);
76 /***************************************************************************
77 * get_tok (internal, static)
79 * strtok wrapper for non-destructive buffer writing.
80 * NOTE: strtok is not reentrant and therefore this code is neither.
82 static char *get_tok(const char *str
, const char *delim
)
84 static char *buf
= NULL
;
92 HeapFree(SystemHeap
, 0, buf
);
98 buf
= HEAP_strdupA(SystemHeap
, 0, str
);
99 cptr
= strtok(buf
, delim
);
103 cptr
= strtok(NULL
, delim
);
108 HeapFree(SystemHeap
, 0, buf
);
115 /***************************************************************************
116 * ParseLoadOrder (internal, static)
118 * Parses the loadorder options from the configuration and puts it into
121 static BOOL
ParseLoadOrder(char *order
, module_loadorder_t
*mlo
)
126 memset(mlo
->loadorder
, 0, sizeof(mlo
->loadorder
));
128 cptr
= get_tok(order
, ", \t");
131 char type
= MODULE_LOADORDER_INVALID
;
133 if(n
>= MODULE_LOADORDER_NTYPES
)
135 ERR("More than existing %d module-types specified, rest ignored", MODULE_LOADORDER_NTYPES
);
141 case 'N': /* Native */
142 case 'n': type
= MODULE_LOADORDER_DLL
; break;
144 case 'E': /* Elfdll */
145 case 'e': type
= MODULE_LOADORDER_ELFDLL
; break;
148 case 's': type
= MODULE_LOADORDER_SO
; break;
150 case 'B': /* Builtin */
151 case 'b': type
= MODULE_LOADORDER_BI
; break;
154 ERR("Invalid load order module-type '%s', ignored\n", cptr
);
157 if(type
!= MODULE_LOADORDER_INVALID
)
159 mlo
->loadorder
[n
++] = type
;
161 cptr
= get_tok(NULL
, ", \t");
167 /***************************************************************************
168 * AddLoadOrder (internal, static)
170 * Adds an entry in the list of overrides. If the entry exists then the
171 * override parameter determines whether it will be overwriten.
173 static BOOL
AddLoadOrder(module_loadorder_t
*plo
, BOOL override
)
177 /* TRACE(module, "'%s' -> %08lx\n", plo->modulename, *(DWORD *)(plo->loadorder)); */
179 for(i
= 0; i
< nmodule_loadorder
; i
++)
181 if(!cmp_sort_func(plo
, &module_loadorder
[i
]))
184 ERR("Module '%s' is already in the list of overrides, using first definition\n", plo
->modulename
);
186 memcpy(module_loadorder
[i
].loadorder
, plo
->loadorder
, sizeof(plo
->loadorder
));
191 if(nmodule_loadorder
>= nmodule_loadorder_alloc
)
193 /* No space in current array, make it larger */
194 nmodule_loadorder_alloc
+= LOADORDER_ALLOC_CLUSTER
;
195 module_loadorder
= (module_loadorder_t
*)HeapReAlloc(SystemHeap
,
198 nmodule_loadorder_alloc
* sizeof(module_loadorder_t
));
199 if(!module_loadorder
)
201 MESSAGE("Virtual memory exhausted\n");
205 memcpy(module_loadorder
[nmodule_loadorder
].loadorder
, plo
->loadorder
, sizeof(plo
->loadorder
));
206 module_loadorder
[nmodule_loadorder
].modulename
= HEAP_strdupA(SystemHeap
, 0, plo
->modulename
);
212 /***************************************************************************
213 * AddLoadOrderSet (internal, static)
215 * Adds an set of entries in the list of overrides from the key parameter.
216 * If the entry exists then the override parameter determines whether it
217 * will be overwriten.
219 static BOOL
AddLoadOrderSet(char *key
, char *order
, BOOL override
)
221 module_loadorder_t ldo
;
224 /* Parse the loadorder before the rest because strtok is not reentrant */
225 if(!ParseLoadOrder(order
, &ldo
))
228 cptr
= get_tok(key
, ", \t");
231 char *ext
= strrchr(cptr
, '.');
234 if(strlen(ext
) == 4 && (!strcasecmp(ext
, ".dll") || !strcasecmp(ext
, ".exe")))
235 MESSAGE("Warning: Loadorder override '%s' contains an extension and might not be found during lookup\n", cptr
);
238 ldo
.modulename
= cptr
;
239 if(!AddLoadOrder(&ldo
, override
))
241 cptr
= get_tok(NULL
, ", \t");
247 /***************************************************************************
248 * ParseCommandlineOverrides (internal, static)
250 * The commandline is in the form:
251 * name[,name,...]=native[,b,...][:...]
253 static BOOL
ParseCommandlineOverrides(void)
261 if(!Options
.dllFlags
)
264 cpy
= HEAP_strdupA(SystemHeap
, 0, Options
.dllFlags
);
267 for(; next
; key
= next
)
269 next
= strchr(key
, ':');
275 value
= strchr(key
, '=');
284 TRACE("Commandline override '%s' = '%s'\n", key
, value
);
286 if(!AddLoadOrderSet(key
, value
, TRUE
))
293 HeapFree(SystemHeap
, 0, cpy
);
298 /***************************************************************************
299 * MODULE_InitLoadOrder (internal)
301 * Initialize the load order from the wine.conf file.
302 * The section has tyhe following format:
307 * EXTRA_LD_LIBRARY_PATH=/usr/local/lib/wine[:/more/path/to/search[:...]]
308 * The path will be appended to any existing LD_LIBRARY_PATH from the
309 * environment (see note in code below).
311 * DefaultLoadOrder=native,elfdll,so,builtin
312 * A comma seperated list of module-types to try to load in that specific
313 * order. The DefaultLoadOrder key is used as a fallback when a module is
314 * not specified explicitely. If the DefaultLoadOrder key is not found,
315 * then the order "dll,elfdll,so,bi" is used
316 * The possible module-types are:
317 * - native Native windows dll files
318 * - elfdll Dlls encapsulated in .so libraries
319 * - so Native .so libraries mapped to dlls
320 * - builtin Built-in modules
322 * Case is not important and only the first letter of each type is enough to
323 * identify the type n[ative], e[lfdll], s[o], b[uiltin]. Also whitespace is
328 * native,elfdll,so,builtin
334 * There are no explicit keys defined other than module/library names. A comma
335 * separated list of modules is followed by an assignment of the load-order
336 * for these specific modules. See above for possible types. You should not
337 * specify an extension.
339 * kernel32, gdi32, user32 = builtin
340 * kernel, gdi, user = builtin
341 * comdlg32 = elfdll, native, builtin
342 * commdlg = native, builtin
343 * version, ver = elfdll, native, builtin
349 * This is a simple pairing in the form 'name1 = name2'. It is supposed to
350 * identify the dlls that cannot live without eachother unless they are
351 * loaded in the same format. Examples are common dialogs and controls,
352 * shell, kernel, gdi, user, etc...
353 * The code will issue a warning if the loadorder of these pairs are different
354 * and might cause hard-to-find bugs due to incompatible pairs loaded at
355 * run-time. Note that this pairing gives *no* guarantee that the pairs
356 * actually get loaded as the same type, nor that the correct versions are
357 * loaded (might be implemented later). It merely notes obvious trouble.
364 #define BUFFERSIZE 1024
366 BOOL
MODULE_InitLoadOrder(void)
368 char buffer
[BUFFERSIZE
];
371 #if defined(HAVE_DL_API)
372 /* Get/set the new LD_LIBRARY_PATH */
373 nbuffer
= PROFILE_GetWineIniString("DllDefaults", "EXTRA_LD_LIBRARY_PATH", "", buffer
, sizeof(buffer
));
377 extra_ld_library_path
= HEAP_strdupA(SystemHeap
, 0, buffer
);
378 TRACE("Setting extra LD_LIBRARY_PATH=%s\n", buffer
);
382 /* Get the default load order */
383 nbuffer
= PROFILE_GetWineIniString("DllDefaults", "DefaultLoadOrder", "n,e,s,b", buffer
, sizeof(buffer
));
386 MESSAGE("MODULE_InitLoadOrder: misteriously read nothing from default loadorder\n");
390 TRACE("Setting default loadorder=%s\n", buffer
);
392 if(!ParseLoadOrder(buffer
, &default_loadorder
))
394 default_loadorder
.modulename
= "<none>";
398 for (i
=0;DefaultDllOverrides
[i
].key
;i
++)
400 DefaultDllOverrides
[i
].key
,
401 DefaultDllOverrides
[i
].value
,
406 /* Read the explicitely defined orders for specific modules as an entire section */
407 nbuffer
= PROFILE_GetWineIniString("DllOverrides", NULL
, "", buffer
, sizeof(buffer
));
408 if(nbuffer
== BUFFERSIZE
-2)
410 ERR("BUFFERSIZE %d is too small to read [DllOverrides]. Needs to grow in the source\n", BUFFERSIZE
);
415 /* We only have the keys in the buffer, not the values */
417 char value
[BUFFERSIZE
];
420 for(key
= buffer
; *key
; key
= next
)
422 next
= key
+ strlen(key
) + 1;
424 nbuffer
= PROFILE_GetWineIniString("DllOverrides", key
, "", value
, sizeof(value
));
427 ERR("Module(s) '%s' will always fail to load. Are you sure you want this?\n", key
);
428 value
[0] = '\0'; /* Just in case */
430 if(nbuffer
== BUFFERSIZE
-2)
432 ERR("BUFFERSIZE %d is too small to read [DllOverrides] key '%s'. Needs to grow in the source\n", BUFFERSIZE
, key
);
436 TRACE("Key '%s' uses override '%s'\n", key
, value
);
438 if(!AddLoadOrderSet(key
, value
, TRUE
))
443 /* Add the commandline overrides to the pool */
444 if(!ParseCommandlineOverrides())
446 MESSAGE( "Syntax: -dll name[,name[,...]]={native|elfdll|so|builtin}[,{n|e|s|b}[,...]][:...]\n"
447 " - 'name' is the name of any dll without extension\n"
448 " - the order of loading (native, elfdll, so and builtin) can be abbreviated\n"
449 " with the first letter\n"
450 " - different loadorders for different dlls can be specified by seperating the\n"
451 " commandline entries with a ':'\n"
453 " -dll comdlg32,commdlg=n:shell,shell32=b\n"
458 /* Sort the array for quick lookup */
459 qsort(module_loadorder
, nmodule_loadorder
, sizeof(module_loadorder
[0]), cmp_sort_func
);
461 /* Check the pairs of dlls */
462 nbuffer
= PROFILE_GetWineIniString("DllPairs", NULL
, "", buffer
, sizeof(buffer
));
463 if(nbuffer
== BUFFERSIZE
-2)
465 ERR("BUFFERSIZE %d is too small to read [DllPairs]. Needs to grow in the source\n", BUFFERSIZE
);
470 /* We only have the keys in the buffer, not the values */
472 char value
[BUFFERSIZE
];
475 for(key
= buffer
; *key
; key
= next
)
477 module_loadorder_t
*plo1
, *plo2
;
479 next
= key
+ strlen(key
) + 1;
481 nbuffer
= PROFILE_GetWineIniString("DllPairs", key
, "", value
, sizeof(value
));
484 ERR("Module pair '%s' is not associated with another module?\n", key
);
487 if(nbuffer
== BUFFERSIZE
-2)
489 ERR("BUFFERSIZE %d is too small to read [DllPairs] key '%s'. Needs to grow in the source\n", BUFFERSIZE
, key
);
493 plo1
= MODULE_GetLoadOrder(key
);
494 plo2
= MODULE_GetLoadOrder(value
);
495 assert(plo1
&& plo2
);
497 if(memcmp(plo1
->loadorder
, plo2
->loadorder
, sizeof(plo1
->loadorder
)))
498 MESSAGE("Warning: Modules '%s' and '%s' have different loadorder which may cause trouble\n", key
, value
);
505 static char types
[6] = "-NESB";
507 for(i
= 0; i
< nmodule_loadorder
; i
++)
509 DPRINTF("%3d: %-12s:", i
, module_loadorder
[i
].modulename
);
510 for(j
= 0; j
< MODULE_LOADORDER_NTYPES
; j
++)
511 DPRINTF(" %c", types
[module_loadorder
[i
].loadorder
[j
] % (MODULE_LOADORDER_NTYPES
+1)]);
520 /***************************************************************************
521 * MODULE_GetLoadOrder (internal)
523 * Locate the loadorder of a module.
524 * Any path is stripped from the path-argument and so are the extension
525 * '.dll' and '.exe'. A lookup in the table can yield an override for
526 * the specific dll. Otherwise the default load order is returned.
528 module_loadorder_t
*MODULE_GetLoadOrder(const char *path
)
530 module_loadorder_t lo
, *tmp
;
536 assert(path
!= NULL
);
538 /* Strip path information */
539 cptr
= strrchr(path
, '\\');
541 name
= strrchr(path
, '/');
543 name
= strrchr(cptr
, '/');
546 name
= cptr
? cptr
+1 : (char *)path
;
550 if((cptr
= strchr(name
, ':')) != NULL
) /* Also strip drive if in format 'C:MODULE.DLL' */
554 if(len
>= sizeof(fname
) || len
<= 0)
556 ERR("Path '%s' -> '%s' reduces to zilch or just too large...\n", path
, name
);
557 return &default_loadorder
;
561 if(len
>= 4 && (!lstrcmpiA(fname
+len
-4, ".dll") || !lstrcmpiA(fname
+len
-4, ".exe")))
564 lo
.modulename
= fname
;
565 tmp
= bsearch(&lo
, module_loadorder
, nmodule_loadorder
, sizeof(module_loadorder
[0]), cmp_sort_func
);
567 TRACE("Looking for '%s' (%s), found '%s'\n", path
, fname
, tmp
? tmp
->modulename
: "<nothing>");
570 return &default_loadorder
;