src/dumm/cowfs.h

   1 /*
   2  * Copyright (C) 2007 Martin Willi
   3  * Hochschule fuer Technik Rapperswil
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; either version 2 of the License, or (at your
   8  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * for more details.
  14  */
  15
  16 #ifndef COWFS_H
  17 #define COWFS_H
  18
  19 #include <library.h>
  20
  21 typedef struct cowfs_t cowfs_t;
  22
  23 /**
  24  * @brief cowfs - Copy on write FUSE filesystem.
  25  *
  26  */
  27 struct cowfs_t {
  28
  29         /**
  30          * @brief Set an additional copy on write overlay.
  31          *
  32          * @param path          path of the overlay
  33          * @return                      FALSE if failed
  34          */
  35         bool (*set_overlay)(cowfs_t *this, char *path);
  36
  37         /**
  38          * @brief Stop, umount and destroy a cowfs FUSE filesystem.
  39          */
  40         void (*destroy) (cowfs_t *this);
  41 };
  42
  43 /**
  44  * @brief Mount a cowfs FUSE filesystem.
  45  *
  46  * @param master                read only master file system directory
  47  * @param host                  copy on write host directory
  48  * @param mount                 mountpoint where union is mounted
  49  * @return                              instance, or NULL if FUSE initalization failed
  50  */
  51 cowfs_t *cowfs_create(char *master, char *host, char *mount);
  52
  53 #endif /* COWFS_H */
  54