git.sesse.net Git - bcachefs-tools-debian/blob - bcachefs.c

   1 /*
   2  * Authors: Kent Overstreet <kent.overstreet@gmail.com>
   3  *          Gabriel de Perthuis <g2p.code@gmail.com>
   4  *          Jacob Malevich <jam@datera.io>
   5  *
   6  * GPLv2
   7  */
   8
   9 #include <stdlib.h>
  10 #include <stdio.h>
  11 #include <ctype.h>
  12 #include <errno.h>
  13 #include <inttypes.h>
  14 #include <limits.h>
  15 #include <fcntl.h>
  16 #include <unistd.h>
  17 #include <stdbool.h>
  18 #include <stdint.h>
  19 #include <string.h>
  20 #include <sys/ioctl.h>
  21 #include <sys/types.h>
  22 #include <sys/stat.h>
  23
  24 #include <raid/raid.h>
  25
  26 #include "cmds.h"
  27
  28 static void usage(void)
  29 {
  30         puts("bcachefs - tool for managing bcachefs filesystems\n"
  31              "usage: bcachefs <command> [<args>]\n"
  32              "\n"
  33              "Superblock commands:\n"
  34              "  format                   Format a new filesystem\n"
  35              "  show-super               Dump superblock information to stdout\n"
  36              "  set-option               Set a filesystem option\n"
  37              "  reset-counters           Reset all counters on an unmounted device\n"
  38              "\n"
  39 #ifndef BCACHEFS_NO_RUST
  40              "Mount:\n"
  41              "  mount                    Mount a filesystem\n"
  42              "\n"
  43 #endif
  44              "Repair:\n"
  45              "  fsck                     Check an existing filesystem for errors\n"
  46              "\n"
  47 #if 0
  48              "Startup/shutdown, assembly of multi device filesystems:\n"
  49              "  assemble                 Assemble an existing multi device filesystem\n"
  50              "  incremental              Incrementally assemble an existing multi device filesystem\n"
  51              "  run                      Start a partially assembled filesystem\n"
  52              "  stop                     Stop a running filesystem\n"
  53              "\n"
  54 #endif
  55              "Commands for managing a running filesystem:\n"
  56              "  fs usage                 Show disk usage\n"
  57              "\n"
  58              "Commands for managing devices within a running filesystem:\n"
  59              "  device add               Add a new device to an existing filesystem\n"
  60              "  device remove            Remove a device from an existing filesystem\n"
  61              "  device online            Re-add an existing member to a filesystem\n"
  62              "  device offline           Take a device offline, without removing it\n"
  63              "  device evacuate          Migrate data off of a specific device\n"
  64              "  device set-state         Mark a device as failed\n"
  65              "  device resize            Resize filesystem on a device\n"
  66              "  device resize-journal    Resize journal on a device\n"
  67              "\n"
  68              "Commands for managing subvolumes and snapshots:\n"
  69              "  subvolume create         Create a new subvolume\n"
  70              "  subvolume delete         Delete an existing subvolume\n"
  71              "  subvolume snapshot       Create a snapshot\n"
  72              "\n"
  73              "Commands for managing filesystem data:\n"
  74              "  data rereplicate         Rereplicate degraded data\n"
  75              "  data job                 Kick off low level data jobs\n"
  76              "\n"
  77              "Encryption:\n"
  78              "  unlock                   Unlock an encrypted filesystem prior to running/mounting\n"
  79              "  set-passphrase           Change passphrase on an existing (unmounted) filesystem\n"
  80              "  remove-passphrase        Remove passphrase on an existing (unmounted) filesystem\n"
  81              "\n"
  82              "Migrate:\n"
  83              "  migrate                  Migrate an existing filesystem to bcachefs, in place\n"
  84              "  migrate-superblock       Add default superblock, after bcachefs migrate\n"
  85              "\n"
  86              "Commands for operating on files in a bcachefs filesystem:\n"
  87              "  setattr                  Set various per file attributes\n"
  88              "\n"
  89              "Debug:\n"
  90              "These commands work on offline, unmounted filesystems\n"
  91              "  dump                     Dump filesystem metadata to a qcow2 image\n"
  92 #ifndef BCACHEFS_NO_RUST
  93              "  list                     List filesystem metadata in textual form\n"
  94 #endif
  95              "  list_journal             List contents of journal\n"
  96              "\n"
  97              "FUSE:\n"
  98              "  fusemount                Mount a filesystem via FUSE\n"
  99              "\n"
 100              "Miscellaneous:\n"
 101 #ifndef BCACHEFS_NO_RUST
 102          "  completions              Generate shell completions\n"
 103 #endif
 104              "  version                  Display the version of the invoked bcachefs tool\n");
 105 }
 106
 107 static char *pop_cmd(int *argc, char *argv[])
 108 {
 109         char *cmd = argv[1];
 110         if (!(*argc < 2))
 111                 memmove(&argv[1], &argv[2], (*argc - 2) * sizeof(argv[0]));
 112         (*argc)--;
 113         argv[*argc] = NULL;
 114
 115         return cmd;
 116 }
 117
 118 static int fs_cmds(int argc, char *argv[])
 119 {
 120         char *cmd = pop_cmd(&argc, argv);
 121
 122         if (argc < 1) {
 123                 usage();
 124                 exit(EXIT_FAILURE);
 125         }
 126         if (!strcmp(cmd, "usage"))
 127                 return cmd_fs_usage(argc, argv);
 128
 129         return 0;
 130 }
 131
 132 static int device_cmds(int argc, char *argv[])
 133 {
 134         char *cmd = pop_cmd(&argc, argv);
 135
 136         if (argc < 1)
 137                 return device_usage();
 138         if (!strcmp(cmd, "add"))
 139                 return cmd_device_add(argc, argv);
 140         if (!strcmp(cmd, "remove"))
 141                 return cmd_device_remove(argc, argv);
 142         if (!strcmp(cmd, "online"))
 143                 return cmd_device_online(argc, argv);
 144         if (!strcmp(cmd, "offline"))
 145                 return cmd_device_offline(argc, argv);
 146         if (!strcmp(cmd, "evacuate"))
 147                 return cmd_device_evacuate(argc, argv);
 148         if (!strcmp(cmd, "set-state"))
 149                 return cmd_device_set_state(argc, argv);
 150         if (!strcmp(cmd, "resize"))
 151                 return cmd_device_resize(argc, argv);
 152         if (!strcmp(cmd, "resize-journal"))
 153                 return cmd_device_resize_journal(argc, argv);
 154
 155         return 0;
 156 }
 157
 158 static int data_cmds(int argc, char *argv[])
 159 {
 160         char *cmd = pop_cmd(&argc, argv);
 161
 162         if (argc < 1)
 163                 return data_usage();
 164         if (!strcmp(cmd, "rereplicate"))
 165                 return cmd_data_rereplicate(argc, argv);
 166         if (!strcmp(cmd, "job"))
 167                 return cmd_data_job(argc, argv);
 168
 169         return 0;
 170 }
 171
 172 static int subvolume_cmds(int argc, char *argv[])
 173 {
 174         char *cmd = pop_cmd(&argc, argv);
 175         if (argc < 1)
 176                 return subvolume_usage();
 177         if (!strcmp(cmd, "create"))
 178                 return cmd_subvolume_create(argc, argv);
 179         if (!strcmp(cmd, "delete"))
 180                 return cmd_subvolume_delete(argc, argv);
 181         if (!strcmp(cmd, "snapshot"))
 182                 return cmd_subvolume_snapshot(argc, argv);
 183
 184         return 0;
 185 }
 186
 187 int main(int argc, char *argv[])
 188 {
 189         raid_init();
 190
 191         char *full_cmd = argv[0];
 192
 193         /* Are we being called via a symlink? */
 194
 195         if (strstr(full_cmd, "mkfs"))
 196                 return cmd_format(argc, argv);
 197
 198         if (strstr(full_cmd, "fsck"))
 199                 return cmd_fsck(argc, argv);
 200
 201 #ifdef BCACHEFS_FUSE
 202         if (strstr(full_cmd, "mount.fuse"))
 203                 return cmd_fusemount(argc, argv);
 204 #endif
 205
 206 #ifndef BCACHEFS_NO_RUST
 207         if (strstr(full_cmd, "mount"))
 208                 return rust_main(argc, argv, "mount");
 209 #endif
 210
 211         setvbuf(stdout, NULL, _IOLBF, 0);
 212
 213         char *cmd = pop_cmd(&argc, argv);
 214         if (!cmd) {
 215                 puts("missing command\n");
 216                 goto usage;
 217         }
 218
 219         /* these subcommands display usage when argc < 2 */
 220         if (!strcmp(cmd, "device"))
 221                 return device_cmds(argc, argv);
 222         if (!strcmp(cmd, "fs"))
 223                 return fs_cmds(argc, argv);
 224         if (!strcmp(cmd, "data"))
 225                 return data_cmds(argc, argv);
 226         if (!strcmp(cmd, "subvolume"))
 227                 return subvolume_cmds(argc, argv);
 228         if (!strcmp(cmd, "format"))
 229                 return cmd_format(argc, argv);
 230         if (!strcmp(cmd, "fsck"))
 231                 return cmd_fsck(argc, argv);
 232         if (!strcmp(cmd, "version"))
 233                 return cmd_version(argc, argv);
 234         if (!strcmp(cmd, "show-super"))
 235                 return cmd_show_super(argc, argv);
 236         if (!strcmp(cmd, "set-option"))
 237                 return cmd_set_option(argc, argv);
 238         if (!strcmp(cmd, "reset-counters"))
 239                 return cmd_reset_counters(argc, argv);
 240
 241 #if 0
 242         if (!strcmp(cmd, "assemble"))
 243                 return cmd_assemble(argc, argv);
 244         if (!strcmp(cmd, "incremental"))
 245                 return cmd_incremental(argc, argv);
 246         if (!strcmp(cmd, "run"))
 247                 return cmd_run(argc, argv);
 248         if (!strcmp(cmd, "stop"))
 249                 return cmd_stop(argc, argv);
 250 #endif
 251
 252         if (!strcmp(cmd, "unlock"))
 253                 return cmd_unlock(argc, argv);
 254         if (!strcmp(cmd, "set-passphrase"))
 255                 return cmd_set_passphrase(argc, argv);
 256         if (!strcmp(cmd, "remove-passphrase"))
 257                 return cmd_remove_passphrase(argc, argv);
 258
 259         if (!strcmp(cmd, "migrate"))
 260                 return cmd_migrate(argc, argv);
 261         if (!strcmp(cmd, "migrate-superblock"))
 262                 return cmd_migrate_superblock(argc, argv);
 263
 264         if (!strcmp(cmd, "dump"))
 265                 return cmd_dump(argc, argv);
 266         if (!strcmp(cmd, "list_journal"))
 267                 return cmd_list_journal(argc, argv);
 268         if (!strcmp(cmd, "kill_btree_node"))
 269                 return cmd_kill_btree_node(argc, argv);
 270
 271         if (!strcmp(cmd, "setattr"))
 272                 return cmd_setattr(argc, argv);
 273 #ifndef BCACHEFS_NO_RUST
 274         if (!strcmp(cmd, "list") ||
 275             !strcmp(cmd, "mount") ||
 276             !strcmp(cmd, "completions"))
 277                 return rust_main(argc, argv, cmd);
 278 #endif
 279
 280 #ifdef BCACHEFS_FUSE
 281         if (!strcmp(cmd, "fusemount"))
 282                 return cmd_fusemount(argc, argv);
 283 #endif
 284
 285         if (!strcmp(cmd, "--help")) {
 286                 usage();
 287                 return 0;
 288         }
 289
 290         printf("Unknown command %s\n", cmd);
 291 usage:
 292         usage();
 293         exit(EXIT_FAILURE);
 294 }