[apple/system_cmds.git] / vm_stat.tproj / vm_stat.c

/*
 * Copyright (c) 1999-2009 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * "Portions Copyright (c) 1999 Apple Computer, Inc.  All Rights
 * Reserved.  This file contains Original Code and/or Modifications of
 * Original Code as defined in and that are subject to the Apple Public
 * Source License Version 1.0 (the 'License').  You may not use this file
 * except in compliance with the License.  Please obtain a copy of the
 * License at http://www.apple.com/publicsource and read it before using
 * this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License."
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 *	File:	vm_stat.c
 *	Author:	Avadis Tevanian, Jr.
 *
 *	Copyright (C) 1986, Avadis Tevanian, Jr.
 *
 *
 *	Display Mach VM statistics.
 *
 ************************************************************************
 * HISTORY
 *  6-Jun-86  Avadis Tevanian, Jr. (avie) at Carnegie-Mellon University
 *	Use official Mach interface.
 *
 *  25-mar-99	A.Ramesh at Apple
 *		Ported to MacOS X
 *  
 *  22-Jan-09	R.Branche at Apple
 *  		Changed some fields to 64-bit to alleviate overflows
 ************************************************************************
 */

#include <err.h>
#include <stddef.h>
#include <stdlib.h>
#include <unistd.h>
#include <stdio.h>

#include <mach/mach.h>

vm_statistics64_data_t	vm_stat, last;
char	*pgmname;
mach_port_t myHost;
vm_size_t pageSize = 4096; 	/* set to 4k default */

void usage(void);
void snapshot(void);
void sspstat(char *str, uint64_t n);
void banner(void);
void print_stats(void);
void get_stats(vm_statistics64_t stat);

void pstat(uint64_t n, int width);

int
main(int argc, char *argv[])
{

	double delay = 0.0;
	int count = 0;

	pgmname = argv[0];

	setlinebuf (stdout);

	int c;
	while ((c = getopt (argc, argv, "c:")) != -1) {
		switch (c) {
			case 'c':
				count = (int)strtol(optarg, NULL, 10);
				if (count < 1) {
					warnx("count must be positive");
					usage();
				}
				break;
			default:
				usage();
				break;
		}
	}

	argc -= optind; argv += optind;

	if (argc == 1) {
		delay = strtod(argv[0], NULL);
		if (delay < 0.0)
			usage();
	} else if (argc > 1) {
		usage();
	}

	myHost = mach_host_self();

	if(host_page_size(mach_host_self(), &pageSize) != KERN_SUCCESS) {
		fprintf(stderr, "%s: failed to get pagesize; defaulting to 4K.\n", pgmname);
		pageSize = 4096;
	}	

	if (delay == 0.0) {
		snapshot();
	} else {
		print_stats();
		for (int i = 1; i < count || count == 0; i++ ){
			usleep((int)(delay * USEC_PER_SEC));
			print_stats();
		}
	}
	exit(EXIT_SUCCESS);
}

void
usage(void)
{
	fprintf(stderr, "usage: %s [[-c count] interval]\n", pgmname);
	exit(EXIT_FAILURE);
}

void
snapshot(void)
{

	get_stats(&vm_stat);
	printf("Mach Virtual Memory Statistics: (page size of %d bytes)\n",
				(int) (pageSize));

	sspstat("Pages free:", (uint64_t) (vm_stat.free_count - vm_stat.speculative_count));
	sspstat("Pages active:", (uint64_t) (vm_stat.active_count));
	sspstat("Pages inactive:", (uint64_t) (vm_stat.inactive_count));
	sspstat("Pages speculative:", (uint64_t) (vm_stat.speculative_count));
	sspstat("Pages throttled:", (uint64_t) (vm_stat.throttled_count));
	sspstat("Pages wired down:", (uint64_t) (vm_stat.wire_count));
	sspstat("Pages purgeable:", (uint64_t) (vm_stat.purgeable_count));
	sspstat("\"Translation faults\":", (uint64_t) (vm_stat.faults));
	sspstat("Pages copy-on-write:", (uint64_t) (vm_stat.cow_faults));
	sspstat("Pages zero filled:", (uint64_t) (vm_stat.zero_fill_count));
	sspstat("Pages reactivated:", (uint64_t) (vm_stat.reactivations));
	sspstat("Pages purged:", (uint64_t) (vm_stat.purges));
	sspstat("File-backed pages:", (uint64_t) (vm_stat.external_page_count));
	sspstat("Anonymous pages:", (uint64_t) (vm_stat.internal_page_count));
	sspstat("Pages stored in compressor:", (uint64_t) (vm_stat.total_uncompressed_pages_in_compressor));
	sspstat("Pages occupied by compressor:", (uint64_t) (vm_stat.compressor_page_count));
	sspstat("Decompressions:", (uint64_t) (vm_stat.decompressions));
	sspstat("Compressions:", (uint64_t) (vm_stat.compressions));
	sspstat("Pageins:", (uint64_t) (vm_stat.pageins));
	sspstat("Pageouts:", (uint64_t) (vm_stat.pageouts));
	sspstat("Swapins:", (uint64_t) (vm_stat.swapins));
	sspstat("Swapouts:", (uint64_t) (vm_stat.swapouts));
}

