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 /* 225a98e54bSBrendan Gregg - Sun Microsystems * Copyright 2009 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 #include <sys/zfs_context.h> 30fa9e4066Sahrens 31fa9e4066Sahrens #ifdef __cplusplus 32fa9e4066Sahrens extern "C" { 33fa9e4066Sahrens #endif 34fa9e4066Sahrens 35fa9e4066Sahrens #include <sys/zio.h> 36e45ce728Sahrens #include <sys/dmu.h> 37fa94a07fSbrendan #include <sys/spa.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); 42ea8dc4b6Seschrock typedef int arc_evict_func_t(void *private); 43fa9e4066Sahrens 44fa9e4066Sahrens /* generic arc_done_func_t's which you can use */ 45fa9e4066Sahrens arc_done_func_t arc_bcopy_func; 46fa9e4066Sahrens arc_done_func_t arc_getbuf_func; 47fa9e4066Sahrens 48fa9e4066Sahrens struct arc_buf { 49fa9e4066Sahrens arc_buf_hdr_t *b_hdr; 50fa9e4066Sahrens arc_buf_t *b_next; 516f83844dSMark Maybee krwlock_t b_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); 88*2fdbea25SAleksandr Guzovskiy arc_buf_t *arc_loan_buf(spa_t *spa, int size); 89*2fdbea25SAleksandr Guzovskiy void arc_return_buf(arc_buf_t *buf, void *tag); 90ea8dc4b6Seschrock void arc_buf_add_ref(arc_buf_t *buf, void *tag); 91ea8dc4b6Seschrock int arc_buf_remove_ref(arc_buf_t *buf, void *tag); 92fa9e4066Sahrens int arc_buf_size(arc_buf_t *buf); 93fa9e4066Sahrens void arc_release(arc_buf_t *buf, void *tag); 94fa9e4066Sahrens int arc_released(arc_buf_t *buf); 95ea8dc4b6Seschrock int arc_has_callback(arc_buf_t *buf); 966b4acc8bSahrens void arc_buf_freeze(arc_buf_t *buf); 976b4acc8bSahrens void arc_buf_thaw(arc_buf_t *buf); 98ea8dc4b6Seschrock #ifdef ZFS_DEBUG 99ea8dc4b6Seschrock int arc_referenced(arc_buf_t *buf); 100ea8dc4b6Seschrock #endif 101fa9e4066Sahrens 102088f3894Sahrens typedef struct writeprops { 103088f3894Sahrens dmu_object_type_t wp_type; 104088f3894Sahrens uint8_t wp_level; 105e14bb325SJeff Bonwick uint8_t wp_copies; 106088f3894Sahrens uint8_t wp_dncompress, wp_oscompress; 107088f3894Sahrens uint8_t wp_dnchecksum, wp_oschecksum; 108088f3894Sahrens } writeprops_t; 109088f3894Sahrens 11082c9918fSTim Haley void write_policy(spa_t *spa, const writeprops_t *wp, zio_prop_t *zp); 111088f3894Sahrens int arc_read(zio_t *pio, spa_t *spa, blkptr_t *bp, arc_buf_t *pbuf, 1123baa08fcSek arc_done_func_t *done, void *private, int priority, int zio_flags, 113088f3894Sahrens uint32_t *arc_flags, const zbookmark_t *zb); 114088f3894Sahrens int arc_read_nolock(zio_t *pio, spa_t *spa, blkptr_t *bp, 115088f3894Sahrens arc_done_func_t *done, void *private, int priority, int flags, 116088f3894Sahrens uint32_t *arc_flags, const zbookmark_t *zb); 117088f3894Sahrens zio_t *arc_write(zio_t *pio, spa_t *spa, const writeprops_t *wp, 1183baa08fcSek boolean_t l2arc, uint64_t txg, blkptr_t *bp, arc_buf_t *buf, 119c717a561Smaybee arc_done_func_t *ready, arc_done_func_t *done, void *private, int priority, 1203baa08fcSek int zio_flags, const zbookmark_t *zb); 121fa9e4066Sahrens int arc_free(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp, 122fa9e4066Sahrens zio_done_func_t *done, void *private, uint32_t arc_flags); 123fa9e4066Sahrens int arc_tryread(spa_t *spa, blkptr_t *bp, void *data); 124fa9e4066Sahrens 125ea8dc4b6Seschrock void arc_set_callback(arc_buf_t *buf, arc_evict_func_t *func, void *private); 126ea8dc4b6Seschrock int arc_buf_evict(arc_buf_t *buf); 127ea8dc4b6Seschrock 128874395d5Smaybee void arc_flush(spa_t *spa); 1291ab7f2deSmaybee void arc_tempreserve_clear(uint64_t reserve); 1301ab7f2deSmaybee int arc_tempreserve_space(uint64_t reserve, uint64_t txg); 131fa9e4066Sahrens 132fa9e4066Sahrens void arc_init(void); 133fa9e4066Sahrens void arc_fini(void); 134fa9e4066Sahrens 135fa94a07fSbrendan /* 136fa94a07fSbrendan * Level 2 ARC 137fa94a07fSbrendan */ 138fa94a07fSbrendan 139fa94a07fSbrendan void l2arc_add_vdev(spa_t *spa, vdev_t *vd, uint64_t start, uint64_t end); 140fa94a07fSbrendan void l2arc_remove_vdev(vdev_t *vd); 141c5904d13Seschrock boolean_t l2arc_vdev_present(vdev_t *vd); 142fa94a07fSbrendan void l2arc_init(void); 143fa94a07fSbrendan void l2arc_fini(void); 144e14bb325SJeff Bonwick void l2arc_start(void); 145e14bb325SJeff Bonwick void l2arc_stop(void); 146fa94a07fSbrendan 147fa9e4066Sahrens #ifdef __cplusplus 148fa9e4066Sahrens } 149fa9e4066Sahrens #endif 150fa9e4066Sahrens 151fa9e4066Sahrens #endif /* _SYS_ARC_H */ 152