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