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"
73 struct hammer2_pfsmount;
76 * The chain structure tracks blockref recursions all the way to
77 * the root volume. These consist of indirect blocks, inodes,
78 * and eventually the volume header.
80 * The chain structure is embedded in the hammer2_mount, hammer2_inode,
81 * and other system memory structures. The chain structure typically
82 * implements the reference count and busy flag for the larger structure.
84 * It is always possible to track a chain element all the way back to the
85 * root by following the (parent) links. (index) is a type-dependent index
86 * in the parent indicating where in the parent the chain element resides.
88 * When a blockref is added or deleted the related chain element is marked
89 * modified and all of its parents are marked SUBMODIFIED (the parent
90 * recursion can stop once we hit a node that is already marked SUBMODIFIED).
91 * A deleted chain element must remain intact until synchronized against
94 * The blockref at (parent, index) is not adjusted until the modified chain
95 * element is flushed and unmarked. Until then the child's blockref may
96 * not match the blockref at (parent, index).
98 SPLAY_HEAD(hammer2_chain_splay, hammer2_chain);
100 struct hammer2_chain {
101 struct hammer2_blockref bref;
102 struct hammer2_blockref bref_flush; /* synchronized w/MOVED bit */
103 struct hammer2_chain *parent; /* return chain to root */
104 struct hammer2_chain_splay shead;
105 SPLAY_ENTRY(hammer2_chain) snode;
106 TAILQ_ENTRY(hammer2_chain) flush_node; /* flush deferral list */
108 struct hammer2_inode *ip;
109 struct hammer2_indblock *np;
110 struct hammer2_data *dp;
114 struct buf *bp; /* buffer cache (ro) */
115 hammer2_media_data_t *data; /* modified copy of data (rw) */
116 u_int bytes; /* physical size of data */
117 struct lock lk; /* lockmgr lock */
118 int index; /* index in parent */
120 u_int busy; /* soft-busy */
124 typedef struct hammer2_chain hammer2_chain_t;
126 int hammer2_chain_cmp(hammer2_chain_t *chain1, hammer2_chain_t *chain2);
127 SPLAY_PROTOTYPE(hammer2_chain_splay, hammer2_chain, snode, hammer2_chain_cmp);
130 * MOVED - This bit is set during the flush when the MODIFIED bit is cleared,
131 * indicating that the parent's blocktable must inherit a change to
132 * the bref (typically a block reallocation)
134 * It must also be set in situations where a chain is not MODIFIED
135 * but whos bref has changed (typically due to fields other than
136 * a block reallocation).
138 #define HAMMER2_CHAIN_MODIFIED 0x00000001 /* active mods */
139 #define HAMMER2_CHAIN_DIRTYEMBED 0x00000002 /* inode embedded */
140 #define HAMMER2_CHAIN_DIRTYBP 0x00000004 /* dirty on unlock */
141 #define HAMMER2_CHAIN_SUBMODIFIED 0x00000008 /* 1+ subs modified */
142 #define HAMMER2_CHAIN_DELETED 0x00000010
143 #define HAMMER2_CHAIN_INITIAL 0x00000020 /* initial create */
144 #define HAMMER2_CHAIN_FLUSHED 0x00000040 /* flush on unlock */
145 #define HAMMER2_CHAIN_MOVED 0x00000080 /* bref changed */
146 #define HAMMER2_CHAIN_IOFLUSH 0x00000100 /* bawrite on put */
147 #define HAMMER2_CHAIN_DEFERRED 0x00000200 /* on a deferral list*/
148 #define HAMMER2_CHAIN_DESTROYED 0x00000400 /* destroying */
149 #define HAMMER2_CHAIN_MODIFIED_AUX 0x00000800 /* hmp->vchain only */
150 #define HAMMER2_CHAIN_MODIFY_TID 0x00001000 /* mod updates field */
151 #define HAMMER2_CHAIN_MOUNTED 0x00002000 /* PFS is mounted */
154 * Flags passed to hammer2_chain_lookup() and hammer2_chain_next()
156 #define HAMMER2_LOOKUP_NOLOCK 0x00000001 /* ref only */
157 #define HAMMER2_LOOKUP_NODATA 0x00000002 /* data left NULL */
160 * Flags passed to hammer2_chain_modify() and hammer2_chain_resize()
162 * NOTE: OPTDATA allows us to avoid instantiating buffers for INDIRECT
163 * blocks in the INITIAL-create state.
165 * NOTE: NO_MODIFY_TID tells the function to not set HAMMER2_CHAIN_MODIFY_TID
166 * when marking the chain modified (used when a sub-chain modification
167 * propagates upward).
169 #define HAMMER2_MODIFY_NOSUB 0x00000001 /* do not set SUBMOD */
170 #define HAMMER2_MODIFY_OPTDATA 0x00000002 /* data can be NULL */
171 #define HAMMER2_MODIFY_NO_MODIFY_TID 0x00000004
174 * Flags passed to hammer2_chain_lock()
176 #define HAMMER2_RESOLVE_NEVER 1
177 #define HAMMER2_RESOLVE_MAYBE 2
178 #define HAMMER2_RESOLVE_ALWAYS 3
181 * Cluster different types of storage together for allocations
183 #define HAMMER2_FREECACHE_INODE 0
184 #define HAMMER2_FREECACHE_INDIR 1
185 #define HAMMER2_FREECACHE_DATA 2
186 #define HAMMER2_FREECACHE_UNUSED3 3
187 #define HAMMER2_FREECACHE_TYPES 4
190 * BMAP read-ahead maximum parameters
192 #define HAMMER2_BMAP_COUNT 16 /* max bmap read-ahead */
193 #define HAMMER2_BMAP_BYTES (HAMMER2_PBUFSIZE * HAMMER2_BMAP_COUNT)
198 #define HAMMER2_FLUSH_DEPTH_LIMIT 40 /* stack recursion limit */
201 * HAMMER2 IN-MEMORY CACHE OF MEDIA STRUCTURES
203 * There is an in-memory representation of all on-media data structure.
205 * When accessed read-only the data will be mapped to the related buffer
208 * When accessed read-write (marked modified) a kmalloc()'d copy of the
209 * is created which can then be modified. The copy is destroyed when a
210 * filesystem block is allocated to replace it.
212 * Active inodes (those with vnodes attached) will maintain the kmalloc()'d
213 * copy for both the read-only and the read-write case. The combination of
214 * (bp) and (data) determines whether (data) was allocated or not.
216 * The in-memory representation may remain cached (for example in order to
217 * placemark clustering locks) even after the related data has been
224 struct hammer2_inode {
225 struct hammer2_mount *hmp; /* Global mount */
226 struct hammer2_pfsmount *pmp; /* PFS mount */
227 struct hammer2_inode *pip; /* parent inode */
229 hammer2_chain_t chain;
230 struct hammer2_inode_data ip_data;
231 struct lockf advlock;
232 u_int depth; /* directory depth */
233 hammer2_off_t delta_dcount; /* adjust data_count */
234 hammer2_off_t delta_icount; /* adjust inode_count */
237 typedef struct hammer2_inode hammer2_inode_t;
240 * A hammer2 indirect block
242 struct hammer2_indblock {
243 hammer2_chain_t chain;
246 typedef struct hammer2_indblock hammer2_indblock_t;
249 * A hammer2 data block
251 struct hammer2_data {
252 hammer2_chain_t chain;
255 typedef struct hammer2_data hammer2_data_t;
257 struct hammer2_freecache {
259 hammer2_off_t single;
262 typedef struct hammer2_freecache hammer2_freecache_t;
265 * Global (per device) mount structure for device (aka vp->v_mount->hmp)
267 struct hammer2_mount {
268 struct vnode *devvp; /* device vnode */
269 int ronly; /* read-only mount */
270 int pmp_count; /* PFS mounts backed by us */
271 TAILQ_ENTRY(hammer2_mount) mntentry; /* hammer2_mntlist */
273 struct malloc_type *minode;
277 struct malloc_type *mchain;
280 hammer2_chain_t vchain; /* anchor chain */
281 hammer2_chain_t *schain; /* super-root */
282 struct lock alloclk; /* lockmgr lock */
283 struct lock voldatalk; /* lockmgr lock */
285 hammer2_volume_data_t voldata;
286 hammer2_freecache_t freecache[HAMMER2_FREECACHE_TYPES][HAMMER2_MAX_RADIX+1];
289 typedef struct hammer2_mount hammer2_mount_t;
292 * Per-PFS mount structure for device (aka vp->v_mount)
294 struct hammer2_pfsmount {
295 struct mount *mp; /* kernel mount */
296 struct hammer2_mount *hmp; /* device global mount */
297 hammer2_chain_t *rchain; /* PFS root chain */
298 hammer2_inode_t *iroot; /* PFS root inode */
299 struct netexport export; /* nfs export */
300 int ronly; /* read-only mount */
303 typedef struct hammer2_pfsmount hammer2_pfsmount_t;
307 MALLOC_DECLARE(M_HAMMER2);
309 #define VTOI(vp) ((hammer2_inode_t *)(vp)->v_data)
310 #define ITOV(ip) ((ip)->vp)
314 MPTOPMP(struct mount *mp)
316 return ((hammer2_pfsmount_t *)mp->mnt_data);
321 MPTOHMP(struct mount *mp)
323 return (((hammer2_pfsmount_t *)mp->mnt_data)->hmp);
326 extern struct vop_ops hammer2_vnode_vops;
327 extern struct vop_ops hammer2_spec_vops;
328 extern struct vop_ops hammer2_fifo_vops;
330 extern int hammer2_debug;
331 extern int hammer2_cluster_enable;
332 extern int hammer2_hardlink_enable;
333 extern long hammer2_iod_file_read;
334 extern long hammer2_iod_meta_read;
335 extern long hammer2_iod_indr_read;
336 extern long hammer2_iod_file_write;
337 extern long hammer2_iod_meta_write;
338 extern long hammer2_iod_indr_write;
339 extern long hammer2_iod_volu_write;
340 extern long hammer2_ioa_file_read;
341 extern long hammer2_ioa_meta_read;
342 extern long hammer2_ioa_indr_read;
343 extern long hammer2_ioa_file_write;
344 extern long hammer2_ioa_meta_write;
345 extern long hammer2_ioa_indr_write;
346 extern long hammer2_ioa_volu_write;
351 void hammer2_inode_lock_ex(hammer2_inode_t *ip);
352 void hammer2_inode_unlock_ex(hammer2_inode_t *ip);
353 void hammer2_inode_lock_sh(hammer2_inode_t *ip);
354 void hammer2_inode_unlock_sh(hammer2_inode_t *ip);
355 void hammer2_inode_busy(hammer2_inode_t *ip);
356 void hammer2_inode_unbusy(hammer2_inode_t *ip);
357 void hammer2_voldata_lock(hammer2_mount_t *hmp);
358 void hammer2_voldata_unlock(hammer2_mount_t *hmp);
360 void hammer2_mount_exlock(hammer2_mount_t *hmp);
361 void hammer2_mount_shlock(hammer2_mount_t *hmp);
362 void hammer2_mount_unlock(hammer2_mount_t *hmp);
364 int hammer2_get_dtype(hammer2_inode_t *ip);
365 int hammer2_get_vtype(hammer2_inode_t *ip);
366 u_int8_t hammer2_get_obj_type(enum vtype vtype);
367 void hammer2_time_to_timespec(u_int64_t xtime, struct timespec *ts);
368 u_int64_t hammer2_timespec_to_time(struct timespec *ts);
369 u_int32_t hammer2_to_unix_xid(uuid_t *uuid);
370 void hammer2_guid_to_uuid(uuid_t *uuid, u_int32_t guid);
372 hammer2_key_t hammer2_dirhash(const unsigned char *name, size_t len);
373 int hammer2_bytes_to_radix(size_t bytes);
375 int hammer2_calc_logical(hammer2_inode_t *ip, hammer2_off_t uoff,
376 hammer2_key_t *lbasep, hammer2_key_t *leofp);
377 void hammer2_update_time(uint64_t *timep);
382 struct vnode *hammer2_igetv(hammer2_inode_t *ip, int *errorp);
384 void hammer2_inode_lock_nlinks(hammer2_inode_t *ip);
385 void hammer2_inode_unlock_nlinks(hammer2_inode_t *ip);
386 hammer2_inode_t *hammer2_inode_alloc(hammer2_pfsmount_t *pmp, void *data);
387 void hammer2_inode_free(hammer2_inode_t *ip);
388 void hammer2_inode_ref(hammer2_inode_t *ip);
389 void hammer2_inode_drop(hammer2_inode_t *ip);
390 int hammer2_inode_calc_alloc(hammer2_key_t filesize);
392 int hammer2_inode_create(hammer2_inode_t *dip,
393 struct vattr *vap, struct ucred *cred,
394 const uint8_t *name, size_t name_len,
395 hammer2_inode_t **nipp);
397 int hammer2_inode_duplicate(hammer2_inode_t *dip,
398 hammer2_inode_t *oip, hammer2_inode_t **nipp,
399 const uint8_t *name, size_t name_len);
400 int hammer2_inode_connect(hammer2_inode_t *dip, hammer2_inode_t *oip,
401 const uint8_t *name, size_t name_len);
403 int hammer2_unlink_file(hammer2_inode_t *dip,
404 const uint8_t *name, size_t name_len,
405 int isdir, hammer2_inode_t *retain_ip);
406 int hammer2_hardlink_consolidate(hammer2_inode_t **ipp, hammer2_inode_t *tdip);
407 int hammer2_hardlink_deconsolidate(hammer2_inode_t *dip,
408 hammer2_chain_t **chainp, hammer2_inode_t **ipp);
409 int hammer2_hardlink_find(hammer2_inode_t *dip, hammer2_chain_t **chainp,
410 hammer2_inode_t **ipp);
415 void hammer2_modify_volume(hammer2_mount_t *hmp);
416 hammer2_chain_t *hammer2_chain_alloc(hammer2_mount_t *hmp,
417 hammer2_blockref_t *bref);
418 void hammer2_chain_free(hammer2_mount_t *hmp, hammer2_chain_t *chain);
419 void hammer2_chain_ref(hammer2_mount_t *hmp, hammer2_chain_t *chain);
420 void hammer2_chain_drop(hammer2_mount_t *hmp, hammer2_chain_t *chain);
421 int hammer2_chain_lock(hammer2_mount_t *hmp, hammer2_chain_t *chain, int how);
422 void hammer2_chain_moved(hammer2_mount_t *hmp, hammer2_chain_t *chain);
423 void hammer2_chain_modify(hammer2_mount_t *hmp, hammer2_chain_t *chain,
425 void hammer2_chain_resize(hammer2_inode_t *ip, hammer2_chain_t *chain,
426 int nradix, int flags);
427 void hammer2_chain_unlock(hammer2_mount_t *hmp, hammer2_chain_t *chain);
428 hammer2_chain_t *hammer2_chain_find(hammer2_mount_t *hmp,
429 hammer2_chain_t *parent, int index);
430 hammer2_chain_t *hammer2_chain_get(hammer2_mount_t *hmp,
431 hammer2_chain_t *parent,
432 int index, int flags);
433 hammer2_chain_t *hammer2_chain_lookup(hammer2_mount_t *hmp,
434 hammer2_chain_t **parentp,
435 hammer2_key_t key_beg, hammer2_key_t key_end,
437 hammer2_chain_t *hammer2_chain_next(hammer2_mount_t *hmp,
438 hammer2_chain_t **parentp,
439 hammer2_chain_t *chain,
440 hammer2_key_t key_beg, hammer2_key_t key_end,
442 hammer2_chain_t *hammer2_chain_create(hammer2_mount_t *hmp,
443 hammer2_chain_t *parent,
444 hammer2_chain_t *chain,
445 hammer2_key_t key, int keybits,
446 int type, size_t bytes);
447 void hammer2_chain_delete(hammer2_mount_t *hmp, hammer2_chain_t *parent,
448 hammer2_chain_t *chain, int retain);
449 void hammer2_chain_flush(hammer2_mount_t *hmp, hammer2_chain_t *chain,
450 hammer2_tid_t modify_tid);
451 void hammer2_chain_commit(hammer2_mount_t *hmp, hammer2_chain_t *chain);
456 int hammer2_ioctl(hammer2_inode_t *ip, u_long com, void *data,
457 int fflag, struct ucred *cred);
462 hammer2_off_t hammer2_freemap_alloc(hammer2_mount_t *hmp,
463 int type, size_t bytes);
464 void hammer2_freemap_free(hammer2_mount_t *hmp, hammer2_off_t data_off,
467 #endif /* !_KERNEL */
468 #endif /* !_VFS_HAMMER2_HAMMER2_H_ */