ctf-spec
ctf-spec
Version 3
Nick Alcock
Copyright c 2021-2024 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document under the terms
of the GNU General Public License, Version 3 or any later version published by the Free
Software Foundation. A copy of the license is included in the section entitled “GNU General
Public License”.
i
Table of Contents
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1 CTF archives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2 CTF dictionaries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.1 CTF Preamble . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.1.1 CTF file-wide flags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 CTF header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.3 The type section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.3.1 The info word, ctt info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.3.2 Type indexes and type IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.3.3 Type kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.3.4 Integer types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.3.5 Floating-point types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.3.6 Slices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.3.7 Pointers, typedefs, and cvr-quals . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.3.8 Arrays. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.3.9 Function pointers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.3.10 Enums . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.3.11 Structs and unions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.3.12 Forward declarations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.4 The symtypetab sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
2.5 The variable section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.6 The label section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.7 The string section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.8 Data models. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.9 Limits of CTF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
1
Overview
The CTF file format compactly describes C types and the association between function and
data symbols and types: if embedded in ELF objects, it can exploit the ELF string table to
reduce duplication further. There is no real concept of namespacing: only top-level types
are described, not types scoped to within single functions.
CTF dictionaries can be children of other dictionaries, in a one-level hierarchy: child
dictionaries can refer to types in the parent, but the opposite is not sensible (since if you
refer to a child type in the parent, the actual type you cited would vary depending on what
child was attached). This parent/child definition is recorded in the child, but only as a
recommendation: users of the API have to attach parents to children explicitly, and can
choose to attach a child to any parent they like, or to none, though doing so might lead to
unpleasant consequences like dangling references to types. See Section 2.3.2 [Type indexes
and type IDs], page 9. Type lookups in child dicts that are not associated with a parent at
all will fail with ECTF_NOPARENT if a parent type was needed.
The associated API to generate, merge together, and query this file format will be
described in the accompanying libctf manual once it is written. There is no API to modify
dictionaries once they’ve been written out: CTF is a write-once file format. (However, it is
always possible to dynamically create a new child dictionary on the fly and attach it to a
pre-existing, read-only parent.)
There are two major pieces to CTF: the archive and the dictionary. Some relatives and
ancestors of CTF call dictionaries containers: the archive format is unique to this variant of
CTF. (Much of the source code still uses the old term.)
The archive file format is a very simple mmappable archive used to group multiple
dictionaries together into groups: it is expected to slowly go away and be replaced by
other mechanisms, but right now it is an important part of the file format, used to group
dictionaries containing types with conflicting definitions in different TUs with the overarching
dictionary used to store all other types. (Even when archives go away, the libctf API used
to access them will remain, and access the other mechanisms that replace it instead.)
The CTF dictionary consists of a preamble, which does not vary between versions of
the CTF file format, and a header and some number of sections, which can vary between
versions.
The rest of this specification describes the format of these sections, first for the latest
version of CTF, then for all earlier versions supported by libctf: the earlier versions are
defined in terms of their differences from the next later one. We describe each part of the
format first by reproducing the C structure which defines that part, then describing it at
greater length in terms of file offsets.
The description of the file format ends with a description of relevant limits that apply to
it. These limits can vary between file format versions.
This document is quite young, so for now the C code in ctf.h should be presumed correct
when this document conflicts with it.
2
1 CTF archives
The CTF archive format maps names to CTF dictionaries. The names may contain any
character other than \0, but for now archives containing slashes in the names may not
extract correctly. It is possible to insert multiple members with the same name, but these
are quite hard to access reliably (you have to iterate through all the members rather than
opening by name) so this is not recommended.
CTF archives are not themselves compressed: the constituent components, CTF dictio-
naries, can be compressed. (See Section 2.2 [CTF header], page 5).
CTF archives usually contain a collection of related dictionaries, one parent and many
children of that parent. CTF archives can have a member with a default name, .ctf (which
can be represented as NULL in the API). If present, this member is usually the parent of all
the children, but it is possible for CTF producers to emit parents with different names if
they wish (usually for backward- compatibility purposes).
.ctf sections in ELF objects consist of a single CTF dictionary rather than an archive of
dictionaries if and only if the section contains no types with identical names but conflicting
definitions: if two conflicting definitions exist, the deduplicator will place the type most
commonly referred to by other types in the parent and will place the other type in a child
named after the translation unit it is found in, and will emit a CTF archive containing both
dictionaries instead of a raw dictionary. All types that refer to such conflicting types are
also placed in the per-translation-unit child.
The definition of an archive in ctf.h is as follows:
struct ctf_archive
{
uint64_t ctfa_magic;
uint64_t ctfa_model;
uint64_t ctfa_nfiles;
uint64_t ctfa_names;
uint64_t ctfa_ctfs;
};
0x08 uint64_t ctfa_model The data model for this archive: an arbitrary integer
that serves no purpose but to be handed back by the
libctf API. See Section 2.8 [Data models], page 20.
0x18 uint64_t ctfa_names Offset of the name table, in bytes from the start of
the archive. The name table is an array of struct
ctf_archive_modent_t[ctfa_nfiles].
0x20 uint64_t ctfa_ctfs Offset of the CTF table. Each element starts with a
uint64_t size, followed by a CTF dictionary.
The ctfa_names array is sorted into ASCIIbetical order by name (i.e. by the result of
dereferencing the name_offset).
The archive file also contains a name table and a table of CTF dictionaries: these are
pointed to by the structures above. The name table is a simple strtab which is not required
to be sorted; the dictionary array is described above in the entry for ctfa_ctfs.
The relative order of these various parts is not defined, except that the header naturally
always comes first.
4
2 CTF dictionaries
CTF dictionaries consist of a header, starting with a premable, and a number of sections.
0x02 unsigned char ctp_version The version number of this CTF dictio-
nary.
0x03 ctp_flags Flags for this CTF file. See Section 2.1.1
[CTF file-wide flags], page 5.
Every element of a dictionary must be naturally aligned unless otherwise specified. (This
restriction will be lifted in later versions.)
CTF dictionaries are stored in the native endianness of the system that generates them:
the consumer (e.g., libctf) can detect whether to endian-flip a CTF dictionary by inspecting
the ctp_magic. (If it appears as 0xf2df, endian-flipping is needed.)
The version of the CTF dictionary can be determined by inspecting ctp_version. The
following versions are currently valid, and libctf can read all of them:
Version Number Description
CTF_VERSION_1 1 First version, rare. Very similar to Solaris CTF.
uint32_t cth_typeoff;
uint32_t cth_stroff;
uint32_t cth_strlen;
} ctf_header_t;
In detail:
0x1c uint32_t cth_cuname The name of the compilation unit, for consumers like
GDB that want to know the name of CUs associated
with single CUs: a strtab offset. 0 if this dictionary
describes types from many CUs.
0x10 uint32_t cth_lbloff The offset of the label section, which tiles the type
space into named regions. See Section 2.6 [The label
section], page 20.
0x14 uint32_t cth_objtoff The offset of the data object symtypetab section,
which maps ELF data symbols to types. See
Section 2.4 [The symtypetab sections], page 18.
0x18 uint32_t cth_funcoff The offset of the function info symtypetab section,
which maps ELF function symbols to a return type
and arg types. See Section 2.4 [The symtypetab sec-
tions], page 18.
0x1c uint32_t cth_objtidxoff The offset of the object index section, which maps ELF
object symbols to entries in the data object section.
See Section 2.4 [The symtypetab sections], page 18.
Chapter 2: CTF dictionaries 7
0x20 uint32_t cth_funcidxoff The offset of the function info index section, which
maps ELF function symbols to entries in the function
info section. See Section 2.4 [The symtypetab sections],
page 18.
0x24 uint32_t cth_varoff The offset of the variable section, which maps string
names to types. See Section 2.5 [The variable section],
page 19.
0x28 uint32_t cth_typeoff The offset of the type section, the core of CTF, which
describes types using variable-length array elements.
See Section 2.3 [The type section], page 7.
0x2c uint32_t cth_stroff The offset of the string section. See Section 2.7 [The
string section], page 20.
0x30 uint32_t cth_strlen The length of the string section (not an offset!). The
CTF file ends at this point.
Everything from this point on (until the end of the file at cth_stroff + cth_strlen) is
compressed with zlib if CTF_F_COMPRESS is set in the preamble’s ctp_flags.
} ctf_type_t;
Here’s the much more common smaller form:
typedef struct ctf_stype
{
uint32_t ctt_name;
uint32_t ctt_info;
__extension__
union
{
uint32_t ctt_size;
uint32_t ctt_type;
};
} ctf_stype_t;
If ctt_size is the #define CTF_LSIZE_SENT, 0xffffffff, this type is described by a ctf_
type_t: otherwise, a ctf_stype_t.
Here’s what the fields mean:
Offset Name Description
0x00 uint32_t ctt_name Strtab offset of the type name, if any (0 if none).
0x04 uint32_t ctt_info The info word, containing information on the kind
of this type, its variable-length data and whether
it is visible to name lookup. See See Section 2.3.1
[The info word], page 9.
0x08 uint32_t ctt_size The size of this type, if this type is of a kind for
which a size needs to be recorded (constant-size
types don’t need one). If this is CTF_LSIZE_SENT,
this type is a huge type described by ctf_type_t.
0x08 uint32_t ctt_type The type this type refers to, if this type is of a
kind which refers to other types (like a pointer).
All such types are fixed-size, and no types that are
variable-size refer to other types, so ctt_size and
ctt_type overlap. All type kinds that use ctt_
type are described by ctf_stype_t, not ctf_
type_t. See Section 2.3.2 [Type indexes and type
IDs], page 9.
0x0c (ctf_type_t uint32_t ctt_lsizehi The high 32 bits of the size of a very large type.
only) The CTF_TYPE_LSIZE macro can be used to get a
64-bit size out of this field and the next one. CTF_
SIZE_TO_LSIZE_HI splits the ctt_lsizehi out of
it again.
Chapter 2: CTF dictionaries 9
0x10 (ctf_type_t uint32_t ctt_lsizelo The low 32 bits of the size of a very large type.
only) CTF_SIZE_TO_LSIZE_LO splits the ctt_lsizelo
out of a 64-bit size.
Two aspects of this need further explanation: the info word, and what exactly a type ID
is and how you determine it. (Information on the various type-kind- dependent things, like
whether ctt_size or ctt_type is used, is described in the section devoted to each kind.)
0–24 vlen Length of variable-length data for this type (some kinds only).
The variable-length data directly follows the ctf_type_t or ctf_
stype_t. This is a kind-dependent array length value, not a
length in bytes. Some kinds have no variable-length data, or
fixed-size variable-length data, and do not use this value.
The most mysterious of these is undoubtedly isroot. This indicates whether types with
names (nonzero ctt_name) are visible to name lookup: if zero, this type is considered a
non-root type and you can’t look it up by name at all. Multiple types with the same name
in the same C namespace (struct, union, enum, other) can exist in a single dictionary, but
only one of them may have a nonzero value for isroot. libctf validates this at open time
and refuses to open dictionaries that violate this constraint.
Historically, this feature was introduced for the encoding of bitfields (see Section 2.3.4
[Integer types], page 12): for instance, int bitfields will all be named int with different
widths or offsets, but only the full-width one at offset zero is wanted when you look up the
type named int. With the introduction of slices (see Section 2.3.6 [Slices], page 14) as a
more general bitfield encoding mechanism, this is less important, but we still use non-root
types to handle conflicts if the linker API is used to fuse multiple translation units into one
dictionary and those translation units contain types with the same name and conflicting
definitions. (We do not discuss this further here, because the linker never does this: only
specialized type mergers do, like that used for the Linux kernel. The libctf documentation
will describe this in more detail.)
The CTF_TYPE_INFO macro can be used to compose an info word from a kind, isroot,
and vlen; CTF_V2_INFO_KIND, CTF_V2_INFO_ISROOT and CTF_V2_INFO_VLEN pick it apart
again.
These IDs appear in ctf_type_t.ctt_type (see Section 2.3 [The type section], page 7),
but the types themselves have no visible ID: quite intentionally, because adding an ID uses
space, and every ID is different so they don’t compress well. The IDs are implicit: at open
time, the consumer walks through the entire type section and counts the types in the type
section. The type section is an array of variable-length elements, so each entry could be
considered as having an index, starting from 1. We count these indexes and associate each
with its corresponding ctf_type_t or ctf_stype_t.
Lookups of types with IDs in the parent space look in the parent dictionary if this
dictionary has one associated with it; lookups of types with IDs in the child space error
out if the dictionary does not have a parent, and otherwise convert the ID into an index by
shaving off the top bit and look up the index in the child.
These properties mean that the same dictionary can be used as a parent of child
dictionaries and can also be used directly with no children at all, but a dictionary created as
a child dictionary must always be associated with a parent — usually, the same parent —
because its references to its own types have the high bit turned on and this is only flipped
off again if this is a child dictionary. (This is not a problem, because if you don’t associate
the child with a parent, any references within it to its parent types will fail, and there are
almost certain to be many such references, or why is it a child at all?)
This does mean that consumers should keep a close eye on the distinction between type
IDs and type indexes: if you mix them up, everything will appear to work as long as you’re
only using parent dictionaries or standalone dictionaries, but as soon as you start using
children, everything will fail horribly.
Type index zero, and type ID zero, are used to indicate that this type cannot be
represented in CTF as currently constituted: they are emitted by the compiler, but all type
chains that terminate in the unknown type are erased at link time (structure fields that
use them just vanish, etc). So you will probably never see a use of type zero outside the
symtypetab sections, where they serve as sentinels of sorts, to indicate symbols with no
associated type.
The macros CTF_V2_TYPE_TO_INDEX and CTF_V2_INDEX_TO_TYPE may help in translation
between types and indexes: CTF_V2_TYPE_ISPARENT and CTF_V2_TYPE_ISCHILD can be used
to tell whether a given ID is in the parent or child range.
It is quite possible and indeed common for type IDs to point forward in the dictionary,
as well as backward.
Yes, integers are rare: how many kinds of int are there in a program? They’re just very
frequently referenced.)
Here’s the set of kinds so far. Each kind has a #define associated with it, also given
here.
Kind Macro Purpose
0 CTF_K_UNKNOWN Indicates a type that cannot be represented in CTF, or that is
being skipped. It is very similar to type ID 0, except that you
can have multiple, distinct types of kind CTF_K_UNKNOWN.
1 CTF_K_INTEGER An integer type. See Section 2.3.4 [Integer types], page 12.
6 CTF_K_STRUCT A structure. See Section 2.3.11 [Structs and unions], page 17.
7 CTF_K_UNION A union. See Section 2.3.11 [Structs and unions], page 17.
16–23 Offset The offset of this integral type in bits from the start of
its enclosing structure field, adjusted for endianness: see
Section 2.3.11 [Structs and unions], page 17. You can
extract this field with the CTF_INT_OFFSET macro.
0–15 Bit-width The width of this integral type in bits. You can extract
this field with the CTF_INT_BITS macro.
If you choose, bitfields can be represented using the things above as a sort of integral
type with the isroot bit flipped off and the offset and bits values set in the vlen word: you
can populate it with the CTF_INT_DATA macro. (But it may be more convenient to represent
them using slices of a full-width integer: see Section 2.3.6 [Slices], page 14.)
Integers that are bitfields usually have a ctt_size rounded up to the nearest power
of two in bytes, for natural alignment (e.g. a 17-bit integer would have a ctt_size of 4).
However, not all types are naturally aligned on all architectures: packed structures may in
theory use integral bitfields with different ctt_size, though this is rarely observed.
The encoding for integers is a bit-field comprised of the values below, which consumers
can use to decide how to display values of this type:
Offset Name Description
0x01 CTF_INT_SIGNED If set, this is a signed int: if false, unsigned.
0x04 CTF_INT_BOOL If set, this is a boolean type. (It is theoretically possible to turn this and
CTF_INT_CHAR on at the same time, but it is not clear what this would
mean.)
16–23 Offset The offset of this floating-point type in bits from the start of its
enclosing structure field, adjusted for endianness: see Section 2.3.11
[Structs and unions], page 17. You can extract this field with the
CTF_FP_OFFSET macro.
0–15 Bit-width The width of this floating-point type in bits. You can extract this
field with the CTF_FP_BITS macro.
The purpose of the floating-point offset and bit-width is somewhat opaque, since there
are no such things as floating-point bitfields in C: the bit-width should be filled out with the
full width of the type in bits, and the offset should always be zero. It is likely that these
fields will go away in the future. As with integers, you can use CTF_FP_DATA to assemble
one of these vlen items from its component parts.
The encoding for floats is not a bitfield but a simple value indicating the display
representation. Many of these are unused, relate to Solaris-specific compiler extensions, and
will be recycled in future: some are unused and will become used in future.
Offset Name Description
1 CTF_FP_SINGLE This is a single-precision IEEE 754 float.
2 CTF_FP_DOUBLE This is a double-precision IEEE 754 double.
3 CTF_FP_CPLX This is a Complex float.
4 CTF_FP_DCPLX This is a Complex double.
5 CTF_FP_LDCPLX This is a Complex long double.
6 CTF_FP_LDOUBLE This is a long double.
7 CTF_FP_INTRVL This is a float interval type, a Solaris-specific extension.
Unused: will be recycled.
8 CTF_FP_DINTRVL This is a double interval type, a Solaris-specific extension.
Unused: will be recycled.
9 CTF_FP_LDINTRVL This is a long double interval type, a Solaris-specific exten-
sion. Unused: will be recycled.
10 CTF_FP_IMAGRY This is a the imaginary part of a Complex float. Not
currently generated. May change.
11 CTF_FP_DIMAGRY This is a the imaginary part of a Complex double. Not
currently generated. May change.
12 CTF_FP_LDIMAGRY This is a the imaginary part of a Complex long double.
Not currently generated. May change.
Chapter 2: CTF dictionaries 14
The use of the complex floating-point encodings is obscure: it is possible that CTF_FP_
CPLX is meant to be used for only the real part of complex types, and CTF_FP_IMAGRY et al
for the imaginary part – but for now, we are emitting CTF_FP_CPLX to cover the entire type,
with no way to get at its constituent parts. There appear to be no uses of these encodings
anywhere, so they are quite likely to change incompatibly in future.
2.3.6 Slices
Slices, with kind CTF_K_SLICE, are an unusual CTF construct: they do not directly corre-
spond to any C type, but are a way to model other types in a more convenient fashion for
CTF generators.
A slice is like a pointer or other reference type in that they are always represented by
ctf_stype_t: but unlike pointers and other reference types, they populate the ctt_size
field just like integral types do, and come with an attached encoding and transform the
encoding of the underlying type. The underlying type is described in the variable-length
data, similarly to structure and union fields: see below. Requests for the type size should
also chase down to the referenced type.
(The libctf API behaviour is unusual as well, and justifies the existence of slices:
ctf_type_kind never returns CTF_K_SLICE but always the underlying type kind, so that
consumers never need to know about slices: they can tell if an apparent integer is actually
a slice if they need to by calling ctf_type_reference, which will uniquely return the
underlying integral type rather than erroring out with ECTF_NOTREF if this is actually a slice.
So slices act just like an integer with an encoding, but more closely mirror DWARF and
other debugging information formats by allowing CTF file creators to represent a bitfield as
a slice of an underlying integral type.)
The vlen in the info word for a slice should be ignored and is always zero. The variable-
length data for a slice is a single ctf_slice_t:
0x4 unsigned short cts_offset The offset of this integral type in bits from the
start of its enclosing structure field, adjusted
for endianness: see Section 2.3.11 [Structs
and unions], page 17. Identical semantics to
the CTF_INT_OFFSET field: see Section 2.3.4
[Integer types], page 12. This field is much
too long, because the maximum possible off-
set of an integral type would easily fit in a
char: this field is bigger just for the sake of
alignment. This will change in v4.
0x6 unsigned short cts_bits The bit-width of this integral type. Identi-
cal semantics to the CTF_INT_BITS field: see
Section 2.3.4 [Integer types], page 12. As
above, this field is really too large and will
shrink in v4.
2.3.8 Arrays
Arrays are encoded as types of kind CTF_K_ARRAY in a ctf_stype_t. Both size and kind for
arrays are zero. The variable-length data is a ctf_array_t: vlen in the info word should
be disregarded and is always zero.
typedef struct ctf_array
{
uint32_t cta_contents;
uint32_t cta_index;
uint32_t cta_nelems;
} ctf_array_t;
Offset Name Description
0x0 uint32_t cta_contents The type of the array elements: a type ID.
Chapter 2: CTF dictionaries 16
2.3.10 Enums
Enumerated types are represented as types of kind CTF_K_ENUM in a ctf_stype_t. The
ctt_size is always the size of an int from the data model (enum bitfields are implemented via
slices). The vlen is a count of enumerations, each of which is represented by a ctf_enum_t
in the vlen:
typedef struct ctf_enum
{
uint32_t cte_name;
int32_t cte_value;
} ctf_enum_t;
Offset Name Description
0x0 uint32_t cte_name Strtab offset of the enumeration name.
Must not be 0.
Enumeration values larger than 23 2 are not yet supported and are omitted from the
enumeration. (v4 will lift this restriction by encoding the value differently.)
Forward declarations of enums are not implemented with this kind: see Section 2.3.12
[Forward declarations], page 18.
Enumerated type names, as usual in C, go into their own namespace, and do not conflict
with non-enums, structs, or unions with the same name.
Chapter 2: CTF dictionaries 17
0x04 uint32_t ctm_offset The offset of this field in bits. (Usually, for bitfields, this is
machine-word-aligned and the individual field has an offset
in bits, but the format allows for the offset to be encoded in
bits here.)
0x04 uint32_t ctlm_offsethi The high 32 bits of the offset of this field in bits.
Chapter 2: CTF dictionaries 18
0x0c uint32_t ctlm_offsetlo The low 32 bits of the offset of this field in bits.
Macros CTF_LMEM_OFFSET, CTF_OFFSET_TO_LMEMHI and CTF_OFFSET_TO_LMEMLO serve
to extract and install the values of the ctlm_offset fields, much as with the split size fields
in ctf_type_t.
Unnamed structure and union fields are simply implemented by collapsing the unnamed
field’s members into the containing structure or union: this does mean that a structure
containing an unnamed union can end up being a “structure” with multiple members at the
same offset. (A future format revision may collapse CTF_K_STRUCT and CTF_K_UNION into
the same kind and decide among them based on whether their members do in fact overlap.)
Structure and union type names, as usual in C, go into their own namespace, just as
enum type names do.
Forward declarations of structures and unions are not implemented with this kind: see
Section 2.3.12 [Forward declarations], page 18.
Index
A ctf lblent t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
alignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 ctf lblent t, ctl label . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
archive, CTF archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 ctf lblent t, ctl type . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 ctf lmember t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
ctf lmember t, ctlm name . . . . . . . . . . . . . . . . . . . . . 17
ctf lmember t, ctlm offsethi . . . . . . . . . . . . . . . . . . . . 17
B ctf lmember t, ctlm offsetlo . . . . . . . . . . . . . . . . . . . . 18
ctf member t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
bool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 ctf member t, ctlm type . . . . . . . . . . . . . . . . . . . . . . . 18
Bug workarounds, CTF F DYNSTR. . . . . . . . 18, 20 ctf member t, ctm name . . . . . . . . . . . . . . . . . . . . . . . 17
ctf member t, ctm offset . . . . . . . . . . . . . . . . . . . . . . . 17
ctf member t, ctm type . . . . . . . . . . . . . . . . . . . . . . . . 17
C ctf offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
char . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 ctf preamble t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Child range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 ctf preamble t, ctp flags . . . . . . . . . . . . . . . . . . . . . . . . 4
Complex, double . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 ctf preamble t, ctp magic . . . . . . . . . . . . . . . . . . . . . . . 4
Complex, float . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 ctf preamble t, ctp version . . . . . . . . . . . . . . . . . . . . . . 4
Complex, signed double . . . . . . . . . . . . . . . . . . . . . . . . 13 ctf slice t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Complex, signed float . . . . . . . . . . . . . . . . . . . . . . . . . . 13 ctf slice t, cts bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Complex, unsigned double . . . . . . . . . . . . . . . . . . . . . 13 ctf slice t, cts offset. . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Complex, unsigned float . . . . . . . . . . . . . . . . . . . . . . . . 13 ctf slice t, cts type . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
const . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 ctf stype t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
cta contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 ctf stype t, ctt info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
cta index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 ctf stype t, ctt size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
cta nelems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 ctf stype t, ctt type . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
cte name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 ctf type t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
cte value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 ctf type t, ctt info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
ctf archive modent t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 ctf type t, ctt lsizehi . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
ctf archive modent t, ctf offset . . . . . . . . . . . . . . . . . . 3 ctf type t, ctt lsizelo . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
ctf archive modent t, name offset . . . . . . . . . . . . . . . 3 ctf type t, ctt size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
ctf array t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 ctf varent t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
ctf array t, cta contents . . . . . . . . . . . . . . . . . . . . . . . 15 ctf varent t, ctv name . . . . . . . . . . . . . . . . . . . . . . . . . 19
ctf array t, cta index . . . . . . . . . . . . . . . . . . . . . . . . . . 16 ctf varent t, ctv type . . . . . . . . . . . . . . . . . . . . . . . . . . 19
ctf array t, cta nelems . . . . . . . . . . . . . . . . . . . . . . . . . 16 CTF header. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
ctf enum t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 CTF versions, versions . . . . . . . . . . . . . . . . . . . . . . . . . . 4
ctf enum t, cte name . . . . . . . . . . . . . . . . . . . . . . . . . . 16 CTF CHAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
ctf enum t, cte value . . . . . . . . . . . . . . . . . . . . . . . . . . 16 CTF F COMPRESS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
ctf header t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 CTF F DYNSTR. . . . . . . . . . . . . . . . . . . . . . . . 5, 18, 20
ctf header t, cth cuname . . . . . . . . . . . . . . . . . . . . . . . . 6 CTF F IDXSORTED . . . . . . . . . . . . . . . . . . . . . . . 5, 18
ctf header t, cth flags . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 CTF F NEWFUNCINFO . . . . . . . . . . . . . . . . . . . . . . . 5
ctf header t, cth funcidxoff . . . . . . . . . . . . . . . . . . . . . 7 CTF FP BITS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ctf header t, cth funcoff . . . . . . . . . . . . . . . . . . . . . . . . 6 CTF FP CPLX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ctf header t, cth lbloff . . . . . . . . . . . . . . . . . . . . . . . . . . 6 CTF FP DCPLX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ctf header t, cth magic . . . . . . . . . . . . . . . . . . . . . . . . . 4 CTF FP DIMAGRY. . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ctf header t, cth objtidxoff. . . . . . . . . . . . . . . . . . . . . . 6 CTF FP DINTRVL . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ctf header t, cth objtoff . . . . . . . . . . . . . . . . . . . . . . . . . 6 CTF FP DOUBLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ctf header t, cth parlabel . . . . . . . . . . . . . . . . . . . . . . . 6 CTF FP ENCODING . . . . . . . . . . . . . . . . . . . . . . . . . 13
ctf header t, cth parname . . . . . . . . . . . . . . . . . . . . . . . 6 CTF FP IMAGRY . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ctf header t, cth preamble . . . . . . . . . . . . . . . . . . . . . . 6 CTF FP INTRVL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ctf header t, cth strlen . . . . . . . . . . . . . . . . . . . . . . . . . . 7 CTF FP LDCPLX . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ctf header t, cth stroff . . . . . . . . . . . . . . . . . . . . . . . . . . 7 CTF FP LDIMAGRY . . . . . . . . . . . . . . . . . . . . . . . . . 13
ctf header t, cth typeoff . . . . . . . . . . . . . . . . . . . . . . . . 7 CTF FP LDINTRVL . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ctf header t, cth varoff . . . . . . . . . . . . . . . . . . . . . . . . . . 7 CTF FP LDOUBLE . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ctf header t, cth version . . . . . . . . . . . . . . . . . . . . . . . . 4 CTF FP OFFSET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ctf id t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 CTF FP SINGLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Index 23
Symtypetab section . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 U
union . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17, 18
Unions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
T unsigned char . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Type IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 unsigned double. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Type IDs, ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 unsigned float . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Type indexes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 unsigned int . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Type kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 unsigned long . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Type section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 unsigned long long . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Type, IDs of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 unsigned short . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Type, indexes of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Unused bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Type, kinds of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
typedef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Typedefs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Types, floating-point . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
V
Types, integer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Variable section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Types, slices of integral . . . . . . . . . . . . . . . . . . . . . . . . 14 volatile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15