bcache.h

浏览该文件的文档.

/* ----------------------------------------------------------------------------
 * Copyright (c) Huawei Technologies Co., Ltd. 2015-2019. All rights reserved.
 * Description: LiteOS Bcache Module Headfile
 * Author: Huawei LiteOS Team
 * Create: 2015-01-01
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright notice, this list of
 * conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
 * of conditions and the following disclaimer in the documentation and/or other materials
 * provided with the distribution.
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific prior written
 * permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * --------------------------------------------------------------------------- */
#ifndef _BCACHE_H
#define _BCACHE_H
 
#include "pthread.h"
#include "linux/rbtree.h"
#include "los_list.h"
#include "los_atomic.h"
#ifdef LOSCFG_SHELL
#include "reset_shell.h"
#endif
#include "inode/inode.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define ALIGN_LIB(x)          (((x) + (HALARC_ALIGNMENT - 1)) & ~(HALARC_ALIGNMENT - 1))
#define ALIGN_DISP(x)         (HALARC_ALIGNMENT - ((x) & (HALARC_ALIGNMENT - 1)))
#define UNSIGNED_INTEGER_BITS 32
#define UNINT_MAX_SHIFT_BITS  31
#define UNINT_LOG2_SHIFT      5
#define EVEN_JUDGED           2
#define PERCENTAGE            100
 
#if CONFIG_FS_FAT_SECTOR_PER_BLOCK < UNSIGNED_INTEGER_BITS
#error cache too small
#else
#define BCACHE_BLOCK_FLAGS (CONFIG_FS_FAT_SECTOR_PER_BLOCK / UNSIGNED_INTEGER_BITS)
#endif
 
typedef struct {
    LOS_DL_LIST listNode;   /* list node */
    struct rb_node rbNode;  /* red-black tree node */
    UINT64 num;             /* block number */
    Atomic status;          /* the block status */
    BOOL readFlag;          /* is the block data have read form sd(real data) */
    UINT64 age;             /* the tick value of first fetch block */
    UINT8 *data;            /* block data */
    UINT32 flag[0];
} OsBcacheBlock;
 
typedef INT32 (*BcacheReadFun)(struct inode *, /* private data */
                               UINT8 *,        /* block buffer */
                               UINT32,         /* number of blocks to read */
                               UINT64);        /* starting block number */
 
typedef INT32 (*BcacheWriteFun)(struct inode *, /* private data */
                                const UINT8 *,  /* block buffer */
                                UINT32,         /* number of blocks to write */
                                UINT64);        /* starting block number */
 
typedef INT32 (*BcacheWritevFun)(struct inode *, /* private data */
                                 const struct iovec *,    /* segments */
                                 UINT32,         /* segments size to write */
                                 UINT64);        /* starting block number */
 
typedef struct tagOsBcache {
    VOID *priv;                   /* private data */
    LOS_DL_LIST listHead;         /* head of block list */
    struct rb_root rbRoot;        /* block red-black tree root */
    UINT32 blockSize;             /* block size in bytes */
    UINT32 blockSizeLog2;         /* block size log2 */
    UINT64 blockCount;            /* block count of the disk */
    UINT32 sectorSize;            /* device sector size in bytes */
    UINT32 sectorPerBlock;        /* sector count per block */
    UINT8 *memStart;              /* memory base */
    UINT64 curBlockNum;           /* current preread block number */
    LOS_DL_LIST freeListHead;     /* list of free blocks */
    BcacheReadFun breadFun;       /* block read function */
    BcacheWriteFun bwriteFun;     /* block write function */
    BcacheWritevFun bwritevFun;   /* block write segments function */
    UINT8 *rwBuffer;              /* buffer for bcache block */
    UINT32 bcacheMutex;           /* mutex for bcache */
    EVENT_CB_S bcacheEvent;       /* event for bcache */
    Atomic dirtyBlockNums;        /* number of dirty blocks */
#ifdef LOSCFG_FS_FAT_CACHE_SYNC_THREAD
    BOOL syncTaskDelete;          /* delete notify flag */
    BOOL syncTaskPend;            /* sync task is pending */
    UINT32 syncTaskId;            /* sync task id */
#endif
} OsBcache;
 
INT32 BlockCacheRead(OsBcache *bc,
                     UINT8 *buf,
                     UINT32 *len,
                     UINT64 num,
                     UINT64 pos);
 
INT32 BlockCacheWrite(OsBcache *bc,
                      const UINT8 *buf,
                      UINT32 *len,
                      UINT64 num,
                      UINT64 pos);
 
INT32 BlockCacheSync(OsBcache *bc);
 
OsBcache *BlockCacheInit(struct inode *devNode,
                         UINT32 sectorSize,
                         UINT32 sectorPerBlock,
                         UINT32 blockNum,
                         UINT64 blockCount);
 
VOID BlockCacheDeinit(OsBcache *bc);
 
INT32 OsSdSync(INT32 id);
 
#ifdef LOSCFG_FS_FAT_CACHE_SYNC_THREAD
VOID BcacheSyncThreadInit(OsBcache *bc, INT32 id);
VOID BcacheSyncThreadDeinit(OsBcache *bc);
#endif
 
#ifdef __cplusplus
}
#endif  /* __cplusplus */
#endif  /* _BCACHE_H */