fssvar.h revision 1.26 1 /* $NetBSD: fssvar.h,v 1.26 2011/11/29 19:17:03 bouyer Exp $ */
2
3 /*-
4 * Copyright (c) 2003, 2007 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Juergen Hannken-Illjes.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifndef _SYS_DEV_FSSVAR_H
33 #define _SYS_DEV_FSSVAR_H
34
35 #include <sys/simplelock.h>
36
37 #define FSS_UNCONFIG_ON_CLOSE 0x01 /* Unconfigure on last close */
38 #define FSS_UNLINK_ON_CREATE 0x02 /* Unlink backing store on create */
39
40 struct fss_set50 {
41 char *fss_mount; /* Mount point of file system */
42 char *fss_bstore; /* Path of backing store */
43 blksize_t fss_csize; /* Preferred cluster size */
44 };
45
46 struct fss_set {
47 char *fss_mount; /* Mount point of file system */
48 char *fss_bstore; /* Path of backing store */
49 blksize_t fss_csize; /* Preferred cluster size */
50 int fss_flags; /* Initial flags */
51 };
52
53 struct fss_get {
54 char fsg_mount[MNAMELEN]; /* Mount point of file system */
55 struct timeval fsg_time; /* Time this snapshot was taken */
56 blksize_t fsg_csize; /* Current cluster size */
57 blkcnt_t fsg_mount_size; /* # clusters on file system */
58 blkcnt_t fsg_bs_size; /* # clusters on backing store */
59 };
60
61 #define FSSIOCSET _IOW('F', 5, struct fss_set) /* Configure */
62 #define FSSIOCGET _IOR('F', 1, struct fss_get) /* Status */
63 #define FSSIOCCLR _IO('F', 2) /* Unconfigure */
64 #define FSSIOFSET _IOW('F', 3, int) /* Set flags */
65 #define FSSIOFGET _IOR('F', 4, int) /* Get flags */
66 #define FSSIOCSET50 _IOW('F', 0, struct fss_set50) /* Old configure */
67
68 #ifdef _KERNEL
69
70 #include <sys/bufq.h>
71
72 #define FSS_CLUSTER_MAX (1<<24) /* Upper bound of clusters. The
73 sc_copied map uses up to
74 FSS_CLUSTER_MAX/NBBY bytes */
75
76 /* Check if still valid */
77 #define FSS_ISVALID(sc) \
78 (((sc)->sc_flags & (FSS_ACTIVE|FSS_ERROR)) == FSS_ACTIVE)
79
80 /* Offset to cluster */
81 #define FSS_BTOCL(sc, off) \
82 ((off) >> (sc)->sc_clshift)
83
84 /* Cluster to offset */
85 #define FSS_CLTOB(sc, cl) \
86 ((off_t)(cl) << (sc)->sc_clshift)
87
88 /* Offset from start of cluster */
89 #define FSS_CLOFF(sc, off) \
90 ((off) & (sc)->sc_clmask)
91
92 /* Size of cluster */
93 #define FSS_CLSIZE(sc) \
94 (1 << (sc)->sc_clshift)
95
96 /* Offset to backing store block */
97 #define FSS_BTOFSB(sc, off) \
98 ((off) >> (sc)->sc_bs_bshift)
99
100 /* Backing store block to offset */
101 #define FSS_FSBTOB(sc, blk) \
102 ((off_t)(blk) << (sc)->sc_bs_bshift)
103
104 /* Offset from start of backing store block */
105 #define FSS_FSBOFF(sc, off) \
106 ((off) & (sc)->sc_bs_bmask)
107
108 /* Size of backing store block */
109 #define FSS_FSBSIZE(sc) \
110 (1 << (sc)->sc_bs_bshift)
111
112 typedef enum {
113 FSS_READ,
114 FSS_WRITE
115 } fss_io_type;
116
117 typedef enum {
118 FSS_CACHE_FREE = 0, /* Cache entry is free */
119 FSS_CACHE_BUSY = 1, /* Cache entry is read from device */
120 FSS_CACHE_VALID = 2 /* Cache entry contains valid data */
121 } fss_cache_type;
122
123 struct fss_cache {
124 fss_cache_type fc_type; /* Current state */
125 u_int32_t fc_cluster; /* Cluster number of this entry */
126 kcondvar_t fc_state_cv; /* Signals state change from busy */
127 void * fc_data; /* Data */
128 };
129
130 struct fss_softc {
131 device_t sc_dev; /* Self */
132 kmutex_t sc_slock; /* Protect this softc */
133 kmutex_t sc_lock; /* Sleep lock for fss_ioctl */
134 kcondvar_t sc_work_cv; /* Signals work for the kernel thread */
135 kcondvar_t sc_cache_cv; /* Signals free cache slot */
136 volatile int sc_flags; /* Flags */
137 #define FSS_ACTIVE 0x01 /* Snapshot is active */
138 #define FSS_ERROR 0x02 /* I/O error occurred */
139 #define FSS_BS_THREAD 0x04 /* Kernel thread is running */
140 #define FSS_PERSISTENT 0x20 /* File system internal snapshot */
141 #define FSS_CDEV_OPEN 0x40 /* character device open */
142 #define FSS_BDEV_OPEN 0x80 /* block device open */
143 int sc_uflags; /* User visible flags */
144 struct disk *sc_dkdev; /* Generic disk device info */
145 struct mount *sc_mount; /* Mount point */
146 char sc_mntname[MNAMELEN]; /* Mount point */
147 struct timeval sc_time; /* Time this snapshot was taken */
148 dev_t sc_bdev; /* Underlying block device */
149 struct vnode *sc_bs_vp; /* Our backing store */
150 int sc_bs_bshift; /* Shift of backing store block */
151 u_int32_t sc_bs_bmask; /* Mask of backing store block */
152 struct lwp *sc_bs_lwp; /* Our kernel thread */
153 int sc_clshift; /* Shift of cluster size */
154 u_int32_t sc_clmask; /* Mask of cluster size */
155 u_int32_t sc_clcount; /* # clusters in file system */
156 u_int8_t *sc_copied; /* Map of clusters already copied */
157 long sc_clresid; /* Bytes in last cluster */
158 int sc_cache_size; /* Number of entries in sc_cache */
159 struct fss_cache *sc_cache; /* Cluster cache */
160 struct bufq_state *sc_bufq; /* Transfer queue */
161 u_int32_t sc_clnext; /* Next free cluster on backing store */
162 int sc_indir_size; /* # clusters for indirect mapping */
163 u_int8_t *sc_indir_valid; /* Map of valid indirect clusters */
164 u_int32_t sc_indir_cur; /* Current indir cluster number */
165 int sc_indir_dirty; /* Current indir cluster modified */
166 u_int32_t *sc_indir_data; /* Current indir cluster data */
167 };
168
169 #endif /* _KERNEL */
170
171 #endif /* !_SYS_DEV_FSSVAR_H */
172