[deliverable/binutils-gdb.git] / include / ctf-api.h

/* Public API to libctf.
   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/>.  */

/* This header file defines the interfaces available from the CTF debugger
   library, libctf.  This API can be used by a debugger to operate on data in
   the Compact ANSI-C Type Format (CTF).  */

#ifndef	_CTF_API_H
#define	_CTF_API_H

#include <sys/param.h>
#include <sys/types.h>
#include <ctf.h>
#include <zlib.h>

#ifdef	__cplusplus
extern "C"
  {
#endif

/* Clients can open one or more CTF containers and obtain a pointer to an
   opaque ctf_file_t.  Types are identified by an opaque ctf_id_t token.
   They can also open or create read-only archives of CTF containers in a
   ctf_archive_t.

   These opaque definitions allow libctf to evolve without breaking clients.  */

typedef struct ctf_file ctf_file_t;
typedef struct ctf_archive_internal ctf_archive_t;
typedef unsigned long ctf_id_t;

/* This opaque definition allows libctf to accept BFD data structures without
   importing all the BFD noise into users' namespaces.  */

struct bfd;

/* If the debugger needs to provide the CTF library with a set of raw buffers
   for use as the CTF data, symbol table, and string table, it can do so by
   filling in ctf_sect_t structures and passing them to ctf_bufopen().

   The contents of this structure must always be in native endianness (no
   byteswapping is performed).  */

typedef struct ctf_sect
{
  const char *cts_name;		  /* Section name (if any).  */
  const void *cts_data;		  /* Pointer to section data.  */
  size_t cts_size;		  /* Size of data in bytes.  */
  size_t cts_entsize;		  /* Size of each section entry (symtab only).  */
} ctf_sect_t;

/* Symbolic names for CTF sections.  */

typedef enum ctf_sect_names
  {
   CTF_SECT_HEADER,
   CTF_SECT_LABEL,
   CTF_SECT_OBJT,
   CTF_SECT_FUNC,
   CTF_SECT_VAR,
   CTF_SECT_TYPE,
   CTF_SECT_STR
  } ctf_sect_names_t;

/* Encoding information for integers, floating-point values, and certain other
   intrinsics can be obtained by calling ctf_type_encoding(), below.  The flags
   field will contain values appropriate for the type defined in <ctf.h>.  */

typedef struct ctf_encoding
{
  uint32_t cte_format;		 /* Data format (CTF_INT_* or CTF_FP_* flags).  */
  uint32_t cte_offset;		 /* Offset of value in bits.  */
  uint32_t cte_bits;		 /* Size of storage in bits.  */
} ctf_encoding_t;

typedef struct ctf_membinfo
{
  ctf_id_t ctm_type;		/* Type of struct or union member.  */
  unsigned long ctm_offset;	/* Offset of member in bits.  */
} ctf_membinfo_t;

typedef struct ctf_arinfo
{
  ctf_id_t ctr_contents;	/* Type of array contents.  */
  ctf_id_t ctr_index;		/* Type of array index.  */
  uint32_t ctr_nelems;		/* Number of elements.  */
} ctf_arinfo_t;

typedef struct ctf_funcinfo
{
  ctf_id_t ctc_return;		/* Function return type.  */
  uint32_t ctc_argc;		/* Number of typed arguments to function.  */
  uint32_t ctc_flags;		/* Function attributes (see below).  */
} ctf_funcinfo_t;

typedef struct ctf_lblinfo
{
  ctf_id_t ctb_type;		/* Last type associated with the label.  */
} ctf_lblinfo_t;

typedef struct ctf_snapshot_id
{
  unsigned long dtd_id;		/* Highest DTD ID at time of snapshot.  */
  unsigned long snapshot_id;	/* Snapshot id at time of snapshot.  */
} ctf_snapshot_id_t;

#define	CTF_FUNC_VARARG	0x1	/* Function arguments end with varargs.  */

/* Functions that return a ctf_id_t use the following value to indicate failure.
   ctf_errno() can be used to obtain an error code.  Functions that return
   a straight integral -1 also use ctf_errno().  */
#define	CTF_ERR	((ctf_id_t) -1L)

#define	ECTF_BASE	1000	/* Base value for libctf errnos.  */


enum
  {
   ECTF_FMT = ECTF_BASE,	/* File is not in CTF or ELF format.  */
   ECTF_BFDERR,			/* BFD error.  */
   ECTF_CTFVERS,		/* CTF version is more recent than libctf.  */
   ECTF_BFD_AMBIGUOUS,		/* Ambiguous BFD target.  */
   ECTF_SYMTAB,			/* Symbol table uses invalid entry size.  */
   ECTF_SYMBAD,			/* Symbol table data buffer invalid.  */
   ECTF_STRBAD,			/* String table data buffer invalid.  */
   ECTF_CORRUPT,		/* File data corruption detected.  */
   ECTF_NOCTFDATA,		/* ELF file does not contain CTF data.  */
   ECTF_NOCTFBUF,		/* Buffer does not contain CTF data.  */
   ECTF_NOSYMTAB,		/* Symbol table data is not available.  */
   ECTF_NOPARENT,		/* Parent CTF container is not available.  */
   ECTF_DMODEL,			/* Data model mismatch.  */
   ECTF_UNUSED,			/* Unused error.  */
   ECTF_ZALLOC,			/* Failed to allocate (de)compression buffer.  */
   ECTF_DECOMPRESS,		/* Failed to decompress CTF data.  */
   ECTF_STRTAB,			/* String table for this string is missing.  */
   ECTF_BADNAME,		/* String offset is corrupt w.r.t. strtab.  */
   ECTF_BADID,			/* Invalid type ID number.  */
   ECTF_NOTSOU,			/* Type is not a struct or union.  */
   ECTF_NOTENUM,		/* Type is not an enum.  */
   ECTF_NOTSUE,			/* Type is not a struct, union, or enum.  */
   ECTF_NOTINTFP,		/* Type is not an integer, float, or enum.  */
   ECTF_NOTARRAY,		/* Type is not an array.  */
   ECTF_NOTREF,			/* Type does not reference another type.  */
   ECTF_NAMELEN,		/* Buffer is too small to hold type name.  */
   ECTF_NOTYPE,			/* No type found corresponding to name.  */
   ECTF_SYNTAX,			/* Syntax error in type name.  */
   ECTF_NOTFUNC,		/* Symbol entry or type is not a function.  */
   ECTF_NOFUNCDAT,		/* No func info available for function.  */
   ECTF_NOTDATA,		/* Symtab entry does not refer to a data obj.  */
   ECTF_NOTYPEDAT,		/* No type info available for object.  */
   ECTF_NOLABEL,		/* No label found corresponding to name.  */
   ECTF_NOLABELDATA,		/* File does not contain any labels.  */
   ECTF_NOTSUP,			/* Feature not supported.  */
   ECTF_NOENUMNAM,		/* Enum element name not found.  */
   ECTF_NOMEMBNAM,		/* Member name not found.  */
   ECTF_RDONLY,			/* CTF container is read-only.  */
   ECTF_DTFULL,			/* CTF type is full (no more members allowed).  */
   ECTF_FULL,			/* CTF container is full.  */
   ECTF_DUPLICATE,		/* Duplicate member or variable name.  */
   ECTF_CONFLICT,		/* Conflicting type definition present.  */
   ECTF_OVERROLLBACK,		/* Attempt to roll back past a ctf_update.  */
   ECTF_COMPRESS,		/* Failed to compress CTF data.  */
   ECTF_ARCREATE,		/* Error creating CTF archive.  */
   ECTF_ARNNAME,		/* Name not found in CTF archive.  */
   ECTF_SLICEOVERFLOW,		/* Overflow of type bitness or offset in slice.  */
   ECTF_DUMPSECTUNKNOWN,	/* Unknown section number in dump.  */
   ECTF_DUMPSECTCHANGED		/* Section changed in middle of dump.  */
  };

/* The CTF data model is inferred to be the caller's data model or the data
   model of the given object, unless ctf_setmodel() is explicitly called.  */
#define	CTF_MODEL_ILP32 1	/* Object data model is ILP32.  */
#define	CTF_MODEL_LP64  2	/* Object data model is LP64.  */
#ifdef _LP64
# define CTF_MODEL_NATIVE CTF_MODEL_LP64
#else
# define CTF_MODEL_NATIVE CTF_MODEL_ILP32
#endif

/* Dynamic CTF containers can be created using ctf_create().  The ctf_add_*
   routines can be used to add new definitions to the dynamic container.
   New types are labeled as root or non-root to determine whether they are
   visible at the top-level program scope when subsequently doing a lookup.  */

#define	CTF_ADD_NONROOT	0	/* Type only visible in nested scope.  */
#define	CTF_ADD_ROOT	1	/* Type visible at top-level scope.  */

/* These typedefs are used to define the signature for callback functions
   that can be used with the iteration and visit functions below.  */

typedef int ctf_visit_f (const char *name, ctf_id_t type, unsigned long offset,
			 int depth, void *arg);
typedef int ctf_member_f (const char *name, ctf_id_t membtype,
			  unsigned long offset, void *arg);
typedef int ctf_enum_f (const char *name, int val, void *arg);
typedef int ctf_variable_f (const char *name, ctf_id_t type, void *arg);
typedef int ctf_type_f (ctf_id_t type, void *arg);
typedef int ctf_label_f (const char *name, const ctf_lblinfo_t *info,
			 void *arg);
typedef int ctf_archive_member_f (ctf_file_t *fp, const char *name, void *arg);
typedef int ctf_archive_raw_member_f (const char *name, const void *content,
				      size_t len, void *arg);
typedef char *ctf_dump_decorate_f (ctf_sect_names_t sect,
				   char *line, void *arg);

typedef struct ctf_dump_state ctf_dump_state_t;

/* Opening.  These mostly return an abstraction over both CTF files and CTF
   archives: so they can be used to open both.  CTF files will appear to be an
   archive with one member named '.ctf'.  The low-level functions
   ctf_simple_open() and ctf_bufopen() return ctf_file_t's directly, and cannot
   be used on CTF archives.  */

extern ctf_archive_t *ctf_bfdopen (struct bfd *, int *);
extern ctf_archive_t *ctf_bfdopen_ctfsect (struct bfd *, const ctf_sect_t *,
					   int *);
extern ctf_archive_t *ctf_fdopen (int fd, const char *filename,
				  const char *target, int *errp);
extern ctf_archive_t *ctf_open (const char *filename,
				const char *target, int *errp);
extern void ctf_close (ctf_archive_t *);
extern ctf_sect_t ctf_getdatasect (const ctf_file_t *);
extern ctf_archive_t *ctf_get_arc (const ctf_file_t *);
extern ctf_archive_t *ctf_arc_open (const char *, int *);
extern void ctf_arc_close (ctf_archive_t *);
extern ctf_file_t *ctf_arc_open_by_name (const ctf_archive_t *,
					 const char *, int *);
extern ctf_file_t *ctf_arc_open_by_name_sections (const ctf_archive_t *,
						  const ctf_sect_t *,
						  const ctf_sect_t *,
						  const char *, int *);

/* The next functions return or close real CTF files, or write out CTF archives,
   not opaque containers around either.  */

extern ctf_file_t *ctf_simple_open (const char *, size_t, const char *, size_t,
				   size_t, const char *, size_t, int *);
extern ctf_file_t *ctf_bufopen (const ctf_sect_t *, const ctf_sect_t *,
				const ctf_sect_t *, int *);
extern void ctf_file_close (ctf_file_t *);

extern int ctf_arc_write (const char *, ctf_file_t **, size_t,
			  const char **, size_t);

extern ctf_file_t *ctf_parent_file (ctf_file_t *);
extern const char *ctf_parent_name (ctf_file_t *);
extern void ctf_parent_name_set (ctf_file_t *, const char *);
extern int ctf_type_isparent (ctf_file_t *, ctf_id_t);
extern int ctf_type_ischild (ctf_file_t *, ctf_id_t);

extern int ctf_import (ctf_file_t *, ctf_file_t *);
extern int ctf_setmodel (ctf_file_t *, int);
extern int ctf_getmodel (ctf_file_t *);

extern void ctf_setspecific (ctf_file_t *, void *);
extern void *ctf_getspecific (ctf_file_t *);

extern int ctf_errno (ctf_file_t *);
extern const char *ctf_errmsg (int);
extern int ctf_version (int);

extern int ctf_func_info (ctf_file_t *, unsigned long, ctf_funcinfo_t *);
extern int ctf_func_args (ctf_file_t *, unsigned long, uint32_t, ctf_id_t *);
extern int ctf_func_type_info (ctf_file_t *, ctf_id_t, ctf_funcinfo_t *);
extern int ctf_func_type_args (ctf_file_t *, ctf_id_t, uint32_t, ctf_id_t *);

extern ctf_id_t ctf_lookup_by_name (ctf_file_t *, const char *);
extern ctf_id_t ctf_lookup_by_symbol (ctf_file_t *, unsigned long);
extern ctf_id_t ctf_lookup_variable (ctf_file_t *, const char *);

extern ctf_id_t ctf_type_resolve (ctf_file_t *, ctf_id_t);
extern char *ctf_type_aname (ctf_file_t *, ctf_id_t);
extern char *ctf_type_aname_raw (ctf_file_t *, ctf_id_t);
extern ssize_t ctf_type_lname (ctf_file_t *, ctf_id_t, char *, size_t);
extern char *ctf_type_name (ctf_file_t *, ctf_id_t, char *, size_t);
extern ssize_t ctf_type_size (ctf_file_t *, ctf_id_t);
extern ssize_t ctf_type_align (ctf_file_t *, ctf_id_t);
extern int ctf_type_kind (ctf_file_t *, ctf_id_t);
extern ctf_id_t ctf_type_reference (ctf_file_t *, ctf_id_t);
extern ctf_id_t ctf_type_pointer (ctf_file_t *, ctf_id_t);
extern int ctf_type_encoding (ctf_file_t *, ctf_id_t, ctf_encoding_t *);
extern int ctf_type_visit (ctf_file_t *, ctf_id_t, ctf_visit_f *, void *);
extern int ctf_type_cmp (ctf_file_t *, ctf_id_t, ctf_file_t *, ctf_id_t);
extern int ctf_type_compat (ctf_file_t *, ctf_id_t, ctf_file_t *, ctf_id_t);

extern int ctf_member_info (ctf_file_t *, ctf_id_t, const char *,
			    ctf_membinfo_t *);
extern int ctf_array_info (ctf_file_t *, ctf_id_t, ctf_arinfo_t *);

extern const char *ctf_enum_name (ctf_file_t *, ctf_id_t, int);
extern int ctf_enum_value (ctf_file_t *, ctf_id_t, const char *, int *);

extern void ctf_label_set (ctf_file_t *, const char *);
extern const char *ctf_label_get (ctf_file_t *);

extern const char *ctf_label_topmost (ctf_file_t *);
extern int ctf_label_info (ctf_file_t *, const char *, ctf_lblinfo_t *);

extern int ctf_member_iter (ctf_file_t *, ctf_id_t, ctf_member_f *, void *);
extern int ctf_enum_iter (ctf_file_t *, ctf_id_t, ctf_enum_f *, void *);
extern int ctf_type_iter (ctf_file_t *, ctf_type_f *, void *);
extern int ctf_label_iter (ctf_file_t *, ctf_label_f *, void *);
extern int ctf_variable_iter (ctf_file_t *, ctf_variable_f *, void *);
extern int ctf_archive_iter (const ctf_archive_t *, ctf_archive_member_f *,
			     void *);
/* This function alone does not currently operate on CTF files masquerading
   as archives, and returns -EINVAL: the raw data is no longer available.  It is
   expected to be used only by archiving tools, in any case, which have no need
   to deal with non-archives at all.  */
extern int ctf_archive_raw_iter (const ctf_archive_t *,
				 ctf_archive_raw_member_f *, void *);
extern char *ctf_dump (ctf_file_t *, ctf_dump_state_t **state,
		       ctf_sect_names_t sect, ctf_dump_decorate_f *,
		       void *arg);

extern ctf_id_t ctf_add_array (ctf_file_t *, uint32_t,
			       const ctf_arinfo_t *);
extern ctf_id_t ctf_add_const (ctf_file_t *, uint32_t, ctf_id_t);
extern ctf_id_t ctf_add_enum_encoded (ctf_file_t *, uint32_t, const char *,
				      const ctf_encoding_t *);
extern ctf_id_t ctf_add_enum (ctf_file_t *, uint32_t, const char *);
extern ctf_id_t ctf_add_float (ctf_file_t *, uint32_t,
			       const char *, const ctf_encoding_t *);
extern ctf_id_t ctf_add_forward (ctf_file_t *, uint32_t, const char *,
				 uint32_t);
extern ctf_id_t ctf_add_function (ctf_file_t *, uint32_t,
				  const ctf_funcinfo_t *, const ctf_id_t *);
extern ctf_id_t ctf_add_integer (ctf_file_t *, uint32_t, const char *,
				 const ctf_encoding_t *);
extern ctf_id_t ctf_add_slice (ctf_file_t *, uint32_t, ctf_id_t, const ctf_encoding_t *);
extern ctf_id_t ctf_add_pointer (ctf_file_t *, uint32_t, ctf_id_t);
extern ctf_id_t ctf_add_type (ctf_file_t *, ctf_file_t *, ctf_id_t);
extern ctf_id_t ctf_add_typedef (ctf_file_t *, uint32_t, const char *,
				 ctf_id_t);
extern ctf_id_t ctf_add_restrict (ctf_file_t *, uint32_t, ctf_id_t);
extern ctf_id_t ctf_add_struct (ctf_file_t *, uint32_t, const char *);
extern ctf_id_t ctf_add_union (ctf_file_t *, uint32_t, const char *);
extern ctf_id_t ctf_add_struct_sized (ctf_file_t *, uint32_t, const char *,
				      size_t);
extern ctf_id_t ctf_add_union_sized (ctf_file_t *, uint32_t, const char *,
				     size_t);
extern ctf_id_t ctf_add_volatile (ctf_file_t *, uint32_t, ctf_id_t);

extern int ctf_add_enumerator (ctf_file_t *, ctf_id_t, const char *, int);
extern int ctf_add_member (ctf_file_t *, ctf_id_t, const char *, ctf_id_t);
extern int ctf_add_member_offset (ctf_file_t *, ctf_id_t, const char *,
				  ctf_id_t, unsigned long);
extern int ctf_add_member_encoded (ctf_file_t *, ctf_id_t, const char *,
				   ctf_id_t, unsigned long,
				   const ctf_encoding_t);

extern int ctf_add_variable (ctf_file_t *, const char *, ctf_id_t);

extern int ctf_set_array (ctf_file_t *, ctf_id_t, const ctf_arinfo_t *);

extern ctf_file_t *ctf_create (int *);
extern int ctf_update (ctf_file_t *);
extern ctf_snapshot_id_t ctf_snapshot (ctf_file_t *);
extern int ctf_rollback (ctf_file_t *, ctf_snapshot_id_t);
extern int ctf_discard (ctf_file_t *);
extern int ctf_write (ctf_file_t *, int);
extern int ctf_gzwrite (ctf_file_t * fp, gzFile fd);
extern int ctf_compress_write (ctf_file_t * fp, int fd);

extern void ctf_setdebug (int debug);
extern int ctf_getdebug (void);

#ifdef	__cplusplus
}
#endif

