libctf: Add iteration over non-root types

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

diff --git a/include/ctf-api.h b/include/ctf-api.h
index 023c890d7d0e999f37c4dd323dcda284fd49860c..fa747888e04f60aee80934504c5a39b936e7ec81 100644 (file)
--- a/include/ctf-api.h
+++ b/include/ctf-api.h
@@ -43,7 +43,7 @@ extern "C"
 
 typedef struct ctf_file ctf_file_t;
 typedef struct ctf_archive_internal ctf_archive_t;
-typedef long ctf_id_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.  */
@@ -60,12 +60,9 @@ struct bfd;
 typedef struct ctf_sect
 {
   const char *cts_name;                  /* Section name (if any).  */
-  unsigned long cts_type;        /* Section type (ELF SHT_... value).  */
-  unsigned long cts_flags;       /* Section flags (ELF SHF_... value).  */
   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).  */
-  off64_t cts_offset;            /* File offset of this section (if any).  */
 } ctf_sect_t;
 
 /* Symbolic names for CTF sections.  */
@@ -125,9 +122,10 @@ typedef struct ctf_snapshot_id
 
 #define        CTF_FUNC_VARARG 0x1     /* Function arguments end with varargs.  */
 
-/* Functions that return integer status or a ctf_id_t use the following value
-   to indicate failure.  ctf_errno() can be used to obtain an error code.  */
-#define        CTF_ERR (-1L)
+/* 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.  */
 
@@ -162,7 +160,7 @@ enum
    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,               /* Symtab entry does not refer to a function.  */
+   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.  */
@@ -213,9 +211,16 @@ typedef int ctf_member_f (const char *name, ctf_id_t membtype,
 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_type_all_f (ctf_id_t type, int flag, 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
@@ -254,6 +259,8 @@ 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 const char *ctf_cuname (ctf_file_t *);
+extern void ctf_cuname_set (ctf_file_t *, const char *);
 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 *);
@@ -269,9 +276,20 @@ 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);
@@ -291,9 +309,17 @@ 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_type_iter_all (ctf_file_t *, ctf_type_all_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 *);
@@ -303,6 +329,9 @@ extern int ctf_archive_iter (const ctf_archive_t *, ctf_archive_member_f *,
    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 *);