sys/space_map.h

Go to the documentation of this file.

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef _SYS_SPACE_MAP_H
#define _SYS_SPACE_MAP_H

#include <sys/avl.h>
#include <sys/dmu.h>

#ifdef  __cplusplus
extern "C" {
#endif

typedef struct space_map_ops space_map_ops_t;

typedef struct space_map {
        avl_tree_t      sm_root;        
        uint64_t        sm_space;       
        uint64_t        sm_start;       
        uint64_t        sm_size;        
        uint8_t         sm_shift;       
        uint8_t         sm_pad[3];      
        uint8_t         sm_loaded;      
        uint8_t         sm_loading;     
        kcondvar_t      sm_load_cv;     
        space_map_ops_t *sm_ops;        
        avl_tree_t      *sm_pp_root;    
        void            *sm_ppd;        
        kmutex_t        *sm_lock;       
} space_map_t;

typedef struct space_seg {
        avl_node_t      ss_node;        
        avl_node_t      ss_pp_node;     
        uint64_t        ss_start;       
        uint64_t        ss_end;         
} space_seg_t;

typedef struct space_ref {
        avl_node_t      sr_node;        
        uint64_t        sr_offset;      
        int64_t         sr_refcnt;      
} space_ref_t;

typedef struct space_map_obj {
        uint64_t        smo_object;     
        uint64_t        smo_objsize;    
        uint64_t        smo_alloc;      
} space_map_obj_t;

struct space_map_ops {
        void    (*smop_load)(space_map_t *sm);
        void    (*smop_unload)(space_map_t *sm);
        uint64_t (*smop_alloc)(space_map_t *sm, uint64_t size);
        void    (*smop_claim)(space_map_t *sm, uint64_t start, uint64_t size);
        void    (*smop_free)(space_map_t *sm, uint64_t start, uint64_t size);
        uint64_t (*smop_max)(space_map_t *sm);
        boolean_t (*smop_fragmented)(space_map_t *sm);
};

/* All this stuff takes and returns bytes */
#define SM_RUN_DECODE(x)        (BF64_DECODE(x, 0, 15) + 1)
#define SM_RUN_ENCODE(x)        BF64_ENCODE((x) - 1, 0, 15)
#define SM_TYPE_DECODE(x)       BF64_DECODE(x, 15, 1)
#define SM_TYPE_ENCODE(x)       BF64_ENCODE(x, 15, 1)
#define SM_OFFSET_DECODE(x)     BF64_DECODE(x, 16, 47)
#define SM_OFFSET_ENCODE(x)     BF64_ENCODE(x, 16, 47)
#define SM_DEBUG_DECODE(x)      BF64_DECODE(x, 63, 1)
#define SM_DEBUG_ENCODE(x)      BF64_ENCODE(x, 63, 1)

#define SM_DEBUG_ACTION_DECODE(x)       BF64_DECODE(x, 60, 3)
#define SM_DEBUG_ACTION_ENCODE(x)       BF64_ENCODE(x, 60, 3)

#define SM_DEBUG_SYNCPASS_DECODE(x)     BF64_DECODE(x, 50, 10)
#define SM_DEBUG_SYNCPASS_ENCODE(x)     BF64_ENCODE(x, 50, 10)

#define SM_DEBUG_TXG_DECODE(x)          BF64_DECODE(x, 0, 50)
#define SM_DEBUG_TXG_ENCODE(x)          BF64_ENCODE(x, 0, 50)

#define SM_RUN_MAX                      SM_RUN_DECODE(~0ULL)

#define SM_ALLOC        0x0
#define SM_FREE         0x1

#define SPACE_MAP_BLOCKSHIFT    12

typedef void space_map_func_t(space_map_t *sm, uint64_t start, uint64_t size);

extern void space_map_create(space_map_t *sm, uint64_t start, uint64_t size,
    uint8_t shift, kmutex_t *lp);
extern void space_map_destroy(space_map_t *sm);
extern void space_map_add(space_map_t *sm, uint64_t start, uint64_t size);
extern void space_map_remove(space_map_t *sm, uint64_t start, uint64_t size);
extern boolean_t space_map_contains(space_map_t *sm,
    uint64_t start, uint64_t size);
extern void space_map_vacate(space_map_t *sm,
    space_map_func_t *func, space_map_t *mdest);
extern void space_map_walk(space_map_t *sm,
    space_map_func_t *func, space_map_t *mdest);

extern void space_map_load_wait(space_map_t *sm);
extern int space_map_load(space_map_t *sm, space_map_ops_t *ops,
    uint8_t maptype, space_map_obj_t *smo, objset_t *os);
extern void space_map_unload(space_map_t *sm);

extern uint64_t space_map_alloc(space_map_t *sm, uint64_t size);
extern void space_map_claim(space_map_t *sm, uint64_t start, uint64_t size);
extern void space_map_free(space_map_t *sm, uint64_t start, uint64_t size);
extern uint64_t space_map_maxsize(space_map_t *sm);

extern void space_map_sync(space_map_t *sm, uint8_t maptype,
    space_map_obj_t *smo, objset_t *os, dmu_tx_t *tx);
extern void space_map_truncate(space_map_obj_t *smo,
    objset_t *os, dmu_tx_t *tx);

extern void space_map_ref_create(avl_tree_t *t);
extern void space_map_ref_destroy(avl_tree_t *t);
extern void space_map_ref_add_seg(avl_tree_t *t,
    uint64_t start, uint64_t end, int64_t refcnt);
extern void space_map_ref_add_map(avl_tree_t *t,
    space_map_t *sm, int64_t refcnt);
extern void space_map_ref_generate_map(avl_tree_t *t,
    space_map_t *sm, int64_t minref);

#ifdef  __cplusplus
}
#endif

#endif  /* _SYS_SPACE_MAP_H */