fs/exofs/exofs.h

   1 /*
   2  * Copyright (C) 2005, 2006
   3  * Avishay Traeger (avishay@gmail.com)
   4  * Copyright (C) 2008, 2009
   5  * Boaz Harrosh <bharrosh@panasas.com>
   6  *
   7  * Copyrights for code taken from ext2:
   8  *     Copyright (C) 1992, 1993, 1994, 1995
   9  *     Remy Card (card@masi.ibp.fr)
  10  *     Laboratoire MASI - Institut Blaise Pascal
  11  *     Universite Pierre et Marie Curie (Paris VI)
  12  *     from
  13  *     linux/fs/minix/inode.c
  14  *     Copyright (C) 1991, 1992  Linus Torvalds
  15  *
  16  * This file is part of exofs.
  17  *
  18  * exofs is free software; you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation.  Since it is based on ext2, and the only
  21  * valid version of GPL for the Linux kernel is version 2, the only valid
  22  * version of GPL for exofs is version 2.
  23  *
  24  * exofs is distributed in the hope that it will be useful,
  25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  * GNU General Public License for more details.
  28  *
  29  * You should have received a copy of the GNU General Public License
  30  * along with exofs; if not, write to the Free Software
  31  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  32  */
  33 #ifndef __EXOFS_H__
  34 #define __EXOFS_H__
  35
  36 #include <linux/fs.h>
  37 #include <linux/time.h>
  38 #include "common.h"
  39
  40 /* FIXME: Remove once pnfs hits mainline
  41  * #include <linux/exportfs/pnfs_osd_xdr.h>
  42  */
  43 #include "pnfs.h"
  44
  45 #define EXOFS_ERR(fmt, a...) printk(KERN_ERR "exofs: " fmt, ##a)
  46
  47 #ifdef CONFIG_EXOFS_DEBUG
  48 #define EXOFS_DBGMSG(fmt, a...) \
  49         printk(KERN_NOTICE "exofs @%s:%d: " fmt, __func__, __LINE__, ##a)
  50 #else
  51 #define EXOFS_DBGMSG(fmt, a...) \
  52         do { if (0) printk(fmt, ##a); } while (0)
  53 #endif
  54
  55 /* u64 has problems with printk this will cast it to unsigned long long */
  56 #define _LLU(x) (unsigned long long)(x)
  57
  58 /*
  59  * our extension to the in-memory superblock
  60  */
  61 struct exofs_sb_info {
  62         struct exofs_fscb s_fscb;               /* Written often, pre-allocate*/
  63         osd_id          s_pid;                  /* partition ID of file system*/
  64         int             s_timeout;              /* timeout for OSD operations */
  65         uint64_t        s_nextid;               /* highest object ID used     */
  66         uint32_t        s_numfiles;             /* number of files on fs      */
  67         spinlock_t      s_next_gen_lock;        /* spinlock for gen # update  */
  68         u32             s_next_generation;      /* next gen # to use          */
  69         atomic_t        s_curr_pending;         /* number of pending commands */
  70         uint8_t         s_cred[OSD_CAP_LEN];    /* credential for the fscb    */
  71
  72         struct pnfs_osd_data_map data_map;      /* Default raid to use        */
  73         unsigned        s_numdevs;              /* Num of devices in array    */
  74         struct osd_dev  *s_ods[1];              /* Variable length, minimum 1 */
  75 };
  76
  77 /*
  78  * our extension to the in-memory inode
  79  */
  80 struct exofs_i_info {
  81         unsigned long  i_flags;            /* various atomic flags            */
  82         uint32_t       i_data[EXOFS_IDATA];/*short symlink names and device #s*/
  83         uint32_t       i_dir_start_lookup; /* which page to start lookup      */
  84         wait_queue_head_t i_wq;            /* wait queue for inode            */
  85         uint64_t       i_commit_size;      /* the object's written length     */
  86         uint8_t        i_cred[OSD_CAP_LEN];/* all-powerful credential         */
  87         struct inode   vfs_inode;          /* normal in-memory inode          */
  88 };
  89
  90 static inline osd_id exofs_oi_objno(struct exofs_i_info *oi)
  91 {
  92         return oi->vfs_inode.i_ino + EXOFS_OBJ_OFF;
  93 }
  94
  95 struct exofs_io_state;
  96 typedef void (*exofs_io_done_fn)(struct exofs_io_state *or, void *private);
  97
  98 struct exofs_io_state {
  99         struct kref             kref;
 100
 101         void                    *private;
 102         exofs_io_done_fn        done;
 103
 104         struct exofs_sb_info    *sbi;
 105         struct osd_obj_id       obj;
 106         u8                      *cred;
 107
 108         /* Global read/write IO*/
 109         loff_t                  offset;
 110         unsigned long           length;
 111         void                    *kern_buff;
 112         struct bio              *bio;
 113
 114         /* Attributes */
 115         unsigned                in_attr_len;
 116         struct osd_attr         *in_attr;
 117         unsigned                out_attr_len;
 118         struct osd_attr         *out_attr;
 119
 120         /* Variable array of size numdevs */
 121         unsigned numdevs;
 122         struct exofs_per_dev_state {
 123                 struct osd_request *or;
 124                 struct bio *bio;
 125         } per_dev[];
 126 };
 127
 128 static inline unsigned exofs_io_state_size(unsigned numdevs)
 129 {
 130         return sizeof(struct exofs_io_state) +
 131                 sizeof(struct exofs_per_dev_state) * numdevs;
 132 }
 133
 134 /*
 135  * our inode flags
 136  */
 137 #define OBJ_2BCREATED   0       /* object will be created soon*/
 138 #define OBJ_CREATED     1       /* object has been created on the osd*/
 139
 140 static inline int obj_2bcreated(struct exofs_i_info *oi)
 141 {
 142         return test_bit(OBJ_2BCREATED, &oi->i_flags);
 143 }
 144
 145 static inline void set_obj_2bcreated(struct exofs_i_info *oi)
 146 {
 147         set_bit(OBJ_2BCREATED, &oi->i_flags);
 148 }
 149
 150 static inline int obj_created(struct exofs_i_info *oi)
 151 {
 152         return test_bit(OBJ_CREATED, &oi->i_flags);
 153 }
 154
 155 static inline void set_obj_created(struct exofs_i_info *oi)
 156 {
 157         set_bit(OBJ_CREATED, &oi->i_flags);
 158 }
 159
 160 int __exofs_wait_obj_created(struct exofs_i_info *oi);
 161 static inline int wait_obj_created(struct exofs_i_info *oi)
 162 {
 163         if (likely(obj_created(oi)))
 164                 return 0;
 165
 166         return __exofs_wait_obj_created(oi);
 167 }
 168
 169 /*
 170  * get to our inode from the vfs inode
 171  */
 172 static inline struct exofs_i_info *exofs_i(struct inode *inode)
 173 {
 174         return container_of(inode, struct exofs_i_info, vfs_inode);
 175 }
 176
 177 /*
 178  * Maximum count of links to a file
 179  */
 180 #define EXOFS_LINK_MAX           32000
 181
 182 /*************************
 183  * function declarations *
 184  *************************/
 185
 186 /* ios.c */
 187 void exofs_make_credential(u8 cred_a[OSD_CAP_LEN],
 188                            const struct osd_obj_id *obj);
 189 int exofs_read_kern(struct osd_dev *od, u8 *cred, struct osd_obj_id *obj,
 190                     u64 offset, void *p, unsigned length);
 191
 192 int  exofs_get_io_state(struct exofs_sb_info *sbi, struct exofs_io_state** ios);
 193 void exofs_put_io_state(struct exofs_io_state *ios);
 194
 195 int exofs_check_io(struct exofs_io_state *ios, u64 *resid);
 196
 197 int exofs_sbi_create(struct exofs_io_state *ios);
 198 int exofs_sbi_remove(struct exofs_io_state *ios);
 199 int exofs_sbi_write(struct exofs_io_state *ios);
 200 int exofs_sbi_read(struct exofs_io_state *ios);
 201
 202 int extract_attr_from_ios(struct exofs_io_state *ios, struct osd_attr *attr);
 203
 204 int exofs_oi_truncate(struct exofs_i_info *oi, u64 new_len);
 205 static inline int exofs_oi_write(struct exofs_i_info *oi,
 206                                  struct exofs_io_state *ios)
 207 {
 208         ios->obj.id = exofs_oi_objno(oi);
 209         ios->cred = oi->i_cred;
 210         return exofs_sbi_write(ios);
 211 }
 212
 213 static inline int exofs_oi_read(struct exofs_i_info *oi,
 214                                 struct exofs_io_state *ios)
 215 {
 216         ios->obj.id = exofs_oi_objno(oi);
 217         ios->cred = oi->i_cred;
 218         return exofs_sbi_read(ios);
 219 }
 220
 221 /* inode.c               */
 222 void exofs_truncate(struct inode *inode);
 223 int exofs_setattr(struct dentry *, struct iattr *);
 224 int exofs_write_begin(struct file *file, struct address_space *mapping,
 225                 loff_t pos, unsigned len, unsigned flags,
 226                 struct page **pagep, void **fsdata);
 227 extern struct inode *exofs_iget(struct super_block *, unsigned long);
 228 struct inode *exofs_new_inode(struct inode *, int);
 229 extern int exofs_write_inode(struct inode *, int);
 230 extern void exofs_delete_inode(struct inode *);
 231
 232 /* dir.c:                */
 233 int exofs_add_link(struct dentry *, struct inode *);
 234 ino_t exofs_inode_by_name(struct inode *, struct dentry *);
 235 int exofs_delete_entry(struct exofs_dir_entry *, struct page *);
 236 int exofs_make_empty(struct inode *, struct inode *);
 237 struct exofs_dir_entry *exofs_find_entry(struct inode *, struct dentry *,
 238                                          struct page **);
 239 int exofs_empty_dir(struct inode *);
 240 struct exofs_dir_entry *exofs_dotdot(struct inode *, struct page **);
 241 ino_t exofs_parent_ino(struct dentry *child);
 242 int exofs_set_link(struct inode *, struct exofs_dir_entry *, struct page *,
 243                     struct inode *);
 244
 245 /* super.c               */
 246 int exofs_sync_fs(struct super_block *sb, int wait);
 247
 248 /*********************
 249  * operation vectors *
 250  *********************/
 251 /* dir.c:            */
 252 extern const struct file_operations exofs_dir_operations;
 253
 254 /* file.c            */
 255 extern const struct inode_operations exofs_file_inode_operations;
 256 extern const struct file_operations exofs_file_operations;
 257
 258 /* inode.c           */
 259 extern const struct address_space_operations exofs_aops;
 260 extern const struct osd_attr g_attr_logical_length;
 261
 262 /* namei.c           */
 263 extern const struct inode_operations exofs_dir_inode_operations;
 264 extern const struct inode_operations exofs_special_inode_operations;
 265
 266 /* symlink.c         */
 267 extern const struct inode_operations exofs_symlink_inode_operations;
 268 extern const struct inode_operations exofs_fast_symlink_inode_operations;
 269
 270 #endif