2 * Copyright (c) 2011-2012 The DragonFly Project. All rights reserved.
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>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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
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.
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
41 int NormalExit = 1; /* if set to 0 main() has to pthread_exit() */
45 static void usage(int code);
48 main(int ac, char **av)
50 const char *sel_path = NULL;
51 const char *uuid_str = NULL;
53 int pfs_type = HAMMER2_PFSTYPE_NONE;
59 signal(SIGPIPE, SIG_IGN);
65 while ((ch = getopt(ac, av, "adfrqs:t:u:v")) != -1) {
86 * set node type for mkpfs
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;
101 fprintf(stderr, "-t: Unrecognized node type\n");
107 * set uuid for mkpfs, else one will be generated
108 * (required for all except the MASTER node_type)
125 fprintf(stderr, "Unknown option: %c\n", ch);
133 * Adjust, then process the command
138 fprintf(stderr, "Missing command\n");
143 if (strcmp(av[0], "connect") == 0) {
145 * Add cluster connection
148 fprintf(stderr, "connect: missing argument\n");
151 ecode = cmd_remote_connect(sel_path, av[1]);
152 } else if (strcmp(av[0], "chaindump") == 0) {
154 ecode = cmd_chaindump(".");
156 ecode = cmd_chaindump(av[1]);
157 } else if (strcmp(av[0], "debugspan") == 0) {
159 * Debug connection to the target hammer2 service and run
160 * the CONN/SPAN protocol.
163 fprintf(stderr, "debugspan: requires hostname\n");
166 ecode = cmd_debugspan(av[1]);
167 } else if (strcmp(av[0], "disconnect") == 0) {
169 * Remove cluster connection
172 fprintf(stderr, "disconnect: missing argument\n");
175 ecode = cmd_remote_disconnect(sel_path, av[1]);
176 } else if (strcmp(av[0], "destroy") == 0) {
179 "Specify one or more paths to destroy\n");
181 ecode = cmd_destroy_path(ac - 1, (const char **)(void *)&av[1]);
182 } else if (strcmp(av[0], "hash") == 0) {
183 ecode = cmd_hash(ac - 1, (const char **)(void *)&av[1]);
184 } else if (strcmp(av[0], "info") == 0) {
185 ecode = cmd_info(ac - 1, (const char **)(void *)&av[1]);
186 } else if (strcmp(av[0], "mountall") == 0) {
187 ecode = cmd_mountall(ac - 1, (const char **)(void *)&av[1]);
188 } else if (strcmp(av[0], "status") == 0) {
190 * Get status of PFS and its connections (-a for all PFSs)
193 ecode = cmd_remote_status(sel_path, all_opt);
197 for (i = 1; i < ac; ++i)
198 ecode = cmd_remote_status(av[i], all_opt);
200 } else if (strcmp(av[0], "pfs-clid") == 0) {
202 * Print cluster id (uuid) for specific PFS
205 fprintf(stderr, "pfs-clid: requires name\n");
208 ecode = cmd_pfs_getid(sel_path, av[1], 0);
209 } else if (strcmp(av[0], "pfs-fsid") == 0) {
211 * Print private id (uuid) for specific PFS
214 fprintf(stderr, "pfs-fsid: requires name\n");
217 ecode = cmd_pfs_getid(sel_path, av[1], 1);
218 } else if (strcmp(av[0], "pfs-list") == 0) {
223 ecode = cmd_pfs_list(ac - 1,
224 (const char **)(void *)&av[1]);
226 ecode = cmd_pfs_list(1, &sel_path);
228 } else if (strcmp(av[0], "pfs-create") == 0) {
230 * Create new PFS using pfs_type
233 fprintf(stderr, "pfs-create: requires name\n");
236 ecode = cmd_pfs_create(sel_path, av[1], pfs_type, uuid_str);
237 } else if (strcmp(av[0], "pfs-delete") == 0) {
239 * Delete a PFS by name
242 fprintf(stderr, "pfs-delete: requires name\n");
245 ecode = cmd_pfs_delete(sel_path, av[1]);
246 } else if (strcmp(av[0], "snapshot") == 0) {
248 * Create snapshot with optional pfs-type and optional
252 fprintf(stderr, "pfs-snapshot: too many arguments\n");
257 ecode = cmd_pfs_snapshot(sel_path, NULL, NULL);
260 ecode = cmd_pfs_snapshot(sel_path, av[1], NULL);
263 ecode = cmd_pfs_snapshot(sel_path, av[1], av[2]);
266 } else if (strcmp(av[0], "service") == 0) {
268 * Start the service daemon. This daemon accepts
269 * connections from local and remote clients, handles
270 * the security handshake, and manages the core messaging
273 ecode = cmd_service();
274 } else if (strcmp(av[0], "stat") == 0) {
275 ecode = cmd_stat(ac - 1, (const char **)(void *)&av[1]);
276 } else if (strcmp(av[0], "leaf") == 0) {
278 * Start the management daemon for a specific PFS.
280 * This will typically connect to the local master node
281 * daemon, register the PFS, and then pass its side of
282 * the socket descriptor to the kernel HAMMER2 VFS via an
283 * ioctl(). The process and/or thread context remains in the
284 * kernel until the PFS is unmounted or the connection is
285 * lost, then returns from the ioctl.
287 * It is possible to connect directly to a remote master node
288 * instead of the local master node in situations where
289 * encryption is not desired or no local master node is
290 * desired. This is not recommended because it represents
291 * a single point of failure for the PFS's communications.
293 * Direct kernel<->kernel communication between HAMMER2 VFSs
294 * is theoretically possible for directly-connected
295 * registrations (i.e. where the spanning tree is degenerate),
296 * but not recommended. We specifically try to reduce the
297 * complexity of the HAMMER2 VFS kernel code.
299 ecode = cmd_leaf(sel_path);
300 } else if (strcmp(av[0], "shell") == 0) {
302 * Connect to the command line monitor in the hammer2 master
303 * node for the machine using HAMMER2_DBG_SHELL messages.
305 ecode = cmd_shell((ac < 2) ? NULL : av[1]);
306 } else if (strcmp(av[0], "rsainit") == 0) {
308 * Initialize a RSA keypair. If no target directory is
309 * specified we default to "/etc/hammer2".
311 arg = (ac < 2) ? HAMMER2_DEFAULT_DIR : av[1];
312 ecode = cmd_rsainit(arg);
313 } else if (strcmp(av[0], "rsaenc") == 0) {
315 * Encrypt the input symmetrically by running it through
316 * the specified public and/or private key files.
318 * If no key files are specified data is encoded using
319 * "/etc/hammer2/rsa.pub".
321 * WARNING: no padding is added, data stream must contain
322 * random padding for this to be secure.
324 * Used for debugging only
327 const char *rsapath = HAMMER2_DEFAULT_DIR "/rsa.pub";
328 ecode = cmd_rsaenc(&rsapath, 1);
330 ecode = cmd_rsaenc((const char **)(void *)&av[1],
333 } else if (strcmp(av[0], "rsadec") == 0) {
335 * Decrypt the input symmetrically by running it through
336 * the specified public and/or private key files.
338 * If no key files are specified data is decoded using
339 * "/etc/hammer2/rsa.prv".
341 * WARNING: no padding is added, data stream must contain
342 * random padding for this to be secure.
344 * Used for debugging only
347 const char *rsapath = HAMMER2_DEFAULT_DIR "/rsa.prv";
348 ecode = cmd_rsadec(&rsapath, 1);
350 ecode = cmd_rsadec((const char **)(void *)&av[1],
353 } else if (strcmp(av[0], "show") == 0) {
355 * Raw dump of filesystem. Use -v to check all crc's, and
356 * -vv to dump bulk file data.
359 fprintf(stderr, "show: requires device path\n");
364 } else if (strcmp(av[0], "freemap") == 0) {
366 * Raw dump of freemap. Use -v to check all crc's, and
367 * -vv to dump bulk file data.
370 fprintf(stderr, "freemap: requires device path\n");
375 } else if (strcmp(av[0], "setcomp") == 0) {
378 * Missing compression method and at least one
382 "setcomp: requires compression method and"
383 "directory/file path\n");
387 * Multiple paths may be specified
389 ecode = cmd_setcomp(av[1], &av[2]);
391 } else if (strcmp(av[0], "setcheck") == 0) {
394 * Missing compression method and at least one
398 "setcheck: requires check code method and"
399 "directory/file path\n");
403 * Multiple paths may be specified
405 ecode = cmd_setcheck(av[1], &av[2]);
407 } else if (strcmp(av[0], "clrcheck") == 0) {
408 ecode = cmd_setcheck("none", &av[1]);
409 } else if (strcmp(av[0], "setcrc32") == 0) {
410 ecode = cmd_setcheck("crc32", &av[1]);
411 } else if (strcmp(av[0], "setxxhash64") == 0) {
412 ecode = cmd_setcheck("xxhash64", &av[1]);
413 } else if (strcmp(av[0], "setsha192") == 0) {
414 ecode = cmd_setcheck("sha192", &av[1]);
415 } else if (strcmp(av[0], "printinode") == 0) {
418 "printinode: requires directory/file path\n");
423 } else if (strcmp(av[0], "bulkfree") == 0) {
426 "bulkfree: requires path to mount\n");
429 ecode = cmd_bulkfree(av[1]);
432 } else if (strcmp(av[0], "bulkfree-async") == 0) {
435 "bulkfree-async: requires path to mount\n");
438 ecode = cmd_bulkfree_async(av[1]);
441 } else if (strcmp(av[0], "cleanup") == 0) {
442 ecode = cmd_cleanup(av[1]); /* can be NULL */
444 fprintf(stderr, "Unrecognized command: %s\n", av[0]);
449 * In DebugMode we may wind up starting several pthreads in the
450 * original process, in which case we have to let them run and
457 _exit(2); /* NOT REACHED */
466 "hammer2 [options] command...\n"
467 " -s path Select filesystem\n"
468 " -t type PFS type for pfs-create\n"
469 " -u uuid uuid for pfs-create\n"
473 " debugspan <target> "
474 "Debug spanning tree\n"
476 "Dump in-memory chain topo at\n"
478 "Destroy a directory entry (only use if inode bad)\n"
479 " disconnect <target> "
482 "Print directory hash\n"
483 " info [devpath...] "
484 "Info on all offline or online H2 partitions\n"
485 " mountall [devpath...] "
486 "Mount @LOCAL for all H2 partitions\n"
487 " status [<path>...] "
488 "Report active cluster status\n"
489 " pfs-list [<path>...] "
492 "Print cluster id for specific PFS\n"
494 "Print private id for specific PFS\n"
495 " pfs-create <label> "
497 " pfs-delete <label> "
499 " snapshot <path> [<label>] "
500 "Snapshot a PFS or directory\n"
502 "Start service daemon\n"
504 "Return inode quota & config\n"
506 "Start pfs leaf daemon\n"
508 "Connect to debug shell\n"
509 " debugspan <target> "
510 "Connect to target, run CONN/SPAN\n"
512 "Initialize rsa fields\n"
514 "Raw hammer2 media dump\n"
516 "Raw hammer2 media dump\n"
517 " setcomp comp[:level] path... "
518 "Set comp algo {none, autozero, lz4, zlib} & level\n"
519 " setcheck check path... "
520 "Set check algo {none, crc32, xxhash64, sha192}\n"
522 "Clear check code override\n"
524 "Set check algo to crc32\n"
525 " setxxhash64 path... "
526 "Set check algo to xxhash64\n"
527 " setsha192 path... "
528 "Set check algo to sha192\n"
530 "Run bulkfree pass\n"
532 " bulkfree-async path... "
533 "Run bulkfree pass asynchronously\n"