xipfs_fs.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2024-2026 Université de Lille
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */

 
#ifndef FS_XIPFS_FS_H
#define FS_XIPFS_FS_H
 
#include "vfs.h"
#include "mtd_flashpage.h"
#include "mutex.h"
#include "include/xipfs.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define XIPFS_PARTITION_CORE(id, path, data, data_bytesize) \
    static mutex_t execution_mutex_##id = MUTEX_INIT;       \
    static mutex_t mutex_##id = MUTEX_INIT;                 \
    static vfs_xipfs_mount_t id = {                         \
        .vfs_mp = {                                         \
            .fs = &xipfs_file_system,                       \
            .mount_point = path,                            \
        },                                                  \
        .magic = XIPFS_MAGIC,                               \
        .mount_path = path,                                 \
        .page_num = data_bytesize / XIPFS_NVM_PAGE_SIZE,    \
        .page_addr = (void *)data,                          \
        .execution_mutex = &execution_mutex_##id,           \
        .mutex = &mutex_##id                                \
    }

#define XIPFS_NEW_PARTITION(id, path, num)                                      \
    FLASH_WRITABLE_INIT(xipfs_part_##id, num);                                  \
    XIPFS_PARTITION_CORE(id, path, xipfs_part_##id, num * XIPFS_NVM_PAGE_SIZE)

#define XIPFS_START_PARTITION_INCLUSION(id)         \
    __attribute__((aligned(XIPFS_NVM_PAGE_SIZE)))   \
    __attribute__((section(".rodata.xipfs." #id)))

#define XIPFS_END_PARTITION_INCLUSION(id, path, data, data_bytesize) \
    XIPFS_PARTITION_CORE(id, path, data, data_bytesize)

typedef struct vfs_xipfs_mount_s {
    vfs_mount_t vfs_mp;      
    unsigned magic;          
    const char *mount_path;  
    size_t page_num;         
    void *page_addr;         
    mutex_t *execution_mutex;
    mutex_t *mutex;          
} vfs_xipfs_mount_t;

extern const vfs_file_system_t xipfs_file_system;

int xipfs_construct_from_flashpage(mtd_flashpage_t *flashpage, const char *path,
                                   mutex_t *execution_mutex, mutex_t *mutex,
                                   vfs_xipfs_mount_t *vfs_xipfs_mount);
 
/* Extended driver handling executables */

int xipfs_extended_driver_new_file(const char *full_path, uint32_t size,
                                   uint32_t exec);

int xipfs_extended_driver_execv(const char *full_path, char *const argv[]);
 
#ifdef XIPFS_ENABLE_SAFE_EXEC_SUPPORT

int xipfs_extended_driver_safe_execv(const char *full_path,
                                     char *const argv[]);
 
#endif /* XIPFS_ENABLE_SAFE_EXEC_SUPPORT */
 
#ifdef __cplusplus
}
#endif
 
#endif /* FS_XIPFS_FS_H */