loadorder.c 17.5 KB
Newer Older
1 2 3 4 5 6
/*
 * Module/Library loadorder
 *
 * Copyright 1999 Bertho Stultiens
 */

7 8
#include "config.h"

9 10 11 12 13
#include <stdlib.h>
#include <string.h>
#include <assert.h>

#include "windef.h"
14 15
#include "winreg.h"
#include "winerror.h"
16
#include "options.h"
17
#include "file.h"
18
#include "module.h"
19
#include "debugtools.h"
20

21
DEFAULT_DEBUG_CHANNEL(module);
22

23
#define LOADORDER_ALLOC_CLUSTER	32	/* Allocate with 32 entries at a time */
24

25 26 27 28 29
typedef struct module_loadorder
{
    const char         *modulename;
    enum loadorder_type loadorder[LOADORDER_NTYPES];
} module_loadorder_t;
30

31 32 33 34 35 36
struct loadorder_list
{
    int                 count;
    int                 alloc;
    module_loadorder_t *order;
};
37

38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
/* default load-order if nothing specified */
/* the list must remain sorted by dll name */
static module_loadorder_t default_order_list[] =
{
    { "display",      { LOADORDER_BI,  0,             0, 0 } },
    { "gdi",          { LOADORDER_BI,  0,             0, 0 } },
    { "gdi32",        { LOADORDER_BI,  0,             0, 0 } },
    { "glide2x",      { LOADORDER_SO,  LOADORDER_DLL, 0, 0 } },
    { "glide3x",      { LOADORDER_SO,  LOADORDER_DLL, 0, 0 } },
    { "icmp",         { LOADORDER_BI,  0,             0, 0 } },
    { "kernel",       { LOADORDER_BI,  0,             0, 0 } },
    { "kernel32",     { LOADORDER_BI,  0,             0, 0 } },
    { "keyboard",     { LOADORDER_BI,  0,             0, 0 } },
    { "krnl386",      { LOADORDER_BI,  0,             0, 0 } },
    { "mmsystem",     { LOADORDER_BI,  0,             0, 0 } },
    { "mouse",        { LOADORDER_BI,  0,             0, 0 } },
    { "ntdll",        { LOADORDER_BI,  0,             0, 0 } },
    { "odbc32",       { LOADORDER_BI,  0,             0, 0 } },
    { "system",       { LOADORDER_BI,  0,             0, 0 } },
    { "toolhelp",     { LOADORDER_BI,  0,             0, 0 } },
    { "ttydrv",       { LOADORDER_BI,  0,             0, 0 } },
    { "user",         { LOADORDER_BI,  0,             0, 0 } },
    { "user32",       { LOADORDER_BI,  0,             0, 0 } },
    { "w32skrnl",     { LOADORDER_BI,  0,             0, 0 } },
    { "winaspi",      { LOADORDER_BI,  0,             0, 0 } },
    { "windebug",     { LOADORDER_DLL, LOADORDER_BI,  0, 0 } },
    { "winedos",      { LOADORDER_BI,  0,             0, 0 } },
    { "wineps",       { LOADORDER_BI,  0,             0, 0 } },
    { "wing",         { LOADORDER_BI,  0,             0, 0 } },
    { "winmm",        { LOADORDER_BI,  0,             0, 0 } },
    { "winsock",      { LOADORDER_BI,  0,             0, 0 } },
    { "wnaspi32",     { LOADORDER_BI,  0,             0, 0 } },
    { "wow32",        { LOADORDER_BI,  0,             0, 0 } },
    { "wprocs",       { LOADORDER_BI,  0,             0, 0 } },
    { "ws2_32",       { LOADORDER_BI,  0,             0, 0 } },
    { "wsock32",      { LOADORDER_BI,  0,             0, 0 } },
    { "x11drv",       { LOADORDER_BI,  0,             0, 0 } }
75 76
};

77 78 79 80 81
static const struct loadorder_list default_list =
{
    sizeof(default_order_list)/sizeof(default_order_list[0]),
    sizeof(default_order_list)/sizeof(default_order_list[0]),
    default_order_list
82 83
};

84 85 86
static struct loadorder_list cmdline_list;


87 88 89 90 91 92 93 94
/***************************************************************************
 *	cmp_sort_func	(internal, static)
 *
 * Sorting and comparing function used in sort and search of loadorder
 * entries.
 */
