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 { "alpha", CPU_ALPHA },
61 { "powerpc", CPU_POWERPC },
65 /* atexit handler to clean tmp files */
66 static void cleanup_tmp_files(void)
69 for (i = 0; i < nb_tmp_files; i++) if (tmp_files[i]) unlink( tmp_files[i] );
73 void *xmalloc (size_t size)
77 res = malloc (size ? size : 1);
80 fprintf (stderr, "Virtual memory exhausted.\n");
86 void *xrealloc (void *ptr, size_t size)
88 void *res = realloc (ptr, size);
89 if (size && res == NULL)
91 fprintf (stderr, "Virtual memory exhausted.\n");
97 char *xstrdup( const char *str )
99 char *res = strdup( str );
102 fprintf (stderr, "Virtual memory exhausted.\n");
108 char *strupper(char *s)
111 for (p = s; *p; p++) *p = toupper(*p);
115 int strendswith(const char* str, const char* end)
119 return l >= m && strcmp(str + l - m, end) == 0;
122 char *strmake( const char* fmt, ... )
130 char *p = xmalloc( size );
132 n = vsnprintf( p, size, fmt, ap );
134 if (n == -1) size *= 2;
135 else if ((size_t)n >= size) size = n + 1;
141 struct strarray *strarray_init(void)
143 struct strarray *array = xmalloc( sizeof(*array) );
146 array->str = xmalloc( array->max * sizeof(*array->str) );
150 static void strarray_add_one( struct strarray *array, const char *str )
152 if (array->count == array->max)
155 array->str = xrealloc( array->str, array->max * sizeof(*array->str) );
157 array->str[array->count++] = str;
160 void strarray_add( struct strarray *array, ... )
165 va_start( valist, array );
166 while ((str = va_arg( valist, const char *))) strarray_add_one( array, str );
170 void strarray_addv( struct strarray *array, char * const *argv )
172 while (*argv) strarray_add_one( array, *argv++ );
175 void strarray_free( struct strarray *array )
181 void fatal_error( const char *msg, ... )
184 va_start( valist, msg );
187 fprintf( stderr, "%s:", input_file_name );
189 fprintf( stderr, "%d:", current_line );
190 fputc( ' ', stderr );
192 else fprintf( stderr, "winebuild: " );
193 vfprintf( stderr, msg, valist );
198 void fatal_perror( const char *msg, ... )
201 va_start( valist, msg );
204 fprintf( stderr, "%s:", input_file_name );
206 fprintf( stderr, "%d:", current_line );
207 fputc( ' ', stderr );
209 vfprintf( stderr, msg, valist );
215 void error( const char *msg, ... )
218 va_start( valist, msg );
221 fprintf( stderr, "%s:", input_file_name );
223 fprintf( stderr, "%d:", current_line );
224 fputc( ' ', stderr );
226 vfprintf( stderr, msg, valist );
231 void warning( const char *msg, ... )
235 if (!display_warnings) return;
236 va_start( valist, msg );
239 fprintf( stderr, "%s:", input_file_name );
241 fprintf( stderr, "%d:", current_line );
242 fputc( ' ', stderr );
244 fprintf( stderr, "warning: " );
245 vfprintf( stderr, msg, valist );
249 int output( const char *format, ... )
254 va_start( valist, format );
255 ret = vfprintf( output_file, format, valist );
257 if (ret < 0) fatal_perror( "Output error" );
261 void spawn( struct strarray *args )
266 strarray_add_one( args, NULL );
268 for (i = 0; args->str[i]; i++)
269 fprintf( stderr, "%s%c", args->str[i], args->str[i+1] ? ' ' : '\n' );
271 if ((status = spawnvp( _P_WAIT, args->str[0], args->str )))
273 if (status > 0) fatal_error( "%s failed with status %u\n", args->str[0], status );
274 else fatal_perror( "winebuild" );
279 /* find a build tool in the path, trying the various names */
280 char *find_tool( const char *name, const char * const *names )
283 static unsigned int count, maxlen;
286 const char *alt_names[2];
290 if (target_alias) return strmake( "%s-%s", target_alias, name );
296 /* split the path in directories */
298 if (!getenv( "PATH" )) return NULL;
299 path = xstrdup( getenv( "PATH" ));
300 for (p = path, count = 2; *p; p++) if (*p == ':') count++;
301 dirs = xmalloc( count * sizeof(*dirs) );
303 dirs[count++] = p = path;
306 while (*p && *p != ':') p++;
311 for (i = 0; i < count; i++) maxlen = max( maxlen, strlen(dirs[i])+2 );
323 len = strlen(*names) + sizeof(EXEEXT) + 1;
324 file = xmalloc( maxlen + len );
326 for (i = 0; i < count; i++)
328 strcpy( file, dirs[i] );
329 p = file + strlen(file);
330 if (p == file) *p++ = '.';
331 if (p[-1] != '/') *p++ = '/';
335 if (!stat( file, &st ) && S_ISREG(st.st_mode) && (st.st_mode & 0111)) return file;
340 return xstrdup( name );
343 struct strarray *get_as_command(void)
345 struct strarray *args = strarray_init();
349 static const char * const commands[] = { "gas", "as", NULL };
350 as_command = find_tool( "as", commands );
352 strarray_add_one( args, as_command );
354 if (force_pointer_size)
356 switch (target_platform)
359 strarray_add( args, "-arch", (force_pointer_size == 8) ? "x86_64" : "i386", NULL );
362 strarray_add_one( args, (force_pointer_size == 8) ? "--64" : "--32" );
369 struct strarray *get_ld_command(void)
371 struct strarray *args = strarray_init();
375 static const char * const commands[] = { "ld", "gld", NULL };
376 ld_command = find_tool( "ld", commands );
378 strarray_add_one( args, ld_command );
380 if (force_pointer_size)
382 switch (target_platform)
385 strarray_add( args, "-arch", (force_pointer_size == 8) ? "x86_64" : "i386", NULL );
387 case PLATFORM_FREEBSD:
388 strarray_add( args, "-m", (force_pointer_size == 8) ? "elf_x86_64_fbsd" : "elf_i386_fbsd", NULL );
391 strarray_add( args, "-m", (force_pointer_size == 8) ? "elf_x86_64" : "elf_i386", NULL );
398 const char *get_nm_command(void)
402 static const char * const commands[] = { "nm", "gnm", NULL };
403 nm_command = find_tool( "nm", commands );
408 /* get a name for a temp file, automatically cleaned up on exit */
409 char *get_temp_file_name( const char *prefix, const char *suffix )
415 if (!nb_tmp_files && !save_temps) atexit( cleanup_tmp_files );
417 if (!prefix || !prefix[0]) prefix = "winebuild";
418 if (!suffix) suffix = "";
419 if (!(ext = strchr( prefix, '.' ))) ext = prefix + strlen(prefix);
420 name = xmalloc( sizeof("/tmp/") + (ext - prefix) + sizeof(".XXXXXX") + strlen(suffix) );
421 strcpy( name, "/tmp/" );
422 memcpy( name + 5, prefix, ext - prefix );
423 strcpy( name + 5 + (ext - prefix), ".XXXXXX" );
424 strcat( name, suffix );
426 /* first try without the /tmp/ prefix */
427 if ((fd = mkstemps( name + 5, strlen(suffix) )) != -1)
429 else if ((fd = mkstemps( name, strlen(suffix) )) == -1)
430 fatal_error( "could not generate a temp file\n" );
433 if (nb_tmp_files >= max_tmp_files)
435 max_tmp_files = max( 2 * max_tmp_files, 8 );
436 tmp_files = xrealloc( tmp_files, max_tmp_files * sizeof(tmp_files[0]) );
438 tmp_files[nb_tmp_files++] = name;
442 /*******************************************************************
445 * Function for reading from/writing to a memory buffer.
448 int byte_swapped = 0;
449 const char *input_buffer_filename;
450 const unsigned char *input_buffer;
451 size_t input_buffer_pos;
452 size_t input_buffer_size;
453 unsigned char *output_buffer;
454 size_t output_buffer_pos;
455 size_t output_buffer_size;
457 static void check_output_buffer_space( size_t size )
459 if (output_buffer_pos + size >= output_buffer_size)
461 output_buffer_size = max( output_buffer_size * 2, output_buffer_pos + size );
462 output_buffer = xrealloc( output_buffer, output_buffer_size );
466 void init_input_buffer( const char *file )
471 if ((fd = open( file, O_RDONLY | O_BINARY )) == -1) fatal_perror( "Cannot open %s", file );
472 if ((fstat( fd, &st ) == -1)) fatal_perror( "Cannot stat %s", file );
473 if (!st.st_size) fatal_error( "%s is an empty file\n", file );
475 if ((input_buffer = mmap( NULL, st.st_size, PROT_READ, MAP_PRIVATE, fd, 0 )) == (void*)-1)
478 unsigned char *buffer = xmalloc( st.st_size );
479 if (read( fd, buffer, st.st_size ) != st.st_size) fatal_error( "Cannot read %s\n", file );
480 input_buffer = buffer;
483 input_buffer_filename = xstrdup( file );
484 input_buffer_size = st.st_size;
485 input_buffer_pos = 0;
489 void init_output_buffer(void)
491 output_buffer_size = 1024;
492 output_buffer_pos = 0;
493 output_buffer = xmalloc( output_buffer_size );
496 void flush_output_buffer(void)
498 if (fwrite( output_buffer, 1, output_buffer_pos, output_file ) != output_buffer_pos)
499 fatal_error( "Error writing to %s\n", output_file_name );
500 free( output_buffer );
503 unsigned char get_byte(void)
505 if (input_buffer_pos >= input_buffer_size)
506 fatal_error( "%s is a truncated file\n", input_buffer_filename );
507 return input_buffer[input_buffer_pos++];
510 unsigned short get_word(void)
514 if (input_buffer_pos + sizeof(ret) > input_buffer_size)
515 fatal_error( "%s is a truncated file\n", input_buffer_filename );
516 memcpy( &ret, input_buffer + input_buffer_pos, sizeof(ret) );
517 if (byte_swapped) ret = (ret << 8) | (ret >> 8);
518 input_buffer_pos += sizeof(ret);
522 unsigned int get_dword(void)
526 if (input_buffer_pos + sizeof(ret) > input_buffer_size)
527 fatal_error( "%s is a truncated file\n", input_buffer_filename );
528 memcpy( &ret, input_buffer + input_buffer_pos, sizeof(ret) );
530 ret = ((ret << 24) | ((ret << 8) & 0x00ff0000) | ((ret >> 8) & 0x0000ff00) | (ret >> 24));
531 input_buffer_pos += sizeof(ret);
535 void put_data( const void *data, size_t size )
537 check_output_buffer_space( size );
538 memcpy( output_buffer + output_buffer_pos, data, size );
539 output_buffer_pos += size;
542 void put_byte( unsigned char val )
544 check_output_buffer_space( 1 );
545 output_buffer[output_buffer_pos++] = val;
548 void put_word( unsigned short val )
550 if (byte_swapped) val = (val << 8) | (val >> 8);
551 put_data( &val, sizeof(val) );
554 void put_dword( unsigned int val )
557 val = ((val << 24) | ((val << 8) & 0x00ff0000) | ((val >> 8) & 0x0000ff00) | (val >> 24));
558 put_data( &val, sizeof(val) );
561 void put_qword( unsigned int val )
575 /* pointer-sized word */
576 void put_pword( unsigned int val )
578 if (get_ptr_size() == 8) put_qword( val );
579 else put_dword( val );
582 void align_output( unsigned int align )
584 size_t size = align - (output_buffer_pos % align);
586 if (size == align) return;
587 check_output_buffer_space( size );
588 memset( output_buffer + output_buffer_pos, 0, size );
589 output_buffer_pos += size;
592 /* output a standard header for generated files */
593 void output_standard_file_header(void)
596 output( "/* File generated automatically from %s; do not edit! */\n", spec_file_name );
598 output( "/* File generated automatically; do not edit! */\n" );
599 output( "/* This file can be copied, modified and distributed without restriction. */\n\n" );
602 /* dump a byte stream into the assembly code */
603 void dump_bytes( const void *buffer, unsigned int size )
606 const unsigned char *ptr = buffer;
609 output( "\t.byte " );
610 for (i = 0; i < size - 1; i++, ptr++)
612 if ((i % 16) == 15) output( "0x%02x\n\t.byte ", *ptr );
613 else output( "0x%02x,", *ptr );
615 output( "0x%02x\n", *ptr );
619 /*******************************************************************
622 * Open a file in the given srcdir and set the input_file_name global variable.
624 FILE *open_input_file( const char *srcdir, const char *name )
627 FILE *file = fopen( name, "r" );
631 fullname = strmake( "%s/%s", srcdir, name );
632 file = fopen( fullname, "r" );
634 else fullname = xstrdup( name );
636 if (!file) fatal_error( "Cannot open file '%s'\n", fullname );
637 input_file_name = fullname;
643 /*******************************************************************
646 * Close the current input file (must have been opened with open_input_file).
648 void close_input_file( FILE *file )
651 free( input_file_name );
652 input_file_name = NULL;
657 /*******************************************************************
658 * remove_stdcall_decoration
660 * Remove a possible @xx suffix from a function name.
661 * Return the numerical value of the suffix, or -1 if none.
663 int remove_stdcall_decoration( char *name )
665 char *p, *end = strrchr( name, '@' );
666 if (!end || !end[1] || end == name) return -1;
667 if (target_cpu != CPU_x86) return -1;
668 /* make sure all the rest is digits */
669 for (p = end + 1; *p; p++) if (!isdigit(*p)) return -1;
671 return atoi( end + 1 );
675 /*******************************************************************
678 * Run a file through the assembler.
680 void assemble_file( const char *src_file, const char *obj_file )
682 struct strarray *args = get_as_command();
683 strarray_add( args, "-o", obj_file, src_file, NULL );
685 strarray_free( args );
689 /*******************************************************************
692 * Create a new dll spec file descriptor
694 DLLSPEC *alloc_dll_spec(void)
698 spec = xmalloc( sizeof(*spec) );
699 spec->file_name = NULL;
700 spec->dll_name = NULL;
701 spec->init_func = NULL;
702 spec->main_module = NULL;
703 spec->type = SPEC_WIN32;
704 spec->base = MAX_ORDINALS;
706 spec->stack_size = 0;
708 spec->nb_entry_points = 0;
709 spec->alloc_entry_points = 0;
711 spec->nb_resources = 0;
712 spec->characteristics = IMAGE_FILE_EXECUTABLE_IMAGE;
713 if (get_ptr_size() > 4)
714 spec->characteristics |= IMAGE_FILE_LARGE_ADDRESS_AWARE;
716 spec->characteristics |= IMAGE_FILE_32BIT_MACHINE;
717 spec->dll_characteristics = IMAGE_DLLCHARACTERISTICS_NX_COMPAT;
719 spec->subsystem_major = 4;
720 spec->subsystem_minor = 0;
721 spec->entry_points = NULL;
723 spec->ordinals = NULL;
724 spec->resources = NULL;
729 /*******************************************************************
732 * Free dll spec file descriptor
734 void free_dll_spec( DLLSPEC *spec )
738 for (i = 0; i < spec->nb_entry_points; i++)
740 ORDDEF *odp = &spec->entry_points[i];
742 free( odp->export_name );
743 free( odp->link_name );
745 free( spec->file_name );
746 free( spec->dll_name );
747 free( spec->init_func );
748 free( spec->entry_points );
750 free( spec->ordinals );
751 free( spec->resources );
756 /*******************************************************************
759 * Map a string to a valid C identifier.
761 const char *make_c_identifier( const char *str )
763 static char buffer[256];
766 for (p = buffer; *str && p < buffer+sizeof(buffer)-1; p++, str++)
768 if (isalnum(*str)) *p = *str;
776 /*******************************************************************
779 * Generate an internal name for a stub entry point.
781 const char *get_stub_name( const ORDDEF *odp, const DLLSPEC *spec )
786 if (odp->name || odp->export_name)
789 buffer = strmake( "__wine_stub_%s", odp->name ? odp->name : odp->export_name );
790 /* make sure name is a legal C identifier */
791 for (p = buffer; *p; p++) if (!isalnum(*p) && *p != '_') break;
792 if (!*p) return buffer;
795 buffer = strmake( "__wine_stub_%s_%d", make_c_identifier(spec->file_name), odp->ordinal );
799 /* parse a cpu name and return the corresponding value */
800 enum target_cpu get_cpu_from_name( const char *name )
804 for (i = 0; i < sizeof(cpu_names)/sizeof(cpu_names[0]); i++)
805 if (!strcmp( cpu_names[i].name, name )) return cpu_names[i].cpu;
809 /*****************************************************************
810 * Function: get_alignment
813 * According to the info page for gas, the .align directive behaves
814 * differently on different systems. On some architectures, the
815 * argument of a .align directive is the number of bytes to pad to, so
816 * to align on an 8-byte boundary you'd say
818 * On other systems, the argument is "the number of low-order zero bits
819 * that the location counter must have after advancement." So to
820 * align on an 8-byte boundary you'd say
823 * The reason gas is written this way is that it's trying to mimick
824 * native assemblers for the various architectures it runs on. gas
825 * provides other directives that work consistently across
826 * architectures, but of course we want to work on all arches with or
827 * without gas. Hence this function.
831 * align -- the number of bytes to align to. Must be a power of 2.
833 unsigned int get_alignment(unsigned int align)
837 assert( !(align & (align - 1)) );
844 if (target_platform != PLATFORM_APPLE) return align;
850 while ((1u << n) != align) n++;
858 /* return the page size for the target CPU */
859 unsigned int get_page_size(void)
863 case CPU_x86: return 4096;
864 case CPU_x86_64: return 4096;
865 case CPU_POWERPC: return 4096;
866 case CPU_ARM: return 4096;
867 case CPU_SPARC: return 8192;
868 case CPU_ALPHA: return 8192;
875 /* return the size of a pointer on the target CPU */
876 unsigned int get_ptr_size(void)
894 /* return the total size in bytes of the arguments on the stack */
895 unsigned int get_args_size( const ORDDEF *odp )
897 unsigned int i, size;
899 for (i = size = 0; i < odp->u.func.nb_args; i++)
901 switch (odp->u.func.args[i])
908 /* int128 is passed as pointer on x86_64 */
909 if (target_cpu != CPU_x86_64)
916 size += get_ptr_size();
923 /* return the assembly name for a C symbol */
924 const char *asm_name( const char *sym )
928 switch (target_platform)
931 case PLATFORM_WINDOWS:
932 if (sym[0] == '.' && sym[1] == 'L') return sym;
934 buffer = strmake( "_%s", sym );
941 /* return an assembly function declaration for a C function name */
942 const char *func_declaration( const char *func )
946 switch (target_platform)
950 case PLATFORM_WINDOWS:
952 buffer = strmake( ".def _%s; .scl 2; .type 32; .endef", func );
959 buffer = strmake( ".type %s,%%function", func );
962 buffer = strmake( ".type %s,@function", func );
970 /* output a size declaration for an assembly function */
971 void output_function_size( const char *name )
973 switch (target_platform)
976 case PLATFORM_WINDOWS:
979 output( "\t.size %s, .-%s\n", name, name );
984 /* output a .cfi directive */
985 void output_cfi( const char *format, ... )
989 if (!unwind_tables) return;
990 va_start( valist, format );
991 fputc( '\t', output_file );
992 vfprintf( output_file, format, valist );
993 fputc( '\n', output_file );
997 /* output the GNU note for non-exec stack */
998 void output_gnu_stack_note(void)
1000 switch (target_platform)
1002 case PLATFORM_WINDOWS:
1003 case PLATFORM_APPLE:
1009 output( "\t.section .note.GNU-stack,\"\",%%progbits\n" );
1012 output( "\t.section .note.GNU-stack,\"\",@progbits\n" );
1019 /* return a global symbol declaration for an assembly symbol */
1020 const char *asm_globl( const char *func )
1022 static char *buffer;
1025 switch (target_platform)
1027 case PLATFORM_APPLE:
1028 buffer = strmake( "\t.globl _%s\n\t.private_extern _%s\n_%s:", func, func, func );
1030 case PLATFORM_WINDOWS:
1031 buffer = strmake( "\t.globl _%s\n_%s:", func, func );
1034 buffer = strmake( "\t.globl %s\n\t.hidden %s\n%s:", func, func, func );
1040 const char *get_asm_ptr_keyword(void)
1042 switch(get_ptr_size())
1044 case 4: return ".long";
1045 case 8: return ".quad";
1051 const char *get_asm_string_keyword(void)
1053 switch (target_platform)
1055 case PLATFORM_APPLE:
1062 const char *get_asm_short_keyword(void)
1064 switch (target_platform)
1066 default: return ".short";
1070 const char *get_asm_rodata_section(void)
1072 switch (target_platform)
1074 case PLATFORM_APPLE: return ".const";
1075 default: return ".section .rodata";
1079 const char *get_asm_string_section(void)
1081 switch (target_platform)
1083 case PLATFORM_APPLE: return ".cstring";
1084 default: return ".section .rodata";