Subversion Repositories HelenOS

Rev

Rev 2707 | Rev 2731 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2008 Jakub Jermar
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  * - Redistributions of source code must retain the above copyright
  10.  *   notice, this list of conditions and the following disclaimer.
  11.  * - Redistributions in binary form must reproduce the above copyright
  12.  *   notice, this list of conditions and the following disclaimer in the
  13.  *   documentation and/or other materials provided with the distribution.
  14.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. /** @addtogroup fs
  30.  * @{
  31.  */
  32.  
  33. #ifndef VFS_VFS_H_
  34. #define VFS_VFS_H_
  35.  
  36. #include <ipc/ipc.h>
  37. #include <libadt/list.h>
  38. #include <atomic.h>
  39. #include <rwlock.h>
  40. #include <sys/types.h>
  41. #include <bool.h>
  42.  
  43. #define dprintf(...)    printf(__VA_ARGS__)
  44.  
  45. #define VFS_FIRST   IPC_FIRST_USER_METHOD
  46.  
  47. #define IPC_METHOD_TO_VFS_OP(m) ((m) - VFS_FIRST)  
  48.  
  49. typedef enum {
  50.     VFS_OPEN = VFS_FIRST,
  51.     VFS_CLOSE,
  52.     VFS_READ,
  53.     VFS_WRITE,
  54.     VFS_TRUNCATE,
  55.     VFS_RENAME,
  56.     VFS_OPENDIR,
  57.     VFS_READDIR,
  58.     VFS_CLOSEDIR,
  59.     VFS_MKDIR,
  60.     VFS_UNLINK,
  61.     VFS_MOUNT,
  62.     VFS_UNMOUNT,
  63.     VFS_LAST_CMN,   /* keep this the last member of this enum */
  64. } vfs_request_cmn_t;
  65.  
  66. typedef enum {
  67.     VFS_LOOKUP = VFS_LAST_CMN,
  68.     VFS_LAST_CLNT,  /* keep this the last member of this enum */
  69. } vfs_request_clnt_t;
  70.  
  71. typedef enum {
  72.     VFS_REGISTER = VFS_LAST_CMN,
  73.     VFS_SEEK,
  74.     VFS_LAST_SRV,   /* keep this the last member of this enum */
  75. } vfs_request_srv_t;
  76.  
  77.  
  78. /**
  79.  * An instance of this structure is associated with a particular FS operation.
  80.  * It tells VFS if the FS supports the operation or maybe if a default one
  81.  * should be used.
  82.  */
  83. typedef enum {
  84.     VFS_OP_NULL = 0,
  85.     VFS_OP_DEFAULT,
  86.     VFS_OP_DEFINED
  87. } vfs_op_t;
  88.  
  89. #define FS_NAME_MAXLEN  20
  90.  
  91. /**
  92.  * A structure like this is passed to VFS by each individual FS upon its
  93.  * registration. It assosiates a human-readable identifier with each
  94.  * registered FS. More importantly, through this structure, the FS announces
  95.  * what operations it supports.
  96.  */
  97. typedef struct {
  98.     /** Unique identifier of the fs. */
  99.     char name[FS_NAME_MAXLEN + 1];
  100.    
  101.     /** Operations. */
  102.     vfs_op_t ops[VFS_LAST_CLNT - VFS_FIRST];
  103. } vfs_info_t;
  104.  
  105. /**
  106.  * A structure like this will be allocated for each registered file system.
  107.  */
  108. typedef struct {
  109.     link_t fs_link;
  110.     vfs_info_t vfs_info;
  111.     int fs_handle;
  112.     atomic_t phone_futex;   /**< Phone serializing futex. */
  113.     ipcarg_t phone;
  114. } fs_info_t;
  115.  
  116. /**
  117.  * VFS_PAIR uniquely represents a file system instance.
  118.  */
  119. #define VFS_PAIR    \
  120.     int fs_handle;  \
  121.     int dev_handle;
  122.  
  123. /**
  124.  * VFS_TRIPLET uniquely identifies a file system node (e.g. directory, file) but
  125.  * doesn't contain any state. For a stateful structure, see vfs_node_t.
  126.  *
  127.  * @note    fs_handle, dev_handle and index are meant to be returned in one
  128.  *      IPC reply.
  129.  */
  130. #define VFS_TRIPLET \
  131.     VFS_PAIR;   \
  132.     uint64_t index;
  133.  
  134. typedef struct {
  135.     VFS_PAIR;
  136. } vfs_pair_t;
  137.  
  138. typedef struct {
  139.     VFS_TRIPLET;
  140. } vfs_triplet_t;
  141.  
  142. /*
  143.  * Lookup flags.
  144.  */
  145. /**
  146.  * Lookup will succeed only if the object is a regular file.  If L_CREATE is
  147.  * specified, an empty file will be created. This flag is mutually exclusive
  148.  * with L_DIRECTORY.
  149.  */
  150. #define L_FILE      1
  151. /**
  152.  * Lookup wil succeed only if the object is a directory. If L_CREATE is
  153.  * specified, an empty directory will be created. This flag is mutually
  154.  * exclusive with L_FILE.
  155.  */
  156. #define L_DIRECTORY 2
  157. /**
  158.  * When used with L_CREATE, L_EXCLUSIVE will cause the lookup to fail if the
  159.  * object already exists. L_EXCLUSIVE is implied when L_DIRECTORY is used.
  160.  */
  161. #define L_EXCLUSIVE 4
  162. /**
  163.  * L_CREATE is used for creating both regular files and directories.
  164.  */
  165. #define L_CREATE    8
  166. /**
  167.  * L_DESTROY is used to remove leaves from the file system namespace. This flag
  168.  * cannot be passed directly by the client, but will be set by VFS during
  169.  * VFS_UNLINK.
  170.  */
  171. #define L_DESTROY   16
  172.  
  173. typedef struct {
  174.     vfs_triplet_t triplet;
  175.     size_t size;
  176. } vfs_lookup_res_t;
  177.  
  178. /**
  179.  * Instances of this type represent an active, in-memory VFS node and any state
  180.  * which may be associated with it.
  181.  */
  182. typedef struct {
  183.     VFS_TRIPLET;        /**< Identity of the node. */
  184.     unsigned refcnt;    /**< Usage counter. */
  185.     link_t nh_link;     /**< Node hash-table link. */
  186.     size_t size;        /**< Cached size of the file. */
  187.  
  188.     /**
  189.      * Holding this rwlock prevents modifications of the node's contents.
  190.      */
  191.     rwlock_t contents_rwlock;
  192. } vfs_node_t;
  193.  
  194. /**
  195.  * Instances of this type represent an open file. If the file is opened by more
  196.  * than one task, there will be a separate structure allocated for each task.
  197.  */
  198. typedef struct {
  199.     /** Serializes access to this open file. */
  200.     futex_t lock;
  201.  
  202.     vfs_node_t *node;
  203.    
  204.     /** Number of file handles referencing this file. */
  205.     unsigned refcnt;
  206.  
  207.     /** Append on write. */
  208.     bool append;
  209.  
  210.     /** Current position in the file. */
  211.     off_t pos;
  212. } vfs_file_t;
  213.  
  214. extern link_t fs_head;      /**< List of registered file systems. */
  215.  
  216. extern vfs_triplet_t rootfs;    /**< Root node of the root file system. */
  217.  
  218. #define MAX_PATH_LEN        (64 * 1024)
  219.  
  220. #define PLB_SIZE        (2 * MAX_PATH_LEN)
  221.  
  222. /** Each instance of this type describes one path lookup in progress. */
  223. typedef struct {
  224.     link_t  plb_link;   /**< Active PLB entries list link. */
  225.     unsigned index;     /**< Index of the first character in PLB. */
  226.     size_t len;     /**< Number of characters in this PLB entry. */
  227. } plb_entry_t;
  228.  
  229. extern atomic_t plb_futex;  /**< Futex protecting plb and plb_head. */
  230. extern uint8_t *plb;        /**< Path Lookup Buffer */
  231. extern link_t plb_head;     /**< List of active PLB entries. */
  232.  
  233. /** Holding this rwlock prevents changes in file system namespace. */
  234. extern rwlock_t namespace_rwlock;
  235.  
  236. extern int vfs_grab_phone(int);
  237. extern void vfs_release_phone(int);
  238.  
  239. extern int fs_name_to_handle(char *, bool);
  240.  
  241. extern int vfs_lookup_internal(char *, size_t, int, vfs_lookup_res_t *,
  242.     vfs_pair_t *);
  243.  
  244. extern bool vfs_nodes_init(void);
  245. extern vfs_node_t *vfs_node_get(vfs_lookup_res_t *);
  246. extern void vfs_node_put(vfs_node_t *);
  247.  
  248. #define MAX_OPEN_FILES  128
  249.  
  250. extern bool vfs_files_init(void);
  251. extern vfs_file_t *vfs_file_get(int);
  252. extern int vfs_fd_alloc(void);
  253. extern void vfs_fd_free(int);
  254.  
  255. extern void vfs_file_addref(vfs_file_t *);
  256. extern void vfs_file_delref(vfs_file_t *);
  257.  
  258. extern void vfs_node_addref(vfs_node_t *);
  259. extern void vfs_node_delref(vfs_node_t *);
  260.  
  261. extern void vfs_register(ipc_callid_t, ipc_call_t *);
  262. extern void vfs_mount(ipc_callid_t, ipc_call_t *);
  263. extern void vfs_open(ipc_callid_t, ipc_call_t *);
  264. extern void vfs_read(ipc_callid_t, ipc_call_t *);
  265. extern void vfs_write(ipc_callid_t, ipc_call_t *);
  266. extern void vfs_seek(ipc_callid_t, ipc_call_t *);
  267. extern void vfs_truncate(ipc_callid_t, ipc_call_t *);
  268. extern void vfs_mkdir(ipc_callid_t, ipc_call_t *);
  269.  
  270. #endif
  271.  
  272. /**
  273.  * @}
  274.  */
  275.