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[0];              /* Variable length            */
  70 };
  71
  72 /*
  73  * our extension to the in-memory superblock
  74  */
  75 struct exofs_sb_info {
  76         struct exofs_sb_stats s_ess;            /* Written often, pre-allocate*/
  77         int             s_timeout;              /* timeout for OSD operations */
  78         uint64_t        s_nextid;               /* highest object ID used     */
  79         uint32_t        s_numfiles;             /* number of files on fs      */
  80         spinlock_t      s_next_gen_lock;        /* spinlock for gen # update  */
  81         u32             s_next_generation;      /* next gen # to use          */
  82         atomic_t        s_curr_pending;         /* number of pending commands */
  83         uint8_t         s_cred[OSD_CAP_LEN];    /* credential for the fscb    */
  84         struct          backing_dev_info bdi;   /* register our bdi with VFS  */
  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
 132         struct page             **pages;
 133         unsigned                nr_pages;
 134         unsigned                pgbase;
 135         unsigned                pages_consumed;
 136
 137         /* Attributes */
 138         unsigned                in_attr_len;
 139         struct osd_attr         *in_attr;
 140         unsigned                out_attr_len;
 141         struct osd_attr         *out_attr;
 142
 143         /* Variable array of size numdevs */
 144         unsigned numdevs;
 145         struct exofs_per_dev_state {
 146                 struct osd_request *or;
 147                 struct bio *bio;
 148                 loff_t offset;
 149                 unsigned length;
 150                 unsigned dev;
 151         } per_dev[];
 152 };
 153
 154 static inline unsigned exofs_io_state_size(unsigned numdevs)
 155 {
 156         return sizeof(struct exofs_io_state) +
 157                 sizeof(struct exofs_per_dev_state) * numdevs;
 158 }
 159
 160 /*
 161  * our inode flags
 162  */
 163 #define OBJ_2BCREATED   0       /* object will be created soon*/
 164 #define OBJ_CREATED     1       /* object has been created on the osd*/
 165
 166 static inline int obj_2bcreated(struct exofs_i_info *oi)
 167 {
 168         return test_bit(OBJ_2BCREATED, &oi->i_flags);
 169 }
 170
 171 static inline void set_obj_2bcreated(struct exofs_i_info *oi)
 172 {
 173         set_bit(OBJ_2BCREATED, &oi->i_flags);
 174 }
 175
 176 static inline int obj_created(struct exofs_i_info *oi)
 177 {
 178         return test_bit(OBJ_CREATED, &oi->i_flags);
 179 }
 180
 181 static inline void set_obj_created(struct exofs_i_info *oi)
 182 {
 183         set_bit(OBJ_CREATED, &oi->i_flags);
 184 }
 185
 186 int __exofs_wait_obj_created(struct exofs_i_info *oi);
 187 static inline int wait_obj_created(struct exofs_i_info *oi)
 188 {
 189         if (likely(obj_created(oi)))
 190                 return 0;
 191
 192         return __exofs_wait_obj_created(oi);
 193 }
 194
 195 /*
 196  * get to our inode from the vfs inode
 197  */
 198 static inline struct exofs_i_info *exofs_i(struct inode *inode)
 199 {
 200         return container_of(inode, struct exofs_i_info, vfs_inode);
 201 }
 202
 203 /*
 204  * Given a layout, object_number and stripe_index return the associated global
 205  * dev_index
 206  */
 207 unsigned exofs_layout_od_id(struct exofs_layout *layout,
 208                             osd_id obj_no, unsigned layout_index);
 209 /*
 210  * Maximum count of links to a file
 211  */
 212 #define EXOFS_LINK_MAX           32000
 213
 214 /*************************
 215  * function declarations *
 216  *************************/
 217
 218 /* ios.c */
 219 void exofs_make_credential(u8 cred_a[OSD_CAP_LEN],
 220                            const struct osd_obj_id *obj);
 221 int exofs_read_kern(struct osd_dev *od, u8 *cred, struct osd_obj_id *obj,
 222                     u64 offset, void *p, unsigned length);
 223
 224 int  exofs_get_io_state(struct exofs_layout *layout,
 225                         struct exofs_io_state **ios);
 226 void exofs_put_io_state(struct exofs_io_state *ios);
 227
 228 int exofs_check_io(struct exofs_io_state *ios, u64 *resid);
 229
 230 int exofs_sbi_create(struct exofs_io_state *ios);
 231 int exofs_sbi_remove(struct exofs_io_state *ios);
 232 int exofs_sbi_write(struct exofs_io_state *ios);
 233 int exofs_sbi_read(struct exofs_io_state *ios);
 234
 235 int extract_attr_from_ios(struct exofs_io_state *ios, struct osd_attr *attr);
 236
 237 int exofs_oi_truncate(struct exofs_i_info *oi, u64 new_len);
 238 static inline int exofs_oi_write(struct exofs_i_info *oi,
 239                                  struct exofs_io_state *ios)
 240 {
 241         ios->obj.id = exofs_oi_objno(oi);
 242         ios->cred = oi->i_cred;
 243         return exofs_sbi_write(ios);
 244 }
 245
 246 static inline int exofs_oi_read(struct exofs_i_info *oi,
 247                                 struct exofs_io_state *ios)
 248 {
 249         ios->obj.id = exofs_oi_objno(oi);
 250         ios->cred = oi->i_cred;
 251         return exofs_sbi_read(ios);
 252 }
 253
 254 /* inode.c               */
 255 unsigned exofs_max_io_pages(struct exofs_layout *layout,
 256                             unsigned expected_pages);
 257 int exofs_setattr(struct dentry *, struct iattr *);
 258 int exofs_write_begin(struct file *file, struct address_space *mapping,
 259                 loff_t pos, unsigned len, unsigned flags,
 260                 struct page **pagep, void **fsdata);
 261 extern struct inode *exofs_iget(struct super_block *, unsigned long);
 262 struct inode *exofs_new_inode(struct inode *, int);
 263 extern int exofs_write_inode(struct inode *, struct writeback_control *wbc);
 264 extern void exofs_evict_inode(struct inode *);
 265
 266 /* dir.c:                */
 267 int exofs_add_link(struct dentry *, struct inode *);
 268 ino_t exofs_inode_by_name(struct inode *, struct dentry *);
 269 int exofs_delete_entry(struct exofs_dir_entry *, struct page *);
 270 int exofs_make_empty(struct inode *, struct inode *);
 271 struct exofs_dir_entry *exofs_find_entry(struct inode *, struct dentry *,
 272                                          struct page **);
 273 int exofs_empty_dir(struct inode *);
 274 struct exofs_dir_entry *exofs_dotdot(struct inode *, struct page **);
 275 ino_t exofs_parent_ino(struct dentry *child);
 276 int exofs_set_link(struct inode *, struct exofs_dir_entry *, struct page *,
 277                     struct inode *);
 278
 279 /* super.c               */
 280 int exofs_sbi_write_stats(struct exofs_sb_info *sbi);
 281
 282 /*********************
 283  * operation vectors *
 284  *********************/
 285 /* dir.c:            */
 286 extern const struct file_operations exofs_dir_operations;
 287
 288 /* file.c            */
 289 extern const struct inode_operations exofs_file_inode_operations;
 290 extern const struct file_operations exofs_file_operations;
 291
 292 /* inode.c           */
 293 extern const struct address_space_operations exofs_aops;
 294 extern const struct osd_attr g_attr_logical_length;
 295
 296 /* namei.c           */
 297 extern const struct inode_operations exofs_dir_inode_operations;
 298 extern const struct inode_operations exofs_special_inode_operations;
 299
 300 /* symlink.c         */
 301 extern const struct inode_operations exofs_symlink_inode_operations;
 302 extern const struct inode_operations exofs_fast_symlink_inode_operations;
 303
 304 #endif