93 lines
2.7 KiB
Groff
93 lines
2.7 KiB
Groff
|
.\" $NetBSD: utrace.2,v 1.13 2008/05/02 18:38:32 martin Exp $
|
||
|
|
.\"
|
||
|
|
.\" Copyright (c) 2000 The NetBSD Foundation, Inc.
|
||
|
|
.\" All rights reserved.
|
||
|
|
.\"
|
||
|
|
.\" This code is derived from software contributed to The NetBSD Foundation
|
||
|
|
.\" by Gregory McGarry <g.mcgarry@ieee.org>.
|
||
|
|
.\"
|
||
|
|
.\" Redistribution and use in source and binary forms, with or without
|
||
|
|
.\" modification, are permitted provided that the following conditions
|
||
|
|
.\" are met:
|
||
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer.
|
||
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
||
|
|
.\" documentation and/or other materials provided with the distribution.
|
||
|
|
.\"
|
||
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
||
|
|
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
||
|
|
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
||
|
|
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||
|
|
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||
|
|
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||
|
|
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||
|
|
.\" POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
.\"
|
||
|
|
.Dd December 28, 2000
|
||
|
|
.Dt UTRACE 2
|
||
|
|
.Os
|
||
|
|
.Sh NAME
|
||
|
|
.Nm utrace
|
||
|
|
.Nd insert user record in ktrace log
|
||
|
|
.Sh LIBRARY
|
||
|
|
.Lb libc
|
||
|
|
.Sh SYNOPSIS
|
||
|
|
.In sys/types.h
|
||
|
|
.In sys/param.h
|
||
|
|
.In sys/time.h
|
||
|
|
.In sys/uio.h
|
||
|
|
.In sys/ktrace.h
|
||
|
|
.Ft int
|
||
|
|
.Fn utrace "const char *label" "void *addr" "size_t len"
|
||
|
|
.Sh DESCRIPTION
|
||
|
|
Adds a record to the process trace with information supplied by user.
|
||
|
|
The record is identified by
|
||
|
|
.Fa label
|
||
|
|
and contains
|
||
|
|
.Fa len
|
||
|
|
bytes from memory pointed to by
|
||
|
|
.Fa addr .
|
||
|
|
This call only has an effect if the calling process is being traced.
|
||
|
|
.Sh RETURN VALUES
|
||
|
|
Upon successful completion, a value of 0 is returned.
|
||
|
|
Otherwise, a value of \-1 is returned and
|
||
|
|
.Va errno
|
||
|
|
is set to indicate the error.
|
||
|
|
.Sh ERRORS
|
||
|
|
.Bl -tag -width Er
|
||
|
|
.It Bq Er ENOSYS
|
||
|
|
Currently running kernel was compiled without
|
||
|
|
.Xr ktrace 2
|
||
|
|
support (option KTRACE).
|
||
|
|
.It Bq Er EINVAL
|
||
|
|
Specified data length
|
||
|
|
.Fa len
|
||
|
|
was bigger than
|
||
|
|
.Dv KTR_USER_MAXLEN .
|
||
|
|
.El
|
||
|
|
.Sh SEE ALSO
|
||
|
|
.Xr kdump 1 ,
|
||
|
|
.Xr ktrace 1 ,
|
||
|
|
.Xr ktruss 1 ,
|
||
|
|
.Xr fktrace 2 ,
|
||
|
|
.Xr ktrace 2 ,
|
||
|
|
.Xr options 4
|
||
|
|
.Sh HISTORY
|
||
|
|
The
|
||
|
|
.Fn utrace
|
||
|
|
system call first appeared in
|
||
|
|
.Fx 2.2 .
|
||
|
|
It was added to
|
||
|
|
.Nx
|
||
|
|
in
|
||
|
|
.Nx 1.6 .
|
||
|
|
The
|
||
|
|
.Fa label
|
||
|
|
argument is a
|
||
|
|
.Nx
|
||
|
|
extension.
|