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
  69     /* Directory-specific fields */
  70     GSequence *dirents;
  71     uint64_t parent_inum;       /* inode for ".."; 0 if the root directory */
  72 } BlueSkyInode;
  73
  74 /* A directory entry.  The name is UTF-8 and is a freshly-allocated string.
  75  * The name is hashed to a 64-bit value, and the directory entries are sorted
  76  * by hash value (the hash value can then be used as a cookie for resuming a
  77  * READDIR call). */
  78 typedef struct {
  79     gchar *name;
  80     uint64_t hash;
  81     uint64_t inum;
  82 } BlueSkyDirent ;
  83
  84 int64_t bluesky_get_current_time();
  85 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs);
  86 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFileType type);
  87
  88 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum);
  89 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode);
  90
  91 void bluesky_dirent_destroy(gpointer dirent);
  92 uint64_t bluesky_directory_hash(gchar *name);
  93 uint64_t bluesky_directory_lookup(BlueSkyInode *inode, gchar *name);
  94 gboolean bluesky_directory_insert(BlueSkyInode *dir, gchar *name,
  95                                   uint64_t inum);
  96 void bluesky_directory_dump(BlueSkyInode *dir);
  97
  98 #endif