1.\" $OpenBSD: utrace.2,v 1.1 2013/06/01 09:49:53 miod Exp $ 2.\" $NetBSD: utrace.2,v 1.13 2008/05/02 18:38:32 martin Exp $ 3.\" 4.\" Copyright (c) 2000 The NetBSD Foundation, Inc. 5.\" All rights reserved. 6.\" 7.\" This code is derived from software contributed to The NetBSD Foundation 8.\" by Gregory McGarry <g.mcgarry@ieee.org>. 9.\" 10.\" Redistribution and use in source and binary forms, with or without 11.\" modification, are permitted provided that the following conditions 12.\" are met: 13.\" 1. Redistributions of source code must retain the above copyright 14.\" notice, this list of conditions and the following disclaimer. 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in the 17.\" documentation and/or other materials provided with the distribution. 18.\" 19.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29.\" POSSIBILITY OF SUCH DAMAGE. 30.\" 31.Dd $Mdocdate: June 1 2013 $ 32.Dt UTRACE 2 33.Os 34.Sh NAME 35.Nm utrace 36.Nd insert user record in ktrace log 37.Sh SYNOPSIS 38.In sys/types.h 39.In sys/param.h 40.In sys/uio.h 41.In sys/ktrace.h 42.Ft int 43.Fn utrace "const char *label" "void *addr" "size_t len" 44.Sh DESCRIPTION 45Adds a record to the process trace with information supplied by the user. 46The record is identified by 47.Fa label 48and contains 49.Fa len 50bytes from memory pointed to by 51.Fa addr . 52This call only has an effect if the calling process is being traced. 53.Sh RETURN VALUES 54.Rv -std 55.Sh ERRORS 56.Bl -tag -width Er 57.It Bq Er ENOSYS 58The currently running kernel was compiled without 59.Xr ktrace 2 60support (option KTRACE). 61.It Bq Er ENAMETOOLONG 62The length of the 63.Fa label 64string was longer than 65.Dv KTR_USER_MAXIDLEN\-1 . 66.It Bq Er EINVAL 67The specified data length 68.Fa len 69was bigger than 70.Dv KTR_USER_MAXLEN . 71.El 72.Sh SEE ALSO 73.Xr kdump 1 , 74.Xr ktrace 1 , 75.Xr ktrace 2 , 76.Xr options 4 77.Sh HISTORY 78The 79.Fn utrace 80system call first appeared in 81.Fx 2.2 . 82It was added to 83.Ox 84in 85.Ox 5.4 . 86The 87.Fa label 88argument is an extension. 89