mmfile.h File Reference

#include <stdint.h>
#include <Fs/vfs.h>

Include dependency graph for mmfile.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	__page_cache__
struct	__mm_file_back__

Typedefs
typedef struct __page_cache__	AuMMPageCache
typedef struct __mm_file_back__	AuMMFileBack

Functions
void	AuMmngrFileCacheInit ()
	AuMmngrFileCacheInit – initialize copy-on-write manager.
void	AuMmngrAddFileBack (AuMMFileBack *fb)
	AuMmngrAddFileBack – add a file back to file list.
void	AuMmngrRemoveFileBack (AuMMFileBack *fb)
	AuThreadDelete – remove a thread from thread list.
void	AuMmngrFileCacheEnable ()
	AuMmngrFileCacheEnable – enable file cache.
AuMMFileBack *	AuMmngrFileCacheLookup (const char *filename)
uint64_t	AuMmngrFileCacheGetPhysicalBlock (AuMMFileBack *fb, uint32_t fileoffset)
AuMMPageCache *	AuMmngrPageCacheCreate ()
	AuMmngrPageCacheCreate – create page cache.
AuMMPageCache *	AuMmngrFileCacheGetByIndex (AuMMFileBack *fb, size_t pageIndex)
void	AuMmngrFileBackAddPageCache (AuMMFileBack *fileb, AuMMPageCache *cache)
	AuMmngrFileBackAddPageCache – add a page cache to file back.

Detailed Description

BSD 2-Clause License

Copyright (c) 2022-2023, Manas Kamal Choudhury All rights reserved.

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.

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.

Typedef Documentation

AuMMFileBack

typedef struct __mm_file_back__ AuMMFileBack

AuMMPageCache

typedef struct __page_cache__ AuMMPageCache

Function Documentation

AuMmngrAddFileBack()

void AuMmngrAddFileBack ( AuMMFileBack *  fb )

extern

AuMmngrAddFileBack – add a file back to file list.

Parameters

fb	– Pointer to file back struct

AuMmngrFileBackAddPageCache()

void AuMmngrFileBackAddPageCache ( AuMMFileBack *  fileb, AuMMPageCache *  cache  )

extern

AuMmngrFileBackAddPageCache – add a page cache to file back.

Parameters

fileb	– Pointer to file back struct
cache	– Cache to add

AuMmngrFileCacheEnable()

void AuMmngrFileCacheEnable ( )

extern

AuMmngrFileCacheEnable – enable file cache.

AuMmngrFileCacheGetByIndex()

AuMMPageCache * AuMmngrFileCacheGetByIndex ( AuMMFileBack *  fb, size_t  pageIndex  )

extern

AuMmngrFileCacheGetPhysicalBlock()

uint64_t AuMmngrFileCacheGetPhysicalBlock ( AuMMFileBack *  fb, uint32_t  fileoffset  )

extern

AuMmngrFileCacheGetPhysicalBlock – returns a physical block of a file relative to file offset in bytes

Parameters

fb	– pointer to file back structure
fileoffset	– offset in bytes within the file

Returns

physical page number or UINT64_MAX if not found

AuMmngrFileCacheInit()

void AuMmngrFileCacheInit ( )

extern

AuMmngrFileCacheInit – initialize copy-on-write manager.

AuMmngrFileCacheLookup()

AuMMFileBack * AuMmngrFileCacheLookup ( const char *  filename )

extern

AuMmngrFileCacheLookup – lookup the file cache list for specific file if it's already opened

Parameters

filename

– name of the file to lookup

AuMmngrPageCacheCreate()

AuMMPageCache * AuMmngrPageCacheCreate ( )

extern

AuMmngrPageCacheCreate – create page cache.

Returns

newly created page cache

AuMmngrRemoveFileBack()

void AuMmngrRemoveFileBack ( AuMMFileBack *  fb )

extern

AuThreadDelete – remove a thread from thread list.

Parameters

thread

– thread address to remove