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;
47 static void softprune_usage(int code);
48 static void hammer_softprune_scandir(struct softprune **basep,
49 struct hammer_ioc_prune *template,
51 static struct softprune *hammer_softprune_addentry(struct softprune **basep,
52 struct hammer_ioc_prune *template,
54 const char *linkbuf, const char *tidptr);
55 static void hammer_softprune_finalize(struct softprune *scan);
58 * prune <softlink-dir>
59 * prune-everything <filesystem>
62 hammer_cmd_softprune(char **av, int ac, int everything_opt)
64 struct hammer_ioc_prune template;
65 struct softprune *base, *scan;
75 * NOTE: To restrict to a single file XXX we have to set
76 * the localization the same (not yet implemented). Typically
77 * two passes would be needed, one using HAMMER_LOCALIZE_MISC
78 * and one using HAMMER_LOCALIZE_INODE.
81 bzero(&template, sizeof(template));
82 template.key_beg.localization = HAMMER_MIN_LOCALIZATION;
83 template.key_beg.obj_id = HAMMER_MIN_OBJID;
84 template.key_end.localization = HAMMER_MAX_LOCALIZATION;
85 template.key_end.obj_id = HAMMER_MAX_OBJID;
86 hammer_get_cycle(&template.key_end, NULL);
87 template.stat_oldest_tid = HAMMER_MAX_TID;
90 * For now just allow one directory
92 if (ac == 0 || ac > 1)
96 * Scan the softlink directory.
99 const char *dummylink = "";
100 scan = hammer_softprune_addentry(&base, &template, *av,
101 dummylink, dummylink);
104 scan->prune.nelms = 0;
105 scan->prune.head.flags |= HAMMER_IOC_PRUNE_ALL;
108 hammer_softprune_scandir(&base, &template, *av);
114 * XXX future (need to store separate cycles for each filesystem)
117 fprintf(stderr, "No snapshot softlinks found\n");
121 fprintf(stderr, "Currently only one HAMMER filesystem may "
122 "be specified in the softlink scan\n");
129 for (scan = base; scan; scan = scan->next) {
130 hammer_softprune_finalize(scan);
131 if (everything_opt) {
132 printf("Prune %s: EVERYTHING\n",
135 printf("Prune %s: %d snapshots\n",
136 scan->filesystem, scan->prune.nelms);
138 if (scan->prune.nelms == 0 &&
139 (scan->prune.head.flags & HAMMER_IOC_PRUNE_ALL) == 0) {
142 fd = open(scan->filesystem, O_RDONLY);
144 warn("Unable to open %s", scan->filesystem);
148 printf("objspace %016llx %016llx\n",
149 scan->prune.key_beg.obj_id,
150 scan->prune.key_end.obj_id);
152 if (ioctl(fd, HAMMERIOC_PRUNE, &scan->prune) < 0) {
153 printf("Prune %s failed: %s\n",
154 scan->filesystem, strerror(errno));
156 } else if (scan->prune.head.flags & HAMMER_IOC_HEAD_INTR) {
157 printf("Prune %s interrupted by timer at "
160 scan->prune.key_cur.obj_id,
161 scan->prune.key_cur.localization);
163 hammer_set_cycle(&scan->prune.key_cur, 0);
167 hammer_reset_cycle();
168 printf("Prune %s succeeded\n", scan->filesystem);
170 printf("Pruned %lld/%lld records (%lld directory entries) "
172 scan->prune.stat_rawrecords,
173 scan->prune.stat_scanrecords,
174 scan->prune.stat_dirrecords,
175 scan->prune.stat_bytes
184 * Scan a directory for softlinks representing snapshots and build
185 * associated softprune structures.
188 hammer_softprune_scandir(struct softprune **basep,
189 struct hammer_ioc_prune *template,
201 linkbuf = malloc(MAXPATHLEN);
203 if ((dir = opendir(dirname)) == NULL)
204 err(1, "Cannot open directory %s", dirname);
205 while ((den = readdir(dir)) != NULL) {
206 if (strcmp(den->d_name, ".") == 0)
208 if (strcmp(den->d_name, "..") == 0)
212 asprintf(&path, "%s/%s", dirname, den->d_name);
213 if (lstat(path, &st) < 0)
215 if (!S_ISLNK(st.st_mode))
217 if ((len = readlink(path, linkbuf, MAXPATHLEN - 1)) < 0)
220 if ((ptr = strrchr(linkbuf, '@')) &&
221 ptr > linkbuf && ptr[-1] == '@') {
222 hammer_softprune_addentry(basep, template,
223 dirname, linkbuf, ptr - 1);
232 * Add the softlink to the appropriate softprune structure, creating a new
237 hammer_softprune_addentry(struct softprune **basep,
238 struct hammer_ioc_prune *template,
240 const char *linkbuf, const char *tidptr)
242 struct hammer_ioc_prune_elm *elm;
243 struct softprune *scan;
247 if (linkbuf[0] == '/') {
248 asprintf(&fspath, "%*.*s",
249 (tidptr - linkbuf), (tidptr - linkbuf), linkbuf);
251 asprintf(&fspath, "%s/%*.*s", dirpath,
252 (tidptr - linkbuf), (tidptr - linkbuf), linkbuf);
254 if (statfs(fspath, &fs) < 0) {
260 * Locate the filesystem in an existing softprune structure
262 for (scan = *basep; scan; scan = scan->next) {
263 if (bcmp(&fs.f_fsid, &scan->fs.f_fsid, sizeof(fs.f_fsid)) != 0)
265 if (strcmp(fs.f_mntonname, scan->fs.f_mntonname) != 0)
271 * Create a new softprune structure if necessasry
274 scan = malloc(sizeof(*scan));
275 bzero(scan, sizeof(*scan));
278 scan->filesystem = fspath;
279 scan->prune = *template;
281 scan->prune.elms = malloc(sizeof(*elm) * scan->maxelms);
289 * Add the entry (unsorted). Just set the beg_tid, we will sort
290 * and set the remaining entries later.
292 * Always leave one entry free for our terminator.
294 if (scan->prune.nelms >= scan->maxelms - 1) {
295 scan->maxelms = (scan->maxelms * 3 / 2);
296 scan->prune.elms = realloc(scan->prune.elms,
297 sizeof(*elm) * scan->maxelms);
299 elm = &scan->prune.elms[scan->prune.nelms];
300 elm->beg_tid = strtoull(tidptr + 2, NULL, 0);
308 * Finalize a softprune structure after scanning in its softlinks.
309 * Sort the elements, remove duplicates, and then fill in end_tid and
312 * The array must end up in descending order.
315 hammer_softprune_qsort_cmp(const void *arg1, const void *arg2)
317 const struct hammer_ioc_prune_elm *elm1 = arg1;
318 const struct hammer_ioc_prune_elm *elm2 = arg2;
320 if (elm1->beg_tid < elm2->beg_tid)
322 if (elm1->beg_tid > elm2->beg_tid)
328 hammer_softprune_finalize(struct softprune *scan)
330 struct hammer_ioc_prune_elm *elm;
334 * Don't do anything if there are no elements.
336 if (scan->prune.nelms == 0)
340 * Sort the elements in descending order, remove duplicates, and
341 * fill in any missing bits.
343 qsort(scan->prune.elms, scan->prune.nelms, sizeof(*elm),
344 hammer_softprune_qsort_cmp);
346 for (i = 0; i < scan->prune.nelms; ++i) {
347 elm = &scan->prune.elms[i];
350 * First (highest TID) (also last if only one element)
352 elm->end_tid = HAMMER_MAX_TID;
353 } else if (elm[0].beg_tid == elm[-1].beg_tid) {
358 if (i != scan->prune.nelms) {
360 (scan->prune.nelms - i) * sizeof(*elm));
368 elm->end_tid = elm[-1].beg_tid;
370 elm->mod_tid = elm->end_tid - elm->beg_tid;
374 * Add a final element to prune everything from transaction id
375 * 0 to the lowest transaction id (aka last so far).
377 assert(scan->prune.nelms < scan->maxelms);
378 elm = &scan->prune.elms[scan->prune.nelms++];
380 elm->end_tid = elm[-1].beg_tid;
381 elm->mod_tid = elm->end_tid - elm->beg_tid;
386 softprune_usage(int code)
388 fprintf(stderr, "Badly formed prune command, use:\n");
389 fprintf(stderr, "hammer prune <softlink-dir>\n");
390 fprintf(stderr, "hammer prune-everything <filesystem>\n");