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