2 * Copyright (c) 2010-2012 Semihalf.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
33 #include <sys/kernel.h>
35 #include <sys/malloc.h>
36 #include <sys/mount.h>
37 #include <sys/mutex.h>
38 #include <sys/namei.h>
39 #include <sys/sysctl.h>
40 #include <sys/vnode.h>
45 #include <vm/vm_param.h>
46 #include <vm/vm_kern.h>
47 #include <vm/vm_page.h>
49 #include "nandfs_mount.h"
51 #include "nandfs_subr.h"
55 nandfs_checkpoint_size(struct nandfs_device *fsdev)
58 return (fsdev->nd_fsdata.f_checkpoint_size);
62 nandfs_checkpoint_blk_offset(struct nandfs_device *fsdev, uint64_t cn,
63 uint64_t *blk, uint64_t *offset)
66 uint16_t cp_size, cp_per_blk;
68 KASSERT((cn), ("checkpoing cannot be zero"));
70 cp_size = fsdev->nd_fsdata.f_checkpoint_size;
71 cp_per_blk = fsdev->nd_blocksize / cp_size;
72 off = roundup(sizeof(struct nandfs_cpfile_header), cp_size) / cp_size;
75 *blk = off / cp_per_blk;
76 *offset = (off % cp_per_blk) * cp_size;
82 nandfs_checkpoint_blk_remaining(struct nandfs_device *fsdev, uint64_t cn,
83 uint64_t blk, uint64_t offset)
85 uint16_t cp_size, cp_remaining;
87 cp_size = fsdev->nd_fsdata.f_checkpoint_size;
88 cp_remaining = (fsdev->nd_blocksize - offset) / cp_size;
90 return (cp_remaining);
94 nandfs_get_checkpoint(struct nandfs_device *fsdev, struct nandfs_node *cp_node,
101 if (cn != fsdev->nd_last_cno && cn != (fsdev->nd_last_cno + 1)) {
105 error = nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
111 error = nandfs_dirty_buf(bp, 0);
116 nandfs_checkpoint_blk_offset(fsdev, cn, &blk, &offset);
119 if (blk < cp_node->nn_inode.i_blocks)
120 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
122 error = nandfs_bcreate(cp_node, blk, NOCRED, 0, &bp);
129 nandfs_dirty_buf(bp, 1);
132 DPRINTF(CPFILE, ("%s: cn:%#jx entry block:%#jx offset:%#jx\n",
133 __func__, (uintmax_t)cn, (uintmax_t)blk, (uintmax_t)offset));
139 nandfs_set_checkpoint(struct nandfs_device *fsdev, struct nandfs_node *cp_node,
140 uint64_t cn, struct nandfs_inode *ifile_inode, uint64_t nblocks)
142 struct nandfs_cpfile_header *cnh;
143 struct nandfs_checkpoint *cnp;
145 uint64_t blk, offset;
148 if (cn != fsdev->nd_last_cno && cn != (fsdev->nd_last_cno + 1)) {
149 nandfs_error("%s: trying to set invalid chekpoint %jx - %jx\n",
150 __func__, cn, fsdev->nd_last_cno);
154 error = nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
160 cnh = (struct nandfs_cpfile_header *) bp->b_data;
161 cnh->ch_ncheckpoints++;
163 nandfs_checkpoint_blk_offset(fsdev, cn, &blk, &offset);
167 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
174 cnp = (struct nandfs_checkpoint *)((uint8_t *)bp->b_data + offset);
176 cnp->cp_checkpoints_count = 1;
177 memset(&cnp->cp_snapshot_list, 0, sizeof(struct nandfs_snapshot_list));
179 cnp->cp_create = fsdev->nd_ts.tv_sec;
180 cnp->cp_nblk_inc = nblocks;
181 cnp->cp_blocks_count = 0;
182 memcpy (&cnp->cp_ifile_inode, ifile_inode, sizeof(cnp->cp_ifile_inode));
184 DPRINTF(CPFILE, ("%s: cn:%#jx ctime:%#jx nblk:%#jx\n",
185 __func__, (uintmax_t)cn, (uintmax_t)cnp->cp_create,
186 (uintmax_t)nblocks));
193 nandfs_cp_mounted(struct nandfs_device *nandfsdev, uint64_t cno)
195 struct nandfsmount *nmp;
198 mtx_lock(&nandfsdev->nd_mutex);
199 /* No double-mounting of the same checkpoint */
200 STAILQ_FOREACH(nmp, &nandfsdev->nd_mounts, nm_next_mount) {
201 if (nmp->nm_mount_args.cpno == cno) {
206 mtx_unlock(&nandfsdev->nd_mutex);
212 nandfs_cp_set_snapshot(struct nandfs_node *cp_node, uint64_t cno)
214 struct nandfs_device *fsdev;
215 struct nandfs_cpfile_header *cnh;
216 struct nandfs_checkpoint *cnp;
217 struct nandfs_snapshot_list *list;
219 uint64_t blk, prev_blk, offset;
223 fsdev = cp_node->nn_nandfsdev;
225 /* Get snapshot data */
226 nandfs_checkpoint_blk_offset(fsdev, cno, &blk, &offset);
227 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
232 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
233 if (cnp->cp_flags & NANDFS_CHECKPOINT_INVALID) {
237 if ((cnp->cp_flags & NANDFS_CHECKPOINT_SNAPSHOT)) {
243 /* Get list from header */
244 error = nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
250 cnh = (struct nandfs_cpfile_header *) bp->b_data;
251 list = &cnh->ch_snapshot_list;
252 prev = list->ssl_prev;
258 nandfs_checkpoint_blk_offset(fsdev, prev, &prev_blk, &offset);
259 error = nandfs_bread(cp_node, prev_blk, NOCRED, 0, &bp);
264 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
265 list = &cnp->cp_snapshot_list;
266 prev = list->ssl_prev;
271 nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
272 cnh = (struct nandfs_cpfile_header *) bp->b_data;
273 list = &cnh->ch_snapshot_list;
275 nandfs_checkpoint_blk_offset(fsdev, curr, &blk, &offset);
276 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
281 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
282 list = &cnp->cp_snapshot_list;
285 list->ssl_prev = cno;
286 error = nandfs_dirty_buf(bp, 0);
291 /* Update snapshot for cno */
292 nandfs_checkpoint_blk_offset(fsdev, cno, &blk, &offset);
293 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
298 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
299 list = &cnp->cp_snapshot_list;
300 list->ssl_prev = prev;
301 list->ssl_next = curr;
302 cnp->cp_flags |= NANDFS_CHECKPOINT_SNAPSHOT;
303 nandfs_dirty_buf(bp, 1);
306 nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
307 cnh = (struct nandfs_cpfile_header *) bp->b_data;
308 list = &cnh->ch_snapshot_list;
310 /* Update snapshot list for prev */
311 nandfs_checkpoint_blk_offset(fsdev, prev, &blk, &offset);
312 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
317 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
318 list = &cnp->cp_snapshot_list;
320 list->ssl_next = cno;
321 nandfs_dirty_buf(bp, 1);
324 error = nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
329 cnh = (struct nandfs_cpfile_header *) bp->b_data;
330 cnh->ch_nsnapshots++;
331 nandfs_dirty_buf(bp, 1);
337 nandfs_cp_clr_snapshot(struct nandfs_node *cp_node, uint64_t cno)
339 struct nandfs_device *fsdev;
340 struct nandfs_cpfile_header *cnh;
341 struct nandfs_checkpoint *cnp;
342 struct nandfs_snapshot_list *list;
344 uint64_t blk, offset, snapshot_cnt;
348 fsdev = cp_node->nn_nandfsdev;
350 /* Get snapshot data */
351 nandfs_checkpoint_blk_offset(fsdev, cno, &blk, &offset);
352 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
357 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
358 if (cnp->cp_flags & NANDFS_CHECKPOINT_INVALID) {
362 if (!(cnp->cp_flags & NANDFS_CHECKPOINT_SNAPSHOT)) {
367 list = &cnp->cp_snapshot_list;
368 next = list->ssl_next;
369 prev = list->ssl_prev;
372 /* Get previous snapshot */
374 nandfs_checkpoint_blk_offset(fsdev, prev, &blk, &offset);
375 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
380 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
381 list = &cnp->cp_snapshot_list;
383 nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
384 cnh = (struct nandfs_cpfile_header *) bp->b_data;
385 list = &cnh->ch_snapshot_list;
388 list->ssl_next = next;
389 error = nandfs_dirty_buf(bp, 0);
393 /* Get next snapshot */
395 nandfs_checkpoint_blk_offset(fsdev, next, &blk, &offset);
396 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
401 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
402 list = &cnp->cp_snapshot_list;
404 nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
405 cnh = (struct nandfs_cpfile_header *) bp->b_data;
406 list = &cnh->ch_snapshot_list;
408 list->ssl_prev = prev;
409 nandfs_dirty_buf(bp, 1);
411 /* Update snapshot list for cno */
412 nandfs_checkpoint_blk_offset(fsdev, cno, &blk, &offset);
413 error = nandfs_bread(cp_node, blk, NOCRED, 0, &bp);
418 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
419 list = &cnp->cp_snapshot_list;
422 cnp->cp_flags &= !NANDFS_CHECKPOINT_SNAPSHOT;
423 nandfs_dirty_buf(bp, 1);
426 error = nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
431 cnh = (struct nandfs_cpfile_header *) bp->b_data;
432 snapshot_cnt = cnh->ch_nsnapshots;
434 cnh->ch_nsnapshots = snapshot_cnt;
435 nandfs_dirty_buf(bp, 1);
441 nandfs_chng_cpmode(struct nandfs_node *node, struct nandfs_cpmode *ncpm)
443 struct nandfs_device *fsdev;
444 uint64_t cno = ncpm->ncpm_cno;
445 int mode = ncpm->ncpm_mode;
448 fsdev = node->nn_nandfsdev;
449 VOP_LOCK(NTOV(node), LK_EXCLUSIVE);
451 case NANDFS_CHECKPOINT:
452 if (nandfs_cp_mounted(fsdev, cno)) {
455 ret = nandfs_cp_clr_snapshot(node, cno);
457 case NANDFS_SNAPSHOT:
458 ret = nandfs_cp_set_snapshot(node, cno);
464 VOP_UNLOCK(NTOV(node), 0);
470 nandfs_cpinfo_fill(struct nandfs_checkpoint *cnp, struct nandfs_cpinfo *nci)
473 nci->nci_flags = cnp->cp_flags;
475 nci->nci_cno = cnp->cp_cno;
476 nci->nci_create = cnp->cp_create;
477 nci->nci_nblk_inc = cnp->cp_nblk_inc;
478 nci->nci_blocks_count = cnp->cp_blocks_count;
479 nci->nci_next = cnp->cp_snapshot_list.ssl_next;
480 DPRINTF(CPFILE, ("%s: cn:%#jx ctime:%#jx\n",
481 __func__, (uintmax_t)cnp->cp_cno,
482 (uintmax_t)cnp->cp_create));
486 nandfs_get_cpinfo_cp(struct nandfs_node *node, uint64_t cno,
487 struct nandfs_cpinfo *nci, uint32_t mnmembs, uint32_t *nmembs)
489 struct nandfs_device *fsdev;
491 uint64_t blk, offset, last_cno, i;
495 uint64_t testblk, testoffset;
506 fsdev = node->nn_nandfsdev;
507 last_cno = fsdev->nd_last_cno;
508 DPRINTF(CPFILE, ("%s: cno:%#jx mnmembs: %#jx last:%#jx\n", __func__,
509 (uintmax_t)cno, (uintmax_t)mnmembs,
510 (uintmax_t)fsdev->nd_last_cno));
515 * read checkpoints until we hit last checkpoint, end of block or
517 * } while (last read checkpoint <= last checkpoint on fs &&
518 * read checkpoints < request number);
522 nandfs_checkpoint_blk_offset(fsdev, cno, &blk, &offset);
523 remaining = nandfs_checkpoint_blk_remaining(fsdev, cno,
525 error = nandfs_bread(node, blk, NOCRED, 0, &bp);
531 while (cno <= last_cno && i < mnmembs && remaining) {
533 nandfs_checkpoint_blk_offset(fsdev, cno, &testblk,
535 KASSERT(testblk == blk, ("testblk != blk"));
536 KASSERT(testoffset == offset, ("testoffset != offset"));
538 DPRINTF(CPFILE, ("%s: cno %#jx\n", __func__,
541 nandfs_cpinfo_fill((struct nandfs_checkpoint *)
542 (bp->b_data + offset), nci);
543 offset += nandfs_checkpoint_size(fsdev);
551 } while (cno <= last_cno && i < mnmembs);
557 nandfs_get_cpinfo_sp(struct nandfs_node *node, uint64_t cno,
558 struct nandfs_cpinfo *nci, uint32_t mnmembs, uint32_t *nmembs)
560 struct nandfs_checkpoint *cnp;
561 struct nandfs_cpfile_header *cnh;
562 struct nandfs_device *fsdev;
563 struct buf *bp = NULL;
565 uint64_t blk, offset, curr_cno;
569 if (cno == 0 || cno == ~(0))
572 fsdev = node->nn_nandfsdev;
578 /* Get list from header */
579 error = nandfs_bread(node, 0, NOCRED, 0, &bp);
584 cnh = (struct nandfs_cpfile_header *) bp->b_data;
585 curr_cno = cnh->ch_snapshot_list.ssl_next;
594 for (i = 0; i < mnmembs; i++, nci++) {
595 nandfs_checkpoint_blk_offset(fsdev, curr_cno, &blk, &offset);
596 if (i == 0 || curr != blk) {
599 error = nandfs_bread(node, blk, NOCRED, 0, &bp);
606 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
607 flag = cnp->cp_flags;
608 if (!(flag & NANDFS_CHECKPOINT_SNAPSHOT) ||
609 (flag & NANDFS_CHECKPOINT_INVALID))
612 nci->nci_flags = flag;
614 nci->nci_cno = cnp->cp_cno;
615 nci->nci_create = cnp->cp_create;
616 nci->nci_nblk_inc = cnp->cp_nblk_inc;
617 nci->nci_blocks_count = cnp->cp_blocks_count;
618 nci->nci_next = cnp->cp_snapshot_list.ssl_next;
622 curr_cno = nci->nci_next;
633 nandfs_get_cpinfo(struct nandfs_node *node, uint64_t cno, uint16_t flags,
634 struct nandfs_cpinfo *nci, uint32_t nmembs, uint32_t *nnmembs)
638 VOP_LOCK(NTOV(node), LK_EXCLUSIVE);
640 case NANDFS_CHECKPOINT:
641 error = nandfs_get_cpinfo_cp(node, cno, nci, nmembs, nnmembs);
643 case NANDFS_SNAPSHOT:
644 error = nandfs_get_cpinfo_sp(node, cno, nci, nmembs, nnmembs);
650 VOP_UNLOCK(NTOV(node), 0);
656 nandfs_get_cpinfo_ioctl(struct nandfs_node *node, struct nandfs_argv *nargv)
658 struct nandfs_cpinfo *nci;
659 uint64_t cno = nargv->nv_index;
660 void *buf = (void *)((uintptr_t)nargv->nv_base);
661 uint16_t flags = nargv->nv_flags;
665 if (nargv->nv_nmembs > NANDFS_CPINFO_MAX)
668 nci = malloc(sizeof(struct nandfs_cpinfo) * nargv->nv_nmembs,
669 M_NANDFSTEMP, M_WAITOK | M_ZERO);
671 error = nandfs_get_cpinfo(node, cno, flags, nci, nargv->nv_nmembs, &nmembs);
674 nargv->nv_nmembs = nmembs;
675 error = copyout(nci, buf,
676 sizeof(struct nandfs_cpinfo) * nmembs);
679 free(nci, M_NANDFSTEMP);
684 nandfs_delete_cp(struct nandfs_node *node, uint64_t start, uint64_t end)
686 struct nandfs_checkpoint *cnp;
687 struct nandfs_device *fsdev;
689 uint64_t cno = start, blk, offset;
692 DPRINTF(CPFILE, ("%s: delete cno %jx-%jx\n", __func__, start, end));
693 VOP_LOCK(NTOV(node), LK_EXCLUSIVE);
694 fsdev = node->nn_nandfsdev;
695 for (cno = start; cno <= end; cno++) {
699 nandfs_checkpoint_blk_offset(fsdev, cno, &blk, &offset);
700 error = nandfs_bread(node, blk, NOCRED, 0, &bp);
702 VOP_UNLOCK(NTOV(node), 0);
707 cnp = (struct nandfs_checkpoint *)(bp->b_data + offset);
708 if (cnp->cp_flags & NANDFS_CHECKPOINT_SNAPSHOT) {
710 VOP_UNLOCK(NTOV(node), 0);
714 cnp->cp_flags |= NANDFS_CHECKPOINT_INVALID;
716 error = nandfs_dirty_buf(bp, 0);
720 VOP_UNLOCK(NTOV(node), 0);
726 nandfs_make_snap(struct nandfs_device *fsdev, uint64_t *cno)
728 struct nandfs_cpmode cpm;
731 *cno = cpm.ncpm_cno = fsdev->nd_last_cno;
732 cpm.ncpm_mode = NANDFS_SNAPSHOT;
733 error = nandfs_chng_cpmode(fsdev->nd_cp_node, &cpm);
738 nandfs_delete_snap(struct nandfs_device *fsdev, uint64_t cno)
740 struct nandfs_cpmode cpm;
744 cpm.ncpm_mode = NANDFS_CHECKPOINT;
745 error = nandfs_chng_cpmode(fsdev->nd_cp_node, &cpm);
749 int nandfs_get_cpstat(struct nandfs_node *cp_node, struct nandfs_cpstat *ncp)
751 struct nandfs_device *fsdev;
752 struct nandfs_cpfile_header *cnh;
756 VOP_LOCK(NTOV(cp_node), LK_EXCLUSIVE);
757 fsdev = cp_node->nn_nandfsdev;
760 error = nandfs_bread(cp_node, 0, NOCRED, 0, &bp);
763 VOP_UNLOCK(NTOV(cp_node), 0);
766 cnh = (struct nandfs_cpfile_header *) bp->b_data;
767 ncp->ncp_cno = fsdev->nd_last_cno;
768 ncp->ncp_ncps = cnh->ch_ncheckpoints;
769 ncp->ncp_nss = cnh->ch_nsnapshots;
770 DPRINTF(CPFILE, ("%s: cno:%#jx ncps:%#jx nss:%#jx\n",
771 __func__, ncp->ncp_cno, ncp->ncp_ncps, ncp->ncp_nss));
773 VOP_UNLOCK(NTOV(cp_node), 0);