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 January 9, 2017 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 p Ar port 54.Op Fl w Ar wait 55.Sh DESCRIPTION 56The 57.Nm 58utility provides statistics information for the CAM Target Layer. 59The first display (except for dump and JSON modes) shows average statistics 60since system startup. 61Subsequent displays show average statistics during the measurement 62interval. 63.Pp 64The options are as follows: 65.Bl -tag -width 10n 66.It Fl t 67Total mode. 68This displays separate columns with the total read and write output, 69and a combined total column that also includes non I/O operations. 70.It Fl c Ar count 71Display statistics this many times. 72.It Fl C 73Disable CPU statistics display. 74.It Fl d 75Display DMA operation time (latency) instead of overall I/O time (latency). 76.It Fl D 77Text dump mode. 78Dump statistics every 30 seconds in a text format suitable for 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 statistics every 30 seconds in JavaScript Object Notation (JSON) format. 85No statistics are computed in this mode, only raw numbers are displayed. 86.It Fl l Ar lun 87Request statistics for the specified LUN. 88.It Fl n Ar numdevs 89Display statistics for this many devices. 90.It Fl p Ar port 91Request statistics for the specified port. 92.It Fl w Ar wait 93Wait this many seconds in between displays. 94If this option is not specified, 95.Nm 96defaults to a 1 second interval. 97.El 98.Sh EXAMPLES 99.Dl ctlstat -t 100.Pp 101Display total statistics for the system with a one second interval. 102.Pp 103.Dl ctlstat -d -l 5 -C 104.Pp 105Display average DMA time for LUN 5 and omit CPU utilization. 106.Pp 107.Dl ctlstat -n 7 -w 10 108.Pp 109Display statistics for the first 7 LUNs, and display average statistics 110every 10 seconds. 111.Sh SEE ALSO 112.Xr cam 3 , 113.Xr cam 4 , 114.Xr ctl 4 , 115.Xr xpt 4 , 116.Xr camcontrol 8 , 117.Xr ctladm 8 , 118.Xr ctld 8 , 119.Xr iostat 8 120.Sh AUTHORS 121.An Ken Merry Aq Mt ken@FreeBSD.org 122.An Will Andrews Aq Mt will@FreeBSD.org 123.An Alexander Motin Aq Mt mav@FreeBSD.org 124