sys/dnode.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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2012 by Delphix. All rights reserved.
 */

#ifndef _SYS_DNODE_H
#define _SYS_DNODE_H

#include <sys/zfs_context.h>
#include <sys/avl.h>
#include <sys/spa.h>
#include <sys/txg.h>
#include <sys/zio.h>
#include <sys/refcount.h>
#include <sys/dmu_zfetch.h>
#include <sys/zrlock.h>

#ifdef  __cplusplus
extern "C" {
#endif

#define DNODE_MUST_BE_ALLOCATED 1
#define DNODE_MUST_BE_FREE      2

#define DNODE_FIND_HOLE         1
#define DNODE_FIND_BACKWARDS    2
#define DNODE_FIND_HAVELOCK     4

#define DNODE_SHIFT             9       
#define DN_MIN_INDBLKSHIFT      10      
#define DN_MAX_INDBLKSHIFT      14      
#define DNODE_BLOCK_SHIFT       14      
#define DNODE_CORE_SIZE         64      
#define DN_MAX_OBJECT_SHIFT     48      
#define DN_MAX_OFFSET_SHIFT     64      
#define DN_ID_CHKED_BONUS       0x1
#define DN_ID_CHKED_SPILL       0x2
#define DN_ID_OLD_EXIST         0x4
#define DN_ID_NEW_EXIST         0x8

#define DNODE_SIZE      (1 << DNODE_SHIFT)
#define DN_MAX_NBLKPTR  ((DNODE_SIZE - DNODE_CORE_SIZE) >> SPA_BLKPTRSHIFT)
#define DN_MAX_BONUSLEN (DNODE_SIZE - DNODE_CORE_SIZE - (1 << SPA_BLKPTRSHIFT))
#define DN_MAX_OBJECT   (1ULL << DN_MAX_OBJECT_SHIFT)
#define DN_ZERO_BONUSLEN        (DN_MAX_BONUSLEN + 1)
#define DN_KILL_SPILLBLK (1)

#define DNODES_PER_BLOCK_SHIFT  (DNODE_BLOCK_SHIFT - DNODE_SHIFT)
#define DNODES_PER_BLOCK        (1ULL << DNODES_PER_BLOCK_SHIFT)
#define DNODES_PER_LEVEL_SHIFT  (DN_MAX_INDBLKSHIFT - SPA_BLKPTRSHIFT)
#define DNODES_PER_LEVEL        (1ULL << DNODES_PER_LEVEL_SHIFT)

/* The +2 here is a cheesy way to round up */
#define DN_MAX_LEVELS   (2 + ((DN_MAX_OFFSET_SHIFT - SPA_MINBLOCKSHIFT) / \
        (DN_MIN_INDBLKSHIFT - SPA_BLKPTRSHIFT)))

#define DN_BONUS(dnp)   ((void*)((dnp)->dn_bonus + \
        (((dnp)->dn_nblkptr - 1) * sizeof (blkptr_t))))

#define DN_USED_BYTES(dnp) (((dnp)->dn_flags & DNODE_FLAG_USED_BYTES) ? \
        (dnp)->dn_used : (dnp)->dn_used << SPA_MINBLOCKSHIFT)

#define EPB(blkshift, typeshift)        (1 << (blkshift - typeshift))

struct dmu_buf_impl;
struct objset;
struct zio;

enum dnode_dirtycontext {
        DN_UNDIRTIED,
        DN_DIRTY_OPEN,
        DN_DIRTY_SYNC
};

#define DNODE_FLAG_USED_BYTES           (1<<0)
#define DNODE_FLAG_USERUSED_ACCOUNTED   (1<<1)

#define DNODE_FLAG_SPILL_BLKPTR (1<<2)

typedef struct dnode_phys {
        uint8_t dn_type;                
        uint8_t dn_indblkshift;         
        uint8_t dn_nlevels;             
        uint8_t dn_nblkptr;             
        uint8_t dn_bonustype;           
        uint8_t dn_checksum;            
        uint8_t dn_compress;            
        uint8_t dn_flags;               
        uint16_t dn_datablkszsec;       
        uint16_t dn_bonuslen;           
        uint8_t dn_pad2[4];

        /* accounting is protected by dn_dirty_mtx */
        uint64_t dn_maxblkid;           
        uint64_t dn_used;               
        uint64_t dn_pad3[4];

        blkptr_t dn_blkptr[1];
        uint8_t dn_bonus[DN_MAX_BONUSLEN - sizeof (blkptr_t)];
        blkptr_t dn_spill;
} dnode_phys_t;

