lustre/include/linux/obdfs.h

   1 /* object based disk file system
   2  *
   3  * This software is licensed under the GPL.  See the file COPYING in the
   4  * top directory of this distribution for details.
   5  *
   6  * Copyright (C), 1999, Stelias Computing Inc
   7  *
   8  *
   9  */
  10
  11
  12 #ifndef _OBDFS_H
  13 #define OBDFS_H
  14 #include <linux/obd_class.h>
  15 #include <linux/list.h>
  16
  17
  18 #define obd_unlock_page(page)   do {    if (PageLocked(page)) { \
  19                         UnlockPage(page);\
  20                 } else {\
  21                         printk("file %s, line %d: expecting locked page\n",\
  22                                __FILE__, __LINE__); \
  23                 }                       \
  24 } while(0)
  25
  26 struct obdfs_pgrq {
  27         struct list_head         rq_plist;      /* linked list of req's */
  28         unsigned long            rq_jiffies;
  29         struct page             *rq_page;       /* page to be written */
  30 };
  31
  32 struct list_head obdfs_super_list;       /* list of all OBDFS superblocks */
  33
  34 struct obdfs_sb_info {
  35         struct list_head         osi_list;      /* list of supers */
  36         struct obd_conn          osi_conn;
  37         struct super_block      *osi_super;
  38         struct obd_device       *osi_obd;
  39         struct obd_ops          *osi_ops;
  40         ino_t                    osi_rootino;   /* number of root inode */
  41         int                      osi_minor;     /* minor of /dev/obdX */
  42         struct list_head         osi_inodes;    /* list of dirty inodes */
  43         unsigned long            osi_cache_count;
  44         struct semaphore         osi_list_mutex;
  45 };
  46
  47 struct obdfs_inode_info {
  48         int              oi_flags;
  49         struct list_head oi_inodes;
  50         struct list_head oi_pages;
  51         char             oi_inline[OBD_INLINESZ];
  52 };
  53
  54 /* dir.c */
  55 #define EXT2_DIR_PAD                    4
  56 #define EXT2_DIR_ROUND                  (EXT2_DIR_PAD - 1)
  57 #define EXT2_DIR_REC_LEN(name_len)      (((name_len) + 8 + EXT2_DIR_ROUND) & \
  58                                          ~EXT2_DIR_ROUND)
  59 #define EXT2_NAME_LEN 255
  60 struct ext2_dir_entry_2 {
  61         __u32   inode;                  /* Inode number */
  62         __u16   rec_len;                /* Directory entry length */
  63         __u8    name_len;               /* Name length */
  64         __u8    file_type;
  65         char    name[EXT2_NAME_LEN];    /* File name */
  66 };
  67 int obdfs_check_dir_entry (const char * function, struct inode * dir,
  68                           struct ext2_dir_entry_2 * de, struct page * page,
  69                           unsigned long offset);
  70 extern struct file_operations obdfs_dir_operations;
  71 extern struct inode_operations obdfs_dir_inode_operations;
  72
  73 /* file.c */
  74 extern struct file_operations obdfs_file_operations;
  75 extern struct inode_operations obdfs_file_inode_operations;
  76
  77 /* flush.c */
  78 void obdfs_dequeue_pages(struct inode *inode);
  79 int obdfs_flushd_init(void);
  80 int obdfs_flushd_cleanup(void);
  81 int obdfs_flush_reqs(struct list_head *inode_list, unsigned long check_time);
  82 int obdfs_flush_dirty_pages(unsigned long check_time);
  83
  84 /* namei.c */
  85 /*
  86  * Structure of the super block
  87  */
  88 struct ext2_super_block {
  89         __u32   s_inodes_count;         /* Inodes count */
  90         __u32   s_blocks_count;         /* Blocks count */
  91         __u32   s_r_blocks_count;       /* Reserved blocks count */
  92         __u32   s_free_blocks_count;    /* Free blocks count */
  93         __u32   s_free_inodes_count;    /* Free inodes count */
  94         __u32   s_first_data_block;     /* First Data Block */
  95         __u32   s_log_block_size;       /* Block size */
  96         __s32   s_log_frag_size;        /* Fragment size */
  97         __u32   s_blocks_per_group;     /* # Blocks per group */
  98         __u32   s_frags_per_group;      /* # Fragments per group */
  99         __u32   s_inodes_per_group;     /* # Inodes per group */
 100         __u32   s_mtime;                /* Mount time */
 101         __u32   s_wtime;                /* Write time */
 102         __u16   s_mnt_count;            /* Mount count */
 103         __s16   s_max_mnt_count;        /* Maximal mount count */
 104         __u16   s_magic;                /* Magic signature */
 105         __u16   s_state;                /* File system state */
 106         __u16   s_errors;               /* Behaviour when detecting errors */
 107         __u16   s_minor_rev_level;      /* minor revision level */
 108         __u32   s_lastcheck;            /* time of last check */
 109         __u32   s_checkinterval;        /* max. time between checks */
 110         __u32   s_creator_os;           /* OS */
 111         __u32   s_rev_level;            /* Revision level */
 112         __u16   s_def_resuid;           /* Default uid for reserved blocks */
 113         __u16   s_def_resgid;           /* Default gid for reserved blocks */
 114         /*
 115          * These fields are for EXT2_DYNAMIC_REV superblocks only.
 116          *
 117          * Note: the difference between the compatible feature set and
 118          * the incompatible feature set is that if there is a bit set
 119          * in the incompatible feature set that the kernel doesn't
 120          * know about, it should refuse to mount the filesystem.
 121          *
 122          * e2fsck's requirements are more strict; if it doesn't know
 123          * about a feature in either the compatible or incompatible
 124          * feature set, it must abort and not try to meddle with
 125          * things it doesn't understand...
 126          */
 127         __u32   s_first_ino;            /* First non-reserved inode */
 128         __u16   s_inode_size;           /* size of inode structure */
 129         __u16   s_block_group_nr;       /* block group # of this superblock */
 130         __u32   s_feature_compat;       /* compatible feature set */
 131         __u32   s_feature_incompat;     /* incompatible feature set */
 132         __u32   s_feature_ro_compat;    /* readonly-compatible feature set */
 133         __u8    s_uuid[16];             /* 128-bit uuid for volume */
 134         char    s_volume_name[16];      /* volume name */
 135         char    s_last_mounted[64];     /* directory where last mounted */
 136         __u32   s_algorithm_usage_bitmap; /* For compression */
 137         /*
 138          * Performance hints.  Directory preallocation should only
 139          * happen if the EXT2_COMPAT_PREALLOC flag is on.
 140          */
 141         __u8    s_prealloc_blocks;      /* Nr of blocks to try to preallocate*/
 142         __u8    s_prealloc_dir_blocks;  /* Nr to preallocate for dirs */
 143         __u16   s_padding1;
 144         __u32   s_reserved[204];        /* Padding to the end of the block */
 145 };
 146
 147 #define EXT2_SB(sb)     (&((sb)->u.ext2_sb))
 148 /*
 149  * Maximal count of links to a file
 150  */
 151 #define EXT2_LINK_MAX           32000
 152 /*
 153  * Ext2 directory file types.  Only the low 3 bits are used.  The
 154  * other bits are reserved for now.
 155  */
 156 #define EXT2_FT_UNKNOWN         0
 157 #define EXT2_FT_REG_FILE        1
 158 #define EXT2_FT_DIR             2
 159 #define EXT2_FT_CHRDEV          3
 160 #define EXT2_FT_BLKDEV          4
 161 #define EXT2_FT_FIFO            5
 162 #define EXT2_FT_SOCK            6
 163 #define EXT2_FT_SYMLINK         7
 164
 165 #define EXT2_FT_MAX             8
 166
 167 #define EXT2_BTREE_FL                   0x00001000 /* btree format dir */
 168 #define EXT2_RESERVED_FL                0x80000000 /* reserved for ext2 lib */
 169 #define EXT2_FEATURE_INCOMPAT_FILETYPE          0x0002
 170 #define EXT2_HAS_COMPAT_FEATURE(sb,mask)                        \
 171         ( EXT2_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask) )
 172 #define EXT2_HAS_INCOMPAT_FEATURE(sb,mask)                      \
 173         ( EXT2_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask) )
 174
 175
 176 struct dentry *obdfs_lookup(struct inode * dir, struct dentry *dentry);
 177 int obdfs_create (struct inode * dir, struct dentry * dentry, int mode);
 178 int obdfs_mkdir(struct inode *dir, struct dentry *dentry, int mode);
 179 int obdfs_rmdir(struct inode *dir, struct dentry *dentry);
 180 int obdfs_unlink(struct inode *dir, struct dentry *dentry);
 181 int obdfs_mknod(struct inode *dir, struct dentry *dentry, int mode, int rdev);
 182 int obdfs_symlink(struct inode *dir, struct dentry *dentry,
 183                   const char *symname);
 184 int obdfs_link(struct dentry *old_dentry, struct inode *dir,
 185                struct dentry *dentry);
 186 int obdfs_rename(struct inode *old_dir, struct dentry *old_dentry,
 187                  struct inode *new_dir, struct dentry *new_dentry);
 188
 189 /* rw.c */
 190 int obdfs_do_writepage(struct page *, int sync);
 191 int obdfs_init_pgrqcache(void);
 192 void obdfs_cleanup_pgrqcache(void);
 193 inline void obdfs_pgrq_del(struct obdfs_pgrq *pgrq);
 194 int obdfs_readpage(struct file *file, struct page *page);
 195 int obdfs_writepage(struct page *page);
 196 struct page *obdfs_getpage(struct inode *inode, unsigned long offset,
 197                            int create, int locked);
 198 int obdfs_write_one_page(struct file *file, struct page *page,
 199                          unsigned long offset, unsigned long bytes,
 200                          const char * buf);
 201 int obdfs_do_vec_wr(struct inode **inodes, obd_count num_io, obd_count num_oa,
 202                     struct obdo **obdos, obd_count *oa_bufs,
 203                     struct page **pages, char **bufs, obd_size *counts,
 204                     obd_off *offsets, obd_flag *flags);
 205 void obdfs_truncate(struct inode *inode);
 206
 207 /* super.c */
 208 extern long obdfs_cache_count;
 209 extern long obdfs_mutex_start;
 210
 211 /* symlink.c */
 212 extern struct inode_operations obdfs_fast_symlink_inode_operations;
 213 extern struct inode_operations obdfs_symlink_inode_operations;
 214
 215 /* sysctl.c */
 216 void obdfs_sysctl_init(void);
 217 void obdfs_sysctl_clean(void);
 218
 219
 220 static inline struct obdfs_inode_info *obdfs_i2info(struct inode *inode)
 221 {
 222         return (struct obdfs_inode_info *)&(inode->u.generic_ip);
 223 }
 224
 225 static inline struct obdfs_sb_info *obdfs_i2sbi(struct inode *inode)
 226 {
 227         return (struct obdfs_sb_info *) &(inode->i_sb->u.generic_sbp);
 228 }
 229
 230 static inline struct list_head *obdfs_iplist(struct inode *inode)
 231 {
 232         struct obdfs_inode_info *info = obdfs_i2info(inode);
 233
 234         return &info->oi_pages;
 235 }
 236
 237 static inline struct list_head *obdfs_islist(struct inode *inode)
 238 {
 239         struct obdfs_inode_info *info = obdfs_i2info(inode);
 240
 241         return &info->oi_inodes;
 242 }
 243
 244 static inline struct list_head *obdfs_slist(struct inode *inode)
 245 {
 246         struct obdfs_sb_info *sbi = obdfs_i2sbi(inode);
 247
 248         return &sbi->osi_inodes;
 249 }
 250
 251 #define obd_down(mutex) {                                               \
 252         /* CDEBUG(D_INFO, "get lock\n"); */                             \
 253         obdfs_mutex_start = jiffies;                                    \
 254         down(mutex);                                                    \
 255         if (jiffies - obdfs_mutex_start)                                \
 256                 CDEBUG(D_CACHE, "waited on mutex %ld jiffies\n",        \
 257                        jiffies - obdfs_mutex_start);                    \
 258 }
 259
 260 #define obd_up(mutex) {                                                 \
 261         up(mutex);                                                      \
 262         if (jiffies - obdfs_mutex_start > 1)                            \
 263                 CDEBUG(D_CACHE, "held mutex for %ld jiffies\n",         \
 264                        jiffies - obdfs_mutex_start);                    \
 265         /* CDEBUG(D_INFO, "free lock\n"); */                            \
 266 }
 267
 268 /* We track if a page has been added to the OBD page cache by stting a
 269  * flag on the page.  We have chosen a bit that will hopefully not be
 270  * used for a while.
 271  */
 272 #define PG_obdcache 29
 273 #define OBDAddCachePage(page)   test_and_set_bit(PG_obdcache, &(page)->flags)
 274 #define OBDClearCachePage(page) clear_bit(PG_obdcache, &(page)->flags)
 275
 276 static inline void obdfs_print_plist(struct inode *inode)
 277 {
 278         struct list_head *page_list = obdfs_iplist(inode);
 279         struct list_head *tmp;
 280
 281         CDEBUG(D_INFO, "inode %ld: page", inode->i_ino);
 282         /* obd_down(&obdfs_i2sbi(inode)->osi_list_mutex); */
 283         if (list_empty(page_list)) {
 284                 CDEBUG(D_INFO, " list empty\n");
 285                 obd_up(&obdfs_i2sbi(inode)->osi_list_mutex);
 286                 return;
 287         }
 288
 289         tmp = page_list;
 290         while ( (tmp = tmp->next) != page_list) {
 291                 struct obdfs_pgrq *pgrq;
 292                 pgrq = list_entry(tmp, struct obdfs_pgrq, rq_plist);
 293                 CDEBUG(D_INFO, " %p", pgrq->rq_page);
 294         }
 295         CDEBUG(D_INFO, "\n");
 296         /* obd_up(&obdfs_i2sbi(inode)->osi_list_mutex); */
 297 }
 298
 299 static inline int obdfs_has_inline(struct inode *inode)
 300 {
 301         return (obdfs_i2info(inode)->oi_flags & OBD_FL_INLINEDATA);
 302 }
 303
 304 static void inline obdfs_from_inode(struct obdo *oa, struct inode *inode)
 305 {
 306         struct obdfs_inode_info *oinfo = obdfs_i2info(inode);
 307
 308         CDEBUG(D_INFO, "src inode %ld, dst obdo %ld valid 0x%08x\n",
 309                inode->i_ino, (long)oa->o_id, oa->o_valid);
 310         obdo_from_inode(oa, inode);
 311         if (obdfs_has_inline(inode)) {
 312                 CDEBUG(D_INODE, "copying inline data from inode to obdo\n");
 313                 memcpy(oa->o_inline, oinfo->oi_inline, OBD_INLINESZ);
 314                 oa->o_obdflags |= OBD_FL_INLINEDATA;
 315                 oa->o_valid |= OBD_MD_FLINLINE;
 316         }
 317 } /* obdfs_from_inode */
 318
 319 static void inline obdfs_to_inode(struct inode *inode, struct obdo *oa)
 320 {
 321         struct obdfs_inode_info *oinfo = obdfs_i2info(inode);
 322
 323         CDEBUG(D_INFO, "src obdo %ld valid 0x%08x, dst inode %ld\n",
 324                (long)oa->o_id, oa->o_valid, inode->i_ino);
 325
 326         obdo_to_inode(inode, oa);
 327
 328         if (obdo_has_inline(oa)) {
 329                 CDEBUG(D_INODE, "copying inline data from obdo to inode\n");
 330                 memcpy(oinfo->oi_inline, oa->o_inline, OBD_INLINESZ);
 331                 oinfo->oi_flags |= OBD_FL_INLINEDATA;
 332         }
 333 } /* obdfs_to_inode */
 334
 335 #define NOLOCK 0
 336 #define LOCKED 1
 337
 338 #ifdef OPS
 339 #warning "*** WARNING redefining OPS"
 340 #else
 341 #define OPS(sb,op) ((struct obdfs_sb_info *)(& ## sb ## ->u.generic_sbp))->osi_ops->o_ ## op
 342 #define IOPS(inode,op) ((struct obdfs_sb_info *)(& ## inode->i_sb ## ->u.generic_sbp))->osi_ops->o_ ## op
 343 #endif
 344
 345 #ifdef ID
 346 #warning "*** WARNING redefining ID"
 347 #else
 348 #define ID(sb) (&((struct obdfs_sb_info *)( & ## sb ## ->u.generic_sbp))->osi_conn)
 349 #define IID(inode) (&((struct obdfs_sb_info *)( & ## inode->i_sb ## ->u.generic_sbp))->osi_conn)
 350 #endif
 351
 352 #define OBDFS_SUPER_MAGIC 0x4711
 353
 354 #endif
 355