xref: /dragonfly/sys/vfs/hammer2/hammer2.h (revision 2b7dbe20)
1 /*
2  * Copyright (c) 2011-2018 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 #ifdef _KERNEL
66 #include <sys/param.h>
67 #endif
68 #include <sys/types.h>
69 #ifdef _KERNEL
70 #include <sys/kernel.h>
71 #endif
72 #include <sys/conf.h>
73 #ifdef _KERNEL
74 #include <sys/systm.h>
75 #endif
76 #include <sys/diskslice.h>
77 #include <sys/tree.h>
78 #include <sys/malloc.h>
79 #include <sys/mount.h>
80 #include <sys/vnode.h>
81 #include <sys/proc.h>
82 #include <sys/mountctl.h>
83 #include <sys/priv.h>
84 #include <sys/stat.h>
85 #include <sys/thread.h>
86 #include <sys/globaldata.h>
87 #include <sys/lockf.h>
88 #include <sys/buf.h>
89 #include <sys/queue.h>
90 #include <sys/limits.h>
91 #include <sys/dmsg.h>
92 #include <sys/mutex.h>
93 #ifdef _KERNEL
94 #include <sys/kern_syscall.h>
95 #endif
96 
97 #ifdef _KERNEL
98 #include <sys/signal2.h>
99 #include <sys/buf2.h>
100 #include <sys/mutex2.h>
101 #include <sys/spinlock2.h>
102 #endif
103 
104 #include "hammer2_xxhash.h"
105 #include "hammer2_disk.h"
106 #include "hammer2_mount.h"
107 #include "hammer2_ioctl.h"
108 
109 struct hammer2_io;
110 struct hammer2_chain;
111 struct hammer2_cluster;
112 struct hammer2_inode;
113 struct hammer2_depend;
114 struct hammer2_dev;
115 struct hammer2_pfs;
116 struct hammer2_span;
117 struct hammer2_msg;
118 struct hammer2_thread;
119 union hammer2_xop;
120 
121 /*
122  * Mutex and lock shims.  Hammer2 requires support for asynchronous and
123  * abortable locks, and both exclusive and shared spinlocks.  Normal
124  * synchronous non-abortable locks can be substituted for spinlocks.
125  */
126 typedef mtx_t				hammer2_mtx_t;
127 typedef mtx_link_t			hammer2_mtx_link_t;
128 typedef mtx_state_t			hammer2_mtx_state_t;
129 
130 typedef struct spinlock			hammer2_spin_t;
131 
132 #define hammer2_mtx_ex			mtx_lock_ex_quick
133 #define hammer2_mtx_ex_try		mtx_lock_ex_try
134 #define hammer2_mtx_sh			mtx_lock_sh_quick
135 #define hammer2_mtx_sh_again		mtx_lock_sh_again
136 #define hammer2_mtx_sh_try		mtx_lock_sh_try
137 #define hammer2_mtx_unlock		mtx_unlock
138 #define hammer2_mtx_downgrade		mtx_downgrade
139 #define hammer2_mtx_owned		mtx_owned
140 #define hammer2_mtx_init		mtx_init
141 #define hammer2_mtx_temp_release	mtx_lock_temp_release
142 #define hammer2_mtx_temp_restore	mtx_lock_temp_restore
143 #define hammer2_mtx_refs		mtx_lockrefs
144 
145 #define hammer2_spin_init		spin_init
146 #define hammer2_spin_sh			spin_lock_shared
147 #define hammer2_spin_ex			spin_lock
148 #define hammer2_spin_unsh		spin_unlock_shared
149 #define hammer2_spin_unex		spin_unlock
150 
151 TAILQ_HEAD(hammer2_xop_list, hammer2_xop_head);
152 TAILQ_HEAD(hammer2_chain_list, hammer2_chain);
153 
154 typedef struct hammer2_xop_list	hammer2_xop_list_t;
155 
156 #ifdef _KERNEL
157 /*
158  * General lock support
159  */
160 static __inline
161 int
162 hammer2_mtx_upgrade_try(hammer2_mtx_t *mtx)
163 {
164 	return mtx_upgrade_try(mtx);
165 }
166 
167 #endif
168 
169 /*
170  * The xid tracks internal transactional updates.
171  *
172  * XXX fix-me, really needs to be 64-bits
173  */
174 typedef uint32_t hammer2_xid_t;
175 
176 #define HAMMER2_XID_MIN			0x00000000U
177 #define HAMMER2_XID_MAX			0x7FFFFFFFU
178 
179 /*
180  * Cap the dynamic calculation for the maximum number of dirty
181  * chains and dirty inodes allowed.
182  */
183 #define HAMMER2_LIMIT_DIRTY_CHAINS	(1024*1024)
184 #define HAMMER2_LIMIT_DIRTY_INODES	(65536)
185 
186 /*
187  * The chain structure tracks a portion of the media topology from the
188  * root (volume) down.  Chains represent volumes, inodes, indirect blocks,
189  * data blocks, and freemap nodes and leafs.
190  *
191  * The chain structure utilizes a simple singly-homed topology and the
192  * chain's in-memory topology will move around as the chains do, due mainly
193  * to renames and indirect block creation.
194  *
195  * Block Table Updates
196  *
197  *	Block table updates for insertions and updates are delayed until the
198  *	flush.  This allows us to avoid having to modify the parent chain
199  *	all the way to the root.
200  *
201  *	Block table deletions are performed immediately (modifying the parent
202  *	in the process) because the flush code uses the chain structure to
203  *	track delayed updates and the chain will be (likely) gone or moved to
204  *	another location in the topology after a deletion.
205  *
206  *	A prior iteration of the code tried to keep the relationship intact
207  *	on deletes by doing a delete-duplicate operation on the chain, but
208  *	it added way too much complexity to the codebase.
209  *
210  * Flush Synchronization
211  *
212  *	The flush code must flush modified chains bottom-up.  Because chain
213  *	structures can shift around and are NOT topologically stable,
214  *	modified chains are independently indexed for the flush.  As the flush
215  *	runs it modifies (or further modifies) and updates the parents,
216  *	propagating the flush all the way to the volume root.
217  *
218  *	Modifying front-end operations can occur during a flush but will block
219  *	in two cases: (1) when the front-end tries to operate on the inode
220  *	currently in the midst of being flushed and (2) if the front-end
221  *	crosses an inode currently being flushed (such as during a rename).
222  *	So, for example, if you rename directory "x" to "a/b/c/d/e/f/g/x" and
223  *	the flusher is currently working on "a/b/c", the rename will block
224  *	temporarily in order to ensure that "x" exists in one place or the
225  *	other.
226  *
227  *	Meta-data statistics are updated by the flusher.  The front-end will
228  *	make estimates but meta-data must be fully synchronized only during a
229  *	flush in order to ensure that it remains correct across a crash.
230  *
231  *	Multiple flush synchronizations can theoretically be in-flight at the
232  *	same time but the implementation is not coded to handle the case and
233  *	currently serializes them.
234  *
235  * Snapshots:
236  *
237  *	Snapshots currently require the subdirectory tree being snapshotted
238  *	to be flushed.  The snapshot then creates a new super-root inode which
239  *	copies the flushed blockdata of the directory or file that was
240  *	snapshotted.
241  *
242  * Radix tree NOTES:
243  *
244  *	- Note that the radix tree runs in powers of 2 only so sub-trees
245  *	  cannot straddle edges.
246  */
247 RB_HEAD(hammer2_chain_tree, hammer2_chain);
248 
249 struct hammer2_reptrack {
250 	hammer2_spin_t	spin;
251 	struct hammer2_reptrack *next;
252 	struct hammer2_chain	*chain;
253 };
254 
255 /*
256  * Core topology for chain (embedded in chain).  Protected by a spinlock.
257  */
258 struct hammer2_chain_core {
259 	hammer2_spin_t	spin;
260 	struct hammer2_reptrack *reptrack;
261 	struct hammer2_chain_tree rbtree; /* sub-chains */
262 	int		live_zero;	/* blockref array opt */
263 	u_int		live_count;	/* live (not deleted) chains in tree */
264 	u_int		chain_count;	/* live + deleted chains under core */
265 	int		generation;	/* generation number (inserts only) */
266 };
267 
268 typedef struct hammer2_chain_core hammer2_chain_core_t;
269 
270 RB_HEAD(hammer2_io_tree, hammer2_io);
271 
272 /*
273  * DIO - Management structure wrapping system buffer cache.
274  *
275  * HAMMER2 uses an I/O abstraction that allows it to cache and manipulate
276  * fixed-sized filesystem buffers frontend by variable-sized hammer2_chain
277  * structures.
278  */
279 /* #define HAMMER2_IO_DEBUG */
280 
281 #ifdef HAMMER2_IO_DEBUG
282 #define HAMMER2_IO_DEBUG_ARGS	, const char *file, int line
283 #define HAMMER2_IO_DEBUG_CALL	, file, line
284 #define HAMMER2_IO_DEBUG_COUNT	2048
285 #define HAMMER2_IO_DEBUG_MASK	(HAMMER2_IO_DEBUG_COUNT - 1)
286 #else
287 #define HAMMER2_IO_DEBUG_ARGS
288 #define HAMMER2_IO_DEBUG_CALL
289 #endif
290 
291 struct hammer2_io {
292 	RB_ENTRY(hammer2_io) rbnode;	/* indexed by device offset */
293 	struct hammer2_dev *hmp;
294 	struct buf	*bp;
295 	off_t		pbase;
296 	uint64_t	refs;
297 	int		psize;
298 	int		act;		/* activity */
299 	int		btype;		/* approximate BREF_TYPE_* */
300 	int		ticks;
301 	int		error;
302 #ifdef HAMMER2_IO_DEBUG
303 	int		debug_index;
304 #else
305 	int		unused01;
306 #endif
307 	uint64_t	dedup_valid;	/* valid for dedup operation */
308 	uint64_t	dedup_alloc;	/* allocated / de-dupable */
309 #ifdef HAMMER2_IO_DEBUG
310 	const char	*debug_file[HAMMER2_IO_DEBUG_COUNT];
311 	void		*debug_td[HAMMER2_IO_DEBUG_COUNT];
312 	int		debug_line[HAMMER2_IO_DEBUG_COUNT];
313 	uint64_t	debug_refs[HAMMER2_IO_DEBUG_COUNT];
314 #endif
315 };
316 
317 typedef struct hammer2_io hammer2_io_t;
318 
319 #define HAMMER2_DIO_INPROG	0x8000000000000000LLU	/* bio in progress */
320 #define HAMMER2_DIO_GOOD	0x4000000000000000LLU	/* dio->bp is stable */
321 #define HAMMER2_DIO_WAITING	0x2000000000000000LLU	/* wait on INPROG */
322 #define HAMMER2_DIO_DIRTY	0x1000000000000000LLU	/* flush last drop */
323 #define HAMMER2_DIO_FLUSH	0x0800000000000000LLU	/* immediate flush */
324 
325 #define HAMMER2_DIO_MASK	0x00FFFFFFFFFFFFFFLLU
326 
327 /*
328  * Primary chain structure keeps track of the topology in-memory.
329  */
330 struct hammer2_chain {
331 	hammer2_mtx_t		lock;
332 	hammer2_chain_core_t	core;
333 	RB_ENTRY(hammer2_chain) rbnode;		/* live chain(s) */
334 	hammer2_blockref_t	bref;
335 	struct hammer2_chain	*parent;
336 	struct hammer2_dev	*hmp;
337 	struct hammer2_pfs	*pmp;		/* A PFS or super-root (spmp) */
338 
339 	struct lock	diolk;			/* xop focus interlock */
340 	hammer2_io_t	*dio;			/* physical data buffer */
341 	hammer2_media_data_t *data;		/* data pointer shortcut */
342 	u_int		bytes;			/* physical data size */
343 	u_int		flags;
344 	u_int		refs;
345 	u_int		lockcnt;
346 	int		error;			/* on-lock data error state */
347 	int		cache_index;		/* heur speeds up lookup */
348 
349 	TAILQ_ENTRY(hammer2_chain) lru_node;	/* 0-refs LRU */
350 };
351 
352 typedef struct hammer2_chain hammer2_chain_t;
353 
354 int hammer2_chain_cmp(hammer2_chain_t *chain1, hammer2_chain_t *chain2);
355 RB_PROTOTYPE(hammer2_chain_tree, hammer2_chain, rbnode, hammer2_chain_cmp);
356 
357 /*
358  * Special notes on flags:
359  *
360  * INITIAL	- This flag allows a chain to be created and for storage to
361  *		  be allocated without having to immediately instantiate the
362  *		  related buffer.  The data is assumed to be all-zeros.  It
363  *		  is primarily used for indirect blocks.
364  *
365  * MODIFIED	- The chain's media data has been modified.  Prevents chain
366  *		  free on lastdrop if still in the topology.
367  *
368  * UPDATE	- Chain might not be modified but parent blocktable needs
369  *		  an update.  Prevents chain free on lastdrop if still in
370  *		  the topology.
371  *
372  * BMAPPED	- Indicates that the chain is present in the parent blockmap.
373  *
374  * BMAPUPD	- Indicates that the chain is present but needs to be updated
375  *		  in the parent blockmap.
376  */
377 #define HAMMER2_CHAIN_MODIFIED		0x00000001	/* dirty chain data */
378 #define HAMMER2_CHAIN_ALLOCATED		0x00000002	/* kmalloc'd chain */
379 #define HAMMER2_CHAIN_DESTROY		0x00000004
380 #define HAMMER2_CHAIN_DEDUPABLE		0x00000008	/* registered w/dedup */
381 #define HAMMER2_CHAIN_DELETED		0x00000010	/* deleted chain */
382 #define HAMMER2_CHAIN_INITIAL		0x00000020	/* initial create */
383 #define HAMMER2_CHAIN_UPDATE		0x00000040	/* need parent update */
384 #define HAMMER2_CHAIN_NOTTESTED		0x00000080	/* crc not generated */
385 #define HAMMER2_CHAIN_TESTEDGOOD	0x00000100	/* crc tested good */
386 #define HAMMER2_CHAIN_ONFLUSH		0x00000200	/* on a flush list */
387 #define HAMMER2_CHAIN_UNUSED0400	0x00000400
388 #define HAMMER2_CHAIN_VOLUMESYNC	0x00000800	/* needs volume sync */
389 #define HAMMER2_CHAIN_UNUSED1000	0x00001000
390 #define HAMMER2_CHAIN_COUNTEDBREFS	0x00002000	/* block table stats */
391 #define HAMMER2_CHAIN_ONRBTREE		0x00004000	/* on parent RB tree */
392 #define HAMMER2_CHAIN_ONLRU		0x00008000	/* on LRU list */
393 #define HAMMER2_CHAIN_UNUSED10000	0x00010000
394 #define HAMMER2_CHAIN_RELEASE		0x00020000	/* don't keep around */
395 #define HAMMER2_CHAIN_BMAPPED		0x00040000	/* present in blkmap */
396 #define HAMMER2_CHAIN_BMAPUPD		0x00080000	/* +needs updating */
397 #define HAMMER2_CHAIN_IOINPROG		0x00100000	/* I/O interlock */
398 #define HAMMER2_CHAIN_IOSIGNAL		0x00200000	/* I/O interlock */
399 #define HAMMER2_CHAIN_PFSBOUNDARY	0x00400000	/* super->pfs inode */
400 #define HAMMER2_CHAIN_HINT_LEAF_COUNT	0x00800000	/* redo leaf count */
401 #define HAMMER2_CHAIN_LRUHINT		0x01000000	/* was reused */
402 
403 #define HAMMER2_CHAIN_FLUSH_MASK	(HAMMER2_CHAIN_MODIFIED |	\
404 					 HAMMER2_CHAIN_UPDATE |		\
405 					 HAMMER2_CHAIN_ONFLUSH |	\
406 					 HAMMER2_CHAIN_DESTROY)
407 
408 /*
409  * Hammer2 error codes, used by chain->error and cluster->error.  The error
410  * code is typically set on-lock unless no I/O was requested, and set on
411  * I/O otherwise.  If set for a cluster it generally means that the cluster
412  * code could not find a valid copy to present.
413  *
414  * All H2 error codes are flags and can be accumulated by ORing them
415  * together.
416  *
417  * IO		- An I/O error occurred
418  * CHECK	- I/O succeeded but did not match the check code
419  * INCOMPLETE	- A cluster is not complete enough to use, or
420  *		  a chain cannot be loaded because its parent has an error.
421  *
422  * NOTE: API allows callers to check zero/non-zero to determine if an error
423  *	 condition exists.
424  *
425  * NOTE: Chain's data field is usually NULL on an IO error but not necessarily
426  *	 NULL on other errors.  Check chain->error, not chain->data.
427  */
428 #define HAMMER2_ERROR_NONE		0	/* no error (must be 0) */
429 #define HAMMER2_ERROR_EIO		0x00000001	/* device I/O error */
430 #define HAMMER2_ERROR_CHECK		0x00000002	/* check code error */
431 #define HAMMER2_ERROR_INCOMPLETE	0x00000004	/* incomplete cluster */
432 #define HAMMER2_ERROR_DEPTH		0x00000008	/* tmp depth limit */
433 #define HAMMER2_ERROR_BADBREF		0x00000010	/* illegal bref */
434 #define HAMMER2_ERROR_ENOSPC		0x00000020	/* allocation failure */
435 #define HAMMER2_ERROR_ENOENT		0x00000040	/* entry not found */
436 #define HAMMER2_ERROR_ENOTEMPTY		0x00000080	/* dir not empty */
437 #define HAMMER2_ERROR_EAGAIN		0x00000100	/* retry */
438 #define HAMMER2_ERROR_ENOTDIR		0x00000200	/* not directory */
439 #define HAMMER2_ERROR_EISDIR		0x00000400	/* is directory */
440 #define HAMMER2_ERROR_EINPROGRESS	0x00000800	/* already running */
441 #define HAMMER2_ERROR_ABORTED		0x00001000	/* aborted operation */
442 #define HAMMER2_ERROR_EOF		0x00002000	/* end of scan */
443 #define HAMMER2_ERROR_EINVAL		0x00004000	/* catch-all */
444 #define HAMMER2_ERROR_EEXIST		0x00008000	/* entry exists */
445 #define HAMMER2_ERROR_EDEADLK		0x00010000
446 #define HAMMER2_ERROR_ESRCH		0x00020000
447 #define HAMMER2_ERROR_ETIMEDOUT		0x00040000
448 
449 /*
450  * Flags passed to hammer2_chain_lookup() and hammer2_chain_next()
451  *
452  * NOTES:
453  *	NODATA	    - Asks that the chain->data not be resolved in order
454  *		      to avoid I/O.
455  *
456  *	NODIRECT    - Prevents a lookup of offset 0 in an inode from returning
457  *		      the inode itself if the inode is in DIRECTDATA mode
458  *		      (i.e. file is <= 512 bytes).  Used by the synchronization
459  *		      code to prevent confusion.
460  *
461  *	SHARED	    - The input chain is expected to be locked shared,
462  *		      and the output chain is locked shared.
463  *
464  *	MATCHIND    - Allows an indirect block / freemap node to be returned
465  *		      when the passed key range matches the radix.  Remember
466  *		      that key_end is inclusive (e.g. {0x000,0xFFF},
467  *		      not {0x000,0x1000}).
468  *
469  *		      (Cannot be used for remote or cluster ops).
470  *
471  *	ALWAYS	    - Always resolve the data.  If ALWAYS and NODATA are both
472  *		      missing, bulk file data is not resolved but inodes and
473  *		      other meta-data will.
474  */
475 #define HAMMER2_LOOKUP_UNUSED0001	0x00000001
476 #define HAMMER2_LOOKUP_NODATA		0x00000002	/* data left NULL */
477 #define HAMMER2_LOOKUP_NODIRECT		0x00000004	/* no offset=0 DD */
478 #define HAMMER2_LOOKUP_SHARED		0x00000100
479 #define HAMMER2_LOOKUP_MATCHIND		0x00000200	/* return all chains */
480 #define HAMMER2_LOOKUP_UNUSED0400	0x00000400
481 #define HAMMER2_LOOKUP_ALWAYS		0x00000800	/* resolve data */
482 #define HAMMER2_LOOKUP_UNUSED1000	0x00001000
483 
484 /*
485  * Flags passed to hammer2_chain_modify() and hammer2_chain_resize()
486  *
487  * NOTE: OPTDATA allows us to avoid instantiating buffers for INDIRECT
488  *	 blocks in the INITIAL-create state.
489  */
490 #define HAMMER2_MODIFY_OPTDATA		0x00000002	/* data can be NULL */
491 
492 /*
493  * Flags passed to hammer2_chain_lock()
494  *
495  * NOTE: RDONLY is set to optimize cluster operations when *no* modifications
496  *	 will be made to either the cluster being locked or any underlying
497  *	 cluster.  It allows the cluster to lock and access data for a subset
498  *	 of available nodes instead of all available nodes.
499  *
500  * NOTE: NONBLOCK is only used for hammer2_chain_repparent() and getparent(),
501  *	 other functions (e.g. hammer2_chain_lookup(), etc) can't handle its
502  *	 operation.
503  */
504 #define HAMMER2_RESOLVE_NEVER		1
505 #define HAMMER2_RESOLVE_MAYBE		2
506 #define HAMMER2_RESOLVE_ALWAYS		3
507 #define HAMMER2_RESOLVE_MASK		0x0F
508 
509 #define HAMMER2_RESOLVE_SHARED		0x10	/* request shared lock */
510 #define HAMMER2_RESOLVE_LOCKAGAIN	0x20	/* another shared lock */
511 #define HAMMER2_RESOLVE_UNUSED40	0x40
512 #define HAMMER2_RESOLVE_NONBLOCK	0x80	/* non-blocking */
513 
514 /*
515  * Flags passed to hammer2_chain_delete()
516  */
517 #define HAMMER2_DELETE_PERMANENT	0x0001
518 
519 /*
520  * Flags passed to hammer2_chain_insert() or hammer2_chain_rename()
521  * or hammer2_chain_create().
522  */
523 #define HAMMER2_INSERT_PFSROOT		0x0004
524 #define HAMMER2_INSERT_SAMEPARENT	0x0008
525 
526 /*
527  * hammer2_freemap_adjust()
528  */
529 #define HAMMER2_FREEMAP_DORECOVER	1
530 #define HAMMER2_FREEMAP_DOMAYFREE	2
531 #define HAMMER2_FREEMAP_DOREALFREE	3
532 
533 /*
534  * HAMMER2 cluster - A set of chains representing the same entity.
535  *
536  * hammer2_cluster typically represents a temporary set of representitive
537  * chains.  The one exception is that a hammer2_cluster is embedded in
538  * hammer2_inode.  This embedded cluster is ONLY used to track the
539  * representitive chains and cannot be directly locked.
540  *
541  * A cluster is usually temporary (and thus per-thread) for locking purposes,
542  * allowing us to embed the asynchronous storage required for cluster
543  * operations in the cluster itself and adjust the state and status without
544  * having to worry too much about SMP issues.
545  *
546  * The exception is the cluster embedded in the hammer2_inode structure.
547  * This is used to cache the cluster state on an inode-by-inode basis.
548  * Individual hammer2_chain structures not incorporated into clusters might
549  * also stick around to cache miscellanious elements.
550  *
551  * Because the cluster is a 'working copy' and is usually subject to cluster
552  * quorum rules, it is quite possible for us to end up with an insufficient
553  * number of live chains to execute an operation.  If an insufficient number
554  * of chains remain in a working copy, the operation may have to be
555  * downgraded, retried, stall until the requisit number of chains are
556  * available, or possibly even error out depending on the mount type.
557  *
558  * A cluster's focus is set when it is locked.  The focus can only be set
559  * to a chain still part of the synchronized set.
560  */
561 #define HAMMER2_XOPFIFO		16
562 #define HAMMER2_XOPFIFO_MASK	(HAMMER2_XOPFIFO - 1)
563 #define HAMMER2_XOPGROUPS_MIN	32
564 
565 #define HAMMER2_MAXCLUSTER	8
566 #define HAMMER2_XOPMASK_CLUSTER	((uint64_t)((1LLU << HAMMER2_MAXCLUSTER) - 1))
567 #define HAMMER2_XOPMASK_VOP	((uint64_t)0x0000000080000000LLU)
568 #define HAMMER2_XOPMASK_FIFOW	((uint64_t)0x0000000040000000LLU)
569 #define HAMMER2_XOPMASK_WAIT	((uint64_t)0x0000000020000000LLU)
570 #define HAMMER2_XOPMASK_FEED	((uint64_t)0x0000000100000000LLU)
571 
572 #define HAMMER2_XOPMASK_ALLDONE	(HAMMER2_XOPMASK_VOP | HAMMER2_XOPMASK_CLUSTER)
573 
574 struct hammer2_cluster_item {
575 	hammer2_chain_t		*chain;
576 	int			error;
577 	uint32_t		flags;
578 };
579 
580 typedef struct hammer2_cluster_item hammer2_cluster_item_t;
581 
582 /*
583  * INVALID	- Invalid for focus, i.e. not part of synchronized set.
584  *		  Once set, this bit is sticky across operations.
585  *
586  * FEMOD	- Indicates that front-end modifying operations can
587  *		  mess with this entry and MODSYNC will copy also
588  *		  effect it.
589  */
590 #define HAMMER2_CITEM_INVALID	0x00000001
591 #define HAMMER2_CITEM_FEMOD	0x00000002
592 #define HAMMER2_CITEM_NULL	0x00000004
593 
594 struct hammer2_cluster {
595 	int			refs;		/* track for deallocation */
596 	int			ddflag;
597 	struct hammer2_pfs	*pmp;
598 	uint32_t		flags;
599 	int			nchains;
600 	int			error;		/* error code valid on lock */
601 	int			focus_index;
602 	hammer2_chain_t		*focus;		/* current focus (or mod) */
603 	hammer2_cluster_item_t	array[HAMMER2_MAXCLUSTER];
604 };
605 
606 typedef struct hammer2_cluster	hammer2_cluster_t;
607 
608 /*
609  * WRHARD	- Hard mounts can write fully synchronized
610  * RDHARD	- Hard mounts can read fully synchronized
611  * UNHARD	- Unsynchronized masters present
612  * NOHARD	- No masters visible
613  * WRSOFT	- Soft mounts can write to at least the SOFT_MASTER
614  * RDSOFT	- Soft mounts can read from at least a SOFT_SLAVE
615  * UNSOFT	- Unsynchronized slaves present
616  * NOSOFT	- No slaves visible
617  * RDSLAVE	- slaves are accessible (possibly unsynchronized or remote).
618  * MSYNCED	- All masters are fully synchronized
619  * SSYNCED	- All known local slaves are fully synchronized to masters
620  *
621  * All available masters are always incorporated.  All PFSs belonging to a
622  * cluster (master, slave, copy, whatever) always try to synchronize the
623  * total number of known masters in the PFSs root inode.
624  *
625  * A cluster might have access to many slaves, copies, or caches, but we
626  * have a limited number of cluster slots.  Any such elements which are
627  * directly mounted from block device(s) will always be incorporated.   Note
628  * that SSYNCED only applies to such elements which are directly mounted,
629  * not to any remote slaves, copies, or caches that could be available.  These
630  * bits are used to monitor and drive our synchronization threads.
631  *
632  * When asking the question 'is any data accessible at all', then a simple
633  * test against (RDHARD|RDSOFT|RDSLAVE) gives you the answer.  If any of
634  * these bits are set the object can be read with certain caveats:
635  * RDHARD - no caveats.  RDSOFT - authoritative but might not be synchronized.
636  * and RDSLAVE - not authoritative, has some data but it could be old or
637  * incomplete.
638  *
639  * When both soft and hard mounts are available, data will be read and written
640  * via the soft mount only.  But all might be in the cluster because
641  * background synchronization threads still need to do their work.
642  */
643 #define HAMMER2_CLUSTER_INODE	0x00000001	/* embedded in inode struct */
644 #define HAMMER2_CLUSTER_UNUSED2	0x00000002
645 #define HAMMER2_CLUSTER_LOCKED	0x00000004	/* cluster lks not recursive */
646 #define HAMMER2_CLUSTER_WRHARD	0x00000100	/* hard-mount can write */
647 #define HAMMER2_CLUSTER_RDHARD	0x00000200	/* hard-mount can read */
648 #define HAMMER2_CLUSTER_UNHARD	0x00000400	/* unsynchronized masters */
649 #define HAMMER2_CLUSTER_NOHARD	0x00000800	/* no masters visible */
650 #define HAMMER2_CLUSTER_WRSOFT	0x00001000	/* soft-mount can write */
651 #define HAMMER2_CLUSTER_RDSOFT	0x00002000	/* soft-mount can read */
652 #define HAMMER2_CLUSTER_UNSOFT	0x00004000	/* unsynchronized slaves */
653 #define HAMMER2_CLUSTER_NOSOFT	0x00008000	/* no slaves visible */
654 #define HAMMER2_CLUSTER_MSYNCED	0x00010000	/* all masters synchronized */
655 #define HAMMER2_CLUSTER_SSYNCED	0x00020000	/* known slaves synchronized */
656 
657 #define HAMMER2_CLUSTER_ANYDATA	( HAMMER2_CLUSTER_RDHARD |	\
658 				  HAMMER2_CLUSTER_RDSOFT |	\
659 				  HAMMER2_CLUSTER_RDSLAVE)
660 
661 #define HAMMER2_CLUSTER_RDOK	( HAMMER2_CLUSTER_RDHARD |	\
662 				  HAMMER2_CLUSTER_RDSOFT)
663 
664 #define HAMMER2_CLUSTER_WROK	( HAMMER2_CLUSTER_WRHARD |	\
665 				  HAMMER2_CLUSTER_WRSOFT)
666 
667 #define HAMMER2_CLUSTER_ZFLAGS	( HAMMER2_CLUSTER_WRHARD |	\
668 				  HAMMER2_CLUSTER_RDHARD |	\
669 				  HAMMER2_CLUSTER_WRSOFT |	\
670 				  HAMMER2_CLUSTER_RDSOFT |	\
671 				  HAMMER2_CLUSTER_MSYNCED |	\
672 				  HAMMER2_CLUSTER_SSYNCED)
673 
674 /*
675  * Helper functions (cluster must be locked for flags to be valid).
676  */
677 static __inline
678 int
679 hammer2_cluster_rdok(hammer2_cluster_t *cluster)
680 {
681 	return (cluster->flags & HAMMER2_CLUSTER_RDOK);
682 }
683 
684 static __inline
685 int
686 hammer2_cluster_wrok(hammer2_cluster_t *cluster)
687 {
688 	return (cluster->flags & HAMMER2_CLUSTER_WROK);
689 }
690 
691 RB_HEAD(hammer2_inode_tree, hammer2_inode);	/* ip->rbnode */
692 TAILQ_HEAD(inoq_head, hammer2_inode);		/* ip->entry */
693 TAILQ_HEAD(depq_head, hammer2_depend);		/* depend->entry */
694 
695 struct hammer2_depend {
696 	TAILQ_ENTRY(hammer2_depend) entry;
697 	struct inoq_head	sideq;
698 	long			count;
699 	int			pass2;
700 	int			unused01;
701 };
702 
703 typedef struct hammer2_depend hammer2_depend_t;
704 
705 /*
706  * A hammer2 inode.
707  *
708  * NOTE: The inode-embedded cluster is never used directly for I/O (since
709  *	 it may be shared).  Instead it will be replicated-in and synchronized
710  *	 back out if changed.
711  */
712 struct hammer2_inode {
713 	RB_ENTRY(hammer2_inode) rbnode;		/* inumber lookup (HL) */
714 	TAILQ_ENTRY(hammer2_inode) entry;	/* SYNCQ/SIDEQ */
715 	hammer2_depend_t	*depend;	/* non-NULL if SIDEQ */
716 	hammer2_depend_t	depend_static;	/* (in-place allocation) */
717 	hammer2_mtx_t		lock;		/* inode lock */
718 	hammer2_mtx_t		truncate_lock;	/* prevent truncates */
719 	struct hammer2_pfs	*pmp;		/* PFS mount */
720 	struct vnode		*vp;
721 	hammer2_spin_t		cluster_spin;	/* update cluster */
722 	hammer2_cluster_t	cluster;
723 	struct lockf		advlock;
724 	u_int			flags;
725 	u_int			refs;		/* +vpref, +flushref */
726 	uint8_t			comp_heuristic;
727 	hammer2_inode_meta_t	meta;		/* copy of meta-data */
728 	hammer2_off_t		osize;
729 };
730 
731 typedef struct hammer2_inode hammer2_inode_t;
732 
733 /*
734  * MODIFIED	- Inode is in a modified state, ip->meta may have changes.
735  * RESIZED	- Inode truncated (any) or inode extended beyond
736  *		  EMBEDDED_BYTES.
737  *
738  * SYNCQ	- Inode is included in the current filesystem sync.  The
739  *		  DELETING and CREATING flags will be acted upon.
740  *
741  * SIDEQ	- Inode has likely been disconnected from the vnode topology
742  *		  and so is not visible to the vnode-based filesystem syncer
743  *		  code, but is dirty and must be included in the next
744  *		  filesystem sync.  These inodes are moved to the SYNCQ at
745  *		  the time the sync occurs.
746  *
747  *		  Inodes are not placed on this queue simply because they have
748  *		  become dirty, if a vnode is attached.
749  *
750  * DELETING	- Inode is flagged for deletion during the next filesystem
751  *		  sync.  That is, the inode's chain is currently connected
752  *		  and must be deleting during the current or next fs sync.
753  *
754  * CREATING	- Inode is flagged for creation during the next filesystem
755  *		  sync.  That is, the inode's chain topology exists (so
756  *		  kernel buffer flushes can occur), but is currently
757  *		  disconnected and must be inserted during the current or
758  *		  next fs sync.  If the DELETING flag is also set, the
759  *		  topology can be thrown away instead.
760  *
761  * If an inode that is already part of the current filesystem sync is
762  * modified by the frontend, including by buffer flushes, the inode lock
763  * code detects the SYNCQ flag and moves the inode to the head of the
764  * flush-in-progress, then blocks until the flush has gotten past it.
765  */
766 #define HAMMER2_INODE_MODIFIED		0x0001
767 #define HAMMER2_INODE_SROOT		0x0002
768 #define HAMMER2_INODE_UNUSED0004	0x0004
769 #define HAMMER2_INODE_ONRBTREE		0x0008
770 #define HAMMER2_INODE_RESIZED		0x0010	/* requires inode_chain_sync */
771 #define HAMMER2_INODE_UNUSED0020	0x0020
772 #define HAMMER2_INODE_ISUNLINKED	0x0040
773 #define HAMMER2_INODE_METAGOOD		0x0080	/* inode meta-data good */
774 #define HAMMER2_INODE_SIDEQ		0x0100	/* on side processing queue */
775 #define HAMMER2_INODE_NOSIDEQ		0x0200	/* disable sideq operation */
776 #define HAMMER2_INODE_DIRTYDATA		0x0400	/* interlocks inode flush */
777 #define HAMMER2_INODE_SYNCQ		0x0800	/* sync interlock, sequenced */
778 #define HAMMER2_INODE_DELETING		0x1000	/* sync interlock, chain topo */
779 #define HAMMER2_INODE_CREATING		0x2000	/* sync interlock, chain topo */
780 #define HAMMER2_INODE_SYNCQ_WAKEUP	0x4000	/* sync interlock wakeup */
781 #define HAMMER2_INODE_SYNCQ_PASS2	0x8000	/* force retry delay */
782 
783 #define HAMMER2_INODE_DIRTY		(HAMMER2_INODE_MODIFIED |	\
784 					 HAMMER2_INODE_DIRTYDATA |	\
785 					 HAMMER2_INODE_DELETING |	\
786 					 HAMMER2_INODE_CREATING)
787 
788 int hammer2_inode_cmp(hammer2_inode_t *ip1, hammer2_inode_t *ip2);
789 RB_PROTOTYPE2(hammer2_inode_tree, hammer2_inode, rbnode, hammer2_inode_cmp,
790 		hammer2_tid_t);
791 
792 /*
793  * Transaction management sub-structure under hammer2_pfs
794  */
795 struct hammer2_trans {
796 	uint32_t		flags;
797 	uint32_t		sync_wait;
798 };
799 
800 typedef struct hammer2_trans hammer2_trans_t;
801 
802 #define HAMMER2_TRANS_ISFLUSH		0x80000000	/* flush code */
803 #define HAMMER2_TRANS_BUFCACHE		0x40000000	/* bio strategy */
804 #define HAMMER2_TRANS_SIDEQ		0x20000000	/* run sideq */
805 #define HAMMER2_TRANS_UNUSED10		0x10000000
806 #define HAMMER2_TRANS_WAITING		0x08000000	/* someone waiting */
807 #define HAMMER2_TRANS_RESCAN		0x04000000	/* rescan sideq */
808 #define HAMMER2_TRANS_MASK		0x00FFFFFF	/* count mask */
809 
810 #define HAMMER2_FREEMAP_HEUR_NRADIX	4	/* pwr 2 PBUFRADIX-LBUFRADIX */
811 #define HAMMER2_FREEMAP_HEUR_TYPES	8
812 #define HAMMER2_FREEMAP_HEUR_SIZE	(HAMMER2_FREEMAP_HEUR_NRADIX * \
813 					 HAMMER2_FREEMAP_HEUR_TYPES)
814 
815 #define HAMMER2_DEDUP_HEUR_SIZE		(65536 * 4)
816 #define HAMMER2_DEDUP_HEUR_MASK		(HAMMER2_DEDUP_HEUR_SIZE - 1)
817 
818 #define HAMMER2_FLUSH_TOP		0x0001
819 #define HAMMER2_FLUSH_ALL		0x0002
820 #define HAMMER2_FLUSH_INODE_STOP	0x0004	/* stop at sub-inode */
821 #define HAMMER2_FLUSH_FSSYNC		0x0008	/* part of filesystem sync */
822 
823 
824 /*
825  * Hammer2 support thread element.
826  *
827  * Potentially many support threads can hang off of hammer2, primarily
828  * off the hammer2_pfs structure.  Typically:
829  *
830  * td x Nodes		 	A synchronization thread for each node.
831  * td x Nodes x workers		Worker threads for frontend operations.
832  * td x 1			Bioq thread for logical buffer writes.
833  *
834  * In addition, the synchronization thread(s) associated with the
835  * super-root PFS (spmp) for a node is responsible for automatic bulkfree
836  * and dedup scans.
837  */
838 struct hammer2_thread {
839 	struct hammer2_pfs *pmp;
840 	struct hammer2_dev *hmp;
841 	hammer2_xop_list_t xopq;
842 	thread_t	td;
843 	uint32_t	flags;
844 	int		depth;
845 	int		clindex;	/* cluster element index */
846 	int		repidx;
847 	char		*scratch;	/* MAXPHYS */
848 };
849 
850 typedef struct hammer2_thread hammer2_thread_t;
851 
852 #define HAMMER2_THREAD_UNMOUNTING	0x0001	/* unmount request */
853 #define HAMMER2_THREAD_DEV		0x0002	/* related to dev, not pfs */
854 #define HAMMER2_THREAD_WAITING		0x0004	/* thread in idle tsleep */
855 #define HAMMER2_THREAD_REMASTER		0x0008	/* remaster request */
856 #define HAMMER2_THREAD_STOP		0x0010	/* exit request */
857 #define HAMMER2_THREAD_FREEZE		0x0020	/* force idle */
858 #define HAMMER2_THREAD_FROZEN		0x0040	/* thread is frozen */
859 #define HAMMER2_THREAD_XOPQ		0x0080	/* work pending */
860 #define HAMMER2_THREAD_STOPPED		0x0100	/* thread has stopped */
861 #define HAMMER2_THREAD_UNFREEZE		0x0200
862 
863 #define HAMMER2_THREAD_WAKEUP_MASK	(HAMMER2_THREAD_UNMOUNTING |	\
864 					 HAMMER2_THREAD_REMASTER |	\
865 					 HAMMER2_THREAD_STOP |		\
866 					 HAMMER2_THREAD_FREEZE |	\
867 					 HAMMER2_THREAD_XOPQ)
868 
869 /*
870  * Support structure for dedup heuristic.
871  */
872 struct hammer2_dedup {
873 	hammer2_off_t	data_off;
874 	uint64_t	data_crc;
875 	uint32_t	ticks;
876 	uint32_t	saved_error;
877 };
878 
879 typedef struct hammer2_dedup hammer2_dedup_t;
880 
881 /*
882  * hammer2_xop - container for VOP/XOP operation (allocated, not on stack).
883  *
884  * This structure is used to distribute a VOP operation across multiple
885  * nodes.  It provides a rendezvous for concurrent node execution and
886  * can be detached from the frontend operation to allow the frontend to
887  * return early.
888  *
889  * This structure also sequences operations on up to three inodes.
890  */
891 typedef void (*hammer2_xop_func_t)(union hammer2_xop *xop, void *scratch,
892 				   int clindex);
893 
894 struct hammer2_xop_desc {
895 	hammer2_xop_func_t	storage_func;	/* local storage function */
896 	hammer2_xop_func_t	dmsg_dispatch;	/* dmsg dispatch function */
897 	hammer2_xop_func_t	dmsg_process;	/* dmsg processing function */
898 	const char		*id;
899 };
900 
901 typedef struct hammer2_xop_desc hammer2_xop_desc_t;
902 
903 struct hammer2_xop_fifo {
904 	TAILQ_ENTRY(hammer2_xop_head) entry;
905 	hammer2_chain_t		*array[HAMMER2_XOPFIFO];
906 	int			errors[HAMMER2_XOPFIFO];
907 	int			ri;
908 	int			wi;
909 	int			flags;
910 	hammer2_thread_t	*thr;
911 };
912 
913 typedef struct hammer2_xop_fifo hammer2_xop_fifo_t;
914 
915 #define HAMMER2_XOP_FIFO_RUN	0x0001
916 #define HAMMER2_XOP_FIFO_STALL	0x0002
917 
918 struct hammer2_xop_head {
919 	hammer2_xop_desc_t	*desc;
920 	hammer2_tid_t		mtid;
921 	struct hammer2_inode	*ip1;
922 	struct hammer2_inode	*ip2;
923 	struct hammer2_inode	*ip3;
924 	uint64_t		run_mask;
925 	uint64_t		chk_mask;
926 	int			flags;
927 	int			state;
928 	int			error;
929 	hammer2_key_t		collect_key;
930 	char			*name1;
931 	size_t			name1_len;
932 	char			*name2;
933 	size_t			name2_len;
934 	hammer2_xop_fifo_t	collect[HAMMER2_MAXCLUSTER];
935 	hammer2_cluster_t	cluster;	/* help collections */
936 	hammer2_io_t		*focus_dio;
937 };
938 
939 typedef struct hammer2_xop_head hammer2_xop_head_t;
940 
941 struct hammer2_xop_ipcluster {
942 	hammer2_xop_head_t	head;
943 };
944 
945 struct hammer2_xop_strategy {
946 	hammer2_xop_head_t	head;
947 	hammer2_key_t		lbase;
948 	int			finished;
949 	hammer2_mtx_t		lock;
950 	struct bio		*bio;
951 };
952 
953 struct hammer2_xop_readdir {
954 	hammer2_xop_head_t	head;
955 	hammer2_key_t		lkey;
956 };
957 
958 struct hammer2_xop_nresolve {
959 	hammer2_xop_head_t	head;
960 	hammer2_key_t		lhc;	/* if name is NULL used lhc */
961 };
962 
963 struct hammer2_xop_unlink {
964 	hammer2_xop_head_t	head;
965 	int			isdir;
966 	int			dopermanent;
967 };
968 
969 #define H2DOPERM_PERMANENT	0x01
970 #define H2DOPERM_FORCE		0x02
971 #define H2DOPERM_IGNINO		0x04
972 
973 struct hammer2_xop_nrename {
974 	hammer2_xop_head_t	head;
975 	hammer2_tid_t		lhc;
976 	int			ip_key;
977 };
978 
979 struct hammer2_xop_scanlhc {
980 	hammer2_xop_head_t	head;
981 	hammer2_key_t		lhc;
982 };
983 
984 struct hammer2_xop_scanall {
985 	hammer2_xop_head_t	head;
986 	hammer2_key_t		key_beg;	/* inclusive */
987 	hammer2_key_t		key_end;	/* inclusive */
988 	int			resolve_flags;
989 	int			lookup_flags;
990 };
991 
992 struct hammer2_xop_lookup {
993 	hammer2_xop_head_t	head;
994 	hammer2_key_t		lhc;
995 };
996 
997 struct hammer2_xop_mkdirent {
998 	hammer2_xop_head_t	head;
999 	hammer2_dirent_head_t	dirent;
1000 	hammer2_key_t		lhc;
1001 };
1002 
1003 struct hammer2_xop_create {
1004 	hammer2_xop_head_t	head;
1005 	hammer2_inode_meta_t	meta;		/* initial metadata */
1006 	hammer2_key_t		lhc;
1007 	int			flags;
1008 };
1009 
1010 struct hammer2_xop_destroy {
1011 	hammer2_xop_head_t	head;
1012 };
1013 
1014 struct hammer2_xop_fsync {
1015 	hammer2_xop_head_t	head;
1016 	hammer2_inode_meta_t	meta;
1017 	hammer2_off_t		osize;
1018 	u_int			ipflags;
1019 	int			clear_directdata;
1020 };
1021 
1022 struct hammer2_xop_unlinkall {
1023 	hammer2_xop_head_t	head;
1024 	hammer2_key_t		key_beg;
1025 	hammer2_key_t		key_end;
1026 };
1027 
1028 struct hammer2_xop_connect {
1029 	hammer2_xop_head_t	head;
1030 	hammer2_key_t		lhc;
1031 };
1032 
1033 struct hammer2_xop_flush {
1034 	hammer2_xop_head_t	head;
1035 };
1036 
1037 typedef struct hammer2_xop_readdir hammer2_xop_readdir_t;
1038 typedef struct hammer2_xop_nresolve hammer2_xop_nresolve_t;
1039 typedef struct hammer2_xop_unlink hammer2_xop_unlink_t;
1040 typedef struct hammer2_xop_nrename hammer2_xop_nrename_t;
1041 typedef struct hammer2_xop_ipcluster hammer2_xop_ipcluster_t;
1042 typedef struct hammer2_xop_strategy hammer2_xop_strategy_t;
1043 typedef struct hammer2_xop_mkdirent hammer2_xop_mkdirent_t;
1044 typedef struct hammer2_xop_create hammer2_xop_create_t;
1045 typedef struct hammer2_xop_destroy hammer2_xop_destroy_t;
1046 typedef struct hammer2_xop_fsync hammer2_xop_fsync_t;
1047 typedef struct hammer2_xop_unlinkall hammer2_xop_unlinkall_t;
1048 typedef struct hammer2_xop_scanlhc hammer2_xop_scanlhc_t;
1049 typedef struct hammer2_xop_scanall hammer2_xop_scanall_t;
1050 typedef struct hammer2_xop_lookup hammer2_xop_lookup_t;
1051 typedef struct hammer2_xop_connect hammer2_xop_connect_t;
1052 typedef struct hammer2_xop_flush hammer2_xop_flush_t;
1053 
1054 union hammer2_xop {
1055 	hammer2_xop_head_t	head;
1056 	hammer2_xop_ipcluster_t	xop_ipcluster;
1057 	hammer2_xop_readdir_t	xop_readdir;
1058 	hammer2_xop_nresolve_t	xop_nresolve;
1059 	hammer2_xop_unlink_t	xop_unlink;
1060 	hammer2_xop_nrename_t	xop_nrename;
1061 	hammer2_xop_strategy_t	xop_strategy;
1062 	hammer2_xop_mkdirent_t	xop_mkdirent;
1063 	hammer2_xop_create_t	xop_create;
1064 	hammer2_xop_destroy_t	xop_destroy;
1065 	hammer2_xop_fsync_t	xop_fsync;
1066 	hammer2_xop_unlinkall_t	xop_unlinkall;
1067 	hammer2_xop_scanlhc_t	xop_scanlhc;
1068 	hammer2_xop_scanall_t	xop_scanall;
1069 	hammer2_xop_lookup_t	xop_lookup;
1070 	hammer2_xop_flush_t	xop_flush;
1071 	hammer2_xop_connect_t	xop_connect;
1072 };
1073 
1074 typedef union hammer2_xop hammer2_xop_t;
1075 
1076 /*
1077  * hammer2_xop_group - Manage XOP support threads.
1078  */
1079 struct hammer2_xop_group {
1080 	hammer2_thread_t	thrs[HAMMER2_MAXCLUSTER];
1081 };
1082 
1083 typedef struct hammer2_xop_group hammer2_xop_group_t;
1084 
1085 /*
1086  * flags to hammer2_xop_collect()
1087  */
1088 #define HAMMER2_XOP_COLLECT_NOWAIT	0x00000001
1089 #define HAMMER2_XOP_COLLECT_WAITALL	0x00000002
1090 
1091 /*
1092  * flags to hammer2_xop_alloc()
1093  *
1094  * MODIFYING	- This is a modifying transaction, allocate a mtid.
1095  * RECURSE	- Recurse top-level inode (for root flushes)
1096  */
1097 #define HAMMER2_XOP_MODIFYING		0x00000001
1098 #define HAMMER2_XOP_STRATEGY		0x00000002
1099 #define HAMMER2_XOP_INODE_STOP		0x00000004
1100 #define HAMMER2_XOP_VOLHDR		0x00000008
1101 #define HAMMER2_XOP_FSSYNC		0x00000010
1102 #define HAMMER2_XOP_IROOT		0x00000020
1103 
1104 /*
1105  * Global (per partition) management structure, represents a hard block
1106  * device.  Typically referenced by hammer2_chain structures when applicable.
1107  * Typically not used for network-managed elements.
1108  *
1109  * Note that a single hammer2_dev can be indirectly tied to multiple system
1110  * mount points.  There is no direct relationship.  System mounts are
1111  * per-cluster-id, not per-block-device, and a single hard mount might contain
1112  * many PFSs and those PFSs might combine together in various ways to form
1113  * the set of available clusters.
1114  */
1115 struct hammer2_dev {
1116 	struct vnode	*devvp;		/* device vnode */
1117 	int		ronly;		/* read-only mount */
1118 	int		mount_count;	/* number of actively mounted PFSs */
1119 	TAILQ_ENTRY(hammer2_dev) mntentry; /* hammer2_mntlist */
1120 
1121 	struct malloc_type *mchain;
1122 	int		nipstacks;
1123 	int		maxipstacks;
1124 	kdmsg_iocom_t	iocom;		/* volume-level dmsg interface */
1125 	hammer2_spin_t	io_spin;	/* iotree, iolruq access */
1126 	struct hammer2_io_tree iotree;
1127 	int		iofree_count;
1128 	int		freemap_relaxed;
1129 	hammer2_chain_t vchain;		/* anchor chain (topology) */
1130 	hammer2_chain_t fchain;		/* anchor chain (freemap) */
1131 	hammer2_spin_t	list_spin;
1132 	struct hammer2_pfs *spmp;	/* super-root pmp for transactions */
1133 	struct lock	vollk;		/* lockmgr lock */
1134 	struct lock	bulklk;		/* bulkfree operation lock */
1135 	struct lock	bflock;		/* bulk-free manual function lock */
1136 	hammer2_off_t	heur_freemap[HAMMER2_FREEMAP_HEUR_SIZE];
1137 	hammer2_dedup_t heur_dedup[HAMMER2_DEDUP_HEUR_SIZE];
1138 	int		volhdrno;	/* last volhdrno written */
1139 	uint32_t	hflags;		/* HMNT2 flags applicable to device */
1140 	hammer2_off_t	free_reserved;	/* nominal free reserved */
1141 	hammer2_thread_t bfthr;		/* bulk-free thread */
1142 	char		devrepname[64];	/* for kprintf */
1143 	hammer2_ioc_bulkfree_t bflast;	/* stats for last bulkfree run */
1144 	hammer2_volume_data_t voldata;
1145 	hammer2_volume_data_t volsync;	/* synchronized voldata */
1146 };
1147 
1148 typedef struct hammer2_dev hammer2_dev_t;
1149 
1150 /*
1151  * Helper functions (cluster must be locked for flags to be valid).
1152  */
1153 static __inline
1154 int
1155 hammer2_chain_rdok(hammer2_chain_t *chain)
1156 {
1157 	return (chain->error == 0);
1158 }
1159 
1160 static __inline
1161 int
1162 hammer2_chain_wrok(hammer2_chain_t *chain)
1163 {
1164 	return (chain->error == 0 && chain->hmp->ronly == 0);
1165 }
1166 
1167 /*
1168  * Per-cluster management structure.  This structure will be tied to a
1169  * system mount point if the system is mounting the PFS, but is also used
1170  * to manage clusters encountered during the super-root scan or received
1171  * via LNK_SPANs that might not be mounted.
1172  *
1173  * This structure is also used to represent the super-root that hangs off
1174  * of a hard mount point.  The super-root is not really a cluster element.
1175  * In this case the spmp_hmp field will be non-NULL.  It's just easier to do
1176  * this than to special case super-root manipulation in the hammer2_chain*
1177  * code as being only hammer2_dev-related.
1178  *
1179  * pfs_mode and pfs_nmasters are rollup fields which critically describes
1180  * how elements of the cluster act on the cluster.  pfs_mode is only applicable
1181  * when a PFS is mounted by the system.  pfs_nmasters is our best guess as to
1182  * how many masters have been configured for a cluster and is always
1183  * applicable.  pfs_types[] is an array with 1:1 correspondance to the
1184  * iroot cluster and describes the PFS types of the nodes making up the
1185  * cluster.
1186  *
1187  * WARNING! Portions of this structure have deferred initialization.  In
1188  *	    particular, if not mounted there will be no wthread.
1189  *	    umounted network PFSs will also be missing iroot and numerous
1190  *	    other fields will not be initialized prior to mount.
1191  *
1192  *	    Synchronization threads are chain-specific and only applicable
1193  *	    to local hard PFS entries.  A hammer2_pfs structure may contain
1194  *	    more than one when multiple hard PFSs are present on the local
1195  *	    machine which require synchronization monitoring.  Most PFSs
1196  *	    (such as snapshots) are 1xMASTER PFSs which do not need a
1197  *	    synchronization thread.
1198  *
1199  * WARNING! The chains making up pfs->iroot's cluster are accounted for in
1200  *	    hammer2_dev->mount_count when the pfs is associated with a mount
1201  *	    point.
1202  */
1203 struct hammer2_pfs {
1204 	struct mount		*mp;
1205 	TAILQ_ENTRY(hammer2_pfs) mntentry;	/* hammer2_pfslist */
1206 	uuid_t			pfs_clid;
1207 	hammer2_dev_t		*spmp_hmp;	/* only if super-root pmp */
1208 	hammer2_dev_t		*force_local;	/* only if 'local' mount */
1209 	hammer2_inode_t		*iroot;		/* PFS root inode */
1210 	uint8_t			pfs_types[HAMMER2_MAXCLUSTER];
1211 	char			*pfs_names[HAMMER2_MAXCLUSTER];
1212 	hammer2_dev_t		*pfs_hmps[HAMMER2_MAXCLUSTER];
1213 	hammer2_blockset_t	pfs_iroot_blocksets[HAMMER2_MAXCLUSTER];
1214 	hammer2_trans_t		trans;
1215 	struct lock		lock;		/* PFS lock for certain ops */
1216 	struct lock		lock_nlink;	/* rename and nlink lock */
1217 	struct netexport	export;		/* nfs export */
1218 	int			unused00;
1219 	int			ronly;		/* read-only mount */
1220 	int			hflags;		/* pfs-specific mount flags */
1221 	struct malloc_type	*minode;
1222 	struct malloc_type	*mmsg;
1223 	hammer2_spin_t		inum_spin;	/* inumber lookup */
1224 	struct hammer2_inode_tree inum_tree;	/* (not applicable to spmp) */
1225 	long			inum_count;	/* #of inodes in inum_tree */
1226 	hammer2_spin_t		lru_spin;	/* inumber lookup */
1227 	struct hammer2_chain_list lru_list;	/* basis for LRU tests */
1228 	int			lru_count;	/* #of chains on LRU */
1229 	int			flags;
1230 	hammer2_tid_t		modify_tid;	/* modify transaction id */
1231 	hammer2_tid_t		inode_tid;	/* inode allocator */
1232 	uint8_t			pfs_nmasters;	/* total masters */
1233 	uint8_t			pfs_mode;	/* operating mode PFSMODE */
1234 	uint8_t			unused01;
1235 	uint8_t			unused02;
1236 	int			free_ticks;	/* free_* calculations */
1237 	long			inmem_inodes;
1238 	hammer2_off_t		free_reserved;
1239 	hammer2_off_t		free_nominal;
1240 	uint32_t		inmem_dirty_chains;
1241 	int			count_lwinprog;	/* logical write in prog */
1242 	hammer2_spin_t		list_spin;
1243 	struct inoq_head	syncq;		/* SYNCQ flagged inodes */
1244 	struct depq_head	depq;		/* SIDEQ flagged inodes */
1245 	long			sideq_count;	/* total inodes on depq */
1246 	hammer2_thread_t	sync_thrs[HAMMER2_MAXCLUSTER];
1247 	uint32_t		cluster_flags;	/* cached cluster flags */
1248 	int			has_xop_threads;
1249 	hammer2_spin_t		xop_spin;	/* xop sequencer */
1250 	hammer2_xop_group_t	*xop_groups;
1251 };
1252 
1253 typedef struct hammer2_pfs hammer2_pfs_t;
1254 
1255 TAILQ_HEAD(hammer2_pfslist, hammer2_pfs);
1256 
1257 /*
1258  * pmp->flags
1259  */
1260 #define HAMMER2_PMPF_SPMP	0x00000001
1261 #define HAMMER2_PMPF_EMERG	0x00000002	/* Emergency delete mode */
1262 
1263 /*
1264  * NOTE: The LRU list contains at least all the chains with refs == 0
1265  *	 that can be recycled, and may contain additional chains which
1266  *	 cannot.
1267  */
1268 #define HAMMER2_LRU_LIMIT		4096
1269 
1270 #define HAMMER2_DIRTYCHAIN_WAITING	0x80000000
1271 #define HAMMER2_DIRTYCHAIN_MASK		0x7FFFFFFF
1272 
1273 #define HAMMER2_LWINPROG_WAITING	0x80000000
1274 #define HAMMER2_LWINPROG_WAITING0	0x40000000
1275 #define HAMMER2_LWINPROG_MASK		0x3FFFFFFF
1276 
1277 /*
1278  * hammer2_cluster_check
1279  */
1280 #define HAMMER2_CHECK_NULL	0x00000001
1281 
1282 /*
1283  * Misc
1284  */
1285 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
1286 #define VTOI(vp)	((hammer2_inode_t *)(vp)->v_data)
1287 #endif
1288 
1289 #if defined(_KERNEL)
1290 
1291 #ifdef MALLOC_DECLARE
1292 MALLOC_DECLARE(M_HAMMER2);
1293 #endif
1294 
1295 static __inline
1296 hammer2_pfs_t *
1297 MPTOPMP(struct mount *mp)
1298 {
1299 	return ((hammer2_pfs_t *)mp->mnt_data);
1300 }
1301 
1302 #define HAMMER2_DEDUP_FRAG      (HAMMER2_PBUFSIZE / 64)
1303 #define HAMMER2_DEDUP_FRAGRADIX (HAMMER2_PBUFRADIX - 6)
1304 
1305 static __inline
1306 uint64_t
1307 hammer2_dedup_mask(hammer2_io_t *dio, hammer2_off_t data_off, u_int bytes)
1308 {
1309 	int bbeg;
1310 	int bits;
1311 	uint64_t mask;
1312 
1313 	bbeg = (int)((data_off & ~HAMMER2_OFF_MASK_RADIX) - dio->pbase) >>
1314 	       HAMMER2_DEDUP_FRAGRADIX;
1315 	bits = (int)((bytes + (HAMMER2_DEDUP_FRAG - 1)) >>
1316 	       HAMMER2_DEDUP_FRAGRADIX);
1317 	mask = ((uint64_t)1 << bbeg) - 1;
1318 	if (bbeg + bits == 64)
1319 		mask = (uint64_t)-1;
1320 	else
1321 		mask = ((uint64_t)1 << (bbeg + bits)) - 1;
1322 
1323 	mask &= ~(((uint64_t)1 << bbeg) - 1);
1324 
1325 	return mask;
1326 }
1327 
1328 static __inline
1329 int
1330 hammer2_error_to_errno(int error)
1331 {
1332 	if (error) {
1333 		if (error & HAMMER2_ERROR_EIO)
1334 			error = EIO;
1335 		else if (error & HAMMER2_ERROR_CHECK)
1336 			error = EDOM;
1337 		else if (error & HAMMER2_ERROR_ABORTED)
1338 			error = EINTR;
1339 		else if (error & HAMMER2_ERROR_BADBREF)
1340 			error = EIO;
1341 		else if (error & HAMMER2_ERROR_ENOSPC)
1342 			error = ENOSPC;
1343 		else if (error & HAMMER2_ERROR_ENOENT)
1344 			error = ENOENT;
1345 		else if (error & HAMMER2_ERROR_ENOTEMPTY)
1346 			error = ENOTEMPTY;
1347 		else if (error & HAMMER2_ERROR_EAGAIN)
1348 			error = EAGAIN;
1349 		else if (error & HAMMER2_ERROR_ENOTDIR)
1350 			error = ENOTDIR;
1351 		else if (error & HAMMER2_ERROR_EISDIR)
1352 			error = EISDIR;
1353 		else if (error & HAMMER2_ERROR_EINPROGRESS)
1354 			error = EINPROGRESS;
1355 		else if (error & HAMMER2_ERROR_EEXIST)
1356 			error = EEXIST;
1357 		else if (error & HAMMER2_ERROR_EINVAL)
1358 			error = EINVAL;
1359 		else if (error & HAMMER2_ERROR_EDEADLK)
1360 			error = EDEADLK;
1361 		else if (error & HAMMER2_ERROR_ESRCH)
1362 			error = ESRCH;
1363 		else if (error & HAMMER2_ERROR_ETIMEDOUT)
1364 			error = ETIMEDOUT;
1365 		else
1366 			error = EDOM;
1367 	}
1368 	return error;
1369 }
1370 
1371 static __inline
1372 int
1373 hammer2_errno_to_error(int error)
1374 {
1375 	switch(error) {
1376 	case 0:
1377 		return 0;
1378 	case EIO:
1379 		return HAMMER2_ERROR_EIO;
1380 	case EDOM:
1381 		return HAMMER2_ERROR_CHECK;
1382 	case EINTR:
1383 		return HAMMER2_ERROR_ABORTED;
1384 	//case EIO:
1385 	//	return HAMMER2_ERROR_BADBREF;
1386 	case ENOSPC:
1387 		return HAMMER2_ERROR_ENOSPC;
1388 	case ENOENT:
1389 		return HAMMER2_ERROR_ENOENT;
1390 	case ENOTEMPTY:
1391 		return HAMMER2_ERROR_ENOTEMPTY;
1392 	case EAGAIN:
1393 		return HAMMER2_ERROR_EAGAIN;
1394 	case ENOTDIR:
1395 		return HAMMER2_ERROR_ENOTDIR;
1396 	case EISDIR:
1397 		return HAMMER2_ERROR_EISDIR;
1398 	case EINPROGRESS:
1399 		return HAMMER2_ERROR_EINPROGRESS;
1400 	case EEXIST:
1401 		return HAMMER2_ERROR_EEXIST;
1402 	case EINVAL:
1403 		return HAMMER2_ERROR_EINVAL;
1404 	case EDEADLK:
1405 		return HAMMER2_ERROR_EDEADLK;
1406 	case ESRCH:
1407 		return HAMMER2_ERROR_ESRCH;
1408 	case ETIMEDOUT:
1409 		return HAMMER2_ERROR_ETIMEDOUT;
1410 	default:
1411 		return HAMMER2_ERROR_EINVAL;
1412 	}
1413 }
1414 
1415 
1416 extern struct vop_ops hammer2_vnode_vops;
1417 extern struct vop_ops hammer2_spec_vops;
1418 extern struct vop_ops hammer2_fifo_vops;
1419 extern struct hammer2_pfslist hammer2_pfslist;
1420 extern struct lock hammer2_mntlk;
1421 
1422 
1423 extern int hammer2_debug;
1424 extern int hammer2_xopgroups;
1425 extern long hammer2_debug_inode;
1426 extern int hammer2_cluster_meta_read;
1427 extern int hammer2_cluster_data_read;
1428 extern int hammer2_cluster_write;
1429 extern int hammer2_dedup_enable;
1430 extern int hammer2_always_compress;
1431 extern int hammer2_flush_pipe;
1432 extern int hammer2_dio_count;
1433 extern int hammer2_dio_limit;
1434 extern int hammer2_bulkfree_tps;
1435 extern int hammer2_worker_rmask;
1436 extern long hammer2_chain_allocs;
1437 extern long hammer2_limit_dirty_chains;
1438 extern long hammer2_limit_dirty_inodes;
1439 extern long hammer2_count_modified_chains;
1440 extern long hammer2_iod_file_read;
1441 extern long hammer2_iod_meta_read;
1442 extern long hammer2_iod_indr_read;
1443 extern long hammer2_iod_fmap_read;
1444 extern long hammer2_iod_volu_read;
1445 extern long hammer2_iod_file_write;
1446 extern long hammer2_iod_file_wembed;
1447 extern long hammer2_iod_file_wzero;
1448 extern long hammer2_iod_file_wdedup;
1449 extern long hammer2_iod_meta_write;
1450 extern long hammer2_iod_indr_write;
1451 extern long hammer2_iod_fmap_write;
1452 extern long hammer2_iod_volu_write;
1453 
1454 extern long hammer2_process_icrc32;
1455 extern long hammer2_process_xxhash64;
1456 
1457 extern struct objcache *cache_buffer_read;
1458 extern struct objcache *cache_buffer_write;
1459 extern struct objcache *cache_xops;
1460 
1461 /*
1462  * hammer2_subr.c
1463  */
1464 #define hammer2_icrc32(buf, size)	iscsi_crc32((buf), (size))
1465 #define hammer2_icrc32c(buf, size, crc)	iscsi_crc32_ext((buf), (size), (crc))
1466 
1467 int hammer2_signal_check(time_t *timep);
1468 const char *hammer2_error_str(int error);
1469 const char *hammer2_bref_type_str(int btype);
1470 
1471 int hammer2_get_dtype(uint8_t type);
1472 int hammer2_get_vtype(uint8_t type);
1473 uint8_t hammer2_get_obj_type(enum vtype vtype);
1474 void hammer2_time_to_timespec(uint64_t xtime, struct timespec *ts);
1475 uint64_t hammer2_timespec_to_time(const struct timespec *ts);
1476 uint32_t hammer2_to_unix_xid(const uuid_t *uuid);
1477 void hammer2_guid_to_uuid(uuid_t *uuid, uint32_t guid);
1478 
1479 hammer2_key_t hammer2_dirhash(const unsigned char *name, size_t len);
1480 int hammer2_getradix(size_t bytes);
1481 
1482 int hammer2_calc_logical(hammer2_inode_t *ip, hammer2_off_t uoff,
1483 			hammer2_key_t *lbasep, hammer2_key_t *leofp);
1484 int hammer2_calc_physical(hammer2_inode_t *ip, hammer2_key_t lbase);
1485 void hammer2_update_time(uint64_t *timep);
1486 void hammer2_adjreadcounter(int btype, size_t bytes);
1487 void hammer2_adjwritecounter(int btype, size_t bytes);
1488 
1489 /*
1490  * hammer2_inode.c
1491  */
1492 struct vnode *hammer2_igetv(hammer2_inode_t *ip, int *errorp);
1493 hammer2_inode_t *hammer2_inode_lookup(hammer2_pfs_t *pmp,
1494 			hammer2_tid_t inum);
1495 hammer2_inode_t *hammer2_inode_get(hammer2_pfs_t *pmp,
1496 			hammer2_xop_head_t *xop, hammer2_tid_t inum, int idx);
1497 void hammer2_inode_ref(hammer2_inode_t *ip);
1498 void hammer2_inode_drop(hammer2_inode_t *ip);
1499 void hammer2_inode_repoint(hammer2_inode_t *ip, hammer2_cluster_t *cluster);
1500 void hammer2_inode_repoint_one(hammer2_inode_t *ip, hammer2_cluster_t *cluster,
1501 			int idx);
1502 hammer2_key_t hammer2_inode_data_count(const hammer2_inode_t *ip);
1503 hammer2_key_t hammer2_inode_inode_count(const hammer2_inode_t *ip);
1504 void hammer2_inode_modify(hammer2_inode_t *ip);
1505 void hammer2_inode_delayed_sideq(hammer2_inode_t *ip);
1506 void hammer2_inode_lock(hammer2_inode_t *ip, int how);
1507 void hammer2_inode_lock4(hammer2_inode_t *ip1, hammer2_inode_t *ip2,
1508 			hammer2_inode_t *ip3, hammer2_inode_t *ip4);
1509 void hammer2_inode_unlock(hammer2_inode_t *ip);
1510 void hammer2_inode_depend(hammer2_inode_t *ip1, hammer2_inode_t *ip2);
1511 hammer2_chain_t *hammer2_inode_chain(hammer2_inode_t *ip, int clindex, int how);
1512 hammer2_chain_t *hammer2_inode_chain_and_parent(hammer2_inode_t *ip,
1513 			int clindex, hammer2_chain_t **parentp, int how);
1514 hammer2_mtx_state_t hammer2_inode_lock_temp_release(hammer2_inode_t *ip);
1515 void hammer2_inode_lock_temp_restore(hammer2_inode_t *ip,
1516 			hammer2_mtx_state_t ostate);
1517 int hammer2_inode_lock_upgrade(hammer2_inode_t *ip);
1518 void hammer2_inode_lock_downgrade(hammer2_inode_t *ip, int);
1519 
1520 hammer2_inode_t *hammer2_inode_create_normal(hammer2_inode_t *pip,
1521 			struct vattr *vap, struct ucred *cred,
1522 			hammer2_key_t inum, int *errorp);
1523 hammer2_inode_t *hammer2_inode_create_pfs(hammer2_pfs_t *spmp,
1524 			const uint8_t *name, size_t name_len,
1525 			int *errorp);
1526 int hammer2_inode_chain_ins(hammer2_inode_t *ip);
1527 int hammer2_inode_chain_des(hammer2_inode_t *ip);
1528 int hammer2_inode_chain_sync(hammer2_inode_t *ip);
1529 int hammer2_inode_chain_flush(hammer2_inode_t *ip, int flags);
1530 int hammer2_inode_unlink_finisher(hammer2_inode_t *ip, int isopen);
1531 int hammer2_dirent_create(hammer2_inode_t *dip, const char *name,
1532 			size_t name_len, hammer2_key_t inum, uint8_t type);
1533 
1534 /*
1535  * hammer2_chain.c
1536  */
1537 hammer2_chain_t *hammer2_chain_alloc(hammer2_dev_t *hmp,
1538 				hammer2_pfs_t *pmp,
1539 				hammer2_blockref_t *bref);
1540 void hammer2_chain_core_init(hammer2_chain_t *chain);
1541 void hammer2_chain_ref(hammer2_chain_t *chain);
1542 void hammer2_chain_ref_hold(hammer2_chain_t *chain);
1543 void hammer2_chain_drop(hammer2_chain_t *chain);
1544 void hammer2_chain_drop_unhold(hammer2_chain_t *chain);
1545 void hammer2_chain_unhold(hammer2_chain_t *chain);
1546 void hammer2_chain_rehold(hammer2_chain_t *chain);
1547 int hammer2_chain_lock(hammer2_chain_t *chain, int how);
1548 void hammer2_chain_lock_unhold(hammer2_chain_t *chain, int how);
1549 void hammer2_chain_load_data(hammer2_chain_t *chain);
1550 
1551 int hammer2_chain_inode_find(hammer2_pfs_t *pmp, hammer2_key_t inum,
1552 				int clindex, int flags,
1553 				hammer2_chain_t **parentp,
1554 				hammer2_chain_t **chainp);
1555 int hammer2_chain_modify(hammer2_chain_t *chain, hammer2_tid_t mtid,
1556 				hammer2_off_t dedup_off, int flags);
1557 int hammer2_chain_modify_ip(hammer2_inode_t *ip, hammer2_chain_t *chain,
1558 				hammer2_tid_t mtid, int flags);
1559 int hammer2_chain_resize(hammer2_chain_t *chain,
1560 				hammer2_tid_t mtid, hammer2_off_t dedup_off,
1561 				int nradix, int flags);
1562 void hammer2_chain_unlock(hammer2_chain_t *chain);
1563 void hammer2_chain_unlock_hold(hammer2_chain_t *chain);
1564 hammer2_chain_t *hammer2_chain_get(hammer2_chain_t *parent, int generation,
1565 				hammer2_blockref_t *bref, int how);
1566 hammer2_chain_t *hammer2_chain_lookup_init(hammer2_chain_t *parent, int flags);
1567 void hammer2_chain_lookup_done(hammer2_chain_t *parent);
1568 hammer2_chain_t *hammer2_chain_getparent(hammer2_chain_t *chain, int flags);
1569 hammer2_chain_t *hammer2_chain_repparent(hammer2_chain_t **chainp, int flags);
1570 hammer2_chain_t *hammer2_chain_lookup(hammer2_chain_t **parentp,
1571 				hammer2_key_t *key_nextp,
1572 				hammer2_key_t key_beg, hammer2_key_t key_end,
1573 				int *errorp, int flags);
1574 hammer2_chain_t *hammer2_chain_next(hammer2_chain_t **parentp,
1575 				hammer2_chain_t *chain,
1576 				hammer2_key_t *key_nextp,
1577 				hammer2_key_t key_beg, hammer2_key_t key_end,
1578 				int *errorp, int flags);
1579 int hammer2_chain_scan(hammer2_chain_t *parent,
1580 				hammer2_chain_t **chainp,
1581 				hammer2_blockref_t *bref,
1582 				int *firstp, int flags);
1583 
1584 int hammer2_chain_create(hammer2_chain_t **parentp, hammer2_chain_t **chainp,
1585 				hammer2_dev_t *hmp, hammer2_pfs_t *pmp,
1586 				int methods, hammer2_key_t key, int keybits,
1587 				int type, size_t bytes, hammer2_tid_t mtid,
1588 				hammer2_off_t dedup_off, int flags);
1589 void hammer2_chain_rename(hammer2_chain_t **parentp,
1590 				hammer2_chain_t *chain,
1591 				hammer2_tid_t mtid, int flags);
1592 int hammer2_chain_delete(hammer2_chain_t *parent, hammer2_chain_t *chain,
1593 				hammer2_tid_t mtid, int flags);
1594 int hammer2_chain_indirect_maintenance(hammer2_chain_t *parent,
1595 				hammer2_chain_t *chain);
1596 void hammer2_chain_setflush(hammer2_chain_t *chain);
1597 void hammer2_chain_countbrefs(hammer2_chain_t *chain,
1598 				hammer2_blockref_t *base, int count);
1599 hammer2_chain_t *hammer2_chain_bulksnap(hammer2_dev_t *hmp);
1600 void hammer2_chain_bulkdrop(hammer2_chain_t *copy);
1601 
1602 void hammer2_chain_setcheck(hammer2_chain_t *chain, void *bdata);
1603 int hammer2_chain_testcheck(hammer2_chain_t *chain, void *bdata);
1604 int hammer2_chain_dirent_test(hammer2_chain_t *chain, const char *name,
1605 				size_t name_len);
1606 
1607 void hammer2_base_delete(hammer2_chain_t *parent,
1608 				hammer2_blockref_t *base, int count,
1609 				hammer2_chain_t *chain,
1610 				hammer2_blockref_t *obref);
1611 void hammer2_base_insert(hammer2_chain_t *parent,
1612 				hammer2_blockref_t *base, int count,
1613 				hammer2_chain_t *chain,
1614 				hammer2_blockref_t *elm);
1615 
1616 /*
1617  * hammer2_flush.c
1618  */
1619 void hammer2_trans_manage_init(hammer2_pfs_t *pmp);
1620 int hammer2_flush(hammer2_chain_t *chain, int istop);
1621 void hammer2_trans_init(hammer2_pfs_t *pmp, uint32_t flags);
1622 void hammer2_trans_setflags(hammer2_pfs_t *pmp, uint32_t flags);
1623 void hammer2_trans_clearflags(hammer2_pfs_t *pmp, uint32_t flags);
1624 hammer2_tid_t hammer2_trans_sub(hammer2_pfs_t *pmp);
1625 void hammer2_trans_done(hammer2_pfs_t *pmp, uint32_t flags);
1626 hammer2_tid_t hammer2_trans_newinum(hammer2_pfs_t *pmp);
1627 void hammer2_trans_assert_strategy(hammer2_pfs_t *pmp);
1628 
1629 /*
1630  * hammer2_ioctl.c
1631  */
1632 int hammer2_ioctl(hammer2_inode_t *ip, u_long com, void *data,
1633 				int fflag, struct ucred *cred);
1634 
1635 /*
1636  * hammer2_io.c
1637  */
1638 void hammer2_io_inval(hammer2_io_t *dio, hammer2_off_t data_off, u_int bytes);
1639 void hammer2_io_cleanup(hammer2_dev_t *hmp, struct hammer2_io_tree *tree);
1640 char *hammer2_io_data(hammer2_io_t *dio, off_t lbase);
1641 void hammer2_io_bkvasync(hammer2_io_t *dio);
1642 void hammer2_io_dedup_set(hammer2_dev_t *hmp, hammer2_blockref_t *bref);
1643 void hammer2_io_dedup_delete(hammer2_dev_t *hmp, uint8_t btype,
1644 				hammer2_off_t data_off, u_int bytes);
1645 void hammer2_io_dedup_assert(hammer2_dev_t *hmp, hammer2_off_t data_off,
1646 				u_int bytes);
1647 int hammer2_io_new(hammer2_dev_t *hmp, int btype, off_t lbase, int lsize,
1648 				hammer2_io_t **diop);
1649 int hammer2_io_newnz(hammer2_dev_t *hmp, int btype, off_t lbase, int lsize,
1650 				hammer2_io_t **diop);
1651 int _hammer2_io_bread(hammer2_dev_t *hmp, int btype, off_t lbase, int lsize,
1652 				hammer2_io_t **diop HAMMER2_IO_DEBUG_ARGS);
1653 void hammer2_io_setdirty(hammer2_io_t *dio);
1654 
1655 hammer2_io_t *_hammer2_io_getblk(hammer2_dev_t *hmp, int btype, off_t lbase,
1656 				int lsize, int op HAMMER2_IO_DEBUG_ARGS);
1657 hammer2_io_t *_hammer2_io_getquick(hammer2_dev_t *hmp, off_t lbase,
1658 				int lsize HAMMER2_IO_DEBUG_ARGS);
1659 void _hammer2_io_putblk(hammer2_io_t **diop HAMMER2_IO_DEBUG_ARGS);
1660 int _hammer2_io_bwrite(hammer2_io_t **diop HAMMER2_IO_DEBUG_ARGS);
1661 void _hammer2_io_bawrite(hammer2_io_t **diop HAMMER2_IO_DEBUG_ARGS);
1662 void _hammer2_io_bdwrite(hammer2_io_t **diop HAMMER2_IO_DEBUG_ARGS);
1663 void _hammer2_io_brelse(hammer2_io_t **diop HAMMER2_IO_DEBUG_ARGS);
1664 void _hammer2_io_bqrelse(hammer2_io_t **diop HAMMER2_IO_DEBUG_ARGS);
1665 void _hammer2_io_ref(hammer2_io_t *dio HAMMER2_IO_DEBUG_ARGS);
1666 
1667 #ifndef HAMMER2_IO_DEBUG
1668 
1669 #define hammer2_io_getblk(hmp, btype, lbase, lsize, op)			\
1670 	_hammer2_io_getblk((hmp), (btype), (lbase), (lsize), (op))
1671 #define hammer2_io_getquick(hmp, lbase, lsize)				\
1672 	_hammer2_io_getquick((hmp), (lbase), (lsize))
1673 #define hammer2_io_putblk(diop)						\
1674 	_hammer2_io_putblk(diop)
1675 #define hammer2_io_bwrite(diop)						\
1676 	_hammer2_io_bwrite((diop))
1677 #define hammer2_io_bawrite(diop)					\
1678 	_hammer2_io_bawrite((diop))
1679 #define hammer2_io_bdwrite(diop)					\
1680 	_hammer2_io_bdwrite((diop))
1681 #define hammer2_io_brelse(diop)						\
1682 	_hammer2_io_brelse((diop))
1683 #define hammer2_io_bqrelse(diop)					\
1684 	_hammer2_io_bqrelse((diop))
1685 #define hammer2_io_ref(dio)						\
1686 	_hammer2_io_ref((dio))
1687 
1688 #define hammer2_io_bread(hmp, btype, lbase, lsize, diop)		\
1689 	_hammer2_io_bread((hmp), (btype), (lbase), (lsize), (diop))
1690 
1691 #else
1692 
1693 #define hammer2_io_getblk(hmp, btype, lbase, lsize, op)			\
1694 	_hammer2_io_getblk((hmp), (btype), (lbase), (lsize), (op),	\
1695 	__FILE__, __LINE__)
1696 
1697 #define hammer2_io_getquick(hmp, lbase, lsize)				\
1698 	_hammer2_io_getquick((hmp), (lbase), (lsize), __FILE__, __LINE__)
1699 
1700 #define hammer2_io_putblk(diop)						\
1701 	_hammer2_io_putblk(diop, __FILE__, __LINE__)
1702 
1703 #define hammer2_io_bwrite(diop)						\
1704 	_hammer2_io_bwrite((diop), __FILE__, __LINE__)
1705 #define hammer2_io_bawrite(diop)					\
1706 	_hammer2_io_bawrite((diop), __FILE__, __LINE__)
1707 #define hammer2_io_bdwrite(diop)					\
1708 	_hammer2_io_bdwrite((diop), __FILE__, __LINE__)
1709 #define hammer2_io_brelse(diop)						\
1710 	_hammer2_io_brelse((diop), __FILE__, __LINE__)
1711 #define hammer2_io_bqrelse(diop)					\
1712 	_hammer2_io_bqrelse((diop), __FILE__, __LINE__)
1713 #define hammer2_io_ref(dio)						\
1714 	_hammer2_io_ref((dio), __FILE__, __LINE__)
1715 
1716 #define hammer2_io_bread(hmp, btype, lbase, lsize, diop)		\
1717 	_hammer2_io_bread((hmp), (btype), (lbase), (lsize), (diop),	\
1718 			  __FILE__, __LINE__)
1719 
1720 #endif
1721 
1722 /*
1723  * hammer2_admin.c
1724  */
1725 void hammer2_thr_signal(hammer2_thread_t *thr, uint32_t flags);
1726 void hammer2_thr_signal2(hammer2_thread_t *thr,
1727 			uint32_t pflags, uint32_t nflags);
1728 void hammer2_thr_wait(hammer2_thread_t *thr, uint32_t flags);
1729 void hammer2_thr_wait_neg(hammer2_thread_t *thr, uint32_t flags);
1730 int hammer2_thr_wait_any(hammer2_thread_t *thr, uint32_t flags, int timo);
1731 void hammer2_thr_create(hammer2_thread_t *thr,
1732 			hammer2_pfs_t *pmp, hammer2_dev_t *hmp,
1733 			const char *id, int clindex, int repidx,
1734 			void (*func)(void *arg));
1735 void hammer2_thr_delete(hammer2_thread_t *thr);
1736 void hammer2_thr_remaster(hammer2_thread_t *thr);
1737 void hammer2_thr_freeze_async(hammer2_thread_t *thr);
1738 void hammer2_thr_freeze(hammer2_thread_t *thr);
1739 void hammer2_thr_unfreeze(hammer2_thread_t *thr);
1740 int hammer2_thr_break(hammer2_thread_t *thr);
1741 void hammer2_primary_xops_thread(void *arg);
1742 
1743 /*
1744  * hammer2_thread.c (XOP API)
1745  */
1746 void *hammer2_xop_alloc(hammer2_inode_t *ip, int flags);
1747 void hammer2_xop_setname(hammer2_xop_head_t *xop,
1748 				const char *name, size_t name_len);
1749 void hammer2_xop_setname2(hammer2_xop_head_t *xop,
1750 				const char *name, size_t name_len);
1751 size_t hammer2_xop_setname_inum(hammer2_xop_head_t *xop, hammer2_key_t inum);
1752 void hammer2_xop_setip2(hammer2_xop_head_t *xop, hammer2_inode_t *ip2);
1753 void hammer2_xop_setip3(hammer2_xop_head_t *xop, hammer2_inode_t *ip3);
1754 void hammer2_xop_reinit(hammer2_xop_head_t *xop);
1755 void hammer2_xop_helper_create(hammer2_pfs_t *pmp);
1756 void hammer2_xop_helper_cleanup(hammer2_pfs_t *pmp);
1757 void hammer2_xop_start(hammer2_xop_head_t *xop, hammer2_xop_desc_t *desc);
1758 void hammer2_xop_start_except(hammer2_xop_head_t *xop, hammer2_xop_desc_t *desc,
1759 				int notidx);
1760 int hammer2_xop_collect(hammer2_xop_head_t *xop, int flags);
1761 void hammer2_xop_retire(hammer2_xop_head_t *xop, uint64_t mask);
1762 int hammer2_xop_active(hammer2_xop_head_t *xop);
1763 int hammer2_xop_feed(hammer2_xop_head_t *xop, hammer2_chain_t *chain,
1764 				int clindex, int error);
1765 
1766 /*
1767  * hammer2_synchro.c
1768  */
1769 void hammer2_primary_sync_thread(void *arg);
1770 
1771 /*
1772  * XOP backends in hammer2_xops.c, primarily for VNOPS.  Other XOP backends
1773  * may be integrated into other source files.
1774  */
1775 void hammer2_xop_ipcluster(hammer2_xop_t *xop, void *scratch, int clindex);
1776 void hammer2_xop_readdir(hammer2_xop_t *xop, void *scratch, int clindex);
1777 void hammer2_xop_nresolve(hammer2_xop_t *xop, void *scratch, int clindex);
1778 void hammer2_xop_unlink(hammer2_xop_t *xop, void *scratch, int clindex);
1779 void hammer2_xop_nrename(hammer2_xop_t *xop, void *scratch, int clindex);
1780 void hammer2_xop_scanlhc(hammer2_xop_t *xop, void *scratch, int clindex);
1781 void hammer2_xop_scanall(hammer2_xop_t *xop, void *scratch, int clindex);
1782 void hammer2_xop_lookup(hammer2_xop_t *xop, void *scratch, int clindex);
1783 void hammer2_xop_delete(hammer2_xop_t *xop, void *scratch, int clindex);
1784 void hammer2_xop_inode_mkdirent(hammer2_xop_t *xop, void *scratch, int clindex);
1785 void hammer2_xop_inode_create(hammer2_xop_t *xop, void *scratch, int clindex);
1786 void hammer2_xop_inode_create_det(hammer2_xop_t *xop,
1787 				void *scratch, int clindex);
1788 void hammer2_xop_inode_create_ins(hammer2_xop_t *xop,
1789 				void *scratch, int clindex);
1790 void hammer2_xop_inode_destroy(hammer2_xop_t *xop, void *scratch, int clindex);
1791 void hammer2_xop_inode_chain_sync(hammer2_xop_t *xop, void *scratch,
1792 				int clindex);
1793 void hammer2_xop_inode_unlinkall(hammer2_xop_t *xop, void *scratch,
1794 				int clindex);
1795 void hammer2_xop_inode_connect(hammer2_xop_t *xop, void *scratch, int clindex);
1796 void hammer2_xop_inode_flush(hammer2_xop_t *xop, void *scratch, int clindex);
1797 void hammer2_xop_strategy_read(hammer2_xop_t *xop, void *scratch, int clindex);
1798 void hammer2_xop_strategy_write(hammer2_xop_t *xop, void *scratch, int clindex);
1799 
1800 void hammer2_dmsg_ipcluster(hammer2_xop_t *xop, void *scratch, int clindex);
1801 void hammer2_dmsg_readdir(hammer2_xop_t *xop, void *scratch, int clindex);
1802 void hammer2_dmsg_nresolve(hammer2_xop_t *xop, void *scratch, int clindex);
1803 void hammer2_dmsg_unlink(hammer2_xop_t *xop, void *scratch, int clindex);
1804 void hammer2_dmsg_nrename(hammer2_xop_t *xop, void *scratch, int clindex);
1805 void hammer2_dmsg_scanlhc(hammer2_xop_t *xop, void *scratch, int clindex);
1806 void hammer2_dmsg_scanall(hammer2_xop_t *xop, void *scratch, int clindex);
1807 void hammer2_dmsg_lookup(hammer2_xop_t *xop, void *scratch, int clindex);
1808 void hammer2_dmsg_inode_mkdirent(hammer2_xop_t *xop, void *scratch,
1809 				int clindex);
1810 void hammer2_dmsg_inode_create(hammer2_xop_t *xop, void *scratch, int clindex);
1811 void hammer2_dmsg_inode_destroy(hammer2_xop_t *xop, void *scratch, int clindex);
1812 void hammer2_dmsg_inode_chain_sync(hammer2_xop_t *xop, void *scratch,
1813 				int clindex);
1814 void hammer2_dmsg_inode_unlinkall(hammer2_xop_t *xop, void *scratch,
1815 				int clindex);
1816 void hammer2_dmsg_inode_connect(hammer2_xop_t *xop, void *scratch, int clindex);
1817 void hammer2_dmsg_inode_flush(hammer2_xop_t *xop, void *scratch, int clindex);
1818 void hammer2_dmsg_strategy_read(hammer2_xop_t *xop, void *scratch, int clindex);
1819 void hammer2_dmsg_strategy_write(hammer2_xop_t *xop, void *scratch,
1820 				int clindex);
1821 
1822 void hammer2_rmsg_ipcluster(hammer2_xop_t *xop, void *scratch, int clindex);
1823 void hammer2_rmsg_readdir(hammer2_xop_t *xop, void *scratch, int clindex);
1824 void hammer2_rmsg_nresolve(hammer2_xop_t *xop, void *scratch, int clindex);
1825 void hammer2_rmsg_unlink(hammer2_xop_t *xop, void *scratch, int clindex);
1826 void hammer2_rmsg_nrename(hammer2_xop_t *xop, void *scratch, int clindex);
1827 void hammer2_rmsg_scanlhc(hammer2_xop_t *xop, void *scratch, int clindex);
1828 void hammer2_rmsg_scanall(hammer2_xop_t *xop, void *scratch, int clindex);
1829 void hammer2_rmsg_lookup(hammer2_xop_t *xop, void *scratch, int clindex);
1830 void hammer2_rmsg_inode_mkdirent(hammer2_xop_t *xop, void *scratch,
1831 				int clindex);
1832 void hammer2_rmsg_inode_create(hammer2_xop_t *xop, void *scratch, int clindex);
1833 void hammer2_rmsg_inode_destroy(hammer2_xop_t *xop, void *scratch, int clindex);
1834 void hammer2_rmsg_inode_chain_sync(hammer2_xop_t *xop, void *scratch,
1835 				int clindex);
1836 void hammer2_rmsg_inode_unlinkall(hammer2_xop_t *xop, void *scratch,
1837 				int clindex);
1838 void hammer2_rmsg_inode_connect(hammer2_xop_t *xop, void *scratch, int clindex);
1839 void hammer2_rmsg_inode_flush(hammer2_xop_t *xop, void *scratch, int clindex);
1840 void hammer2_rmsg_strategy_read(hammer2_xop_t *xop, void *scratch, int clindex);
1841 void hammer2_rmsg_strategy_write(hammer2_xop_t *xop, void *scratch,
1842 				int clindex);
1843 
1844 extern hammer2_xop_desc_t hammer2_ipcluster_desc;
1845 extern hammer2_xop_desc_t hammer2_readdir_desc;
1846 extern hammer2_xop_desc_t hammer2_nresolve_desc;
1847 extern hammer2_xop_desc_t hammer2_unlink_desc;
1848 extern hammer2_xop_desc_t hammer2_nrename_desc;
1849 extern hammer2_xop_desc_t hammer2_scanlhc_desc;
1850 extern hammer2_xop_desc_t hammer2_scanall_desc;
1851 extern hammer2_xop_desc_t hammer2_lookup_desc;
1852 extern hammer2_xop_desc_t hammer2_delete_desc;
1853 extern hammer2_xop_desc_t hammer2_inode_mkdirent_desc;
1854 extern hammer2_xop_desc_t hammer2_inode_create_desc;
1855 extern hammer2_xop_desc_t hammer2_inode_create_det_desc;
1856 extern hammer2_xop_desc_t hammer2_inode_create_ins_desc;
1857 extern hammer2_xop_desc_t hammer2_inode_destroy_desc;
1858 extern hammer2_xop_desc_t hammer2_inode_chain_sync_desc;
1859 extern hammer2_xop_desc_t hammer2_inode_unlinkall_desc;
1860 extern hammer2_xop_desc_t hammer2_inode_connect_desc;
1861 extern hammer2_xop_desc_t hammer2_inode_flush_desc;
1862 extern hammer2_xop_desc_t hammer2_strategy_read_desc;
1863 extern hammer2_xop_desc_t hammer2_strategy_write_desc;
1864 
1865 /*
1866  * hammer2_msgops.c
1867  */
1868 int hammer2_msg_dbg_rcvmsg(kdmsg_msg_t *msg);
1869 int hammer2_msg_adhoc_input(kdmsg_msg_t *msg);
1870 
1871 /*
1872  * hammer2_vfsops.c
1873  */
1874 void hammer2_dump_chain(hammer2_chain_t *chain, int tab, int bi, int *countp,
1875 				char pfx, u_int flags);
1876 int hammer2_vfs_sync(struct mount *mp, int waitflags);
1877 int hammer2_vfs_sync_pmp(hammer2_pfs_t *pmp, int waitfor);
1878 int hammer2_vfs_enospace(hammer2_inode_t *ip, off_t bytes, struct ucred *cred);
1879 
1880 hammer2_pfs_t *hammer2_pfsalloc(hammer2_chain_t *chain,
1881 				const hammer2_inode_data_t *ripdata,
1882 				hammer2_tid_t modify_tid,
1883 				hammer2_dev_t *force_local);
1884 void hammer2_pfsdealloc(hammer2_pfs_t *pmp, int clindex, int destroying);
1885 int hammer2_vfs_vget(struct mount *mp, struct vnode *dvp,
1886 				ino_t ino, struct vnode **vpp);
1887 
1888 void hammer2_lwinprog_ref(hammer2_pfs_t *pmp);
1889 void hammer2_lwinprog_drop(hammer2_pfs_t *pmp);
1890 void hammer2_lwinprog_wait(hammer2_pfs_t *pmp, int pipe);
1891 
1892 void hammer2_pfs_memory_wait(hammer2_pfs_t *pmp);
1893 void hammer2_pfs_memory_inc(hammer2_pfs_t *pmp);
1894 void hammer2_pfs_memory_wakeup(hammer2_pfs_t *pmp, int count);
1895 
1896 void hammer2_voldata_lock(hammer2_dev_t *hmp);
1897 void hammer2_voldata_unlock(hammer2_dev_t *hmp);
1898 void hammer2_voldata_modify(hammer2_dev_t *hmp);
1899 
1900 /*
1901  * hammer2_freemap.c
1902  */
1903 int hammer2_freemap_alloc(hammer2_chain_t *chain, size_t bytes);
1904 void hammer2_freemap_adjust(hammer2_dev_t *hmp,
1905 				hammer2_blockref_t *bref, int how);
1906 
1907 /*
1908  * hammer2_cluster.c
1909  */
1910 uint8_t hammer2_cluster_type(hammer2_cluster_t *cluster);
1911 void hammer2_cluster_bref(hammer2_cluster_t *cluster, hammer2_blockref_t *bref);
1912 void hammer2_cluster_ref(hammer2_cluster_t *cluster);
1913 void hammer2_cluster_drop(hammer2_cluster_t *cluster);
1914 void hammer2_cluster_unhold(hammer2_cluster_t *cluster);
1915 void hammer2_cluster_rehold(hammer2_cluster_t *cluster);
1916 void hammer2_cluster_lock(hammer2_cluster_t *cluster, int how);
1917 int hammer2_cluster_check(hammer2_cluster_t *cluster, hammer2_key_t lokey,
1918 			int flags);
1919 void hammer2_cluster_resolve(hammer2_cluster_t *cluster);
1920 void hammer2_cluster_forcegood(hammer2_cluster_t *cluster);
1921 void hammer2_cluster_unlock(hammer2_cluster_t *cluster);
1922 
1923 void hammer2_bulkfree_init(hammer2_dev_t *hmp);
1924 void hammer2_bulkfree_uninit(hammer2_dev_t *hmp);
1925 int hammer2_bulkfree_pass(hammer2_dev_t *hmp, hammer2_chain_t *vchain,
1926 			struct hammer2_ioc_bulkfree *bfi);
1927 void hammer2_dummy_xop_from_chain(hammer2_xop_head_t *xop,
1928 			hammer2_chain_t *chain);
1929 
1930 /*
1931  * hammer2_iocom.c
1932  */
1933 void hammer2_iocom_init(hammer2_dev_t *hmp);
1934 void hammer2_iocom_uninit(hammer2_dev_t *hmp);
1935 void hammer2_cluster_reconnect(hammer2_dev_t *hmp, struct file *fp);
1936 void hammer2_volconf_update(hammer2_dev_t *hmp, int index);
1937 
1938 /*
1939  * hammer2_strategy.c
1940  */
1941 int hammer2_vop_strategy(struct vop_strategy_args *ap);
1942 int hammer2_vop_bmap(struct vop_bmap_args *ap);
1943 void hammer2_bioq_sync(hammer2_pfs_t *pmp);
1944 void hammer2_dedup_record(hammer2_chain_t *chain, hammer2_io_t *dio,
1945 				const char *data);
1946 void hammer2_dedup_clear(hammer2_dev_t *hmp);
1947 
1948 /*
1949  * More complex inlines
1950  */
1951 
1952 #define hammer2_xop_gdata(xop)	_hammer2_xop_gdata((xop), __FILE__, __LINE__)
1953 
1954 static __inline
1955 const hammer2_media_data_t *
1956 _hammer2_xop_gdata(hammer2_xop_head_t *xop, const char *file, int line)
1957 {
1958 	hammer2_chain_t *focus;
1959 	const void *data;
1960 
1961 	focus = xop->cluster.focus;
1962 	if (focus->dio) {
1963 		lockmgr(&focus->diolk, LK_SHARED);
1964 		if ((xop->focus_dio = focus->dio) != NULL) {
1965 			_hammer2_io_ref(xop->focus_dio HAMMER2_IO_DEBUG_CALL);
1966 			hammer2_io_bkvasync(xop->focus_dio);
1967 		}
1968 		data = focus->data;
1969 		lockmgr(&focus->diolk, LK_RELEASE);
1970 	} else {
1971 		data = focus->data;
1972 	}
1973 
1974 	return data;
1975 }
1976 
1977 #define hammer2_xop_pdata(xop)	_hammer2_xop_pdata((xop), __FILE__, __LINE__)
1978 
1979 static __inline
1980 void
1981 _hammer2_xop_pdata(hammer2_xop_head_t *xop, const char *file, int line)
1982 {
1983 	if (xop->focus_dio)
1984 		_hammer2_io_putblk(&xop->focus_dio HAMMER2_IO_DEBUG_CALL);
1985 }
1986 
1987 #endif /* !_KERNEL */
1988 #endif /* !_VFS_HAMMER2_HAMMER2_H_ */
1989