1.\" 2.\" Copyright (c) 2010 Silicon Graphics International Corp. 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.\" without modification. 11.\" 2. Redistributions in binary form must reproduce at minimum a disclaimer 12.\" substantially similar to the "NO WARRANTY" disclaimer below 13.\" ("Disclaimer") and any redistribution must be conditioned upon 14.\" including a substantially similar Disclaimer requirement for further 15.\" binary redistribution. 16.\" 17.\" NO WARRANTY 18.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 21.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22.\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 26.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 27.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGES. 29.\" 30.\" ctlstat utility man page. 31.\" 32.\" Author: Ken Merry <ken@FreeBSD.org> 33.\" 34.\" $Id: //depot/users/kenm/FreeBSD-test2/usr.bin/ctlstat/ctlstat.8#2 $ 35.\" $FreeBSD$ 36.\" 37.Dd March 8, 2015 38.Dt CTLSTAT 8 39.Os 40.Sh NAME 41.Nm ctlstat 42.Nd CAM Target Layer statistics utility 43.Sh SYNOPSIS 44.Nm 45.Op Fl t 46.Op Fl c Ar count 47.Op Fl C 48.Op Fl d 49.Op Fl D 50.Op Fl j 51.Op Fl l Ar lun 52.Op Fl n Ar numdevs 53.Op Fl w Ar wait 54.Sh DESCRIPTION 55The 56.Nm 57utility provides statistics information for the CAM Target Layer. 58The first display (except for dump and JSON modes) shows average statistics 59since system startup. 60Subsequent displays show average statistics during the measurement 61interval. 62.Pp 63The options are as follows: 64.Bl -tag -width 10n 65.It Fl t 66Total mode. 67This displays separate columns with the total CTL read and write output, 68and a combined total column that also includes non I/O operations. 69.It Fl c Ar count 70Display statistics this many times. 71.It Fl C 72Disable CPU statistics display. 73.It Fl d 74Display DMA operation time (latency) instead of overall I/O time (latency). 75.It Fl D 76Text dump mode. 77Dump all available statistics every 30 seconds in a text format suitable 78for parsing. 79No statistics are computed in this mode, only raw numbers are displayed. 80.It Fl h 81Suppress display of the header. 82.It Fl j 83JSON dump mode. 84Dump all available statistics every 30 seconds in JavaScript Object 85Notation (JSON) format. 86No statistics are computed in this mode, only raw numbers are displayed. 87.It Fl l Ar lun 88Request statistics for the specified LUN. 89This option is incompatible with total 90.Fl ( t ) 91mode. 92.It Fl n Ar numdevs 93Display statistics for this many devices. 94.It Fl w Ar wait 95Wait this many seconds in between displays. 96If this option is not specified, 97.Nm 98defaults to a 1 second interval. 99.El 100.Sh EXAMPLES 101.Dl ctlstat -t 102.Pp 103Display total statistics for the system with a one second interval. 104.Pp 105.Dl ctlstat -d -l 5 -C 106.Pp 107Display average DMA time for LUN 5 and omit CPU utilization. 108.Pp 109.Dl ctlstat -n 7 -w 10 110.Pp 111Display statistics for the first 7 LUNs, and display average statistics 112every 10 seconds. 113.Sh SEE ALSO 114.Xr cam 3 , 115.Xr cam 4 , 116.Xr ctl 4 , 117.Xr xpt 4 , 118.Xr camcontrol 8 , 119.Xr ctladm 8 , 120.Xr iostat 8 121.Sh AUTHORS 122.An Ken Merry Aq Mt ken@FreeBSD.org 123.An Will Andrews Aq Mt will@FreeBSD.org 124