2 * Module/Library loadorder
4 * Copyright 1999 Bertho Stultiens
14 #include "loadorder.h"
18 #include "debugtools.h"
20 DEFAULT_DEBUG_CHANNEL(module
)
23 /* #define DEBUG_LOADORDER */
25 #define LOADORDER_ALLOC_CLUSTER 32 /* Allocate with 32 entries at a time */
27 static module_loadorder_t default_loadorder
;
28 static module_loadorder_t
*module_loadorder
= NULL
;
29 static int nmodule_loadorder
= 0;
30 static int nmodule_loadorder_alloc
= 0;
32 static struct tagDllOverride
{
34 } DefaultDllOverrides
[] = {
35 {"kernel32,gdi32,user32", "builtin"},
36 {"krnl386,gdi,user", "builtin"},
37 {"toolhelp", "builtin"},
38 {"comdlg32,commdlg", "elfdll,builtin,native"},
39 {"version,ver", "elfdll,builtin,native"},
40 {"shell32,shell", "builtin,native"},
41 {"shlwapi", "native,builtin"},
42 {"lz32,lzexpand", "builtin,native"},
43 {"commctrl,comctl32", "builtin,native"},
44 {"wsock32,winsock", "builtin"},
45 {"ws2_32", "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"},
60 /* we have to use libglide2x.so instead of glide2x.dll ... */
61 {"glide2x", "so,native"},
62 {"glide3x", "so,native"},
63 {"odbc32", "builtin"},
64 {"opengl32", "builtin,native"},
65 {"shfolder", "builtin,native"},
66 {"rpcrt4", "native,builtin"},
70 static const struct tagDllPair
{
71 const char *dll1
, *dll2
;
73 { "krnl386", "kernel32" },
76 { "commdlg", "comdlg32" },
77 { "commctrl", "comctl32" },
79 { "shell", "shell32" },
80 { "lzexpand", "lz32" },
81 { "mmsystem", "winmm" },
82 { "msvideo", "msvfw32" },
83 { "winsock", "wsock32" },
87 /***************************************************************************
88 * cmp_sort_func (internal, static)
90 * Sorting and comparing function used in sort and search of loadorder
93 static int cmp_sort_func(const void *s1
, const void *s2
)
95 return strcasecmp(((module_loadorder_t
*)s1
)->modulename
, ((module_loadorder_t
*)s2
)->modulename
);
99 /***************************************************************************
100 * get_tok (internal, static)
102 * strtok wrapper for non-destructive buffer writing.
103 * NOTE: strtok is not reentrant and therefore this code is neither.
105 static char *get_tok(const char *str
, const char *delim
)
107 static char *buf
= NULL
;
115 HeapFree(GetProcessHeap(), 0, buf
);
121 buf
= HEAP_strdupA(GetProcessHeap(), 0, str
);
122 cptr
= strtok(buf
, delim
);
126 cptr
= strtok(NULL
, delim
);
131 HeapFree(GetProcessHeap(), 0, buf
);
138 /***************************************************************************
139 * ParseLoadOrder (internal, static)
141 * Parses the loadorder options from the configuration and puts it into
144 static BOOL
ParseLoadOrder(char *order
, module_loadorder_t
*mlo
)
149 memset(mlo
->loadorder
, 0, sizeof(mlo
->loadorder
));
151 cptr
= get_tok(order
, ", \t");
154 char type
= MODULE_LOADORDER_INVALID
;
156 if(n
>= MODULE_LOADORDER_NTYPES
)
158 ERR("More than existing %d module-types specified, rest ignored", MODULE_LOADORDER_NTYPES
);
164 case 'N': /* Native */
165 case 'n': type
= MODULE_LOADORDER_DLL
; break;
167 case 'E': /* Elfdll */
168 case 'e': type
= MODULE_LOADORDER_ELFDLL
; break;
171 case 's': type
= MODULE_LOADORDER_SO
; break;
173 case 'B': /* Builtin */
174 case 'b': type
= MODULE_LOADORDER_BI
; break;
177 ERR("Invalid load order module-type '%s', ignored\n", cptr
);
180 if(type
!= MODULE_LOADORDER_INVALID
)
182 mlo
->loadorder
[n
++] = type
;
184 cptr
= get_tok(NULL
, ", \t");
190 /***************************************************************************
191 * AddLoadOrder (internal, static)
193 * Adds an entry in the list of overrides. If the entry exists, then the
194 * override parameter determines whether it will be overwritten.
196 static BOOL
AddLoadOrder(module_loadorder_t
*plo
, BOOL override
)
200 /* TRACE(module, "'%s' -> %08lx\n", plo->modulename, *(DWORD *)(plo->loadorder)); */
202 for(i
= 0; i
< nmodule_loadorder
; i
++)
204 if(!cmp_sort_func(plo
, &module_loadorder
[i
]))
207 ERR("Module '%s' is already in the list of overrides, using first definition\n", plo
->modulename
);
209 memcpy(module_loadorder
[i
].loadorder
, plo
->loadorder
, sizeof(plo
->loadorder
));
214 if(nmodule_loadorder
>= nmodule_loadorder_alloc
)
216 /* No space in current array, make it larger */
217 nmodule_loadorder_alloc
+= LOADORDER_ALLOC_CLUSTER
;
218 module_loadorder
= (module_loadorder_t
*)HeapReAlloc(GetProcessHeap(),
221 nmodule_loadorder_alloc
* sizeof(module_loadorder_t
));
222 if(!module_loadorder
)
224 MESSAGE("Virtual memory exhausted\n");
228 memcpy(module_loadorder
[nmodule_loadorder
].loadorder
, plo
->loadorder
, sizeof(plo
->loadorder
));
229 module_loadorder
[nmodule_loadorder
].modulename
= HEAP_strdupA(GetProcessHeap(), 0, plo
->modulename
);
235 /***************************************************************************
236 * AddLoadOrderSet (internal, static)
238 * Adds a set of entries in the list of overrides from the key parameter.
239 * If the entry exists, then the override parameter determines whether it
240 * will be overwritten.
242 static BOOL
AddLoadOrderSet(char *key
, char *order
, BOOL override
)
244 module_loadorder_t ldo
;
247 /* Parse the loadorder before the rest because strtok is not reentrant */
248 if(!ParseLoadOrder(order
, &ldo
))
251 cptr
= get_tok(key
, ", \t");
254 char *ext
= strrchr(cptr
, '.');
257 if(strlen(ext
) == 4 && (!strcasecmp(ext
, ".dll") || !strcasecmp(ext
, ".exe")))
258 MESSAGE("Warning: Loadorder override '%s' contains an extension and might not be found during lookup\n", cptr
);
261 ldo
.modulename
= cptr
;
262 if(!AddLoadOrder(&ldo
, override
))
264 cptr
= get_tok(NULL
, ", \t");
270 /***************************************************************************
271 * ParseCommandlineOverrides (internal, static)
273 * The commandline is in the form:
274 * name[,name,...]=native[,b,...][:...]
276 static BOOL
ParseCommandlineOverrides(void)
284 if(!Options
.dllFlags
)
287 cpy
= HEAP_strdupA(GetProcessHeap(), 0, Options
.dllFlags
);
290 for(; next
; key
= next
)
292 next
= strchr(key
, ':');
298 value
= strchr(key
, '=');
307 TRACE("Commandline override '%s' = '%s'\n", key
, value
);
309 if(!AddLoadOrderSet(key
, value
, TRUE
))
316 HeapFree(GetProcessHeap(), 0, cpy
);
321 /***************************************************************************
322 * MODULE_InitLoadOrder (internal)
324 * Initialize the load order from the wine.conf file.
325 * The section has the following format:
330 * EXTRA_LD_LIBRARY_PATH=/usr/local/lib/wine[:/more/path/to/search[:...]]
331 * The path will be appended to any existing LD_LIBRARY_PATH from the
332 * environment (see note in code below).
334 * DefaultLoadOrder=native,elfdll,so,builtin
335 * A comma separated list of module types to try to load in that specific
336 * order. The DefaultLoadOrder key is used as a fallback when a module is
337 * not specified explicitly. If the DefaultLoadOrder key is not found,
338 * then the order "dll,elfdll,so,bi" is used
339 * The possible module types are:
340 * - native Native windows dll files
341 * - elfdll Dlls encapsulated in .so libraries
342 * - so Native .so libraries mapped to dlls
343 * - builtin Built-in modules
345 * Case is not important and only the first letter of each type is enough to
346 * identify the type n[ative], e[lfdll], s[o], b[uiltin]. Also whitespace is
351 * native,elfdll,so,builtin
357 * There are no explicit keys defined other than module/library names. A comma
358 * separated list of modules is followed by an assignment of the load-order
359 * for these specific modules. See above for possible types. You should not
360 * specify an extension.
362 * kernel32, gdi32, user32 = builtin
363 * kernel, gdi, user = builtin
364 * comdlg32 = elfdll, native, builtin
365 * commdlg = native, builtin
366 * version, ver = elfdll, native, builtin
370 #define BUFFERSIZE 1024
372 BOOL
MODULE_InitLoadOrder(void)
374 char buffer
[BUFFERSIZE
];
378 const struct tagDllPair
*dllpair
;
380 #if defined(HAVE_DL_API)
381 /* Get/set the new LD_LIBRARY_PATH */
382 nbuffer
= PROFILE_GetWineIniString("DllDefaults", "EXTRA_LD_LIBRARY_PATH", "", buffer
, sizeof(buffer
));
386 extra_ld_library_path
= HEAP_strdupA(GetProcessHeap(), 0, buffer
);
387 TRACE("Setting extra LD_LIBRARY_PATH=%s\n", buffer
);
391 /* Get the default load order */
392 nbuffer
= PROFILE_GetWineIniString("DllDefaults", "DefaultLoadOrder", "n,b,e,s", buffer
, sizeof(buffer
));
395 MESSAGE("MODULE_InitLoadOrder: mysteriously read nothing from default loadorder\n");
399 TRACE("Setting default loadorder=%s\n", buffer
);
401 if(!ParseLoadOrder(buffer
, &default_loadorder
))
403 default_loadorder
.modulename
= "<none>";
407 for (i
=0;DefaultDllOverrides
[i
].key
;i
++)
409 DefaultDllOverrides
[i
].key
,
410 DefaultDllOverrides
[i
].value
,
415 /* Read the explicitely defined orders for specific modules as an entire section */
417 while (PROFILE_EnumWineIniString( "DllOverrides", idx
++, key
, sizeof(key
),
418 buffer
, sizeof(buffer
)))
420 TRACE("Key '%s' uses override '%s'\n", key
, buffer
);
421 if(!AddLoadOrderSet(key
, buffer
, TRUE
))
425 /* Add the commandline overrides to the pool */
426 if(!ParseCommandlineOverrides())
428 MESSAGE( "Syntax: -dll name[,name[,...]]={native|elfdll|so|builtin}[,{n|e|s|b}[,...]][:...]\n"
429 " - 'name' is the name of any dll without extension\n"
430 " - the order of loading (native, elfdll, so and builtin) can be abbreviated\n"
431 " with the first letter\n"
432 " - different loadorders for different dlls can be specified by seperating the\n"
433 " commandline entries with a ':'\n"
435 " -dll comdlg32,commdlg=n:shell,shell32=b\n"
440 /* Sort the array for quick lookup */
441 qsort(module_loadorder
, nmodule_loadorder
, sizeof(module_loadorder
[0]), cmp_sort_func
);
443 /* Check the pairs of dlls */
445 while (dllpair
->dll1
)
447 module_loadorder_t
*plo1
, *plo2
;
448 plo1
= MODULE_GetLoadOrder(dllpair
->dll1
);
449 plo2
= MODULE_GetLoadOrder(dllpair
->dll2
);
450 assert(plo1
&& plo2
);
451 if(memcmp(plo1
->loadorder
, plo2
->loadorder
, sizeof(plo1
->loadorder
)))
452 MESSAGE("Warning: Modules '%s' and '%s' have different loadorder which may cause trouble\n", dllpair
->dll1
, dllpair
->dll2
);
459 static char types
[6] = "-NESB";
461 for(i
= 0; i
< nmodule_loadorder
; i
++)
463 DPRINTF("%3d: %-12s:", i
, module_loadorder
[i
].modulename
);
464 for(j
= 0; j
< MODULE_LOADORDER_NTYPES
; j
++)
465 DPRINTF(" %c", types
[module_loadorder
[i
].loadorder
[j
] % (MODULE_LOADORDER_NTYPES
+1)]);
474 /***************************************************************************
475 * MODULE_GetLoadOrder (internal)
477 * Locate the loadorder of a module.
478 * Any path is stripped from the path-argument and so are the extension
479 * '.dll' and '.exe'. A lookup in the table can yield an override for
480 * the specific dll. Otherwise the default load order is returned.
482 module_loadorder_t
*MODULE_GetLoadOrder(const char *path
)
484 module_loadorder_t lo
, *tmp
;
490 TRACE("looking for %s\n", path
);
492 assert(path
!= NULL
);
494 /* Strip path information */
495 cptr
= strrchr(path
, '\\');
497 name
= strrchr(path
, '/');
499 name
= strrchr(cptr
, '/');
502 name
= cptr
? cptr
+1 : (char *)path
;
506 if((cptr
= strchr(name
, ':')) != NULL
) /* Also strip drive if in format 'C:MODULE.DLL' */
510 if(len
>= sizeof(fname
) || len
<= 0)
512 ERR("Path '%s' -> '%s' reduces to zilch or just too large...\n", path
, name
);
513 return &default_loadorder
;
517 if(len
>= 4 && (!lstrcmpiA(fname
+len
-4, ".dll") || !lstrcmpiA(fname
+len
-4, ".exe")))
520 lo
.modulename
= fname
;
521 tmp
= bsearch(&lo
, module_loadorder
, nmodule_loadorder
, sizeof(module_loadorder
[0]), cmp_sort_func
);
523 TRACE("Looking for '%s' (%s), found '%s'\n", path
, fname
, tmp
? tmp
->modulename
: "<nothing>");
526 return &default_loadorder
;