6785345f0aad3e5022d5d64159544579dcd07e6b
[dragonfly.git] / sys / vfs / hammer / hammer.h
1 /*
2  * Copyright (c) 2007-2008 The DragonFly Project.  All rights reserved.
3  * 
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  * 
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 
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
16  *    distribution.
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.
20  * 
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
32  * SUCH DAMAGE.
33  * 
34  * $DragonFly: src/sys/vfs/hammer/hammer.h,v 1.126 2008/08/02 21:21:28 dillon Exp $
35  */
36 /*
37  * This header file contains structures used internally by the HAMMERFS
38  * implementation.  See hammer_disk.h for on-disk structures.
39  */
40
41 #include <sys/param.h>
42 #include <sys/types.h>
43 #include <sys/kernel.h>
44 #include <sys/conf.h>
45 #include <sys/systm.h>
46 #include <sys/tree.h>
47 #include <sys/malloc.h>
48 #include <sys/mount.h>
49 #include <sys/mountctl.h>
50 #include <sys/vnode.h>
51 #include <sys/proc.h>
52 #include <sys/stat.h>
53 #include <sys/globaldata.h>
54 #include <sys/lockf.h>
55 #include <sys/buf.h>
56 #include <sys/queue.h>
57 #include <sys/ktr.h>
58 #include <sys/globaldata.h>
59
60 #include <sys/buf2.h>
61 #include <sys/signal2.h>
62 #include "hammer_disk.h"
63 #include "hammer_mount.h"
64 #include "hammer_ioctl.h"
65
66 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
67
68 MALLOC_DECLARE(M_HAMMER);
69 MALLOC_DECLARE(M_HAMMER_INO);
70
71 /*
72  * Kernel trace
73  */
74 #if !defined(KTR_HAMMER)
75 #define KTR_HAMMER      KTR_ALL
76 #endif
77 KTR_INFO_MASTER_EXTERN(hammer);
78
79 /*
80  * Misc structures
81  */
82 struct hammer_mount;
83
84 /*
85  * Key structure used for custom RB tree inode lookups.  This prototypes
86  * the function hammer_ino_rb_tree_RB_LOOKUP_INFO(root, info).
87  */
88 typedef struct hammer_inode_info {
89         int64_t         obj_id;         /* (key) object identifier */
90         hammer_tid_t    obj_asof;       /* (key) snapshot transid or 0 */
91         u_int32_t       obj_localization; /* (key) pseudo-fs */
92         union {
93                 struct hammer_btree_leaf_elm *leaf;
94         } u;
95 } *hammer_inode_info_t;
96
97 typedef enum hammer_transaction_type {
98         HAMMER_TRANS_RO,
99         HAMMER_TRANS_STD,
100         HAMMER_TRANS_FLS
101 } hammer_transaction_type_t;
102
103 /*
104  * HAMMER Transaction tracking
105  */
106 struct hammer_transaction {
107         hammer_transaction_type_t type;
108         struct hammer_mount *hmp;
109         hammer_tid_t    tid;
110         u_int64_t       time;
111         u_int32_t       time32;
112         int             sync_lock_refs;
113         struct hammer_volume *rootvol;
114 };
115
116 typedef struct hammer_transaction *hammer_transaction_t;
117
118 /*
119  * HAMMER locks
120  */
121 struct hammer_lock {
122         int     refs;           /* active references delay writes */
123         int     lockcount;      /* lock count for exclusive/shared access */
124         int     wanted;
125         int     exwanted;       /* number of threads waiting for ex lock */
126         struct thread *locktd;
127 };
128
129 static __inline int
130 hammer_islocked(struct hammer_lock *lock)
131 {
132         return(lock->lockcount != 0);
133 }
134
135 static __inline int
136 hammer_isactive(struct hammer_lock *lock)
137 {
138         return(lock->refs != 0);
139 }
140
141 static __inline int
142 hammer_islastref(struct hammer_lock *lock)
143 {
144         return(lock->refs == 1);
145 }
146
147 /*
148  * Return if we specifically own the lock exclusively.
149  */
150 static __inline int
151 hammer_lock_excl_owned(struct hammer_lock *lock, thread_t td)
152 {
153         if (lock->lockcount > 0 && lock->locktd == td)
154                 return(1);
155         return(0);
156 }
157
158 /*
159  * Flush state, used by various structures
160  */
161 typedef enum hammer_inode_state {
162         HAMMER_FST_IDLE,
163         HAMMER_FST_SETUP,
164         HAMMER_FST_FLUSH
165 } hammer_inode_state_t;
166
167 TAILQ_HEAD(hammer_record_list, hammer_record);
168
169 /*
170  * Pseudo-filesystem extended data tracking
171  */
172 struct hammer_pfs_rb_tree;
173 struct hammer_pseudofs_inmem;
174 RB_HEAD(hammer_pfs_rb_tree, hammer_pseudofs_inmem);
175 RB_PROTOTYPE2(hammer_pfs_rb_tree, hammer_pseudofs_inmem, rb_node,
176               hammer_pfs_rb_compare, u_int32_t);
177
178 struct hammer_pseudofs_inmem {
179         RB_ENTRY(hammer_pseudofs_inmem) rb_node;
180         struct hammer_lock      lock;
181         u_int32_t               localization;
182         hammer_tid_t            create_tid;
183         int                     flags;
184         udev_t                  fsid_udev;
185         struct hammer_pseudofs_data pfsd;
186 };
187
188 typedef struct hammer_pseudofs_inmem *hammer_pseudofs_inmem_t;
189
190 #define HAMMER_PFSM_DELETED     0x0001
191
192 /*
193  * Cache object ids.  A fixed number of objid cache structures are
194  * created to reserve object id's for newly created files in multiples
195  * of 100,000, localized to a particular directory, and recycled as
196  * needed.  This allows parallel create operations in different
197  * directories to retain fairly localized object ids which in turn
198  * improves reblocking performance and layout.
199  */
200 #define OBJID_CACHE_SIZE        1024
201 #define OBJID_CACHE_BULK        100000
202
203 typedef struct hammer_objid_cache {
204         TAILQ_ENTRY(hammer_objid_cache) entry;
205         struct hammer_inode             *dip;
206         hammer_tid_t                    next_tid;
207         int                             count;
208 } *hammer_objid_cache_t;
209
210 /*
211  * Associate an inode with a B-Tree node to cache search start positions
212  */
213 typedef struct hammer_node_cache {
214         TAILQ_ENTRY(hammer_node_cache)  entry;
215         struct hammer_node              *node;
216         struct hammer_inode             *ip;
217 } *hammer_node_cache_t;
218
219 TAILQ_HEAD(hammer_node_cache_list, hammer_node_cache);
220
221 /*
222  * Structure used to organize flush groups.  Flush groups must be
223  * organized into chunks in order to avoid blowing out the UNDO FIFO.
224  * Without this a 'sync' could end up flushing 50,000 inodes in a single
225  * transaction.
226  */
227 struct hammer_flush_group {
228         TAILQ_ENTRY(hammer_flush_group) flush_entry;
229         TAILQ_HEAD(, hammer_inode)      flush_list;
230         int                             inode_count;    /* inode load */
231         int                             total_count;    /* record load */
232         int                             running;        /* group is running */
233         int                             closed;
234         int                             refs;
235 };
236
237 typedef struct hammer_flush_group *hammer_flush_group_t;
238
239 TAILQ_HEAD(hammer_flush_group_list, hammer_flush_group);
240
241 /*
242  * Structure used to represent an inode in-memory.
243  *
244  * The record and data associated with an inode may be out of sync with
245  * the disk (xDIRTY flags), or not even on the disk at all (ONDISK flag
246  * clear).
247  *
248  * An inode may also hold a cache of unsynchronized records, used for
249  * database and directories only.  Unsynchronized regular file data is
250  * stored in the buffer cache.
251  *
252  * NOTE: A file which is created and destroyed within the initial
253  * synchronization period can wind up not doing any disk I/O at all.
254  *
255  * Finally, an inode may cache numerous disk-referencing B-Tree cursors.
256  */
257 struct hammer_ino_rb_tree;
258 struct hammer_inode;
259 RB_HEAD(hammer_ino_rb_tree, hammer_inode);
260 RB_PROTOTYPEX(hammer_ino_rb_tree, INFO, hammer_inode, rb_node,
261               hammer_ino_rb_compare, hammer_inode_info_t);
262
263 struct hammer_rec_rb_tree;
264 struct hammer_record;
265 RB_HEAD(hammer_rec_rb_tree, hammer_record);
266 RB_PROTOTYPEX(hammer_rec_rb_tree, INFO, hammer_record, rb_node,
267               hammer_rec_rb_compare, hammer_btree_leaf_elm_t);
268
269 TAILQ_HEAD(hammer_node_list, hammer_node);
270
271 struct hammer_inode {
272         RB_ENTRY(hammer_inode)  rb_node;
273         hammer_inode_state_t    flush_state;
274         hammer_flush_group_t    flush_group;
275         TAILQ_ENTRY(hammer_inode) flush_entry;
276         struct hammer_record_list target_list;  /* target of dependant recs */
277         int64_t                 obj_id;         /* (key) object identifier */
278         hammer_tid_t            obj_asof;       /* (key) snapshot or 0 */
279         u_int32_t               obj_localization; /* (key) pseudo-fs */
280         struct hammer_mount     *hmp;
281         hammer_objid_cache_t    objid_cache;
282         int                     flags;
283         int                     error;          /* flush error */
284         int                     cursor_ip_refs; /* sanity */
285         int                     rsv_recs;
286         struct vnode            *vp;
287         hammer_pseudofs_inmem_t pfsm;
288         struct lockf            advlock;
289         struct hammer_lock      lock;           /* sync copy interlock */
290         off_t                   trunc_off;
291         struct hammer_btree_leaf_elm ino_leaf;  /* in-memory cache */
292         struct hammer_inode_data ino_data;      /* in-memory cache */
293         struct hammer_rec_rb_tree rec_tree;     /* in-memory cache */
294         struct hammer_node_cache cache[2];      /* search initiate cache */
295
296         /*
297          * When a demark is created to synchronize an inode to
298          * disk, certain fields are copied so the front-end VOPs
299          * can continue to run in parallel with the synchronization
300          * occuring in the background.
301          */
302         int             sync_flags;             /* to-sync flags cache */
303         off_t           sync_trunc_off;         /* to-sync truncation */
304         off_t           save_trunc_off;         /* write optimization */
305         struct hammer_btree_leaf_elm sync_ino_leaf; /* to-sync cache */
306         struct hammer_inode_data sync_ino_data; /* to-sync cache */
307 };
308
309 typedef struct hammer_inode *hammer_inode_t;
310
311 #define VTOI(vp)        ((struct hammer_inode *)(vp)->v_data)
312
313 #define HAMMER_INODE_DDIRTY     0x0001  /* in-memory ino_data is dirty */
314                                         /* (not including atime/mtime) */
315 #define HAMMER_INODE_RSV_INODES 0x0002  /* hmp->rsv_inodes bumped */
316 #define HAMMER_INODE_CONN_DOWN  0x0004  /* include in downward recursion */
317 #define HAMMER_INODE_XDIRTY     0x0008  /* in-memory records */
318 #define HAMMER_INODE_ONDISK     0x0010  /* inode is on-disk (else not yet) */
319 #define HAMMER_INODE_FLUSH      0x0020  /* flush on last ref */
320 #define HAMMER_INODE_DELETED    0x0080  /* inode delete (backend) */
321 #define HAMMER_INODE_DELONDISK  0x0100  /* delete synchronized to disk */
322 #define HAMMER_INODE_RO         0x0200  /* read-only (because of as-of) */
323 #define HAMMER_INODE_VHELD      0x0400  /* vnode held on sync */
324 #define HAMMER_INODE_DONDISK    0x0800  /* data records may be on disk */
325 #define HAMMER_INODE_BUFS       0x1000  /* dirty high level bps present */
326 #define HAMMER_INODE_REFLUSH    0x2000  /* flush on dependancy / reflush */
327 #define HAMMER_INODE_RECLAIM    0x4000  /* trying to reclaim */
328 #define HAMMER_INODE_FLUSHW     0x8000  /* Someone waiting for flush */
329
330 #define HAMMER_INODE_TRUNCATED  0x00010000
331 #define HAMMER_INODE_DELETING   0x00020000 /* inode delete request (frontend)*/
332 #define HAMMER_INODE_RESIGNAL   0x00040000 /* re-signal on re-flush */
333 #define HAMMER_INODE_ATIME      0x00100000 /* in-memory atime modified */
334 #define HAMMER_INODE_MTIME      0x00200000 /* in-memory mtime modified */
335 #define HAMMER_INODE_WOULDBLOCK 0x00400000 /* re-issue to new flush group */
336
337 #define HAMMER_INODE_MODMASK    (HAMMER_INODE_DDIRTY|                       \
338                                  HAMMER_INODE_XDIRTY|HAMMER_INODE_BUFS|     \
339                                  HAMMER_INODE_ATIME|HAMMER_INODE_MTIME|     \
340                                  HAMMER_INODE_TRUNCATED|HAMMER_INODE_DELETING)
341
342 #define HAMMER_INODE_MODMASK_NOXDIRTY \
343                                 (HAMMER_INODE_MODMASK & ~HAMMER_INODE_XDIRTY)
344
345 #define HAMMER_FLUSH_GROUP_SIZE 64
346
347 #define HAMMER_FLUSH_SIGNAL     0x0001
348 #define HAMMER_FLUSH_RECURSION  0x0002
349
350 /*
351  * Used by the inode reclaim code to pipeline reclaims and avoid
352  * blowing out kernel memory or letting the flusher get too far
353  * behind.
354  */
355 struct hammer_reclaim {
356         TAILQ_ENTRY(hammer_reclaim) entry;
357         int     okydoky;
358 };
359
360 #define HAMMER_RECLAIM_FLUSH    2000
361 #define HAMMER_RECLAIM_WAIT     4000
362
363 /*
364  * Structure used to represent an unsynchronized record in-memory.  These
365  * records typically represent directory entries.  Only non-historical
366  * records are kept in-memory.
367  *
368  * Records are organized as a per-inode RB-Tree.  If the inode is not
369  * on disk then neither are any records and the in-memory record tree
370  * represents the entire contents of the inode.  If the inode is on disk
371  * then the on-disk B-Tree is scanned in parallel with the in-memory
372  * RB-Tree to synthesize the current state of the file.
373  *
374  * Records are also used to enforce the ordering of directory create/delete
375  * operations.  A new inode will not be flushed to disk unless its related
376  * directory entry is also being flushed at the same time.  A directory entry
377  * will not be removed unless its related inode is also being removed at the
378  * same time.
379  */
380 typedef enum hammer_record_type {
381         HAMMER_MEM_RECORD_GENERAL,      /* misc record */
382         HAMMER_MEM_RECORD_INODE,        /* inode record */
383         HAMMER_MEM_RECORD_ADD,          /* positive memory cache record */
384         HAMMER_MEM_RECORD_DEL,          /* negative delete-on-disk record */
385         HAMMER_MEM_RECORD_DATA          /* bulk-data record w/on-disk ref */
386 } hammer_record_type_t;
387
388 struct hammer_record {
389         RB_ENTRY(hammer_record)         rb_node;
390         TAILQ_ENTRY(hammer_record)      target_entry;
391         hammer_inode_state_t            flush_state;
392         hammer_flush_group_t            flush_group;
393         hammer_record_type_t            type;
394         struct hammer_lock              lock;
395         struct hammer_reserve           *resv;
396         struct hammer_inode             *ip;
397         struct hammer_inode             *target_ip;
398         struct hammer_btree_leaf_elm    leaf;
399         union hammer_data_ondisk        *data;
400         int                             flags;
401         hammer_off_t                    zone2_offset;   /* direct-write only */
402 };
403
404 typedef struct hammer_record *hammer_record_t;
405
406 /*
407  * Record flags.  Note that FE can only be set by the frontend if the
408  * record has not been interlocked by the backend w/ BE.
409  */
410 #define HAMMER_RECF_ALLOCDATA           0x0001
411 #define HAMMER_RECF_ONRBTREE            0x0002
412 #define HAMMER_RECF_DELETED_FE          0x0004  /* deleted (frontend) */
413 #define HAMMER_RECF_DELETED_BE          0x0008  /* deleted (backend) */
414 #define HAMMER_RECF_COMMITTED           0x0010  /* committed to the B-Tree */
415 #define HAMMER_RECF_INTERLOCK_BE        0x0020  /* backend interlock */
416 #define HAMMER_RECF_WANTED              0x0040  /* wanted by the frontend */
417 #define HAMMER_RECF_CONVERT_DELETE      0x0100  /* special case */
418 #define HAMMER_RECF_DIRECT_IO           0x0200  /* related direct I/O running*/
419 #define HAMMER_RECF_DIRECT_WAIT         0x0400  /* related direct I/O running*/
420 #define HAMMER_RECF_DIRECT_INVAL        0x0800  /* buffer alias invalidation */
421
422 /*
423  * hammer_delete_at_cursor() flags
424  */
425 #define HAMMER_DELETE_ADJUST            0x0001
426 #define HAMMER_DELETE_DESTROY           0x0002
427
428 /*
429  * In-memory structures representing on-disk structures.
430  */
431 struct hammer_volume;
432 struct hammer_buffer;
433 struct hammer_node;
434 struct hammer_undo;
435 struct hammer_reserve;
436
437 RB_HEAD(hammer_vol_rb_tree, hammer_volume);
438 RB_HEAD(hammer_buf_rb_tree, hammer_buffer);
439 RB_HEAD(hammer_nod_rb_tree, hammer_node);
440 RB_HEAD(hammer_und_rb_tree, hammer_undo);
441 RB_HEAD(hammer_res_rb_tree, hammer_reserve);
442
443 RB_PROTOTYPE2(hammer_vol_rb_tree, hammer_volume, rb_node,
444               hammer_vol_rb_compare, int32_t);
445 RB_PROTOTYPE2(hammer_buf_rb_tree, hammer_buffer, rb_node,
446               hammer_buf_rb_compare, hammer_off_t);
447 RB_PROTOTYPE2(hammer_nod_rb_tree, hammer_node, rb_node,
448               hammer_nod_rb_compare, hammer_off_t);
449 RB_PROTOTYPE2(hammer_und_rb_tree, hammer_undo, rb_node,
450               hammer_und_rb_compare, hammer_off_t);
451 RB_PROTOTYPE2(hammer_res_rb_tree, hammer_reserve, rb_node,
452               hammer_res_rb_compare, hammer_off_t);
453
454 /*
455  * IO management - embedded at the head of various in-memory structures
456  *
457  * VOLUME       - hammer_volume containing meta-data
458  * META_BUFFER  - hammer_buffer containing meta-data
459  * DATA_BUFFER  - hammer_buffer containing pure-data
460  *
461  * Dirty volume headers and dirty meta-data buffers are locked until the
462  * flusher can sequence them out.  Dirty pure-data buffers can be written.
463  * Clean buffers can be passively released.
464  */
465 typedef enum hammer_io_type {
466         HAMMER_STRUCTURE_VOLUME,
467         HAMMER_STRUCTURE_META_BUFFER,
468         HAMMER_STRUCTURE_UNDO_BUFFER,
469         HAMMER_STRUCTURE_DATA_BUFFER
470 } hammer_io_type_t;
471
472 union hammer_io_structure;
473 struct hammer_io;
474
475 struct worklist {
476         LIST_ENTRY(worklist) node;
477 };
478
479 TAILQ_HEAD(hammer_io_list, hammer_io);
480 typedef struct hammer_io_list *hammer_io_list_t;
481
482 struct hammer_io {
483         struct worklist         worklist;
484         struct hammer_lock      lock;
485         enum hammer_io_type     type;
486         struct hammer_mount     *hmp;
487         TAILQ_ENTRY(hammer_io)  mod_entry; /* list entry if modified */
488         hammer_io_list_t        mod_list;
489         struct buf              *bp;
490         int64_t                 offset;    /* zone-2 offset */
491         int                     bytes;     /* buffer cache buffer size */
492         int                     loading;   /* loading/unloading interlock */
493         int                     modify_refs;
494
495         u_int           modified : 1;   /* bp's data was modified */
496         u_int           released : 1;   /* bp released (w/ B_LOCKED set) */
497         u_int           running : 1;    /* bp write IO in progress */
498         u_int           waiting : 1;    /* someone is waiting on us */
499         u_int           validated : 1;  /* ondisk has been validated */
500         u_int           waitdep : 1;    /* flush waits for dependancies */
501         u_int           recovered : 1;  /* has recovery ref */
502         u_int           waitmod : 1;    /* waiting for modify_refs */
503         u_int           reclaim : 1;    /* reclaim requested */
504         u_int           gencrc : 1;     /* crc needs to be generated */
505         u_int           ioerror : 1;    /* abort on io-error */
506 };
507
508 typedef struct hammer_io *hammer_io_t;
509
510 #define HAMMER_CLUSTER_SIZE     (64 * 1024)
511 #if HAMMER_CLUSTER_SIZE > MAXBSIZE
512 #undef  HAMMER_CLUSTER_SIZE
513 #define HAMMER_CLUSTER_SIZE     MAXBSIZE
514 #endif
515 #define HAMMER_CLUSTER_BUFS     (HAMMER_CLUSTER_SIZE / HAMMER_BUFSIZE)
516
517 /*
518  * In-memory volume representing on-disk buffer
519  */
520 struct hammer_volume {
521         struct hammer_io io;
522         RB_ENTRY(hammer_volume) rb_node;
523         struct hammer_volume_ondisk *ondisk;
524         int32_t vol_no;
525         int64_t nblocks;        /* note: special calculation for statfs */
526         int64_t buffer_base;    /* base offset of buffer 0 */
527         hammer_off_t maxbuf_off; /* Maximum buffer offset (zone-2) */
528         hammer_off_t maxraw_off; /* Maximum raw offset for device */
529         char    *vol_name;
530         struct vnode *devvp;
531         int     vol_flags;
532 };
533
534 typedef struct hammer_volume *hammer_volume_t;
535
536 /*
537  * In-memory buffer (other then volume, super-cluster, or cluster),
538  * representing an on-disk buffer.
539  */
540 struct hammer_buffer {
541         struct hammer_io io;
542         RB_ENTRY(hammer_buffer) rb_node;
543         void *ondisk;
544         struct hammer_volume *volume;
545         hammer_off_t zoneX_offset;
546         hammer_off_t zone2_offset;
547         struct hammer_reserve *resv;
548         struct hammer_node_list clist;
549 };
550
551 typedef struct hammer_buffer *hammer_buffer_t;
552
553 /*
554  * In-memory B-Tree node, representing an on-disk B-Tree node.
555  *
556  * This is a hang-on structure which is backed by a hammer_buffer,
557  * indexed by a hammer_cluster, and used for fine-grained locking of
558  * B-Tree nodes in order to properly control lock ordering.  A hammer_buffer
559  * can contain multiple nodes representing wildly disassociated portions
560  * of the B-Tree so locking cannot be done on a buffer-by-buffer basis.
561  *
562  * This structure uses a cluster-relative index to reduce the number
563  * of layers required to access it, and also because all on-disk B-Tree
564  * references are cluster-relative offsets.
565  */
566 struct hammer_node {
567         struct hammer_lock      lock;           /* node-by-node lock */
568         TAILQ_ENTRY(hammer_node) entry;         /* per-buffer linkage */
569         RB_ENTRY(hammer_node)   rb_node;        /* per-cluster linkage */
570         hammer_off_t            node_offset;    /* full offset spec */
571         struct hammer_mount     *hmp;
572         struct hammer_buffer    *buffer;        /* backing buffer */
573         hammer_node_ondisk_t    ondisk;         /* ptr to on-disk structure */
574         TAILQ_HEAD(, hammer_cursor) cursor_list;  /* deadlock recovery */
575         struct hammer_node_cache_list cache_list; /* passive caches */
576         int                     flags;
577         int                     loading;        /* load interlock */
578 };
579
580 #define HAMMER_NODE_DELETED     0x0001
581 #define HAMMER_NODE_FLUSH       0x0002
582 #define HAMMER_NODE_CRCGOOD     0x0004
583 #define HAMMER_NODE_NEEDSCRC    0x0008
584 #define HAMMER_NODE_NEEDSMIRROR 0x0010
585
586 typedef struct hammer_node      *hammer_node_t;
587
588 /*
589  * List of locked nodes.
590  */
591 struct hammer_node_locklist {
592         struct hammer_node_locklist *next;
593         hammer_node_t   node;
594 };
595
596 typedef struct hammer_node_locklist *hammer_node_locklist_t;
597
598
599 /*
600  * Common I/O management structure - embedded in in-memory structures
601  * which are backed by filesystem buffers.
602  */
603 union hammer_io_structure {
604         struct hammer_io        io;
605         struct hammer_volume    volume;
606         struct hammer_buffer    buffer;
607 };
608
609 typedef union hammer_io_structure *hammer_io_structure_t;
610
611 /*
612  * The reserve structure prevents the blockmap from allocating
613  * out of a reserved bigblock.  Such reservations are used by
614  * the direct-write mechanism.
615  *
616  * The structure is also used to hold off on reallocations of
617  * big blocks from the freemap until flush dependancies have
618  * been dealt with.
619  */
620 struct hammer_reserve {
621         RB_ENTRY(hammer_reserve) rb_node;
622         TAILQ_ENTRY(hammer_reserve) delay_entry;
623         int             flush_group;
624         int             flags;
625         int             refs;
626         int             zone;
627         int             bytes_freed;
628         int             append_off;
629         hammer_off_t    zone_offset;
630 };
631
632 typedef struct hammer_reserve *hammer_reserve_t;
633
634 #define HAMMER_RESF_ONDELAY     0x0001
635
636 #include "hammer_cursor.h"
637
638 /*
639  * The undo structure tracks recent undos to avoid laying down duplicate
640  * undos within a flush group, saving us a significant amount of overhead.
641  *
642  * This is strictly a heuristic.
643  */
644 #define HAMMER_MAX_UNDOS                1024
645 #define HAMMER_MAX_FLUSHERS             4
646
647 struct hammer_undo {
648         RB_ENTRY(hammer_undo)   rb_node;
649         TAILQ_ENTRY(hammer_undo) lru_entry;
650         hammer_off_t            offset;
651         int                     bytes;
652 };
653
654 typedef struct hammer_undo *hammer_undo_t;
655
656 struct hammer_flusher_info;
657 TAILQ_HEAD(hammer_flusher_info_list, hammer_flusher_info);
658
659 struct hammer_flusher {
660         int             signal;         /* flusher thread sequencer */
661         int             act;            /* currently active flush group */
662         int             done;           /* set to act when complete */
663         int             next;           /* next flush group */
664         int             group_lock;     /* lock sequencing of the next flush */
665         int             exiting;        /* request master exit */
666         thread_t        td;             /* master flusher thread */
667         hammer_tid_t    tid;            /* last flushed transaction id */
668         int             finalize_want;          /* serialize finalization */
669         struct hammer_lock finalize_lock;       /* serialize finalization */
670         struct hammer_transaction trans;        /* shared transaction */
671         struct hammer_flusher_info_list run_list;
672         struct hammer_flusher_info_list ready_list;
673 };
674
675 /*
676  * Internal hammer mount data structure
677  */
678 struct hammer_mount {
679         struct mount *mp;
680         /*struct vnode *rootvp;*/
681         struct hammer_ino_rb_tree rb_inos_root;
682         struct hammer_vol_rb_tree rb_vols_root;
683         struct hammer_nod_rb_tree rb_nods_root;
684         struct hammer_und_rb_tree rb_undo_root;
685         struct hammer_res_rb_tree rb_resv_root;
686         struct hammer_buf_rb_tree rb_bufs_root;
687         struct hammer_pfs_rb_tree rb_pfsm_root;
688         struct hammer_volume *rootvol;
689         struct hammer_base_elm root_btree_beg;
690         struct hammer_base_elm root_btree_end;
691         int     flags;          /* HAMMER_MOUNT_xxx flags */
692         int     hflags;
693         int     ronly;
694         int     nvolumes;
695         int     volume_iterator;
696         int     master_id;      /* -1 or 0-15 - clustering and mirroring */
697         int     rsv_inodes;     /* reserved space due to dirty inodes */
698         int64_t rsv_databytes;  /* reserved space due to record data */
699         int     rsv_recs;       /* reserved space due to dirty records */
700         int     rsv_fromdelay;  /* bigblocks reserved due to flush delay */
701         int     undo_rec_limit; /* based on size of undo area */
702         int     last_newrecords;
703         int     count_newrecords;
704
705         int     inode_reclaims; /* inodes pending reclaim by flusher */
706         int     count_inodes;   /* total number of inodes */
707         int     count_iqueued;  /* inodes queued to flusher */
708
709         struct hammer_flusher flusher;
710
711         u_int   check_interrupt;
712         uuid_t  fsid;
713         struct hammer_io_list volu_list;        /* dirty undo buffers */
714         struct hammer_io_list undo_list;        /* dirty undo buffers */
715         struct hammer_io_list data_list;        /* dirty data buffers */
716         struct hammer_io_list alt_data_list;    /* dirty data buffers */
717         struct hammer_io_list meta_list;        /* dirty meta bufs    */
718         struct hammer_io_list lose_list;        /* loose buffers      */
719         int     locked_dirty_space;             /* meta/volu count    */
720         int     io_running_space;
721         int     objid_cache_count;
722         int     error;                          /* critical I/O error */
723         struct krate    krate;                  /* rate limited kprintf */
724         hammer_tid_t    asof;                   /* snapshot mount */
725         hammer_tid_t    next_tid;
726         hammer_tid_t    flush_tid1;             /* flusher tid sequencing */
727         hammer_tid_t    flush_tid2;             /* flusher tid sequencing */
728         int64_t copy_stat_freebigblocks;        /* number of free bigblocks */
729
730         u_int32_t namekey_iterator;
731         struct netexport export;
732         struct hammer_lock sync_lock;
733         struct hammer_lock free_lock;
734         struct hammer_lock undo_lock;
735         struct hammer_lock blkmap_lock;
736         struct hammer_blockmap  blockmap[HAMMER_MAX_ZONES];
737         struct hammer_undo      undos[HAMMER_MAX_UNDOS];
738         int                     undo_alloc;
739         TAILQ_HEAD(, hammer_undo)  undo_lru_list;
740         TAILQ_HEAD(, hammer_reserve) delay_list;
741         struct hammer_flush_group_list  flush_group_list;
742         hammer_flush_group_t    next_flush_group;
743         TAILQ_HEAD(, hammer_objid_cache) objid_cache_list;
744         TAILQ_HEAD(, hammer_reclaim) reclaim_list;
745 };
746
747 typedef struct hammer_mount     *hammer_mount_t;
748
749 #define HAMMER_MOUNT_CRITICAL_ERROR     0x0001
750
751 struct hammer_sync_info {
752         int error;
753         int waitfor;
754 };
755
756 #endif
757
758 /*
759  * checkspace slop (8MB chunks), higher numbers are more conservative.
760  */
761 #define HAMMER_CHKSPC_REBLOCK   25
762 #define HAMMER_CHKSPC_MIRROR    20
763 #define HAMMER_CHKSPC_WRITE     20
764 #define HAMMER_CHKSPC_CREATE    20
765 #define HAMMER_CHKSPC_REMOVE    10
766 #define HAMMER_CHKSPC_EMERGENCY 0
767
768 #if defined(_KERNEL)
769
770 extern struct vop_ops hammer_vnode_vops;
771 extern struct vop_ops hammer_spec_vops;
772 extern struct vop_ops hammer_fifo_vops;
773 extern struct bio_ops hammer_bioops;
774
775 extern int hammer_debug_io;
776 extern int hammer_debug_general;
777 extern int hammer_debug_debug;
778 extern int hammer_debug_inode;
779 extern int hammer_debug_locks;
780 extern int hammer_debug_btree;
781 extern int hammer_debug_tid;
782 extern int hammer_debug_recover;
783 extern int hammer_debug_recover_faults;
784 extern int hammer_cluster_enable;
785 extern int hammer_count_fsyncs;
786 extern int hammer_count_inodes;
787 extern int hammer_count_iqueued;
788 extern int hammer_count_reclaiming;
789 extern int hammer_count_records;
790 extern int hammer_count_record_datas;
791 extern int hammer_count_volumes;
792 extern int hammer_count_buffers;
793 extern int hammer_count_nodes;
794 extern int64_t hammer_count_extra_space_used;
795 extern int64_t hammer_stats_btree_lookups;
796 extern int64_t hammer_stats_btree_searches;
797 extern int64_t hammer_stats_btree_inserts;
798 extern int64_t hammer_stats_btree_deletes;
799 extern int64_t hammer_stats_btree_elements;
800 extern int64_t hammer_stats_btree_splits;
801 extern int64_t hammer_stats_btree_iterations;
802 extern int64_t hammer_stats_record_iterations;
803 extern int64_t hammer_stats_file_read;
804 extern int64_t hammer_stats_file_write;
805 extern int64_t hammer_stats_file_iopsr;
806 extern int64_t hammer_stats_file_iopsw;
807 extern int64_t hammer_stats_disk_read;
808 extern int64_t hammer_stats_disk_write;
809 extern int64_t hammer_stats_inode_flushes;
810 extern int64_t hammer_stats_commits;
811 extern int hammer_count_dirtybufspace;
812 extern int hammer_count_refedbufs;
813 extern int hammer_count_reservations;
814 extern int hammer_count_io_running_read;
815 extern int hammer_count_io_running_write;
816 extern int hammer_count_io_locked;
817 extern int hammer_limit_dirtybufspace;
818 extern int hammer_limit_iqueued;
819 extern int hammer_limit_recs;
820 extern int hammer_bio_count;
821 extern int hammer_verify_zone;
822 extern int hammer_verify_data;
823 extern int hammer_write_mode;
824 extern int64_t hammer_contention_count;
825
826 void    hammer_critical_error(hammer_mount_t hmp, hammer_inode_t ip,
827                         int error, const char *msg);
828 int     hammer_vop_inactive(struct vop_inactive_args *);
829 int     hammer_vop_reclaim(struct vop_reclaim_args *);
830 int     hammer_get_vnode(struct hammer_inode *ip, struct vnode **vpp);
831 struct hammer_inode *hammer_get_inode(hammer_transaction_t trans,
832                         hammer_inode_t dip, int64_t obj_id,
833                         hammer_tid_t asof, u_int32_t localization,
834                         int flags, int *errorp);
835 void    hammer_scan_inode_snapshots(hammer_mount_t hmp,
836                         hammer_inode_info_t iinfo,
837                         int (*callback)(hammer_inode_t ip, void *data),
838                         void *data);
839 void    hammer_put_inode(struct hammer_inode *ip);
840 void    hammer_put_inode_ref(struct hammer_inode *ip);
841 void    hammer_inode_waitreclaims(hammer_mount_t hmp);
842
843 int     hammer_unload_volume(hammer_volume_t volume, void *data __unused);
844 int     hammer_adjust_volume_mode(hammer_volume_t volume, void *data __unused);
845
846 int     hammer_unload_buffer(hammer_buffer_t buffer, void *data __unused);
847 int     hammer_install_volume(hammer_mount_t hmp, const char *volname,
848                         struct vnode *devvp);
849 int     hammer_mountcheck_volumes(hammer_mount_t hmp);
850
851 int     hammer_mem_add(hammer_record_t record);
852 int     hammer_ip_lookup(hammer_cursor_t cursor);
853 int     hammer_ip_first(hammer_cursor_t cursor);
854 int     hammer_ip_next(hammer_cursor_t cursor);
855 int     hammer_ip_resolve_data(hammer_cursor_t cursor);
856 int     hammer_ip_delete_record(hammer_cursor_t cursor, hammer_inode_t ip,
857                         hammer_tid_t tid);
858 int     hammer_delete_at_cursor(hammer_cursor_t cursor, int delete_flags,
859                         hammer_tid_t delete_tid, u_int32_t delete_ts,
860                         int track, int64_t *stat_bytes);
861 int     hammer_ip_check_directory_empty(hammer_transaction_t trans,
862                         hammer_inode_t ip);
863 int     hammer_sync_hmp(hammer_mount_t hmp, int waitfor);
864 int     hammer_queue_inodes_flusher(hammer_mount_t hmp, int waitfor);
865
866 hammer_record_t
867         hammer_alloc_mem_record(hammer_inode_t ip, int data_len);
868 void    hammer_flush_record_done(hammer_record_t record, int error);
869 void    hammer_wait_mem_record_ident(hammer_record_t record, const char *ident);
870 void    hammer_rel_mem_record(hammer_record_t record);
871
872 int     hammer_cursor_up(hammer_cursor_t cursor);
873 int     hammer_cursor_up_locked(hammer_cursor_t cursor);
874 int     hammer_cursor_down(hammer_cursor_t cursor);
875 int     hammer_cursor_upgrade(hammer_cursor_t cursor);
876 int     hammer_cursor_upgrade_node(hammer_cursor_t cursor);
877 void    hammer_cursor_downgrade(hammer_cursor_t cursor);
878 int     hammer_cursor_seek(hammer_cursor_t cursor, hammer_node_t node,
879                         int index);
880 void    hammer_lock_ex_ident(struct hammer_lock *lock, const char *ident);
881 int     hammer_lock_ex_try(struct hammer_lock *lock);
882 void    hammer_lock_sh(struct hammer_lock *lock);
883 int     hammer_lock_sh_try(struct hammer_lock *lock);
884 int     hammer_lock_upgrade(struct hammer_lock *lock);
885 void    hammer_lock_downgrade(struct hammer_lock *lock);
886 int     hammer_lock_status(struct hammer_lock *lock);
887 void    hammer_unlock(struct hammer_lock *lock);
888 void    hammer_ref(struct hammer_lock *lock);
889 void    hammer_unref(struct hammer_lock *lock);
890
891 void    hammer_sync_lock_ex(hammer_transaction_t trans);
892 void    hammer_sync_lock_sh(hammer_transaction_t trans);
893 int     hammer_sync_lock_sh_try(hammer_transaction_t trans);
894 void    hammer_sync_unlock(hammer_transaction_t trans);
895
896 u_int32_t hammer_to_unix_xid(uuid_t *uuid);
897 void hammer_guid_to_uuid(uuid_t *uuid, u_int32_t guid);
898 void    hammer_time_to_timespec(u_int64_t xtime, struct timespec *ts);
899 u_int64_t hammer_timespec_to_time(struct timespec *ts);
900 hammer_tid_t hammer_str_to_tid(const char *str, int *ispfs,
901                         u_int32_t *localizationp);
902 hammer_tid_t hammer_alloc_objid(hammer_mount_t hmp, hammer_inode_t dip);
903 void hammer_clear_objid(hammer_inode_t dip);
904 void hammer_destroy_objid_cache(hammer_mount_t hmp);
905
906 int hammer_enter_undo_history(hammer_mount_t hmp, hammer_off_t offset,
907                         int bytes);
908 void hammer_clear_undo_history(hammer_mount_t hmp);
909 enum vtype hammer_get_vnode_type(u_int8_t obj_type);
910 int hammer_get_dtype(u_int8_t obj_type);
911 u_int8_t hammer_get_obj_type(enum vtype vtype);
912 int64_t hammer_directory_namekey(const void *name, int len);
913 int     hammer_nohistory(hammer_inode_t ip);
914
915 int     hammer_init_cursor(hammer_transaction_t trans, hammer_cursor_t cursor,
916                         hammer_node_cache_t cache, hammer_inode_t ip);
917 void    hammer_normalize_cursor(hammer_cursor_t cursor);
918 void    hammer_done_cursor(hammer_cursor_t cursor);
919 int     hammer_recover_cursor(hammer_cursor_t cursor);
920 void    hammer_unlock_cursor(hammer_cursor_t cursor, int also_ip);
921 int     hammer_lock_cursor(hammer_cursor_t cursor, int also_ip);
922 hammer_cursor_t hammer_push_cursor(hammer_cursor_t ocursor);
923 void    hammer_pop_cursor(hammer_cursor_t ocursor, hammer_cursor_t ncursor);
924
925 void    hammer_cursor_replaced_node(hammer_node_t onode, hammer_node_t nnode);
926 void    hammer_cursor_removed_node(hammer_node_t onode, hammer_node_t parent,
927                         int index);
928 void    hammer_cursor_split_node(hammer_node_t onode, hammer_node_t nnode,
929                         int index);
930 void    hammer_cursor_inserted_element(hammer_node_t node, int index);
931 void    hammer_cursor_deleted_element(hammer_node_t node, int index);
932
933 int     hammer_btree_lookup(hammer_cursor_t cursor);
934 int     hammer_btree_first(hammer_cursor_t cursor);
935 int     hammer_btree_last(hammer_cursor_t cursor);
936 int     hammer_btree_extract(hammer_cursor_t cursor, int flags);
937 int     hammer_btree_iterate(hammer_cursor_t cursor);
938 int     hammer_btree_iterate_reverse(hammer_cursor_t cursor);
939 int     hammer_btree_insert(hammer_cursor_t cursor,
940                             hammer_btree_leaf_elm_t elm, int *doprop);
941 int     hammer_btree_delete(hammer_cursor_t cursor);
942 void    hammer_btree_do_propagation(hammer_cursor_t cursor,
943                             hammer_pseudofs_inmem_t pfsm,
944                             hammer_btree_leaf_elm_t leaf);
945 int     hammer_btree_cmp(hammer_base_elm_t key1, hammer_base_elm_t key2);
946 int     hammer_btree_chkts(hammer_tid_t ts, hammer_base_elm_t key);
947 int     hammer_btree_correct_rhb(hammer_cursor_t cursor, hammer_tid_t tid);
948 int     hammer_btree_correct_lhb(hammer_cursor_t cursor, hammer_tid_t tid);
949
950 int     btree_set_parent(hammer_transaction_t trans, hammer_node_t node,
951                         hammer_btree_elm_t elm);
952 int     hammer_btree_lock_children(hammer_cursor_t cursor,
953                         struct hammer_node_locklist **locklistp);
954 void    hammer_btree_unlock_children(struct hammer_node_locklist **locklistp);
955 int     hammer_btree_search_node(hammer_base_elm_t elm, hammer_node_ondisk_t node);
956 hammer_node_t hammer_btree_get_parent(hammer_node_t node, int *parent_indexp,
957                         int *errorp, int try_exclusive);
958
959 void    hammer_print_btree_node(hammer_node_ondisk_t ondisk);
960 void    hammer_print_btree_elm(hammer_btree_elm_t elm, u_int8_t type, int i);
961
962 void    *hammer_bread(struct hammer_mount *hmp, hammer_off_t off,
963                         int *errorp, struct hammer_buffer **bufferp);
964 void    *hammer_bnew(struct hammer_mount *hmp, hammer_off_t off,
965                         int *errorp, struct hammer_buffer **bufferp);
966 void    *hammer_bread_ext(struct hammer_mount *hmp, hammer_off_t off, int bytes,
967                         int *errorp, struct hammer_buffer **bufferp);
968 void    *hammer_bnew_ext(struct hammer_mount *hmp, hammer_off_t off, int bytes,
969                         int *errorp, struct hammer_buffer **bufferp);
970
971 hammer_volume_t hammer_get_root_volume(hammer_mount_t hmp, int *errorp);
972
973 hammer_volume_t hammer_get_volume(hammer_mount_t hmp,
974                         int32_t vol_no, int *errorp);
975 hammer_buffer_t hammer_get_buffer(hammer_mount_t hmp, hammer_off_t buf_offset,
976                         int bytes, int isnew, int *errorp);
977 void            hammer_sync_buffers(hammer_mount_t hmp,
978                         hammer_off_t base_offset, int bytes);
979 void            hammer_del_buffers(hammer_mount_t hmp,
980                         hammer_off_t base_offset,
981                         hammer_off_t zone2_offset, int bytes);
982
983 int             hammer_ref_volume(hammer_volume_t volume);
984 int             hammer_ref_buffer(hammer_buffer_t buffer);
985 void            hammer_flush_buffer_nodes(hammer_buffer_t buffer);
986
987 void            hammer_rel_volume(hammer_volume_t volume, int flush);
988 void            hammer_rel_buffer(hammer_buffer_t buffer, int flush);
989
990 int             hammer_vfs_export(struct mount *mp, int op,
991                         const struct export_args *export);
992 hammer_node_t   hammer_get_node(hammer_mount_t hmp, hammer_off_t node_offset,
993                         int isnew, int *errorp);
994 void            hammer_ref_node(hammer_node_t node);
995 hammer_node_t   hammer_ref_node_safe(struct hammer_mount *hmp,
996                         hammer_node_cache_t cache, int *errorp);
997 void            hammer_rel_node(hammer_node_t node);
998 void            hammer_delete_node(hammer_transaction_t trans,
999                         hammer_node_t node);
1000 void            hammer_cache_node(hammer_node_cache_t cache,
1001                         hammer_node_t node);
1002 void            hammer_uncache_node(hammer_node_cache_t cache);
1003 void            hammer_flush_node(hammer_node_t node);
1004
1005 void hammer_dup_buffer(struct hammer_buffer **bufferp,
1006                         struct hammer_buffer *buffer);
1007 hammer_node_t hammer_alloc_btree(hammer_transaction_t trans, int *errorp);
1008 void *hammer_alloc_data(hammer_transaction_t trans, int32_t data_len,
1009                         u_int16_t rec_type, hammer_off_t *data_offsetp,
1010                         struct hammer_buffer **data_bufferp, int *errorp);
1011
1012 int hammer_generate_undo(hammer_transaction_t trans, hammer_io_t io,
1013                         hammer_off_t zone1_offset, void *base, int len);
1014
1015 void hammer_put_volume(struct hammer_volume *volume, int flush);
1016 void hammer_put_buffer(struct hammer_buffer *buffer, int flush);
1017
1018 hammer_off_t hammer_freemap_alloc(hammer_transaction_t trans,
1019                         hammer_off_t owner, int *errorp);
1020 void hammer_freemap_free(hammer_transaction_t trans, hammer_off_t phys_offset,
1021                         hammer_off_t owner, int *errorp);
1022 int hammer_checkspace(hammer_mount_t hmp, int slop);
1023 hammer_off_t hammer_blockmap_alloc(hammer_transaction_t trans, int zone,
1024                         int bytes, int *errorp);
1025 hammer_reserve_t hammer_blockmap_reserve(hammer_mount_t hmp, int zone,
1026                         int bytes, hammer_off_t *zone_offp, int *errorp);
1027 void hammer_blockmap_reserve_undo(hammer_reserve_t resv,
1028                         hammer_off_t zone_offset, int bytes);
1029 void hammer_blockmap_reserve_complete(hammer_mount_t hmp,
1030                         hammer_reserve_t resv);
1031 void hammer_reserve_clrdelay(hammer_mount_t hmp, hammer_reserve_t resv);
1032 void hammer_blockmap_free(hammer_transaction_t trans,
1033                         hammer_off_t bmap_off, int bytes);
1034 int hammer_blockmap_finalize(hammer_transaction_t trans,
1035                         hammer_off_t bmap_off, int bytes);
1036 int hammer_blockmap_getfree(hammer_mount_t hmp, hammer_off_t bmap_off,
1037                         int *curp, int *errorp);
1038 hammer_off_t hammer_blockmap_lookup(hammer_mount_t hmp, hammer_off_t bmap_off,
1039                         int *errorp);
1040 hammer_off_t hammer_undo_lookup(hammer_mount_t hmp, hammer_off_t bmap_off,
1041                         int *errorp);
1042 int64_t hammer_undo_used(hammer_transaction_t trans);
1043 int64_t hammer_undo_space(hammer_transaction_t trans);
1044 int64_t hammer_undo_max(hammer_mount_t hmp);
1045
1046 void hammer_start_transaction(struct hammer_transaction *trans,
1047                               struct hammer_mount *hmp);
1048 void hammer_simple_transaction(struct hammer_transaction *trans,
1049                               struct hammer_mount *hmp);
1050 void hammer_start_transaction_fls(struct hammer_transaction *trans,
1051                                   struct hammer_mount *hmp);
1052 void hammer_done_transaction(struct hammer_transaction *trans);
1053
1054 void hammer_modify_inode(hammer_inode_t ip, int flags);
1055 void hammer_flush_inode(hammer_inode_t ip, int flags);
1056 void hammer_flush_inode_done(hammer_inode_t ip, int error);
1057 void hammer_wait_inode(hammer_inode_t ip);
1058
1059 int  hammer_create_inode(struct hammer_transaction *trans, struct vattr *vap,
1060                         struct ucred *cred, struct hammer_inode *dip,
1061                         hammer_pseudofs_inmem_t pfsm,
1062                         struct hammer_inode **ipp);
1063 void hammer_rel_inode(hammer_inode_t ip, int flush);
1064 int hammer_reload_inode(hammer_inode_t ip, void *arg __unused);
1065 int hammer_ino_rb_compare(hammer_inode_t ip1, hammer_inode_t ip2);
1066 int hammer_destroy_inode_callback(hammer_inode_t ip, void *data __unused);
1067
1068 int hammer_sync_inode(hammer_transaction_t trans, hammer_inode_t ip);
1069 void hammer_test_inode(hammer_inode_t dip);
1070 void hammer_inode_unloadable_check(hammer_inode_t ip, int getvp);
1071
1072 int  hammer_ip_add_directory(struct hammer_transaction *trans,
1073                         hammer_inode_t dip, const char *name, int bytes,
1074                         hammer_inode_t nip);
1075 int  hammer_ip_del_directory(struct hammer_transaction *trans,
1076                         hammer_cursor_t cursor, hammer_inode_t dip,
1077                         hammer_inode_t ip);
1078 hammer_record_t hammer_ip_add_bulk(hammer_inode_t ip, off_t file_offset,
1079                         void *data, int bytes, int *errorp);
1080 int  hammer_ip_frontend_trunc(struct hammer_inode *ip, off_t file_size);
1081 int  hammer_ip_add_record(struct hammer_transaction *trans,
1082                         hammer_record_t record);
1083 int  hammer_ip_delete_range(hammer_cursor_t cursor, hammer_inode_t ip,
1084                         int64_t ran_beg, int64_t ran_end, int truncating);
1085 int  hammer_ip_delete_clean(hammer_cursor_t cursor, hammer_inode_t ip,
1086                         int *countp);
1087 int  hammer_ip_sync_data(hammer_cursor_t cursor, hammer_inode_t ip,
1088                         int64_t offset, void *data, int bytes);
1089 int  hammer_ip_sync_record(hammer_transaction_t trans, hammer_record_t rec);
1090 int  hammer_ip_sync_record_cursor(hammer_cursor_t cursor, hammer_record_t rec);
1091 hammer_pseudofs_inmem_t  hammer_load_pseudofs(hammer_transaction_t trans,
1092                         u_int32_t localization, int *errorp);
1093 int  hammer_mkroot_pseudofs(hammer_transaction_t trans, struct ucred *cred,
1094                         hammer_pseudofs_inmem_t pfsm);
1095 int  hammer_save_pseudofs(hammer_transaction_t trans,
1096                         hammer_pseudofs_inmem_t pfsm);
1097 int  hammer_unload_pseudofs(hammer_transaction_t trans, u_int32_t localization);
1098 void hammer_rel_pseudofs(hammer_mount_t hmp, hammer_pseudofs_inmem_t pfsm);
1099 int hammer_ioctl(hammer_inode_t ip, u_long com, caddr_t data, int fflag,
1100                         struct ucred *cred);
1101
1102 void hammer_io_init(hammer_io_t io, hammer_mount_t hmp,
1103                         enum hammer_io_type type);
1104 int hammer_io_read(struct vnode *devvp, struct hammer_io *io,
1105                         hammer_off_t limit);
1106 int hammer_io_new(struct vnode *devvp, struct hammer_io *io);
1107 void hammer_io_inval(hammer_volume_t volume, hammer_off_t zone2_offset);
1108 struct buf *hammer_io_release(struct hammer_io *io, int flush);
1109 void hammer_io_flush(struct hammer_io *io);
1110 void hammer_io_wait(struct hammer_io *io);
1111 void hammer_io_waitdep(struct hammer_io *io);
1112 void hammer_io_wait_all(hammer_mount_t hmp, const char *ident);
1113 int hammer_io_direct_read(hammer_mount_t hmp, struct bio *bio,
1114                         hammer_btree_leaf_elm_t leaf);
1115 int hammer_io_direct_write(hammer_mount_t hmp, hammer_record_t record,
1116                         struct bio *bio);
1117 void hammer_io_direct_wait(hammer_record_t record);
1118 void hammer_io_direct_uncache(hammer_mount_t hmp, hammer_btree_leaf_elm_t leaf);
1119 void hammer_io_write_interlock(hammer_io_t io);
1120 void hammer_io_done_interlock(hammer_io_t io);
1121 void hammer_io_clear_modify(struct hammer_io *io, int inval);
1122 void hammer_io_clear_modlist(struct hammer_io *io);
1123 void hammer_modify_volume(hammer_transaction_t trans, hammer_volume_t volume,
1124                         void *base, int len);
1125 void hammer_modify_buffer(hammer_transaction_t trans, hammer_buffer_t buffer,
1126                         void *base, int len);
1127 void hammer_modify_volume_done(hammer_volume_t volume);
1128 void hammer_modify_buffer_done(hammer_buffer_t buffer);
1129
1130 int hammer_ioc_reblock(hammer_transaction_t trans, hammer_inode_t ip,
1131                         struct hammer_ioc_reblock *reblock);
1132 int hammer_ioc_prune(hammer_transaction_t trans, hammer_inode_t ip,
1133                         struct hammer_ioc_prune *prune);
1134 int hammer_ioc_mirror_read(hammer_transaction_t trans, hammer_inode_t ip,
1135                         struct hammer_ioc_mirror_rw *mirror);
1136 int hammer_ioc_mirror_write(hammer_transaction_t trans, hammer_inode_t ip,
1137                         struct hammer_ioc_mirror_rw *mirror);
1138 int hammer_ioc_set_pseudofs(hammer_transaction_t trans, hammer_inode_t ip,
1139                         struct ucred *cred, struct hammer_ioc_pseudofs_rw *pfs);
1140 int hammer_ioc_get_pseudofs(hammer_transaction_t trans, hammer_inode_t ip,
1141                         struct hammer_ioc_pseudofs_rw *pfs);
1142 int hammer_ioc_destroy_pseudofs(hammer_transaction_t trans, hammer_inode_t ip,
1143                         struct hammer_ioc_pseudofs_rw *pfs);
1144 int hammer_ioc_downgrade_pseudofs(hammer_transaction_t trans, hammer_inode_t ip,
1145                         struct hammer_ioc_pseudofs_rw *pfs);
1146 int hammer_ioc_upgrade_pseudofs(hammer_transaction_t trans, hammer_inode_t ip,
1147                         struct hammer_ioc_pseudofs_rw *pfs);
1148 int hammer_ioc_wait_pseudofs(hammer_transaction_t trans, hammer_inode_t ip,
1149                         struct hammer_ioc_pseudofs_rw *pfs);
1150
1151 int hammer_signal_check(hammer_mount_t hmp);
1152
1153 void hammer_flusher_create(hammer_mount_t hmp);
1154 void hammer_flusher_destroy(hammer_mount_t hmp);
1155 void hammer_flusher_sync(hammer_mount_t hmp);
1156 int  hammer_flusher_async(hammer_mount_t hmp, hammer_flush_group_t flg);
1157 int  hammer_flusher_async_one(hammer_mount_t hmp);
1158 void hammer_flusher_wait(hammer_mount_t hmp, int seq);
1159 int  hammer_flusher_meta_limit(hammer_mount_t hmp);
1160 int  hammer_flusher_meta_halflimit(hammer_mount_t hmp);
1161 int  hammer_flusher_undo_exhausted(hammer_transaction_t trans, int quarter);
1162 void hammer_flusher_clean_loose_ios(hammer_mount_t hmp);
1163 void hammer_flusher_finalize(hammer_transaction_t trans, int final);
1164 int  hammer_flusher_haswork(hammer_mount_t hmp);
1165
1166
1167 int hammer_recover(hammer_mount_t hmp, hammer_volume_t rootvol);
1168 void hammer_recover_flush_buffers(hammer_mount_t hmp,
1169                         hammer_volume_t root_volume, int final);
1170
1171 void hammer_crc_set_blockmap(hammer_blockmap_t blockmap);
1172 void hammer_crc_set_volume(hammer_volume_ondisk_t ondisk);
1173 void hammer_crc_set_leaf(void *data, hammer_btree_leaf_elm_t leaf);
1174
1175 int hammer_crc_test_blockmap(hammer_blockmap_t blockmap);
1176 int hammer_crc_test_volume(hammer_volume_ondisk_t ondisk);
1177 int hammer_crc_test_btree(hammer_node_ondisk_t ondisk);
1178 int hammer_crc_test_leaf(void *data, hammer_btree_leaf_elm_t leaf);
1179 void hkprintf(const char *ctl, ...);
1180 udev_t hammer_fsid_to_udev(uuid_t *uuid);
1181
1182
1183 int hammer_blocksize(int64_t file_offset);
1184 int64_t hammer_blockdemarc(int64_t file_offset1, int64_t file_offset2);
1185
1186 #endif
1187
1188 static __inline void
1189 hammer_wait_mem_record(hammer_record_t record)
1190 {
1191         hammer_wait_mem_record_ident(record, "hmmwai");
1192 }
1193
1194 static __inline void
1195 hammer_lock_ex(struct hammer_lock *lock)
1196 {
1197         hammer_lock_ex_ident(lock, "hmrlck");
1198 }
1199
1200 /*
1201  * Indicate that a B-Tree node is being modified.
1202  */
1203 static __inline void
1204 hammer_modify_node_noundo(hammer_transaction_t trans, hammer_node_t node)
1205 {
1206         hammer_modify_buffer(trans, node->buffer, NULL, 0);
1207 }
1208
1209 static __inline void
1210 hammer_modify_node_all(hammer_transaction_t trans, struct hammer_node *node)
1211 {
1212         hammer_modify_buffer(trans, node->buffer,
1213                              node->ondisk, sizeof(*node->ondisk));
1214 }
1215
1216 static __inline void
1217 hammer_modify_node(hammer_transaction_t trans, hammer_node_t node,
1218                    void *base, int len)
1219 {
1220         hammer_crc_t *crcptr;
1221
1222         KKASSERT((char *)base >= (char *)node->ondisk &&
1223                  (char *)base + len <=
1224                     (char *)node->ondisk + sizeof(*node->ondisk));
1225         hammer_modify_buffer(trans, node->buffer, base, len);
1226         crcptr = &node->ondisk->crc;
1227         hammer_modify_buffer(trans, node->buffer, crcptr, sizeof(hammer_crc_t));
1228         --node->buffer->io.modify_refs; /* only want one ref */
1229 }
1230
1231 /*
1232  * Indicate that the specified modifications have been completed.
1233  *
1234  * Do not try to generate the crc here, it's very expensive to do and a
1235  * sequence of insertions or deletions can result in many calls to this
1236  * function on the same node.
1237  */
1238 static __inline void
1239 hammer_modify_node_done(hammer_node_t node)
1240 {
1241         node->flags |= HAMMER_NODE_CRCGOOD;
1242         if ((node->flags & HAMMER_NODE_NEEDSCRC) == 0) {
1243                 node->flags |= HAMMER_NODE_NEEDSCRC;
1244                 node->buffer->io.gencrc = 1;
1245                 hammer_ref_node(node);
1246         }
1247         hammer_modify_buffer_done(node->buffer);
1248 }
1249
1250 #define hammer_modify_volume_field(trans, vol, field)           \
1251         hammer_modify_volume(trans, vol, &(vol)->ondisk->field, \
1252                              sizeof((vol)->ondisk->field))
1253
1254 #define hammer_modify_node_field(trans, node, field)            \
1255         hammer_modify_node(trans, node, &(node)->ondisk->field, \
1256                              sizeof((node)->ondisk->field))
1257