void
sspstat(char *str, uint64_t n)
{
	printf("%-30s %16llu.\n", str, n);
}

void
banner(void)
{
	get_stats(&vm_stat);
	printf("Mach Virtual Memory Statistics: ");
	printf("(page size of %d bytes)\n",
				(int) (pageSize));
	printf("%8s %8s %8s %8s %8s %8s %8s %8s %8s %8s %8s %8s %11s %9s %8s %8s %8s %8s %8s %8s %8s %8s\n",
	       "free",
	       "active",
	       "specul",
	       "inactive",
	       "throttle",
	       "wired",
	       "prgable",
	       "faults",
	       "copy",
	       "0fill",
	       "reactive",
	       "purged",
	       "file-backed",
	       "anonymous",
	       "cmprssed",
	       "cmprssor",
	       "dcomprs",
	       "comprs",
	       "pageins",
	       "pageout",
	       "swapins",
	       "swapouts");
	bzero(&last, sizeof(last));
}

void
print_stats(void)
{
	static int count = 0;

	if (count++ == 0)
		banner();

	if (count > 20)
		count = 0;

	get_stats(&vm_stat);
	pstat((uint64_t) (vm_stat.free_count - vm_stat.speculative_count), 8);
	pstat((uint64_t) (vm_stat.active_count), 8);
	pstat((uint64_t) (vm_stat.speculative_count), 8);
	pstat((uint64_t) (vm_stat.inactive_count), 8);
	pstat((uint64_t) (vm_stat.throttled_count), 8);
	pstat((uint64_t) (vm_stat.wire_count), 8);
	pstat((uint64_t) (vm_stat.purgeable_count), 8);
	pstat((uint64_t) (vm_stat.faults - last.faults), 8);
	pstat((uint64_t) (vm_stat.cow_faults - last.cow_faults), 8);
	pstat((uint64_t) (vm_stat.zero_fill_count - last.zero_fill_count), 8);
	pstat((uint64_t) (vm_stat.reactivations - last.reactivations), 8);
	pstat((uint64_t) (vm_stat.purges - last.purges), 8);
	pstat((uint64_t) (vm_stat.external_page_count), 11);
	pstat((uint64_t) (vm_stat.internal_page_count), 9);
	pstat((uint64_t) (vm_stat.total_uncompressed_pages_in_compressor), 8);
	pstat((uint64_t) (vm_stat.compressor_page_count), 8);
	pstat((uint64_t) (vm_stat.decompressions - last.decompressions), 8);
	pstat((uint64_t) (vm_stat.compressions - last.compressions), 8);
	pstat((uint64_t) (vm_stat.pageins - last.pageins), 8);
	pstat((uint64_t) (vm_stat.pageouts - last.pageouts), 8);
	pstat((uint64_t) (vm_stat.swapins - last.swapins), 8);
	pstat((uint64_t) (vm_stat.swapouts - last.swapouts), 8);
	putchar('\n');
	last = vm_stat;
}

void
pstat(uint64_t n, int width)
{
	char buf[80];
	if (width >= sizeof(buf)) {
		width = sizeof(buf) -1;
	}

	/* Now that we have the speculative field, there is really not enough
	 space, but we were actually overflowing three or four fields before
	 anyway.  So any field that overflows we drop some insignifigant
	 digets and slap on the appropriate suffix
	*/
	int w = snprintf(buf, sizeof(buf), "%*llu", width, n);
	if (w > width) {
		w = snprintf(buf, sizeof(buf), "%*lluK", width -1, n / 1000);
		if (w > width) {
			w = snprintf(buf, sizeof(buf), "%*lluM", width -1, n / 1000000);
			if (w > width) {
				w = snprintf(buf, sizeof(buf), "%*lluG", width -1, n / 1000000000);
			}
		}
	}
	fputs(buf, stdout);
	putchar(' ');
}

