include/sys/arc.h

   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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  23  * Copyright (c) 2012, 2014 by Delphix. All rights reserved.
  24  * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
  25  */
  26
  27 #ifndef _SYS_ARC_H
  28 #define _SYS_ARC_H
  29
  30 #include <sys/zfs_context.h>
  31
  32 #ifdef  __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 #include <sys/zio.h>
  37 #include <sys/dmu.h>
  38 #include <sys/spa.h>
  39 #include <sys/refcount.h>
  40
  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);
  47
  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;
  51
  52 /* generic arc_prune_func_t wrapper for callbacks */
  53 struct arc_prune {
  54         arc_prune_func_t        *p_pfunc;
  55         void                    *p_private;
  56         list_node_t             p_node;
  57         refcount_t              p_refcnt;
  58 };
  59
  60 struct arc_buf {
  61         arc_buf_hdr_t           *b_hdr;
  62         arc_buf_t               *b_next;
  63         kmutex_t                b_evict_lock;
  64         void                    *b_data;
  65         arc_evict_func_t        *b_efunc;
  66         void                    *b_private;
  67 };
  68
  69 typedef enum arc_buf_contents {
  70         ARC_BUFC_DATA,                          /* buffer contains data */
  71         ARC_BUFC_METADATA,                      /* buffer contains metadata */
  72         ARC_BUFC_NUMTYPES
  73 } arc_buf_contents_t;
  74 /*
  75  * These are the flags we pass into calls to the arc
  76  */
  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 */
  83
  84 /*
  85  * The following breakdows of arc_size exist for kstat only.
  86  */
  87 typedef enum arc_space_type {
  88         ARC_SPACE_DATA,
  89         ARC_SPACE_META,
  90         ARC_SPACE_HDRS,
  91         ARC_SPACE_L2HDRS,
  92         ARC_SPACE_OTHER,
  93         ARC_SPACE_NUMTYPES
  94 } arc_space_type_t;
  95
  96 typedef enum arc_state_type {
  97         ARC_STATE_ANON,
  98         ARC_STATE_MRU,
  99         ARC_STATE_MRU_GHOST,
 100         ARC_STATE_MFU,
 101         ARC_STATE_MFU_GHOST,
 102         ARC_STATE_L2C_ONLY,
 103         ARC_STATE_NUMTYPES
 104 } arc_state_type_t;
 105
 106 typedef struct arc_buf_info {
 107         arc_state_type_t        abi_state_type;
 108         arc_buf_contents_t      abi_state_contents;
 109         uint64_t                abi_state_index;
 110         uint32_t                abi_flags;
 111         uint32_t                abi_datacnt;
 112         uint64_t                abi_size;
 113         uint64_t                abi_spa;
 114         uint64_t                abi_access;
 115         uint32_t                abi_mru_hits;
 116         uint32_t                abi_mru_ghost_hits;
 117         uint32_t                abi_mfu_hits;
 118         uint32_t                abi_mfu_ghost_hits;
 119         uint32_t                abi_l2arc_hits;
 120         uint32_t                abi_holds;
 121         uint64_t                abi_l2arc_dattr;
 122         uint64_t                abi_l2arc_asize;
 123         enum zio_compress       abi_l2arc_compress;
 124 } arc_buf_info_t;
 125
 126 void arc_space_consume(uint64_t space, arc_space_type_t type);
 127 void arc_space_return(uint64_t space, arc_space_type_t type);
 128 arc_buf_t *arc_buf_alloc(spa_t *spa, int size, void *tag,
 129     arc_buf_contents_t type);
 130 arc_buf_t *arc_loan_buf(spa_t *spa, int size);
 131 void arc_return_buf(arc_buf_t *buf, void *tag);
 132 void arc_loan_inuse_buf(arc_buf_t *buf, void *tag);
 133 void arc_buf_add_ref(arc_buf_t *buf, void *tag);
 134 boolean_t arc_buf_remove_ref(arc_buf_t *buf, void *tag);
 135 void arc_buf_info(arc_buf_t *buf, arc_buf_info_t *abi, int state_index);
 136 int arc_buf_size(arc_buf_t *buf);
 137 void arc_release(arc_buf_t *buf, void *tag);
 138 int arc_released(arc_buf_t *buf);
 139 int arc_has_callback(arc_buf_t *buf);
 140 void arc_buf_sigsegv(int sig, siginfo_t *si, void *unused);
 141 void arc_buf_freeze(arc_buf_t *buf);
 142 void arc_buf_thaw(arc_buf_t *buf);
 143 boolean_t arc_buf_eviction_needed(arc_buf_t *buf);
 144 #ifdef ZFS_DEBUG
 145 int arc_referenced(arc_buf_t *buf);
 146 #endif
 147
 148 int arc_read(zio_t *pio, spa_t *spa, const blkptr_t *bp,
 149     arc_done_func_t *done, void *private, zio_priority_t priority, int flags,
 150     uint32_t *arc_flags, const zbookmark_phys_t *zb);
 151 zio_t *arc_write(zio_t *pio, spa_t *spa, uint64_t txg,
 152     blkptr_t *bp, arc_buf_t *buf, boolean_t l2arc, boolean_t l2arc_compress,
 153     const zio_prop_t *zp, arc_done_func_t *ready, arc_done_func_t *physdone,
 154     arc_done_func_t *done, void *private, zio_priority_t priority,
 155     int zio_flags, const zbookmark_phys_t *zb);
 156
 157 arc_prune_t *arc_add_prune_callback(arc_prune_func_t *func, void *private);
 158 void arc_remove_prune_callback(arc_prune_t *p);
 159 void arc_freed(spa_t *spa, const blkptr_t *bp);
 160
 161 void arc_set_callback(arc_buf_t *buf, arc_evict_func_t *func, void *private);
 162 int arc_buf_evict(arc_buf_t *buf);
 163
 164 void arc_flush(spa_t *spa);
 165 void arc_tempreserve_clear(uint64_t reserve);
 166 int arc_tempreserve_space(uint64_t reserve, uint64_t txg);
 167
 168 void arc_init(void);
 169 void arc_fini(void);
 170
 171 /*
 172  * Level 2 ARC
 173  */
 174
 175 void l2arc_add_vdev(spa_t *spa, vdev_t *vd);
 176 void l2arc_remove_vdev(vdev_t *vd);
 177 boolean_t l2arc_vdev_present(vdev_t *vd);
 178 void l2arc_init(void);
 179 void l2arc_fini(void);
 180 void l2arc_start(void);
 181 void l2arc_stop(void);
 182
 183 #ifndef _KERNEL
 184 extern boolean_t arc_watch;
 185 #endif
 186
 187 #ifdef  __cplusplus
 188 }
 189 #endif
 190
 191 #endif /* _SYS_ARC_H */