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 struct exofs_layout {
  59         osd_id          s_pid;                  /* partition ID of file system*/
  60
  61         /* Our way of looking at the data_map */
  62         unsigned stripe_unit;
  63         unsigned mirrors_p1;
  64
  65         unsigned group_width;
  66
  67         enum exofs_inode_layout_gen_functions lay_func;
  68
  69         unsigned        s_numdevs;              /* Num of devices in array    */
  70         struct osd_dev  *s_ods[0];              /* Variable length            */
  71 };
  72
  73 /*
  74  * our extension to the in-memory superblock
  75  */
  76 struct exofs_sb_info {
  77         struct exofs_fscb s_fscb;               /* Written often, pre-allocate*/
  78         int             s_timeout;              /* timeout for OSD operations */
  79         uint64_t        s_nextid;               /* highest object ID used     */
  80         uint32_t        s_numfiles;             /* number of files on fs      */
  81         spinlock_t      s_next_gen_lock;        /* spinlock for gen # update  */
  82         u32             s_next_generation;      /* next gen # to use          */
  83         atomic_t        s_curr_pending;         /* number of pending commands */
  84         uint8_t         s_cred[OSD_CAP_LEN];    /* credential for the fscb    */
  85
  86         struct pnfs_osd_data_map data_map;      /* Default raid to use
  87                                                  * FIXME: Needed ?
  88                                                  */
  89 /*      struct exofs_layout     dir_layout;*/   /* Default dir layout */
  90         struct exofs_layout     layout;         /* Default files layout,
  91                                                  * contains the variable osd_dev
  92                                                  * array. Keep last */
  93         struct osd_dev  *_min_one_dev[1];       /* Place holder for one dev   */
  94 };
  95
  96 /*
  97  * our extension to the in-memory inode
  98  */
  99 struct exofs_i_info {
 100         struct inode   vfs_inode;          /* normal in-memory inode          */
 101         wait_queue_head_t i_wq;            /* wait queue for inode            */
 102         unsigned long  i_flags;            /* various atomic flags            */
 103         uint32_t       i_data[EXOFS_IDATA];/*short symlink names and device #s*/
 104         uint32_t       i_dir_start_lookup; /* which page to start lookup      */
 105         uint64_t       i_commit_size;      /* the object's written length     */
 106         uint8_t        i_cred[OSD_CAP_LEN];/* all-powerful credential         */
 107 };
 108
 109 static inline osd_id exofs_oi_objno(struct exofs_i_info *oi)
 110 {
 111         return oi->vfs_inode.i_ino + EXOFS_OBJ_OFF;
 112 }
 113
 114 struct exofs_io_state;
 115 typedef void (*exofs_io_done_fn)(struct exofs_io_state *or, void *private);
 116
 117 struct exofs_io_state {
 118         struct kref             kref;
 119
 120         void                    *private;
 121         exofs_io_done_fn        done;
 122
 123         struct exofs_layout     *layout;
 124         struct osd_obj_id       obj;
 125         u8                      *cred;
 126
 127         /* Global read/write IO*/
 128         loff_t                  offset;
 129         unsigned long           length;
 130         void                    *kern_buff;
 131         struct bio              *bio;
 132
 133         /* Attributes */
 134         unsigned                in_attr_len;
 135         struct osd_attr         *in_attr;
 136         unsigned                out_attr_len;
 137         struct osd_attr         *out_attr;
 138
 139         /* Variable array of size numdevs */
 140         unsigned numdevs;
 141         struct exofs_per_dev_state {
 142                 struct osd_request *or;
 143                 struct bio *bio;
 144                 loff_t offset;
 145                 unsigned length;
 146                 unsigned dev;
 147         } per_dev[];
 148 };
 149
 150 static inline unsigned exofs_io_state_size(unsigned numdevs)
 151 {
 152         return sizeof(struct exofs_io_state) +
 153                 sizeof(struct exofs_per_dev_state) * numdevs;
 154 }
 155
 156 /*
 157  * our inode flags
 158  */
 159 #define OBJ_2BCREATED   0       /* object will be created soon*/
 160 #define OBJ_CREATED     1       /* object has been created on the osd*/
 161
 162 static inline int obj_2bcreated(struct exofs_i_info *oi)
 163 {
 164         return test_bit(OBJ_2BCREATED, &oi->i_flags);
 165 }
 166
 167 static inline void set_obj_2bcreated(struct exofs_i_info *oi)
 168 {
 169         set_bit(OBJ_2BCREATED, &oi->i_flags);
 170 }
 171
 172 static inline int obj_created(struct exofs_i_info *oi)
 173 {
 174         return test_bit(OBJ_CREATED, &oi->i_flags);
 175 }
 176
 177 static inline void set_obj_created(struct exofs_i_info *oi)
 178 {
 179         set_bit(OBJ_CREATED, &oi->i_flags);
 180 }
 181
 182 int __exofs_wait_obj_created(struct exofs_i_info *oi);
 183 static inline int wait_obj_created(struct exofs_i_info *oi)
 184 {
 185         if (likely(obj_created(oi)))
 186                 return 0;
 187
 188         return __exofs_wait_obj_created(oi);
 189 }
 190
 191 /*
 192  * get to our inode from the vfs inode
 193  */
 194 static inline struct exofs_i_info *exofs_i(struct inode *inode)
 195 {
 196         return container_of(inode, struct exofs_i_info, vfs_inode);
 197 }
 198
 199 /*
 200  * Given a layout, object_number and stripe_index return the associated global
 201  * dev_index
 202  */
 203 unsigned exofs_layout_od_id(struct exofs_layout *layout,
 204                             osd_id obj_no, unsigned layout_index);
 205 /*
 206  * Maximum count of links to a file
 207  */
 208 #define EXOFS_LINK_MAX           32000
 209
 210 /*************************
 211  * function declarations *
 212  *************************/
 213
 214 /* ios.c */
 215 void exofs_make_credential(u8 cred_a[OSD_CAP_LEN],
 216                            const struct osd_obj_id *obj);
 217 int exofs_read_kern(struct osd_dev *od, u8 *cred, struct osd_obj_id *obj,
 218                     u64 offset, void *p, unsigned length);
 219
 220 int  exofs_get_io_state(struct exofs_layout *layout,
 221                         struct exofs_io_state **ios);
 222 void exofs_put_io_state(struct exofs_io_state *ios);
 223
 224 int exofs_check_io(struct exofs_io_state *ios, u64 *resid);
 225
 226 int exofs_sbi_create(struct exofs_io_state *ios);
 227 int exofs_sbi_remove(struct exofs_io_state *ios);
 228 int exofs_sbi_write(struct exofs_io_state *ios);
 229 int exofs_sbi_read(struct exofs_io_state *ios);
 230
 231 int extract_attr_from_ios(struct exofs_io_state *ios, struct osd_attr *attr);
 232
 233 int exofs_oi_truncate(struct exofs_i_info *oi, u64 new_len);
 234 static inline int exofs_oi_write(struct exofs_i_info *oi,
 235                                  struct exofs_io_state *ios)
 236 {
 237         ios->obj.id = exofs_oi_objno(oi);
 238         ios->cred = oi->i_cred;
 239         return exofs_sbi_write(ios);
 240 }
 241
 242 static inline int exofs_oi_read(struct exofs_i_info *oi,
 243                                 struct exofs_io_state *ios)
 244 {
 245         ios->obj.id = exofs_oi_objno(oi);
 246         ios->cred = oi->i_cred;
 247         return exofs_sbi_read(ios);
 248 }
 249
 250 /* inode.c               */
 251 void exofs_truncate(struct inode *inode);
 252 int exofs_setattr(struct dentry *, struct iattr *);
 253 int exofs_write_begin(struct file *file, struct address_space *mapping,
 254                 loff_t pos, unsigned len, unsigned flags,
 255                 struct page **pagep, void **fsdata);
 256 extern struct inode *exofs_iget(struct super_block *, unsigned long);
 257 struct inode *exofs_new_inode(struct inode *, int);
 258 extern int exofs_write_inode(struct inode *, int);
 259 extern void exofs_delete_inode(struct inode *);
 260
 261 /* dir.c:                */
 262 int exofs_add_link(struct dentry *, struct inode *);
 263 ino_t exofs_inode_by_name(struct inode *, struct dentry *);
 264 int exofs_delete_entry(struct exofs_dir_entry *, struct page *);
 265 int exofs_make_empty(struct inode *, struct inode *);
 266 struct exofs_dir_entry *exofs_find_entry(struct inode *, struct dentry *,
 267                                          struct page **);
 268 int exofs_empty_dir(struct inode *);
 269 struct exofs_dir_entry *exofs_dotdot(struct inode *, struct page **);
 270 ino_t exofs_parent_ino(struct dentry *child);
 271 int exofs_set_link(struct inode *, struct exofs_dir_entry *, struct page *,
 272                     struct inode *);
 273
 274 /* super.c               */
 275 int exofs_sync_fs(struct super_block *sb, int wait);
 276
 277 /*********************
 278  * operation vectors *
 279  *********************/
 280 /* dir.c:            */
 281 extern const struct file_operations exofs_dir_operations;
 282
 283 /* file.c            */
 284 extern const struct inode_operations exofs_file_inode_operations;
 285 extern const struct file_operations exofs_file_operations;
 286
 287 /* inode.c           */
 288 extern const struct address_space_operations exofs_aops;
 289 extern const struct osd_attr g_attr_logical_length;
 290
 291 /* namei.c           */
 292 extern const struct inode_operations exofs_dir_inode_operations;
 293 extern const struct inode_operations exofs_special_inode_operations;
 294
 295 /* symlink.c         */
 296 extern const struct inode_operations exofs_symlink_inode_operations;
 297 extern const struct inode_operations exofs_fast_symlink_inode_operations;
 298
 299 #endif