xref: /freebsd/lib/libsysdecode/sysdecode_utrace.3 (revision 1f4bcc459a76b7aa664f3fd557684cd0ba6da352)
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 December 11, 2015
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.Ft int
38.Fn sysdecode_utrace "FILE *fp" "void *buf" "size_t len" "int decimal"
39.Sh DESCRIPTION
40The
41.Fn sysdecode_utrace
42function outputs a textual representation of a
43.Xr utrace 2
44record identified by
45.Fa buf
46and
47.Fa len
48to the output stream
49.Fa fp .
50.Pp
51The function only outputs a representation for certain types of records.
52If a record is recognized,
53the function outputs the description and returns a non-zero value.
54If the record is not recognized,
55the function does not output anything and returns zero.
56The
57.Fn sysdecode_utrace
58function currently recognizes
59.Xr utrace 2
60records generated by
61.Xr malloc 3
62and
63.Xr rtld 1 .
64.Sh RETURN VALUES
65The
66.Fn sysdecode_utrace
67function returns a non-zero value if it recognizes a
68.Xr utrace 2
69record;
70otherwise it returns zero.
71.Sh SEE ALSO
72.Xr utrace 2 ,
73.Xr sysdecode 3
74