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 { "powerpc", CPU_POWERPC },
61 { "arm64", CPU_ARM64 },
62 { "aarch64", CPU_ARM64 },
65 /* atexit handler to clean tmp files */
66 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];
294 /* split the path in directories */
296 if (!getenv( "PATH" )) return NULL;
297 path = xstrdup( getenv( "PATH" ));
298 for (p = path, count = 2; *p; p++) if (*p == ':') count++;
299 dirs = xmalloc( count * sizeof(*dirs) );
301 dirs[count++] = p = path;
304 while (*p && *p != ':') p++;
309 for (i = 0; i < count; i++) maxlen = max( maxlen, strlen(dirs[i])+2 );
321 len = strlen(*names) + sizeof(EXEEXT) + 1;
323 len += strlen(target_alias) + 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++ = '/';
334 strcpy( p, target_alias );
341 if (!stat( file, &st ) && S_ISREG(st.st_mode) && (st.st_mode & 0111)) return file;
349 struct strarray *get_as_command(void)
351 static int as_is_clang = 0;
352 struct strarray *args = strarray_init();
356 as_command = find_tool( "clang", NULL );
357 if (as_command) as_is_clang = 1;
362 static const char * const commands[] = { "gas", "as", NULL };
363 as_command = find_tool( "as", commands );
367 fatal_error( "cannot find suitable assembler\n" );
369 strarray_add_one( args, as_command );
373 strarray_add( args, "-xassembler", "-c", NULL );
374 if (force_pointer_size)
375 strarray_add_one( args, (force_pointer_size == 8) ? "-m64" : "-m32" );
377 else if (force_pointer_size)
379 switch (target_platform)
382 strarray_add( args, "-arch", (force_pointer_size == 8) ? "x86_64" : "i386", NULL );
388 strarray_add_one( args, (force_pointer_size == 8) ? "-a64" : "-a32" );
391 strarray_add_one( args, (force_pointer_size == 8) ? "--64" : "--32" );
398 if (cpu_option) strarray_add_one( args, strmake("-mcpu=%s", cpu_option) );
402 struct strarray *get_ld_command(void)
404 struct strarray *args = strarray_init();
408 static const char * const commands[] = { "ld", "gld", NULL };
409 ld_command = find_tool( "ld", commands );
413 fatal_error( "cannot find suitable linker\n" );
415 strarray_add_one( args, ld_command );
417 if (force_pointer_size)
419 switch (target_platform)
422 strarray_add( args, "-arch", (force_pointer_size == 8) ? "x86_64" : "i386", NULL );
424 case PLATFORM_FREEBSD:
425 strarray_add( args, "-m", (force_pointer_size == 8) ? "elf_x86_64_fbsd" : "elf_i386_fbsd", NULL );
431 strarray_add( args, "-m", (force_pointer_size == 8) ? "elf64ppc" : "elf32ppc", NULL );
434 strarray_add( args, "-m", (force_pointer_size == 8) ? "elf_x86_64" : "elf_i386", NULL );
443 const char *get_nm_command(void)
447 static const char * const commands[] = { "nm", "gnm", NULL };
448 nm_command = find_tool( "nm", commands );
452 fatal_error( "cannot find suitable name lister\n" );
456 /* get a name for a temp file, automatically cleaned up on exit */
457 char *get_temp_file_name( const char *prefix, const char *suffix )
460 const char *ext, *basename;
463 if (!prefix || !prefix[0]) prefix = "winebuild";
464 if (!suffix) suffix = "";
465 if ((basename = strrchr( prefix, '/' ))) basename++;
466 else basename = prefix;
467 if (!(ext = strchr( basename, '.' ))) ext = prefix + strlen(prefix);
468 name = xmalloc( sizeof("/tmp/") + (ext - prefix) + sizeof(".XXXXXX") + strlen(suffix) );
469 memcpy( name, prefix, ext - prefix );
470 strcpy( name + (ext - prefix), ".XXXXXX" );
471 strcat( name, suffix );
473 if ((fd = mkstemps( name, strlen(suffix) )) == -1)
475 strcpy( name, "/tmp/" );
476 memcpy( name + 5, basename, ext - basename );
477 strcpy( name + 5 + (ext - basename), ".XXXXXX" );
478 strcat( name, suffix );
479 if ((fd = mkstemps( name, strlen(suffix) )) == -1)
480 fatal_error( "could not generate a temp file\n" );
484 if (nb_tmp_files >= max_tmp_files)
486 max_tmp_files = max( 2 * max_tmp_files, 8 );
487 tmp_files = xrealloc( tmp_files, max_tmp_files * sizeof(tmp_files[0]) );
489 tmp_files[nb_tmp_files++] = name;
493 /*******************************************************************
496 * Function for reading from/writing to a memory buffer.
499 int byte_swapped = 0;
500 const char *input_buffer_filename;
501 const unsigned char *input_buffer;
502 size_t input_buffer_pos;
503 size_t input_buffer_size;
504 unsigned char *output_buffer;
505 size_t output_buffer_pos;
506 size_t output_buffer_size;
508 static void check_output_buffer_space( size_t size )
510 if (output_buffer_pos + size >= output_buffer_size)
512 output_buffer_size = max( output_buffer_size * 2, output_buffer_pos + size );
513 output_buffer = xrealloc( output_buffer, output_buffer_size );
517 void init_input_buffer( const char *file )
522 if ((fd = open( file, O_RDONLY | O_BINARY )) == -1) fatal_perror( "Cannot open %s", file );
523 if ((fstat( fd, &st ) == -1)) fatal_perror( "Cannot stat %s", file );
524 if (!st.st_size) fatal_error( "%s is an empty file\n", file );
526 if ((input_buffer = mmap( NULL, st.st_size, PROT_READ, MAP_PRIVATE, fd, 0 )) == (void*)-1)
529 unsigned char *buffer = xmalloc( st.st_size );
530 if (read( fd, buffer, st.st_size ) != st.st_size) fatal_error( "Cannot read %s\n", file );
531 input_buffer = buffer;
534 input_buffer_filename = xstrdup( file );
535 input_buffer_size = st.st_size;
536 input_buffer_pos = 0;
540 void init_output_buffer(void)
542 output_buffer_size = 1024;
543 output_buffer_pos = 0;
544 output_buffer = xmalloc( output_buffer_size );
547 void flush_output_buffer(void)
549 if (fwrite( output_buffer, 1, output_buffer_pos, output_file ) != output_buffer_pos)
550 fatal_error( "Error writing to %s\n", output_file_name );
551 free( output_buffer );
554 unsigned char get_byte(void)
556 if (input_buffer_pos >= input_buffer_size)
557 fatal_error( "%s is a truncated file\n", input_buffer_filename );
558 return input_buffer[input_buffer_pos++];
561 unsigned short get_word(void)
565 if (input_buffer_pos + sizeof(ret) > input_buffer_size)
566 fatal_error( "%s is a truncated file\n", input_buffer_filename );
567 memcpy( &ret, input_buffer + input_buffer_pos, sizeof(ret) );
568 if (byte_swapped) ret = (ret << 8) | (ret >> 8);
569 input_buffer_pos += sizeof(ret);
573 unsigned int get_dword(void)
577 if (input_buffer_pos + sizeof(ret) > input_buffer_size)
578 fatal_error( "%s is a truncated file\n", input_buffer_filename );
579 memcpy( &ret, input_buffer + input_buffer_pos, sizeof(ret) );
581 ret = ((ret << 24) | ((ret << 8) & 0x00ff0000) | ((ret >> 8) & 0x0000ff00) | (ret >> 24));
582 input_buffer_pos += sizeof(ret);
586 void put_data( const void *data, size_t size )
588 check_output_buffer_space( size );
589 memcpy( output_buffer + output_buffer_pos, data, size );
590 output_buffer_pos += size;
593 void put_byte( unsigned char val )
595 check_output_buffer_space( 1 );
596 output_buffer[output_buffer_pos++] = val;
599 void put_word( unsigned short val )
601 if (byte_swapped) val = (val << 8) | (val >> 8);
602 put_data( &val, sizeof(val) );
605 void put_dword( unsigned int val )
608 val = ((val << 24) | ((val << 8) & 0x00ff0000) | ((val >> 8) & 0x0000ff00) | (val >> 24));
609 put_data( &val, sizeof(val) );
612 void put_qword( unsigned int val )
626 /* pointer-sized word */
627 void put_pword( unsigned int val )
629 if (get_ptr_size() == 8) put_qword( val );
630 else put_dword( val );
633 void align_output( unsigned int align )
635 size_t size = align - (output_buffer_pos % align);
637 if (size == align) return;
638 check_output_buffer_space( size );
639 memset( output_buffer + output_buffer_pos, 0, size );
640 output_buffer_pos += size;
643 /* output a standard header for generated files */
644 void output_standard_file_header(void)
647 output( "/* File generated automatically from %s; do not edit! */\n", spec_file_name );
649 output( "/* File generated automatically; do not edit! */\n" );
650 output( "/* This file can be copied, modified and distributed without restriction. */\n\n" );
653 /* dump a byte stream into the assembly code */
654 void dump_bytes( const void *buffer, unsigned int size )
657 const unsigned char *ptr = buffer;
660 output( "\t.byte " );
661 for (i = 0; i < size - 1; i++, ptr++)
663 if ((i % 16) == 15) output( "0x%02x\n\t.byte ", *ptr );
664 else output( "0x%02x,", *ptr );
666 output( "0x%02x\n", *ptr );
670 /*******************************************************************
673 * Open a file in the given srcdir and set the input_file_name global variable.
675 FILE *open_input_file( const char *srcdir, const char *name )
678 FILE *file = fopen( name, "r" );
682 fullname = strmake( "%s/%s", srcdir, name );
683 file = fopen( fullname, "r" );
685 else fullname = xstrdup( name );
687 if (!file) fatal_error( "Cannot open file '%s'\n", fullname );
688 input_file_name = fullname;
694 /*******************************************************************
697 * Close the current input file (must have been opened with open_input_file).
699 void close_input_file( FILE *file )
702 free( input_file_name );
703 input_file_name = NULL;
708 /*******************************************************************
709 * remove_stdcall_decoration
711 * Remove a possible @xx suffix from a function name.
712 * Return the numerical value of the suffix, or -1 if none.
714 int remove_stdcall_decoration( char *name )
716 char *p, *end = strrchr( name, '@' );
717 if (!end || !end[1] || end == name) return -1;
718 if (target_cpu != CPU_x86) return -1;
719 /* make sure all the rest is digits */
720 for (p = end + 1; *p; p++) if (!isdigit(*p)) return -1;
722 return atoi( end + 1 );
726 /*******************************************************************
729 * Run a file through the assembler.
731 void assemble_file( const char *src_file, const char *obj_file )
733 struct strarray *args = get_as_command();
734 strarray_add( args, "-o", obj_file, src_file, NULL );
736 strarray_free( args );
740 /*******************************************************************
743 * Create a new dll spec file descriptor
745 DLLSPEC *alloc_dll_spec(void)
749 spec = xmalloc( sizeof(*spec) );
750 spec->file_name = NULL;
751 spec->dll_name = NULL;
752 spec->init_func = NULL;
753 spec->main_module = NULL;
754 spec->type = SPEC_WIN32;
755 spec->base = MAX_ORDINALS;
757 spec->stack_size = 0;
759 spec->nb_entry_points = 0;
760 spec->alloc_entry_points = 0;
762 spec->nb_resources = 0;
763 spec->characteristics = IMAGE_FILE_EXECUTABLE_IMAGE;
764 if (get_ptr_size() > 4)
765 spec->characteristics |= IMAGE_FILE_LARGE_ADDRESS_AWARE;
767 spec->characteristics |= IMAGE_FILE_32BIT_MACHINE;
768 spec->dll_characteristics = IMAGE_DLLCHARACTERISTICS_NX_COMPAT;
770 spec->subsystem_major = 4;
771 spec->subsystem_minor = 0;
772 spec->entry_points = NULL;
774 spec->ordinals = NULL;
775 spec->resources = NULL;
780 /*******************************************************************
783 * Free dll spec file descriptor
785 void free_dll_spec( DLLSPEC *spec )
789 for (i = 0; i < spec->nb_entry_points; i++)
791 ORDDEF *odp = &spec->entry_points[i];
793 free( odp->export_name );
794 free( odp->link_name );
796 free( spec->file_name );
797 free( spec->dll_name );
798 free( spec->init_func );
799 free( spec->entry_points );
801 free( spec->ordinals );
802 free( spec->resources );
807 /*******************************************************************
810 * Map a string to a valid C identifier.
812 const char *make_c_identifier( const char *str )
814 static char buffer[256];
817 for (p = buffer; *str && p < buffer+sizeof(buffer)-1; p++, str++)
819 if (isalnum(*str)) *p = *str;
827 /*******************************************************************
830 * Generate an internal name for a stub entry point.
832 const char *get_stub_name( const ORDDEF *odp, const DLLSPEC *spec )
837 if (odp->name || odp->export_name)
840 buffer = strmake( "__wine_stub_%s", odp->name ? odp->name : odp->export_name );
841 /* make sure name is a legal C identifier */
842 for (p = buffer; *p; p++) if (!isalnum(*p) && *p != '_') break;
843 if (!*p) return buffer;
846 buffer = strmake( "__wine_stub_%s_%d", make_c_identifier(spec->file_name), odp->ordinal );
850 /* parse a cpu name and return the corresponding value */
851 enum target_cpu get_cpu_from_name( const char *name )
855 for (i = 0; i < sizeof(cpu_names)/sizeof(cpu_names[0]); i++)
856 if (!strcmp( cpu_names[i].name, name )) return cpu_names[i].cpu;
860 /*****************************************************************
861 * Function: get_alignment
864 * According to the info page for gas, the .align directive behaves
865 * differently on different systems. On some architectures, the
866 * argument of a .align directive is the number of bytes to pad to, so
867 * to align on an 8-byte boundary you'd say
869 * On other systems, the argument is "the number of low-order zero bits
870 * that the location counter must have after advancement." So to
871 * align on an 8-byte boundary you'd say
874 * The reason gas is written this way is that it's trying to mimick
875 * native assemblers for the various architectures it runs on. gas
876 * provides other directives that work consistently across
877 * architectures, but of course we want to work on all arches with or
878 * without gas. Hence this function.
882 * align -- the number of bytes to align to. Must be a power of 2.
884 unsigned int get_alignment(unsigned int align)
888 assert( !(align & (align - 1)) );
894 if (target_platform != PLATFORM_APPLE) return align;
900 while ((1u << n) != align) n++;
908 /* return the page size for the target CPU */
909 unsigned int get_page_size(void)
913 case CPU_x86: return 4096;
914 case CPU_x86_64: return 4096;
915 case CPU_POWERPC: return 4096;
916 case CPU_ARM: return 4096;
917 case CPU_ARM64: return 4096;
924 /* return the size of a pointer on the target CPU */
925 unsigned int get_ptr_size(void)
942 /* return the total size in bytes of the arguments on the stack */
943 unsigned int get_args_size( const ORDDEF *odp )
947 for (i = size = 0; i < odp->u.func.nb_args; i++)
949 switch (odp->u.func.args[i])
956 /* int128 is passed as pointer on x86_64 */
957 if (target_cpu != CPU_x86_64)
964 size += get_ptr_size();
971 /* return the assembly name for a C symbol */
972 const char *asm_name( const char *sym )
976 switch (target_platform)
979 case PLATFORM_WINDOWS:
980 if (sym[0] == '.' && sym[1] == 'L') return sym;
982 buffer = strmake( "_%s", sym );
989 /* return an assembly function declaration for a C function name */
990 const char *func_declaration( const char *func )
994 switch (target_platform)
998 case PLATFORM_WINDOWS:
1000 buffer = strmake( ".def _%s; .scl 2; .type 32; .endef", func );
1008 buffer = strmake( ".type %s,%%function", func );
1011 buffer = strmake( ".type %s,@function", func );
1019 /* output a size declaration for an assembly function */
1020 void output_function_size( const char *name )
1022 switch (target_platform)
1024 case PLATFORM_APPLE:
1025 case PLATFORM_WINDOWS:
1028 output( "\t.size %s, .-%s\n", name, name );
1033 /* output a .cfi directive */
1034 void output_cfi( const char *format, ... )
1038 if (!unwind_tables) return;
1039 va_start( valist, format );
1040 fputc( '\t', output_file );
1041 vfprintf( output_file, format, valist );
1042 fputc( '\n', output_file );
1046 /* output the GNU note for non-exec stack */
1047 void output_gnu_stack_note(void)
1049 switch (target_platform)
1051 case PLATFORM_WINDOWS:
1052 case PLATFORM_APPLE:
1059 output( "\t.section .note.GNU-stack,\"\",%%progbits\n" );
1062 output( "\t.section .note.GNU-stack,\"\",@progbits\n" );
1069 /* return a global symbol declaration for an assembly symbol */
1070 const char *asm_globl( const char *func )
1072 static char *buffer;
1075 switch (target_platform)
1077 case PLATFORM_APPLE:
1078 buffer = strmake( "\t.globl _%s\n\t.private_extern _%s\n_%s:", func, func, func );
1080 case PLATFORM_WINDOWS:
1081 buffer = strmake( "\t.globl _%s\n_%s:", func, func );
1084 buffer = strmake( "\t.globl %s\n\t.hidden %s\n%s:", func, func, func );
1090 const char *get_asm_ptr_keyword(void)
1092 switch(get_ptr_size())
1094 case 4: return ".long";
1095 case 8: return ".quad";
1101 const char *get_asm_string_keyword(void)
1103 switch (target_platform)
1105 case PLATFORM_APPLE:
1112 const char *get_asm_rodata_section(void)
1114 switch (target_platform)
1116 case PLATFORM_APPLE: return ".const";
1117 default: return ".section .rodata";
1121 const char *get_asm_string_section(void)
1123 switch (target_platform)
1125 case PLATFORM_APPLE: return ".cstring";
1126 default: return ".section .rodata";