xref: /freebsd/lib/libsys/utrace.2 (revision 8269e7673cf033aba67dab8264fe719920c70f87)
1*8269e767SBrooks Davis.\"	$NetBSD: utrace.2,v 1.11 2003/04/24 12:17:49 wiz Exp $
2*8269e767SBrooks Davis.\"
3*8269e767SBrooks Davis.\" Copyright (c) 2000 The NetBSD Foundation, Inc.
4*8269e767SBrooks Davis.\" All rights reserved.
5*8269e767SBrooks Davis.\"
6*8269e767SBrooks Davis.\" This code is derived from software contributed to The NetBSD Foundation
7*8269e767SBrooks Davis.\" by Gregory McGarry <g.mcgarry@ieee.org>.
8*8269e767SBrooks Davis.\"
9*8269e767SBrooks Davis.\" Redistribution and use in source and binary forms, with or without
10*8269e767SBrooks Davis.\" modification, are permitted provided that the following conditions
11*8269e767SBrooks Davis.\" are met:
12*8269e767SBrooks Davis.\" 1. Redistributions of source code must retain the above copyright
13*8269e767SBrooks Davis.\"    notice, this list of conditions and the following disclaimer.
14*8269e767SBrooks Davis.\" 2. Redistributions in binary form must reproduce the above copyright
15*8269e767SBrooks Davis.\"    notice, this list of conditions and the following disclaimer in the
16*8269e767SBrooks Davis.\"    documentation and/or other materials provided with the distribution.
17*8269e767SBrooks Davis.\"
18*8269e767SBrooks Davis.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19*8269e767SBrooks Davis.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20*8269e767SBrooks Davis.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21*8269e767SBrooks Davis.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22*8269e767SBrooks Davis.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23*8269e767SBrooks Davis.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24*8269e767SBrooks Davis.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25*8269e767SBrooks Davis.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26*8269e767SBrooks Davis.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27*8269e767SBrooks Davis.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*8269e767SBrooks Davis.\"
29*8269e767SBrooks Davis.Dd December 11, 2015
30*8269e767SBrooks Davis.Dt UTRACE 2
31*8269e767SBrooks Davis.Os
32*8269e767SBrooks Davis.Sh NAME
33*8269e767SBrooks Davis.Nm utrace
34*8269e767SBrooks Davis.Nd insert user record in ktrace log
35*8269e767SBrooks Davis.Sh LIBRARY
36*8269e767SBrooks Davis.Lb libc
37*8269e767SBrooks Davis.Sh SYNOPSIS
38*8269e767SBrooks Davis.In sys/param.h
39*8269e767SBrooks Davis.In sys/time.h
40*8269e767SBrooks Davis.In sys/uio.h
41*8269e767SBrooks Davis.In sys/ktrace.h
42*8269e767SBrooks Davis.Ft int
43*8269e767SBrooks Davis.Fn utrace "const void *addr" "size_t len"
44*8269e767SBrooks Davis.Sh DESCRIPTION
45*8269e767SBrooks DavisAdds a record to the process trace with information supplied by user.
46*8269e767SBrooks DavisThe record contains
47*8269e767SBrooks Davis.Fa len
48*8269e767SBrooks Davisbytes from memory pointed to by
49*8269e767SBrooks Davis.Fa addr .
50*8269e767SBrooks DavisThis call only has an effect if the calling process is being traced.
51*8269e767SBrooks Davis.Sh RETURN VALUES
52*8269e767SBrooks Davis.Rv -std
53*8269e767SBrooks Davis.Sh ERRORS
54*8269e767SBrooks Davis.Bl -tag -width Er
55*8269e767SBrooks Davis.It Bq Er EINVAL
56*8269e767SBrooks DavisSpecified data length
57*8269e767SBrooks Davis.Fa len
58*8269e767SBrooks Daviswas bigger than
59*8269e767SBrooks Davis.Dv KTR_USER_MAXLEN .
60*8269e767SBrooks Davis.It Bq Er ENOMEM
61*8269e767SBrooks DavisInsufficient memory to honor the request.
62*8269e767SBrooks Davis.It Bq Er ENOSYS
63*8269e767SBrooks DavisCurrently running kernel was compiled without
64*8269e767SBrooks Davis.Xr ktrace 2
65*8269e767SBrooks Davissupport
66*8269e767SBrooks Davis.Pq Cd "options KTRACE" .
67*8269e767SBrooks Davis.El
68*8269e767SBrooks Davis.Sh SEE ALSO
69*8269e767SBrooks Davis.Xr kdump 1 ,
70*8269e767SBrooks Davis.Xr ktrace 1 ,
71*8269e767SBrooks Davis.Xr truss 1 ,
72*8269e767SBrooks Davis.Xr ktrace 2 ,
73*8269e767SBrooks Davis.Xr sysdecode_utrace 3
74*8269e767SBrooks Davis.Sh HISTORY
75*8269e767SBrooks DavisThe
76*8269e767SBrooks Davis.Fn utrace
77*8269e767SBrooks Davissystem call first appeared in
78*8269e767SBrooks Davis.Fx 2.2 .
79