Merge commit 'upstream/2.20'

[msp430-binutils.git] / bfd / doc / bfdio.texi

diff --git a/bfd/doc/bfdio.texi b/bfd/doc/bfdio.texi
index 7a7fe3c48de9fbfcf02c69e1425ac97a91e58a50..9b4952fa956d95c964f77cdfb3830189879182ff 100644 (file)
--- a/bfd/doc/bfdio.texi
+++ b/bfd/doc/bfdio.texi
@@ -26,6 +26,9 @@ struct bfd_iovec
   int (*bclose) (struct bfd *abfd);
   int (*bflush) (struct bfd *abfd);
   int (*bstat) (struct bfd *abfd, struct stat *sb);
+  /* Just like mmap: (void*)-1 on failure, mmapped address on success.  */
+  void *(*bmmap) (struct bfd *abfd, void *addr, bfd_size_type len,
+                  int prot, int flags, file_ptr offset);
 @};
 @end example
 
@@ -70,3 +73,13 @@ of space for the 15 bazillon byte table it is about to read.
 This function at least allows us to answer the question, "is the
 size reasonable?".
 
+@findex bfd_mmap
+@subsubsection @code{bfd_mmap}
+@strong{Synopsis}
+@example
+void *bfd_mmap (bfd *abfd, void *addr, bfd_size_type len,
+    int prot, int flags, file_ptr offset);
+@end example
+@strong{Description}@*
+Return mmap()ed region of the file, if possible and implemented.
+