fssvar.h revision 1.8 1 /* $NetBSD: fssvar.h,v 1.8 2005/02/27 00:26:58 perry Exp $ */
2
3 /*-
4 * Copyright (c) 2003 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 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the NetBSD
21 * Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 * contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
39 #ifndef _SYS_DEV_FSSVAR_H
40 #define _SYS_DEV_FSSVAR_H
41
42 struct fss_set {
43 char *fss_mount; /* Mount point of file system */
44 char *fss_bstore; /* Path of backing store */
45 blksize_t fss_csize; /* Preferred cluster size */
46 };
47
48 struct fss_get {
49 char fsg_mount[MNAMELEN]; /* Mount point of file system */
50 struct timeval fsg_time; /* Time this snapshot was taken */
51 blksize_t fsg_csize; /* Current cluster size */
52 blkcnt_t fsg_mount_size; /* # clusters on file system */
53 blkcnt_t fsg_bs_size; /* # clusters on backing store */
54 };
55
56 #define FSSIOCSET _IOW('F', 0, struct fss_set) /* Configure */
57 #define FSSIOCGET _IOR('F', 1, struct fss_get) /* Status */
58 #define FSSIOCCLR _IO('F', 2) /* Unconfigure */
59
60 #ifdef _KERNEL
61
62 #include <sys/bufq.h>
63
64 #define FSS_CLUSTER_MAX (1<<24) /* Upper bound of clusters. The
65 sc_copied map uses up to
66 FSS_CLUSTER_MAX/NBBY bytes */
67
68 #define FSS_LOCK(sc, s) \
69 do { \
70 (s) = splbio(); \
71 simple_lock(&(sc)->sc_slock); \
72 } while (/*CONSTCOND*/0)
73
74 #define FSS_UNLOCK(sc, s) \
75 do { \
76 simple_unlock(&(sc)->sc_slock); \
77 splx((s)); \
78 } while (/*CONSTCOND*/0)
79
80 /* Device to softc, NULL on error */
81 #define FSS_DEV_TO_SOFTC(dev) \
82 (minor((dev)) < 0 || minor((dev)) >= NFSS ? NULL : \
83 &fss_softc[minor((dev))])
84
85 /* Check if still valid */
86 #define FSS_ISVALID(sc) \
87 (((sc)->sc_flags & (FSS_ACTIVE|FSS_ERROR)) == FSS_ACTIVE)
88
89 /* Offset to cluster */
90 #define FSS_BTOCL(sc, off) \
91 ((off) >> (sc)->sc_clshift)
92
93 /* Cluster to offset */
94 #define FSS_CLTOB(sc, cl) \
95 ((off_t)(cl) << (sc)->sc_clshift)
96
97 /* Offset from start of cluster */
98 #define FSS_CLOFF(sc, off) \
99 ((off) & (sc)->sc_clmask)
100
101 /* Size of cluster */
102 #define FSS_CLSIZE(sc) \
103 (1 << (sc)->sc_clshift)
104
105 /* Offset to backing store block */
106 #define FSS_BTOFSB(sc, off) \
107 ((off) >> (sc)->sc_bs_bshift)
108
109 /* Backing store block to offset */
110 #define FSS_FSBTOB(sc, blk) \
111 ((off_t)(blk) << (sc)->sc_bs_bshift)
112
113 /* Offset from start of backing store block */
114 #define FSS_FSBOFF(sc, off) \
115 ((off) & (sc)->sc_bs_bmask)
116
117 /* Size of backing store block */
118 #define FSS_FSBSIZE(sc) \
119 (1 << (sc)->sc_bs_bshift)
120
121 typedef enum {
122 FSS_READ,
123 FSS_WRITE
124 } fss_io_type;
125
126 typedef enum {
127 FSS_CACHE_FREE = 0, /* Cache entry is free */
128 FSS_CACHE_BUSY = 1, /* Cache entry is read from device */
129 FSS_CACHE_VALID = 2 /* Cache entry contains valid data */
130 } fss_cache_type;
131
132 struct fss_cache {
133 fss_cache_type fc_type; /* Current state */
134 struct fss_softc *fc_softc; /* Backlink to our softc */
135 volatile int fc_xfercount; /* Number of outstanding transfers */
136 u_int32_t fc_cluster; /* Cluster number of this entry */
137 caddr_t fc_data; /* Data */
138 };
139
140 struct fss_softc {
141 int sc_unit; /* Logical unit number */
142 struct simplelock sc_slock; /* Protect this softc */
143 volatile int sc_flags; /* Flags */
144 #define FSS_ACTIVE 0x01 /* Snapshot is active */
145 #define FSS_ERROR 0x02 /* I/O error occurred */
146 #define FSS_BS_THREAD 0x04 /* Kernel thread is running */
147 #define FSS_EXCL 0x08 /* Exclusive access granted */
148 #define FSS_BS_ALLOC 0x10 /* Allocate backing store */
149 #define FSS_PERSISTENT 0x20 /* File system internal snapshot */
150 struct mount *sc_mount; /* Mount point */
151 char sc_mntname[MNAMELEN]; /* Mount point */
152 struct timeval sc_time; /* Time this snapshot was taken */
153 dev_t sc_bdev; /* Underlying block device */
154 struct vnode *sc_mount_vp; /* Underlying spec vnode */
155 struct vnode *sc_bs_vp; /* Our backing store */
156 off_t sc_bs_size; /* Its size in bytes */
157 int sc_bs_bshift; /* Shift of backing store block */
158 u_int32_t sc_bs_bmask; /* Mask of backing store block */
159 struct proc *sc_bs_proc; /* Our kernel thread */
160 int sc_clshift; /* Shift of cluster size */
161 u_int32_t sc_clmask; /* Mask of cluster size */
162 u_int32_t sc_clcount; /* # clusters in file system */
163 u_int8_t *sc_copied; /* Map of clusters already copied */
164 long sc_clresid; /* Bytes in last cluster */
165 int sc_cache_size; /* Number of entries in sc_cache */
166 struct fss_cache *sc_cache; /* Cluster cache */
167 struct bufq_state sc_bufq; /* Transfer queue */
168 u_int32_t sc_clnext; /* Next free cluster on backing store */
169 int sc_indir_size; /* # clusters for indirect mapping */
170 u_int8_t *sc_indir_valid; /* Map of valid indirect clusters */
171 u_int32_t sc_indir_cur; /* Current indir cluster number */
172 int sc_indir_dirty; /* Current indir cluster modified */
173 u_int32_t *sc_indir_data; /* Current indir cluster data */
174 };
175
176 int fss_umount_hook(struct mount *, int);
177
178 #endif /* _KERNEL */
179
180 #endif /* !_SYS_DEV_FSSVAR_H */
181