source: rtems/c/src/lib/libc/imfs.h @ 657e1bf6

4.104.114.84.95
Last change on this file since 657e1bf6 was 657e1bf6, checked in by Joel Sherrill <joel.sherrill@…>, on Oct 26, 1999 at 8:17:13 PM

Added initial cut at miniIMFS which leaves out memfile and directory
readdir support. The next step is to add a mount table and configure
either the miniIMFS or the full IMFS at the application level.

  • Property mode set to 100644
File size: 13.1 KB
Line 
1/*
2 *  Header file for the In-Memory File System
3 *
4 *  COPYRIGHT (c) 1989-1998.
5 *  On-Line Applications Research Corporation (OAR).
6 *  Copyright assigned to U.S. Government, 1994.
7 *
8 *  The license and distribution terms for this file may be
9 *  found in the file LICENSE in this distribution or at
10 *  http://www.OARcorp.com/rtems/license.html.
11 *
12 *  $Id$
13 */
14
15#ifndef __IMFS_h
16#define __IMFS_h
17
18#ifdef __cplusplus
19extern "C" {
20#endif
21
22#include <rtems.h>
23#include <chain.h>
24
25#include <sys/types.h>
26#include <limits.h>
27#include <rtems/libio.h>
28
29/*
30 *  File name macros
31 */
32
33#define IMFS_is_valid_name_char( _ch ) ( 1 )
34
35#define IMFS_is_separator( _ch ) \
36   rtems_filesystem_is_separator( _ch )
37
38/*
39 *  Data types
40 */
41
42struct IMFS_jnode_tt;
43typedef struct IMFS_jnode_tt IMFS_jnode_t;
44
45typedef struct {
46  Chain_Control                          Entries;
47  rtems_filesystem_mount_table_entry_t  *mt_fs;
48}  IMFS_directory_t;
49
50typedef struct {
51  rtems_device_major_number  major;
52  rtems_device_minor_number  minor;
53}  IMFS_device_t;
54
55typedef struct {
56  IMFS_jnode_t  *link_node;
57} IMFS_link_t;
58
59typedef struct {
60  const char *name;
61} IMFS_sym_link_t;
62
63/*
64 *  IMFS "memfile" information
65 *
66 *  The data structure for the in-memory "memfiles" is based on classic UNIX.
67 *
68 *  block_ptr is a pointer to a block of IMFS_MEMFILE_BYTES_PER_BLOCK in
69 *  length which could be data or a table of pointers to blocks.
70 */
71
72#define IMFS_MEMFILE_BYTES_PER_BLOCK     64 /* 512 */
73#define IMFS_MEMFILE_BLOCK_SLOTS \
74  (IMFS_MEMFILE_BYTES_PER_BLOCK / sizeof(void *))
75
76typedef unsigned char * block_p;
77typedef block_p *block_ptr;
78
79typedef struct {
80  off_t      size;             /* size of file in bytes */
81  block_ptr  indirect;         /* array of 128 data blocks pointers */
82  block_ptr  doubly_indirect;  /* 128 indirect blocks */
83  block_ptr  triply_indirect;  /* 128 doubly indirect blocks */
84} IMFS_memfile_t;
85
86/*
87 *  Important block numbers for "memfiles"
88 */
89
90#define FIRST_INDIRECT           (0)
91#define LAST_INDIRECT            (IMFS_MEMFILE_BLOCK_SLOTS - 1)
92
93#define FIRST_DOUBLY_INDIRECT    (LAST_INDIRECT + 1)
94#define LAST_DOUBLY_INDIRECT     \
95   (LAST_INDIRECT + \
96     (IMFS_MEMFILE_BLOCK_SLOTS * IMFS_MEMFILE_BLOCK_SLOTS))
97
98#define FIRST_TRIPLY_INDIRECT    (LAST_DOUBLY_INDIRECT + 1)
99#define LAST_TRIPLY_INDIRECT \
100   (LAST_DOUBLY_INDIRECT +\
101     (IMFS_MEMFILE_BLOCK_SLOTS * \
102        IMFS_MEMFILE_BLOCK_SLOTS * IMFS_MEMFILE_BLOCK_SLOTS))
103
104#define IMFS_MEMFILE_MAXIMUM_SIZE \
105  (LAST_TRIPLY_INDIRECT * IMFS_MEMFILE_BYTES_PER_BLOCK)
106
107/*
108 *  What types of IMFS file systems entities there can be.
109 */
110
111#define IMFS_jnode_types_t rtems_filesystem_node_types_t
112#define IMFS_DIRECTORY     RTEMS_FILESYSTEM_DIRECTORY
113#define IMFS_DEVICE        RTEMS_FILESYSTEM_DEVICE
114#define IMFS_HARD_LINK     RTEMS_FILESYSTEM_HARD_LINK
115#define IMFS_SYM_LINK      RTEMS_FILESYSTEM_SYM_LINK
116#define IMFS_MEMORY_FILE   RTEMS_FILESYSTEM_MEMORY_FILE
117
118#define IMFS_NUMBER_OF_TYPES  (IMFS_MEMORY_FILE + 1)
119
120typedef union {
121  IMFS_directory_t   directory;
122  IMFS_device_t      device;
123  IMFS_link_t        hard_link;
124  IMFS_sym_link_t    sym_link;   
125  IMFS_memfile_t     file;   
126} IMFS_types_union;
127
128/*
129 *  Maximum length of a "basename" of an IMFS file/node.
130 */
131
132#define IMFS_NAME_MAX  32
133
134/*
135 *  The control structure for an IMFS jnode.
136 */
137
138struct IMFS_jnode_tt {
139  Chain_Node          Node;                  /* for chaining them together */
140  IMFS_jnode_t       *Parent;                /* Parent node */
141  char                name[IMFS_NAME_MAX+1]; /* "basename" */ 
142  mode_t              st_mode;               /* File mode */
143  nlink_t             st_nlink;              /* Link count */
144  ino_t               st_ino;                /* inode */
145
146  uid_t               st_uid;                /* User ID of owner */
147  gid_t               st_gid;                /* Group ID of owner */
148
149  time_t              st_atime;              /* Time of last access */
150  time_t              st_mtime;              /* Time of last modification */
151  time_t              st_ctime;              /* Time of last status change */
152  IMFS_jnode_types_t  type;                  /* Type of this entry */
153  IMFS_types_union    info;
154};
155
156#define IMFS_update_atime( _jnode )         \
157  do {                                      \
158    struct timeval tv;                      \
159    gettimeofday( &tv, 0 );                 \
160    _jnode->st_atime  = (time_t) tv.tv_sec; \
161  } while (0)
162               
163#define IMFS_update_mtime( _jnode )         \
164  do {                                      \
165    struct timeval tv;                      \
166    gettimeofday( &tv, 0 );                 \
167    _jnode->st_mtime  = (time_t) tv.tv_sec; \
168  } while (0)
169               
170#define IMFS_update_ctime( _jnode )         \
171  do {                                      \
172    struct timeval tv;                      \
173    gettimeofday( &tv, 0 );                 \
174    _jnode->st_ctime  = (time_t) tv.tv_sec; \
175  } while (0)
176
177#define IMFS_atime_mtime_update( _jnode )   \
178  do {                                      \
179    struct timeval tv;                      \
180    gettimeofday( &tv, 0 );                 \
181    _jnode->st_mtime  = (time_t) tv.tv_sec; \
182    _jnode->st_atime  = (time_t) tv.tv_sec; \
183  } while (0)
184
185typedef struct {
186  ino_t                             ino_count;
187  rtems_filesystem_file_handlers_r *memfile_handlers;
188  rtems_filesystem_file_handlers_r *directory_handlers;
189} IMFS_fs_info_t;
190
191#define increment_and_check_linkcounts( _fs_info )                  \
192  ((IMFS_fs_info_t * )_fs_info)->link_counts++;                     \
193  if ( ((IMFS_fs_info_t * )_fs_info)->link_counts  > MAXSYMLINKS )  \
194    set_errno_and_return_minus_one( ELOOP )
195
196#define decrement_linkcounts(  _fs_info )             \
197  ((IMFS_fs_info_t * )_fs_info)->link_counts--;       
198
199/*
200 *  Type defination for tokens returned from IMFS_get_token
201 */
202
203typedef enum {
204  IMFS_NO_MORE_PATH,
205  IMFS_CURRENT_DIR,
206  IMFS_UP_DIR,
207  IMFS_NAME,
208  IMFS_INVALID_TOKEN
209} IMFS_token_types;
210
211/*
212 *  Shared Data
213 */
214
215extern rtems_filesystem_file_handlers_r       IMFS_device_handlers;
216extern rtems_filesystem_file_handlers_r       IMFS_memfile_handlers;
217extern rtems_filesystem_file_handlers_r       IMFS_directory_handlers;
218extern rtems_filesystem_operations_table      IMFS_ops;
219extern rtems_filesystem_operations_table      miniIMFS_ops;
220extern rtems_filesystem_limits_and_options_t  IMFS_LIMITS_AND_OPTIONS; 
221
222/*
223 *  Routines
224 */
225
226int IMFS_initialize( 
227   rtems_filesystem_mount_table_entry_t *mt_entry
228);
229
230int miniIMFS_initialize( 
231   rtems_filesystem_mount_table_entry_t *mt_entry
232);
233
234int IMFS_initialize_support( 
235   rtems_filesystem_mount_table_entry_t *mt_entry,
236   rtems_filesystem_operations_table    *op_table,
237   rtems_filesystem_file_handlers_r     *memfile_handlers,
238   rtems_filesystem_file_handlers_r     *directory_handlers
239);
240
241int IMFS_fsunmount(
242   rtems_filesystem_mount_table_entry_t *mt_entry
243);
244
245
246/*
247 * Returns the number of characters copied from path to token.
248 */
249IMFS_token_types IMFS_get_token(
250  const char       *path,
251  char             *token,
252  int              *token_len
253);
254
255void IMFS_dump( void );
256
257void IMFS_initialize_jnode(
258  IMFS_jnode_t        *the_jnode,
259  IMFS_jnode_types_t   type,
260  IMFS_jnode_t        *the_parent,
261  char                *name,
262  mode_t               mode
263);
264
265IMFS_jnode_t *IMFS_find_match_in_dir(
266  IMFS_jnode_t *directory,                         /* IN */
267  char         *name                               /* IN */
268);
269
270rtems_filesystem_node_types_t IMFS_node_type(
271  rtems_filesystem_location_info_t    *pathloc     /* IN */
272);
273
274int IMFS_stat(
275  rtems_filesystem_location_info_t *loc,           /* IN  */
276  struct stat                      *buf            /* OUT */
277);
278
279int IMFS_evaluate_link(
280  rtems_filesystem_location_info_t *node,        /* IN/OUT */
281  int                               flags        /* IN     */
282);
283
284int IMFS_eval_path( 
285  const char                        *pathname,     /* IN     */
286  int                               flags,         /* IN     */
287  rtems_filesystem_location_info_t  *pathloc       /* IN/OUT */
288);
289
290
291int IMFS_link(
292  rtems_filesystem_location_info_t  *to_loc,      /* IN */
293  rtems_filesystem_location_info_t  *parent_loc,  /* IN */
294  const char                        *token        /* IN */
295);
296
297int IMFS_unlink(
298  rtems_filesystem_location_info_t  *pathloc       /* IN */
299);
300
301int IMFS_chown(
302  rtems_filesystem_location_info_t  *pathloc,      /* IN */
303  uid_t                              owner,        /* IN */
304  gid_t                              group         /* IN */
305);
306
307int IMFS_freenodinfo(
308  rtems_filesystem_location_info_t  *pathloc       /* IN */
309);
310
311int IMFS_rmnod(
312  rtems_filesystem_location_info_t  *pathloc       /* IN */
313);
314
315int IMFS_mknod(
316  const char                        *path,         /* IN */
317  mode_t                             mode,         /* IN */
318  dev_t                              dev,          /* IN */
319  rtems_filesystem_location_info_t  *pathloc       /* IN/OUT */
320);
321
322IMFS_jnode_t *IMFS_create_node(
323  rtems_filesystem_location_info_t  *parent_loc,   /* IN  */
324  IMFS_jnode_types_t                 type,         /* IN  */
325  char                              *name,         /* IN  */
326  mode_t                             mode,         /* IN  */
327  IMFS_types_union                  *info          /* IN  */
328);
329
330int IMFS_evaluate_for_make(
331  const char                         *path,        /* IN     */
332  rtems_filesystem_location_info_t   *pathloc,     /* IN/OUT */
333  const char                        **name         /* OUT    */
334);
335
336int IMFS_mount(
337  rtems_filesystem_mount_table_entry_t *mt_entry  /* IN */
338);
339
340int IMFS_unmount(
341  rtems_filesystem_mount_table_entry_t *mt_entry  /* IN */
342);
343
344int IMFS_freenod(
345  rtems_filesystem_location_info_t  *node         /* IN/OUT */
346);
347
348int IMFS_memfile_remove(
349 IMFS_jnode_t  *the_jnode         /* IN/OUT */
350);
351
352int memfile_ftruncate(
353  rtems_libio_t *iop,               /* IN  */
354  off_t          length             /* IN  */
355);
356int imfs_dir_open(
357  rtems_libio_t *iop,             /* IN  */
358  const char    *pathname,        /* IN  */
359  unsigned32     flag,            /* IN  */
360  unsigned32     mode             /* IN  */
361);
362int imfs_dir_close(
363  rtems_libio_t *iop             /* IN  */
364);
365int imfs_dir_read(
366  rtems_libio_t *iop,              /* IN  */
367  void          *buffer,           /* IN  */
368  unsigned32     count             /* IN  */
369);
370int imfs_dir_lseek(
371  rtems_libio_t        *iop,              /* IN  */
372  off_t                 offset,           /* IN  */
373  int                   whence            /* IN  */
374);
375int imfs_dir_fstat(
376  rtems_filesystem_location_info_t *loc,         /* IN  */
377  struct stat                      *buf          /* OUT */
378);
379int memfile_open(
380  rtems_libio_t *iop,             /* IN  */
381  const char    *pathname,        /* IN  */
382  unsigned32     flag,            /* IN  */
383  unsigned32     mode             /* IN  */
384);
385int memfile_close(
386  rtems_libio_t *iop             /* IN  */
387);
388int memfile_read(
389  rtems_libio_t *iop,             /* IN  */
390  void          *buffer,          /* IN  */
391  unsigned32     count            /* IN  */
392);
393int memfile_write(
394  rtems_libio_t *iop,             /* IN  */
395  const void    *buffer,          /* IN  */
396  unsigned32     count            /* IN  */
397);
398int memfile_ioctl(
399  rtems_libio_t *iop,             /* IN  */
400  unsigned32     command,         /* IN  */
401  void          *buffer           /* IN  */
402);
403int memfile_lseek(
404  rtems_libio_t        *iop,        /* IN  */
405  off_t                 offset,     /* IN  */
406  int                   whence      /* IN  */
407);
408int device_open(
409  rtems_libio_t *iop,            /* IN  */
410  const char    *pathname,       /* IN  */
411  unsigned32     flag,           /* IN  */
412  unsigned32     mode            /* IN  */
413);
414int device_close(
415  rtems_libio_t *iop             /* IN  */
416);
417int device_read(
418  rtems_libio_t *iop,            /* IN  */
419  void          *buffer,         /* IN  */
420  unsigned32     count           /* IN  */
421);
422int device_write(
423  rtems_libio_t *iop,               /* IN  */
424  const void    *buffer,            /* IN  */
425  unsigned32     count              /* IN  */
426);
427int device_ioctl(
428  rtems_libio_t *iop,               /* IN  */
429  unsigned32     command,           /* IN  */
430  void          *buffer             /* IN  */
431);
432int device_lseek(
433  rtems_libio_t *iop,               /* IN  */
434  off_t          offset,            /* IN  */
435  int            whence             /* IN  */
436);
437int IMFS_utime(
438  rtems_filesystem_location_info_t  *pathloc,       /* IN */
439  time_t                             actime,        /* IN */
440  time_t                             modtime        /* IN */
441);
442int IMFS_fchmod(
443  rtems_filesystem_location_info_t *loc,
444  mode_t                            mode
445);
446
447int IMFS_symlink(
448  rtems_filesystem_location_info_t  *parent_loc,  /* IN */
449  const char                        *link_name,
450  const char                        *node_name
451);
452
453int IMFS_readlink(
454 rtems_filesystem_location_info_t   *loc,         /* IN */
455 char                               *buf,         /* OUT */
456 size_t                             bufsize   
457);
458
459int IMFS_fdatasync(
460  rtems_libio_t *iop
461);
462
463int IMFS_fcntl(
464  int            cmd,
465  rtems_libio_t *iop
466);
467
468#ifdef __cplusplus
469}
470#endif
471
472#endif
473/* end of include file */
Note: See TracBrowser for help on using the repository browser.