lustre/llite/llite_internal.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * Copyright (C) 2003 Cluster File Systems, Inc.
   5  *
   6  * This code is issued under the GNU General Public License.
   7  * See the file COPYING in this distribution
   8  */
   9
  10 #ifndef LLITE_INTERNAL_H
  11 #define LLITE_INTERNAL_H
  12
  13 #include <linux/lustre_debug.h>
  14
  15 /* default to about 40meg of readahead on a given system.  That much tied
  16  * up in 512k readahead requests serviced at 40ms each is about 1GB/s. */
  17 #define SBI_DEFAULT_RA_MAX ((40 << 20) >> PAGE_CACHE_SHIFT)
  18
  19 enum ra_stat {
  20         RA_STAT_HIT = 0,
  21         RA_STAT_MISS,
  22         RA_STAT_DISTANT_READPAGE,
  23         RA_STAT_MISS_IN_WINDOW,
  24         RA_STAT_FAILED_MATCH,
  25         RA_STAT_DISCARDED,
  26         RA_STAT_ZERO_LEN,
  27         RA_STAT_ZERO_WINDOW,
  28         RA_STAT_EOF,
  29         RA_STAT_MAX_IN_FLIGHT,
  30         _NR_RA_STAT,
  31 };
  32
  33 struct ll_ra_info {
  34         unsigned long             ra_cur_pages;
  35         unsigned long             ra_max_pages;
  36         unsigned long             ra_stats[_NR_RA_STAT];
  37 };
  38
  39 /* after roughly how long should we remove an inactive mount? */
  40 #define GNS_MOUNT_TIMEOUT 120
  41
  42 /* how often should the GNS timer look for mounts to cleanup? */
  43 #define GNS_TICK_TIMEOUT  1
  44
  45 /* how many times GNS will try to wait for 1 second for mount */
  46 #define GNS_WAIT_ATTEMPTS 10
  47
  48 struct ll_sb_info {
  49         /* this protects pglist and max_r_a_pages.  It isn't safe to grab from
  50          * interrupt contexts. */
  51         spinlock_t                ll_lock;
  52
  53         struct obd_uuid           ll_sb_uuid;
  54         struct obd_export        *ll_md_exp;
  55         struct obd_export        *ll_dt_exp;
  56         struct lov_desc           ll_dt_desc;
  57         struct proc_dir_entry    *ll_proc_root;
  58         struct lustre_id          ll_rootid;     /* root lustre id */
  59
  60         struct lustre_mount_data *ll_lmd;
  61         char                     *ll_instance;
  62
  63         int                       ll_flags;
  64         struct list_head          ll_conn_chain; /* per-conn chain of SBs */
  65
  66         struct hlist_head         ll_orphan_dentry_list; /*please don't ask -p*/
  67         struct ll_close_queue    *ll_lcq;
  68
  69         struct lprocfs_stats     *ll_stats;      /* lprocfs stats counter */
  70
  71         unsigned long             ll_pglist_gen;
  72         struct list_head          ll_pglist;
  73
  74         struct ll_ra_info         ll_ra_info;
  75
  76         unsigned int              ll_remote;      /* remote client? */
  77
  78         /* times spent waiting for locks in each call site.  These are
  79          * all protected by the ll_lock */
  80         struct obd_service_time   ll_read_stime;
  81         struct obd_service_time   ll_write_stime;
  82         struct obd_service_time   ll_grouplock_stime;
  83         struct obd_service_time   ll_seek_stime;
  84         struct obd_service_time   ll_setattr_stime;
  85         struct obd_service_time   ll_brw_stime;
  86 //      struct obd_service_time   ll_done_stime;
  87
  88         int                       ll_config_version; /* last-applied update */
  89
  90         /* list of GNS mounts; protected by the dcache_lock */
  91         struct list_head          ll_mnt_list;
  92
  93         struct semaphore          ll_gns_sem;
  94         spinlock_t                ll_gns_lock;
  95         wait_queue_head_t         ll_gns_waitq;
  96         atomic_t                  ll_gns_enabled;
  97         int                       ll_gns_state;
  98         struct timer_list         ll_gns_timer;
  99         struct list_head          ll_gns_sbi_head;
 100         struct completion         ll_gns_mount_finished;
 101         struct dentry            *ll_gns_pending_dentry;
 102
 103         unsigned long             ll_gns_tick;
 104         unsigned long             ll_gns_timeout;
 105
 106         /* path to upcall */
 107         char                      ll_gns_upcall[PATH_MAX];
 108
 109         /* mount object entry name */
 110         char                      ll_gns_oname[PATH_MAX];
 111 };
 112
 113 struct ll_gns_ctl {
 114         struct completion gc_starting;
 115         struct completion gc_finishing;
 116 };
 117
 118 /* mounting states */
 119 #define LL_GNS_IDLE               (1 << 0)
 120 #define LL_GNS_MOUNTING           (1 << 1)
 121 #define LL_GNS_FINISHED           (1 << 2)
 122
 123 /* mounts checking flags */
 124 #define LL_GNS_UMOUNT             (1 << 0)
 125 #define LL_GNS_CHECK              (1 << 1)
 126
 127 struct ll_readahead_state {
 128         spinlock_t      ras_lock;
 129         unsigned long   ras_last_readpage, ras_consecutive;
 130         unsigned long   ras_window_start, ras_window_len;
 131         unsigned long   ras_next_readahead;
 132
 133 };
 134
 135 extern kmem_cache_t *ll_file_data_slab;
 136 extern kmem_cache_t *ll_intent_slab;
 137 struct lustre_handle;
 138
 139 struct ll_file_data {
 140         struct ll_readahead_state fd_ras;
 141         __u32 fd_flags;
 142         int fd_omode;
 143         struct lustre_handle fd_cwlockh;
 144         unsigned long fd_gid;
 145 };
 146
 147 struct lov_stripe_md;
 148
 149 extern spinlock_t inode_lock;
 150
 151 extern void lprocfs_unregister_mountpoint(struct ll_sb_info *sbi);
 152 extern struct proc_dir_entry *proc_lustre_fs_root;
 153
 154 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 155 # define hlist_del_init list_del_init
 156 #endif
 157
 158 static inline struct inode *ll_info2i(struct ll_inode_info *lli)
 159 {
 160 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0))
 161         return &lli->lli_vfs_inode;
 162 #else
 163         return list_entry(lli, struct inode, u.generic_ip);
 164 #endif
 165 }
 166
 167
 168 struct it_cb_data {
 169         struct inode *icbd_parent;
 170         struct dentry **icbd_childp;
 171         obd_id hash;
 172 };
 173
 174 #define LLAP_MAGIC 98764321
 175
 176 struct ll_async_page {
 177         int             llap_magic;
 178         void            *llap_cookie;
 179         struct page     *llap_page;
 180         struct list_head llap_pending_write;
 181          /* only trust these if the page lock is providing exclusion */
 182         unsigned         llap_write_queued:1,
 183                          llap_defer_uptodate:1,
 184                          llap_origin:3,
 185                          llap_ra_used:1;
 186
 187         struct list_head llap_proc_item;
 188 };
 189
 190 enum {
 191         LLAP_ORIGIN_UNKNOWN = 0,
 192         LLAP_ORIGIN_READPAGE,
 193         LLAP_ORIGIN_READAHEAD,
 194         LLAP_ORIGIN_COMMIT_WRITE,
 195         LLAP_ORIGIN_WRITEPAGE,
 196         LLAP__ORIGIN_MAX,
 197 };
 198
 199 /*
 200  * remote ACL stuff
 201  */
 202 #define REMOTE_ACL_HASHSIZE     16
 203
 204 struct remote_acl {
 205         struct list_head        ra_perm_cache[REMOTE_ACL_HASHSIZE];
 206         spinlock_t              ra_lock;
 207         /* we use one sem per inode, it's kind of coarse: one user must
 208          * wait if another user is updating the perm on this inode. but
 209          * I guess this is fine is real world usage.
 210          */
 211         struct semaphore        ra_update_sem;
 212 };
 213
 214 struct lustre_remote_perm {
 215         struct list_head        lrp_list;
 216         uid_t                   lrp_auth_uid;       /* authenticated uid */
 217         gid_t                   lrp_auth_gid;       /* authenticated gid */
 218         uint16_t                lrp_perm;           /* permission bits */
 219         uint16_t                lrp_valid:1,        /* lrp_perm is valid */
 220                                 lrp_setuid:1,       /* allow setuid */
 221                                 lrp_setgid:1;       /* allow setgid */
 222         struct list_head        lrp_setxid_perms;   /* setxid perms list */
 223 };
 224
 225 struct remote_perm_setxid {
 226         struct list_head        list; /* permission list */
 227         uid_t                   uid;
 228         gid_t                   gid;
 229         uint16_t                perm;
 230 };
 231
 232 /* llite/lproc_llite.c */
 233 int lprocfs_register_mountpoint(struct proc_dir_entry *parent,
 234                                 struct super_block *sb, char *lov,
 235                                 char *lmv);
 236 void lprocfs_unregister_mountpoint(struct ll_sb_info *sbi);
 237
 238 /* llite/dir.c */
 239 extern struct file_operations ll_dir_operations;
 240 extern struct inode_operations ll_dir_inode_operations;
 241
 242 /* llite/namei.c */
 243 int ll_objects_destroy(struct ptlrpc_request *request,
 244                        struct inode *dir, int offset);
 245 struct inode *ll_iget(struct super_block *sb, ino_t hash,
 246                       struct lustre_md *lic);
 247 struct dentry *ll_find_alias(struct inode *, struct dentry *);
 248 int ll_mdc_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
 249                         void *data, int flag);
 250 /* llite/rw.c */
 251 int ll_prepare_write(struct file *, struct page *, unsigned from, unsigned to);
 252 int ll_commit_write(struct file *, struct page *, unsigned from, unsigned to);
 253 int ll_writepage(struct page *page);
 254 void ll_inode_fill_obdo(struct inode *inode, int cmd, struct obdo *oa);
 255 void ll_ap_completion(void *data, int cmd, struct obdo *oa, int rc);
 256 void ll_removepage(struct page *page);
 257 int ll_readpage(struct file *file, struct page *page);
 258 struct ll_async_page *llap_from_cookie(void *cookie);
 259 struct ll_async_page *llap_from_page(struct page *page, unsigned origin);
 260 struct ll_async_page *llap_cast_private(struct page *page);
 261 void ll_readahead_init(struct inode *inode, struct ll_readahead_state *ras);
 262
 263 void ll_ra_accounting(struct page *page, struct address_space *mapping);
 264 void ll_truncate(struct inode *inode);
 265
 266 /* llite/file.c */
 267 extern struct file_operations ll_file_operations;
 268 extern struct inode_operations ll_file_inode_operations;
 269 int ll_md_real_close(struct obd_export *md_exp,
 270                      struct inode *inode, int flags);
 271 extern int ll_inode_revalidate_it(struct dentry *);
 272 int ll_setxattr(struct dentry *, const char *, const void *,
 273                 size_t, int);
 274 int ll_getxattr(struct dentry *, const char *, void *, size_t);
 275 int ll_listxattr(struct dentry *, char *, size_t);
 276 int ll_removexattr(struct dentry *, const char *);
 277 extern int ll_inode_permission(struct inode *, int, struct nameidata *);
 278 int ll_refresh_lsm(struct inode *inode, struct lov_stripe_md *lsm);
 279 int ll_extent_lock(struct ll_file_data *, struct inode *,
 280                    struct lov_stripe_md *, int mode, ldlm_policy_data_t *,
 281                    struct lustre_handle *, int ast_flags,
 282                    struct obd_service_time *);
 283 int ll_extent_unlock(struct ll_file_data *, struct inode *,
 284                      struct lov_stripe_md *, int mode, struct lustre_handle *);
 285 int ll_file_open(struct inode *inode, struct file *file);
 286 int ll_file_release(struct inode *inode, struct file *file);
 287 int ll_lsm_getattr(struct obd_export *, struct lov_stripe_md *, struct obdo *);
 288 int ll_glimpse_size(struct inode *inode);
 289 int ll_local_open(struct file *file, struct lookup_intent *it,
 290                   struct obd_client_handle *och);
 291 int ll_md_close(struct obd_export *md_exp, struct inode *inode,
 292                 struct file *file);
 293 int ll_md_och_close(struct obd_export *md_exp, struct inode *inode,
 294                     struct obd_client_handle *och, int dirty);
 295 void ll_och_fill(struct inode *inode, struct lookup_intent *it,
 296                  struct obd_client_handle *och);
 297
 298 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2,5,0))
 299 int ll_getattr(struct vfsmount *mnt, struct dentry *de, struct kstat *stat);
 300 #endif
 301 void ll_stime_record(struct ll_sb_info *sbi, struct timeval *start,
 302                      struct obd_service_time *stime);
 303
 304 /* llite/dcache.c */
 305 void ll_intent_drop_lock(struct lookup_intent *);
 306 void ll_intent_release(struct lookup_intent *);
 307 int ll_intent_alloc(struct lookup_intent *);
 308 void ll_intent_free(struct lookup_intent *it);
 309 extern void ll_set_dd(struct dentry *de);
 310 void ll_unhash_aliases(struct inode *);
 311 void ll_frob_intent(struct lookup_intent **itp, struct lookup_intent *deft);
 312 void ll_lookup_finish_locks(struct lookup_intent *it, struct dentry *dentry);
 313 int revalidate_it_finish(struct ptlrpc_request *request, int offset,
 314                          struct lookup_intent *it, struct dentry *de);
 315
 316
 317 /* llite/llite_gns.c */
 318 int ll_gns_start_thread(void);
 319 void ll_gns_stop_thread(void);
 320
 321 int ll_gns_mount_object(struct dentry *dentry,
 322                         struct vfsmount *mnt);
 323 int ll_gns_umount_object(struct vfsmount *mnt);
 324
 325 int ll_gns_check_mounts(struct ll_sb_info *sbi,
 326                         int flags);
 327
 328 void ll_gns_timer_callback(unsigned long data);
 329 void ll_gns_add_timer(struct ll_sb_info *sbi);
 330 void ll_gns_del_timer(struct ll_sb_info *sbi);
 331
 332 /* llite/llite_lib.c */
 333 extern struct super_operations lustre_super_operations;
 334
 335 char *ll_read_opt(const char *opt, char *data);
 336 int ll_set_opt(const char *opt, char *data, int fl);
 337 void ll_options(char *options, char **ost, char **mds, char **mds_sec,
 338                 char **oss_sec, int *async, int *flags);
 339 void ll_lli_init(struct ll_inode_info *lli);
 340 int ll_fill_super(struct super_block *sb, void *data, int silent);
 341 int lustre_fill_super(struct super_block *sb, void *data, int silent);
 342 void lustre_put_super(struct super_block *sb);
 343 struct inode *ll_inode_from_lock(struct ldlm_lock *lock);
 344 void ll_clear_inode(struct inode *inode);
 345 int ll_attr2inode(struct inode *inode, struct iattr *attr, int trunc);
 346 int ll_setattr_raw(struct inode *inode, struct iattr *attr);
 347 int ll_setattr(struct dentry *de, struct iattr *attr);
 348 int ll_statfs(struct super_block *sb, struct kstatfs *sfs);
 349 int ll_statfs_internal(struct super_block *sb, struct obd_statfs *osfs,
 350                        unsigned long maxage);
 351 void ll_update_inode(struct inode *inode, struct lustre_md *);
 352 int ll_fetch_remote_perm(struct inode *inode, struct ptlrpc_request *req,
 353                          uint16_t *perm);
 354 int it_disposition(struct lookup_intent *it, int flag);
 355 void it_set_disposition(struct lookup_intent *it, int flag);
 356 void ll_read_inode2(struct inode *inode, void *opaque);
 357 void ll_delete_inode(struct inode *inode);
 358 int ll_iocontrol(struct inode *inode, struct file *file,
 359                  unsigned int cmd, unsigned long arg);
 360 void ll_umount_begin(struct super_block *sb);
 361 int ll_prep_inode(struct obd_export *, struct obd_export *, struct inode **inode,
 362                   struct ptlrpc_request *req, int offset, struct super_block *);
 363 __u32 get_uuid2int(const char *name, int len);
 364 struct dentry *ll_fh_to_dentry(struct super_block *sb, __u32 *data, int len,
 365                                int fhtype, int parent);
 366 int ll_dentry_to_fh(struct dentry *, __u32 *datap, int *lenp, int need_parent);
 367 int null_if_equal(struct ldlm_lock *lock, void *data);
 368 int ll_process_config_update(struct ll_sb_info *sbi, int clean);
 369 int ll_show_options(struct seq_file *m, struct vfsmount *mnt);
 370 int ll_flush_cred(struct inode *inode);
 371
 372 int ll_remote_acl_permission(struct inode *inode, int mode);
 373 int ll_remote_acl_update(struct inode *inode, struct mds_remote_perm *perm);
 374 void ll_inode_invalidate_acl(struct inode *inode);
 375
 376 /* llite/special.c */
 377 extern struct inode_operations ll_special_inode_operations;
 378 extern struct file_operations ll_special_chr_inode_fops;
 379 extern struct file_operations ll_special_chr_file_fops;
 380 extern struct file_operations ll_special_blk_inode_fops;
 381 extern struct file_operations ll_special_fifo_inode_fops;
 382 extern struct file_operations ll_special_fifo_file_fops;
 383 extern struct file_operations ll_special_sock_inode_fops;
 384
 385 /* llite/symlink.c */
 386 extern struct inode_operations ll_fast_symlink_inode_operations;
 387
 388 /* llite/llite_close.c */
 389 struct ll_close_queue {
 390         spinlock_t              lcq_lock;
 391         struct list_head        lcq_list;
 392         wait_queue_head_t       lcq_waitq;
 393         struct completion       lcq_comp;
 394 };
 395
 396 void llap_write_pending(struct inode *inode, struct ll_async_page *llap);
 397 void llap_write_complete(struct inode *inode, struct ll_async_page *llap);
 398 void ll_open_complete(struct inode *inode);
 399 int ll_is_inode_dirty(struct inode *inode);
 400 void ll_try_done_writing(struct inode *inode);
 401 void ll_queue_done_writing(struct inode *inode);
 402 void ll_close_thread_shutdown(struct ll_close_queue *lcq);
 403 int ll_close_thread_start(struct ll_close_queue **lcq_ret);
 404
 405
 406 /* llite/llite_mmap.c */
 407 #if  (LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0))
 408 typedef struct rb_root  rb_root_t;
 409 typedef struct rb_node  rb_node_t;
 410 #endif
 411
 412 struct ll_lock_tree_node;
 413 struct ll_lock_tree {
 414         rb_root_t                       lt_root;
 415         struct list_head                lt_locked_list;
 416         struct ll_file_data             *lt_fd;
 417 };
 418 int ll_teardown_mmaps(struct address_space *mapping, __u64 first,
 419                       __u64 last);
 420 int ll_file_mmap(struct file * file, struct vm_area_struct * vma);
 421 struct ll_lock_tree_node * ll_node_from_inode(struct inode *inode, __u64 start,
 422                                               __u64 end, ldlm_mode_t mode);
 423 int ll_tree_lock(struct ll_lock_tree *tree,
 424                  struct ll_lock_tree_node *first_node, struct inode *inode,
 425                  const char *buf, size_t count, int ast_flags);
 426 int ll_tree_unlock(struct ll_lock_tree *tree, struct inode *inode);
 427
 428 int ll_get_fid(struct obd_export *exp, struct lustre_id *idp,
 429                char *filename, struct lustre_id *ret);
 430
 431 /* generic */
 432 #define LL_SBI_NOLCK           0x1
 433 #define LL_SBI_READAHEAD       0x2
 434 #define LL_SUPER_MAGIC         0x0BD00BD0
 435 #define LL_MAX_BLKSIZE         (4UL * 1024 * 1024)
 436
 437 #if  (LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0))
 438 #define    ll_s2sbi(sb)        ((struct ll_sb_info *)((sb)->s_fs_info))
 439 #define    ll_set_sbi(sb, sbi) ((sb)->s_fs_info = sbi)
 440 static inline __u64 ll_ts2u64(struct timespec *time)
 441 {
 442         __u64 t = time->tv_sec;
 443         return t;
 444 }
 445 #else  /* 2.4 here */
 446 #define    ll_s2sbi(sb)        ((struct ll_sb_info *)((sb)->u.generic_sbp))
 447 #define    ll_set_sbi(sb, sbi) ((sb)->u.generic_sbp = sbi)
 448 static inline __u64 ll_ts2u64(time_t *time)
 449 {
 450         return *time;
 451 }
 452 #endif
 453
 454 /* don't need an addref as the sb_info should be holding one */
 455 static inline struct obd_export *ll_s2dtexp(struct super_block *sb)
 456 {
 457         return ll_s2sbi(sb)->ll_dt_exp;
 458 }
 459
 460 /* don't need an addref as the sb_info should be holding one */
 461 static inline struct obd_export *ll_s2mdexp(struct super_block *sb)
 462 {
 463         return ll_s2sbi(sb)->ll_md_exp;
 464 }
 465
 466 static inline struct client_obd *sbi2md(struct ll_sb_info *sbi)
 467 {
 468         struct obd_device *obd = sbi->ll_md_exp->exp_obd;
 469         if (obd == NULL)
 470                 LBUG();
 471         return &obd->u.cli;
 472 }
 473
 474 // FIXME: replace the name of this with LL_SB to conform to kernel stuff
 475 static inline struct ll_sb_info *ll_i2sbi(struct inode *inode)
 476 {
 477         return ll_s2sbi(inode->i_sb);
 478 }
 479
 480 static inline struct obd_export *ll_i2dtexp(struct inode *inode)
 481 {
 482         return ll_s2dtexp(inode->i_sb);
 483 }
 484
 485 static inline struct obd_export *ll_i2mdexp(struct inode *inode)
 486 {
 487         return ll_s2mdexp(inode->i_sb);
 488 }
 489
 490 static inline int ll_mds_max_easize(struct super_block *sb)
 491 {
 492         return sbi2md(ll_s2sbi(sb))->cl_max_mds_easize;
 493 }
 494
 495 static inline __u64 ll_file_maxbytes(struct inode *inode)
 496 {
 497         return ll_i2info(inode)->lli_maxbytes;
 498 }
 499
 500 static inline void
 501 ll_inode2id(struct lustre_id *id, struct inode *inode)
 502 {
 503         struct lustre_id *lid = &ll_i2info(inode)->lli_id;
 504
 505         mdc_pack_id(id, inode->i_ino, inode->i_generation,
 506                     (inode->i_mode & S_IFMT), id_group(lid),
 507                     id_fid(lid));
 508 }
 509
 510 static inline void
 511 ll_prepare_mdc_data(struct mdc_op_data *data, struct inode *i1,
 512                     struct inode *i2, const char *name, int namelen,
 513                     int mode)
 514 {
 515         LASSERT(i1);
 516         ll_inode2id(&data->id1, i1);
 517
 518         /* it could be directory with mea */
 519         data->mea1 = ll_i2info(i1)->lli_mea;
 520
 521         if (i2) {
 522                 ll_inode2id(&data->id2, i2);
 523                 data->mea2 = ll_i2info(i2)->lli_mea;
 524         }
 525
 526         data->valid = 0;
 527         data->name = name;
 528         data->namelen = namelen;
 529         data->create_mode = mode;
 530         data->mod_time = LTIME_S(CURRENT_TIME);
 531 }
 532
 533 /* pass this flag to ll_md_real_close() to send close rpc right away */
 534 #define FMODE_SYNC               00000010
 535
 536
 537 #endif /* LLITE_INTERNAL_H */