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