rtems-rfs-file.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_H_)
#define _RTEMS_RFS_FILE_H_

#include <rtems/libio_.h>

#include <rtems/rfs/rtems-rfs-block.h>
#include <rtems/rfs/rtems-rfs-data.h>
#include <rtems/rfs/rtems-rfs-file-system.h>
#include <rtems/rfs/rtems-rfs-inode.h>

typedef struct _rtems_rfs_file_shared
{
  rtems_chain_node link;

  int references;

  rtems_rfs_inode_handle inode;

  rtems_rfs_block_map map;

  rtems_rfs_block_size size;

  rtems_rfs_time atime;

  rtems_rfs_time mtime;

  rtems_rfs_time ctime;

  rtems_rfs_file_system* fs;

} rtems_rfs_file_shared;

static inline rtems_rfs_time
rtems_rfs_file_shared_get_atime (rtems_rfs_file_shared* shared)
{
  return shared->atime;
}

static inline rtems_rfs_time
rtems_rfs_file_shared_get_mtime (rtems_rfs_file_shared* shared)
{
  return shared->mtime;
}

static inline rtems_rfs_time
rtems_rfs_file_shared_get_ctime (rtems_rfs_file_shared* shared)
{
  return shared->ctime;
}

static inline uint32_t
rtems_rfs_file_shared_get_block_count (rtems_rfs_file_shared* shared)
{
  return shared->size.count;
}

static inline uint16_t
rtems_rfs_file_shared_get_block_offset (rtems_rfs_file_shared* shared)
{
  return shared->size.offset;
}

static inline rtems_rfs_pos
rtems_rfs_file_shared_get_size (rtems_rfs_file_system* fs,
                                rtems_rfs_file_shared* shared)
{
  return rtems_rfs_block_get_size (fs, &shared->size);
}

#define RTEMS_RFS_FILE_NO_ATIME_UPDATE  (1 << 0) 
#define RTEMS_RFS_FILE_NO_MTIME_UPDATE  (1 << 1) 
#define RTEMS_RFS_FILE_NO_LENGTH_UPDATE (1 << 2) 
typedef struct _rtems_rfs_file_handle
{
  int flags;

  rtems_rfs_buffer_handle buffer;

  rtems_rfs_block_pos bpos;

  rtems_rfs_file_shared* shared;

} rtems_rfs_file_handle;

#define rtems_rfs_file_data(_f) \
  (rtems_rfs_buffer_data (&(_f)->buffer) + (_f)->bpos.boff)

#define rtems_rfs_file_fs(_f) ((_f)->shared->fs)

#define rtems_rfs_file_inode(_f) (&(_f)->shared->inode)

#define rtems_rfs_file_map(_f) (&(_f)->shared->map)

#define rtems_rfs_file_bpos(_f) (&(_f)->bpos)

#define rtems_rfs_file_block(_f) ((_f)->bpos.bno)

#define rtems_rfs_file_block_offset(_f) ((_f)->bpos.boff)

#define rtems_rfs_file_set_bpos(_f, _p) \
  rtems_rfs_block_get_bpos (rtems_rfs_file_fs (_f), _p, (&(_f)->bpos))

#define rtems_rfs_file_buffer(_f) (&(_f)->buffer)

#define rtems_rfs_file_update_atime(_f) \
  (((_f)->flags & RTEMS_RFS_FILE_NO_ATIME_UPDATE) == 0)

#define rtems_rfs_file_update_mtime(_f) \
  (((_f)->flags & RTEMS_RFS_FILE_NO_MTIME_UPDATE) == 0)

#define rtems_rfs_file_update_length(_f) \
  (((_f)->flags & RTEMS_RFS_FILE_NO_LENGTH_UPDATE) == 0)

#define rtems_rfs_file_get_size(_f) \
   (&(_f)->shared->size)

#define rtems_rfs_file_size(_f) \
  rtems_rfs_file_shared_get_size (rtems_rfs_file_fs (_f), (_f)->shared)

#define rtems_rfs_file_size_count(_f) \
  rtems_rfs_file_shared_get_block_count ((_f)->shared)

#define rtems_rfs_file_size_offset(_f) \
  rtems_rfs_file_shared_get_block_offset ((_f)->shared)

int rtems_rfs_file_open (rtems_rfs_file_system*  fs,
                         rtems_rfs_ino           ino,
                         int                     oflag,
                         rtems_rfs_file_handle** handle);

int rtems_rfs_file_close (rtems_rfs_file_system* fs,
                          rtems_rfs_file_handle* handle);

int rtems_rfs_file_io_start (rtems_rfs_file_handle* handle,
                             size_t*                available,
                             bool                   read);

int rtems_rfs_file_io_end (rtems_rfs_file_handle* handle,
                           size_t                 size,
                           bool                   read);

int rtems_rfs_file_io_release (rtems_rfs_file_handle* handle);

int rtems_rfs_file_seek (rtems_rfs_file_handle* handle,
                         rtems_rfs_pos          pos,
                         rtems_rfs_pos*         new_pos);

int rtems_rfs_file_set_size (rtems_rfs_file_handle* handle,
                             rtems_rfs_pos          size);

rtems_rfs_file_shared* rtems_rfs_file_get_shared (rtems_rfs_file_system* fs,
                                                  rtems_rfs_ino          ino);


#endif