void
get_stats(vm_statistics64_t stat)
{
	unsigned int count = HOST_VM_INFO64_COUNT;
	kern_return_t ret;
	if ((ret = host_statistics64(myHost, HOST_VM_INFO64, (host_info64_t)stat, &count) != KERN_SUCCESS)) {
		fprintf(stderr, "%s: failed to get statistics. error %d\n", pgmname, ret);
		exit(EXIT_FAILURE);
	}
}
Commit	Line	Data
1815bff5	1	/*
ef8ad44b	2	* Copyright (c) 1999-2009 Apple Computer, Inc. All rights reserved.
1815bff5 A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
2fc1e207 A	6	* "Portions Copyright (c) 1999 Apple Computer, Inc. All Rights
	7	* Reserved. This file contains Original Code and/or Modifications of
	8	* Original Code as defined in and that are subject to the Apple Public
	9	* Source License Version 1.0 (the 'License'). You may not use this file
	10	* except in compliance with the License. Please obtain a copy of the
	11	* License at http://www.apple.com/publicsource and read it before using
	12	* this file.
1815bff5 A	13	*
	14	* The Original Code and all software distributed under the License are
	15	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	16	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	17	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2fc1e207 A	18	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	19	* License for the specific language governing rights and limitations
	20	* under the License."
1815bff5 A	21	*
	22	* @APPLE_LICENSE_HEADER_END@
	23	*/
	24	/*
	25	* File: vm_stat.c
	26	* Author: Avadis Tevanian, Jr.
	27	*
	28	* Copyright (C) 1986, Avadis Tevanian, Jr.
	29	*
	30	*
	31	* Display Mach VM statistics.
	32	*
	33	************************************************************************
	34	* HISTORY
	35	* 6-Jun-86 Avadis Tevanian, Jr. (avie) at Carnegie-Mellon University
	36	* Use official Mach interface.
	37	*
	38	* 25-mar-99 A.Ramesh at Apple
	39	* Ported to MacOS X
ef8ad44b A	40	*
	41	* 22-Jan-09 R.Branche at Apple
	42	* Changed some fields to 64-bit to alleviate overflows
1815bff5 A	43	************************************************************************
	44	*/
	45
fc6d9e4b	46	#include <err.h>
83f6dbe8 A	47	#include <stddef.h>
83f6dbe8 A	48	#include <stdlib.h>
1815bff5 A	49	#include <unistd.h>
	50	#include <stdio.h>
	51
	52	#include <mach/mach.h>
	53
ef8ad44b	54	vm_statistics64_data_t vm_stat, last;
1815bff5 A	55	char *pgmname;
1815bff5 A	56	mach_port_t myHost;
34d340d7	57	vm_size_t pageSize = 4096; /* set to 4k default */
1815bff5	58
83f6dbe8	59	void usage(void);
83f6dbe8	60	void snapshot(void);
ef8ad44b A	61	void sspstat(char *str, uint64_t n);
ef8ad44b A	62	void banner(void);
83f6dbe8	63	void print_stats(void);
ef8ad44b A	64	void get_stats(vm_statistics64_t stat);
	65
	66	void pstat(uint64_t n, int width);
1815bff5 A	67
1815bff5 A	68	int
83f6dbe8	69	main(int argc, char *argv[])
1815bff5 A	70	{
1815bff5 A	71
fc6d9e4b A	72	double delay = 0.0;
fc6d9e4b A	73	int count = 0;
1815bff5	74
fc6d9e4b	75	pgmname = argv[0];
1815bff5 A	76
	77	setlinebuf (stdout);
	78
fc6d9e4b A	79	int c;
	80	while ((c = getopt (argc, argv, "c:")) != -1) {
	81	switch (c) {
	82	case 'c':
	83	count = (int)strtol(optarg, NULL, 10);
	84	if (count < 1) {
	85	warnx("count must be positive");
	86	usage();
	87	}
	88	break;
	89	default:
	90	usage();
	91	break;
	92	}
	93	}
	94
	95	argc -= optind; argv += optind;
	96
	97	if (argc == 1) {
	98	delay = strtod(argv[0], NULL);
	99	if (delay < 0.0)
1815bff5	100	usage();
fc6d9e4b A	101	} else if (argc > 1) {
fc6d9e4b A	102	usage();
1815bff5 A	103	}
	104
	105	myHost = mach_host_self();
	106
	107	if(host_page_size(mach_host_self(), &pageSize) != KERN_SUCCESS) {
	108	fprintf(stderr, "%s: failed to get pagesize; defaulting to 4K.\n", pgmname);
	109	pageSize = 4096;
	110	}
	111
fc6d9e4b	112	if (delay == 0.0) {
1815bff5	113	snapshot();
fc6d9e4b A	114	} else {
	115	print_stats();
	116	for (int i = 1; i < count \|\| count == 0; i++ ){
	117	usleep((int)(delay * USEC_PER_SEC));
1815bff5	118	print_stats();
1815bff5 A	119	}
1815bff5 A	120	}
83f6dbe8	121	exit(EXIT_SUCCESS);
1815bff5 A	122	}
	123
	124	void