static int cmp_sort_func(const void *s1, const void *s2)
{
95 96
    return FILE_strcasecmp(((module_loadorder_t *)s1)->modulename,
                           ((module_loadorder_t *)s2)->modulename);
97 98 99 100 101 102 103 104 105 106 107 108 109 110
}


/***************************************************************************
 *	get_tok	(internal, static)
 *
 * strtok wrapper for non-destructive buffer writing.
 * NOTE: strtok is not reentrant and therefore this code is neither.
 */
static char *get_tok(const char *str, const char *delim)
{
	static char *buf = NULL;
	char *cptr;

111
	if(!str && !buf)
112 113 114 115
		return NULL;

	if(str && buf)
	{
116
		HeapFree(GetProcessHeap(), 0, buf);
117 118 119 120 121
		buf = NULL;
	}

	if(str && !buf)
	{
122 123
		buf = HeapAlloc(GetProcessHeap(), 0, strlen(str)+1);
		strcpy( buf, str );
124 125 126 127 128 129 130 131 132
		cptr = strtok(buf, delim);
	}
	else
	{
		cptr = strtok(NULL, delim);
	}

	if(!cptr)
	{
133
		HeapFree(GetProcessHeap(), 0, buf);
134 135 136 137 138 139 140 141 142 143 144 145
		buf = NULL;
	}
	return cptr;
}


/***************************************************************************
 *	ParseLoadOrder	(internal, static)
 *
 * Parses the loadorder options from the configuration and puts it into
 * a structure.
 */
146
static BOOL ParseLoadOrder(char *order, enum loadorder_type lo[])
147
{
148
    static int warn;
149 150 151 152 153 154
	char *cptr;
	int n = 0;

	cptr = get_tok(order, ", \t");
	while(cptr)
	{
155
            enum loadorder_type type = LOADORDER_INVALID;
156

157
		if(n >= LOADORDER_NTYPES-1)
158
		{
159
			ERR("More than existing %d module-types specified, rest ignored\n", LOADORDER_NTYPES-1);
160 161 162 163 164 165
			break;
		}

		switch(*cptr)
		{
		case 'N':	/* Native */
166
		case 'n': type = LOADORDER_DLL; break;
167 168

		case 'E':	/* Elfdll */
169
		case 'e':
170
                    if (!warn++) MESSAGE("Load order 'elfdll' no longer supported, ignored\n");
171
                    break;
172
		case 'S':	/* So */
173
		case 's': type = LOADORDER_SO; break;
174 175

		case 'B':	/* Builtin */
176
		case 'b': type = LOADORDER_BI; break;
177 178

		default:
179
			ERR("Invalid load order module-type '%s', ignored\n", cptr);
180 181
		}

182
                if(type != LOADORDER_INVALID) lo[n++] = type;
183 184
		cptr = get_tok(NULL, ", \t");
	}
185
        lo[n] = LOADORDER_INVALID;
186 187 188 189 190 191 192
	return TRUE;
}


/***************************************************************************
 *	AddLoadOrder	(internal, static)
 *
193
 * Adds an entry in the list of command-line overrides.
194
 */
195
static BOOL AddLoadOrder(module_loadorder_t *plo)
196 197 198 199 200
{
	int i;

	/* TRACE(module, "'%s' -> %08lx\n", plo->modulename, *(DWORD *)(plo->loadorder)); */

201
	for(i = 0; i < cmdline_list.count; i++)
202
	{
203 204 205 206 207 208
            if(!cmp_sort_func(plo, &cmdline_list.order[i] ))
            {
                /* replace existing option */
                memcpy( cmdline_list.order[i].loadorder, plo->loadorder, sizeof(plo->loadorder));
                return TRUE;
            }
209 210
	}

211
	if (i >= cmdline_list.alloc)
212 213
	{
		/* No space in current array, make it larger */
214 215 216 217
		cmdline_list.alloc += LOADORDER_ALLOC_CLUSTER;
		cmdline_list.order = HeapReAlloc(GetProcessHeap(), 0, cmdline_list.order,
                                          cmdline_list.alloc * sizeof(module_loadorder_t));
		if(!cmdline_list.order)
218
		{
219
			MESSAGE("Virtual memory exhausted\n");
220 221 222
			exit(1);
		}
	}
223
	memcpy(cmdline_list.order[i].loadorder, plo->loadorder, sizeof(plo->loadorder));
224 225
	cmdline_list.order[i].modulename = HeapAlloc(GetProcessHeap(), 0, strlen(plo->modulename)+1);
	strcpy( (char *)cmdline_list.order[i].modulename, plo->modulename );
226
	cmdline_list.count++;
227 228 229 230 231 232 233
	return TRUE;
}


