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