Automatic date update in version.in
[binutils-gdb.git] / bfd / pdb.c
blob340cda667a2398d3d23eb9ab0488e99ef01c0e86
1 /* BFD back-end for PDB Multi-Stream Format archives.
2 Copyright (C) 2022-2024 Free Software Foundation, Inc.
4 This file is part of BFD, the Binary File Descriptor library.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program 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
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
19 MA 02110-1301, USA. */
21 /* This describes the MSF file archive format, which is used for the
22 PDB debug info generated by MSVC. See https://llvm.org/docs/PDB/MsfFile.html
23 for a full description of the format. */
25 #include "sysdep.h"
26 #include "bfd.h"
27 #include "libbfd.h"
29 /* "Microsoft C/C++ MSF 7.00\r\n\x1a\x44\x53\0\0\0" */
30 static const uint8_t pdb_magic[] =
31 { 0x4d, 0x69, 0x63, 0x72, 0x6f, 0x73, 0x6f, 0x66,
32 0x74, 0x20, 0x43, 0x2f, 0x43, 0x2b, 0x2b, 0x20,
33 0x4d, 0x53, 0x46, 0x20, 0x37, 0x2e, 0x30, 0x30,
34 0x0d, 0x0a, 0x1a, 0x44, 0x53, 0x00, 0x00, 0x00 };
36 #define arch_eltdata(bfd) ((struct areltdata *) ((bfd)->arelt_data))
38 static bfd_cleanup
39 pdb_archive_p (bfd *abfd)
41 int ret;
42 char magic[sizeof (pdb_magic)];
44 ret = bfd_read (magic, sizeof (magic), abfd);
45 if (ret != sizeof (magic))
47 bfd_set_error (bfd_error_wrong_format);
48 return NULL;
51 if (memcmp (magic, pdb_magic, sizeof (magic)))
53 bfd_set_error (bfd_error_wrong_format);
54 return NULL;
57 void *tdata = bfd_zalloc (abfd, sizeof (struct artdata));
58 if (tdata == NULL)
59 return NULL;
60 bfd_ardata (abfd) = tdata;
62 return _bfd_no_cleanup;
65 static bfd *
66 pdb_get_elt_at_index (bfd *abfd, symindex sym_index)
68 char int_buf[sizeof (uint32_t)];
69 uint32_t block_size, block_map_addr, block, num_files;
70 uint32_t first_dir_block, dir_offset, file_size, block_off, left;
71 char name[10];
72 bfd *file;
73 char *buf;
75 /* Get block_size. */
77 if (bfd_seek (abfd, sizeof (pdb_magic), SEEK_SET))
78 return NULL;
80 if (bfd_read (int_buf, sizeof (uint32_t), abfd) != sizeof (uint32_t))
82 bfd_set_error (bfd_error_malformed_archive);
83 return NULL;
86 block_size = bfd_getl32 (int_buf);
87 if ((block_size & -block_size) != block_size
88 || block_size < 512
89 || block_size > 4096)
91 bfd_set_error (bfd_error_malformed_archive);
92 return NULL;
95 /* Get block_map_addr. */
97 if (bfd_seek (abfd, 4 * sizeof (uint32_t), SEEK_CUR))
98 return NULL;
100 if (bfd_read (int_buf, sizeof (uint32_t), abfd) != sizeof (uint32_t))
102 bfd_set_error (bfd_error_malformed_archive);
103 return NULL;
106 block_map_addr = bfd_getl32 (int_buf);
108 /* Get num_files. */
110 if (bfd_seek (abfd, block_map_addr * block_size, SEEK_SET))
111 return NULL;
113 if (bfd_read (int_buf, sizeof (uint32_t), abfd) != sizeof (uint32_t))
115 bfd_set_error (bfd_error_malformed_archive);
116 return NULL;
119 first_dir_block = bfd_getl32 (int_buf);
121 if (bfd_seek (abfd, first_dir_block * block_size, SEEK_SET))
122 return NULL;
124 if (bfd_read (int_buf, sizeof (uint32_t), abfd) != sizeof (uint32_t))
126 bfd_set_error (bfd_error_malformed_archive);
127 return NULL;
130 num_files = bfd_getl32 (int_buf);
132 if (sym_index >= num_files)
134 bfd_set_error (bfd_error_no_more_archived_files);
135 return NULL;
138 /* Read file size. */
140 dir_offset = sizeof (uint32_t) * (sym_index + 1);
142 if (dir_offset >= block_size)
144 uint32_t block_map_addr_off;
146 block_map_addr_off = ((dir_offset / block_size) * sizeof (uint32_t));
148 if (bfd_seek (abfd, (block_map_addr * block_size) + block_map_addr_off,
149 SEEK_SET))
150 return NULL;
152 if (bfd_read (int_buf, sizeof (uint32_t), abfd) != sizeof (uint32_t))
154 bfd_set_error (bfd_error_malformed_archive);
155 return NULL;
158 block = bfd_getl32 (int_buf);
160 else
162 block = first_dir_block;
165 if (bfd_seek (abfd, (block * block_size) + (dir_offset % block_size),
166 SEEK_SET))
167 return NULL;
169 if (bfd_read (int_buf, sizeof (uint32_t), abfd) != sizeof (uint32_t))
171 bfd_set_error (bfd_error_malformed_archive);
172 return NULL;
175 file_size = bfd_getl32 (int_buf);
177 /* Undocumented? Seen on PDBs created by MSVC 2022. */
178 if (file_size == 0xffffffff)
179 file_size = 0;
181 /* Create BFD. */
183 /* Four hex digits is enough - even though MSF allows for 32 bits, the
184 PDB format itself only uses 16 bits for stream numbers. */
185 sprintf (name, "%04lx", sym_index);
187 file = bfd_create (name, abfd);
189 if (!file)
190 return NULL;
192 if (!bfd_make_writable (file))
193 goto fail;
195 file->arelt_data =
196 (struct areltdata *) bfd_zmalloc (sizeof (struct areltdata));
198 if (!file->arelt_data)
199 goto fail;
201 arch_eltdata (file)->parsed_size = file_size;
202 arch_eltdata (file)->key = sym_index;
204 if (file_size == 0)
205 return file;
207 block_off = 0;
209 /* Sum number of blocks in previous files. */
211 if (sym_index != 0)
213 dir_offset = sizeof (uint32_t);
215 if (bfd_seek (abfd, (first_dir_block * block_size) + sizeof (uint32_t),
216 SEEK_SET))
217 goto fail;
219 for (symindex i = 0; i < sym_index; i++)
221 uint32_t size, num_blocks;
223 if ((dir_offset % block_size) == 0)
225 uint32_t block_map_addr_off;
227 block_map_addr_off =
228 ((dir_offset / block_size) * sizeof (uint32_t));
230 if (bfd_seek
231 (abfd, (block_map_addr * block_size) + block_map_addr_off,
232 SEEK_SET))
233 goto fail;
235 if (bfd_read (int_buf, sizeof (uint32_t), abfd) !=
236 sizeof (uint32_t))
238 bfd_set_error (bfd_error_malformed_archive);
239 goto fail;
242 block = bfd_getl32 (int_buf);
244 if (bfd_seek (abfd, block * block_size, SEEK_SET))
245 goto fail;
248 if (bfd_read (int_buf, sizeof (uint32_t), abfd) !=
249 sizeof (uint32_t))
251 bfd_set_error (bfd_error_malformed_archive);
252 goto fail;
255 size = bfd_getl32 (int_buf);
257 if (size == 0xffffffff)
258 size = 0;
260 num_blocks = (size + block_size - 1) / block_size;
261 block_off += num_blocks;
263 dir_offset += sizeof (uint32_t);
267 /* Read blocks, and write into new BFD. */
269 dir_offset = sizeof (uint32_t) * (num_files + block_off + 1);
271 if (dir_offset >= block_size)
273 uint32_t block_map_addr_off;
275 block_map_addr_off = ((dir_offset / block_size) * sizeof (uint32_t));
277 if (bfd_seek (abfd, (block_map_addr * block_size) + block_map_addr_off,
278 SEEK_SET))
279 goto fail;
281 if (bfd_read (int_buf, sizeof (uint32_t), abfd) != sizeof (uint32_t))
283 bfd_set_error (bfd_error_malformed_archive);
284 goto fail;
287 block = bfd_getl32 (int_buf);
289 else
291 block = first_dir_block;
294 buf = bfd_malloc (block_size);
295 if (!buf)
296 goto fail;
298 left = file_size;
301 uint32_t file_block, to_read;
303 if ((dir_offset % block_size) == 0 && left != file_size)
305 uint32_t block_map_addr_off;
307 block_map_addr_off =
308 ((dir_offset / block_size) * sizeof (uint32_t));
310 if (bfd_seek
311 (abfd, (block_map_addr * block_size) + block_map_addr_off,
312 SEEK_SET))
313 goto fail2;
315 if (bfd_read (int_buf, sizeof (uint32_t), abfd) !=
316 sizeof (uint32_t))
318 bfd_set_error (bfd_error_malformed_archive);
319 goto fail2;
322 block = bfd_getl32 (int_buf);
325 if (bfd_seek (abfd, (block * block_size) + (dir_offset % block_size),
326 SEEK_SET))
327 goto fail2;
329 if (bfd_read (int_buf, sizeof (uint32_t), abfd) != sizeof (uint32_t))
331 bfd_set_error (bfd_error_malformed_archive);
332 goto fail2;
335 file_block = bfd_getl32 (int_buf);
337 if (bfd_seek (abfd, file_block * block_size, SEEK_SET))
338 goto fail2;
340 to_read = left > block_size ? block_size : left;
342 if (bfd_read (buf, to_read, abfd) != to_read)
344 bfd_set_error (bfd_error_malformed_archive);
345 goto fail2;
348 if (bfd_write (buf, to_read, file) != to_read)
349 goto fail2;
351 if (left > block_size)
352 left -= block_size;
353 else
354 break;
356 dir_offset += sizeof (uint32_t);
358 while (left > 0);
360 free (buf);
362 return file;
364 fail2:
365 free (buf);
367 fail:
368 bfd_close (file);
369 return NULL;
372 static bfd *
373 pdb_openr_next_archived_file (bfd *archive, bfd *last_file)
375 if (!last_file)
376 return pdb_get_elt_at_index (archive, 0);
377 else
378 return pdb_get_elt_at_index (archive, arch_eltdata (last_file)->key + 1);
381 static int
382 pdb_generic_stat_arch_elt (bfd *abfd, struct stat *buf)
384 buf->st_mtime = 0;
385 buf->st_uid = 0;
386 buf->st_gid = 0;
387 buf->st_mode = 0644;
388 buf->st_size = arch_eltdata (abfd)->parsed_size;
390 return 0;
393 static uint32_t
394 pdb_allocate_block (uint32_t *num_blocks, uint32_t block_size)
396 uint32_t block;
398 block = *num_blocks;
400 (*num_blocks)++;
402 /* If new interval, skip two blocks for free space map. */
404 if ((block % block_size) == 1)
406 block += 2;
407 (*num_blocks) += 2;
410 return block;
413 static bool
414 pdb_write_directory (bfd *abfd, uint32_t block_size, uint32_t num_files,
415 uint32_t block_map_addr, uint32_t * num_blocks,
416 uint32_t *stream0_start)
418 char tmp[sizeof (uint32_t)];
419 uint32_t block, left, block_map_off;
420 bfd *arelt;
421 char *buf;
423 /* Allocate first block for directory. */
425 block = pdb_allocate_block (num_blocks, block_size);
426 left = block_size;
428 /* Write allocated block no. at beginning of block map. */
430 if (bfd_seek (abfd, block_map_addr * block_size, SEEK_SET))
431 return false;
433 bfd_putl32 (block, tmp);
435 if (bfd_write (tmp, sizeof (uint32_t), abfd) != sizeof (uint32_t))
436 return false;
438 block_map_off = sizeof (uint32_t);
440 /* Write num_files at beginning of directory. */
442 if (bfd_seek (abfd, block * block_size, SEEK_SET))
443 return false;
445 bfd_putl32 (num_files, tmp);
447 if (bfd_write (tmp, sizeof (uint32_t), abfd) != sizeof (uint32_t))
448 return false;
450 left -= sizeof (uint32_t);
452 /* Write file sizes. */
454 arelt = abfd->archive_head;
455 while (arelt)
457 if (left == 0)
459 if (block_map_off == block_size) /* Too many blocks. */
461 bfd_set_error (bfd_error_invalid_operation);
462 return false;
465 block = pdb_allocate_block (num_blocks, block_size);
466 left = block_size;
468 if (bfd_seek
469 (abfd, (block_map_addr * block_size) + block_map_off, SEEK_SET))
470 return false;
472 bfd_putl32 (block, tmp);
474 if (bfd_write (tmp, sizeof (uint32_t), abfd) != sizeof (uint32_t))
475 return false;
477 block_map_off += sizeof (uint32_t);
479 if (bfd_seek (abfd, block * block_size, SEEK_SET))
480 return false;
483 bfd_putl32 (bfd_get_size (arelt), tmp);
485 if (bfd_write (tmp, sizeof (uint32_t), abfd) != sizeof (uint32_t))
486 return false;
488 left -= sizeof (uint32_t);
490 arelt = arelt->archive_next;
493 /* Write blocks. */
495 buf = bfd_malloc (block_size);
496 if (!buf)
497 return false;
499 arelt = abfd->archive_head;
500 while (arelt)
502 ufile_ptr size = bfd_get_size (arelt);
503 uint32_t req_blocks = (size + block_size - 1) / block_size;
505 if (bfd_seek (arelt, 0, SEEK_SET))
507 free (buf);
508 return false;
511 for (uint32_t i = 0; i < req_blocks; i++)
513 uint32_t file_block, to_read;
515 if (left == 0)
517 if (block_map_off == block_size) /* Too many blocks. */
519 bfd_set_error (bfd_error_invalid_operation);
520 free (buf);
521 return false;
524 block = pdb_allocate_block (num_blocks, block_size);
525 left = block_size;
527 if (bfd_seek
528 (abfd, (block_map_addr * block_size) + block_map_off,
529 SEEK_SET))
531 free (buf);
532 return false;
535 bfd_putl32 (block, tmp);
537 if (bfd_write (tmp, sizeof (uint32_t), abfd) !=
538 sizeof (uint32_t))
540 free (buf);
541 return false;
544 block_map_off += sizeof (uint32_t);
546 if (bfd_seek (abfd, block * block_size, SEEK_SET))
548 free (buf);
549 return false;
553 /* Allocate block and write number into directory. */
555 file_block = pdb_allocate_block (num_blocks, block_size);
557 bfd_putl32 (file_block, tmp);
559 if (bfd_write (tmp, sizeof (uint32_t), abfd) != sizeof (uint32_t))
561 free (buf);
562 return false;
565 if (arelt == abfd->archive_head && i == 0)
566 *stream0_start = file_block;
568 left -= sizeof (uint32_t);
570 /* Read file contents into buffer. */
572 to_read = size > block_size ? block_size : size;
574 if (bfd_read (buf, to_read, arelt) != to_read)
576 free (buf);
577 return false;
580 size -= to_read;
582 if (to_read < block_size)
583 memset (buf + to_read, 0, block_size - to_read);
585 if (bfd_seek (abfd, file_block * block_size, SEEK_SET))
587 free (buf);
588 return false;
591 /* Write file contents into allocated block. */
593 if (bfd_write (buf, block_size, abfd) != block_size)
595 free (buf);
596 return false;
599 if (bfd_seek
600 (abfd, (block * block_size) + block_size - left, SEEK_SET))
602 free (buf);
603 return false;
607 arelt = arelt->archive_next;
610 memset (buf, 0, left);
612 if (bfd_write (buf, left, abfd) != left)
614 free (buf);
615 return false;
618 free (buf);
620 return true;
623 static bool
624 pdb_write_bitmap (bfd *abfd, uint32_t block_size, uint32_t num_blocks,
625 uint32_t stream0_start)
627 char *buf;
628 uint32_t num_intervals = (num_blocks + block_size - 1) / block_size;
630 buf = bfd_malloc (block_size);
631 if (!buf)
632 return false;
634 for (uint32_t i = 0; i < num_intervals; i++)
636 if (bfd_seek (abfd, ((i * block_size) + 1) * block_size, SEEK_SET))
638 free (buf);
639 return false;
642 /* All of our blocks are contiguous, making our free block map
643 relatively simple. 0 = used, 1 = free. */
645 if (num_blocks >= 8)
646 memset (buf, 0,
647 (num_blocks / 8) >
648 block_size ? block_size : (num_blocks / 8));
650 if (num_blocks < block_size * 8)
652 unsigned int off = num_blocks / 8;
654 if (num_blocks % 8)
656 buf[off] = 256 - (1 << (num_blocks % 8));
657 off++;
660 if (off < block_size)
661 memset (buf + off, 0xff, block_size - off);
664 /* Mark the blocks allocated to stream 0 as free. This is because stream
665 0 is intended to be used for the previous MSF directory, to allow
666 atomic updates. This doesn't apply to us, as we rewrite the whole
667 file whenever any change is made. */
669 if (i == 0 && abfd->archive_head)
671 bfd *arelt = abfd->archive_head;
672 uint32_t stream0_blocks =
673 (bfd_get_size (arelt) + block_size - 1) / block_size;
675 if (stream0_start % 8)
677 unsigned int high_bit;
679 high_bit = (stream0_start % 8) + stream0_blocks;
680 if (high_bit > 8)
681 high_bit = 8;
683 buf[stream0_start / 8] |=
684 (1 << high_bit) - (1 << (stream0_start % 8));
686 stream0_blocks -= high_bit - (stream0_start % 8);
687 stream0_start += high_bit - (stream0_start % 8);
690 memset (buf + (stream0_start / 8), 0xff, stream0_blocks / 8);
691 stream0_start += stream0_blocks / 8;
692 stream0_blocks %= 8;
694 if (stream0_blocks > 0)
695 buf[stream0_start / 8] |= (1 << stream0_blocks) - 1;
698 if (num_blocks < block_size * 8)
699 num_blocks = 0;
700 else
701 num_blocks -= block_size * 8;
703 if (bfd_write (buf, block_size, abfd) != block_size)
704 return false;
707 free (buf);
709 return true;
712 static bool
713 pdb_write_contents (bfd *abfd)
715 char tmp[sizeof (uint32_t)];
716 const uint32_t block_size = 0x400;
717 uint32_t block_map_addr;
718 uint32_t num_blocks;
719 uint32_t num_files = 0;
720 uint32_t num_directory_bytes = sizeof (uint32_t);
721 uint32_t stream0_start = 0;
722 bfd *arelt;
724 if (bfd_write (pdb_magic, sizeof (pdb_magic), abfd) != sizeof (pdb_magic))
725 return false;
727 bfd_putl32 (block_size, tmp);
729 if (bfd_write (tmp, sizeof (uint32_t), abfd) != sizeof (uint32_t))
730 return false;
732 bfd_putl32 (1, tmp); /* Free block map block (always either 1 or 2). */
734 if (bfd_write (tmp, sizeof (uint32_t), abfd) != sizeof (uint32_t))
735 return false;
737 arelt = abfd->archive_head;
739 while (arelt)
741 uint32_t blocks_required =
742 (bfd_get_size (arelt) + block_size - 1) / block_size;
744 num_directory_bytes += sizeof (uint32_t); /* Size. */
745 num_directory_bytes += blocks_required * sizeof (uint32_t); /* Blocks. */
747 num_files++;
749 arelt = arelt->archive_next;
752 /* Superblock plus two bitmap blocks. */
753 num_blocks = 3;
755 /* Skip num_blocks for now. */
756 if (bfd_seek (abfd, sizeof (uint32_t), SEEK_CUR))
757 return false;
759 bfd_putl32 (num_directory_bytes, tmp);
761 if (bfd_write (tmp, sizeof (uint32_t), abfd) != sizeof (uint32_t))
762 return false;
764 /* Skip unknown uint32_t (always 0?). */
765 if (bfd_seek (abfd, sizeof (uint32_t), SEEK_CUR))
766 return false;
768 block_map_addr = pdb_allocate_block (&num_blocks, block_size);
770 bfd_putl32 (block_map_addr, tmp);
772 if (bfd_write (tmp, sizeof (uint32_t), abfd) != sizeof (uint32_t))
773 return false;
775 if (!pdb_write_directory
776 (abfd, block_size, num_files, block_map_addr, &num_blocks,
777 &stream0_start))
778 return false;
780 if (!pdb_write_bitmap (abfd, block_size, num_blocks, stream0_start))
781 return false;
783 /* Write num_blocks now we know it. */
785 if (bfd_seek
786 (abfd, sizeof (pdb_magic) + sizeof (uint32_t) + sizeof (uint32_t),
787 SEEK_SET))
788 return false;
790 bfd_putl32 (num_blocks, tmp);
792 if (bfd_write (tmp, sizeof (uint32_t), abfd) != sizeof (uint32_t))
793 return false;
795 return true;
798 #define pdb_bfd_free_cached_info _bfd_generic_bfd_free_cached_info
799 #define pdb_new_section_hook _bfd_generic_new_section_hook
800 #define pdb_get_section_contents _bfd_generic_get_section_contents
801 #define pdb_close_and_cleanup _bfd_generic_close_and_cleanup
803 #define pdb_slurp_armap _bfd_noarchive_slurp_armap
804 #define pdb_slurp_extended_name_table _bfd_noarchive_slurp_extended_name_table
805 #define pdb_construct_extended_name_table _bfd_noarchive_construct_extended_name_table
806 #define pdb_truncate_arname _bfd_noarchive_truncate_arname
807 #define pdb_write_armap _bfd_noarchive_write_armap
808 #define pdb_read_ar_hdr _bfd_noarchive_read_ar_hdr
809 #define pdb_write_ar_hdr _bfd_noarchive_write_ar_hdr
810 #define pdb_update_armap_timestamp _bfd_noarchive_update_armap_timestamp
812 const bfd_target pdb_vec =
814 "pdb",
815 bfd_target_unknown_flavour,
816 BFD_ENDIAN_LITTLE, /* target byte order */
817 BFD_ENDIAN_LITTLE, /* target headers byte order */
818 0, /* object flags */
819 0, /* section flags */
820 0, /* leading underscore */
821 ' ', /* ar_pad_char */
822 16, /* ar_max_namelen */
823 0, /* match priority. */
824 TARGET_KEEP_UNUSED_SECTION_SYMBOLS, /* keep unused section symbols. */
825 bfd_getl64, bfd_getl_signed_64, bfd_putl64,
826 bfd_getl32, bfd_getl_signed_32, bfd_putl32,
827 bfd_getl16, bfd_getl_signed_16, bfd_putl16, /* Data. */
828 bfd_getl64, bfd_getl_signed_64, bfd_putl64,
829 bfd_getl32, bfd_getl_signed_32, bfd_putl32,
830 bfd_getl16, bfd_getl_signed_16, bfd_putl16, /* Hdrs. */
832 { /* bfd_check_format */
833 _bfd_dummy_target,
834 _bfd_dummy_target,
835 pdb_archive_p,
836 _bfd_dummy_target
838 { /* bfd_set_format */
839 _bfd_bool_bfd_false_error,
840 _bfd_bool_bfd_false_error,
841 _bfd_bool_bfd_true,
842 _bfd_bool_bfd_false_error
844 { /* bfd_write_contents */
845 _bfd_bool_bfd_true,
846 _bfd_bool_bfd_false_error,
847 pdb_write_contents,
848 _bfd_bool_bfd_false_error
851 BFD_JUMP_TABLE_GENERIC (pdb),
852 BFD_JUMP_TABLE_COPY (_bfd_generic),
853 BFD_JUMP_TABLE_CORE (_bfd_nocore),
854 BFD_JUMP_TABLE_ARCHIVE (pdb),
855 BFD_JUMP_TABLE_SYMBOLS (_bfd_nosymbols),
856 BFD_JUMP_TABLE_RELOCS (_bfd_norelocs),
857 BFD_JUMP_TABLE_WRITE (_bfd_generic),
858 BFD_JUMP_TABLE_LINK (_bfd_nolink),
859 BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic),
861 NULL,
863 NULL