/***************************************************************************
 *	AddLoadOrderSet	(internal, static)
 *
234
 * Adds a set of entries in the list of command-line overrides from the key parameter.
235
 */
236
static BOOL AddLoadOrderSet(char *key, char *order)
237 238 239 240 241
{
	module_loadorder_t ldo;
	char *cptr;

	/* Parse the loadorder before the rest because strtok is not reentrant */
242
	if(!ParseLoadOrder(order, ldo.loadorder))
243 244 245 246 247
		return FALSE;

	cptr = get_tok(key, ", \t");
	while(cptr)
	{
248 249 250
		char *ext = strrchr(cptr, '.');
		if(ext)
		{
251 252
			if(strlen(ext) == 4 &&
                           (!FILE_strcasecmp(ext, ".dll") || !FILE_strcasecmp(ext, ".exe")))
253
				MESSAGE("Warning: Loadorder override '%s' contains an extension and might not be found during lookup\n", cptr);
254
		}
255 256

		ldo.modulename = cptr;
257
		if(!AddLoadOrder(&ldo)) return FALSE;
258 259 260 261 262 263 264
		cptr = get_tok(NULL, ", \t");
	}
	return TRUE;
}


/***************************************************************************
265
 *	MODULE_AddLoadOrderOption
266
 *
267 268
 * The commandline option is in the form:
 * name[,name,...]=native[,b,...]
269
 */
270
void MODULE_AddLoadOrderOption( const char *option )
271
{
272
    char *value, *key = HeapAlloc(GetProcessHeap(), 0, strlen(option)+1);
273

274 275
    strcpy( key, option );
    if (!(value = strchr(key, '='))) goto error;
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
    *value++ = '\0';

    TRACE("Commandline override '%s' = '%s'\n", key, value);

    if (!AddLoadOrderSet(key, value)) goto error;
    HeapFree(GetProcessHeap(), 0, key);

    /* sort the array for quick lookup */
    qsort(cmdline_list.order, cmdline_list.count, sizeof(cmdline_list.order[0]), cmp_sort_func);
    return;

 error:
    MESSAGE( "Syntax: -dll name[,name[,...]]={native|so|builtin}[,{n|s|b}[,...]]\n"
             "    - 'name' is the name of any dll without extension\n"
             "    - the order of loading (native, so and builtin) can be abbreviated\n"
             "      with the first letter\n"
             "    - the option can be specified multiple times\n"
             "    Example:\n"
             "    -dll comdlg32,commdlg=n -dll shell,shell32=b\n" );
    ExitProcess(1);
296 297 298 299
}


/***************************************************************************
300
 *	set_registry_keys
301
 *
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
 * Set individual registry keys for a multiple dll specification
 * Helper for MODULE_InitLoadOrder().
 */
inline static void set_registry_keys( HKEY hkey, char *module, const char *buffer )
{
    static int warn;
    char *p = get_tok( module, ", \t" );

    TRACE( "converting \"%s\" = \"%s\"\n", module, buffer );

    if (!warn)
        MESSAGE( "Warning: setting multiple modules in a single DllOverrides entry is no longer\n"
                 "recommended. It is suggested that you rewrite the configuration file entry:\n\n"
                 "\"%s\" = \"%s\"\n\n"
                 "into something like:\n\n", module, buffer );
    while (p)
    {
        if (!warn) MESSAGE( "\"%s\" = \"%s\"\n", p, buffer );
        /* only set it if not existing already */
        if (RegQueryValueExA( hkey, p, 0, NULL, NULL, NULL ) == ERROR_FILE_NOT_FOUND)
            RegSetValueExA( hkey, p, 0, REG_SZ, buffer, strlen(buffer)+1 );
        p = get_tok( NULL, ", \t" );
    }
    if (!warn) MESSAGE( "\n" );
    warn = 1;
}


/***************************************************************************
 *	MODULE_InitLoadOrder
332
 *
333 334
 * Convert entries containing multiple dll names (old syntax) to the
 * new one dll module per entry syntax
335
 */
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
void MODULE_InitLoadOrder(void)
{
    char module[80];
    char buffer[1024];
    char *p;
    HKEY hkey;
    DWORD index = 0;

    if (RegOpenKeyA( HKEY_LOCAL_MACHINE, "Software\\Wine\\Wine\\Config\\DllOverrides", &hkey ))
        return;

    for (;;)
    {
        DWORD type, count = sizeof(buffer), name_len = sizeof(module);

        if (RegEnumValueA( hkey, index, module, &name_len, NULL, &type, buffer, &count )) break;
        p = module;
        while (isspace(*p)) p++;
        p += strcspn( p, ", \t" );
        while (isspace(*p)) p++;
        if (*p)
        {
            RegDeleteValueA( hkey, module );
            set_registry_keys( hkey, module, buffer );
        }
        else index++;
    }
    RegCloseKey( hkey );
}
365 366


