hammer2 - Refactor frontend part 14/many
[dragonfly.git] / sys / vfs / hammer2 / hammer2.h
1 /*
2  * Copyright (c) 2011-2015 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  * HAMMER2 IN-MEMORY CACHE OF MEDIA STRUCTURES
38  *
39  * This header file contains structures used internally by the HAMMER2
40  * implementation.  See hammer2_disk.h for on-disk structures.
41  *
42  * There is an in-memory representation of all on-media data structure.
43  * Almost everything is represented by a hammer2_chain structure in-memory.
44  * Other higher-level structures typically map to chains.
45  *
46  * A great deal of data is accessed simply via its buffer cache buffer,
47  * which is mapped for the duration of the chain's lock.  Hammer2 must
48  * implement its own buffer cache layer on top of the system layer to
49  * allow for different threads to lock different sub-block-sized buffers.
50  *
51  * When modifications are made to a chain a new filesystem block must be
52  * allocated.  Multiple modifications do not typically allocate new blocks
53  * until the current block has been flushed.  Flushes do not block the
54  * front-end unless the front-end operation crosses the current inode being
55  * flushed.
56  *
57  * The in-memory representation may remain cached (for example in order to
58  * placemark clustering locks) even after the related data has been
59  * detached.
60  */
61
62 #ifndef _VFS_HAMMER2_HAMMER2_H_
63 #define _VFS_HAMMER2_HAMMER2_H_
64
65 #include <sys/param.h>
66 #include <sys/types.h>
67 #include <sys/kernel.h>
68 #include <sys/conf.h>
69 #include <sys/systm.h>
70 #include <sys/tree.h>
71 #include <sys/malloc.h>
72 #include <sys/mount.h>
73 #include <sys/vnode.h>
74 #include <sys/proc.h>
75 #include <sys/mountctl.h>
76 #include <sys/priv.h>
77 #include <sys/stat.h>
78 #include <sys/thread.h>
79 #include <sys/globaldata.h>
80 #include <sys/lockf.h>
81 #include <sys/buf.h>
82 #include <sys/queue.h>
83 #include <sys/limits.h>
84 #include <sys/dmsg.h>
85 #include <sys/mutex.h>
86 #include <sys/kern_syscall.h>
87
88 #include <sys/signal2.h>
89 #include <sys/buf2.h>
90 #include <sys/mutex2.h>
91 #include <sys/thread2.h>
92
93 #include "hammer2_disk.h"
94 #include "hammer2_mount.h"
95 #include "hammer2_ioctl.h"
96
97 struct hammer2_io;
98 struct hammer2_iocb;
99 struct hammer2_chain;
100 struct hammer2_cluster;
101 struct hammer2_inode;
102 struct hammer2_dev;
103 struct hammer2_pfs;
104 struct hammer2_span;
105 struct hammer2_state;
106 struct hammer2_msg;
107 struct hammer2_thread;
108 union hammer2_xop;
109
110 /*
111  * Mutex and lock shims.  Hammer2 requires support for asynchronous and
112  * abortable locks, and both exclusive and shared spinlocks.  Normal
113  * synchronous non-abortable locks can be substituted for spinlocks.
114  */
115 typedef mtx_t                           hammer2_mtx_t;
116 typedef mtx_link_t                      hammer2_mtx_link_t;
117 typedef mtx_state_t                     hammer2_mtx_state_t;
118
119 typedef struct spinlock                 hammer2_spin_t;
120
121 #define hammer2_mtx_ex                  mtx_lock_ex_quick
122 #define hammer2_mtx_sh                  mtx_lock_sh_quick
123 #define hammer2_mtx_unlock              mtx_unlock
124 #define hammer2_mtx_owned               mtx_owned
125 #define hammer2_mtx_init                mtx_init
126 #define hammer2_mtx_temp_release        mtx_lock_temp_release
127 #define hammer2_mtx_temp_restore        mtx_lock_temp_restore
128 #define hammer2_mtx_refs                mtx_lockrefs
129
130 #define hammer2_spin_init               spin_init
131 #define hammer2_spin_sh                 spin_lock_shared
132 #define hammer2_spin_ex                 spin_lock
133 #define hammer2_spin_unsh               spin_unlock_shared
134 #define hammer2_spin_unex               spin_unlock
135
136 TAILQ_HEAD(hammer2_xop_list, hammer2_xop_head);
137
138 typedef struct hammer2_xop_list hammer2_xop_list_t;
139
140
141 /*
142  * General lock support
143  */
144 static __inline
145 int
146 hammer2_mtx_upgrade(hammer2_mtx_t *mtx)
147 {
148         int wasexclusive;
149
150         if (mtx_islocked_ex(mtx)) {
151                 wasexclusive = 1;
152         } else {
153                 mtx_unlock(mtx);
154                 mtx_lock_ex_quick(mtx);
155                 wasexclusive = 0;
156         }
157         return wasexclusive;
158 }
159
160 /*
161  * Downgrade an inode lock from exclusive to shared only if the inode
162  * lock was previously shared.  If the inode lock was previously exclusive,
163  * this is a NOP.
164  */
165 static __inline
166 void
167 hammer2_mtx_downgrade(hammer2_mtx_t *mtx, int wasexclusive)
168 {
169         if (wasexclusive == 0)
170                 mtx_downgrade(mtx);
171 }
172
173 /*
174  * The xid tracks internal transactional updates.
175  *
176  * XXX fix-me, really needs to be 64-bits
177  */
178 typedef uint32_t hammer2_xid_t;
179
180 #define HAMMER2_XID_MIN 0x00000000U
181 #define HAMMER2_XID_MAX 0x7FFFFFFFU
182
183 /*
184  * The chain structure tracks a portion of the media topology from the
185  * root (volume) down.  Chains represent volumes, inodes, indirect blocks,
186  * data blocks, and freemap nodes and leafs.
187  *
188  * The chain structure utilizes a simple singly-homed topology and the
189  * chain's in-memory topology will move around as the chains do, due mainly
190  * to renames and indirect block creation.
191  *
192  * Block Table Updates
193  *
194  *      Block table updates for insertions and updates are delayed until the
195  *      flush.  This allows us to avoid having to modify the parent chain
196  *      all the way to the root.
197  *
198  *      Block table deletions are performed immediately (modifying the parent
199  *      in the process) because the flush code uses the chain structure to
200  *      track delayed updates and the chain will be (likely) gone or moved to
201  *      another location in the topology after a deletion.
202  *
203  *      A prior iteration of the code tried to keep the relationship intact
204  *      on deletes by doing a delete-duplicate operation on the chain, but
205  *      it added way too much complexity to the codebase.
206  *
207  * Flush Synchronization
208  *
209  *      The flush code must flush modified chains bottom-up.  Because chain
210  *      structures can shift around and are NOT topologically stable,
211  *      modified chains are independently indexed for the flush.  As the flush
212  *      runs it modifies (or further modifies) and updates the parents,
213  *      propagating the flush all the way to the volume root.
214  *
215  *      Modifying front-end operations can occur during a flush but will block
216  *      in two cases: (1) when the front-end tries to operate on the inode
217  *      currently in the midst of being flushed and (2) if the front-end
218  *      crosses an inode currently being flushed (such as during a rename).
219  *      So, for example, if you rename directory "x" to "a/b/c/d/e/f/g/x" and
220  *      the flusher is currently working on "a/b/c", the rename will block
221  *      temporarily in order to ensure that "x" exists in one place or the
222  *      other.
223  *
224  *      Meta-data statistics are updated by the flusher.  The front-end will
225  *      make estimates but meta-data must be fully synchronized only during a
226  *      flush in order to ensure that it remains correct across a crash.
227  *
228  *      Multiple flush synchronizations can theoretically be in-flight at the
229  *      same time but the implementation is not coded to handle the case and
230  *      currently serializes them.
231  *
232  * Snapshots:
233  *
234  *      Snapshots currently require the subdirectory tree being snapshotted
235  *      to be flushed.  The snapshot then creates a new super-root inode which
236  *      copies the flushed blockdata of the directory or file that was
237  *      snapshotted.
238  *
239  * RBTREE NOTES:
240  *
241  *      - Note that the radix tree runs in powers of 2 only so sub-trees
242  *        cannot straddle edges.
243  */
244 RB_HEAD(hammer2_chain_tree, hammer2_chain);
245 TAILQ_HEAD(h2_flush_list, hammer2_chain);
246 TAILQ_HEAD(h2_core_list, hammer2_chain);
247 TAILQ_HEAD(h2_iocb_list, hammer2_iocb);
248
249 #define CHAIN_CORE_DELETE_BMAP_ENTRIES  \
250         (HAMMER2_PBUFSIZE / sizeof(hammer2_blockref_t) / sizeof(uint32_t))
251
252 /*
253  * Core topology for chain (embedded in chain).  Protected by a spinlock.
254  */
255 struct hammer2_chain_core {
256         hammer2_spin_t  spin;
257         struct hammer2_chain_tree rbtree; /* sub-chains */
258         int             live_zero;      /* blockref array opt */
259         u_int           live_count;     /* live (not deleted) chains in tree */
260         u_int           chain_count;    /* live + deleted chains under core */
261         int             generation;     /* generation number (inserts only) */
262 };
263
264 typedef struct hammer2_chain_core hammer2_chain_core_t;
265
266 RB_HEAD(hammer2_io_tree, hammer2_io);
267
268 /*
269  * IOCB - IO callback (into chain, cluster, or manual request)
270  */
271 struct hammer2_iocb {
272         TAILQ_ENTRY(hammer2_iocb) entry;
273         void (*callback)(struct hammer2_iocb *iocb);
274         struct hammer2_io       *dio;
275         struct hammer2_cluster  *cluster;
276         struct hammer2_chain    *chain;
277         void                    *ptr;
278         off_t                   lbase;
279         int                     lsize;
280         uint32_t                flags;
281         int                     error;
282 };
283
284 typedef struct hammer2_iocb hammer2_iocb_t;
285
286 #define HAMMER2_IOCB_INTERLOCK  0x00000001
287 #define HAMMER2_IOCB_ONQ        0x00000002
288 #define HAMMER2_IOCB_DONE       0x00000004
289 #define HAMMER2_IOCB_INPROG     0x00000008
290 #define HAMMER2_IOCB_UNUSED10   0x00000010
291 #define HAMMER2_IOCB_QUICK      0x00010000
292 #define HAMMER2_IOCB_ZERO       0x00020000
293 #define HAMMER2_IOCB_READ       0x00040000
294 #define HAMMER2_IOCB_WAKEUP     0x00080000
295
296 /*
297  * DIO - Management structure wrapping system buffer cache.
298  *
299  *       Used for multiple purposes including concurrent management
300  *       if small requests by chains into larger DIOs.
301  */
302 struct hammer2_io {
303         RB_ENTRY(hammer2_io) rbnode;    /* indexed by device offset */
304         struct h2_iocb_list iocbq;
305         struct spinlock spin;
306         struct hammer2_dev *hmp;
307         struct buf      *bp;
308         off_t           pbase;
309         int             psize;
310         int             refs;
311         int             act;                    /* activity */
312 };
313
314 typedef struct hammer2_io hammer2_io_t;
315
316 #define HAMMER2_DIO_INPROG      0x80000000      /* bio in progress */
317 #define HAMMER2_DIO_GOOD        0x40000000      /* dio->bp is stable */
318 #define HAMMER2_DIO_WAITING     0x20000000      /* (old) */
319 #define HAMMER2_DIO_DIRTY       0x10000000      /* flush on last drop */
320
321 #define HAMMER2_DIO_MASK        0x0FFFFFFF
322
323 /*
324  * Primary chain structure keeps track of the topology in-memory.
325  */
326 struct hammer2_chain {
327         hammer2_mtx_t           lock;
328         hammer2_chain_core_t    core;
329         RB_ENTRY(hammer2_chain) rbnode;         /* live chain(s) */
330         hammer2_blockref_t      bref;
331         struct hammer2_chain    *parent;
332         struct hammer2_state    *state;         /* if active cache msg */
333         struct hammer2_dev      *hmp;
334         struct hammer2_pfs      *pmp;           /* A PFS or super-root (spmp) */
335
336         hammer2_io_t    *dio;                   /* physical data buffer */
337         u_int           bytes;                  /* physical data size */
338         u_int           flags;
339         u_int           refs;
340         u_int           lockcnt;
341         int             error;                  /* on-lock data error state */
342
343         hammer2_media_data_t *data;             /* data pointer shortcut */
344         TAILQ_ENTRY(hammer2_chain) flush_node;  /* flush list */
345 };
346
347 typedef struct hammer2_chain hammer2_chain_t;
348
349 int hammer2_chain_cmp(hammer2_chain_t *chain1, hammer2_chain_t *chain2);
350 RB_PROTOTYPE(hammer2_chain_tree, hammer2_chain, rbnode, hammer2_chain_cmp);
351
352 /*
353  * Special notes on flags:
354  *
355  * INITIAL      - This flag allows a chain to be created and for storage to
356  *                be allocated without having to immediately instantiate the
357  *                related buffer.  The data is assumed to be all-zeros.  It
358  *                is primarily used for indirect blocks.
359  *
360  * MODIFIED     - The chain's media data has been modified.
361  *
362  * UPDATE       - Chain might not be modified but parent blocktable needs update
363  *
364  * FICTITIOUS   - Faked chain as a placeholder for an error condition.  This
365  *                chain is unsuitable for I/O.
366  *
367  * BMAPPED      - Indicates that the chain is present in the parent blockmap.
368  *
369  * BMAPUPD      - Indicates that the chain is present but needs to be updated
370  *                in the parent blockmap.
371  */
372 #define HAMMER2_CHAIN_MODIFIED          0x00000001      /* dirty chain data */
373 #define HAMMER2_CHAIN_ALLOCATED         0x00000002      /* kmalloc'd chain */
374 #define HAMMER2_CHAIN_DESTROY           0x00000004
375 #define HAMMER2_CHAIN_UNUSED0008        0x00000008
376 #define HAMMER2_CHAIN_DELETED           0x00000010      /* deleted chain */
377 #define HAMMER2_CHAIN_INITIAL           0x00000020      /* initial create */
378 #define HAMMER2_CHAIN_UPDATE            0x00000040      /* need parent update */
379 #define HAMMER2_CHAIN_DEFERRED          0x00000080      /* flush depth defer */
380 #define HAMMER2_CHAIN_IOFLUSH           0x00000100      /* bawrite on put */
381 #define HAMMER2_CHAIN_ONFLUSH           0x00000200      /* on a flush list */
382 #define HAMMER2_CHAIN_FICTITIOUS        0x00000400      /* unsuitable for I/O */
383 #define HAMMER2_CHAIN_VOLUMESYNC        0x00000800      /* needs volume sync */
384 #define HAMMER2_CHAIN_DELAYED           0x00001000      /* delayed flush */
385 #define HAMMER2_CHAIN_COUNTEDBREFS      0x00002000      /* block table stats */
386 #define HAMMER2_CHAIN_ONRBTREE          0x00004000      /* on parent RB tree */
387 #define HAMMER2_CHAIN_UNUSED00008000    0x00008000
388 #define HAMMER2_CHAIN_EMBEDDED          0x00010000      /* embedded data */
389 #define HAMMER2_CHAIN_RELEASE           0x00020000      /* don't keep around */
390 #define HAMMER2_CHAIN_BMAPPED           0x00040000      /* present in blkmap */
391 #define HAMMER2_CHAIN_BMAPUPD           0x00080000      /* +needs updating */
392 #define HAMMER2_CHAIN_IOINPROG          0x00100000      /* I/O interlock */
393 #define HAMMER2_CHAIN_IOSIGNAL          0x00200000      /* I/O interlock */
394 #define HAMMER2_CHAIN_PFSBOUNDARY       0x00400000      /* super->pfs inode */
395
396 #define HAMMER2_CHAIN_FLUSH_MASK        (HAMMER2_CHAIN_MODIFIED |       \
397                                          HAMMER2_CHAIN_UPDATE |         \
398                                          HAMMER2_CHAIN_ONFLUSH)
399
400 /*
401  * Hammer2 error codes, used by chain->error and cluster->error.  The error
402  * code is typically set on-lock unless no I/O was requested, and set on
403  * I/O otherwise.  If set for a cluster it generally means that the cluster
404  * code could not find a valid copy to present.
405  *
406  * IO           - An I/O error occurred
407  * CHECK        - I/O succeeded but did not match the check code
408  * INCOMPLETE   - A cluster is not complete enough to use, or
409  *                a chain cannot be loaded because its parent has an error.
410  *
411  * NOTE: API allows callers to check zero/non-zero to determine if an error
412  *       condition exists.
413  *
414  * NOTE: Chain's data field is usually NULL on an IO error but not necessarily
415  *       NULL on other errors.  Check chain->error, not chain->data.
416  */
417 #define HAMMER2_ERROR_NONE              0
418 #define HAMMER2_ERROR_IO                1       /* device I/O error */
419 #define HAMMER2_ERROR_CHECK             2       /* check code mismatch */
420 #define HAMMER2_ERROR_INCOMPLETE        3       /* incomplete cluster */
421 #define HAMMER2_ERROR_DEPTH             4       /* temporary depth limit */
422
423 /*
424  * Flags passed to hammer2_chain_lookup() and hammer2_chain_next()
425  *
426  * NOTES:
427  *      NOLOCK      - Input and output chains are referenced only and not
428  *                    locked.  Output chain might be temporarily locked
429  *                    internally.
430  *
431  *      NODATA      - Asks that the chain->data not be resolved in order
432  *                    to avoid I/O.
433  *
434  *      NODIRECT    - Prevents a lookup of offset 0 in an inode from returning
435  *                    the inode itself if the inode is in DIRECTDATA mode
436  *                    (i.e. file is <= 512 bytes).  Used by the synchronization
437  *                    code to prevent confusion.
438  *
439  *      SHARED      - The input chain is expected to be locked shared,
440  *                    and the output chain is locked shared.
441  *
442  *      MATCHIND    - Allows an indirect block / freemap node to be returned
443  *                    when the passed key range matches the radix.  Remember
444  *                    that key_end is inclusive (e.g. {0x000,0xFFF},
445  *                    not {0x000,0x1000}).
446  *
447  *                    (Cannot be used for remote or cluster ops).
448  *
449  *      ALLNODES    - Allows NULL focus.
450  *
451  *      ALWAYS      - Always resolve the data.  If ALWAYS and NODATA are both
452  *                    missing, bulk file data is not resolved but inodes and
453  *                    other meta-data will.
454  *
455  *      NOUNLOCK    - Used by hammer2_chain_next() to leave the lock on
456  *                    the input chain intact.  The chain is still dropped.
457  *                    This allows the caller to add a reference to the chain
458  *                    and retain it in a locked state (used by the
459  *                    XOP/feed/collect code).
460  */
461 #define HAMMER2_LOOKUP_NOLOCK           0x00000001      /* ref only */
462 #define HAMMER2_LOOKUP_NODATA           0x00000002      /* data left NULL */
463 #define HAMMER2_LOOKUP_NODIRECT         0x00000004      /* no offset=0 DD */
464 #define HAMMER2_LOOKUP_SHARED           0x00000100
465 #define HAMMER2_LOOKUP_MATCHIND         0x00000200      /* return all chains */
466 #define HAMMER2_LOOKUP_ALLNODES         0x00000400      /* allow NULL focus */
467 #define HAMMER2_LOOKUP_ALWAYS           0x00000800      /* resolve data */
468 #define HAMMER2_LOOKUP_NOUNLOCK         0x00001000      /* leave lock intact */
469
470 /*
471  * Flags passed to hammer2_chain_modify() and hammer2_chain_resize()
472  *
473  * NOTE: OPTDATA allows us to avoid instantiating buffers for INDIRECT
474  *       blocks in the INITIAL-create state.
475  */
476 #define HAMMER2_MODIFY_OPTDATA          0x00000002      /* data can be NULL */
477 #define HAMMER2_MODIFY_NO_MODIFY_TID    0x00000004
478 #define HAMMER2_MODIFY_KEEPMODIFY       0x00000008
479 #define HAMMER2_MODIFY_NOREALLOC        0x00000010
480
481 /*
482  * Flags passed to hammer2_chain_lock()
483  *
484  * NOTE: RDONLY is set to optimize cluster operations when *no* modifications
485  *       will be made to either the cluster being locked or any underlying
486  *       cluster.  It allows the cluster to lock and access data for a subset
487  *       of available nodes instead of all available nodes.
488  */
489 #define HAMMER2_RESOLVE_NEVER           1
490 #define HAMMER2_RESOLVE_MAYBE           2
491 #define HAMMER2_RESOLVE_ALWAYS          3
492 #define HAMMER2_RESOLVE_MASK            0x0F
493
494 #define HAMMER2_RESOLVE_SHARED          0x10    /* request shared lock */
495 #define HAMMER2_RESOLVE_UNUSED20        0x20
496 #define HAMMER2_RESOLVE_RDONLY          0x40    /* higher level op flag */
497
498 /*
499  * Flags passed to hammer2_chain_delete()
500  */
501 #define HAMMER2_DELETE_PERMANENT        0x0001
502 #define HAMMER2_DELETE_NOSTATS          0x0002
503
504 #define HAMMER2_INSERT_NOSTATS          0x0002
505 #define HAMMER2_INSERT_PFSROOT          0x0004
506
507 /*
508  * Flags passed to hammer2_chain_delete_duplicate()
509  */
510 #define HAMMER2_DELDUP_RECORE           0x0001
511
512 /*
513  * Cluster different types of storage together for allocations
514  */
515 #define HAMMER2_FREECACHE_INODE         0
516 #define HAMMER2_FREECACHE_INDIR         1
517 #define HAMMER2_FREECACHE_DATA          2
518 #define HAMMER2_FREECACHE_UNUSED3       3
519 #define HAMMER2_FREECACHE_TYPES         4
520
521 /*
522  * hammer2_freemap_alloc() block preference
523  */
524 #define HAMMER2_OFF_NOPREF              ((hammer2_off_t)-1)
525
526 /*
527  * BMAP read-ahead maximum parameters
528  */
529 #define HAMMER2_BMAP_COUNT              16      /* max bmap read-ahead */
530 #define HAMMER2_BMAP_BYTES              (HAMMER2_PBUFSIZE * HAMMER2_BMAP_COUNT)
531
532 /*
533  * hammer2_freemap_adjust()
534  */
535 #define HAMMER2_FREEMAP_DORECOVER       1
536 #define HAMMER2_FREEMAP_DOMAYFREE       2
537 #define HAMMER2_FREEMAP_DOREALFREE      3
538
539 /*
540  * HAMMER2 cluster - A set of chains representing the same entity.
541  *
542  * hammer2_cluster typically represents a temporary set of representitive
543  * chains.  The one exception is that a hammer2_cluster is embedded in
544  * hammer2_inode.  This embedded cluster is ONLY used to track the
545  * representitive chains and cannot be directly locked.
546  *
547  * A cluster is usually temporary (and thus per-thread) for locking purposes,
548  * allowing us to embed the asynchronous storage required for cluster
549  * operations in the cluster itself and adjust the state and status without
550  * having to worry too much about SMP issues.
551  *
552  * The exception is the cluster embedded in the hammer2_inode structure.
553  * This is used to cache the cluster state on an inode-by-inode basis.
554  * Individual hammer2_chain structures not incorporated into clusters might
555  * also stick around to cache miscellanious elements.
556  *
557  * Because the cluster is a 'working copy' and is usually subject to cluster
558  * quorum rules, it is quite possible for us to end up with an insufficient
559  * number of live chains to execute an operation.  If an insufficient number
560  * of chains remain in a working copy, the operation may have to be
561  * downgraded, retried, stall until the requisit number of chains are
562  * available, or possibly even error out depending on the mount type.
563  *
564  * A cluster's focus is set when it is locked.  The focus can only be set
565  * to a chain still part of the synchronized set.
566  */
567 #define HAMMER2_MAXCLUSTER      8
568 #define HAMMER2_XOPFIFO         16
569 #define HAMMER2_XOPFIFO_MASK    (HAMMER2_XOPFIFO - 1)
570 #define HAMMER2_XOPGROUPS       16
571 #define HAMMER2_XOPGROUPS_MASK  (HAMMER2_XOPGROUPS - 1)
572 #define HAMMER2_XOPMASK_VOP     0x80000000U
573
574 struct hammer2_cluster_item {
575 #if 0
576         hammer2_mtx_link_t      async_link;
577 #endif
578         hammer2_chain_t         *chain;
579 #if 0
580         struct hammer2_cluster  *cluster;       /* link back to cluster */
581 #endif
582         int                     cache_index;
583         uint32_t                flags;
584 };
585
586 typedef struct hammer2_cluster_item hammer2_cluster_item_t;
587
588 /*
589  * INVALID      - Invalid for focus, i.e. not part of synchronized set.
590  *                Once set, this bit is sticky across operations.
591  *
592  * FEMOD        - Indicates that front-end modifying operations can
593  *                mess with this entry and MODSYNC will copy also
594  *                effect it.
595  */
596 #define HAMMER2_CITEM_INVALID   0x00000001
597 #define HAMMER2_CITEM_FEMOD     0x00000002
598 #define HAMMER2_CITEM_NULL      0x00000004
599
600 struct hammer2_cluster {
601         int                     refs;           /* track for deallocation */
602         int                     ddflag;
603         struct hammer2_pfs      *pmp;
604         uint32_t                flags;
605         int                     nchains;
606         int                     error;          /* error code valid on lock */
607         int                     focus_index;
608         hammer2_iocb_t          iocb;
609         hammer2_chain_t         *focus;         /* current focus (or mod) */
610         hammer2_cluster_item_t  array[HAMMER2_MAXCLUSTER];
611 };
612
613 typedef struct hammer2_cluster  hammer2_cluster_t;
614
615 /*
616  * WRHARD       - Hard mounts can write fully synchronized
617  * RDHARD       - Hard mounts can read fully synchronized
618  * UNHARD       - Unsynchronized masters present
619  * NOHARD       - No masters visible
620  * WRSOFT       - Soft mounts can write to at least the SOFT_MASTER
621  * RDSOFT       - Soft mounts can read from at least a SOFT_SLAVE
622  * UNSOFT       - Unsynchronized slaves present
623  * NOSOFT       - No slaves visible
624  * RDSLAVE      - slaves are accessible (possibly unsynchronized or remote).
625  * MSYNCED      - All masters are fully synchronized
626  * SSYNCED      - All known local slaves are fully synchronized to masters
627  *
628  * All available masters are always incorporated.  All PFSs belonging to a
629  * cluster (master, slave, copy, whatever) always try to synchronize the
630  * total number of known masters in the PFSs root inode.
631  *
632  * A cluster might have access to many slaves, copies, or caches, but we
633  * have a limited number of cluster slots.  Any such elements which are
634  * directly mounted from block device(s) will always be incorporated.   Note
635  * that SSYNCED only applies to such elements which are directly mounted,
636  * not to any remote slaves, copies, or caches that could be available.  These
637  * bits are used to monitor and drive our synchronization threads.
638  *
639  * When asking the question 'is any data accessible at all', then a simple
640  * test against (RDHARD|RDSOFT|RDSLAVE) gives you the answer.  If any of
641  * these bits are set the object can be read with certain caveats:
642  * RDHARD - no caveats.  RDSOFT - authoritative but might not be synchronized.
643  * and RDSLAVE - not authoritative, has some data but it could be old or
644  * incomplete.
645  *
646  * When both soft and hard mounts are available, data will be read and written
647  * via the soft mount only.  But all might be in the cluster because
648  * background synchronization threads still need to do their work.
649  */
650 #define HAMMER2_CLUSTER_INODE   0x00000001      /* embedded in inode struct */
651 #define HAMMER2_CLUSTER_UNUSED2 0x00000002
652 #define HAMMER2_CLUSTER_LOCKED  0x00000004      /* cluster lks not recursive */
653 #define HAMMER2_CLUSTER_WRHARD  0x00000100      /* hard-mount can write */
654 #define HAMMER2_CLUSTER_RDHARD  0x00000200      /* hard-mount can read */
655 #define HAMMER2_CLUSTER_UNHARD  0x00000400      /* unsynchronized masters */
656 #define HAMMER2_CLUSTER_NOHARD  0x00000800      /* no masters visible */
657 #define HAMMER2_CLUSTER_WRSOFT  0x00001000      /* soft-mount can write */
658 #define HAMMER2_CLUSTER_RDSOFT  0x00002000      /* soft-mount can read */
659 #define HAMMER2_CLUSTER_UNSOFT  0x00004000      /* unsynchronized slaves */
660 #define HAMMER2_CLUSTER_NOSOFT  0x00008000      /* no slaves visible */
661 #define HAMMER2_CLUSTER_MSYNCED 0x00010000      /* all masters synchronized */
662 #define HAMMER2_CLUSTER_SSYNCED 0x00020000      /* known slaves synchronized */
663
664 #define HAMMER2_CLUSTER_ANYDATA ( HAMMER2_CLUSTER_RDHARD |      \
665                                   HAMMER2_CLUSTER_RDSOFT |      \
666                                   HAMMER2_CLUSTER_RDSLAVE)
667
668 #define HAMMER2_CLUSTER_RDOK    ( HAMMER2_CLUSTER_RDHARD |      \
669                                   HAMMER2_CLUSTER_RDSOFT)
670
671 #define HAMMER2_CLUSTER_WROK    ( HAMMER2_CLUSTER_WRHARD |      \
672                                   HAMMER2_CLUSTER_WRSOFT)
673
674 #define HAMMER2_CLUSTER_ZFLAGS  ( HAMMER2_CLUSTER_WRHARD |      \
675                                   HAMMER2_CLUSTER_RDHARD |      \
676                                   HAMMER2_CLUSTER_WRSOFT |      \
677                                   HAMMER2_CLUSTER_RDSOFT |      \
678                                   HAMMER2_CLUSTER_MSYNCED |     \
679                                   HAMMER2_CLUSTER_SSYNCED)
680
681 /*
682  * Helper functions (cluster must be locked for flags to be valid).
683  */
684 static __inline
685 int
686 hammer2_cluster_rdok(hammer2_cluster_t *cluster)
687 {
688         return (cluster->flags & HAMMER2_CLUSTER_RDOK);
689 }
690
691 static __inline
692 int
693 hammer2_cluster_wrok(hammer2_cluster_t *cluster)
694 {
695         return (cluster->flags & HAMMER2_CLUSTER_WROK);
696 }
697
698 RB_HEAD(hammer2_inode_tree, hammer2_inode);
699
700 /*
701  * A hammer2 inode.
702  *
703  * NOTE: The inode-embedded cluster is never used directly for I/O (since
704  *       it may be shared).  Instead it will be replicated-in and synchronized
705  *       back out if changed.
706  */
707 struct hammer2_inode {
708         RB_ENTRY(hammer2_inode) rbnode;         /* inumber lookup (HL) */
709         hammer2_mtx_t           lock;           /* inode lock */
710         struct hammer2_pfs      *pmp;           /* PFS mount */
711         struct hammer2_inode    *pip;           /* parent inode */
712         struct vnode            *vp;
713         struct spinlock         cluster_spin;   /* update cluster */
714         hammer2_cluster_t       cluster;
715         struct lockf            advlock;
716         u_int                   flags;
717         u_int                   refs;           /* +vpref, +flushref */
718         uint8_t                 comp_heuristic;
719         hammer2_inode_meta_t    meta;           /* copy of meta-data */
720         hammer2_blockref_t      bref;           /* copy of bref statistics */
721         hammer2_off_t           osize;
722 };
723
724 typedef struct hammer2_inode hammer2_inode_t;
725
726 /*
727  * MODIFIED     - Inode is in a modified state, ip->meta may have changes.
728  * RESIZED      - Inode truncated (any) or inode extended beyond
729  *                EMBEDDED_BYTES.
730  */
731 #define HAMMER2_INODE_MODIFIED          0x0001
732 #define HAMMER2_INODE_SROOT             0x0002  /* kmalloc special case */
733 #define HAMMER2_INODE_RENAME_INPROG     0x0004
734 #define HAMMER2_INODE_ONRBTREE          0x0008
735 #define HAMMER2_INODE_RESIZED           0x0010  /* requires inode_fsync */
736 #define HAMMER2_INODE_UNUSED0020        0x0020
737 #define HAMMER2_INODE_ISUNLINKED        0x0040
738 #define HAMMER2_INODE_METAGOOD          0x0080  /* inode meta-data good */
739
740 int hammer2_inode_cmp(hammer2_inode_t *ip1, hammer2_inode_t *ip2);
741 RB_PROTOTYPE2(hammer2_inode_tree, hammer2_inode, rbnode, hammer2_inode_cmp,
742                 hammer2_tid_t);
743
744 /*
745  * inode-unlink side-structure
746  */
747 struct hammer2_inode_unlink {
748         TAILQ_ENTRY(hammer2_inode_unlink) entry;
749         hammer2_inode_t *ip;
750 };
751 TAILQ_HEAD(h2_unlk_list, hammer2_inode_unlink);
752
753 typedef struct hammer2_inode_unlink hammer2_inode_unlink_t;
754
755 /*
756  * Transaction management sub-structure under hammer2_pfs
757  */
758 struct hammer2_trans {
759         uint32_t                flags;
760         uint32_t                sync_wait;
761 };
762
763 typedef struct hammer2_trans hammer2_trans_t;
764
765 #define HAMMER2_TRANS_ISFLUSH           0x80000000      /* flush code */
766 #define HAMMER2_TRANS_BUFCACHE          0x40000000      /* bio strategy */
767 #define HAMMER2_TRANS_PREFLUSH          0x20000000      /* preflush state */
768 #define HAMMER2_TRANS_FPENDING          0x10000000      /* flush pending */
769 #define HAMMER2_TRANS_WAITING           0x08000000      /* someone waiting */
770 #define HAMMER2_TRANS_MASK              0x00FFFFFF      /* count mask */
771
772 #define HAMMER2_FREEMAP_HEUR_NRADIX     4       /* pwr 2 PBUFRADIX-MINIORADIX */
773 #define HAMMER2_FREEMAP_HEUR_TYPES      8
774 #define HAMMER2_FREEMAP_HEUR            (HAMMER2_FREEMAP_HEUR_NRADIX * \
775                                          HAMMER2_FREEMAP_HEUR_TYPES)
776
777 /*
778  * Hammer2 support thread element.
779  *
780  * Potentially many support threads can hang off of hammer2, primarily
781  * off the hammer2_pfs structure.  Typically:
782  *
783  * td x Nodes                   A synchronization thread for each node.
784  * td x Nodes x workers         Worker threads for frontend operations.
785  * td x 1                       Bioq thread for logical buffer writes.
786  *
787  * In addition, the synchronization thread(s) associated with the
788  * super-root PFS (spmp) for a node is responsible for automatic bulkfree
789  * and dedup scans.
790  */
791 struct hammer2_thread {
792         struct hammer2_pfs *pmp;
793         thread_t        td;
794         uint32_t        flags;
795         int             depth;
796         int             clindex;        /* cluster element index */
797         int             repidx;
798         struct lock     lk;             /* thread control lock */
799         hammer2_xop_list_t xopq;
800 };
801
802 typedef struct hammer2_thread hammer2_thread_t;
803
804 #define HAMMER2_THREAD_UNMOUNTING       0x0001  /* unmount request */
805 #define HAMMER2_THREAD_DEV              0x0002  /* related to dev, not pfs */
806 #define HAMMER2_THREAD_UNUSED04         0x0004
807 #define HAMMER2_THREAD_REMASTER         0x0008  /* remaster request */
808 #define HAMMER2_THREAD_STOP             0x0010  /* exit request */
809 #define HAMMER2_THREAD_FREEZE           0x0020  /* force idle */
810 #define HAMMER2_THREAD_FROZEN           0x0040  /* restart */
811
812
813 /*
814  * hammer2_xop - container for VOP/XOP operation (allocated, not on stack).
815  *
816  * This structure is used to distribute a VOP operation across multiple
817  * nodes.  It provides a rendezvous for concurrent node execution and
818  * can be detached from the frontend operation to allow the frontend to
819  * return early.
820  */
821 typedef void (*hammer2_xop_func_t)(union hammer2_xop *xop, int clidx);
822
823 typedef struct hammer2_xop_fifo {
824         TAILQ_ENTRY(hammer2_xop_head) entry;
825         hammer2_chain_t         *array[HAMMER2_XOPFIFO];
826         int                     errors[HAMMER2_XOPFIFO];
827         int                     ri;
828         int                     wi;
829         int                     unused03;
830 } hammer2_xop_fifo_t;
831
832 struct hammer2_xop_head {
833         hammer2_xop_func_t      func;
834         struct hammer2_inode    *ip;
835         struct hammer2_inode    *ip2;
836         struct hammer2_inode    *ip3;
837         struct hammer2_xop_group *xgrp;
838         uint32_t                check_counter;
839         uint32_t                run_mask;
840         uint32_t                chk_mask;
841         int                     state;
842         int                     error;
843         char                    *name;
844         size_t                  name_len;
845         char                    *name2;
846         size_t                  name2_len;
847         hammer2_key_t           lkey;
848         hammer2_key_t           nkey;
849         hammer2_xop_fifo_t      collect[HAMMER2_MAXCLUSTER];
850         hammer2_cluster_t       cluster;        /* help collections */
851 };
852
853 typedef struct hammer2_xop_head hammer2_xop_head_t;
854
855 struct hammer2_xop_strategy {
856         hammer2_xop_head_t      head;
857         hammer2_key_t           lbase;
858         int                     finished;
859         struct bio              *bio;
860 };
861
862 struct hammer2_xop_readdir {
863         hammer2_xop_head_t      head;
864 };
865
866 struct hammer2_xop_nresolve {
867         hammer2_xop_head_t      head;
868 };
869
870 struct hammer2_xop_nlink {
871         hammer2_xop_head_t      head;
872 };
873
874 struct hammer2_xop_unlink {
875         hammer2_xop_head_t      head;
876         int                     isdir;
877         int                     dopermanent;
878 };
879
880 struct hammer2_xop_nrename {
881         hammer2_xop_head_t      head;
882         hammer2_tid_t           lhc;
883         int                     ip_key;
884 };
885
886 struct hammer2_xop_scanlhc {
887         hammer2_xop_head_t      head;
888         hammer2_key_t           lhc;
889 };
890
891 struct hammer2_xop_create {
892         hammer2_xop_head_t      head;
893         hammer2_inode_meta_t    meta;           /* initial metadata */
894         hammer2_key_t           lhc;
895         int                     flags;
896 };
897
898 struct hammer2_xop_connect {
899         hammer2_xop_head_t      head;
900         hammer2_key_t           lhc;
901 };
902
903 struct hammer2_xop_destroy {
904         hammer2_xop_head_t      head;
905         hammer2_key_t           lhc;
906         int                     flags;
907 };
908
909 struct hammer2_xop_flush {
910         hammer2_xop_head_t      head;
911 };
912
913 typedef struct hammer2_xop_readdir hammer2_xop_readdir_t;
914 typedef struct hammer2_xop_nresolve hammer2_xop_nresolve_t;
915 typedef struct hammer2_xop_nlink hammer2_xop_nlink_t;
916 typedef struct hammer2_xop_unlink hammer2_xop_unlink_t;
917 typedef struct hammer2_xop_nrename hammer2_xop_nrename_t;
918 typedef struct hammer2_xop_strategy hammer2_xop_strategy_t;
919 typedef struct hammer2_xop_create hammer2_xop_create_t;
920 typedef struct hammer2_xop_destroy hammer2_xop_destroy_t;
921 typedef struct hammer2_xop_scanlhc hammer2_xop_scanlhc_t;
922 typedef struct hammer2_xop_connect hammer2_xop_connect_t;
923 typedef struct hammer2_xop_flush hammer2_xop_flush_t;
924
925 union hammer2_xop {
926         hammer2_xop_head_t      head;
927         hammer2_xop_readdir_t   xop_readdir;
928         hammer2_xop_nresolve_t  xop_nresolve;
929         hammer2_xop_nlink_t     xop_nlink;
930         hammer2_xop_unlink_t    xop_unlink;
931         hammer2_xop_nrename_t   xop_nrename;
932         hammer2_xop_strategy_t  xop_strategy;
933         hammer2_xop_create_t    xop_create;
934         hammer2_xop_destroy_t   xop_destroy;
935         hammer2_xop_scanlhc_t   xop_scanlhc;
936         hammer2_xop_flush_t     xop_flush;
937         hammer2_xop_connect_t   xop_connect;
938 };
939
940 typedef union hammer2_xop hammer2_xop_t;
941
942 /*
943  * hammer2_xop_group - Manage XOP support threads.
944  */
945 struct hammer2_xop_group {
946         hammer2_thread_t        thrs[HAMMER2_MAXCLUSTER];
947         hammer2_mtx_t           mtx;
948         hammer2_mtx_t           mtx2;
949 };
950
951 typedef struct hammer2_xop_group hammer2_xop_group_t;
952
953 /*
954  * flags to hammer2_xop_collect()
955  */
956 #define HAMMER2_XOP_COLLECT_NOWAIT      0x00000001
957 #define HAMMER2_XOP_COLLECT_WAITALL     0x00000002
958
959 /*
960  * flags to hammer2_xop_alloc()
961  *
962  * TRANS        - The frontend is in a transaction, backend operations
963  *                will do per-node transactions.
964  */
965 #define HAMMER2_XOP_TRANS               0x00000001
966
967 /*
968  * Global (per partition) management structure, represents a hard block
969  * device.  Typically referenced by hammer2_chain structures when applicable.
970  * Typically not used for network-managed elements.
971  *
972  * Note that a single hammer2_dev can be indirectly tied to multiple system
973  * mount points.  There is no direct relationship.  System mounts are
974  * per-cluster-id, not per-block-device, and a single hard mount might contain
975  * many PFSs and those PFSs might combine together in various ways to form
976  * the set of available clusters.
977  */
978 struct hammer2_dev {
979         struct vnode    *devvp;         /* device vnode */
980         int             ronly;          /* read-only mount */
981         int             mount_count;    /* number of actively mounted PFSs */
982         TAILQ_ENTRY(hammer2_dev) mntentry; /* hammer2_mntlist */
983
984         struct malloc_type *mchain;
985         int             nipstacks;
986         int             maxipstacks;
987         kdmsg_iocom_t   iocom;          /* volume-level dmsg interface */
988         struct spinlock io_spin;        /* iotree access */
989         struct hammer2_io_tree iotree;
990         int             iofree_count;
991         hammer2_chain_t vchain;         /* anchor chain (topology) */
992         hammer2_chain_t fchain;         /* anchor chain (freemap) */
993         struct spinlock list_spin;
994         struct h2_flush_list    flushq; /* flush seeds */
995         struct hammer2_pfs *spmp;       /* super-root pmp for transactions */
996         struct lock     vollk;          /* lockmgr lock */
997         hammer2_off_t   heur_freemap[HAMMER2_FREEMAP_HEUR];
998         int             volhdrno;       /* last volhdrno written */
999         char            devrepname[64]; /* for kprintf */
1000         hammer2_volume_data_t voldata;
1001         hammer2_volume_data_t volsync;  /* synchronized voldata */
1002 };
1003
1004 typedef struct hammer2_dev hammer2_dev_t;
1005
1006 /*
1007  * Helper functions (cluster must be locked for flags to be valid).
1008  */
1009 static __inline
1010 int
1011 hammer2_chain_rdok(hammer2_chain_t *chain)
1012 {
1013         return (chain->error == 0);
1014 }
1015
1016 static __inline
1017 int
1018 hammer2_chain_wrok(hammer2_chain_t *chain)
1019 {
1020         return (chain->error == 0 && chain->hmp->ronly == 0);
1021 }
1022
1023 /*
1024  * Per-cluster management structure.  This structure will be tied to a
1025  * system mount point if the system is mounting the PFS, but is also used
1026  * to manage clusters encountered during the super-root scan or received
1027  * via LNK_SPANs that might not be mounted.
1028  *
1029  * This structure is also used to represent the super-root that hangs off
1030  * of a hard mount point.  The super-root is not really a cluster element.
1031  * In this case the spmp_hmp field will be non-NULL.  It's just easier to do
1032  * this than to special case super-root manipulation in the hammer2_chain*
1033  * code as being only hammer2_dev-related.
1034  *
1035  * pfs_mode and pfs_nmasters are rollup fields which critically describes
1036  * how elements of the cluster act on the cluster.  pfs_mode is only applicable
1037  * when a PFS is mounted by the system.  pfs_nmasters is our best guess as to
1038  * how many masters have been configured for a cluster and is always
1039  * applicable.  pfs_types[] is an array with 1:1 correspondance to the
1040  * iroot cluster and describes the PFS types of the nodes making up the
1041  * cluster.
1042  *
1043  * WARNING! Portions of this structure have deferred initialization.  In
1044  *          particular, if not mounted there will be no ihidden or wthread.
1045  *          umounted network PFSs will also be missing iroot and numerous
1046  *          other fields will not be initialized prior to mount.
1047  *
1048  *          Synchronization threads are chain-specific and only applicable
1049  *          to local hard PFS entries.  A hammer2_pfs structure may contain
1050  *          more than one when multiple hard PFSs are present on the local
1051  *          machine which require synchronization monitoring.  Most PFSs
1052  *          (such as snapshots) are 1xMASTER PFSs which do not need a
1053  *          synchronization thread.
1054  *
1055  * WARNING! The chains making up pfs->iroot's cluster are accounted for in
1056  *          hammer2_dev->mount_count when the pfs is associated with a mount
1057  *          point.
1058  */
1059 struct hammer2_pfs {
1060         struct mount            *mp;
1061         TAILQ_ENTRY(hammer2_pfs) mntentry;      /* hammer2_pfslist */
1062         uuid_t                  pfs_clid;
1063         hammer2_dev_t           *spmp_hmp;      /* only if super-root pmp */
1064         hammer2_inode_t         *iroot;         /* PFS root inode */
1065         hammer2_inode_t         *ihidden;       /* PFS hidden directory */
1066         uint8_t                 pfs_types[HAMMER2_MAXCLUSTER];
1067         char                    *pfs_names[HAMMER2_MAXCLUSTER];
1068         hammer2_trans_t         trans;
1069         struct lock             lock;           /* PFS lock for certain ops */
1070         struct netexport        export;         /* nfs export */
1071         int                     ronly;          /* read-only mount */
1072         struct malloc_type      *minode;
1073         struct malloc_type      *mmsg;
1074         struct spinlock         inum_spin;      /* inumber lookup */
1075         struct hammer2_inode_tree inum_tree;    /* (not applicable to spmp) */
1076         hammer2_tid_t           modify_tid;     /* modify transaction id */
1077         hammer2_tid_t           inode_tid;      /* inode allocator */
1078         uint8_t                 pfs_nmasters;   /* total masters */
1079         uint8_t                 pfs_mode;       /* operating mode PFSMODE */
1080         uint8_t                 unused01;
1081         uint8_t                 unused02;
1082         int                     xop_iterator;
1083         long                    inmem_inodes;
1084         uint32_t                inmem_dirty_chains;
1085         int                     count_lwinprog; /* logical write in prog */
1086         struct spinlock         list_spin;
1087         struct h2_unlk_list     unlinkq;        /* last-close unlink */
1088         hammer2_thread_t        sync_thrs[HAMMER2_MAXCLUSTER];
1089         uint32_t                flags;          /* cached cluster flags */
1090         hammer2_xop_group_t     xop_groups[HAMMER2_XOPGROUPS];
1091 };
1092
1093 typedef struct hammer2_pfs hammer2_pfs_t;
1094
1095 #define HAMMER2_DIRTYCHAIN_WAITING      0x80000000
1096 #define HAMMER2_DIRTYCHAIN_MASK         0x7FFFFFFF
1097
1098 #define HAMMER2_LWINPROG_WAITING        0x80000000
1099 #define HAMMER2_LWINPROG_WAITING0       0x40000000
1100 #define HAMMER2_LWINPROG_MASK           0x3FFFFFFF
1101
1102 /*
1103  * hammer2_cluster_check
1104  */
1105 #define HAMMER2_CHECK_NULL      0x00000001
1106
1107 /*
1108  * Bulkscan
1109  */
1110 #define HAMMER2_BULK_ABORT      0x00000001
1111
1112 /*
1113  * Misc
1114  */
1115 #if defined(_KERNEL)
1116
1117 MALLOC_DECLARE(M_HAMMER2);
1118
1119 #define VTOI(vp)        ((hammer2_inode_t *)(vp)->v_data)
1120 #define ITOV(ip)        ((ip)->vp)
1121
1122 /*
1123  * Currently locked chains retain the locked buffer cache buffer for
1124  * indirect blocks, and indirect blocks can be one of two sizes.  The
1125  * device buffer has to match the case to avoid deadlocking recursive
1126  * chains that might otherwise try to access different offsets within
1127  * the same device buffer.
1128  */
1129 static __inline
1130 int
1131 hammer2_devblkradix(int radix)
1132 {
1133 #if 0
1134         if (radix <= HAMMER2_LBUFRADIX) {
1135                 return (HAMMER2_LBUFRADIX);
1136         } else {
1137                 return (HAMMER2_PBUFRADIX);
1138         }
1139 #endif
1140         return (HAMMER2_PBUFRADIX);
1141 }
1142
1143 /*
1144  * XXX almost time to remove this.  DIO uses PBUFSIZE exclusively now.
1145  */
1146 static __inline
1147 size_t
1148 hammer2_devblksize(size_t bytes)
1149 {
1150 #if 0
1151         if (bytes <= HAMMER2_LBUFSIZE) {
1152                 return(HAMMER2_LBUFSIZE);
1153         } else {
1154                 KKASSERT(bytes <= HAMMER2_PBUFSIZE &&
1155                          (bytes ^ (bytes - 1)) == ((bytes << 1) - 1));
1156                 return (HAMMER2_PBUFSIZE);
1157         }
1158 #endif
1159         return (HAMMER2_PBUFSIZE);
1160 }
1161
1162
1163 static __inline
1164 hammer2_pfs_t *
1165 MPTOPMP(struct mount *mp)
1166 {
1167         return ((hammer2_pfs_t *)mp->mnt_data);
1168 }
1169
1170 #define LOCKSTART       int __nlocks = curthread->td_locks
1171 #define LOCKENTER       (++curthread->td_locks)
1172 #define LOCKEXIT        (--curthread->td_locks)
1173 #define LOCKSTOP        KKASSERT(curthread->td_locks == __nlocks)
1174
1175 extern struct vop_ops hammer2_vnode_vops;
1176 extern struct vop_ops hammer2_spec_vops;
1177 extern struct vop_ops hammer2_fifo_vops;
1178
1179 extern int hammer2_debug;
1180 extern int hammer2_cluster_enable;
1181 extern int hammer2_hardlink_enable;
1182 extern int hammer2_flush_pipe;
1183 extern int hammer2_synchronous_flush;
1184 extern int hammer2_dio_count;
1185 extern long hammer2_limit_dirty_chains;
1186 extern long hammer2_iod_file_read;
1187 extern long hammer2_iod_meta_read;
1188 extern long hammer2_iod_indr_read;
1189 extern long hammer2_iod_fmap_read;
1190 extern long hammer2_iod_volu_read;
1191 extern long hammer2_iod_file_write;
1192 extern long hammer2_iod_meta_write;
1193 extern long hammer2_iod_indr_write;
1194 extern long hammer2_iod_fmap_write;
1195 extern long hammer2_iod_volu_write;
1196 extern long hammer2_ioa_file_read;
1197 extern long hammer2_ioa_meta_read;
1198 extern long hammer2_ioa_indr_read;
1199 extern long hammer2_ioa_fmap_read;
1200 extern long hammer2_ioa_volu_read;
1201 extern long hammer2_ioa_file_write;
1202 extern long hammer2_ioa_meta_write;
1203 extern long hammer2_ioa_indr_write;
1204 extern long hammer2_ioa_fmap_write;
1205 extern long hammer2_ioa_volu_write;
1206
1207 extern struct objcache *cache_buffer_read;
1208 extern struct objcache *cache_buffer_write;
1209 extern struct objcache *cache_xops;
1210
1211 /*
1212  * hammer2_subr.c
1213  */
1214 #define hammer2_icrc32(buf, size)       iscsi_crc32((buf), (size))
1215 #define hammer2_icrc32c(buf, size, crc) iscsi_crc32_ext((buf), (size), (crc))
1216
1217 int hammer2_signal_check(time_t *timep);
1218 const char *hammer2_error_str(int error);
1219
1220 void hammer2_inode_lock(hammer2_inode_t *ip, int how);
1221 void hammer2_inode_unlock(hammer2_inode_t *ip, hammer2_cluster_t *cluster);
1222 hammer2_cluster_t *hammer2_inode_cluster(hammer2_inode_t *ip, int how);
1223 hammer2_chain_t *hammer2_inode_chain(hammer2_inode_t *ip, int clindex, int how);
1224 hammer2_mtx_state_t hammer2_inode_lock_temp_release(hammer2_inode_t *ip);
1225 void hammer2_inode_lock_temp_restore(hammer2_inode_t *ip,
1226                         hammer2_mtx_state_t ostate);
1227 int hammer2_inode_lock_upgrade(hammer2_inode_t *ip);
1228 void hammer2_inode_lock_downgrade(hammer2_inode_t *ip, int);
1229
1230 void hammer2_dev_exlock(hammer2_dev_t *hmp);
1231 void hammer2_dev_shlock(hammer2_dev_t *hmp);
1232 void hammer2_dev_unlock(hammer2_dev_t *hmp);
1233
1234 int hammer2_get_dtype(const hammer2_inode_data_t *ipdata);
1235 int hammer2_get_vtype(uint8_t type);
1236 u_int8_t hammer2_get_obj_type(enum vtype vtype);
1237 void hammer2_time_to_timespec(u_int64_t xtime, struct timespec *ts);
1238 u_int64_t hammer2_timespec_to_time(const struct timespec *ts);
1239 u_int32_t hammer2_to_unix_xid(const uuid_t *uuid);
1240 void hammer2_guid_to_uuid(uuid_t *uuid, u_int32_t guid);
1241 void hammer2_trans_manage_init(hammer2_pfs_t *pmp);
1242
1243 hammer2_key_t hammer2_dirhash(const unsigned char *name, size_t len);
1244 int hammer2_getradix(size_t bytes);
1245
1246 int hammer2_calc_logical(hammer2_inode_t *ip, hammer2_off_t uoff,
1247                         hammer2_key_t *lbasep, hammer2_key_t *leofp);
1248 int hammer2_calc_physical(hammer2_inode_t *ip, hammer2_key_t lbase);
1249 void hammer2_update_time(uint64_t *timep);
1250 void hammer2_adjreadcounter(hammer2_blockref_t *bref, size_t bytes);
1251
1252 /*
1253  * hammer2_inode.c
1254  */
1255 struct vnode *hammer2_igetv(hammer2_inode_t *ip, int *errorp);
1256 hammer2_inode_t *hammer2_inode_lookup(hammer2_pfs_t *pmp,
1257                         hammer2_tid_t inum);
1258 hammer2_inode_t *hammer2_inode_get(hammer2_pfs_t *pmp,
1259                         hammer2_inode_t *dip, hammer2_cluster_t *cluster);
1260 void hammer2_inode_free(hammer2_inode_t *ip);
1261 void hammer2_inode_ref(hammer2_inode_t *ip);
1262 void hammer2_inode_drop(hammer2_inode_t *ip);
1263 void hammer2_inode_repoint(hammer2_inode_t *ip, hammer2_inode_t *pip,
1264                         hammer2_cluster_t *cluster);
1265 void hammer2_inode_repoint_one(hammer2_inode_t *ip, hammer2_cluster_t *cluster,
1266                         int idx);
1267 void hammer2_inode_modify(hammer2_inode_t *ip);
1268 void hammer2_run_unlinkq(hammer2_pfs_t *pmp);
1269
1270 hammer2_inode_t *hammer2_inode_create(hammer2_inode_t *dip,
1271                         struct vattr *vap, struct ucred *cred,
1272                         const uint8_t *name, size_t name_len,
1273                         hammer2_key_t inum, uint8_t type, uint8_t target_type,
1274                         int flags, int *errorp);
1275 int hammer2_inode_connect_simple(hammer2_inode_t *dip, hammer2_inode_t *ip,
1276                         const char *name, size_t name_len,
1277                         hammer2_key_t lhc);
1278 hammer2_inode_t *hammer2_inode_common_parent(hammer2_inode_t *fdip,
1279                         hammer2_inode_t *tdip);
1280 void hammer2_inode_fsync(hammer2_inode_t *ip, hammer2_cluster_t *cparent);
1281 int hammer2_inode_unlink_finisher(hammer2_inode_t *ip, int isopen);
1282 int hammer2_parent_find(hammer2_cluster_t **cparentp,
1283                         hammer2_cluster_t *cluster);
1284 void hammer2_inode_install_hidden(hammer2_pfs_t *pmp);
1285
1286 /*
1287  * hammer2_chain.c
1288  */
1289 void hammer2_voldata_lock(hammer2_dev_t *hmp);
1290 void hammer2_voldata_unlock(hammer2_dev_t *hmp);
1291 void hammer2_voldata_modify(hammer2_dev_t *hmp);
1292 hammer2_chain_t *hammer2_chain_alloc(hammer2_dev_t *hmp,
1293                                 hammer2_pfs_t *pmp,
1294                                 hammer2_blockref_t *bref);
1295 void hammer2_chain_core_init(hammer2_chain_t *chain);
1296 void hammer2_chain_ref(hammer2_chain_t *chain);
1297 void hammer2_chain_drop(hammer2_chain_t *chain);
1298 void hammer2_chain_lock(hammer2_chain_t *chain, int how);
1299 void hammer2_chain_load_data(hammer2_chain_t *chain);
1300 const hammer2_media_data_t *hammer2_chain_rdata(hammer2_chain_t *chain);
1301 hammer2_media_data_t *hammer2_chain_wdata(hammer2_chain_t *chain);
1302
1303 int hammer2_chain_hardlink_find(hammer2_inode_t *dip,
1304                                 hammer2_chain_t **parentp,
1305                                 hammer2_chain_t **chainp,
1306                                 int flags);
1307
1308 /*
1309  * hammer2_cluster.c
1310  */
1311 void hammer2_cluster_load_async(hammer2_cluster_t *cluster,
1312                                 void (*callback)(hammer2_iocb_t *iocb),
1313                                 void *ptr);
1314 void hammer2_chain_moved(hammer2_chain_t *chain);
1315 void hammer2_chain_modify(hammer2_chain_t *chain, int flags);
1316 void hammer2_chain_modify_ip(hammer2_inode_t *ip, hammer2_chain_t *chain,
1317                                 int flags);
1318 void hammer2_chain_resize(hammer2_inode_t *ip, hammer2_chain_t *parent,
1319                                 hammer2_chain_t *chain, int nradix, int flags);
1320 void hammer2_chain_unlock(hammer2_chain_t *chain);
1321 void hammer2_chain_wait(hammer2_chain_t *chain);
1322 hammer2_chain_t *hammer2_chain_get(hammer2_chain_t *parent, int generation,
1323                                 hammer2_blockref_t *bref);
1324 hammer2_chain_t *hammer2_chain_lookup_init(hammer2_chain_t *parent, int flags);
1325 void hammer2_chain_lookup_done(hammer2_chain_t *parent);
1326 hammer2_chain_t *hammer2_chain_getparent(hammer2_chain_t **parentp, int how);
1327 hammer2_chain_t *hammer2_chain_lookup(hammer2_chain_t **parentp,
1328                                 hammer2_key_t *key_nextp,
1329                                 hammer2_key_t key_beg, hammer2_key_t key_end,
1330                                 int *cache_indexp, int flags);
1331 hammer2_chain_t *hammer2_chain_next(hammer2_chain_t **parentp,
1332                                 hammer2_chain_t *chain,
1333                                 hammer2_key_t *key_nextp,
1334                                 hammer2_key_t key_beg, hammer2_key_t key_end,
1335                                 int *cache_indexp, int flags);
1336 hammer2_chain_t *hammer2_chain_scan(hammer2_chain_t *parent,
1337                                 hammer2_chain_t *chain,
1338                                 int *cache_indexp, int flags);
1339
1340 int hammer2_chain_create(hammer2_chain_t **parentp,
1341                                 hammer2_chain_t **chainp,
1342                                 hammer2_pfs_t *pmp,
1343                                 hammer2_key_t key, int keybits,
1344                                 int type, size_t bytes, int flags);
1345 void hammer2_chain_rename(hammer2_blockref_t *bref,
1346                                 hammer2_chain_t **parentp,
1347                                 hammer2_chain_t *chain, int flags);
1348 int hammer2_chain_snapshot(hammer2_chain_t **chainp,
1349                                 hammer2_ioc_pfs_t *pmp);
1350 void hammer2_chain_delete(hammer2_chain_t *parent,
1351                                 hammer2_chain_t *chain, int flags);
1352 void hammer2_flush(hammer2_chain_t *chain, int istop);
1353 void hammer2_delayed_flush(hammer2_chain_t *chain);
1354 void hammer2_chain_setflush(hammer2_chain_t *chain);
1355 void hammer2_chain_countbrefs(hammer2_chain_t *chain,
1356                                 hammer2_blockref_t *base, int count);
1357
1358 void hammer2_chain_setcheck(hammer2_chain_t *chain, void *bdata);
1359 int hammer2_chain_testcheck(hammer2_chain_t *chain, void *bdata);
1360
1361
1362 void hammer2_pfs_memory_wait(hammer2_pfs_t *pmp);
1363 void hammer2_pfs_memory_inc(hammer2_pfs_t *pmp);
1364 void hammer2_pfs_memory_wakeup(hammer2_pfs_t *pmp);
1365
1366 void hammer2_base_delete(hammer2_chain_t *chain,
1367                                 hammer2_blockref_t *base, int count,
1368                                 int *cache_indexp, hammer2_chain_t *child);
1369 void hammer2_base_insert(hammer2_chain_t *chain,
1370                                 hammer2_blockref_t *base, int count,
1371                                 int *cache_indexp, hammer2_chain_t *child);
1372
1373 /*
1374  * hammer2_trans.c
1375  */
1376 void hammer2_trans_init(hammer2_pfs_t *pmp, uint32_t flags);
1377 void hammer2_trans_done(hammer2_pfs_t *pmp);
1378 hammer2_tid_t hammer2_trans_newinum(hammer2_pfs_t *pmp);
1379 void hammer2_trans_assert_strategy(hammer2_pfs_t *pmp);
1380
1381 /*
1382  * hammer2_ioctl.c
1383  */
1384 int hammer2_ioctl(hammer2_inode_t *ip, u_long com, void *data,
1385                                 int fflag, struct ucred *cred);
1386
1387 /*
1388  * hammer2_io.c
1389  */
1390 void hammer2_io_putblk(hammer2_io_t **diop);
1391 void hammer2_io_cleanup(hammer2_dev_t *hmp, struct hammer2_io_tree *tree);
1392 char *hammer2_io_data(hammer2_io_t *dio, off_t lbase);
1393 void hammer2_io_getblk(hammer2_dev_t *hmp, off_t lbase, int lsize,
1394                                 hammer2_iocb_t *iocb);
1395 void hammer2_io_complete(hammer2_iocb_t *iocb);
1396 void hammer2_io_callback(struct bio *bio);
1397 void hammer2_iocb_wait(hammer2_iocb_t *iocb);
1398 int hammer2_io_new(hammer2_dev_t *hmp, off_t lbase, int lsize,
1399                                 hammer2_io_t **diop);
1400 int hammer2_io_newnz(hammer2_dev_t *hmp, off_t lbase, int lsize,
1401                                 hammer2_io_t **diop);
1402 int hammer2_io_newq(hammer2_dev_t *hmp, off_t lbase, int lsize,
1403                                 hammer2_io_t **diop);
1404 int hammer2_io_bread(hammer2_dev_t *hmp, off_t lbase, int lsize,
1405                                 hammer2_io_t **diop);
1406 void hammer2_io_bawrite(hammer2_io_t **diop);
1407 void hammer2_io_bdwrite(hammer2_io_t **diop);
1408 int hammer2_io_bwrite(hammer2_io_t **diop);
1409 int hammer2_io_isdirty(hammer2_io_t *dio);
1410 void hammer2_io_setdirty(hammer2_io_t *dio);
1411 void hammer2_io_setinval(hammer2_io_t *dio, u_int bytes);
1412 void hammer2_io_brelse(hammer2_io_t **diop);
1413 void hammer2_io_bqrelse(hammer2_io_t **diop);
1414
1415 /*
1416  * hammer2_xops.c
1417  */
1418 void hammer2_xop_group_init(hammer2_pfs_t *pmp, hammer2_xop_group_t *xgrp);
1419 hammer2_xop_t *hammer2_xop_alloc(hammer2_inode_t *ip);
1420 void hammer2_xop_setname(hammer2_xop_head_t *xop,
1421                                 const char *name, size_t name_len);
1422 void hammer2_xop_setname2(hammer2_xop_head_t *xop,
1423                                 const char *name, size_t name_len);
1424 void hammer2_xop_setip2(hammer2_xop_head_t *xop, hammer2_inode_t *ip2);
1425 void hammer2_xop_setip3(hammer2_xop_head_t *xop, hammer2_inode_t *ip3);
1426 void hammer2_xop_reinit(hammer2_xop_head_t *xop);
1427 void hammer2_xop_helper_create(hammer2_pfs_t *pmp);
1428 void hammer2_xop_helper_cleanup(hammer2_pfs_t *pmp);
1429 void hammer2_xop_start(hammer2_xop_head_t *xop, hammer2_xop_func_t func);
1430 int hammer2_xop_collect(hammer2_xop_head_t *xop, int flags);
1431 void hammer2_xop_retire(hammer2_xop_head_t *xop, uint32_t mask);
1432 int hammer2_xop_active(hammer2_xop_head_t *xop);
1433 int hammer2_xop_feed(hammer2_xop_head_t *xop, hammer2_chain_t *chain,
1434                                 int clindex, int error);
1435
1436
1437 void hammer2_xop_readdir(hammer2_xop_t *xop, int clidx);
1438 void hammer2_xop_nresolve(hammer2_xop_t *xop, int clidx);
1439 void hammer2_xop_unlink(hammer2_xop_t *xop, int clidx);
1440 void hammer2_xop_nrename(hammer2_xop_t *xop, int clidx);
1441 void hammer2_xop_nlink(hammer2_xop_t *xop, int clidx);
1442 void hammer2_inode_xop_scanlhc(hammer2_xop_t *xop, int clidx);
1443 void hammer2_inode_xop_create(hammer2_xop_t *xop, int clidx);
1444 void hammer2_inode_xop_destroy(hammer2_xop_t *xop, int clidx);
1445 void hammer2_inode_xop_connect(hammer2_xop_t *xop, int clidx);
1446 void hammer2_inode_xop_flush(hammer2_xop_t *xop, int clidx);
1447 #if 0
1448 int hammer2_xop_nmkdir(struct vop_nmkdir_args *ap);
1449 int hammer2_xop_advlock(struct vop_advlock_args *ap);
1450 int hammer2_xop_nlink(struct vop_nlink_args *ap);
1451 int hammer2_xop_ncreate(struct vop_ncreate_args *ap);
1452 int hammer2_xop_nmknod(struct vop_nmknod_args *ap);
1453 int hammer2_xop_nsymlink(struct vop_nsymlink_args *ap);
1454 int hammer2_xop_nremove(struct vop_nremove_args *ap);
1455 int hammer2_xop_nrmdir(struct vop_nrmdir_args *ap);
1456 int hammer2_xop_nrename(struct vop_nrename_args *ap);
1457 #endif
1458
1459 /*
1460  * hammer2_msgops.c
1461  */
1462 int hammer2_msg_dbg_rcvmsg(kdmsg_msg_t *msg);
1463 int hammer2_msg_adhoc_input(kdmsg_msg_t *msg);
1464
1465 /*
1466  * hammer2_vfsops.c
1467  */
1468 void hammer2_clusterctl_wakeup(kdmsg_iocom_t *iocom);
1469 void hammer2_volconf_update(hammer2_dev_t *hmp, int index);
1470 void hammer2_dump_chain(hammer2_chain_t *chain, int tab, int *countp, char pfx);
1471 int hammer2_vfs_sync(struct mount *mp, int waitflags);
1472 hammer2_pfs_t *hammer2_pfsalloc(hammer2_cluster_t *cluster,
1473                                 const hammer2_inode_data_t *ripdata,
1474                                 hammer2_tid_t modify_tid);
1475
1476 void hammer2_lwinprog_ref(hammer2_pfs_t *pmp);
1477 void hammer2_lwinprog_drop(hammer2_pfs_t *pmp);
1478 void hammer2_lwinprog_wait(hammer2_pfs_t *pmp, int pipe);
1479
1480 /*
1481  * hammer2_freemap.c
1482  */
1483 int hammer2_freemap_alloc(hammer2_chain_t *chain, size_t bytes);
1484 void hammer2_freemap_adjust(hammer2_dev_t *hmp,
1485                                 hammer2_blockref_t *bref, int how);
1486
1487 /*
1488  * hammer2_cluster.c
1489  */
1490 int hammer2_cluster_need_resize(hammer2_cluster_t *cluster, int bytes);
1491 uint8_t hammer2_cluster_type(hammer2_cluster_t *cluster);
1492 const hammer2_media_data_t *hammer2_cluster_rdata(hammer2_cluster_t *cluster);
1493 const hammer2_media_data_t *hammer2_cluster_rdata_bytes(
1494                                 hammer2_cluster_t *cluster, size_t *bytesp);
1495 hammer2_media_data_t *hammer2_cluster_wdata(hammer2_cluster_t *cluster);
1496 hammer2_cluster_t *hammer2_cluster_from_chain(hammer2_chain_t *chain);
1497 int hammer2_cluster_modified(hammer2_cluster_t *cluster);
1498 int hammer2_cluster_duplicated(hammer2_cluster_t *cluster);
1499 void hammer2_cluster_bref(hammer2_cluster_t *cluster, hammer2_blockref_t *bref);
1500 void hammer2_cluster_setflush(hammer2_cluster_t *cluster);
1501 void hammer2_cluster_setmethod_check(hammer2_cluster_t *cluster,
1502                                 int check_algo);
1503 hammer2_cluster_t *hammer2_cluster_alloc(hammer2_pfs_t *pmp,
1504                                 hammer2_blockref_t *bref);
1505 void hammer2_cluster_ref(hammer2_cluster_t *cluster);
1506 void hammer2_cluster_drop(hammer2_cluster_t *cluster);
1507 void hammer2_cluster_wait(hammer2_cluster_t *cluster);
1508 void hammer2_cluster_lock(hammer2_cluster_t *cluster, int how);
1509 void hammer2_cluster_lock_except(hammer2_cluster_t *cluster, int idx, int how);
1510 int hammer2_cluster_check(hammer2_cluster_t *cluster, hammer2_key_t lokey,
1511                         int flags);
1512 void hammer2_cluster_resolve(hammer2_cluster_t *cluster);
1513 void hammer2_cluster_forcegood(hammer2_cluster_t *cluster);
1514 hammer2_cluster_t *hammer2_cluster_copy(hammer2_cluster_t *ocluster);
1515 void hammer2_cluster_unlock(hammer2_cluster_t *cluster);
1516 void hammer2_cluster_unlock_except(hammer2_cluster_t *cluster, int idx);
1517 void hammer2_cluster_resize(hammer2_inode_t *ip,
1518                         hammer2_cluster_t *cparent, hammer2_cluster_t *cluster,
1519                         int nradix, int flags);
1520 void hammer2_cluster_modify(hammer2_cluster_t *cluster,
1521                         int flags);
1522 hammer2_inode_data_t *hammer2_cluster_modify_ip(hammer2_inode_t *ip,
1523                         hammer2_cluster_t *cluster, int flags);
1524 void hammer2_cluster_modsync(hammer2_cluster_t *cluster);
1525 hammer2_cluster_t *hammer2_cluster_lookup_init(hammer2_cluster_t *cparent,
1526                         int flags);
1527 void hammer2_cluster_lookup_done(hammer2_cluster_t *cparent);
1528 hammer2_cluster_t *hammer2_cluster_lookup(hammer2_cluster_t *cparent,
1529                         hammer2_key_t *key_nextp,
1530                         hammer2_key_t key_beg, hammer2_key_t key_end,
1531                         int flags);
1532 hammer2_cluster_t *hammer2_cluster_next(hammer2_cluster_t *cparent,
1533                         hammer2_cluster_t *cluster,
1534                         hammer2_key_t *key_nextp,
1535                         hammer2_key_t key_beg, hammer2_key_t key_end,
1536                         int flags);
1537 void hammer2_cluster_next_single_chain(hammer2_cluster_t *cparent,
1538                         hammer2_cluster_t *cluster,
1539                         hammer2_key_t *key_nextp,
1540                         hammer2_key_t key_beg,
1541                         hammer2_key_t key_end,
1542                         int i, int flags);
1543 hammer2_cluster_t *hammer2_cluster_scan(hammer2_cluster_t *cparent,
1544                         hammer2_cluster_t *cluster, int flags);
1545 int hammer2_cluster_create(hammer2_pfs_t *pmp, hammer2_cluster_t *cparent,
1546                         hammer2_cluster_t **clusterp,
1547                         hammer2_key_t key, int keybits,
1548                         int type, size_t bytes, int flags);
1549 void hammer2_cluster_rename(hammer2_blockref_t *bref,
1550                         hammer2_cluster_t *cparent, hammer2_cluster_t *cluster,
1551                         int flags);
1552 void hammer2_cluster_delete(hammer2_cluster_t *pcluster,
1553                         hammer2_cluster_t *cluster, int flags);
1554 int hammer2_cluster_snapshot(hammer2_cluster_t *ocluster,
1555                         hammer2_ioc_pfs_t *pmp);
1556 hammer2_cluster_t *hammer2_cluster_parent(hammer2_cluster_t *cluster);
1557
1558 int hammer2_bulk_scan(hammer2_chain_t *parent,
1559                         int (*func)(hammer2_chain_t *chain, void *info),
1560                         void *info);
1561 int hammer2_bulkfree_pass(hammer2_dev_t *hmp,
1562                         struct hammer2_ioc_bulkfree *bfi);
1563
1564 /*
1565  * hammer2_iocom.c
1566  */
1567 void hammer2_iocom_init(hammer2_dev_t *hmp);
1568 void hammer2_iocom_uninit(hammer2_dev_t *hmp);
1569 void hammer2_cluster_reconnect(hammer2_dev_t *hmp, struct file *fp);
1570
1571 /*
1572  * hammer2_thread.c
1573  */
1574 void hammer2_thr_create(hammer2_thread_t *thr, hammer2_pfs_t *pmp,
1575                         const char *id, int clindex, int repidx,
1576                         void (*func)(void *arg));
1577 void hammer2_thr_delete(hammer2_thread_t *thr);
1578 void hammer2_thr_remaster(hammer2_thread_t *thr);
1579 void hammer2_thr_freeze_async(hammer2_thread_t *thr);
1580 void hammer2_thr_freeze(hammer2_thread_t *thr);
1581 void hammer2_thr_unfreeze(hammer2_thread_t *thr);
1582 void hammer2_primary_sync_thread(void *arg);
1583 void hammer2_primary_xops_thread(void *arg);
1584
1585 /*
1586  * hammer2_strategy.c
1587  */
1588 int hammer2_vop_strategy(struct vop_strategy_args *ap);
1589 int hammer2_vop_bmap(struct vop_bmap_args *ap);
1590 void hammer2_write_thread(void *arg);
1591 void hammer2_bioq_sync(hammer2_pfs_t *pmp);
1592
1593 #endif /* !_KERNEL */
1594 #endif /* !_VFS_HAMMER2_HAMMER2_H_ */