typedef struct dnode {
        krwlock_t dn_struct_rwlock;

        list_node_t dn_link;

        struct objset *dn_objset;
        uint64_t dn_object;
        struct dmu_buf_impl *dn_dbuf;
        struct dnode_handle *dn_handle;
        dnode_phys_t *dn_phys; 
        dmu_object_type_t dn_type;      
        uint16_t dn_bonuslen;           
        uint8_t dn_bonustype;           
        uint8_t dn_nblkptr;             
        uint8_t dn_checksum;            
        uint8_t dn_compress;            
        uint8_t dn_nlevels;
        uint8_t dn_indblkshift;
        uint8_t dn_datablkshift;        
        uint8_t dn_moved;               
        uint16_t dn_datablkszsec;       
        uint32_t dn_datablksz;          
        uint64_t dn_maxblkid;
        uint8_t dn_next_nblkptr[TXG_SIZE];
        uint8_t dn_next_nlevels[TXG_SIZE];
        uint8_t dn_next_indblkshift[TXG_SIZE];
        uint8_t dn_next_bonustype[TXG_SIZE];
        uint8_t dn_rm_spillblk[TXG_SIZE];       
        uint16_t dn_next_bonuslen[TXG_SIZE];
        uint32_t dn_next_blksz[TXG_SIZE];       
        uint32_t dn_dbufs_count;        
        list_node_t dn_dirty_link[TXG_SIZE];    
        kmutex_t dn_mtx;
        list_t dn_dirty_records[TXG_SIZE];
        avl_tree_t dn_ranges[TXG_SIZE];
        uint64_t dn_allocated_txg;
        uint64_t dn_free_txg;
        uint64_t dn_assigned_txg;
        kcondvar_t dn_notxholds;
        enum dnode_dirtycontext dn_dirtyctx;
        uint8_t *dn_dirtyctx_firstset;  
        refcount_t dn_tx_holds;
        refcount_t dn_holds;
        kmutex_t dn_dbufs_mtx;
        list_t dn_dbufs;                
        struct dmu_buf_impl *dn_bonus;  
        boolean_t dn_have_spill;        
        zio_t *dn_zio;
        uint64_t dn_oldused;    
        uint64_t dn_oldflags;   
        uint64_t dn_olduid, dn_oldgid;
        uint64_t dn_newuid, dn_newgid;
        int dn_id_flags;
        struct zfetch   dn_zfetch;
} dnode_t;

typedef struct dnode_handle {
        zrlock_t dnh_zrlock;
        dnode_t *dnh_dnode;
} dnode_handle_t;

typedef struct dnode_children {
        size_t dnc_count;               
        dnode_handle_t dnc_children[1]; 
} dnode_children_t;

typedef struct free_range {
        avl_node_t fr_node;
        uint64_t fr_blkid;
        uint64_t fr_nblks;
} free_range_t;

dnode_t *dnode_special_open(struct objset *dd, dnode_phys_t *dnp,
    uint64_t object, dnode_handle_t *dnh);
void dnode_special_close(dnode_handle_t *dnh);

void dnode_setbonuslen(dnode_t *dn, int newsize, dmu_tx_t *tx);
void dnode_setbonus_type(dnode_t *dn, dmu_object_type_t, dmu_tx_t *tx);
void dnode_rm_spill(dnode_t *dn, dmu_tx_t *tx);

int dnode_hold(struct objset *dd, uint64_t object,
    void *ref, dnode_t **dnp);
int dnode_hold_impl(struct objset *dd, uint64_t object, int flag,
    void *ref, dnode_t **dnp);
boolean_t dnode_add_ref(dnode_t *dn, void *ref);
void dnode_rele(dnode_t *dn, void *ref);
void dnode_setdirty(dnode_t *dn, dmu_tx_t *tx);
void dnode_sync(dnode_t *dn, dmu_tx_t *tx);
void dnode_allocate(dnode_t *dn, dmu_object_type_t ot, int blocksize, int ibs,
    dmu_object_type_t bonustype, int bonuslen, dmu_tx_t *tx);
void dnode_reallocate(dnode_t *dn, dmu_object_type_t ot, int blocksize,
    dmu_object_type_t bonustype, int bonuslen, dmu_tx_t *tx);
void dnode_free(dnode_t *dn, dmu_tx_t *tx);
void dnode_byteswap(dnode_phys_t *dnp);
void dnode_buf_byteswap(void *buf, size_t size);
void dnode_verify(dnode_t *dn);
int dnode_set_blksz(dnode_t *dn, uint64_t size, int ibs, dmu_tx_t *tx);
void dnode_free_range(dnode_t *dn, uint64_t off, uint64_t len, dmu_tx_t *tx);
void dnode_clear_range(dnode_t *dn, uint64_t blkid,
    uint64_t nblks, dmu_tx_t *tx);
void dnode_diduse_space(dnode_t *dn, int64_t space);
void dnode_willuse_space(dnode_t *dn, int64_t space, dmu_tx_t *tx);
void dnode_new_blkid(dnode_t *dn, uint64_t blkid, dmu_tx_t *tx, boolean_t);
uint64_t dnode_block_freed(dnode_t *dn, uint64_t blkid);
void dnode_init(void);
void dnode_fini(void);
int dnode_next_offset(dnode_t *dn, int flags, uint64_t *off,
    int minlvl, uint64_t blkfill, uint64_t txg);
void dnode_evict_dbufs(dnode_t *dn);

#ifdef ZFS_DEBUG

/*
 * There should be a ## between the string literal and fmt, to make it
 * clear that we're joining two strings together, but that piece of shit
 * gcc doesn't support that preprocessor token.
 */
#define dprintf_dnode(dn, fmt, ...) do { \
        if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
        char __db_buf[32]; \
        uint64_t __db_obj = (dn)->dn_object; \
        if (__db_obj == DMU_META_DNODE_OBJECT) \
                (void) strcpy(__db_buf, "mdn"); \
        else \
                (void) snprintf(__db_buf, sizeof (__db_buf), "%lld", \
                    (u_longlong_t)__db_obj);\
        dprintf_ds((dn)->dn_objset->os_dsl_dataset, "obj=%s " fmt, \
            __db_buf, __VA_ARGS__); \
        } \
_NOTE(CONSTCOND) } while (0)

#define DNODE_VERIFY(dn)                dnode_verify(dn)
#define FREE_VERIFY(db, start, end, tx) free_verify(db, start, end, tx)

#else

#define dprintf_dnode(db, fmt, ...)
#define DNODE_VERIFY(dn)
#define FREE_VERIFY(db, start, end, tx)

#endif

#ifdef  __cplusplus
}
#endif

#endif  /* _SYS_DNODE_H */