367 368 369 370 371 372 373 374
/***************************************************************************
 *	get_list_load_order
 *
 * Get the load order for a given module from the command-line or
 * default lists.
 */
static BOOL get_list_load_order( const char *module, const struct loadorder_list *list,
                                 enum loadorder_type lo[] )
375
{
Eric Pouech's avatar
Eric Pouech committed
376
    module_loadorder_t tmp, *res = NULL;
377

378
    tmp.modulename = module;
Eric Pouech's avatar
Eric Pouech committed
379 380
    /* some bsearch implementations (Solaris) are buggy when the number of items is 0 */
    if (list->count && (res = bsearch(&tmp, list->order, list->count, sizeof(list->order[0]), cmp_sort_func)))
381 382 383
        memcpy( lo, res->loadorder, sizeof(res->loadorder) );
    return (res != NULL);
}
384 385


386 387 388
/***************************************************************************
 *	get_app_load_order
 *
389 390
 * Get the load order for a given module from the app-specific DllOverrides list.
 * Also look for default '*' key if no module key found.
391
 */
392
static BOOL get_app_load_order( const char *module, enum loadorder_type lo[], BOOL *got_default )
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
{
    HKEY hkey, appkey;
    DWORD count, type, res;
    char buffer[MAX_PATH+16], *appname, *p;

    if (!GetModuleFileName16( GetCurrentTask(), buffer, MAX_PATH ) &&
        !GetModuleFileNameA( 0, buffer, MAX_PATH ))
    {
        WARN( "could not get module file name loading %s\n", module );
        return FALSE;
    }
    appname = buffer;
    if ((p = strrchr( appname, '/' ))) appname = p + 1;
    if ((p = strrchr( appname, '\\' ))) appname = p + 1;

    TRACE( "searching '%s' in AppDefaults\\%s\\DllOverrides\n", module, appname );

    if (RegOpenKeyA( HKEY_LOCAL_MACHINE, "Software\\Wine\\Wine\\Config\\AppDefaults", &hkey ))
        return FALSE;

    /* open AppDefaults\\appname\\DllOverrides key */
    strcat( appname, "\\DllOverrides" );
    res = RegOpenKeyA( hkey, appname, &appkey );
    RegCloseKey( hkey );
    if (res) return FALSE;

    count = sizeof(buffer);
420 421 422 423 424 425
    if ((res = RegQueryValueExA( appkey, module, NULL, &type, buffer, &count )))
    {
        if (!(res = RegQueryValueExA( appkey, "*", NULL, &type, buffer, &count )))
            *got_default = TRUE;
    }
    else TRACE( "got app loadorder '%s' for '%s'\n", buffer, module );
426 427 428 429
    RegCloseKey( appkey );
    if (res) return FALSE;
    return ParseLoadOrder( buffer, lo );
}
430

431

432 433 434 435
/***************************************************************************
 *	get_standard_load_order
 *
 * Get the load order for a given module from the main DllOverrides list
436
 * Also look for default '*' key if no module key found.
437
 */
438 439
static BOOL get_standard_load_order( const char *module, enum loadorder_type lo[],
                                     BOOL *got_default )
440 441 442 443 444 445 446 447 448
{
    HKEY hkey;
    DWORD count, type, res;
    char buffer[80];

    if (RegOpenKeyA( HKEY_LOCAL_MACHINE, "Software\\Wine\\Wine\\Config\\DllOverrides", &hkey ))
        return FALSE;

    count = sizeof(buffer);
449 450 451 452 453 454
    if ((res = RegQueryValueExA( hkey, module, NULL, &type, buffer, &count )))
    {
        if (!(res = RegQueryValueExA( hkey, "*", NULL, &type, buffer, &count )))
            *got_default = TRUE;
    }
    else TRACE( "got standard loadorder '%s' for '%s'\n", buffer, module );
455 456 457 458
    RegCloseKey( hkey );
    if (res) return FALSE;
    return ParseLoadOrder( buffer, lo );
}
459 460


