Mirrors_Framework/nuttx
1
0
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2026-05-21 21:22:17 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

fs/mnemofs: Add journal methods.

Browse Source 
Journal methods for mnemofs.

Signed-off-by: Saurav Pal <resyfer.dev@gmail.com>
This commit is contained in:
Saurav Pal
2024-07-13 12:10:47 +00:00
committed by Alan Carvalho de Assis
parent 9ef9788b6f
commit c86ef1cbc4
6 changed files with 768 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
fs/mnemofs/CMakeLists.txt
+1
View File
@@ -54,6 +54,7 @@ if(CONFIG_FS_MNEMOFS)
mnemofs_fsobj.c
mnemofs_journal.c
mnemofs_lru.c
mnemofs_master.c
mnemofs_rw.c
mnemofs_util.c
mnemofs.c)
fs/mnemofs/Make.defs
+1
View File
@@ -57,6 +57,7 @@ CSRCS += mnemofs_ctz.c
CSRCS += mnemofs_fsobj.c
CSRCS += mnemofs_journal.c
CSRCS += mnemofs_lru.c
CSRCS += mnemofs_master.c
CSRCS += mnemofs_rw.c
CSRCS += mnemofs_util.c
CSRCS += mnemofs.c
fs/mnemofs/mnemofs.h
+95
View File
@@ -410,6 +410,55 @@ static inline mfs_t mfs_popcnt(mfs_t x)
/* mnemofs_journal.c */
/****************************************************************************
* Name: mfs_jrnl_newlog
*
* Description:
* Add a new log to the journal.
*
* Input Parameters:
* sb - Superblock instance of the device.
* path - CTZ representation of the relpath.
* depth - Length of path.
* new_ctz - The updated location.
*
* Returned Value:
* 0 - OK
* < 0 - Error
*
* Assumptions/Limitations:
* Assumes the CTZ list to be updated is `path[depth - 1].ctz`.
*
****************************************************************************/
int mfs_jrnl_newlog(FAR struct mfs_sb_s * const sb,
FAR const struct mfs_path_s * const path,
const mfs_t depth, const struct mfs_ctz_s new_ctz);
/****************************************************************************
* Name: mfs_jrnl_updatepath
*
* Description:
* Updates the path of a CTZ list by applies all changes from the journal.
*
* Input Parameters:
* sb - Superblock instance of the device.
* path - CTZ representation of the relpath.
* depth - Length of path.
*
* Returned Value:
* 0 - OK
* < 0 - Error
*
* Assumptions/Limitations:
* Assumes the CTZ list to be updated is `path[depth - 1].ctz`.
*
****************************************************************************/
int mfs_jrnl_updatepath(FAR const struct mfs_sb_s * const sb,
FAR struct mfs_path_s * const path,
const mfs_t depth);
/****************************************************************************
* Name: mfs_jrnl_init
*
@@ -452,6 +501,29 @@ int mfs_jrnl_init(FAR struct mfs_sb_s * const sb, mfs_t blk);
int mfs_jrnl_fmt(FAR struct mfs_sb_s * const sb, mfs_t blk1, mfs_t blk2);
/****************************************************************************
* Name: mfs_jrnl_blkidx2blk
*
* Description:
* Gets the block number of a journal block at an index.
*
* Input Parameters:
* sb - Superblock instance of the device.
* blk_idx - Index of the block who's block number to find.
*
* Returned Value:
* Block number.
*
* Assumptions/Limitations:
* Assumes valid index. This index can also include master blocks. Also
* assumes, for now, that the entire journal array can fit in the first
* block.
*
****************************************************************************/
mfs_t mfs_jrnl_blkidx2blk(FAR const struct mfs_sb_s * const sb,
const mfs_t blk_idx);
/****************************************************************************
* Name: mfs_jrnl_free
*
@@ -1229,6 +1301,29 @@ void mfs_lru_updatedsz(FAR struct mfs_sb_s * const sb,
FAR const struct mfs_path_s * const path,
const mfs_t depth, mfs_t *n_sz);
/* mnemofs_master.c */
/****************************************************************************
* Name: mfs_mn_fmt
*
* Description:
* Format a master node.
*
* Input Parameters:
* sb - Superblock instance of the device.
* jrnl_blk - First block of the journal.
*
* Returned Value:
* 0 - OK
* < 0 - Error
*
* Assumptions/Limitations:
* The journal will have to be formatted before this.
*
****************************************************************************/
int mfs_mn_fmt(FAR struct mfs_sb_s * const sb, const mfs_t jrnl_blk);
/* mnemofs_fsobj.c */
/****************************************************************************
fs/mnemofs/mnemofs_ctz.c
+5
View File
@@ -375,7 +375,9 @@ int mfs_ctz_rdfromoff(FAR struct mfs_sb_s * const sb, mfs_t data_off,
/* Get updated location from the journal */
finfo("Journal upd!");
DEBUGASSERT(depth > 0);
mfs_jrnl_updatepath(sb, path, depth);
ctz = path[depth - 1].ctz;
ctz_off2loc(sb, data_off, &idx, &off);
@@ -609,6 +611,7 @@ int mfs_ctz_wrtooff(FAR struct mfs_sb_s * const sb, const mfs_t data_off,
/* Get updated location from the journal. */
DEBUGASSERT(depth > 0);
mfs_jrnl_updatepath(sb, path, depth);
o_ctz = path[depth - 1].ctz;
/* TODO: Make the traversal in reverse direction. It would cause
@@ -754,6 +757,8 @@ int mfs_ctz_wrtooff(FAR struct mfs_sb_s * const sb, const mfs_t data_off,
o_data_off += ctz_blk_datasz;
}
mfs_jrnl_newlog(sb, path, depth, n_ctz);
/* path is not updated to point to the new ctz. This is upto the caller. */
*ctz = n_ctz;
fs/mnemofs/mnemofs_journal.c
+545 -5
View File
File diff suppressed because it is too large Load Diff
fs/mnemofs/mnemofs_master.c
+121
View File
@@ -0,0 +1,121 @@
/****************************************************************************
* fs/mnemofs/mnemofs_master.c
* Master node of mnemofs.
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
* Alternatively, the contents of this file may be used under the terms of
* the BSD-3-Clause license:
*
* SPDX-License-Identifier: BSD-3-Clause
*
* Copyright (c) 2024 Saurav Pal
*
* 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 author nor the names of its contributors may
* be used to endorse or promote products derived from this software
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
*
****************************************************************************/
/****************************************************************************
* In mnemofs, the master node points to the root of the file system. It
* contains the information about the root, and when the root is updated,
* the master node needs to point to the updated location, and thus, needs to
* update the master node.
*
* Master nodes sit at the very end of the journal. The last two blocks of
* the journal are called master blocks, and they are filled with a new
* entry for a master node everytime it is updated. They are filled in a
* sequential manner, and thus, the latest master node can be found easily.
* The two master blocks contain identical information, and exist to be as a
* backup.
*
* The stored master nodes are basically `struct mfs_mn_s` without the
* redundant `pg` member.
*
* The master node also points to the start of the journal, and thus, when
* the journal moves, a new master node entry is added.
*
* A master node update, when written to the file system, marks the end of
* an update of the file system tree. Thus, at this point, any obsolete data
* that can be erased, will be erased by the block allocator. Only after
* writing the master block is the file system tree updated. Before this,
* the old file system tree is accessible through the older master node, and
* can be accessed again during power loss.
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/kmalloc.h>
#include <sys/stat.h>
#include "mnemofs.h"
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/****************************************************************************
* Private Types
****************************************************************************/
/****************************************************************************
* Private Function Prototypes
****************************************************************************/
/****************************************************************************
* Private Data
****************************************************************************/
/****************************************************************************
* Public Data
****************************************************************************/
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Public Functions
****************************************************************************/
int mfs_mn_fmt(FAR struct mfs_sb_s * const sb, const mfs_t jrnl_blk)
{
/* TODO */
return OK;
}