xref: /titanic_50/usr/src/cmd/stat/common/statcommon.h (revision a08731ec17cb062d80f19791149c20e0f2f43b01)
17c478bd9Sstevel@tonic-gate /*
27c478bd9Sstevel@tonic-gate  * CDDL HEADER START
37c478bd9Sstevel@tonic-gate  *
47c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*a08731ecScth  * Common Development and Distribution License (the "License").
6*a08731ecScth  * You may not use this file except in compliance with the License.
77c478bd9Sstevel@tonic-gate  *
87c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
97c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
107c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
117c478bd9Sstevel@tonic-gate  * and limitations under the License.
127c478bd9Sstevel@tonic-gate  *
137c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
147c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
157c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
167c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
177c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
187c478bd9Sstevel@tonic-gate  *
197c478bd9Sstevel@tonic-gate  * CDDL HEADER END
207c478bd9Sstevel@tonic-gate  */
217c478bd9Sstevel@tonic-gate /*
22*a08731ecScth  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
237c478bd9Sstevel@tonic-gate  * Use is subject to license terms.
247c478bd9Sstevel@tonic-gate  *
257c478bd9Sstevel@tonic-gate  * Common routines for acquiring snapshots of kstats for
267c478bd9Sstevel@tonic-gate  * iostat, mpstat, and vmstat.
277c478bd9Sstevel@tonic-gate  */
287c478bd9Sstevel@tonic-gate 
297c478bd9Sstevel@tonic-gate #ifndef	_STATCOMMON_H
307c478bd9Sstevel@tonic-gate #define	_STATCOMMON_H
317c478bd9Sstevel@tonic-gate 
327c478bd9Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
337c478bd9Sstevel@tonic-gate 
347c478bd9Sstevel@tonic-gate #ifdef __cplusplus
357c478bd9Sstevel@tonic-gate extern "C" {
367c478bd9Sstevel@tonic-gate #endif
377c478bd9Sstevel@tonic-gate 
387c478bd9Sstevel@tonic-gate #include <stdio.h>
397c478bd9Sstevel@tonic-gate #include <kstat.h>
407c478bd9Sstevel@tonic-gate #include <sys/time.h>
417c478bd9Sstevel@tonic-gate #include <sys/types.h>
427c478bd9Sstevel@tonic-gate #include <sys/buf.h>
437c478bd9Sstevel@tonic-gate #include <sys/dnlc.h>
447c478bd9Sstevel@tonic-gate #include <sys/sysinfo.h>
457c478bd9Sstevel@tonic-gate #include <sys/vmmeter.h>
467c478bd9Sstevel@tonic-gate #include <sys/processor.h>
477c478bd9Sstevel@tonic-gate #include <sys/pset.h>
487c478bd9Sstevel@tonic-gate 
497c478bd9Sstevel@tonic-gate /* No CPU present at this CPU position */
507c478bd9Sstevel@tonic-gate #define	ID_NO_CPU -1
517c478bd9Sstevel@tonic-gate /* CPU belongs to no pset (we number this as "pset 0")  */
527c478bd9Sstevel@tonic-gate #define	ID_NO_PSET 0
537c478bd9Sstevel@tonic-gate /* CPU is usable */
547c478bd9Sstevel@tonic-gate #define	CPU_ONLINE(s) ((s) == P_ONLINE || (s) == P_NOINTR)
557c478bd9Sstevel@tonic-gate /* will the CPU have kstats */
567c478bd9Sstevel@tonic-gate #define	CPU_ACTIVE(c) (CPU_ONLINE((c)->cs_state) && (c)->cs_id != ID_NO_CPU)
577c478bd9Sstevel@tonic-gate /* IO device has no identified ID */
587c478bd9Sstevel@tonic-gate #define	IODEV_NO_ID -1
597c478bd9Sstevel@tonic-gate /* no limit to iodevs to collect */
607c478bd9Sstevel@tonic-gate #define	UNLIMITED_IODEVS ((size_t)-1)
617c478bd9Sstevel@tonic-gate 
627c478bd9Sstevel@tonic-gate enum snapshot_types {
637c478bd9Sstevel@tonic-gate 	/* All CPUs separately */
647c478bd9Sstevel@tonic-gate 	SNAP_CPUS 		= 1 << 0,
657c478bd9Sstevel@tonic-gate 	/* Aggregated processor sets */
667c478bd9Sstevel@tonic-gate 	SNAP_PSETS		= 1 << 1,
677c478bd9Sstevel@tonic-gate 	/* sys-wide stats including aggregated CPU stats */
687c478bd9Sstevel@tonic-gate 	SNAP_SYSTEM		= 1 << 2,
697c478bd9Sstevel@tonic-gate 	/* interrupt sources and counts */
707c478bd9Sstevel@tonic-gate 	SNAP_INTERRUPTS 	= 1 << 3,
717c478bd9Sstevel@tonic-gate 	/* cache flushes */
727c478bd9Sstevel@tonic-gate 	SNAP_FLUSHES		= 1 << 4,
737c478bd9Sstevel@tonic-gate 	/* disk etc. stats */
747c478bd9Sstevel@tonic-gate 	SNAP_IODEVS		= 1 << 5,
757c478bd9Sstevel@tonic-gate 	/* disk controller aggregates */
767c478bd9Sstevel@tonic-gate 	SNAP_CONTROLLERS	= 1 << 6,
777c478bd9Sstevel@tonic-gate 	/* mpxio (multipath) paths */
787c478bd9Sstevel@tonic-gate 	SNAP_IOPATHS		= 1 << 7,
797c478bd9Sstevel@tonic-gate 	/* disk error stats */
807c478bd9Sstevel@tonic-gate 	SNAP_IODEV_ERRORS	= 1 << 8,
817c478bd9Sstevel@tonic-gate 	/* pretty names for iodevs */
82*a08731ecScth 	SNAP_IODEV_PRETTY	= 1 << 9,
83*a08731ecScth 	/* devid for iodevs */
84*a08731ecScth 	SNAP_IODEV_DEVID	= 1 << 10
857c478bd9Sstevel@tonic-gate };
867c478bd9Sstevel@tonic-gate 
877c478bd9Sstevel@tonic-gate struct cpu_snapshot {
887c478bd9Sstevel@tonic-gate 	/* may be ID_NO_CPU if no CPU present */
897c478bd9Sstevel@tonic-gate 	processorid_t cs_id;
907c478bd9Sstevel@tonic-gate 	/* may be ID_NO_PSET if no pset */
917c478bd9Sstevel@tonic-gate 	psetid_t cs_pset_id;
927c478bd9Sstevel@tonic-gate 	/* as in p_online(2) */
937c478bd9Sstevel@tonic-gate 	int cs_state;
947c478bd9Sstevel@tonic-gate 	/* stats for this CPU */
957c478bd9Sstevel@tonic-gate 	kstat_t cs_vm;
967c478bd9Sstevel@tonic-gate 	kstat_t cs_sys;
977c478bd9Sstevel@tonic-gate };
987c478bd9Sstevel@tonic-gate 
997c478bd9Sstevel@tonic-gate struct pset_snapshot {
1007c478bd9Sstevel@tonic-gate 	/* ID may be zero to indicate the "none set" */
1017c478bd9Sstevel@tonic-gate 	psetid_t ps_id;
1027c478bd9Sstevel@tonic-gate 	/* number of CPUs in set */
1037c478bd9Sstevel@tonic-gate 	size_t ps_nr_cpus;
1047c478bd9Sstevel@tonic-gate 	/* the CPUs in this set */
1057c478bd9Sstevel@tonic-gate 	struct cpu_snapshot **ps_cpus;
1067c478bd9Sstevel@tonic-gate };
1077c478bd9Sstevel@tonic-gate 
1087c478bd9Sstevel@tonic-gate struct intr_snapshot {
1097c478bd9Sstevel@tonic-gate 	/* name of interrupt source */
1107c478bd9Sstevel@tonic-gate 	char is_name[KSTAT_STRLEN];
1117c478bd9Sstevel@tonic-gate 	/* total number of interrupts from this source */
1127c478bd9Sstevel@tonic-gate 	ulong_t is_total;
1137c478bd9Sstevel@tonic-gate };
1147c478bd9Sstevel@tonic-gate 
1157c478bd9Sstevel@tonic-gate struct sys_snapshot {
1167c478bd9Sstevel@tonic-gate 	sysinfo_t ss_sysinfo;
1177c478bd9Sstevel@tonic-gate 	vminfo_t ss_vminfo;
1187c478bd9Sstevel@tonic-gate 	struct nc_stats ss_nc;
1197c478bd9Sstevel@tonic-gate 	/* vm/sys stats aggregated across all CPUs */
1207c478bd9Sstevel@tonic-gate 	kstat_t ss_agg_vm;
1217c478bd9Sstevel@tonic-gate 	kstat_t ss_agg_sys;
1227c478bd9Sstevel@tonic-gate 	/* ticks since boot */
1237c478bd9Sstevel@tonic-gate 	ulong_t ss_ticks;
1247c478bd9Sstevel@tonic-gate 	long ss_deficit;
1257c478bd9Sstevel@tonic-gate };
1267c478bd9Sstevel@tonic-gate 
1277c478bd9Sstevel@tonic-gate /* order is significant (see sort_before()) */
1287c478bd9Sstevel@tonic-gate enum iodev_type {
1297c478bd9Sstevel@tonic-gate 	IODEV_CONTROLLER	= 1 << 0,
1307c478bd9Sstevel@tonic-gate 	IODEV_DISK		= 1 << 1,
1317c478bd9Sstevel@tonic-gate 	IODEV_PARTITION		= 1 << 2,
1327c478bd9Sstevel@tonic-gate 	IODEV_TAPE		= 1 << 3,
1337c478bd9Sstevel@tonic-gate 	IODEV_NFS		= 1 << 4,
1347c478bd9Sstevel@tonic-gate 	IODEV_IOPATH		= 1 << 5,
1357c478bd9Sstevel@tonic-gate 	IODEV_UNKNOWN		= 1 << 6
1367c478bd9Sstevel@tonic-gate };
1377c478bd9Sstevel@tonic-gate 
1387c478bd9Sstevel@tonic-gate /* identify a disk, partition, etc. */
1397c478bd9Sstevel@tonic-gate struct iodev_id {
1407c478bd9Sstevel@tonic-gate 	int id;
1417c478bd9Sstevel@tonic-gate 	/* target id (for disks) */
1427c478bd9Sstevel@tonic-gate 	char tid[KSTAT_STRLEN];
1437c478bd9Sstevel@tonic-gate };
1447c478bd9Sstevel@tonic-gate 
1457c478bd9Sstevel@tonic-gate /*
1467c478bd9Sstevel@tonic-gate  * Used for disks, partitions, tapes, nfs, controllers, iopaths
1477c478bd9Sstevel@tonic-gate  * Each entry can be a branch of a tree; for example, the disks
1487c478bd9Sstevel@tonic-gate  * of a controller constitute the children of the controller
1497c478bd9Sstevel@tonic-gate  * iodev_snapshot. This relationship is not strictly maintained
1507c478bd9Sstevel@tonic-gate  * if is_pretty can't be found.
1517c478bd9Sstevel@tonic-gate  */
1527c478bd9Sstevel@tonic-gate struct iodev_snapshot {
1537c478bd9Sstevel@tonic-gate 	/* original kstat name */
1547c478bd9Sstevel@tonic-gate 	char is_name[KSTAT_STRLEN];
1557c478bd9Sstevel@tonic-gate 	enum iodev_type is_type;
1567c478bd9Sstevel@tonic-gate 	/* ID if meaningful */
1577c478bd9Sstevel@tonic-gate 	struct iodev_id is_id;
1587c478bd9Sstevel@tonic-gate 	/* parent ID if meaningful */
1597c478bd9Sstevel@tonic-gate 	struct iodev_id is_parent_id;
1607c478bd9Sstevel@tonic-gate 	/* user-friendly name if found */
1617c478bd9Sstevel@tonic-gate 	char *is_pretty;
1627c478bd9Sstevel@tonic-gate 	/* device ID if applicable */
1637c478bd9Sstevel@tonic-gate 	char *is_devid;
1647c478bd9Sstevel@tonic-gate 	/* mount-point if applicable */
1657c478bd9Sstevel@tonic-gate 	char *is_dname;
1667c478bd9Sstevel@tonic-gate 	/* number of direct children */
1677c478bd9Sstevel@tonic-gate 	int is_nr_children;
1687c478bd9Sstevel@tonic-gate 	/* children of this I/O device */
1697c478bd9Sstevel@tonic-gate 	struct iodev_snapshot *is_children;
1707c478bd9Sstevel@tonic-gate 	/* standard I/O stats */
1717c478bd9Sstevel@tonic-gate 	kstat_io_t is_stats;
1727c478bd9Sstevel@tonic-gate 	/* iodev error stats */
1737c478bd9Sstevel@tonic-gate 	kstat_t is_errors;
1747c478bd9Sstevel@tonic-gate 	/* creation time of the stats */
1757c478bd9Sstevel@tonic-gate 	hrtime_t is_crtime;
1767c478bd9Sstevel@tonic-gate 	/* time at which iodev snapshot was taken */
1777c478bd9Sstevel@tonic-gate 	hrtime_t is_snaptime;
1787c478bd9Sstevel@tonic-gate 	/* kstat module */
1797c478bd9Sstevel@tonic-gate 	char is_module[KSTAT_STRLEN];
1807c478bd9Sstevel@tonic-gate 	/* kstat instance */
1817c478bd9Sstevel@tonic-gate 	int is_instance;
1827c478bd9Sstevel@tonic-gate 	/* kstat (only used temporarily) */
1837c478bd9Sstevel@tonic-gate 	kstat_t *is_ksp;
1847c478bd9Sstevel@tonic-gate 	struct iodev_snapshot *is_prev;
1857c478bd9Sstevel@tonic-gate 	struct iodev_snapshot *is_next;
1867c478bd9Sstevel@tonic-gate };
1877c478bd9Sstevel@tonic-gate 
1887c478bd9Sstevel@tonic-gate /* which iodevs to show. */
1897c478bd9Sstevel@tonic-gate struct iodev_filter {
1907c478bd9Sstevel@tonic-gate 	/* nr. of iodevs to choose */
1917c478bd9Sstevel@tonic-gate 	size_t if_max_iodevs;
1927c478bd9Sstevel@tonic-gate 	/* bit mask of enum io_types to allow */
1937c478bd9Sstevel@tonic-gate 	int if_allowed_types;
1947c478bd9Sstevel@tonic-gate 	/* should we show floppy ? if_names can override this */
1957c478bd9Sstevel@tonic-gate 	int if_skip_floppy;
1967c478bd9Sstevel@tonic-gate 	/* nr. of named iodevs */
1977c478bd9Sstevel@tonic-gate 	size_t if_nr_names;
1987c478bd9Sstevel@tonic-gate 	char **if_names;
1997c478bd9Sstevel@tonic-gate };
2007c478bd9Sstevel@tonic-gate 
2017c478bd9Sstevel@tonic-gate /* The primary structure of a system snapshot. */
2027c478bd9Sstevel@tonic-gate struct snapshot {
2037c478bd9Sstevel@tonic-gate 	/* what types were *requested* */
2047c478bd9Sstevel@tonic-gate 	enum snapshot_types s_types;
2057c478bd9Sstevel@tonic-gate 	size_t s_nr_cpus;
2067c478bd9Sstevel@tonic-gate 	struct cpu_snapshot *s_cpus;
2077c478bd9Sstevel@tonic-gate 	size_t s_nr_psets;
2087c478bd9Sstevel@tonic-gate 	struct pset_snapshot *s_psets;
2097c478bd9Sstevel@tonic-gate 	size_t s_nr_intrs;
2107c478bd9Sstevel@tonic-gate 	struct intr_snapshot *s_intrs;
2117c478bd9Sstevel@tonic-gate 	size_t s_nr_iodevs;
2127c478bd9Sstevel@tonic-gate 	struct iodev_snapshot *s_iodevs;
2137c478bd9Sstevel@tonic-gate 	struct sys_snapshot s_sys;
2147c478bd9Sstevel@tonic-gate 	struct biostats s_biostats;
2157c478bd9Sstevel@tonic-gate 	struct flushmeter s_flushes;
2167c478bd9Sstevel@tonic-gate };
2177c478bd9Sstevel@tonic-gate 
2187c478bd9Sstevel@tonic-gate /* print a message and exit with failure */
2197c478bd9Sstevel@tonic-gate void fail(int do_perror, char *message, ...);
2207c478bd9Sstevel@tonic-gate 
2217c478bd9Sstevel@tonic-gate /* strdup str, or exit with failure */
2227c478bd9Sstevel@tonic-gate char *safe_strdup(char *str);
2237c478bd9Sstevel@tonic-gate 
2247c478bd9Sstevel@tonic-gate /* malloc successfully, or exit with failure */
2257c478bd9Sstevel@tonic-gate void *safe_alloc(size_t size);
2267c478bd9Sstevel@tonic-gate 
2277c478bd9Sstevel@tonic-gate /*
2287c478bd9Sstevel@tonic-gate  * Copy a kstat from src to dst. If the source kstat contains no data,
2297c478bd9Sstevel@tonic-gate  * then set the destination kstat data to NULL and size to zero.
2307c478bd9Sstevel@tonic-gate  * Returns 0 on success.
2317c478bd9Sstevel@tonic-gate  */
2327c478bd9Sstevel@tonic-gate int kstat_copy(const kstat_t *src, kstat_t *dst);
2337c478bd9Sstevel@tonic-gate 
2347c478bd9Sstevel@tonic-gate /*
2357c478bd9Sstevel@tonic-gate  * Look up the named kstat, and give the ui64 difference i.e.
2367c478bd9Sstevel@tonic-gate  * new - old, or if old is NULL, return new.
2377c478bd9Sstevel@tonic-gate  */
2387c478bd9Sstevel@tonic-gate uint64_t kstat_delta(kstat_t *old, kstat_t *new, char *name);
2397c478bd9Sstevel@tonic-gate 
2407c478bd9Sstevel@tonic-gate /*
2417c478bd9Sstevel@tonic-gate  * Add the integer-valued stats from "src" to the
2427c478bd9Sstevel@tonic-gate  * existing ones in "dst". If "dst" does not contain
2437c478bd9Sstevel@tonic-gate  * stats, then a kstat_copy() is performed.
2447c478bd9Sstevel@tonic-gate  */
2457c478bd9Sstevel@tonic-gate int kstat_add(const kstat_t *src, kstat_t *dst);
2467c478bd9Sstevel@tonic-gate 
2477c478bd9Sstevel@tonic-gate /* return the number of CPUs with kstats (i.e. present and online) */
2487c478bd9Sstevel@tonic-gate int nr_active_cpus(struct snapshot *ss);
2497c478bd9Sstevel@tonic-gate 
2507c478bd9Sstevel@tonic-gate /*
2517c478bd9Sstevel@tonic-gate  * Return the difference in CPU ticks between the two sys
2527c478bd9Sstevel@tonic-gate  * kstats.
2537c478bd9Sstevel@tonic-gate  */
2547c478bd9Sstevel@tonic-gate uint64_t cpu_ticks_delta(kstat_t *old, kstat_t *new);
2557c478bd9Sstevel@tonic-gate 
2567c478bd9Sstevel@tonic-gate /*
2577c478bd9Sstevel@tonic-gate  * Open the kstat chain. Cannot fail.
2587c478bd9Sstevel@tonic-gate  */
2597c478bd9Sstevel@tonic-gate kstat_ctl_t *open_kstat(void);
2607c478bd9Sstevel@tonic-gate 
2617c478bd9Sstevel@tonic-gate /*
2627c478bd9Sstevel@tonic-gate  * Return a struct snapshot based on the snapshot_types parameter
2637c478bd9Sstevel@tonic-gate  * passed in. iodev_filter may be NULL in which case all iodevs
2647c478bd9Sstevel@tonic-gate  * are selected if SNAP_IODEVS is passed.
2657c478bd9Sstevel@tonic-gate  */
2667c478bd9Sstevel@tonic-gate struct snapshot *acquire_snapshot(kstat_ctl_t *, int, struct iodev_filter *);
2677c478bd9Sstevel@tonic-gate 
2687c478bd9Sstevel@tonic-gate /* free a snapshot */
2697c478bd9Sstevel@tonic-gate void free_snapshot(struct snapshot *ss);
2707c478bd9Sstevel@tonic-gate 
2717c478bd9Sstevel@tonic-gate typedef void (*snapshot_cb)(void *old, void *new, void *data);
2727c478bd9Sstevel@tonic-gate 
2737c478bd9Sstevel@tonic-gate /*
2747c478bd9Sstevel@tonic-gate  * Call the call back for each pair of data items of the given type,
2757c478bd9Sstevel@tonic-gate  * passing the data pointer passed in as well. If an item has been
2767c478bd9Sstevel@tonic-gate  * added, the first pointer will be NULL; if removed, the second pointer
2777c478bd9Sstevel@tonic-gate  * will be NULL.
2787c478bd9Sstevel@tonic-gate  *
2797c478bd9Sstevel@tonic-gate  * A non-zero return value indicates configuration has changed.
2807c478bd9Sstevel@tonic-gate  */
2817c478bd9Sstevel@tonic-gate int snapshot_walk(enum snapshot_types type, struct snapshot *old,
2827c478bd9Sstevel@tonic-gate     struct snapshot *new, snapshot_cb cb, void *data);
2837c478bd9Sstevel@tonic-gate 
2847c478bd9Sstevel@tonic-gate /*
2857c478bd9Sstevel@tonic-gate  * Output a line detailing any configuration changes such as a CPU
2867c478bd9Sstevel@tonic-gate  * brought online, etc, bracketed by << >>.
2877c478bd9Sstevel@tonic-gate  */
2887c478bd9Sstevel@tonic-gate void snapshot_report_changes(struct snapshot *old, struct snapshot *new);
2897c478bd9Sstevel@tonic-gate 
2907c478bd9Sstevel@tonic-gate /* Return non-zero if configuration has changed. */
2917c478bd9Sstevel@tonic-gate int snapshot_has_changed(struct snapshot *old, struct snapshot *new);
2927c478bd9Sstevel@tonic-gate 
2937c478bd9Sstevel@tonic-gate /* free the given iodev */
2947c478bd9Sstevel@tonic-gate void free_iodev(struct iodev_snapshot *iodev);
2957c478bd9Sstevel@tonic-gate 
2967c478bd9Sstevel@tonic-gate /* acquire the I/O devices */
2977c478bd9Sstevel@tonic-gate int acquire_iodevs(struct snapshot *ss, kstat_ctl_t *kc,
2987c478bd9Sstevel@tonic-gate     struct iodev_filter *df);
2997c478bd9Sstevel@tonic-gate 
3007c478bd9Sstevel@tonic-gate /* strcmp-style I/O device comparator */
3017c478bd9Sstevel@tonic-gate int iodev_cmp(struct iodev_snapshot *io1, struct iodev_snapshot *io2);
3027c478bd9Sstevel@tonic-gate 
3037c478bd9Sstevel@tonic-gate #ifdef __cplusplus
3047c478bd9Sstevel@tonic-gate }
3057c478bd9Sstevel@tonic-gate #endif
3067c478bd9Sstevel@tonic-gate 
3077c478bd9Sstevel@tonic-gate #endif /* _STATCOMMON_H */
308