sbin/hammer/cmd_snapshot.c

   1 /*
   2  * Copyright (c) 2008 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@backplane.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $DragonFly: src/sbin/hammer/cmd_snapshot.c,v 1.7 2008/07/10 18:47:22 mneumann Exp $
  35  */
  36
  37 #include "hammer.h"
  38 #include <sys/param.h>
  39 #include <sys/mount.h>
  40 #include <sys/types.h>
  41 #include <sys/stat.h>
  42 #include <unistd.h>
  43 #include <string.h>
  44 #include <time.h>
  45
  46 #define DEFAULT_SNAPSHOT_NAME "snap-%Y%m%d-%H%M"
  47
  48 static void snapshot_usage(int exit_code);
  49 static void snapshot_add(int fd, const char *fsym, const char *tsym,
  50                 const char *label, hammer_tid_t tid);
  51 static void snapshot_ls(const char *path);
  52 static void snapshot_del(int fsfd, hammer_tid_t tid);
  53 static char *dirpart(const char *path);
  54
  55 /*
  56  * hammer snap path ["note"]
  57  *
  58  * Path may be a directory, softlink, or non-existant (a softlink will be
  59  * created).
  60  */
  61 void
  62 hammer_cmd_snap(char **av, int ac, int tostdout, int fsbase)
  63 {
  64         struct hammer_ioc_synctid synctid;
  65         struct hammer_ioc_version version;
  66         char *dirpath;
  67         char *fsym;
  68         char *tsym;
  69         struct stat st;
  70         char note[64];
  71         int fsfd;
  72
  73         if (ac == 0 || ac > 2) {
  74                 snapshot_usage(1);
  75                 /* not reached */
  76                 exit(1);
  77         }
  78
  79         if (ac == 2)
  80                 snprintf(note, sizeof(note), "%s", av[1]);
  81         else
  82                 note[0] = 0;
  83
  84         /*
  85          * Figure out the softlink path and directory path
  86          */
  87         if (stat(av[0], &st) < 0) {
  88                 dirpath = dirpart(av[0]);
  89                 tsym = av[0];
  90         } else if (S_ISLNK(st.st_mode)) {
  91                 dirpath = dirpart(av[0]);
  92                 tsym = av[0];
  93         } else if (S_ISDIR(st.st_mode)) {
  94                 time_t t = time(NULL);
  95                 struct tm *tp;
  96                 char extbuf[64];
  97
  98                 tp = localtime(&t);
  99                 strftime(extbuf, sizeof(extbuf), DEFAULT_SNAPSHOT_NAME, tp);
 100
 101                 dirpath = strdup(av[0]);
 102                 asprintf(&tsym, "%s/%s", dirpath, extbuf);
 103         } else {
 104                 err(2, "hammer snap: File %s exists and is not a softlink\n",
 105                     av[0]);
 106                 /* not reached */
 107         }
 108
 109         /*
 110          * Get a handle on some directory in the filesystem for the
 111          * ioctl (so it is stored in the correct PFS).
 112          */
 113         fsfd = open(dirpath, O_RDONLY);
 114         if (fsfd < 0) {
 115                 err(2, "hammder snap: Cannot open directory %s\n", dirpath);
 116                 /* not reached */
 117         }
 118
 119         /*
 120          * Must be at least version 3 to use this command.
 121          */
 122         bzero(&version, sizeof(version));
 123
 124         if (ioctl(fsfd, HAMMERIOC_GET_VERSION, &version) < 0) {
 125                 err(2, "Unable to create snapshot");
 126                 /* not reached */
 127         } else if (version.cur_version < 3) {
 128                 errx(2, "Unable to create snapshot: This directive requires "
 129                         "you to upgrade the filesystem\n"
 130                         "to version 3.  Use 'hammer snapshot' for legacy "
 131                         "operation");
 132                 /* not reached */
 133         }
 134
 135         /*
 136          * Synctid to get a transaction id for the snapshot.
 137          */
 138         bzero(&synctid, sizeof(synctid));
 139         synctid.op = HAMMER_SYNCTID_SYNC2;
 140         if (ioctl(fsfd, HAMMERIOC_SYNCTID, &synctid) < 0) {
 141                 err(2, "hammer snap: Synctid %s failed",
 142                     dirpath);
 143         }
 144         if (tostdout) {
 145                 printf("%s/@@%016jx\n", dirpath, (uintmax_t)synctid.tid);
 146                 fsym = NULL;
 147                 tsym = NULL;
 148         }
 149
 150         /*
 151          * Contents of the symlink being created.
 152          */
 153         if (fsbase) {
 154                 struct statfs buf;
 155
 156                 if (statfs(dirpath, &buf) < 0) {
 157                         err(2, "hammer snapfs: Cannot determine mount for %s",
 158                             dirpath);
 159                 }
 160                 asprintf(&fsym, "%s/@@0x%016jx",
 161                          buf.f_mntonname, (uintmax_t)synctid.tid);
 162         } else {
 163                 asprintf(&fsym, "%s/@@0x%016jx",
 164                          dirpath, (uintmax_t)synctid.tid);
 165         }
 166
 167         /*
 168          * Create the snapshot.
 169          */
 170         snapshot_add(fsfd, fsym, tsym, note, synctid.tid);
 171         free(dirpath);
 172 }
 173
 174 /*
 175  * hammer snapls [path]*
 176  *
 177  * If no arguments are specified snapshots for the PFS containing the
 178  * current directory are listed.
 179  */
 180 void
 181 hammer_cmd_snapls(char **av, int ac)
 182 {
 183         int i;
 184
 185         for (i = 0; i < ac; ++i)
 186                 snapshot_ls(av[i]);
 187         if (ac == 0)
 188                 snapshot_ls(".");
 189 }
 190
 191 /*
 192  * hammer snaprm [fsdir] [path/transid]*
 193  */
 194 void
 195 hammer_cmd_snaprm(char **av, int ac)
 196 {
 197         struct stat st;
 198         char linkbuf[1024];
 199         intmax_t tid;
 200         int fsfd = -1;
 201         int i;
 202         char *dirpath;
 203         char *ptr;
 204
 205         for (i = 0; i < ac; ++i) {
 206                 if (lstat(av[i], &st) < 0) {
 207                         tid = strtoull(av[i], &ptr, 16);
 208                         if (tid == 0 || *ptr) {
 209                                 err(2, "hammer snaprm: not a file or tid: %s",
 210                                     av[i]);
 211                                 /* not reached */
 212                         }
 213                         snapshot_del(fsfd, tid);
 214                 } else if (S_ISDIR(st.st_mode)) {
 215                         if (fsfd >= 0)
 216                                 close(fsfd);
 217                         fsfd = open(av[i], O_RDONLY);
 218                         if (fsfd < 0) {
 219                                 err(2, "hammer snaprm: cannot open dir %s",
 220                                     av[i]);
 221                                 /* not reached */
 222                         }
 223                 } else if (S_ISLNK(st.st_mode)) {
 224                         dirpath = dirpart(av[i]);
 225                         if (fsfd >= 0)
 226                                 close(fsfd);
 227                         fsfd = open(dirpath, O_RDONLY);
 228                         if (fsfd < 0) {
 229                                 err(2, "hammer snaprm: cannot open dir %s",
 230                                     dirpath);
 231                                 /* not reached */
 232                         }
 233
 234                         bzero(linkbuf, sizeof(linkbuf));
 235                         if (readlink(av[i], linkbuf, sizeof(linkbuf) - 1) < 0) {
 236                                 err(2, "hammer snaprm: cannot read softlink: "
 237                                        "%s", av[i]);
 238                                 /* not reached */
 239                         }
 240                         if ((ptr = strrchr(linkbuf, '@')) &&
 241                             ptr > linkbuf && ptr[-1] == '@') {
 242                                 tid = strtoull(ptr + 1, NULL, 16);
 243                                 snapshot_del(fsfd, tid);
 244                         }
 245                         remove(av[i]);
 246                         free(dirpath);
 247                 } else {
 248                         err(2, "hammer snaprm: not directory or snapshot "
 249                                "softlink: %s", av[i]);
 250                         /* not reached */
 251                 }
 252         }
 253         if (fsfd >= 0)
 254                 close(fsfd);
 255 }
 256
 257 /*
 258  * snapshot <softlink-dir-in-filesystem>
 259  * snapshot <filesystem> <softlink-dir>
 260  */
 261 void
 262 hammer_cmd_snapshot(char **av, int ac)
 263 {
 264         const char *filesystem;
 265         const char *softlink_dir;
 266         char *softlink_fmt;
 267         struct statfs buf;
 268         struct stat st;
 269         struct hammer_ioc_synctid synctid;
 270         char *from;
 271         char *to;
 272         char *note = NULL;
 273
 274         if (ac == 1) {
 275                 filesystem = NULL;
 276                 softlink_dir = av[0];
 277         } else if (ac == 2) {
 278                 filesystem = av[0];
 279                 softlink_dir = av[1];
 280         } else if (ac == 3) {
 281                 filesystem = av[0];
 282                 softlink_dir = av[1];
 283                 note = av[2];
 284         } else {
 285                 snapshot_usage(1);
 286                 /* not reached */
 287                 softlink_dir = NULL;
 288                 filesystem = NULL;
 289         }
 290
 291         if (stat(softlink_dir, &st) == 0) {
 292                 if (!S_ISDIR(st.st_mode))
 293                         err(2, "File %s already exists", softlink_dir);
 294
 295                 if (filesystem == NULL) {
 296                         if (statfs(softlink_dir, &buf) != 0) {
 297                                 err(2, "Unable to determine filesystem of %s",
 298                                     softlink_dir);
 299                         }
 300                         filesystem = buf.f_mntonname;
 301                 }
 302
 303                 softlink_fmt = malloc(strlen(softlink_dir) + 1 + 1 +
 304                                       sizeof(DEFAULT_SNAPSHOT_NAME));
 305                 if (softlink_fmt == NULL)
 306                         err(2, "Failed to allocate string");
 307
 308                 strcpy(softlink_fmt, softlink_dir);
 309                 if (softlink_fmt[strlen(softlink_fmt)-1] != '/')
 310                         strcat(softlink_fmt, "/");
 311                 strcat(softlink_fmt, DEFAULT_SNAPSHOT_NAME);
 312         } else {
 313                 softlink_fmt = strdup(softlink_dir);
 314
 315                 if (filesystem == NULL) {
 316                         /*
 317                          * strip-off last '/path' segment to get the softlink
 318                          * directory, which we need to determine the filesystem
 319                          * we are on.
 320                          */
 321                         char *pos = strrchr(softlink_fmt, '/');
 322                         if (pos != NULL)
 323                                 *pos = '\0';
 324
 325                         if (stat(softlink_fmt, &st) != 0 ||
 326                             !S_ISDIR(st.st_mode)) {
 327                                 err(2, "Unable to determine softlink dir %s",
 328                                     softlink_fmt);
 329                         }
 330                         if (statfs(softlink_fmt, &buf) != 0) {
 331                                 err(2, "Unable to determine filesystem of %s",
 332                                     softlink_fmt);
 333                         }
 334                         filesystem = buf.f_mntonname;
 335
 336                         /* restore '/' */
 337                         if (pos != NULL)
 338                                 *pos = '/';
 339                 }
 340         }
 341
 342         /*
 343          * Synctid
 344          */
 345         bzero(&synctid, sizeof(synctid));
 346         synctid.op = HAMMER_SYNCTID_SYNC2;
 347
 348         int fd = open(filesystem, O_RDONLY);
 349         if (fd < 0)
 350                 err(2, "Unable to open %s", filesystem);
 351         if (ioctl(fd, HAMMERIOC_SYNCTID, &synctid) < 0)
 352                 err(2, "Synctid %s failed", filesystem);
 353
 354         asprintf(&from, "%s/@@0x%016jx", filesystem, (uintmax_t)synctid.tid);
 355         if (from == NULL)
 356                 err(2, "Couldn't generate string");
 357
 358         int sz = strlen(softlink_fmt) + 50;
 359         to = malloc(sz);
 360         if (to == NULL)
 361                 err(2, "Failed to allocate string");
 362
 363         time_t t = time(NULL);
 364         if (strftime(to, sz, softlink_fmt, localtime(&t)) == 0)
 365                 err(2, "String buffer too small");
 366
 367         asprintf(&from, "%s/@@0x%016jx", filesystem, (uintmax_t)synctid.tid);
 368
 369         snapshot_add(fd, from, to, note, synctid.tid);
 370
 371         close(fd);
 372         printf("%s\n", to);
 373
 374         free(softlink_fmt);
 375         free(from);
 376         free(to);
 377 }
 378
 379 static
 380 void
 381 snapshot_add(int fd, const char *fsym, const char *tsym, const char *label,
 382              hammer_tid_t tid)
 383 {
 384         struct hammer_ioc_version version;
 385         struct hammer_ioc_snapshot snapshot;
 386
 387         bzero(&version, sizeof(version));
 388         bzero(&snapshot, sizeof(snapshot));
 389
 390         /*
 391          * For HAMMER filesystem v3+ the snapshot is recorded in meta-data.
 392          */
 393         if (ioctl(fd, HAMMERIOC_GET_VERSION, &version) == 0 &&
 394             version.cur_version >= 3) {
 395                 snapshot.index = 0;
 396                 snapshot.count = 1;
 397                 snapshot.snaps[0].tid = tid;
 398                 snapshot.snaps[0].ts = time(NULL) * 1000000ULL;
 399                 if (label) {
 400                         snprintf(snapshot.snaps[0].label,
 401                                  sizeof(snapshot.snaps[0].label),
 402                                  "%s",
 403                                  label);
 404                 }
 405                 if (ioctl(fd, HAMMERIOC_ADD_SNAPSHOT, &snapshot) < 0) {
 406                         err(2, "Unable to create snapshot");
 407                 } else if (snapshot.head.error &&
 408                            snapshot.head.error != EEXIST) {
 409                         errx(2, "Unable to create snapshot: %s\n",
 410                                 strerror(snapshot.head.error));
 411                 }
 412         }
 413
 414         /*
 415          * Create a symlink for the snapshot.  If a file exists with the same
 416          * name the new symlink will replace it.
 417          */
 418         if (fsym && tsym) {
 419                 remove(tsym);
 420                 if (symlink(fsym, tsym) < 0) {
 421                         err(2, "Unable to create symlink %s", tsym);
 422                 }
 423         }
 424 }
 425
 426 static
 427 void
 428 snapshot_ls(const char *path)
 429 {
 430         /*struct hammer_ioc_version version;*/
 431         struct hammer_ioc_snapshot snapshot;
 432         struct hammer_ioc_pseudofs_rw pfs;
 433         struct hammer_snapshot_data *snap;
 434         struct tm *tp;
 435         time_t t;
 436         u_int32_t i;
 437         int fd;
 438         char snapts[64];
 439
 440         fd = open(path, O_RDONLY);
 441         if (fd < 0) {
 442                 err(2, "hammer snapls: cannot open %s", path);
 443                 /* not reached */
 444         }
 445
 446         bzero(&pfs, sizeof(pfs));
 447         pfs.pfs_id = -1;
 448         pfs.bytes = sizeof(struct hammer_pseudofs_data);
 449         if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) < 0) {
 450                 err(2, "hammer snapls: cannot retrieve PFS info on %s", path);
 451                 /* not reached */
 452         }
 453
 454         printf("snapshots on pfs %d\n", pfs.pfs_id);
 455
 456         bzero(&snapshot, sizeof(snapshot));
 457         do {
 458                 if (ioctl(fd, HAMMERIOC_GET_SNAPSHOT, &snapshot) < 0) {
 459                         err(2, "hammer snapls: %s: not HAMMER fs or "
 460                                 "version < 3", path);
 461                         /* not reached */
 462                 }
 463                 for (i = 0; i < snapshot.count; ++i) {
 464                         snap = &snapshot.snaps[i];
 465
 466                         t = snap->ts / 1000000ULL;
 467                         tp = localtime(&t);
 468                         strftime(snapts, sizeof(snapts),
 469                                  "%Y-%m-%d %H:%M:%S %Z", tp);
 470                         printf("0x%016jx\t%s\t%s\n",
 471                                 (uintmax_t)snap->tid, snapts, snap->label);
 472                 }
 473         } while (snapshot.head.error == 0 && snapshot.count);
 474 }
 475
 476 static
 477 void
 478 snapshot_del(int fsfd, hammer_tid_t tid)
 479 {
 480         struct hammer_ioc_snapshot snapshot;
 481         struct hammer_ioc_version version;
 482
 483         bzero(&version, sizeof(version));
 484
 485         if (ioctl(fsfd, HAMMERIOC_GET_VERSION, &version) < 0) {
 486                 err(2, "hammer snaprm 0x%016jx", (uintmax_t)tid);
 487         }
 488         if (version.cur_version < 3) {
 489                 errx(2, "hammer snaprm 0x%016jx: You must upgrade to version "
 490                         " 3 to use this directive", (uintmax_t)tid);
 491         }
 492
 493         bzero(&snapshot, sizeof(snapshot));
 494         snapshot.count = 1;
 495         snapshot.snaps[0].tid = tid;
 496
 497         if (ioctl(fsfd, HAMMERIOC_DEL_SNAPSHOT, &snapshot) < 0) {
 498                 err(2, "hammer snaprm 0x%016jx", (uintmax_t)tid);
 499         } else if (snapshot.head.error) {
 500                 fprintf(stderr, "hammer snaprm 0x%016jx: %s\n",
 501                         (uintmax_t)tid, strerror(snapshot.head.error));
 502         }
 503 }
 504
 505 static
 506 void
 507 snapshot_usage(int exit_code)
 508 {
 509         fprintf(stderr,
 510     "hammer snap path [\"note\"]\t- create snapshot & link, "
 511                                 "points to base of PFS mount\n"
 512     "hammer snaplo path [\"note\"]\t- create snapshot & link, "
 513                                 "points to target dir\n"
 514     "hammer snapq  path [\"note\"]\t- create snapshot, output path to stdout\n"
 515     "hammer snapls [<fs>]\t\t- list available snapshots.\n"
 516     "hammer snaprm [<fs>] [path/transid]*\t- delete snapshots.\n"
 517     "\n"
 518     "NOTE: Snapshots are created in filesystem meta-data, any directory\n"
 519     "      in a HAMMER filesystem or PFS may be specified.  If the path\n"
 520     "      specified does not exist this function will also create a\n"
 521     "      softlink.\n"
 522     "\n"
 523     "      When deleting snapshots transaction ids may be directly specified\n"
 524     "      or file paths to snapshoft softlinks may be specified.  If a\n"
 525     "      softlink is specified the softlink will also be deleted\n"
 526     "\n"
 527     "NOTE: The old 'hammer snapshot [<filesystem>] <snapshot-dir>' form\n"
 528     "      is still accepted but is a deprecated form.  This form will\n"
 529     "      work for older hammer versions.  The new forms only work for\n"
 530     "      HAMMER version 3 or later filesystems.  HAMMER can be upgraded\n"
 531     "      to version 3 in-place\n"
 532         );
 533         exit(exit_code);
 534 }
 535
 536 static
 537 char *
 538 dirpart(const char *path)
 539 {
 540         const char *ptr;
 541         char *res;
 542
 543         ptr = strrchr(path, '/');
 544         if (ptr) {
 545                 while (ptr > path && ptr[-1] == '/')
 546                         --ptr;
 547                 if (ptr == path)
 548                         ptr = NULL;
 549         }
 550         if (ptr == NULL) {
 551                 path = ".";
 552                 ptr = path + 1;
 553         }
 554         res = malloc(ptr - path + 1);
 555         bcopy(path, res, ptr - path);
 556         res[ptr - path] = 0;
 557         return(res);
 558 }