a50cc06dfecad1854629257866d885f860124af7
[dragonfly.git] / sys / vfs / hammer2 / hammer2.h
1 /*
2  * Copyright (c) 2011-2012 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@dragonflybsd.org>
6  * by Venkatesh Srinivas <vsrinivas@dragonflybsd.org>
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in
16  *    the documentation and/or other materials provided with the
17  *    distribution.
18  * 3. Neither the name of The DragonFly Project nor the names of its
19  *    contributors may be used to endorse or promote products derived
20  *    from this software without specific, prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
26  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  */
35
36 /*
37  * This header file contains structures used internally by the HAMMER2
38  * implementation.  See hammer2_disk.h for on-disk structures.
39  */
40
41 #ifndef _VFS_HAMMER2_HAMMER2_H_
42 #define _VFS_HAMMER2_HAMMER2_H_
43
44 #include <sys/param.h>
45 #include <sys/types.h>
46 #include <sys/kernel.h>
47 #include <sys/conf.h>
48 #include <sys/systm.h>
49 #include <sys/tree.h>
50 #include <sys/malloc.h>
51 #include <sys/mount.h>
52 #include <sys/vnode.h>
53 #include <sys/proc.h>
54 #include <sys/mountctl.h>
55 #include <sys/priv.h>
56 #include <sys/stat.h>
57 #include <sys/globaldata.h>
58 #include <sys/lockf.h>
59 #include <sys/buf.h>
60 #include <sys/queue.h>
61 #include <sys/limits.h>
62 #include <sys/buf2.h>
63 #include <sys/signal2.h>
64 #include <sys/tree.h>
65
66 #include "hammer2_disk.h"
67 #include "hammer2_mount.h"
68
69 struct hammer2_chain;
70 struct hammer2_inode;
71 struct hammer2_mount;
72
73 /*
74  * The chain structure tracks blockref recursions all the way to
75  * the root volume.  These consist of indirect blocks, inodes,
76  * and eventually the volume header.
77  *
78  * The chain structure is embedded in the hammer2_mount, hammer2_inode,
79  * and other system memory structures.  The chain structure typically
80  * implements the reference count and busy flag for the larger structure.
81  *
82  * It is always possible to track a chain element all the way back to the
83  * root by following the (parent) links.  (index) is a type-dependent index
84  * in the parent indicating where in the parent the chain element resides.
85  *
86  * When a blockref is added or deleted the related chain element is marked
87  * modified and all of its parents are marked SUBMODIFIED (the parent
88  * recursion can stop once we hit a node that is already marked SUBMODIFIED).
89  * A deleted chain element must remain intact until synchronized against
90  * its parent.
91  *
92  * The blockref at (parent, index) is not adjusted until the modified chain
93  * element is flushed and unmarked.  Until then the child's blockref may
94  * not match the blockref at (parent, index).
95  */
96 SPLAY_HEAD(hammer2_chain_splay, hammer2_chain);
97
98 struct hammer2_chain {
99         struct hammer2_blockref bref;
100         struct hammer2_chain *parent;   /* return chain to root */
101         struct hammer2_chain_splay shead;
102         SPLAY_ENTRY(hammer2_chain) snode;
103         union {
104                 struct hammer2_inode *ip;
105                 struct hammer2_indblock *np;
106                 struct hammer2_data *dp;
107                 void *mem;
108         } u;
109
110         struct buf      *bp;            /* buffer cache (ro) */
111         hammer2_media_data_t *data;     /* modified copy of data (rw) */
112
113         struct lock     lk;             /* lockmgr lock */
114         int             index;          /* index in parent */
115         u_int           refs;
116         u_int           busy;           /* soft-busy */
117         u_int           flags;
118 };
119
120 typedef struct hammer2_chain hammer2_chain_t;
121
122 int hammer2_chain_cmp(hammer2_chain_t *chain1, hammer2_chain_t *chain2);
123 SPLAY_PROTOTYPE(hammer2_chain_splay, hammer2_chain, snode, hammer2_chain_cmp);
124
125 #define HAMMER2_CHAIN_MODIFIED          0x00000001      /* this elm modified */
126 #define HAMMER2_CHAIN_COMMITTING        0x00000002      /* mods committing */
127 #define HAMMER2_CHAIN_SUBMODIFIED       0x00000004      /* 1+ subs modified */
128 #define HAMMER2_CHAIN_SUBCOMMITTING     0x00000008      /* 1+ subs committing */
129 #define HAMMER2_CHAIN_DELETED           0x00000010
130 #define HAMMER2_CHAIN_INITIAL           0x00000020      /* initial write */
131 #define HAMMER2_CHAIN_FLUSHED           0x00000040      /* flush on unlock */
132 #define HAMMER2_CHAIN_MOVED             0x00000080      /* moved */
133
134 /*
135  * Flags passed to hammer2_chain_lookup() and hammer2_chain_next()
136  */
137 #define HAMMER2_LOOKUP_NOLOCK           0x00000001      /* ref only */
138
139 /*
140  * HAMMER2 IN-MEMORY CACHE OF MEDIA STRUCTURES
141  *
142  * There is an in-memory representation of all on-media data structure.
143  *
144  * When accessed read-only the data will be mapped to the related buffer
145  * cache buffer.
146  *
147  * When accessed read-write (marked modified) a kmalloc()'d copy of the
148  * is created which can then be modified.  The copy is destroyed when a
149  * filesystem block is allocated to replace it.
150  *
151  * Active inodes (those with vnodes attached) will maintain the kmalloc()'d
152  * copy for both the read-only and the read-write case.  The combination of
153  * (bp) and (data) determines whether (data) was allocated or not.
154  *
155  * The in-memory representation may remain cached (for example in order to
156  * placemark clustering locks) even after the related data has been
157  * detached.
158  */
159
160 /*
161  * A hammer2 inode.
162  */
163 struct hammer2_inode {
164         struct hammer2_mount    *hmp;
165         struct hammer2_inode    *pip;           /* parent inode */
166         struct vnode            *vp;
167         hammer2_chain_t         chain;
168         struct hammer2_inode_data ip_data;
169 };
170
171 typedef struct hammer2_inode hammer2_inode_t;
172
173 /*
174  * A hammer2 indirect block
175  */
176 struct hammer2_indblock {
177         hammer2_chain_t         chain;
178 };
179
180 typedef struct hammer2_indblock hammer2_indblock_t;
181
182 #define np_data         chain.data->npdata
183
184 /*
185  * A hammer2 data block
186  */
187 struct hammer2_data {
188         hammer2_chain_t         chain;
189 };
190
191 #define dp_data         chain.data->buf
192
193 typedef struct hammer2_data hammer2_data_t;
194
195 /*
196  * Governing mount structure for filesystem (aka vp->v_mount)
197  */
198 struct hammer2_mount {
199         struct mount    *mp;            /* kernel mount */
200         struct vnode    *devvp;         /* device vnode */
201         struct netexport export;        /* nfs export */
202         int             ronly;          /* read-only mount */
203
204         struct malloc_type *minode;
205         int             ninodes;
206         int             maxinodes;
207
208         struct malloc_type *mchain;
209         int             nipstacks;
210         int             maxipstacks;
211         hammer2_chain_t vchain;         /* anchor chain */
212         hammer2_chain_t *schain;        /* super-root */
213         hammer2_chain_t *rchain;        /* label-root */
214         struct hammer2_inode *iroot;
215
216         hammer2_volume_data_t voldata;
217         hammer2_off_t   freecache[HAMMER2_MAX_RADIX];
218 };
219
220 typedef struct hammer2_mount hammer2_mount_t;
221
222 #if defined(_KERNEL)
223
224 MALLOC_DECLARE(M_HAMMER2);
225
226 static __inline
227 struct mount *
228 H2TOMP(struct hammer2_mount *hmp)
229 {
230         return (struct mount *) hmp->mp;
231 }
232
233 #define VTOI(vp)        ((hammer2_inode_t *)(vp)->v_data)
234 #define ITOV(ip)        ((ip)->vp)
235
236 static __inline
237 struct hammer2_mount *
238 MPTOH2(struct mount *mp)
239 {
240         return (hammer2_mount_t *) mp->mnt_data;
241 }
242
243 extern struct vop_ops hammer2_vnode_vops;
244 extern struct vop_ops hammer2_spec_vops;
245 extern struct vop_ops hammer2_fifo_vops;
246
247 /*
248  * hammer2_subr.c
249  */
250 void hammer2_inode_lock_ex(hammer2_inode_t *ip);
251 void hammer2_inode_unlock_ex(hammer2_inode_t *ip);
252 void hammer2_inode_lock_sh(hammer2_inode_t *ip);
253 void hammer2_inode_unlock_sh(hammer2_inode_t *ip);
254 void hammer2_inode_busy(hammer2_inode_t *ip);
255 void hammer2_inode_unbusy(hammer2_inode_t *ip);
256
257 void hammer2_mount_exlock(hammer2_mount_t *hmp);
258 void hammer2_mount_shlock(hammer2_mount_t *hmp);
259 void hammer2_mount_unlock(hammer2_mount_t *hmp);
260
261 int hammer2_get_dtype(hammer2_inode_t *ip);
262 int hammer2_get_vtype(hammer2_inode_t *ip);
263 u_int8_t hammer2_get_obj_type(enum vtype vtype);
264 void hammer2_time_to_timespec(u_int64_t xtime, struct timespec *ts);
265 u_int32_t hammer2_to_unix_xid(uuid_t *uuid);
266
267 hammer2_key_t hammer2_dirhash(const unsigned char *name, size_t len);
268
269 /*
270  * hammer2_inode.c
271  */
272 struct vnode *hammer2_igetv(hammer2_inode_t *ip, int *errorp);
273 hammer2_inode_t *hammer2_inode_alloc(hammer2_mount_t *hmp, void *data);
274 void hammer2_inode_free(hammer2_inode_t *ip);
275 void hammer2_inode_ref(hammer2_inode_t *ip);
276 void hammer2_inode_drop(hammer2_inode_t *ip);
277 int hammer2_create_inode(hammer2_mount_t *hmp,
278                          struct vattr *vap, struct ucred *cred,
279                          hammer2_inode_t *dip,
280                          const uint8_t *name, size_t name_len,
281                          hammer2_inode_t **nipp);
282
283 /*
284  * hammer2_chain.c
285  */
286 hammer2_chain_t *hammer2_chain_alloc(hammer2_mount_t *hmp,
287                                 hammer2_blockref_t *bref);
288 void hammer2_chain_free(hammer2_mount_t *hmp, hammer2_chain_t *chain);
289 void hammer2_chain_ref(hammer2_mount_t *hmp, hammer2_chain_t *chain);
290 void hammer2_chain_drop(hammer2_mount_t *hmp, hammer2_chain_t *chain);
291 int hammer2_chain_lock(hammer2_mount_t *hmp, hammer2_chain_t *chain);
292 void hammer2_chain_modify(hammer2_mount_t *hmp, hammer2_chain_t *chain);
293 void hammer2_chain_unlock(hammer2_mount_t *hmp, hammer2_chain_t *chain);
294 hammer2_chain_t *hammer2_chain_find(hammer2_mount_t *hmp,
295                                 hammer2_chain_t *parent, int index);
296 hammer2_chain_t *hammer2_chain_get(hammer2_mount_t *hmp,
297                                 hammer2_chain_t *parent,
298                                 int index, int flags);
299 void hammer2_chain_put(hammer2_mount_t *hmp, hammer2_chain_t *chain);
300 hammer2_chain_t *hammer2_chain_lookup(hammer2_mount_t *hmp,
301                                 hammer2_chain_t **parentp,
302                                 hammer2_key_t key_beg, hammer2_key_t key_end,
303                                 int flags);
304 hammer2_chain_t *hammer2_chain_next(hammer2_mount_t *hmp,
305                                 hammer2_chain_t **parentp,
306                                 hammer2_chain_t *chain,
307                                 hammer2_key_t key_beg, hammer2_key_t key_end,
308                                 int flags);
309 hammer2_chain_t *hammer2_chain_create(hammer2_mount_t *hmp,
310                                 hammer2_chain_t *parent,
311                                 hammer2_key_t key, int keybits,
312                                 int type, size_t bytes);
313 void hammer2_chain_delete(hammer2_mount_t *hmp, hammer2_chain_t **parentp,
314                                 hammer2_chain_t *chain);
315 void hammer2_chain_flush(hammer2_mount_t *hmp, hammer2_chain_t *chain,
316                                 hammer2_blockref_t *parent_bref);
317 void hammer2_chain_commit(hammer2_mount_t *hmp, hammer2_chain_t *chain);
318
319 /*
320  * hammer2_freemap.c
321  */
322 hammer2_off_t hammer2_freemap_alloc(hammer2_mount_t *hmp, size_t bytes);
323 int hammer2_freemap_bytes_to_radix(size_t bytes);
324
325 #endif /* !_KERNEL */
326 #endif /* !_VFS_HAMMER2_HAMMER2_H_ */