HAMMER Utilities: enhanced show, timeout option
[dragonfly.git] / sbin / hammer / cmd_prune.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/Attic/cmd_prune.c,v 1.5 2008/05/04 19:18:17 dillon Exp $
35  */
36
37 #include "hammer.h"
38
39 static void hammer_prune_load_file(hammer_tid_t now_tid, 
40                         struct hammer_ioc_prune *prune,
41                         const char *filesystem, const char *filename);
42 static int hammer_prune_parse_line(hammer_tid_t now_tid,
43                         struct hammer_ioc_prune *prune,
44                         const char *filesystem, char **av, int ac);
45 static void hammer_prune_create_links(const char *filesystem,
46                         struct hammer_ioc_prune *prune);
47 static void hammer_prune_make_softlink(const char *filesystem,
48                         hammer_tid_t tid);
49 static int parse_modulo_time(const char *str, u_int64_t *delta);
50 static char *tid_to_stamp_str(hammer_tid_t tid);
51 static void prune_usage(int code);
52
53 /*
54  * prune <filesystem> from <modulo_time> to <modulo_time> every <modulo_time>
55  * prune <filesystem> [using <filename>]
56  */
57 void
58 hammer_cmd_prune(char **av, int ac)
59 {
60         struct hammer_ioc_prune prune;
61         const char *filesystem;
62         int fd;
63         hammer_tid_t now_tid = (hammer_tid_t)time(NULL) * 1000000000LL;
64
65         bzero(&prune, sizeof(prune));
66         prune.nelms = 0;
67         prune.beg_obj_id = HAMMER_MIN_OBJID;
68         prune.end_obj_id = HAMMER_MAX_OBJID;
69         prune.cur_obj_id = prune.end_obj_id;    /* reverse scan */
70         prune.cur_key = HAMMER_MAX_KEY;
71         prune.stat_oldest_tid = HAMMER_MAX_TID;
72
73         if (ac == 0)
74                 prune_usage(1);
75         filesystem = av[0];
76         if (ac == 1) {
77                 hammer_prune_load_file(now_tid, &prune, filesystem, 
78                                       "/etc/hammer.conf");
79         } else if (strcmp(av[1], "using") == 0) {
80                 if (ac == 2)
81                         prune_usage(1);
82                 hammer_prune_load_file(now_tid, &prune, filesystem, av[2]);
83         } else if (strcmp(av[1], "everything") == 0) {
84                 prune.flags |= HAMMER_IOC_PRUNE_ALL;
85                 if (ac > 2)
86                         prune_usage(1);
87         } else {
88                 if (hammer_prune_parse_line(now_tid, &prune, filesystem,
89                                             av, ac) < 0) {
90                         prune_usage(1);
91                 }
92         }
93         fd = open(filesystem, O_RDONLY);
94         if (fd < 0)
95                 err(1, "Unable to open %s", filesystem);
96         if (ioctl(fd, HAMMERIOC_PRUNE, &prune) < 0) {
97                 if (errno == EINTR) {
98                         printf("Prune %s interrupted by timer\n", filesystem);
99                 } else {
100                         printf("Prune %s failed: %s\n",
101                                filesystem, strerror(errno));
102                 }
103         } else {
104                 printf("Prune %s succeeded\n", filesystem);
105         }
106         close(fd);
107         if (LinkPath)
108                 hammer_prune_create_links(filesystem, &prune);
109         printf("Pruned %lld records (%lld directory entries) and %lld bytes\n",
110                 prune.stat_rawrecords,
111                 prune.stat_dirrecords,
112                 prune.stat_bytes
113         );
114 }
115
116 static void
117 hammer_prune_load_file(hammer_tid_t now_tid, struct hammer_ioc_prune *prune,
118                        const char *filesystem, const char *filename)
119 {
120         char buf[256];
121         FILE *fp;
122         char *av[16];
123         int ac;
124         int lineno;
125
126         if ((fp = fopen(filename, "r")) == NULL)
127                 err(1, "Unable to read %s", filename);
128         lineno = 0;
129         while (fgets(buf, sizeof(buf), fp) != NULL) {
130                 ++lineno;
131                 if (strncmp(buf, "prune", 5) != 0)
132                         continue;
133                 ac = 0;
134                 av[ac] = strtok(buf, " \t\r\n");
135                 while (av[ac] != NULL) {
136                         ++ac;
137                         if (ac == 16) {
138                                 fclose(fp);
139                                 errx(1, "Malformed prune directive in %s "
140                                      "line %d\n", filename, lineno);
141                         }
142                         av[ac] = strtok(NULL, " \t\r\n");
143                 }
144                 if (ac == 0)
145                         continue;
146                 if (strcmp(av[0], "prune") != 0)
147                         continue;
148                 if (hammer_prune_parse_line(now_tid, prune, filesystem,
149                                             av + 1, ac - 1) < 0) {
150                         errx(1, "Malformed prune directive in %s line %d\n",
151                              filename, lineno);
152                 }
153         }
154         fclose(fp);
155 }
156
157 static __inline
158 const char *
159 plural(int notplural)
160 {
161         return(notplural ? "" : "s");
162 }
163
164 /*
165  * Parse the following parameters:
166  *
167  * <filesystem> from <modulo_time> to <modulo_time> every <modulo_time>
168  */
169 static int
170 hammer_prune_parse_line(hammer_tid_t now_tid, struct hammer_ioc_prune *prune,
171                         const char *filesystem, char **av, int ac)
172 {
173         struct hammer_ioc_prune_elm *elm;
174         u_int64_t from_time;
175         u_int64_t to_time;
176         u_int64_t every_time;
177         char *from_stamp_str;
178         char *to_stamp_str;
179
180         if (ac != 7)
181                 return(-1);
182         if (strcmp(av[0], filesystem) != 0)
183                 return(0);
184         if (strcmp(av[1], "from") != 0)
185                 return(-1);
186         if (strcmp(av[3], "to") != 0)
187                 return(-1);
188         if (strcmp(av[5], "every") != 0)
189                 return(-1);
190         if (parse_modulo_time(av[2], &from_time) < 0)
191                 return(-1);
192         if (parse_modulo_time(av[4], &to_time) < 0)
193                 return(-1);
194         if (parse_modulo_time(av[6], &every_time) < 0)
195                 return(-1);
196         if (from_time > to_time)
197                 return(-1);
198         if (from_time == 0 || to_time == 0) {
199                 fprintf(stderr, "Bad from or to time specification.\n");
200                 return(-1);
201         }
202         if (to_time % from_time != 0) {
203                 fprintf(stderr, "Bad TO time specification.\n"
204                         "It must be an integral multiple of FROM time\n");
205                 return(-1);
206         }
207         if (every_time == 0 ||
208             from_time % every_time != 0 ||
209             to_time % every_time != 0) {
210                 fprintf(stderr, "Bad 'every <modulo_time>' specification.\n"
211                         "It must be an integral subdivision of FROM and TO\n");
212                 return(-1);
213         }
214         if (prune->nelms == HAMMER_MAX_PRUNE_ELMS) {
215                 fprintf(stderr, "Too many prune specifications in file! "
216                         "Max is %d\n", HAMMER_MAX_PRUNE_ELMS);
217                 return(-1);
218         }
219
220         /*
221          * Example:  from 1m to 60m every 5m
222          */
223         elm = &prune->elms[prune->nelms++];
224         elm->beg_tid = now_tid - now_tid % to_time;
225         if (now_tid - elm->beg_tid < to_time)
226                 elm->beg_tid -= to_time;
227
228         elm->end_tid = now_tid - now_tid % from_time;
229         if (now_tid - elm->end_tid < from_time)
230                 elm->end_tid -= from_time;
231
232         elm->mod_tid = every_time;
233         assert(elm->beg_tid < elm->end_tid);
234
235         /*
236          * Convert back to local time for pretty printing
237          */
238         from_stamp_str = tid_to_stamp_str(elm->beg_tid);
239         to_stamp_str = tid_to_stamp_str(elm->end_tid);
240         printf("Prune %s to %s every ", from_stamp_str, to_stamp_str);
241
242         every_time /= 1000000000;
243         if (every_time < 60)
244                 printf("%lld second%s\n", every_time, plural(every_time == 1));
245         every_time /= 60;
246         if (every_time && every_time < 60)
247                 printf("%lld minute%s\n", every_time, plural(every_time == 1));
248         every_time /= 60;
249         if (every_time && every_time < 24)
250                 printf("%lld hour%s\n", every_time, plural(every_time == 1));
251         every_time /= 24;
252         if (every_time)
253                 printf("%lld day%s\n", every_time, plural(every_time == 1));
254
255         free(from_stamp_str);
256         free(to_stamp_str);
257         return(0);
258 }
259
260 /*
261  * Create softlinks in the form $linkpath/snap_ddmmmyyyy[_hhmmss]
262  */
263 static void
264 hammer_prune_create_links(const char *filesystem,
265                           struct hammer_ioc_prune *prune)
266 {
267         struct hammer_ioc_prune_elm *elm;
268         hammer_tid_t tid;
269         struct dirent *den;
270         char *path;
271         DIR *dir;
272
273         if ((dir = opendir(LinkPath)) == NULL) {
274                 fprintf(stderr, "Unable to access linkpath %s\n", LinkPath);
275                 return;
276         }
277         while ((den = readdir(dir)) != NULL) {
278                 if (strncmp(den->d_name, "snap-", 5) == 0) {
279                         asprintf(&path, "%s/%s", LinkPath, den->d_name);
280                         remove(path);
281                         free(path);
282                 }
283         }
284         closedir(dir);
285
286         for (elm = &prune->elms[0]; elm < &prune->elms[prune->nelms]; ++elm) {
287                 for (tid = elm->beg_tid;
288                      tid < elm->end_tid;
289                      tid += elm->mod_tid) {
290                         if (tid < prune->stat_oldest_tid)
291                                 continue;
292                         hammer_prune_make_softlink(filesystem, tid);
293                 }
294         }
295 }
296
297 static void
298 hammer_prune_make_softlink(const char *filesystem, hammer_tid_t tid)
299 {
300         struct tm *tp;
301         char *path;
302         char *target;
303         char buf[64];
304         time_t t;
305
306         t = (time_t)(tid / 1000000000);
307         tp = localtime(&t);
308
309         /*
310          * Construct the contents of the softlink.
311          */
312         asprintf(&target, "%s/@@0x%016llx", filesystem, tid);
313
314         /*
315          * Construct the name of the snap-shot softlink
316          */
317         if (tid % (1000000000ULL * 60 * 60 * 24) == 0) {
318                 strftime(buf, sizeof(buf), "snap-%d%b%Y", tp);
319         } else if (tid % (1000000000ULL * 60 * 60) == 0) {
320                 strftime(buf, sizeof(buf), "snap-%d%b%Y_%H%M", tp);
321         } else if (tid % (1000000000ULL * 60) == 0) {
322                 strftime(buf, sizeof(buf), "snap-%d%b%Y_%H%M", tp);
323         } else {
324                 strftime(buf, sizeof(buf), "snap-%d%b%Y_%H%M%S", tp);
325         }
326
327         asprintf(&path, "%s/%s", LinkPath, buf);
328         symlink(target, path);
329         free(path);
330         free(target);
331 }
332
333 static
334 int
335 parse_modulo_time(const char *str, u_int64_t *delta)
336 {
337         char *term;
338
339         *delta = strtoull(str, &term, 10);
340
341         switch(*term) {
342         case 'y':
343                 *delta *= 12;
344                 /* fall through */
345         case 'M':
346                 *delta *= 30;
347                 /* fall through */
348         case 'd':
349                 *delta *= 24;
350                 /* fall through */
351         case 'h':
352                 *delta *= 60;
353                 /* fall through */
354         case 'm':
355                 *delta *= 60;
356                 /* fall through */
357         case 's':
358                 break;
359         default:
360                 return(-1);
361         }
362         *delta *= 1000000000LL; /* TID's are in nanoseconds */
363         return(0);
364 }
365
366 static char *
367 tid_to_stamp_str(hammer_tid_t tid)
368 {
369         struct tm *tp;
370         char *buf = malloc(256);
371         time_t t;
372
373         t = (time_t)(tid / 1000000000);
374         tp = localtime(&t);
375         strftime(buf, 256, "%e-%b-%Y %H:%M:%S %Z", tp);
376         return(buf);
377 }
378
379 static void
380 prune_usage(int code)
381 {
382         fprintf(stderr, "Bad prune directive, specify one of:\n"
383                         "prune filesystem [using filename]\n"
384                         "prune filesystem from <modulo_time> to <modulo_time> every <modulo_time>\n");
385         exit(code);
386 }