[deliverable/binutils-gdb.git] / gdb / minsyms.h

/* Minimal symbol table definitions for GDB.

   Copyright (C) 2011-2013 Free Software Foundation, Inc.

   This file is part of GDB.

   This program 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 of the License, 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.  If not, see <http://www.gnu.org/licenses/>.  */

#ifndef MINSYMS_H
#define MINSYMS_H

/* Several lookup functions return both a minimal symbol and the
   objfile in which it is found.  This structure is used in these
   cases.  */

struct bound_minimal_symbol
{
  /* The minimal symbol that was found, or NULL if no minimal symbol
     was found.  */

  struct minimal_symbol *minsym;

  /* If MINSYM is not NULL, then this is the objfile in which the
     symbol is defined.  */

  struct objfile *objfile;
};

/* This header declares most of the API for dealing with minimal
   symbols and minimal symbol tables.  A few things are declared
   elsewhere; see below.

   A minimal symbol is a symbol for which there is no direct debug
   information.  For example, for an ELF binary, minimal symbols are
   created from the ELF symbol table.

   For the definition of the minimal symbol structure, see struct
   minimal_symbol in symtab.h.

   Minimal symbols are stored in tables attached to an objfile; see
   objfiles.h for details.  Code should generally treat these tables
   as opaque and use functions provided by minsyms.c to inspect them.
*/

/* Prepare to start collecting minimal symbols.  This should be called
   by a symbol reader to initialize the minimal symbol module.
   Currently, minimal symbol table creation is not reentrant; it
   relies on global (static) variables in minsyms.c.  */

void init_minimal_symbol_collection (void);

/* Return a cleanup which is used to clean up the global state left
   over by minimal symbol creation.  After calling
   init_minimal_symbol_collection, a symbol reader should call this
   function.  Then, after all minimal symbols have been read,
   regardless of whether they are installed or not, the cleanup
   returned by this function should be run.  */

struct cleanup *make_cleanup_discard_minimal_symbols (void);

/* Record a new minimal symbol.  This is the "full" entry point;
   simpler convenience entry points are also provided below.
   
   This returns a new minimal symbol.  It is ok to modify the returned
   minimal symbol (though generally not necessary).  It is not ok,
   though, to stash the pointer anywhere; as minimal symbols may be
   moved after creation.  The memory for the returned minimal symbol
   is still owned by the minsyms.c code, and should not be freed.
   
   Arguments are:

   NAME - the symbol's name
   NAME_LEN - the length of the name
   COPY_NAME - if true, the minsym code must make a copy of NAME.  If
   false, then NAME must be NUL-terminated, and must have a lifetime
   that is at least as long as OBJFILE's lifetime.
   ADDRESS - the address of the symbol
   MS_TYPE - the type of the symbol
   SECTION - the symbol's section
   appropriate obj_section for the minimal symbol.  This can be NULL.
   OBJFILE - the objfile associated with the minimal symbol.  */

struct minimal_symbol *prim_record_minimal_symbol_full
    (const char *name,
     int name_len,
     int copy_name,
     CORE_ADDR address,
     enum minimal_symbol_type ms_type,
     int section,
     struct objfile *objfile);

/* Like prim_record_minimal_symbol_full, but:
   - uses strlen to compute NAME_LEN,
   - passes COPY_NAME = 0,
   - and passes a default SECTION, depending on the type
   
   This variant does not return the new symbol.  */

void prim_record_minimal_symbol (const char *, CORE_ADDR,
				 enum minimal_symbol_type,
				 struct objfile *);

/* Like prim_record_minimal_symbol_full, but:
   - uses strlen to compute NAME_LEN,
   - passes COPY_NAME = 0.  */

struct minimal_symbol *prim_record_minimal_symbol_and_info
    (const char *,
     CORE_ADDR,
     enum minimal_symbol_type,
     int section,
     struct objfile *);

/* Install the minimal symbols that have been collected into the given
   objfile.  After this is called, the cleanup returned by
   make_cleanup_discard_minimal_symbols should be run in order to
   clean up global state.  */

