1.\" $NetBSD: tprof.4,v 1.4 2018/12/12 08:28:19 maxv Exp $ 2.\" 3.\" Copyright (c)2011 YAMAMOTO Takashi, 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.\" ------------------------------------------------------------ 28.Dd December 12, 2018 29.Dt TPROF 4 30.Os 31.\" ------------------------------------------------------------ 32.Sh NAME 33.Nm tprof 34.Nd a sampling based profiler 35.\" ------------------------------------------------------------ 36.Sh SYNOPSIS 37.Cd pseudo-device tprof 38.\" ------------------------------------------------------------ 39.Sh DESCRIPTION 40The 41.Nm 42driver provides kernel services necessary for 43.Xr tprof 8 . 44.Pp 45Specifically, it makes its backend driver collect profiling samples and 46provide them to the userland consumer. 47.Pp 48The API/ABI is currently undocumented and will likely change in future 49without keeping compatibility. 50.Pp 51On x86, the tprof_x86 module must be loaded in addition to the 52.Nm 53driver. 54.\" ------------------------------------------------------------ 55.\".Sh EXAMPLES 56.\" ------------------------------------------------------------ 57.Sh SEE ALSO 58.Xr tprof 8 59.\" ------------------------------------------------------------ 60.\".Sh HISTORY 61.\"The 62.\".Nm 63.\"driver first appeared in 64.\".Nx 4.0 . 65.\" ------------------------------------------------------------ 66.Sh AUTHORS 67The 68.Nm 69driver was written by 70.An YAMAMOTO Takashi . 71.\" ------------------------------------------------------------ 72.Sh BUGS 73There is no way to configure multiple backend drivers statically. 74