rtems-rfs-file-system.h

Go to the documentation of this file.

/*
 *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
 *
 *  The license and distribution terms for this file may be
 *  found in the file LICENSE in this distribution or at
 *  http://www.rtems.org/license/LICENSE.
 */

#if !defined (_RTEMS_RFS_FILE_SYSTEM_H_)
#define _RTEMS_RFS_FILE_SYSTEM_H_

#include <rtems/rfs/rtems-rfs-group.h>

#define RTEMS_RFS_SB_OFFSET_MAGIC           (0)
#define RTEMS_RFS_SB_MAGIC                  (0x28092001)
#define RTEMS_RFS_SB_OFFSET_VERSION         (RTEMS_RFS_SB_OFFSET_MAGIC           + 4)
#define RTEMS_RFS_SB_OFFSET_BLOCK_SIZE      (RTEMS_RFS_SB_OFFSET_VERSION         + 4)
#define RTEMS_RFS_SB_OFFSET_BLOCKS          (RTEMS_RFS_SB_OFFSET_BLOCK_SIZE      + 4)
#define RTEMS_RFS_SB_OFFSET_BAD_BLOCKS      (RTEMS_RFS_SB_OFFSET_BLOCKS          + 4)
#define RTEMS_RFS_SB_OFFSET_MAX_NAME_LENGTH (RTEMS_RFS_SB_OFFSET_BAD_BLOCKS      + 4)
#define RTEMS_RFS_SB_OFFSET_GROUPS          (RTEMS_RFS_SB_OFFSET_MAX_NAME_LENGTH + 4)
#define RTEMS_RFS_SB_OFFSET_GROUP_BLOCKS    (RTEMS_RFS_SB_OFFSET_GROUPS          + 4)
#define RTEMS_RFS_SB_OFFSET_GROUP_INODES    (RTEMS_RFS_SB_OFFSET_GROUP_BLOCKS    + 4)
#define RTEMS_RFS_SB_OFFSET_INODE_SIZE      (RTEMS_RFS_SB_OFFSET_GROUP_INODES    + 4)

#define RTEMS_RFS_VERSION (0x00000000)

#define RTEMS_RFS_VERSION_MASK INT32_C(0x00000000)

#define RTEMS_RFS_ROOT_INO (1)

#define RTEMS_RFS_EMPTY_INO (0)

#define RTEMS_RFS_INODE_BLOCKS (5)

#define RTEMS_RFS_INODE_OVERHEAD_PERCENTAGE (1)

#define RTEMS_RFS_SUPERBLOCK_SIZE (1)

#define RTEMS_RFS_FS_MAX_HELD_BUFFERS (5)

typedef uint64_t rtems_rfs_pos;

typedef int64_t rtems_rfs_pos_rel;

#define RTEMS_RFS_FS_BITMAPS_HOLD      (1 << 0) 
#define RTEMS_RFS_FS_NO_LOCAL_CACHE    (1 << 1) 
#define RTEMS_RFS_FS_FORCE_OPEN        (1 << 2) 
#define RTEMS_RFS_FS_READ_ONLY         (1 << 3) 
struct _rtems_rfs_file_system
{
  uint32_t flags;

  size_t blocks;

  size_t block_size;

  int device;

#if RTEMS_RFS_USE_LIBBLOCK

  rtems_disk_device* disk;
#else

  size_t size;
#endif

  uint32_t inodes;

  uint32_t bad_blocks;

  uint32_t max_name_length;

  rtems_rfs_group* groups;

  int group_count;

  size_t group_blocks;

  size_t group_inodes;

  size_t inodes_per_block;

  size_t blocks_per_block;

  size_t block_map_singly_blocks;

  size_t block_map_doubly_blocks;

  uint32_t max_held_buffers;

  rtems_chain_control buffers;

  uint32_t buffers_count;

  rtems_chain_control release;

  uint32_t release_count;

  rtems_chain_control release_modified;

  uint32_t release_modified_count;

  rtems_chain_control file_shares;

  void* user;
};

#define rtems_rfs_fs_flags(_f) ((_f)->flags)

#define rtems_rfs_fs_release_bitmaps(_f) (!((_f)->flags & RTEMS_RFS_FS_BITMAPS_HOLD))

#define rtems_rfs_fs_no_local_cache(_f) ((_f)->flags & RTEMS_RFS_FS_NO_LOCAL_CACHE)

#if RTEMS_RFS_USE_LIBBLOCK
#define rtems_rfs_fs_device(_fs) ((_fs)->disk)
#else
#define rtems_rfs_fs_device(_fs) ((_fs)->device)
#endif

#define rtems_rfs_fs_blocks(_fs) ((_fs)->blocks)

#define rtems_rfs_fs_block_size(_fs) ((_fs)->block_size)

#define rtems_rfs_fs_inodes(_fs) ((_fs)->inodes)

#define rtems_rfs_fs_block(_fs, _grp, _blk) \
  ((((_fs)->group_blocks) * (_grp)) + (_blk) + 1)

#if RTEMS_RFS_USE_LIBBLOCK
#define rtems_rfs_fs_media_blocks(_fs) ((_fs)->disk->size)
#else
#define rtems_rfs_fs_media_blocks(_fs) ((_fs)->media_size)
#endif

#if RTEMS_RFS_USE_LIBBLOCK
#define rtems_rfs_fs_media_block_size(_fs) ((_fs)->disk->media_block_size)
#else
#define rtems_rfs_fs_media_block_size(_fs) (1)
#endif

#define rtems_rfs_fs_max_name(_fs) ((_fs)->max_name_length)

#define rtems_rfs_fs_max_block_map_blocks(_fs) ((_fs)->block_map_doubly_blocks)

#define rtems_rfs_fs_user(_fs) ((_fs)->user)

uint64_t rtems_rfs_fs_size(rtems_rfs_file_system* fs);

uint64_t rtems_rfs_fs_media_size (rtems_rfs_file_system* fs);

int rtems_rfs_fs_open (const char*             name,
                       void*                   user,
                       uint32_t                flags,
                       uint32_t                max_held_buffers,
                       rtems_rfs_file_system** fs);

int rtems_rfs_fs_close (rtems_rfs_file_system* fs);

#endif