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