bcache.h 文件参考

浏览源代码.

结构体
struct	OsBcacheBlock
struct	tagOsBcache

类型定义
typedef INT32(*	BcacheReadFun) (struct Vnode *, UINT8 *, UINT32, UINT64)
typedef INT32(*	BcacheWriteFun) (struct Vnode *, const UINT8 *, UINT32, UINT64)
typedef VOID(*	BcachePrereadFun) (struct tagOsBcache *, const OsBcacheBlock *)
typedef struct tagOsBcache	OsBcache

函数
INT32	BlockCacheRead (OsBcache *bc, UINT8 *buf, UINT32 *len, UINT64 pos, BOOL useRead)
	读块设备缓存 更多...
INT32	BlockCacheWrite (OsBcache *bc, const UINT8 *buf, UINT32 *len, UINT64 pos)
	写块设备缓存 更多...
INT32	BlockCacheSync (OsBcache *bc)
	块缓存同步 更多...
OsBcache *	BlockCacheInit (struct Vnode *devNode, UINT32 sectorSize, UINT32 sectorPerBlock, UINT32 blockNum, UINT64 blockCount)
VOID	BlockCacheDeinit (OsBcache *bc)
INT32	BcacheClearCache (OsBcache *bc)
INT32	OsSdSync (INT32 id)
VOID	BcacheSyncThreadInit (OsBcache *bc, INT32 id)
	块缓存同步任务初始化,开了个内核任务. 更多...
VOID	BcacheSyncThreadDeinit (const OsBcache *bc)
UINT32	BcacheAsyncPrereadInit (OsBcache *bc)
VOID	ResumeAsyncPreread (OsBcache *arg1, const OsBcacheBlock *arg2)
UINT32	BcacheAsyncPrereadDeinit (OsBcache *bc)

类型定义说明

BcachePrereadFun

typedef VOID(* BcachePrereadFun) (struct tagOsBcache *, const OsBcacheBlock *)

在文件 bcache.h 第 90 行定义.

BcacheReadFun

typedef INT32(* BcacheReadFun) (struct Vnode *, UINT8 *, UINT32, UINT64)

在文件 bcache.h 第 78 行定义.

BcacheWriteFun

typedef INT32(* BcacheWriteFun) (struct Vnode *, const UINT8 *, UINT32, UINT64)

在文件 bcache.h 第 83 行定义.

OsBcache

typedef struct tagOsBcache OsBcache

函数说明

BcacheAsyncPrereadDeinit()

UINT32 BcacheAsyncPrereadDeinit

(

OsBcache *

bc

)

在文件 bcache.c 第 1210 行定义.

{
    UINT32 ret = LOS_NOK;
 
    if (bc != NULL) {
        ret = LOS_TaskDelete(bc->prereadTaskId);
        if (ret != ENOERR) {
            PRINT_ERR("Bcache async task delete failed in %s, %d\n", __FUNCTION__, __LINE__);
        }
 
        ret = LOS_EventDestroy(&bc->bcacheEvent);
        if (ret != ENOERR) {
            PRINT_ERR("Async event destroy failed in %s, %d\n", __FUNCTION__, __LINE__);
            return ret;
        }
    }
 
    return ret;
}

函数调用图:

这是这个函数的调用关系图:

BcacheAsyncPrereadInit()

UINT32 BcacheAsyncPrereadInit

(

OsBcache *

bc

)

在文件 bcache.c 第 1184 行定义.

{
    UINT32 ret;
    TSK_INIT_PARAM_S appTask;
 
    ret = LOS_EventInit(&bc->bcacheEvent);
    if (ret != ENOERR) {
        PRINT_ERR("Async event init failed in %s, %d\n", __FUNCTION__, __LINE__);
        return ret;
    }
 
    (VOID)memset_s(&appTask, sizeof(TSK_INIT_PARAM_S), 0, sizeof(TSK_INIT_PARAM_S));
    appTask.pfnTaskEntry = (TSK_ENTRY_FUNC)BcacheAsyncPrereadThread;
    appTask.uwStackSize = BCACHE_STATCK_SIZE;
    appTask.pcName = "bcache_async_task";
    appTask.usTaskPrio = BCACHE_PREREAD_PRIO;
    appTask.auwArgs[0] = (UINTPTR)bc;
    appTask.uwResved = LOS_TASK_STATUS_DETACHED;
    ret = LOS_TaskCreate(&bc->prereadTaskId, &appTask);
    if (ret != ENOERR) {
        PRINT_ERR("Bcache async task create failed in %s, %d\n", __FUNCTION__, __LINE__);
    }
 
    return ret;
}

函数调用图:

