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"
36 #define MAX_TMP_FILES 8
37 static const char *tmp_files[MAX_TMP_FILES];
38 static unsigned int nb_tmp_files;
51 { "x86_64", CPU_x86_64 },
52 { "sparc", CPU_SPARC },
53 { "alpha", CPU_ALPHA },
54 { "powerpc", CPU_POWERPC }
57 /* atexit handler to clean tmp files */
58 static void cleanup_tmp_files(void)
61 for (i = 0; i < MAX_TMP_FILES; i++) if (tmp_files[i]) unlink( tmp_files[i] );
65 void *xmalloc (size_t size)
69 res = malloc (size ? size : 1);
72 fprintf (stderr, "Virtual memory exhausted.\n");
78 void *xrealloc (void *ptr, size_t size)
80 void *res = realloc (ptr, size);
81 if (size && res == NULL)
83 fprintf (stderr, "Virtual memory exhausted.\n");
89 char *xstrdup( const char *str )
91 char *res = strdup( str );
94 fprintf (stderr, "Virtual memory exhausted.\n");
100 char *strupper(char *s)
103 for (p = s; *p; p++) *p = toupper(*p);
107 int strendswith(const char* str, const char* end)
111 return l >= m && strcmp(str + l - m, end) == 0;
114 void fatal_error( const char *msg, ... )
117 va_start( valist, msg );
120 fprintf( stderr, "%s:", input_file_name );
122 fprintf( stderr, "%d:", current_line );
123 fputc( ' ', stderr );
125 else fprintf( stderr, "winebuild: " );
126 vfprintf( stderr, msg, valist );
131 void fatal_perror( const char *msg, ... )
134 va_start( valist, msg );
137 fprintf( stderr, "%s:", input_file_name );
139 fprintf( stderr, "%d:", current_line );
140 fputc( ' ', stderr );
142 vfprintf( stderr, msg, valist );
148 void error( const char *msg, ... )
151 va_start( valist, msg );
154 fprintf( stderr, "%s:", input_file_name );
156 fprintf( stderr, "%d:", current_line );
157 fputc( ' ', stderr );
159 vfprintf( stderr, msg, valist );
164 void warning( const char *msg, ... )
168 if (!display_warnings) return;
169 va_start( valist, msg );
172 fprintf( stderr, "%s:", input_file_name );
174 fprintf( stderr, "%d:", current_line );
175 fputc( ' ', stderr );
177 fprintf( stderr, "warning: " );
178 vfprintf( stderr, msg, valist );
182 int output( const char *format, ... )
187 va_start( valist, format );
188 ret = vfprintf( output_file, format, valist );
190 if (ret < 0) fatal_perror( "Output error" );
194 /* find a build tool in the path, trying the various names */
195 char *find_tool( const char * const *names )
198 static unsigned int count, maxlen;
208 /* split the path in directories */
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) );
215 dirs[count++] = p = path;
218 while (*p && *p != ':') p++;
223 for (i = 0; i < count; i++) maxlen = max( maxlen, strlen(dirs[i])+2 );
228 len = strlen(*names) + 1;
229 file = xmalloc( maxlen + len );
231 for (i = 0; i < count; i++)
233 strcpy( file, dirs[i] );
234 p = file + strlen(file);
235 if (p == file) *p++ = '.';
236 if (p[-1] != '/') *p++ = '/';
239 if (!stat( file, &st ) && S_ISREG(st.st_mode) && (st.st_mode & 0111)) return file;
247 const char *get_as_command(void)
253 as_command = xmalloc( strlen(target_alias) + sizeof("-as") );
254 strcpy( as_command, target_alias );
255 strcat( as_command, "-as" );
259 static const char * const commands[] = { "gas", "as", NULL };
260 if (!(as_command = find_tool( commands ))) as_command = xstrdup("as");
263 if (force_pointer_size)
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 );
275 const char *get_ld_command(void)
281 ld_command = xmalloc( strlen(target_alias) + sizeof("-ld") );
282 strcpy( ld_command, target_alias );
283 strcat( ld_command, "-ld" );
287 static const char * const commands[] = { "ld", "gld", NULL };
288 if (!(ld_command = find_tool( commands ))) ld_command = xstrdup("ld");
291 if (force_pointer_size)
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 );
303 const char *get_nm_command(void)
309 nm_command = xmalloc( strlen(target_alias) + sizeof("-nm") );
310 strcpy( nm_command, target_alias );
311 strcat( nm_command, "-nm" );
315 static const char * const commands[] = { "nm", "gnm", NULL };
316 if (!(nm_command = find_tool( commands ))) nm_command = xstrdup("nm");
322 const char *get_windres_command(void)
324 static char *windres_command;
326 if (!windres_command)
330 windres_command = xmalloc( strlen(target_alias) + sizeof("-windres") );
331 strcpy( windres_command, target_alias );
332 strcat( windres_command, "-windres" );
336 static const char * const commands[] = { "windres", NULL };
337 if (!(windres_command = find_tool( commands ))) windres_command = xstrdup("windres");
340 return windres_command;
343 /* get a name for a temp file, automatically cleaned up on exit */
344 char *get_temp_file_name( const char *prefix, const char *suffix )
350 assert( nb_tmp_files < MAX_TMP_FILES );
351 if (!nb_tmp_files && !save_temps) atexit( cleanup_tmp_files );
353 if (!prefix || !prefix[0]) prefix = "winebuild";
354 if (!suffix) suffix = "";
355 if (!(ext = strchr( prefix, '.' ))) ext = prefix + strlen(prefix);
356 name = xmalloc( sizeof("/tmp/") + (ext - prefix) + sizeof(".XXXXXX") + strlen(suffix) );
357 strcpy( name, "/tmp/" );
358 memcpy( name + 5, prefix, ext - prefix );
359 strcpy( name + 5 + (ext - prefix), ".XXXXXX" );
360 strcat( name, suffix );
362 /* first try without the /tmp/ prefix */
363 if ((fd = mkstemps( name + 5, strlen(suffix) )) != -1)
365 else if ((fd = mkstemps( name, strlen(suffix) )) == -1)
366 fatal_error( "could not generate a temp file\n" );
369 tmp_files[nb_tmp_files++] = name;
373 /* output a standard header for generated files */
374 void output_standard_file_header(void)
377 output( "/* File generated automatically from %s; do not edit! */\n", spec_file_name );
379 output( "/* File generated automatically; do not edit! */\n" );
380 output( "/* This file can be copied, modified and distributed without restriction. */\n\n" );
383 /* dump a byte stream into the assembly code */
384 void dump_bytes( const void *buffer, unsigned int size )
387 const unsigned char *ptr = buffer;
390 output( "\t.byte " );
391 for (i = 0; i < size - 1; i++, ptr++)
393 if ((i % 16) == 15) output( "0x%02x\n\t.byte ", *ptr );
394 else output( "0x%02x,", *ptr );
396 output( "0x%02x\n", *ptr );
400 /*******************************************************************
403 * Open a file in the given srcdir and set the input_file_name global variable.
405 FILE *open_input_file( const char *srcdir, const char *name )
408 FILE *file = fopen( name, "r" );
412 fullname = xmalloc( strlen(srcdir) + strlen(name) + 2 );
413 strcpy( fullname, srcdir );
414 strcat( fullname, "/" );
415 strcat( fullname, name );
416 file = fopen( fullname, "r" );
418 else fullname = xstrdup( name );
420 if (!file) fatal_error( "Cannot open file '%s'\n", fullname );
421 input_file_name = fullname;
427 /*******************************************************************
430 * Close the current input file (must have been opened with open_input_file).
432 void close_input_file( FILE *file )
435 free( input_file_name );
436 input_file_name = NULL;
441 /*******************************************************************
442 * remove_stdcall_decoration
444 * Remove a possible @xx suffix from a function name.
445 * Return the numerical value of the suffix, or -1 if none.
447 int remove_stdcall_decoration( char *name )
449 char *p, *end = strrchr( name, '@' );
450 if (!end || !end[1] || end == name) return -1;
451 /* make sure all the rest is digits */
452 for (p = end + 1; *p; p++) if (!isdigit(*p)) return -1;
454 return atoi( end + 1 );
458 /*******************************************************************
461 * Run a file through the assembler.
463 void assemble_file( const char *src_file, const char *obj_file )
465 const char *prog = get_as_command();
469 cmd = xmalloc( strlen(prog) + strlen(obj_file) + strlen(src_file) + 6 );
470 sprintf( cmd, "%s -o %s %s", prog, obj_file, src_file );
471 if (verbose) fprintf( stderr, "%s\n", cmd );
473 if (err) fatal_error( "%s failed with status %d\n", prog, err );
478 /*******************************************************************
481 * Create a new dll spec file descriptor
483 DLLSPEC *alloc_dll_spec(void)
487 spec = xmalloc( sizeof(*spec) );
488 spec->file_name = NULL;
489 spec->dll_name = NULL;
490 spec->init_func = NULL;
491 spec->main_module = NULL;
492 spec->type = SPEC_WIN32;
493 spec->base = MAX_ORDINALS;
495 spec->stack_size = 0;
497 spec->nb_entry_points = 0;
498 spec->alloc_entry_points = 0;
500 spec->nb_resources = 0;
501 spec->characteristics = IMAGE_FILE_EXECUTABLE_IMAGE;
502 if (get_ptr_size() > 4)
503 spec->characteristics |= IMAGE_FILE_LARGE_ADDRESS_AWARE;
505 spec->characteristics |= IMAGE_FILE_32BIT_MACHINE;
506 spec->dll_characteristics = IMAGE_DLLCHARACTERISTICS_NX_COMPAT;
508 spec->subsystem_major = 4;
509 spec->subsystem_minor = 0;
510 spec->entry_points = NULL;
512 spec->ordinals = NULL;
513 spec->resources = NULL;
518 /*******************************************************************
521 * Free dll spec file descriptor
523 void free_dll_spec( DLLSPEC *spec )
527 for (i = 0; i < spec->nb_entry_points; i++)
529 ORDDEF *odp = &spec->entry_points[i];
531 free( odp->export_name );
532 free( odp->link_name );
534 free( spec->file_name );
535 free( spec->dll_name );
536 free( spec->init_func );
537 free( spec->entry_points );
539 free( spec->ordinals );
540 free( spec->resources );
545 /*******************************************************************
548 * Map a string to a valid C identifier.
550 const char *make_c_identifier( const char *str )
552 static char buffer[256];
555 for (p = buffer; *str && p < buffer+sizeof(buffer)-1; p++, str++)
557 if (isalnum(*str)) *p = *str;
565 /*******************************************************************
568 * Generate an internal name for a stub entry point.
570 const char *get_stub_name( const ORDDEF *odp, const DLLSPEC *spec )
572 static char buffer[256];
573 if (odp->name || odp->export_name)
576 sprintf( buffer, "__wine_stub_%s", odp->name ? odp->name : odp->export_name );
577 /* make sure name is a legal C identifier */
578 for (p = buffer; *p; p++) if (!isalnum(*p) && *p != '_') break;
579 if (!*p) return buffer;
581 sprintf( buffer, "__wine_stub_%s_%d", make_c_identifier(spec->file_name), odp->ordinal );
585 /* parse a cpu name and return the corresponding value */
586 enum target_cpu get_cpu_from_name( const char *name )
590 for (i = 0; i < sizeof(cpu_names)/sizeof(cpu_names[0]); i++)
591 if (!strcmp( cpu_names[i].name, name )) return cpu_names[i].cpu;
595 /*****************************************************************
596 * Function: get_alignment
599 * According to the info page for gas, the .align directive behaves
600 * differently on different systems. On some architectures, the
601 * argument of a .align directive is the number of bytes to pad to, so
602 * to align on an 8-byte boundary you'd say
604 * On other systems, the argument is "the number of low-order zero bits
605 * that the location counter must have after advancement." So to
606 * align on an 8-byte boundary you'd say
609 * The reason gas is written this way is that it's trying to mimick
610 * native assemblers for the various architectures it runs on. gas
611 * provides other directives that work consistently across
612 * architectures, but of course we want to work on all arches with or
613 * without gas. Hence this function.
617 * align -- the number of bytes to align to. Must be a power of 2.
619 unsigned int get_alignment(unsigned int align)
623 assert( !(align & (align - 1)) );
630 if (target_platform != PLATFORM_APPLE) return align;
635 while ((1u << n) != align) n++;
643 /* return the page size for the target CPU */
644 unsigned int get_page_size(void)
648 case CPU_x86: return 4096;
649 case CPU_x86_64: return 4096;
650 case CPU_POWERPC: return 4096;
651 case CPU_SPARC: return 8192;
652 case CPU_ALPHA: return 8192;
659 /* return the size of a pointer on the target CPU */
660 unsigned int get_ptr_size(void)
677 /* return the assembly name for a C symbol */
678 const char *asm_name( const char *sym )
680 static char buffer[256];
682 switch (target_platform)
685 case PLATFORM_WINDOWS:
686 if (sym[0] == '.' && sym[1] == 'L') return sym;
688 strcpy( buffer + 1, sym );
695 /* return an assembly function declaration for a C function name */
696 const char *func_declaration( const char *func )
698 static char buffer[256];
700 switch (target_platform)
704 case PLATFORM_WINDOWS:
705 sprintf( buffer, ".def _%s; .scl 2; .type 32; .endef", func );
708 sprintf( buffer, ".type %s,@function", func );
714 /* output a size declaration for an assembly function */
715 void output_function_size( const char *name )
717 switch (target_platform)
720 case PLATFORM_WINDOWS:
723 output( "\t.size %s, .-%s\n", name, name );
728 /* output the GNU note for non-exec stack */
729 void output_gnu_stack_note(void)
731 switch (target_platform)
733 case PLATFORM_WINDOWS:
737 output( "\t.section .note.GNU-stack,\"\",@progbits\n" );
742 /* return a global symbol declaration for an assembly symbol */
743 const char *asm_globl( const char *func )
745 static char buffer[256];
747 switch (target_platform)
750 sprintf( buffer, "\t.globl _%s\n\t.private_extern _%s\n_%s:", func, func, func );
752 case PLATFORM_WINDOWS:
753 sprintf( buffer, "\t.globl _%s\n_%s:", func, func );
756 sprintf( buffer, "\t.globl %s\n\t.hidden %s\n%s:", func, func, func );
761 const char *get_asm_ptr_keyword(void)
763 switch(get_ptr_size())
765 case 4: return ".long";
766 case 8: return ".quad";
772 const char *get_asm_string_keyword(void)
774 switch (target_platform)
783 const char *get_asm_short_keyword(void)
785 switch (target_platform)
787 default: return ".short";
791 const char *get_asm_rodata_section(void)
793 switch (target_platform)
795 case PLATFORM_APPLE: return ".const";
796 default: return ".section .rodata";
800 const char *get_asm_string_section(void)
802 switch (target_platform)
804 case PLATFORM_APPLE: return ".cstring";
805 default: return ".section .rodata";