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