void install_minimal_symbols (struct objfile *);

/* Create the terminating entry of OBJFILE's minimal symbol table.
   If OBJFILE->msymbols is zero, allocate a single entry from
   OBJFILE->objfile_obstack; otherwise, just initialize
   OBJFILE->msymbols[OBJFILE->minimal_symbol_count].  */

void terminate_minimal_symbol_table (struct objfile *objfile);

/* Sort all the minimal symbols in OBJFILE.  This should be only be
   called after relocating symbols; it ensures that the minimal
   symbols are properly sorted by address.  */

void msymbols_sort (struct objfile *objfile);

\f

/* Compute a hash code for the string argument.  */

unsigned int msymbol_hash (const char *);

/* Like msymbol_hash, but compute a hash code that is compatible with
   strcmp_iw.  */

unsigned int msymbol_hash_iw (const char *);

/* Compute the next hash value from previous HASH and the character C.  This
   is only a GDB in-memory computed value with no external files compatibility
   requirements.  */

#define SYMBOL_HASH_NEXT(hash, c)			\
  ((hash) * 67 + tolower ((unsigned char) (c)) - 113)

\f

/* Return the objfile that holds the minimal symbol SYM.  Every
   minimal symbols is held by some objfile; this will never return
   NULL.  */

struct objfile *msymbol_objfile (struct minimal_symbol *sym);

\f

/* Look through all the current minimal symbol tables and find the
   first minimal symbol that matches NAME.  If OBJF is non-NULL, limit
   the search to that objfile.  If SFILE is non-NULL, the only file-scope
   symbols considered will be from that source file (global symbols are
   still preferred).  Returns a pointer to the minimal symbol that
   matches, or NULL if no match is found.  */

struct minimal_symbol *lookup_minimal_symbol (const char *,
					      const char *,
					      struct objfile *);

/* Find the minimal symbol named NAME, and return both the minsym
   struct and its objfile.  This only checks the linkage name.  */

struct bound_minimal_symbol lookup_minimal_symbol_and_objfile (const char *);

/* Look through all the current minimal symbol tables and find the
   first minimal symbol that matches NAME and has text type.  If OBJF
   is non-NULL, limit the search to that objfile.  Returns a pointer
   to the minimal symbol that matches, or NULL if no match is found.

   This function only searches the mangled (linkage) names.  */

struct minimal_symbol *lookup_minimal_symbol_text (const char *,
						   struct objfile *);

/* Look through all the current minimal symbol tables and find the
   first minimal symbol that matches NAME and is a solib trampoline.
   If OBJF is non-NULL, limit the search to that objfile.  Returns a
   pointer to the minimal symbol that matches, or NULL if no match is
   found.

   This function only searches the mangled (linkage) names.  */

struct minimal_symbol *lookup_minimal_symbol_solib_trampoline
    (const char *,
     struct objfile *);

/* Look through all the current minimal symbol tables and find the
   first minimal symbol that matches NAME and PC.  If OBJF is non-NULL,
   limit the search to that objfile.  Returns a pointer to the minimal
   symbol that matches, or NULL if no match is found.  */

struct minimal_symbol *lookup_minimal_symbol_by_pc_name
    (CORE_ADDR, const char *, struct objfile *);

/* Search through the minimal symbol table for each objfile and find
   the symbol whose address is the largest address that is still less
   than or equal to PC, and which matches SECTION.

   If SECTION is NULL, this uses the result of find_pc_section
   instead.

   The result has a non-NULL 'minsym' member if such a symbol is
   found, or NULL if PC is not in a suitable range.  */

struct bound_minimal_symbol lookup_minimal_symbol_by_pc_section
    (CORE_ADDR,
     struct obj_section *);

/* Backward compatibility: search through the minimal symbol table 
   for a matching PC (no section given).
   
   This is a wrapper that calls lookup_minimal_symbol_by_pc_section
   with a NULL section argument.  */

