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_cleanup.c,v 1.6 2008/10/07 22:28:41 thomas Exp $
37 * Clean up a specific HAMMER filesystem or all HAMMER filesystems.
39 * Each filesystem is expected to have a <mount>/snapshots directory.
40 * No cleanup will be performed on any filesystem that does not. If
41 * no filesystems are specified the 'df' program is run and any HAMMER
42 * or null-mounted hammer PFS's are extracted.
44 * The snapshots directory may contain a config file called 'config'. If
45 * no config file is present one will be created with the following
48 * snapshots 1d 60d (0d 0d for /tmp, /var/tmp, /usr/obj)
53 * All hammer commands create and maintain cycle files in the snapshots
64 static void do_cleanup(const char *path
);
65 static int strtosecs(char *ptr
);
66 static const char *dividing_slash(const char *path
);
67 static int check_period(const char *snapshots_path
, const char *cmd
, int arg1
,
69 static void save_period(const char *snapshots_path
, const char *cmd
,
71 static int check_softlinks(const char *snapshots_path
);
72 static void cleanup_softlinks(const char *path
, const char *snapshots_path
,
73 int arg2
, char *arg3
);
74 static int check_expired(const char *fpath
, int arg2
);
76 static int cleanup_snapshots(const char *path
, const char *snapshots_path
,
78 static int cleanup_prune(const char *path
, const char *snapshots_path
,
79 int arg1
, int arg2
, int snapshots_disabled
);
80 static int cleanup_reblock(const char *path
, const char *snapshots_path
,
82 static int cleanup_recopy(const char *path
, const char *snapshots_path
,
85 static void runcmd(int *resp
, const char *ctl
, ...);
89 struct didpfs
*FirstPFS
;
92 hammer_cmd_cleanup(char **av
, int ac
)
101 fp
= popen("df -t hammer,null", "r");
103 errx(1, "hammer cleanup: 'df' failed");
104 while (fgets(buf
, sizeof(buf
), fp
) != NULL
) {
105 ptr
= strtok(buf
, WS
);
106 if (ptr
&& strcmp(ptr
, "Filesystem") == 0)
109 ptr
= strtok(NULL
, WS
);
111 ptr
= strtok(NULL
, WS
);
113 ptr
= strtok(NULL
, WS
);
115 ptr
= strtok(NULL
, WS
);
117 path
= strtok(NULL
, WS
);
134 do_cleanup(const char *path
)
136 struct hammer_ioc_pseudofs_rw pfs
;
137 union hammer_ioc_mrecord_any mrec_tmp
;
138 char *snapshots_path
;
149 struct didpfs
*didpfs
;
150 int snapshots_disabled
= 0;
151 int prune_warning
= 0;
155 bzero(&pfs
, sizeof(pfs
));
156 bzero(&mrec_tmp
, sizeof(mrec_tmp
));
157 pfs
.ondisk
= &mrec_tmp
.pfs
.pfsd
;
158 pfs
.bytes
= sizeof(mrec_tmp
.pfs
.pfsd
);
161 printf("cleanup %-20s -", path
);
162 fd
= open(path
, O_RDONLY
);
164 printf(" unable to access directory: %s\n", strerror(errno
));
167 if (ioctl(fd
, HAMMERIOC_GET_PSEUDOFS
, &pfs
) != 0) {
168 printf(" not a HAMMER filesystem: %s\n", strerror(errno
));
172 if (pfs
.version
!= HAMMER_IOC_PSEUDOFS_VERSION
) {
173 printf(" unrecognized HAMMER version\n");
178 * Make sure we have not already handled this PFS. Several nullfs
179 * mounts might alias the same PFS.
181 for (didpfs
= FirstPFS
; didpfs
; didpfs
= didpfs
->next
) {
182 if (bcmp(&didpfs
->uuid
, &mrec_tmp
.pfs
.pfsd
.unique_uuid
, sizeof(uuid_t
)) == 0) {
183 printf(" PFS #%d already handled\n", pfs
.pfs_id
);
187 didpfs
= malloc(sizeof(*didpfs
));
188 didpfs
->next
= FirstPFS
;
190 didpfs
->uuid
= mrec_tmp
.pfs
.pfsd
.unique_uuid
;
193 * Figure out where the snapshot directory is.
195 if (mrec_tmp
.pfs
.pfsd
.snapshots
[0] == '/') {
196 asprintf(&snapshots_path
, "%s", mrec_tmp
.pfs
.pfsd
.snapshots
);
197 } else if (mrec_tmp
.pfs
.pfsd
.snapshots
[0]) {
198 printf(" WARNING: pfs-slave's snapshots dir is not absolute\n");
200 } else if (mrec_tmp
.pfs
.pfsd
.mirror_flags
& HAMMER_PFSD_SLAVE
) {
201 printf(" WARNING: must configure snapshot dir for PFS slave\n");
202 printf("\tWe suggest <fs>/var/slaves/<name> where "
203 "<fs> is the base HAMMER fs\n");
204 printf("\tcontaining the slave\n");
207 asprintf(&snapshots_path
,
208 "%s%ssnapshots", path
, dividing_slash(path
));
212 * Create a snapshot directory if necessary, and a config file if
215 if (stat(snapshots_path
, &st
) < 0) {
216 if (mkdir(snapshots_path
, 0755) != 0) {
217 free(snapshots_path
);
218 printf(" unable to create snapshot dir \"%s\": %s\n",
219 snapshots_path
, strerror(errno
));
223 asprintf(&config_path
, "%s/config", snapshots_path
);
224 if ((fp
= fopen(config_path
, "r")) == NULL
) {
225 fp
= fopen(config_path
, "w");
227 printf(" cannot create %s: %s\n",
228 config_path
, strerror(errno
));
231 if (strcmp(path
, "/tmp") == 0 ||
232 strcmp(path
, "/var/tmp") == 0 ||
233 strcmp(path
, "/usr/obj") == 0) {
234 fprintf(fp
, "snapshots 0d 0d\n");
236 fprintf(fp
, "snapshots 1d 60d\n");
243 fp
= fopen(config_path
, "r");
246 printf(" cannot access %s: %s\n",
247 config_path
, strerror(errno
));
251 printf(" handle PFS #%d using %s\n", pfs
.pfs_id
, snapshots_path
);
254 * Process the config file
256 while (fgets(buf
, sizeof(buf
), fp
) != NULL
) {
257 cmd
= strtok(buf
, WS
);
261 if ((ptr
= strtok(NULL
, WS
)) != NULL
) {
262 arg1
= strtosecs(ptr
);
263 if ((ptr
= strtok(NULL
, WS
)) != NULL
) {
264 arg2
= strtosecs(ptr
);
265 arg3
= strtok(NULL
, WS
);
269 printf("%20s - ", cmd
);
273 if (strcmp(cmd
, "snapshots") == 0) {
275 if (arg2
&& check_softlinks(snapshots_path
)) {
276 printf("only removing old snapshots\n");
278 cleanup_softlinks(path
, snapshots_path
,
281 printf("disabled\n");
282 snapshots_disabled
= 1;
285 if (check_period(snapshots_path
, cmd
, arg1
, &savet
)) {
287 cleanup_softlinks(path
, snapshots_path
,
289 r
= cleanup_snapshots(path
, snapshots_path
,
294 } else if (arg1
== 0) {
296 * The commands following this check can't handle
297 * a period of 0, so call the feature disabled and
298 * ignore the directive.
300 printf("disabled\n");
301 } else if (strcmp(cmd
, "prune") == 0) {
302 if (check_period(snapshots_path
, cmd
, arg1
, &savet
)) {
304 printf("run - WARNING snapshot "
306 "but snapshots disabled\n");
310 r
= cleanup_prune(path
, snapshots_path
,
311 arg1
, arg2
, snapshots_disabled
);
315 } else if (strcmp(cmd
, "reblock") == 0) {
316 if (check_period(snapshots_path
, cmd
, arg1
, &savet
)) {
321 r
= cleanup_reblock(path
, snapshots_path
,
326 } else if (strcmp(cmd
, "recopy") == 0) {
327 if (check_period(snapshots_path
, cmd
, arg1
, &savet
)) {
332 r
= cleanup_recopy(path
, snapshots_path
,
338 printf("unknown directive\n");
342 save_period(snapshots_path
, cmd
, savet
);
354 val
= strtol(ptr
, &ptr
, 0);
368 errx(1, "illegal suffix converting %s\n", ptr
);
375 dividing_slash(const char *path
)
377 int len
= strlen(path
);
378 if (len
&& path
[len
-1] == '/')
385 * Check whether the desired period has elapsed since the last successful
386 * run. The run may take a while and cross a boundary so we remember the
387 * current time_t so we can save it later on.
389 * Periods in minutes, hours, or days are assumed to have been crossed
390 * if the local time crosses a minute, hour, or day boundary regardless
391 * of how close the last operation actually was.
394 check_period(const char *snapshots_path
, const char *cmd
, int arg1
,
405 localtime_r(savep
, &tp1
);
408 * Retrieve the start time of the last successful operation.
410 asprintf(&check_path
, "%s/.%s.period", snapshots_path
, cmd
);
411 fp
= fopen(check_path
, "r");
415 if (fgets(buf
, sizeof(buf
), fp
) == NULL
) {
421 lastt
= strtol(buf
, NULL
, 0);
422 localtime_r(&lastt
, &tp2
);
425 * Normalize the times. e.g. if asked to do something on a 1-day
426 * interval the operation will be performed as soon as the day
427 * turns over relative to the previous operation, even if the previous
428 * operation ran a few seconds ago just before midnight.
430 if (arg1
% 60 == 0) {
434 if (arg1
% (60 * 60) == 0) {
438 if (arg1
% (24 * 60 * 60) == 0) {
443 baset
= mktime(&tp1
);
444 lastt
= mktime(&tp2
);
447 printf("%lld vs %lld\n", (long long)(baset
- lastt
), (long long)arg1
);
450 if ((int)(baset
- lastt
) >= arg1
)
456 * Store the start time of the last successful operation.
459 save_period(const char *snapshots_path
, const char *cmd
,
466 asprintf(&ocheck_path
, "%s/.%s.period", snapshots_path
, cmd
);
467 asprintf(&ncheck_path
, "%s/.%s.period.new", snapshots_path
, cmd
);
468 fp
= fopen(ncheck_path
, "w");
469 fprintf(fp
, "0x%08llx\n", (long long)savet
);
471 rename(ncheck_path
, ocheck_path
);
476 * Simply count the number of softlinks in the snapshots dir
479 check_softlinks(const char *snapshots_path
)
487 if ((dir
= opendir(snapshots_path
)) != NULL
) {
488 while ((den
= readdir(dir
)) != NULL
) {
489 if (den
->d_name
[0] == '.')
491 asprintf(&fpath
, "%s/%s", snapshots_path
, den
->d_name
);
492 if (lstat(fpath
, &st
) == 0 && S_ISLNK(st
.st_mode
))
502 * Clean up expired softlinks in the snapshots dir
505 cleanup_softlinks(const char *path __unused
, const char *snapshots_path
,
506 int arg2
, char *arg3
)
514 if (strstr(arg3
, "any") != NULL
)
517 if ((dir
= opendir(snapshots_path
)) != NULL
) {
518 while ((den
= readdir(dir
)) != NULL
) {
519 if (den
->d_name
[0] == '.')
521 asprintf(&fpath
, "%s/%s", snapshots_path
, den
->d_name
);
522 if (lstat(fpath
, &st
) == 0 && S_ISLNK(st
.st_mode
) &&
523 (anylink
|| strncmp(den
->d_name
, "snap-", 5) == 0)
525 if (check_expired(den
->d_name
, arg2
)) {
527 printf(" expire %s\n",
540 * Take a softlink path in the form snap-yyyymmdd-hhmm and the
541 * expiration in seconds (arg2) and return non-zero if the softlink
545 check_expired(const char *fpath
, int arg2
)
556 while (*fpath
&& *fpath
!= '-' && *fpath
!= '.')
561 r
= sscanf(fpath
, "%4d%2d%2d-%2d%2d",
562 &year
, &month
, &day
, &hour
, &minute
);
565 bzero(&tm
, sizeof(tm
));
570 tm
.tm_mon
= month
- 1;
571 tm
.tm_year
= year
- 1900;
586 cleanup_snapshots(const char *path __unused
, const char *snapshots_path
,
587 int arg1 __unused
, int arg2 __unused
)
591 runcmd(&r
, "hammer snapshot %s %s", path
, snapshots_path
);
596 cleanup_prune(const char *path __unused
, const char *snapshots_path
,
597 int arg1 __unused
, int arg2
, int snapshots_disabled
)
600 * If snapshots have been disabled run prune-everything instead
603 if (snapshots_disabled
&& arg2
) {
604 runcmd(NULL
, "hammer -c %s/.prune.cycle -t %d prune-everything %s",
605 snapshots_path
, arg2
, path
);
606 } else if (snapshots_disabled
) {
607 runcmd(NULL
, "hammer prune-everything %s", path
);
609 runcmd(NULL
, "hammer -c %s/.prune.cycle -t %d prune %s",
610 snapshots_path
, arg2
, snapshots_path
);
612 runcmd(NULL
, "hammer prune %s", snapshots_path
);
618 cleanup_reblock(const char *path
, const char *snapshots_path
,
619 int arg1 __unused
, int arg2
)
621 if (VerboseOpt
== 0) {
626 "hammer -c %s/.reblock-1.cycle -t %d reblock-btree %s 95",
627 snapshots_path
, arg2
, path
);
628 if (VerboseOpt
== 0) {
633 "hammer -c %s/.reblock-2.cycle -t %d reblock-inodes %s 95",
634 snapshots_path
, arg2
, path
);
635 if (VerboseOpt
== 0) {
640 "hammer -c %s/.reblock-3.cycle -t %d reblock-data %s 95",
641 snapshots_path
, arg2
, path
);
648 cleanup_recopy(const char *path
, const char *snapshots_path
,
649 int arg1 __unused
, int arg2
)
651 if (VerboseOpt
== 0) {
656 "hammer -c %s/.recopy-1.cycle -t %d reblock-btree %s",
657 snapshots_path
, arg2
, path
);
658 if (VerboseOpt
== 0) {
663 "hammer -c %s/.recopy-2.cycle -t %d reblock-inodes %s",
664 snapshots_path
, arg2
, path
);
665 if (VerboseOpt
== 0) {
670 "hammer -c %s/.recopy-3.cycle -t %d reblock-data %s",
671 snapshots_path
, arg2
, path
);
679 runcmd(int *resp
, const char *ctl
, ...)
691 * Generate the command
694 vasprintf(&cmd
, ctl
, va
);
697 printf(" %s\n", cmd
);
700 * Break us down into arguments. We do not just use system() here
701 * because it blocks SIGINT and friends.
705 av
= malloc(sizeof(char *) * nmax
);
707 for (arg
= strtok(cmd
, WS
); arg
; arg
= strtok(NULL
, WS
)) {
710 av
= realloc(av
, sizeof(char *) * nmax
);
719 if ((pid
= fork()) == 0) {
720 if (VerboseOpt
< 2) {
721 int fd
= open("/dev/null", O_RDWR
);
727 } else if (pid
< 0) {
731 while (waitpid(pid
, &status
, 0) != pid
)
733 res
= WEXITSTATUS(status
);