1 /* 2 * Copyright (c) 2011-2019 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 size_t MemOpt; 45 46 static void usage(int code); 47 48 int 49 main(int ac, char **av) 50 { 51 const char *sel_path = NULL; 52 const char *uuid_str = NULL; 53 const char *arg; 54 char *opt; 55 int pfs_type = HAMMER2_PFSTYPE_NONE; 56 int all_opt = 0; 57 int ecode = 0; 58 int ch; 59 60 srandomdev(); 61 signal(SIGPIPE, SIG_IGN); 62 dmsg_crypto_setup(); 63 64 /* 65 * Core options 66 */ 67 while ((ch = getopt(ac, av, "adfm:rqs:t:u:v")) != -1) { 68 switch(ch) { 69 case 'a': 70 all_opt = 1; 71 break; 72 case 'd': 73 if (DebugOpt) 74 ++DMsgDebugOpt; 75 DebugOpt = 1; 76 break; 77 case 'f': 78 ForceOpt = 1; 79 break; 80 case 'm': 81 MemOpt = strtoul(optarg, &opt, 0); 82 switch(*opt) { 83 case 'g': 84 case 'G': 85 MemOpt *= 1024; 86 /* FALLTHROUGH */ 87 case 'm': 88 case 'M': 89 MemOpt *= 1024; 90 /* FALLTHROUGH */ 91 case 'k': 92 case 'K': 93 MemOpt *= 1024; 94 break; 95 case 0: 96 break; 97 default: 98 fprintf(stderr, "-m: Unrecognized suffix\n"); 99 usage(1); 100 break; 101 } 102 break; 103 case 'r': 104 RecurseOpt = 1; 105 break; 106 case 's': 107 sel_path = optarg; 108 break; 109 case 't': 110 /* 111 * set node type for mkpfs 112 */ 113 if (strcasecmp(optarg, "CACHE") == 0) { 114 pfs_type = HAMMER2_PFSTYPE_CACHE; 115 } else if (strcasecmp(optarg, "DUMMY") == 0) { 116 pfs_type = HAMMER2_PFSTYPE_DUMMY; 117 } else if (strcasecmp(optarg, "SLAVE") == 0) { 118 pfs_type = HAMMER2_PFSTYPE_SLAVE; 119 } else if (strcasecmp(optarg, "SOFT_SLAVE") == 0) { 120 pfs_type = HAMMER2_PFSTYPE_SOFT_SLAVE; 121 } else if (strcasecmp(optarg, "SOFT_MASTER") == 0) { 122 pfs_type = HAMMER2_PFSTYPE_SOFT_MASTER; 123 } else if (strcasecmp(optarg, "MASTER") == 0) { 124 pfs_type = HAMMER2_PFSTYPE_MASTER; 125 } else { 126 fprintf(stderr, "-t: Unrecognized node type\n"); 127 usage(1); 128 } 129 break; 130 case 'u': 131 /* 132 * set uuid for mkpfs, else one will be generated 133 * (required for all except the MASTER node_type) 134 */ 135 uuid_str = optarg; 136 break; 137 case 'v': 138 if (QuietOpt) 139 --QuietOpt; 140 else 141 ++VerboseOpt; 142 break; 143 case 'q': 144 if (VerboseOpt) 145 --VerboseOpt; 146 else 147 ++QuietOpt; 148 break; 149 default: 150 fprintf(stderr, "Unknown option: %c\n", ch); 151 usage(1); 152 /* not reached */ 153 break; 154 } 155 } 156 157 /* 158 * Adjust, then process the command 159 */ 160 ac -= optind; 161 av += optind; 162 if (ac < 1) { 163 fprintf(stderr, "Missing command\n"); 164 usage(1); 165 /* not reached */ 166 } 167 168 if (strcmp(av[0], "connect") == 0) { 169 /* 170 * Add cluster connection 171 */ 172 if (ac < 2) { 173 fprintf(stderr, "connect: missing argument\n"); 174 usage(1); 175 } 176 ecode = cmd_remote_connect(sel_path, av[1]); 177 } else if (strcmp(av[0], "dumpchain") == 0) { 178 if (ac < 2) 179 ecode = cmd_dumpchain(".", (u_int)-1); 180 else if (ac < 3) 181 ecode = cmd_dumpchain(av[1], (u_int)-1); 182 else 183 ecode = cmd_dumpchain(av[1], 184 (u_int)strtoul(av[2], NULL, 0)); 185 } else if (strcmp(av[0], "debugspan") == 0) { 186 /* 187 * Debug connection to the target hammer2 service and run 188 * the CONN/SPAN protocol. 189 */ 190 if (ac < 2) { 191 fprintf(stderr, "debugspan: requires hostname\n"); 192 usage(1); 193 } 194 ecode = cmd_debugspan(av[1]); 195 } else if (strcmp(av[0], "disconnect") == 0) { 196 /* 197 * Remove cluster connection 198 */ 199 if (ac < 2) { 200 fprintf(stderr, "disconnect: missing argument\n"); 201 usage(1); 202 } 203 ecode = cmd_remote_disconnect(sel_path, av[1]); 204 } else if (strcmp(av[0], "destroy") == 0) { 205 if (ac < 2) { 206 fprintf(stderr, 207 "destroy: specify one or more paths to " 208 "destroy\n"); 209 usage(1); 210 } 211 ecode = cmd_destroy_path(ac - 1, (const char **)(void *)&av[1]); 212 } else if (strcmp(av[0], "destroy-inum") == 0) { 213 if (ac < 2) { 214 fprintf(stderr, 215 "destroy-inum: specify one or more inode " 216 "numbers to destroy\n"); 217 usage(1); 218 } 219 ecode = cmd_destroy_inum(sel_path, ac - 1, 220 (const char **)(void *)&av[1]); 221 } else if (strcmp(av[0], "emergency-mode-enable") == 0) { 222 ecode = cmd_emergency_mode(sel_path, 1, ac - 1, 223 (const char **)(void *)&av[1]); 224 } else if (strcmp(av[0], "emergency-mode-disable") == 0) { 225 ecode = cmd_emergency_mode(sel_path, 0, ac - 1, 226 (const char **)(void *)&av[1]); 227 } else if (strcmp(av[0], "hash") == 0) { 228 ecode = cmd_hash(ac - 1, (const char **)(void *)&av[1]); 229 } else if (strcmp(av[0], "dhash") == 0) { 230 ecode = cmd_dhash(ac - 1, (const char **)(void *)&av[1]); 231 } else if (strcmp(av[0], "info") == 0) { 232 ecode = cmd_info(ac - 1, (const char **)(void *)&av[1]); 233 } else if (strcmp(av[0], "mountall") == 0) { 234 ecode = cmd_mountall(ac - 1, (const char **)(void *)&av[1]); 235 } else if (strcmp(av[0], "status") == 0) { 236 /* 237 * Get status of PFS and its connections (-a for all PFSs) 238 */ 239 if (ac < 2) { 240 ecode = cmd_remote_status(sel_path, all_opt); 241 } else { 242 int i; 243 for (i = 1; i < ac; ++i) 244 ecode = cmd_remote_status(av[i], all_opt); 245 } 246 } else if (strcmp(av[0], "pfs-clid") == 0) { 247 /* 248 * Print cluster id (uuid) for specific PFS 249 */ 250 if (ac < 2) { 251 fprintf(stderr, "pfs-clid: requires name\n"); 252 usage(1); 253 } 254 ecode = cmd_pfs_getid(sel_path, av[1], 0); 255 } else if (strcmp(av[0], "pfs-fsid") == 0) { 256 /* 257 * Print private id (uuid) for specific PFS 258 */ 259 if (ac < 2) { 260 fprintf(stderr, "pfs-fsid: requires name\n"); 261 usage(1); 262 } 263 ecode = cmd_pfs_getid(sel_path, av[1], 1); 264 } else if (strcmp(av[0], "pfs-list") == 0) { 265 /* 266 * List all PFSs 267 */ 268 if (ac >= 2) { 269 ecode = cmd_pfs_list(ac - 1, 270 (const char **)(void *)&av[1]); 271 } else { 272 ecode = cmd_pfs_list(1, &sel_path); 273 } 274 } else if (strcmp(av[0], "pfs-create") == 0) { 275 /* 276 * Create new PFS using pfs_type 277 */ 278 if (ac < 2) { 279 fprintf(stderr, "pfs-create: requires name\n"); 280 usage(1); 281 } 282 ecode = cmd_pfs_create(sel_path, av[1], pfs_type, uuid_str); 283 } else if (strcmp(av[0], "pfs-delete") == 0) { 284 /* 285 * Delete a PFS by name 286 */ 287 if (ac < 2) { 288 fprintf(stderr, "pfs-delete: requires name\n"); 289 usage(1); 290 } 291 ecode = cmd_pfs_delete(sel_path, av[1]); 292 } else if (strcmp(av[0], "snapshot") == 0 || 293 strcmp(av[0], "snapshot-debug") == 0) { 294 /* 295 * Create snapshot with optional pfs-type and optional 296 * label override. 297 */ 298 uint32_t flags = 0; 299 300 if (strcmp(av[0], "snapshot-debug") == 0) 301 flags = HAMMER2_PFSFLAGS_NOSYNC; 302 303 if (ac > 3) { 304 fprintf(stderr, "%s: too many arguments\n", av[0]); 305 usage(1); 306 } 307 switch(ac) { 308 case 1: 309 ecode = cmd_pfs_snapshot(sel_path, NULL, NULL, flags); 310 break; 311 case 2: 312 ecode = cmd_pfs_snapshot(sel_path, av[1], NULL, flags); 313 break; 314 case 3: 315 ecode = cmd_pfs_snapshot(sel_path, av[1], av[2], flags); 316 break; 317 } 318 } else if (strcmp(av[0], "service") == 0) { 319 /* 320 * Start the service daemon. This daemon accepts 321 * connections from local and remote clients, handles 322 * the security handshake, and manages the core messaging 323 * protocol. 324 */ 325 ecode = cmd_service(); 326 } else if (strcmp(av[0], "stat") == 0) { 327 ecode = cmd_stat(ac - 1, (const char **)(void *)&av[1]); 328 } else if (strcmp(av[0], "leaf") == 0) { 329 /* 330 * Start the management daemon for a specific PFS. 331 * 332 * This will typically connect to the local master node 333 * daemon, register the PFS, and then pass its side of 334 * the socket descriptor to the kernel HAMMER2 VFS via an 335 * ioctl(). The process and/or thread context remains in the 336 * kernel until the PFS is unmounted or the connection is 337 * lost, then returns from the ioctl. 338 * 339 * It is possible to connect directly to a remote master node 340 * instead of the local master node in situations where 341 * encryption is not desired or no local master node is 342 * desired. This is not recommended because it represents 343 * a single point of failure for the PFS's communications. 344 * 345 * Direct kernel<->kernel communication between HAMMER2 VFSs 346 * is theoretically possible for directly-connected 347 * registrations (i.e. where the spanning tree is degenerate), 348 * but not recommended. We specifically try to reduce the 349 * complexity of the HAMMER2 VFS kernel code. 350 */ 351 ecode = cmd_leaf(sel_path); 352 } else if (strcmp(av[0], "shell") == 0) { 353 /* 354 * Connect to the command line monitor in the hammer2 master 355 * node for the machine using HAMMER2_DBG_SHELL messages. 356 */ 357 ecode = cmd_shell((ac < 2) ? NULL : av[1]); 358 } else if (strcmp(av[0], "rsainit") == 0) { 359 /* 360 * Initialize a RSA keypair. If no target directory is 361 * specified we default to "/etc/hammer2". 362 */ 363 arg = (ac < 2) ? HAMMER2_DEFAULT_DIR : av[1]; 364 ecode = cmd_rsainit(arg); 365 } else if (strcmp(av[0], "rsaenc") == 0) { 366 /* 367 * Encrypt the input symmetrically by running it through 368 * the specified public and/or private key files. 369 * 370 * If no key files are specified data is encoded using 371 * "/etc/hammer2/rsa.pub". 372 * 373 * WARNING: no padding is added, data stream must contain 374 * random padding for this to be secure. 375 * 376 * Used for debugging only 377 */ 378 if (ac == 1) { 379 const char *rsapath = HAMMER2_DEFAULT_DIR "/rsa.pub"; 380 ecode = cmd_rsaenc(&rsapath, 1); 381 } else { 382 ecode = cmd_rsaenc((const char **)(void *)&av[1], 383 ac - 1); 384 } 385 } else if (strcmp(av[0], "rsadec") == 0) { 386 /* 387 * Decrypt the input symmetrically by running it through 388 * the specified public and/or private key files. 389 * 390 * If no key files are specified data is decoded using 391 * "/etc/hammer2/rsa.prv". 392 * 393 * WARNING: no padding is added, data stream must contain 394 * random padding for this to be secure. 395 * 396 * Used for debugging only 397 */ 398 if (ac == 1) { 399 const char *rsapath = HAMMER2_DEFAULT_DIR "/rsa.prv"; 400 ecode = cmd_rsadec(&rsapath, 1); 401 } else { 402 ecode = cmd_rsadec((const char **)(void *)&av[1], 403 ac - 1); 404 } 405 } else if (strcmp(av[0], "show") == 0) { 406 /* 407 * Raw dump of filesystem. Use -v to check all crc's, and 408 * -vv to dump bulk file data. 409 */ 410 if (ac != 2) { 411 fprintf(stderr, "show: requires device path\n"); 412 usage(1); 413 } else { 414 cmd_show(av[1], 0); 415 } 416 } else if (strcmp(av[0], "freemap") == 0) { 417 /* 418 * Raw dump of freemap. Use -v to check all crc's, and 419 * -vv to dump bulk file data. 420 */ 421 if (ac != 2) { 422 fprintf(stderr, "freemap: requires device path\n"); 423 usage(1); 424 } else { 425 cmd_show(av[1], 1); 426 } 427 } else if (strcmp(av[0], "volhdr") == 0) { 428 /* 429 * Dump the volume header. 430 */ 431 if (ac != 2) { 432 fprintf(stderr, "volhdr: requires device path\n"); 433 usage(1); 434 } else { 435 cmd_show(av[1], 2); 436 } 437 } else if (strcmp(av[0], "setcomp") == 0) { 438 if (ac < 3) { 439 /* 440 * Missing compression method and at least one 441 * path. 442 */ 443 fprintf(stderr, 444 "setcomp: requires compression method and " 445 "directory/file path\n"); 446 usage(1); 447 } else { 448 /* 449 * Multiple paths may be specified 450 */ 451 ecode = cmd_setcomp(av[1], &av[2]); 452 } 453 } else if (strcmp(av[0], "setcheck") == 0) { 454 if (ac < 3) { 455 /* 456 * Missing compression method and at least one 457 * path. 458 */ 459 fprintf(stderr, 460 "setcheck: requires check code method and " 461 "directory/file path\n"); 462 usage(1); 463 } else { 464 /* 465 * Multiple paths may be specified 466 */ 467 ecode = cmd_setcheck(av[1], &av[2]); 468 } 469 } else if (strcmp(av[0], "clrcheck") == 0) { 470 ecode = cmd_setcheck("none", &av[1]); 471 } else if (strcmp(av[0], "setcrc32") == 0) { 472 ecode = cmd_setcheck("crc32", &av[1]); 473 } else if (strcmp(av[0], "setxxhash64") == 0) { 474 ecode = cmd_setcheck("xxhash64", &av[1]); 475 } else if (strcmp(av[0], "setsha192") == 0) { 476 ecode = cmd_setcheck("sha192", &av[1]); 477 } else if (strcmp(av[0], "printinode") == 0) { 478 if (ac != 2) { 479 fprintf(stderr, 480 "printinode: requires directory/file path\n"); 481 usage(1); 482 } else { 483 print_inode(av[1]); 484 } 485 } else if (strcmp(av[0], "bulkfree") == 0) { 486 if (ac != 2) { 487 fprintf(stderr, "bulkfree: requires path to mount\n"); 488 usage(1); 489 } else { 490 ecode = cmd_bulkfree(av[1]); 491 } 492 #if 0 493 } else if (strcmp(av[0], "bulkfree-async") == 0) { 494 if (ac != 2) { 495 fprintf(stderr, 496 "bulkfree-async: requires path to mount\n"); 497 usage(1); 498 } else { 499 ecode = cmd_bulkfree_async(av[1]); 500 } 501 #endif 502 } else if (strcmp(av[0], "cleanup") == 0) { 503 ecode = cmd_cleanup(av[1]); /* can be NULL */ 504 } else { 505 fprintf(stderr, "Unrecognized command: %s\n", av[0]); 506 usage(1); 507 } 508 509 /* 510 * In DebugMode we may wind up starting several pthreads in the 511 * original process, in which case we have to let them run and 512 * not actually exit. 513 */ 514 if (NormalExit) { 515 return (ecode); 516 } else { 517 pthread_exit(NULL); 518 _exit(2); /* NOT REACHED */ 519 } 520 } 521 522 static 523 void 524 usage(int code) 525 { 526 fprintf(stderr, 527 "hammer2 [options] command [argument ...]\n" 528 " -s path Select filesystem\n" 529 " -t type PFS type for pfs-create\n" 530 " -u uuid uuid for pfs-create\n" 531 " -m mem[k,m,g] buffer memory (bulkfree)\n" 532 "\n" 533 " cleanup [<path>] " 534 "Run cleanup passes\n" 535 " connect <target> " 536 "Add cluster link\n" 537 " destroy <path>... " 538 "Destroy directory entries (only use if inode bad)\n" 539 " destroy-inum <inum>... " 540 "Destroy inodes (only use if inode bad)\n" 541 " disconnect <target> " 542 "Del cluster link\n" 543 " emergency-mode-enable <target> " 544 "Enable emergency operations mode on filesystem\n" 545 " " 546 "THIS IS A VERY DANGEROUS MODE\n" 547 " emergency-mode-disable <target> " 548 "Disable emergency operations mode on filesystem\n" 549 " info [<devpath>...] " 550 "Info on all offline or online H2 partitions\n" 551 " mountall [<devpath>...] " 552 "Mount @LOCAL for all H2 partitions\n" 553 " status [<path>...] " 554 "Report active cluster status\n" 555 " hash [<filename>...] " 556 "Print directory hash (key) for name\n" 557 " dhash [<filename>...] " 558 "Print data hash for long directory entry\n" 559 " pfs-list [<path>...] " 560 "List PFSs\n" 561 " pfs-clid <label> " 562 "Print cluster id for specific PFS\n" 563 " pfs-fsid <label> " 564 "Print private id for specific PFS\n" 565 " pfs-create <label> " 566 "Create a PFS\n" 567 " pfs-delete <label> " 568 "Destroy a PFS\n" 569 " snapshot <path> [<label>] " 570 "Snapshot a PFS or directory\n" 571 " snapshot-debug <path> [<label>] " 572 "Snapshot without filesystem sync\n" 573 " service " 574 "Start service daemon\n" 575 " stat [<path>...] " 576 "Return inode quota & config\n" 577 " leaf " 578 "Start pfs leaf daemon\n" 579 " shell [<host>] " 580 "Connect to debug shell\n" 581 " debugspan <target> " 582 "Connect to target, run CONN/SPAN\n" 583 " rsainit [<path>] " 584 "Initialize rsa fields\n" 585 " show <devpath> " 586 "Raw hammer2 media dump for topology\n" 587 " freemap <devpath> " 588 "Raw hammer2 media dump for freemap\n" 589 " volhdr <devpath> " 590 "Raw hammer2 media dump for the volume header(s)\n" 591 " setcomp <comp[:level]> <path>... " 592 "Set comp algo {none, autozero, lz4, zlib} & level\n" 593 " setcheck <check> <path>... " 594 "Set check algo {none, crc32, xxhash64, sha192}\n" 595 " clrcheck [<path>...] " 596 "Clear check code override\n" 597 " setcrc32 [<path>...] " 598 "Set check algo to crc32\n" 599 " setxxhash64 [<path>...] " 600 "Set check algo to xxhash64\n" 601 " setsha192 [<path>...] " 602 "Set check algo to sha192\n" 603 " bulkfree <path> " 604 "Run bulkfree pass\n" 605 " printinode <path> " 606 "Dump inode\n" 607 " dumpchain [<path> [<chnflags>]] " 608 "Dump in-memory chain topology (ONFLUSH flag is 0x200)\n" 609 #if 0 610 " bulkfree-async path " 611 "Run bulkfree pass asynchronously\n" 612 #endif 613 ); 614 exit(code); 615 } 616