struct bound_minimal_symbol lookup_minimal_symbol_by_pc (CORE_ADDR);

/* Iterate over all the minimal symbols in the objfile OBJF which
   match NAME.  Both the ordinary and demangled names of each symbol
   are considered.  The caller is responsible for canonicalizing NAME,
   should that need to be done.

   For each matching symbol, CALLBACK is called with the symbol and
   USER_DATA as arguments.  */

void iterate_over_minimal_symbols (struct objfile *objf,
				   const char *name,
				   void (*callback) (struct minimal_symbol *,
						     void *),
				   void *user_data);

#endif /* MINSYMS_H */
Commit	Line	Data
c35384fb TT	1	/* Minimal symbol table definitions for GDB.
c35384fb TT	2
28e7fd62	3	Copyright (C) 2011-2013 Free Software Foundation, Inc.
c35384fb TT	4
	5	This file is part of GDB.
	6
	7	This program is free software; you can redistribute it and/or modify
	8	it under the terms of the GNU General Public License as published by
	9	the Free Software Foundation; either version 3 of the License, or
	10	(at your option) any later version.
	11
	12	This program is distributed in the hope that it will be useful,
	13	but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	GNU General Public License for more details.
	16
	17	You should have received a copy of the GNU General Public License
	18	along with this program. If not, see <http://www.gnu.org/licenses/>. */
	19
	20	#ifndef MINSYMS_H
	21	#define MINSYMS_H
	22
7cbd4a93 TT	23	/* Several lookup functions return both a minimal symbol and the
	24	objfile in which it is found. This structure is used in these
	25	cases. */
	26
	27	struct bound_minimal_symbol
	28	{
	29	/* The minimal symbol that was found, or NULL if no minimal symbol
	30	was found. */
	31
	32	struct minimal_symbol *minsym;
	33
	34	/* If MINSYM is not NULL, then this is the objfile in which the
	35	symbol is defined. */
	36
	37	struct objfile *objfile;
	38	};
	39
b19686e0 TT	40	/* This header declares most of the API for dealing with minimal
	41	symbols and minimal symbol tables. A few things are declared
	42	elsewhere; see below.
c35384fb	43
b19686e0 TT	44	A minimal symbol is a symbol for which there is no direct debug
	45	information. For example, for an ELF binary, minimal symbols are
	46	created from the ELF symbol table.
	47
	48	For the definition of the minimal symbol structure, see struct
	49	minimal_symbol in symtab.h.
	50
	51	Minimal symbols are stored in tables attached to an objfile; see
	52	objfiles.h for details. Code should generally treat these tables
	53	as opaque and use functions provided by minsyms.c to inspect them.
	54	*/
	55
	56	/* Prepare to start collecting minimal symbols. This should be called
	57	by a symbol reader to initialize the minimal symbol module.
	58	Currently, minimal symbol table creation is not reentrant; it
	59	relies on global (static) variables in minsyms.c. */
	60
	61	void init_minimal_symbol_collection (void);
	62
	63	/* Return a cleanup which is used to clean up the global state left
	64	over by minimal symbol creation. After calling
	65	init_minimal_symbol_collection, a symbol reader should call this
	66	function. Then, after all minimal symbols have been read,
	67	regardless of whether they are installed or not, the cleanup
	68	returned by this function should be run. */
	69
	70	struct cleanup *make_cleanup_discard_minimal_symbols (void);
	71
	72	/* Record a new minimal symbol. This is the "full" entry point;
	73	simpler convenience entry points are also provided below.
	74
	75	This returns a new minimal symbol. It is ok to modify the returned
	76	minimal symbol (though generally not necessary). It is not ok,
	77	though, to stash the pointer anywhere; as minimal symbols may be
	78	moved after creation. The memory for the returned minimal symbol
	79	is still owned by the minsyms.c code, and should not be freed.
	80
	81	Arguments are:
	82
	83	NAME - the symbol's name
	84	NAME_LEN - the length of the name
	85	COPY_NAME - if true, the minsym code must make a copy of NAME. If
	86	false, then NAME must be NUL-terminated, and must have a lifetime
	87	that is at least as long as OBJFILE's lifetime.
	88	ADDRESS - the address of the symbol
	89	MS_TYPE - the type of the symbol
	90	SECTION - the symbol's section
b19686e0 TT	91	appropriate obj_section for the minimal symbol. This can be NULL.
b19686e0 TT	92	OBJFILE - the objfile associated with the minimal symbol. */
c35384fb TT	93
c35384fb TT	94	struct minimal_symbol *prim_record_minimal_symbol_full
b19686e0 TT	95	(const char *name,
	96	int name_len,
	97	int copy_name,
	98	CORE_ADDR address,
	99	enum minimal_symbol_type ms_type,
c35384fb	100	int section,
b19686e0 TT	101	struct objfile *objfile);
	102
	103	/* Like prim_record_minimal_symbol_full, but:
	104	- uses strlen to compute NAME_LEN,
	105	- passes COPY_NAME = 0,
e6dc44a8	106	- and passes a default SECTION, depending on the type
b19686e0 TT	107
	108	This variant does not return the new symbol. */
	109
	110	void prim_record_minimal_symbol (const char *, CORE_ADDR,
	111	enum minimal_symbol_type,
	112	struct objfile *);
	113
	114	/* Like prim_record_minimal_symbol_full, but:
	115	- uses strlen to compute NAME_LEN,
	116	- passes COPY_NAME = 0. */
