hammer2 - Initial CCMS adaptation and code-up
[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 #include "hammer2_ioctl.h"
69 #include "hammer2_ccms.h"
70
71 struct hammer2_chain;
72 struct hammer2_inode;
73 struct hammer2_mount;
74 struct hammer2_pfsmount;
75
76 /*
77  * The chain structure tracks blockref recursions all the way to
78  * the root volume.  These consist of indirect blocks, inodes,
79  * and eventually the volume header.
80  *
81  * The chain structure is embedded in the hammer2_mount, hammer2_inode,
82  * and other system memory structures.  The chain structure typically
83  * implements the reference count and busy flag for the larger structure.
84  *
85  * It is always possible to track a chain element all the way back to the
86  * root by following the (parent) links.  (index) is a type-dependent index
87  * in the parent indicating where in the parent the chain element resides.
88  *
89  * When a blockref is added or deleted the related chain element is marked
90  * modified and all of its parents are marked SUBMODIFIED (the parent
91  * recursion can stop once we hit a node that is already marked SUBMODIFIED).
92  * A deleted chain element must remain intact until synchronized against
93  * its parent.
94  *
95  * The blockref at (parent, index) is not adjusted until the modified chain
96  * element is flushed and unmarked.  Until then the child's blockref may
97  * not match the blockref at (parent, index).
98  */
99 SPLAY_HEAD(hammer2_chain_splay, hammer2_chain);
100
101 struct hammer2_chain {
102         struct hammer2_blockref bref;
103         struct hammer2_blockref bref_flush;     /* synchronized w/MOVED bit */
104         struct hammer2_chain *parent;           /* return chain to root */
105         struct hammer2_chain_splay shead;
106         SPLAY_ENTRY(hammer2_chain) snode;
107         TAILQ_ENTRY(hammer2_chain) flush_node;  /* flush deferral list */
108         union {
109                 struct hammer2_inode *ip;
110                 struct hammer2_indblock *np;
111                 struct hammer2_data *dp;
112                 void *mem;
113         } u;
114
115         struct buf      *bp;            /* buffer cache (ro) */
116         hammer2_media_data_t *data;     /* modified copy of data (rw) */
117         u_int           bytes;          /* physical size of data */
118         struct lock     lk;             /* lockmgr lock */
119         int             index;          /* index in parent */
120         u_int           refs;
121         u_int           busy;           /* soft-busy */
122         u_int           flags;
123 };
124
125 typedef struct hammer2_chain hammer2_chain_t;
126
127 int hammer2_chain_cmp(hammer2_chain_t *chain1, hammer2_chain_t *chain2);
128 SPLAY_PROTOTYPE(hammer2_chain_splay, hammer2_chain, snode, hammer2_chain_cmp);
129
130 /*
131  * MOVED - This bit is set during the flush when the MODIFIED bit is cleared,
132  *         indicating that the parent's blocktable must inherit a change to
133  *         the bref (typically a block reallocation)
134  *
135  *         It must also be set in situations where a chain is not MODIFIED
136  *         but whos bref has changed (typically due to fields other than
137  *         a block reallocation).
138  */
139 #define HAMMER2_CHAIN_MODIFIED          0x00000001      /* active mods */
140 #define HAMMER2_CHAIN_DIRTYEMBED        0x00000002      /* inode embedded */
141 #define HAMMER2_CHAIN_DIRTYBP           0x00000004      /* dirty on unlock */
142 #define HAMMER2_CHAIN_SUBMODIFIED       0x00000008      /* 1+ subs modified */
143 #define HAMMER2_CHAIN_DELETED           0x00000010
144 #define HAMMER2_CHAIN_INITIAL           0x00000020      /* initial create */
145 #define HAMMER2_CHAIN_FLUSHED           0x00000040      /* flush on unlock */
146 #define HAMMER2_CHAIN_MOVED             0x00000080      /* bref changed */
147 #define HAMMER2_CHAIN_IOFLUSH           0x00000100      /* bawrite on put */
148 #define HAMMER2_CHAIN_DEFERRED          0x00000200      /* on a deferral list*/
149 #define HAMMER2_CHAIN_DESTROYED         0x00000400      /* destroying */
150 #define HAMMER2_CHAIN_MODIFIED_AUX      0x00000800      /* hmp->vchain only */
151 #define HAMMER2_CHAIN_MODIFY_TID        0x00001000      /* mod updates field */
152 #define HAMMER2_CHAIN_MOUNTED           0x00002000      /* PFS is mounted */
153
154 /*
155  * Flags passed to hammer2_chain_lookup() and hammer2_chain_next()
156  */
157 #define HAMMER2_LOOKUP_NOLOCK           0x00000001      /* ref only */
158 #define HAMMER2_LOOKUP_NODATA           0x00000002      /* data left NULL */
159
160 /*
161  * Flags passed to hammer2_chain_modify() and hammer2_chain_resize()
162  *
163  * NOTE: OPTDATA allows us to avoid instantiating buffers for INDIRECT
164  *       blocks in the INITIAL-create state.
165  *
166  * NOTE: NO_MODIFY_TID tells the function to not set HAMMER2_CHAIN_MODIFY_TID
167  *       when marking the chain modified (used when a sub-chain modification
168  *       propagates upward).
169  */
170 #define HAMMER2_MODIFY_NOSUB            0x00000001      /* do not set SUBMOD */
171 #define HAMMER2_MODIFY_OPTDATA          0x00000002      /* data can be NULL */
172 #define HAMMER2_MODIFY_NO_MODIFY_TID    0x00000004
173
174 /*
175  * Flags passed to hammer2_chain_lock()
176  */
177 #define HAMMER2_RESOLVE_NEVER           1
178 #define HAMMER2_RESOLVE_MAYBE           2
179 #define HAMMER2_RESOLVE_ALWAYS          3
180
181 /*
182  * Cluster different types of storage together for allocations
183  */
184 #define HAMMER2_FREECACHE_INODE         0
185 #define HAMMER2_FREECACHE_INDIR         1
186 #define HAMMER2_FREECACHE_DATA          2
187 #define HAMMER2_FREECACHE_UNUSED3       3
188 #define HAMMER2_FREECACHE_TYPES         4
189
190 /*
191  * BMAP read-ahead maximum parameters
192  */
193 #define HAMMER2_BMAP_COUNT              16      /* max bmap read-ahead */
194 #define HAMMER2_BMAP_BYTES              (HAMMER2_PBUFSIZE * HAMMER2_BMAP_COUNT)
195
196 /*
197  * Misc
198  */
199 #define HAMMER2_FLUSH_DEPTH_LIMIT       40      /* stack recursion limit */
200
201 /*
202  * HAMMER2 IN-MEMORY CACHE OF MEDIA STRUCTURES
203  *
204  * There is an in-memory representation of all on-media data structure.
205  *
206  * When accessed read-only the data will be mapped to the related buffer
207  * cache buffer.
208  *
209  * When accessed read-write (marked modified) a kmalloc()'d copy of the
210  * is created which can then be modified.  The copy is destroyed when a
211  * filesystem block is allocated to replace it.
212  *
213  * Active inodes (those with vnodes attached) will maintain the kmalloc()'d
214  * copy for both the read-only and the read-write case.  The combination of
215  * (bp) and (data) determines whether (data) was allocated or not.
216  *
217  * The in-memory representation may remain cached (for example in order to
218  * placemark clustering locks) even after the related data has been
219  * detached.
220  */
221
222 /*
223  * A hammer2 inode.
224  */
225 struct hammer2_inode {
226         struct hammer2_mount    *hmp;           /* Global mount */
227         struct hammer2_pfsmount *pmp;           /* PFS mount */
228         struct hammer2_inode    *pip;           /* parent inode */
229         struct vnode            *vp;
230         hammer2_chain_t         chain;
231         struct hammer2_inode_data ip_data;
232         struct lockf            advlock;
233         u_int                   depth;          /* directory depth */
234         hammer2_off_t           delta_dcount;   /* adjust data_count */
235         hammer2_off_t           delta_icount;   /* adjust inode_count */
236 };
237
238 typedef struct hammer2_inode hammer2_inode_t;
239
240 /*
241  * A hammer2 indirect block
242  */
243 struct hammer2_indblock {
244         hammer2_chain_t         chain;
245 };
246
247 typedef struct hammer2_indblock hammer2_indblock_t;
248
249 /*
250  * A hammer2 data block
251  */
252 struct hammer2_data {
253         hammer2_chain_t         chain;
254 };
255
256 typedef struct hammer2_data hammer2_data_t;
257
258 struct hammer2_freecache {
259         hammer2_off_t   bulk;
260         hammer2_off_t   single;
261 };
262
263 typedef struct hammer2_freecache hammer2_freecache_t;
264
265 /*
266  * Global (per device) mount structure for device (aka vp->v_mount->hmp)
267  */
268 struct hammer2_mount {
269         struct vnode    *devvp;         /* device vnode */
270         int             ronly;          /* read-only mount */
271         int             pmp_count;      /* PFS mounts backed by us */
272         TAILQ_ENTRY(hammer2_mount) mntentry; /* hammer2_mntlist */
273
274         struct malloc_type *minode;
275         int             ninodes;
276         int             maxinodes;
277
278         struct malloc_type *mchain;
279         int             nipstacks;
280         int             maxipstacks;
281         hammer2_chain_t vchain;         /* anchor chain */
282         hammer2_chain_t *schain;        /* super-root */
283         struct lock     alloclk;        /* lockmgr lock */
284         struct lock     voldatalk;      /* lockmgr lock */
285
286         hammer2_volume_data_t voldata;
287         hammer2_freecache_t freecache[HAMMER2_FREECACHE_TYPES][HAMMER2_MAX_RADIX+1];
288 };
289
290 typedef struct hammer2_mount hammer2_mount_t;
291
292 /*
293  * Per-PFS mount structure for device (aka vp->v_mount)
294  */
295 struct hammer2_pfsmount {
296         struct mount            *mp;            /* kernel mount */
297         struct hammer2_mount    *hmp;           /* device global mount */
298         hammer2_chain_t         *rchain;        /* PFS root chain */
299         hammer2_inode_t         *iroot;         /* PFS root inode */
300         struct netexport        export;         /* nfs export */
301         int                     ronly;          /* read-only mount */
302 };
303
304 typedef struct hammer2_pfsmount hammer2_pfsmount_t;
305
306 #if defined(_KERNEL)
307
308 MALLOC_DECLARE(M_HAMMER2);
309
310 #define VTOI(vp)        ((hammer2_inode_t *)(vp)->v_data)
311 #define ITOV(ip)        ((ip)->vp)
312
313 static __inline
314 hammer2_pfsmount_t *
315 MPTOPMP(struct mount *mp)
316 {
317         return ((hammer2_pfsmount_t *)mp->mnt_data);
318 }
319
320 static __inline
321 hammer2_mount_t *
322 MPTOHMP(struct mount *mp)
323 {
324         return (((hammer2_pfsmount_t *)mp->mnt_data)->hmp);
325 }
326
327 extern struct vop_ops hammer2_vnode_vops;
328 extern struct vop_ops hammer2_spec_vops;
329 extern struct vop_ops hammer2_fifo_vops;
330
331 extern int hammer2_debug;
332 extern int hammer2_cluster_enable;
333 extern int hammer2_hardlink_enable;
334 extern long hammer2_iod_file_read;
335 extern long hammer2_iod_meta_read;
336 extern long hammer2_iod_indr_read;
337 extern long hammer2_iod_file_write;
338 extern long hammer2_iod_meta_write;
339 extern long hammer2_iod_indr_write;
340 extern long hammer2_iod_volu_write;
341 extern long hammer2_ioa_file_read;
342 extern long hammer2_ioa_meta_read;
343 extern long hammer2_ioa_indr_read;
344 extern long hammer2_ioa_file_write;
345 extern long hammer2_ioa_meta_write;
346 extern long hammer2_ioa_indr_write;
347 extern long hammer2_ioa_volu_write;
348
349 /*
350  * hammer2_subr.c
351  */
352 void hammer2_inode_lock_ex(hammer2_inode_t *ip);
353 void hammer2_inode_unlock_ex(hammer2_inode_t *ip);
354 void hammer2_inode_lock_sh(hammer2_inode_t *ip);
355 void hammer2_inode_unlock_sh(hammer2_inode_t *ip);
356 void hammer2_inode_busy(hammer2_inode_t *ip);
357 void hammer2_inode_unbusy(hammer2_inode_t *ip);
358 void hammer2_voldata_lock(hammer2_mount_t *hmp);
359 void hammer2_voldata_unlock(hammer2_mount_t *hmp);
360
361 void hammer2_mount_exlock(hammer2_mount_t *hmp);
362 void hammer2_mount_shlock(hammer2_mount_t *hmp);
363 void hammer2_mount_unlock(hammer2_mount_t *hmp);
364
365 int hammer2_get_dtype(hammer2_inode_t *ip);
366 int hammer2_get_vtype(hammer2_inode_t *ip);
367 u_int8_t hammer2_get_obj_type(enum vtype vtype);
368 void hammer2_time_to_timespec(u_int64_t xtime, struct timespec *ts);
369 u_int64_t hammer2_timespec_to_time(struct timespec *ts);
370 u_int32_t hammer2_to_unix_xid(uuid_t *uuid);
371 void hammer2_guid_to_uuid(uuid_t *uuid, u_int32_t guid);
372
373 hammer2_key_t hammer2_dirhash(const unsigned char *name, size_t len);
374 int hammer2_bytes_to_radix(size_t bytes);
375
376 int hammer2_calc_logical(hammer2_inode_t *ip, hammer2_off_t uoff,
377                          hammer2_key_t *lbasep, hammer2_key_t *leofp);
378 void hammer2_update_time(uint64_t *timep);
379
380 /*
381  * hammer2_inode.c
382  */
383 struct vnode *hammer2_igetv(hammer2_inode_t *ip, int *errorp);
384
385 void hammer2_inode_lock_nlinks(hammer2_inode_t *ip);
386 void hammer2_inode_unlock_nlinks(hammer2_inode_t *ip);
387 hammer2_inode_t *hammer2_inode_alloc(hammer2_pfsmount_t *pmp, void *data);
388 void hammer2_inode_free(hammer2_inode_t *ip);
389 void hammer2_inode_ref(hammer2_inode_t *ip);
390 void hammer2_inode_drop(hammer2_inode_t *ip);
391 int hammer2_inode_calc_alloc(hammer2_key_t filesize);
392
393 int hammer2_inode_create(hammer2_inode_t *dip,
394                         struct vattr *vap, struct ucred *cred,
395                         const uint8_t *name, size_t name_len,
396                         hammer2_inode_t **nipp);
397
398 int hammer2_inode_duplicate(hammer2_inode_t *dip,
399                         hammer2_inode_t *oip, hammer2_inode_t **nipp,
400                         const uint8_t *name, size_t name_len);
401 int hammer2_inode_connect(hammer2_inode_t *dip, hammer2_inode_t *oip,
402                         const uint8_t *name, size_t name_len);
403
404 int hammer2_unlink_file(hammer2_inode_t *dip,
405                         const uint8_t *name, size_t name_len,
406                         int isdir, hammer2_inode_t *retain_ip);
407 int hammer2_hardlink_consolidate(hammer2_inode_t **ipp, hammer2_inode_t *tdip);
408 int hammer2_hardlink_deconsolidate(hammer2_inode_t *dip,
409                         hammer2_chain_t **chainp, hammer2_inode_t **ipp);
410 int hammer2_hardlink_find(hammer2_inode_t *dip, hammer2_chain_t **chainp,
411                         hammer2_inode_t **ipp);
412
413 /*
414  * hammer2_chain.c
415  */
416 void hammer2_modify_volume(hammer2_mount_t *hmp);
417 hammer2_chain_t *hammer2_chain_alloc(hammer2_mount_t *hmp,
418                                 hammer2_blockref_t *bref);
419 void hammer2_chain_free(hammer2_mount_t *hmp, hammer2_chain_t *chain);
420 void hammer2_chain_ref(hammer2_mount_t *hmp, hammer2_chain_t *chain);
421 void hammer2_chain_drop(hammer2_mount_t *hmp, hammer2_chain_t *chain);
422 int hammer2_chain_lock(hammer2_mount_t *hmp, hammer2_chain_t *chain, int how);
423 void hammer2_chain_moved(hammer2_mount_t *hmp, hammer2_chain_t *chain);
424 void hammer2_chain_modify(hammer2_mount_t *hmp, hammer2_chain_t *chain,
425                                 int flags);
426 void hammer2_chain_resize(hammer2_inode_t *ip, hammer2_chain_t *chain,
427                                 int nradix, int flags);
428 void hammer2_chain_unlock(hammer2_mount_t *hmp, hammer2_chain_t *chain);
429 hammer2_chain_t *hammer2_chain_find(hammer2_mount_t *hmp,
430                                 hammer2_chain_t *parent, int index);
431 hammer2_chain_t *hammer2_chain_get(hammer2_mount_t *hmp,
432                                 hammer2_chain_t *parent,
433                                 int index, int flags);
434 hammer2_chain_t *hammer2_chain_lookup(hammer2_mount_t *hmp,
435                                 hammer2_chain_t **parentp,
436                                 hammer2_key_t key_beg, hammer2_key_t key_end,
437                                 int flags);
438 hammer2_chain_t *hammer2_chain_next(hammer2_mount_t *hmp,
439                                 hammer2_chain_t **parentp,
440                                 hammer2_chain_t *chain,
441                                 hammer2_key_t key_beg, hammer2_key_t key_end,
442                                 int flags);
443 hammer2_chain_t *hammer2_chain_create(hammer2_mount_t *hmp,
444                                 hammer2_chain_t *parent,
445                                 hammer2_chain_t *chain,
446                                 hammer2_key_t key, int keybits,
447                                 int type, size_t bytes);
448 void hammer2_chain_delete(hammer2_mount_t *hmp, hammer2_chain_t *parent,
449                                 hammer2_chain_t *chain, int retain);
450 void hammer2_chain_flush(hammer2_mount_t *hmp, hammer2_chain_t *chain,
451                                 hammer2_tid_t modify_tid);
452 void hammer2_chain_commit(hammer2_mount_t *hmp, hammer2_chain_t *chain);
453
454 /*
455  * hammer2_ioctl.c
456  */
457 int hammer2_ioctl(hammer2_inode_t *ip, u_long com, void *data,
458                                 int fflag, struct ucred *cred);
459
460 /*
461  * hammer2_freemap.c
462  */
463 hammer2_off_t hammer2_freemap_alloc(hammer2_mount_t *hmp,
464                                 int type, size_t bytes);
465 void hammer2_freemap_free(hammer2_mount_t *hmp, hammer2_off_t data_off,
466                                 int type);
467
468 #endif /* !_KERNEL */
469 #endif /* !_VFS_HAMMER2_HAMMER2_H_ */