xref: /dragonfly/sbin/hammer2/main.c (revision 78478697)
1 /*
2  * Copyright (c) 2011-2012 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@dragonflybsd.org>
6  * by Venkatesh Srinivas <vsrinivas@dragonflybsd.org>
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in
16  *    the documentation and/or other materials provided with the
17  *    distribution.
18  * 3. Neither the name of The DragonFly Project nor the names of its
19  *    contributors may be used to endorse or promote products derived
20  *    from this software without specific, prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
26  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  */
35 
36 #include "hammer2.h"
37 
38 int DebugOpt;
39 int VerboseOpt;
40 int QuietOpt;
41 int NormalExit = 1;	/* if set to 0 main() has to pthread_exit() */
42 int RecurseOpt;
43 int ForceOpt;
44 
45 static void usage(int code);
46 
47 int
48 main(int ac, char **av)
49 {
50 	const char *sel_path = NULL;
51 	const char *uuid_str = NULL;
52 	const char *arg;
53 	int pfs_type = HAMMER2_PFSTYPE_NONE;
54 	int all_opt = 0;
55 	int ecode = 0;
56 	int ch;
57 
58 	srandomdev();
59 	signal(SIGPIPE, SIG_IGN);
60 	dmsg_crypto_setup();
61 
62 	/*
63 	 * Core options
64 	 */
65 	while ((ch = getopt(ac, av, "adfrqs:t:u:v")) != -1) {
66 		switch(ch) {
67 		case 'a':
68 			all_opt = 1;
69 			break;
70 		case 'd':
71 			if (DebugOpt)
72 				++DMsgDebugOpt;
73 			DebugOpt = 1;
74 			break;
75 		case 'f':
76 			ForceOpt = 1;
77 			break;
78 		case 'r':
79 			RecurseOpt = 1;
80 			break;
81 		case 's':
82 			sel_path = optarg;
83 			break;
84 		case 't':
85 			/*
86 			 * set node type for mkpfs
87 			 */
88 			if (strcasecmp(optarg, "CACHE") == 0) {
89 				pfs_type = HAMMER2_PFSTYPE_CACHE;
90 			} else if (strcasecmp(optarg, "DUMMY") == 0) {
91 				pfs_type = HAMMER2_PFSTYPE_DUMMY;
92 			} else if (strcasecmp(optarg, "SLAVE") == 0) {
93 				pfs_type = HAMMER2_PFSTYPE_SLAVE;
94 			} else if (strcasecmp(optarg, "SOFT_SLAVE") == 0) {
95 				pfs_type = HAMMER2_PFSTYPE_SOFT_SLAVE;
96 			} else if (strcasecmp(optarg, "SOFT_MASTER") == 0) {
97 				pfs_type = HAMMER2_PFSTYPE_SOFT_MASTER;
98 			} else if (strcasecmp(optarg, "MASTER") == 0) {
99 				pfs_type = HAMMER2_PFSTYPE_MASTER;
100 			} else {
101 				fprintf(stderr, "-t: Unrecognized node type\n");
102 				usage(1);
103 			}
104 			break;
105 		case 'u':
106 			/*
107 			 * set uuid for mkpfs, else one will be generated
108 			 * (required for all except the MASTER node_type)
109 			 */
110 			uuid_str = optarg;
111 			break;
112 		case 'v':
113 			if (QuietOpt)
114 				--QuietOpt;
115 			else
116 				++VerboseOpt;
117 			break;
118 		case 'q':
119 			if (VerboseOpt)
120 				--VerboseOpt;
121 			else
122 				++QuietOpt;
123 			break;
124 		default:
125 			fprintf(stderr, "Unknown option: %c\n", ch);
126 			usage(1);
127 			/* not reached */
128 			break;
129 		}
130 	}
131 
132 	/*
133 	 * Adjust, then process the command
134 	 */
135 	ac -= optind;
136 	av += optind;
137 	if (ac < 1) {
138 		fprintf(stderr, "Missing command\n");
139 		usage(1);
140 		/* not reached */
141 	}
142 
143 	if (strcmp(av[0], "connect") == 0) {
144 		/*
145 		 * Add cluster connection
146 		 */
147 		if (ac < 2) {
148 			fprintf(stderr, "connect: missing argument\n");
149 			usage(1);
150 		}
151 		ecode = cmd_remote_connect(sel_path, av[1]);
152 	} else if (strcmp(av[0], "chaindump") == 0) {
153 		if (ac < 2)
154 			ecode = cmd_chaindump(".");
155 		else
156 			ecode = cmd_chaindump(av[1]);
157 	} else if (strcmp(av[0], "debugspan") == 0) {
158 		/*
159 		 * Debug connection to the target hammer2 service and run
160 		 * the CONN/SPAN protocol.
161 		 */
162 		if (ac < 2) {
163 			fprintf(stderr, "debugspan: requires hostname\n");
164 			usage(1);
165 		}
166 		ecode = cmd_debugspan(av[1]);
167 	} else if (strcmp(av[0], "disconnect") == 0) {
168 		/*
169 		 * Remove cluster connection
170 		 */
171 		if (ac < 2) {
172 			fprintf(stderr, "disconnect: missing argument\n");
173 			usage(1);
174 		}
175 		ecode = cmd_remote_disconnect(sel_path, av[1]);
176 	} else if (strcmp(av[0], "hash") == 0) {
177 		ecode = cmd_hash(ac - 1, (const char **)(void *)&av[1]);
178 	} else if (strcmp(av[0], "info") == 0) {
179 		ecode = cmd_info(ac - 1, (const char **)(void *)&av[1]);
180 	} else if (strcmp(av[0], "mountall") == 0) {
181 		ecode = cmd_mountall(ac - 1, (const char **)(void *)&av[1]);
182 	} else if (strcmp(av[0], "status") == 0) {
183 		/*
184 		 * Get status of PFS and its connections (-a for all PFSs)
185 		 */
186 		if (ac < 2) {
187 			ecode = cmd_remote_status(sel_path, all_opt);
188 		} else {
189 			int i;
190 
191 			for (i = 1; i < ac; ++i)
192 				ecode = cmd_remote_status(av[i], all_opt);
193 		}
194 	} else if (strcmp(av[0], "pfs-clid") == 0) {
195 		/*
196 		 * Print cluster id (uuid) for specific PFS
197 		 */
198 		if (ac < 2) {
199 			fprintf(stderr, "pfs-clid: requires name\n");
200 			usage(1);
201 		}
202 		ecode = cmd_pfs_getid(sel_path, av[1], 0);
203 	} else if (strcmp(av[0], "pfs-fsid") == 0) {
204 		/*
205 		 * Print private id (uuid) for specific PFS
206 		 */
207 		if (ac < 2) {
208 			fprintf(stderr, "pfs-fsid: requires name\n");
209 			usage(1);
210 		}
211 		ecode = cmd_pfs_getid(sel_path, av[1], 1);
212 	} else if (strcmp(av[0], "pfs-list") == 0) {
213 		/*
214 		 * List all PFSs
215 		 */
216 		if (ac >= 2) {
217 			ecode = cmd_pfs_list(ac - 1,
218 					     (const char **)(void *)&av[1]);
219 		} else {
220 			ecode = cmd_pfs_list(1, &sel_path);
221 		}
222 	} else if (strcmp(av[0], "pfs-create") == 0) {
223 		/*
224 		 * Create new PFS using pfs_type
225 		 */
226 		if (ac < 2) {
227 			fprintf(stderr, "pfs-create: requires name\n");
228 			usage(1);
229 		}
230 		ecode = cmd_pfs_create(sel_path, av[1], pfs_type, uuid_str);
231 	} else if (strcmp(av[0], "pfs-delete") == 0) {
232 		/*
233 		 * Delete a PFS by name
234 		 */
235 		if (ac < 2) {
236 			fprintf(stderr, "pfs-delete: requires name\n");
237 			usage(1);
238 		}
239 		ecode = cmd_pfs_delete(sel_path, av[1]);
240 	} else if (strcmp(av[0], "snapshot") == 0) {
241 		/*
242 		 * Create snapshot with optional pfs-type and optional
243 		 * label override.
244 		 */
245 		if (ac > 3) {
246 			fprintf(stderr, "pfs-snapshot: too many arguments\n");
247 			usage(1);
248 		}
249 		switch(ac) {
250 		case 1:
251 			ecode = cmd_pfs_snapshot(sel_path, NULL, NULL);
252 			break;
253 		case 2:
254 			ecode = cmd_pfs_snapshot(sel_path, av[1], NULL);
255 			break;
256 		case 3:
257 			ecode = cmd_pfs_snapshot(sel_path, av[1], av[2]);
258 			break;
259 		}
260 	} else if (strcmp(av[0], "service") == 0) {
261 		/*
262 		 * Start the service daemon.  This daemon accepts
263 		 * connections from local and remote clients, handles
264 		 * the security handshake, and manages the core messaging
265 		 * protocol.
266 		 */
267 		ecode = cmd_service();
268 	} else if (strcmp(av[0], "stat") == 0) {
269 		ecode = cmd_stat(ac - 1, (const char **)(void *)&av[1]);
270 	} else if (strcmp(av[0], "leaf") == 0) {
271 		/*
272 		 * Start the management daemon for a specific PFS.
273 		 *
274 		 * This will typically connect to the local master node
275 		 * daemon, register the PFS, and then pass its side of
276 		 * the socket descriptor to the kernel HAMMER2 VFS via an
277 		 * ioctl().  The process and/or thread context remains in the
278 		 * kernel until the PFS is unmounted or the connection is
279 		 * lost, then returns from the ioctl.
280 		 *
281 		 * It is possible to connect directly to a remote master node
282 		 * instead of the local master node in situations where
283 		 * encryption is not desired or no local master node is
284 		 * desired.  This is not recommended because it represents
285 		 * a single point of failure for the PFS's communications.
286 		 *
287 		 * Direct kernel<->kernel communication between HAMMER2 VFSs
288 		 * is theoretically possible for directly-connected
289 		 * registrations (i.e. where the spanning tree is degenerate),
290 		 * but not recommended.  We specifically try to reduce the
291 		 * complexity of the HAMMER2 VFS kernel code.
292 		 */
293 		ecode = cmd_leaf(sel_path);
294 	} else if (strcmp(av[0], "shell") == 0) {
295 		/*
296 		 * Connect to the command line monitor in the hammer2 master
297 		 * node for the machine using HAMMER2_DBG_SHELL messages.
298 		 */
299 		ecode = cmd_shell((ac < 2) ? NULL : av[1]);
300 	} else if (strcmp(av[0], "rsainit") == 0) {
301 		/*
302 		 * Initialize a RSA keypair.  If no target directory is
303 		 * specified we default to "/etc/hammer2".
304 		 */
305 		arg = (ac < 2) ? HAMMER2_DEFAULT_DIR : av[1];
306 		ecode = cmd_rsainit(arg);
307 	} else if (strcmp(av[0], "rsaenc") == 0) {
308 		/*
309 		 * Encrypt the input symmetrically by running it through
310 		 * the specified public and/or private key files.
311 		 *
312 		 * If no key files are specified data is encoded using
313 		 * "/etc/hammer2/rsa.pub".
314 		 *
315 		 * WARNING: no padding is added, data stream must contain
316 		 *	    random padding for this to be secure.
317 		 *
318 		 * Used for debugging only
319 		 */
320 		if (ac == 1) {
321 			const char *rsapath = HAMMER2_DEFAULT_DIR "/rsa.pub";
322 			ecode = cmd_rsaenc(&rsapath, 1);
323 		} else {
324 			ecode = cmd_rsaenc((const char **)(void *)&av[1],
325 					   ac - 1);
326 		}
327 	} else if (strcmp(av[0], "rsadec") == 0) {
328 		/*
329 		 * Decrypt the input symmetrically by running it through
330 		 * the specified public and/or private key files.
331 		 *
332 		 * If no key files are specified data is decoded using
333 		 * "/etc/hammer2/rsa.prv".
334 		 *
335 		 * WARNING: no padding is added, data stream must contain
336 		 *	    random padding for this to be secure.
337 		 *
338 		 * Used for debugging only
339 		 */
340 		if (ac == 1) {
341 			const char *rsapath = HAMMER2_DEFAULT_DIR "/rsa.prv";
342 			ecode = cmd_rsadec(&rsapath, 1);
343 		} else {
344 			ecode = cmd_rsadec((const char **)(void *)&av[1],
345 					   ac - 1);
346 		}
347 	} else if (strcmp(av[0], "show") == 0) {
348 		/*
349 		 * Raw dump of filesystem.  Use -v to check all crc's, and
350 		 * -vv to dump bulk file data.
351 		 */
352 		if (ac != 2) {
353 			fprintf(stderr, "show: requires device path\n");
354 			usage(1);
355 		} else {
356 			cmd_show(av[1], 0);
357 		}
358 	} else if (strcmp(av[0], "freemap") == 0) {
359 		/*
360 		 * Raw dump of freemap.  Use -v to check all crc's, and
361 		 * -vv to dump bulk file data.
362 		 */
363 		if (ac != 2) {
364 			fprintf(stderr, "freemap: requires device path\n");
365 			usage(1);
366 		} else {
367 			cmd_show(av[1], 1);
368 		}
369 	} else if (strcmp(av[0], "setcomp") == 0) {
370 		if (ac < 3) {
371 			/*
372 			 * Missing compression method and at least one
373 			 * path.
374 			 */
375 			fprintf(stderr,
376 				"setcomp: requires compression method and"
377 				"directory/file path\n");
378 			usage(1);
379 		} else {
380 			/*
381 			 * Multiple paths may be specified
382 			 */
383 			ecode = cmd_setcomp(av[1], &av[2]);
384 		}
385 	} else if (strcmp(av[0], "setcheck") == 0) {
386 		if (ac < 3) {
387 			/*
388 			 * Missing compression method and at least one
389 			 * path.
390 			 */
391 			fprintf(stderr,
392 				"setcheck: requires check code method and"
393 				"directory/file path\n");
394 			usage(1);
395 		} else {
396 			/*
397 			 * Multiple paths may be specified
398 			 */
399 			ecode = cmd_setcheck(av[1], &av[2]);
400 		}
401 	} else if (strcmp(av[0], "clrcheck") == 0) {
402 		ecode = cmd_setcheck("none", &av[1]);
403 	} else if (strcmp(av[0], "setcrc32") == 0) {
404 		ecode = cmd_setcheck("crc32", &av[1]);
405 	} else if (strcmp(av[0], "setcrc64") == 0) {
406 		ecode = cmd_setcheck("crc64", &av[1]);
407 	} else if (strcmp(av[0], "setsha192") == 0) {
408 		ecode = cmd_setcheck("sha192", &av[1]);
409 	} else if (strcmp(av[0], "printinode") == 0) {
410 		if (ac != 2) {
411 			fprintf(stderr,
412 				"printinode: requires directory/file path\n");
413 			usage(1);
414 		} else {
415 			print_inode(av[1]);
416 		}
417 	} else if (strcmp(av[0], "bulkfree") == 0) {
418 		if (ac != 2) {
419 			fprintf(stderr,
420 				"bulkfree: requires path to mount\n");
421 			usage(1);
422 		} else {
423 			ecode = cmd_bulkfree(av[1]);
424 		}
425 	} else {
426 		fprintf(stderr, "Unrecognized command: %s\n", av[0]);
427 		usage(1);
428 	}
429 
430 	/*
431 	 * In DebugMode we may wind up starting several pthreads in the
432 	 * original process, in which case we have to let them run and
433 	 * not actually exit.
434 	 */
435 	if (NormalExit) {
436 		return (ecode);
437 	} else {
438 		pthread_exit(NULL);
439 		_exit(2);	/* NOT REACHED */
440 	}
441 }
442 
443 static
444 void
445 usage(int code)
446 {
447 	fprintf(stderr,
448 		"hammer2 [options] command...\n"
449 		"    -s path            Select filesystem\n"
450 		"    -t type            PFS type for pfs-create\n"
451 		"    -u uuid            uuid for pfs-create\n"
452 		"\n"
453 		"    connect <target>             "
454 			"Add cluster link\n"
455 		"    disconnect <target>          "
456 			"Del cluster link\n"
457 		"    hash filename*               "
458 			"Print directory hash\n"
459 		"    info [devpath...]            "
460 			"Info on all offline or online H2 partitions\n"
461 		"    mountall [devpath...]        "
462 			"Mount @LOCAL for all H2 partitions\n"
463 		"    status [<path>...]           "
464 			"Report active cluster status\n"
465 		"    pfs-list [<path>...]         "
466 			"List PFSs\n"
467 		"    pfs-clid <label>             "
468 			"Print cluster id for specific PFS\n"
469 		"    pfs-fsid <label>             "
470 			"Print private id for specific PFS\n"
471 		"    pfs-create <label>           "
472 			"Create a PFS\n"
473 		"    pfs-delete <label>           "
474 			"Destroy a PFS\n"
475 		"    snapshot <path> [<label>]           "
476 			"Snapshot a PFS or directory\n"
477 		"    service                      "
478 			"Start service daemon\n"
479 		"    stat [<path>]	          "
480 			"Return inode quota & config\n"
481 		"    leaf                         "
482 			"Start pfs leaf daemon\n"
483 		"    shell [<host>]               "
484 			"Connect to debug shell\n"
485 		"    debugspan <target>           "
486 			"Connect to target, run CONN/SPAN\n"
487 		"    rsainit                      "
488 			"Initialize rsa fields\n"
489 		"    show devpath                 "
490 			"Raw hammer2 media dump\n"
491 		"    freemap devpath              "
492 			"Raw hammer2 media dump\n"
493 		"    setcomp comp[:level] path... "
494 			"Set comp algo {none, autozero, lz4, zlib} & level\n"
495 		"    setcheck check path...       "
496 			"Set check algo {none, crc32, crc64, sha192}\n"
497 		"    clrcheck path...             "
498 			"Clear check code override\n"
499 		"    setcrc32 path...             "
500 			"Set check algo to crc32\n"
501 		"    setcrc64 path...             "
502 			"Set check algo to crc64\n"
503 		"    setsha192 path...            "
504 			"Set check algo to sha192\n"
505 		"    bulkfree path...             "
506 			"Run bulkfree pass\n"
507 	);
508 	exit(code);
509 }
510