c35384fb TT	117
	118	struct minimal_symbol *prim_record_minimal_symbol_and_info
	119	(const char *,
	120	CORE_ADDR,
	121	enum minimal_symbol_type,
	122	int section,
c35384fb TT	123	struct objfile *);
c35384fb TT	124
b19686e0 TT	125	/* Install the minimal symbols that have been collected into the given
	126	objfile. After this is called, the cleanup returned by
	127	make_cleanup_discard_minimal_symbols should be run in order to
	128	clean up global state. */
	129
	130	void install_minimal_symbols (struct objfile *);
	131
	132	/* Create the terminating entry of OBJFILE's minimal symbol table.
	133	If OBJFILE->msymbols is zero, allocate a single entry from
	134	OBJFILE->objfile_obstack; otherwise, just initialize
	135	OBJFILE->msymbols[OBJFILE->minimal_symbol_count]. */
	136
	137	void terminate_minimal_symbol_table (struct objfile *objfile);
	138
	139	/* Sort all the minimal symbols in OBJFILE. This should be only be
	140	called after relocating symbols; it ensures that the minimal
	141	symbols are properly sorted by address. */
	142
	143	void msymbols_sort (struct objfile *objfile);
	144
	145	\f
	146
	147	/* Compute a hash code for the string argument. */
c35384fb TT	148
	149	unsigned int msymbol_hash (const char *);
	150
b19686e0 TT	151	/* Like msymbol_hash, but compute a hash code that is compatible with
	152	strcmp_iw. */
	153
	154	unsigned int msymbol_hash_iw (const char *);
	155
c35384fb TT	156	/* Compute the next hash value from previous HASH and the character C. This
	157	is only a GDB in-memory computed value with no external files compatibility
	158	requirements. */
	159
	160	#define SYMBOL_HASH_NEXT(hash, c) \
	161	((hash) * 67 + tolower ((unsigned char) (c)) - 113)
	162
b19686e0 TT	163	\f
	164
	165	/* Return the objfile that holds the minimal symbol SYM. Every
	166	minimal symbols is held by some objfile; this will never return
	167	NULL. */
	168
c35384fb TT	169	struct objfile msymbol_objfile (struct minimal_symbol sym);
c35384fb TT	170
b19686e0 TT	171	\f
	172
	173	/* Look through all the current minimal symbol tables and find the
	174	first minimal symbol that matches NAME. If OBJF is non-NULL, limit
	175	the search to that objfile. If SFILE is non-NULL, the only file-scope
	176	symbols considered will be from that source file (global symbols are
	177	still preferred). Returns a pointer to the minimal symbol that
	178	matches, or NULL if no match is found. */
	179
