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) 2013 by Delphix. All rights reserved.
24 * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
30 #include <sys/zfs_context.h>
39 #include <sys/refcount.h>
41 typedef struct arc_buf_hdr arc_buf_hdr_t;
42 typedef struct arc_buf arc_buf_t;
43 typedef struct arc_prune arc_prune_t;
44 typedef void arc_done_func_t(zio_t *zio, arc_buf_t *buf, void *private);
45 typedef void arc_prune_func_t(int64_t bytes, void *private);
46 typedef int arc_evict_func_t(void *private);
48 /* generic arc_done_func_t's which you can use */
49 arc_done_func_t arc_bcopy_func;
50 arc_done_func_t arc_getbuf_func;
52 /* generic arc_prune_func_t wrapper for callbacks */
54 arc_prune_func_t *p_pfunc;
63 kmutex_t b_evict_lock;
65 arc_evict_func_t *b_efunc;
69 typedef enum arc_buf_contents {
70 ARC_BUFC_DATA, /* buffer contains data */
71 ARC_BUFC_METADATA, /* buffer contains metadata */
75 * These are the flags we pass into calls to the arc
77 #define ARC_WAIT (1 << 1) /* perform I/O synchronously */
78 #define ARC_NOWAIT (1 << 2) /* perform I/O asynchronously */
79 #define ARC_PREFETCH (1 << 3) /* I/O is a prefetch */
80 #define ARC_CACHED (1 << 4) /* I/O was already in cache */
81 #define ARC_L2CACHE (1 << 5) /* cache in L2ARC */
82 #define ARC_L2COMPRESS (1 << 6) /* compress in L2ARC */
85 * The following breakdows of arc_size exist for kstat only.
87 typedef enum arc_space_type {
95 void arc_space_consume(uint64_t space, arc_space_type_t type);
96 void arc_space_return(uint64_t space, arc_space_type_t type);
97 arc_buf_t *arc_buf_alloc(spa_t *spa, int size, void *tag,
98 arc_buf_contents_t type);
99 arc_buf_t *arc_loan_buf(spa_t *spa, int size);
100 void arc_return_buf(arc_buf_t *buf, void *tag);
101 void arc_loan_inuse_buf(arc_buf_t *buf, void *tag);
102 void arc_buf_add_ref(arc_buf_t *buf, void *tag);
103 int arc_buf_remove_ref(arc_buf_t *buf, void *tag);
104 int arc_buf_size(arc_buf_t *buf);
105 void arc_release(arc_buf_t *buf, void *tag);
106 int arc_released(arc_buf_t *buf);
107 int arc_has_callback(arc_buf_t *buf);
108 void arc_buf_freeze(arc_buf_t *buf);
109 void arc_buf_thaw(arc_buf_t *buf);
110 boolean_t arc_buf_eviction_needed(arc_buf_t *buf);
112 int arc_referenced(arc_buf_t *buf);
115 int arc_read(zio_t *pio, spa_t *spa, const blkptr_t *bp,
116 arc_done_func_t *done, void *private, int priority, int flags,
117 uint32_t *arc_flags, const zbookmark_t *zb);
118 zio_t *arc_write(zio_t *pio, spa_t *spa, uint64_t txg,
119 blkptr_t *bp, arc_buf_t *buf, boolean_t l2arc, boolean_t l2arc_compress,
120 const zio_prop_t *zp, arc_done_func_t *ready, arc_done_func_t *done,
121 void *private, int priority, int zio_flags, const zbookmark_t *zb);
123 arc_prune_t *arc_add_prune_callback(arc_prune_func_t *func, void *private);
124 void arc_remove_prune_callback(arc_prune_t *p);
125 void arc_freed(spa_t *spa, const blkptr_t *bp);
127 void arc_set_callback(arc_buf_t *buf, arc_evict_func_t *func, void *private);
128 int arc_buf_evict(arc_buf_t *buf);
130 void arc_adjust_meta(int64_t adjustment, boolean_t may_prune);
131 void arc_flush(spa_t *spa);
132 void arc_tempreserve_clear(uint64_t reserve);
133 int arc_tempreserve_space(uint64_t reserve, uint64_t txg);
142 void l2arc_add_vdev(spa_t *spa, vdev_t *vd);
143 void l2arc_remove_vdev(vdev_t *vd);
144 boolean_t l2arc_vdev_present(vdev_t *vd);
145 void l2arc_init(void);
146 void l2arc_fini(void);
147 void l2arc_start(void);
148 void l2arc_stop(void);
151 extern int zfs_write_limit_shift;
152 extern unsigned long zfs_write_limit_max;
153 extern kmutex_t zfs_write_limit_lock;
159 #endif /* _SYS_ARC_H */