Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
ELFTC_STRING_TABLE_CR... BSD Library Functions Manual ELFTC_STRING_TABLE_CR...

NAME
     elftc_string_table_create,	elftc_string_table_destroy,
     elftc_string_table_from_section, elftc_string_table_image,
     elftc_string_table_insert,	elftc_string_table_lookup,
     elftc_string_table_remove,	elftc_string_table_to_string --	convenience
     routines for handling ELF string tables

SYNOPSIS
     #include <libelftc.h>

     Elftc_String_Table	*
     elftc_string_table_create(int sizehint);

     int
     elftc_string_table_destroy(Elftc_String_Table *table);

     Elftc_String_Table	*
     elftc_string_table_from_section(Elf_Scn *scn, int sizehint);

     const char	*
     elftc_string_table_image(Elftc_String_Table *table, size_t	*size);

     size_t
     elftc_string_table_insert(Elftc_String_Table *table, const	char *string);

     size_t
     elftc_string_table_lookup(Elftc_String_Table *table, const	char *string);

     int
     elftc_string_table_remove(Elftc_String_Table *table, const	char *string);

     const char	*
     elftc_string_table_to_string(Elftc_String_Table *table, size_t offset);

DESCRIPTION
     This manual page documents	convenience routines for handling ELF string
     tables.

     Function elftc_string_table_create() creates a new, empty string table.
     The argument sizehint provides a hint about the expected number of	bytes
     of	string data in the table.  If the argument sizehint is zero, an	imple-
     mentation-defined default will be used instead.

     Function elftc_string_table_destroy() destroys the	previously allocated
     string table specified by argument	table, and frees the internal re-
     sources allocated for it.

     Function elftc_string_table_from_section()	creates	a new string table and
     initializes it based on the contents of the section specified by argument
     scn.  This	section	must be	of type	SHT_STRTAB.  The argument sizehint
     provides a	hint about expected number of bytes of string data in the ta-
     ble.  If the value	of sizehint is zero, an	implementation-default will be
     used instead.

     Function elftc_string_table_image() returns a pointer to the ELF repre-
     sentation of the contents of the string table specified by	argument
     table.  If	argument size is not NULL, the size of the ELF representation
     of	the string table is stored in the location pointed to by argument
     size.  The	function elftc_string_table_image() will compact the string
     table if the table	contains deleted strings.  The string offsets returned
     by	prior calls to elftc_string_table_insert() and
     elftc_string_table_lookup() should	be treated as invalid after a call to
     this function.

     Function elftc_string_table_insert() inserts the NUL-terminated string
     pointed to	by argument string into	the string table specified by argument
     table, and	returns	an offset value	usable in ELF data structures.	Multi-
     ple insertions of the same	content	will return the	same offset.  The off-
     set returned will remain valid until the next call	to
     elftc_string_table_image().

     Function elftc_string_table_lookup() looks	up the string referenced by
     argument string in	the string table specified by argument table, and if
     found, returns the	offset associated with the string.  The	returned off-
     set will be valid till the	next call to function
     elftc_string_table_image().

     Function elftc_string_table_remove() removes the string pointed by	argu-
     ment string from the string table referenced by argument table, if	it is
     present in	the string table.

     Function elftc_string_table_to_string() returns a pointer to the NUL-ter-
     minated string residing at	argument offset	in the string table specified
     by	argument table.	 The value of argument offset should be	one returned
     by	a prior	call to	elftc_string_table_insert() or
     elftc_string_table_lookup().  The returned	pointer	will remain valid un-
     til the next call to elftc_string_table_insert() or
     elftc_string_table_image().

   Memory Management
     The library "libelftc" library manages its	own memory allocations.	 The
     application should	not free the pointers returned by the string table
     functions.

IMPLEMENTATION NOTES
     The current implementation	is optimized for the case where	strings	are
     added to a	string table, but rarely removed from it.

     The functions elftc_string_table_insert(),	elftc_string_table_lookup(),
     elftc_string_table_remove() and elftc_string_table_to_string() have O(1)
     asymptotic	behavior.  The function	elftc_string_table_image() can have
     O(size) asymptotic	behavior, where	size denotes the size of the string
     table.

RETURN VALUES
     Functions elftc_string_table_create() and
     elftc_string_table_from_section() return a	valid pointer to an opaque
     structure of type Elftc_String_Table on success, or NULL in case of an
     error.

     The function elftc_string_table_image() returns a pointer to an in-memory
     representation of an ELF string table on success, or NULL in case of an
     error.

     Functions elftc_string_table_insert() and elftc_string_table_lookup() re-
     turn a non-zero offset on success,	or zero	in case	of an error.

     Function elftc_string_table_remove() returns a positive value on success,
     or	zero in	case of	an error.

     Function elftc_string_table_to_string() returns a valid pointer on	suc-
     cess, or NULL in case of an error.

SEE ALSO
     dwarf(3), elf(3), elftc(3)

BSD				January	5, 2013				   BSD

NAME | SYNOPSIS | DESCRIPTION | IMPLEMENTATION NOTES | RETURN VALUES | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=elftc_string_table_create&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help