littlefs原理分析--存储结构（一）

[----            32             ----]
[1|--  11   --|--  10  --|--  10  --]
 ^.     ^     .     ^          ^- length
 |.     |     .     '------------ id
 |.     '-----.------------------ type (type3)
 '.-----------.------------------ valid bit
  [-3-|-- 8 --]
    ^     ^- chunk
    '------- type (type1)

tag                          data
[--      32      --][--      32      --|--      32      --]
[1|- 11 -| 10 | 10 ][--      32      --|--      32      --]
 ^    ^     ^    ^            ^                  ^- file size
 |    |     |    |            '-------------------- file head
 |    |     |    '- size (8)
 |    |     '------ id
 |    '------------ type (0x202)
 '----------------- valid bit

typedef struct lfs_superblock {
    uint32_t version;           // littlefs版本
    lfs_size_t block_size;      // 一个块的大小
    lfs_size_t block_count;     // 文件系统中块的总数
    lfs_size_t name_max;        // 文件名字节数的最大值
    lfs_size_t file_max;        // 文件大小字节数的最大值
    lfs_size_t attr_max;        // 文件属性字节数的最大值
} lfs_superblock_t;

typedef struct lfs_mdir {
    lfs_block_t pair[2];    // 元数据对块指针
    uint32_t rev;           // revision count

    // 当前在元数据块中的偏移
    // 用于commit和fetch相关函数
    // 作为起始偏移传入，结束时保存了写入后的偏移
    lfs_off_t off;

    // entry tag，用于记录当前的ptag
    // ptag用于commit过程中计算异或tag、计算CRC等，见commit机制和tag的遍历
    // 当fetch时，fetch到一个commit时，会将计算的ptag存入etag
    // 当进行commit时，ptag就可以初始化为etag
    uint32_t etag;

    uint16_t count;         // 目录中属性数量（文件、子目录数）

    // 表示下一个commit是否写入完成
    // 用于commit和fetch相关函数，见commit机制和tag的遍历
    // 当fetch时，fetch到末尾还未匹配，会把erased置为true
    // 在commit函数中，只有erased为true才进行commit
    bool erased;

    bool split;             // 表示当前目录块后面是否还有块，为false时表示末尾

    // 表示当前目录块中最后一个TAIL
    // 既可能是HARDTAIL，也可能是SOFTTAIL
    // 与fetch机制、目录的遍历等有关
    lfs_block_t tail[2];

    // 注：off、etag、erased、tail与commit机制、tag的遍历等有关，见后面的文章
} lfs_mdir_t;

typedef struct lfs_file {
    // 以下4个成员与mlist相关，见后文mlist的介绍
    struct lfs_file *next;
    uint16_t id;
    uint8_t type;
    lfs_mdir_t m;

    struct lfs_ctz {
        lfs_block_t head;    // 跳表头指针，inline文件时为LFS_BLOCK_INLINE
        lfs_size_t size;     // 文件大小，inline和outline文件均用此记录
    } ctz;

    uint32_t flags;          // INLINE、OUTLINE、DIRTY、WRITING等标志
    lfs_off_t pos;           // 文件当前的偏移字节数
    lfs_block_t block;       // 文件当前的block
    lfs_off_t off;           // 文件在当前block的偏移
    lfs_cache_t cache;       // 文件缓存，用于读写等操作

    const struct lfs_file_config *cfg;    // 文件的其他配置信息
} lfs_file_t;

typedef struct lfs {
    ...
    struct lfs_mlist {
        struct lfs_mlist *next;    // 下一个链表中的节点
        uint16_t id;               // 文件或目录在其父目录中的id
        uint8_t type;              // 类型，表明是文件还是目录
        lfs_mdir_t m;              // 父目录元数据对信息
    } *mlist;
    ...
} lfs_t;

typedef struct lfs_file {
    struct lfs_file *next;   // 下一个链表中的节点
    uint16_t id;             // 文件在父目录中的id
    uint8_t type;            // 类型，文件类型应为LFS_REG_TYPE
    lfs_mdir_t m;            // 父目录元数据对信息

    // 以下成员见上文中存储结构
    ...
} lfs_file_t;

typedef struct lfs_dir {
    struct lfs_dir *next;    // 下一个链表中的节点
    uint16_t id;             // 目录在父目录中的id
    uint8_t type;            // 类型，目录应为LFS_DIR_TYPE
    lfs_mdir_t m;            // 父目录元数据对信息

    lfs_off_t pos;           // 当前目录或文件在父目录中的位置，.和..分别为0和1
    lfs_block_t head[2];     // 第一个元数据对所在块号
} lfs_dir_t;

lfs_file_open(lfs_t *lfs, lfs_file_t *file, const char *path, int flags)
|-> lfs_file_rawopen(lfs_t *lfs, lfs_file_t *file,
    |    const char *path, int flags)
    |-> lfs_file_rawopencfg(lfs_t *lfs, lfs_file_t *file,
        |   const char *path, int flags,
        |   const struct lfs_file_config *cfg)
        |-> ...
        |
        |   // 将file加入到mlist
        |-> lfs_mlist_append(lfs, (struct lfs_mlist *)file);
        |
        |-> ...

lfs_file_close(lfs_t *lfs, lfs_file_t *file)
|-> lfs_file_rawclose(lfs_t *lfs, lfs_file_t *file)
    |-> lfs_mlist_remove(lfs, (struct lfs_mlist*)file);
    |
    |-> ...

lfs_dir_open(lfs_t *lfs, lfs_dir_t *dir, const char *path)
|-> lfs_dir_rawopen(lfs_t *lfs, lfs_dir_t *dir, const char *path)
    |-> ...
    |
    |-> lfs_mlist_append(lfs, (struct lfs_mlist *)dir);

lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir)
|-> lfs_dir_rawclose(lfs_t *lfs, lfs_dir_t *dir)
    |-> lfs_mlist_remove(lfs, (struct lfs_mlist *)dir);