2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2010-2012 Semihalf.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/systm.h>
35 #include <sys/kernel.h>
37 #include <sys/malloc.h>
38 #include <sys/mount.h>
39 #include <sys/mutex.h>
41 #include <sys/namei.h>
42 #include <sys/vnode.h>
45 #include <fs/nandfs/nandfs_mount.h>
46 #include <fs/nandfs/nandfs.h>
47 #include <fs/nandfs/nandfs_subr.h>
49 #define NANDFS_CLEANER_KILL 1
51 static void nandfs_cleaner(struct nandfs_device *);
52 static int nandfs_cleaner_clean_segments(struct nandfs_device *,
53 struct nandfs_vinfo *, uint32_t, struct nandfs_period *, uint32_t,
54 struct nandfs_bdesc *, uint32_t, uint64_t *, uint32_t);
57 nandfs_process_bdesc(struct nandfs_device *nffsdev, struct nandfs_bdesc *bd,
61 nandfs_wakeup_wait_cleaner(struct nandfs_device *fsdev, int reason)
64 mtx_lock(&fsdev->nd_clean_mtx);
65 if (reason == NANDFS_CLEANER_KILL)
66 fsdev->nd_cleaner_exit = 1;
67 if (fsdev->nd_cleaning == 0) {
68 fsdev->nd_cleaning = 1;
69 wakeup(&fsdev->nd_cleaning);
71 cv_wait(&fsdev->nd_clean_cv, &fsdev->nd_clean_mtx);
72 mtx_unlock(&fsdev->nd_clean_mtx);
76 nandfs_start_cleaner(struct nandfs_device *fsdev)
80 MPASS(fsdev->nd_cleaner == NULL);
82 fsdev->nd_cleaner_exit = 0;
84 error = kthread_add((void(*)(void *))nandfs_cleaner, fsdev, NULL,
85 &fsdev->nd_cleaner, 0, 0, "nandfs_cleaner");
87 printf("nandfs: could not start cleaner: %d\n", error);
93 nandfs_stop_cleaner(struct nandfs_device *fsdev)
96 MPASS(fsdev->nd_cleaner != NULL);
97 nandfs_wakeup_wait_cleaner(fsdev, NANDFS_CLEANER_KILL);
98 fsdev->nd_cleaner = NULL;
100 DPRINTF(CLEAN, ("cleaner stopped\n"));
105 nandfs_cleaner_finished(struct nandfs_device *fsdev)
109 mtx_lock(&fsdev->nd_clean_mtx);
110 fsdev->nd_cleaning = 0;
111 if (!fsdev->nd_cleaner_exit) {
112 DPRINTF(CLEAN, ("%s: sleep\n", __func__));
113 msleep(&fsdev->nd_cleaning, &fsdev->nd_clean_mtx, PRIBIO, "-",
114 hz * nandfs_cleaner_interval);
116 exit = fsdev->nd_cleaner_exit;
117 cv_broadcast(&fsdev->nd_clean_cv);
118 mtx_unlock(&fsdev->nd_clean_mtx);
120 DPRINTF(CLEAN, ("%s: no longer active\n", __func__));
128 print_suinfo(struct nandfs_suinfo *suinfo, int nsegs)
132 for (i = 0; i < nsegs; i++) {
133 DPRINTF(CLEAN, ("%jx %jd %c%c%c %10u\n",
134 suinfo[i].nsi_num, suinfo[i].nsi_lastmod,
135 (suinfo[i].nsi_flags &
136 (NANDFS_SEGMENT_USAGE_ACTIVE) ? 'a' : '-'),
137 (suinfo[i].nsi_flags &
138 (NANDFS_SEGMENT_USAGE_DIRTY) ? 'd' : '-'),
139 (suinfo[i].nsi_flags &
140 (NANDFS_SEGMENT_USAGE_ERROR) ? 'e' : '-'),
141 suinfo[i].nsi_blocks));
146 nandfs_cleaner_vblock_is_alive(struct nandfs_device *fsdev,
147 struct nandfs_vinfo *vinfo, struct nandfs_cpinfo *cp, uint32_t ncps)
149 int64_t idx, min, max;
151 if (vinfo->nvi_end >= fsdev->nd_last_cno)
157 if (vinfo->nvi_end < cp[0].nci_cno ||
158 vinfo->nvi_start > cp[ncps - 1].nci_cno)
164 idx = (min + max) / 2;
165 if (vinfo->nvi_start == cp[idx].nci_cno)
167 if (vinfo->nvi_start < cp[idx].nci_cno)
173 return (vinfo->nvi_end >= cp[idx].nci_cno);
177 nandfs_cleaner_vinfo_mark_alive(struct nandfs_device *fsdev,
178 struct nandfs_vinfo *vinfo, uint32_t nmembs, struct nandfs_cpinfo *cp,
183 for (i = 0; i < nmembs; i++)
185 nandfs_cleaner_vblock_is_alive(fsdev, &vinfo[i], cp, ncps);
189 nandfs_cleaner_bdesc_is_alive(struct nandfs_device *fsdev,
190 struct nandfs_bdesc *bdesc)
194 alive = bdesc->bd_oblocknr == bdesc->bd_blocknr;
196 MPASS(abs(bdesc->bd_oblocknr - bdesc->bd_blocknr) > 2);
202 nandfs_cleaner_bdesc_mark_alive(struct nandfs_device *fsdev,
203 struct nandfs_bdesc *bdesc, uint32_t nmembs)
207 for (i = 0; i < nmembs; i++)
208 bdesc[i].bd_alive = nandfs_cleaner_bdesc_is_alive(fsdev,
213 nandfs_cleaner_iterate_psegment(struct nandfs_device *fsdev,
214 struct nandfs_segment_summary *segsum, union nandfs_binfo *binfo,
215 nandfs_daddr_t blk, struct nandfs_vinfo **vipp, struct nandfs_bdesc **bdpp)
219 DPRINTF(CLEAN, ("%s nbinfos %x\n", __func__, segsum->ss_nbinfos));
220 for (i = 0; i < segsum->ss_nbinfos; i++) {
221 if (binfo[i].bi_v.bi_ino == NANDFS_DAT_INO) {
222 (*bdpp)->bd_oblocknr = blk + segsum->ss_nblocks -
223 segsum->ss_nbinfos + i;
227 if (segsum->ss_flags & NANDFS_SS_SR)
228 (*bdpp)->bd_oblocknr--;
229 (*bdpp)->bd_level = binfo[i].bi_dat.bi_level;
230 (*bdpp)->bd_offset = binfo[i].bi_dat.bi_blkoff;
233 (*vipp)->nvi_ino = binfo[i].bi_v.bi_ino;
234 (*vipp)->nvi_vblocknr = binfo[i].bi_v.bi_vblocknr;
241 nandfs_cleaner_iterate_segment(struct nandfs_device *fsdev, uint64_t segno,
242 struct nandfs_vinfo **vipp, struct nandfs_bdesc **bdpp, int *select)
244 struct nandfs_segment_summary *segsum;
245 union nandfs_binfo *binfo;
248 nandfs_daddr_t curr, start, end;
251 nandfs_get_segment_range(fsdev, segno, &start, &end);
253 DPRINTF(CLEAN, ("%s: segno %jx start %jx end %jx\n", __func__, segno,
258 for (curr = start; curr < end; curr += nblocks) {
259 error = nandfs_dev_bread(fsdev, curr, NOCRED, 0, &bp);
262 nandfs_error("%s: couldn't load segment summary of %jx: %d\n",
263 __func__, segno, error);
267 segsum = (struct nandfs_segment_summary *)bp->b_data;
268 binfo = (union nandfs_binfo *)(bp->b_data + segsum->ss_bytes);
270 if (!nandfs_segsum_valid(segsum)) {
272 nandfs_error("nandfs: invalid summary of segment %jx\n", segno);
276 DPRINTF(CLEAN, ("%s: %jx magic %x bytes %x nblocks %x nbinfos "
277 "%x\n", __func__, segno, segsum->ss_magic, segsum->ss_bytes,
278 segsum->ss_nblocks, segsum->ss_nbinfos));
280 nandfs_cleaner_iterate_psegment(fsdev, segsum, binfo, curr,
282 nblocks = segsum->ss_nblocks;
293 nandfs_cleaner_choose_segment(struct nandfs_device *fsdev, uint64_t **segpp,
294 uint64_t nsegs, uint64_t *rseg)
296 struct nandfs_suinfo *suinfo;
300 suinfo = malloc(sizeof(*suinfo) * nsegs, M_NANDFSTEMP,
303 if (*rseg >= fsdev->nd_fsdata.f_nsegments)
307 error = nandfs_get_segment_info_filter(fsdev, suinfo, nsegs, *rseg,
308 &ssegs, NANDFS_SEGMENT_USAGE_DIRTY,
309 NANDFS_SEGMENT_USAGE_ACTIVE | NANDFS_SEGMENT_USAGE_ERROR |
310 NANDFS_SEGMENT_USAGE_GC);
312 nandfs_error("%s:%d", __FILE__, __LINE__);
315 if (ssegs == 0 && *rseg != 0) {
320 print_suinfo(suinfo, ssegs);
322 for (i = 0; i < ssegs; i++) {
323 (**segpp) = suinfo[i].nsi_num;
326 *rseg = suinfo[i - 1].nsi_num + 1;
330 free(suinfo, M_NANDFSTEMP);
335 nandfs_cleaner_body(struct nandfs_device *fsdev, uint64_t *rseg)
337 struct nandfs_vinfo *vinfo, *vip, *vipi;
338 struct nandfs_bdesc *bdesc, *bdp, *bdpi;
339 struct nandfs_cpstat cpstat;
340 struct nandfs_cpinfo *cpinfo = NULL;
341 uint64_t *segnums, *segp;
342 int select, selected;
347 nsegs = nandfs_cleaner_segments;
349 vip = vinfo = malloc(sizeof(*vinfo) *
350 fsdev->nd_fsdata.f_blocks_per_segment * nsegs, M_NANDFSTEMP,
352 bdp = bdesc = malloc(sizeof(*bdesc) *
353 fsdev->nd_fsdata.f_blocks_per_segment * nsegs, M_NANDFSTEMP,
355 segp = segnums = malloc(sizeof(*segnums) * nsegs, M_NANDFSTEMP,
358 error = nandfs_cleaner_choose_segment(fsdev, &segp, nsegs, rseg);
360 nandfs_error("%s:%d", __FILE__, __LINE__);
368 for (i = 0; i < segp - segnums; i++) {
369 error = nandfs_cleaner_iterate_segment(fsdev, segnums[i], &vip,
373 * XXX deselect (see below)?
378 segnums[i] = NANDFS_NOSEGMENT;
380 error = nandfs_markgc_segment(fsdev, segnums[i]);
382 nandfs_error("%s:%d\n", __FILE__, __LINE__);
395 error = nandfs_get_cpstat(fsdev->nd_cp_node, &cpstat);
397 nandfs_error("%s:%d\n", __FILE__, __LINE__);
401 if (cpstat.ncp_nss != 0) {
402 cpinfo = malloc(sizeof(struct nandfs_cpinfo) * cpstat.ncp_nss,
403 M_NANDFSTEMP, M_WAITOK);
404 error = nandfs_get_cpinfo(fsdev->nd_cp_node, 1, NANDFS_SNAPSHOT,
405 cpinfo, cpstat.ncp_nss, NULL);
407 nandfs_error("%s:%d\n", __FILE__, __LINE__);
412 NANDFS_WRITELOCK(fsdev);
413 DPRINTF(CLEAN, ("%s: got lock\n", __func__));
415 error = nandfs_get_dat_vinfo(fsdev, vinfo, vip - vinfo);
417 nandfs_error("%s:%d\n", __FILE__, __LINE__);
421 nandfs_cleaner_vinfo_mark_alive(fsdev, vinfo, vip - vinfo, cpinfo,
424 error = nandfs_get_dat_bdescs(fsdev, bdesc, bdp - bdesc);
426 nandfs_error("%s:%d\n", __FILE__, __LINE__);
430 nandfs_cleaner_bdesc_mark_alive(fsdev, bdesc, bdp - bdesc);
432 DPRINTF(CLEAN, ("got:\n"));
433 for (vipi = vinfo; vipi < vip; vipi++) {
434 DPRINTF(CLEAN, ("v ino %jx vblocknr %jx start %jx end %jx "
435 "alive %d\n", vipi->nvi_ino, vipi->nvi_vblocknr,
436 vipi->nvi_start, vipi->nvi_end, vipi->nvi_alive));
438 for (bdpi = bdesc; bdpi < bdp; bdpi++) {
439 DPRINTF(CLEAN, ("b oblocknr %jx blocknr %jx offset %jx "
440 "alive %d\n", bdpi->bd_oblocknr, bdpi->bd_blocknr,
441 bdpi->bd_offset, bdpi->bd_alive));
443 DPRINTF(CLEAN, ("end list\n"));
445 error = nandfs_cleaner_clean_segments(fsdev, vinfo, vip - vinfo, NULL,
446 0, bdesc, bdp - bdesc, segnums, segp - segnums);
448 nandfs_error("%s:%d\n", __FILE__, __LINE__);
451 NANDFS_WRITEUNLOCK(fsdev);
453 free(cpinfo, M_NANDFSTEMP);
454 free(segnums, M_NANDFSTEMP);
455 free(bdesc, M_NANDFSTEMP);
456 free(vinfo, M_NANDFSTEMP);
462 nandfs_cleaner(struct nandfs_device *fsdev)
464 uint64_t checked_seg = 0;
467 while (!nandfs_cleaner_finished(fsdev)) {
468 if (!nandfs_cleaner_enable || rebooting)
471 DPRINTF(CLEAN, ("%s: run started\n", __func__));
473 fsdev->nd_cleaning = 1;
475 error = nandfs_cleaner_body(fsdev, &checked_seg);
477 DPRINTF(CLEAN, ("%s: run finished error %d\n", __func__,
481 DPRINTF(CLEAN, ("%s: exiting\n", __func__));
486 nandfs_cleaner_clean_segments(struct nandfs_device *nffsdev,
487 struct nandfs_vinfo *vinfo, uint32_t nvinfo,
488 struct nandfs_period *pd, uint32_t npd,
489 struct nandfs_bdesc *bdesc, uint32_t nbdesc,
490 uint64_t *segments, uint32_t nsegs)
492 struct nandfs_node *gc;
497 gc = nffsdev->nd_gc_node;
499 DPRINTF(CLEAN, ("%s: enter\n", __func__));
501 VOP_LOCK(NTOV(gc), LK_EXCLUSIVE);
502 for (i = 0; i < nvinfo; i++) {
503 if (!vinfo[i].nvi_alive)
505 DPRINTF(CLEAN, ("%s: read vblknr:%#jx blk:%#jx\n",
506 __func__, (uintmax_t)vinfo[i].nvi_vblocknr,
507 (uintmax_t)vinfo[i].nvi_blocknr));
508 error = nandfs_bread(nffsdev->nd_gc_node, vinfo[i].nvi_blocknr,
511 nandfs_error("%s:%d", __FILE__, __LINE__);
512 VOP_UNLOCK(NTOV(gc), 0);
515 nandfs_vblk_set(bp, vinfo[i].nvi_vblocknr);
516 nandfs_buf_set(bp, NANDFS_VBLK_ASSIGNED);
517 nandfs_dirty_buf(bp, 1);
519 VOP_UNLOCK(NTOV(gc), 0);
521 /* Delete checkpoints */
522 for (i = 0; i < npd; i++) {
523 DPRINTF(CLEAN, ("delete checkpoint: %jx\n",
524 (uintmax_t)pd[i].p_start));
525 error = nandfs_delete_cp(nffsdev->nd_cp_node, pd[i].p_start,
528 nandfs_error("%s:%d", __FILE__, __LINE__);
534 for (i = 0; i < nvinfo; i++) {
535 if (vinfo[i].nvi_alive)
537 DPRINTF(CLEAN, ("freeing vblknr: %jx\n", vinfo[i].nvi_vblocknr));
538 error = nandfs_vblock_free(nffsdev, vinfo[i].nvi_vblocknr);
540 nandfs_error("%s:%d", __FILE__, __LINE__);
545 error = nandfs_process_bdesc(nffsdev, bdesc, nbdesc);
547 nandfs_error("%s:%d", __FILE__, __LINE__);
551 /* Add segments to clean */
552 if (nffsdev->nd_free_count) {
553 nffsdev->nd_free_base = realloc(nffsdev->nd_free_base,
554 (nffsdev->nd_free_count + nsegs) * sizeof(uint64_t),
555 M_NANDFSTEMP, M_WAITOK | M_ZERO);
556 memcpy(&nffsdev->nd_free_base[nffsdev->nd_free_count], segments,
557 nsegs * sizeof(uint64_t));
558 nffsdev->nd_free_count += nsegs;
560 nffsdev->nd_free_base = malloc(nsegs * sizeof(uint64_t),
561 M_NANDFSTEMP, M_WAITOK|M_ZERO);
562 memcpy(nffsdev->nd_free_base, segments,
563 nsegs * sizeof(uint64_t));
564 nffsdev->nd_free_count = nsegs;
569 DPRINTF(CLEAN, ("%s: exit error %d\n", __func__, error));
575 nandfs_process_bdesc(struct nandfs_device *nffsdev, struct nandfs_bdesc *bd,
578 struct nandfs_node *dat_node;
583 dat_node = nffsdev->nd_dat_node;
585 VOP_LOCK(NTOV(dat_node), LK_EXCLUSIVE);
587 for (i = 0; i < nmembs; i++) {
590 DPRINTF(CLEAN, ("%s: idx %jx offset %jx\n",
591 __func__, i, bd[i].bd_offset));
592 if (bd[i].bd_level) {
593 error = nandfs_bread_meta(dat_node, bd[i].bd_offset,
596 nandfs_error("%s: cannot read dat node "
597 "level:%d\n", __func__, bd[i].bd_level);
599 VOP_UNLOCK(NTOV(dat_node), 0);
602 nandfs_dirty_buf_meta(bp, 1);
603 nandfs_bmap_dirty_blocks(VTON(bp->b_vp), bp, 1);
605 error = nandfs_bread(dat_node, bd[i].bd_offset, NULL,
608 nandfs_error("%s: cannot read dat node\n",
611 VOP_UNLOCK(NTOV(dat_node), 0);
614 nandfs_dirty_buf(bp, 1);
616 DPRINTF(CLEAN, ("%s: bp: %p\n", __func__, bp));
619 VOP_UNLOCK(NTOV(dat_node), 0);