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