freebsd-dev/usr.bin/systat/extern.h
Warner Losh 22054f8891 Report I/O stats from the CAM_IOSCHED_DYNAMIC extension
Report, on a periodic basis, the I/O latencies the CAM I/O scheduler
computes. These times are only for the hardware portion of the I/O as
measured from the time the operation is scheduled with the SIM using
xpt_action() until the SIM reports it has completed with xpt_dine(). Any
time the I/O operation spends in a software queue is no included.

The P50 (median), P90, P99 and P99.9 statistics about the latency of
each of the read, write and trim operations that completed during the
polling interval are reported. If there are fewer than 2, 10, 100 or
1000 operations during the polling interval, no statistic is reported
and a single dash '-' is displayed.

The read, write and trim commands (either on the command line or at run
time) toggle display of these operations. The color command toggles
color (it defaults to on, like gstat). When color is enabled, unknown
statistics are reported in blue, high latency for a statistics is
reported in red, medium in magenta and low in green (as with gstat). The
med= and hi= commands can set these latency thresholds.

Limitations: The entire sysctl space for all the devices is walked for
each polling period. This should be optimized to remember the OIDs and
only do such polling with the xpt generation changes. There is also no
way to filter devices displayed. This command only works on physical
devies that are connected to SCSI, ATA or NVME sims as those are the
only ones that are instrumented in the CAM I/O scheduler (the
CAM_IOSCHED_DYNAMIC option must be in the kernel, and the dynamic
scheduler can't be disabled).

MFC After:		1 month
Relnotes:		yes
Sponsored by:		Netflix
Reviewed by:		pauamma_gundo.com, chs
Differential Revision:	https://reviews.freebsd.org/D34259
2022-02-28 10:44:47 -07:00

193 lines
5.7 KiB
C

/*-
* SPDX-License-Identifier: BSD-3-Clause
*
* Copyright (c) 1991, 1993
* The Regents of the University of California. All rights reserved.
*
* 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.
* 3. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
*
* @(#)extern.h 8.1 (Berkeley) 6/6/93
* $FreeBSD$
*/
#include <sys/cdefs.h>
#include <fcntl.h>
#include <kvm.h>
extern struct cmdtab *curcmd;
extern struct cmdtab cmdtab[];
extern struct text *xtext;
extern WINDOW *wnd;
extern char **dr_name;
extern char c, *namp, hostname[];
extern double avenrun[3];
extern float *dk_mspw;
extern kvm_t *kd;
extern long ntext, textp;
extern int *dk_select;
extern int CMDLINE;
extern int dk_ndrive;
extern int hz, stathz;
extern double hertz; /* sampling frequency for cp_time and dk_time */
extern int col;
extern int nhosts;
extern int nports;
extern int protos;
extern int verbose;
extern unsigned int delay;
extern int curscale;
extern char *matchline;
extern int showpps;
extern int needsort;
struct in_conninfo;
extern struct device_selection *dev_select;
extern long generation;
extern int num_devices;
extern int num_selected;
extern int num_selections;
extern long select_generation;
extern struct nlist namelist[];
int checkhost(struct in_conninfo *);
int checkport(struct in_conninfo *);
void closeicmp(WINDOW *);
void closeicmp6(WINDOW *);
void closeifstat(WINDOW *);
void closeiostat(WINDOW *);
void closeip(WINDOW *);
void closeip6(WINDOW *);
void closekre(WINDOW *);
void closenetstat(WINDOW *);
void closepigs(WINDOW *);
void closeswap(WINDOW *);
void closetcp(WINDOW *);
int cmdifstat(const char *, const char *);
int cmdiolat(const char *, const char *);
int cmdiostat(const char *, const char *);
int cmdkre(const char *, const char *);
int cmdnetstat(const char *, const char *);
struct cmdtab *lookup(const char *);
void command(const char *);
void die(int);
void display(void);
int dkinit(void);
int dkcmd(char *, char *);
void error(const char *fmt, ...) __printflike(1, 2);
void fetchicmp(void);
void fetchicmp6(void);
void fetchifstat(void);
void fetchip(void);
void fetchip6(void);
void fetchiostat(void);
void fetchkre(void);
void fetchnetstat(void);
void fetchpigs(void);
void fetchswap(void);
void fetchtcp(void);
void getsysctl(const char *, void *, size_t);
int ifcmd(const char *cmd, const char *args);
int initicmp(void);
int initicmp6(void);
int initifstat(void);
int initip(void);
int initip6(void);
int initiostat(void);
int initkre(void);
int initnetstat(void);
int initpigs(void);
int initswap(void);
int inittcp(void);
int keyboard(void);
int kvm_ckread(void *, void *, int);
void labelicmp(void);
void labelicmp6(void);
void labelifstat(void);
void labelip(void);
void labelip6(void);
void labeliostat(void);
void labelkre(void);
void labelnetstat(void);
void labelpigs(void);
void labels(void);
void labelswap(void);
void labeltcp(void);
void load(void);
int netcmd(const char *, const char *);
void nlisterr(struct nlist []);
WINDOW *openicmp(void);
WINDOW *openicmp6(void);
WINDOW *openifstat(void);
WINDOW *openip(void);
WINDOW *openip6(void);
WINDOW *openiostat(void);
WINDOW *openkre(void);
WINDOW *opennetstat(void);
WINDOW *openpigs(void);
WINDOW *openswap(void);
WINDOW *opentcp(void);
int prefix(const char *, const char *);
void reseticmp(void);
void reseticmp6(void);
void resetip(void);
void resetip6(void);
void resettcp(void);
void showicmp(void);
void showicmp6(void);
void showifstat(void);
void showip(void);
void showip6(void);
void showiostat(void);
void showkre(void);
void shownetstat(void);
void showpigs(void);
void showswap(void);
void showtcp(void);
void status(void);
void suspend(int);
char *sysctl_dynread(const char *, size_t *);
void sysputpage(WINDOW* , int, int, int, uint64_t, int);
void sysputspaces(WINDOW* , int, int, int);
void sysputstrs(WINDOW* , int, int, int);
void sysputXs(WINDOW* , int, int, int);
void sysputuint64(WINDOW* , int, int, int, uint64_t, int);
void sysputwuint64(WINDOW* , int, int, int, uint64_t, int);
#define SYSTAT_CMD(name) \
void close ## name(WINDOW *); \
void fetch ## name(void); \
int init ## name(void); \
void label ## name(void); \
WINDOW *open ## name(void); \
void reset ## name(void); \
void show ## name(void)
SYSTAT_CMD( zarc );
SYSTAT_CMD( sctp );
SYSTAT_CMD( iolat );