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 softprune_usage(int code);
49 static void hammer_softprune_scandir(struct softprune **basep,
50 struct hammer_ioc_prune *template,
52 static int hammer_softprune_scanmeta(int fd, struct softprune *scan,
54 static void hammer_meta_flushdelete(int fd, struct hammer_ioc_snapshot *dsnap);
55 static struct softprune *hammer_softprune_addentry(struct softprune **basep,
56 struct hammer_ioc_prune *template,
57 const char *dirpath, const char *denname,
59 const char *linkbuf, const char *tidptr);
60 static void hammer_softprune_addelm(struct softprune *scan, hammer_tid_t tid,
61 time_t ct, time_t mt);
62 static void hammer_softprune_finalize(struct softprune *scan);
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 bzero(&pfs, sizeof(pfs));
83 pfs.bytes = sizeof(*pfs.ondisk);
84 pfs.ondisk = malloc(pfs.bytes);
85 bzero(pfs.ondisk, pfs.bytes);
89 * NOTE: To restrict to a single file XXX we have to set
90 * the localization the same (not yet implemented). Typically
91 * two passes would be needed, one using HAMMER_LOCALIZE_MISC
92 * and one using HAMMER_LOCALIZE_INODE.
95 bzero(&template, sizeof(template));
96 template.key_beg.localization = HAMMER_MIN_LOCALIZATION;
97 template.key_beg.obj_id = HAMMER_MIN_OBJID;
98 template.key_end.localization = HAMMER_MAX_LOCALIZATION;
99 template.key_end.obj_id = HAMMER_MAX_OBJID;
100 hammer_get_cycle(&template.key_end, NULL);
101 template.stat_oldest_tid = HAMMER_MAX_TID;
104 * For now just allow one directory
106 if (ac == 0 || ac > 1)
110 * Scan the softlink directory.
112 if (everything_opt) {
113 const char *dummylink = "";
114 scan = hammer_softprune_addentry(&base, &template,
116 dummylink, dummylink);
119 scan->prune.nelms = 0;
120 scan->prune.head.flags |= HAMMER_IOC_PRUNE_ALL;
122 hammer_softprune_scandir(&base, &template, *av);
124 const char *dummylink = "";
125 scan = hammer_softprune_addentry(&base, &template,
127 dummylink, dummylink);
130 scan->prune.nelms = 0;
137 * XXX future (need to store separate cycles for each filesystem)
140 fprintf(stderr, "Currently only one HAMMER filesystem may "
141 "be specified in the softlink scan\n");
148 for (scan = base; scan; scan = scan->next) {
150 * Open the filesystem for ioctl calls and extract the
153 fd = open(scan->filesystem, O_RDONLY);
155 warn("Unable to open %s", scan->filesystem);
160 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) < 0) {
161 warn("Filesystem %s is not HAMMER", scan->filesystem);
166 scan->prune_min = pfs.ondisk->prune_min;
169 * Incorporate meta-data snapshots into the pruning regimen.
170 * If pruning everything we delete the meta-data snapshots.
172 if (hammer_softprune_scanmeta(fd, scan, everything_opt) < 0) {
173 warn("Filesystem %s could not scan meta-data snaps",
181 * Finalize operations
183 hammer_softprune_finalize(scan);
184 if (everything_opt) {
185 printf("Prune %s: EVERYTHING\n",
188 printf("Prune %s: %d snapshots\n",
189 scan->filesystem, scan->prune.nelms);
191 if (scan->prune.nelms == 0 &&
192 (scan->prune.head.flags & HAMMER_IOC_PRUNE_ALL) == 0) {
193 fprintf(stderr, "No snapshots found\n");
197 printf("Prune %s: objspace %016jx:%04x %016jx:%04x "
200 (uintmax_t)scan->prune.key_beg.obj_id,
201 scan->prune.key_beg.localization,
202 (uintmax_t)scan->prune.key_end.obj_id,
203 scan->prune.key_end.localization,
205 printf("Prune %s: prune_min is %dd/%02d:%02d:%02d\n",
207 pfs.ondisk->prune_min / (24 * 60 * 60),
208 pfs.ondisk->prune_min / 60 / 60 % 24,
209 pfs.ondisk->prune_min / 60 % 60,
210 pfs.ondisk->prune_min % 60);
213 if (ioctl(fd, HAMMERIOC_PRUNE, &scan->prune) < 0) {
214 printf("Prune %s failed: %s\n",
215 scan->filesystem, strerror(errno));
217 } else if (scan->prune.head.flags & HAMMER_IOC_HEAD_INTR) {
218 printf("Prune %s interrupted by timer at "
221 (uintmax_t)scan->prune.key_cur.obj_id,
222 scan->prune.key_cur.localization);
224 hammer_set_cycle(&scan->prune.key_cur, 0);
228 hammer_reset_cycle();
229 printf("Prune %s succeeded\n", scan->filesystem);
231 printf("Pruned %jd/%jd records (%jd directory entries) "
233 (uintmax_t)scan->prune.stat_rawrecords,
234 (uintmax_t)scan->prune.stat_scanrecords,
235 (uintmax_t)scan->prune.stat_dirrecords,
236 (uintmax_t)scan->prune.stat_bytes
246 * Scan a directory for softlinks representing snapshots and build
247 * associated softprune structures.
249 * NOTE: Once a filesystem is completely converted to the meta-data
250 * snapshot mechanic we don't have to scan softlinks any more
251 * and can just use the meta-data. But for now we do both.
254 hammer_softprune_scandir(struct softprune **basep,
255 struct hammer_ioc_prune *template,
267 linkbuf = malloc(MAXPATHLEN);
269 if ((dir = opendir(dirname)) == NULL)
270 err(1, "Cannot open directory %s", dirname);
271 while ((den = readdir(dir)) != NULL) {
272 if (strcmp(den->d_name, ".") == 0)
274 if (strcmp(den->d_name, "..") == 0)
278 asprintf(&path, "%s/%s", dirname, den->d_name);
279 if (lstat(path, &st) < 0)
281 if (!S_ISLNK(st.st_mode))
283 if ((len = readlink(path, linkbuf, MAXPATHLEN - 1)) < 0)
286 if ((ptr = strrchr(linkbuf, '@')) &&
287 ptr > linkbuf && ptr[-1] == '@') {
288 hammer_softprune_addentry(basep, template,
289 dirname, den->d_name, &st,
299 * Scan the metadata snapshots for the filesystem and either delete them
300 * or add them to the pruning list.
304 hammer_softprune_scanmeta(int fd, struct softprune *scan, int delete_all)
306 struct hammer_ioc_version version;
307 struct hammer_ioc_snapshot snapshot;
308 struct hammer_ioc_snapshot dsnapshot;
309 struct hammer_snapshot_data *snap;
313 * Stop if we can't get the version. Meta-data snapshots only
314 * exist for HAMMER version 3 or greater.
316 bzero(&version, sizeof(version));
317 if (ioctl(fd, HAMMERIOC_GET_VERSION, &version) < 0)
319 if (version.cur_version < 3)
322 bzero(&snapshot, sizeof(snapshot));
323 bzero(&dsnapshot, sizeof(dsnapshot));
326 * Scan meta-data snapshots, either add them to the prune list or
327 * delete them. When deleting, just skip any entries which cannot
331 if (ioctl(fd, HAMMERIOC_GET_SNAPSHOT, &snapshot) < 0) {
332 printf("hammer prune: Unable to access "
333 "meta-data snaps: %s\n", strerror(errno));
336 while (snapshot.index < snapshot.count) {
337 snap = &snapshot.snaps[snapshot.index];
339 dsnapshot.snaps[dsnapshot.count++] = *snap;
340 if (dsnapshot.count == HAMMER_SNAPS_PER_IOCTL)
341 hammer_meta_flushdelete(fd, &dsnapshot);
343 ct = snap->ts / 1000000ULL;
344 hammer_softprune_addelm(scan, snap->tid,
349 if (snapshot.head.flags & HAMMER_IOC_SNAPSHOT_EOF)
354 hammer_meta_flushdelete(fd, &dsnapshot);
359 * Flush any entries built up in the deletion snapshot ioctl structure.
360 * Used during a prune-everything.
363 hammer_meta_flushdelete(int fd, struct hammer_ioc_snapshot *dsnap)
365 while (dsnap->index < dsnap->count) {
366 if (ioctl(fd, HAMMERIOC_DEL_SNAPSHOT, dsnap) < 0)
368 if (dsnap->head.error == 0)
377 * Add the softlink to the appropriate softprune structure, creating a new
382 hammer_softprune_addentry(struct softprune **basep,
383 struct hammer_ioc_prune *template,
384 const char *dirpath, const char *denname __unused,
386 const char *linkbuf, const char *tidptr)
388 struct softprune *scan;
393 * Calculate filesystem path.
395 if (linkbuf[0] == '/') {
396 asprintf(&fspath, "%*.*s",
397 (int)(tidptr - linkbuf), (int)(tidptr - linkbuf),
400 asprintf(&fspath, "%s/%*.*s", dirpath,
401 (int)(tidptr - linkbuf), (int)(tidptr - linkbuf),
404 if (statfs(fspath, &fs) < 0) {
410 * Locate the filesystem in an existing softprune structure
412 for (scan = *basep; scan; scan = scan->next) {
413 if (bcmp(&fs.f_fsid, &scan->fs.f_fsid, sizeof(fs.f_fsid)) != 0)
415 if (strcmp(fs.f_mntonname, scan->fs.f_mntonname) != 0)
421 * Create a new softprune structure if necessasry
424 scan = malloc(sizeof(*scan));
425 bzero(scan, sizeof(*scan));
428 scan->filesystem = fspath;
429 scan->prune = *template;
431 scan->prune.elms = malloc(sizeof(struct hammer_ioc_prune_elm) *
438 hammer_softprune_addelm(scan,
439 (hammer_tid_t)strtoull(tidptr + 2, NULL, 0),
440 (st ? st->st_ctime : 0),
441 (st ? st->st_mtime : 0));
446 * Add the entry (unsorted). Just set the beg_tid, we will sort
447 * and set the remaining entries later.
449 * Always leave one entry free for our terminator.
452 hammer_softprune_addelm(struct softprune *scan, hammer_tid_t tid,
453 time_t ct, time_t mt)
455 struct hammer_ioc_prune_elm *elm;
457 if (scan->prune.nelms >= scan->maxelms - 1) {
458 scan->maxelms = (scan->maxelms * 3 / 2);
459 scan->prune.elms = realloc(scan->prune.elms,
460 sizeof(*elm) * scan->maxelms);
464 * NOTE: Temporarily store the snapshot timestamp in mod_tid.
465 * This will be cleaned up in the finalization phase.
467 elm = &scan->prune.elms[scan->prune.nelms];
479 * Finalize a softprune structure after scanning in its softlinks.
480 * Sort the elements, remove duplicates, and then fill in end_tid and
483 * The array must end up in descending order.
486 hammer_softprune_qsort_cmp(const void *arg1, const void *arg2)
488 const struct hammer_ioc_prune_elm *elm1 = arg1;
489 const struct hammer_ioc_prune_elm *elm2 = arg2;
491 if (elm1->beg_tid < elm2->beg_tid)
493 if (elm1->beg_tid > elm2->beg_tid)
499 hammer_softprune_finalize(struct softprune *scan)
501 struct hammer_ioc_prune_elm *elm;
507 * Don't do anything if there are no elements.
509 if (scan->prune.nelms == 0)
513 * Sort the elements in descending order, remove duplicates, and
514 * fill in any missing bits.
516 qsort(scan->prune.elms, scan->prune.nelms, sizeof(*elm),
517 hammer_softprune_qsort_cmp);
519 for (i = 0; i < scan->prune.nelms; ++i) {
520 elm = &scan->prune.elms[i];
523 * First (highest TID) (also last if only one element)
525 elm->end_tid = HAMMER_MAX_TID;
526 } else if (elm[0].beg_tid == elm[-1].beg_tid) {
531 if (i != scan->prune.nelms) {
533 (scan->prune.nelms - i) * sizeof(*elm));
541 elm->end_tid = elm[-1].beg_tid;
546 * If a minimum retention time (in seconds) is configured for the
547 * PFS, remove any snapshots from the pruning list that are within
550 if (scan->prune_min) {
552 for (i = scan->prune.nelms - 1; i >= 0; --i) {
553 elm = &scan->prune.elms[i];
554 if (elm->mod_tid == 0)
556 delta = (long)(t - (time_t)elm->mod_tid);
557 if (delta < scan->prune_min)
562 printf("Prune %s: prune_min: Will not clean between "
563 "the teeth of the first %d snapshots\n",
564 scan->filesystem, i);
565 bcopy(&scan->prune.elms[i], &scan->prune.elms[0],
566 (scan->prune.nelms - i) * sizeof(scan->prune.elms[0]));
567 scan->prune.elms[0].end_tid = HAMMER_MAX_TID;
568 scan->prune.nelms -= i;
573 * Remove the first entry. This entry represents the prune from
574 * the most recent snapshot to current. We wish to retain the
575 * fine-grained history for this region.
577 if (scan->prune.nelms) {
578 bcopy(&scan->prune.elms[1], &scan->prune.elms[0],
579 (scan->prune.nelms - 1) * sizeof(scan->prune.elms[0]));
584 * Add a final element to prune everything from transaction id
585 * 0 to the lowest transaction id (aka last so far).
587 if (scan->prune.nelms) {
588 assert(scan->prune.nelms < scan->maxelms);
589 elm = &scan->prune.elms[scan->prune.nelms];
591 elm->end_tid = elm[-1].beg_tid;
596 * Adjust mod_tid to what the ioctl() expects.
598 for (i = 0; i < scan->prune.nelms; ++i) {
599 elm = &scan->prune.elms[i];
600 elm->mod_tid = elm->end_tid - elm->beg_tid;
601 printf("TID %016jx - %016jx\n",
602 (uintmax_t)elm->beg_tid, (uintmax_t)elm->end_tid);
608 softprune_usage(int code)
610 fprintf(stderr, "Badly formed prune command, use:\n");
611 fprintf(stderr, "hammer prune <softlink-dir>\n");
612 fprintf(stderr, "hammer prune-everything <filesystem>\n");