Home | History | Annotate | Download | only in sys
      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	"@(#)arc.h	1.11	07/12/07 SMI"
     30 
     31 #include <sys/zfs_context.h>
     32 
     33 #ifdef	__cplusplus
     34 extern "C" {
     35 #endif
     36 
     37 #include <sys/zio.h>
     38 #include <sys/dmu.h>
     39 #include <sys/spa.h>
     40 
     41 typedef struct arc_buf_hdr arc_buf_hdr_t;
     42 typedef struct arc_buf arc_buf_t;
     43 typedef void arc_done_func_t(zio_t *zio, arc_buf_t *buf, void *private);
     44 typedef int arc_evict_func_t(void *private);
     45 
     46 /* generic arc_done_func_t's which you can use */
     47 arc_done_func_t arc_bcopy_func;
     48 arc_done_func_t arc_getbuf_func;
     49 
     50 struct arc_buf {
     51 	arc_buf_hdr_t		*b_hdr;
     52 	arc_buf_t		*b_next;
     53 	void			*b_data;
     54 	arc_evict_func_t	*b_efunc;
     55 	void			*b_private;
     56 };
     57 
     58 typedef enum arc_buf_contents {
     59 	ARC_BUFC_DATA,				/* buffer contains data */
     60 	ARC_BUFC_METADATA,			/* buffer contains metadata */
     61 	ARC_BUFC_NUMTYPES
     62 } arc_buf_contents_t;
     63 /*
     64  * These are the flags we pass into calls to the arc
     65  */
     66 #define	ARC_WAIT	(1 << 1)	/* perform I/O synchronously */
     67 #define	ARC_NOWAIT	(1 << 2)	/* perform I/O asynchronously */
     68 #define	ARC_PREFETCH	(1 << 3)	/* I/O is a prefetch */
     69 #define	ARC_CACHED	(1 << 4)	/* I/O was already in cache */
     70 
     71 void arc_space_consume(uint64_t space);
     72 void arc_space_return(uint64_t space);
     73 void *arc_data_buf_alloc(uint64_t space);
     74 void arc_data_buf_free(void *buf, uint64_t space);
     75 arc_buf_t *arc_buf_alloc(spa_t *spa, int size, void *tag,
     76     arc_buf_contents_t type);
     77 void arc_buf_add_ref(arc_buf_t *buf, void *tag);
     78 int arc_buf_remove_ref(arc_buf_t *buf, void *tag);
     79 int arc_buf_size(arc_buf_t *buf);
     80 void arc_release(arc_buf_t *buf, void *tag);
     81 int arc_released(arc_buf_t *buf);
     82 int arc_has_callback(arc_buf_t *buf);
     83 void arc_buf_freeze(arc_buf_t *buf);
     84 void arc_buf_thaw(arc_buf_t *buf);
     85 #ifdef ZFS_DEBUG
     86 int arc_referenced(arc_buf_t *buf);
     87 #endif
     88 
     89 int arc_read(zio_t *pio, spa_t *spa, blkptr_t *bp, arc_byteswap_func_t *swap,
     90     arc_done_func_t *done, void *private, int priority, int flags,
     91     uint32_t *arc_flags, zbookmark_t *zb);
     92 zio_t *arc_write(zio_t *pio, spa_t *spa, int checksum, int compress,
     93     int ncopies, uint64_t txg, blkptr_t *bp, arc_buf_t *buf,
     94     arc_done_func_t *ready, arc_done_func_t *done, void *private, int priority,
     95     int flags, zbookmark_t *zb);
     96 int arc_free(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp,
     97     zio_done_func_t *done, void *private, uint32_t arc_flags);
     98 int arc_tryread(spa_t *spa, blkptr_t *bp, void *data);
     99 
    100 void arc_set_callback(arc_buf_t *buf, arc_evict_func_t *func, void *private);
    101 int arc_buf_evict(arc_buf_t *buf);
    102 
    103 void arc_flush(spa_t *spa);
    104 void arc_tempreserve_clear(uint64_t tempreserve);
    105 int arc_tempreserve_space(uint64_t tempreserve);
    106 
    107 void arc_init(void);
    108 void arc_fini(void);
    109 
    110 /*
    111  * Level 2 ARC
    112  */
    113 
    114 void l2arc_add_vdev(spa_t *spa, vdev_t *vd, uint64_t start, uint64_t end);
    115 void l2arc_remove_vdev(vdev_t *vd);
    116 void l2arc_init(void);
    117 void l2arc_fini(void);
    118 
    119 #ifdef	__cplusplus
    120 }
    121 #endif
    122 
    123 #endif /* _SYS_ARC_H */
    124