tools/winebuild/utils.c

   1 /*
   2  * Small utility functions for winebuild
   3  *
   4  * Copyright 2000 Alexandre Julliard
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  */
  20
  21 #include "config.h"
  22 #include "wine/port.h"
  23
  24 #include <assert.h>
  25 #include <ctype.h>
  26 #include <stdarg.h>
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #ifdef HAVE_UNISTD_H
  31 # include <unistd.h>
  32 #endif
  33
  34 #include "windef.h"
  35 #include "winnt.h"
  36 #include "build.h"
  37
  38 #define MAX_TMP_FILES 8
  39 static const char *tmp_files[MAX_TMP_FILES];
  40 static unsigned int nb_tmp_files;
  41
  42 /* atexit handler to clean tmp files */
  43 static void cleanup_tmp_files(void)
  44 {
  45     unsigned int i;
  46     for (i = 0; i < MAX_TMP_FILES; i++) if (tmp_files[i]) unlink( tmp_files[i] );
  47 }
  48
  49
  50 void *xmalloc (size_t size)
  51 {
  52     void *res;
  53
  54     res = malloc (size ? size : 1);
  55     if (res == NULL)
  56     {
  57         fprintf (stderr, "Virtual memory exhausted.\n");
  58         exit (1);
  59     }
  60     return res;
  61 }
  62
  63 void *xrealloc (void *ptr, size_t size)
  64 {
  65     void *res = realloc (ptr, size);
  66     if (size && res == NULL)
  67     {
  68         fprintf (stderr, "Virtual memory exhausted.\n");
  69         exit (1);
  70     }
  71     return res;
  72 }
  73
  74 char *xstrdup( const char *str )
  75 {
  76     char *res = strdup( str );
  77     if (!res)
  78     {
  79         fprintf (stderr, "Virtual memory exhausted.\n");
  80         exit (1);
  81     }
  82     return res;
  83 }
  84
  85 char *strupper(char *s)
  86 {
  87     char *p;
  88     for (p = s; *p; p++) *p = toupper(*p);
  89     return s;
  90 }
  91
  92 int strendswith(const char* str, const char* end)
  93 {
  94     int l = strlen(str);
  95     int m = strlen(end);
  96     return l >= m && strcmp(str + l - m, end) == 0;
  97 }
  98
  99 void fatal_error( const char *msg, ... )
 100 {
 101     va_list valist;
 102     va_start( valist, msg );
 103     if (input_file_name)
 104     {
 105         fprintf( stderr, "%s:", input_file_name );
 106         if (current_line)
 107             fprintf( stderr, "%d:", current_line );
 108         fputc( ' ', stderr );
 109     }
 110     else fprintf( stderr, "winebuild: " );
 111     vfprintf( stderr, msg, valist );
 112     va_end( valist );
 113     exit(1);
 114 }
 115
 116 void fatal_perror( const char *msg, ... )
 117 {
 118     va_list valist;
 119     va_start( valist, msg );
 120     if (input_file_name)
 121     {
 122         fprintf( stderr, "%s:", input_file_name );
 123         if (current_line)
 124             fprintf( stderr, "%d:", current_line );
 125         fputc( ' ', stderr );
 126     }
 127     vfprintf( stderr, msg, valist );
 128     perror( " " );
 129     va_end( valist );
 130     exit(1);
 131 }
 132
 133 void error( const char *msg, ... )
 134 {
 135     va_list valist;
 136     va_start( valist, msg );
 137     if (input_file_name)
 138     {
 139         fprintf( stderr, "%s:", input_file_name );
 140         if (current_line)
 141             fprintf( stderr, "%d:", current_line );
 142         fputc( ' ', stderr );
 143     }
 144     vfprintf( stderr, msg, valist );
 145     va_end( valist );
 146     nb_errors++;
 147 }
 148
 149 void warning( const char *msg, ... )
 150 {
 151     va_list valist;
 152
 153     if (!display_warnings) return;
 154     va_start( valist, msg );
 155     if (input_file_name)
 156     {
 157         fprintf( stderr, "%s:", input_file_name );
 158         if (current_line)
 159             fprintf( stderr, "%d:", current_line );
 160         fputc( ' ', stderr );
 161     }
 162     fprintf( stderr, "warning: " );
 163     vfprintf( stderr, msg, valist );
 164     va_end( valist );
 165 }
 166
 167 int output( const char *format, ... )
 168 {
 169     int ret;
 170     va_list valist;
 171
 172     va_start( valist, format );
 173     ret = vfprintf( output_file, format, valist );
 174     va_end( valist );
 175     if (ret < 0) fatal_perror( "Output error" );
 176     return ret;
 177 }
 178
 179 /* get a name for a temp file, automatically cleaned up on exit */
 180 char *get_temp_file_name( const char *prefix, const char *suffix )
 181 {
 182     char *name;
 183     const char *ext;
 184     int fd;
 185
 186     assert( nb_tmp_files < MAX_TMP_FILES );
 187     if (!nb_tmp_files && !save_temps) atexit( cleanup_tmp_files );
 188
 189     if (!prefix || !prefix[0]) prefix = "winebuild";
 190     if (!suffix) suffix = "";
 191     if (!(ext = strchr( prefix, '.' ))) ext = prefix + strlen(prefix);
 192     name = xmalloc( sizeof("/tmp/") + (ext - prefix) + sizeof(".XXXXXX") + strlen(suffix) );
 193     strcpy( name, "/tmp/" );
 194     memcpy( name + 5, prefix, ext - prefix );
 195     strcpy( name + 5 + (ext - prefix), ".XXXXXX" );
 196     strcat( name, suffix );
 197
 198     /* first try without the /tmp/ prefix */
 199     if ((fd = mkstemps( name + 5, strlen(suffix) )) != -1)
 200         name += 5;
 201     else if ((fd = mkstemps( name, strlen(suffix) )) == -1)
 202         fatal_error( "could not generate a temp file\n" );
 203
 204     close( fd );
 205     tmp_files[nb_tmp_files++] = name;
 206     return name;
 207 }
 208
 209 /* output a standard header for generated files */
 210 void output_standard_file_header(void)
 211 {
 212     if (spec_file_name)
 213         output( "/* File generated automatically from %s; do not edit! */\n", spec_file_name );
 214     else
 215         output( "/* File generated automatically; do not edit! */\n" );
 216     output( "/* This file can be copied, modified and distributed without restriction. */\n\n" );
 217 }
 218
 219 /* dump a byte stream into the assembly code */
 220 void dump_bytes( const void *buffer, unsigned int size )
 221 {
 222     unsigned int i;
 223     const unsigned char *ptr = buffer;
 224
 225     if (!size) return;
 226     output( "\t.byte " );
 227     for (i = 0; i < size - 1; i++, ptr++)
 228     {
 229         if ((i % 16) == 15) output( "0x%02x\n\t.byte ", *ptr );
 230         else output( "0x%02x,", *ptr );
 231     }
 232     output( "0x%02x\n", *ptr );
 233 }
 234
 235
 236 /*******************************************************************
 237  *         open_input_file
 238  *
 239  * Open a file in the given srcdir and set the input_file_name global variable.
 240  */
 241 FILE *open_input_file( const char *srcdir, const char *name )
 242 {
 243     char *fullname;
 244     FILE *file = fopen( name, "r" );
 245
 246     if (!file && srcdir)
 247     {
 248         fullname = xmalloc( strlen(srcdir) + strlen(name) + 2 );
 249         strcpy( fullname, srcdir );
 250         strcat( fullname, "/" );
 251         strcat( fullname, name );
 252         file = fopen( fullname, "r" );
 253     }
 254     else fullname = xstrdup( name );
 255
 256     if (!file) fatal_error( "Cannot open file '%s'\n", fullname );
 257     input_file_name = fullname;
 258     current_line = 1;
 259     return file;
 260 }
 261
 262
 263 /*******************************************************************
 264  *         close_input_file
 265  *
 266  * Close the current input file (must have been opened with open_input_file).
 267  */
 268 void close_input_file( FILE *file )
 269 {
 270     fclose( file );
 271     free( input_file_name );
 272     input_file_name = NULL;
 273     current_line = 0;
 274 }
 275
 276
 277 /*******************************************************************
 278  *         remove_stdcall_decoration
 279  *
 280  * Remove a possible @xx suffix from a function name.
 281  * Return the numerical value of the suffix, or -1 if none.
 282  */
 283 int remove_stdcall_decoration( char *name )
 284 {
 285     char *p, *end = strrchr( name, '@' );
 286     if (!end || !end[1] || end == name) return -1;
 287     /* make sure all the rest is digits */
 288     for (p = end + 1; *p; p++) if (!isdigit(*p)) return -1;
 289     *end = 0;
 290     return atoi( end + 1 );
 291 }
 292
 293
 294 /*******************************************************************
 295  *         assemble_file
 296  *
 297  * Run a file through the assembler.
 298  */
 299 void assemble_file( const char *src_file, const char *obj_file )
 300 {
 301     char *cmd;
 302     int err;
 303
 304     if (!as_command) as_command = xstrdup("as");
 305     cmd = xmalloc( strlen(as_command) + strlen(obj_file) + strlen(src_file) + 6 );
 306     sprintf( cmd, "%s -o %s %s", as_command, obj_file, src_file );
 307     if (verbose) fprintf( stderr, "%s\n", cmd );
 308     err = system( cmd );
 309     if (err) fatal_error( "%s failed with status %d\n", as_command, err );
 310     free( cmd );
 311 }
 312
 313
 314 /*******************************************************************
 315  *         alloc_dll_spec
 316  *
 317  * Create a new dll spec file descriptor
 318  */
 319 DLLSPEC *alloc_dll_spec(void)
 320 {
 321     DLLSPEC *spec;
 322
 323     spec = xmalloc( sizeof(*spec) );
 324     spec->file_name          = NULL;
 325     spec->dll_name           = NULL;
 326     spec->init_func          = NULL;
 327     spec->type               = SPEC_WIN32;
 328     spec->base               = MAX_ORDINALS;
 329     spec->limit              = 0;
 330     spec->stack_size         = 0;
 331     spec->heap_size          = 0;
 332     spec->nb_entry_points    = 0;
 333     spec->alloc_entry_points = 0;
 334     spec->nb_names           = 0;
 335     spec->nb_resources       = 0;
 336     spec->characteristics    = IMAGE_FILE_EXECUTABLE_IMAGE;
 337     if (get_ptr_size() > 4)
 338         spec->characteristics |= IMAGE_FILE_LARGE_ADDRESS_AWARE;
 339     spec->dll_characteristics = IMAGE_DLLCHARACTERISTICS_NX_COMPAT;
 340     spec->subsystem          = 0;
 341     spec->subsystem_major    = 4;
 342     spec->subsystem_minor    = 0;
 343     spec->entry_points       = NULL;
 344     spec->names              = NULL;
 345     spec->ordinals           = NULL;
 346     spec->resources          = NULL;
 347     return spec;
 348 }
 349
 350
 351 /*******************************************************************
 352  *         free_dll_spec
 353  *
 354  * Free dll spec file descriptor
 355  */
 356 void free_dll_spec( DLLSPEC *spec )
 357 {
 358     int i;
 359
 360     for (i = 0; i < spec->nb_entry_points; i++)
 361     {
 362         ORDDEF *odp = &spec->entry_points[i];
 363         free( odp->name );
 364         free( odp->export_name );
 365         free( odp->link_name );
 366     }
 367     free( spec->file_name );
 368     free( spec->dll_name );
 369     free( spec->init_func );
 370     free( spec->entry_points );
 371     free( spec->names );
 372     free( spec->ordinals );
 373     free( spec->resources );
 374     free( spec );
 375 }
 376
 377
 378 /*******************************************************************
 379  *         make_c_identifier
 380  *
 381  * Map a string to a valid C identifier.
 382  */
 383 const char *make_c_identifier( const char *str )
 384 {
 385     static char buffer[256];
 386     char *p;
 387
 388     for (p = buffer; *str && p < buffer+sizeof(buffer)-1; p++, str++)
 389     {
 390         if (isalnum(*str)) *p = *str;
 391         else *p = '_';
 392     }
 393     *p = 0;
 394     return buffer;
 395 }
 396
 397
 398 /*******************************************************************
 399  *         get_stub_name
 400  *
 401  * Generate an internal name for a stub entry point.
 402  */
 403 const char *get_stub_name( const ORDDEF *odp, const DLLSPEC *spec )
 404 {
 405     static char buffer[256];
 406     if (odp->name || odp->export_name)
 407     {
 408         char *p;
 409         sprintf( buffer, "__wine_stub_%s", odp->name ? odp->name : odp->export_name );
 410         /* make sure name is a legal C identifier */
 411         for (p = buffer; *p; p++) if (!isalnum(*p) && *p != '_') break;
 412         if (!*p) return buffer;
 413     }
 414     sprintf( buffer, "__wine_stub_%s_%d", make_c_identifier(spec->file_name), odp->ordinal );
 415     return buffer;
 416 }
 417
 418
 419 /*****************************************************************
 420  *  Function:    get_alignment
 421  *
 422  *  Description:
 423  *    According to the info page for gas, the .align directive behaves
 424  * differently on different systems.  On some architectures, the
 425  * argument of a .align directive is the number of bytes to pad to, so
 426  * to align on an 8-byte boundary you'd say
 427  *     .align 8
 428  * On other systems, the argument is "the number of low-order zero bits
 429  * that the location counter must have after advancement."  So to
 430  * align on an 8-byte boundary you'd say
 431  *     .align 3
 432  *
 433  * The reason gas is written this way is that it's trying to mimick
 434  * native assemblers for the various architectures it runs on.  gas
 435  * provides other directives that work consistently across
 436  * architectures, but of course we want to work on all arches with or
 437  * without gas.  Hence this function.
 438  *
 439  *
 440  *  Parameters:
 441  *    align  --  the number of bytes to align to. Must be a power of 2.
 442  */
 443 unsigned int get_alignment(unsigned int align)
 444 {
 445     unsigned int n;
 446
 447     assert( !(align & (align - 1)) );
 448
 449     switch(target_cpu)
 450     {
 451     case CPU_x86:
 452     case CPU_x86_64:
 453     case CPU_SPARC:
 454         if (target_platform != PLATFORM_APPLE) return align;
 455         /* fall through */
 456     case CPU_POWERPC:
 457     case CPU_ALPHA:
 458         n = 0;
 459         while ((1u << n) != align) n++;
 460         return n;
 461     }
 462     /* unreached */
 463     assert(0);
 464     return 0;
 465 }
 466
 467 /* return the page size for the target CPU */
 468 unsigned int get_page_size(void)
 469 {
 470     switch(target_cpu)
 471     {
 472     case CPU_x86:     return 4096;
 473     case CPU_x86_64:  return 4096;
 474     case CPU_POWERPC: return 4096;
 475     case CPU_SPARC:   return 8192;
 476     case CPU_ALPHA:   return 8192;
 477     }
 478     /* unreached */
 479     assert(0);
 480     return 0;
 481 }
 482
 483 /* return the size of a pointer on the target CPU */
 484 unsigned int get_ptr_size(void)
 485 {
 486     switch(target_cpu)
 487     {
 488     case CPU_x86:
 489     case CPU_POWERPC:
 490     case CPU_SPARC:
 491     case CPU_ALPHA:
 492         return 4;
 493     case CPU_x86_64:
 494         return 8;
 495     }
 496     /* unreached */
 497     assert(0);
 498     return 0;
 499 }
 500
 501 /* return the assembly name for a C symbol */
 502 const char *asm_name( const char *sym )
 503 {
 504     static char buffer[256];
 505
 506     switch (target_platform)
 507     {
 508     case PLATFORM_APPLE:
 509     case PLATFORM_WINDOWS:
 510         buffer[0] = '_';
 511         strcpy( buffer + 1, sym );
 512         return buffer;
 513     default:
 514         return sym;
 515     }
 516 }
 517
 518 /* return an assembly function declaration for a C function name */
 519 const char *func_declaration( const char *func )
 520 {
 521     static char buffer[256];
 522
 523     switch (target_platform)
 524     {
 525     case PLATFORM_APPLE:
 526         return "";
 527     case PLATFORM_WINDOWS:
 528         sprintf( buffer, ".def _%s; .scl 2; .type 32; .endef", func );
 529         break;
 530     default:
 531         sprintf( buffer, ".type %s,@function", func );
 532         break;
 533     }
 534     return buffer;
 535 }
 536
 537 /* output a size declaration for an assembly function */
 538 void output_function_size( const char *name )
 539 {
 540     switch (target_platform)
 541     {
 542     case PLATFORM_APPLE:
 543     case PLATFORM_WINDOWS:
 544         break;
 545     default:
 546         output( "\t.size %s, .-%s\n", name, name );
 547         break;
 548     }
 549 }
 550
 551 /* output the GNU note for non-exec stack */
 552 void output_gnu_stack_note(void)
 553 {
 554     switch (target_platform)
 555     {
 556     case PLATFORM_WINDOWS:
 557     case PLATFORM_APPLE:
 558         break;
 559     default:
 560         output( "\t.section .note.GNU-stack,\"\",@progbits\n" );
 561         break;
 562     }
 563 }
 564
 565 /* return a global symbol declaration for an assembly symbol */
 566 const char *asm_globl( const char *func )
 567 {
 568     static char buffer[256];
 569
 570     switch (target_platform)
 571     {
 572     case PLATFORM_APPLE:
 573         sprintf( buffer, "\t.globl _%s\n\t.private_extern _%s\n_%s:", func, func, func );
 574         return buffer;
 575     case PLATFORM_WINDOWS:
 576         sprintf( buffer, "\t.globl _%s\n_%s:", func, func );
 577         return buffer;
 578     default:
 579         sprintf( buffer, "\t.globl %s\n\t.hidden %s\n%s:", func, func, func );
 580         return buffer;
 581     }
 582 }
 583
 584 const char *get_asm_ptr_keyword(void)
 585 {
 586     switch(get_ptr_size())
 587     {
 588     case 4: return ".long";
 589     case 8: return ".quad";
 590     }
 591     assert(0);
 592     return NULL;
 593 }
 594
 595 const char *get_asm_string_keyword(void)
 596 {
 597     switch (target_platform)
 598     {
 599     case PLATFORM_APPLE:
 600         return ".asciz";
 601     default:
 602         return ".string";
 603     }
 604 }
 605
 606 const char *get_asm_short_keyword(void)
 607 {
 608     switch (target_platform)
 609     {
 610     default:            return ".short";
 611     }
 612 }
 613
 614 const char *get_asm_rodata_section(void)
 615 {
 616     switch (target_platform)
 617     {
 618     case PLATFORM_APPLE: return ".const";
 619     default:             return ".section .rodata";
 620     }
 621 }
 622
 623 const char *get_asm_string_section(void)
 624 {
 625     switch (target_platform)
 626     {
 627     case PLATFORM_APPLE: return ".cstring";
 628     default:             return ".section .rodata";
 629     }
 630 }