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 /* 22*3f9d6ad7SLin Ling * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 23fa9e4066Sahrens */ 24fa9e4066Sahrens 25fa9e4066Sahrens #ifndef _SYS_ARC_H 26fa9e4066Sahrens #define _SYS_ARC_H 27fa9e4066Sahrens 28fa9e4066Sahrens #include <sys/zfs_context.h> 29fa9e4066Sahrens 30fa9e4066Sahrens #ifdef __cplusplus 31fa9e4066Sahrens extern "C" { 32fa9e4066Sahrens #endif 33fa9e4066Sahrens 34fa9e4066Sahrens #include <sys/zio.h> 35e45ce728Sahrens #include <sys/dmu.h> 36fa94a07fSbrendan #include <sys/spa.h> 37fa9e4066Sahrens 38fa9e4066Sahrens typedef struct arc_buf_hdr arc_buf_hdr_t; 39fa9e4066Sahrens typedef struct arc_buf arc_buf_t; 40fa9e4066Sahrens typedef void arc_done_func_t(zio_t *zio, arc_buf_t *buf, void *private); 41ea8dc4b6Seschrock typedef int arc_evict_func_t(void *private); 42fa9e4066Sahrens 43fa9e4066Sahrens /* generic arc_done_func_t's which you can use */ 44fa9e4066Sahrens arc_done_func_t arc_bcopy_func; 45fa9e4066Sahrens arc_done_func_t arc_getbuf_func; 46fa9e4066Sahrens 47fa9e4066Sahrens struct arc_buf { 48fa9e4066Sahrens arc_buf_hdr_t *b_hdr; 49fa9e4066Sahrens arc_buf_t *b_next; 50*3f9d6ad7SLin Ling kmutex_t b_evict_lock; 51*3f9d6ad7SLin Ling krwlock_t b_data_lock; 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 */ 590e8c6158Smaybee ARC_BUFC_METADATA, /* buffer contains metadata */ 600e8c6158Smaybee 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 */ 693baa08fcSek #define ARC_L2CACHE (1 << 5) /* cache in L2ARC */ 70fa9e4066Sahrens 715a98e54bSBrendan Gregg - Sun Microsystems /* 725a98e54bSBrendan Gregg - Sun Microsystems * The following breakdows of arc_size exist for kstat only. 735a98e54bSBrendan Gregg - Sun Microsystems */ 745a98e54bSBrendan Gregg - Sun Microsystems typedef enum arc_space_type { 755a98e54bSBrendan Gregg - Sun Microsystems ARC_SPACE_DATA, 765a98e54bSBrendan Gregg - Sun Microsystems ARC_SPACE_HDRS, 775a98e54bSBrendan Gregg - Sun Microsystems ARC_SPACE_L2HDRS, 785a98e54bSBrendan Gregg - Sun Microsystems ARC_SPACE_OTHER, 795a98e54bSBrendan Gregg - Sun Microsystems ARC_SPACE_NUMTYPES 805a98e54bSBrendan Gregg - Sun Microsystems } arc_space_type_t; 815a98e54bSBrendan Gregg - Sun Microsystems 825a98e54bSBrendan Gregg - Sun Microsystems void arc_space_consume(uint64_t space, arc_space_type_t type); 835a98e54bSBrendan Gregg - Sun Microsystems void arc_space_return(uint64_t space, arc_space_type_t type); 840e8c6158Smaybee void *arc_data_buf_alloc(uint64_t space); 850e8c6158Smaybee void arc_data_buf_free(void *buf, uint64_t space); 86ad23a2dbSjohansen arc_buf_t *arc_buf_alloc(spa_t *spa, int size, void *tag, 87ad23a2dbSjohansen arc_buf_contents_t type); 882fdbea25SAleksandr Guzovskiy arc_buf_t *arc_loan_buf(spa_t *spa, int size); 892fdbea25SAleksandr Guzovskiy void arc_return_buf(arc_buf_t *buf, void *tag); 90c242f9a0Schunli zhang - Sun Microsystems - Irvine United States void arc_loan_inuse_buf(arc_buf_t *buf, void *tag); 91ea8dc4b6Seschrock void arc_buf_add_ref(arc_buf_t *buf, void *tag); 92ea8dc4b6Seschrock int arc_buf_remove_ref(arc_buf_t *buf, void *tag); 93fa9e4066Sahrens int arc_buf_size(arc_buf_t *buf); 94fa9e4066Sahrens void arc_release(arc_buf_t *buf, void *tag); 95*3f9d6ad7SLin Ling int arc_release_bp(arc_buf_t *buf, void *tag, blkptr_t *bp, spa_t *spa, 96*3f9d6ad7SLin Ling zbookmark_t *zb); 97fa9e4066Sahrens int arc_released(arc_buf_t *buf); 98ea8dc4b6Seschrock int arc_has_callback(arc_buf_t *buf); 996b4acc8bSahrens void arc_buf_freeze(arc_buf_t *buf); 1006b4acc8bSahrens void arc_buf_thaw(arc_buf_t *buf); 101ea8dc4b6Seschrock #ifdef ZFS_DEBUG 102ea8dc4b6Seschrock int arc_referenced(arc_buf_t *buf); 103ea8dc4b6Seschrock #endif 104fa9e4066Sahrens 105b24ab676SJeff Bonwick int arc_read(zio_t *pio, spa_t *spa, const blkptr_t *bp, arc_buf_t *pbuf, 1063baa08fcSek arc_done_func_t *done, void *private, int priority, int zio_flags, 107088f3894Sahrens uint32_t *arc_flags, const zbookmark_t *zb); 108b24ab676SJeff Bonwick int arc_read_nolock(zio_t *pio, spa_t *spa, const blkptr_t *bp, 109088f3894Sahrens arc_done_func_t *done, void *private, int priority, int flags, 110088f3894Sahrens uint32_t *arc_flags, const zbookmark_t *zb); 111b24ab676SJeff Bonwick zio_t *arc_write(zio_t *pio, spa_t *spa, uint64_t txg, 112b24ab676SJeff Bonwick blkptr_t *bp, arc_buf_t *buf, boolean_t l2arc, const zio_prop_t *zp, 113b24ab676SJeff Bonwick arc_done_func_t *ready, arc_done_func_t *done, void *private, 114b24ab676SJeff Bonwick int priority, int zio_flags, const zbookmark_t *zb); 115b24ab676SJeff Bonwick void arc_free(spa_t *spa, const blkptr_t *bp); 116fa9e4066Sahrens 117ea8dc4b6Seschrock void arc_set_callback(arc_buf_t *buf, arc_evict_func_t *func, void *private); 118ea8dc4b6Seschrock int arc_buf_evict(arc_buf_t *buf); 119ea8dc4b6Seschrock 120874395d5Smaybee void arc_flush(spa_t *spa); 1211ab7f2deSmaybee void arc_tempreserve_clear(uint64_t reserve); 1221ab7f2deSmaybee int arc_tempreserve_space(uint64_t reserve, uint64_t txg); 123fa9e4066Sahrens 124fa9e4066Sahrens void arc_init(void); 125fa9e4066Sahrens void arc_fini(void); 126fa9e4066Sahrens 127fa94a07fSbrendan /* 128fa94a07fSbrendan * Level 2 ARC 129fa94a07fSbrendan */ 130fa94a07fSbrendan 131573ca77eSGeorge Wilson void l2arc_add_vdev(spa_t *spa, vdev_t *vd); 132fa94a07fSbrendan void l2arc_remove_vdev(vdev_t *vd); 133c5904d13Seschrock boolean_t l2arc_vdev_present(vdev_t *vd); 134fa94a07fSbrendan void l2arc_init(void); 135fa94a07fSbrendan void l2arc_fini(void); 136e14bb325SJeff Bonwick void l2arc_start(void); 137e14bb325SJeff Bonwick void l2arc_stop(void); 138fa94a07fSbrendan 139fa9e4066Sahrens #ifdef __cplusplus 140fa9e4066Sahrens } 141fa9e4066Sahrens #endif 142fa9e4066Sahrens 143fa9e4066Sahrens #endif /* _SYS_ARC_H */ 144