4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2012, 2017 by Delphix. All rights reserved.
24 * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
30 #include <sys/zfs_context.h>
41 * Used by arc_flush() to inform arc_evict_state() that it should evict
42 * all available buffers from the arc state being passed in.
44 #define ARC_EVICT_ALL -1ULL
46 #define HDR_SET_LSIZE(hdr, x) do { \
47 ASSERT(IS_P2ALIGNED(x, 1U << SPA_MINBLOCKSHIFT)); \
48 (hdr)->b_lsize = ((x) >> SPA_MINBLOCKSHIFT); \
49 _NOTE(CONSTCOND) } while (0)
51 #define HDR_SET_PSIZE(hdr, x) do { \
52 ASSERT(IS_P2ALIGNED((x), 1U << SPA_MINBLOCKSHIFT)); \
53 (hdr)->b_psize = ((x) >> SPA_MINBLOCKSHIFT); \
54 _NOTE(CONSTCOND) } while (0)
56 #define HDR_GET_LSIZE(hdr) ((hdr)->b_lsize << SPA_MINBLOCKSHIFT)
57 #define HDR_GET_PSIZE(hdr) ((hdr)->b_psize << SPA_MINBLOCKSHIFT)
59 typedef struct arc_buf_hdr arc_buf_hdr_t;
60 typedef struct arc_buf arc_buf_t;
61 typedef void arc_read_done_func_t(zio_t *zio, const zbookmark_phys_t *zb,
62 const blkptr_t *bp, arc_buf_t *buf, void *priv);
63 typedef void arc_write_done_func_t(zio_t *zio, arc_buf_t *buf, void *priv);
65 /* generic arc_done_func_t's which you can use */
66 arc_read_done_func_t arc_bcopy_func;
67 arc_read_done_func_t arc_getbuf_func;
69 typedef enum arc_flags
72 * Public flags that can be passed into the ARC by external consumers.
74 ARC_FLAG_WAIT = 1 << 0, /* perform sync I/O */
75 ARC_FLAG_NOWAIT = 1 << 1, /* perform async I/O */
76 ARC_FLAG_PREFETCH = 1 << 2, /* I/O is a prefetch */
77 ARC_FLAG_CACHED = 1 << 3, /* I/O was in cache */
78 ARC_FLAG_L2CACHE = 1 << 4, /* cache in L2ARC */
79 ARC_FLAG_PREDICTIVE_PREFETCH = 1 << 5, /* I/O from zfetch */
80 ARC_FLAG_PRESCIENT_PREFETCH = 1 << 6, /* long min lifespan */
83 * Private ARC flags. These flags are private ARC only flags that
84 * will show up in b_flags in the arc_hdr_buf_t. These flags should
85 * only be set by ARC code.
87 ARC_FLAG_IN_HASH_TABLE = 1 << 7, /* buffer is hashed */
88 ARC_FLAG_IO_IN_PROGRESS = 1 << 8, /* I/O in progress */
89 ARC_FLAG_IO_ERROR = 1 << 9, /* I/O failed for buf */
90 ARC_FLAG_INDIRECT = 1 << 10, /* indirect block */
91 /* Indicates that block was read with ASYNC priority. */
92 ARC_FLAG_PRIO_ASYNC_READ = 1 << 11,
93 ARC_FLAG_L2_WRITING = 1 << 12, /* write in progress */
94 ARC_FLAG_L2_EVICTED = 1 << 13, /* evicted during I/O */
95 ARC_FLAG_L2_WRITE_HEAD = 1 << 14, /* head of write list */
96 /* indicates that the buffer contains metadata (otherwise, data) */
97 ARC_FLAG_BUFC_METADATA = 1 << 15,
99 /* Flags specifying whether optional hdr struct fields are defined */
100 ARC_FLAG_HAS_L1HDR = 1 << 16,
101 ARC_FLAG_HAS_L2HDR = 1 << 17,
104 * Indicates the arc_buf_hdr_t's b_pdata matches the on-disk data.
105 * This allows the l2arc to use the blkptr's checksum to verify
106 * the data without having to store the checksum in the hdr.
108 ARC_FLAG_COMPRESSED_ARC = 1 << 18,
109 ARC_FLAG_SHARED_DATA = 1 << 19,
112 * The arc buffer's compression mode is stored in the top 7 bits of the
113 * flags field, so these dummy flags are included so that MDB can
114 * interpret the enum properly.
116 ARC_FLAG_COMPRESS_0 = 1 << 24,
117 ARC_FLAG_COMPRESS_1 = 1 << 25,
118 ARC_FLAG_COMPRESS_2 = 1 << 26,
119 ARC_FLAG_COMPRESS_3 = 1 << 27,
120 ARC_FLAG_COMPRESS_4 = 1 << 28,
121 ARC_FLAG_COMPRESS_5 = 1 << 29,
122 ARC_FLAG_COMPRESS_6 = 1 << 30
126 typedef enum arc_buf_flags {
127 ARC_BUF_FLAG_SHARED = 1 << 0,
128 ARC_BUF_FLAG_COMPRESSED = 1 << 1
132 arc_buf_hdr_t *b_hdr;
134 kmutex_t b_evict_lock;
136 arc_buf_flags_t b_flags;
139 typedef enum arc_buf_contents {
140 ARC_BUFC_INVALID, /* invalid type */
141 ARC_BUFC_DATA, /* buffer contains data */
142 ARC_BUFC_METADATA, /* buffer contains metadata */
144 } arc_buf_contents_t;
147 * The following breakdows of arc_size exist for kstat only.
149 typedef enum arc_space_type {
158 void arc_space_consume(uint64_t space, arc_space_type_t type);
159 void arc_space_return(uint64_t space, arc_space_type_t type);
160 boolean_t arc_is_metadata(arc_buf_t *buf);
161 enum zio_compress arc_get_compression(arc_buf_t *buf);
162 int arc_decompress(arc_buf_t *buf);
163 arc_buf_t *arc_alloc_buf(spa_t *spa, void *tag, arc_buf_contents_t type,
165 arc_buf_t *arc_alloc_compressed_buf(spa_t *spa, void *tag,
166 uint64_t psize, uint64_t lsize, enum zio_compress compression_type);
167 arc_buf_t *arc_loan_buf(spa_t *spa, boolean_t is_metadata, int size);
168 arc_buf_t *arc_loan_compressed_buf(spa_t *spa, uint64_t psize, uint64_t lsize,
169 enum zio_compress compression_type);
170 void arc_return_buf(arc_buf_t *buf, void *tag);
171 void arc_loan_inuse_buf(arc_buf_t *buf, void *tag);
172 void arc_buf_destroy(arc_buf_t *buf, void *tag);
173 int arc_buf_size(arc_buf_t *buf);
174 int arc_buf_lsize(arc_buf_t *buf);
175 void arc_buf_access(arc_buf_t *buf);
176 void arc_release(arc_buf_t *buf, void *tag);
177 int arc_released(arc_buf_t *buf);
178 void arc_buf_freeze(arc_buf_t *buf);
179 void arc_buf_thaw(arc_buf_t *buf);
181 int arc_referenced(arc_buf_t *buf);
184 int arc_read(zio_t *pio, spa_t *spa, const blkptr_t *bp,
185 arc_read_done_func_t *done, void *priv, zio_priority_t priority,
186 int flags, arc_flags_t *arc_flags, const zbookmark_phys_t *zb);
187 zio_t *arc_write(zio_t *pio, spa_t *spa, uint64_t txg,
188 blkptr_t *bp, arc_buf_t *buf, boolean_t l2arc, const zio_prop_t *zp,
189 arc_write_done_func_t *ready, arc_write_done_func_t *child_ready,
190 arc_write_done_func_t *physdone, arc_write_done_func_t *done,
191 void *priv, zio_priority_t priority, int zio_flags,
192 const zbookmark_phys_t *zb);
193 void arc_freed(spa_t *spa, const blkptr_t *bp);
195 void arc_flush(spa_t *spa, boolean_t retry);
196 void arc_tempreserve_clear(uint64_t reserve);
197 int arc_tempreserve_space(spa_t *spa, uint64_t reserve, uint64_t txg);
199 uint64_t arc_max_bytes(void);
207 void l2arc_add_vdev(spa_t *spa, vdev_t *vd);
208 void l2arc_remove_vdev(vdev_t *vd);
209 boolean_t l2arc_vdev_present(vdev_t *vd);
210 void l2arc_init(void);
211 void l2arc_fini(void);
212 void l2arc_start(void);
213 void l2arc_stop(void);
217 extern boolean_t arc_watch;
218 extern int arc_procfd;
226 #endif /* _SYS_ARC_H */