sys/zil.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.
 */

/* Portions Copyright 2010 Robert Milkowski */

#ifndef _SYS_ZIL_H
#define _SYS_ZIL_H

#include <sys/types.h>
#include <sys/spa.h>
#include <sys/zio.h>
#include <sys/dmu.h>

#ifdef  __cplusplus
extern "C" {
#endif

typedef struct zil_header {
        uint64_t zh_claim_txg;  
        uint64_t zh_replay_seq; 
        blkptr_t zh_log;        
        uint64_t zh_claim_blk_seq; 
        uint64_t zh_flags;      
        uint64_t zh_claim_lr_seq; 
        uint64_t zh_pad[3];
} zil_header_t;

#define ZIL_REPLAY_NEEDED       0x1     
#define ZIL_CLAIM_LR_SEQ_VALID  0x2     
typedef struct zil_chain {
        uint64_t zc_pad;
        blkptr_t zc_next_blk;   
        uint64_t zc_nused;      
        zio_eck_t zc_eck;       
} zil_chain_t;

#define ZIL_MIN_BLKSZ   4096ULL
#define ZIL_MAX_BLKSZ   SPA_MAXBLOCKSIZE

#define ZIL_ZC_GUID_0   0
#define ZIL_ZC_GUID_1   1
#define ZIL_ZC_OBJSET   2
#define ZIL_ZC_SEQ      3

typedef enum zil_create {
        Z_FILE,
        Z_DIR,
        Z_XATTRDIR,
} zil_create_t;

#define ZIL_XVAT_SIZE(mapsize) \
        sizeof (lr_attr_t) + (sizeof (uint32_t) * (mapsize - 1)) + \
        (sizeof (uint64_t) * 7)

#define ZIL_ACE_LENGTH(x)       (roundup(x, sizeof (uint64_t)))

#define TX_CREATE               1       
#define TX_MKDIR                2       
#define TX_MKXATTR              3       
#define TX_SYMLINK              4       
#define TX_REMOVE               5       
#define TX_RMDIR                6       
#define TX_LINK                 7       
#define TX_RENAME               8       
#define TX_WRITE                9       
#define TX_TRUNCATE             10      
#define TX_SETATTR              11      
#define TX_ACL_V0               12      
#define TX_ACL                  13      
#define TX_CREATE_ACL           14      
#define TX_CREATE_ATTR          15      
#define TX_CREATE_ACL_ATTR      16      
#define TX_MKDIR_ACL            17      
#define TX_MKDIR_ATTR           18      
#define TX_MKDIR_ACL_ATTR       19      
#define TX_WRITE2               20      
#define TX_MAX_TYPE             21      
#define TX_CI   ((uint64_t)0x1 << 63) /* case-insensitive behavior requested */

#define TX_OOO(txtype)                  \
        ((txtype) == TX_WRITE ||        \
        (txtype) == TX_TRUNCATE ||      \
        (txtype) == TX_SETATTR ||       \
        (txtype) == TX_ACL_V0 ||        \
        (txtype) == TX_ACL ||           \
        (txtype) == TX_WRITE2)

typedef struct {                        
        uint64_t        lrc_txtype;     
        uint64_t        lrc_reclen;     
        uint64_t        lrc_txg;        
        uint64_t        lrc_seq;        
} lr_t;

typedef struct {
        lr_t            lr_common;      
        uint64_t        lr_foid;        
} lr_ooo_t;

typedef struct {
        uint32_t        lr_attr_masksize; 
        uint32_t        lr_attr_bitmap; 
        /* remainder of array and any additional fields */
} lr_attr_t;

typedef struct {
        lr_t            lr_common;      
        uint64_t        lr_doid;        
        uint64_t        lr_foid;        
        uint64_t        lr_mode;        
        uint64_t        lr_uid;         
        uint64_t        lr_gid;         
        uint64_t        lr_gen;         
        uint64_t        lr_crtime[2];   
        uint64_t        lr_rdev;        
        /* name of object to create follows this */
        /* for symlinks, link content follows name */
        /* for creates with xvattr data, the name follows the xvattr info */
} lr_create_t;

/*
 * FUID ACL record will be an array of ACEs from the original ACL.
 * If this array includes ephemeral IDs, the record will also include
 * an array of log-specific FUIDs to replace the ephemeral IDs.
 * Only one copy of each unique domain will be present, so the log-specific
 * FUIDs will use an index into a compressed domain table.  On replay this
 * information will be used to construct real FUIDs (and bypass idmap,
 * since it may not be available).
 */

typedef struct {
        lr_create_t     lr_create;      
        uint64_t        lr_aclcnt;      
        uint64_t        lr_domcnt;      
        uint64_t        lr_fuidcnt;     
        uint64_t        lr_acl_bytes;   
        uint64_t        lr_acl_flags;   
} lr_acl_create_t;

typedef struct {
        lr_t            lr_common;      
        uint64_t        lr_doid;        
} lr_remove_t;

typedef struct {
        lr_t            lr_common;      
        uint64_t        lr_doid;        
        uint64_t        lr_link_obj;    
} lr_link_t;

typedef struct {
        lr_t            lr_common;      
        uint64_t        lr_sdoid;       
        uint64_t        lr_tdoid;       
} lr_rename_t;

typedef struct {
        lr_t            lr_common;      
        uint64_t        lr_foid;        
        uint64_t        lr_offset;      
        uint64_t        lr_length;      
        uint64_t        lr_blkoff;      
        blkptr_t        lr_blkptr;      
} lr_write_t;

typedef struct {
        lr_t            lr_common;      
        uint64_t        lr_foid;        
        uint64_t        lr_offset;      
        uint64_t        lr_length;      
} lr_truncate_t;

typedef struct {
        lr_t            lr_common;      
        uint64_t        lr_foid;        
        uint64_t        lr_mask;        
        uint64_t        lr_mode;        
        uint64_t        lr_uid;         
        uint64_t        lr_gid;         
        uint64_t        lr_size;        
        uint64_t        lr_atime[2];    
        uint64_t        lr_mtime[2];    
} lr_setattr_t;

typedef struct {
        lr_t            lr_common;      
        uint64_t        lr_foid;        
        uint64_t        lr_aclcnt;      
} lr_acl_v0_t;

typedef struct {
        lr_t            lr_common;      
        uint64_t        lr_foid;        
        uint64_t        lr_aclcnt;      
        uint64_t        lr_domcnt;      
        uint64_t        lr_fuidcnt;     
        uint64_t        lr_acl_bytes;   
        uint64_t        lr_acl_flags;   
} lr_acl_t;

/*
 * ZIL structure definitions, interface function prototype and globals.
 */

typedef enum {
        WR_INDIRECT,    
        WR_COPIED,      
        WR_NEED_COPY,   
        WR_NUM_STATES   
} itx_wr_state_t;

typedef struct itx {
        list_node_t     itx_node;       
        void            *itx_private;   
        itx_wr_state_t  itx_wr_state;   
        uint8_t         itx_sync;       
        uint64_t        itx_sod;        
        uint64_t        itx_oid;        
        lr_t            itx_lr;         
} itx_t;

typedef int zil_parse_blk_func_t(zilog_t *zilog, blkptr_t *bp, void *arg,
    uint64_t txg);
typedef int zil_parse_lr_func_t(zilog_t *zilog, lr_t *lr, void *arg,
    uint64_t txg);
typedef int zil_replay_func_t();
typedef int zil_get_data_t(void *arg, lr_write_t *lr, char *dbuf, zio_t *zio);

extern int zil_parse(zilog_t *zilog, zil_parse_blk_func_t *parse_blk_func,
    zil_parse_lr_func_t *parse_lr_func, void *arg, uint64_t txg);

extern void     zil_init(void);
extern void     zil_fini(void);

extern zilog_t  *zil_alloc(objset_t *os, zil_header_t *zh_phys);
extern void     zil_free(zilog_t *zilog);

extern zilog_t  *zil_open(objset_t *os, zil_get_data_t *get_data);
extern void     zil_close(zilog_t *zilog);

extern void     zil_replay(objset_t *os, void *arg,
    zil_replay_func_t *replay_func[TX_MAX_TYPE]);
extern boolean_t zil_replaying(zilog_t *zilog, dmu_tx_t *tx);
extern void     zil_destroy(zilog_t *zilog, boolean_t keep_first);
extern void     zil_destroy_sync(zilog_t *zilog, dmu_tx_t *tx);
extern void     zil_rollback_destroy(zilog_t *zilog, dmu_tx_t *tx);

extern itx_t    *zil_itx_create(uint64_t txtype, size_t lrsize);
extern void     zil_itx_destroy(itx_t *itx);
extern void     zil_itx_assign(zilog_t *zilog, itx_t *itx, dmu_tx_t *tx);

extern void     zil_commit(zilog_t *zilog, uint64_t oid);

extern int      zil_vdev_offline(const char *osname, void *txarg);
extern int      zil_claim(const char *osname, void *txarg);
extern int      zil_check_log_chain(const char *osname, void *txarg);
extern void     zil_sync(zilog_t *zilog, dmu_tx_t *tx);
extern void     zil_clean(zilog_t *zilog, uint64_t synced_txg);

extern int      zil_suspend(zilog_t *zilog);
extern void     zil_resume(zilog_t *zilog);

extern void     zil_add_block(zilog_t *zilog, const blkptr_t *bp);
extern int      zil_bp_tree_add(zilog_t *zilog, const blkptr_t *bp);

extern void     zil_set_sync(zilog_t *zilog, uint64_t syncval);

extern void     zil_set_logbias(zilog_t *zilog, uint64_t slogval);

extern int zil_replay_disable;

#ifdef  __cplusplus
}
#endif

#endif  /* _SYS_ZIL_H */