vfs.h

Go to the documentation of this file.

/* Copyright (c) 2013 Wildfire Games
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

/*
 * Virtual File System API - allows transparent access to files in
 * archives, modding via multiple mount points and hotloading.
 */

#ifndef INCLUDED_VFS
#define INCLUDED_VFS

#include "lib/file/file_system.h"   // CFileInfo
#include "lib/file/vfs/vfs_path.h"

namespace ERR
{
    const Status VFS_DIR_NOT_FOUND   = -110100;
    const Status VFS_FILE_NOT_FOUND  = -110101;
    const Status VFS_ALREADY_MOUNTED = -110102;
}

// (recursive mounting and mounting archives are no longer optional since they don't hurt)
enum VfsMountFlags
{
    /**
     * all real directories mounted during this operation will be watched
     * for changes. this flag is provided to avoid watches in output-only
     * directories, e.g. screenshots/ (only causes unnecessary overhead).
     **/
    VFS_MOUNT_WATCH = 1,

    /**
     * anything mounted from here should be included when building archives.
     **/
    VFS_MOUNT_ARCHIVABLE = 2,

    /**
     * return ERR::VFS_DIR_NOT_FOUND if the given real path doesn't exist.
     * (the default behavior is to create all real directories in the path)
     **/
    VFS_MOUNT_MUST_EXIST = 4,

    /**
     * keep the files named "*.DELETED" visible in the VFS directories.
     * the standard behavior of hiding the file with the same name minus the
     * ".DELETED" suffix will still apply.
     * (the default behavior is to hide both the suffixed and unsuffixed files)
     **/
    VFS_MOUNT_KEEP_DELETED = 8,

    /**
     * mark a directory replaceable, so that when writing a file to this path
     * new real directories will be created instead of reusing already existing
     * ones mounted at a subpath of the VFS path.
     * (the default behaviour is to write to the real directory associated
     * with the VFS directory that was last mounted to this path (or subpath))
     **/
    VFS_MOUNT_REPLACEABLE = 16
};

// (member functions are thread-safe after the instance has been
// constructed - each acquires a pthread mutex.)
struct IVFS
{
    virtual ~IVFS() {}

    /**
     * mount a directory into the VFS.
     *
     * @param mountPoint (will be created if it does not already exist)
     * @param path real directory path
     * @param flags
     * @param priority
     * @return Status.
     *
     * if files are encountered that already exist in the VFS (sub)directories,
     * the most recent / highest priority/precedence version is preferred.
     *
     * if files with archive extensions are seen, their contents are added
     * as well.
     **/
    virtual Status Mount(const VfsPath& mountPoint, const OsPath& path, size_t flags = 0, size_t priority = 0) = 0;

    /**
     * Retrieve information about a file (similar to POSIX stat).
     *
     * @param pathname
     * @param pfileInfo receives information about the file. Passing NULL
     *        suppresses warnings if the file doesn't exist.
     *
     * @return Status.
     **/
    virtual Status GetFileInfo(const VfsPath& pathname, CFileInfo* pfileInfo) const = 0;

    /**
     * Retrieve mount priority for a file.
     *
     * @param pathname
     * @param ppriority receives priority value, if the file can be found.
     *
     * @return Status.
     **/
    virtual Status GetFilePriority(const VfsPath& pathname, size_t* ppriority) const = 0;

    /**
     * Retrieve lists of all files and subdirectories in a directory.
     *
     * @return Status.
     *
     * Rationale:
     * - this interface avoids having to lock the directory while an
     *   iterator is extant.
     * - we cannot efficiently provide routines for returning files and
     *   subdirectories separately due to the underlying POSIX interface.
     **/
    virtual Status GetDirectoryEntries(const VfsPath& path, CFileInfos* fileInfos, DirectoryNames* subdirectoryNames) const = 0;

    /**
     * Create a file with the given contents.
     * @param pathname
     * @param fileContents
     * @param size [bytes] of the contents, will match that of the file.
     * @return Status.
     *
     * rationale: disallowing partial writes simplifies file cache coherency
     * (we need only invalidate cached data when closing a newly written file).
     **/
    virtual Status CreateFile(const VfsPath& pathname, const shared_ptr<u8>& fileContents, size_t size) = 0;

    /**
     * Replace a file with the given contents.
     *
     * @see CreateFile
     *
     * Used to replace a file if it is already present (even if the file is not
     * in the attached vfs directory). Calls CreateFile if the file doesn't yet
     * exist.
      **/
    virtual Status ReplaceFile(const VfsPath& pathname, const shared_ptr<u8>& fileContents, size_t size) = 0;

    /**
     * Read an entire file into memory.
     *
     * @param pathname
     * @param fileContents receives a smart pointer to the contents.
     *        CAVEAT: this will be taken from the file cache if the VFS was
     *        created with cacheSize != 0 and size < cacheSize. There is no
     *        provision for Copy-on-Write, which means that such buffers
     *        must not be modified (this is enforced via mprotect).
     * @param size receives the size [bytes] of the file contents.
     * @return Status.
     **/
    virtual Status LoadFile(const VfsPath& pathname, shared_ptr<u8>& fileContents, size_t& size) = 0;

    /**
     * @return a string representation of all files and directories.
     **/
    virtual std::wstring TextRepresentation() const = 0;

    /**
     * retrieve the real (POSIX) pathname underlying a VFS file.
     *
     * this is useful for passing paths to external libraries.
     **/
    virtual Status GetRealPath(const VfsPath& pathname, OsPath& realPathname) = 0;

    /**
     * retrieve the real (POSIX) pathname underlying a VFS directory.
     *
     * this is useful for passing paths to external libraries.
     **/
    virtual Status GetDirectoryRealPath(const VfsPath& pathname, OsPath& realPathname) = 0;

    /**
     * retrieve the VFS pathname that corresponds to a real file.
     *
     * this is useful for reacting to file change notifications.
     *
     * the current implementation requires time proportional to the
     * number of directories; this could be accelerated by only checking
     * directories below a mount point with a matching real path.
     **/
    virtual Status GetVirtualPath(const OsPath& realPathname, VfsPath& pathname) = 0;

    /**
     * remove file from the virtual directory listing and evict its
     * data from the cache.
     **/
    virtual Status RemoveFile(const VfsPath& pathname) = 0;

    /**
     * request the directory be re-populated when it is next accessed.
     * useful for synchronizing with the underlying filesystem after
     * files have been created or their metadata changed.
     **/
    virtual Status RepopulateDirectory(const VfsPath& path) = 0;

    /**
     * empty the contents of the filesystem.
     * this is typically only necessary when changing the set of
     * mounted directories, e.g. when switching mods.
     * NB: open files are not affected.
     **/
    virtual void Clear() = 0;
};

typedef shared_ptr<IVFS> PIVFS;

/**
 * create an instance of a Virtual File System.
 *
 * @param cacheSize size [bytes] of memory to reserve for a file cache,
 * or zero to disable it. if small enough to fit, file contents are
 * stored here until no references remain and they are evicted.
 *
 * note: there is no limitation to a single instance, it may make sense
 * to create and destroy VFS instances during each unit test.
 **/
LIB_API PIVFS CreateVfs(size_t cacheSize);

#endif  // #ifndef INCLUDED_VFS