fs/exofs/common.h

   1 /*
   2  * common.h - Common definitions for both Kernel and user-mode utilities
   3  *
   4  * Copyright (C) 2005, 2006
   5  * Avishay Traeger (avishay@gmail.com) (avishay@il.ibm.com)
   6  * Copyright (C) 2005, 2006
   7  * International Business Machines
   8  * Copyright (C) 2008, 2009
   9  * Boaz Harrosh <bharrosh@panasas.com>
  10  *
  11  * Copyrights for code taken from ext2:
  12  *     Copyright (C) 1992, 1993, 1994, 1995
  13  *     Remy Card (card@masi.ibp.fr)
  14  *     Laboratoire MASI - Institut Blaise Pascal
  15  *     Universite Pierre et Marie Curie (Paris VI)
  16  *     from
  17  *     linux/fs/minix/inode.c
  18  *     Copyright (C) 1991, 1992  Linus Torvalds
  19  *
  20  * This file is part of exofs.
  21  *
  22  * exofs is free software; you can redistribute it and/or modify
  23  * it under the terms of the GNU General Public License as published by
  24  * the Free Software Foundation.  Since it is based on ext2, and the only
  25  * valid version of GPL for the Linux kernel is version 2, the only valid
  26  * version of GPL for exofs is version 2.
  27  *
  28  * exofs is distributed in the hope that it will be useful,
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  * GNU General Public License for more details.
  32  *
  33  * You should have received a copy of the GNU General Public License
  34  * along with exofs; if not, write to the Free Software
  35  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  36  */
  37
  38 #ifndef __EXOFS_COM_H__
  39 #define __EXOFS_COM_H__
  40
  41 #include <linux/types.h>
  42
  43 #include <scsi/osd_attributes.h>
  44 #include <scsi/osd_initiator.h>
  45 #include <scsi/osd_sec.h>
  46
  47 /****************************************************************************
  48  * Object ID related defines
  49  * NOTE: inode# = object ID - EXOFS_OBJ_OFF
  50  ****************************************************************************/
  51 #define EXOFS_MIN_PID   0x10000 /* Smallest partition ID */
  52 #define EXOFS_OBJ_OFF   0x10000 /* offset for objects */
  53 #define EXOFS_SUPER_ID  0x10000 /* object ID for on-disk superblock */
  54 #define EXOFS_ROOT_ID   0x10002 /* object ID for root directory */
  55
  56 /* exofs Application specific page/attribute */
  57 # define EXOFS_APAGE_FS_DATA    (OSD_APAGE_APP_DEFINED_FIRST + 3)
  58 # define EXOFS_ATTR_INODE_DATA  1
  59
  60 /*
  61  * The maximum number of files we can have is limited by the size of the
  62  * inode number.  This is the largest object ID that the file system supports.
  63  * Object IDs 0, 1, and 2 are always in use (see above defines).
  64  */
  65 enum {
  66         EXOFS_MAX_INO_ID = (sizeof(ino_t) * 8 == 64) ? ULLONG_MAX :
  67                                         (1ULL << (sizeof(ino_t) * 8ULL - 1ULL)),
  68         EXOFS_MAX_ID     = (EXOFS_MAX_INO_ID - 1 - EXOFS_OBJ_OFF),
  69 };
  70
  71 /****************************************************************************
  72  * Misc.
  73  ****************************************************************************/
  74 #define EXOFS_BLKSHIFT  12
  75 #define EXOFS_BLKSIZE   (1UL << EXOFS_BLKSHIFT)
  76
  77 /****************************************************************************
  78  * superblock-related things
  79  ****************************************************************************/
  80 #define EXOFS_SUPER_MAGIC       0x5DF5
  81
  82 /*
  83  * The file system control block - stored in an object's data (mainly, the one
  84  * with ID EXOFS_SUPER_ID).  This is where the in-memory superblock is stored
  85  * on disk.  Right now it just has a magic value, which is basically a sanity
  86  * check on our ability to communicate with the object store.
  87  */
  88 struct exofs_fscb {
  89         __le64  s_nextid;       /* Highest object ID used */
  90         __le32  s_numfiles;     /* Number of files on fs */
  91         __le16  s_magic;        /* Magic signature */
  92         __le16  s_newfs;        /* Non-zero if this is a new fs */
  93 };
  94
  95 /****************************************************************************
  96  * inode-related things
  97  ****************************************************************************/
  98 #define EXOFS_IDATA             5
  99
 100 /*
 101  * The file control block - stored in an object's attributes.  This is where
 102  * the in-memory inode is stored on disk.
 103  */
 104 struct exofs_fcb {
 105         __le64  i_size;                 /* Size of the file */
 106         __le16  i_mode;                 /* File mode */
 107         __le16  i_links_count;          /* Links count */
 108         __le32  i_uid;                  /* Owner Uid */
 109         __le32  i_gid;                  /* Group Id */
 110         __le32  i_atime;                /* Access time */
 111         __le32  i_ctime;                /* Creation time */
 112         __le32  i_mtime;                /* Modification time */
 113         __le32  i_flags;                /* File flags (unused for now)*/
 114         __le32  i_generation;           /* File version (for NFS) */
 115         __le32  i_data[EXOFS_IDATA];    /* Short symlink names and device #s */
 116 };
 117
 118 #define EXOFS_INO_ATTR_SIZE     sizeof(struct exofs_fcb)
 119
 120 /* This is the Attribute the fcb is stored in */
 121 static const struct __weak osd_attr g_attr_inode_data = ATTR_DEF(
 122         EXOFS_APAGE_FS_DATA,
 123         EXOFS_ATTR_INODE_DATA,
 124         EXOFS_INO_ATTR_SIZE);
 125
 126 /****************************************************************************
 127  * dentry-related things
 128  ****************************************************************************/
 129 #define EXOFS_NAME_LEN  255
 130
 131 /*
 132  * The on-disk directory entry
 133  */
 134 struct exofs_dir_entry {
 135         __le64          inode_no;               /* inode number           */
 136         __le16          rec_len;                /* directory entry length */
 137         u8              name_len;               /* name length            */
 138         u8              file_type;              /* umm...file type        */
 139         char            name[EXOFS_NAME_LEN];   /* file name              */
 140 };
 141
 142 enum {
 143         EXOFS_FT_UNKNOWN,
 144         EXOFS_FT_REG_FILE,
 145         EXOFS_FT_DIR,
 146         EXOFS_FT_CHRDEV,
 147         EXOFS_FT_BLKDEV,
 148         EXOFS_FT_FIFO,
 149         EXOFS_FT_SOCK,
 150         EXOFS_FT_SYMLINK,
 151         EXOFS_FT_MAX
 152 };
 153
 154 #define EXOFS_DIR_PAD                   4
 155 #define EXOFS_DIR_ROUND                 (EXOFS_DIR_PAD - 1)
 156 #define EXOFS_DIR_REC_LEN(name_len) \
 157         (((name_len) + offsetof(struct exofs_dir_entry, name)  + \
 158           EXOFS_DIR_ROUND) & ~EXOFS_DIR_ROUND)
 159
 160 /*************************
 161  * function declarations *
 162  *************************/
 163 /* osd.c                 */
 164 void exofs_make_credential(u8 cred_a[OSD_CAP_LEN],
 165                            const struct osd_obj_id *obj);
 166
 167 int exofs_check_ok_resid(struct osd_request *or, u64 *in_resid, u64 *out_resid);
 168 static inline int exofs_check_ok(struct osd_request *or)
 169 {
 170         return exofs_check_ok_resid(or, NULL, NULL);
 171 }
 172 int exofs_sync_op(struct osd_request *or, int timeout, u8 *cred);
 173 int exofs_async_op(struct osd_request *or,
 174         osd_req_done_fn *async_done, void *caller_context, u8 *cred);
 175
 176 int extract_attr_from_req(struct osd_request *or, struct osd_attr *attr);
 177
 178 int osd_req_read_kern(struct osd_request *or,
 179         const struct osd_obj_id *obj, u64 offset, void *buff, u64 len);
 180
 181 int osd_req_write_kern(struct osd_request *or,
 182         const struct osd_obj_id *obj, u64 offset, void *buff, u64 len);
 183
 184 #endif /*ifndef __EXOFS_COM_H__*/