#endif				/* _CTF_API_H */
Commit	Line	Data
2e94b056 NA	1	/* Public API to libctf.
	2	Copyright (C) 2019 Free Software Foundation, Inc.
	3
	4	This file is part of libctf.
	5
	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
	9	version.
	10
	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.
	15
	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/>. */
	19
	20	/* This header file defines the interfaces available from the CTF debugger
	21	library, libctf. This API can be used by a debugger to operate on data in
	22	the Compact ANSI-C Type Format (CTF). */
	23
	24	#ifndef _CTF_API_H
	25	#define _CTF_API_H
	26
	27	#include <sys/param.h>
	28	#include <sys/types.h>
	29	#include <ctf.h>
47d546f4	30	#include <zlib.h>
2e94b056 NA	31
	32	#ifdef __cplusplus
	33	extern "C"
	34	{
	35	#endif
	36
	37	/* Clients can open one or more CTF containers and obtain a pointer to an
	38	opaque ctf_file_t. Types are identified by an opaque ctf_id_t token.
	39	They can also open or create read-only archives of CTF containers in a
	40	ctf_archive_t.
	41
	42	These opaque definitions allow libctf to evolve without breaking clients. */
	43
	44	typedef struct ctf_file ctf_file_t;
	45	typedef struct ctf_archive_internal ctf_archive_t;
a0486bac	46	typedef unsigned long ctf_id_t;
2e94b056	47
143dce84 NA	48	/* This opaque definition allows libctf to accept BFD data structures without
	49	importing all the BFD noise into users' namespaces. */
	50
	51	struct bfd;
	52
47d546f4 NA	53	/* If the debugger needs to provide the CTF library with a set of raw buffers
	54	for use as the CTF data, symbol table, and string table, it can do so by
	55	filling in ctf_sect_t structures and passing them to ctf_bufopen().
	56
	57	The contents of this structure must always be in native endianness (no
	58	byteswapping is performed). */
	59
	60	typedef struct ctf_sect
	61	{
	62	const char cts_name; / Section name (if any). */
47d546f4 NA	63	const void cts_data; / Pointer to section data. */
	64	size_t cts_size; /* Size of data in bytes. */
	65	size_t cts_entsize; /* Size of each section entry (symtab only). */
47d546f4 NA	66	} ctf_sect_t;
	67
	68	/* Symbolic names for CTF sections. */
	69
	70	typedef enum ctf_sect_names
	71	{
	72	CTF_SECT_HEADER,
	73	CTF_SECT_LABEL,
	74	CTF_SECT_OBJT,
	75	CTF_SECT_FUNC,
	76	CTF_SECT_VAR,
	77	CTF_SECT_TYPE,
	78	CTF_SECT_STR
	79	} ctf_sect_names_t;
	80
	81	/* Encoding information for integers, floating-point values, and certain other
	82	intrinsics can be obtained by calling ctf_type_encoding(), below. The flags
	83	field will contain values appropriate for the type defined in <ctf.h>. */
	84
	85	typedef struct ctf_encoding
	86	{
	87	uint32_t cte_format; /* Data format (CTF_INT_* or CTF_FP_* flags). */
	88	uint32_t cte_offset; /* Offset of value in bits. */
	89	uint32_t cte_bits; /* Size of storage in bits. */
	90	} ctf_encoding_t;
	91
	92	typedef struct ctf_membinfo
	93	{
	94	ctf_id_t ctm_type; /* Type of struct or union member. */
	95	unsigned long ctm_offset; /* Offset of member in bits. */
	96	} ctf_membinfo_t;
	97
	98	typedef struct ctf_arinfo
	99	{
	100	ctf_id_t ctr_contents; /* Type of array contents. */
	101	ctf_id_t ctr_index; /* Type of array index. */
	102	uint32_t ctr_nelems; /* Number of elements. */
	103	} ctf_arinfo_t;
	104
	105	typedef struct ctf_funcinfo
	106	{
	107	ctf_id_t ctc_return; /* Function return type. */
	108	uint32_t ctc_argc; /* Number of typed arguments to function. */
	109	uint32_t ctc_flags; /* Function attributes (see below). */
	110	} ctf_funcinfo_t;
	111
	112	typedef struct ctf_lblinfo
	113	{
	114	ctf_id_t ctb_type; /* Last type associated with the label. */
	115	} ctf_lblinfo_t;
	116
	117	typedef struct ctf_snapshot_id
	118	{
	119	unsigned long dtd_id; /* Highest DTD ID at time of snapshot. */
	120	unsigned long snapshot_id; /* Snapshot id at time of snapshot. */
	121	} ctf_snapshot_id_t;
	122
	123	#define CTF_FUNC_VARARG 0x1 /* Function arguments end with varargs. */
	124
a0486bac JM	125	/* Functions that return a ctf_id_t use the following value to indicate failure.
	126	ctf_errno() can be used to obtain an error code. Functions that return
	127	a straight integral -1 also use ctf_errno(). */
	128	#define CTF_ERR ((ctf_id_t) -1L)
2e94b056 NA	129
	130	#define ECTF_BASE 1000 /* Base value for libctf errnos. */
	131
	132
	133	enum
	134	{
	135	ECTF_FMT = ECTF_BASE, /* File is not in CTF or ELF format. */
	136	ECTF_BFDERR, /* BFD error. */
	137	ECTF_CTFVERS, /* CTF version is more recent than libctf. */
	138	ECTF_BFD_AMBIGUOUS, /* Ambiguous BFD target. */
	139	ECTF_SYMTAB, /* Symbol table uses invalid entry size. */
	140	ECTF_SYMBAD, /* Symbol table data buffer invalid. */
	141	ECTF_STRBAD, /* String table data buffer invalid. */
	142	ECTF_CORRUPT, /* File data corruption detected. */
	143	ECTF_NOCTFDATA, /* ELF file does not contain CTF data. */
	144	ECTF_NOCTFBUF, /* Buffer does not contain CTF data. */
	145	ECTF_NOSYMTAB, /* Symbol table data is not available. */
	146	ECTF_NOPARENT, /* Parent CTF container is not available. */
	147	ECTF_DMODEL, /* Data model mismatch. */
	148	ECTF_UNUSED, /* Unused error. */
	149	ECTF_ZALLOC, /* Failed to allocate (de)compression buffer. */
	150	ECTF_DECOMPRESS, /* Failed to decompress CTF data. */
	151	ECTF_STRTAB, /* String table for this string is missing. */
	152	ECTF_BADNAME, /* String offset is corrupt w.r.t. strtab. */
	153	ECTF_BADID, /* Invalid type ID number. */
	154	ECTF_NOTSOU, /* Type is not a struct or union. */
	155	ECTF_NOTENUM, /* Type is not an enum. */
	156	ECTF_NOTSUE, /* Type is not a struct, union, or enum. */
	157	ECTF_NOTINTFP, /* Type is not an integer, float, or enum. */
	158	ECTF_NOTARRAY, /* Type is not an array. */
	159	ECTF_NOTREF, /* Type does not reference another type. */
	160	ECTF_NAMELEN, /* Buffer is too small to hold type name. */
	161	ECTF_NOTYPE, /* No type found corresponding to name. */
	162	ECTF_SYNTAX, /* Syntax error in type name. */
12a0b67d	163	ECTF_NOTFUNC, /* Symbol entry or type is not a function. */
2e94b056 NA	164	ECTF_NOFUNCDAT, /* No func info available for function. */
	165	ECTF_NOTDATA, /* Symtab entry does not refer to a data obj. */
	166	ECTF_NOTYPEDAT, /* No type info available for object. */
	167	ECTF_NOLABEL, /* No label found corresponding to name. */
	168	ECTF_NOLABELDATA, /* File does not contain any labels. */
	169	ECTF_NOTSUP, /* Feature not supported. */
	170	ECTF_NOENUMNAM, /* Enum element name not found. */
	171	ECTF_NOMEMBNAM, /* Member name not found. */
	172	ECTF_RDONLY, /* CTF container is read-only. */
	173	ECTF_DTFULL, /* CTF type is full (no more members allowed). */
	174	ECTF_FULL, /* CTF container is full. */
	175	ECTF_DUPLICATE, /* Duplicate member or variable name. */
	176	ECTF_CONFLICT, /* Conflicting type definition present. */
	177	ECTF_OVERROLLBACK, /* Attempt to roll back past a ctf_update. */
	178	ECTF_COMPRESS, /* Failed to compress CTF data. */
	179	ECTF_ARCREATE, /* Error creating CTF archive. */
	180	ECTF_ARNNAME, /* Name not found in CTF archive. */
	181	ECTF_SLICEOVERFLOW, /* Overflow of type bitness or offset in slice. */
	182	ECTF_DUMPSECTUNKNOWN, /* Unknown section number in dump. */
	183	ECTF_DUMPSECTCHANGED /* Section changed in middle of dump. */
	184	};
	185
	186	/* The CTF data model is inferred to be the caller's data model or the data
	187	model of the given object, unless ctf_setmodel() is explicitly called. */
	188	#define CTF_MODEL_ILP32 1 /* Object data model is ILP32. */
	189	#define CTF_MODEL_LP64 2 /* Object data model is LP64. */
	190	#ifdef _LP64
	191	# define CTF_MODEL_NATIVE CTF_MODEL_LP64
	192	#else
	193	# define CTF_MODEL_NATIVE CTF_MODEL_ILP32
	194	#endif
	195
	196	/* Dynamic CTF containers can be created using ctf_create(). The ctf_add_*
	197	routines can be used to add new definitions to the dynamic container.
	198	New types are labeled as root or non-root to determine whether they are
	199	visible at the top-level program scope when subsequently doing a lookup. */
	200
	201	#define CTF_ADD_NONROOT 0 /* Type only visible in nested scope. */
	202	#define CTF_ADD_ROOT 1 /* Type visible at top-level scope. */
	203
9402cc59 NA	204	/* These typedefs are used to define the signature for callback functions
	205	that can be used with the iteration and visit functions below. */
	206
316afdb1 NA	207	typedef int ctf_visit_f (const char *name, ctf_id_t type, unsigned long offset,
	208	int depth, void *arg);
	209	typedef int ctf_member_f (const char *name, ctf_id_t membtype,
	210	unsigned long offset, void *arg);
	211	typedef int ctf_enum_f (const char name, int val, void arg);
	212	typedef int ctf_variable_f (const char name, ctf_id_t type, void arg);
	213	typedef int ctf_type_f (ctf_id_t type, void *arg);
6dbf2b73 NA	214	typedef int ctf_label_f (const char name, const ctf_lblinfo_t info,
6dbf2b73 NA	215	void *arg);
9402cc59 NA	216	typedef int ctf_archive_member_f (ctf_file_t fp, const char name, void *arg);
	217	typedef int ctf_archive_raw_member_f (const char name, const void content,
	218	size_t len, void *arg);
a30b3e18 NA	219	typedef char *ctf_dump_decorate_f (ctf_sect_names_t sect,
	220	char line, void arg);
	221
	222	typedef struct ctf_dump_state ctf_dump_state_t;
9402cc59	223
143dce84 NA	224	/* Opening. These mostly return an abstraction over both CTF files and CTF
	225	archives: so they can be used to open both. CTF files will appear to be an
	226	archive with one member named '.ctf'. The low-level functions
	227	ctf_simple_open() and ctf_bufopen() return ctf_file_t's directly, and cannot
	228	be used on CTF archives. */
	229
	230	extern ctf_archive_t ctf_bfdopen (struct bfd , int *);
	231	extern ctf_archive_t ctf_bfdopen_ctfsect (struct bfd , const ctf_sect_t *,
	232	int *);
	233	extern ctf_archive_t ctf_fdopen (int fd, const char filename,
	234	const char target, int errp);
	235	extern ctf_archive_t ctf_open (const char filename,
	236	const char target, int errp);
	237	extern void ctf_close (ctf_archive_t *);
72f33921	238	extern ctf_sect_t ctf_getdatasect (const ctf_file_t *);
9402cc59	239	extern ctf_archive_t ctf_get_arc (const ctf_file_t );
143dce84	240	extern ctf_archive_t ctf_arc_open (const char , int *);
9402cc59 NA	241	extern void ctf_arc_close (ctf_archive_t *);
	242	extern ctf_file_t ctf_arc_open_by_name (const ctf_archive_t ,
	243	const char , int );
	244	extern ctf_file_t ctf_arc_open_by_name_sections (const ctf_archive_t ,
	245	const ctf_sect_t *,
	246	const ctf_sect_t *,
	247	const char , int );
	248
	249	/* The next functions return or close real CTF files, or write out CTF archives,
	250	not opaque containers around either. */
	251
47d546f4 NA	252	extern ctf_file_t ctf_simple_open (const char , size_t, const char *, size_t,
	253	size_t, const char , size_t, int );
	254	extern ctf_file_t ctf_bufopen (const ctf_sect_t , const ctf_sect_t *,
	255	const ctf_sect_t , int );
72f33921 NA	256	extern void ctf_file_close (ctf_file_t *);
72f33921 NA	257
9402cc59 NA	258	extern int ctf_arc_write (const char , ctf_file_t *, size_t,
	259	const char **, size_t);
	260
72f33921 NA	261	extern ctf_file_t ctf_parent_file (ctf_file_t );
	262	extern const char ctf_parent_name (ctf_file_t );
	263	extern void ctf_parent_name_set (ctf_file_t , const char );
316afdb1 NA	264	extern int ctf_type_isparent (ctf_file_t *, ctf_id_t);
316afdb1 NA	265	extern int ctf_type_ischild (ctf_file_t *, ctf_id_t);
72f33921 NA	266
	267	extern int ctf_import (ctf_file_t , ctf_file_t );
	268	extern int ctf_setmodel (ctf_file_t *, int);
	269	extern int ctf_getmodel (ctf_file_t *);
	270
	271	extern void ctf_setspecific (ctf_file_t , void );
	272	extern void ctf_getspecific (ctf_file_t );
47d546f4	273
479604f4 NA	274	extern int ctf_errno (ctf_file_t *);
479604f4 NA	275	extern const char *ctf_errmsg (int);
6c33b742	276	extern int ctf_version (int);
316afdb1	277
b437bfe0 NA	278	extern int ctf_func_info (ctf_file_t , unsigned long, ctf_funcinfo_t );
b437bfe0 NA	279	extern int ctf_func_args (ctf_file_t , unsigned long, uint32_t, ctf_id_t );
12a0b67d NA	280	extern int ctf_func_type_info (ctf_file_t , ctf_id_t, ctf_funcinfo_t );
12a0b67d NA	281	extern int ctf_func_type_args (ctf_file_t , ctf_id_t, uint32_t, ctf_id_t );
b437bfe0 NA	282
	283	extern ctf_id_t ctf_lookup_by_name (ctf_file_t , const char );
	284	extern ctf_id_t ctf_lookup_by_symbol (ctf_file_t *, unsigned long);
	285	extern ctf_id_t ctf_lookup_variable (ctf_file_t , const char );
	286
316afdb1 NA	287	extern ctf_id_t ctf_type_resolve (ctf_file_t *, ctf_id_t);
316afdb1 NA	288	extern char ctf_type_aname (ctf_file_t , ctf_id_t);
12a0b67d	289	extern char ctf_type_aname_raw (ctf_file_t , ctf_id_t);
316afdb1 NA	290	extern ssize_t ctf_type_lname (ctf_file_t , ctf_id_t, char , size_t);
	291	extern char ctf_type_name (ctf_file_t , ctf_id_t, char *, size_t);
	292	extern ssize_t ctf_type_size (ctf_file_t *, ctf_id_t);
	293	extern ssize_t ctf_type_align (ctf_file_t *, ctf_id_t);
	294	extern int ctf_type_kind (ctf_file_t *, ctf_id_t);
	295	extern ctf_id_t ctf_type_reference (ctf_file_t *, ctf_id_t);
	296	extern ctf_id_t ctf_type_pointer (ctf_file_t *, ctf_id_t);
	297	extern int ctf_type_encoding (ctf_file_t , ctf_id_t, ctf_encoding_t );
	298	extern int ctf_type_visit (ctf_file_t , ctf_id_t, ctf_visit_f , void *);
	299	extern int ctf_type_cmp (ctf_file_t , ctf_id_t, ctf_file_t , ctf_id_t);
	300	extern int ctf_type_compat (ctf_file_t , ctf_id_t, ctf_file_t , ctf_id_t);
	301
	302	extern int ctf_member_info (ctf_file_t , ctf_id_t, const char ,
	303	ctf_membinfo_t *);
	304	extern int ctf_array_info (ctf_file_t , ctf_id_t, ctf_arinfo_t );
	305
	306	extern const char ctf_enum_name (ctf_file_t , ctf_id_t, int);
	307	extern int ctf_enum_value (ctf_file_t , ctf_id_t, const char , int *);
	308
6dbf2b73 NA	309	extern void ctf_label_set (ctf_file_t , const char );
	310	extern const char ctf_label_get (ctf_file_t );
	311
	312	extern const char ctf_label_topmost (ctf_file_t );
	313	extern int ctf_label_info (ctf_file_t , const char , ctf_lblinfo_t *);
	314
316afdb1 NA	315	extern int ctf_member_iter (ctf_file_t , ctf_id_t, ctf_member_f , void *);
	316	extern int ctf_enum_iter (ctf_file_t , ctf_id_t, ctf_enum_f , void *);
	317	extern int ctf_type_iter (ctf_file_t , ctf_type_f , void *);
6dbf2b73	318	extern int ctf_label_iter (ctf_file_t , ctf_label_f , void *);
316afdb1	319	extern int ctf_variable_iter (ctf_file_t , ctf_variable_f , void *);
9402cc59 NA	320	extern int ctf_archive_iter (const ctf_archive_t , ctf_archive_member_f ,
	321	void *);
	322	/* This function alone does not currently operate on CTF files masquerading
	323	as archives, and returns -EINVAL: the raw data is no longer available. It is
	324	expected to be used only by archiving tools, in any case, which have no need
	325	to deal with non-archives at all. */
	326	extern int ctf_archive_raw_iter (const ctf_archive_t *,
	327	ctf_archive_raw_member_f , void );
a30b3e18 NA	328	extern char ctf_dump (ctf_file_t , ctf_dump_state_t **state,
	329	ctf_sect_names_t sect, ctf_dump_decorate_f *,
	330	void *arg);
316afdb1	331
47d546f4 NA	332	extern ctf_id_t ctf_add_array (ctf_file_t *, uint32_t,
	333	const ctf_arinfo_t *);
	334	extern ctf_id_t ctf_add_const (ctf_file_t *, uint32_t, ctf_id_t);
	335	extern ctf_id_t ctf_add_enum_encoded (ctf_file_t , uint32_t, const char ,
	336	const ctf_encoding_t *);
	337	extern ctf_id_t ctf_add_enum (ctf_file_t , uint32_t, const char );
	338	extern ctf_id_t ctf_add_float (ctf_file_t *, uint32_t,
	339	const char , const ctf_encoding_t );
	340	extern ctf_id_t ctf_add_forward (ctf_file_t , uint32_t, const char ,
	341	uint32_t);
	342	extern ctf_id_t ctf_add_function (ctf_file_t *, uint32_t,
	343	const ctf_funcinfo_t , const ctf_id_t );
	344	extern ctf_id_t ctf_add_integer (ctf_file_t , uint32_t, const char ,
	345	const ctf_encoding_t *);
	346	extern ctf_id_t ctf_add_slice (ctf_file_t , uint32_t, ctf_id_t, const ctf_encoding_t );
	347	extern ctf_id_t ctf_add_pointer (ctf_file_t *, uint32_t, ctf_id_t);
	348	extern ctf_id_t ctf_add_type (ctf_file_t , ctf_file_t , ctf_id_t);
	349	extern ctf_id_t ctf_add_typedef (ctf_file_t , uint32_t, const char ,
	350	ctf_id_t);
	351	extern ctf_id_t ctf_add_restrict (ctf_file_t *, uint32_t, ctf_id_t);
	352	extern ctf_id_t ctf_add_struct (ctf_file_t , uint32_t, const char );
	353	extern ctf_id_t ctf_add_union (ctf_file_t , uint32_t, const char );
	354	extern ctf_id_t ctf_add_struct_sized (ctf_file_t , uint32_t, const char ,
	355	size_t);
	356	extern ctf_id_t ctf_add_union_sized (ctf_file_t , uint32_t, const char ,
	357	size_t);
	358	extern ctf_id_t ctf_add_volatile (ctf_file_t *, uint32_t, ctf_id_t);
	359
	360	extern int ctf_add_enumerator (ctf_file_t , ctf_id_t, const char , int);
	361	extern int ctf_add_member (ctf_file_t , ctf_id_t, const char , ctf_id_t);
	362	extern int ctf_add_member_offset (ctf_file_t , ctf_id_t, const char ,
	363	ctf_id_t, unsigned long);
	364	extern int ctf_add_member_encoded (ctf_file_t , ctf_id_t, const char ,
	365	ctf_id_t, unsigned long,
	366	const ctf_encoding_t);
	367
	368	extern int ctf_add_variable (ctf_file_t , const char , ctf_id_t);
	369
	370	extern int ctf_set_array (ctf_file_t , ctf_id_t, const ctf_arinfo_t );
	371
	372	extern ctf_file_t ctf_create (int );
	373	extern int ctf_update (ctf_file_t *);
	374	extern ctf_snapshot_id_t ctf_snapshot (ctf_file_t *);
	375	extern int ctf_rollback (ctf_file_t *, ctf_snapshot_id_t);
	376	extern int ctf_discard (ctf_file_t *);
	377	extern int ctf_write (ctf_file_t *, int);
	378	extern int ctf_gzwrite (ctf_file_t * fp, gzFile fd);
	379	extern int ctf_compress_write (ctf_file_t * fp, int fd);
2e94b056	380
60da9d95 NA	381	extern void ctf_setdebug (int debug);
	382	extern int ctf_getdebug (void);
	383
2e94b056 NA	384	#ifdef __cplusplus
	385	}
	386	#endif
	387
	388	#endif /* _CTF_API_H */