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 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 "Specify one or more paths to destroy\n"); 208 } 209 ecode = cmd_destroy_path(ac - 1, (const char **)(void *)&av[1]); 210 } else if (strcmp(av[0], "destroy-inum") == 0) { 211 if (ac < 2) { 212 fprintf(stderr, 213 "Specify one or more inode numbers to destroy\n"); 214 } 215 ecode = cmd_destroy_inum(sel_path, ac - 1, (const char **)(void *)&av[1]); 216 } else if (strcmp(av[0], "hash") == 0) { 217 ecode = cmd_hash(ac - 1, (const char **)(void *)&av[1]); 218 } else if (strcmp(av[0], "info") == 0) { 219 ecode = cmd_info(ac - 1, (const char **)(void *)&av[1]); 220 } else if (strcmp(av[0], "mountall") == 0) { 221 ecode = cmd_mountall(ac - 1, (const char **)(void *)&av[1]); 222 } else if (strcmp(av[0], "status") == 0) { 223 /* 224 * Get status of PFS and its connections (-a for all PFSs) 225 */ 226 if (ac < 2) { 227 ecode = cmd_remote_status(sel_path, all_opt); 228 } else { 229 int i; 230 231 for (i = 1; i < ac; ++i) 232 ecode = cmd_remote_status(av[i], all_opt); 233 } 234 } else if (strcmp(av[0], "pfs-clid") == 0) { 235 /* 236 * Print cluster id (uuid) for specific PFS 237 */ 238 if (ac < 2) { 239 fprintf(stderr, "pfs-clid: requires name\n"); 240 usage(1); 241 } 242 ecode = cmd_pfs_getid(sel_path, av[1], 0); 243 } else if (strcmp(av[0], "pfs-fsid") == 0) { 244 /* 245 * Print private id (uuid) for specific PFS 246 */ 247 if (ac < 2) { 248 fprintf(stderr, "pfs-fsid: requires name\n"); 249 usage(1); 250 } 251 ecode = cmd_pfs_getid(sel_path, av[1], 1); 252 } else if (strcmp(av[0], "pfs-list") == 0) { 253 /* 254 * List all PFSs 255 */ 256 if (ac >= 2) { 257 ecode = cmd_pfs_list(ac - 1, 258 (const char **)(void *)&av[1]); 259 } else { 260 ecode = cmd_pfs_list(1, &sel_path); 261 } 262 } else if (strcmp(av[0], "pfs-create") == 0) { 263 /* 264 * Create new PFS using pfs_type 265 */ 266 if (ac < 2) { 267 fprintf(stderr, "pfs-create: requires name\n"); 268 usage(1); 269 } 270 ecode = cmd_pfs_create(sel_path, av[1], pfs_type, uuid_str); 271 } else if (strcmp(av[0], "pfs-delete") == 0) { 272 /* 273 * Delete a PFS by name 274 */ 275 if (ac < 2) { 276 fprintf(stderr, "pfs-delete: requires name\n"); 277 usage(1); 278 } 279 ecode = cmd_pfs_delete(sel_path, av[1]); 280 } else if (strcmp(av[0], "snapshot") == 0 || 281 strcmp(av[0], "snapshot-debug") == 0) { 282 /* 283 * Create snapshot with optional pfs-type and optional 284 * label override. 285 */ 286 uint32_t flags = 0; 287 288 if (strcmp(av[0], "snapshot-debug") == 0) 289 flags = HAMMER2_PFSFLAGS_NOSYNC; 290 291 if (ac > 3) { 292 fprintf(stderr, "pfs-snapshot: too many arguments\n"); 293 usage(1); 294 } 295 switch(ac) { 296 case 1: 297 ecode = cmd_pfs_snapshot(sel_path, NULL, NULL, flags); 298 break; 299 case 2: 300 ecode = cmd_pfs_snapshot(sel_path, av[1], NULL, flags); 301 break; 302 case 3: 303 ecode = cmd_pfs_snapshot(sel_path, av[1], av[2], flags); 304 break; 305 } 306 } else if (strcmp(av[0], "service") == 0) { 307 /* 308 * Start the service daemon. This daemon accepts 309 * connections from local and remote clients, handles 310 * the security handshake, and manages the core messaging 311 * protocol. 312 */ 313 ecode = cmd_service(); 314 } else if (strcmp(av[0], "stat") == 0) { 315 ecode = cmd_stat(ac - 1, (const char **)(void *)&av[1]); 316 } else if (strcmp(av[0], "leaf") == 0) { 317 /* 318 * Start the management daemon for a specific PFS. 319 * 320 * This will typically connect to the local master node 321 * daemon, register the PFS, and then pass its side of 322 * the socket descriptor to the kernel HAMMER2 VFS via an 323 * ioctl(). The process and/or thread context remains in the 324 * kernel until the PFS is unmounted or the connection is 325 * lost, then returns from the ioctl. 326 * 327 * It is possible to connect directly to a remote master node 328 * instead of the local master node in situations where 329 * encryption is not desired or no local master node is 330 * desired. This is not recommended because it represents 331 * a single point of failure for the PFS's communications. 332 * 333 * Direct kernel<->kernel communication between HAMMER2 VFSs 334 * is theoretically possible for directly-connected 335 * registrations (i.e. where the spanning tree is degenerate), 336 * but not recommended. We specifically try to reduce the 337 * complexity of the HAMMER2 VFS kernel code. 338 */ 339 ecode = cmd_leaf(sel_path); 340 } else if (strcmp(av[0], "shell") == 0) { 341 /* 342 * Connect to the command line monitor in the hammer2 master 343 * node for the machine using HAMMER2_DBG_SHELL messages. 344 */ 345 ecode = cmd_shell((ac < 2) ? NULL : av[1]); 346 } else if (strcmp(av[0], "rsainit") == 0) { 347 /* 348 * Initialize a RSA keypair. If no target directory is 349 * specified we default to "/etc/hammer2". 350 */ 351 arg = (ac < 2) ? HAMMER2_DEFAULT_DIR : av[1]; 352 ecode = cmd_rsainit(arg); 353 } else if (strcmp(av[0], "rsaenc") == 0) { 354 /* 355 * Encrypt the input symmetrically by running it through 356 * the specified public and/or private key files. 357 * 358 * If no key files are specified data is encoded using 359 * "/etc/hammer2/rsa.pub". 360 * 361 * WARNING: no padding is added, data stream must contain 362 * random padding for this to be secure. 363 * 364 * Used for debugging only 365 */ 366 if (ac == 1) { 367 const char *rsapath = HAMMER2_DEFAULT_DIR "/rsa.pub"; 368 ecode = cmd_rsaenc(&rsapath, 1); 369 } else { 370 ecode = cmd_rsaenc((const char **)(void *)&av[1], 371 ac - 1); 372 } 373 } else if (strcmp(av[0], "rsadec") == 0) { 374 /* 375 * Decrypt the input symmetrically by running it through 376 * the specified public and/or private key files. 377 * 378 * If no key files are specified data is decoded using 379 * "/etc/hammer2/rsa.prv". 380 * 381 * WARNING: no padding is added, data stream must contain 382 * random padding for this to be secure. 383 * 384 * Used for debugging only 385 */ 386 if (ac == 1) { 387 const char *rsapath = HAMMER2_DEFAULT_DIR "/rsa.prv"; 388 ecode = cmd_rsadec(&rsapath, 1); 389 } else { 390 ecode = cmd_rsadec((const char **)(void *)&av[1], 391 ac - 1); 392 } 393 } else if (strcmp(av[0], "show") == 0) { 394 /* 395 * Raw dump of filesystem. Use -v to check all crc's, and 396 * -vv to dump bulk file data. 397 */ 398 if (ac != 2) { 399 fprintf(stderr, "show: requires device path\n"); 400 usage(1); 401 } else { 402 cmd_show(av[1], 0); 403 } 404 } else if (strcmp(av[0], "freemap") == 0) { 405 /* 406 * Raw dump of freemap. Use -v to check all crc's, and 407 * -vv to dump bulk file data. 408 */ 409 if (ac != 2) { 410 fprintf(stderr, "freemap: requires device path\n"); 411 usage(1); 412 } else { 413 cmd_show(av[1], 1); 414 } 415 } else if (strcmp(av[0], "setcomp") == 0) { 416 if (ac < 3) { 417 /* 418 * Missing compression method and at least one 419 * path. 420 */ 421 fprintf(stderr, 422 "setcomp: requires compression method and" 423 "directory/file path\n"); 424 usage(1); 425 } else { 426 /* 427 * Multiple paths may be specified 428 */ 429 ecode = cmd_setcomp(av[1], &av[2]); 430 } 431 } else if (strcmp(av[0], "setcheck") == 0) { 432 if (ac < 3) { 433 /* 434 * Missing compression method and at least one 435 * path. 436 */ 437 fprintf(stderr, 438 "setcheck: requires check code method and" 439 "directory/file path\n"); 440 usage(1); 441 } else { 442 /* 443 * Multiple paths may be specified 444 */ 445 ecode = cmd_setcheck(av[1], &av[2]); 446 } 447 } else if (strcmp(av[0], "clrcheck") == 0) { 448 ecode = cmd_setcheck("none", &av[1]); 449 } else if (strcmp(av[0], "setcrc32") == 0) { 450 ecode = cmd_setcheck("crc32", &av[1]); 451 } else if (strcmp(av[0], "setxxhash64") == 0) { 452 ecode = cmd_setcheck("xxhash64", &av[1]); 453 } else if (strcmp(av[0], "setsha192") == 0) { 454 ecode = cmd_setcheck("sha192", &av[1]); 455 } else if (strcmp(av[0], "printinode") == 0) { 456 if (ac != 2) { 457 fprintf(stderr, 458 "printinode: requires directory/file path\n"); 459 usage(1); 460 } else { 461 print_inode(av[1]); 462 } 463 } else if (strcmp(av[0], "bulkfree") == 0) { 464 if (ac != 2) { 465 fprintf(stderr, 466 "bulkfree: requires path to mount\n"); 467 usage(1); 468 } else { 469 ecode = cmd_bulkfree(av[1]); 470 } 471 #if 0 472 } else if (strcmp(av[0], "bulkfree-async") == 0) { 473 if (ac != 2) { 474 fprintf(stderr, 475 "bulkfree-async: requires path to mount\n"); 476 usage(1); 477 } else { 478 ecode = cmd_bulkfree_async(av[1]); 479 } 480 #endif 481 } else if (strcmp(av[0], "cleanup") == 0) { 482 ecode = cmd_cleanup(av[1]); /* can be NULL */ 483 } else { 484 fprintf(stderr, "Unrecognized command: %s\n", av[0]); 485 usage(1); 486 } 487 488 /* 489 * In DebugMode we may wind up starting several pthreads in the 490 * original process, in which case we have to let them run and 491 * not actually exit. 492 */ 493 if (NormalExit) { 494 return (ecode); 495 } else { 496 pthread_exit(NULL); 497 _exit(2); /* NOT REACHED */ 498 } 499 } 500 501 static 502 void 503 usage(int code) 504 { 505 fprintf(stderr, 506 "hammer2 [options] command...\n" 507 " -s path Select filesystem\n" 508 " -t type PFS type for pfs-create\n" 509 " -u uuid uuid for pfs-create\n" 510 " -m mem[k,m,g] buffer memory (bulkfree)\n" 511 "\n" 512 " cleanup [<path>...] " 513 "Run cleanup passes\n" 514 " connect <target> " 515 "Add cluster link\n" 516 " debugspan <target> " 517 "Debug spanning tree\n" 518 " dumpchain <path> [chnflags] " 519 "Dump in-memory chain topo from\n" 520 "NOTE: ONFLUSH flag is 0x200\n" 521 " destroy <path>* " 522 "Destroy directory entries (only use if inode bad)\n" 523 " destroy-inum <inum>* " 524 "Destroy inodes (only use if inode bad)\n" 525 " disconnect <target> " 526 "Del cluster link\n" 527 " hash filename* " 528 "Print directory hash\n" 529 " info [devpath...] " 530 "Info on all offline or online H2 partitions\n" 531 " mountall [devpath...] " 532 "Mount @LOCAL for all H2 partitions\n" 533 " status [<path>...] " 534 "Report active cluster status\n" 535 " pfs-list [<path>...] " 536 "List PFSs\n" 537 " pfs-clid <label> " 538 "Print cluster id for specific PFS\n" 539 " pfs-fsid <label> " 540 "Print private id for specific PFS\n" 541 " pfs-create <label> " 542 "Create a PFS\n" 543 " pfs-delete <label> " 544 "Destroy a PFS\n" 545 " snapshot <path> [<label>] " 546 "Snapshot a PFS or directory\n" 547 " snapshot-debug <path> [<label>] " 548 "Snapshot without filesystem sync\n" 549 " service " 550 "Start service daemon\n" 551 " stat [<path>] " 552 "Return inode quota & config\n" 553 " leaf " 554 "Start pfs leaf daemon\n" 555 " shell [<host>] " 556 "Connect to debug shell\n" 557 " debugspan <target> " 558 "Connect to target, run CONN/SPAN\n" 559 " rsainit " 560 "Initialize rsa fields\n" 561 " show devpath " 562 "Raw hammer2 media dump\n" 563 " freemap devpath " 564 "Raw hammer2 media dump\n" 565 " setcomp comp[:level] path... " 566 "Set comp algo {none, autozero, lz4, zlib} & level\n" 567 " setcheck check path... " 568 "Set check algo {none, crc32, xxhash64, sha192}\n" 569 " clrcheck path... " 570 "Clear check code override\n" 571 " setcrc32 path... " 572 "Set check algo to crc32\n" 573 " setxxhash64 path... " 574 "Set check algo to xxhash64\n" 575 " setsha192 path... " 576 "Set check algo to sha192\n" 577 " bulkfree path... " 578 "Run bulkfree pass\n" 579 #if 0 580 " bulkfree-async path... " 581 "Run bulkfree pass asynchronously\n" 582 #endif 583 ); 584 exit(code); 585 } 586