nfsdumpstate.c revision 347174
1/*-
2 * Copyright (c) 2009 Rick Macklem, University of Guelph
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 */
27
28#include <sys/cdefs.h>
29__FBSDID("$FreeBSD: stable/10/usr.sbin/nfsdumpstate/nfsdumpstate.c 347174 2019-05-06 03:20:02Z rmacklem $");
30
31#include <sys/param.h>
32#include <sys/linker.h>
33#include <sys/module.h>
34#include <sys/socket.h>
35
36#include <arpa/inet.h>
37
38#include <netinet/in.h>
39
40#include <nfs/nfssvc.h>
41
42#include <fs/nfs/rpcv2.h>
43#include <fs/nfs/nfsproto.h>
44#include <fs/nfs/nfskpiport.h>
45#include <fs/nfs/nfs.h>
46
47#include <ctype.h>
48#include <err.h>
49#include <errno.h>
50#include <stdio.h>
51#include <stdlib.h>
52#include <string.h>
53#include <unistd.h>
54
55#define	DUMPSIZE	10000
56
57static void dump_lockstate(char *);
58static void dump_openstate(void);
59static void usage(void);
60static char *open_flags(uint32_t);
61static char *deleg_flags(uint32_t);
62static char *lock_flags(uint32_t);
63static char *client_flags(uint32_t);
64
65static struct nfsd_dumpclients dp[DUMPSIZE];
66static struct nfsd_dumplocks lp[DUMPSIZE];
67static char flag_string[20];
68
69int
70main(int argc, char **argv)
71{
72	int ch, openstate;
73	char *lockfile;
74
75	if (modfind("nfsd") < 0)
76		errx(1, "nfsd not loaded - self terminating");
77	openstate = 0;
78	lockfile = NULL;
79	while ((ch = getopt(argc, argv, "ol:")) != -1)
80		switch (ch) {
81		case 'o':
82			openstate = 1;
83			break;
84		case 'l':
85			lockfile = optarg;
86			break;
87		default:
88			usage();
89		}
90	argc -= optind;
91	argv += optind;
92
93	if (openstate == 0 && lockfile == NULL)
94		openstate = 1;
95	else if (openstate != 0 && lockfile != NULL)
96		errx(1, "-o and -l cannot both be specified");
97
98	/*
99	 * For -o, dump all open/lock state.
100	 * For -l, dump lock state for that file.
101	 */
102	if (openstate != 0)
103		dump_openstate();
104	else
105		dump_lockstate(lockfile);
106	exit(0);
107}
108
109static void
110usage(void)
111{
112
113	errx(1, "usage: nfsdumpstate [-o] [-l]");
114}
115
116/*
117 * Dump all open/lock state.
118 */
119static void
120dump_openstate(void)
121{
122	struct nfsd_dumplist dumplist;
123	int cnt, i;
124#ifdef INET6
125	char nbuf[INET6_ADDRSTRLEN];
126#endif
127
128	dumplist.ndl_size = DUMPSIZE;
129	dumplist.ndl_list = (void *)dp;
130	if (nfssvc(NFSSVC_DUMPCLIENTS, &dumplist) < 0)
131		errx(1, "Can't perform dump clients syscall");
132
133	printf("%-13s %9.9s %9.9s %9.9s %9.9s %9.9s %9.9s %-45s %s\n",
134	    "Flags", "OpenOwner", "Open", "LockOwner",
135	    "Lock", "Deleg", "OldDeleg", "Clientaddr", "ClientID");
136	/*
137	 * Loop through results, printing them out.
138	 */
139	cnt = 0;
140	while (dp[cnt].ndcl_clid.nclid_idlen > 0 && cnt < DUMPSIZE) {
141		printf("%-13s ", client_flags(dp[cnt].ndcl_flags));
142		printf("%9d %9d %9d %9d %9d %9d ",
143		    dp[cnt].ndcl_nopenowners,
144		    dp[cnt].ndcl_nopens,
145		    dp[cnt].ndcl_nlockowners,
146		    dp[cnt].ndcl_nlocks,
147		    dp[cnt].ndcl_ndelegs,
148		    dp[cnt].ndcl_nolddelegs);
149		switch (dp[cnt].ndcl_addrfam) {
150#ifdef INET
151		case AF_INET:
152			printf("%-45s ",
153			    inet_ntoa(dp[cnt].ndcl_cbaddr.sin_addr));
154			break;
155#endif
156#ifdef INET6
157		case AF_INET6:
158			if (inet_ntop(AF_INET6, &dp[cnt].ndcl_cbaddr.sin6_addr,
159			    nbuf, sizeof(nbuf)) != NULL)
160				printf("%-45s ", nbuf);
161			else
162				printf("%-45s ", " ");
163			break;
164#endif
165		}
166		for (i = 0; i < dp[cnt].ndcl_clid.nclid_idlen; i++)
167			printf("%02x", dp[cnt].ndcl_clid.nclid_id[i]);
168		printf("\n");
169		cnt++;
170	}
171}
172
173/*
174 * Dump the lock state for a file.
175 */
176static void
177dump_lockstate(char *fname)
178{
179	struct nfsd_dumplocklist dumplocklist;
180	int cnt, i;
181#ifdef INET6
182	char nbuf[INET6_ADDRSTRLEN];
183#endif
184
185	dumplocklist.ndllck_size = DUMPSIZE;
186	dumplocklist.ndllck_list = (void *)lp;
187	dumplocklist.ndllck_fname = fname;
188	if (nfssvc(NFSSVC_DUMPLOCKS, &dumplocklist) < 0)
189		errx(1, "Can't dump locks for %s\n", fname);
190
191	printf("%-11s %-36s %-45s %s\n",
192	    "Open/Lock",
193	    "          Stateid or Lock Range",
194	    "Clientaddr",
195	    "Owner and ClientID");
196	/*
197	 * Loop through results, printing them out.
198	 */
199	cnt = 0;
200	while (lp[cnt].ndlck_clid.nclid_idlen > 0 && cnt < DUMPSIZE) {
201		if (lp[cnt].ndlck_flags & NFSLCK_OPEN)
202			printf("%-11s %9d %08x %08x %08x ",
203			    open_flags(lp[cnt].ndlck_flags),
204			    lp[cnt].ndlck_stateid.seqid,
205			    lp[cnt].ndlck_stateid.other[0],
206			    lp[cnt].ndlck_stateid.other[1],
207			    lp[cnt].ndlck_stateid.other[2]);
208		else if (lp[cnt].ndlck_flags & (NFSLCK_DELEGREAD |
209		    NFSLCK_DELEGWRITE))
210			printf("%-11s %9d %08x %08x %08x ",
211			    deleg_flags(lp[cnt].ndlck_flags),
212			    lp[cnt].ndlck_stateid.seqid,
213			    lp[cnt].ndlck_stateid.other[0],
214			    lp[cnt].ndlck_stateid.other[1],
215			    lp[cnt].ndlck_stateid.other[2]);
216		else
217			printf("%-11s  %17jd %17jd ",
218			    lock_flags(lp[cnt].ndlck_flags),
219			    lp[cnt].ndlck_first,
220			    lp[cnt].ndlck_end);
221		switch (lp[cnt].ndlck_addrfam) {
222#ifdef INET
223		case AF_INET:
224			printf("%-45s ",
225			    inet_ntoa(lp[cnt].ndlck_cbaddr.sin_addr));
226			break;
227#endif
228#ifdef INET6
229		case AF_INET6:
230			if (inet_ntop(AF_INET6, &lp[cnt].ndlck_cbaddr.sin6_addr,
231			    nbuf, sizeof(nbuf)) != NULL)
232				printf("%-45s ", nbuf);
233			else
234				printf("%-45s ", " ");
235			break;
236#endif
237		default:
238			printf("%-45s ", "  ");
239			break;
240		}
241		for (i = 0; i < lp[cnt].ndlck_owner.nclid_idlen; i++)
242			printf("%02x", lp[cnt].ndlck_owner.nclid_id[i]);
243		printf(" ");
244		for (i = 0; i < lp[cnt].ndlck_clid.nclid_idlen; i++)
245			printf("%02x", lp[cnt].ndlck_clid.nclid_id[i]);
246		printf("\n");
247		cnt++;
248	}
249}
250
251/*
252 * Parse the Open/Lock flag bits and create a string to be printed.
253 */
254static char *
255open_flags(uint32_t flags)
256{
257	int i, j;
258
259	strlcpy(flag_string, "Open ", sizeof (flag_string));
260	i = 5;
261	if (flags & NFSLCK_READACCESS)
262		flag_string[i++] = 'R';
263	if (flags & NFSLCK_WRITEACCESS)
264		flag_string[i++] = 'W';
265	flag_string[i++] = ' ';
266	flag_string[i++] = 'D';
267	flag_string[i] = 'N';
268	j = i;
269	if (flags & NFSLCK_READDENY)
270		flag_string[i++] = 'R';
271	if (flags & NFSLCK_WRITEDENY)
272		flag_string[i++] = 'W';
273	if (i == j)
274		i++;
275	flag_string[i] = '\0';
276	return (flag_string);
277}
278
279static char *
280deleg_flags(uint32_t flags)
281{
282
283	if (flags & NFSLCK_DELEGREAD)
284		strlcpy(flag_string, "Deleg R", sizeof (flag_string));
285	else
286		strlcpy(flag_string, "Deleg W", sizeof (flag_string));
287	return (flag_string);
288}
289
290static char *
291lock_flags(uint32_t flags)
292{
293
294	if (flags & NFSLCK_READ)
295		strlcpy(flag_string, "Lock R", sizeof (flag_string));
296	else
297		strlcpy(flag_string, "Lock W", sizeof (flag_string));
298	return (flag_string);
299}
300
301static char *
302client_flags(uint32_t flags)
303{
304
305	flag_string[0] = '\0';
306	if (flags & LCL_NEEDSCONFIRM)
307		strlcat(flag_string, "NC ", sizeof (flag_string));
308	if (flags & LCL_CALLBACKSON)
309		strlcat(flag_string, "CB ", sizeof (flag_string));
310	if (flags & LCL_GSS)
311		strlcat(flag_string, "GSS ", sizeof (flag_string));
312	if (flags & LCL_ADMINREVOKED)
313		strlcat(flag_string, "REV", sizeof (flag_string));
314	return (flag_string);
315}
316