Debian Codegraph @

doc/SystemTap_Tapset_Reference/man3/function::sprint_usyms.3stap

raw
1 '\" t
2 .\" Title: function::sprint_usyms
3 .\" Author:
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: October 2025
6 .\" Manual: Context Functions
7 .\" Source: SystemTap Tapset Reference
8 .\" Language: English
9 .\"
10 .TH "FUNCTION::SPRINT_USY" "3stap" "October 2025" "SystemTap Tapset Reference" "Context Functions"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 function::sprint_usyms \- Return stack for user addresses from string
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 sprint_usyms(callers:string)
36 .fi
37 .SH "ARGUMENTS"
38 .PP
39 \fIcallers\fR
40 .RS 4
41 String with list of hexadecimal (user) addresses
42 .RE
43 .SH "DESCRIPTION"
44 .PP
45 Perform a symbolic lookup of the addresses in the given string, which are assumed to be the result of a prior calls to
46 \fBustack\fR,
47 \fBucallers\fR, and similar functions\&.
48 .PP
49 Returns a simple backtrace from the given hex string\&. One line per address\&. Includes the symbol name (or hex address if symbol couldn\*(Aqt be resolved) and module name (if found), as obtained from
50 \fBusymdata\fR\&. Includes the offset from the start of the function if found, otherwise the offset will be added to the module (if found, between brackets)\&. Returns the backtrace as string (each line terminated by a newline character)\&. Note that the returned stack will be truncated to MAXSTRINGLEN, to print fuller and richer stacks use
51 \fBprint_usyms\fR\&.
52 .SH SEE ALSO\n
53 .IR tapset::ucontext-symbols (3stap)