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 <libhammer.h> 38 39 #include "hammer.h" 40 41 #define DEFAULT_SNAPSHOT_NAME "snap-%Y%m%d-%H%M" 42 43 static void snapshot_usage(int exit_code); 44 static void snapshot_add(int fd, const char *fsym, const char *tsym, 45 const char *label, hammer_tid_t tid); 46 static void snapshot_ls(const char *path); 47 static void snapshot_del(int fsfd, hammer_tid_t tid); 48 static char *dirpart(const char *path); 49 50 /* 51 * hammer snap <path> [<note>] 52 * 53 * Path may be a directory, softlink, or non-existent (a softlink will be 54 * created). 55 */ 56 void 57 hammer_cmd_snap(char **av, int ac, int tostdout, int fsbase) 58 { 59 struct hammer_ioc_synctid synctid; 60 struct hammer_ioc_version version; 61 char *dirpath; 62 char *fsym = NULL; 63 char *tsym = NULL; 64 struct stat st; 65 char note[64]; 66 int fsfd; 67 68 if (ac == 0 || ac > 2) { 69 snapshot_usage(1); 70 /* not reached */ 71 } 72 73 if (ac == 2) 74 snprintf(note, sizeof(note), "%s", av[1]); 75 else 76 note[0] = 0; 77 78 /* 79 * Figure out the softlink path and directory path 80 */ 81 if (stat(av[0], &st) < 0) { 82 dirpath = dirpart(av[0]); 83 tsym = strdup(av[0]); 84 } else if (S_ISDIR(st.st_mode)) { 85 time_t t = time(NULL); 86 struct tm *tp; 87 char extbuf[64]; 88 89 tp = localtime(&t); 90 strftime(extbuf, sizeof(extbuf), DEFAULT_SNAPSHOT_NAME, tp); 91 92 dirpath = strdup(av[0]); 93 asprintf(&tsym, "%s/%s", dirpath, extbuf); 94 } else { 95 err(2, "hammer snap: File %s exists and is not a directory\n", 96 av[0]); 97 /* not reached */ 98 } 99 100 /* 101 * Get a handle on some directory in the filesystem for the 102 * ioctl (so it is stored in the correct PFS). 103 */ 104 fsfd = open(dirpath, O_RDONLY); 105 if (fsfd < 0) { 106 err(2, "hammer snap: Cannot open directory %s\n", dirpath); 107 /* not reached */ 108 } 109 110 /* 111 * Must be at least version 3 to use this command. 112 */ 113 bzero(&version, sizeof(version)); 114 115 if (ioctl(fsfd, HAMMERIOC_GET_VERSION, &version) < 0) { 116 err(2, "Unable to create snapshot"); 117 /* not reached */ 118 } else if (version.cur_version < 3) { 119 errx(2, "Unable to create snapshot: This directive requires " 120 "you to upgrade\n" 121 "the filesystem to version 3. " 122 "Use 'hammer snapshot' for legacy operation."); 123 /* not reached */ 124 } 125 126 /* 127 * Synctid to get a transaction id for the snapshot. 128 */ 129 bzero(&synctid, sizeof(synctid)); 130 synctid.op = HAMMER_SYNCTID_SYNC2; 131 if (ioctl(fsfd, HAMMERIOC_SYNCTID, &synctid) < 0) { 132 err(2, "hammer snap: Synctid %s failed", 133 dirpath); 134 } 135 if (tostdout) { 136 if (strcmp(dirpath, ".") == 0 || strcmp(dirpath, "..") == 0) { 137 printf("%s/@@0x%016jx\n", 138 dirpath, (uintmax_t)synctid.tid); 139 } else { 140 printf("%s@@0x%016jx\n", 141 dirpath, (uintmax_t)synctid.tid); 142 } 143 fsym = NULL; 144 tsym = NULL; 145 } 146 147 /* 148 * Contents of the symlink being created. 149 */ 150 if (fsbase) { 151 struct statfs buf; 152 153 if (statfs(dirpath, &buf) < 0) { 154 err(2, "hammer snap: Cannot determine mount for %s", 155 dirpath); 156 } 157 asprintf(&fsym, "%s/@@0x%016jx", 158 buf.f_mntonname, (uintmax_t)synctid.tid); 159 } else if (strcmp(dirpath, ".") == 0 || strcmp(dirpath, "..") == 0) { 160 asprintf(&fsym, "%s/@@0x%016jx", 161 dirpath, (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 free(fsym); 173 free(tsym); 174 } 175 176 /* 177 * hammer snapls [<path> ...] 178 * 179 * If no arguments are specified snapshots for the PFS containing the 180 * current directory are listed. 181 */ 182 void 183 hammer_cmd_snapls(char **av, int ac) 184 { 185 int i; 186 187 for (i = 0; i < ac; ++i) 188 snapshot_ls(av[i]); 189 if (ac == 0) 190 snapshot_ls("."); 191 } 192 193 /* 194 * hammer snaprm <path> ... 195 * hammer snaprm <transid> ... 196 * hammer snaprm <filesystem> <transid> ... 197 */ 198 void 199 hammer_cmd_snaprm(char **av, int ac) 200 { 201 struct stat st; 202 char linkbuf[1024]; 203 intmax_t tid; 204 int fsfd = -1; 205 int i; 206 int delete; 207 enum snaprm_mode { none_m, path_m, tid_m } mode = none_m; 208 char *dirpath; 209 char *ptr, *ptr2; 210 211 if (ac == 0) { 212 snapshot_usage(1); 213 /* not reached */ 214 } 215 216 for (i = 0; i < ac; ++i) { 217 if (lstat(av[i], &st) < 0) { 218 tid = strtoull(av[i], &ptr, 16); 219 if (*ptr) { 220 err(2, "hammer snaprm: not a file or tid: %s", 221 av[i]); 222 /* not reached */ 223 } 224 if (mode == path_m) { 225 snapshot_usage(1); 226 /* not reached */ 227 } 228 mode = tid_m; 229 if (fsfd < 0) 230 fsfd = open(".", O_RDONLY); 231 snapshot_del(fsfd, tid); 232 } else if (S_ISDIR(st.st_mode)) { 233 if (i != 0 || ac < 2) { 234 snapshot_usage(1); 235 /* not reached */ 236 } 237 if (fsfd >= 0) 238 close(fsfd); 239 fsfd = open(av[i], O_RDONLY); 240 if (fsfd < 0) { 241 err(2, "hammer snaprm: cannot open dir %s", 242 av[i]); 243 /* not reached */ 244 } 245 mode = tid_m; 246 } else if (S_ISLNK(st.st_mode)) { 247 dirpath = dirpart(av[i]); 248 bzero(linkbuf, sizeof(linkbuf)); 249 if (readlink(av[i], linkbuf, sizeof(linkbuf) - 1) < 0) { 250 err(2, "hammer snaprm: cannot read softlink: " 251 "%s", av[i]); 252 /* not reached */ 253 } 254 if (linkbuf[0] == '/') { 255 free(dirpath); 256 dirpath = dirpart(linkbuf); 257 } else { 258 asprintf(&ptr, "%s/%s", dirpath, linkbuf); 259 free(dirpath); 260 dirpath = dirpart(ptr); 261 free(ptr); 262 } 263 264 if (fsfd >= 0) 265 close(fsfd); 266 fsfd = open(dirpath, O_RDONLY); 267 if (fsfd < 0) { 268 err(2, "hammer snaprm: cannot open dir %s", 269 dirpath); 270 /* not reached */ 271 } 272 273 delete = 1; 274 if (i == 0 && ac > 1) { 275 mode = path_m; 276 if (lstat(av[1], &st) < 0) { 277 tid = strtoull(av[1], &ptr, 16); 278 if (*ptr == '\0') { 279 delete = 0; 280 mode = tid_m; 281 } 282 } 283 } else { 284 if (mode == tid_m) { 285 snapshot_usage(1); 286 /* not reached */ 287 } 288 mode = path_m; 289 } 290 if (delete && (ptr = strrchr(linkbuf, '@')) && 291 ptr > linkbuf && ptr[-1] == '@' && ptr[1]) { 292 tid = strtoull(ptr + 1, &ptr2, 16); 293 if (*ptr2 == '\0') { 294 snapshot_del(fsfd, tid); 295 remove(av[i]); 296 } 297 } 298 free(dirpath); 299 } else { 300 err(2, "hammer snaprm: not directory or snapshot " 301 "softlink: %s", av[i]); 302 /* not reached */ 303 } 304 } 305 if (fsfd >= 0) 306 close(fsfd); 307 } 308 309 /* 310 * snapshot <softlink-dir> 311 * snapshot <filesystem> <softlink-dir> [<note>] 312 */ 313 void 314 hammer_cmd_snapshot(char **av, int ac) 315 { 316 const char *filesystem; 317 const char *softlink_dir; 318 char *softlink_fmt; 319 struct statfs buf; 320 struct stat st; 321 struct hammer_ioc_synctid synctid; 322 char *from; 323 char *to; 324 char *note = NULL; 325 326 if (ac == 1) { 327 filesystem = NULL; 328 softlink_dir = av[0]; 329 } else if (ac == 2) { 330 filesystem = av[0]; 331 softlink_dir = av[1]; 332 } else if (ac == 3) { 333 filesystem = av[0]; 334 softlink_dir = av[1]; 335 note = av[2]; 336 } else { 337 snapshot_usage(1); 338 /* not reached */ 339 } 340 341 if (stat(softlink_dir, &st) == 0) { 342 if (!S_ISDIR(st.st_mode)) 343 err(2, "File %s already exists", softlink_dir); 344 345 if (filesystem == NULL) { 346 if (statfs(softlink_dir, &buf) != 0) { 347 err(2, "Unable to determine filesystem of %s", 348 softlink_dir); 349 } 350 filesystem = buf.f_mntonname; 351 } 352 353 softlink_fmt = malloc(strlen(softlink_dir) + 1 + 1 + 354 sizeof(DEFAULT_SNAPSHOT_NAME)); 355 if (softlink_fmt == NULL) 356 err(2, "Failed to allocate string"); 357 358 strcpy(softlink_fmt, softlink_dir); 359 if (softlink_fmt[strlen(softlink_fmt)-1] != '/') 360 strcat(softlink_fmt, "/"); 361 strcat(softlink_fmt, DEFAULT_SNAPSHOT_NAME); 362 } else { 363 softlink_fmt = strdup(softlink_dir); 364 365 if (filesystem == NULL) { 366 /* 367 * strip-off last '/path' segment to get the softlink 368 * directory, which we need to determine the filesystem 369 * we are on. 370 */ 371 char *pos = strrchr(softlink_fmt, '/'); 372 if (pos != NULL) 373 *pos = '\0'; 374 375 if (stat(softlink_fmt, &st) != 0 || 376 !S_ISDIR(st.st_mode)) { 377 err(2, "Unable to determine softlink dir %s", 378 softlink_fmt); 379 } 380 if (statfs(softlink_fmt, &buf) != 0) { 381 err(2, "Unable to determine filesystem of %s", 382 softlink_fmt); 383 } 384 filesystem = buf.f_mntonname; 385 386 /* restore '/' */ 387 if (pos != NULL) 388 *pos = '/'; 389 } 390 } 391 392 /* 393 * Synctid 394 */ 395 bzero(&synctid, sizeof(synctid)); 396 synctid.op = HAMMER_SYNCTID_SYNC2; 397 398 int fd = open(filesystem, O_RDONLY); 399 if (fd < 0) 400 err(2, "Unable to open %s", filesystem); 401 if (ioctl(fd, HAMMERIOC_SYNCTID, &synctid) < 0) 402 err(2, "Synctid %s failed", filesystem); 403 404 asprintf(&from, "%s/@@0x%016jx", filesystem, (uintmax_t)synctid.tid); 405 if (from == NULL) 406 err(2, "Couldn't generate string"); 407 408 int sz = strlen(softlink_fmt) + 50; 409 to = malloc(sz); 410 if (to == NULL) 411 err(2, "Failed to allocate string"); 412 413 time_t t = time(NULL); 414 if (strftime(to, sz, softlink_fmt, localtime(&t)) == 0) 415 err(2, "String buffer too small"); 416 417 asprintf(&from, "%s/@@0x%016jx", filesystem, (uintmax_t)synctid.tid); 418 419 snapshot_add(fd, from, to, note, synctid.tid); 420 421 close(fd); 422 printf("%s\n", to); 423 424 free(softlink_fmt); 425 free(from); 426 free(to); 427 } 428 429 static 430 void 431 snapshot_add(int fd, const char *fsym, const char *tsym, const char *label, 432 hammer_tid_t tid) 433 { 434 struct hammer_ioc_version version; 435 struct hammer_ioc_snapshot snapshot; 436 437 bzero(&version, sizeof(version)); 438 bzero(&snapshot, sizeof(snapshot)); 439 440 /* 441 * For HAMMER filesystem v3+ the snapshot is recorded in meta-data. 442 */ 443 if (ioctl(fd, HAMMERIOC_GET_VERSION, &version) == 0 && 444 version.cur_version >= 3) { 445 snapshot.index = 0; 446 snapshot.count = 1; 447 snapshot.snaps[0].tid = tid; 448 snapshot.snaps[0].ts = time(NULL) * 1000000ULL; 449 if (label) { 450 snprintf(snapshot.snaps[0].label, 451 sizeof(snapshot.snaps[0].label), 452 "%s", 453 label); 454 } 455 if (ioctl(fd, HAMMERIOC_ADD_SNAPSHOT, &snapshot) < 0) { 456 err(2, "Unable to create snapshot"); 457 } else if (snapshot.head.error && 458 snapshot.head.error != EEXIST) { 459 errx(2, "Unable to create snapshot: %s\n", 460 strerror(snapshot.head.error)); 461 } 462 } 463 464 /* 465 * Create a symlink for the snapshot. If a file exists with the same 466 * name the new symlink will replace it. 467 */ 468 if (fsym && tsym) { 469 remove(tsym); 470 if (symlink(fsym, tsym) < 0) { 471 err(2, "Unable to create symlink %s", tsym); 472 } 473 } 474 } 475 476 static 477 void 478 snapshot_ls(const char *path) 479 { 480 struct hammer_ioc_info info; 481 struct hammer_ioc_snapshot snapshot; 482 struct hammer_ioc_pseudofs_rw pfs; 483 struct hammer_pseudofs_data pfs_od; 484 hammer_snapshot_data_t snap; 485 struct tm *tp; 486 time_t t; 487 uint32_t i; 488 int fd; 489 char snapts[64]; 490 char *mntpoint; 491 492 fd = open(path, O_RDONLY); 493 if (fd < 0) { 494 err(2, "hammer snapls: cannot open %s", path); 495 /* not reached */ 496 } 497 498 clrpfs(&pfs, &pfs_od, -1); 499 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) < 0) { 500 err(2, "hammer snapls: cannot retrieve PFS info on %s", path); 501 /* not reached */ 502 } 503 504 bzero(&info, sizeof(info)); 505 if ((ioctl(fd, HAMMERIOC_GET_INFO, &info)) < 0) { 506 err(2, "hammer snapls: cannot retrieve HAMMER info"); 507 /* not reached */ 508 } 509 510 mntpoint = libhammer_find_pfs_mount(&pfs.ondisk->unique_uuid); 511 512 printf("Snapshots on %s\tPFS #%d\n", 513 mntpoint ? mntpoint : path, pfs.pfs_id); 514 printf("Transaction ID\t\tTimestamp\t\tNote\n"); 515 516 if (mntpoint) 517 free(mntpoint); 518 519 bzero(&snapshot, sizeof(snapshot)); 520 do { 521 if (ioctl(fd, HAMMERIOC_GET_SNAPSHOT, &snapshot) < 0) { 522 err(2, "hammer snapls: %s: not HAMMER fs or " 523 "version < 3", path); 524 /* not reached */ 525 } 526 for (i = 0; i < snapshot.count; ++i) { 527 snap = &snapshot.snaps[i]; 528 529 t = snap->ts / 1000000ULL; 530 tp = localtime(&t); 531 strftime(snapts, sizeof(snapts), 532 "%Y-%m-%d %H:%M:%S %Z", tp); 533 printf("0x%016jx\t%s\t%s\n", 534 (uintmax_t)snap->tid, snapts, 535 strlen(snap->label) ? snap->label : "-"); 536 } 537 } while (snapshot.head.error == 0 && snapshot.count); 538 } 539 540 static 541 void 542 snapshot_del(int fsfd, hammer_tid_t tid) 543 { 544 struct hammer_ioc_snapshot snapshot; 545 struct hammer_ioc_version version; 546 547 bzero(&version, sizeof(version)); 548 549 if (ioctl(fsfd, HAMMERIOC_GET_VERSION, &version) < 0) { 550 err(2, "hammer snaprm 0x%016jx", (uintmax_t)tid); 551 } 552 if (version.cur_version < 3) { 553 errx(2, "hammer snaprm 0x%016jx: You must upgrade to version " 554 " 3 to use this directive", (uintmax_t)tid); 555 } 556 557 bzero(&snapshot, sizeof(snapshot)); 558 snapshot.count = 1; 559 snapshot.snaps[0].tid = tid; 560 561 /* 562 * Do not abort if we are unable to remove the meta-data. 563 */ 564 if (ioctl(fsfd, HAMMERIOC_DEL_SNAPSHOT, &snapshot) < 0) { 565 err(2, "hammer snaprm 0x%016jx", 566 (uintmax_t)tid); 567 } else if (snapshot.head.error == ENOENT) { 568 fprintf(stderr, "Warning: hammer snaprm 0x%016jx: " 569 "meta-data not found\n", 570 (uintmax_t)tid); 571 } else if (snapshot.head.error) { 572 fprintf(stderr, "Warning: hammer snaprm 0x%016jx: %s\n", 573 (uintmax_t)tid, strerror(snapshot.head.error)); 574 } 575 } 576 577 static 578 void 579 snapshot_usage(int exit_code) 580 { 581 fprintf(stderr, 582 "hammer snap <path> [<note>]\t\tcreate snapshot & link, points to\n" 583 "\t\t\t\t\tbase of PFS mount\n" 584 "hammer snaplo <path> [<note>]\t\tcreate snapshot & link, points to\n" 585 "\t\t\t\t\ttarget dir\n" 586 "hammer snapq <dir> [<note>]\t\tcreate snapshot, output path to stdout\n" 587 "hammer snaprm <path> ...\t\tdelete snapshots; filesystem is CWD\n" 588 "hammer snaprm <transid> ...\t\tdelete snapshots\n" 589 "hammer snaprm <filesystem> <transid> ...\tdelete snapshots\n" 590 "hammer snapls [<path> ...]\t\tlist available snapshots\n" 591 "\n" 592 "NOTE: Snapshots are created in filesystem meta-data, any directory\n" 593 " in a HAMMER filesystem or PFS may be specified. If the path\n" 594 " specified does not exist this function will also create a\n" 595 " softlink.\n" 596 "\n" 597 " When deleting snapshots transaction ids may be directly specified\n" 598 " or file paths to snapshot softlinks may be specified. If a\n" 599 " softlink is specified the softlink will also be deleted.\n" 600 "\n" 601 "NOTE: The old 'hammer snapshot [<filesystem>] <snapshot-dir>' form\n" 602 " is still accepted but is a deprecated form. This form will\n" 603 " work for older hammer versions. The new forms only work for\n" 604 " HAMMER version 3 or later filesystems. HAMMER can be upgraded\n" 605 " to version 3 in-place.\n" 606 ); 607 exit(exit_code); 608 } 609 610 static 611 char * 612 dirpart(const char *path) 613 { 614 const char *ptr; 615 char *res; 616 617 ptr = strrchr(path, '/'); 618 if (ptr) { 619 while (ptr > path && ptr[-1] == '/') 620 --ptr; 621 if (ptr == path) 622 ptr = NULL; 623 } 624 if (ptr == NULL) { 625 path = "."; 626 ptr = path + 1; 627 } 628 res = malloc(ptr - path + 1); 629 bcopy(path, res, ptr - path); 630 res[ptr - path] = 0; 631 return(res); 632 } 633