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