83f6dbe8	125	usage(void)
1815bff5	126	{
fc6d9e4b	127	fprintf(stderr, "usage: %s [[-c count] interval]\n", pgmname);
83f6dbe8	128	exit(EXIT_FAILURE);
1815bff5 A	129	}
1815bff5 A	130
ef8ad44b A	131	void
	132	snapshot(void)
	133	{
	134
	135	get_stats(&vm_stat);
	136	printf("Mach Virtual Memory Statistics: (page size of %d bytes)\n",
	137	(int) (pageSize));
	138
	139	sspstat("Pages free:", (uint64_t) (vm_stat.free_count - vm_stat.speculative_count));
	140	sspstat("Pages active:", (uint64_t) (vm_stat.active_count));
	141	sspstat("Pages inactive:", (uint64_t) (vm_stat.inactive_count));
	142	sspstat("Pages speculative:", (uint64_t) (vm_stat.speculative_count));
fc6d9e4b	143	sspstat("Pages throttled:", (uint64_t) (vm_stat.throttled_count));
ef8ad44b	144	sspstat("Pages wired down:", (uint64_t) (vm_stat.wire_count));
fc6d9e4b	145	sspstat("Pages purgeable:", (uint64_t) (vm_stat.purgeable_count));
ef8ad44b A	146	sspstat("\"Translation faults\":", (uint64_t) (vm_stat.faults));
	147	sspstat("Pages copy-on-write:", (uint64_t) (vm_stat.cow_faults));
	148	sspstat("Pages zero filled:", (uint64_t) (vm_stat.zero_fill_count));
	149	sspstat("Pages reactivated:", (uint64_t) (vm_stat.reactivations));
fc6d9e4b A	150	sspstat("Pages purged:", (uint64_t) (vm_stat.purges));
	151	sspstat("File-backed pages:", (uint64_t) (vm_stat.external_page_count));
	152	sspstat("Anonymous pages:", (uint64_t) (vm_stat.internal_page_count));
	153	sspstat("Pages stored in compressor:", (uint64_t) (vm_stat.total_uncompressed_pages_in_compressor));
	154	sspstat("Pages occupied by compressor:", (uint64_t) (vm_stat.compressor_page_count));
	155	sspstat("Decompressions:", (uint64_t) (vm_stat.decompressions));
	156	sspstat("Compressions:", (uint64_t) (vm_stat.compressions));
ef8ad44b A	157	sspstat("Pageins:", (uint64_t) (vm_stat.pageins));
ef8ad44b A	158	sspstat("Pageouts:", (uint64_t) (vm_stat.pageouts));
fc6d9e4b A	159	sspstat("Swapins:", (uint64_t) (vm_stat.swapins));
fc6d9e4b A	160	sspstat("Swapouts:", (uint64_t) (vm_stat.swapouts));
ef8ad44b A	161	}
	162
	163	void
	164	sspstat(char *str, uint64_t n)
	165	{
fc6d9e4b	166	printf("%-30s %16llu.\n", str, n);
ef8ad44b A	167	}
ef8ad44b A	168
1815bff5	169	void
83f6dbe8	170	banner(void)
1815bff5 A	171	{
	172	get_stats(&vm_stat);
	173	printf("Mach Virtual Memory Statistics: ");
fc6d9e4b A	174	printf("(page size of %d bytes)\n",
	175	(int) (pageSize));
	176	printf("%8s %8s %8s %8s %8s %8s %8s %8s %8s %8s %8s %8s %11s %9s %8s %8s %8s %8s %8s %8s %8s %8s\n",
	177	"free",
	178	"active",
	179	"specul",
	180	"inactive",
	181	"throttle",
	182	"wired",
	183	"prgable",
	184	"faults",
	185	"copy",
	186	"0fill",
	187	"reactive",
	188	"purged",
	189	"file-backed",
	190	"anonymous",
	191	"cmprssed",
	192	"cmprssor",
	193	"dcomprs",
	194	"comprs",
	195	"pageins",
	196	"pageout",
	197	"swapins",
	198	"swapouts");
1815bff5 A	199	bzero(&last, sizeof(last));
	200	}
	201
