Debian Codegraph @

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

raw
1 '\" t
2 .\" Title: function::kernel_buffer_quoted_error
3 .\" Author:
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: October 2025
6 .\" Manual: String and data retrieving functions Tapset
7 .\" Source: SystemTap Tapset Reference
8 .\" Language: English
9 .\"
10 .TH "FUNCTION::KERNEL_BUF" "3stap" "October 2025" "SystemTap Tapset Reference" "String and data retrieving fun"
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::kernel_buffer_quoted_error \- Retrieves and quotes buffer from kernel space
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 kernel_buffer_quoted_error:string(addr:long,inlen:long,outlen:long)
36 .fi
37 .SH "ARGUMENTS"
38 .PP
39 \fIaddr\fR
40 .RS 4
41 the kernel space address to retrieve the buffer from
42 .RE
43 .PP
44 \fIinlen\fR
45 .RS 4
46 the exact length of the buffer to read
47 .RE
48 .PP
49 \fIoutlen\fR
50 .RS 4
51 the maximum length of the output string
52 .RE
53 .SH "DESCRIPTION"
54 .PP
55 Reads inlen characters of a buffer from the given kernel space memory address, and returns up to outlen characters, where any ASCII characters that are not printable are replaced by the corresponding escape sequence in the returned string\&. Note that the string will be surrounded by double quotes\&. On the rare cases when kernel space data is not accessible at the given address, an error is thrown\&.
56 .SH SEE ALSO\n
57 .IR tapset::conversions (3stap)