xref: /freebsd/lib/libsysdecode/sysdecode_utrace.3 (revision f3c5273d315a64826d2149ac453ff8c4583ddbe8)
1.\"
2.\" Copyright (c) 2015 John Baldwin <jhb@FreeBSD.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd November 24, 2017
29.Dt sysdecode_utrace 3
30.Os
31.Sh NAME
32.Nm sysdecode_utrace
33.Nd produce text description of a utrace record
34.Sh LIBRARY
35.Lb libsysdecode
36.Sh SYNOPSIS
37.In sys/types.h
38.In stdbool.h
39.In stdio.h
40.In sysdecode.h
41.Ft int
42.Fn sysdecode_utrace "FILE *fp" "void *buf" "size_t len" "int decimal"
43.Sh DESCRIPTION
44The
45.Fn sysdecode_utrace
46function outputs a textual representation of a
47.Xr utrace 2
48record identified by
49.Fa buf
50and
51.Fa len
52to the output stream
53.Fa fp .
54.Pp
55The function only outputs a representation for certain types of records.
56If a record is recognized,
57the function outputs the description and returns a non-zero value.
58If the record is not recognized,
59the function does not output anything and returns zero.
60The
61.Fn sysdecode_utrace
62function currently recognizes
63.Xr utrace 2
64records generated by
65.Xr malloc 3
66and
67.Xr rtld 1 .
68.Sh RETURN VALUES
69The
70.Fn sysdecode_utrace
71function returns a non-zero value if it recognizes a
72.Xr utrace 2
73record;
74otherwise it returns zero.
75.Sh SEE ALSO
76.Xr utrace 2 ,
77.Xr sysdecode 3
78