1815bff5	202	void
83f6dbe8	203	print_stats(void)
1815bff5	204	{
83f6dbe8	205	static int count = 0;
1815bff5 A	206
	207	if (count++ == 0)
	208	banner();
	209
	210	if (count > 20)
	211	count = 0;
	212
	213	get_stats(&vm_stat);
fc6d9e4b A	214	pstat((uint64_t) (vm_stat.free_count - vm_stat.speculative_count), 8);
	215	pstat((uint64_t) (vm_stat.active_count), 8);
	216	pstat((uint64_t) (vm_stat.speculative_count), 8);
ef8ad44b	217	pstat((uint64_t) (vm_stat.inactive_count), 8);
fc6d9e4b A	218	pstat((uint64_t) (vm_stat.throttled_count), 8);
	219	pstat((uint64_t) (vm_stat.wire_count), 8);
	220	pstat((uint64_t) (vm_stat.purgeable_count), 8);
ef8ad44b A	221	pstat((uint64_t) (vm_stat.faults - last.faults), 8);
	222	pstat((uint64_t) (vm_stat.cow_faults - last.cow_faults), 8);
	223	pstat((uint64_t) (vm_stat.zero_fill_count - last.zero_fill_count), 8);
	224	pstat((uint64_t) (vm_stat.reactivations - last.reactivations), 8);
fc6d9e4b A	225	pstat((uint64_t) (vm_stat.purges - last.purges), 8);
	226	pstat((uint64_t) (vm_stat.external_page_count), 11);
	227	pstat((uint64_t) (vm_stat.internal_page_count), 9);
	228	pstat((uint64_t) (vm_stat.total_uncompressed_pages_in_compressor), 8);
	229	pstat((uint64_t) (vm_stat.compressor_page_count), 8);
	230	pstat((uint64_t) (vm_stat.decompressions - last.decompressions), 8);
	231	pstat((uint64_t) (vm_stat.compressions - last.compressions), 8);
ef8ad44b A	232	pstat((uint64_t) (vm_stat.pageins - last.pageins), 8);
ef8ad44b A	233	pstat((uint64_t) (vm_stat.pageouts - last.pageouts), 8);
fc6d9e4b A	234	pstat((uint64_t) (vm_stat.swapins - last.swapins), 8);
fc6d9e4b A	235	pstat((uint64_t) (vm_stat.swapouts - last.swapouts), 8);
ef8ad44b	236	putchar('\n');
1815bff5 A	237	last = vm_stat;
	238	}
	239
	240	void
ef8ad44b A	241	pstat(uint64_t n, int width)
	242	{
	243	char buf[80];
	244	if (width >= sizeof(buf)) {
	245	width = sizeof(buf) -1;
	246	}
	247
ef8ad44b A	248	/* Now that we have the speculative field, there is really not enough
	249	space, but we were actually overflowing three or four fields before
	250	anyway. So any field that overflows we drop some insignifigant
	251	digets and slap on the appropriate suffix
	252	*/
	253	int w = snprintf(buf, sizeof(buf), "%*llu", width, n);
	254	if (w > width) {
	255	w = snprintf(buf, sizeof(buf), "%*lluK", width -1, n / 1000);
	256	if (w > width) {
	257	w = snprintf(buf, sizeof(buf), "%*lluM", width -1, n / 1000000);
	258	if (w > width) {
	259	w = snprintf(buf, sizeof(buf), "%*lluG", width -1, n / 1000000000);
	260	}
	261	}
	262	}
	263	fputs(buf, stdout);
	264	putchar(' ');
	265	}
	266
	267	void
	268	get_stats(vm_statistics64_t stat)
1815bff5	269	{
ef8ad44b	270	unsigned int count = HOST_VM_INFO64_COUNT;
381af97e A	271	kern_return_t ret;
	272	if ((ret = host_statistics64(myHost, HOST_VM_INFO64, (host_info64_t)stat, &count) != KERN_SUCCESS)) {
	273	fprintf(stderr, "%s: failed to get statistics. error %d\n", pgmname, ret);
83f6dbe8	274	exit(EXIT_FAILURE);
1815bff5	275	}
1815bff5	276	}