kernel32/tests: Add basic tests for partially received pipe messages (ERROR_MORE_DATA).
[wine/wine-gecko.git] / tools / winebuild / utils.c
blob566911fd18a617baad50f32b4205f4720cc21162
1 /*
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
21 #include "config.h"
22 #include "wine/port.h"
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 #ifdef HAVE_SYS_STAT_H
34 # include <sys/stat.h>
35 #endif
36 #ifdef HAVE_SYS_MMAN_H
37 #include <sys/mman.h>
38 #endif
40 #include "build.h"
42 #if defined(_WIN32) && !defined(__CYGWIN__)
43 # define PATH_SEPARATOR ';'
44 #else
45 # define PATH_SEPARATOR ':'
46 #endif
48 static const char **tmp_files;
49 static unsigned int nb_tmp_files;
50 static unsigned int max_tmp_files;
52 static const struct
54 const char *name;
55 enum target_cpu cpu;
56 } cpu_names[] =
58 { "i386", CPU_x86 },
59 { "i486", CPU_x86 },
60 { "i586", CPU_x86 },
61 { "i686", CPU_x86 },
62 { "i786", CPU_x86 },
63 { "amd64", CPU_x86_64 },
64 { "x86_64", CPU_x86_64 },
65 { "powerpc", CPU_POWERPC },
66 { "arm", CPU_ARM },
67 { "arm64", CPU_ARM64 },
68 { "aarch64", CPU_ARM64 },
71 /* atexit handler to clean tmp files */
72 void cleanup_tmp_files(void)
74 unsigned int i;
75 for (i = 0; i < nb_tmp_files; i++) if (tmp_files[i]) unlink( tmp_files[i] );
79 void *xmalloc (size_t size)
81 void *res;
83 res = malloc (size ? size : 1);
84 if (res == NULL)
86 fprintf (stderr, "Virtual memory exhausted.\n");
87 exit (1);
89 return res;
92 void *xrealloc (void *ptr, size_t size)
94 void *res = realloc (ptr, size);
95 if (size && res == NULL)
97 fprintf (stderr, "Virtual memory exhausted.\n");
98 exit (1);
100 return res;
103 char *xstrdup( const char *str )
105 char *res = strdup( str );
106 if (!res)
108 fprintf (stderr, "Virtual memory exhausted.\n");
109 exit (1);
111 return res;
114 char *strupper(char *s)
116 char *p;
117 for (p = s; *p; p++) *p = toupper(*p);
118 return s;
121 int strendswith(const char* str, const char* end)
123 int l = strlen(str);
124 int m = strlen(end);
125 return l >= m && strcmp(str + l - m, end) == 0;
128 char *strmake( const char* fmt, ... )
130 int n;
131 size_t size = 100;
132 va_list ap;
134 for (;;)
136 char *p = xmalloc( size );
137 va_start( ap, fmt );
138 n = vsnprintf( p, size, fmt, ap );
139 va_end( ap );
140 if (n == -1) size *= 2;
141 else if ((size_t)n >= size) size = n + 1;
142 else return p;
143 free( p );
147 static struct strarray *strarray_init( const char *str )
149 struct strarray *array = xmalloc( sizeof(*array) );
150 array->count = 0;
151 array->max = 16;
152 array->str = xmalloc( array->max * sizeof(*array->str) );
153 if (str) array->str[array->count++] = str;
154 return array;
157 static struct strarray *strarray_copy( const struct strarray *src )
159 struct strarray *array = xmalloc( sizeof(*array) );
160 array->count = src->count;
161 array->max = src->max;
162 array->str = xmalloc( array->max * sizeof(*array->str) );
163 memcpy( array->str, src->str, array->count * sizeof(*array->str) );
164 return array;
167 static void strarray_add_one( struct strarray *array, const char *str )
169 if (array->count == array->max)
171 array->max *= 2;
172 array->str = xrealloc( array->str, array->max * sizeof(*array->str) );
174 array->str[array->count++] = str;
177 void strarray_add( struct strarray *array, ... )
179 va_list valist;
180 const char *str;
182 va_start( valist, array );
183 while ((str = va_arg( valist, const char *))) strarray_add_one( array, str );
184 va_end( valist );
187 void strarray_addv( struct strarray *array, char * const *argv )
189 while (*argv) strarray_add_one( array, *argv++ );
192 struct strarray *strarray_fromstring( const char *str, const char *delim )
194 const char *tok;
195 struct strarray *array = strarray_init( NULL );
196 char *buf = strdup( str );
198 for (tok = strtok( buf, delim ); tok; tok = strtok( NULL, delim ))
199 strarray_add_one( array, strdup( tok ));
201 free( buf );
202 return array;
205 void strarray_free( struct strarray *array )
207 free( array->str );
208 free( array );
211 void fatal_error( const char *msg, ... )
213 va_list valist;
214 va_start( valist, msg );
215 if (input_file_name)
217 fprintf( stderr, "%s:", input_file_name );
218 if (current_line)
219 fprintf( stderr, "%d:", current_line );
220 fputc( ' ', stderr );
222 else fprintf( stderr, "winebuild: " );
223 vfprintf( stderr, msg, valist );
224 va_end( valist );
225 exit(1);
228 void fatal_perror( const char *msg, ... )
230 va_list valist;
231 va_start( valist, msg );
232 if (input_file_name)
234 fprintf( stderr, "%s:", input_file_name );
235 if (current_line)
236 fprintf( stderr, "%d:", current_line );
237 fputc( ' ', stderr );
239 vfprintf( stderr, msg, valist );
240 perror( " " );
241 va_end( valist );
242 exit(1);
245 void error( const char *msg, ... )
247 va_list valist;
248 va_start( valist, msg );
249 if (input_file_name)
251 fprintf( stderr, "%s:", input_file_name );
252 if (current_line)
253 fprintf( stderr, "%d:", current_line );
254 fputc( ' ', stderr );
256 vfprintf( stderr, msg, valist );
257 va_end( valist );
258 nb_errors++;
261 void warning( const char *msg, ... )
263 va_list valist;
265 if (!display_warnings) return;
266 va_start( valist, msg );
267 if (input_file_name)
269 fprintf( stderr, "%s:", input_file_name );
270 if (current_line)
271 fprintf( stderr, "%d:", current_line );
272 fputc( ' ', stderr );
274 fprintf( stderr, "warning: " );
275 vfprintf( stderr, msg, valist );
276 va_end( valist );
279 int output( const char *format, ... )
281 int ret;
282 va_list valist;
284 va_start( valist, format );
285 ret = vfprintf( output_file, format, valist );
286 va_end( valist );
287 if (ret < 0) fatal_perror( "Output error" );
288 return ret;
291 void spawn( struct strarray *args )
293 unsigned int i;
294 int status;
296 strarray_add_one( args, NULL );
297 if (verbose)
298 for (i = 0; args->str[i]; i++)
299 fprintf( stderr, "%s%c", args->str[i], args->str[i+1] ? ' ' : '\n' );
301 if ((status = _spawnvp( _P_WAIT, args->str[0], args->str )))
303 if (status > 0) fatal_error( "%s failed with status %u\n", args->str[0], status );
304 else fatal_perror( "winebuild" );
305 exit( 1 );
309 /* find a build tool in the path, trying the various names */
310 struct strarray *find_tool( const char *name, const char * const *names )
312 static char **dirs;
313 static unsigned int count, maxlen;
315 char *p, *file;
316 const char *alt_names[2];
317 unsigned int i, len;
318 struct stat st;
320 if (!dirs)
322 char *path;
324 /* split the path in directories */
326 if (!getenv( "PATH" )) fatal_error( "PATH not set, cannot find required tools\n" );
327 path = xstrdup( getenv( "PATH" ));
328 for (p = path, count = 2; *p; p++) if (*p == PATH_SEPARATOR) count++;
329 dirs = xmalloc( count * sizeof(*dirs) );
330 count = 0;
331 dirs[count++] = p = path;
332 while (*p)
334 while (*p && *p != PATH_SEPARATOR) p++;
335 if (!*p) break;
336 *p++ = 0;
337 dirs[count++] = p;
339 for (i = 0; i < count; i++) maxlen = max( maxlen, strlen(dirs[i])+2 );
342 if (!names)
344 alt_names[0] = name;
345 alt_names[1] = NULL;
346 names = alt_names;
349 while (*names)
351 len = strlen(*names) + sizeof(EXEEXT) + 1;
352 if (target_alias)
353 len += strlen(target_alias) + 1;
354 file = xmalloc( maxlen + len );
356 for (i = 0; i < count; i++)
358 strcpy( file, dirs[i] );
359 p = file + strlen(file);
360 if (p == file) *p++ = '.';
361 if (p[-1] != '/') *p++ = '/';
362 if (target_alias)
364 strcpy( p, target_alias );
365 p += strlen(p);
366 *p++ = '-';
368 strcpy( p, *names );
369 strcat( p, EXEEXT );
371 if (!stat( file, &st ) && S_ISREG(st.st_mode) && (st.st_mode & 0111))
372 return strarray_init( file );
374 free( file );
375 names++;
377 fatal_error( "cannot find the '%s' tool\n", name );
380 struct strarray *get_as_command(void)
382 struct strarray *args;
384 if (cc_command)
386 args = strarray_copy( cc_command );
387 strarray_add( args, "-xassembler", "-c", NULL );
388 if (force_pointer_size)
389 strarray_add_one( args, (force_pointer_size == 8) ? "-m64" : "-m32" );
390 if (cpu_option) strarray_add_one( args, strmake("-mcpu=%s", cpu_option) );
391 return args;
394 if (!as_command)
396 static const char * const commands[] = { "gas", "as", NULL };
397 as_command = find_tool( "as", commands );
400 args = strarray_copy( as_command );
402 if (force_pointer_size)
404 switch (target_platform)
406 case PLATFORM_APPLE:
407 strarray_add( args, "-arch", (force_pointer_size == 8) ? "x86_64" : "i386", NULL );
408 break;
409 default:
410 switch(target_cpu)
412 case CPU_POWERPC:
413 strarray_add_one( args, (force_pointer_size == 8) ? "-a64" : "-a32" );
414 break;
415 default:
416 strarray_add_one( args, (force_pointer_size == 8) ? "--64" : "--32" );
417 break;
419 break;
423 if (cpu_option) strarray_add_one( args, strmake("-mcpu=%s", cpu_option) );
424 return args;
427 struct strarray *get_ld_command(void)
429 struct strarray *args;
431 if (!ld_command)
433 static const char * const commands[] = { "ld", "gld", NULL };
434 ld_command = find_tool( "ld", commands );
437 args = strarray_copy( ld_command );
439 if (force_pointer_size)
441 switch (target_platform)
443 case PLATFORM_APPLE:
444 strarray_add( args, "-arch", (force_pointer_size == 8) ? "x86_64" : "i386", NULL );
445 break;
446 case PLATFORM_FREEBSD:
447 strarray_add( args, "-m", (force_pointer_size == 8) ? "elf_x86_64_fbsd" : "elf_i386_fbsd", NULL );
448 break;
449 default:
450 switch(target_cpu)
452 case CPU_POWERPC:
453 strarray_add( args, "-m", (force_pointer_size == 8) ? "elf64ppc" : "elf32ppc", NULL );
454 break;
455 default:
456 strarray_add( args, "-m", (force_pointer_size == 8) ? "elf_x86_64" : "elf_i386", NULL );
457 break;
459 break;
462 return args;
465 const char *get_nm_command(void)
467 if (!nm_command)
469 static const char * const commands[] = { "nm", "gnm", NULL };
470 nm_command = find_tool( "nm", commands );
472 if (nm_command->count > 1)
473 fatal_error( "multiple arguments in nm command not supported yet\n" );
474 return nm_command->str[0];
477 /* get a name for a temp file, automatically cleaned up on exit */
478 char *get_temp_file_name( const char *prefix, const char *suffix )
480 char *name;
481 const char *ext, *basename;
482 int fd;
484 if (!prefix || !prefix[0]) prefix = "winebuild";
485 if (!suffix) suffix = "";
486 if ((basename = strrchr( prefix, '/' ))) basename++;
487 else basename = prefix;
488 if (!(ext = strchr( basename, '.' ))) ext = prefix + strlen(prefix);
489 name = xmalloc( sizeof("/tmp/") + (ext - prefix) + sizeof(".XXXXXX") + strlen(suffix) );
490 memcpy( name, prefix, ext - prefix );
491 strcpy( name + (ext - prefix), ".XXXXXX" );
492 strcat( name, suffix );
494 if ((fd = mkstemps( name, strlen(suffix) )) == -1)
496 strcpy( name, "/tmp/" );
497 memcpy( name + 5, basename, ext - basename );
498 strcpy( name + 5 + (ext - basename), ".XXXXXX" );
499 strcat( name, suffix );
500 if ((fd = mkstemps( name, strlen(suffix) )) == -1)
501 fatal_error( "could not generate a temp file\n" );
504 close( fd );
505 if (nb_tmp_files >= max_tmp_files)
507 max_tmp_files = max( 2 * max_tmp_files, 8 );
508 tmp_files = xrealloc( tmp_files, max_tmp_files * sizeof(tmp_files[0]) );
510 tmp_files[nb_tmp_files++] = name;
511 return name;
514 /*******************************************************************
515 * buffer management
517 * Function for reading from/writing to a memory buffer.
520 int byte_swapped = 0;
521 const char *input_buffer_filename;
522 const unsigned char *input_buffer;
523 size_t input_buffer_pos;
524 size_t input_buffer_size;
525 unsigned char *output_buffer;
526 size_t output_buffer_pos;
527 size_t output_buffer_size;
529 static void check_output_buffer_space( size_t size )
531 if (output_buffer_pos + size >= output_buffer_size)
533 output_buffer_size = max( output_buffer_size * 2, output_buffer_pos + size );
534 output_buffer = xrealloc( output_buffer, output_buffer_size );
538 void init_input_buffer( const char *file )
540 int fd;
541 struct stat st;
543 if ((fd = open( file, O_RDONLY | O_BINARY )) == -1) fatal_perror( "Cannot open %s", file );
544 if ((fstat( fd, &st ) == -1)) fatal_perror( "Cannot stat %s", file );
545 if (!st.st_size) fatal_error( "%s is an empty file\n", file );
546 #ifdef HAVE_MMAP
547 if ((input_buffer = mmap( NULL, st.st_size, PROT_READ, MAP_PRIVATE, fd, 0 )) == (void*)-1)
548 #endif
550 unsigned char *buffer = xmalloc( st.st_size );
551 if (read( fd, buffer, st.st_size ) != st.st_size) fatal_error( "Cannot read %s\n", file );
552 input_buffer = buffer;
554 close( fd );
555 input_buffer_filename = xstrdup( file );
556 input_buffer_size = st.st_size;
557 input_buffer_pos = 0;
558 byte_swapped = 0;
561 void init_output_buffer(void)
563 output_buffer_size = 1024;
564 output_buffer_pos = 0;
565 output_buffer = xmalloc( output_buffer_size );
568 void flush_output_buffer(void)
570 if (fwrite( output_buffer, 1, output_buffer_pos, output_file ) != output_buffer_pos)
571 fatal_error( "Error writing to %s\n", output_file_name );
572 free( output_buffer );
575 unsigned char get_byte(void)
577 if (input_buffer_pos >= input_buffer_size)
578 fatal_error( "%s is a truncated file\n", input_buffer_filename );
579 return input_buffer[input_buffer_pos++];
582 unsigned short get_word(void)
584 unsigned short ret;
586 if (input_buffer_pos + sizeof(ret) > input_buffer_size)
587 fatal_error( "%s is a truncated file\n", input_buffer_filename );
588 memcpy( &ret, input_buffer + input_buffer_pos, sizeof(ret) );
589 if (byte_swapped) ret = (ret << 8) | (ret >> 8);
590 input_buffer_pos += sizeof(ret);
591 return ret;
594 unsigned int get_dword(void)
596 unsigned int ret;
598 if (input_buffer_pos + sizeof(ret) > input_buffer_size)
599 fatal_error( "%s is a truncated file\n", input_buffer_filename );
600 memcpy( &ret, input_buffer + input_buffer_pos, sizeof(ret) );
601 if (byte_swapped)
602 ret = ((ret << 24) | ((ret << 8) & 0x00ff0000) | ((ret >> 8) & 0x0000ff00) | (ret >> 24));
603 input_buffer_pos += sizeof(ret);
604 return ret;
607 void put_data( const void *data, size_t size )
609 check_output_buffer_space( size );
610 memcpy( output_buffer + output_buffer_pos, data, size );
611 output_buffer_pos += size;
614 void put_byte( unsigned char val )
616 check_output_buffer_space( 1 );
617 output_buffer[output_buffer_pos++] = val;
620 void put_word( unsigned short val )
622 if (byte_swapped) val = (val << 8) | (val >> 8);
623 put_data( &val, sizeof(val) );
626 void put_dword( unsigned int val )
628 if (byte_swapped)
629 val = ((val << 24) | ((val << 8) & 0x00ff0000) | ((val >> 8) & 0x0000ff00) | (val >> 24));
630 put_data( &val, sizeof(val) );
633 void put_qword( unsigned int val )
635 if (byte_swapped)
637 put_dword( 0 );
638 put_dword( val );
640 else
642 put_dword( val );
643 put_dword( 0 );
647 /* pointer-sized word */
648 void put_pword( unsigned int val )
650 if (get_ptr_size() == 8) put_qword( val );
651 else put_dword( val );
654 void align_output( unsigned int align )
656 size_t size = align - (output_buffer_pos % align);
658 if (size == align) return;
659 check_output_buffer_space( size );
660 memset( output_buffer + output_buffer_pos, 0, size );
661 output_buffer_pos += size;
664 /* output a standard header for generated files */
665 void output_standard_file_header(void)
667 if (spec_file_name)
668 output( "/* File generated automatically from %s; do not edit! */\n", spec_file_name );
669 else
670 output( "/* File generated automatically; do not edit! */\n" );
671 output( "/* This file can be copied, modified and distributed without restriction. */\n\n" );
674 /* dump a byte stream into the assembly code */
675 void dump_bytes( const void *buffer, unsigned int size )
677 unsigned int i;
678 const unsigned char *ptr = buffer;
680 if (!size) return;
681 output( "\t.byte " );
682 for (i = 0; i < size - 1; i++, ptr++)
684 if ((i % 16) == 15) output( "0x%02x\n\t.byte ", *ptr );
685 else output( "0x%02x,", *ptr );
687 output( "0x%02x\n", *ptr );
691 /*******************************************************************
692 * open_input_file
694 * Open a file in the given srcdir and set the input_file_name global variable.
696 FILE *open_input_file( const char *srcdir, const char *name )
698 char *fullname;
699 FILE *file = fopen( name, "r" );
701 if (!file && srcdir)
703 fullname = strmake( "%s/%s", srcdir, name );
704 file = fopen( fullname, "r" );
706 else fullname = xstrdup( name );
708 if (!file) fatal_error( "Cannot open file '%s'\n", fullname );
709 input_file_name = fullname;
710 current_line = 1;
711 return file;
715 /*******************************************************************
716 * close_input_file
718 * Close the current input file (must have been opened with open_input_file).
720 void close_input_file( FILE *file )
722 fclose( file );
723 free( input_file_name );
724 input_file_name = NULL;
725 current_line = 0;
729 /*******************************************************************
730 * remove_stdcall_decoration
732 * Remove a possible @xx suffix from a function name.
733 * Return the numerical value of the suffix, or -1 if none.
735 int remove_stdcall_decoration( char *name )
737 char *p, *end = strrchr( name, '@' );
738 if (!end || !end[1] || end == name) return -1;
739 if (target_cpu != CPU_x86) return -1;
740 /* make sure all the rest is digits */
741 for (p = end + 1; *p; p++) if (!isdigit(*p)) return -1;
742 *end = 0;
743 return atoi( end + 1 );
747 /*******************************************************************
748 * assemble_file
750 * Run a file through the assembler.
752 void assemble_file( const char *src_file, const char *obj_file )
754 struct strarray *args = get_as_command();
755 strarray_add( args, "-o", obj_file, src_file, NULL );
756 spawn( args );
757 strarray_free( args );
761 /*******************************************************************
762 * alloc_dll_spec
764 * Create a new dll spec file descriptor
766 DLLSPEC *alloc_dll_spec(void)
768 DLLSPEC *spec;
770 spec = xmalloc( sizeof(*spec) );
771 spec->file_name = NULL;
772 spec->dll_name = NULL;
773 spec->init_func = NULL;
774 spec->main_module = NULL;
775 spec->type = SPEC_WIN32;
776 spec->base = MAX_ORDINALS;
777 spec->limit = 0;
778 spec->stack_size = 0;
779 spec->heap_size = 0;
780 spec->nb_entry_points = 0;
781 spec->alloc_entry_points = 0;
782 spec->nb_names = 0;
783 spec->nb_resources = 0;
784 spec->characteristics = IMAGE_FILE_EXECUTABLE_IMAGE;
785 if (get_ptr_size() > 4)
786 spec->characteristics |= IMAGE_FILE_LARGE_ADDRESS_AWARE;
787 else
788 spec->characteristics |= IMAGE_FILE_32BIT_MACHINE;
789 spec->dll_characteristics = IMAGE_DLLCHARACTERISTICS_NX_COMPAT;
790 spec->subsystem = 0;
791 spec->subsystem_major = 4;
792 spec->subsystem_minor = 0;
793 spec->entry_points = NULL;
794 spec->names = NULL;
795 spec->ordinals = NULL;
796 spec->resources = NULL;
797 return spec;
801 /*******************************************************************
802 * free_dll_spec
804 * Free dll spec file descriptor
806 void free_dll_spec( DLLSPEC *spec )
808 int i;
810 for (i = 0; i < spec->nb_entry_points; i++)
812 ORDDEF *odp = &spec->entry_points[i];
813 free( odp->name );
814 free( odp->export_name );
815 free( odp->link_name );
817 free( spec->file_name );
818 free( spec->dll_name );
819 free( spec->init_func );
820 free( spec->entry_points );
821 free( spec->names );
822 free( spec->ordinals );
823 free( spec->resources );
824 free( spec );
828 /*******************************************************************
829 * make_c_identifier
831 * Map a string to a valid C identifier.
833 const char *make_c_identifier( const char *str )
835 static char buffer[256];
836 char *p;
838 for (p = buffer; *str && p < buffer+sizeof(buffer)-1; p++, str++)
840 if (isalnum(*str)) *p = *str;
841 else *p = '_';
843 *p = 0;
844 return buffer;
848 /*******************************************************************
849 * get_stub_name
851 * Generate an internal name for a stub entry point.
853 const char *get_stub_name( const ORDDEF *odp, const DLLSPEC *spec )
855 static char *buffer;
857 free( buffer );
858 if (odp->name || odp->export_name)
860 char *p;
861 buffer = strmake( "__wine_stub_%s", odp->name ? odp->name : odp->export_name );
862 /* make sure name is a legal C identifier */
863 for (p = buffer; *p; p++) if (!isalnum(*p) && *p != '_') break;
864 if (!*p) return buffer;
865 free( buffer );
867 buffer = strmake( "__wine_stub_%s_%d", make_c_identifier(spec->file_name), odp->ordinal );
868 return buffer;
871 /* parse a cpu name and return the corresponding value */
872 enum target_cpu get_cpu_from_name( const char *name )
874 unsigned int i;
876 for (i = 0; i < sizeof(cpu_names)/sizeof(cpu_names[0]); i++)
877 if (!strcmp( cpu_names[i].name, name )) return cpu_names[i].cpu;
878 return -1;
881 /*****************************************************************
882 * Function: get_alignment
884 * Description:
885 * According to the info page for gas, the .align directive behaves
886 * differently on different systems. On some architectures, the
887 * argument of a .align directive is the number of bytes to pad to, so
888 * to align on an 8-byte boundary you'd say
889 * .align 8
890 * On other systems, the argument is "the number of low-order zero bits
891 * that the location counter must have after advancement." So to
892 * align on an 8-byte boundary you'd say
893 * .align 3
895 * The reason gas is written this way is that it's trying to mimick
896 * native assemblers for the various architectures it runs on. gas
897 * provides other directives that work consistently across
898 * architectures, but of course we want to work on all arches with or
899 * without gas. Hence this function.
902 * Parameters:
903 * align -- the number of bytes to align to. Must be a power of 2.
905 unsigned int get_alignment(unsigned int align)
907 unsigned int n;
909 assert( !(align & (align - 1)) );
911 switch(target_cpu)
913 case CPU_x86:
914 case CPU_x86_64:
915 if (target_platform != PLATFORM_APPLE) return align;
916 /* fall through */
917 case CPU_POWERPC:
918 case CPU_ARM:
919 case CPU_ARM64:
920 n = 0;
921 while ((1u << n) != align) n++;
922 return n;
924 /* unreached */
925 assert(0);
926 return 0;
929 /* return the page size for the target CPU */
930 unsigned int get_page_size(void)
932 switch(target_cpu)
934 case CPU_x86: return 4096;
935 case CPU_x86_64: return 4096;
936 case CPU_POWERPC: return 4096;
937 case CPU_ARM: return 4096;
938 case CPU_ARM64: return 4096;
940 /* unreached */
941 assert(0);
942 return 0;
945 /* return the size of a pointer on the target CPU */
946 unsigned int get_ptr_size(void)
948 switch(target_cpu)
950 case CPU_x86:
951 case CPU_POWERPC:
952 case CPU_ARM:
953 return 4;
954 case CPU_x86_64:
955 case CPU_ARM64:
956 return 8;
958 /* unreached */
959 assert(0);
960 return 0;
963 /* return the total size in bytes of the arguments on the stack */
964 unsigned int get_args_size( const ORDDEF *odp )
966 int i, size;
968 for (i = size = 0; i < odp->u.func.nb_args; i++)
970 switch (odp->u.func.args[i])
972 case ARG_INT64:
973 case ARG_DOUBLE:
974 size += 8;
975 break;
976 case ARG_INT128:
977 /* int128 is passed as pointer on x86_64 */
978 if (target_cpu != CPU_x86_64)
980 size += 16;
981 break;
983 /* fall through */
984 default:
985 size += get_ptr_size();
986 break;
989 return size;
992 /* return the assembly name for a C symbol */
993 const char *asm_name( const char *sym )
995 static char *buffer;
997 switch (target_platform)
999 case PLATFORM_APPLE:
1000 case PLATFORM_WINDOWS:
1001 if (sym[0] == '.' && sym[1] == 'L') return sym;
1002 free( buffer );
1003 buffer = strmake( "_%s", sym );
1004 return buffer;
1005 default:
1006 return sym;
1010 /* return an assembly function declaration for a C function name */
1011 const char *func_declaration( const char *func )
1013 static char *buffer;
1015 switch (target_platform)
1017 case PLATFORM_APPLE:
1018 return "";
1019 case PLATFORM_WINDOWS:
1020 free( buffer );
1021 buffer = strmake( ".def _%s; .scl 2; .type 32; .endef", func );
1022 break;
1023 default:
1024 free( buffer );
1025 switch(target_cpu)
1027 case CPU_ARM:
1028 case CPU_ARM64:
1029 buffer = strmake( ".type %s,%%function", func );
1030 break;
1031 default:
1032 buffer = strmake( ".type %s,@function", func );
1033 break;
1035 break;
1037 return buffer;
1040 /* output a size declaration for an assembly function */
1041 void output_function_size( const char *name )
1043 switch (target_platform)
1045 case PLATFORM_APPLE:
1046 case PLATFORM_WINDOWS:
1047 break;
1048 default:
1049 output( "\t.size %s, .-%s\n", name, name );
1050 break;
1054 /* output a .cfi directive */
1055 void output_cfi( const char *format, ... )
1057 va_list valist;
1059 if (!unwind_tables) return;
1060 va_start( valist, format );
1061 fputc( '\t', output_file );
1062 vfprintf( output_file, format, valist );
1063 fputc( '\n', output_file );
1064 va_end( valist );
1067 /* output the GNU note for non-exec stack */
1068 void output_gnu_stack_note(void)
1070 switch (target_platform)
1072 case PLATFORM_WINDOWS:
1073 case PLATFORM_APPLE:
1074 break;
1075 default:
1076 switch(target_cpu)
1078 case CPU_ARM:
1079 case CPU_ARM64:
1080 output( "\t.section .note.GNU-stack,\"\",%%progbits\n" );
1081 break;
1082 default:
1083 output( "\t.section .note.GNU-stack,\"\",@progbits\n" );
1084 break;
1086 break;
1090 /* return a global symbol declaration for an assembly symbol */
1091 const char *asm_globl( const char *func )
1093 static char *buffer;
1095 free( buffer );
1096 switch (target_platform)
1098 case PLATFORM_APPLE:
1099 buffer = strmake( "\t.globl _%s\n\t.private_extern _%s\n_%s:", func, func, func );
1100 break;
1101 case PLATFORM_WINDOWS:
1102 buffer = strmake( "\t.globl _%s\n_%s:", func, func );
1103 break;
1104 default:
1105 buffer = strmake( "\t.globl %s\n\t.hidden %s\n%s:", func, func, func );
1106 break;
1108 return buffer;
1111 const char *get_asm_ptr_keyword(void)
1113 switch(get_ptr_size())
1115 case 4: return ".long";
1116 case 8: return ".quad";
1118 assert(0);
1119 return NULL;
1122 const char *get_asm_string_keyword(void)
1124 switch (target_platform)
1126 case PLATFORM_APPLE:
1127 return ".asciz";
1128 default:
1129 return ".string";
1133 const char *get_asm_rodata_section(void)
1135 switch (target_platform)
1137 case PLATFORM_APPLE: return ".const";
1138 default: return ".section .rodata";
1142 const char *get_asm_string_section(void)
1144 switch (target_platform)
1146 case PLATFORM_APPLE: return ".cstring";
1147 default: return ".section .rodata";