wined3d: Pack hardcoded local constants in ARB.
[wine] / tools / winebuild / utils.c
1 /*
2  * Small utility functions for winebuild
3  *
4  * Copyright 2000 Alexandre Julliard
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #include "config.h"
22 #include "wine/port.h"
23
24 #include <assert.h>
25 #include <ctype.h>
26 #include <stdarg.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #ifdef HAVE_UNISTD_H
31 # include <unistd.h>
32 #endif
33
34 #include "build.h"
35
36 #define MAX_TMP_FILES 8
37 static const char *tmp_files[MAX_TMP_FILES];
38 static unsigned int nb_tmp_files;
39
40 static const struct
41 {
42     const char *name;
43     enum target_cpu cpu;
44 } cpu_names[] =
45 {
46     { "i386",    CPU_x86 },
47     { "i486",    CPU_x86 },
48     { "i586",    CPU_x86 },
49     { "i686",    CPU_x86 },
50     { "i786",    CPU_x86 },
51     { "x86_64",  CPU_x86_64 },
52     { "sparc",   CPU_SPARC },
53     { "alpha",   CPU_ALPHA },
54     { "powerpc", CPU_POWERPC }
55 };
56
57 /* atexit handler to clean tmp files */
58 static void cleanup_tmp_files(void)
59 {
60     unsigned int i;
61     for (i = 0; i < MAX_TMP_FILES; i++) if (tmp_files[i]) unlink( tmp_files[i] );
62 }
63
64
65 void *xmalloc (size_t size)
66 {
67     void *res;
68
69     res = malloc (size ? size : 1);
70     if (res == NULL)
71     {
72         fprintf (stderr, "Virtual memory exhausted.\n");
73         exit (1);
74     }
75     return res;
76 }
77
78 void *xrealloc (void *ptr, size_t size)
79 {
80     void *res = realloc (ptr, size);
81     if (size && res == NULL)
82     {
83         fprintf (stderr, "Virtual memory exhausted.\n");
84         exit (1);
85     }
86     return res;
87 }
88
89 char *xstrdup( const char *str )
90 {
91     char *res = strdup( str );
92     if (!res)
93     {
94         fprintf (stderr, "Virtual memory exhausted.\n");
95         exit (1);
96     }
97     return res;
98 }
99
100 char *strupper(char *s)
101 {
102     char *p;
103     for (p = s; *p; p++) *p = toupper(*p);
104     return s;
105 }
106
107 int strendswith(const char* str, const char* end)
108 {
109     int l = strlen(str);
110     int m = strlen(end);
111     return l >= m && strcmp(str + l - m, end) == 0;
112 }
113
114 void fatal_error( const char *msg, ... )
115 {
116     va_list valist;
117     va_start( valist, msg );
118     if (input_file_name)
119     {
120         fprintf( stderr, "%s:", input_file_name );
121         if (current_line)
122             fprintf( stderr, "%d:", current_line );
123         fputc( ' ', stderr );
124     }
125     else fprintf( stderr, "winebuild: " );
126     vfprintf( stderr, msg, valist );
127     va_end( valist );
128     exit(1);
129 }
130
131 void fatal_perror( const char *msg, ... )
132 {
133     va_list valist;
134     va_start( valist, msg );
135     if (input_file_name)
136     {
137         fprintf( stderr, "%s:", input_file_name );
138         if (current_line)
139             fprintf( stderr, "%d:", current_line );
140         fputc( ' ', stderr );
141     }
142     vfprintf( stderr, msg, valist );
143     perror( " " );
144     va_end( valist );
145     exit(1);
146 }
147
148 void error( const char *msg, ... )
149 {
150     va_list valist;
151     va_start( valist, msg );
152     if (input_file_name)
153     {
154         fprintf( stderr, "%s:", input_file_name );
155         if (current_line)
156             fprintf( stderr, "%d:", current_line );
157         fputc( ' ', stderr );
158     }
159     vfprintf( stderr, msg, valist );
160     va_end( valist );
161     nb_errors++;
162 }
163
164 void warning( const char *msg, ... )
165 {
166     va_list valist;
167
168     if (!display_warnings) return;
169     va_start( valist, msg );
170     if (input_file_name)
171     {
172         fprintf( stderr, "%s:", input_file_name );
173         if (current_line)
174             fprintf( stderr, "%d:", current_line );
175         fputc( ' ', stderr );
176     }
177     fprintf( stderr, "warning: " );
178     vfprintf( stderr, msg, valist );
179     va_end( valist );
180 }
181
182 int output( const char *format, ... )
183 {
184     int ret;
185     va_list valist;
186
187     va_start( valist, format );
188     ret = vfprintf( output_file, format, valist );
189     va_end( valist );
190     if (ret < 0) fatal_perror( "Output error" );
191     return ret;
192 }
193
194 /* find a build tool in the path, trying the various names */
195 char *find_tool( const char * const *names )
196 {
197     static char **dirs;
198     static unsigned int count, maxlen;
199
200     char *p, *file;
201     unsigned int i, len;
202     struct stat st;
203
204     if (!dirs)
205     {
206         char *path;
207
208         /* split the path in directories */
209
210         if (!getenv( "PATH" )) return NULL;
211         path = xstrdup( getenv( "PATH" ));
212         for (p = path, count = 2; *p; p++) if (*p == ':') count++;
213         dirs = xmalloc( count * sizeof(*dirs) );
214         count = 0;
215         dirs[count++] = p = path;
216         while (*p)
217         {
218             while (*p && *p != ':') p++;
219             if (!*p) break;
220             *p++ = 0;
221             dirs[count++] = p;
222         }
223         for (i = 0; i < count; i++) maxlen = max( maxlen, strlen(dirs[i])+2 );
224     }
225
226     while (*names)
227     {
228         len = strlen(*names) + 1;
229         file = xmalloc( maxlen + len );
230
231         for (i = 0; i < count; i++)
232         {
233             strcpy( file, dirs[i] );
234             p = file + strlen(file);
235             if (p == file) *p++ = '.';
236             if (p[-1] != '/') *p++ = '/';
237             strcpy( p, *names );
238
239             if (!stat( file, &st ) && S_ISREG(st.st_mode) && (st.st_mode & 0111)) return file;
240         }
241         free( file );
242         names++;
243     }
244     return NULL;
245 }
246
247 const char *get_as_command(void)
248 {
249     if (!as_command)
250     {
251         if (target_alias)
252         {
253             as_command = xmalloc( strlen(target_alias) + sizeof("-as") );
254             strcpy( as_command, target_alias );
255             strcat( as_command, "-as" );
256         }
257         else
258         {
259             static const char * const commands[] = { "gas", "as", NULL };
260             if (!(as_command = find_tool( commands ))) as_command = xstrdup("as");
261         }
262
263         if (force_pointer_size)
264         {
265             const char *args = (target_platform == PLATFORM_APPLE) ?
266                 ((force_pointer_size == 8) ? " -arch x86_64" : " -arch i386") :
267                 ((force_pointer_size == 8) ? " --64" : " --32");
268             as_command = xrealloc( as_command, strlen(as_command) + strlen(args) + 1 );
269             strcat( as_command, args );
270         }
271     }
272     return as_command;
273 }
274
275 const char *get_ld_command(void)
276 {
277     if (!ld_command)
278     {
279         if (target_alias)
280         {
281             ld_command = xmalloc( strlen(target_alias) + sizeof("-ld") );
282             strcpy( ld_command, target_alias );
283             strcat( ld_command, "-ld" );
284         }
285         else
286         {
287             static const char * const commands[] = { "ld", "gld", NULL };
288             if (!(ld_command = find_tool( commands ))) ld_command = xstrdup("ld");
289         }
290
291         if (force_pointer_size)
292         {
293             const char *args = (target_platform == PLATFORM_APPLE) ?
294                 ((force_pointer_size == 8) ? " -arch x86_64" : " -arch i386") :
295                 ((force_pointer_size == 8) ? " -m elf_x86_64" : " -m elf_i386");
296             ld_command = xrealloc( ld_command, strlen(ld_command) + strlen(args) + 1 );
297             strcat( ld_command, args );
298         }
299     }
300     return ld_command;
301 }
302
303 const char *get_nm_command(void)
304 {
305     if (!nm_command)
306     {
307         if (target_alias)
308         {
309             nm_command = xmalloc( strlen(target_alias) + sizeof("-nm") );
310             strcpy( nm_command, target_alias );
311             strcat( nm_command, "-nm" );
312         }
313         else
314         {
315             static const char * const commands[] = { "nm", "gnm", NULL };
316             if (!(nm_command = find_tool( commands ))) nm_command = xstrdup("nm");
317         }
318     }
319     return nm_command;
320 }
321
322 /* get a name for a temp file, automatically cleaned up on exit */
323 char *get_temp_file_name( const char *prefix, const char *suffix )
324 {
325     char *name;
326     const char *ext;
327     int fd;
328
329     assert( nb_tmp_files < MAX_TMP_FILES );
330     if (!nb_tmp_files && !save_temps) atexit( cleanup_tmp_files );
331
332     if (!prefix || !prefix[0]) prefix = "winebuild";
333     if (!suffix) suffix = "";
334     if (!(ext = strchr( prefix, '.' ))) ext = prefix + strlen(prefix);
335     name = xmalloc( sizeof("/tmp/") + (ext - prefix) + sizeof(".XXXXXX") + strlen(suffix) );
336     strcpy( name, "/tmp/" );
337     memcpy( name + 5, prefix, ext - prefix );
338     strcpy( name + 5 + (ext - prefix), ".XXXXXX" );
339     strcat( name, suffix );
340
341     /* first try without the /tmp/ prefix */
342     if ((fd = mkstemps( name + 5, strlen(suffix) )) != -1)
343         name += 5;
344     else if ((fd = mkstemps( name, strlen(suffix) )) == -1)
345         fatal_error( "could not generate a temp file\n" );
346
347     close( fd );
348     tmp_files[nb_tmp_files++] = name;
349     return name;
350 }
351
352 /* output a standard header for generated files */
353 void output_standard_file_header(void)
354 {
355     if (spec_file_name)
356         output( "/* File generated automatically from %s; do not edit! */\n", spec_file_name );
357     else
358         output( "/* File generated automatically; do not edit! */\n" );
359     output( "/* This file can be copied, modified and distributed without restriction. */\n\n" );
360 }
361
362 /* dump a byte stream into the assembly code */
363 void dump_bytes( const void *buffer, unsigned int size )
364 {
365     unsigned int i;
366     const unsigned char *ptr = buffer;
367
368     if (!size) return;
369     output( "\t.byte " );
370     for (i = 0; i < size - 1; i++, ptr++)
371     {
372         if ((i % 16) == 15) output( "0x%02x\n\t.byte ", *ptr );
373         else output( "0x%02x,", *ptr );
374     }
375     output( "0x%02x\n", *ptr );
376 }
377
378
379 /*******************************************************************
380  *         open_input_file
381  *
382  * Open a file in the given srcdir and set the input_file_name global variable.
383  */
384 FILE *open_input_file( const char *srcdir, const char *name )
385 {
386     char *fullname;
387     FILE *file = fopen( name, "r" );
388
389     if (!file && srcdir)
390     {
391         fullname = xmalloc( strlen(srcdir) + strlen(name) + 2 );
392         strcpy( fullname, srcdir );
393         strcat( fullname, "/" );
394         strcat( fullname, name );
395         file = fopen( fullname, "r" );
396     }
397     else fullname = xstrdup( name );
398
399     if (!file) fatal_error( "Cannot open file '%s'\n", fullname );
400     input_file_name = fullname;
401     current_line = 1;
402     return file;
403 }
404
405
406 /*******************************************************************
407  *         close_input_file
408  *
409  * Close the current input file (must have been opened with open_input_file).
410  */
411 void close_input_file( FILE *file )
412 {
413     fclose( file );
414     free( input_file_name );
415     input_file_name = NULL;
416     current_line = 0;
417 }
418
419
420 /*******************************************************************
421  *         remove_stdcall_decoration
422  *
423  * Remove a possible @xx suffix from a function name.
424  * Return the numerical value of the suffix, or -1 if none.
425  */
426 int remove_stdcall_decoration( char *name )
427 {
428     char *p, *end = strrchr( name, '@' );
429     if (!end || !end[1] || end == name) return -1;
430     /* make sure all the rest is digits */
431     for (p = end + 1; *p; p++) if (!isdigit(*p)) return -1;
432     *end = 0;
433     return atoi( end + 1 );
434 }
435
436
437 /*******************************************************************
438  *         assemble_file
439  *
440  * Run a file through the assembler.
441  */
442 void assemble_file( const char *src_file, const char *obj_file )
443 {
444     const char *prog = get_as_command();
445     char *cmd;
446     int err;
447
448     cmd = xmalloc( strlen(prog) + strlen(obj_file) + strlen(src_file) + 6 );
449     sprintf( cmd, "%s -o %s %s", prog, obj_file, src_file );
450     if (verbose) fprintf( stderr, "%s\n", cmd );
451     err = system( cmd );
452     if (err) fatal_error( "%s failed with status %d\n", prog, err );
453     free( cmd );
454 }
455
456
457 /*******************************************************************
458  *         alloc_dll_spec
459  *
460  * Create a new dll spec file descriptor
461  */
462 DLLSPEC *alloc_dll_spec(void)
463 {
464     DLLSPEC *spec;
465
466     spec = xmalloc( sizeof(*spec) );
467     spec->file_name          = NULL;
468     spec->dll_name           = NULL;
469     spec->init_func          = NULL;
470     spec->main_module        = NULL;
471     spec->type               = SPEC_WIN32;
472     spec->base               = MAX_ORDINALS;
473     spec->limit              = 0;
474     spec->stack_size         = 0;
475     spec->heap_size          = 0;
476     spec->nb_entry_points    = 0;
477     spec->alloc_entry_points = 0;
478     spec->nb_names           = 0;
479     spec->nb_resources       = 0;
480     spec->characteristics    = IMAGE_FILE_EXECUTABLE_IMAGE;
481     if (get_ptr_size() > 4)
482         spec->characteristics |= IMAGE_FILE_LARGE_ADDRESS_AWARE;
483     else
484         spec->characteristics |= IMAGE_FILE_32BIT_MACHINE;
485     spec->dll_characteristics = IMAGE_DLLCHARACTERISTICS_NX_COMPAT;
486     spec->subsystem          = 0;
487     spec->subsystem_major    = 4;
488     spec->subsystem_minor    = 0;
489     spec->entry_points       = NULL;
490     spec->names              = NULL;
491     spec->ordinals           = NULL;
492     spec->resources          = NULL;
493     return spec;
494 }
495
496
497 /*******************************************************************
498  *         free_dll_spec
499  *
500  * Free dll spec file descriptor
501  */
502 void free_dll_spec( DLLSPEC *spec )
503 {
504     int i;
505
506     for (i = 0; i < spec->nb_entry_points; i++)
507     {
508         ORDDEF *odp = &spec->entry_points[i];
509         free( odp->name );
510         free( odp->export_name );
511         free( odp->link_name );
512     }
513     free( spec->file_name );
514     free( spec->dll_name );
515     free( spec->init_func );
516     free( spec->entry_points );
517     free( spec->names );
518     free( spec->ordinals );
519     free( spec->resources );
520     free( spec );
521 }
522
523
524 /*******************************************************************
525  *         make_c_identifier
526  *
527  * Map a string to a valid C identifier.
528  */
529 const char *make_c_identifier( const char *str )
530 {
531     static char buffer[256];
532     char *p;
533
534     for (p = buffer; *str && p < buffer+sizeof(buffer)-1; p++, str++)
535     {
536         if (isalnum(*str)) *p = *str;
537         else *p = '_';
538     }
539     *p = 0;
540     return buffer;
541 }
542
543
544 /*******************************************************************
545  *         get_stub_name
546  *
547  * Generate an internal name for a stub entry point.
548  */
549 const char *get_stub_name( const ORDDEF *odp, const DLLSPEC *spec )
550 {
551     static char buffer[256];
552     if (odp->name || odp->export_name)
553     {
554         char *p;
555         sprintf( buffer, "__wine_stub_%s", odp->name ? odp->name : odp->export_name );
556         /* make sure name is a legal C identifier */
557         for (p = buffer; *p; p++) if (!isalnum(*p) && *p != '_') break;
558         if (!*p) return buffer;
559     }
560     sprintf( buffer, "__wine_stub_%s_%d", make_c_identifier(spec->file_name), odp->ordinal );
561     return buffer;
562 }
563
564 /* parse a cpu name and return the corresponding value */
565 enum target_cpu get_cpu_from_name( const char *name )
566 {
567     unsigned int i;
568
569     for (i = 0; i < sizeof(cpu_names)/sizeof(cpu_names[0]); i++)
570         if (!strcmp( cpu_names[i].name, name )) return cpu_names[i].cpu;
571     return -1;
572 }
573
574 /*****************************************************************
575  *  Function:    get_alignment
576  *
577  *  Description:
578  *    According to the info page for gas, the .align directive behaves
579  * differently on different systems.  On some architectures, the
580  * argument of a .align directive is the number of bytes to pad to, so
581  * to align on an 8-byte boundary you'd say
582  *     .align 8
583  * On other systems, the argument is "the number of low-order zero bits
584  * that the location counter must have after advancement."  So to
585  * align on an 8-byte boundary you'd say
586  *     .align 3
587  *
588  * The reason gas is written this way is that it's trying to mimick
589  * native assemblers for the various architectures it runs on.  gas
590  * provides other directives that work consistently across
591  * architectures, but of course we want to work on all arches with or
592  * without gas.  Hence this function.
593  *
594  *
595  *  Parameters:
596  *    align  --  the number of bytes to align to. Must be a power of 2.
597  */
598 unsigned int get_alignment(unsigned int align)
599 {
600     unsigned int n;
601
602     assert( !(align & (align - 1)) );
603
604     switch(target_cpu)
605     {
606     case CPU_x86:
607     case CPU_x86_64:
608     case CPU_SPARC:
609         if (target_platform != PLATFORM_APPLE) return align;
610         /* fall through */
611     case CPU_POWERPC:
612     case CPU_ALPHA:
613         n = 0;
614         while ((1u << n) != align) n++;
615         return n;
616     }
617     /* unreached */
618     assert(0);
619     return 0;
620 }
621
622 /* return the page size for the target CPU */
623 unsigned int get_page_size(void)
624 {
625     switch(target_cpu)
626     {
627     case CPU_x86:     return 4096;
628     case CPU_x86_64:  return 4096;
629     case CPU_POWERPC: return 4096;
630     case CPU_SPARC:   return 8192;
631     case CPU_ALPHA:   return 8192;
632     }
633     /* unreached */
634     assert(0);
635     return 0;
636 }
637
638 /* return the size of a pointer on the target CPU */
639 unsigned int get_ptr_size(void)
640 {
641     switch(target_cpu)
642     {
643     case CPU_x86:
644     case CPU_POWERPC:
645     case CPU_SPARC:
646     case CPU_ALPHA:
647         return 4;
648     case CPU_x86_64:
649         return 8;
650     }
651     /* unreached */
652     assert(0);
653     return 0;
654 }
655
656 /* return the assembly name for a C symbol */
657 const char *asm_name( const char *sym )
658 {
659     static char buffer[256];
660
661     switch (target_platform)
662     {
663     case PLATFORM_APPLE:
664     case PLATFORM_WINDOWS:
665         if (sym[0] == '.' && sym[1] == 'L') return sym;
666         buffer[0] = '_';
667         strcpy( buffer + 1, sym );
668         return buffer;
669     default:
670         return sym;
671     }
672 }
673
674 /* return an assembly function declaration for a C function name */
675 const char *func_declaration( const char *func )
676 {
677     static char buffer[256];
678
679     switch (target_platform)
680     {
681     case PLATFORM_APPLE:
682         return "";
683     case PLATFORM_WINDOWS:
684         sprintf( buffer, ".def _%s; .scl 2; .type 32; .endef", func );
685         break;
686     default:
687         sprintf( buffer, ".type %s,@function", func );
688         break;
689     }
690     return buffer;
691 }
692
693 /* output a size declaration for an assembly function */
694 void output_function_size( const char *name )
695 {
696     switch (target_platform)
697     {
698     case PLATFORM_APPLE:
699     case PLATFORM_WINDOWS:
700         break;
701     default:
702         output( "\t.size %s, .-%s\n", name, name );
703         break;
704     }
705 }
706
707 /* output the GNU note for non-exec stack */
708 void output_gnu_stack_note(void)
709 {
710     switch (target_platform)
711     {
712     case PLATFORM_WINDOWS:
713     case PLATFORM_APPLE:
714         break;
715     default:
716         output( "\t.section .note.GNU-stack,\"\",@progbits\n" );
717         break;
718     }
719 }
720
721 /* return a global symbol declaration for an assembly symbol */
722 const char *asm_globl( const char *func )
723 {
724     static char buffer[256];
725
726     switch (target_platform)
727     {
728     case PLATFORM_APPLE:
729         sprintf( buffer, "\t.globl _%s\n\t.private_extern _%s\n_%s:", func, func, func );
730         return buffer;
731     case PLATFORM_WINDOWS:
732         sprintf( buffer, "\t.globl _%s\n_%s:", func, func );
733         return buffer;
734     default:
735         sprintf( buffer, "\t.globl %s\n\t.hidden %s\n%s:", func, func, func );
736         return buffer;
737     }
738 }
739
740 const char *get_asm_ptr_keyword(void)
741 {
742     switch(get_ptr_size())
743     {
744     case 4: return ".long";
745     case 8: return ".quad";
746     }
747     assert(0);
748     return NULL;
749 }
750
751 const char *get_asm_string_keyword(void)
752 {
753     switch (target_platform)
754     {
755     case PLATFORM_APPLE:
756         return ".asciz";
757     default:
758         return ".string";
759     }
760 }
761
762 const char *get_asm_short_keyword(void)
763 {
764     switch (target_platform)
765     {
766     default:            return ".short";
767     }
768 }
769
770 const char *get_asm_rodata_section(void)
771 {
772     switch (target_platform)
773     {
774     case PLATFORM_APPLE: return ".const";
775     default:             return ".section .rodata";
776     }
777 }
778
779 const char *get_asm_string_section(void)
780 {
781     switch (target_platform)
782     {
783     case PLATFORM_APPLE: return ".cstring";
784     default:             return ".section .rodata";
785     }
786 }