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