461 462 463 464 465 466 467 468 469 470
/***************************************************************************
 *	get_default_load_order
 *
 * Get the default load order if nothing specified for a given dll.
 */
static void get_default_load_order( enum loadorder_type lo[] )
{
    DWORD res;
    static enum loadorder_type default_loadorder[LOADORDER_NTYPES];
    static int loaded;
471

472 473 474 475
    if (!loaded)
    {
        char buffer[80];
        HKEY hkey;
476

477 478 479 480
        if (!(res = RegOpenKeyA( HKEY_LOCAL_MACHINE,
                                 "Software\\Wine\\Wine\\Config\\DllDefaults", &hkey )))
        {
            DWORD type, count = sizeof(buffer);
481

482 483 484 485 486 487 488 489 490
            res = RegQueryValueExA( hkey, "DefaultLoadOrder", NULL, &type, buffer, &count );
            RegCloseKey( hkey );
        }
        if (res) strcpy( buffer, "n,b,s" );
        ParseLoadOrder( buffer, default_loadorder );
        loaded = 1;
        TRACE( "got default loadorder '%s'\n", buffer );
    }
    memcpy( lo, default_loadorder, sizeof(default_loadorder) );
491 492 493 494 495 496 497 498
}


/***************************************************************************
 *	MODULE_GetLoadOrder	(internal)
 *
 * Locate the loadorder of a module.
 * Any path is stripped from the path-argument and so are the extension
499
 * '.dll' and '.exe'. A lookup in the table can yield an override for
500
 * the specific dll. Otherwise the default load order is returned.
501
 */
502
void MODULE_GetLoadOrder( enum loadorder_type loadorder[], const char *path, BOOL win32 )
503 504
{
	char fname[256];
505
	char sysdir[MAX_PATH+1];
506 507 508
	char *cptr;
	char *name;
	int len;
509 510
        BOOL got_app_default = FALSE, got_std_default = FALSE;
        enum loadorder_type lo_default[LOADORDER_NTYPES];
511

Lionel Ulmer's avatar
Lionel Ulmer committed
512
	TRACE("looking for %s\n", path);
513

514
        if ( ! GetSystemDirectoryA ( sysdir, MAX_PATH ) ) goto done;
515

516 517
	/* Strip path information for 16 bit modules or if the module 
	   resides in the system directory */
518
	if ( !win32 || !FILE_strncasecmp ( sysdir, path, strlen (sysdir) ) )
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
	{
	
	    cptr = strrchr(path, '\\');
	    if(!cptr)
	        name = strrchr(path, '/');
	    else
	        name = strrchr(cptr, '/');
	    
	    if(!name)
	        name = cptr ? cptr+1 : (char *)path;
	    else
	        name++;
	    
	    if((cptr = strchr(name, ':')) != NULL)	/* Also strip drive if in format 'C:MODULE.DLL' */
	        name = cptr+1;
	}
	else 
	  name = (char *)path;
    
538 539 540
	len = strlen(name);
	if(len >= sizeof(fname) || len <= 0)
	{
541 542
            WARN("Path '%s' -> '%s' reduces to zilch or just too large...\n", path, name);
            goto done;
543 544 545
	}

	strcpy(fname, name);
546
	if(len >= 4 && (!FILE_strcasecmp(fname+len-4, ".dll") || !FILE_strcasecmp(fname+len-4, ".exe")))
547 548
		fname[len-4] = '\0';

549 550
        /* check command-line first */
        if (get_list_load_order( fname, &cmdline_list, loadorder )) return;
551

552
        /* then app-specific config */
553 554 555 556 557 558
        if (get_app_load_order( fname, loadorder, &got_app_default ))
        {
            if (!got_app_default) return;
            /* save the default value for later on */
            memcpy( lo_default, loadorder, sizeof(lo_default) );
        }
559

560
        /* then standard config */
561 562 563 564 565 566
        if (get_standard_load_order( fname, loadorder, &got_std_default ))
        {
            if (!got_std_default) return;
            /* save the default value for later on */
            if (!got_app_default) memcpy( lo_default, loadorder, sizeof(lo_default) );
        }
567

568 569 570 571 572
        /* then compiled-in defaults */
        if (get_list_load_order( fname, &default_list, loadorder )) return;

 done:
        /* last, return the default */
573 574 575 576
        if (got_app_default || got_std_default)
            memcpy( loadorder, lo_default, sizeof(lo_default) );
        else
            get_default_load_order( loadorder );
577
}