2 * Copyright (c) 2008 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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
34 * $DragonFly: src/sbin/hammer/cmd_softprune.c,v 1.7 2008/08/21 23:28:43 thomas Exp $
40 struct softprune *next;
43 struct hammer_ioc_prune prune;
48 static void hammer_softprune_scandir(struct softprune **basep,
49 struct hammer_ioc_prune *template,
51 static int hammer_softprune_scanmeta(int fd, struct softprune *scan,
53 static void hammer_meta_flushdelete(int fd, struct hammer_ioc_snapshot *dsnap);
54 static struct softprune *hammer_softprune_addentry(struct softprune **basep,
55 struct hammer_ioc_prune *template,
56 const char *dirpath, const char *denname,
58 const char *linkbuf, const char *tidptr);
59 static void hammer_softprune_addelm(struct softprune *scan, hammer_tid_t tid,
60 time_t ct, time_t mt);
61 static void hammer_softprune_finalize(struct softprune *scan);
62 static void softprune_usage(int code);
65 * prune <softlink-dir>
66 * prune-everything <filesystem>
69 hammer_cmd_softprune(char **av, int ac, int everything_opt)
71 struct hammer_ioc_prune template;
72 struct hammer_ioc_pseudofs_rw pfs;
73 struct softprune *base, *scan;
82 clrpfs(&pfs, NULL, -1);
85 * NOTE: To restrict to a single file XXX we have to set
86 * the localization the same (not yet implemented). Typically
87 * two passes would be needed, one using HAMMER_LOCALIZE_MISC
88 * and one using HAMMER_LOCALIZE_INODE.
91 bzero(&template, sizeof(template));
92 template.key_beg.localization = HAMMER_MIN_LOCALIZATION;
93 template.key_beg.obj_id = HAMMER_MIN_OBJID;
94 template.key_end.localization = HAMMER_MAX_LOCALIZATION;
95 template.key_end.obj_id = HAMMER_MAX_OBJID;
96 hammer_get_cycle(&template.key_end, NULL);
97 template.stat_oldest_tid = HAMMER_MAX_TID;
100 * For now just allow one directory
102 if (ac == 0 || ac > 1)
106 * Scan the softlink directory.
108 if (everything_opt) {
109 const char *dummylink = "";
110 scan = hammer_softprune_addentry(&base, &template,
112 dummylink, dummylink);
115 scan->prune.nelms = 0;
116 scan->prune.head.flags |= HAMMER_IOC_PRUNE_ALL;
118 hammer_softprune_scandir(&base, &template, *av);
120 const char *dummylink = "";
121 scan = hammer_softprune_addentry(&base, &template,
123 dummylink, dummylink);
126 scan->prune.nelms = 0;
133 * XXX future (need to store separate cycles for each filesystem)
136 errx(1, "Currently only one HAMMER filesystem may "
137 "be specified in the softlink scan");
142 for (scan = base; scan; scan = scan->next) {
144 * Open the filesystem for ioctl calls and extract the
147 fd = open(scan->filesystem, O_RDONLY);
149 warn("Unable to open %s", scan->filesystem);
154 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) < 0) {
155 warn("Filesystem %s is not HAMMER", scan->filesystem);
160 scan->prune_min = pfs.ondisk->prune_min;
163 * Incorporate meta-data snapshots into the pruning regimen.
164 * If pruning everything we delete the meta-data snapshots.
166 if (hammer_softprune_scanmeta(fd, scan, everything_opt) < 0) {
167 warn("Filesystem %s could not scan meta-data snaps",
175 * Finalize operations
177 hammer_softprune_finalize(scan);
178 if (everything_opt) {
179 printf("Prune %s: EVERYTHING\n",
182 printf("Prune %s: %d snapshots\n",
183 scan->filesystem, scan->prune.nelms);
185 if (scan->prune.nelms == 0 &&
186 (scan->prune.head.flags & HAMMER_IOC_PRUNE_ALL) == 0) {
187 fprintf(stderr, "No snapshots found\n");
191 printf("Prune %s: objspace %016jx:%04x %016jx:%04x "
194 (uintmax_t)scan->prune.key_beg.obj_id,
195 scan->prune.key_beg.localization,
196 (uintmax_t)scan->prune.key_end.obj_id,
197 scan->prune.key_end.localization,
199 printf("Prune %s: prune_min is %dd/%02d:%02d:%02d\n",
201 pfs.ondisk->prune_min / (24 * 60 * 60),
202 pfs.ondisk->prune_min / 60 / 60 % 24,
203 pfs.ondisk->prune_min / 60 % 60,
204 pfs.ondisk->prune_min % 60);
207 if (ioctl(fd, HAMMERIOC_PRUNE, &scan->prune) < 0) {
208 printf("Prune %s failed: %s\n",
209 scan->filesystem, strerror(errno));
211 } else if (scan->prune.head.flags & HAMMER_IOC_HEAD_INTR) {
212 printf("Prune %s interrupted by timer at "
215 (uintmax_t)scan->prune.key_cur.obj_id,
216 scan->prune.key_cur.localization);
218 hammer_set_cycle(&scan->prune.key_cur, 0);
222 hammer_reset_cycle();
223 printf("Prune %s succeeded\n", scan->filesystem);
225 printf("Pruned %jd/%jd records (%jd directory entries) "
227 (uintmax_t)scan->prune.stat_rawrecords,
228 (uintmax_t)scan->prune.stat_scanrecords,
229 (uintmax_t)scan->prune.stat_dirrecords,
230 (uintmax_t)scan->prune.stat_bytes
240 * Scan a directory for softlinks representing snapshots and build
241 * associated softprune structures.
243 * NOTE: Once a filesystem is completely converted to the meta-data
244 * snapshot mechanic we don't have to scan softlinks any more
245 * and can just use the meta-data. But for now we do both.
248 hammer_softprune_scandir(struct softprune **basep,
249 struct hammer_ioc_prune *template,
261 linkbuf = malloc(MAXPATHLEN);
263 if ((dir = opendir(dirname)) == NULL)
264 err(1, "Cannot open directory %s", dirname);
265 while ((den = readdir(dir)) != NULL) {
266 if (strcmp(den->d_name, ".") == 0)
268 if (strcmp(den->d_name, "..") == 0)
272 asprintf(&path, "%s/%s", dirname, den->d_name);
273 if (lstat(path, &st) < 0)
275 if (!S_ISLNK(st.st_mode))
277 if ((len = readlink(path, linkbuf, MAXPATHLEN - 1)) < 0)
280 if ((ptr = strrchr(linkbuf, '@')) &&
281 ptr > linkbuf && ptr[-1] == '@') {
282 hammer_softprune_addentry(basep, template,
283 dirname, den->d_name, &st,
293 * Scan a directory for softlinks representing snapshots.
294 * Return 1 if the directory contains snapshots, otherwise 0.
297 hammer_softprune_testdir(const char *dirname)
299 struct softprune *base = NULL;
300 struct hammer_ioc_prune dummy_template;
302 bzero(&dummy_template, sizeof(dummy_template));
303 hammer_softprune_scandir(&base, &dummy_template, dirname);
311 * Scan the metadata snapshots for the filesystem and either delete them
312 * or add them to the pruning list.
316 hammer_softprune_scanmeta(int fd, struct softprune *scan, int delete_all)
318 struct hammer_ioc_version version;
319 struct hammer_ioc_snapshot snapshot;
320 struct hammer_ioc_snapshot dsnapshot;
321 hammer_snapshot_data_t snap;
325 * Stop if we can't get the version. Meta-data snapshots only
326 * exist for HAMMER version 3 or greater.
328 bzero(&version, sizeof(version));
329 if (ioctl(fd, HAMMERIOC_GET_VERSION, &version) < 0)
331 if (version.cur_version < 3)
334 bzero(&snapshot, sizeof(snapshot));
335 bzero(&dsnapshot, sizeof(dsnapshot));
338 * Scan meta-data snapshots, either add them to the prune list or
339 * delete them. When deleting, just skip any entries which cannot
343 if (ioctl(fd, HAMMERIOC_GET_SNAPSHOT, &snapshot) < 0) {
344 printf("hammer prune: Unable to access "
345 "meta-data snaps: %s\n", strerror(errno));
348 while (snapshot.index < snapshot.count) {
349 snap = &snapshot.snaps[snapshot.index];
351 dsnapshot.snaps[dsnapshot.count++] = *snap;
352 if (dsnapshot.count == HAMMER_SNAPS_PER_IOCTL)
353 hammer_meta_flushdelete(fd, &dsnapshot);
355 ct = snap->ts / 1000000ULL;
356 hammer_softprune_addelm(scan, snap->tid,
361 if (snapshot.head.flags & HAMMER_IOC_SNAPSHOT_EOF)
366 hammer_meta_flushdelete(fd, &dsnapshot);
371 * Flush any entries built up in the deletion snapshot ioctl structure.
372 * Used during a prune-everything.
375 hammer_meta_flushdelete(int fd, struct hammer_ioc_snapshot *dsnap)
377 while (dsnap->index < dsnap->count) {
378 if (ioctl(fd, HAMMERIOC_DEL_SNAPSHOT, dsnap) < 0)
380 if (dsnap->head.error == 0)
389 * Add the softlink to the appropriate softprune structure, creating a new
394 hammer_softprune_addentry(struct softprune **basep,
395 struct hammer_ioc_prune *template,
396 const char *dirpath, const char *denname __unused,
398 const char *linkbuf, const char *tidptr)
400 struct softprune *scan;
405 * Calculate filesystem path.
407 if (linkbuf[0] == '/') {
408 asprintf(&fspath, "%*.*s",
409 (int)(tidptr - linkbuf), (int)(tidptr - linkbuf),
412 asprintf(&fspath, "%s/%*.*s", dirpath,
413 (int)(tidptr - linkbuf), (int)(tidptr - linkbuf),
416 if (statfs(fspath, &fs) < 0) {
422 * Locate the filesystem in an existing softprune structure
424 for (scan = *basep; scan; scan = scan->next) {
425 if (bcmp(&fs.f_fsid, &scan->fs.f_fsid, sizeof(fs.f_fsid)) != 0)
427 if (strcmp(fs.f_mntonname, scan->fs.f_mntonname) != 0)
433 * Create a new softprune structure if necessasry
436 scan = malloc(sizeof(*scan));
437 bzero(scan, sizeof(*scan));
440 scan->filesystem = fspath;
441 scan->prune = *template;
443 scan->prune.elms = malloc(sizeof(struct hammer_ioc_prune_elm) *
450 hammer_softprune_addelm(scan,
451 (hammer_tid_t)strtoull(tidptr + 2, NULL, 0),
452 (st ? st->st_ctime : 0),
453 (st ? st->st_mtime : 0));
458 * Add the entry (unsorted). Just set the beg_tid, we will sort
459 * and set the remaining entries later.
461 * Always leave one entry free for our terminator.
464 hammer_softprune_addelm(struct softprune *scan, hammer_tid_t tid,
465 time_t ct, time_t mt)
467 struct hammer_ioc_prune_elm *elm;
469 if (scan->prune.nelms >= scan->maxelms - 1) {
470 scan->maxelms = (scan->maxelms * 3 / 2);
471 scan->prune.elms = realloc(scan->prune.elms,
472 sizeof(*elm) * scan->maxelms);
476 * NOTE: Temporarily store the snapshot timestamp in mod_tid.
477 * This will be cleaned up in the finalization phase.
479 elm = &scan->prune.elms[scan->prune.nelms];
491 * Finalize a softprune structure after scanning in its softlinks.
492 * Sort the elements, remove duplicates, and then fill in end_tid and
495 * The array must end up in descending order.
498 hammer_softprune_qsort_cmp(const void *arg1, const void *arg2)
500 const struct hammer_ioc_prune_elm *elm1 = arg1;
501 const struct hammer_ioc_prune_elm *elm2 = arg2;
503 if (elm1->beg_tid < elm2->beg_tid)
505 if (elm1->beg_tid > elm2->beg_tid)
511 hammer_softprune_finalize(struct softprune *scan)
513 struct hammer_ioc_prune_elm *elm;
519 * Don't do anything if there are no elements.
521 if (scan->prune.nelms == 0)
525 * Sort the elements in descending order, remove duplicates, and
526 * fill in any missing bits.
528 qsort(scan->prune.elms, scan->prune.nelms, sizeof(*elm),
529 hammer_softprune_qsort_cmp);
531 for (i = 0; i < scan->prune.nelms; ++i) {
532 elm = &scan->prune.elms[i];
535 * First (highest TID) (also last if only one element)
537 elm->end_tid = HAMMER_MAX_TID;
538 } else if (elm[0].beg_tid == elm[-1].beg_tid) {
543 if (i != scan->prune.nelms) {
545 (scan->prune.nelms - i) * sizeof(*elm));
553 elm->end_tid = elm[-1].beg_tid;
558 * If a minimum retention time (in seconds) is configured for the
559 * PFS, remove any snapshots from the pruning list that are within
562 if (scan->prune_min) {
564 for (i = scan->prune.nelms - 1; i >= 0; --i) {
565 elm = &scan->prune.elms[i];
566 if (elm->mod_tid == 0)
568 delta = (long)(t - (time_t)elm->mod_tid);
569 if (delta < scan->prune_min)
574 printf("Prune %s: prune_min: Will not clean between "
575 "the teeth of the first %d snapshots\n",
576 scan->filesystem, i);
577 bcopy(&scan->prune.elms[i], &scan->prune.elms[0],
578 (scan->prune.nelms - i) * sizeof(scan->prune.elms[0]));
579 scan->prune.elms[0].end_tid = HAMMER_MAX_TID;
580 scan->prune.nelms -= i;
585 * Remove the first entry. This entry represents the prune from
586 * the most recent snapshot to current. We wish to retain the
587 * fine-grained history for this region.
589 if (scan->prune.nelms) {
590 bcopy(&scan->prune.elms[1], &scan->prune.elms[0],
591 (scan->prune.nelms - 1) * sizeof(scan->prune.elms[0]));
596 * Add a final element to prune everything from transaction id
597 * 0 to the lowest transaction id (aka last so far).
599 if (scan->prune.nelms) {
600 assert(scan->prune.nelms < scan->maxelms);
601 elm = &scan->prune.elms[scan->prune.nelms];
603 elm->end_tid = elm[-1].beg_tid;
608 * Adjust mod_tid to what the ioctl() expects.
610 for (i = 0; i < scan->prune.nelms; ++i) {
611 elm = &scan->prune.elms[i];
612 elm->mod_tid = elm->end_tid - elm->beg_tid;
613 printf("TID %016jx - %016jx\n",
614 (uintmax_t)elm->beg_tid, (uintmax_t)elm->end_tid);
620 softprune_usage(int code)
622 fprintf(stderr, "Badly formed prune command, use:\n");
623 fprintf(stderr, "hammer prune <softlink-dir>\n");
624 fprintf(stderr, "hammer prune-everything <filesystem>\n");