loader/loadorder.c

   1 /*
   2  * Module/Library loadorder
   3  *
   4  * Copyright 1999 Bertho Stultiens
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  */
  20
  21 #include "config.h"
  22 #include "wine/port.h"
  23
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <assert.h>
  27
  28 #include "windef.h"
  29 #include "winreg.h"
  30 #include "winerror.h"
  31 #include "file.h"
  32 #include "module.h"
  33 #include "wine/debug.h"
  34
  35 WINE_DEFAULT_DEBUG_CHANNEL(module);
  36
  37 #define LOADORDER_ALLOC_CLUSTER 32      /* Allocate with 32 entries at a time */
  38
  39 typedef struct module_loadorder
  40 {
  41     const char         *modulename;
  42     enum loadorder_type loadorder[LOADORDER_NTYPES];
  43 } module_loadorder_t;
  44
  45 struct loadorder_list
  46 {
  47     int                 count;
  48     int                 alloc;
  49     module_loadorder_t *order;
  50 };
  51
  52 /* default load-order if nothing specified */
  53 /* the list must remain sorted by dll name */
  54 static module_loadorder_t default_order_list[] =
  55 {
  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 } }
  89 };
  90
  91 static const struct loadorder_list default_list =
  92 {
  93     sizeof(default_order_list)/sizeof(default_order_list[0]),
  94     sizeof(default_order_list)/sizeof(default_order_list[0]),
  95     default_order_list
  96 };
  97
  98 /* default if nothing else specified */
  99 static const enum loadorder_type default_loadorder[LOADORDER_NTYPES] =
 100 {
 101     LOADORDER_DLL, LOADORDER_BI, 0, 0
 102 };
 103
 104 static struct loadorder_list cmdline_list;
 105
 106
 107 /***************************************************************************
 108  *      cmp_sort_func   (internal, static)
 109  *
 110  * Sorting and comparing function used in sort and search of loadorder
 111  * entries.
 112  */
 113 static int cmp_sort_func(const void *s1, const void *s2)
 114 {
 115     return FILE_strcasecmp(((module_loadorder_t *)s1)->modulename,
 116                            ((module_loadorder_t *)s2)->modulename);
 117 }
 118
 119
 120 /***************************************************************************
 121  *      get_tok (internal, static)
 122  *
 123  * strtok wrapper for non-destructive buffer writing.
 124  * NOTE: strtok is not reentrant and therefore this code is neither.
 125  */
 126 static char *get_tok(const char *str, const char *delim)
 127 {
 128         static char *buf = NULL;
 129         char *cptr;
 130
 131         if(!str && !buf)
 132                 return NULL;
 133
 134         if(str && buf)
 135         {
 136                 HeapFree(GetProcessHeap(), 0, buf);
 137                 buf = NULL;
 138         }
 139
 140         if(str && !buf)
 141         {
 142                 buf = HeapAlloc(GetProcessHeap(), 0, strlen(str)+1);
 143                 strcpy( buf, str );
 144                 cptr = strtok(buf, delim);
 145         }
 146         else
 147         {
 148                 cptr = strtok(NULL, delim);
 149         }
 150
 151         if(!cptr)
 152         {
 153                 HeapFree(GetProcessHeap(), 0, buf);
 154                 buf = NULL;
 155         }
 156         return cptr;
 157 }
 158
 159
 160 /***************************************************************************
 161  *      get_basename
 162  *
 163  * Return the base name of a file name (i.e. remove the path components).
 164  */
 165 static const char *get_basename( const char *name )
 166 {
 167     const char *ptr;
 168
 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;
 172     return name;
 173 }
 174
 175
 176 /***************************************************************************
 177  *      debugstr_loadorder
 178  *
 179  * Return a loadorder in printable form.
 180  */
 181 static const char *debugstr_loadorder( enum loadorder_type lo[] )
 182 {
 183     int i;
 184     char buffer[LOADORDER_NTYPES*3+1];
 185
 186     buffer[0] = 0;
 187     for(i = 0; i < LOADORDER_NTYPES; i++)
 188     {
 189         if (lo[i] == LOADORDER_INVALID) break;
 190         switch(lo[i])
 191         {
 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;
 196         }
 197     }
 198     if (buffer[0]) buffer[strlen(buffer)-1] = 0;
 199     return debugstr_a(buffer);
 200 }
 201
 202
 203 /***************************************************************************
 204  *      ParseLoadOrder  (internal, static)
 205  *
 206  * Parses the loadorder options from the configuration and puts it into
 207  * a structure.
 208  */
 209 static BOOL ParseLoadOrder(char *order, enum loadorder_type lo[])
 210 {
 211     static int warn;
 212         char *cptr;
 213         int n = 0;
 214
 215         cptr = get_tok(order, ", \t");
 216         while(cptr)
 217         {
 218             enum loadorder_type type = LOADORDER_INVALID;
 219
 220                 if(n >= LOADORDER_NTYPES-1)
 221                 {
 222                         ERR("More than existing %d module-types specified, rest ignored\n", LOADORDER_NTYPES-1);
 223                         break;
 224                 }
 225
 226                 switch(*cptr)
 227                 {
 228                 case 'N':       /* Native */
 229                 case 'n': type = LOADORDER_DLL; break;
 230
 231                 case 'E':       /* Elfdll */
 232                 case 'e':
 233                     if (!warn++) MESSAGE("Load order 'elfdll' no longer supported, ignored\n");
 234                     break;
 235                 case 'S':       /* So */
 236                 case 's': type = LOADORDER_SO; break;
 237
 238                 case 'B':       /* Builtin */
 239                 case 'b': type = LOADORDER_BI; break;
 240
 241                 default:
 242                         ERR("Invalid load order module-type '%s', ignored\n", cptr);
 243                 }
 244
 245                 if(type != LOADORDER_INVALID) lo[n++] = type;
 246                 cptr = get_tok(NULL, ", \t");
 247         }
 248         lo[n] = LOADORDER_INVALID;
 249         return TRUE;
 250 }
 251
 252
 253 /***************************************************************************
 254  *      AddLoadOrder    (internal, static)
 255  *
 256  * Adds an entry in the list of command-line overrides.
 257  */
 258 static BOOL AddLoadOrder(module_loadorder_t *plo)
 259 {
 260         int i;
 261
 262         /* TRACE(module, "'%s' -> %08lx\n", plo->modulename, *(DWORD *)(plo->loadorder)); */
 263
 264         for(i = 0; i < cmdline_list.count; i++)
 265         {
 266             if(!cmp_sort_func(plo, &cmdline_list.order[i] ))
 267             {
 268                 /* replace existing option */
 269                 memcpy( cmdline_list.order[i].loadorder, plo->loadorder, sizeof(plo->loadorder));
 270                 return TRUE;
 271             }
 272         }
 273
 274         if (i >= cmdline_list.alloc)
 275         {
 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)
 281                 {
 282                         MESSAGE("Virtual memory exhausted\n");
 283                         exit(1);
 284                 }
 285         }
 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++;
 290         return TRUE;
 291 }
 292
 293
 294 /***************************************************************************
 295  *      AddLoadOrderSet (internal, static)
 296  *
 297  * Adds a set of entries in the list of command-line overrides from the key parameter.
 298  */
 299 static BOOL AddLoadOrderSet(char *key, char *order)
 300 {
 301         module_loadorder_t ldo;
 302         char *cptr;
 303
 304         /* Parse the loadorder before the rest because strtok is not reentrant */
 305         if(!ParseLoadOrder(order, ldo.loadorder))
 306                 return FALSE;
 307
 308         cptr = get_tok(key, ", \t");
 309         while(cptr)
 310         {
 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");
 316         }
 317         return TRUE;
 318 }
 319
 320
 321 /***************************************************************************
 322  *      MODULE_AddLoadOrderOption
 323  *
 324  * The commandline option is in the form:
 325  * name[,name,...]=native[,b,...]
 326  */
 327 void MODULE_AddLoadOrderOption( const char *option )
 328 {
 329     char *value, *key = HeapAlloc(GetProcessHeap(), 0, strlen(option)+1);
 330
 331     strcpy( key, option );
 332     if (!(value = strchr(key, '='))) goto error;
 333     *value++ = '\0';
 334
 335     TRACE("Commandline override '%s' = '%s'\n", key, value);
 336
 337     if (!AddLoadOrderSet(key, value)) goto error;
 338     HeapFree(GetProcessHeap(), 0, key);
 339
 340     /* sort the array for quick lookup */
 341     qsort(cmdline_list.order, cmdline_list.count, sizeof(cmdline_list.order[0]), cmp_sort_func);
 342     return;
 343
 344  error:
 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"
 350              "    Example:\n"
 351              "    -dll comdlg32,commdlg=n -dll shell,shell32=b\n" );
 352     ExitProcess(1);
 353 }
 354
 355
 356 /***************************************************************************
 357  *      get_list_load_order
 358  *
 359  * Get the load order for a given module from the command-line or
 360  * default lists.
 361  */
 362 static BOOL get_list_load_order( const char *module, const struct loadorder_list *list,
 363                                  enum loadorder_type lo[] )
 364 {
 365     module_loadorder_t tmp, *res = NULL;
 366
 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);
 372 }
 373
 374
 375 /***************************************************************************
 376  *      open_app_key
 377  *
 378  * Open the registry key to the app-specific DllOverrides list.
 379  */
 380 static HKEY open_app_key( const char *module )
 381 {
 382     HKEY hkey, appkey;
 383     char buffer[MAX_PATH+16], *appname;
 384
 385     if (!GetModuleFileNameA( 0, buffer, MAX_PATH ))
 386     {
 387         WARN( "could not get module file name loading %s\n", module );
 388         return 0;
 389     }
 390     appname = (char *)get_basename( buffer );
 391
 392     TRACE( "searching '%s' in AppDefaults\\%s\\DllOverrides\n", module, appname );
 393
 394     if (RegOpenKeyA( HKEY_LOCAL_MACHINE, "Software\\Wine\\Wine\\Config\\AppDefaults", &hkey ))
 395         return 0;
 396
 397     /* open AppDefaults\\appname\\DllOverrides key */
 398     strcat( appname, "\\DllOverrides" );
 399     if (RegOpenKeyA( hkey, appname, &appkey )) appkey = 0;
 400     RegCloseKey( hkey );
 401     return appkey;
 402 }
 403
 404
 405 /***************************************************************************
 406  *      get_registry_value
 407  *
 408  * Load the registry loadorder value for a given module.
 409  */
 410 static BOOL get_registry_value( HKEY hkey, const char *module, enum loadorder_type lo[] )
 411 {
 412     char buffer[80];
 413     DWORD count, type;
 414
 415     count = sizeof(buffer);
 416     if (RegQueryValueExA( hkey, module, NULL, &type, buffer, &count )) return FALSE;
 417     return ParseLoadOrder( buffer, lo );
 418 }
 419
 420
 421 /***************************************************************************
 422  *      MODULE_GetBuiltinPath
 423  *
 424  * Get the path of a builtin module when the native file does not exist.
 425  */
 426 BOOL MODULE_GetBuiltinPath( const char *libname, const char *ext, char *filename, UINT size )
 427 {
 428     char *p;
 429     BOOL ret = FALSE;
 430     UINT len = GetSystemDirectoryA( filename, size );
 431
 432     if (FILE_contains_path( libname ))
 433     {
 434         char *tmp;
 435
 436         /* if the library name contains a path and can not be found,
 437          * return an error.
 438          * exception: if the path is the system directory, proceed,
 439          * so that modules which are not PE modules can be loaded.
 440          * If the library name does not contain a path and can not
 441          * be found, assume the system directory is meant */
 442
 443         if (strlen(libname) >= size) return FALSE;  /* too long */
 444         if (strchr( libname, '/' ))  /* need to convert slashes */
 445         {
 446             if (!(tmp = HeapAlloc( GetProcessHeap(), 0, strlen(libname)+1 ))) return FALSE;
 447             strcpy( tmp, libname );
 448             for (p = tmp; *p; p++) if (*p == '/') *p = '\\';
 449         }
 450         else tmp = (char *)libname;
 451
 452         if (!FILE_strncasecmp( filename, tmp, len ) && tmp[len] == '\\')
 453         {
 454             strcpy( filename, tmp );
 455             ret = TRUE;
 456         }
 457         if (tmp != libname) HeapFree( GetProcessHeap(), 0, tmp );
 458         if (!ret) return FALSE;
 459     }
 460     else
 461     {
 462         if (strlen(libname) >= size - len - 1) return FALSE;
 463         filename[len] = '\\';
 464         strcpy( filename+len+1, libname );
 465     }
 466
 467     /* if the filename doesn't have an extension, append the default */
 468     if (!(p = strrchr( filename, '.')) || strchr( p, '/' ) || strchr( p, '\\'))
 469     {
 470         if (strlen(filename) + strlen(ext) >= size) return FALSE;
 471         strcat( filename, ext );
 472     }
 473     return TRUE;
 474 }
 475
 476
 477 /***************************************************************************
 478  *      MODULE_GetLoadOrder     (internal)
 479  *
 480  * Locate the loadorder of a module.
 481  * Any path is stripped from the path-argument and so are the extension
 482  * '.dll' and '.exe'. A lookup in the table can yield an override for
 483  * the specific dll. Otherwise the default load order is returned.
 484  */
 485 void MODULE_GetLoadOrder( enum loadorder_type loadorder[], const char *path, BOOL win32 )
 486 {
 487     static HKEY std_key = (HKEY)-1;  /* key to standard section, cached */
 488     HKEY app_key = 0;
 489     char *module, *basename;
 490     int len;
 491
 492     TRACE("looking for %s\n", path);
 493
 494     loadorder[0] = LOADORDER_INVALID;  /* in case something bad happens below */
 495
 496     /* Strip path information for 16 bit modules or if the module
 497      * resides in the system directory */
 498     if (!win32)
 499     {
 500         path = get_basename( path );
 501         if (BUILTIN_IsPresent(path))
 502         {
 503             TRACE( "forcing loadorder to builtin for %s\n", debugstr_a(path) );
 504             /* force builtin loadorder since the dll is already in memory */
 505             loadorder[0] = LOADORDER_BI;
 506             loadorder[1] = LOADORDER_INVALID;
 507             return;
 508         }
 509     }
 510     else
 511     {
 512         char sysdir[MAX_PATH+1];
 513         if (!GetSystemDirectoryA( sysdir, MAX_PATH )) return;
 514         if (!FILE_strncasecmp( sysdir, path, strlen (sysdir) ))
 515         {
 516             path += strlen(sysdir);
 517             while (*path == '\\' || *path == '/') path++;
 518         }
 519     }
 520
 521     if (!(len = strlen(path))) return;
 522     if (!(module = HeapAlloc( GetProcessHeap(), 0, len + 2 ))) return;
 523     strcpy( module+1, path );  /* reserve module[0] for the wildcard char */
 524
 525     if (len >= 4)
 526     {
 527         char *ext = module + 1 + len - 4;
 528         if (!FILE_strcasecmp( ext, ".dll" )) *ext = 0;
 529     }
 530
 531     /* check command-line first */
 532     if (get_list_load_order( module+1, &cmdline_list, loadorder ))
 533     {
 534         TRACE( "got cmdline %s for %s\n",
 535                debugstr_loadorder(loadorder), debugstr_a(path) );
 536         goto done;
 537     }
 538
 539     /* then explicit module name in AppDefaults */
 540     app_key = open_app_key( module+1 );
 541     if (app_key && get_registry_value( app_key, module+1, loadorder ))
 542     {
 543         TRACE( "got app defaults %s for %s\n",
 544                debugstr_loadorder(loadorder), debugstr_a(path) );
 545         goto done;
 546     }
 547
 548     /* then explicit module name in standard section */
 549     if (std_key == (HKEY)-1)
 550         RegOpenKeyA( HKEY_LOCAL_MACHINE, "Software\\Wine\\Wine\\Config\\DllOverrides", &std_key );
 551
 552     if (std_key && get_registry_value( std_key, module+1, loadorder ))
 553     {
 554         TRACE( "got standard entry %s for %s\n",
 555                debugstr_loadorder(loadorder), debugstr_a(path) );
 556         goto done;
 557     }
 558
 559     /* then module basename preceded by '*' in AppDefaults */
 560     basename = (char *)get_basename( module+1 );
 561     basename[-1] = '*';
 562     if (app_key && get_registry_value( app_key, basename-1, loadorder ))
 563     {
 564         TRACE( "got app defaults basename %s for %s\n",
 565                debugstr_loadorder(loadorder), debugstr_a(path) );
 566         goto done;
 567     }
 568
 569     /* then module name preceded by '*' in standard section */
 570     if (std_key && get_registry_value( std_key, basename-1, loadorder ))
 571     {
 572         TRACE( "got standard base name %s for %s\n",
 573                debugstr_loadorder(loadorder), debugstr_a(path) );
 574         goto done;
 575     }
 576
 577     /* then base name matching compiled-in defaults */
 578     if (get_list_load_order( basename, &default_list, loadorder ))
 579     {
 580         TRACE( "got compiled-in default %s for %s\n",
 581                debugstr_loadorder(loadorder), debugstr_a(path) );
 582         goto done;
 583     }
 584
 585     if (basename == module+1)
 586     {
 587         /* then wildcard entry in AppDefaults (only if no explicit path) */
 588         if (app_key && get_registry_value( app_key, "*", loadorder ))
 589         {
 590             TRACE( "got app defaults wildcard %s for %s\n",
 591                    debugstr_loadorder(loadorder), debugstr_a(path) );
 592             goto done;
 593         }
 594
 595         /* then wildcard entry in standard section (only if no explicit path) */
 596         if (std_key && get_registry_value( std_key, "*", loadorder ))
 597         {
 598             TRACE( "got standard wildcard %s for %s\n",
 599                    debugstr_loadorder(loadorder), debugstr_a(path) );
 600             goto done;
 601         }
 602     }
 603
 604     /* and last the hard-coded default */
 605     memcpy( loadorder, default_loadorder, sizeof(default_loadorder) );
 606     TRACE( "got hardcoded default %s for %s\n",
 607            debugstr_loadorder(loadorder), debugstr_a(path) );
 608
 609
 610  done:
 611     if (app_key) RegCloseKey( app_key );
 612     HeapFree( GetProcessHeap(), 0, module );
 613 }