676c3ecbad
The method of operation of libctf when the dictionary is writable has before now been that types that are added land in the dynamic type section, which is a linked list and hash of IDs -> dynamic type definitions (and, recently a hash of names): the DTDs are a bit of CTF representing the ctf_type_t and ad hoc C structures representing the vlen. Historically, libctf was unable to do anything with these types, not even look them up by ID, let alone by name: if you wanted to do that say if you were adding a type that depended on one you just added) you called ctf_update, which serializes all the DTDs into a CTF file and reopens it, copying its guts over the fp it's called with. The ctf_updated types are then frozen in amber and unchangeable: all lookups will return the types in the static portion in preference to the dynamic portion, and we will refuse to re-add things that already exist in the static portion (and, of late, in the dynamic portion too). The libctf machinery remembers the boundary between static and dynamic types and looks in the right portion for each type. Lots of things still don't quite work with dynamic types (e.g. getting their size), but enough works to do a bunch of additions and then a ctf_update, most of the time. Except it doesn't, because ctf_add_type finds it necessary to walk the full dynamic type definition list looking for types with matching names, so it gets slower and slower with every type you add: fixing this requires calling ctf_update periodically for no other reason than to avoid massively slowing things down. This is all clunky and very slow but kind of works, until you consider that it is in fact possible and indeed necessary to modify one sort of type after it has been added: forwards. These are necessarily promoted to structs, unions or enums, and when they do so *their type ID does not change*. So all of a sudden we are changing types that already exist in the static portion. ctf_update gets massively confused by this and allocates space enough for the forward (with no members), but then emits the new dynamic type (with all the members) into it. You get an assertion failure after that, if you're lucky, or a coredump. So this commit rejigs things a bit and arranges to exclusively use the dynamic type definitions in writable dictionaries, and the static type definitions in readable dictionaries: we don't at any time have a mixture of static and dynamic types, and you don't need to call ctf_update to make things "appear". The ctf_dtbyname hash I introduced a few months ago, which maps things like "struct foo" to DTDs, is removed, replaced instead by a change of type of the four dictionaries which track names. Rather than just being (unresizable) ctf_hash_t's populated only at ctf_bufopen time, they are now a ctf_names_t structure, which is a pair of ctf_hash_t and ctf_dynhash_t, with the ctf_hash_t portion being used in readonly dictionaries, and the ctf_dynhash_t being used in writable ones. The decision as to which to use is centralized in the new functions ctf_lookup_by_rawname (which takes a type kind) and ctf_lookup_by_rawhash, which it calls (which takes a ctf_names_t *.) This change lets us switch from using static to dynamic name hashes on the fly across the entirety of libctf without complexifying anything: in fact, because we now centralize the knowledge about how to map from type kind to name hash, it actually simplifies things and lets us throw out quite a lot of now-unnecessary complexity, from ctf_dtnyname (replaced by the dynamic half of the name tables), through to ctf_dtnextid (now that a dictionary's static portion is never referenced if the dictionary is writable, we can just use ctf_typemax to indicate the maximum type: dynamic or non-dynamic does not matter, and we no longer need to track the boundary between the types). You can now ctf_rollback() as far as you like, even past a ctf_update or for that matter a full writeout; all the iteration functions work just as well on writable as on read-only dictionaries; ctf_add_type no longer needs expensive duplicated code to run over the dynamic types hunting for ones it might be interested in; and the linker no longer needs a hack to call ctf_update so that calling ctf_add_type is not impossibly expensive. There is still a bit more complexity: some new code paths in ctf-types.c need to know how to extract information from dynamic types. This complexity will go away again in a few months when libctf acquires a proper intermediate representation. You can still call ctf_update if you like (it's public API, after all), but its only effect now is to set the point to which ctf_discard rolls back. Obviously *something* still needs to serialize the CTF file before writeout, and this job is done by ctf_serialize, which does everything ctf_update used to except set the counter used by ctf_discard. It is automatically called by the various functions that do CTF writeout: nobody else ever needs to call it. With this in place, forwards that are promoted to non-forwards no longer crash the link, even if it happens tens of thousands of types later. v5: fix tabdamage. libctf/ * ctf-impl.h (ctf_names_t): New. (ctf_lookup_t) <ctf_hash>: Now a ctf_names_t, not a ctf_hash_t. (ctf_file_t) <ctf_structs>: Likewise. <ctf_unions>: Likewise. <ctf_enums>: Likewise. <ctf_names>: Likewise. <ctf_lookups>: Improve comment. <ctf_ptrtab_len>: New. <ctf_prov_strtab>: New. <ctf_str_prov_offset>: New. <ctf_dtbyname>: Remove, redundant to the names hashes. <ctf_dtnextid>: Remove, redundant to ctf_typemax. (ctf_dtdef_t) <dtd_name>: Remove. <dtd_data>: Note that the ctt_name is now populated. (ctf_str_atom_t) <csa_offset>: This is now the strtab offset for internal strings too. <csa_external_offset>: New, the external strtab offset. (CTF_INDEX_TO_TYPEPTR): Handle the LCTF_RDWR case. (ctf_name_table): New declaration. (ctf_lookup_by_rawname): Likewise. (ctf_lookup_by_rawhash): Likewise. (ctf_set_ctl_hashes): Likewise. (ctf_serialize): Likewise. (ctf_dtd_insert): Adjust. (ctf_simple_open_internal): Likewise. (ctf_bufopen_internal): Likewise. (ctf_list_empty_p): Likewise. (ctf_str_remove_ref): Likewise. (ctf_str_add): Returns uint32_t now. (ctf_str_add_ref): Likewise. (ctf_str_add_external): Now returns a boolean (int). * ctf-string.c (ctf_strraw_explicit): Check the ctf_prov_strtab for strings in the appropriate range. (ctf_str_create_atoms): Create the ctf_prov_strtab. Detect OOM when adding the null string to the new strtab. (ctf_str_free_atoms): Destroy the ctf_prov_strtab. (ctf_str_add_ref_internal): Add make_provisional argument. If make_provisional, populate the offset and fill in the ctf_prov_strtab accordingly. (ctf_str_add): Return the offset, not the string. (ctf_str_add_ref): Likewise. (ctf_str_add_external): Return a success integer. (ctf_str_remove_ref): New, remove a single ref. (ctf_str_count_strtab): Do not count the initial null string's length or the existence or length of any unreferenced internal atoms. (ctf_str_populate_sorttab): Skip atoms with no refs. (ctf_str_write_strtab): Populate the nullstr earlier. Add one to the cts_len for the null string, since it is no longer done in ctf_str_count_strtab. Adjust for csa_external_offset rename. Populate the csa_offset for both internal and external cases. Flush the ctf_prov_strtab afterwards, and reset the ctf_str_prov_offset. * ctf-create.c (ctf_grow_ptrtab): New. (ctf_create): Call it. Initialize new fields rather than old ones. Tell ctf_bufopen_internal that this is a writable dictionary. Set the ctl hashes and data model. (ctf_update): Rename to... (ctf_serialize): ... this. Leave a compatibility function behind. Tell ctf_simple_open_internal that this is a writable dictionary. Pass the new fields along from the old dictionary. Drop ctf_dtnextid and ctf_dtbyname. Use ctf_strraw, not dtd_name. Do not zero out the DTD's ctt_name. (ctf_prefixed_name): Rename to... (ctf_name_table): ... this. No longer return a prefixed name: return the applicable name table instead. (ctf_dtd_insert): Use it, and use the right name table. Pass in the kind we're adding. Migrate away from dtd_name. (ctf_dtd_delete): Adjust similarly. Remove the ref to the deleted ctt_name. (ctf_dtd_lookup_type_by_name): Remove. (ctf_dynamic_type): Always return NULL on read-only dictionaries. No longer check ctf_dtnextid: check ctf_typemax instead. (ctf_snapshot): No longer use ctf_dtnextid: use ctf_typemax instead. (ctf_rollback): Likewise. No longer fail with ECTF_OVERROLLBACK. Use ctf_name_table and the right name table, and migrate away from dtd_name as in ctf_dtd_delete. (ctf_add_generic): Pass in the kind explicitly and pass it to ctf_dtd_insert. Use ctf_typemax, not ctf_dtnextid. Migrate away from dtd_name to using ctf_str_add_ref to populate the ctt_name. Grow the ptrtab if needed. (ctf_add_encoded): Pass in the kind. (ctf_add_slice): Likewise. (ctf_add_array): Likewise. (ctf_add_function): Likewise. (ctf_add_typedef): Likewise. (ctf_add_reftype): Likewise. Initialize the ctf_ptrtab, checking ctt_name rather than dtd_name. (ctf_add_struct_sized): Pass in the kind. Use ctf_lookup_by_rawname, not ctf_hash_lookup_type / ctf_dtd_lookup_type_by_name. (ctf_add_union_sized): Likewise. (ctf_add_enum): Likewise. (ctf_add_enum_encoded): Likewise. (ctf_add_forward): Likewise. (ctf_add_type): Likewise. (ctf_compress_write): Call ctf_serialize: adjust for ctf_size not being initialized until after the call. (ctf_write_mem): Likewise. (ctf_write): Likewise. * ctf-archive.c (arc_write_one_ctf): Likewise. * ctf-lookup.c (ctf_lookup_by_name): Use ctf_lookuup_by_rawhash, not ctf_hash_lookup_type. (ctf_lookup_by_id): No longer check the readonly types if the dictionary is writable. * ctf-open.c (init_types): Assert that this dictionary is not writable. Adjust to use the new name hashes, ctf_name_table, and ctf_ptrtab_len. GNU style fix for the final ptrtab scan. (ctf_bufopen_internal): New 'writable' parameter. Flip on LCTF_RDWR if set. Drop out early when dictionary is writable. Split the ctf_lookups initialization into... (ctf_set_cth_hashes): ... this new function. (ctf_simple_open_internal): Adjust. New 'writable' parameter. (ctf_simple_open): Adjust accordingly. (ctf_bufopen): Likewise. (ctf_file_close): Destroy the appropriate name hashes. No longer destroy ctf_dtbyname, which is gone. (ctf_getdatasect): Remove spurious "extern". * ctf-types.c (ctf_lookup_by_rawname): New, look up types in the specified name table, given a kind. (ctf_lookup_by_rawhash): Likewise, given a ctf_names_t *. (ctf_member_iter): Add support for iterating over the dynamic type list. (ctf_enum_iter): Likewise. (ctf_variable_iter): Likewise. (ctf_type_rvisit): Likewise. (ctf_member_info): Add support for types in the dynamic type list. (ctf_enum_name): Likewise. (ctf_enum_value): Likewise. (ctf_func_type_info): Likewise. (ctf_func_type_args): Likewise. * ctf-link.c (ctf_accumulate_archive_names): No longer call ctf_update. (ctf_link_write): Likewise. (ctf_link_intern_extern_string): Adjust for new ctf_str_add_external return value. (ctf_link_add_strtab): Likewise. * ctf-util.c (ctf_list_empty_p): New.
789 lines
21 KiB
C
789 lines
21 KiB
C
/* CTF archive files.
|
|
Copyright (C) 2019 Free Software Foundation, Inc.
|
|
|
|
This file is part of libctf.
|
|
|
|
libctf is free software; you can redistribute it and/or modify it under
|
|
the terms of the GNU General Public License as published by the Free
|
|
Software Foundation; either version 3, or (at your option) any later
|
|
version.
|
|
|
|
This program is distributed in the hope that it will be useful, but
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
See the GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; see the file COPYING. If not see
|
|
<http://www.gnu.org/licenses/>. */
|
|
|
|
#include <ctf-impl.h>
|
|
#include <sys/types.h>
|
|
#include <sys/stat.h>
|
|
#include <elf.h>
|
|
#include "ctf-endian.h"
|
|
#include <errno.h>
|
|
#include <fcntl.h>
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
#include <unistd.h>
|
|
|
|
#ifdef HAVE_MMAP
|
|
#include <sys/mman.h>
|
|
#endif
|
|
|
|
static off_t arc_write_one_ctf (ctf_file_t * f, int fd, size_t threshold);
|
|
static ctf_file_t *ctf_arc_open_by_offset (const struct ctf_archive *arc,
|
|
const ctf_sect_t *symsect,
|
|
const ctf_sect_t *strsect,
|
|
size_t offset, int *errp);
|
|
static int sort_modent_by_name (const void *one, const void *two, void *n);
|
|
static void *arc_mmap_header (int fd, size_t headersz);
|
|
static void *arc_mmap_file (int fd, size_t size);
|
|
static int arc_mmap_writeout (int fd, void *header, size_t headersz,
|
|
const char **errmsg);
|
|
static int arc_mmap_unmap (void *header, size_t headersz, const char **errmsg);
|
|
|
|
/* bsearch() internal state. */
|
|
static __thread char *search_nametbl;
|
|
|
|
/* Write out a CTF archive to the start of the file referenced by the passed-in
|
|
fd. The entries in CTF_FILES are referenced by name: the names are passed in
|
|
the names array, which must have CTF_FILES entries.
|
|
|
|
Returns 0 on success, or an errno, or an ECTF_* value. */
|
|
int
|
|
ctf_arc_write_fd (int fd, ctf_file_t **ctf_files, size_t ctf_file_cnt,
|
|
const char **names, size_t threshold)
|
|
{
|
|
const char *errmsg;
|
|
struct ctf_archive *archdr;
|
|
size_t i;
|
|
char dummy = 0;
|
|
size_t headersz;
|
|
ssize_t namesz;
|
|
size_t ctf_startoffs; /* Start of the section we are working over. */
|
|
char *nametbl = NULL; /* The name table. */
|
|
char *np;
|
|
off_t nameoffs;
|
|
struct ctf_archive_modent *modent;
|
|
|
|
ctf_dprintf ("Writing CTF archive with %lu files\n",
|
|
(unsigned long) ctf_file_cnt);
|
|
|
|
/* Figure out the size of the mmap()ed header, including the
|
|
ctf_archive_modent array. We assume that all of this needs no
|
|
padding: a likely assumption, given that it's all made up of
|
|
uint64_t's. */
|
|
headersz = sizeof (struct ctf_archive)
|
|
+ (ctf_file_cnt * sizeof (uint64_t) * 2);
|
|
ctf_dprintf ("headersz is %lu\n", (unsigned long) headersz);
|
|
|
|
/* From now on we work in two pieces: an mmap()ed region from zero up to the
|
|
headersz, and a region updated via write() starting after that, containing
|
|
all the tables. Platforms that do not support mmap() just use write(). */
|
|
ctf_startoffs = headersz;
|
|
if (lseek (fd, ctf_startoffs - 1, SEEK_SET) < 0)
|
|
{
|
|
errmsg = "ctf_arc_write(): cannot extend file while writing: %s\n";
|
|
goto err;
|
|
}
|
|
|
|
if (write (fd, &dummy, 1) < 0)
|
|
{
|
|
errmsg = "ctf_arc_write(): cannot extend file while writing: %s\n";
|
|
goto err;
|
|
}
|
|
|
|
if ((archdr = arc_mmap_header (fd, headersz)) == NULL)
|
|
{
|
|
errmsg = "ctf_arc_write(): Cannot mmap(): %s\n";
|
|
goto err;
|
|
}
|
|
|
|
/* Fill in everything we can, which is everything other than the name
|
|
table offset. */
|
|
archdr->ctfa_magic = htole64 (CTFA_MAGIC);
|
|
archdr->ctfa_nfiles = htole64 (ctf_file_cnt);
|
|
archdr->ctfa_ctfs = htole64 (ctf_startoffs);
|
|
|
|
/* We could validate that all CTF files have the same data model, but
|
|
since any reasonable construction process will be building things of
|
|
only one bitness anyway, this is pretty pointless, so just use the
|
|
model of the first CTF file for all of them. (It *is* valid to
|
|
create an empty archive: the value of ctfa_model is irrelevant in
|
|
this case, but we must be sure not to dereference uninitialized
|
|
memory.) */
|
|
|
|
if (ctf_file_cnt > 0)
|
|
archdr->ctfa_model = htole64 (ctf_getmodel (ctf_files[0]));
|
|
|
|
/* Now write out the CTFs: ctf_archive_modent array via the mapping,
|
|
ctfs via write(). The names themselves have not been written yet: we
|
|
track them in a local strtab until the time is right, and sort the
|
|
modents array after construction.
|
|
|
|
The name table is not sorted. */
|
|
|
|
for (i = 0, namesz = 0; i < le64toh (archdr->ctfa_nfiles); i++)
|
|
namesz += strlen (names[i]) + 1;
|
|
|
|
nametbl = malloc (namesz);
|
|
if (nametbl == NULL)
|
|
{
|
|
errmsg = "Error writing named CTF to archive: %s\n";
|
|
goto err_unmap;
|
|
}
|
|
|
|
for (i = 0, namesz = 0,
|
|
modent = (ctf_archive_modent_t *) ((char *) archdr
|
|
+ sizeof (struct ctf_archive));
|
|
i < le64toh (archdr->ctfa_nfiles); i++)
|
|
{
|
|
off_t off;
|
|
|
|
strcpy (&nametbl[namesz], names[i]);
|
|
|
|
off = arc_write_one_ctf (ctf_files[i], fd, threshold);
|
|
if ((off < 0) && (off > -ECTF_BASE))
|
|
{
|
|
errmsg = "ctf_arc_write(): Cannot determine file "
|
|
"position while writing to archive: %s";
|
|
goto err_free;
|
|
}
|
|
if (off < 0)
|
|
{
|
|
errmsg = "ctf_arc_write(): Cannot write CTF file to archive: %s\n";
|
|
errno = off * -1;
|
|
goto err_free;
|
|
}
|
|
|
|
modent->name_offset = htole64 (namesz);
|
|
modent->ctf_offset = htole64 (off - ctf_startoffs);
|
|
namesz += strlen (names[i]) + 1;
|
|
modent++;
|
|
}
|
|
|
|
ctf_qsort_r ((ctf_archive_modent_t *) ((char *) archdr
|
|
+ sizeof (struct ctf_archive)),
|
|
le64toh (archdr->ctfa_nfiles),
|
|
sizeof (struct ctf_archive_modent), sort_modent_by_name,
|
|
nametbl);
|
|
|
|
/* Now the name table. */
|
|
|
|
if ((nameoffs = lseek (fd, 0, SEEK_CUR)) < 0)
|
|
{
|
|
errmsg = "ctf_arc_write(): Cannot get current file position "
|
|
"in archive: %s\n";
|
|
goto err_free;
|
|
}
|
|
archdr->ctfa_names = htole64 (nameoffs);
|
|
np = nametbl;
|
|
while (namesz > 0)
|
|
{
|
|
ssize_t len;
|
|
if ((len = write (fd, np, namesz)) < 0)
|
|
{
|
|
errmsg = "ctf_arc_write(): Cannot write name table to archive: %s\n";
|
|
goto err_free;
|
|
}
|
|
namesz -= len;
|
|
np += len;
|
|
}
|
|
free (nametbl);
|
|
|
|
if (arc_mmap_writeout (fd, archdr, headersz, &errmsg) < 0)
|
|
goto err_unmap;
|
|
if (arc_mmap_unmap (archdr, headersz, &errmsg) < 0)
|
|
goto err;
|
|
return 0;
|
|
|
|
err_free:
|
|
free (nametbl);
|
|
err_unmap:
|
|
arc_mmap_unmap (archdr, headersz, NULL);
|
|
err:
|
|
ctf_dprintf (errmsg, errno < ECTF_BASE ? strerror (errno) :
|
|
ctf_errmsg (errno));
|
|
return errno;
|
|
}
|
|
|
|
/* Write out a CTF archive. The entries in CTF_FILES are referenced by name:
|
|
the names are passed in the names array, which must have CTF_FILES entries.
|
|
|
|
If the filename is NULL, create a temporary file and return a pointer to it.
|
|
|
|
Returns 0 on success, or an errno, or an ECTF_* value. */
|
|
int
|
|
ctf_arc_write (const char *file, ctf_file_t ** ctf_files, size_t ctf_file_cnt,
|
|
const char **names, size_t threshold)
|
|
{
|
|
int err;
|
|
int fd;
|
|
|
|
if ((fd = open (file, O_RDWR | O_CREAT | O_TRUNC | O_CLOEXEC, 0666)) < 0)
|
|
{
|
|
ctf_dprintf ("ctf_arc_write(): cannot create %s: %s\n", file,
|
|
strerror (errno));
|
|
return errno;
|
|
}
|
|
|
|
err = ctf_arc_write_fd (fd, ctf_files, ctf_file_cnt, names, threshold);
|
|
if (err)
|
|
goto err;
|
|
|
|
if ((err = close (fd)) < 0)
|
|
{
|
|
ctf_dprintf ("ctf_arc_write(): Cannot close after writing to archive: "
|
|
"%s\n", strerror (errno));
|
|
goto err_close;
|
|
}
|
|
|
|
err:
|
|
close (fd);
|
|
if (err < 0)
|
|
unlink (file);
|
|
|
|
return err;
|
|
|
|
err_close:
|
|
if (err < 0)
|
|
unlink (file);
|
|
|
|
return err;
|
|
}
|
|
|
|
/* Write one CTF file out. Return the file position of the written file (or
|
|
rather, of the file-size uint64_t that precedes it): negative return is a
|
|
negative errno or ctf_errno value. On error, the file position may no longer
|
|
be at the end of the file. */
|
|
static off_t
|
|
arc_write_one_ctf (ctf_file_t * f, int fd, size_t threshold)
|
|
{
|
|
off_t off, end_off;
|
|
uint64_t ctfsz = 0;
|
|
char *ctfszp;
|
|
size_t ctfsz_len;
|
|
int (*writefn) (ctf_file_t * fp, int fd);
|
|
|
|
if (ctf_serialize (f) < 0)
|
|
return f->ctf_errno * -1;
|
|
|
|
if ((off = lseek (fd, 0, SEEK_CUR)) < 0)
|
|
return errno * -1;
|
|
|
|
if (f->ctf_size > threshold)
|
|
writefn = ctf_compress_write;
|
|
else
|
|
writefn = ctf_write;
|
|
|
|
/* This zero-write turns into the size in a moment. */
|
|
ctfsz_len = sizeof (ctfsz);
|
|
ctfszp = (char *) &ctfsz;
|
|
while (ctfsz_len > 0)
|
|
{
|
|
ssize_t writelen = write (fd, ctfszp, ctfsz_len);
|
|
if (writelen < 0)
|
|
return errno * -1;
|
|
ctfsz_len -= writelen;
|
|
ctfszp += writelen;
|
|
}
|
|
|
|
if (writefn (f, fd) != 0)
|
|
return f->ctf_errno * -1;
|
|
|
|
if ((end_off = lseek (fd, 0, SEEK_CUR)) < 0)
|
|
return errno * -1;
|
|
ctfsz = htole64 (end_off - off);
|
|
|
|
if ((lseek (fd, off, SEEK_SET)) < 0)
|
|
return errno * -1;
|
|
|
|
/* ... here. */
|
|
ctfsz_len = sizeof (ctfsz);
|
|
ctfszp = (char *) &ctfsz;
|
|
while (ctfsz_len > 0)
|
|
{
|
|
ssize_t writelen = write (fd, ctfszp, ctfsz_len);
|
|
if (writelen < 0)
|
|
return errno * -1;
|
|
ctfsz_len -= writelen;
|
|
ctfszp += writelen;
|
|
}
|
|
|
|
end_off = LCTF_ALIGN_OFFS (end_off, 8);
|
|
if ((lseek (fd, end_off, SEEK_SET)) < 0)
|
|
return errno * -1;
|
|
|
|
return off;
|
|
}
|
|
|
|
/* qsort() function to sort the array of struct ctf_archive_modents into
|
|
ascending name order. */
|
|
static int
|
|
sort_modent_by_name (const void *one, const void *two, void *n)
|
|
{
|
|
const struct ctf_archive_modent *a = one;
|
|
const struct ctf_archive_modent *b = two;
|
|
char *nametbl = n;
|
|
|
|
return strcmp (&nametbl[le64toh (a->name_offset)],
|
|
&nametbl[le64toh (b->name_offset)]);
|
|
}
|
|
|
|
/* bsearch() function to search for a given name in the sorted array of struct
|
|
ctf_archive_modents. */
|
|
static int
|
|
search_modent_by_name (const void *key, const void *ent)
|
|
{
|
|
const char *k = key;
|
|
const struct ctf_archive_modent *v = ent;
|
|
|
|
return strcmp (k, &search_nametbl[le64toh (v->name_offset)]);
|
|
}
|
|
|
|
/* A trivial wrapper: open a CTF archive, from data in a buffer (which the
|
|
caller must preserve until ctf_arc_close() time). Returns the archive, or
|
|
NULL and an error in *err (if not NULL). */
|
|
struct ctf_archive *
|
|
ctf_arc_bufopen (const void *buf, size_t size _libctf_unused_, int *errp)
|
|
{
|
|
struct ctf_archive *arc = (struct ctf_archive *) buf;
|
|
|
|
if (le64toh (arc->ctfa_magic) != CTFA_MAGIC)
|
|
{
|
|
if (errp)
|
|
*errp = ECTF_FMT;
|
|
return NULL;
|
|
}
|
|
return arc;
|
|
}
|
|
|
|
/* Open a CTF archive. Returns the archive, or NULL and an error in *err (if
|
|
not NULL). */
|
|
struct ctf_archive *
|
|
ctf_arc_open_internal (const char *filename, int *errp)
|
|
{
|
|
const char *errmsg;
|
|
int fd;
|
|
struct stat s;
|
|
struct ctf_archive *arc; /* (Actually the whole file.) */
|
|
|
|
libctf_init_debug();
|
|
if ((fd = open (filename, O_RDONLY)) < 0)
|
|
{
|
|
errmsg = "ctf_arc_open(): cannot open %s: %s\n";
|
|
goto err;
|
|
}
|
|
if (fstat (fd, &s) < 0)
|
|
{
|
|
errmsg = "ctf_arc_open(): cannot stat %s: %s\n";
|
|
goto err_close;
|
|
}
|
|
|
|
if ((arc = arc_mmap_file (fd, s.st_size)) == NULL)
|
|
{
|
|
errmsg = "ctf_arc_open(): Cannot read in %s: %s\n";
|
|
goto err_close;
|
|
}
|
|
|
|
if (le64toh (arc->ctfa_magic) != CTFA_MAGIC)
|
|
{
|
|
errmsg = "ctf_arc_open(): Invalid magic number";
|
|
errno = ECTF_FMT;
|
|
goto err_unmap;
|
|
}
|
|
|
|
/* This horrible hack lets us know how much to unmap when the file is
|
|
closed. (We no longer need the magic number, and the mapping
|
|
is private.) */
|
|
arc->ctfa_magic = s.st_size;
|
|
close (fd);
|
|
return arc;
|
|
|
|
err_unmap:
|
|
arc_mmap_unmap (arc, s.st_size, NULL);
|
|
err_close:
|
|
close (fd);
|
|
err:
|
|
if (errp)
|
|
*errp = errno;
|
|
ctf_dprintf (errmsg, filename, errno < ECTF_BASE ? strerror (errno) :
|
|
ctf_errmsg (errno));
|
|
return NULL;
|
|
}
|
|
|
|
/* Close an archive. */
|
|
void
|
|
ctf_arc_close_internal (struct ctf_archive *arc)
|
|
{
|
|
if (arc == NULL)
|
|
return;
|
|
|
|
/* See the comment in ctf_arc_open(). */
|
|
arc_mmap_unmap (arc, arc->ctfa_magic, NULL);
|
|
}
|
|
|
|
/* Public entry point: close an archive, or CTF file. */
|
|
void
|
|
ctf_arc_close (ctf_archive_t *arc)
|
|
{
|
|
if (arc == NULL)
|
|
return;
|
|
|
|
if (arc->ctfi_is_archive)
|
|
ctf_arc_close_internal (arc->ctfi_archive);
|
|
else
|
|
ctf_file_close (arc->ctfi_file);
|
|
free ((void *) arc->ctfi_symsect.cts_data);
|
|
/* Do not free the ctfi_strsect: it is bound to the bfd. */
|
|
free (arc->ctfi_data);
|
|
if (arc->ctfi_bfd_close)
|
|
arc->ctfi_bfd_close (arc);
|
|
free (arc);
|
|
}
|
|
|
|
/* Return the ctf_file_t with the given name, or NULL if none, setting 'err' if
|
|
non-NULL. A name of NULL means to open the default file. */
|
|
static ctf_file_t *
|
|
ctf_arc_open_by_name_internal (const struct ctf_archive *arc,
|
|
const ctf_sect_t *symsect,
|
|
const ctf_sect_t *strsect,
|
|
const char *name, int *errp)
|
|
{
|
|
struct ctf_archive_modent *modent;
|
|
|
|
if (name == NULL)
|
|
name = _CTF_SECTION; /* The default name. */
|
|
|
|
ctf_dprintf ("ctf_arc_open_by_name(%s): opening\n", name);
|
|
|
|
modent = (ctf_archive_modent_t *) ((char *) arc
|
|
+ sizeof (struct ctf_archive));
|
|
|
|
search_nametbl = (char *) arc + le64toh (arc->ctfa_names);
|
|
modent = bsearch (name, modent, le64toh (arc->ctfa_nfiles),
|
|
sizeof (struct ctf_archive_modent),
|
|
search_modent_by_name);
|
|
|
|
/* This is actually a common case and normal operation: no error
|
|
debug output. */
|
|
if (modent == NULL)
|
|
{
|
|
if (errp)
|
|
*errp = ECTF_ARNNAME;
|
|
return NULL;
|
|
}
|
|
|
|
return ctf_arc_open_by_offset (arc, symsect, strsect,
|
|
le64toh (modent->ctf_offset), errp);
|
|
}
|
|
|
|
/* Return the ctf_file_t with the given name, or NULL if none, setting 'err' if
|
|
non-NULL. A name of NULL means to open the default file.
|
|
|
|
Use the specified string and symbol table sections.
|
|
|
|
Public entry point. */
|
|
ctf_file_t *
|
|
ctf_arc_open_by_name_sections (const ctf_archive_t *arc,
|
|
const ctf_sect_t *symsect,
|
|
const ctf_sect_t *strsect,
|
|
const char *name,
|
|
int *errp)
|
|
{
|
|
if (arc->ctfi_is_archive)
|
|
{
|
|
ctf_file_t *ret;
|
|
ret = ctf_arc_open_by_name_internal (arc->ctfi_archive, symsect, strsect,
|
|
name, errp);
|
|
if (ret)
|
|
ret->ctf_archive = (ctf_archive_t *) arc;
|
|
return ret;
|
|
}
|
|
|
|
if ((name != NULL) && (strcmp (name, _CTF_SECTION) != 0))
|
|
{
|
|
if (errp)
|
|
*errp = ECTF_ARNNAME;
|
|
return NULL;
|
|
}
|
|
arc->ctfi_file->ctf_archive = (ctf_archive_t *) arc;
|
|
|
|
/* Bump the refcount so that the user can ctf_file_close() it. */
|
|
arc->ctfi_file->ctf_refcnt++;
|
|
return arc->ctfi_file;
|
|
}
|
|
|
|
/* Return the ctf_file_t with the given name, or NULL if none, setting 'err' if
|
|
non-NULL. A name of NULL means to open the default file.
|
|
|
|
Public entry point. */
|
|
ctf_file_t *
|
|
ctf_arc_open_by_name (const ctf_archive_t *arc, const char *name, int *errp)
|
|
{
|
|
const ctf_sect_t *symsect = &arc->ctfi_symsect;
|
|
const ctf_sect_t *strsect = &arc->ctfi_strsect;
|
|
|
|
if (symsect->cts_name == NULL)
|
|
symsect = NULL;
|
|
if (strsect->cts_name == NULL)
|
|
strsect = NULL;
|
|
|
|
return ctf_arc_open_by_name_sections (arc, symsect, strsect, name, errp);
|
|
}
|
|
|
|
/* Return the ctf_file_t at the given ctfa_ctfs-relative offset, or NULL if
|
|
none, setting 'err' if non-NULL. */
|
|
static ctf_file_t *
|
|
ctf_arc_open_by_offset (const struct ctf_archive *arc,
|
|
const ctf_sect_t *symsect,
|
|
const ctf_sect_t *strsect, size_t offset,
|
|
int *errp)
|
|
{
|
|
ctf_sect_t ctfsect;
|
|
ctf_file_t *fp;
|
|
|
|
ctf_dprintf ("ctf_arc_open_by_offset(%lu): opening\n", (unsigned long) offset);
|
|
|
|
memset (&ctfsect, 0, sizeof (ctf_sect_t));
|
|
|
|
offset += le64toh (arc->ctfa_ctfs);
|
|
|
|
ctfsect.cts_name = _CTF_SECTION;
|
|
ctfsect.cts_size = le64toh (*((uint64_t *) ((char *) arc + offset)));
|
|
ctfsect.cts_entsize = 1;
|
|
ctfsect.cts_data = (void *) ((char *) arc + offset + sizeof (uint64_t));
|
|
fp = ctf_bufopen (&ctfsect, symsect, strsect, errp);
|
|
if (fp)
|
|
ctf_setmodel (fp, le64toh (arc->ctfa_model));
|
|
return fp;
|
|
}
|
|
|
|
/* Raw iteration over all CTF files in an archive. We pass the raw data for all
|
|
CTF files in turn to the specified callback function. */
|
|
static int
|
|
ctf_archive_raw_iter_internal (const struct ctf_archive *arc,
|
|
ctf_archive_raw_member_f *func, void *data)
|
|
{
|
|
int rc;
|
|
size_t i;
|
|
struct ctf_archive_modent *modent;
|
|
const char *nametbl;
|
|
|
|
modent = (ctf_archive_modent_t *) ((char *) arc
|
|
+ sizeof (struct ctf_archive));
|
|
nametbl = (((const char *) arc) + le64toh (arc->ctfa_names));
|
|
|
|
for (i = 0; i < le64toh (arc->ctfa_nfiles); i++)
|
|
{
|
|
const char *name;
|
|
char *fp;
|
|
|
|
name = &nametbl[le64toh (modent[i].name_offset)];
|
|
fp = ((char *) arc + le64toh (arc->ctfa_ctfs)
|
|
+ le64toh (modent[i].ctf_offset));
|
|
|
|
if ((rc = func (name, (void *) (fp + sizeof (uint64_t)),
|
|
le64toh (*((uint64_t *) fp)), data)) != 0)
|
|
return rc;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/* Raw iteration over all CTF files in an archive: public entry point.
|
|
|
|
Returns -EINVAL if not supported for this sort of archive. */
|
|
int
|
|
ctf_archive_raw_iter (const ctf_archive_t *arc,
|
|
ctf_archive_raw_member_f * func, void *data)
|
|
{
|
|
if (arc->ctfi_is_archive)
|
|
return ctf_archive_raw_iter_internal (arc->ctfi_archive, func, data);
|
|
|
|
return -EINVAL; /* Not supported. */
|
|
}
|
|
|
|
/* Iterate over all CTF files in an archive. We pass all CTF files in turn to
|
|
the specified callback function. */
|
|
static int
|
|
ctf_archive_iter_internal (const ctf_archive_t *wrapper,
|
|
const struct ctf_archive *arc,
|
|
const ctf_sect_t *symsect,
|
|
const ctf_sect_t *strsect,
|
|
ctf_archive_member_f *func, void *data)
|
|
{
|
|
int rc;
|
|
size_t i;
|
|
ctf_file_t *f;
|
|
struct ctf_archive_modent *modent;
|
|
const char *nametbl;
|
|
|
|
modent = (ctf_archive_modent_t *) ((char *) arc
|
|
+ sizeof (struct ctf_archive));
|
|
nametbl = (((const char *) arc) + le64toh (arc->ctfa_names));
|
|
|
|
for (i = 0; i < le64toh (arc->ctfa_nfiles); i++)
|
|
{
|
|
const char *name;
|
|
|
|
name = &nametbl[le64toh (modent[i].name_offset)];
|
|
if ((f = ctf_arc_open_by_name_internal (arc, symsect, strsect,
|
|
name, &rc)) == NULL)
|
|
return rc;
|
|
|
|
f->ctf_archive = (ctf_archive_t *) wrapper;
|
|
if ((rc = func (f, name, data)) != 0)
|
|
{
|
|
ctf_file_close (f);
|
|
return rc;
|
|
}
|
|
|
|
ctf_file_close (f);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/* Iterate over all CTF files in an archive: public entry point. We pass all
|
|
CTF files in turn to the specified callback function. */
|
|
int
|
|
ctf_archive_iter (const ctf_archive_t *arc, ctf_archive_member_f *func,
|
|
void *data)
|
|
{
|
|
const ctf_sect_t *symsect = &arc->ctfi_symsect;
|
|
const ctf_sect_t *strsect = &arc->ctfi_strsect;
|
|
|
|
if (symsect->cts_name == NULL)
|
|
symsect = NULL;
|
|
if (strsect->cts_name == NULL)
|
|
strsect = NULL;
|
|
|
|
if (arc->ctfi_is_archive)
|
|
return ctf_archive_iter_internal (arc, arc->ctfi_archive, symsect, strsect,
|
|
func, data);
|
|
|
|
return func (arc->ctfi_file, _CTF_SECTION, data);
|
|
}
|
|
|
|
#ifdef HAVE_MMAP
|
|
/* Map the header in. Only used on new, empty files. */
|
|
static void *arc_mmap_header (int fd, size_t headersz)
|
|
{
|
|
void *hdr;
|
|
if ((hdr = mmap (NULL, headersz, PROT_READ | PROT_WRITE, MAP_SHARED, fd,
|
|
0)) == MAP_FAILED)
|
|
return NULL;
|
|
return hdr;
|
|
}
|
|
|
|
/* mmap() the whole file, for reading only. (Map it writably, but privately: we
|
|
need to modify the region, but don't need anyone else to see the
|
|
modifications.) */
|
|
static void *arc_mmap_file (int fd, size_t size)
|
|
{
|
|
void *arc;
|
|
if ((arc = mmap (NULL, size, PROT_READ | PROT_WRITE, MAP_PRIVATE,
|
|
fd, 0)) == MAP_FAILED)
|
|
return NULL;
|
|
return arc;
|
|
}
|
|
|
|
/* Persist the header to disk. */
|
|
static int arc_mmap_writeout (int fd _libctf_unused_, void *header,
|
|
size_t headersz, const char **errmsg)
|
|
{
|
|
if (msync (header, headersz, MS_ASYNC) < 0)
|
|
{
|
|
if (errmsg)
|
|
*errmsg = "arc_mmap_writeout(): Cannot sync after writing to %s: %s\n";
|
|
return -1;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/* Unmap the region. */
|
|
static int arc_mmap_unmap (void *header, size_t headersz, const char **errmsg)
|
|
{
|
|
if (munmap (header, headersz) < 0)
|
|
{
|
|
if (errmsg)
|
|
*errmsg = "arc_mmap_munmap(): Cannot unmap after writing to %s: %s\n";
|
|
return -1;
|
|
}
|
|
return 0;
|
|
}
|
|
#else
|
|
/* Map the header in. Only used on new, empty files. */
|
|
static void *arc_mmap_header (int fd _libctf_unused_, size_t headersz)
|
|
{
|
|
void *hdr;
|
|
if ((hdr = malloc (headersz)) == NULL)
|
|
return NULL;
|
|
return hdr;
|
|
}
|
|
|
|
/* Pull in the whole file, for reading only. We assume the current file
|
|
position is at the start of the file. */
|
|
static void *arc_mmap_file (int fd, size_t size)
|
|
{
|
|
char *data;
|
|
|
|
if ((data = malloc (size)) == NULL)
|
|
return NULL;
|
|
|
|
if (ctf_pread (fd, data, size, 0) < 0)
|
|
{
|
|
free (data);
|
|
return NULL;
|
|
}
|
|
return data;
|
|
}
|
|
|
|
/* Persist the header to disk. */
|
|
static int arc_mmap_writeout (int fd, void *header, size_t headersz,
|
|
const char **errmsg)
|
|
{
|
|
ssize_t len;
|
|
size_t acc = 0;
|
|
char *data = (char *) header;
|
|
ssize_t count = headersz;
|
|
|
|
if ((lseek (fd, 0, SEEK_SET)) < 0)
|
|
{
|
|
if (errmsg)
|
|
*errmsg = "arc_mmap_writeout(): Cannot seek while writing header to "
|
|
"%s: %s\n";
|
|
return -1;
|
|
}
|
|
|
|
while (headersz > 0)
|
|
{
|
|
if ((len = write (fd, data, count)) < 0)
|
|
{
|
|
if (errmsg)
|
|
*errmsg = "arc_mmap_writeout(): Cannot write header to %s: %s\n";
|
|
return len;
|
|
}
|
|
if (len == EINTR)
|
|
continue;
|
|
|
|
acc += len;
|
|
if (len == 0) /* EOF. */
|
|
break;
|
|
|
|
count -= len;
|
|
data += len;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/* Unmap the region. */
|
|
static int arc_mmap_unmap (void *header, size_t headersz _libctf_unused_,
|
|
const char **errmsg _libctf_unused_)
|
|
{
|
|
free (header);
|
|
return 0;
|
|
}
|
|
#endif
|