xref: /onnv-gate/usr/src/cmd/mdb/demo/common/example1.c (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright (c) 1998-1999 by Sun Microsystems, Inc.
24*0Sstevel@tonic-gate  * All rights reserved.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
28*0Sstevel@tonic-gate 
29*0Sstevel@tonic-gate #include <sys/mdb_modapi.h>
30*0Sstevel@tonic-gate #include <sys/sysinfo.h>
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate /*
33*0Sstevel@tonic-gate  * simple_echo dcmd - Demonstrate some simple argument processing by iterating
34*0Sstevel@tonic-gate  * through the argument array and printing back each argument.
35*0Sstevel@tonic-gate  */
36*0Sstevel@tonic-gate static int
simple_echo(uintptr_t addr,uint_t flags,int argc,const mdb_arg_t * argv)37*0Sstevel@tonic-gate simple_echo(uintptr_t addr, uint_t flags, int argc, const mdb_arg_t *argv)
38*0Sstevel@tonic-gate {
39*0Sstevel@tonic-gate 	if (flags & DCMD_ADDRSPEC)
40*0Sstevel@tonic-gate 		mdb_printf("You specified address %p\n", addr);
41*0Sstevel@tonic-gate 	else
42*0Sstevel@tonic-gate 		mdb_printf("Current address is %p\n", addr);
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate 	while (argc-- != 0) {
45*0Sstevel@tonic-gate 		if (argv->a_type == MDB_TYPE_STRING)
46*0Sstevel@tonic-gate 			mdb_printf("%s ", argv->a_un.a_str);
47*0Sstevel@tonic-gate 		else
48*0Sstevel@tonic-gate 			mdb_printf("%llr ", argv->a_un.a_val);
49*0Sstevel@tonic-gate 		argv++;
50*0Sstevel@tonic-gate 	}
51*0Sstevel@tonic-gate 
52*0Sstevel@tonic-gate 	mdb_printf("\n");
53*0Sstevel@tonic-gate 	return (DCMD_OK);
54*0Sstevel@tonic-gate }
55*0Sstevel@tonic-gate 
56*0Sstevel@tonic-gate /*
57*0Sstevel@tonic-gate  * vminfo dcmd - Print out the global vminfo structure, nicely formatted.
58*0Sstevel@tonic-gate  * This function illustrates one of the functions for reading data from
59*0Sstevel@tonic-gate  * the target program (or core file): mdb_readvar().  The vminfo_t
60*0Sstevel@tonic-gate  * structure contains cumulative counters for various system virtual
61*0Sstevel@tonic-gate  * memory statistics.  Each second, these are incremented by the current
62*0Sstevel@tonic-gate  * values of freemem and the other corresponding statistical counters.
63*0Sstevel@tonic-gate  */
64*0Sstevel@tonic-gate /*ARGSUSED*/
65*0Sstevel@tonic-gate static int
vminfo(uintptr_t addr,uint_t flags,int argc,const mdb_arg_t * argv)66*0Sstevel@tonic-gate vminfo(uintptr_t addr, uint_t flags, int argc, const mdb_arg_t *argv)
67*0Sstevel@tonic-gate {
68*0Sstevel@tonic-gate 	vminfo_t vm;
69*0Sstevel@tonic-gate 
70*0Sstevel@tonic-gate 	if ((flags & DCMD_ADDRSPEC) || argc != 0)
71*0Sstevel@tonic-gate 		return (DCMD_USAGE);
72*0Sstevel@tonic-gate 
73*0Sstevel@tonic-gate 	if (mdb_readvar(&vm, "vminfo") == -1) {
74*0Sstevel@tonic-gate 		/*
75*0Sstevel@tonic-gate 		 * If the mdb_warn string does not end in a \n, mdb will
76*0Sstevel@tonic-gate 		 * automatically append the reason for the failure.
77*0Sstevel@tonic-gate 		 */
78*0Sstevel@tonic-gate 		mdb_warn("failed to read vminfo structure");
79*0Sstevel@tonic-gate 		return (DCMD_ERR);
80*0Sstevel@tonic-gate 	}
81*0Sstevel@tonic-gate 
82*0Sstevel@tonic-gate 	mdb_printf("Cumulative memory statistics:\n");
83*0Sstevel@tonic-gate 	mdb_printf("%8llu pages of free memory\n", vm.freemem);
84*0Sstevel@tonic-gate 	mdb_printf("%8llu pages of reserved swap\n", vm.swap_resv);
85*0Sstevel@tonic-gate 	mdb_printf("%8llu pages of allocated swap\n", vm.swap_alloc);
86*0Sstevel@tonic-gate 	mdb_printf("%8llu pages of unreserved swap\n", vm.swap_avail);
87*0Sstevel@tonic-gate 	mdb_printf("%8llu pages of unallocated swap\n", vm.swap_free);
88*0Sstevel@tonic-gate 
89*0Sstevel@tonic-gate 	return (DCMD_OK);
90*0Sstevel@tonic-gate }
91*0Sstevel@tonic-gate 
92*0Sstevel@tonic-gate /*
93*0Sstevel@tonic-gate  * MDB module linkage information:
94*0Sstevel@tonic-gate  *
95*0Sstevel@tonic-gate  * We declare a list of structures describing our dcmds, and a function
96*0Sstevel@tonic-gate  * named _mdb_init to return a pointer to our module information.
97*0Sstevel@tonic-gate  */
98*0Sstevel@tonic-gate 
99*0Sstevel@tonic-gate static const mdb_dcmd_t dcmds[] = {
100*0Sstevel@tonic-gate 	{ "simple_echo", "[ args ... ]", "echo back arguments", simple_echo },
101*0Sstevel@tonic-gate 	{ "vminfo", NULL, "print vm information", vminfo },
102*0Sstevel@tonic-gate 	{ NULL }
103*0Sstevel@tonic-gate };
104*0Sstevel@tonic-gate 
105*0Sstevel@tonic-gate static const mdb_modinfo_t modinfo = {
106*0Sstevel@tonic-gate 	MDB_API_VERSION, dcmds, NULL
107*0Sstevel@tonic-gate };
108*0Sstevel@tonic-gate 
109*0Sstevel@tonic-gate const mdb_modinfo_t *
_mdb_init(void)110*0Sstevel@tonic-gate _mdb_init(void)
111*0Sstevel@tonic-gate {
112*0Sstevel@tonic-gate 	return (&modinfo);
113*0Sstevel@tonic-gate }
114