Mercurial > illumos > illumos-gate

annotate usr/src/uts/common/fs/zfs/sys/arc.h @ 11539:10d35fc3d7fd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
6873106 Need a mechanism to share buffers between fs modules
author chunli zhang - Sun Microsystems - Irvine United States <Chunli.Zhang@Sun.COM>
date Mon, 18 Jan 2010 10:34:16 -0800
parents e2081f502306
children 7cf402a7f374
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
789
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
1 /*
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
2 * CDDL HEADER START
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
3 *
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
4 * The contents of this file are subject to the terms of the
1544
938876158511 PSARC 2006/077 zpool clear
eschrock
parents: 789
diff changeset
5 * Common Development and Distribution License (the "License").
938876158511 PSARC 2006/077 zpool clear
eschrock
parents: 789
diff changeset
6 * You may not use this file except in compliance with the License.
789
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
7 *
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
9 * or http://www.opensolaris.org/os/licensing.
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
10 * See the License for the specific language governing permissions
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
11 * and limitations under the License.
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
12 *
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
13 * When distributing Covered Code, include this CDDL HEADER in each
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
15 * If applicable, add the following below this CDDL HEADER, with the
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
16 * fields enclosed by brackets "[]" replaced with your own identifying
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
17 * information: Portions Copyright [yyyy] [name of copyright owner]
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
18 *
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
19 * CDDL HEADER END
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
20 */
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
21 /*
11539
10d35fc3d7fd 6873106 Need a mechanism to share buffers between fs modules
chunli zhang - Sun Microsystems - Irvine United States <Chunli.Zhang@Sun.COM>
parents: 10922
diff changeset
22 * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
789
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
23 * Use is subject to license terms.
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
24 */
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
25
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
26 #ifndef _SYS_ARC_H
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
27 #define _SYS_ARC_H
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
28
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
29 #include <sys/zfs_context.h>
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
30
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
31 #ifdef __cplusplus
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
32 extern "C" {
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
33 #endif
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
34
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
35 #include <sys/zio.h>
4849
3a61e0a9a953 6536043 arc_byteswap_func_t and dmu_byteswap_func_t are redundant
ahrens
parents: 4309
diff changeset
36 #include <sys/dmu.h>
5450
b25030891c44 PSARC 2007/618 ZFS L2ARC
brendan
parents: 4849
diff changeset
37 #include <sys/spa.h>
789
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
38
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
39 typedef struct arc_buf_hdr arc_buf_hdr_t;
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
40 typedef struct arc_buf arc_buf_t;
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
41 typedef void arc_done_func_t(zio_t *zio, arc_buf_t *buf, void *private);
1544
938876158511 PSARC 2006/077 zpool clear
eschrock
parents: 789
diff changeset
42 typedef int arc_evict_func_t(void *private);
789
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
43
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
44 /* generic arc_done_func_t's which you can use */
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
45 arc_done_func_t arc_bcopy_func;
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
46 arc_done_func_t arc_getbuf_func;
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
47
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
48 struct arc_buf {
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
49 arc_buf_hdr_t *b_hdr;
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
50 arc_buf_t *b_next;
7545
d8ac8023a8e3 6737207 assertion failed: race between arc_release() and arc_referenced()
Mark Maybee <Mark.Maybee@Sun.COM>
parents: 7237
diff changeset
51 krwlock_t b_lock;
789
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
52 void *b_data;
1544
938876158511 PSARC 2006/077 zpool clear
eschrock
parents: 789
diff changeset
53 arc_evict_func_t *b_efunc;
938876158511 PSARC 2006/077 zpool clear
eschrock
parents: 789
diff changeset
54 void *b_private;
789
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
55 };
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
56
3290
256464cbb73c 4894692 caching data in heap inflates crash dump
johansen
parents: 3093
diff changeset
57 typedef enum arc_buf_contents {
256464cbb73c 4894692 caching data in heap inflates crash dump
johansen
parents: 3093
diff changeset
58 ARC_BUFC_DATA, /* buffer contains data */
4309
3dfde0f4662d 6542676 ARC needs to track meta-data memory overhead
maybee
parents: 3547
diff changeset
59 ARC_BUFC_METADATA, /* buffer contains metadata */
3dfde0f4662d 6542676 ARC needs to track meta-data memory overhead
maybee
parents: 3547
diff changeset
60 ARC_BUFC_NUMTYPES
3290
256464cbb73c 4894692 caching data in heap inflates crash dump
johansen
parents: 3093
diff changeset
61 } arc_buf_contents_t;
789
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
62 /*
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
63 * These are the flags we pass into calls to the arc
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
64 */
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
65 #define ARC_WAIT (1 << 1) /* perform I/O synchronously */
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
66 #define ARC_NOWAIT (1 << 2) /* perform I/O asynchronously */
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
67 #define ARC_PREFETCH (1 << 3) /* I/O is a prefetch */
2391
2fa3fd1db808 6447377 ZFS prefetch is inconsistant
maybee
parents: 1775
diff changeset
68 #define ARC_CACHED (1 << 4) /* I/O was already in cache */
7237
f47d41541b14 PSARC 2008/393 zfs primarycache and secondarycache properties
ek110237
parents: 7046
diff changeset
69 #define ARC_L2CACHE (1 << 5) /* cache in L2ARC */
789
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
70
8582
df9361868dbe 6748019 ARC/L2ARC metadata accounting for arc_size
Brendan Gregg - Sun Microsystems <Brendan.Gregg@Sun.COM>
parents: 7872
diff changeset
71 /*
df9361868dbe 6748019 ARC/L2ARC metadata accounting for arc_size
Brendan Gregg - Sun Microsystems <Brendan.Gregg@Sun.COM>
parents: 7872
diff changeset
72 * The following breakdows of arc_size exist for kstat only.
df9361868dbe 6748019 ARC/L2ARC metadata accounting for arc_size
Brendan Gregg - Sun Microsystems <Brendan.Gregg@Sun.COM>
parents: 7872
diff changeset
73 */
df9361868dbe 6748019 ARC/L2ARC metadata accounting for arc_size
Brendan Gregg - Sun Microsystems <Brendan.Gregg@Sun.COM>
parents: 7872
diff changeset
74 typedef enum arc_space_type {
df9361868dbe 6748019 ARC/L2ARC metadata accounting for arc_size
Brendan Gregg - Sun Microsystems <Brendan.Gregg@Sun.COM>
parents: 7872
diff changeset
75 ARC_SPACE_DATA,
df9361868dbe 6748019 ARC/L2ARC metadata accounting for arc_size
Brendan Gregg - Sun Microsystems <Brendan.Gregg@Sun.COM>
parents: 7872
diff changeset
76 ARC_SPACE_HDRS,
df9361868dbe 6748019 ARC/L2ARC metadata accounting for arc_size
Brendan Gregg - Sun Microsystems <Brendan.Gregg@Sun.COM>
parents: 7872
diff changeset
77 ARC_SPACE_L2HDRS,
df9361868dbe 6748019 ARC/L2ARC metadata accounting for arc_size
Brendan Gregg - Sun Microsystems <Brendan.Gregg@Sun.COM>
parents: 7872
diff changeset
78 ARC_SPACE_OTHER,
df9361868dbe 6748019 ARC/L2ARC metadata accounting for arc_size
Brendan Gregg - Sun Microsystems <Brendan.Gregg@Sun.COM>
parents: 7872
diff changeset
79 ARC_SPACE_NUMTYPES
df9361868dbe 6748019 ARC/L2ARC metadata accounting for arc_size
Brendan Gregg - Sun Microsystems <Brendan.Gregg@Sun.COM>
parents: 7872
diff changeset
80 } arc_space_type_t;
df9361868dbe 6748019 ARC/L2ARC metadata accounting for arc_size
Brendan Gregg - Sun Microsystems <Brendan.Gregg@Sun.COM>
parents: 7872
diff changeset
81
df9361868dbe 6748019 ARC/L2ARC metadata accounting for arc_size
Brendan Gregg - Sun Microsystems <Brendan.Gregg@Sun.COM>
parents: 7872
diff changeset
82 void arc_space_consume(uint64_t space, arc_space_type_t type);
df9361868dbe 6748019 ARC/L2ARC metadata accounting for arc_size
Brendan Gregg - Sun Microsystems <Brendan.Gregg@Sun.COM>
parents: 7872
diff changeset
83 void arc_space_return(uint64_t space, arc_space_type_t type);
4309
3dfde0f4662d 6542676 ARC needs to track meta-data memory overhead
maybee
parents: 3547
diff changeset
84 void *arc_data_buf_alloc(uint64_t space);
3dfde0f4662d 6542676 ARC needs to track meta-data memory overhead
maybee
parents: 3547
diff changeset
85 void arc_data_buf_free(void *buf, uint64_t space);
3290
256464cbb73c 4894692 caching data in heap inflates crash dump
johansen
parents: 3093
diff changeset
86 arc_buf_t *arc_buf_alloc(spa_t *spa, int size, void *tag,
256464cbb73c 4894692 caching data in heap inflates crash dump
johansen
parents: 3093
diff changeset
87 arc_buf_contents_t type);
9412
4aefd8704ce0 6717022 ZFS DMU needs zero-copy support
Aleksandr Guzovskiy <Aleksandr.Guzovskiy@Sun.COM>
parents: 8582
diff changeset
88 arc_buf_t *arc_loan_buf(spa_t *spa, int size);
4aefd8704ce0 6717022 ZFS DMU needs zero-copy support
Aleksandr Guzovskiy <Aleksandr.Guzovskiy@Sun.COM>
parents: 8582
diff changeset
89 void arc_return_buf(arc_buf_t *buf, void *tag);
11539
10d35fc3d7fd 6873106 Need a mechanism to share buffers between fs modules
chunli zhang - Sun Microsystems - Irvine United States <Chunli.Zhang@Sun.COM>
parents: 10922
diff changeset
90 void arc_loan_inuse_buf(arc_buf_t *buf, void *tag);
1544
938876158511 PSARC 2006/077 zpool clear
eschrock
parents: 789
diff changeset
91 void arc_buf_add_ref(arc_buf_t *buf, void *tag);
938876158511 PSARC 2006/077 zpool clear
eschrock
parents: 789
diff changeset
92 int arc_buf_remove_ref(arc_buf_t *buf, void *tag);
789
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
93 int arc_buf_size(arc_buf_t *buf);
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
94 void arc_release(arc_buf_t *buf, void *tag);
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
95 int arc_released(arc_buf_t *buf);
1544
938876158511 PSARC 2006/077 zpool clear
eschrock
parents: 789
diff changeset
96 int arc_has_callback(arc_buf_t *buf);
3093
71525e4187d5 6490569 verify arc bufs are not modified when they shouldn't be
ahrens
parents: 2391
diff changeset
97 void arc_buf_freeze(arc_buf_t *buf);
71525e4187d5 6490569 verify arc bufs are not modified when they shouldn't be
ahrens
parents: 2391
diff changeset
98 void arc_buf_thaw(arc_buf_t *buf);
1544
938876158511 PSARC 2006/077 zpool clear
eschrock
parents: 789
diff changeset
99 #ifdef ZFS_DEBUG
938876158511 PSARC 2006/077 zpool clear
eschrock
parents: 789
diff changeset
100 int arc_referenced(arc_buf_t *buf);
938876158511 PSARC 2006/077 zpool clear
eschrock
parents: 789
diff changeset
101 #endif
789
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
102
10922
e2081f502306 PSARC 2009/571 ZFS Deduplication Properties
Jeff Bonwick <Jeff.Bonwick@Sun.COM>
parents: 10407
diff changeset
103 int arc_read(zio_t *pio, spa_t *spa, const blkptr_t *bp, arc_buf_t *pbuf,
7237
f47d41541b14 PSARC 2008/393 zfs primarycache and secondarycache properties
ek110237
parents: 7046
diff changeset
104 arc_done_func_t *done, void *private, int priority, int zio_flags,
7046
361307ae060d 6343667 scrub/resilver has to start over when a snapshot is taken
ahrens
parents: 6643
diff changeset
105 uint32_t *arc_flags, const zbookmark_t *zb);
10922
e2081f502306 PSARC 2009/571 ZFS Deduplication Properties
Jeff Bonwick <Jeff.Bonwick@Sun.COM>
parents: 10407
diff changeset
106 int arc_read_nolock(zio_t *pio, spa_t *spa, const blkptr_t *bp,
7046
361307ae060d 6343667 scrub/resilver has to start over when a snapshot is taken
ahrens
parents: 6643
diff changeset
107 arc_done_func_t *done, void *private, int priority, int flags,
361307ae060d 6343667 scrub/resilver has to start over when a snapshot is taken
ahrens
parents: 6643
diff changeset
108 uint32_t *arc_flags, const zbookmark_t *zb);
10922
e2081f502306 PSARC 2009/571 ZFS Deduplication Properties
Jeff Bonwick <Jeff.Bonwick@Sun.COM>
parents: 10407
diff changeset
109 zio_t *arc_write(zio_t *pio, spa_t *spa, uint64_t txg,
e2081f502306 PSARC 2009/571 ZFS Deduplication Properties
Jeff Bonwick <Jeff.Bonwick@Sun.COM>
parents: 10407
diff changeset
110 blkptr_t *bp, arc_buf_t *buf, boolean_t l2arc, const zio_prop_t *zp,
e2081f502306 PSARC 2009/571 ZFS Deduplication Properties
Jeff Bonwick <Jeff.Bonwick@Sun.COM>
parents: 10407
diff changeset
111 arc_done_func_t *ready, arc_done_func_t *done, void *private,
e2081f502306 PSARC 2009/571 ZFS Deduplication Properties
Jeff Bonwick <Jeff.Bonwick@Sun.COM>
parents: 10407
diff changeset
112 int priority, int zio_flags, const zbookmark_t *zb);
e2081f502306 PSARC 2009/571 ZFS Deduplication Properties
Jeff Bonwick <Jeff.Bonwick@Sun.COM>
parents: 10407
diff changeset
113 void arc_free(spa_t *spa, const blkptr_t *bp);
789
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
114
1544
938876158511 PSARC 2006/077 zpool clear
eschrock
parents: 789
diff changeset
115 void arc_set_callback(arc_buf_t *buf, arc_evict_func_t *func, void *private);
938876158511 PSARC 2006/077 zpool clear
eschrock
parents: 789
diff changeset
116 int arc_buf_evict(arc_buf_t *buf);
938876158511 PSARC 2006/077 zpool clear
eschrock
parents: 789
diff changeset
117
5642
504c84876fda 6513209 Destroying pools under stress caused a hang in arc_flush
maybee
parents: 5450
diff changeset
118 void arc_flush(spa_t *spa);
6245
1a2a7cfb9f26 6429205 each zpool needs to monitor its throughput and throttle heavy writers
maybee
parents: 5642
diff changeset
119 void arc_tempreserve_clear(uint64_t reserve);
1a2a7cfb9f26 6429205 each zpool needs to monitor its throughput and throttle heavy writers
maybee
parents: 5642
diff changeset
120 int arc_tempreserve_space(uint64_t reserve, uint64_t txg);
789
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
121
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
122 void arc_init(void);
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
123 void arc_fini(void);
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
124
5450
b25030891c44 PSARC 2007/618 ZFS L2ARC
brendan
parents: 4849
diff changeset
125 /*
b25030891c44 PSARC 2007/618 ZFS L2ARC
brendan
parents: 4849
diff changeset
126 * Level 2 ARC
b25030891c44 PSARC 2007/618 ZFS L2ARC
brendan
parents: 4849
diff changeset
127 */
b25030891c44 PSARC 2007/618 ZFS L2ARC
brendan
parents: 4849
diff changeset
128
9816
847676ec1c5b PSARC 2008/353 zpool autoexpand property
George Wilson <George.Wilson@Sun.COM>
parents: 9412
diff changeset
129 void l2arc_add_vdev(spa_t *spa, vdev_t *vd);
5450
b25030891c44 PSARC 2007/618 ZFS L2ARC
brendan
parents: 4849
diff changeset
130 void l2arc_remove_vdev(vdev_t *vd);
6643
3a34b0dbb107 6625086 changing cachefile doesn't remove old cache on last user
eschrock
parents: 6245
diff changeset
131 boolean_t l2arc_vdev_present(vdev_t *vd);
5450
b25030891c44 PSARC 2007/618 ZFS L2ARC
brendan
parents: 4849
diff changeset
132 void l2arc_init(void);
b25030891c44 PSARC 2007/618 ZFS L2ARC
brendan
parents: 4849
diff changeset
133 void l2arc_fini(void);
7754
b80e4842ad54 6754011 SPA 3.0: lock breakup, i/o pipeline refactoring, device failure handling
Jeff Bonwick <Jeff.Bonwick@Sun.COM>
parents: 7545
diff changeset
134 void l2arc_start(void);
b80e4842ad54 6754011 SPA 3.0: lock breakup, i/o pipeline refactoring, device failure handling
Jeff Bonwick <Jeff.Bonwick@Sun.COM>
parents: 7545
diff changeset
135 void l2arc_stop(void);
5450
b25030891c44 PSARC 2007/618 ZFS L2ARC
brendan
parents: 4849
diff changeset
136
789
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
137 #ifdef __cplusplus
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
138 }
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
139 #endif
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
140
b348f31ed315 PSARC 2002/240 ZFS
ahrens
parents:
diff changeset
141 #endif /* _SYS_ARC_H */