这是这个函数的调用关系图:

BcacheClearCache()

INT32 BcacheClearCache

(

OsBcache *

bc

)

在文件 bcache.c 第 706 行定义.

{
    OsBcacheBlock *block = NULL;
    OsBcacheBlock *next = NULL;
    LOS_DL_LIST_FOR_EACH_ENTRY_SAFE(block, next, &bc->listHead, OsBcacheBlock, listNode) {
        DelBlock(bc, block);
    }
    return 0;
}

函数调用图:

这是这个函数的调用关系图:

BcacheSyncThreadDeinit()

VOID BcacheSyncThreadDeinit

(

const OsBcache *

bc

)

在文件 bcache.c 第 1055 行定义.

{
    if (bc != NULL) {
        if (LOS_TaskDelete(bc->syncTaskId) != ENOERR) {
            PRINT_ERR("Bcache sync task delete failed in %s, %d\n", __FUNCTION__, __LINE__);
        }
    }
}

函数调用图:

这是这个函数的调用关系图:

BcacheSyncThreadInit()

VOID BcacheSyncThreadInit	(	OsBcache *	bc,
		INT32	id
	)

块缓存同步任务初始化,开了个内核任务.

在文件 bcache.c 第 1037 行定义.

{
    UINT32 ret;
    TSK_INIT_PARAM_S appTask;
 
    (VOID)memset_s(&appTask, sizeof(TSK_INIT_PARAM_S), 0, sizeof(TSK_INIT_PARAM_S));
    appTask.pfnTaskEntry = (TSK_ENTRY_FUNC)BcacheSyncThread;
    appTask.uwStackSize = BCACHE_STATCK_SIZE;
    appTask.pcName = "bcache_sync_task";
    appTask.usTaskPrio = g_syncThreadPrio;//任务优先级
    appTask.auwArgs[0] = (UINTPTR)id;
    appTask.uwResved = LOS_TASK_STATUS_DETACHED;
    ret = LOS_TaskCreate(&bc->syncTaskId, &appTask);
    if (ret != ENOERR) {
        PRINT_ERR("Bcache sync task create failed in %s, %d\n", __FUNCTION__, __LINE__);
    }
}

函数调用图:

这是这个函数的调用关系图:

BlockCacheDeinit()

VOID BlockCacheDeinit

(

OsBcache *

bc

)

Description:

The BlockCacheDeinit() function shall deinit the bcache and release resources.

参数

bc	[IN] block cache instance

注意

• None.

返回值

#VOID

None.

Dependency:

• bcache.h

在文件 bcache.c 第 1122 行定义.

{
    if (bcache != NULL) {
        (VOID)pthread_mutex_destroy(&bcache->bcacheMutex);
        free(bcache->memStart);
        bcache->memStart = NULL;
        free(bcache->rwBuffer);
        bcache->rwBuffer = NULL;
        free(bcache);
    }
}

函数调用图:

这是这个函数的调用关系图:

BlockCacheInit()

OsBcache * BlockCacheInit	(	struct Vnode *	devNode,
		UINT32	sectorSize,
		UINT32	sectorPerBlock,
		UINT32	blockNum,
		UINT64	blockCount
	)

Description:

The BlockCacheInit() function shall alloc memory for bcache and init it.

参数

devNode	[IN] dev node instance
sectorSize	[IN] size of a sector
sectorPerBlock	[IN] sector count per block in bcache
blockNum	[IN] block number of bcache
blockCount	[IN] block count of the disk

注意

• None.

返回值

OsBcache	* init succeded
#NULL	init failed

Dependency:

• bcache.h

在文件 bcache.c 第 1065 行定义.

