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>
40 #include <sys/namei.h>
41 #include <sys/sysctl.h>
42 #include <sys/vnode.h>
47 #include <vm/vm_param.h>
48 #include <vm/vm_kern.h>
49 #include <vm/vm_page.h>
51 #include "nandfs_mount.h"
53 #include "nandfs_subr.h"
57 nandfs_checkpoint_size(struct nandfs_device *fsdev)
60 return (fsdev->nd_fsdata.f_checkpoint_size);
64 nandfs_checkpoint_blk_offset(struct nandfs_device *fsdev, uint64_t cn,
65 uint64_t *blk, uint64_t *offset)
68 uint16_t cp_size, cp_per_blk;
70 KASSERT((cn), ("checkpoing cannot be zero"));
72 cp_size = fsdev->nd_fsdata.f_checkpoint_size;
73 cp_per_blk = fsdev->nd_blocksize / cp_size;
74 off = roundup(sizeof(struct nandfs_cpfile_header), cp_size) / cp_size;
77 *blk = off / cp_per_blk;
78 *offset = (off % cp_per_blk) * cp_size;
84 nandfs_checkpoint_blk_remaining(struct nandfs_device *fsdev, uint64_t cn,
85 uint64_t blk, uint64_t offset)
87 uint16_t cp_size, cp_remaining;
89 cp_size = fsdev->nd_fsdata.f_checkpoint_size;
90 cp_remaining = (fsdev->nd_blocksize - offset) / cp_size;
92 return (cp_remaining);
96 nandfs_get_checkpoint(struct nandfs_device *fsdev, struct nandfs_node *cp_node,
100 uint64_t blk, offset;
103 if (cn != fsdev->nd_last_cno && cn != (fsdev->nd_last_cno + 1)) {
107 error = nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
113 error = nandfs_dirty_buf(bp, 0);
118 nandfs_checkpoint_blk_offset(fsdev, cn, &blk, &offset);
121 if (blk < cp_node->nn_inode.i_blocks)
122 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
124 error = nandfs_bcreate(cp_node, blk, NOCRED, 0, &bp);
131 nandfs_dirty_buf(bp, 1);
134 DPRINTF(CPFILE, ("%s: cn:%#jx entry block:%#jx offset:%#jx\n",
135 __func__, (uintmax_t)cn, (uintmax_t)blk, (uintmax_t)offset));
141 nandfs_set_checkpoint(struct nandfs_device *fsdev, struct nandfs_node *cp_node,
142 uint64_t cn, struct nandfs_inode *ifile_inode, uint64_t nblocks)
144 struct nandfs_cpfile_header *cnh;
145 struct nandfs_checkpoint *cnp;
147 uint64_t blk, offset;
150 if (cn != fsdev->nd_last_cno && cn != (fsdev->nd_last_cno + 1)) {
151 nandfs_error("%s: trying to set invalid chekpoint %jx - %jx\n",
152 __func__, cn, fsdev->nd_last_cno);
156 error = nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
162 cnh = (struct nandfs_cpfile_header *) bp->b_data;
163 cnh->ch_ncheckpoints++;
165 nandfs_checkpoint_blk_offset(fsdev, cn, &blk, &offset);
169 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
176 cnp = (struct nandfs_checkpoint *)((uint8_t *)bp->b_data + offset);
178 cnp->cp_checkpoints_count = 1;
179 memset(&cnp->cp_snapshot_list, 0, sizeof(struct nandfs_snapshot_list));
181 cnp->cp_create = fsdev->nd_ts.tv_sec;
182 cnp->cp_nblk_inc = nblocks;
183 cnp->cp_blocks_count = 0;
184 memcpy (&cnp->cp_ifile_inode, ifile_inode, sizeof(cnp->cp_ifile_inode));
186 DPRINTF(CPFILE, ("%s: cn:%#jx ctime:%#jx nblk:%#jx\n",
187 __func__, (uintmax_t)cn, (uintmax_t)cnp->cp_create,
188 (uintmax_t)nblocks));
195 nandfs_cp_mounted(struct nandfs_device *nandfsdev, uint64_t cno)
197 struct nandfsmount *nmp;
200 mtx_lock(&nandfsdev->nd_mutex);
201 /* No double-mounting of the same checkpoint */
202 STAILQ_FOREACH(nmp, &nandfsdev->nd_mounts, nm_next_mount) {
203 if (nmp->nm_mount_args.cpno == cno) {
208 mtx_unlock(&nandfsdev->nd_mutex);
214 nandfs_cp_set_snapshot(struct nandfs_node *cp_node, uint64_t cno)
216 struct nandfs_device *fsdev;
217 struct nandfs_cpfile_header *cnh;
218 struct nandfs_checkpoint *cnp;
219 struct nandfs_snapshot_list *list;
221 uint64_t blk, prev_blk, offset;
225 fsdev = cp_node->nn_nandfsdev;
227 /* Get snapshot data */
228 nandfs_checkpoint_blk_offset(fsdev, cno, &blk, &offset);
229 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
234 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
235 if (cnp->cp_flags & NANDFS_CHECKPOINT_INVALID) {
239 if ((cnp->cp_flags & NANDFS_CHECKPOINT_SNAPSHOT)) {
245 /* Get list from header */
246 error = nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
252 cnh = (struct nandfs_cpfile_header *) bp->b_data;
253 list = &cnh->ch_snapshot_list;
254 prev = list->ssl_prev;
260 nandfs_checkpoint_blk_offset(fsdev, prev, &prev_blk, &offset);
261 error = nandfs_bread(cp_node, prev_blk, NOCRED, 0, &bp);
266 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
267 list = &cnp->cp_snapshot_list;
268 prev = list->ssl_prev;
273 nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
274 cnh = (struct nandfs_cpfile_header *) bp->b_data;
275 list = &cnh->ch_snapshot_list;
277 nandfs_checkpoint_blk_offset(fsdev, curr, &blk, &offset);
278 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
283 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
284 list = &cnp->cp_snapshot_list;
287 list->ssl_prev = cno;
288 error = nandfs_dirty_buf(bp, 0);
293 /* Update snapshot for cno */
294 nandfs_checkpoint_blk_offset(fsdev, cno, &blk, &offset);
295 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
300 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
301 list = &cnp->cp_snapshot_list;
302 list->ssl_prev = prev;
303 list->ssl_next = curr;
304 cnp->cp_flags |= NANDFS_CHECKPOINT_SNAPSHOT;
305 nandfs_dirty_buf(bp, 1);
308 nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
309 cnh = (struct nandfs_cpfile_header *) bp->b_data;
310 list = &cnh->ch_snapshot_list;
312 /* Update snapshot list for prev */
313 nandfs_checkpoint_blk_offset(fsdev, prev, &blk, &offset);
314 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
319 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
320 list = &cnp->cp_snapshot_list;
322 list->ssl_next = cno;
323 nandfs_dirty_buf(bp, 1);
326 error = nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
331 cnh = (struct nandfs_cpfile_header *) bp->b_data;
332 cnh->ch_nsnapshots++;
333 nandfs_dirty_buf(bp, 1);
339 nandfs_cp_clr_snapshot(struct nandfs_node *cp_node, uint64_t cno)
341 struct nandfs_device *fsdev;
342 struct nandfs_cpfile_header *cnh;
343 struct nandfs_checkpoint *cnp;
344 struct nandfs_snapshot_list *list;
346 uint64_t blk, offset, snapshot_cnt;
350 fsdev = cp_node->nn_nandfsdev;
352 /* Get snapshot data */
353 nandfs_checkpoint_blk_offset(fsdev, cno, &blk, &offset);
354 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
359 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
360 if (cnp->cp_flags & NANDFS_CHECKPOINT_INVALID) {
364 if (!(cnp->cp_flags & NANDFS_CHECKPOINT_SNAPSHOT)) {
369 list = &cnp->cp_snapshot_list;
370 next = list->ssl_next;
371 prev = list->ssl_prev;
374 /* Get previous snapshot */
376 nandfs_checkpoint_blk_offset(fsdev, prev, &blk, &offset);
377 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
382 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
383 list = &cnp->cp_snapshot_list;
385 nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
386 cnh = (struct nandfs_cpfile_header *) bp->b_data;
387 list = &cnh->ch_snapshot_list;
390 list->ssl_next = next;
391 error = nandfs_dirty_buf(bp, 0);
395 /* Get next snapshot */
397 nandfs_checkpoint_blk_offset(fsdev, next, &blk, &offset);
398 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
403 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
404 list = &cnp->cp_snapshot_list;
406 nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
407 cnh = (struct nandfs_cpfile_header *) bp->b_data;
408 list = &cnh->ch_snapshot_list;
410 list->ssl_prev = prev;
411 nandfs_dirty_buf(bp, 1);
413 /* Update snapshot list for cno */
414 nandfs_checkpoint_blk_offset(fsdev, cno, &blk, &offset);
415 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
420 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
421 list = &cnp->cp_snapshot_list;
424 cnp->cp_flags &= !NANDFS_CHECKPOINT_SNAPSHOT;
425 nandfs_dirty_buf(bp, 1);
428 error = nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
433 cnh = (struct nandfs_cpfile_header *) bp->b_data;
434 snapshot_cnt = cnh->ch_nsnapshots;
436 cnh->ch_nsnapshots = snapshot_cnt;
437 nandfs_dirty_buf(bp, 1);
443 nandfs_chng_cpmode(struct nandfs_node *node, struct nandfs_cpmode *ncpm)
445 struct nandfs_device *fsdev;
446 uint64_t cno = ncpm->ncpm_cno;
447 int mode = ncpm->ncpm_mode;
450 fsdev = node->nn_nandfsdev;
451 VOP_LOCK(NTOV(node), LK_EXCLUSIVE);
453 case NANDFS_CHECKPOINT:
454 if (nandfs_cp_mounted(fsdev, cno)) {
457 ret = nandfs_cp_clr_snapshot(node, cno);
459 case NANDFS_SNAPSHOT:
460 ret = nandfs_cp_set_snapshot(node, cno);
466 VOP_UNLOCK(NTOV(node), 0);
472 nandfs_cpinfo_fill(struct nandfs_checkpoint *cnp, struct nandfs_cpinfo *nci)
475 nci->nci_flags = cnp->cp_flags;
477 nci->nci_cno = cnp->cp_cno;
478 nci->nci_create = cnp->cp_create;
479 nci->nci_nblk_inc = cnp->cp_nblk_inc;
480 nci->nci_blocks_count = cnp->cp_blocks_count;
481 nci->nci_next = cnp->cp_snapshot_list.ssl_next;
482 DPRINTF(CPFILE, ("%s: cn:%#jx ctime:%#jx\n",
483 __func__, (uintmax_t)cnp->cp_cno,
484 (uintmax_t)cnp->cp_create));
488 nandfs_get_cpinfo_cp(struct nandfs_node *node, uint64_t cno,
489 struct nandfs_cpinfo *nci, uint32_t mnmembs, uint32_t *nmembs)
491 struct nandfs_device *fsdev;
493 uint64_t blk, offset, last_cno, i;
497 uint64_t testblk, testoffset;
508 fsdev = node->nn_nandfsdev;
509 last_cno = fsdev->nd_last_cno;
510 DPRINTF(CPFILE, ("%s: cno:%#jx mnmembs: %#jx last:%#jx\n", __func__,
511 (uintmax_t)cno, (uintmax_t)mnmembs,
512 (uintmax_t)fsdev->nd_last_cno));
517 * read checkpoints until we hit last checkpoint, end of block or
519 * } while (last read checkpoint <= last checkpoint on fs &&
520 * read checkpoints < request number);
524 nandfs_checkpoint_blk_offset(fsdev, cno, &blk, &offset);
525 remaining = nandfs_checkpoint_blk_remaining(fsdev, cno,
527 error = nandfs_bread(node, blk, NOCRED, 0, &bp);
533 while (cno <= last_cno && i < mnmembs && remaining) {
535 nandfs_checkpoint_blk_offset(fsdev, cno, &testblk,
537 KASSERT(testblk == blk, ("testblk != blk"));
538 KASSERT(testoffset == offset, ("testoffset != offset"));
540 DPRINTF(CPFILE, ("%s: cno %#jx\n", __func__,
543 nandfs_cpinfo_fill((struct nandfs_checkpoint *)
544 (bp->b_data + offset), nci);
545 offset += nandfs_checkpoint_size(fsdev);
553 } while (cno <= last_cno && i < mnmembs);
559 nandfs_get_cpinfo_sp(struct nandfs_node *node, uint64_t cno,
560 struct nandfs_cpinfo *nci, uint32_t mnmembs, uint32_t *nmembs)
562 struct nandfs_checkpoint *cnp;
563 struct nandfs_cpfile_header *cnh;
564 struct nandfs_device *fsdev;
565 struct buf *bp = NULL;
567 uint64_t blk, offset, curr_cno;
571 if (cno == 0 || cno == ~(0))
574 fsdev = node->nn_nandfsdev;
580 /* Get list from header */
581 error = nandfs_bread(node, 0, NOCRED, 0, &bp);
586 cnh = (struct nandfs_cpfile_header *) bp->b_data;
587 curr_cno = cnh->ch_snapshot_list.ssl_next;
596 for (i = 0; i < mnmembs; i++, nci++) {
597 nandfs_checkpoint_blk_offset(fsdev, curr_cno, &blk, &offset);
598 if (i == 0 || curr != blk) {
601 error = nandfs_bread(node, blk, NOCRED, 0, &bp);
608 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
609 flag = cnp->cp_flags;
610 if (!(flag & NANDFS_CHECKPOINT_SNAPSHOT) ||
611 (flag & NANDFS_CHECKPOINT_INVALID))
614 nci->nci_flags = flag;
616 nci->nci_cno = cnp->cp_cno;
617 nci->nci_create = cnp->cp_create;
618 nci->nci_nblk_inc = cnp->cp_nblk_inc;
619 nci->nci_blocks_count = cnp->cp_blocks_count;
620 nci->nci_next = cnp->cp_snapshot_list.ssl_next;
624 curr_cno = nci->nci_next;
635 nandfs_get_cpinfo(struct nandfs_node *node, uint64_t cno, uint16_t flags,
636 struct nandfs_cpinfo *nci, uint32_t nmembs, uint32_t *nnmembs)
640 VOP_LOCK(NTOV(node), LK_EXCLUSIVE);
642 case NANDFS_CHECKPOINT:
643 error = nandfs_get_cpinfo_cp(node, cno, nci, nmembs, nnmembs);
645 case NANDFS_SNAPSHOT:
646 error = nandfs_get_cpinfo_sp(node, cno, nci, nmembs, nnmembs);
652 VOP_UNLOCK(NTOV(node), 0);
658 nandfs_get_cpinfo_ioctl(struct nandfs_node *node, struct nandfs_argv *nargv)
660 struct nandfs_cpinfo *nci;
661 uint64_t cno = nargv->nv_index;
662 void *buf = (void *)((uintptr_t)nargv->nv_base);
663 uint16_t flags = nargv->nv_flags;
667 if (nargv->nv_nmembs > NANDFS_CPINFO_MAX)
670 nci = malloc(sizeof(struct nandfs_cpinfo) * nargv->nv_nmembs,
671 M_NANDFSTEMP, M_WAITOK | M_ZERO);
673 error = nandfs_get_cpinfo(node, cno, flags, nci, nargv->nv_nmembs, &nmembs);
676 nargv->nv_nmembs = nmembs;
677 error = copyout(nci, buf,
678 sizeof(struct nandfs_cpinfo) * nmembs);
681 free(nci, M_NANDFSTEMP);
686 nandfs_delete_cp(struct nandfs_node *node, uint64_t start, uint64_t end)
688 struct nandfs_checkpoint *cnp;
689 struct nandfs_device *fsdev;
691 uint64_t cno = start, blk, offset;
694 DPRINTF(CPFILE, ("%s: delete cno %jx-%jx\n", __func__, start, end));
695 VOP_LOCK(NTOV(node), LK_EXCLUSIVE);
696 fsdev = node->nn_nandfsdev;
697 for (cno = start; cno <= end; cno++) {
701 nandfs_checkpoint_blk_offset(fsdev, cno, &blk, &offset);
702 error = nandfs_bread(node, blk, NOCRED, 0, &bp);
704 VOP_UNLOCK(NTOV(node), 0);
709 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
710 if (cnp->cp_flags & NANDFS_CHECKPOINT_SNAPSHOT) {
712 VOP_UNLOCK(NTOV(node), 0);
716 cnp->cp_flags |= NANDFS_CHECKPOINT_INVALID;
718 error = nandfs_dirty_buf(bp, 0);
722 VOP_UNLOCK(NTOV(node), 0);
728 nandfs_make_snap(struct nandfs_device *fsdev, uint64_t *cno)
730 struct nandfs_cpmode cpm;
733 *cno = cpm.ncpm_cno = fsdev->nd_last_cno;
734 cpm.ncpm_mode = NANDFS_SNAPSHOT;
735 error = nandfs_chng_cpmode(fsdev->nd_cp_node, &cpm);
740 nandfs_delete_snap(struct nandfs_device *fsdev, uint64_t cno)
742 struct nandfs_cpmode cpm;
746 cpm.ncpm_mode = NANDFS_CHECKPOINT;
747 error = nandfs_chng_cpmode(fsdev->nd_cp_node, &cpm);
751 int nandfs_get_cpstat(struct nandfs_node *cp_node, struct nandfs_cpstat *ncp)
753 struct nandfs_device *fsdev;
754 struct nandfs_cpfile_header *cnh;
758 VOP_LOCK(NTOV(cp_node), LK_EXCLUSIVE);
759 fsdev = cp_node->nn_nandfsdev;
762 error = nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
765 VOP_UNLOCK(NTOV(cp_node), 0);
768 cnh = (struct nandfs_cpfile_header *) bp->b_data;
769 ncp->ncp_cno = fsdev->nd_last_cno;
770 ncp->ncp_ncps = cnh->ch_ncheckpoints;
771 ncp->ncp_nss = cnh->ch_nsnapshots;
772 DPRINTF(CPFILE, ("%s: cno:%#jx ncps:%#jx nss:%#jx\n",
773 __func__, ncp->ncp_cno, ncp->ncp_ncps, ncp->ncp_nss));
775 VOP_UNLOCK(NTOV(cp_node), 0);