2 Copyright (C) 2019 Free Software Foundation, Inc.
4 This file is part of libctf.
6 libctf is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
11 This program is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14 See the 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; see the file COPYING. If not see
18 <http://www.gnu.org/licenses/>. */
21 #include <sys/types.h>
24 #include "ctf-endian.h"
35 static off_t
arc_write_one_ctf (ctf_file_t
* f
, int fd
, size_t threshold
);
36 static ctf_file_t
*ctf_arc_open_by_offset (const struct ctf_archive
*arc
,
37 const ctf_sect_t
*symsect
,
38 const ctf_sect_t
*strsect
,
39 size_t offset
, int *errp
);
40 static int sort_modent_by_name (const void *one
, const void *two
, void *n
);
41 static void *arc_mmap_header (int fd
, size_t headersz
);
42 static void *arc_mmap_file (int fd
, size_t size
);
43 static int arc_mmap_writeout (int fd
, void *header
, size_t headersz
,
45 static int arc_mmap_unmap (void *header
, size_t headersz
, const char **errmsg
);
47 /* bsearch() internal state. */
48 static __thread
char *search_nametbl
;
50 /* Write out a CTF archive to the start of the file referenced by the passed-in
51 fd. The entries in CTF_FILES are referenced by name: the names are passed in
52 the names array, which must have CTF_FILES entries.
54 Returns 0 on success, or an errno, or an ECTF_* value. */
56 ctf_arc_write_fd (int fd
, ctf_file_t
**ctf_files
, size_t ctf_file_cnt
,
57 const char **names
, size_t threshold
)
60 struct ctf_archive
*archdr
;
65 size_t ctf_startoffs
; /* Start of the section we are working over. */
66 char *nametbl
= NULL
; /* The name table. */
69 struct ctf_archive_modent
*modent
;
71 ctf_dprintf ("Writing CTF archive with %lu files\n",
72 (unsigned long) ctf_file_cnt
);
74 /* Figure out the size of the mmap()ed header, including the
75 ctf_archive_modent array. We assume that all of this needs no
76 padding: a likely assumption, given that it's all made up of
78 headersz
= sizeof (struct ctf_archive
)
79 + (ctf_file_cnt
* sizeof (uint64_t) * 2);
80 ctf_dprintf ("headersz is %lu\n", (unsigned long) headersz
);
82 /* From now on we work in two pieces: an mmap()ed region from zero up to the
83 headersz, and a region updated via write() starting after that, containing
84 all the tables. Platforms that do not support mmap() just use write(). */
85 ctf_startoffs
= headersz
;
86 if (lseek (fd
, ctf_startoffs
- 1, SEEK_SET
) < 0)
88 errmsg
= "ctf_arc_write(): cannot extend file while writing: %s\n";
92 if (write (fd
, &dummy
, 1) < 0)
94 errmsg
= "ctf_arc_write(): cannot extend file while writing: %s\n";
98 if ((archdr
= arc_mmap_header (fd
, headersz
)) == NULL
)
100 errmsg
= "ctf_arc_write(): Cannot mmap(): %s\n";
104 /* Fill in everything we can, which is everything other than the name
106 archdr
->ctfa_magic
= htole64 (CTFA_MAGIC
);
107 archdr
->ctfa_nfiles
= htole64 (ctf_file_cnt
);
108 archdr
->ctfa_ctfs
= htole64 (ctf_startoffs
);
110 /* We could validate that all CTF files have the same data model, but
111 since any reasonable construction process will be building things of
112 only one bitness anyway, this is pretty pointless, so just use the
113 model of the first CTF file for all of them. (It *is* valid to
114 create an empty archive: the value of ctfa_model is irrelevant in
115 this case, but we must be sure not to dereference uninitialized
118 if (ctf_file_cnt
> 0)
119 archdr
->ctfa_model
= htole64 (ctf_getmodel (ctf_files
[0]));
121 /* Now write out the CTFs: ctf_archive_modent array via the mapping,
122 ctfs via write(). The names themselves have not been written yet: we
123 track them in a local strtab until the time is right, and sort the
124 modents array after construction.
126 The name table is not sorted. */
128 for (i
= 0, namesz
= 0; i
< le64toh (archdr
->ctfa_nfiles
); i
++)
129 namesz
+= strlen (names
[i
]) + 1;
131 nametbl
= malloc (namesz
);
134 errmsg
= "Error writing named CTF to archive: %s\n";
138 for (i
= 0, namesz
= 0,
139 modent
= (ctf_archive_modent_t
*) ((char *) archdr
140 + sizeof (struct ctf_archive
));
141 i
< le64toh (archdr
->ctfa_nfiles
); i
++)
145 strcpy (&nametbl
[namesz
], names
[i
]);
147 off
= arc_write_one_ctf (ctf_files
[i
], fd
, threshold
);
148 if ((off
< 0) && (off
> -ECTF_BASE
))
150 errmsg
= "ctf_arc_write(): Cannot determine file "
151 "position while writing to archive: %s";
156 errmsg
= "ctf_arc_write(): Cannot write CTF file to archive: %s\n";
161 modent
->name_offset
= htole64 (namesz
);
162 modent
->ctf_offset
= htole64 (off
- ctf_startoffs
);
163 namesz
+= strlen (names
[i
]) + 1;
167 ctf_qsort_r ((ctf_archive_modent_t
*) ((char *) archdr
168 + sizeof (struct ctf_archive
)),
169 le64toh (archdr
->ctfa_nfiles
),
170 sizeof (struct ctf_archive_modent
), sort_modent_by_name
,
173 /* Now the name table. */
175 if ((nameoffs
= lseek (fd
, 0, SEEK_CUR
)) < 0)
177 errmsg
= "ctf_arc_write(): Cannot get current file position "
181 archdr
->ctfa_names
= htole64 (nameoffs
);
186 if ((len
= write (fd
, np
, namesz
)) < 0)
188 errmsg
= "ctf_arc_write(): Cannot write name table to archive: %s\n";
196 if (arc_mmap_writeout (fd
, archdr
, headersz
, &errmsg
) < 0)
198 if (arc_mmap_unmap (archdr
, headersz
, &errmsg
) < 0)
205 arc_mmap_unmap (archdr
, headersz
, NULL
);
207 ctf_dprintf (errmsg
, errno
< ECTF_BASE
? strerror (errno
) :
212 /* Write out a CTF archive. The entries in CTF_FILES are referenced by name:
213 the names are passed in the names array, which must have CTF_FILES entries.
215 If the filename is NULL, create a temporary file and return a pointer to it.
217 Returns 0 on success, or an errno, or an ECTF_* value. */
219 ctf_arc_write (const char *file
, ctf_file_t
** ctf_files
, size_t ctf_file_cnt
,
220 const char **names
, size_t threshold
)
225 if ((fd
= open (file
, O_RDWR
| O_CREAT
| O_TRUNC
| O_CLOEXEC
, 0666)) < 0)
227 ctf_dprintf ("ctf_arc_write(): cannot create %s: %s\n", file
,
232 err
= ctf_arc_write_fd (fd
, ctf_files
, ctf_file_cnt
, names
, threshold
);
236 if ((err
= close (fd
)) < 0)
238 ctf_dprintf ("ctf_arc_write(): Cannot close after writing to archive: "
239 "%s\n", strerror (errno
));
257 /* Write one CTF file out. Return the file position of the written file (or
258 rather, of the file-size uint64_t that precedes it): negative return is a
259 negative errno or ctf_errno value. On error, the file position may no longer
260 be at the end of the file. */
262 arc_write_one_ctf (ctf_file_t
* f
, int fd
, size_t threshold
)
268 int (*writefn
) (ctf_file_t
* fp
, int fd
);
270 if ((off
= lseek (fd
, 0, SEEK_CUR
)) < 0)
273 if (f
->ctf_size
> threshold
)
274 writefn
= ctf_compress_write
;
278 /* This zero-write turns into the size in a moment. */
279 ctfsz_len
= sizeof (ctfsz
);
280 ctfszp
= (char *) &ctfsz
;
281 while (ctfsz_len
> 0)
283 ssize_t writelen
= write (fd
, ctfszp
, ctfsz_len
);
286 ctfsz_len
-= writelen
;
290 if (writefn (f
, fd
) != 0)
291 return f
->ctf_errno
* -1;
293 if ((end_off
= lseek (fd
, 0, SEEK_CUR
)) < 0)
295 ctfsz
= htole64 (end_off
- off
);
297 if ((lseek (fd
, off
, SEEK_SET
)) < 0)
301 ctfsz_len
= sizeof (ctfsz
);
302 ctfszp
= (char *) &ctfsz
;
303 while (ctfsz_len
> 0)
305 ssize_t writelen
= write (fd
, ctfszp
, ctfsz_len
);
308 ctfsz_len
-= writelen
;
312 end_off
= LCTF_ALIGN_OFFS (end_off
, 8);
313 if ((lseek (fd
, end_off
, SEEK_SET
)) < 0)
319 /* qsort() function to sort the array of struct ctf_archive_modents into
320 ascending name order. */
322 sort_modent_by_name (const void *one
, const void *two
, void *n
)
324 const struct ctf_archive_modent
*a
= one
;
325 const struct ctf_archive_modent
*b
= two
;
328 return strcmp (&nametbl
[le64toh (a
->name_offset
)],
329 &nametbl
[le64toh (b
->name_offset
)]);
332 /* bsearch() function to search for a given name in the sorted array of struct
333 ctf_archive_modents. */
335 search_modent_by_name (const void *key
, const void *ent
)
338 const struct ctf_archive_modent
*v
= ent
;
340 return strcmp (k
, &search_nametbl
[le64toh (v
->name_offset
)]);
343 /* A trivial wrapper: open a CTF archive, from data in a buffer (which the
344 caller must preserve until ctf_arc_close() time). Returns the archive, or
345 NULL and an error in *err (if not NULL). */
347 ctf_arc_bufopen (const void *buf
, size_t size _libctf_unused_
, int *errp
)
349 struct ctf_archive
*arc
= (struct ctf_archive
*) buf
;
351 if (le64toh (arc
->ctfa_magic
) != CTFA_MAGIC
)
360 /* Open a CTF archive. Returns the archive, or NULL and an error in *err (if
363 ctf_arc_open_internal (const char *filename
, int *errp
)
368 struct ctf_archive
*arc
; /* (Actually the whole file.) */
371 if ((fd
= open (filename
, O_RDONLY
)) < 0)
373 errmsg
= "ctf_arc_open(): cannot open %s: %s\n";
376 if (fstat (fd
, &s
) < 0)
378 errmsg
= "ctf_arc_open(): cannot stat %s: %s\n";
382 if ((arc
= arc_mmap_file (fd
, s
.st_size
)) == NULL
)
384 errmsg
= "ctf_arc_open(): Cannot read in %s: %s\n";
388 if (le64toh (arc
->ctfa_magic
) != CTFA_MAGIC
)
390 errmsg
= "ctf_arc_open(): Invalid magic number";
395 /* This horrible hack lets us know how much to unmap when the file is
396 closed. (We no longer need the magic number, and the mapping
398 arc
->ctfa_magic
= s
.st_size
;
403 arc_mmap_unmap (arc
, s
.st_size
, NULL
);
409 ctf_dprintf (errmsg
, filename
, errno
< ECTF_BASE
? strerror (errno
) :
414 /* Close an archive. */
416 ctf_arc_close_internal (struct ctf_archive
*arc
)
421 /* See the comment in ctf_arc_open(). */
422 arc_mmap_unmap (arc
, arc
->ctfa_magic
, NULL
);
425 /* Public entry point: close an archive, or CTF file. */
427 ctf_arc_close (ctf_archive_t
*arc
)
432 if (arc
->ctfi_is_archive
)
433 ctf_arc_close_internal (arc
->ctfi_archive
);
435 ctf_file_close (arc
->ctfi_file
);
436 free ((void *) arc
->ctfi_symsect
.cts_data
);
437 /* Do not free the ctfi_strsect: it is bound to the bfd. */
438 free (arc
->ctfi_data
);
439 if (arc
->ctfi_bfd_close
)
440 arc
->ctfi_bfd_close (arc
);
444 /* Return the ctf_file_t with the given name, or NULL if none, setting 'err' if
445 non-NULL. A name of NULL means to open the default file. */
447 ctf_arc_open_by_name_internal (const struct ctf_archive
*arc
,
448 const ctf_sect_t
*symsect
,
449 const ctf_sect_t
*strsect
,
450 const char *name
, int *errp
)
452 struct ctf_archive_modent
*modent
;
455 name
= _CTF_SECTION
; /* The default name. */
457 ctf_dprintf ("ctf_arc_open_by_name(%s): opening\n", name
);
459 modent
= (ctf_archive_modent_t
*) ((char *) arc
460 + sizeof (struct ctf_archive
));
462 search_nametbl
= (char *) arc
+ le64toh (arc
->ctfa_names
);
463 modent
= bsearch (name
, modent
, le64toh (arc
->ctfa_nfiles
),
464 sizeof (struct ctf_archive_modent
),
465 search_modent_by_name
);
467 /* This is actually a common case and normal operation: no error
472 *errp
= ECTF_ARNNAME
;
476 return ctf_arc_open_by_offset (arc
, symsect
, strsect
,
477 le64toh (modent
->ctf_offset
), errp
);
480 /* Return the ctf_file_t with the given name, or NULL if none, setting 'err' if
481 non-NULL. A name of NULL means to open the default file.
483 Use the specified string and symbol table sections.
485 Public entry point. */
487 ctf_arc_open_by_name_sections (const ctf_archive_t
*arc
,
488 const ctf_sect_t
*symsect
,
489 const ctf_sect_t
*strsect
,
493 if (arc
->ctfi_is_archive
)
496 ret
= ctf_arc_open_by_name_internal (arc
->ctfi_archive
, symsect
, strsect
,
499 ret
->ctf_archive
= (ctf_archive_t
*) arc
;
503 if ((name
!= NULL
) && (strcmp (name
, _CTF_SECTION
) != 0))
506 *errp
= ECTF_ARNNAME
;
509 arc
->ctfi_file
->ctf_archive
= (ctf_archive_t
*) arc
;
511 /* Bump the refcount so that the user can ctf_file_close() it. */
512 arc
->ctfi_file
->ctf_refcnt
++;
513 return arc
->ctfi_file
;
516 /* Return the ctf_file_t with the given name, or NULL if none, setting 'err' if
517 non-NULL. A name of NULL means to open the default file.
519 Public entry point. */
521 ctf_arc_open_by_name (const ctf_archive_t
*arc
, const char *name
, int *errp
)
523 const ctf_sect_t
*symsect
= &arc
->ctfi_symsect
;
524 const ctf_sect_t
*strsect
= &arc
->ctfi_strsect
;
526 if (symsect
->cts_name
== NULL
)
528 if (strsect
->cts_name
== NULL
)
531 return ctf_arc_open_by_name_sections (arc
, symsect
, strsect
, name
, errp
);
534 /* Return the ctf_file_t at the given ctfa_ctfs-relative offset, or NULL if
535 none, setting 'err' if non-NULL. */
537 ctf_arc_open_by_offset (const struct ctf_archive
*arc
,
538 const ctf_sect_t
*symsect
,
539 const ctf_sect_t
*strsect
, size_t offset
,
545 ctf_dprintf ("ctf_arc_open_by_offset(%lu): opening\n", (unsigned long) offset
);
547 memset (&ctfsect
, 0, sizeof (ctf_sect_t
));
549 offset
+= le64toh (arc
->ctfa_ctfs
);
551 ctfsect
.cts_name
= _CTF_SECTION
;
552 ctfsect
.cts_size
= le64toh (*((uint64_t *) ((char *) arc
+ offset
)));
553 ctfsect
.cts_entsize
= 1;
554 ctfsect
.cts_data
= (void *) ((char *) arc
+ offset
+ sizeof (uint64_t));
555 fp
= ctf_bufopen (&ctfsect
, symsect
, strsect
, errp
);
557 ctf_setmodel (fp
, le64toh (arc
->ctfa_model
));
561 /* Raw iteration over all CTF files in an archive. We pass the raw data for all
562 CTF files in turn to the specified callback function. */
564 ctf_archive_raw_iter_internal (const struct ctf_archive
*arc
,
565 ctf_archive_raw_member_f
*func
, void *data
)
569 struct ctf_archive_modent
*modent
;
572 modent
= (ctf_archive_modent_t
*) ((char *) arc
573 + sizeof (struct ctf_archive
));
574 nametbl
= (((const char *) arc
) + le64toh (arc
->ctfa_names
));
576 for (i
= 0; i
< le64toh (arc
->ctfa_nfiles
); i
++)
581 name
= &nametbl
[le64toh (modent
[i
].name_offset
)];
582 fp
= ((char *) arc
+ le64toh (arc
->ctfa_ctfs
)
583 + le64toh (modent
[i
].ctf_offset
));
585 if ((rc
= func (name
, (void *) (fp
+ sizeof (uint64_t)),
586 le64toh (*((uint64_t *) fp
)), data
)) != 0)
592 /* Raw iteration over all CTF files in an archive: public entry point.
594 Returns -EINVAL if not supported for this sort of archive. */
596 ctf_archive_raw_iter (const ctf_archive_t
*arc
,
597 ctf_archive_raw_member_f
* func
, void *data
)
599 if (arc
->ctfi_is_archive
)
600 return ctf_archive_raw_iter_internal (arc
->ctfi_archive
, func
, data
);
602 return -EINVAL
; /* Not supported. */
605 /* Iterate over all CTF files in an archive. We pass all CTF files in turn to
606 the specified callback function. */
608 ctf_archive_iter_internal (const ctf_archive_t
*wrapper
,
609 const struct ctf_archive
*arc
,
610 const ctf_sect_t
*symsect
,
611 const ctf_sect_t
*strsect
,
612 ctf_archive_member_f
*func
, void *data
)
617 struct ctf_archive_modent
*modent
;
620 modent
= (ctf_archive_modent_t
*) ((char *) arc
621 + sizeof (struct ctf_archive
));
622 nametbl
= (((const char *) arc
) + le64toh (arc
->ctfa_names
));
624 for (i
= 0; i
< le64toh (arc
->ctfa_nfiles
); i
++)
628 name
= &nametbl
[le64toh (modent
[i
].name_offset
)];
629 if ((f
= ctf_arc_open_by_name_internal (arc
, symsect
, strsect
,
633 f
->ctf_archive
= (ctf_archive_t
*) wrapper
;
634 if ((rc
= func (f
, name
, data
)) != 0)
645 /* Iterate over all CTF files in an archive: public entry point. We pass all
646 CTF files in turn to the specified callback function. */
648 ctf_archive_iter (const ctf_archive_t
*arc
, ctf_archive_member_f
*func
,
651 const ctf_sect_t
*symsect
= &arc
->ctfi_symsect
;
652 const ctf_sect_t
*strsect
= &arc
->ctfi_strsect
;
654 if (symsect
->cts_name
== NULL
)
656 if (strsect
->cts_name
== NULL
)
659 if (arc
->ctfi_is_archive
)
660 return ctf_archive_iter_internal (arc
, arc
->ctfi_archive
, symsect
, strsect
,
663 return func (arc
->ctfi_file
, _CTF_SECTION
, data
);
667 /* Map the header in. Only used on new, empty files. */
668 static void *arc_mmap_header (int fd
, size_t headersz
)
671 if ((hdr
= mmap (NULL
, headersz
, PROT_READ
| PROT_WRITE
, MAP_SHARED
, fd
,
677 /* mmap() the whole file, for reading only. (Map it writably, but privately: we
678 need to modify the region, but don't need anyone else to see the
680 static void *arc_mmap_file (int fd
, size_t size
)
683 if ((arc
= mmap (NULL
, size
, PROT_READ
| PROT_WRITE
, MAP_PRIVATE
,
684 fd
, 0)) == MAP_FAILED
)
689 /* Persist the header to disk. */
690 static int arc_mmap_writeout (int fd _libctf_unused_
, void *header
,
691 size_t headersz
, const char **errmsg
)
693 if (msync (header
, headersz
, MS_ASYNC
) < 0)
696 *errmsg
= "arc_mmap_writeout(): Cannot sync after writing to %s: %s\n";
702 /* Unmap the region. */
703 static int arc_mmap_unmap (void *header
, size_t headersz
, const char **errmsg
)
705 if (munmap (header
, headersz
) < 0)
708 *errmsg
= "arc_mmap_munmap(): Cannot unmap after writing to %s: %s\n";
714 /* Map the header in. Only used on new, empty files. */
715 static void *arc_mmap_header (int fd _libctf_unused_
, size_t headersz
)
718 if ((hdr
= malloc (headersz
)) == NULL
)
723 /* Pull in the whole file, for reading only. We assume the current file
724 position is at the start of the file. */
725 static void *arc_mmap_file (int fd
, size_t size
)
729 if ((data
= malloc (size
)) == NULL
)
732 if (ctf_pread (fd
, data
, size
, 0) < 0)
740 /* Persist the header to disk. */
741 static int arc_mmap_writeout (int fd
, void *header
, size_t headersz
,
746 char *data
= (char *) header
;
747 ssize_t count
= headersz
;
749 if ((lseek (fd
, 0, SEEK_SET
)) < 0)
752 *errmsg
= "arc_mmap_writeout(): Cannot seek while writing header to "
759 if ((len
= write (fd
, data
, count
)) < 0)
762 *errmsg
= "arc_mmap_writeout(): Cannot write header to %s: %s\n";
769 if (len
== 0) /* EOF. */
778 /* Unmap the region. */
779 static int arc_mmap_unmap (void *header
, size_t headersz _libctf_unused_
,
780 const char **errmsg _libctf_unused_
)
This page took 0.046477 seconds and 5 git commands to generate.