1 /* Low-level I/O routines for BFDs.
3 Copyright (C) 1990-2024 Free Software Foundation, Inc.
5 Written by Cygnus Support.
7 This file is part of BFD, the Binary File Descriptor library.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
22 MA 02110-1301, USA. */
35 #define S_IXUSR 0100 /* Execute by owner. */
38 #define S_IXGRP 0010 /* Execute by group. */
41 #define S_IXOTH 0001 /* Execute by others. */
49 _bfd_real_ftell (FILE *file
)
51 #if defined (HAVE_FTELLO64)
52 return ftello64 (file
);
53 #elif defined (HAVE_FTELLO)
61 _bfd_real_fseek (FILE *file
, file_ptr offset
, int whence
)
63 #if defined (HAVE_FSEEKO64)
64 return fseeko64 (file
, offset
, whence
);
65 #elif defined (HAVE_FSEEKO)
66 return fseeko (file
, offset
, whence
);
68 return fseek (file
, offset
, whence
);
72 /* Mark FILE as close-on-exec. Return FILE. FILE may be NULL, in
73 which case nothing is done. */
75 close_on_exec (FILE *file
)
77 #if defined (HAVE_FILENO) && defined (F_GETFD)
80 int fd
= fileno (file
);
81 int old
= fcntl (fd
, F_GETFD
, 0);
83 fcntl (fd
, F_SETFD
, old
| FD_CLOEXEC
);
90 _bfd_real_fopen (const char *filename
, const char *modes
)
95 /* On VMS, fopen allows file attributes as optional arguments.
96 We need to use them but we'd better to use the common prototype.
97 In fopen-vms.h, they are separated from the mode with a comma.
99 vms_attr
= strchr (modes
, ',');
100 if (vms_attr
!= NULL
)
102 /* Attributes found. Split. */
103 size_t modes_len
= strlen (modes
) + 1;
104 char attrs
[modes_len
+ 1];
108 memcpy (attrs
, modes
, modes_len
);
110 for (i
= 0; i
< 2; i
++)
112 at
[i
+ 1] = strchr (at
[i
], ',');
113 BFD_ASSERT (at
[i
+ 1] != NULL
);
114 *(at
[i
+ 1]++) = 0; /* Replace ',' with a nul, and skip it. */
116 return close_on_exec (fopen (filename
, at
[0], at
[1], at
[2]));
119 #elif defined (_WIN32)
120 /* PR 25713: Handle extra long path names possibly containing '..' and '.'. */
121 wchar_t ** lpFilePart
= {NULL
};
122 const wchar_t prefix
[] = L
"\\\\?\\";
123 const size_t partPathLen
= strlen (filename
) + 1;
125 #if !HAVE_DECL____LC_CODEPAGE_FUNC
126 /* This prototype was added to locale.h in version 9.0 of MinGW-w64. */
127 _CRTIMP
unsigned int __cdecl
___lc_codepage_func (void);
129 const unsigned int cp
= ___lc_codepage_func ();
131 const unsigned int cp
= CP_UTF8
;
134 /* Converting the partial path from ascii to unicode.
135 1) Get the length: Calling with lpWideCharStr set to null returns the length.
136 2) Convert the string: Calling with cbMultiByte set to -1 includes the terminating null. */
137 size_t partPathWSize
= MultiByteToWideChar (cp
, 0, filename
, -1, NULL
, 0);
138 wchar_t * partPath
= calloc (partPathWSize
, sizeof(wchar_t));
141 MultiByteToWideChar (cp
, 0, filename
, -1, partPath
, partPathWSize
);
143 /* Convert any UNIX style path separators into the DOS i.e. backslash separator. */
144 for (ix
= 0; ix
< partPathLen
; ix
++)
145 if (IS_UNIX_DIR_SEPARATOR(filename
[ix
]))
148 /* Getting the full path from the provided partial path.
150 2) Resolve the path. */
151 long fullPathWSize
= GetFullPathNameW (partPath
, 0, NULL
, lpFilePart
);
152 wchar_t * fullPath
= calloc (fullPathWSize
+ sizeof(prefix
) + 1, sizeof(wchar_t));
154 wcscpy (fullPath
, prefix
);
156 int prefixLen
= sizeof(prefix
) / sizeof(wchar_t);
158 /* Do not add a prefix to the null device. */
159 if (stricmp (filename
, "nul") == 0)
162 wchar_t * fullPathOffset
= fullPath
+ prefixLen
- 1;
164 GetFullPathNameW (partPath
, fullPathWSize
, fullPathOffset
, lpFilePart
);
167 /* It is non-standard for modes to exceed 16 characters. */
170 MultiByteToWideChar (cp
, 0, modes
, -1, modesW
, sizeof(modesW
));
172 FILE * file
= _wfopen (fullPath
, modesW
);
175 return close_on_exec (file
);
177 #elif defined (HAVE_FOPEN64)
178 return close_on_exec (fopen64 (filename
, modes
));
181 return close_on_exec (fopen (filename
, modes
));
191 The <<struct bfd_iovec>> contains the internal file I/O class.
192 Each <<BFD>> has an instance of this class and all file I/O is
193 routed through it (it is assumed that the instance implements
194 all methods listed below).
198 . {* To avoid problems with macros, a "b" rather than "f"
199 . prefix is prepended to each method name. *}
200 . {* Attempt to read/write NBYTES on ABFD's IOSTREAM storing/fetching
201 . bytes starting at PTR. Return the number of bytes actually
202 . transfered (a read past end-of-file returns less than NBYTES),
203 . or -1 (setting <<bfd_error>>) if an error occurs. *}
204 . file_ptr (*bread) (struct bfd *abfd, void *ptr, file_ptr nbytes);
205 . file_ptr (*bwrite) (struct bfd *abfd, const void *ptr,
207 . {* Return the current IOSTREAM file offset, or -1 (setting <<bfd_error>>
208 . if an error occurs. *}
209 . file_ptr (*btell) (struct bfd *abfd);
210 . {* For the following, on successful completion a value of 0 is returned.
211 . Otherwise, a value of -1 is returned (and <<bfd_error>> is set). *}
212 . int (*bseek) (struct bfd *abfd, file_ptr offset, int whence);
213 . int (*bclose) (struct bfd *abfd);
214 . int (*bflush) (struct bfd *abfd);
215 . int (*bstat) (struct bfd *abfd, struct stat *sb);
216 . {* Mmap a part of the files. ADDR, LEN, PROT, FLAGS and OFFSET are the usual
217 . mmap parameter, except that LEN and OFFSET do not need to be page
218 . aligned. Returns (void *)-1 on failure, mmapped address on success.
219 . Also write in MAP_ADDR the address of the page aligned buffer and in
220 . MAP_LEN the size mapped (a page multiple). Use unmap with MAP_ADDR and
221 . MAP_LEN to unmap. *}
222 . void *(*bmmap) (struct bfd *abfd, void *addr, bfd_size_type len,
223 . int prot, int flags, file_ptr offset,
224 . void **map_addr, bfd_size_type *map_len);
227 .extern const struct bfd_iovec _bfd_memory_iovec;
237 bfd_size_type bfd_read (void *, bfd_size_type, bfd *)
238 ATTRIBUTE_WARN_UNUSED_RESULT;
241 Attempt to read SIZE bytes from ABFD's iostream to PTR.
242 Return the amount read.
246 bfd_read (void *ptr
, bfd_size_type size
, bfd
*abfd
)
249 bfd
*element_bfd
= abfd
;
250 ufile_ptr offset
= 0;
252 while (abfd
->my_archive
!= NULL
253 && !bfd_is_thin_archive (abfd
->my_archive
))
255 offset
+= abfd
->origin
;
256 abfd
= abfd
->my_archive
;
258 offset
+= abfd
->origin
;
260 /* If this is a non-thin archive element, don't read past the end of
262 if (element_bfd
->arelt_data
!= NULL
263 && element_bfd
->my_archive
!= NULL
264 && !bfd_is_thin_archive (element_bfd
->my_archive
))
266 bfd_size_type maxbytes
= arelt_size (element_bfd
);
268 if (abfd
->where
< offset
|| abfd
->where
- offset
>= maxbytes
)
270 bfd_set_error (bfd_error_invalid_operation
);
273 if (abfd
->where
- offset
+ size
> maxbytes
)
274 size
= maxbytes
- (abfd
->where
- offset
);
277 if (abfd
->iovec
== NULL
)
279 bfd_set_error (bfd_error_invalid_operation
);
283 if (abfd
->last_io
== bfd_io_write
)
285 abfd
->last_io
= bfd_io_force
;
286 if (bfd_seek (abfd
, 0, SEEK_CUR
) != 0)
289 abfd
->last_io
= bfd_io_read
;
291 nread
= abfd
->iovec
->bread (abfd
, ptr
, size
);
293 abfd
->where
+= nread
;
303 bfd_size_type bfd_write (const void *, bfd_size_type, bfd *)
304 ATTRIBUTE_WARN_UNUSED_RESULT;
307 Attempt to write SIZE bytes to ABFD's iostream from PTR.
308 Return the amount written.
312 bfd_write (const void *ptr
, bfd_size_type size
, bfd
*abfd
)
316 while (abfd
->my_archive
!= NULL
317 && !bfd_is_thin_archive (abfd
->my_archive
))
318 abfd
= abfd
->my_archive
;
320 if (abfd
->iovec
== NULL
)
322 bfd_set_error (bfd_error_invalid_operation
);
326 if (abfd
->last_io
== bfd_io_read
)
328 abfd
->last_io
= bfd_io_force
;
329 if (bfd_seek (abfd
, 0, SEEK_CUR
) != 0)
332 abfd
->last_io
= bfd_io_write
;
334 nwrote
= abfd
->iovec
->bwrite (abfd
, ptr
, size
);
336 abfd
->where
+= nwrote
;
337 if ((bfd_size_type
) nwrote
!= size
)
342 bfd_set_error (bfd_error_system_call
);
352 file_ptr bfd_tell (bfd *) ATTRIBUTE_WARN_UNUSED_RESULT;
355 Return ABFD's iostream file position.
361 ufile_ptr offset
= 0;
364 while (abfd
->my_archive
!= NULL
365 && !bfd_is_thin_archive (abfd
->my_archive
))
367 offset
+= abfd
->origin
;
368 abfd
= abfd
->my_archive
;
370 offset
+= abfd
->origin
;
372 if (abfd
->iovec
== NULL
)
375 ptr
= abfd
->iovec
->btell (abfd
);
385 int bfd_flush (bfd *);
388 Flush ABFD's iostream pending IO.
392 bfd_flush (bfd
*abfd
)
394 while (abfd
->my_archive
!= NULL
395 && !bfd_is_thin_archive (abfd
->my_archive
))
396 abfd
= abfd
->my_archive
;
398 if (abfd
->iovec
== NULL
)
401 return abfd
->iovec
->bflush (abfd
);
409 int bfd_stat (bfd *, struct stat *) ATTRIBUTE_WARN_UNUSED_RESULT;
412 Call fstat on ABFD's iostream. Return 0 on success, and a
413 negative value on failure.
417 bfd_stat (bfd
*abfd
, struct stat
*statbuf
)
421 while (abfd
->my_archive
!= NULL
422 && !bfd_is_thin_archive (abfd
->my_archive
))
423 abfd
= abfd
->my_archive
;
425 if (abfd
->iovec
== NULL
)
427 bfd_set_error (bfd_error_invalid_operation
);
431 result
= abfd
->iovec
->bstat (abfd
, statbuf
);
433 bfd_set_error (bfd_error_system_call
);
442 int bfd_seek (bfd *, file_ptr, int) ATTRIBUTE_WARN_UNUSED_RESULT;
445 Call fseek on ABFD's iostream. Return 0 on success, and a
446 negative value on failure.
450 bfd_seek (bfd
*abfd
, file_ptr position
, int direction
)
453 ufile_ptr offset
= 0;
455 while (abfd
->my_archive
!= NULL
456 && !bfd_is_thin_archive (abfd
->my_archive
))
458 offset
+= abfd
->origin
;
459 abfd
= abfd
->my_archive
;
461 offset
+= abfd
->origin
;
463 if (abfd
->iovec
== NULL
)
465 bfd_set_error (bfd_error_invalid_operation
);
469 /* For the time being, a BFD may not seek to it's end. The problem
470 is that we don't easily have a way to recognize the end of an
471 element in an archive. */
472 BFD_ASSERT (direction
== SEEK_SET
|| direction
== SEEK_CUR
);
474 if (direction
!= SEEK_CUR
)
477 if (((direction
== SEEK_CUR
&& position
== 0)
478 || (direction
== SEEK_SET
&& (ufile_ptr
) position
== abfd
->where
))
479 && abfd
->last_io
!= bfd_io_force
)
482 abfd
->last_io
= bfd_io_seek
;
484 result
= abfd
->iovec
->bseek (abfd
, position
, direction
);
487 /* An EINVAL error probably means that the file offset was
490 bfd_set_error (bfd_error_file_truncated
);
492 bfd_set_error (bfd_error_system_call
);
496 /* Adjust `where' field. */
497 if (direction
== SEEK_CUR
)
498 abfd
->where
+= position
;
500 abfd
->where
= position
;
511 long bfd_get_mtime (bfd *abfd);
514 Return the file modification time (as read from the file system, or
515 from the archive header for archive members).
520 bfd_get_mtime (bfd
*abfd
)
527 if (bfd_stat (abfd
, &buf
) != 0)
530 abfd
->mtime
= buf
.st_mtime
; /* Save value in case anyone wants it */
539 ufile_ptr bfd_get_size (bfd *abfd);
542 Return the file size (as read from file system) for the file
543 associated with BFD @var{abfd}.
545 The initial motivation for, and use of, this routine is not
546 so we can get the exact size of the object the BFD applies to, since
547 that might not be generally possible (archive members for example).
548 It would be ideal if someone could eventually modify
549 it so that such results were guaranteed.
551 Instead, we want to ask questions like "is this NNN byte sized
552 object I'm about to try read from file offset YYY reasonable?"
553 As as example of where we might do this, some object formats
554 use string tables for which the first <<sizeof (long)>> bytes of the
555 table contain the size of the table itself, including the size bytes.
556 If an application tries to read what it thinks is one of these
557 string tables, without some way to validate the size, and for
558 some reason the size is wrong (byte swapping error, wrong location
559 for the string table, etc.), the only clue is likely to be a read
560 error when it tries to read the table, or a "virtual memory
561 exhausted" error when it tries to allocate 15 bazillon bytes
562 of space for the 15 bazillon byte table it is about to read.
563 This function at least allows us to answer the question, "is the
566 A return value of zero indicates the file size is unknown.
570 bfd_get_size (bfd
*abfd
)
572 /* A size of 0 means we haven't yet called bfd_stat. A size of 1
573 means we have a cached value of 0, ie. unknown. */
574 if (abfd
->size
<= 1 || bfd_write_p (abfd
))
578 if (abfd
->size
== 1 && !bfd_write_p (abfd
))
581 if (bfd_stat (abfd
, &buf
) != 0
583 || buf
.st_size
- (ufile_ptr
) buf
.st_size
!= 0)
588 abfd
->size
= buf
.st_size
;
598 ufile_ptr bfd_get_file_size (bfd *abfd);
601 Return the file size (as read from file system) for the file
602 associated with BFD @var{abfd}. It supports both normal files
603 and archive elements.
608 bfd_get_file_size (bfd
*abfd
)
610 ufile_ptr file_size
, archive_size
= (ufile_ptr
) -1;
611 unsigned int compression_p2
= 0;
613 if (abfd
->my_archive
!= NULL
614 && !bfd_is_thin_archive (abfd
->my_archive
))
616 struct areltdata
*adata
= (struct areltdata
*) abfd
->arelt_data
;
619 archive_size
= adata
->parsed_size
;
620 /* If the archive is compressed, assume an element won't
621 expand more than eight times file size. */
622 if (adata
->arch_header
!= NULL
623 && memcmp (((struct ar_hdr
*) adata
->arch_header
)->ar_fmag
,
626 abfd
= abfd
->my_archive
;
630 file_size
= bfd_get_size (abfd
) << compression_p2
;
631 if (archive_size
< file_size
)
641 void *bfd_mmap (bfd *abfd, void *addr, bfd_size_type len,
642 int prot, int flags, file_ptr offset,
643 void **map_addr, bfd_size_type *map_len)
644 ATTRIBUTE_WARN_UNUSED_RESULT;
647 Return mmap()ed region of the file, if possible and implemented.
648 LEN and OFFSET do not need to be page aligned. The page aligned
649 address and length are written to MAP_ADDR and MAP_LEN.
654 bfd_mmap (bfd
*abfd
, void *addr
, bfd_size_type len
,
655 int prot
, int flags
, file_ptr offset
,
656 void **map_addr
, bfd_size_type
*map_len
)
658 while (abfd
->my_archive
!= NULL
659 && !bfd_is_thin_archive (abfd
->my_archive
))
661 offset
+= abfd
->origin
;
662 abfd
= abfd
->my_archive
;
664 offset
+= abfd
->origin
;
666 if (abfd
->iovec
== NULL
)
668 bfd_set_error (bfd_error_invalid_operation
);
672 return abfd
->iovec
->bmmap (abfd
, addr
, len
, prot
, flags
, offset
,
676 /* Memory file I/O operations. */
679 memory_bread (bfd
*abfd
, void *ptr
, file_ptr size
)
681 struct bfd_in_memory
*bim
;
684 bim
= (struct bfd_in_memory
*) abfd
->iostream
;
686 if (abfd
->where
+ get
> bim
->size
)
688 if (bim
->size
< (bfd_size_type
) abfd
->where
)
691 get
= bim
->size
- abfd
->where
;
692 bfd_set_error (bfd_error_file_truncated
);
694 memcpy (ptr
, bim
->buffer
+ abfd
->where
, (size_t) get
);
699 memory_bwrite (bfd
*abfd
, const void *ptr
, file_ptr size
)
701 struct bfd_in_memory
*bim
= (struct bfd_in_memory
*) abfd
->iostream
;
703 if (abfd
->where
+ size
> bim
->size
)
705 bfd_size_type newsize
, oldsize
;
707 oldsize
= (bim
->size
+ 127) & ~(bfd_size_type
) 127;
708 bim
->size
= abfd
->where
+ size
;
709 /* Round up to cut down on memory fragmentation */
710 newsize
= (bim
->size
+ 127) & ~(bfd_size_type
) 127;
711 if (newsize
> oldsize
)
713 bim
->buffer
= (bfd_byte
*) bfd_realloc_or_free (bim
->buffer
, newsize
);
714 if (bim
->buffer
== NULL
)
719 if (newsize
> bim
->size
)
720 memset (bim
->buffer
+ bim
->size
, 0, newsize
- bim
->size
);
723 memcpy (bim
->buffer
+ abfd
->where
, ptr
, (size_t) size
);
728 memory_btell (bfd
*abfd
)
734 memory_bseek (bfd
*abfd
, file_ptr position
, int direction
)
737 struct bfd_in_memory
*bim
;
739 bim
= (struct bfd_in_memory
*) abfd
->iostream
;
741 if (direction
== SEEK_SET
)
744 nwhere
= abfd
->where
+ position
;
753 if ((bfd_size_type
)nwhere
> bim
->size
)
755 if (abfd
->direction
== write_direction
756 || abfd
->direction
== both_direction
)
758 bfd_size_type newsize
, oldsize
;
760 oldsize
= (bim
->size
+ 127) & ~(bfd_size_type
) 127;
762 /* Round up to cut down on memory fragmentation */
763 newsize
= (bim
->size
+ 127) & ~(bfd_size_type
) 127;
764 if (newsize
> oldsize
)
766 bim
->buffer
= (bfd_byte
*) bfd_realloc_or_free (bim
->buffer
, newsize
);
767 if (bim
->buffer
== NULL
)
773 memset (bim
->buffer
+ oldsize
, 0, newsize
- oldsize
);
778 abfd
->where
= bim
->size
;
780 bfd_set_error (bfd_error_file_truncated
);
788 memory_bclose (struct bfd
*abfd
)
790 struct bfd_in_memory
*bim
= (struct bfd_in_memory
*) abfd
->iostream
;
794 abfd
->iostream
= NULL
;
800 memory_bflush (bfd
*abfd ATTRIBUTE_UNUSED
)
806 memory_bstat (bfd
*abfd
, struct stat
*statbuf
)
808 struct bfd_in_memory
*bim
= (struct bfd_in_memory
*) abfd
->iostream
;
810 memset (statbuf
, 0, sizeof (*statbuf
));
811 statbuf
->st_size
= bim
->size
;
817 memory_bmmap (bfd
*abfd ATTRIBUTE_UNUSED
, void *addr ATTRIBUTE_UNUSED
,
818 bfd_size_type len ATTRIBUTE_UNUSED
, int prot ATTRIBUTE_UNUSED
,
819 int flags ATTRIBUTE_UNUSED
, file_ptr offset ATTRIBUTE_UNUSED
,
820 void **map_addr ATTRIBUTE_UNUSED
,
821 bfd_size_type
*map_len ATTRIBUTE_UNUSED
)
826 const struct bfd_iovec _bfd_memory_iovec
=
828 &memory_bread
, &memory_bwrite
, &memory_btell
, &memory_bseek
,
829 &memory_bclose
, &memory_bflush
, &memory_bstat
, &memory_bmmap
837 time_t bfd_get_current_time (time_t now);
840 Returns the current time.
842 If the environment variable SOURCE_DATE_EPOCH is defined
843 then this is parsed and its value is returned. Otherwise
844 if the paramter NOW is non-zero, then that is returned.
845 Otherwise the result of the system call "time(NULL)" is
850 bfd_get_current_time (time_t now
)
852 char *source_date_epoch
;
853 unsigned long long epoch
;
855 /* FIXME: We could probably cache this lookup,
856 and the parsing of its value below. */
857 source_date_epoch
= getenv ("SOURCE_DATE_EPOCH");
859 if (source_date_epoch
== NULL
)
866 epoch
= strtoull (source_date_epoch
, NULL
, 0);
868 /* If epoch == 0 then something is wrong with SOURCE_DATE_EPOCH,
869 but we do not have an easy way to report it. Since the presence
870 of the environment variable implies that the user wants
871 deterministic behaviour we just accept the 0 value. */
873 return (time_t) epoch
;