{
    OsBcache *bcache = NULL;
    struct Vnode *blkDriver = devNode;
    UINT8 *bcacheMem = NULL;
    UINT8 *rwBuffer = NULL;
    UINT32 blockSize, memSize;
 
    if ((blkDriver == NULL) || (sectorSize * sectorPerBlock * blockNum == 0) || (blockCount == 0)) {
        return NULL;
    }
 
    blockSize = sectorSize * sectorPerBlock;
    if ((((UINT64)(sizeof(OsBcacheBlock) + blockSize) * blockNum) + DMA_ALLGN) > UINT_MAX) {
        return NULL;
    }
    memSize = ((sizeof(OsBcacheBlock) + blockSize) * blockNum) + DMA_ALLGN;
 
    bcache = (OsBcache *)zalloc(sizeof(OsBcache));
    if (bcache == NULL) {
        PRINT_ERR("bcache_init : malloc %u Bytes failed!\n", sizeof(OsBcache));
        return NULL;
    }
 
    bcacheMem = (UINT8 *)zalloc(memSize);
    if (bcacheMem == NULL) {
        PRINT_ERR("bcache_init : malloc %u Bytes failed!\n", memSize);
        goto ERROR_OUT_WITH_BCACHE;
    }
 
    rwBuffer = (UINT8 *)memalign(DMA_ALLGN, blockSize);
    if (rwBuffer == NULL) {
        PRINT_ERR("bcache_init : malloc %u Bytes failed!\n", blockSize);
        goto ERROR_OUT_WITH_MEM;
    }
 
    bcache->rwBuffer = rwBuffer;
    bcache->sectorSize = sectorSize;
    bcache->sectorPerBlock = sectorPerBlock;
    bcache->blockCount = blockCount;
 
    if (BlockCacheDrvCreate(blkDriver, bcacheMem, memSize, blockSize, bcache) != ENOERR) {
        goto ERROR_OUT_WITH_BUFFER;
    }
 
    return bcache;
 
ERROR_OUT_WITH_BUFFER:
    free(rwBuffer);
ERROR_OUT_WITH_MEM:
    free(bcacheMem);
ERROR_OUT_WITH_BCACHE:
    free(bcache);
    return NULL;
}

函数调用图:

这是这个函数的调用关系图:

BlockCacheRead()

INT32 BlockCacheRead	(	OsBcache *	bc,
		UINT8 *	buf,
		UINT32 *	len,
		UINT64	pos,
		BOOL	useRead
	)

读块设备缓存

Description:

The BlockCacheRead() function shall read data from the bcache, and if it doesn't hit, read the data from disk.

参数

bc	[IN] block cache instance
buf	[OUT] data buffer ptr
len	[IN] number of bytes to read
num	[IN] starting block number
pos	[IN] starting position inside starting block
useRead	[IN] whether use the read block or write block

注意

• The block number is automatically adjusted if position is greater than block size.

返回值

#0	read succeded
INT32	read failed

Dependency:

• bcache.h

在文件 bcache.c 第 824 行定义.

{
    OsBcacheBlock *block = NULL;
    UINT8 *tempBuf = buf;
    UINT32 size;
    UINT32 currentSize;
    INT32 ret = ENOERR;
    UINT64 pos;
    UINT64 num;
#ifdef BCACHE_ANALYSE
    PRINTK("bcache read:\n");
#endif
 
    if (bc == NULL || buf == NULL || len == NULL) {
        return -EPERM;
    }
 
    size = *len;
    pos = sector * bc->sectorSize;
    num = pos >> bc->blockSizeLog2;
    pos = pos & (bc->blockSize - 1);
 
    while (size > 0) {
        if ((size + pos) > bc->blockSize) {
            currentSize = bc->blockSize - (UINT32)pos;
        } else {
            currentSize = size;
        }
 
        (VOID)pthread_mutex_lock(&bc->bcacheMutex);
 
        /* useRead should be FALSE when reading large contiguous data */
        ret = BcacheGetBlock(bc, num, useRead, &block);
        if (ret != ENOERR) {
            (VOID)pthread_mutex_unlock(&bc->bcacheMutex);
            break;
        }
 
        if ((block->readFlag == FALSE) && (block->modified == TRUE)) {
            ret = BcacheGetFlag(bc, block);
            if (ret != ENOERR) {
                (VOID)pthread_mutex_unlock(&bc->bcacheMutex);
                return ret;
            }
        } else if ((block->readFlag == FALSE) && (block->modified == FALSE)) {
            ret = BlockRead(bc, block, block->data);
            if (ret != ENOERR) {
                (VOID)pthread_mutex_unlock(&bc->bcacheMutex);
                return ret;
            }
        }
 
        if (LOS_CopyFromKernel((VOID *)tempBuf, size, (VOID *)(block->data + pos), currentSize) != EOK) {
            (VOID)pthread_mutex_unlock(&bc->bcacheMutex);
            return VFS_ERROR;
        }
 
        (VOID)pthread_mutex_unlock(&bc->bcacheMutex);
 
        tempBuf += currentSize;
        size -= currentSize;
        pos = 0;
        num++;
    }
    *len -= size;
    return ret;
}

函数调用图:

这是这个函数的调用关系图:

BlockCacheSync()

INT32 BlockCacheSync

(

OsBcache *

bc

)

块缓存同步

Description:

The BlockCacheSync() function shall write-back all dirty data in the bcache into the disk.

参数

bc	[IN] block cache instance

注意

• None.

返回值

#0	sync succeded
INT32	sync failed

Dependency:

• bcache.h

在文件 bcache.c 第 951 行定义.

{
    return BcacheSync(bc);
}

函数调用图:

