1.. _symtab:
2
3Symbol Table (Symtab)
4#####################
5
6The Symtab module, when enabled, will generate full symbol table during the Zephyr linking
7stage that keep tracks of the information about the functions' name and address, for advanced application
8with a lot of functions, this is expected to consume a sizable amount of ROM.
9
10Currently, this is being used to look up the function names during a stack trace in supported architectures.
11
12
13Usage
14*****
15
16Application can gain access to the symbol table data structure by including the :file:`symtab.h` header
17file and call :c:func:`symtab_get`. For now, we only provide :c:func:`symtab_find_symbol_name`
18function to look-up the symbol name and offset of an address. More advanced functionalities and be
19achieved by directly accessing the members of the data structure.
20
21Configuration
22*************
23
24Configure this module using the following options.
25
26* :kconfig:option:`CONFIG_SYMTAB`: enable the generation of the symbol table.
27
28API documentation
29*****************
30
31.. doxygengroup:: symtab_apis
32