xref: /illumos-gate/usr/src/cmd/smbsrv/smbstat/smbstat.c (revision 5015ecc3)

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
 * Copyright 2020 Nexenta by DDN, Inc.  All rights reserved.
 */

/*
 * smbstat: Server Message Block File System statistics
 *
 * The statistics this CLI displays come from two sources:
 *
 * 1) The kernel module 'smbsrv'.
 * 2) The SMB workers task queue statistics the task queue manager of Solaris
 *    maintains.
 *
 * The flow of the code is the following:
 *
 *
 *			+----------------+
 *			| Initialization |
 *			+----------------+
 *				|
 *				|
 *				v
 *		  +--------------------------*
 *		  | Take a snapshot the data | <--------+
 *		  +--------------------------+		|
 *				|			|
 *				|			|
 *				v			|
 *		    +----------------------+		|
 *		    | Process the snapshot |		|
 *		    +----------------------+		|
 *				|			|
 *				|			|
 *				v			|
 *	     +------------------------------------+	|
 *	     | Print the result of the processing |	|
 *	     +------------------------------------+	|
 *				|			|
 *				|			|
 *				v			|
 *		Yes	---------------			|
 *	+------------ < interval == 0 ? >		|
 *	|		---------------			|
 *	|		       |			|
 *	|		       | No			|
 *	|		       v			|
 *	|	   +------------------------+		|
 *	|	   | Sleep for the duration | ----------+
 *	|	   |   of the interval.     |
 *	|	   +------------------------+
 *	|
 *	+---------------------+
 *			      |
 *			      v
 *
 *			    Exit
 *
 * There are two sets of snapshots. One set for the smbsrv module and the other
 * for the task queue (SMB workers). Each set contains 2 snapshots. One is
 * labeled 'current' the other one 'previous'. Their role changes after each
 * snapshot. The 'current' becomes 'previous' and vice versa.
 * The first snapshot taken is compared against the data gathered since the
 * smbsrv module was loaded. Subsequent snapshots will be compared against the
 * previous snapshot.
 */

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <kstat.h>
#include <stdarg.h>
#include <errno.h>
#include <inttypes.h>
#include <strings.h>
#include <utility.h>
#include <libintl.h>
#include <zone.h>
#include <termios.h>
#include <stropts.h>
#include <math.h>
#include <umem.h>
#include <locale.h>
#include <sys/processor.h>
#include <smbsrv/smb_kstat.h>

#if !defined(TEXT_DOMAIN)
#define	TEXT_DOMAIN "SYS_TEST"
#endif /* TEXT_DOMAIN */

#define	SMBSTAT_ID_NO_CPU	-1
#define	SMBSTAT_SNAPSHOT_COUNT	2		/* Must be a power of 2 */
#define	SMBSTAT_SNAPSHOT_MASK	(SMBSTAT_SNAPSHOT_COUNT - 1)

#define	SMBSTAT_HELP	\
	"Usage: smbstat [-acnrtuz] [interval]\n" \
	"    -c: display counters\n" \
	"    -t: display throughput\n" \
	"    -u: display utilization\n" \
	"    -r: display requests\n" \
	"        -a: all the requests (supported and unsupported)\n" \
	"        -z: skip the requests not received\n" \
	"        -n: display in alphabetic order\n" \
	"    interval: refresh cycle in seconds\n"

#define	SMBSRV_COUNTERS_BANNER	"\n  nbt   tcp users trees files pipes\n"
#define	SMBSRV_COUNTERS_FORMAT	"%5d %5d %5d %5d %5d %5d\n"

#define	SMBSRV_THROUGHPUT_BANNER	\
	"\nrbytes/s   tbytes/s    reqs/s     reads/s   writes/s\n"
#define	SMBSRV_THROUGHPUT_FORMAT	\
	"%1.3e  %1.3e  %1.3e  %1.3e  %1.3e\n"

#define	SMBSRV_UTILIZATION_BANNER	\
	"\n  wcnt       rcnt       wtime      rtime" \
	"     w%%   r%%   u%%  sat usr%% sys%%  idle%%\n"
#define	SMBSRV_UTILIZATION_FORMAT	\
	"%1.3e  %1.3e  %1.3e  %1.3e  %3.0f  %3.0f  %3.0f  %s " \
	"%3.0f  %3.0f    %3.0f\n"

#define	SMBSRV_REQUESTS_BANNER	\
	"\n%30s code   %%   rbytes/s   tbytes/s     req/s     rt-mean"	\
	"   rt-stddev\n"
#define	SMBSRV_REQUESTS_FORMAT	\
	"%30s  %02X   %3.0f  %1.3e  %1.3e  %1.3e  %1.3e  %1.3e\n"

typedef enum {
	CPU_TICKS_IDLE = 0,
	CPU_TICKS_USER,
	CPU_TICKS_KERNEL,
	CPU_TICKS_SENTINEL
} cpu_state_idx_t;

typedef struct smbstat_cpu_snapshot {