hammer2 - Redo refactor code, fix races, add assertions
[dragonfly.git] / sys / vfs / hammer2 / hammer2.h
1 /*
2  * Copyright (c) 2011-2013 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/thread.h>
58 #include <sys/globaldata.h>
59 #include <sys/lockf.h>
60 #include <sys/buf.h>
61 #include <sys/queue.h>
62 #include <sys/limits.h>
63 #include <sys/buf2.h>
64 #include <sys/signal2.h>
65 #include <sys/dmsg.h>
66 #include <sys/mutex.h>
67 #include <sys/mutex2.h>
68
69 #include "hammer2_disk.h"
70 #include "hammer2_mount.h"
71 #include "hammer2_ioctl.h"
72 #include "hammer2_ccms.h"
73
74 struct hammer2_chain;
75 struct hammer2_inode;
76 struct hammer2_mount;
77 struct hammer2_pfsmount;
78 struct hammer2_span;
79 struct hammer2_state;
80 struct hammer2_msg;
81
82 /*
83  * The chain structure tracks a portion of the media topology from the
84  * root (volume) down.  Chains represent volumes, inodes, indirect blocks,
85  * data blocks, and freemap nodes and leafs.
86  *
87  * The chain structure can be multi-homed and its topological recursion
88  * (chain->core) can be shared amongst several chains.  Chain structures
89  * are topologically stable once placed in the in-memory topology (they
90  * don't move around).  Modifications which cross flush synchronization
91  * boundaries, renames, resizing, or any move of the chain to elsewhere
92  * in the topology is accomplished via the DELETE-DUPLICATE mechanism.
93  *
94  * DELETE-DUPLICATE allows HAMMER2 to track work across flush synchronization
95  * points without stalling the filesystem or corrupting the flush
96  * sychronization point.  When necessary a chain will be marked DELETED
97  * and a new, duplicate chain will be allocated.
98  *
99  * This mechanism necessarily requires that we be able to overload chains
100  * at any given layer in the topology.  Overloading is accomplished via a
101  * RBTREE recursion through chain->rbtree.
102  *
103  * Advantages:
104  *
105  *      (1) Fully coherent snapshots can be taken without requiring
106  *          a pre-flush, resulting in extremely fast (sub-millisecond)
107  *          snapshots.
108  *
109  *      (2) Multiple synchronization points can be in-flight at the same
110  *          time, representing multiple snapshots or flushes.
111  *
112  *      (3) The algorithms needed to keep track of everything are actually
113  *          not that complex.
114  *
115  * Special Considerations:
116  *
117  *      A chain is ref-counted on a per-chain basis, but the chain's lock
118  *      is associated with the shared chain_core and is not per-chain.
119  *
120  *      The power-of-2 nature of the media radix tree ensures that there
121  *      will be no overlaps which straddle edges.
122  */
123 RB_HEAD(hammer2_chain_tree, hammer2_chain);
124 TAILQ_HEAD(h2_flush_deferral_list, hammer2_chain);
125 TAILQ_HEAD(h2_core_list, hammer2_chain);
126 TAILQ_HEAD(h2_layer_list, hammer2_chain_layer);
127
128 struct hammer2_chain_layer {
129         int             good;
130         TAILQ_ENTRY(hammer2_chain_layer) entry;
131         struct hammer2_chain_tree rbtree;
132         int     refs;           /* prevent destruction */
133 };
134
135 typedef struct hammer2_chain_layer hammer2_chain_layer_t;
136
137 struct hammer2_chain_core {
138         int             good;
139         struct ccms_cst cst;
140         struct h2_core_list ownerq;     /* chain's which own this core */
141         struct h2_layer_list layerq;
142         u_int           chain_count;    /* total chains in layers */
143         u_int           sharecnt;
144         u_int           flags;
145         u_int           live_count;     /* live (not deleted) chains in tree */
146 };
147
148 typedef struct hammer2_chain_core hammer2_chain_core_t;
149
150 #define HAMMER2_CORE_INDIRECT           0x0001
151
152 struct hammer2_chain {
153         RB_ENTRY(hammer2_chain) rbnode;         /* node */
154         TAILQ_ENTRY(hammer2_chain) core_entry;  /* contemporary chains */
155         hammer2_chain_layer_t   *inlayer;
156         hammer2_blockref_t      bref;
157         hammer2_chain_core_t    *core;
158         hammer2_chain_core_t    *above;
159         struct hammer2_state    *state;         /* if active cache msg */
160         struct hammer2_mount    *hmp;
161         struct hammer2_pfsmount *pmp;           /* can be NULL */
162
163         hammer2_tid_t   modify_tid;             /* snapshot/flush filter */
164         hammer2_tid_t   delete_tid;
165         hammer2_key_t   data_count;             /* delta's to apply */
166         hammer2_key_t   inode_count;            /* delta's to apply */
167         struct buf      *bp;                    /* physical data buffer */
168         u_int           bytes;                  /* physical data size */
169         u_int           flags;
170         u_int           refs;
171         u_int           lockcnt;
172         int             live_zero;              /* blockref array opt */
173         hammer2_media_data_t *data;             /* data pointer shortcut */
174         TAILQ_ENTRY(hammer2_chain) flush_node;  /* flush deferral list */
175 };
176
177 typedef struct hammer2_chain hammer2_chain_t;
178
179 int hammer2_chain_cmp(hammer2_chain_t *chain1, hammer2_chain_t *chain2);
180 RB_PROTOTYPE(hammer2_chain_tree, hammer2_chain, rbnode, hammer2_chain_cmp);
181
182 /*
183  * Special notes on flags:
184  *
185  * INITIAL - This flag allows a chain to be created and for storage to
186  *           be allocated without having to immediately instantiate the
187  *           related buffer.  The data is assumed to be all-zeros.  It
188  *           is primarily used for indirect blocks.
189  *
190  * MOVED   - A modified chain becomes MOVED after it flushes.  A chain
191  *           can also become MOVED if it is moved within the topology
192  *           (even if not modified).
193  */
194 #define HAMMER2_CHAIN_MODIFIED          0x00000001      /* dirty chain data */
195 #define HAMMER2_CHAIN_ALLOCATED         0x00000002      /* kmalloc'd chain */
196 #define HAMMER2_CHAIN_DIRTYBP           0x00000004      /* dirty on unlock */
197 #define HAMMER2_CHAIN_SUBMODIFIED       0x00000008      /* recursive flush */
198 #define HAMMER2_CHAIN_DELETED           0x00000010      /* deleted chain */
199 #define HAMMER2_CHAIN_INITIAL           0x00000020      /* initial create */
200 #define HAMMER2_CHAIN_FLUSHED           0x00000040      /* flush on unlock */
201 #define HAMMER2_CHAIN_MOVED             0x00000080      /* bref changed */
202 #define HAMMER2_CHAIN_IOFLUSH           0x00000100      /* bawrite on put */
203 #define HAMMER2_CHAIN_DEFERRED          0x00000200      /* on a deferral list */
204 #define HAMMER2_CHAIN_DESTROYED         0x00000400      /* destroying inode */
205 #define HAMMER2_CHAIN_VOLUMESYNC        0x00000800      /* needs volume sync */
206 #define HAMMER2_CHAIN_RECYCLE           0x00001000      /* force recycle */
207 #define HAMMER2_CHAIN_MOUNTED           0x00002000      /* PFS is mounted */
208 #define HAMMER2_CHAIN_ONRBTREE          0x00004000      /* on parent RB tree */
209 #define HAMMER2_CHAIN_SNAPSHOT          0x00008000      /* snapshot special */
210 #define HAMMER2_CHAIN_EMBEDDED          0x00010000      /* embedded data */
211 #define HAMMER2_CHAIN_UNUSE20000        0x00020000
212 #define HAMMER2_CHAIN_REPLACE           0x00040000      /* replace bref */
213 #define HAMMER2_CHAIN_COUNTEDBREFS      0x00080000      /* counted brefs */
214 #define HAMMER2_CHAIN_DUPLICATED        0x00100000      /* fwd delete-dup */
215
216 /*
217  * Flags passed to hammer2_chain_lookup() and hammer2_chain_next()
218  *
219  * NOTE: MATCHIND allows an indirect block / freemap node to be returned
220  *       when the passed key range matches the radix.  Remember that key_end
221  *       is inclusive (e.g. {0x000,0xFFF}, not {0x000,0x1000}).
222  */
223 #define HAMMER2_LOOKUP_NOLOCK           0x00000001      /* ref only */
224 #define HAMMER2_LOOKUP_NODATA           0x00000002      /* data left NULL */
225 #define HAMMER2_LOOKUP_SHARED           0x00000100
226 #define HAMMER2_LOOKUP_MATCHIND         0x00000200
227 #define HAMMER2_LOOKUP_FREEMAP          0x00000400      /* freemap base */
228 #define HAMMER2_LOOKUP_ALWAYS           0x00000800      /* resolve data */
229
230 /*
231  * Flags passed to hammer2_chain_modify() and hammer2_chain_resize()
232  *
233  * NOTE: OPTDATA allows us to avoid instantiating buffers for INDIRECT
234  *       blocks in the INITIAL-create state.
235  */
236 #define HAMMER2_MODIFY_OPTDATA          0x00000002      /* data can be NULL */
237 #define HAMMER2_MODIFY_NO_MODIFY_TID    0x00000004
238 #define HAMMER2_MODIFY_ASSERTNOCOPY     0x00000008
239 #define HAMMER2_MODIFY_NOREALLOC        0x00000010
240
241 /*
242  * Flags passed to hammer2_chain_lock()
243  */
244 #define HAMMER2_RESOLVE_NEVER           1
245 #define HAMMER2_RESOLVE_MAYBE           2
246 #define HAMMER2_RESOLVE_ALWAYS          3
247 #define HAMMER2_RESOLVE_MASK            0x0F
248
249 #define HAMMER2_RESOLVE_SHARED          0x10    /* request shared lock */
250 #define HAMMER2_RESOLVE_NOREF           0x20    /* already ref'd on lock */
251
252 /*
253  * Flags passed to hammer2_chain_delete()
254  */
255 #define HAMMER2_DELETE_WILLDUP          0x0001  /* no blk free, will be dup */
256
257 /*
258  * Flags passed to hammer2_chain_delete_duplicate()
259  */
260 #define HAMMER2_DELDUP_RECORE           0x0001
261
262 /*
263  * Cluster different types of storage together for allocations
264  */
265 #define HAMMER2_FREECACHE_INODE         0
266 #define HAMMER2_FREECACHE_INDIR         1
267 #define HAMMER2_FREECACHE_DATA          2
268 #define HAMMER2_FREECACHE_UNUSED3       3
269 #define HAMMER2_FREECACHE_TYPES         4
270
271 /*
272  * hammer2_freemap_alloc() block preference
273  */
274 #define HAMMER2_OFF_NOPREF              ((hammer2_off_t)-1)
275
276 /*
277  * BMAP read-ahead maximum parameters
278  */
279 #define HAMMER2_BMAP_COUNT              16      /* max bmap read-ahead */
280 #define HAMMER2_BMAP_BYTES              (HAMMER2_PBUFSIZE * HAMMER2_BMAP_COUNT)
281
282 /*
283  * Misc
284  */
285 #define HAMMER2_FLUSH_DEPTH_LIMIT       40      /* stack recursion limit */
286
287 /*
288  * HAMMER2 IN-MEMORY CACHE OF MEDIA STRUCTURES
289  *
290  * There is an in-memory representation of all on-media data structure.
291  *
292  * When accessed read-only the data will be mapped to the related buffer
293  * cache buffer.
294  *
295  * When accessed read-write (marked modified) a kmalloc()'d copy of the
296  * is created which can then be modified.  The copy is destroyed when a
297  * filesystem block is allocated to replace it.
298  *
299  * Active inodes (those with vnodes attached) will maintain the kmalloc()'d
300  * copy for both the read-only and the read-write case.  The combination of
301  * (bp) and (data) determines whether (data) was allocated or not.
302  *
303  * The in-memory representation may remain cached (for example in order to
304  * placemark clustering locks) even after the related data has been
305  * detached.
306  */
307
308 RB_HEAD(hammer2_inode_tree, hammer2_inode);
309
310 /*
311  * A hammer2 inode.
312  *
313  * NOTE: The inode's attribute CST which is also used to lock the inode
314  *       is embedded in the chain (chain.cst) and aliased w/ attr_cst.
315  */
316 struct hammer2_inode {
317         RB_ENTRY(hammer2_inode) rbnode;         /* inumber lookup (HL) */
318         ccms_cst_t              topo_cst;       /* directory topology cst */
319         struct hammer2_pfsmount *pmp;           /* PFS mount */
320         struct hammer2_inode    *pip;           /* parent inode */
321         struct vnode            *vp;
322         hammer2_chain_t         *chain;         /* NOTE: rehomed on rename */
323         struct lockf            advlock;
324         hammer2_tid_t           inum;
325         u_int                   flags;
326         u_int                   refs;           /* +vpref, +flushref */
327         uint8_t                 comp_heuristic;
328         hammer2_off_t           size;
329         uint64_t                mtime;
330 };
331
332 typedef struct hammer2_inode hammer2_inode_t;
333
334 #define HAMMER2_INODE_MODIFIED          0x0001
335 #define HAMMER2_INODE_SROOT             0x0002  /* kmalloc special case */
336 #define HAMMER2_INODE_RENAME_INPROG     0x0004
337 #define HAMMER2_INODE_ONRBTREE          0x0008
338 #define HAMMER2_INODE_RESIZED           0x0010
339 #define HAMMER2_INODE_MTIME             0x0020
340
341 int hammer2_inode_cmp(hammer2_inode_t *ip1, hammer2_inode_t *ip2);
342 RB_PROTOTYPE2(hammer2_inode_tree, hammer2_inode, rbnode, hammer2_inode_cmp,
343                 hammer2_tid_t);
344
345 /*
346  * A hammer2 transaction and flush sequencing structure.
347  *
348  * This global structure is tied into hammer2_mount and is used
349  * to sequence modifying operations and flushes.
350  *
351  * (a) Any modifying operations with sync_tid >= flush_tid will stall until
352  *     all modifying operating with sync_tid < flush_tid complete.
353  *
354  *     The flush related to flush_tid stalls until all modifying operations
355  *     with sync_tid < flush_tid complete.
356  *
357  * (b) Once unstalled, modifying operations with sync_tid > flush_tid are
358  *     allowed to run.  All modifications cause modify/duplicate operations
359  *     to occur on the related chains.  Note that most INDIRECT blocks will
360  *     be unaffected because the modifications just overload the RBTREE
361  *     structurally instead of actually modifying the indirect blocks.
362  *
363  * (c) The actual flush unstalls and RUNS CONCURRENTLY with (b), but only
364  *     utilizes the chain structures with sync_tid <= flush_tid.  The
365  *     flush will modify related indirect blocks and inodes in-place
366  *     (rather than duplicate) since the adjustments are compatible with
367  *     (b)'s RBTREE overloading
368  *
369  *     SPECIAL NOTE:  Inode modifications have to also propagate along any
370  *                    modify/duplicate chains.  File writes detect the flush
371  *                    and force out the conflicting buffer cache buffer(s)
372  *                    before reusing them.
373  *
374  * (d) Snapshots can be made instantly but must be flushed and disconnected
375  *     from their duplicative source before they can be mounted.  This is
376  *     because while H2's on-media structure supports forks, its in-memory
377  *     structure only supports very simple forking for background flushing
378  *     purposes.
379  *
380  * TODO: Flush merging.  When fsync() is called on multiple discrete files
381  *       concurrently there is no reason to stall the second fsync.
382  *       The final flush that reaches to root can cover both fsync()s.
383  *
384  *     The chains typically terminate as they fly onto the disk.  The flush
385  *     ultimately reaches the volume header.
386  */
387 struct hammer2_trans {
388         TAILQ_ENTRY(hammer2_trans) entry;
389         struct hammer2_pfsmount *pmp;
390         hammer2_tid_t           sync_tid;
391         thread_t                td;             /* pointer */
392         int                     flags;
393         int                     blocked;
394         uint8_t                 inodes_created;
395         uint8_t                 dummy[7];
396 };
397
398 typedef struct hammer2_trans hammer2_trans_t;
399
400 #define HAMMER2_TRANS_ISFLUSH           0x0001  /* formal flush */
401 #define HAMMER2_TRANS_RESTRICTED        0x0002  /* snapshot flush restrict */
402 #define HAMMER2_TRANS_BUFCACHE          0x0004  /* from bioq strategy write */
403
404 #define HAMMER2_FREEMAP_HEUR_NRADIX     4       /* pwr 2 PBUFRADIX-MINIORADIX */
405 #define HAMMER2_FREEMAP_HEUR_TYPES      8
406 #define HAMMER2_FREEMAP_HEUR            (HAMMER2_FREEMAP_HEUR_NRADIX * \
407                                          HAMMER2_FREEMAP_HEUR_TYPES)
408
409 /*
410  * Global (per device) mount structure for device (aka vp->v_mount->hmp)
411  */
412 TAILQ_HEAD(hammer2_trans_queue, hammer2_trans);
413
414 struct hammer2_mount {
415         struct vnode    *devvp;         /* device vnode */
416         int             ronly;          /* read-only mount */
417         int             pmp_count;      /* PFS mounts backed by us */
418         TAILQ_ENTRY(hammer2_mount) mntentry; /* hammer2_mntlist */
419
420         struct malloc_type *mchain;
421         int             nipstacks;
422         int             maxipstacks;
423         hammer2_chain_t vchain;         /* anchor chain */
424         hammer2_chain_t fchain;         /* freemap chain special */
425         hammer2_chain_t *schain;        /* super-root */
426         hammer2_inode_t *sroot;         /* super-root inode */
427         struct lock     alloclk;        /* lockmgr lock */
428         struct lock     voldatalk;      /* lockmgr lock */
429         struct hammer2_trans_queue transq; /* all in-progress transactions */
430         hammer2_trans_t *curflush;      /* current flush in progress */
431         hammer2_tid_t   topo_flush_tid; /* currently synchronizing flush pt */
432         hammer2_tid_t   free_flush_tid; /* currently synchronizing flush pt */
433         hammer2_off_t   heur_freemap[HAMMER2_FREEMAP_HEUR];
434         int             flushcnt;       /* #of flush trans on the list */
435
436         int             volhdrno;       /* last volhdrno written */
437         hammer2_volume_data_t voldata;
438         hammer2_volume_data_t volsync;  /* synchronized voldata */
439         struct bio_queue_head wthread_bioq; /* bio queue for write thread */
440         struct mtx wthread_mtx;     /* mutex for write thread */
441         int     wthread_destroy;    /* to control the write thread */
442 };
443
444 typedef struct hammer2_mount hammer2_mount_t;
445
446 /*
447  * HAMMER2 cluster - a device/root associated with a PFS.
448  *
449  * A PFS may have several hammer2_cluster's associated with it.
450  */
451 struct hammer2_cluster {
452         struct hammer2_mount    *hmp;           /* device global mount */
453         hammer2_chain_t         *rchain;        /* PFS root chain */
454 };
455
456 typedef struct hammer2_cluster hammer2_cluster_t;
457
458 /*
459  * HAMMER2 PFS mount point structure (aka vp->v_mount->mnt_data).
460  *
461  * This structure represents a cluster mount and not necessarily a
462  * PFS under a specific device mount (HMP).  The distinction is important
463  * because the elements backing a cluster mount can change on the fly.
464  */
465 struct hammer2_pfsmount {
466         struct mount            *mp;            /* kernel mount */
467         hammer2_cluster_t       *mount_cluster;
468         hammer2_cluster_t       *cluster;
469         hammer2_inode_t         *iroot;         /* PFS root inode */
470         hammer2_off_t           inode_count;    /* copy of inode_count */
471         ccms_domain_t           ccms_dom;
472         struct netexport        export;         /* nfs export */
473         int                     ronly;          /* read-only mount */
474         struct malloc_type      *minode;
475         struct malloc_type      *mmsg;
476         kdmsg_iocom_t           iocom;
477         struct spinlock         inum_spin;      /* inumber lookup */
478         struct hammer2_inode_tree inum_tree;
479         long                    inmem_inodes;
480         long                    inmem_chains;
481         int                     inmem_waiting;
482 };
483
484 typedef struct hammer2_pfsmount hammer2_pfsmount_t;
485
486 struct hammer2_cbinfo {
487         hammer2_chain_t *chain;
488         void (*func)(hammer2_chain_t *, struct buf *, char *, void *);
489         void *arg;
490         size_t boff;
491 };
492
493 typedef struct hammer2_cbinfo hammer2_cbinfo_t;
494
495 #if defined(_KERNEL)
496
497 MALLOC_DECLARE(M_HAMMER2);
498
499 #define VTOI(vp)        ((hammer2_inode_t *)(vp)->v_data)
500 #define ITOV(ip)        ((ip)->vp)
501
502 /*
503  * Currently locked chains retain the locked buffer cache buffer for
504  * indirect blocks, and indirect blocks can be one of two sizes.  The
505  * device buffer has to match the case to avoid deadlocking recursive
506  * chains that might otherwise try to access different offsets within
507  * the same device buffer.
508  */
509 static __inline
510 int
511 hammer2_devblkradix(int radix)
512 {
513 #if 1
514         if (radix <= HAMMER2_LBUFRADIX) {
515                 return (HAMMER2_LBUFRADIX);
516         } else {
517                 return (HAMMER2_PBUFRADIX);
518         }
519 #else
520         return (HAMMER2_PBUFRADIX);
521 #endif
522 }
523
524 static __inline
525 size_t
526 hammer2_devblksize(size_t bytes)
527 {
528 #if 1
529         if (bytes <= HAMMER2_LBUFSIZE) {
530                 return(HAMMER2_LBUFSIZE);
531         } else {
532                 KKASSERT(bytes <= HAMMER2_PBUFSIZE &&
533                          (bytes ^ (bytes - 1)) == ((bytes << 1) - 1));
534                 return (HAMMER2_PBUFSIZE);
535         }
536 #else
537         KKASSERT(bytes <= HAMMER2_PBUFSIZE &&
538                  (bytes ^ (bytes - 1)) == ((bytes << 1) - 1));
539         return(HAMMER2_PBUFSIZE);
540 #endif
541 }
542
543
544 static __inline
545 hammer2_pfsmount_t *
546 MPTOPMP(struct mount *mp)
547 {
548         return ((hammer2_pfsmount_t *)mp->mnt_data);
549 }
550
551 static __inline
552 hammer2_mount_t *
553 MPTOHMP(struct mount *mp)
554 {
555         return (((hammer2_pfsmount_t *)mp->mnt_data)->cluster->hmp);
556 }
557
558 extern struct vop_ops hammer2_vnode_vops;
559 extern struct vop_ops hammer2_spec_vops;
560 extern struct vop_ops hammer2_fifo_vops;
561
562 extern int hammer2_debug;
563 extern int hammer2_cluster_enable;
564 extern int hammer2_hardlink_enable;
565 extern long hammer2_iod_file_read;
566 extern long hammer2_iod_meta_read;
567 extern long hammer2_iod_indr_read;
568 extern long hammer2_iod_fmap_read;
569 extern long hammer2_iod_volu_read;
570 extern long hammer2_iod_file_write;
571 extern long hammer2_iod_meta_write;
572 extern long hammer2_iod_indr_write;
573 extern long hammer2_iod_fmap_write;
574 extern long hammer2_iod_volu_write;
575 extern long hammer2_ioa_file_read;
576 extern long hammer2_ioa_meta_read;
577 extern long hammer2_ioa_indr_read;
578 extern long hammer2_ioa_fmap_read;
579 extern long hammer2_ioa_volu_read;
580 extern long hammer2_ioa_file_write;
581 extern long hammer2_ioa_meta_write;
582 extern long hammer2_ioa_indr_write;
583 extern long hammer2_ioa_fmap_write;
584 extern long hammer2_ioa_volu_write;
585
586 extern struct objcache *cache_buffer_read;
587 extern struct objcache *cache_buffer_write;
588
589 extern int destroy;
590 extern int write_thread_wakeup;
591
592 extern mtx_t thread_protect;
593
594 /*
595  * hammer2_subr.c
596  */
597 #define hammer2_icrc32(buf, size)       iscsi_crc32((buf), (size))
598 #define hammer2_icrc32c(buf, size, crc) iscsi_crc32_ext((buf), (size), (crc))
599
600 hammer2_chain_t *hammer2_inode_lock_ex(hammer2_inode_t *ip);
601 hammer2_chain_t *hammer2_inode_lock_sh(hammer2_inode_t *ip);
602 void hammer2_inode_unlock_ex(hammer2_inode_t *ip, hammer2_chain_t *chain);
603 void hammer2_inode_unlock_sh(hammer2_inode_t *ip, hammer2_chain_t *chain);
604 void hammer2_voldata_lock(hammer2_mount_t *hmp);
605 void hammer2_voldata_unlock(hammer2_mount_t *hmp, int modify);
606 ccms_state_t hammer2_inode_lock_temp_release(hammer2_inode_t *ip);
607 void hammer2_inode_lock_temp_restore(hammer2_inode_t *ip, ccms_state_t ostate);
608 ccms_state_t hammer2_inode_lock_upgrade(hammer2_inode_t *ip);
609 void hammer2_inode_lock_downgrade(hammer2_inode_t *ip, ccms_state_t ostate);
610
611 void hammer2_mount_exlock(hammer2_mount_t *hmp);
612 void hammer2_mount_shlock(hammer2_mount_t *hmp);
613 void hammer2_mount_unlock(hammer2_mount_t *hmp);
614
615 int hammer2_get_dtype(hammer2_chain_t *chain);
616 int hammer2_get_vtype(hammer2_chain_t *chain);
617 u_int8_t hammer2_get_obj_type(enum vtype vtype);
618 void hammer2_time_to_timespec(u_int64_t xtime, struct timespec *ts);
619 u_int64_t hammer2_timespec_to_time(struct timespec *ts);
620 u_int32_t hammer2_to_unix_xid(uuid_t *uuid);
621 void hammer2_guid_to_uuid(uuid_t *uuid, u_int32_t guid);
622
623 hammer2_key_t hammer2_dirhash(const unsigned char *name, size_t len);
624 int hammer2_getradix(size_t bytes);
625
626 int hammer2_calc_logical(hammer2_inode_t *ip, hammer2_off_t uoff,
627                         hammer2_key_t *lbasep, hammer2_key_t *leofp);
628 int hammer2_calc_physical(hammer2_inode_t *ip, hammer2_key_t lbase);
629 void hammer2_update_time(uint64_t *timep);
630
631 /*
632  * hammer2_inode.c
633  */
634 struct vnode *hammer2_igetv(hammer2_inode_t *ip, int *errorp);
635
636 void hammer2_inode_lock_nlinks(hammer2_inode_t *ip);
637 void hammer2_inode_unlock_nlinks(hammer2_inode_t *ip);
638 hammer2_inode_t *hammer2_inode_lookup(hammer2_pfsmount_t *pmp,
639                         hammer2_tid_t inum);
640 hammer2_inode_t *hammer2_inode_get(hammer2_pfsmount_t *pmp,
641                         hammer2_inode_t *dip, hammer2_chain_t *chain);
642 void hammer2_inode_free(hammer2_inode_t *ip);
643 void hammer2_inode_ref(hammer2_inode_t *ip);
644 void hammer2_inode_drop(hammer2_inode_t *ip);
645 void hammer2_inode_repoint(hammer2_inode_t *ip, hammer2_inode_t *pip,
646                         hammer2_chain_t *chain);
647
648 hammer2_inode_t *hammer2_inode_create(hammer2_trans_t *trans,
649                         hammer2_inode_t *dip,
650                         struct vattr *vap, struct ucred *cred,
651                         const uint8_t *name, size_t name_len,
652                         hammer2_chain_t **chainp, int *errorp);
653 int hammer2_inode_connect(hammer2_trans_t *trans, int hlink,
654                         hammer2_inode_t *dip, hammer2_chain_t **chainp,
655                         const uint8_t *name, size_t name_len);
656 hammer2_inode_t *hammer2_inode_common_parent(hammer2_inode_t *fdip,
657                         hammer2_inode_t *tdip);
658 void hammer2_inode_fsync(hammer2_trans_t *trans, hammer2_inode_t *ip,
659                         hammer2_chain_t **parentp);
660 int hammer2_unlink_file(hammer2_trans_t *trans, hammer2_inode_t *dip,
661                         const uint8_t *name, size_t name_len, int isdir,
662                         int *hlinkp);
663 int hammer2_hardlink_consolidate(hammer2_trans_t *trans, hammer2_inode_t *ip,
664                         hammer2_chain_t **chainp,
665                         hammer2_inode_t *tdip, int linkcnt);
666 int hammer2_hardlink_deconsolidate(hammer2_trans_t *trans, hammer2_inode_t *dip,
667                         hammer2_chain_t **chainp, hammer2_chain_t **ochainp);
668 int hammer2_hardlink_find(hammer2_inode_t *dip,
669                         hammer2_chain_t **chainp, hammer2_chain_t **ochainp);
670
671 /*
672  * hammer2_chain.c
673  */
674 void hammer2_modify_volume(hammer2_mount_t *hmp);
675 hammer2_chain_t *hammer2_chain_alloc(hammer2_mount_t *hmp, hammer2_pfsmount_t *pmp,
676                                 hammer2_trans_t *trans, hammer2_blockref_t *bref);
677 void hammer2_chain_core_alloc(hammer2_trans_t *trans, hammer2_chain_t *nchain,
678                                 hammer2_chain_t *ochain);
679 void hammer2_chain_ref(hammer2_chain_t *chain);
680 void hammer2_chain_drop(hammer2_chain_t *chain);
681 int hammer2_chain_lock(hammer2_chain_t *chain, int how);
682 void hammer2_chain_load_async(hammer2_chain_t *chain,
683                                 void (*func)(hammer2_chain_t *, struct buf *,
684                                              char *, void *),
685                                 void *arg);
686 void hammer2_chain_moved(hammer2_chain_t *chain);
687 void hammer2_chain_modify(hammer2_trans_t *trans,
688                                 hammer2_chain_t **chainp, int flags);
689 hammer2_inode_data_t *hammer2_chain_modify_ip(hammer2_trans_t *trans,
690                                 hammer2_inode_t *ip, hammer2_chain_t **chainp,
691                                 int flags);
692 void hammer2_chain_resize(hammer2_trans_t *trans, hammer2_inode_t *ip,
693                                 hammer2_chain_t *parent,
694                                 hammer2_chain_t **chainp,
695                                 int nradix, int flags);
696 void hammer2_chain_unlock(hammer2_chain_t *chain);
697 void hammer2_chain_wait(hammer2_chain_t *chain);
698 hammer2_chain_t *hammer2_chain_get(hammer2_chain_t *parent,
699                                 hammer2_blockref_t *bref);
700 hammer2_chain_t *hammer2_chain_lookup_init(hammer2_chain_t *parent, int flags);
701 void hammer2_chain_lookup_done(hammer2_chain_t *parent);
702 hammer2_chain_t *hammer2_chain_lookup(hammer2_chain_t **parentp,
703                                 hammer2_key_t *key_nextp,
704                                 hammer2_key_t key_beg, hammer2_key_t key_end,
705                                 int *cache_indexp, int flags);
706 hammer2_chain_t *hammer2_chain_next(hammer2_chain_t **parentp,
707                                 hammer2_chain_t *chain,
708                                 hammer2_key_t *key_nextp,
709                                 hammer2_key_t key_beg, hammer2_key_t key_end,
710                                 int *cache_indexp, int flags);
711
712 int hammer2_chain_create(hammer2_trans_t *trans,
713                                 hammer2_chain_t **parentp,
714                                 hammer2_chain_t **chainp,
715                                 hammer2_key_t key, int keybits,
716                                 int type, size_t bytes);
717 void hammer2_chain_duplicate(hammer2_trans_t *trans, hammer2_chain_t *parent,
718                                 hammer2_chain_t **chainp,
719                                 hammer2_blockref_t *bref);
720 int hammer2_chain_snapshot(hammer2_trans_t *trans, hammer2_inode_t *ip,
721                                 hammer2_ioc_pfs_t *pfs);
722 void hammer2_chain_delete(hammer2_trans_t *trans, hammer2_chain_t *chain,
723                                 int flags);
724 void hammer2_chain_delete_duplicate(hammer2_trans_t *trans,
725                                 hammer2_chain_t **chainp, int flags);
726 void hammer2_chain_flush(hammer2_trans_t *trans, hammer2_chain_t *chain);
727 void hammer2_chain_commit(hammer2_trans_t *trans, hammer2_chain_t *chain);
728 void hammer2_chain_setsubmod(hammer2_trans_t *trans, hammer2_chain_t *chain);
729
730 void hammer2_chain_memory_wait(hammer2_pfsmount_t *pmp);
731 void hammer2_chain_memory_wakeup(hammer2_pfsmount_t *pmp);
732 void hammer2_chain_countbrefs(hammer2_chain_t *chain,
733                                 hammer2_blockref_t *base, int count);
734 void hammer2_chain_layer_check_locked(hammer2_mount_t *hmp,
735                                 hammer2_chain_core_t *core);
736
737 int hammer2_base_find(hammer2_chain_t *chain,
738                                 hammer2_blockref_t *base, int count,
739                                 int *cache_indexp, hammer2_key_t *key_nextp,
740                                 hammer2_key_t key_beg, hammer2_key_t key_end);
741 void hammer2_base_delete(hammer2_chain_t *chain,
742                                 hammer2_blockref_t *base, int count,
743                                 int *cache_indexp, hammer2_blockref_t *elm);
744 void hammer2_base_insert(hammer2_chain_t *chain,
745                                 hammer2_blockref_t *base, int count,
746                                 int *cache_indexp, hammer2_blockref_t *elm,
747                                 int flags);
748
749 /*
750  * hammer2_trans.c
751  */
752 void hammer2_trans_init(hammer2_trans_t *trans,
753                         hammer2_pfsmount_t *pmp, int flags);
754 void hammer2_trans_done(hammer2_trans_t *trans);
755
756 /*
757  * hammer2_ioctl.c
758  */
759 int hammer2_ioctl(hammer2_inode_t *ip, u_long com, void *data,
760                                 int fflag, struct ucred *cred);
761
762 /*
763  * hammer2_msgops.c
764  */
765 int hammer2_msg_dbg_rcvmsg(kdmsg_msg_t *msg);
766 int hammer2_msg_adhoc_input(kdmsg_msg_t *msg);
767
768 /*
769  * hammer2_vfsops.c
770  */
771 void hammer2_clusterctl_wakeup(kdmsg_iocom_t *iocom);
772 void hammer2_volconf_update(hammer2_pfsmount_t *pmp, int index);
773 void hammer2_cluster_reconnect(hammer2_pfsmount_t *pmp, struct file *fp);
774 void hammer2_dump_chain(hammer2_chain_t *chain, int tab, int *countp);
775
776 /*
777  * hammer2_freemap.c
778  */
779 int hammer2_freemap_alloc(hammer2_trans_t *trans, hammer2_mount_t *hmp,
780                                 hammer2_blockref_t *bref, size_t bytes);
781 void hammer2_freemap_free(hammer2_trans_t *trans, hammer2_mount_t *hmp,
782                                 hammer2_blockref_t *bref, int how);
783
784
785 #endif /* !_KERNEL */
786 #endif /* !_VFS_HAMMER2_HAMMER2_H_ */