xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/arc.h (revision 0e8c61582669940ab28fea7e6dd2935372681236)
1fa9e4066Sahrens /*
2fa9e4066Sahrens  * CDDL HEADER START
3fa9e4066Sahrens  *
4fa9e4066Sahrens  * The contents of this file are subject to the terms of the
5ea8dc4b6Seschrock  * Common Development and Distribution License (the "License").
6ea8dc4b6Seschrock  * You may not use this file except in compliance with the License.
7fa9e4066Sahrens  *
8fa9e4066Sahrens  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9fa9e4066Sahrens  * or http://www.opensolaris.org/os/licensing.
10fa9e4066Sahrens  * See the License for the specific language governing permissions
11fa9e4066Sahrens  * and limitations under the License.
12fa9e4066Sahrens  *
13fa9e4066Sahrens  * When distributing Covered Code, include this CDDL HEADER in each
14fa9e4066Sahrens  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15fa9e4066Sahrens  * If applicable, add the following below this CDDL HEADER, with the
16fa9e4066Sahrens  * fields enclosed by brackets "[]" replaced with your own identifying
17fa9e4066Sahrens  * information: Portions Copyright [yyyy] [name of copyright owner]
18fa9e4066Sahrens  *
19fa9e4066Sahrens  * CDDL HEADER END
20fa9e4066Sahrens  */
21fa9e4066Sahrens /*
22c717a561Smaybee  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
23fa9e4066Sahrens  * Use is subject to license terms.
24fa9e4066Sahrens  */
25fa9e4066Sahrens 
26fa9e4066Sahrens #ifndef	_SYS_ARC_H
27fa9e4066Sahrens #define	_SYS_ARC_H
28fa9e4066Sahrens 
29fa9e4066Sahrens #pragma ident	"%Z%%M%	%I%	%E% SMI"
30fa9e4066Sahrens 
31fa9e4066Sahrens #include <sys/zfs_context.h>
32fa9e4066Sahrens 
33fa9e4066Sahrens #ifdef	__cplusplus
34fa9e4066Sahrens extern "C" {
35fa9e4066Sahrens #endif
36fa9e4066Sahrens 
37fa9e4066Sahrens #include <sys/zio.h>
38fa9e4066Sahrens 
39fa9e4066Sahrens typedef struct arc_buf_hdr arc_buf_hdr_t;
40fa9e4066Sahrens typedef struct arc_buf arc_buf_t;
41fa9e4066Sahrens typedef void arc_done_func_t(zio_t *zio, arc_buf_t *buf, void *private);
42fa9e4066Sahrens typedef void arc_byteswap_func_t(void *buf, size_t size);
43ea8dc4b6Seschrock typedef int arc_evict_func_t(void *private);
44fa9e4066Sahrens 
45fa9e4066Sahrens /* generic arc_done_func_t's which you can use */
46fa9e4066Sahrens arc_done_func_t arc_bcopy_func;
47fa9e4066Sahrens arc_done_func_t arc_getbuf_func;
48fa9e4066Sahrens 
49fa9e4066Sahrens struct arc_buf {
50fa9e4066Sahrens 	arc_buf_hdr_t		*b_hdr;
51fa9e4066Sahrens 	arc_buf_t		*b_next;
52fa9e4066Sahrens 	void			*b_data;
53ea8dc4b6Seschrock 	arc_evict_func_t	*b_efunc;
54ea8dc4b6Seschrock 	void			*b_private;
55fa9e4066Sahrens };
56fa9e4066Sahrens 
57ad23a2dbSjohansen typedef enum arc_buf_contents {
58ad23a2dbSjohansen 	ARC_BUFC_DATA,				/* buffer contains data */
59*0e8c6158Smaybee 	ARC_BUFC_METADATA,			/* buffer contains metadata */
60*0e8c6158Smaybee 	ARC_BUFC_NUMTYPES
61ad23a2dbSjohansen } arc_buf_contents_t;
62fa9e4066Sahrens /*
63fa9e4066Sahrens  * These are the flags we pass into calls to the arc
64fa9e4066Sahrens  */
65fa9e4066Sahrens #define	ARC_WAIT	(1 << 1)	/* perform I/O synchronously */
66fa9e4066Sahrens #define	ARC_NOWAIT	(1 << 2)	/* perform I/O asynchronously */
67fa9e4066Sahrens #define	ARC_PREFETCH	(1 << 3)	/* I/O is a prefetch */
6813506d1eSmaybee #define	ARC_CACHED	(1 << 4)	/* I/O was already in cache */
69fa9e4066Sahrens 
70*0e8c6158Smaybee void arc_space_consume(uint64_t space);
71*0e8c6158Smaybee void arc_space_return(uint64_t space);
72*0e8c6158Smaybee void *arc_data_buf_alloc(uint64_t space);
73*0e8c6158Smaybee void arc_data_buf_free(void *buf, uint64_t space);
74ad23a2dbSjohansen arc_buf_t *arc_buf_alloc(spa_t *spa, int size, void *tag,
75ad23a2dbSjohansen     arc_buf_contents_t type);
76ea8dc4b6Seschrock void arc_buf_add_ref(arc_buf_t *buf, void *tag);
77ea8dc4b6Seschrock int arc_buf_remove_ref(arc_buf_t *buf, void *tag);
78fa9e4066Sahrens int arc_buf_size(arc_buf_t *buf);
79fa9e4066Sahrens void arc_release(arc_buf_t *buf, void *tag);
80fa9e4066Sahrens int arc_released(arc_buf_t *buf);
81ea8dc4b6Seschrock int arc_has_callback(arc_buf_t *buf);
826b4acc8bSahrens void arc_buf_freeze(arc_buf_t *buf);
836b4acc8bSahrens void arc_buf_thaw(arc_buf_t *buf);
84ea8dc4b6Seschrock #ifdef ZFS_DEBUG
85ea8dc4b6Seschrock int arc_referenced(arc_buf_t *buf);
86ea8dc4b6Seschrock #endif
87fa9e4066Sahrens 
88fa9e4066Sahrens int arc_read(zio_t *pio, spa_t *spa, blkptr_t *bp, arc_byteswap_func_t *swap,
89fa9e4066Sahrens     arc_done_func_t *done, void *private, int priority, int flags,
9013506d1eSmaybee     uint32_t *arc_flags, zbookmark_t *zb);
91c717a561Smaybee zio_t *arc_write(zio_t *pio, spa_t *spa, int checksum, int compress,
92c717a561Smaybee     int ncopies, uint64_t txg, blkptr_t *bp, arc_buf_t *buf,
93c717a561Smaybee     arc_done_func_t *ready, arc_done_func_t *done, void *private, int priority,
94c717a561Smaybee     int flags, zbookmark_t *zb);
95fa9e4066Sahrens int arc_free(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp,
96fa9e4066Sahrens     zio_done_func_t *done, void *private, uint32_t arc_flags);
97fa9e4066Sahrens int arc_tryread(spa_t *spa, blkptr_t *bp, void *data);
98fa9e4066Sahrens 
99ea8dc4b6Seschrock void arc_set_callback(arc_buf_t *buf, arc_evict_func_t *func, void *private);
100ea8dc4b6Seschrock int arc_buf_evict(arc_buf_t *buf);
101ea8dc4b6Seschrock 
102fa9e4066Sahrens void arc_flush(void);
103fa9e4066Sahrens void arc_tempreserve_clear(uint64_t tempreserve);
104fa9e4066Sahrens int arc_tempreserve_space(uint64_t tempreserve);
105fa9e4066Sahrens 
106fa9e4066Sahrens void arc_init(void);
107fa9e4066Sahrens void arc_fini(void);
108fa9e4066Sahrens 
109fa9e4066Sahrens #ifdef	__cplusplus
110fa9e4066Sahrens }
111fa9e4066Sahrens #endif
112fa9e4066Sahrens 
113fa9e4066Sahrens #endif /* _SYS_ARC_H */
114