sbin/hammer2/main.c

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