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$");
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
125	dumplist.ndl_size = DUMPSIZE;
126	dumplist.ndl_list = (void *)dp;
127	if (nfssvc(NFSSVC_DUMPCLIENTS, &dumplist) < 0)
128		errx(1, "Can't perform dump clients syscall");
129
130	printf("%-13s %9.9s %9.9s %9.9s %9.9s %9.9s %9.9s %-15s %s\n",
131	    "Flags", "OpenOwner", "Open", "LockOwner",
132	    "Lock", "Deleg", "OldDeleg", "Clientaddr", "ClientID");
133	/*
134	 * Loop through results, printing them out.
135	 */
136	cnt = 0;
137	while (dp[cnt].ndcl_clid.nclid_idlen > 0 && cnt < DUMPSIZE) {
138		printf("%-13s ", client_flags(dp[cnt].ndcl_flags));
139		printf("%9d %9d %9d %9d %9d %9d ",
140		    dp[cnt].ndcl_nopenowners,
141		    dp[cnt].ndcl_nopens,
142		    dp[cnt].ndcl_nlockowners,
143		    dp[cnt].ndcl_nlocks,
144		    dp[cnt].ndcl_ndelegs,
145		    dp[cnt].ndcl_nolddelegs);
146		if (dp[cnt].ndcl_addrfam == AF_INET)
147			printf("%-15s ",
148			    inet_ntoa(dp[cnt].ndcl_cbaddr.sin_addr));
149		for (i = 0; i < dp[cnt].ndcl_clid.nclid_idlen; i++)
150			printf("%02x", dp[cnt].ndcl_clid.nclid_id[i]);
151		printf("\n");
152		cnt++;
153	}
154}
155
156/*
157 * Dump the lock state for a file.
158 */
159static void
160dump_lockstate(char *fname)
161{
162	struct nfsd_dumplocklist dumplocklist;
163	int cnt, i;
164
165	dumplocklist.ndllck_size = DUMPSIZE;
166	dumplocklist.ndllck_list = (void *)lp;
167	dumplocklist.ndllck_fname = fname;
168	if (nfssvc(NFSSVC_DUMPLOCKS, &dumplocklist) < 0)
169		errx(1, "Can't dump locks for %s\n", fname);
170
171	printf("%-11s %-36s %-15s %s\n",
172	    "Open/Lock",
173	    "          Stateid or Lock Range",
174	    "Clientaddr",
175	    "Owner and ClientID");
176	/*
177	 * Loop through results, printing them out.
178	 */
179	cnt = 0;
180	while (lp[cnt].ndlck_clid.nclid_idlen > 0 && cnt < DUMPSIZE) {
181		if (lp[cnt].ndlck_flags & NFSLCK_OPEN)
182			printf("%-11s %9d %08x %08x %08x ",
183			    open_flags(lp[cnt].ndlck_flags),
184			    lp[cnt].ndlck_stateid.seqid,
185			    lp[cnt].ndlck_stateid.other[0],
186			    lp[cnt].ndlck_stateid.other[1],
187			    lp[cnt].ndlck_stateid.other[2]);
188		else if (lp[cnt].ndlck_flags & (NFSLCK_DELEGREAD |
189		    NFSLCK_DELEGWRITE))
190			printf("%-11s %9d %08x %08x %08x ",
191			    deleg_flags(lp[cnt].ndlck_flags),
192			    lp[cnt].ndlck_stateid.seqid,
193			    lp[cnt].ndlck_stateid.other[0],
194			    lp[cnt].ndlck_stateid.other[1],
195			    lp[cnt].ndlck_stateid.other[2]);
196		else
197			printf("%-11s  %17jd %17jd ",
198			    lock_flags(lp[cnt].ndlck_flags),
199			    lp[cnt].ndlck_first,
200			    lp[cnt].ndlck_end);
201		if (lp[cnt].ndlck_addrfam == AF_INET)
202			printf("%-15s ",
203			    inet_ntoa(lp[cnt].ndlck_cbaddr.sin_addr));
204		else
205			printf("%-15s ", "  ");
206		for (i = 0; i < lp[cnt].ndlck_owner.nclid_idlen; i++)
207			printf("%02x", lp[cnt].ndlck_owner.nclid_id[i]);
208		printf(" ");
209		for (i = 0; i < lp[cnt].ndlck_clid.nclid_idlen; i++)
210			printf("%02x", lp[cnt].ndlck_clid.nclid_id[i]);
211		printf("\n");
212		cnt++;
213	}
214}
215
216/*
217 * Parse the Open/Lock flag bits and create a string to be printed.
218 */
219static char *
220open_flags(uint32_t flags)
221{
222	int i, j;
223
224	strlcpy(flag_string, "Open ", sizeof (flag_string));
225	i = 5;
226	if (flags & NFSLCK_READACCESS)
227		flag_string[i++] = 'R';
228	if (flags & NFSLCK_WRITEACCESS)
229		flag_string[i++] = 'W';
230	flag_string[i++] = ' ';
231	flag_string[i++] = 'D';
232	flag_string[i] = 'N';
233	j = i;
234	if (flags & NFSLCK_READDENY)
235		flag_string[i++] = 'R';
236	if (flags & NFSLCK_WRITEDENY)
237		flag_string[i++] = 'W';
238	if (i == j)
239		i++;
240	flag_string[i] = '\0';
241	return (flag_string);
242}
243
244static char *
245deleg_flags(uint32_t flags)
246{
247
248	if (flags & NFSLCK_DELEGREAD)
249		strlcpy(flag_string, "Deleg R", sizeof (flag_string));
250	else
251		strlcpy(flag_string, "Deleg W", sizeof (flag_string));
252	return (flag_string);
253}
254
255static char *
256lock_flags(uint32_t flags)
257{
258
259	if (flags & NFSLCK_READ)
260		strlcpy(flag_string, "Lock R", sizeof (flag_string));
261	else
262		strlcpy(flag_string, "Lock W", sizeof (flag_string));
263	return (flag_string);
264}
265
266static char *
267client_flags(uint32_t flags)
268{
269
270	flag_string[0] = '\0';
271	if (flags & LCL_NEEDSCONFIRM)
272		strlcat(flag_string, "NC ", sizeof (flag_string));
273	if (flags & LCL_CALLBACKSON)
274		strlcat(flag_string, "CB ", sizeof (flag_string));
275	if (flags & LCL_GSS)
276		strlcat(flag_string, "GSS ", sizeof (flag_string));
277	if (flags & LCL_ADMINREVOKED)
278		strlcat(flag_string, "REV", sizeof (flag_string));
279	return (flag_string);
280}
281