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 #define MAX_TMP_FILES 8
43 static const char *tmp_files
[MAX_TMP_FILES
];
44 static unsigned int nb_tmp_files
;
57 { "x86_64", CPU_x86_64
},
58 { "sparc", CPU_SPARC
},
59 { "alpha", CPU_ALPHA
},
60 { "powerpc", CPU_POWERPC
}
63 /* atexit handler to clean tmp files */
64 static void cleanup_tmp_files(void)
67 for (i
= 0; i
< MAX_TMP_FILES
; i
++) if (tmp_files
[i
]) unlink( tmp_files
[i
] );
71 void *xmalloc (size_t size
)
75 res
= malloc (size
? size
: 1);
78 fprintf (stderr
, "Virtual memory exhausted.\n");
84 void *xrealloc (void *ptr
, size_t size
)
86 void *res
= realloc (ptr
, size
);
87 if (size
&& res
== NULL
)
89 fprintf (stderr
, "Virtual memory exhausted.\n");
95 char *xstrdup( const char *str
)
97 char *res
= strdup( str
);
100 fprintf (stderr
, "Virtual memory exhausted.\n");
106 char *strupper(char *s
)
109 for (p
= s
; *p
; p
++) *p
= toupper(*p
);
113 int strendswith(const char* str
, const char* end
)
117 return l
>= m
&& strcmp(str
+ l
- m
, end
) == 0;
120 void fatal_error( const char *msg
, ... )
123 va_start( valist
, msg
);
126 fprintf( stderr
, "%s:", input_file_name
);
128 fprintf( stderr
, "%d:", current_line
);
129 fputc( ' ', stderr
);
131 else fprintf( stderr
, "winebuild: " );
132 vfprintf( stderr
, msg
, valist
);
137 void fatal_perror( const char *msg
, ... )
140 va_start( valist
, msg
);
143 fprintf( stderr
, "%s:", input_file_name
);
145 fprintf( stderr
, "%d:", current_line
);
146 fputc( ' ', stderr
);
148 vfprintf( stderr
, msg
, valist
);
154 void error( const char *msg
, ... )
157 va_start( valist
, msg
);
160 fprintf( stderr
, "%s:", input_file_name
);
162 fprintf( stderr
, "%d:", current_line
);
163 fputc( ' ', stderr
);
165 vfprintf( stderr
, msg
, valist
);
170 void warning( const char *msg
, ... )
174 if (!display_warnings
) return;
175 va_start( valist
, msg
);
178 fprintf( stderr
, "%s:", input_file_name
);
180 fprintf( stderr
, "%d:", current_line
);
181 fputc( ' ', stderr
);
183 fprintf( stderr
, "warning: " );
184 vfprintf( stderr
, msg
, valist
);
188 int output( const char *format
, ... )
193 va_start( valist
, format
);
194 ret
= vfprintf( output_file
, format
, valist
);
196 if (ret
< 0) fatal_perror( "Output error" );
200 /* find a build tool in the path, trying the various names */
201 static char *find_tool( const char * const *names
)
204 static unsigned int count
, maxlen
;
214 /* split the path in directories */
216 if (!getenv( "PATH" )) return NULL
;
217 path
= xstrdup( getenv( "PATH" ));
218 for (p
= path
, count
= 2; *p
; p
++) if (*p
== ':') count
++;
219 dirs
= xmalloc( count
* sizeof(*dirs
) );
221 dirs
[count
++] = p
= path
;
224 while (*p
&& *p
!= ':') p
++;
229 for (i
= 0; i
< count
; i
++) maxlen
= max( maxlen
, strlen(dirs
[i
])+2 );
234 len
= strlen(*names
) + sizeof(EXEEXT
) + 1;
235 file
= xmalloc( maxlen
+ len
);
237 for (i
= 0; i
< count
; i
++)
239 strcpy( file
, dirs
[i
] );
240 p
= file
+ strlen(file
);
241 if (p
== file
) *p
++ = '.';
242 if (p
[-1] != '/') *p
++ = '/';
246 if (!stat( file
, &st
) && S_ISREG(st
.st_mode
) && (st
.st_mode
& 0111)) return file
;
254 const char *get_as_command(void)
260 as_command
= xmalloc( strlen(target_alias
) + sizeof("-as") );
261 strcpy( as_command
, target_alias
);
262 strcat( as_command
, "-as" );
266 static const char * const commands
[] = { "gas", "as", NULL
};
267 if (!(as_command
= find_tool( commands
))) as_command
= xstrdup("as");
270 if (force_pointer_size
)
272 const char *args
= (target_platform
== PLATFORM_APPLE
) ?
273 ((force_pointer_size
== 8) ? " -arch x86_64" : " -arch i386") :
274 ((force_pointer_size
== 8) ? " --64" : " --32");
275 as_command
= xrealloc( as_command
, strlen(as_command
) + strlen(args
) + 1 );
276 strcat( as_command
, args
);
282 const char *get_ld_command(void)
288 ld_command
= xmalloc( strlen(target_alias
) + sizeof("-ld") );
289 strcpy( ld_command
, target_alias
);
290 strcat( ld_command
, "-ld" );
294 static const char * const commands
[] = { "ld", "gld", NULL
};
295 if (!(ld_command
= find_tool( commands
))) ld_command
= xstrdup("ld");
298 if (force_pointer_size
)
302 switch (target_platform
)
305 args
= (force_pointer_size
== 8) ? " -arch x86_64" : " -arch i386";
307 case PLATFORM_FREEBSD
:
308 args
= (force_pointer_size
== 8) ? " -m elf_x86_64" : " -m elf_i386_fbsd";
311 args
= (force_pointer_size
== 8) ? " -m elf_x86_64" : " -m elf_i386";
314 ld_command
= xrealloc( ld_command
, strlen(ld_command
) + strlen(args
) + 1 );
315 strcat( ld_command
, args
);
321 const char *get_nm_command(void)
327 nm_command
= xmalloc( strlen(target_alias
) + sizeof("-nm") );
328 strcpy( nm_command
, target_alias
);
329 strcat( nm_command
, "-nm" );
333 static const char * const commands
[] = { "nm", "gnm", NULL
};
334 if (!(nm_command
= find_tool( commands
))) nm_command
= xstrdup("nm");
340 const char *get_windres_command(void)
342 static char *windres_command
;
344 if (!windres_command
)
348 windres_command
= xmalloc( strlen(target_alias
) + sizeof("-windres") );
349 strcpy( windres_command
, target_alias
);
350 strcat( windres_command
, "-windres" );
354 static const char * const commands
[] = { "windres", NULL
};
355 if (!(windres_command
= find_tool( commands
))) windres_command
= xstrdup("windres");
358 return windres_command
;
361 /* get a name for a temp file, automatically cleaned up on exit */
362 char *get_temp_file_name( const char *prefix
, const char *suffix
)
368 assert( nb_tmp_files
< MAX_TMP_FILES
);
369 if (!nb_tmp_files
&& !save_temps
) atexit( cleanup_tmp_files
);
371 if (!prefix
|| !prefix
[0]) prefix
= "winebuild";
372 if (!suffix
) suffix
= "";
373 if (!(ext
= strchr( prefix
, '.' ))) ext
= prefix
+ strlen(prefix
);
374 name
= xmalloc( sizeof("/tmp/") + (ext
- prefix
) + sizeof(".XXXXXX") + strlen(suffix
) );
375 strcpy( name
, "/tmp/" );
376 memcpy( name
+ 5, prefix
, ext
- prefix
);
377 strcpy( name
+ 5 + (ext
- prefix
), ".XXXXXX" );
378 strcat( name
, suffix
);
380 /* first try without the /tmp/ prefix */
381 if ((fd
= mkstemps( name
+ 5, strlen(suffix
) )) != -1)
383 else if ((fd
= mkstemps( name
, strlen(suffix
) )) == -1)
384 fatal_error( "could not generate a temp file\n" );
387 tmp_files
[nb_tmp_files
++] = name
;
391 /*******************************************************************
394 * Function for reading from/writing to a memory buffer.
397 int byte_swapped
= 0;
398 const char *input_buffer_filename
;
399 const unsigned char *input_buffer
;
400 size_t input_buffer_pos
;
401 size_t input_buffer_size
;
402 unsigned char *output_buffer
;
403 size_t output_buffer_pos
;
404 size_t output_buffer_size
;
406 static void check_output_buffer_space( size_t size
)
408 if (output_buffer_pos
+ size
>= output_buffer_size
)
410 output_buffer_size
= max( output_buffer_size
* 2, output_buffer_pos
+ size
);
411 output_buffer
= xrealloc( output_buffer
, output_buffer_size
);
415 void init_input_buffer( const char *file
)
420 if ((fd
= open( file
, O_RDONLY
| O_BINARY
)) == -1) fatal_perror( "Cannot open %s", file
);
421 if ((fstat( fd
, &st
) == -1)) fatal_perror( "Cannot stat %s", file
);
422 if (!st
.st_size
) fatal_error( "%s is an empty file\n", file
);
424 if ((input_buffer
= mmap( NULL
, st
.st_size
, PROT_READ
, MAP_PRIVATE
, fd
, 0 )) == (void*)-1)
427 unsigned char *buffer
= xmalloc( st
.st_size
);
428 if (read( fd
, buffer
, st
.st_size
) != st
.st_size
) fatal_error( "Cannot read %s\n", file
);
429 input_buffer
= buffer
;
432 input_buffer_filename
= xstrdup( file
);
433 input_buffer_size
= st
.st_size
;
434 input_buffer_pos
= 0;
438 void init_output_buffer(void)
440 output_buffer_size
= 1024;
441 output_buffer_pos
= 0;
442 output_buffer
= xmalloc( output_buffer_size
);
445 void flush_output_buffer(void)
447 if (fwrite( output_buffer
, 1, output_buffer_pos
, output_file
) != output_buffer_pos
)
448 fatal_error( "Error writing to %s\n", output_file_name
);
449 free( output_buffer
);
452 unsigned char get_byte(void)
454 if (input_buffer_pos
>= input_buffer_size
)
455 fatal_error( "%s is a truncated file\n", input_buffer_filename
);
456 return input_buffer
[input_buffer_pos
++];
459 unsigned short get_word(void)
463 if (input_buffer_pos
+ sizeof(ret
) > input_buffer_size
)
464 fatal_error( "%s is a truncated file\n", input_buffer_filename
);
465 memcpy( &ret
, input_buffer
+ input_buffer_pos
, sizeof(ret
) );
466 if (byte_swapped
) ret
= (ret
<< 8) | (ret
>> 8);
467 input_buffer_pos
+= sizeof(ret
);
471 unsigned int get_dword(void)
475 if (input_buffer_pos
+ sizeof(ret
) > input_buffer_size
)
476 fatal_error( "%s is a truncated file\n", input_buffer_filename
);
477 memcpy( &ret
, input_buffer
+ input_buffer_pos
, sizeof(ret
) );
479 ret
= ((ret
<< 24) | ((ret
<< 8) & 0x00ff0000) | ((ret
>> 8) & 0x0000ff00) | (ret
>> 24));
480 input_buffer_pos
+= sizeof(ret
);
484 void put_data( const void *data
, size_t size
)
486 check_output_buffer_space( size
);
487 memcpy( output_buffer
+ output_buffer_pos
, data
, size
);
488 output_buffer_pos
+= size
;
491 void put_byte( unsigned char val
)
493 check_output_buffer_space( 1 );
494 output_buffer
[output_buffer_pos
++] = val
;
497 void put_word( unsigned short val
)
499 if (byte_swapped
) val
= (val
<< 8) | (val
>> 8);
500 put_data( &val
, sizeof(val
) );
503 void put_dword( unsigned int val
)
506 val
= ((val
<< 24) | ((val
<< 8) & 0x00ff0000) | ((val
>> 8) & 0x0000ff00) | (val
>> 24));
507 put_data( &val
, sizeof(val
) );
510 void put_qword( unsigned int val
)
524 /* pointer-sized word */
525 void put_pword( unsigned int val
)
527 if (get_ptr_size() == 8) put_qword( val
);
528 else put_dword( val
);
531 void align_output( unsigned int align
)
533 size_t size
= align
- (output_buffer_pos
% align
);
535 if (size
== align
) return;
536 check_output_buffer_space( size
);
537 memset( output_buffer
+ output_buffer_pos
, 0, size
);
538 output_buffer_pos
+= size
;
541 /* output a standard header for generated files */
542 void output_standard_file_header(void)
545 output( "/* File generated automatically from %s; do not edit! */\n", spec_file_name
);
547 output( "/* File generated automatically; do not edit! */\n" );
548 output( "/* This file can be copied, modified and distributed without restriction. */\n\n" );
551 /* dump a byte stream into the assembly code */
552 void dump_bytes( const void *buffer
, unsigned int size
)
555 const unsigned char *ptr
= buffer
;
558 output( "\t.byte " );
559 for (i
= 0; i
< size
- 1; i
++, ptr
++)
561 if ((i
% 16) == 15) output( "0x%02x\n\t.byte ", *ptr
);
562 else output( "0x%02x,", *ptr
);
564 output( "0x%02x\n", *ptr
);
568 /*******************************************************************
571 * Open a file in the given srcdir and set the input_file_name global variable.
573 FILE *open_input_file( const char *srcdir
, const char *name
)
576 FILE *file
= fopen( name
, "r" );
580 fullname
= xmalloc( strlen(srcdir
) + strlen(name
) + 2 );
581 strcpy( fullname
, srcdir
);
582 strcat( fullname
, "/" );
583 strcat( fullname
, name
);
584 file
= fopen( fullname
, "r" );
586 else fullname
= xstrdup( name
);
588 if (!file
) fatal_error( "Cannot open file '%s'\n", fullname
);
589 input_file_name
= fullname
;
595 /*******************************************************************
598 * Close the current input file (must have been opened with open_input_file).
600 void close_input_file( FILE *file
)
603 free( input_file_name
);
604 input_file_name
= NULL
;
609 /*******************************************************************
610 * remove_stdcall_decoration
612 * Remove a possible @xx suffix from a function name.
613 * Return the numerical value of the suffix, or -1 if none.
615 int remove_stdcall_decoration( char *name
)
617 char *p
, *end
= strrchr( name
, '@' );
618 if (!end
|| !end
[1] || end
== name
) return -1;
619 /* make sure all the rest is digits */
620 for (p
= end
+ 1; *p
; p
++) if (!isdigit(*p
)) return -1;
622 return atoi( end
+ 1 );
626 /*******************************************************************
629 * Run a file through the assembler.
631 void assemble_file( const char *src_file
, const char *obj_file
)
633 const char *prog
= get_as_command();
637 cmd
= xmalloc( strlen(prog
) + strlen(obj_file
) + strlen(src_file
) + 6 );
638 sprintf( cmd
, "%s -o %s %s", prog
, obj_file
, src_file
);
639 if (verbose
) fprintf( stderr
, "%s\n", cmd
);
641 if (err
) fatal_error( "%s failed with status %d\n", prog
, err
);
646 /*******************************************************************
649 * Create a new dll spec file descriptor
651 DLLSPEC
*alloc_dll_spec(void)
655 spec
= xmalloc( sizeof(*spec
) );
656 spec
->file_name
= NULL
;
657 spec
->dll_name
= NULL
;
658 spec
->init_func
= NULL
;
659 spec
->main_module
= NULL
;
660 spec
->type
= SPEC_WIN32
;
661 spec
->base
= MAX_ORDINALS
;
663 spec
->stack_size
= 0;
665 spec
->nb_entry_points
= 0;
666 spec
->alloc_entry_points
= 0;
668 spec
->nb_resources
= 0;
669 spec
->characteristics
= IMAGE_FILE_EXECUTABLE_IMAGE
;
670 if (get_ptr_size() > 4)
671 spec
->characteristics
|= IMAGE_FILE_LARGE_ADDRESS_AWARE
;
673 spec
->characteristics
|= IMAGE_FILE_32BIT_MACHINE
;
674 spec
->dll_characteristics
= IMAGE_DLLCHARACTERISTICS_NX_COMPAT
;
676 spec
->subsystem_major
= 4;
677 spec
->subsystem_minor
= 0;
678 spec
->entry_points
= NULL
;
680 spec
->ordinals
= NULL
;
681 spec
->resources
= NULL
;
686 /*******************************************************************
689 * Free dll spec file descriptor
691 void free_dll_spec( DLLSPEC
*spec
)
695 for (i
= 0; i
< spec
->nb_entry_points
; i
++)
697 ORDDEF
*odp
= &spec
->entry_points
[i
];
699 free( odp
->export_name
);
700 free( odp
->link_name
);
702 free( spec
->file_name
);
703 free( spec
->dll_name
);
704 free( spec
->init_func
);
705 free( spec
->entry_points
);
707 free( spec
->ordinals
);
708 free( spec
->resources
);
713 /*******************************************************************
716 * Map a string to a valid C identifier.
718 const char *make_c_identifier( const char *str
)
720 static char buffer
[256];
723 for (p
= buffer
; *str
&& p
< buffer
+sizeof(buffer
)-1; p
++, str
++)
725 if (isalnum(*str
)) *p
= *str
;
733 /*******************************************************************
736 * Generate an internal name for a stub entry point.
738 const char *get_stub_name( const ORDDEF
*odp
, const DLLSPEC
*spec
)
740 static char buffer
[256];
741 if (odp
->name
|| odp
->export_name
)
744 sprintf( buffer
, "__wine_stub_%s", odp
->name
? odp
->name
: odp
->export_name
);
745 /* make sure name is a legal C identifier */
746 for (p
= buffer
; *p
; p
++) if (!isalnum(*p
) && *p
!= '_') break;
747 if (!*p
) return buffer
;
749 sprintf( buffer
, "__wine_stub_%s_%d", make_c_identifier(spec
->file_name
), odp
->ordinal
);
753 /* parse a cpu name and return the corresponding value */
754 enum target_cpu
get_cpu_from_name( const char *name
)
758 for (i
= 0; i
< sizeof(cpu_names
)/sizeof(cpu_names
[0]); i
++)
759 if (!strcmp( cpu_names
[i
].name
, name
)) return cpu_names
[i
].cpu
;
763 /*****************************************************************
764 * Function: get_alignment
767 * According to the info page for gas, the .align directive behaves
768 * differently on different systems. On some architectures, the
769 * argument of a .align directive is the number of bytes to pad to, so
770 * to align on an 8-byte boundary you'd say
772 * On other systems, the argument is "the number of low-order zero bits
773 * that the location counter must have after advancement." So to
774 * align on an 8-byte boundary you'd say
777 * The reason gas is written this way is that it's trying to mimick
778 * native assemblers for the various architectures it runs on. gas
779 * provides other directives that work consistently across
780 * architectures, but of course we want to work on all arches with or
781 * without gas. Hence this function.
785 * align -- the number of bytes to align to. Must be a power of 2.
787 unsigned int get_alignment(unsigned int align
)
791 assert( !(align
& (align
- 1)) );
798 if (target_platform
!= PLATFORM_APPLE
) return align
;
803 while ((1u << n
) != align
) n
++;
811 /* return the page size for the target CPU */
812 unsigned int get_page_size(void)
816 case CPU_x86
: return 4096;
817 case CPU_x86_64
: return 4096;
818 case CPU_POWERPC
: return 4096;
819 case CPU_SPARC
: return 8192;
820 case CPU_ALPHA
: return 8192;
827 /* return the size of a pointer on the target CPU */
828 unsigned int get_ptr_size(void)
845 /* return the assembly name for a C symbol */
846 const char *asm_name( const char *sym
)
848 static char buffer
[256];
850 switch (target_platform
)
853 case PLATFORM_WINDOWS
:
854 if (sym
[0] == '.' && sym
[1] == 'L') return sym
;
856 strcpy( buffer
+ 1, sym
);
863 /* return an assembly function declaration for a C function name */
864 const char *func_declaration( const char *func
)
866 static char buffer
[256];
868 switch (target_platform
)
872 case PLATFORM_WINDOWS
:
873 sprintf( buffer
, ".def _%s; .scl 2; .type 32; .endef", func
);
876 sprintf( buffer
, ".type %s,@function", func
);
882 /* output a size declaration for an assembly function */
883 void output_function_size( const char *name
)
885 switch (target_platform
)
888 case PLATFORM_WINDOWS
:
891 output( "\t.size %s, .-%s\n", name
, name
);
896 /* output the GNU note for non-exec stack */
897 void output_gnu_stack_note(void)
899 switch (target_platform
)
901 case PLATFORM_WINDOWS
:
905 output( "\t.section .note.GNU-stack,\"\",@progbits\n" );
910 /* return a global symbol declaration for an assembly symbol */
911 const char *asm_globl( const char *func
)
913 static char buffer
[256];
915 switch (target_platform
)
918 sprintf( buffer
, "\t.globl _%s\n\t.private_extern _%s\n_%s:", func
, func
, func
);
920 case PLATFORM_WINDOWS
:
921 sprintf( buffer
, "\t.globl _%s\n_%s:", func
, func
);
924 sprintf( buffer
, "\t.globl %s\n\t.hidden %s\n%s:", func
, func
, func
);
929 const char *get_asm_ptr_keyword(void)
931 switch(get_ptr_size())
933 case 4: return ".long";
934 case 8: return ".quad";
940 const char *get_asm_string_keyword(void)
942 switch (target_platform
)
951 const char *get_asm_short_keyword(void)
953 switch (target_platform
)
955 default: return ".short";
959 const char *get_asm_rodata_section(void)
961 switch (target_platform
)
963 case PLATFORM_APPLE
: return ".const";
964 default: return ".section .rodata";
968 const char *get_asm_string_section(void)
970 switch (target_platform
)
972 case PLATFORM_APPLE
: return ".cstring";
973 default: return ".section .rodata";