2 * Copyright (c) 2007-2008 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * $DragonFly: src/sys/vfs/hammer/hammer.h,v 1.80 2008/06/10 22:30:21 dillon Exp $
37 * This header file contains structures used internally by the HAMMERFS
38 * implementation. See hammer_disk.h for on-disk structures.
41 #include <sys/param.h>
42 #include <sys/types.h>
43 #include <sys/kernel.h>
45 #include <sys/systm.h>
47 #include <sys/malloc.h>
48 #include <sys/mount.h>
49 #include <sys/mountctl.h>
50 #include <sys/vnode.h>
53 #include <sys/globaldata.h>
54 #include <sys/lockf.h>
56 #include <sys/queue.h>
57 #include <sys/globaldata.h>
60 #include <sys/signal2.h>
61 #include "hammer_disk.h"
62 #include "hammer_mount.h"
63 #include "hammer_ioctl.h"
65 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
67 MALLOC_DECLARE(M_HAMMER);
72 * Key structure used for custom RB tree inode lookups. This prototypes
73 * the function hammer_ino_rb_tree_RB_LOOKUP_INFO(root, info).
75 typedef struct hammer_inode_info {
76 int64_t obj_id; /* (key) object identifier */
77 hammer_tid_t obj_asof; /* (key) snapshot transid or 0 */
78 } *hammer_inode_info_t;
80 typedef enum hammer_transaction_type {
84 } hammer_transaction_type_t;
87 * HAMMER Transaction tracking
89 struct hammer_transaction {
90 hammer_transaction_type_t type;
91 struct hammer_mount *hmp;
95 struct hammer_volume *rootvol;
98 typedef struct hammer_transaction *hammer_transaction_t;
104 int refs; /* active references delay writes */
105 int lockcount; /* lock count for exclusive/shared access */
107 struct thread *locktd;
111 hammer_islocked(struct hammer_lock *lock)
113 return(lock->lockcount != 0);
117 hammer_isactive(struct hammer_lock *lock)
119 return(lock->refs != 0);
123 hammer_islastref(struct hammer_lock *lock)
125 return(lock->refs == 1);
129 * Return if we specifically own the lock exclusively.
132 hammer_lock_excl_owned(struct hammer_lock *lock, thread_t td)
134 if (lock->lockcount > 0 && lock->locktd == td)
140 * Flush state, used by various structures
142 typedef enum hammer_inode_state {
146 } hammer_inode_state_t;
148 TAILQ_HEAD(hammer_record_list, hammer_record);
151 * Cache object ids. A fixed number of objid cache structures are
152 * created to reserve object id's for newly created files in multiples
153 * of 100,000, localized to a particular directory, and recycled as
154 * needed. This allows parallel create operations in different
155 * directories to retain fairly localized object ids which in turn
156 * improves reblocking performance and layout.
158 #define OBJID_CACHE_SIZE 128
159 #define OBJID_CACHE_BULK 100000
161 typedef struct hammer_objid_cache {
162 TAILQ_ENTRY(hammer_objid_cache) entry;
163 struct hammer_inode *dip;
164 hammer_tid_t next_tid;
166 } *hammer_objid_cache_t;
169 * Structure used to represent an inode in-memory.
171 * The record and data associated with an inode may be out of sync with
172 * the disk (xDIRTY flags), or not even on the disk at all (ONDISK flag
175 * An inode may also hold a cache of unsynchronized records, used for
176 * database and directories only. Unsynchronized regular file data is
177 * stored in the buffer cache.
179 * NOTE: A file which is created and destroyed within the initial
180 * synchronization period can wind up not doing any disk I/O at all.
182 * Finally, an inode may cache numerous disk-referencing B-Tree cursors.
184 struct hammer_ino_rb_tree;
186 RB_HEAD(hammer_ino_rb_tree, hammer_inode);
187 RB_PROTOTYPEX(hammer_ino_rb_tree, INFO, hammer_inode, rb_node,
188 hammer_ino_rb_compare, hammer_inode_info_t);
190 struct hammer_rec_rb_tree;
191 struct hammer_record;
192 RB_HEAD(hammer_rec_rb_tree, hammer_record);
193 RB_PROTOTYPEX(hammer_rec_rb_tree, INFO, hammer_record, rb_node,
194 hammer_rec_rb_compare, hammer_btree_leaf_elm_t);
196 TAILQ_HEAD(hammer_node_list, hammer_node);
198 struct hammer_inode {
199 RB_ENTRY(hammer_inode) rb_node;
200 hammer_inode_state_t flush_state;
202 TAILQ_ENTRY(hammer_inode) flush_entry;
203 struct hammer_record_list target_list; /* target of dependant recs */
204 u_int64_t obj_id; /* (key) object identifier */
205 hammer_tid_t obj_asof; /* (key) snapshot or 0 */
206 struct hammer_mount *hmp;
207 hammer_objid_cache_t objid_cache;
209 int error; /* flush error */
210 int cursor_ip_refs; /* sanity */
215 struct lockf advlock;
216 struct hammer_lock lock; /* sync copy interlock */
218 struct hammer_btree_leaf_elm ino_leaf; /* in-memory cache */
219 struct hammer_inode_data ino_data; /* in-memory cache */
220 struct hammer_rec_rb_tree rec_tree; /* in-memory cache */
221 struct hammer_node *cache[2]; /* search initiate cache */
224 * When a demark is created to synchronize an inode to
225 * disk, certain fields are copied so the front-end VOPs
226 * can continue to run in parallel with the synchronization
227 * occuring in the background.
229 int sync_flags; /* to-sync flags cache */
230 off_t sync_trunc_off; /* to-sync truncation */
231 struct hammer_btree_leaf_elm sync_ino_leaf; /* to-sync cache */
232 struct hammer_inode_data sync_ino_data; /* to-sync cache */
235 typedef struct hammer_inode *hammer_inode_t;
237 #define VTOI(vp) ((struct hammer_inode *)(vp)->v_data)
239 #define HAMMER_INODE_DDIRTY 0x0001 /* in-memory ino_data is dirty */
240 #define HAMMER_INODE_RSV_INODES 0x0002 /* hmp->rsv_inodes bumped */
241 #define HAMMER_INODE_ITIMES 0x0004 /* in-memory mtime/atime modified */
242 #define HAMMER_INODE_XDIRTY 0x0008 /* in-memory records */
243 #define HAMMER_INODE_ONDISK 0x0010 /* inode is on-disk (else not yet) */
244 #define HAMMER_INODE_FLUSH 0x0020 /* flush on last ref */
245 #define HAMMER_INODE_DELETED 0x0080 /* inode delete (backend) */
246 #define HAMMER_INODE_DELONDISK 0x0100 /* delete synchronized to disk */
247 #define HAMMER_INODE_RO 0x0200 /* read-only (because of as-of) */
248 #define HAMMER_INODE_VHELD 0x0400 /* vnode held on sync */
249 #define HAMMER_INODE_DONDISK 0x0800 /* data records may be on disk */
250 #define HAMMER_INODE_BUFS 0x1000 /* dirty high level bps present */
251 #define HAMMER_INODE_REFLUSH 0x2000 /* pipelined flush during flush */
252 #define HAMMER_INODE_RECLAIM 0x4000 /* trying to reclaim */
253 #define HAMMER_INODE_FLUSHW 0x8000 /* Someone waiting for flush */
255 #define HAMMER_INODE_TRUNCATED 0x00010000
256 #define HAMMER_INODE_DELETING 0x00020000 /* inode delete request (frontend)*/
257 #define HAMMER_INODE_RESIGNAL 0x00040000 /* re-signal on re-flush */
259 #define HAMMER_INODE_MODMASK (HAMMER_INODE_DDIRTY| \
260 HAMMER_INODE_XDIRTY|HAMMER_INODE_BUFS| \
261 HAMMER_INODE_ITIMES|HAMMER_INODE_TRUNCATED|\
262 HAMMER_INODE_DELETING)
264 #define HAMMER_INODE_MODMASK_NOXDIRTY \
265 (HAMMER_INODE_MODMASK & ~HAMMER_INODE_XDIRTY)
267 #define HAMMER_MAX_INODE_CURSORS 4
269 #define HAMMER_FLUSH_SIGNAL 0x0001
270 #define HAMMER_FLUSH_RECURSION 0x0002
272 #define HAMMER_RECLAIM_MIN 1000 /* absolute value */
273 #define HAMMER_RECLAIM_MID 2000 /* absolute value */
274 #define HAMMER_RECLAIM_MAX 3000 /* absolute value */
277 * Structure used to represent an unsynchronized record in-memory. These
278 * records typically represent directory entries. Only non-historical
279 * records are kept in-memory.
281 * Records are organized as a per-inode RB-Tree. If the inode is not
282 * on disk then neither are any records and the in-memory record tree
283 * represents the entire contents of the inode. If the inode is on disk
284 * then the on-disk B-Tree is scanned in parallel with the in-memory
285 * RB-Tree to synthesize the current state of the file.
287 * Records are also used to enforce the ordering of directory create/delete
288 * operations. A new inode will not be flushed to disk unless its related
289 * directory entry is also being flushed at the same time. A directory entry
290 * will not be removed unless its related inode is also being removed at the
293 typedef enum hammer_record_type {
294 HAMMER_MEM_RECORD_GENERAL, /* misc record */
295 HAMMER_MEM_RECORD_INODE, /* inode record */
296 HAMMER_MEM_RECORD_ADD, /* positive memory cache record */
297 HAMMER_MEM_RECORD_DEL, /* negative delete-on-disk record */
298 HAMMER_MEM_RECORD_DATA /* bulk-data record w/on-disk ref */
299 } hammer_record_type_t;
301 struct hammer_record {
302 RB_ENTRY(hammer_record) rb_node;
303 TAILQ_ENTRY(hammer_record) target_entry;
304 hammer_inode_state_t flush_state;
306 hammer_record_type_t type;
307 struct hammer_lock lock;
308 struct hammer_reserve *resv;
309 struct hammer_inode *ip;
310 struct hammer_inode *target_ip;
311 struct hammer_btree_leaf_elm leaf;
312 union hammer_data_ondisk *data;
316 typedef struct hammer_record *hammer_record_t;
319 * Record flags. Note that FE can only be set by the frontend if the
320 * record has not been interlocked by the backend w/ BE.
322 #define HAMMER_RECF_ALLOCDATA 0x0001
323 #define HAMMER_RECF_ONRBTREE 0x0002
324 #define HAMMER_RECF_DELETED_FE 0x0004 /* deleted (frontend) */
325 #define HAMMER_RECF_DELETED_BE 0x0008 /* deleted (backend) */
326 #define HAMMER_RECF_UNUSED0010 0x0010
327 #define HAMMER_RECF_INTERLOCK_BE 0x0020 /* backend interlock */
328 #define HAMMER_RECF_WANTED 0x0040 /* wanted by the frontend */
329 #define HAMMER_RECF_WANTIDLE 0x0080 /* wanted when idle */
330 #define HAMMER_RECF_CONVERT_DELETE 0x0100 /* special case */
333 * In-memory structures representing on-disk structures.
335 struct hammer_volume;
336 struct hammer_buffer;
339 struct hammer_reserve;
341 RB_HEAD(hammer_vol_rb_tree, hammer_volume);
342 RB_HEAD(hammer_buf_rb_tree, hammer_buffer);
343 RB_HEAD(hammer_nod_rb_tree, hammer_node);
344 RB_HEAD(hammer_und_rb_tree, hammer_undo);
345 RB_HEAD(hammer_res_rb_tree, hammer_reserve);
347 RB_PROTOTYPE2(hammer_vol_rb_tree, hammer_volume, rb_node,
348 hammer_vol_rb_compare, int32_t);
349 RB_PROTOTYPE2(hammer_buf_rb_tree, hammer_buffer, rb_node,
350 hammer_buf_rb_compare, hammer_off_t);
351 RB_PROTOTYPE2(hammer_nod_rb_tree, hammer_node, rb_node,
352 hammer_nod_rb_compare, hammer_off_t);
353 RB_PROTOTYPE2(hammer_und_rb_tree, hammer_undo, rb_node,
354 hammer_und_rb_compare, hammer_off_t);
355 RB_PROTOTYPE2(hammer_res_rb_tree, hammer_reserve, rb_node,
356 hammer_res_rb_compare, hammer_off_t);
359 * IO management - embedded at the head of various in-memory structures
361 * VOLUME - hammer_volume containing meta-data
362 * META_BUFFER - hammer_buffer containing meta-data
363 * DATA_BUFFER - hammer_buffer containing pure-data
365 * Dirty volume headers and dirty meta-data buffers are locked until the
366 * flusher can sequence them out. Dirty pure-data buffers can be written.
367 * Clean buffers can be passively released.
369 typedef enum hammer_io_type {
370 HAMMER_STRUCTURE_VOLUME,
371 HAMMER_STRUCTURE_META_BUFFER,
372 HAMMER_STRUCTURE_UNDO_BUFFER,
373 HAMMER_STRUCTURE_DATA_BUFFER
376 union hammer_io_structure;
380 LIST_ENTRY(worklist) node;
383 TAILQ_HEAD(hammer_io_list, hammer_io);
384 typedef struct hammer_io_list *hammer_io_list_t;
387 struct worklist worklist;
388 struct hammer_lock lock;
389 enum hammer_io_type type;
390 struct hammer_mount *hmp;
391 TAILQ_ENTRY(hammer_io) mod_entry; /* list entry if modified */
392 hammer_io_list_t mod_list;
395 int loading; /* loading/unloading interlock */
398 u_int modified : 1; /* bp's data was modified */
399 u_int released : 1; /* bp released (w/ B_LOCKED set) */
400 u_int running : 1; /* bp write IO in progress */
401 u_int waiting : 1; /* someone is waiting on us */
402 u_int validated : 1; /* ondisk has been validated */
403 u_int waitdep : 1; /* flush waits for dependancies */
404 u_int recovered : 1; /* has recovery ref */
405 u_int waitmod : 1; /* waiting for modify_refs */
406 u_int reclaim : 1; /* reclaim requested */
409 typedef struct hammer_io *hammer_io_t;
411 #define HAMMER_CLUSTER_SIZE (64 * 1024)
412 #if HAMMER_CLUSTER_SIZE > MAXBSIZE
413 #undef HAMMER_CLUSTER_SIZE
414 #define HAMMER_CLUSTER_SIZE MAXBSIZE
416 #define HAMMER_CLUSTER_BUFS (HAMMER_CLUSTER_SIZE / HAMMER_BUFSIZE)
419 * In-memory volume representing on-disk buffer
421 struct hammer_volume {
423 RB_ENTRY(hammer_volume) rb_node;
424 struct hammer_volume_ondisk *ondisk;
426 int64_t nblocks; /* note: special calculation for statfs */
427 int64_t buffer_base; /* base offset of buffer 0 */
428 hammer_off_t maxbuf_off; /* Maximum buffer offset (zone-2) */
429 hammer_off_t maxraw_off; /* Maximum raw offset for device */
435 typedef struct hammer_volume *hammer_volume_t;
438 * In-memory buffer (other then volume, super-cluster, or cluster),
439 * representing an on-disk buffer.
441 struct hammer_buffer {
443 RB_ENTRY(hammer_buffer) rb_node;
445 struct hammer_volume *volume;
446 hammer_off_t zoneX_offset;
447 hammer_off_t zone2_offset;
448 struct hammer_reserve *resv;
449 struct hammer_node_list clist;
452 typedef struct hammer_buffer *hammer_buffer_t;
455 * In-memory B-Tree node, representing an on-disk B-Tree node.
457 * This is a hang-on structure which is backed by a hammer_buffer,
458 * indexed by a hammer_cluster, and used for fine-grained locking of
459 * B-Tree nodes in order to properly control lock ordering. A hammer_buffer
460 * can contain multiple nodes representing wildly disassociated portions
461 * of the B-Tree so locking cannot be done on a buffer-by-buffer basis.
463 * This structure uses a cluster-relative index to reduce the number
464 * of layers required to access it, and also because all on-disk B-Tree
465 * references are cluster-relative offsets.
468 struct hammer_lock lock; /* node-by-node lock */
469 TAILQ_ENTRY(hammer_node) entry; /* per-buffer linkage */
470 RB_ENTRY(hammer_node) rb_node; /* per-cluster linkage */
471 hammer_off_t node_offset; /* full offset spec */
472 struct hammer_mount *hmp;
473 struct hammer_buffer *buffer; /* backing buffer */
474 hammer_node_ondisk_t ondisk; /* ptr to on-disk structure */
475 struct hammer_node **cache1; /* passive cache(s) */
476 struct hammer_node **cache2;
478 int loading; /* load interlock */
481 #define HAMMER_NODE_DELETED 0x0001
482 #define HAMMER_NODE_FLUSH 0x0002
484 typedef struct hammer_node *hammer_node_t;
487 * List of locked nodes.
489 struct hammer_node_locklist {
490 struct hammer_node_locklist *next;
494 typedef struct hammer_node_locklist *hammer_node_locklist_t;
498 * Common I/O management structure - embedded in in-memory structures
499 * which are backed by filesystem buffers.
501 union hammer_io_structure {
503 struct hammer_volume volume;
504 struct hammer_buffer buffer;
507 typedef union hammer_io_structure *hammer_io_structure_t;
510 * Allocation holes are recorded when an allocation does not fit within a
511 * buffer. Later allocations which might fit may then be satisfied from
512 * a recorded hole. The resv reference prevents the big block from being
513 * allocated out of via the normal blockmap mechanism.
515 * This is strictly a heuristic.
517 #define HAMMER_MAX_HOLES 8
521 struct hammer_holes {
522 TAILQ_HEAD(, hammer_hole) list;
526 typedef struct hammer_holes *hammer_holes_t;
529 TAILQ_ENTRY(hammer_hole) entry;
530 struct hammer_reserve *resv;
531 hammer_off_t zone_offset;
535 typedef struct hammer_hole *hammer_hole_t;
538 * The reserve structure prevents the blockmap from allocating
539 * out of a reserved bigblock. Such reservations are used by
540 * the direct-write mechanism.
542 * The structure is also used to hold off on reallocations of
543 * big blocks from the freemap until flush dependancies have
546 struct hammer_reserve {
547 RB_ENTRY(hammer_reserve) rb_node;
548 TAILQ_ENTRY(hammer_reserve) delay_entry;
551 hammer_off_t zone_offset;
554 typedef struct hammer_reserve *hammer_reserve_t;
556 #include "hammer_cursor.h"
559 * The undo structure tracks recent undos to avoid laying down duplicate
560 * undos within a flush group, saving us a significant amount of overhead.
562 * This is strictly a heuristic.
564 #define HAMMER_MAX_UNDOS 1024
565 #define HAMMER_MAX_FLUSHERS 4
568 RB_ENTRY(hammer_undo) rb_node;
569 TAILQ_ENTRY(hammer_undo) lru_entry;
574 typedef struct hammer_undo *hammer_undo_t;
576 struct hammer_flusher_info;
578 struct hammer_flusher {
579 int signal; /* flusher thread sequencer */
580 int act; /* currently active flush group */
581 int done; /* set to act when complete */
582 int next; /* next flush group */
583 int group_lock; /* lock sequencing of the next flush */
584 int exiting; /* request master exit */
585 int count; /* number of slave flushers */
586 int running; /* number of slave flushers running */
587 thread_t td; /* master flusher thread */
588 hammer_tid_t tid; /* last flushed transaction id */
589 int finalize_want; /* serialize finalization */
590 struct hammer_lock finalize_lock; /* serialize finalization */
591 struct hammer_transaction trans; /* shared transaction */
592 struct hammer_flusher_info *info[HAMMER_MAX_FLUSHERS];
596 * Internal hammer mount data structure
598 struct hammer_mount {
600 /*struct vnode *rootvp;*/
601 struct hammer_ino_rb_tree rb_inos_root;
602 struct hammer_vol_rb_tree rb_vols_root;
603 struct hammer_nod_rb_tree rb_nods_root;
604 struct hammer_und_rb_tree rb_undo_root;
605 struct hammer_res_rb_tree rb_resv_root;
606 struct hammer_buf_rb_tree rb_bufs_root;
607 struct hammer_volume *rootvol;
608 struct hammer_base_elm root_btree_beg;
609 struct hammer_base_elm root_btree_end;
610 char *zbuf; /* HAMMER_BUFSIZE bytes worth of all-zeros */
616 int rsv_inodes; /* reserved space due to dirty inodes */
617 int rsv_databufs; /* reserved space due to dirty buffers */
618 int rsv_databytes; /* reserved space due to record data */
619 int rsv_recs; /* reserved space due to dirty records */
621 int inode_reclaims; /* inodes pending reclaim by flusher */
622 int count_inodes; /* total number of inodes */
623 int count_iqueued; /* inodes queued to flusher */
625 struct hammer_flusher flusher;
627 u_int check_interrupt;
630 struct hammer_io_list volu_list; /* dirty undo buffers */
631 struct hammer_io_list undo_list; /* dirty undo buffers */
632 struct hammer_io_list data_list; /* dirty data buffers */
633 struct hammer_io_list alt_data_list; /* dirty data buffers */
634 struct hammer_io_list meta_list; /* dirty meta bufs */
635 struct hammer_io_list lose_list; /* loose buffers */
636 int locked_dirty_count; /* meta/volu count */
637 int io_running_count;
638 int objid_cache_count;
640 hammer_off_t next_tid;
641 int64_t copy_stat_freebigblocks; /* number of free bigblocks */
643 u_int32_t namekey_iterator;
644 hammer_off_t zone_limits[HAMMER_MAX_ZONES];
645 struct netexport export;
646 struct hammer_lock sync_lock;
647 struct hammer_lock free_lock;
648 struct lock blockmap_lock;
649 struct hammer_blockmap blockmap[HAMMER_MAX_ZONES];
650 struct hammer_holes holes[HAMMER_MAX_ZONES];
651 struct hammer_undo undos[HAMMER_MAX_UNDOS];
653 TAILQ_HEAD(, hammer_undo) undo_lru_list;
654 TAILQ_HEAD(, hammer_inode) flush_list;
655 TAILQ_HEAD(, hammer_reserve) delay_list;
656 TAILQ_HEAD(, hammer_objid_cache) objid_cache_list;
659 typedef struct hammer_mount *hammer_mount_t;
661 #define HAMMER_MOUNT_WAITIMAX 0x0001
663 struct hammer_sync_info {
672 extern struct vop_ops hammer_vnode_vops;
673 extern struct vop_ops hammer_spec_vops;
674 extern struct vop_ops hammer_fifo_vops;
675 extern struct bio_ops hammer_bioops;
677 extern int hammer_debug_io;
678 extern int hammer_debug_general;
679 extern int hammer_debug_debug;
680 extern int hammer_debug_inode;
681 extern int hammer_debug_locks;
682 extern int hammer_debug_btree;
683 extern int hammer_debug_tid;
684 extern int hammer_debug_recover;
685 extern int hammer_debug_recover_faults;
686 extern int hammer_debug_write_release;
687 extern int hammer_count_inodes;
688 extern int hammer_count_iqueued;
689 extern int hammer_count_reclaiming;
690 extern int hammer_count_records;
691 extern int hammer_count_record_datas;
692 extern int hammer_count_volumes;
693 extern int hammer_count_buffers;
694 extern int hammer_count_nodes;
695 extern int hammer_count_dirtybufs;
696 extern int hammer_count_reservations;
697 extern int hammer_limit_dirtybufs;
698 extern int hammer_limit_iqueued;
699 extern int hammer_limit_irecs;
700 extern int hammer_limit_recs;
701 extern int hammer_bio_count;
702 extern int hammer_stats_btree_iterations;
703 extern int hammer_stats_record_iterations;
704 extern int64_t hammer_contention_count;
706 int hammer_vop_inactive(struct vop_inactive_args *);
707 int hammer_vop_reclaim(struct vop_reclaim_args *);
708 int hammer_get_vnode(struct hammer_inode *ip, struct vnode **vpp);
709 struct hammer_inode *hammer_get_inode(hammer_transaction_t trans,
710 struct hammer_node **cache,
711 u_int64_t obj_id, hammer_tid_t asof, int flags,
713 void hammer_put_inode(struct hammer_inode *ip);
714 void hammer_put_inode_ref(struct hammer_inode *ip);
716 int hammer_unload_volume(hammer_volume_t volume, void *data __unused);
717 int hammer_adjust_volume_mode(hammer_volume_t volume, void *data __unused);
719 int hammer_unload_buffer(hammer_buffer_t buffer, void *data __unused);
720 int hammer_install_volume(hammer_mount_t hmp, const char *volname);
722 int hammer_ip_lookup(hammer_cursor_t cursor);
723 int hammer_ip_first(hammer_cursor_t cursor);
724 int hammer_ip_next(hammer_cursor_t cursor);
725 int hammer_ip_resolve_data(hammer_cursor_t cursor);
726 int hammer_ip_delete_record(hammer_cursor_t cursor, hammer_inode_t ip,
728 int hammer_delete_at_cursor(hammer_cursor_t cursor, int64_t *stat_bytes);
729 int hammer_ip_check_directory_empty(hammer_transaction_t trans,
731 int hammer_sync_hmp(hammer_mount_t hmp, int waitfor);
732 int hammer_queue_inodes_flusher(hammer_mount_t hmp, int waitfor);
736 hammer_alloc_mem_record(hammer_inode_t ip, int data_len);
737 void hammer_flush_record_done(hammer_record_t record, int error);
738 void hammer_wait_mem_record_ident(hammer_record_t record, const char *ident);
739 void hammer_rel_mem_record(hammer_record_t record);
741 int hammer_cursor_up(hammer_cursor_t cursor);
742 int hammer_cursor_up_locked(hammer_cursor_t cursor);
743 int hammer_cursor_down(hammer_cursor_t cursor);
744 int hammer_cursor_upgrade(hammer_cursor_t cursor);
745 void hammer_cursor_downgrade(hammer_cursor_t cursor);
746 int hammer_cursor_seek(hammer_cursor_t cursor, hammer_node_t node,
748 void hammer_lock_ex_ident(struct hammer_lock *lock, const char *ident);
749 int hammer_lock_ex_try(struct hammer_lock *lock);
750 void hammer_lock_sh(struct hammer_lock *lock);
751 int hammer_lock_sh_try(struct hammer_lock *lock);
752 int hammer_lock_upgrade(struct hammer_lock *lock);
753 void hammer_lock_downgrade(struct hammer_lock *lock);
754 void hammer_unlock(struct hammer_lock *lock);
755 void hammer_ref(struct hammer_lock *lock);
756 void hammer_unref(struct hammer_lock *lock);
758 void hammer_sync_lock_ex(hammer_transaction_t trans);
759 void hammer_sync_lock_sh(hammer_transaction_t trans);
760 int hammer_sync_lock_sh_try(hammer_transaction_t trans);
761 void hammer_sync_unlock(hammer_transaction_t trans);
763 u_int32_t hammer_to_unix_xid(uuid_t *uuid);
764 void hammer_guid_to_uuid(uuid_t *uuid, u_int32_t guid);
765 void hammer_to_timespec(hammer_tid_t tid, struct timespec *ts);
766 hammer_tid_t hammer_timespec_to_transid(struct timespec *ts);
767 hammer_tid_t hammer_now_tid(void);
768 hammer_tid_t hammer_str_to_tid(const char *str);
769 hammer_tid_t hammer_alloc_objid(hammer_transaction_t trans, hammer_inode_t dip);
770 void hammer_clear_objid(hammer_inode_t dip);
771 void hammer_destroy_objid_cache(hammer_mount_t hmp);
773 int hammer_enter_undo_history(hammer_mount_t hmp, hammer_off_t offset,
775 void hammer_clear_undo_history(hammer_mount_t hmp);
776 enum vtype hammer_get_vnode_type(u_int8_t obj_type);
777 int hammer_get_dtype(u_int8_t obj_type);
778 u_int8_t hammer_get_obj_type(enum vtype vtype);
779 int64_t hammer_directory_namekey(void *name, int len);
780 int hammer_nohistory(hammer_inode_t ip);
782 int hammer_init_cursor(hammer_transaction_t trans, hammer_cursor_t cursor,
783 struct hammer_node **cache, hammer_inode_t ip);
784 int hammer_reinit_cursor(hammer_cursor_t cursor);
785 void hammer_normalize_cursor(hammer_cursor_t cursor);
786 void hammer_done_cursor(hammer_cursor_t cursor);
787 void hammer_mem_done(hammer_cursor_t cursor);
789 int hammer_btree_lookup(hammer_cursor_t cursor);
790 int hammer_btree_first(hammer_cursor_t cursor);
791 int hammer_btree_last(hammer_cursor_t cursor);
792 int hammer_btree_extract(hammer_cursor_t cursor, int flags);
793 int hammer_btree_iterate(hammer_cursor_t cursor);
794 int hammer_btree_iterate_reverse(hammer_cursor_t cursor);
795 int hammer_btree_insert(hammer_cursor_t cursor,
796 hammer_btree_leaf_elm_t elm);
797 int hammer_btree_delete(hammer_cursor_t cursor);
798 int hammer_btree_cmp(hammer_base_elm_t key1, hammer_base_elm_t key2);
799 int hammer_btree_chkts(hammer_tid_t ts, hammer_base_elm_t key);
800 int hammer_btree_correct_rhb(hammer_cursor_t cursor, hammer_tid_t tid);
801 int hammer_btree_correct_lhb(hammer_cursor_t cursor, hammer_tid_t tid);
803 int btree_set_parent(hammer_transaction_t trans, hammer_node_t node,
804 hammer_btree_elm_t elm);
805 int hammer_btree_lock_children(hammer_cursor_t cursor,
806 struct hammer_node_locklist **locklistp);
807 void hammer_btree_unlock_children(struct hammer_node_locklist **locklistp);
810 void hammer_print_btree_node(hammer_node_ondisk_t ondisk);
811 void hammer_print_btree_elm(hammer_btree_elm_t elm, u_int8_t type, int i);
813 void *hammer_bread(struct hammer_mount *hmp, hammer_off_t off,
814 int *errorp, struct hammer_buffer **bufferp);
815 void *hammer_bnew(struct hammer_mount *hmp, hammer_off_t off,
816 int *errorp, struct hammer_buffer **bufferp);
818 hammer_volume_t hammer_get_root_volume(hammer_mount_t hmp, int *errorp);
820 hammer_volume_t hammer_get_volume(hammer_mount_t hmp,
821 int32_t vol_no, int *errorp);
822 hammer_buffer_t hammer_get_buffer(hammer_mount_t hmp,
823 hammer_off_t buf_offset, int isnew, int *errorp);
824 void hammer_del_buffers(hammer_mount_t hmp, hammer_off_t base_offset,
825 hammer_off_t zone2_offset, int bytes);
827 int hammer_ref_volume(hammer_volume_t volume);
828 int hammer_ref_buffer(hammer_buffer_t buffer);
829 void hammer_flush_buffer_nodes(hammer_buffer_t buffer);
831 void hammer_rel_volume(hammer_volume_t volume, int flush);
832 void hammer_rel_buffer(hammer_buffer_t buffer, int flush);
834 int hammer_vfs_export(struct mount *mp, int op,
835 const struct export_args *export);
836 hammer_node_t hammer_get_node(hammer_mount_t hmp, hammer_off_t node_offset,
837 int isnew, int *errorp);
838 void hammer_ref_node(hammer_node_t node);
839 hammer_node_t hammer_ref_node_safe(struct hammer_mount *hmp,
840 struct hammer_node **cache, int *errorp);
841 void hammer_rel_node(hammer_node_t node);
842 void hammer_delete_node(hammer_transaction_t trans,
844 void hammer_cache_node(hammer_node_t node,
845 struct hammer_node **cache);
846 void hammer_uncache_node(struct hammer_node **cache);
847 void hammer_flush_node(hammer_node_t node);
849 void hammer_dup_buffer(struct hammer_buffer **bufferp,
850 struct hammer_buffer *buffer);
851 hammer_node_t hammer_alloc_btree(hammer_transaction_t trans, int *errorp);
852 void *hammer_alloc_data(hammer_transaction_t trans, int32_t data_len,
853 hammer_off_t *data_offsetp,
854 struct hammer_buffer **data_bufferp, int *errorp);
856 int hammer_generate_undo(hammer_transaction_t trans, hammer_io_t io,
857 hammer_off_t zone1_offset, void *base, int len);
859 void hammer_put_volume(struct hammer_volume *volume, int flush);
860 void hammer_put_buffer(struct hammer_buffer *buffer, int flush);
862 hammer_off_t hammer_freemap_alloc(hammer_transaction_t trans,
863 hammer_off_t owner, int *errorp);
864 void hammer_freemap_free(hammer_transaction_t trans, hammer_off_t phys_offset,
865 hammer_off_t owner, int *errorp);
866 int hammer_checkspace(hammer_mount_t hmp);
867 hammer_off_t hammer_blockmap_alloc(hammer_transaction_t trans, int zone,
868 int bytes, int *errorp);
869 hammer_reserve_t hammer_blockmap_reserve(hammer_mount_t hmp, int zone,
870 int bytes, hammer_off_t *zone_offp, int *errorp);
871 void hammer_blockmap_reserve_complete(hammer_mount_t hmp,
872 hammer_reserve_t resv);
873 void hammer_blockmap_free(hammer_transaction_t trans,
874 hammer_off_t bmap_off, int bytes);
875 int hammer_blockmap_getfree(hammer_mount_t hmp, hammer_off_t bmap_off,
876 int *curp, int *errorp);
877 hammer_off_t hammer_blockmap_lookup(hammer_mount_t hmp, hammer_off_t bmap_off,
879 hammer_off_t hammer_undo_lookup(hammer_mount_t hmp, hammer_off_t bmap_off,
881 int64_t hammer_undo_used(hammer_mount_t hmp);
882 int64_t hammer_undo_space(hammer_mount_t hmp);
883 int64_t hammer_undo_max(hammer_mount_t hmp);
885 void hammer_start_transaction(struct hammer_transaction *trans,
886 struct hammer_mount *hmp);
887 void hammer_simple_transaction(struct hammer_transaction *trans,
888 struct hammer_mount *hmp);
889 void hammer_start_transaction_fls(struct hammer_transaction *trans,
890 struct hammer_mount *hmp);
891 void hammer_done_transaction(struct hammer_transaction *trans);
893 void hammer_modify_inode(hammer_inode_t ip, int flags);
894 void hammer_flush_inode(hammer_inode_t ip, int flags);
895 void hammer_flush_inode_done(hammer_inode_t ip);
896 void hammer_wait_inode(hammer_inode_t ip);
898 int hammer_create_inode(struct hammer_transaction *trans, struct vattr *vap,
899 struct ucred *cred, struct hammer_inode *dip,
900 struct hammer_inode **ipp);
901 void hammer_rel_inode(hammer_inode_t ip, int flush);
902 int hammer_reload_inode(hammer_inode_t ip, void *arg __unused);
903 int hammer_ino_rb_compare(hammer_inode_t ip1, hammer_inode_t ip2);
905 int hammer_sync_inode(hammer_inode_t ip);
906 void hammer_test_inode(hammer_inode_t ip);
907 void hammer_inode_unloadable_check(hammer_inode_t ip, int getvp);
908 void hammer_inode_waitreclaims(hammer_mount_t hmp);
910 int hammer_ip_add_directory(struct hammer_transaction *trans,
911 hammer_inode_t dip, struct namecache *ncp,
913 int hammer_ip_del_directory(struct hammer_transaction *trans,
914 hammer_cursor_t cursor, hammer_inode_t dip,
916 hammer_record_t hammer_ip_add_bulk(hammer_inode_t ip, off_t file_offset,
917 void *data, int bytes, int *errorp);
918 int hammer_ip_frontend_trunc(struct hammer_inode *ip, off_t file_size);
919 int hammer_ip_add_record(struct hammer_transaction *trans,
920 hammer_record_t record);
921 int hammer_ip_delete_range(hammer_cursor_t cursor, hammer_inode_t ip,
922 int64_t ran_beg, int64_t ran_end, int truncating);
923 int hammer_ip_delete_range_all(hammer_cursor_t cursor, hammer_inode_t ip,
925 int hammer_ip_sync_data(hammer_cursor_t cursor, hammer_inode_t ip,
926 int64_t offset, void *data, int bytes);
927 int hammer_ip_sync_record(hammer_transaction_t trans, hammer_record_t rec);
928 int hammer_ip_sync_record_cursor(hammer_cursor_t cursor, hammer_record_t rec);
930 int hammer_ioctl(hammer_inode_t ip, u_long com, caddr_t data, int fflag,
933 void hammer_io_init(hammer_io_t io, hammer_mount_t hmp,
934 enum hammer_io_type type);
935 int hammer_io_read(struct vnode *devvp, struct hammer_io *io,
937 int hammer_io_new(struct vnode *devvp, struct hammer_io *io);
938 void hammer_io_inval(hammer_volume_t volume, hammer_off_t zone2_offset);
939 void hammer_io_release(struct hammer_io *io, int flush);
940 void hammer_io_flush(struct hammer_io *io);
941 void hammer_io_waitdep(struct hammer_io *io);
942 void hammer_io_wait_all(hammer_mount_t hmp, const char *ident);
943 int hammer_io_direct_read(hammer_mount_t hmp, hammer_btree_leaf_elm_t leaf,
945 int hammer_io_direct_write(hammer_mount_t hmp, hammer_btree_leaf_elm_t leaf,
947 void hammer_io_write_interlock(hammer_io_t io);
948 void hammer_io_done_interlock(hammer_io_t io);
949 void hammer_io_clear_modify(struct hammer_io *io);
950 void hammer_io_clear_modlist(struct hammer_io *io);
951 void hammer_modify_volume(hammer_transaction_t trans, hammer_volume_t volume,
952 void *base, int len);
953 void hammer_modify_buffer(hammer_transaction_t trans, hammer_buffer_t buffer,
954 void *base, int len);
955 void hammer_modify_volume_done(hammer_volume_t volume);
956 void hammer_modify_buffer_done(hammer_buffer_t buffer);
958 int hammer_ioc_reblock(hammer_transaction_t trans, hammer_inode_t ip,
959 struct hammer_ioc_reblock *reblock);
960 int hammer_ioc_prune(hammer_transaction_t trans, hammer_inode_t ip,
961 struct hammer_ioc_prune *prune);
963 void hammer_init_holes(hammer_mount_t hmp, hammer_holes_t holes);
964 void hammer_free_holes(hammer_mount_t hmp, hammer_holes_t holes);
965 int hammer_signal_check(hammer_mount_t hmp);
967 void hammer_flusher_create(hammer_mount_t hmp);
968 void hammer_flusher_destroy(hammer_mount_t hmp);
969 void hammer_flusher_sync(hammer_mount_t hmp);
970 void hammer_flusher_async(hammer_mount_t hmp);
972 int hammer_recover(hammer_mount_t hmp, hammer_volume_t rootvol);
973 void hammer_recover_flush_buffers(hammer_mount_t hmp,
974 hammer_volume_t root_volume);
976 void hammer_crc_set_blockmap(hammer_blockmap_t blockmap);
977 void hammer_crc_set_volume(hammer_volume_ondisk_t ondisk);
979 int hammer_crc_test_blockmap(hammer_blockmap_t blockmap);
980 int hammer_crc_test_volume(hammer_volume_ondisk_t ondisk);
981 int hammer_crc_test_btree(hammer_node_ondisk_t ondisk);
982 void hkprintf(const char *ctl, ...);
987 hammer_wait_mem_record(hammer_record_t record)
989 hammer_wait_mem_record_ident(record, "hmmwai");
993 hammer_lock_ex(struct hammer_lock *lock)
995 hammer_lock_ex_ident(lock, "hmrlck");
999 hammer_modify_node_noundo(hammer_transaction_t trans, hammer_node_t node)
1001 hammer_modify_buffer(trans, node->buffer, NULL, 0);
1004 static __inline void
1005 hammer_modify_node_all(hammer_transaction_t trans, struct hammer_node *node)
1007 hammer_modify_buffer(trans, node->buffer,
1008 node->ondisk, sizeof(*node->ondisk));
1011 static __inline void
1012 hammer_modify_node(hammer_transaction_t trans, hammer_node_t node,
1013 void *base, int len)
1015 hammer_crc_t *crcptr;
1017 KKASSERT((char *)base >= (char *)node->ondisk &&
1018 (char *)base + len <=
1019 (char *)node->ondisk + sizeof(*node->ondisk));
1020 hammer_modify_buffer(trans, node->buffer, base, len);
1021 crcptr = &node->ondisk->crc;
1022 hammer_modify_buffer(trans, node->buffer, crcptr, sizeof(hammer_crc_t));
1023 --node->buffer->io.modify_refs; /* only want one ref */
1026 static __inline void
1027 hammer_modify_node_done(hammer_node_t node)
1029 node->ondisk->crc = crc32(&node->ondisk->crc + 1, HAMMER_BTREE_CRCSIZE);
1030 hammer_modify_buffer_done(node->buffer);
1033 #define hammer_modify_volume_field(trans, vol, field) \
1034 hammer_modify_volume(trans, vol, &(vol)->ondisk->field, \
1035 sizeof((vol)->ondisk->field))
1037 #define hammer_modify_node_field(trans, node, field) \
1038 hammer_modify_node(trans, node, &(node)->ondisk->field, \
1039 sizeof((node)->ondisk->field))