1 /* 2 * CDDL HEADER START 3 * 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. 7 * 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. 12 * 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] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_ARC_H 27 #define _SYS_ARC_H 28 29 #pragma ident "%Z%%M% %I% %E% SMI" 30 31 #include <sys/zfs_context.h> 32 33 #ifdef __cplusplus 34 extern "C" { 35 #endif 36 37 #include <sys/zio.h> 38 39 typedef struct arc_buf_hdr arc_buf_hdr_t; 40 typedef struct arc_buf arc_buf_t; 41 typedef void arc_done_func_t(zio_t *zio, arc_buf_t *buf, void *private); 42 typedef void arc_byteswap_func_t(void *buf, size_t size); 43 typedef int arc_evict_func_t(void *private); 44 45 /* generic arc_done_func_t's which you can use */ 46 arc_done_func_t arc_bcopy_func; 47 arc_done_func_t arc_getbuf_func; 48 49 struct arc_buf { 50 arc_buf_hdr_t *b_hdr; 51 arc_buf_t *b_next; 52 void *b_data; 53 arc_evict_func_t *b_efunc; 54 void *b_private; 55 }; 56 57 typedef enum arc_buf_contents { 58 ARC_BUFC_DATA, /* buffer contains data */ 59 ARC_BUFC_METADATA, /* buffer contains metadata */ 60 ARC_BUFC_NUMTYPES 61 } arc_buf_contents_t; 62 /* 63 * These are the flags we pass into calls to the arc 64 */ 65 #define ARC_WAIT (1 << 1) /* perform I/O synchronously */ 66 #define ARC_NOWAIT (1 << 2) /* perform I/O asynchronously */ 67 #define ARC_PREFETCH (1 << 3) /* I/O is a prefetch */ 68 #define ARC_CACHED (1 << 4) /* I/O was already in cache */ 69 70 void arc_space_consume(uint64_t space); 71 void arc_space_return(uint64_t space); 72 void *arc_data_buf_alloc(uint64_t space); 73 void arc_data_buf_free(void *buf, uint64_t space); 74 arc_buf_t *arc_buf_alloc(spa_t *spa, int size, void *tag, 75 arc_buf_contents_t type); 76 void arc_buf_add_ref(arc_buf_t *buf, void *tag); 77 int arc_buf_remove_ref(arc_buf_t *buf, void *tag); 78 int arc_buf_size(arc_buf_t *buf); 79 void arc_release(arc_buf_t *buf, void *tag); 80 int arc_released(arc_buf_t *buf); 81 int arc_has_callback(arc_buf_t *buf); 82 void arc_buf_freeze(arc_buf_t *buf); 83 void arc_buf_thaw(arc_buf_t *buf); 84 #ifdef ZFS_DEBUG 85 int arc_referenced(arc_buf_t *buf); 86 #endif 87 88 int arc_read(zio_t *pio, spa_t *spa, blkptr_t *bp, arc_byteswap_func_t *swap, 89 arc_done_func_t *done, void *private, int priority, int flags, 90 uint32_t *arc_flags, zbookmark_t *zb); 91 zio_t *arc_write(zio_t *pio, spa_t *spa, int checksum, int compress, 92 int ncopies, uint64_t txg, blkptr_t *bp, arc_buf_t *buf, 93 arc_done_func_t *ready, arc_done_func_t *done, void *private, int priority, 94 int flags, zbookmark_t *zb); 95 int arc_free(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp, 96 zio_done_func_t *done, void *private, uint32_t arc_flags); 97 int arc_tryread(spa_t *spa, blkptr_t *bp, void *data); 98 99 void arc_set_callback(arc_buf_t *buf, arc_evict_func_t *func, void *private); 100 int arc_buf_evict(arc_buf_t *buf); 101 102 void arc_flush(void); 103 void arc_tempreserve_clear(uint64_t tempreserve); 104 int arc_tempreserve_space(uint64_t tempreserve); 105 106 void arc_init(void); 107 void arc_fini(void); 108 109 #ifdef __cplusplus 110 } 111 #endif 112 113 #endif /* _SYS_ARC_H */ 114