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