tools/winebuild/main.c

   1 /*
   2  * Main function
   3  *
   4  * Copyright 1993 Robert J. Amstadt
   5  * Copyright 1995 Martin von Loewis
   6  * Copyright 1995, 1996, 1997 Alexandre Julliard
   7  * Copyright 1997 Eric Youngdale
   8  * Copyright 1999 Ulrich Weigand
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2.1 of the License, or (at your option) any later version.
  14  *
  15  * This library is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with this library; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  23  */
  24
  25 #include "config.h"
  26 #include "wine/port.h"
  27
  28 #include <assert.h>
  29 #include <stdio.h>
  30 #include <signal.h>
  31 #include <errno.h>
  32 #include <string.h>
  33 #include <stdarg.h>
  34 #include <ctype.h>
  35 #ifdef HAVE_GETOPT_H
  36 # include <getopt.h>
  37 #endif
  38
  39 #include "windef.h"
  40 #include "winbase.h"
  41 #include "build.h"
  42
  43 int UsePIC = 0;
  44 int nb_lib_paths = 0;
  45 int nb_errors = 0;
  46 int display_warnings = 0;
  47 int kill_at = 0;
  48 int verbose = 0;
  49 int save_temps = 0;
  50 int link_ext_symbols = 0;
  51
  52 #ifdef __i386__
  53 enum target_cpu target_cpu = CPU_x86;
  54 #elif defined(__x86_64__)
  55 enum target_cpu target_cpu = CPU_x86_64;
  56 #elif defined(__sparc__)
  57 enum target_cpu target_cpu = CPU_SPARC;
  58 #elif defined(__ALPHA__)
  59 enum target_cpu target_cpu = CPU_ALPHA;
  60 #elif defined(__powerpc__)
  61 enum target_cpu target_cpu = CPU_POWERPC;
  62 #else
  63 #error Unsupported CPU
  64 #endif
  65
  66 #ifdef __APPLE__
  67 enum target_platform target_platform = PLATFORM_APPLE;
  68 #elif defined(__sun)
  69 enum target_platform target_platform = PLATFORM_SOLARIS;
  70 #elif defined(_WINDOWS)
  71 enum target_platform target_platform = PLATFORM_WINDOWS;
  72 #else
  73 enum target_platform target_platform = PLATFORM_UNSPECIFIED;
  74 #endif
  75
  76 char **lib_path = NULL;
  77
  78 char *input_file_name = NULL;
  79 char *spec_file_name = NULL;
  80 FILE *output_file = NULL;
  81 const char *output_file_name = NULL;
  82 static const char *output_file_source_name;
  83
  84 char *as_command = NULL;
  85 char *ld_command = NULL;
  86 char *nm_command = NULL;
  87
  88 static int nb_res_files;
  89 static char **res_files;
  90
  91 /* execution mode */
  92 enum exec_mode_values
  93 {
  94     MODE_NONE,
  95     MODE_DLL,
  96     MODE_EXE,
  97     MODE_DEF,
  98     MODE_RELAY16,
  99     MODE_RELAY32
 100 };
 101
 102 static enum exec_mode_values exec_mode = MODE_NONE;
 103
 104 static const struct
 105 {
 106     const char *name;
 107     enum target_platform platform;
 108 } platform_names[] =
 109 {
 110     { "macos",   PLATFORM_APPLE },
 111     { "darwin",  PLATFORM_APPLE },
 112     { "solaris", PLATFORM_SOLARIS },
 113     { "windows", PLATFORM_WINDOWS },
 114     { "winnt",   PLATFORM_WINDOWS }
 115 };
 116
 117 /* set the dll file name from the input file name */
 118 static void set_dll_file_name( const char *name, DLLSPEC *spec )
 119 {
 120     char *p;
 121
 122     if (spec->file_name) return;
 123
 124     if ((p = strrchr( name, '\\' ))) name = p + 1;
 125     if ((p = strrchr( name, '/' ))) name = p + 1;
 126     spec->file_name = xmalloc( strlen(name) + 5 );
 127     strcpy( spec->file_name, name );
 128     if ((p = strrchr( spec->file_name, '.' )))
 129     {
 130         if (!strcmp( p, ".spec" ) || !strcmp( p, ".def" )) *p = 0;
 131     }
 132 }
 133
 134 /* set the dll subsystem */
 135 static void set_subsystem( const char *subsystem, DLLSPEC *spec )
 136 {
 137     char *major, *minor, *str = xstrdup( subsystem );
 138
 139     if ((major = strchr( str, ':' ))) *major++ = 0;
 140     if (!strcmp( str, "native" )) spec->subsystem = IMAGE_SUBSYSTEM_NATIVE;
 141     else if (!strcmp( str, "windows" )) spec->subsystem = IMAGE_SUBSYSTEM_WINDOWS_GUI;
 142     else if (!strcmp( str, "console" )) spec->subsystem = IMAGE_SUBSYSTEM_WINDOWS_CUI;
 143     else fatal_error( "Invalid subsystem name '%s'\n", subsystem );
 144     if (major)
 145     {
 146         if ((minor = strchr( major, '.' )))
 147         {
 148             *minor++ = 0;
 149             spec->subsystem_minor = atoi( minor );
 150         }
 151         spec->subsystem_major = atoi( major );
 152     }
 153     free( str );
 154 }
 155
 156 /* set the target CPU and platform */
 157 static void set_target( const char *target )
 158 {
 159     unsigned int i;
 160     char *p, *platform, *spec = xstrdup( target );
 161
 162     /* target specification is in the form CPU-MANUFACTURER-OS or CPU-MANUFACTURER-KERNEL-OS */
 163
 164     /* get the CPU part */
 165
 166     if (!(p = strchr( spec, '-' ))) fatal_error( "Invalid target specification '%s'\n", target );
 167     *p++ = 0;
 168     if ((target_cpu = get_cpu_from_name( spec )) == -1)
 169         fatal_error( "Unrecognized CPU '%s'\n", spec );
 170     platform = p;
 171     if ((p = strrchr( p, '-' ))) platform = p + 1;
 172
 173     /* get the OS part */
 174
 175     target_platform = PLATFORM_UNSPECIFIED;  /* default value */
 176     for (i = 0; i < sizeof(platform_names)/sizeof(platform_names[0]); i++)
 177     {
 178         if (!strncmp( platform_names[i].name, platform, strlen(platform_names[i].name) ))
 179         {
 180             target_platform = platform_names[i].platform;
 181             break;
 182         }
 183     }
 184
 185     free( spec );
 186
 187     if (!as_command)
 188     {
 189         as_command = xmalloc( strlen(target) + sizeof("-as") );
 190         strcpy( as_command, target );
 191         strcat( as_command, "-as" );
 192     }
 193     if (!ld_command)
 194     {
 195         ld_command = xmalloc( strlen(target) + sizeof("-ld") );
 196         strcpy( ld_command, target );
 197         strcat( ld_command, "-ld" );
 198     }
 199     if (!nm_command)
 200     {
 201         nm_command = xmalloc( strlen(target) + sizeof("-nm") );
 202         strcpy( nm_command, target );
 203         strcat( nm_command, "-nm" );
 204     }
 205 }
 206
 207 /* cleanup on program exit */
 208 static void cleanup(void)
 209 {
 210     if (output_file_name) unlink( output_file_name );
 211 }
 212
 213 /* clean things up when aborting on a signal */
 214 static void exit_on_signal( int sig )
 215 {
 216     exit(1);  /* this will call atexit functions */
 217 }
 218
 219 /*******************************************************************
 220  *         command-line option handling
 221  */
 222 static const char usage_str[] =
 223 "Usage: winebuild [OPTIONS] [FILES]\n\n"
 224 "Options:\n"
 225 "       --as-cmd=AS          Command to use for assembling (default: as)\n"
 226 "   -d, --delay-lib=LIB      Import the specified library in delayed mode\n"
 227 "   -D SYM                   Ignored for C flags compatibility\n"
 228 "   -e, --entry=FUNC         Set the DLL entry point function (default: DllMain)\n"
 229 "   -E, --export=FILE        Export the symbols defined in the .spec or .def file\n"
 230 "       --external-symbols   Allow linking to external symbols\n"
 231 "   -f FLAGS                 Compiler flags (only -fPIC is supported)\n"
 232 "   -F, --filename=DLLFILE   Set the DLL filename (default: from input file name)\n"
 233 "   -h, --help               Display this help message\n"
 234 "   -H, --heap=SIZE          Set the heap size for a Win16 dll\n"
 235 "   -i, --ignore=SYM[,SYM]   Ignore specified symbols when resolving imports\n"
 236 "   -I DIR                   Ignored for C flags compatibility\n"
 237 "   -k, --kill-at            Kill stdcall decorations in generated .def files\n"
 238 "   -K, FLAGS                Compiler flags (only -KPIC is supported)\n"
 239 "       --ld-cmd=LD          Command to use for linking (default: ld)\n"
 240 "   -l, --library=LIB        Import the specified library\n"
 241 "   -L, --library-path=DIR   Look for imports libraries in DIR\n"
 242 "   -M, --main-module=MODULE Set the name of the main module for a Win16 dll\n"
 243 "       --nm-cmd=NM          Command to use to get undefined symbols (default: nm)\n"
 244 "       --nxcompat=y|n       Set the NX compatibility flag (default: yes)\n"
 245 "   -N, --dll-name=DLLNAME   Set the DLL name (default: from input file name)\n"
 246 "   -o, --output=NAME        Set the output file name (default: stdout)\n"
 247 "   -r, --res=RSRC.RES       Load resources from RSRC.RES\n"
 248 "       --save-temps         Do not delete the generated intermediate files\n"
 249 "       --subsystem=SUBSYS   Set the subsystem (one of native, windows, console)\n"
 250 "       --target=TARGET      Specify target CPU and platform for cross-compiling\n"
 251 "   -u, --undefined=SYMBOL   Add an undefined reference to SYMBOL when linking\n"
 252 "   -v, --verbose            Display the programs invoked\n"
 253 "       --version            Print the version and exit\n"
 254 "   -w, --warnings           Turn on warnings\n"
 255 "\nMode options:\n"
 256 "       --dll                Build a .c file from a .spec or .def file\n"
 257 "       --def                Build a .def file from a .spec file\n"
 258 "       --exe                Build a .c file for an executable\n"
 259 "       --relay16            Build the 16-bit relay assembly routines\n"
 260 "       --relay32            Build the 32-bit relay assembly routines\n\n"
 261 "The mode options are mutually exclusive; you must specify one and only one.\n\n";
 262
 263 enum long_options_values
 264 {
 265     LONG_OPT_DLL = 1,
 266     LONG_OPT_DEF,
 267     LONG_OPT_EXE,
 268     LONG_OPT_ASCMD,
 269     LONG_OPT_EXTERNAL_SYMS,
 270     LONG_OPT_LDCMD,
 271     LONG_OPT_NMCMD,
 272     LONG_OPT_NXCOMPAT,
 273     LONG_OPT_RELAY16,
 274     LONG_OPT_RELAY32,
 275     LONG_OPT_SAVE_TEMPS,
 276     LONG_OPT_SUBSYSTEM,
 277     LONG_OPT_TARGET,
 278     LONG_OPT_VERSION
 279 };
 280
 281 static const char short_options[] = "C:D:E:F:H:I:K:L:M:N:d:e:f:hi:kl:m:o:r:u:vw";
 282
 283 static const struct option long_options[] =
 284 {
 285     { "dll",           0, 0, LONG_OPT_DLL },
 286     { "def",           0, 0, LONG_OPT_DEF },
 287     { "exe",           0, 0, LONG_OPT_EXE },
 288     { "as-cmd",        1, 0, LONG_OPT_ASCMD },
 289     { "external-symbols", 0, 0, LONG_OPT_EXTERNAL_SYMS },
 290     { "ld-cmd",        1, 0, LONG_OPT_LDCMD },
 291     { "nm-cmd",        1, 0, LONG_OPT_NMCMD },
 292     { "nxcompat",      1, 0, LONG_OPT_NXCOMPAT },
 293     { "relay16",       0, 0, LONG_OPT_RELAY16 },
 294     { "relay32",       0, 0, LONG_OPT_RELAY32 },
 295     { "save-temps",    0, 0, LONG_OPT_SAVE_TEMPS },
 296     { "subsystem",     1, 0, LONG_OPT_SUBSYSTEM },
 297     { "target",        1, 0, LONG_OPT_TARGET },
 298     { "version",       0, 0, LONG_OPT_VERSION },
 299     /* aliases for short options */
 300     { "delay-lib",     1, 0, 'd' },
 301     { "export",        1, 0, 'E' },
 302     { "entry",         1, 0, 'e' },
 303     { "filename",      1, 0, 'F' },
 304     { "help",          0, 0, 'h' },
 305     { "heap",          1, 0, 'H' },
 306     { "ignore",        1, 0, 'i' },
 307     { "kill-at",       0, 0, 'k' },
 308     { "library",       1, 0, 'l' },
 309     { "library-path",  1, 0, 'L' },
 310     { "main-module",   1, 0, 'M' },
 311     { "dll-name",      1, 0, 'N' },
 312     { "output",        1, 0, 'o' },
 313     { "res",           1, 0, 'r' },
 314     { "undefined",     1, 0, 'u' },
 315     { "verbose",       0, 0, 'v' },
 316     { "warnings",      0, 0, 'w' },
 317     { NULL,            0, 0, 0 }
 318 };
 319
 320 static void usage( int exit_code )
 321 {
 322     fprintf( stderr, "%s", usage_str );
 323     exit( exit_code );
 324 }
 325
 326 static void set_exec_mode( enum exec_mode_values mode )
 327 {
 328     if (exec_mode != MODE_NONE) usage(1);
 329     exec_mode = mode;
 330 }
 331
 332 /* parse options from the argv array and remove all the recognized ones */
 333 static char **parse_options( int argc, char **argv, DLLSPEC *spec )
 334 {
 335     char *p;
 336     int optc;
 337
 338     while ((optc = getopt_long( argc, argv, short_options, long_options, NULL )) != -1)
 339     {
 340         switch(optc)
 341         {
 342         case 'D':
 343             /* ignored */
 344             break;
 345         case 'E':
 346             spec_file_name = xstrdup( optarg );
 347             set_dll_file_name( optarg, spec );
 348             break;
 349         case 'F':
 350             spec->file_name = xstrdup( optarg );
 351             break;
 352         case 'H':
 353             if (!isdigit(optarg[0]))
 354                 fatal_error( "Expected number argument with -H option instead of '%s'\n", optarg );
 355             spec->heap_size = atoi(optarg);
 356             if (spec->heap_size > 65535)
 357                 fatal_error( "Invalid heap size %d, maximum is 65535\n", spec->heap_size );
 358             break;
 359         case 'I':
 360             /* ignored */
 361             break;
 362         case 'K':
 363             /* ignored, because cc generates correct code. */
 364             break;
 365         case 'L':
 366             lib_path = xrealloc( lib_path, (nb_lib_paths+1) * sizeof(*lib_path) );
 367             lib_path[nb_lib_paths++] = xstrdup( optarg );
 368             break;
 369         case 'M':
 370             spec->type = SPEC_WIN16;
 371             break;
 372         case 'N':
 373             spec->dll_name = xstrdup( optarg );
 374             break;
 375         case 'd':
 376             add_delayed_import( optarg );
 377             break;
 378         case 'e':
 379             spec->init_func = xstrdup( optarg );
 380             if ((p = strchr( spec->init_func, '@' ))) *p = 0;  /* kill stdcall decoration */
 381             break;
 382         case 'f':
 383             if (!strcmp( optarg, "PIC") || !strcmp( optarg, "pic")) UsePIC = 1;
 384             /* ignore all other flags */
 385             break;
 386         case 'h':
 387             usage(0);
 388             break;
 389         case 'i':
 390             {
 391                 char *str = xstrdup( optarg );
 392                 char *token = strtok( str, "," );
 393                 while (token)
 394                 {
 395                     add_ignore_symbol( token );
 396                     token = strtok( NULL, "," );
 397                 }
 398                 free( str );
 399             }
 400             break;
 401         case 'k':
 402             kill_at = 1;
 403             break;
 404         case 'l':
 405             add_import_dll( optarg, NULL );
 406             break;
 407         case 'o':
 408             {
 409                 char *ext = strrchr( optarg, '.' );
 410
 411                 if (unlink( optarg ) == -1 && errno != ENOENT)
 412                     fatal_error( "Unable to create output file '%s'\n", optarg );
 413                 if (ext && !strcmp( ext, ".o" ))
 414                 {
 415                     output_file_source_name = get_temp_file_name( optarg, ".s" );
 416                     if (!(output_file = fopen( output_file_source_name, "w" )))
 417                         fatal_error( "Unable to create output file '%s'\n", optarg );
 418                 }
 419                 else
 420                 {
 421                     if (!(output_file = fopen( optarg, "w" )))
 422                         fatal_error( "Unable to create output file '%s'\n", optarg );
 423                 }
 424                 output_file_name = xstrdup(optarg);
 425                 atexit( cleanup );  /* make sure we remove the output file on exit */
 426             }
 427             break;
 428         case 'r':
 429             res_files = xrealloc( res_files, (nb_res_files+1) * sizeof(*res_files) );
 430             res_files[nb_res_files++] = xstrdup( optarg );
 431             break;
 432         case 'u':
 433             add_extra_ld_symbol( optarg );
 434             break;
 435         case 'v':
 436             verbose++;
 437             break;
 438         case 'w':
 439             display_warnings = 1;
 440             break;
 441         case LONG_OPT_DLL:
 442             set_exec_mode( MODE_DLL );
 443             break;
 444         case LONG_OPT_DEF:
 445             set_exec_mode( MODE_DEF );
 446             break;
 447         case LONG_OPT_EXE:
 448             set_exec_mode( MODE_EXE );
 449             if (!spec->subsystem) spec->subsystem = IMAGE_SUBSYSTEM_WINDOWS_GUI;
 450             break;
 451         case LONG_OPT_ASCMD:
 452             as_command = xstrdup( optarg );
 453             break;
 454         case LONG_OPT_EXTERNAL_SYMS:
 455             link_ext_symbols = 1;
 456             break;
 457         case LONG_OPT_LDCMD:
 458             ld_command = xstrdup( optarg );
 459             break;
 460         case LONG_OPT_NMCMD:
 461             nm_command = xstrdup( optarg );
 462             break;
 463         case LONG_OPT_NXCOMPAT:
 464             if (optarg[0] == 'n' || optarg[0] == 'N')
 465                 spec->dll_characteristics &= ~IMAGE_DLLCHARACTERISTICS_NX_COMPAT;
 466             break;
 467         case LONG_OPT_RELAY16:
 468             set_exec_mode( MODE_RELAY16 );
 469             break;
 470         case LONG_OPT_RELAY32:
 471             set_exec_mode( MODE_RELAY32 );
 472             break;
 473         case LONG_OPT_SAVE_TEMPS:
 474             save_temps = 1;
 475             break;
 476         case LONG_OPT_SUBSYSTEM:
 477             set_subsystem( optarg, spec );
 478             break;
 479         case LONG_OPT_TARGET:
 480             set_target( optarg );
 481             break;
 482         case LONG_OPT_VERSION:
 483             printf( "winebuild version " PACKAGE_VERSION "\n" );
 484             exit(0);
 485         case '?':
 486             usage(1);
 487             break;
 488         }
 489     }
 490
 491     if (spec->file_name && !strchr( spec->file_name, '.' ))
 492         strcat( spec->file_name, exec_mode == MODE_EXE ? ".exe" : ".dll" );
 493
 494     return &argv[optind];
 495 }
 496
 497
 498 /* load all specified resource files */
 499 static void load_resources( char *argv[], DLLSPEC *spec )
 500 {
 501     int i;
 502     char **ptr, **last;
 503
 504     switch (spec->type)
 505     {
 506     case SPEC_WIN16:
 507         for (i = 0; i < nb_res_files; i++) load_res16_file( res_files[i], spec );
 508         break;
 509
 510     case SPEC_WIN32:
 511         for (i = 0; i < nb_res_files; i++)
 512         {
 513             if (!load_res32_file( res_files[i], spec ))
 514                 fatal_error( "%s is not a valid Win32 resource file\n", res_files[i] );
 515         }
 516
 517         /* load any resource file found in the remaining arguments */
 518         for (ptr = last = argv; *ptr; ptr++)
 519         {
 520             if (!load_res32_file( *ptr, spec ))
 521                 *last++ = *ptr; /* not a resource file, keep it in the list */
 522         }
 523         *last = NULL;
 524         break;
 525     }
 526 }
 527
 528 /* add input files that look like import libs to the import list */
 529 static void load_import_libs( char *argv[] )
 530 {
 531     char **ptr, **last;
 532
 533     for (ptr = last = argv; *ptr; ptr++)
 534     {
 535         if (strendswith( *ptr, ".def" ))
 536             add_import_dll( NULL, *ptr );
 537         else
 538             *last++ = *ptr; /* not an import dll, keep it in the list */
 539     }
 540     *last = NULL;
 541 }
 542
 543 static int parse_input_file( DLLSPEC *spec )
 544 {
 545     FILE *input_file = open_input_file( NULL, spec_file_name );
 546     char *extension = strrchr( spec_file_name, '.' );
 547     int result;
 548
 549     spec->src_name = xstrdup( input_file_name );
 550     if (extension && !strcmp( extension, ".def" ))
 551         result = parse_def_file( input_file, spec );
 552     else
 553         result = parse_spec_file( input_file, spec );
 554     close_input_file( input_file );
 555     return result;
 556 }
 557
 558
 559 /*******************************************************************
 560  *         main
 561  */
 562 int main(int argc, char **argv)
 563 {
 564     DLLSPEC *spec = alloc_dll_spec();
 565
 566 #ifdef SIGHUP
 567     signal( SIGHUP, exit_on_signal );
 568 #endif
 569     signal( SIGTERM, exit_on_signal );
 570     signal( SIGINT, exit_on_signal );
 571
 572     output_file = stdout;
 573     argv = parse_options( argc, argv, spec );
 574
 575     switch(exec_mode)
 576     {
 577     case MODE_DLL:
 578         if (spec->subsystem != IMAGE_SUBSYSTEM_NATIVE)
 579             spec->characteristics |= IMAGE_FILE_DLL;
 580         if (!spec_file_name) fatal_error( "missing .spec file\n" );
 581         /* fall through */
 582     case MODE_EXE:
 583         load_resources( argv, spec );
 584         load_import_libs( argv );
 585         if (spec_file_name && !parse_input_file( spec )) break;
 586         switch (spec->type)
 587         {
 588             case SPEC_WIN16:
 589                 if (argv[0])
 590                     fatal_error( "file argument '%s' not allowed in this mode\n", argv[0] );
 591                 BuildSpec16File( spec );
 592                 break;
 593             case SPEC_WIN32:
 594                 read_undef_symbols( spec, argv );
 595                 BuildSpec32File( spec );
 596                 break;
 597             default: assert(0);
 598         }
 599         break;
 600     case MODE_DEF:
 601         if (argv[0]) fatal_error( "file argument '%s' not allowed in this mode\n", argv[0] );
 602         if (spec->type == SPEC_WIN16) fatal_error( "Cannot yet build .def file for 16-bit dlls\n" );
 603         if (!spec_file_name) fatal_error( "missing .spec file\n" );
 604         if (!parse_input_file( spec )) break;
 605         BuildDef32File( spec );
 606         break;
 607     case MODE_RELAY16:
 608         if (argv[0]) fatal_error( "file argument '%s' not allowed in this mode\n", argv[0] );
 609         BuildRelays16();
 610         break;
 611     case MODE_RELAY32:
 612         if (argv[0]) fatal_error( "file argument '%s' not allowed in this mode\n", argv[0] );
 613         BuildRelays32();
 614         break;
 615     default:
 616         usage(1);
 617         break;
 618     }
 619     if (nb_errors) exit(1);
 620     if (output_file_name)
 621     {
 622         if (fclose( output_file ) < 0) fatal_perror( "fclose" );
 623         if (output_file_source_name) assemble_file( output_file_source_name, output_file_name );
 624         output_file_name = NULL;
 625     }
 626     return 0;
 627 }