2 * Small utility functions for winebuild
4 * Copyright 2000 Alexandre Julliard
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.
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.
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
22 #include "wine/port.h"
33 #ifdef HAVE_SYS_STAT_H
34 # include <sys/stat.h>
36 #ifdef HAVE_SYS_MMAN_H
42 static const char **tmp_files;
43 static unsigned int nb_tmp_files;
44 static unsigned int max_tmp_files;
57 { "amd64", CPU_x86_64 },
58 { "x86_64", CPU_x86_64 },
59 { "sparc", CPU_SPARC },
60 { "powerpc", CPU_POWERPC },
64 /* atexit handler to clean tmp files */
65 static void cleanup_tmp_files(void)
68 for (i = 0; i < nb_tmp_files; i++) if (tmp_files[i]) unlink( tmp_files[i] );
72 void *xmalloc (size_t size)
76 res = malloc (size ? size : 1);
79 fprintf (stderr, "Virtual memory exhausted.\n");
85 void *xrealloc (void *ptr, size_t size)
87 void *res = realloc (ptr, size);
88 if (size && res == NULL)
90 fprintf (stderr, "Virtual memory exhausted.\n");
96 char *xstrdup( const char *str )
98 char *res = strdup( str );
101 fprintf (stderr, "Virtual memory exhausted.\n");
107 char *strupper(char *s)
110 for (p = s; *p; p++) *p = toupper(*p);
114 int strendswith(const char* str, const char* end)
118 return l >= m && strcmp(str + l - m, end) == 0;
121 char *strmake( const char* fmt, ... )
129 char *p = xmalloc( size );
131 n = vsnprintf( p, size, fmt, ap );
133 if (n == -1) size *= 2;
134 else if ((size_t)n >= size) size = n + 1;
140 struct strarray *strarray_init(void)
142 struct strarray *array = xmalloc( sizeof(*array) );
145 array->str = xmalloc( array->max * sizeof(*array->str) );
149 static void strarray_add_one( struct strarray *array, const char *str )
151 if (array->count == array->max)
154 array->str = xrealloc( array->str, array->max * sizeof(*array->str) );
156 array->str[array->count++] = str;
159 void strarray_add( struct strarray *array, ... )
164 va_start( valist, array );
165 while ((str = va_arg( valist, const char *))) strarray_add_one( array, str );
169 void strarray_addv( struct strarray *array, char * const *argv )
171 while (*argv) strarray_add_one( array, *argv++ );
174 void strarray_free( struct strarray *array )
180 void fatal_error( const char *msg, ... )
183 va_start( valist, msg );
186 fprintf( stderr, "%s:", input_file_name );
188 fprintf( stderr, "%d:", current_line );
189 fputc( ' ', stderr );
191 else fprintf( stderr, "winebuild: " );
192 vfprintf( stderr, msg, valist );
197 void fatal_perror( const char *msg, ... )
200 va_start( valist, msg );
203 fprintf( stderr, "%s:", input_file_name );
205 fprintf( stderr, "%d:", current_line );
206 fputc( ' ', stderr );
208 vfprintf( stderr, msg, valist );
214 void error( const char *msg, ... )
217 va_start( valist, msg );
220 fprintf( stderr, "%s:", input_file_name );
222 fprintf( stderr, "%d:", current_line );
223 fputc( ' ', stderr );
225 vfprintf( stderr, msg, valist );
230 void warning( const char *msg, ... )
234 if (!display_warnings) return;
235 va_start( valist, msg );
238 fprintf( stderr, "%s:", input_file_name );
240 fprintf( stderr, "%d:", current_line );
241 fputc( ' ', stderr );
243 fprintf( stderr, "warning: " );
244 vfprintf( stderr, msg, valist );
248 int output( const char *format, ... )
253 va_start( valist, format );
254 ret = vfprintf( output_file, format, valist );
256 if (ret < 0) fatal_perror( "Output error" );
260 void spawn( struct strarray *args )
265 strarray_add_one( args, NULL );
267 for (i = 0; args->str[i]; i++)
268 fprintf( stderr, "%s%c", args->str[i], args->str[i+1] ? ' ' : '\n' );
270 if ((status = spawnvp( _P_WAIT, args->str[0], args->str )))
272 if (status > 0) fatal_error( "%s failed with status %u\n", args->str[0], status );
273 else fatal_perror( "winebuild" );
278 /* find a build tool in the path, trying the various names */
279 char *find_tool( const char *name, const char * const *names )
282 static unsigned int count, maxlen;
285 const char *alt_names[2];
289 if (target_alias) return strmake( "%s-%s", target_alias, name );
295 /* split the path in directories */
297 if (!getenv( "PATH" )) return NULL;
298 path = xstrdup( getenv( "PATH" ));
299 for (p = path, count = 2; *p; p++) if (*p == ':') count++;
300 dirs = xmalloc( count * sizeof(*dirs) );
302 dirs[count++] = p = path;
305 while (*p && *p != ':') p++;
310 for (i = 0; i < count; i++) maxlen = max( maxlen, strlen(dirs[i])+2 );
322 len = strlen(*names) + sizeof(EXEEXT) + 1;
323 file = xmalloc( maxlen + len );
325 for (i = 0; i < count; i++)
327 strcpy( file, dirs[i] );
328 p = file + strlen(file);
329 if (p == file) *p++ = '.';
330 if (p[-1] != '/') *p++ = '/';
334 if (!stat( file, &st ) && S_ISREG(st.st_mode) && (st.st_mode & 0111)) return file;
339 return xstrdup( name );
342 struct strarray *get_as_command(void)
344 struct strarray *args = strarray_init();
348 static const char * const commands[] = { "gas", "as", NULL };
349 as_command = find_tool( "as", commands );
351 strarray_add_one( args, as_command );
353 if (force_pointer_size)
355 switch (target_platform)
358 strarray_add( args, "-arch", (force_pointer_size == 8) ? "x86_64" : "i386", NULL );
364 strarray_add_one( args, (force_pointer_size == 8) ? "-a64" : "-a32" );
367 strarray_add_one( args, (force_pointer_size == 8) ? "--64" : "--32" );
374 if (cpu_option) strarray_add_one( args, strmake("-mcpu=%s", cpu_option) );
378 struct strarray *get_ld_command(void)
380 struct strarray *args = strarray_init();
384 static const char * const commands[] = { "ld", "gld", NULL };
385 ld_command = find_tool( "ld", commands );
387 strarray_add_one( args, ld_command );
389 if (force_pointer_size)
391 switch (target_platform)
394 strarray_add( args, "-arch", (force_pointer_size == 8) ? "x86_64" : "i386", NULL );
396 case PLATFORM_FREEBSD:
397 strarray_add( args, "-m", (force_pointer_size == 8) ? "elf_x86_64_fbsd" : "elf_i386_fbsd", NULL );
403 strarray_add( args, "-m", (force_pointer_size == 8) ? "elf64ppc" : "elf32ppc", NULL );
406 strarray_add( args, "-m", (force_pointer_size == 8) ? "elf_x86_64" : "elf_i386", NULL );
415 const char *get_nm_command(void)
419 static const char * const commands[] = { "nm", "gnm", NULL };
420 nm_command = find_tool( "nm", commands );
425 /* get a name for a temp file, automatically cleaned up on exit */
426 char *get_temp_file_name( const char *prefix, const char *suffix )
429 const char *ext, *basename;
432 if (!nb_tmp_files && !save_temps) atexit( cleanup_tmp_files );
434 if (!prefix || !prefix[0]) prefix = "winebuild";
435 if (!suffix) suffix = "";
436 if ((basename = strrchr( prefix, '/' ))) basename++;
437 else basename = prefix;
438 if (!(ext = strchr( basename, '.' ))) ext = prefix + strlen(prefix);
439 name = xmalloc( sizeof("/tmp/") + (ext - prefix) + sizeof(".XXXXXX") + strlen(suffix) );
440 memcpy( name, prefix, ext - prefix );
441 strcpy( name + (ext - prefix), ".XXXXXX" );
442 strcat( name, suffix );
444 if ((fd = mkstemps( name, strlen(suffix) )) == -1)
446 strcpy( name, "/tmp/" );
447 memcpy( name + 5, basename, ext - basename );
448 strcpy( name + 5 + (ext - basename), ".XXXXXX" );
449 strcat( name, suffix );
450 if ((fd = mkstemps( name, strlen(suffix) )) == -1)
451 fatal_error( "could not generate a temp file\n" );
455 if (nb_tmp_files >= max_tmp_files)
457 max_tmp_files = max( 2 * max_tmp_files, 8 );
458 tmp_files = xrealloc( tmp_files, max_tmp_files * sizeof(tmp_files[0]) );
460 tmp_files[nb_tmp_files++] = name;
464 /*******************************************************************
467 * Function for reading from/writing to a memory buffer.
470 int byte_swapped = 0;
471 const char *input_buffer_filename;
472 const unsigned char *input_buffer;
473 size_t input_buffer_pos;
474 size_t input_buffer_size;
475 unsigned char *output_buffer;
476 size_t output_buffer_pos;
477 size_t output_buffer_size;
479 static void check_output_buffer_space( size_t size )
481 if (output_buffer_pos + size >= output_buffer_size)
483 output_buffer_size = max( output_buffer_size * 2, output_buffer_pos + size );
484 output_buffer = xrealloc( output_buffer, output_buffer_size );
488 void init_input_buffer( const char *file )
493 if ((fd = open( file, O_RDONLY | O_BINARY )) == -1) fatal_perror( "Cannot open %s", file );
494 if ((fstat( fd, &st ) == -1)) fatal_perror( "Cannot stat %s", file );
495 if (!st.st_size) fatal_error( "%s is an empty file\n", file );
497 if ((input_buffer = mmap( NULL, st.st_size, PROT_READ, MAP_PRIVATE, fd, 0 )) == (void*)-1)
500 unsigned char *buffer = xmalloc( st.st_size );
501 if (read( fd, buffer, st.st_size ) != st.st_size) fatal_error( "Cannot read %s\n", file );
502 input_buffer = buffer;
505 input_buffer_filename = xstrdup( file );
506 input_buffer_size = st.st_size;
507 input_buffer_pos = 0;
511 void init_output_buffer(void)
513 output_buffer_size = 1024;
514 output_buffer_pos = 0;
515 output_buffer = xmalloc( output_buffer_size );
518 void flush_output_buffer(void)
520 if (fwrite( output_buffer, 1, output_buffer_pos, output_file ) != output_buffer_pos)
521 fatal_error( "Error writing to %s\n", output_file_name );
522 free( output_buffer );
525 unsigned char get_byte(void)
527 if (input_buffer_pos >= input_buffer_size)
528 fatal_error( "%s is a truncated file\n", input_buffer_filename );
529 return input_buffer[input_buffer_pos++];
532 unsigned short get_word(void)
536 if (input_buffer_pos + sizeof(ret) > input_buffer_size)
537 fatal_error( "%s is a truncated file\n", input_buffer_filename );
538 memcpy( &ret, input_buffer + input_buffer_pos, sizeof(ret) );
539 if (byte_swapped) ret = (ret << 8) | (ret >> 8);
540 input_buffer_pos += sizeof(ret);
544 unsigned int get_dword(void)
548 if (input_buffer_pos + sizeof(ret) > input_buffer_size)
549 fatal_error( "%s is a truncated file\n", input_buffer_filename );
550 memcpy( &ret, input_buffer + input_buffer_pos, sizeof(ret) );
552 ret = ((ret << 24) | ((ret << 8) & 0x00ff0000) | ((ret >> 8) & 0x0000ff00) | (ret >> 24));
553 input_buffer_pos += sizeof(ret);
557 void put_data( const void *data, size_t size )
559 check_output_buffer_space( size );
560 memcpy( output_buffer + output_buffer_pos, data, size );
561 output_buffer_pos += size;
564 void put_byte( unsigned char val )
566 check_output_buffer_space( 1 );
567 output_buffer[output_buffer_pos++] = val;
570 void put_word( unsigned short val )
572 if (byte_swapped) val = (val << 8) | (val >> 8);
573 put_data( &val, sizeof(val) );
576 void put_dword( unsigned int val )
579 val = ((val << 24) | ((val << 8) & 0x00ff0000) | ((val >> 8) & 0x0000ff00) | (val >> 24));
580 put_data( &val, sizeof(val) );
583 void put_qword( unsigned int val )
597 /* pointer-sized word */
598 void put_pword( unsigned int val )
600 if (get_ptr_size() == 8) put_qword( val );
601 else put_dword( val );
604 void align_output( unsigned int align )
606 size_t size = align - (output_buffer_pos % align);
608 if (size == align) return;
609 check_output_buffer_space( size );
610 memset( output_buffer + output_buffer_pos, 0, size );
611 output_buffer_pos += size;
614 /* output a standard header for generated files */
615 void output_standard_file_header(void)
618 output( "/* File generated automatically from %s; do not edit! */\n", spec_file_name );
620 output( "/* File generated automatically; do not edit! */\n" );
621 output( "/* This file can be copied, modified and distributed without restriction. */\n\n" );
624 /* dump a byte stream into the assembly code */
625 void dump_bytes( const void *buffer, unsigned int size )
628 const unsigned char *ptr = buffer;
631 output( "\t.byte " );
632 for (i = 0; i < size - 1; i++, ptr++)
634 if ((i % 16) == 15) output( "0x%02x\n\t.byte ", *ptr );
635 else output( "0x%02x,", *ptr );
637 output( "0x%02x\n", *ptr );
641 /*******************************************************************
644 * Open a file in the given srcdir and set the input_file_name global variable.
646 FILE *open_input_file( const char *srcdir, const char *name )
649 FILE *file = fopen( name, "r" );
653 fullname = strmake( "%s/%s", srcdir, name );
654 file = fopen( fullname, "r" );
656 else fullname = xstrdup( name );
658 if (!file) fatal_error( "Cannot open file '%s'\n", fullname );
659 input_file_name = fullname;
665 /*******************************************************************
668 * Close the current input file (must have been opened with open_input_file).
670 void close_input_file( FILE *file )
673 free( input_file_name );
674 input_file_name = NULL;
679 /*******************************************************************
680 * remove_stdcall_decoration
682 * Remove a possible @xx suffix from a function name.
683 * Return the numerical value of the suffix, or -1 if none.
685 int remove_stdcall_decoration( char *name )
687 char *p, *end = strrchr( name, '@' );
688 if (!end || !end[1] || end == name) return -1;
689 if (target_cpu != CPU_x86) return -1;
690 /* make sure all the rest is digits */
691 for (p = end + 1; *p; p++) if (!isdigit(*p)) return -1;
693 return atoi( end + 1 );
697 /*******************************************************************
700 * Run a file through the assembler.
702 void assemble_file( const char *src_file, const char *obj_file )
704 struct strarray *args = get_as_command();
705 strarray_add( args, "-o", obj_file, src_file, NULL );
707 strarray_free( args );
711 /*******************************************************************
714 * Create a new dll spec file descriptor
716 DLLSPEC *alloc_dll_spec(void)
720 spec = xmalloc( sizeof(*spec) );
721 spec->file_name = NULL;
722 spec->dll_name = NULL;
723 spec->init_func = NULL;
724 spec->main_module = NULL;
725 spec->type = SPEC_WIN32;
726 spec->base = MAX_ORDINALS;
728 spec->stack_size = 0;
730 spec->nb_entry_points = 0;
731 spec->alloc_entry_points = 0;
733 spec->nb_resources = 0;
734 spec->characteristics = IMAGE_FILE_EXECUTABLE_IMAGE;
735 if (get_ptr_size() > 4)
736 spec->characteristics |= IMAGE_FILE_LARGE_ADDRESS_AWARE;
738 spec->characteristics |= IMAGE_FILE_32BIT_MACHINE;
739 spec->dll_characteristics = IMAGE_DLLCHARACTERISTICS_NX_COMPAT;
741 spec->subsystem_major = 4;
742 spec->subsystem_minor = 0;
743 spec->entry_points = NULL;
745 spec->ordinals = NULL;
746 spec->resources = NULL;
751 /*******************************************************************
754 * Free dll spec file descriptor
756 void free_dll_spec( DLLSPEC *spec )
760 for (i = 0; i < spec->nb_entry_points; i++)
762 ORDDEF *odp = &spec->entry_points[i];
764 free( odp->export_name );
765 free( odp->link_name );
767 free( spec->file_name );
768 free( spec->dll_name );
769 free( spec->init_func );
770 free( spec->entry_points );
772 free( spec->ordinals );
773 free( spec->resources );
778 /*******************************************************************
781 * Map a string to a valid C identifier.
783 const char *make_c_identifier( const char *str )
785 static char buffer[256];
788 for (p = buffer; *str && p < buffer+sizeof(buffer)-1; p++, str++)
790 if (isalnum(*str)) *p = *str;
798 /*******************************************************************
801 * Generate an internal name for a stub entry point.
803 const char *get_stub_name( const ORDDEF *odp, const DLLSPEC *spec )
808 if (odp->name || odp->export_name)
811 buffer = strmake( "__wine_stub_%s", odp->name ? odp->name : odp->export_name );
812 /* make sure name is a legal C identifier */
813 for (p = buffer; *p; p++) if (!isalnum(*p) && *p != '_') break;
814 if (!*p) return buffer;
817 buffer = strmake( "__wine_stub_%s_%d", make_c_identifier(spec->file_name), odp->ordinal );
821 /* parse a cpu name and return the corresponding value */
822 enum target_cpu get_cpu_from_name( const char *name )
826 for (i = 0; i < sizeof(cpu_names)/sizeof(cpu_names[0]); i++)
827 if (!strcmp( cpu_names[i].name, name )) return cpu_names[i].cpu;
831 /*****************************************************************
832 * Function: get_alignment
835 * According to the info page for gas, the .align directive behaves
836 * differently on different systems. On some architectures, the
837 * argument of a .align directive is the number of bytes to pad to, so
838 * to align on an 8-byte boundary you'd say
840 * On other systems, the argument is "the number of low-order zero bits
841 * that the location counter must have after advancement." So to
842 * align on an 8-byte boundary you'd say
845 * The reason gas is written this way is that it's trying to mimick
846 * native assemblers for the various architectures it runs on. gas
847 * provides other directives that work consistently across
848 * architectures, but of course we want to work on all arches with or
849 * without gas. Hence this function.
853 * align -- the number of bytes to align to. Must be a power of 2.
855 unsigned int get_alignment(unsigned int align)
859 assert( !(align & (align - 1)) );
866 if (target_platform != PLATFORM_APPLE) return align;
871 while ((1u << n) != align) n++;
879 /* return the page size for the target CPU */
880 unsigned int get_page_size(void)
884 case CPU_x86: return 4096;
885 case CPU_x86_64: return 4096;
886 case CPU_POWERPC: return 4096;
887 case CPU_ARM: return 4096;
888 case CPU_SPARC: return 8192;
895 /* return the size of a pointer on the target CPU */
896 unsigned int get_ptr_size(void)
913 /* return the total size in bytes of the arguments on the stack */
914 unsigned int get_args_size( const ORDDEF *odp )
918 for (i = size = 0; i < odp->u.func.nb_args; i++)
920 switch (odp->u.func.args[i])
927 /* int128 is passed as pointer on x86_64 */
928 if (target_cpu != CPU_x86_64)
935 size += get_ptr_size();
942 /* return the assembly name for a C symbol */
943 const char *asm_name( const char *sym )
947 switch (target_platform)
950 case PLATFORM_WINDOWS:
951 if (sym[0] == '.' && sym[1] == 'L') return sym;
953 buffer = strmake( "_%s", sym );
960 /* return an assembly function declaration for a C function name */
961 const char *func_declaration( const char *func )
965 switch (target_platform)
969 case PLATFORM_WINDOWS:
971 buffer = strmake( ".def _%s; .scl 2; .type 32; .endef", func );
978 buffer = strmake( ".type %s,%%function", func );
981 buffer = strmake( ".type %s,@function", func );
989 /* output a size declaration for an assembly function */
990 void output_function_size( const char *name )
992 switch (target_platform)
995 case PLATFORM_WINDOWS:
998 output( "\t.size %s, .-%s\n", name, name );
1003 /* output a .cfi directive */
1004 void output_cfi( const char *format, ... )
1008 if (!unwind_tables) return;
1009 va_start( valist, format );
1010 fputc( '\t', output_file );
1011 vfprintf( output_file, format, valist );
1012 fputc( '\n', output_file );
1016 /* output the GNU note for non-exec stack */
1017 void output_gnu_stack_note(void)
1019 switch (target_platform)
1021 case PLATFORM_WINDOWS:
1022 case PLATFORM_APPLE:
1028 output( "\t.section .note.GNU-stack,\"\",%%progbits\n" );
1031 output( "\t.section .note.GNU-stack,\"\",@progbits\n" );
1038 /* return a global symbol declaration for an assembly symbol */
1039 const char *asm_globl( const char *func )
1041 static char *buffer;
1044 switch (target_platform)
1046 case PLATFORM_APPLE:
1047 buffer = strmake( "\t.globl _%s\n\t.private_extern _%s\n_%s:", func, func, func );
1049 case PLATFORM_WINDOWS:
1050 buffer = strmake( "\t.globl _%s\n_%s:", func, func );
1053 buffer = strmake( "\t.globl %s\n\t.hidden %s\n%s:", func, func, func );
1059 const char *get_asm_ptr_keyword(void)
1061 switch(get_ptr_size())
1063 case 4: return ".long";
1064 case 8: return ".quad";
1070 const char *get_asm_string_keyword(void)
1072 switch (target_platform)
1074 case PLATFORM_APPLE:
1081 const char *get_asm_short_keyword(void)
1083 switch (target_platform)
1085 default: return ".short";
1089 const char *get_asm_rodata_section(void)
1091 switch (target_platform)
1093 case PLATFORM_APPLE: return ".const";
1094 default: return ".section .rodata";
1098 const char *get_asm_string_section(void)
1100 switch (target_platform)
1102 case PLATFORM_APPLE: return ".cstring";
1103 default: return ".section .rodata";