这是这个函数的调用关系图:

BlockCacheWrite()

INT32 BlockCacheWrite	(	OsBcache *	bc,
		const UINT8 *	buf,
		UINT32 *	len,
		UINT64	pos
	)

写块设备缓存

Description:

The BlockCacheWrite() function shall write data to the bcache.

参数

bc	[IN] block cache instance
buf	[IN] data buffer ptr
len	[IN] number of bytes to write
num	[IN] starting block number
pos	[IN] starting position inside starting block

注意

• The block number is automatically adjusted if position is greater than block size.

返回值

#0	write succeded
INT32	write failed

Dependency:

• bcache.h

在文件 bcache.c 第 892 行定义.

{
    OsBcacheBlock *block = NULL;
    const UINT8 *tempBuf = buf;
    UINT32 size = *len;
    INT32 ret = ENOERR;
    UINT32 currentSize;
    UINT64 pos;
    UINT64 num;
#ifdef BCACHE_ANALYSE
    PRINTK("bcache write:\n");
#endif
 
    pos = sector * bc->sectorSize;
    num = pos >> bc->blockSizeLog2;
    pos = pos & (bc->blockSize - 1);
 
    D(("bcache write len = %u pos = %llu bnum = %llu\n", *len, pos, num));
 
    while (size > 0) {
        if ((size + pos) > bc->blockSize) {
            currentSize = bc->blockSize - (UINT32)pos;
        } else {
            currentSize = size;
        }
 
        (VOID)pthread_mutex_lock(&bc->bcacheMutex);
        ret = BcacheGetBlock(bc, num, FALSE, &block);
        if (ret != ENOERR) {
            (VOID)pthread_mutex_unlock(&bc->bcacheMutex);
            break;
        }
 
        if (LOS_CopyToKernel((VOID *)(block->data + pos), bc->blockSize - (UINT32)pos,
            (VOID *)tempBuf, currentSize) != EOK) {
            (VOID)pthread_mutex_unlock(&bc->bcacheMutex);
            return VFS_ERROR;
        }
        if (block->modified == FALSE) {
            block->modified = TRUE;
            bc->modifiedBlock++;
        }
        if ((pos == 0) && (currentSize == bc->blockSize)) {
            (void)memset_s(block->flag, sizeof(block->flag), 0xFF, sizeof(block->flag));
            block->allDirty = TRUE;
        } else {
            BcacheSetFlag(bc, block, (UINT32)pos, currentSize);
        }
        (VOID)pthread_mutex_unlock(&bc->bcacheMutex);
 
        tempBuf += currentSize;
        size -= currentSize;
        pos = 0;
        num++;
    }
    *len -= size;
    return ret;
}

函数调用图:

这是这个函数的调用关系图:

OsSdSync()

INT32 OsSdSync

(

INT32

id

)

在文件 bcache.c 第 956 行定义.

{
#ifdef LOSCFG_FS_FAT_CACHE
    INT32 ret;
    los_disk *disk = get_disk(id);
    if ((disk == NULL) || (disk->disk_status == STAT_UNUSED)) {
        return VFS_ERROR;
    }
    if (pthread_mutex_lock(&disk->disk_mutex) != ENOERR) {
        PRINT_ERR("%s %d, mutex lock fail!\n", __FUNCTION__, __LINE__);
        return VFS_ERROR;
    }
    if ((disk->disk_status == STAT_INUSED) && (disk->bcache != NULL)) {
        ret = BcacheSync(disk->bcache);
    } else {
        ret = VFS_ERROR;
    }
    if (pthread_mutex_unlock(&disk->disk_mutex) != ENOERR) {
        PRINT_ERR("%s %d, mutex unlock fail!\n", __FUNCTION__, __LINE__);
        return VFS_ERROR;
    }
    return ret;
#else
    return VFS_ERROR;
#endif
}

函数调用图:

这是这个函数的调用关系图:

ResumeAsyncPreread()

VOID ResumeAsyncPreread	(	OsBcache *	arg1,
		const OsBcacheBlock *	arg2
	)

在文件 bcache.c 第 1169 行定义.

{
    UINT32 ret;
    OsBcache *bc = arg1;
    const OsBcacheBlock *block = arg2;
 
    if (OsCurrTaskGet()->taskID != bc->prereadTaskId) {
        bc->curBlockNum = block->num;
        ret = LOS_EventWrite(&bc->bcacheEvent, ASYNC_EVENT_BIT);
        if (ret != ENOERR) {
            PRINT_ERR("Write event failed in %s, %d\n", __FUNCTION__, __LINE__);
        }
    }
}

函数调用图:

这是这个函数的调用关系图: