l4/pkg/l4re_vfs/include/backend

   1 // vi:ft=cpp
   2 /*
   3  * (c) 2010 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
   4  *          Alexander Warg <warg@os.inf.tu-dresden.de>
   5  *     economic rights: Technische Universität Dresden (Germany)
   6  *
   7  * This file is part of TUD:OS and distributed under the terms of the
   8  * GNU General Public License 2.
   9  * Please see the COPYING-GPL-2 file for details.
  10  *
  11  * As a special exception, you may use this file as part of a free software
  12  * library without restriction.  Specifically, if other files instantiate
  13  * templates or use macros or inline functions from this file, or you compile
  14  * this file and link it with other files to produce an executable, this
  15  * file does not by itself cause the resulting executable to be covered by
  16  * the GNU General Public License.  This exception does not however
  17  * invalidate any other reasons why the executable file might be covered by
  18  * the GNU General Public License.
  19  */
  20 #pragma once
  21
  22 #include <l4/l4re_vfs/vfs.h>
  23 #include <l4/crtn/initpriorities.h>
  24
  25 namespace L4Re { namespace Vfs {
  26
  27 /// Reference to the applications L4Re::Vfs::Ops singleton.
  28 extern L4Re::Vfs::Ops *vfs_ops asm ("l4re_env_posix_vfs_ops");
  29
  30 class Mount_tree;
  31
  32 /**
  33  * \brief Boiler plate class for implementing an open file for L4Re::Vfs.
  34  *
  35  * This class may be used as a base class for everything that a POSIX
  36  * file descriptor may point to.  This are things such as regular files,
  37  * directories, special device files, streams, pipes, and so on.
  38  */
  39 class Be_file : public File
  40 {
  41 public:
  42   // used in close, to unlock all locks of a file (as POSIX says)
  43   int unlock_all_locks() throw()
  44   { return 0; }
  45
  46   // for mmap
  47   L4::Cap<L4Re::Dataspace> data_space() const throw()
  48   { return L4::Cap<L4Re::Dataspace>::Invalid; }
  49
  50   /// Default backend for POSIX read and readv functions.
  51   ssize_t readv(const struct iovec*, int) throw()
  52   { return -EINVAL; }
  53
  54   /// Default backend for POSIX write and writev functions.
  55   ssize_t writev(const struct iovec*, int) throw()
  56   { return -EINVAL; }
  57
  58   /// Default backend for POSIX pwrite and pwritev functions.
  59   ssize_t pwritev(const struct iovec*, int, off64_t) throw()
  60   { return -EINVAL; }
  61
  62   /// Default backend for POSIX pread and preadv functions.
  63   ssize_t preadv(const struct iovec*, int, off64_t) throw()
  64   { return -EINVAL; }
  65
  66   /// Default backend for POSIX seek and lseek functions.
  67   off64_t lseek64(off64_t, int) throw()
  68   { return -ESPIPE; }
  69
  70   /// Default backend for the POSIX truncate, ftruncate and similar functions.
  71   int ftruncate64(off64_t) throw()
  72   { return -EINVAL; }
  73
  74   /// Default backend for POSIX fsync.
  75   int fsync() const throw()
  76   { return -EINVAL; }
  77
  78   /// Default backend for POSIX fdatasync.
  79   int fdatasync() const throw()
  80   { return -EINVAL; }
  81
  82   /// Default backend for POSIX ioctl.
  83   int ioctl(unsigned long, va_list) throw()
  84   { return -EINVAL; }
  85
  86   int fstat64(struct stat64 *) const throw()
  87   { return -EINVAL; }
  88
  89   /// Default backend for POSIX chmod and fchmod.
  90   int fchmod(mode_t) throw()
  91   { return -EINVAL; }
  92
  93   /// Default backend for POSIX fcntl subfunctions.
  94   int get_status_flags() const throw()
  95   { return 0; }
  96
  97   /// Default backend for POSIX fcntl subfunctions.
  98   int set_status_flags(long) throw()
  99   { return 0; }
 100
 101   /// Default backend for POSIX fcntl subfunctions.
 102   int get_lock(struct flock64 *) throw()
 103   { return -ENOLCK; }
 104
 105   /// Default backend for POSIX fcntl subfunctions.
 106   int set_lock(struct flock64 *, bool) throw()
 107   { return -ENOLCK; }
 108
 109   /// Default backend for POSIX access and faccessat functions.
 110   int faccessat(const char *, int, int) throw()
 111   { return -ENOTDIR; }
 112
 113   /// Default backend for POSIX utime.
 114   int utime(const struct utimbuf *) throw()
 115   { return -EROFS; }
 116
 117   /// Default backend for POSIX utimes.
 118   int utimes(const struct utimbuf [2]) throw()
 119   { return -EROFS; }
 120
 121   /// Default backend for POSIX mkdir and mkdirat.
 122   int mkdir(const char *, mode_t) throw()
 123   { return -ENOTDIR; }
 124
 125   /// Default backend for POSIX unlink, unlinkat.
 126   int unlink(const char *) throw()
 127   { return -ENOTDIR; }
 128
 129   /// Default backend for POSIX rename, renameat.
 130   int rename(const char *, const char *) throw()
 131   { return -ENOTDIR; }
 132
 133   /// Default backend for POSIX link, linkat.
 134   int link(const char *, const char *) throw()
 135   { return -ENOTDIR; }
 136
 137   /// Default backend for POSIX symlink, symlinkat.
 138   int symlink(const char *, const char *) throw()
 139   { return -EPERM; }
 140
 141   /// Default backend for POSIX rmdir, rmdirat.
 142   int rmdir(const char *) throw()
 143   { return -ENOTDIR; }
 144
 145   /// Default backend for POSIX readlink, readlinkat.
 146   ssize_t readlink(char *, size_t)
 147   { return -EINVAL; }
 148
 149   ssize_t getdents(char *, size_t) throw()
 150   { return -ENOTDIR; }
 151
 152   ~Be_file() throw() = 0;
 153
 154 private:
 155   /// Default backend for POSIX openat, open.
 156   int get_entry(const char *, int, mode_t, cxx::Ref_ptr<File> *) throw()
 157   { return -ENOTDIR; }
 158
 159 protected:
 160   const char *get_mount(const char *path, cxx::Ref_ptr<File> *dir) throw();
 161 };
 162
 163 inline
 164 Be_file::~Be_file() throw() {}
 165
 166 class Be_file_pos : public Be_file
 167 {
 168 public:
 169   Be_file_pos() throw() : Be_file(), _pos(0) {}
 170
 171   virtual off64_t size() const throw() = 0;
 172
 173   ssize_t readv(const struct iovec *v, int iovcnt) throw()
 174   {
 175     ssize_t r = preadv(v, iovcnt, _pos);
 176     if (r > 0)
 177       _pos += r;
 178     return r;
 179   }
 180
 181   ssize_t writev(const struct iovec *v, int iovcnt) throw()
 182   {
 183     ssize_t r = pwritev(v, iovcnt, _pos);
 184     if (r > 0)
 185       _pos += r;
 186     return r;
 187   }
 188
 189   ssize_t preadv(const struct iovec *v, int iovcnt, off64_t offset) throw() = 0;
 190   ssize_t pwritev(const struct iovec *v, int iovcnt, off64_t offset) throw() = 0;
 191
 192   off64_t lseek64(off64_t offset, int whence) throw()
 193   {
 194     off64_t r;
 195     switch (whence)
 196       {
 197       case SEEK_SET: r = offset; break;
 198       case SEEK_CUR: r = _pos + offset; break;
 199       case SEEK_END: r = size() + offset; break;
 200       default: return -EINVAL;
 201       };
 202
 203     if (r < 0)
 204       return -EINVAL;
 205
 206     _pos = r;
 207     return _pos;
 208   }
 209
 210 protected:
 211   off64_t pos() const throw() { return _pos; }
 212
 213 private:
 214   off64_t _pos;
 215 };
 216
 217 class Be_file_stream : public Be_file
 218 {
 219 public:
 220   ssize_t preadv(const struct iovec *v, int iovcnt, off64_t) throw()
 221   { return readv(v, iovcnt); }
 222
 223   ssize_t pwritev(const struct iovec *v, int iovcnt, off64_t) throw()
 224   { return writev(v, iovcnt); }
 225
 226 };
 227
 228 /**
 229  * \brief Boilerplate class for implementing a L4Re::Vfs::File_system.
 230  *
 231  * This class already takes care of registering and unregistering the
 232  * file system in the global registry and implements the type() method.
 233  */
 234 class Be_file_system : public File_system
 235 {
 236 private:
 237   char const *const _fstype;
 238
 239 public:
 240
 241   /**
 242    * \brief Create a file-system object for the given \a fstype.
 243    * \param fstype The type that type() shall return.
 244    *
 245    * This constructor takes care of registering the file system
 246    * in the registry of L4Re::Vfs::vfs_ops.
 247    */
 248   explicit Be_file_system(char const *fstype) throw()
 249   : File_system(), _fstype(fstype)
 250   {
 251     vfs_ops->register_file_system(this);
 252   }
 253
 254   /**
 255    * \brief Destroy a file-system object.
 256    *
 257    * This destructor takes care of removing this file system
 258    * from the registry of L4Re::Vfs::vfs_ops.
 259    */
 260   ~Be_file_system() throw()
 261   {
 262     vfs_ops->unregister_file_system(this);
 263   }
 264
 265   /**
 266    * \brief Return the file-system type.
 267    *
 268    * Returns the file-system type given as \a fstype in the constructor.
 269    */
 270   char const *type() const throw() { return _fstype; }
 271 };
 272
 273 /* Make sure filesystems can register before the constructor of libmount
 274  * runs */
 275 #define L4RE_VFS_FILE_SYSTEM_ATTRIBUTE \
 276      __attribute__((init_priority(INIT_PRIO_LATE_VAL)))
 277
 278 }}