bluesky.h

   1 /* Blue Sky: File Systems in the Cloud
   2  *
   3  * Copyright (C) 2009  The Regents of the University of California
   4  * Written by Michael Vrable <mvrable@cs.ucsd.edu>
   5  *
   6  * TODO: Licensing
   7  */
   8
   9 #ifndef _BLUESKY_H
  10 #define _BLUESKY_H
  11
  12 #include <stdint.h>
  13 #include <glib.h>
  14
  15 /* File types.  The numeric values are chosen to match with those used in
  16  * NFSv3. */
  17 typedef enum {
  18     BLUESKY_REGULAR = 1,
  19     BLUESKY_DIRECTORY = 2,
  20     BLUESKY_BLOCK = 3,
  21     BLUESKY_CHARACTER = 4,
  22     BLUESKY_SYMLINK = 5,
  23     BLUESKY_SOCKET = 6,
  24     BLUESKY_FIFO = 7,
  25 } BlueSkyFileType;
  26
  27 /* Filesystem state.  Each filesystem which is exported is represented by a
  28  * single bluesky_fs structure in memory. */
  29 typedef struct {
  30     GMutex *lock;
  31
  32     gchar *name;                /* Descriptive name for the filesystem */
  33     GHashTable *inodes;         /* Cached inodes */
  34     uint64_t next_inum;         /* Next available inode for allocation */
  35 } BlueSkyFS;
  36
  37 /* Inode number of the root directory. */
  38 #define BLUESKY_ROOT_INUM 1
  39
  40 /* Timestamp, measured in microseconds since the Unix epoch. */
  41 typedef int64_t bluesky_time;
  42
  43 /* In-memory representation of an inode within a Blue Sky server.  This
  44  * corresponds roughly with information that is committed to persistent
  45  * storage. */
  46 typedef struct {
  47     gint refcnt;                /* May be accessed atomically without lock */
  48     GMutex *lock;
  49
  50     BlueSkyFileType type;
  51     uint32_t mode;
  52     uint32_t uid, gid;
  53     uint32_t nlink;
  54
  55     /* Rather than track an inode number and generation number, we will simply
  56      * never re-use a fileid after a file is deleted.  64 bits should be enough
  57      * that we don't exhaust the identifier space. */
  58     uint64_t inum;
  59
  60     uint64_t change_count;      /* Incremented each with each change made */
  61     int64_t atime;              /* Microseconds since the Unix epoch */
  62     int64_t ctime;
  63     int64_t mtime;
  64     int64_t ntime;              /* "new time": time object was created */
  65
  66     /* File-specific fields */
  67     uint64_t size;
  68     GArray *blocks;
  69
  70     /* Directory-specific fields */
  71     GSequence *dirents;
  72     uint64_t parent_inum;       /* inode for ".."; 0 if the root directory */
  73 } BlueSkyInode;
  74
  75 /* A directory entry.  The name is UTF-8 and is a freshly-allocated string.
  76  * The name is hashed to a 64-bit value, and the directory entries are sorted
  77  * by hash value (the hash value can then be used as a cookie for resuming a
  78  * READDIR call). */
  79 typedef struct {
  80     gchar *name;
  81     uint64_t hash;
  82     uint64_t inum;
  83 } BlueSkyDirent;
  84
  85 /* File data is divided into fixed-size blocks (except the last block which may
  86  * be short?).  These blocks are backed by storage in a key/value store, but
  87  * may also be dirty if modifications have been made in-memory that have not
  88  * been committed. */
  89 #define BLUESKY_BLOCK_SIZE 32768ULL
  90 #define BLUESKY_MAX_FILE_SIZE (BLUESKY_BLOCK_SIZE << 24)
  91 typedef enum {
  92     BLUESKY_BLOCK_ZERO = 0,     /* Data is all zeroes, not explicitly stored */
  93     BLUESKY_BLOCK_REF = 1,      /* Reference to key/value store, not cached */
  94     BLUESKY_BLOCK_CACHED = 2,   /* Data is cached in memory, clean */
  95     BLUESKY_BLOCK_DIRTY = 3,    /* Data needs to be committed to store */
  96 } BlueSkyBlockType;
  97
  98 typedef struct {
  99     BlueSkyBlockType type;
 100     gchar *ref;                 /* Name of data block in the backing store */
 101     gchar *data;                /* Pointer to data in memory */
 102 } BlueSkyBlock;
 103
 104 BlueSkyFS *bluesky_new_fs(gchar *name);
 105 int64_t bluesky_get_current_time();
 106 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs);
 107 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFileType type);
 108
 109 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum);
 110 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode);
 111
 112 void bluesky_dirent_destroy(gpointer dirent);
 113 uint64_t bluesky_directory_hash(gchar *name);
 114 uint64_t bluesky_directory_lookup(BlueSkyInode *inode, gchar *name);
 115 gboolean bluesky_directory_insert(BlueSkyInode *dir, gchar *name,
 116                                   uint64_t inum);
 117 void bluesky_directory_dump(BlueSkyInode *dir);
 118
 119 void bluesky_file_truncate(BlueSkyInode *inode, uint64_t size);
 120
 121 #endif