1 /* Assorted BFD support routines, only used internally.
2 Copyright 1990, 1991, 1992 Free Software Foundation, Inc.
3 Written by Cygnus Support.
5 This file is part of BFD, the Binary File Descriptor library.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
30 This file contains various routines which are used within BFD.
31 They are not intended for export, but are documented here for
36 DEFUN(_bfd_dummy_new_section_hook,(ignore, ignore_newsect),
38 asection *ignore_newsect)
44 DEFUN(bfd_false ,(ignore),
51 DEFUN(bfd_true,(ignore),
58 DEFUN(bfd_nullvoidptr,(ignore),
72 DEFUN(bfd_0u,(ignore),
79 DEFUN(bfd_void,(ignore),
85 DEFUN(_bfd_dummy_core_file_matches_executable_p,(ignore_core_bfd, ignore_exec_bfd),
86 bfd *ignore_core_bfd AND
89 bfd_error = invalid_operation;
93 /* of course you can't initialize a function to be the same as another, grr */
96 DEFUN(_bfd_dummy_core_file_failing_command,(ignore_abfd),
103 DEFUN(_bfd_dummy_core_file_failing_signal,(ignore_abfd),
110 DEFUN(_bfd_dummy_target,(ignore_abfd),
116 /** zalloc -- allocate and clear storage */
124 char *ptr = (char *) malloc ((size_t)size);
126 if ((ptr != NULL) && (size != 0))
127 memset(ptr,0, (size_t) size);
138 PTR bfd_xmalloc( bfd_size_type size);
141 Like malloc, but exit if no more memory.
145 /** There is major inconsistency in how running out of memory is handled.
146 Some routines return a NULL, and set bfd_error to no_memory.
147 However, obstack routines can't do this ... */
150 DEFUN(PTR bfd_xmalloc,(size),
153 static CONST char no_memory_message[] = "Virtual memory exhausted!\n";
155 if (size == 0) size = 1;
156 ptr = (PTR)malloc((size_t) size);
159 write (2, no_memory_message, sizeof(no_memory_message)-1);
167 bfd_xmalloc_by_size_t
170 PTR bfd_xmalloc_by_size_t ( size_t size);
173 Like malloc, but exit if no more memory.
174 Uses size_t, so it's suitable for use as obstack_chunk_alloc.
177 DEFUN(bfd_xmalloc_by_size_t, (size),
180 return bfd_xmalloc ((bfd_size_type) size);
186 /* Note that archive entries don't have streams; they share their parent's.
187 This allows someone to play with the iostream behind BFD's back.
189 Also, note that the origin pointer points to the beginning of a file's
190 contents (0 for non-archive elements). For archive entries this is the
191 first octet in the file, NOT the beginning of the archive header. */
194 int DEFUN(real_read,(where, a,b, file),
200 return fread(where, a,b,file);
203 DEFUN(bfd_read,(ptr, size, nitems, abfd),
205 bfd_size_type size AND
206 bfd_size_type nitems AND
210 nread = real_read (ptr, 1, (int)(size*nitems), bfd_cache_lookup(abfd));
211 #ifdef FILE_OFFSET_IS_CHAR_INDEX
213 abfd->where += nread;
219 DEFUN(bfd_write,(ptr, size, nitems, abfd),
221 bfd_size_type size AND
222 bfd_size_type nitems AND
225 int nwrote = fwrite (ptr, 1, (int)(size*nitems), bfd_cache_lookup(abfd));
226 #ifdef FILE_OFFSET_IS_CHAR_INDEX
228 abfd->where += nwrote;
235 bfd_write_bigendian_4byte_int
238 void bfd_write_bigendian_4byte_int(bfd *abfd, int i);
241 Writes a 4 byte integer to the outputing bfd, in big endian
242 mode regardless of what else is going on. This is useful in
247 DEFUN(bfd_write_bigendian_4byte_int,(abfd, i),
252 bfd_putb32(i, buffer);
253 bfd_write((PTR)buffer, 4, 1, abfd);
257 DEFUN(bfd_tell,(abfd),
262 ptr = ftell (bfd_cache_lookup(abfd));
264 if (abfd->my_archive)
271 DEFUN(bfd_flush,(abfd),
274 return fflush (bfd_cache_lookup(abfd));
278 DEFUN(bfd_stat,(abfd, statbuf),
280 struct stat *statbuf)
282 return fstat (fileno(bfd_cache_lookup(abfd)), statbuf);
286 DEFUN(bfd_seek,(abfd, position, direction),
288 CONST file_ptr position AND
293 file_ptr file_position;
294 /* For the time being, a BFD may not seek to it's end. The problem
295 is that we don't easily have a way to recognize the end of an
296 element in an archive. */
298 BFD_ASSERT (direction == SEEK_SET || direction == SEEK_CUR);
300 if (direction == SEEK_CUR && position == 0)
302 #ifdef FILE_OFFSET_IS_CHAR_INDEX
303 if (abfd->format != bfd_archive && abfd->my_archive == 0)
306 /* Explanation for this code: I'm only about 95+% sure that the above
307 conditions are sufficient and that all i/o calls are properly
308 adjusting the `where' field. So this is sort of an `assert'
309 that the `where' field is correct. If we can go a while without
310 tripping the abort, we can probably safely disable this code,
311 so that the real optimizations happen. */
312 file_ptr where_am_i_now;
313 where_am_i_now = ftell (bfd_cache_lookup (abfd));
314 if (abfd->my_archive)
315 where_am_i_now -= abfd->origin;
316 if (where_am_i_now != abfd->where)
319 if (direction == SEEK_SET && position == abfd->where)
324 /* We need something smarter to optimize access to archives.
325 Currently, anything inside an archive is read via the file
326 handle for the archive. Which means that a bfd_seek on one
327 component affects the `current position' in the archive, as
328 well as in any other component.
330 It might be sufficient to put a spike through the cache
331 abstraction, and look to the archive for the file position,
332 but I think we should try for something cleaner.
334 In the meantime, no optimization for archives. */
338 f = bfd_cache_lookup (abfd);
339 file_position = position;
340 if (direction == SEEK_SET && abfd->my_archive != NULL)
341 file_position += abfd->origin;
343 result = fseek (f, file_position, direction);
346 /* Force redetermination of `where' field. */
350 #ifdef FILE_OFFSET_IS_CHAR_INDEX
351 /* Adjust `where' field. */
352 if (direction == SEEK_SET)
353 abfd->where = position;
355 abfd->where += position;
361 /** Make a string table */
364 Add string to table pointed to by table, at location starting with free_ptr.
365 resizes the table if necessary (if it's NULL, creates it, ignoring
366 table_length). Updates free_ptr, table, table_length */
369 DEFUN(bfd_add_to_string_table,(table, new_string, table_length, free_ptr),
372 unsigned int *table_length AND
375 size_t string_length = strlen (new_string) + 1; /* include null here */
377 size_t space_length = *table_length;
378 unsigned int offset = (base ? *free_ptr - base : 0);
381 /* Avoid a useless regrow if we can (but of course we still
383 space_length = (string_length < DEFAULT_STRING_SPACE_SIZE ?
384 DEFAULT_STRING_SPACE_SIZE : string_length+1);
385 base = zalloc ((bfd_size_type) space_length);
388 bfd_error = no_memory;
393 if ((size_t)(offset + string_length) >= space_length) {
394 /* Make sure we will have enough space */
395 while ((size_t)(offset + string_length) >= space_length)
396 space_length += space_length/2; /* grow by 50% */
398 base = (char *) realloc (base, space_length);
400 bfd_error = no_memory;
406 memcpy (base + offset, new_string, string_length);
408 *table_length = space_length;
409 *free_ptr = base + offset + string_length;
414 /** The do-it-yourself (byte) sex-change kit */
416 /* The middle letter e.g. get<b>short indicates Big or Little endian
417 target machine. It doesn't matter what the byte order of the host
418 machine is; these routines work for either. */
420 /* FIXME: Should these take a count argument?
421 Answer (gnu@cygnus.com): No, but perhaps they should be inline
422 functions in swap.h #ifdef __GNUC__.
423 Gprof them later and find out. */
432 These macros as used for reading and writing raw data in
433 sections; each access (except for bytes) is vectored through
434 the target format of the BFD and mangled accordingly. The
435 mangling performs any necessary endian translations and
436 removes alignment restrictions. Note that types accepted and
437 returned by these macros are identical so they can be swapped
438 around in macros--for example libaout.h defines GET_WORD to
439 either bfd_get_32 or bfd_get_64.
441 In the put routines, val must be a bfd_vma. If we are on a
442 system without prototypes, the caller is responsible for making
443 sure that is true, with a cast if necessary. We don't cast
444 them in the macro definitions because that would prevent lint
445 or gcc -Wall from detecting sins such as passing a pointer.
446 To detect calling these with less than a bfd_vma, use gcc
447 -Wconversion on a host with 64 bit bfd_vma's.
450 .{* Byte swapping macros for user section data. *}
452 .#define bfd_put_8(abfd, val, ptr) \
453 . (*((unsigned char *)(ptr)) = (unsigned char)val)
454 .#define bfd_put_signed_8 \
456 .#define bfd_get_8(abfd, ptr) \
457 . (*(unsigned char *)(ptr))
458 .#define bfd_get_signed_8(abfd, ptr) \
459 . ((*(unsigned char *)(ptr) ^ 0x80) - 0x80)
461 .#define bfd_put_16(abfd, val, ptr) \
462 . BFD_SEND(abfd, bfd_putx16, ((val),(ptr)))
463 .#define bfd_put_signed_16 \
465 .#define bfd_get_16(abfd, ptr) \
466 . BFD_SEND(abfd, bfd_getx16, (ptr))
467 .#define bfd_get_signed_16(abfd, ptr) \
468 . BFD_SEND (abfd, bfd_getx_signed_16, (ptr))
470 .#define bfd_put_32(abfd, val, ptr) \
471 . BFD_SEND(abfd, bfd_putx32, ((val),(ptr)))
472 .#define bfd_put_signed_32 \
474 .#define bfd_get_32(abfd, ptr) \
475 . BFD_SEND(abfd, bfd_getx32, (ptr))
476 .#define bfd_get_signed_32(abfd, ptr) \
477 . BFD_SEND(abfd, bfd_getx_signed_32, (ptr))
479 .#define bfd_put_64(abfd, val, ptr) \
480 . BFD_SEND(abfd, bfd_putx64, ((val), (ptr)))
481 .#define bfd_put_signed_64 \
483 .#define bfd_get_64(abfd, ptr) \
484 . BFD_SEND(abfd, bfd_getx64, (ptr))
485 .#define bfd_get_signed_64(abfd, ptr) \
486 . BFD_SEND(abfd, bfd_getx_signed_64, (ptr))
497 These macros have the same function as their <<bfd_get_x>>
498 bretherin, except that they are used for removing information
499 for the header records of object files. Believe it or not,
500 some object files keep their header records in big endian
501 order, and their data in little endian order.
503 .{* Byte swapping macros for file header data. *}
505 .#define bfd_h_put_8(abfd, val, ptr) \
506 . bfd_put_8 (abfd, val, ptr)
507 .#define bfd_h_put_signed_8(abfd, val, ptr) \
508 . bfd_put_8 (abfd, val, ptr)
509 .#define bfd_h_get_8(abfd, ptr) \
510 . bfd_get_8 (abfd, ptr)
511 .#define bfd_h_get_signed_8(abfd, ptr) \
512 . bfd_get_signed_8 (abfd, ptr)
514 .#define bfd_h_put_16(abfd, val, ptr) \
515 . BFD_SEND(abfd, bfd_h_putx16,(val,ptr))
516 .#define bfd_h_put_signed_16 \
518 .#define bfd_h_get_16(abfd, ptr) \
519 . BFD_SEND(abfd, bfd_h_getx16,(ptr))
520 .#define bfd_h_get_signed_16(abfd, ptr) \
521 . BFD_SEND(abfd, bfd_h_getx_signed_16, (ptr))
523 .#define bfd_h_put_32(abfd, val, ptr) \
524 . BFD_SEND(abfd, bfd_h_putx32,(val,ptr))
525 .#define bfd_h_put_signed_32 \
527 .#define bfd_h_get_32(abfd, ptr) \
528 . BFD_SEND(abfd, bfd_h_getx32,(ptr))
529 .#define bfd_h_get_signed_32(abfd, ptr) \
530 . BFD_SEND(abfd, bfd_h_getx_signed_32, (ptr))
532 .#define bfd_h_put_64(abfd, val, ptr) \
533 . BFD_SEND(abfd, bfd_h_putx64,(val, ptr))
534 .#define bfd_h_put_signed_64 \
536 .#define bfd_h_get_64(abfd, ptr) \
537 . BFD_SEND(abfd, bfd_h_getx64,(ptr))
538 .#define bfd_h_get_signed_64(abfd, ptr) \
539 . BFD_SEND(abfd, bfd_h_getx_signed_64, (ptr))
543 /* Sign extension to bfd_signed_vma. */
544 #define COERCE16(x) ((bfd_signed_vma) (((x) ^ 0x8000) - 0x8000))
545 #define COERCE32(x) ((bfd_signed_vma) (((x) ^ 0x80000000) - 0x80000000))
546 #define EIGHT_GAZILLION (((HOST_64_BIT)0x80000000) << 32)
547 #define COERCE64(x) ((bfd_signed_vma)\
548 (((x) ^ EIGHT_GAZILLION) - EIGHT_GAZILLION))
551 DEFUN(bfd_getb16,(addr),
552 register bfd_byte *addr)
554 return (addr[0] << 8) | addr[1];
558 DEFUN(bfd_getl16,(addr),
559 register bfd_byte *addr)
561 return (addr[1] << 8) | addr[0];
565 DEFUN(bfd_getb_signed_16,(addr),
566 register bfd_byte *addr)
568 return COERCE16((addr[0] << 8) | addr[1]);
572 DEFUN(bfd_getl_signed_16,(addr),
573 register bfd_byte *addr)
575 return COERCE16((addr[1] << 8) | addr[0]);
579 DEFUN(bfd_putb16,(data, addr),
581 register bfd_byte *addr)
583 addr[0] = (bfd_byte)(data >> 8);
584 addr[1] = (bfd_byte )data;
588 DEFUN(bfd_putl16,(data, addr),
590 register bfd_byte *addr)
592 addr[0] = (bfd_byte )data;
593 addr[1] = (bfd_byte)(data >> 8);
598 register bfd_byte *addr;
600 return ((((addr[0] << 8) | addr[1]) << 8) | addr[2]) << 8 | addr[3];
605 register bfd_byte *addr;
607 return ((((addr[3] << 8) | addr[2]) << 8) | addr[1]) << 8 | addr[0];
611 bfd_getb_signed_32 (addr)
612 register bfd_byte *addr;
614 return COERCE32(((((addr[0] << 8) | addr[1]) << 8)
615 | addr[2]) << 8 | addr[3]);
619 bfd_getl_signed_32 (addr)
620 register bfd_byte *addr;
622 return COERCE32(((((addr[3] << 8) | addr[2]) << 8)
623 | addr[1]) << 8 | addr[0]);
627 DEFUN(bfd_getb64,(addr),
628 register bfd_byte *addr)
633 high= ((((((((addr[0]) << 8) |
638 low = ((((((((addr[4]) << 8) |
643 return high << 32 | low;
652 DEFUN(bfd_getl64,(addr),
653 register bfd_byte *addr)
658 high= (((((((addr[7] << 8) |
663 low = (((((((addr[3] << 8) |
668 return high << 32 | low;
677 DEFUN(bfd_getb_signed_64,(addr),
678 register bfd_byte *addr)
683 high= ((((((((addr[0]) << 8) |
688 low = ((((((((addr[4]) << 8) |
693 return COERCE64(high << 32 | low);
702 DEFUN(bfd_getl_signed_64,(addr),
703 register bfd_byte *addr)
708 high= (((((((addr[7] << 8) |
713 low = (((((((addr[3] << 8) |
718 return COERCE64(high << 32 | low);
727 DEFUN(bfd_putb32,(data, addr),
729 register bfd_byte *addr)
731 addr[0] = (bfd_byte)(data >> 24);
732 addr[1] = (bfd_byte)(data >> 16);
733 addr[2] = (bfd_byte)(data >> 8);
734 addr[3] = (bfd_byte)data;
738 DEFUN(bfd_putl32,(data, addr),
740 register bfd_byte *addr)
742 addr[0] = (bfd_byte)data;
743 addr[1] = (bfd_byte)(data >> 8);
744 addr[2] = (bfd_byte)(data >> 16);
745 addr[3] = (bfd_byte)(data >> 24);
748 DEFUN(bfd_putb64,(data, addr),
750 register bfd_byte *addr)
753 addr[0] = (bfd_byte)(data >> (7*8));
754 addr[1] = (bfd_byte)(data >> (6*8));
755 addr[2] = (bfd_byte)(data >> (5*8));
756 addr[3] = (bfd_byte)(data >> (4*8));
757 addr[4] = (bfd_byte)(data >> (3*8));
758 addr[5] = (bfd_byte)(data >> (2*8));
759 addr[6] = (bfd_byte)(data >> (1*8));
760 addr[7] = (bfd_byte)(data >> (0*8));
768 DEFUN(bfd_putl64,(data, addr),
770 register bfd_byte *addr)
773 addr[7] = (bfd_byte)(data >> (7*8));
774 addr[6] = (bfd_byte)(data >> (6*8));
775 addr[5] = (bfd_byte)(data >> (5*8));
776 addr[4] = (bfd_byte)(data >> (4*8));
777 addr[3] = (bfd_byte)(data >> (3*8));
778 addr[2] = (bfd_byte)(data >> (2*8));
779 addr[1] = (bfd_byte)(data >> (1*8));
780 addr[0] = (bfd_byte)(data >> (0*8));
788 /* Default implementation */
791 DEFUN(bfd_generic_get_section_contents, (abfd, section, location, offset, count),
800 if ((bfd_size_type)(offset+count) > section->_raw_size
801 || bfd_seek(abfd, (file_ptr)(section->filepos + offset), SEEK_SET) == -1
802 || bfd_read(location, (bfd_size_type)1, count, abfd) != count)
803 return (false); /* on error */
807 /* This generic function can only be used in implementations where creating
808 NEW sections is disallowed. It is useful in patching existing sections
809 in read-write files, though. See other set_section_contents functions
810 to see why it doesn't work for new sections. */
812 DEFUN(bfd_generic_set_section_contents, (abfd, section, location, offset, count),
821 if ((bfd_size_type)(offset+count) > bfd_get_section_size_after_reloc(section)
822 || bfd_seek(abfd, (file_ptr)(section->filepos + offset), SEEK_SET) == -1
823 || bfd_write(location, (bfd_size_type)1, count, abfd) != count)
824 return (false); /* on error */
833 Return the log base 2 of the value supplied, rounded up. eg an
834 arg of 1025 would return 11.
837 unsigned int bfd_log2(bfd_vma x);
845 while ( (bfd_vma)(1<< result) < x)