Subversion Repositories HelenOS

Rev

Rev 4609 | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2009 Martin Decky
  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 libcipc
  30.  * @{
  31.  */
  32. /** @file
  33.  */
  34.  
  35. #ifndef LIBC_IPC_VFS_H_
  36. #define LIBC_IPC_VFS_H_
  37.  
  38. #include <sys/types.h>
  39. #include <ipc/ipc.h>
  40.  
  41. #define FS_NAME_MAXLEN  20
  42. #define MAX_PATH_LEN    (64 * 1024)
  43. #define PLB_SIZE        (2 * MAX_PATH_LEN)
  44.  
  45. /* Basic types. */
  46. typedef int16_t fs_handle_t;
  47. typedef uint32_t fs_index_t;
  48.  
  49. /**
  50.  * A structure like this is passed to VFS by each individual FS upon its
  51.  * registration. It assosiates a human-readable identifier with each
  52.  * registered FS.
  53.  */
  54. typedef struct {
  55.     /** Unique identifier of the fs. */
  56.     char name[FS_NAME_MAXLEN + 1];
  57. } vfs_info_t;
  58.  
  59. typedef enum {
  60.     VFS_IN_OPEN = IPC_FIRST_USER_METHOD,
  61.     VFS_IN_OPEN_NODE,
  62.     VFS_IN_READ,
  63.     VFS_IN_WRITE,
  64.     VFS_IN_SEEK,
  65.     VFS_IN_TRUNCATE,
  66.     VFS_IN_FSTAT,
  67.     VFS_IN_CLOSE,
  68.     VFS_IN_MOUNT,
  69.     VFS_IN_UNMOUNT,
  70.     VFS_IN_SYNC,
  71.     VFS_IN_REGISTER,
  72.     VFS_IN_MKDIR,
  73.     VFS_IN_UNLINK,
  74.     VFS_IN_RENAME,
  75.     VFS_IN_STAT
  76. } vfs_in_request_t;
  77.  
  78. typedef enum {
  79.     VFS_OUT_OPEN_NODE = IPC_FIRST_USER_METHOD,
  80.     VFS_OUT_READ,
  81.     VFS_OUT_WRITE,
  82.     VFS_OUT_TRUNCATE,
  83.     VFS_OUT_CLOSE,
  84.     VFS_OUT_MOUNT,
  85.     VFS_OUT_MOUNTED,
  86.     VFS_OUT_UNMOUNT,
  87.     VFS_OUT_SYNC,
  88.     VFS_OUT_STAT,
  89.     VFS_OUT_LOOKUP,
  90.     VFS_OUT_DESTROY,
  91.     VFS_OUT_LAST
  92. } vfs_out_request_t;
  93.  
  94. /*
  95.  * Lookup flags.
  96.  */
  97.  
  98. /**
  99.  * No lookup flags used.
  100.  */
  101. #define L_NONE  0
  102.  
  103. /**
  104.  * Lookup will succeed only if the object is a regular file.  If L_CREATE is
  105.  * specified, an empty file will be created. This flag is mutually exclusive
  106.  * with L_DIRECTORY.
  107.  */
  108. #define L_FILE  1
  109.  
  110. /**
  111.  * Lookup wil succeed only if the object is a directory. If L_CREATE is
  112.  * specified, an empty directory will be created. This flag is mutually
  113.  * exclusive with L_FILE.
  114.  */
  115. #define L_DIRECTORY  2
  116.  
  117. /**
  118.  * When used with L_CREATE, L_EXCLUSIVE will cause the lookup to fail if the
  119.  * object already exists. L_EXCLUSIVE is implied when L_DIRECTORY is used.
  120.  */
  121. #define L_EXCLUSIVE  4
  122.  
  123. /**
  124.  * L_CREATE is used for creating both regular files and directories.
  125.  */
  126. #define L_CREATE  8
  127.  
  128. /**
  129.  * L_LINK is used for linking to an already existing nodes.
  130.  */
  131. #define L_LINK  16
  132.  
  133. /**
  134.  * L_UNLINK is used to remove leaves from the file system namespace. This flag
  135.  * cannot be passed directly by the client, but will be set by VFS during
  136.  * VFS_UNLINK.
  137.  */
  138. #define L_UNLINK  32
  139.  
  140. /**
  141.  * L_OPEN is used to indicate that the lookup operation is a part of VFS_OPEN
  142.  * call from the client. This means that the server might allocate some
  143.  * resources for the opened file. This flag cannot be passed directly by the
  144.  * client.
  145.  */
  146. #define L_OPEN  64
  147.  
  148. #endif
  149.  
  150. /** @}
  151.  */
  152.