c35384fb TT	180	struct minimal_symbol lookup_minimal_symbol (const char ,
	181	const char *,
	182	struct objfile *);
	183
b19686e0	184	/* Find the minimal symbol named NAME, and return both the minsym
7cbd4a93	185	struct and its objfile. This only checks the linkage name. */
b19686e0	186
7cbd4a93	187	struct bound_minimal_symbol lookup_minimal_symbol_and_objfile (const char *);
b19686e0 TT	188
	189	/* Look through all the current minimal symbol tables and find the
	190	first minimal symbol that matches NAME and has text type. If OBJF
	191	is non-NULL, limit the search to that objfile. Returns a pointer
	192	to the minimal symbol that matches, or NULL if no match is found.
	193
	194	This function only searches the mangled (linkage) names. */
	195
c35384fb TT	196	struct minimal_symbol lookup_minimal_symbol_text (const char ,
	197	struct objfile *);
	198
b19686e0 TT	199	/* Look through all the current minimal symbol tables and find the
	200	first minimal symbol that matches NAME and is a solib trampoline.
	201	If OBJF is non-NULL, limit the search to that objfile. Returns a
	202	pointer to the minimal symbol that matches, or NULL if no match is
	203	found.
	204
	205	This function only searches the mangled (linkage) names. */
	206
c35384fb TT	207	struct minimal_symbol *lookup_minimal_symbol_solib_trampoline
	208	(const char *,
	209	struct objfile *);
	210
b19686e0 TT	211	/* Look through all the current minimal symbol tables and find the
	212	first minimal symbol that matches NAME and PC. If OBJF is non-NULL,
	213	limit the search to that objfile. Returns a pointer to the minimal
	214	symbol that matches, or NULL if no match is found. */
	215
c35384fb	216	struct minimal_symbol *lookup_minimal_symbol_by_pc_name
b19686e0	217	(CORE_ADDR, const char , struct objfile );
c35384fb	218
b19686e0 TT	219	/* Search through the minimal symbol table for each objfile and find
	220	the symbol whose address is the largest address that is still less
	221	than or equal to PC, and which matches SECTION.
c35384fb	222
b19686e0 TT	223	If SECTION is NULL, this uses the result of find_pc_section
	224	instead.
	225
7cbd4a93 TT	226	The result has a non-NULL 'minsym' member if such a symbol is
7cbd4a93 TT	227	found, or NULL if PC is not in a suitable range. */
c35384fb	228
7cbd4a93	229	struct bound_minimal_symbol lookup_minimal_symbol_by_pc_section
c35384fb TT	230	(CORE_ADDR,
	231	struct obj_section *);
	232
b19686e0 TT	233	/* Backward compatibility: search through the minimal symbol table
	234	for a matching PC (no section given).
	235
	236	This is a wrapper that calls lookup_minimal_symbol_by_pc_section
	237	with a NULL section argument. */
c35384fb	238
7cbd4a93	239	struct bound_minimal_symbol lookup_minimal_symbol_by_pc (CORE_ADDR);
c35384fb	240
b19686e0 TT	241	/* Iterate over all the minimal symbols in the objfile OBJF which
	242	match NAME. Both the ordinary and demangled names of each symbol
	243	are considered. The caller is responsible for canonicalizing NAME,
	244	should that need to be done.
c35384fb	245
b19686e0 TT	246	For each matching symbol, CALLBACK is called with the symbol and
b19686e0 TT	247	USER_DATA as arguments. */
c35384fb TT	248
	249	void iterate_over_minimal_symbols (struct objfile *objf,
	250	const char *name,
	251	void (callback) (struct minimal_symbol ,
	252	void *),
	253	void *user_data);
	254
	255	#endif /* MINSYMS_H */