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