2 * Copyright (c) 2011-2012 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@dragonflybsd.org>
6 * by Venkatesh Srinivas <vsrinivas@dragonflybsd.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * 3. Neither the name of The DragonFly Project nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific, prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * This header file contains structures used internally by the HAMMER2
38 * implementation. See hammer2_disk.h for on-disk structures.
41 #ifndef _VFS_HAMMER2_HAMMER2_H_
42 #define _VFS_HAMMER2_HAMMER2_H_
44 #include <sys/param.h>
45 #include <sys/types.h>
46 #include <sys/kernel.h>
48 #include <sys/systm.h>
50 #include <sys/malloc.h>
51 #include <sys/mount.h>
52 #include <sys/vnode.h>
54 #include <sys/mountctl.h>
57 #include <sys/globaldata.h>
58 #include <sys/lockf.h>
60 #include <sys/queue.h>
61 #include <sys/limits.h>
63 #include <sys/signal2.h>
66 #include "hammer2_disk.h"
67 #include "hammer2_mount.h"
68 #include "hammer2_ioctl.h"
69 #include "hammer2_ccms.h"
74 struct hammer2_pfsmount;
77 * The chain structure tracks blockref recursions all the way to
78 * the root volume. These consist of indirect blocks, inodes,
79 * and eventually the volume header.
81 * The chain structure is embedded in the hammer2_mount, hammer2_inode,
82 * and other system memory structures. The chain structure typically
83 * implements the reference count and busy flag for the larger structure.
85 * It is always possible to track a chain element all the way back to the
86 * root by following the (parent) links. (index) is a type-dependent index
87 * in the parent indicating where in the parent the chain element resides.
89 * When a blockref is added or deleted the related chain element is marked
90 * modified and all of its parents are marked SUBMODIFIED (the parent
91 * recursion can stop once we hit a node that is already marked SUBMODIFIED).
92 * A deleted chain element must remain intact until synchronized against
95 * The blockref at (parent, index) is not adjusted until the modified chain
96 * element is flushed and unmarked. Until then the child's blockref may
97 * not match the blockref at (parent, index).
99 SPLAY_HEAD(hammer2_chain_splay, hammer2_chain);
101 struct hammer2_chain {
102 struct hammer2_blockref bref;
103 struct hammer2_blockref bref_flush; /* synchronized w/MOVED bit */
104 struct hammer2_chain *parent; /* return chain to root */
105 struct hammer2_chain_splay shead;
106 SPLAY_ENTRY(hammer2_chain) snode;
107 TAILQ_ENTRY(hammer2_chain) flush_node; /* flush deferral list */
109 struct hammer2_inode *ip;
110 struct hammer2_indblock *np;
111 struct hammer2_data *dp;
115 struct buf *bp; /* buffer cache (ro) */
116 hammer2_media_data_t *data; /* modified copy of data (rw) */
117 u_int bytes; /* physical size of data */
118 struct lock lk; /* lockmgr lock */
119 int index; /* index in parent */
121 u_int busy; /* soft-busy */
125 typedef struct hammer2_chain hammer2_chain_t;
127 int hammer2_chain_cmp(hammer2_chain_t *chain1, hammer2_chain_t *chain2);
128 SPLAY_PROTOTYPE(hammer2_chain_splay, hammer2_chain, snode, hammer2_chain_cmp);
131 * MOVED - This bit is set during the flush when the MODIFIED bit is cleared,
132 * indicating that the parent's blocktable must inherit a change to
133 * the bref (typically a block reallocation)
135 * It must also be set in situations where a chain is not MODIFIED
136 * but whos bref has changed (typically due to fields other than
137 * a block reallocation).
139 #define HAMMER2_CHAIN_MODIFIED 0x00000001 /* active mods */
140 #define HAMMER2_CHAIN_DIRTYEMBED 0x00000002 /* inode embedded */
141 #define HAMMER2_CHAIN_DIRTYBP 0x00000004 /* dirty on unlock */
142 #define HAMMER2_CHAIN_SUBMODIFIED 0x00000008 /* 1+ subs modified */
143 #define HAMMER2_CHAIN_DELETED 0x00000010
144 #define HAMMER2_CHAIN_INITIAL 0x00000020 /* initial create */
145 #define HAMMER2_CHAIN_FLUSHED 0x00000040 /* flush on unlock */
146 #define HAMMER2_CHAIN_MOVED 0x00000080 /* bref changed */
147 #define HAMMER2_CHAIN_IOFLUSH 0x00000100 /* bawrite on put */
148 #define HAMMER2_CHAIN_DEFERRED 0x00000200 /* on a deferral list*/
149 #define HAMMER2_CHAIN_DESTROYED 0x00000400 /* destroying */
150 #define HAMMER2_CHAIN_MODIFIED_AUX 0x00000800 /* hmp->vchain only */
151 #define HAMMER2_CHAIN_MODIFY_TID 0x00001000 /* mod updates field */
152 #define HAMMER2_CHAIN_MOUNTED 0x00002000 /* PFS is mounted */
155 * Flags passed to hammer2_chain_lookup() and hammer2_chain_next()
157 #define HAMMER2_LOOKUP_NOLOCK 0x00000001 /* ref only */
158 #define HAMMER2_LOOKUP_NODATA 0x00000002 /* data left NULL */
161 * Flags passed to hammer2_chain_modify() and hammer2_chain_resize()
163 * NOTE: OPTDATA allows us to avoid instantiating buffers for INDIRECT
164 * blocks in the INITIAL-create state.
166 * NOTE: NO_MODIFY_TID tells the function to not set HAMMER2_CHAIN_MODIFY_TID
167 * when marking the chain modified (used when a sub-chain modification
168 * propagates upward).
170 #define HAMMER2_MODIFY_NOSUB 0x00000001 /* do not set SUBMOD */
171 #define HAMMER2_MODIFY_OPTDATA 0x00000002 /* data can be NULL */
172 #define HAMMER2_MODIFY_NO_MODIFY_TID 0x00000004
175 * Flags passed to hammer2_chain_lock()
177 #define HAMMER2_RESOLVE_NEVER 1
178 #define HAMMER2_RESOLVE_MAYBE 2
179 #define HAMMER2_RESOLVE_ALWAYS 3
182 * Cluster different types of storage together for allocations
184 #define HAMMER2_FREECACHE_INODE 0
185 #define HAMMER2_FREECACHE_INDIR 1
186 #define HAMMER2_FREECACHE_DATA 2
187 #define HAMMER2_FREECACHE_UNUSED3 3
188 #define HAMMER2_FREECACHE_TYPES 4
191 * BMAP read-ahead maximum parameters
193 #define HAMMER2_BMAP_COUNT 16 /* max bmap read-ahead */
194 #define HAMMER2_BMAP_BYTES (HAMMER2_PBUFSIZE * HAMMER2_BMAP_COUNT)
199 #define HAMMER2_FLUSH_DEPTH_LIMIT 40 /* stack recursion limit */
202 * HAMMER2 IN-MEMORY CACHE OF MEDIA STRUCTURES
204 * There is an in-memory representation of all on-media data structure.
206 * When accessed read-only the data will be mapped to the related buffer
209 * When accessed read-write (marked modified) a kmalloc()'d copy of the
210 * is created which can then be modified. The copy is destroyed when a
211 * filesystem block is allocated to replace it.
213 * Active inodes (those with vnodes attached) will maintain the kmalloc()'d
214 * copy for both the read-only and the read-write case. The combination of
215 * (bp) and (data) determines whether (data) was allocated or not.
217 * The in-memory representation may remain cached (for example in order to
218 * placemark clustering locks) even after the related data has been
225 struct hammer2_inode {
226 struct hammer2_mount *hmp; /* Global mount */
227 struct hammer2_pfsmount *pmp; /* PFS mount */
228 struct hammer2_inode *pip; /* parent inode */
230 ccms_inode_t *cino; /* cluster cache state */
231 hammer2_chain_t chain;
232 struct hammer2_inode_data ip_data;
233 struct lockf advlock;
234 u_int depth; /* directory depth */
235 hammer2_off_t delta_dcount; /* adjust data_count */
236 hammer2_off_t delta_icount; /* adjust inode_count */
239 typedef struct hammer2_inode hammer2_inode_t;
242 * A hammer2 indirect block
244 struct hammer2_indblock {
245 hammer2_chain_t chain;
248 typedef struct hammer2_indblock hammer2_indblock_t;
251 * A hammer2 data block
253 struct hammer2_data {
254 hammer2_chain_t chain;
257 typedef struct hammer2_data hammer2_data_t;
259 struct hammer2_freecache {
261 hammer2_off_t single;
264 typedef struct hammer2_freecache hammer2_freecache_t;
267 * Global (per device) mount structure for device (aka vp->v_mount->hmp)
269 struct hammer2_mount {
270 struct vnode *devvp; /* device vnode */
271 int ronly; /* read-only mount */
272 int pmp_count; /* PFS mounts backed by us */
273 TAILQ_ENTRY(hammer2_mount) mntentry; /* hammer2_mntlist */
275 struct malloc_type *minode;
279 struct malloc_type *mchain;
282 hammer2_chain_t vchain; /* anchor chain */
283 hammer2_chain_t *schain; /* super-root */
284 struct lock alloclk; /* lockmgr lock */
285 struct lock voldatalk; /* lockmgr lock */
287 hammer2_volume_data_t voldata;
288 hammer2_freecache_t freecache[HAMMER2_FREECACHE_TYPES][HAMMER2_MAX_RADIX+1];
291 typedef struct hammer2_mount hammer2_mount_t;
294 * Per-PFS mount structure for device (aka vp->v_mount)
296 struct hammer2_pfsmount {
297 struct mount *mp; /* kernel mount */
298 struct hammer2_mount *hmp; /* device global mount */
299 hammer2_chain_t *rchain; /* PFS root chain */
300 hammer2_inode_t *iroot; /* PFS root inode */
301 ccms_domain_t ccms_dom;
302 struct netexport export; /* nfs export */
303 int ronly; /* read-only mount */
306 typedef struct hammer2_pfsmount hammer2_pfsmount_t;
310 MALLOC_DECLARE(M_HAMMER2);
312 #define VTOI(vp) ((hammer2_inode_t *)(vp)->v_data)
313 #define ITOV(ip) ((ip)->vp)
317 MPTOPMP(struct mount *mp)
319 return ((hammer2_pfsmount_t *)mp->mnt_data);
324 MPTOHMP(struct mount *mp)
326 return (((hammer2_pfsmount_t *)mp->mnt_data)->hmp);
329 extern struct vop_ops hammer2_vnode_vops;
330 extern struct vop_ops hammer2_spec_vops;
331 extern struct vop_ops hammer2_fifo_vops;
333 extern int hammer2_debug;
334 extern int hammer2_cluster_enable;
335 extern int hammer2_hardlink_enable;
336 extern long hammer2_iod_file_read;
337 extern long hammer2_iod_meta_read;
338 extern long hammer2_iod_indr_read;
339 extern long hammer2_iod_file_write;
340 extern long hammer2_iod_meta_write;
341 extern long hammer2_iod_indr_write;
342 extern long hammer2_iod_volu_write;
343 extern long hammer2_ioa_file_read;
344 extern long hammer2_ioa_meta_read;
345 extern long hammer2_ioa_indr_read;
346 extern long hammer2_ioa_file_write;
347 extern long hammer2_ioa_meta_write;
348 extern long hammer2_ioa_indr_write;
349 extern long hammer2_ioa_volu_write;
354 void hammer2_inode_lock_ex(hammer2_inode_t *ip);
355 void hammer2_inode_unlock_ex(hammer2_inode_t *ip);
356 void hammer2_inode_lock_sh(hammer2_inode_t *ip);
357 void hammer2_inode_unlock_sh(hammer2_inode_t *ip);
358 void hammer2_inode_busy(hammer2_inode_t *ip);
359 void hammer2_inode_unbusy(hammer2_inode_t *ip);
360 void hammer2_voldata_lock(hammer2_mount_t *hmp);
361 void hammer2_voldata_unlock(hammer2_mount_t *hmp);
363 void hammer2_mount_exlock(hammer2_mount_t *hmp);
364 void hammer2_mount_shlock(hammer2_mount_t *hmp);
365 void hammer2_mount_unlock(hammer2_mount_t *hmp);
367 int hammer2_get_dtype(hammer2_inode_t *ip);
368 int hammer2_get_vtype(hammer2_inode_t *ip);
369 u_int8_t hammer2_get_obj_type(enum vtype vtype);
370 void hammer2_time_to_timespec(u_int64_t xtime, struct timespec *ts);
371 u_int64_t hammer2_timespec_to_time(struct timespec *ts);
372 u_int32_t hammer2_to_unix_xid(uuid_t *uuid);
373 void hammer2_guid_to_uuid(uuid_t *uuid, u_int32_t guid);
375 hammer2_key_t hammer2_dirhash(const unsigned char *name, size_t len);
376 int hammer2_bytes_to_radix(size_t bytes);
378 int hammer2_calc_logical(hammer2_inode_t *ip, hammer2_off_t uoff,
379 hammer2_key_t *lbasep, hammer2_key_t *leofp);
380 void hammer2_update_time(uint64_t *timep);
385 struct vnode *hammer2_igetv(hammer2_inode_t *ip, int *errorp);
387 void hammer2_inode_lock_nlinks(hammer2_inode_t *ip);
388 void hammer2_inode_unlock_nlinks(hammer2_inode_t *ip);
389 hammer2_inode_t *hammer2_inode_alloc(hammer2_pfsmount_t *pmp, void *data);
390 void hammer2_inode_free(hammer2_inode_t *ip);
391 void hammer2_inode_ref(hammer2_inode_t *ip);
392 void hammer2_inode_drop(hammer2_inode_t *ip);
393 int hammer2_inode_calc_alloc(hammer2_key_t filesize);
395 int hammer2_inode_create(hammer2_inode_t *dip,
396 struct vattr *vap, struct ucred *cred,
397 const uint8_t *name, size_t name_len,
398 hammer2_inode_t **nipp);
400 int hammer2_inode_duplicate(hammer2_inode_t *dip,
401 hammer2_inode_t *oip, hammer2_inode_t **nipp,
402 const uint8_t *name, size_t name_len);
403 int hammer2_inode_connect(hammer2_inode_t *dip, hammer2_inode_t *oip,
404 const uint8_t *name, size_t name_len);
406 int hammer2_unlink_file(hammer2_inode_t *dip,
407 const uint8_t *name, size_t name_len,
408 int isdir, hammer2_inode_t *retain_ip);
409 int hammer2_hardlink_consolidate(hammer2_inode_t **ipp, hammer2_inode_t *tdip);
410 int hammer2_hardlink_deconsolidate(hammer2_inode_t *dip,
411 hammer2_chain_t **chainp, hammer2_inode_t **ipp);
412 int hammer2_hardlink_find(hammer2_inode_t *dip, hammer2_chain_t **chainp,
413 hammer2_inode_t **ipp);
418 void hammer2_modify_volume(hammer2_mount_t *hmp);
419 hammer2_chain_t *hammer2_chain_alloc(hammer2_mount_t *hmp,
420 hammer2_blockref_t *bref);
421 void hammer2_chain_free(hammer2_mount_t *hmp, hammer2_chain_t *chain);
422 void hammer2_chain_ref(hammer2_mount_t *hmp, hammer2_chain_t *chain);
423 void hammer2_chain_drop(hammer2_mount_t *hmp, hammer2_chain_t *chain);
424 int hammer2_chain_lock(hammer2_mount_t *hmp, hammer2_chain_t *chain, int how);
425 void hammer2_chain_moved(hammer2_mount_t *hmp, hammer2_chain_t *chain);
426 void hammer2_chain_modify(hammer2_mount_t *hmp, hammer2_chain_t *chain,
428 void hammer2_chain_resize(hammer2_inode_t *ip, hammer2_chain_t *chain,
429 int nradix, int flags);
430 void hammer2_chain_unlock(hammer2_mount_t *hmp, hammer2_chain_t *chain);
431 hammer2_chain_t *hammer2_chain_find(hammer2_mount_t *hmp,
432 hammer2_chain_t *parent, int index);
433 hammer2_chain_t *hammer2_chain_get(hammer2_mount_t *hmp,
434 hammer2_chain_t *parent,
435 int index, int flags);
436 hammer2_chain_t *hammer2_chain_lookup(hammer2_mount_t *hmp,
437 hammer2_chain_t **parentp,
438 hammer2_key_t key_beg, hammer2_key_t key_end,
440 hammer2_chain_t *hammer2_chain_next(hammer2_mount_t *hmp,
441 hammer2_chain_t **parentp,
442 hammer2_chain_t *chain,
443 hammer2_key_t key_beg, hammer2_key_t key_end,
445 hammer2_chain_t *hammer2_chain_create(hammer2_mount_t *hmp,
446 hammer2_chain_t *parent,
447 hammer2_chain_t *chain,
448 hammer2_key_t key, int keybits,
449 int type, size_t bytes);
450 void hammer2_chain_delete(hammer2_mount_t *hmp, hammer2_chain_t *parent,
451 hammer2_chain_t *chain, int retain);
452 void hammer2_chain_flush(hammer2_mount_t *hmp, hammer2_chain_t *chain,
453 hammer2_tid_t modify_tid);
454 void hammer2_chain_commit(hammer2_mount_t *hmp, hammer2_chain_t *chain);
459 int hammer2_ioctl(hammer2_inode_t *ip, u_long com, void *data,
460 int fflag, struct ucred *cred);
465 hammer2_off_t hammer2_freemap_alloc(hammer2_mount_t *hmp,
466 int type, size_t bytes);
467 void hammer2_freemap_free(hammer2_mount_t *hmp, hammer2_off_t data_off,
470 #endif /* !_KERNEL */
471 #endif /* !_VFS_HAMMER2_HAMMER2_H_ */