lustre/osd-ldiskfs/osd_internal.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2012, Whamcloud, Inc.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/osd/osd_internal.h
  37  *
  38  * Shared definitions and declarations for osd module
  39  *
  40  * Author: Nikita Danilov <nikita@clusterfs.com>
  41  */
  42
  43 #ifndef _OSD_INTERNAL_H
  44 #define _OSD_INTERNAL_H
  45
  46 #if defined(__KERNEL__)
  47
  48 /* struct rw_semaphore */
  49 #include <linux/rwsem.h>
  50 /* struct dentry */
  51 #include <linux/dcache.h>
  52 /* struct dirent64 */
  53 #include <linux/dirent.h>
  54
  55 #include <ldiskfs/ldiskfs.h>
  56 #include <ldiskfs/ldiskfs_jbd2.h>
  57 #ifdef HAVE_LDISKFS_JOURNAL_CALLBACK_ADD
  58 # define journal_callback ldiskfs_journal_cb_entry
  59 # define osd_journal_callback_set(handle, func, jcb) \
  60          ldiskfs_journal_callback_add(handle, func, jcb)
  61 #else
  62 # define osd_journal_callback_set(handle, func, jcb) \
  63          jbd2_journal_callback_set(handle, func, jcb)
  64 #endif
  65
  66 /* fsfilt_{get|put}_ops */
  67 #include <lustre_fsfilt.h>
  68
  69 /* LUSTRE_OSD_NAME */
  70 #include <obd.h>
  71 /* class_register_type(), class_unregister_type(), class_get_type() */
  72 #include <obd_class.h>
  73 #include <lustre_disk.h>
  74 #include <dt_object.h>
  75 #include <lquota.h>
  76
  77 #include "osd_oi.h"
  78 #include "osd_iam.h"
  79 #include "osd_scrub.h"
  80 #include "osd_quota_fmt.h"
  81
  82 struct inode;
  83
  84 #define OSD_COUNTERS (0)
  85
  86 /* Lustre special inode::i_state to indicate OI scrub skip this inode. */
  87 #define I_LUSTRE_NOSCRUB        (1 << 31)
  88
  89 /** Enable thandle usage statistics */
  90 #define OSD_THANDLE_STATS (0)
  91
  92 #ifdef HAVE_QUOTA_SUPPORT
  93 struct osd_ctxt {
  94         __u32 oc_uid;
  95         __u32 oc_gid;
  96         cfs_kernel_cap_t oc_cap;
  97 };
  98 #endif
  99
 100 struct osd_directory {
 101         struct iam_container od_container;
 102         struct iam_descr     od_descr;
 103 };
 104
 105 /*
 106  * Object Index (oi) instance.
 107  */
 108 struct osd_oi {
 109         /*
 110          * underlying index object, where fid->id mapping in stored.
 111          */
 112         struct inode         *oi_inode;
 113         struct osd_directory  oi_dir;
 114 };
 115
 116 extern const int osd_dto_credits_noquota[];
 117
 118 struct osd_object {
 119         struct dt_object        oo_dt;
 120         /**
 121          * Inode for file system object represented by this osd_object. This
 122          * inode is pinned for the whole duration of lu_object life.
 123          *
 124          * Not modified concurrently (either setup early during object
 125          * creation, or assigned by osd_object_create() under write lock).
 126          */
 127         struct inode           *oo_inode;
 128         /**
 129          * to protect index ops.
 130          */
 131         struct htree_lock_head *oo_hl_head;
 132         cfs_rw_semaphore_t      oo_ext_idx_sem;
 133         cfs_rw_semaphore_t      oo_sem;
 134         struct osd_directory   *oo_dir;
 135         /** protects inode attributes. */
 136         cfs_spinlock_t          oo_guard;
 137         /**
 138          * Following two members are used to indicate the presence of dot and
 139          * dotdot in the given directory. This is required for interop mode
 140          * (b11826).
 141          */
 142         int                     oo_compat_dot_created;
 143         int                     oo_compat_dotdot_created;
 144
 145         const struct lu_env    *oo_owner;
 146 #ifdef CONFIG_LOCKDEP
 147         struct lockdep_map      oo_dep_map;
 148 #endif
 149 };
 150
 151 #ifdef HAVE_LDISKFS_PDO
 152
 153 #define osd_ldiskfs_find_entry(dir, dentry, de, lock)   \
 154         ll_ldiskfs_find_entry(dir, dentry, de, lock)
 155 #define osd_ldiskfs_add_entry(handle, child, cinode, hlock) \
 156         ldiskfs_add_entry(handle, child, cinode, hlock)
 157
 158 #else /* HAVE_LDISKFS_PDO */
 159
 160 struct htree_lock {
 161         int     dummy;
 162 };
 163
 164 struct htree_lock_head {
 165         int     dummy;
 166 };
 167
 168 #define ldiskfs_htree_lock(lock, head, inode, op)  do { LBUG(); } while (0)
 169 #define ldiskfs_htree_unlock(lock)                 do { LBUG(); } while (0)
 170
 171 static inline struct htree_lock_head *ldiskfs_htree_lock_head_alloc(int dep)
 172 {
 173         LBUG();
 174         return NULL;
 175 }
 176
 177 #define ldiskfs_htree_lock_head_free(lh)           do { LBUG(); } while (0)
 178
 179 #define LDISKFS_DUMMY_HTREE_LOCK        0xbabecafe
 180
 181 static inline struct htree_lock *ldiskfs_htree_lock_alloc(void)
 182 {
 183         return (struct htree_lock *)LDISKFS_DUMMY_HTREE_LOCK;
 184 }
 185
 186 static inline void ldiskfs_htree_lock_free(struct htree_lock *lk)
 187 {
 188         LASSERT((unsigned long)lk == LDISKFS_DUMMY_HTREE_LOCK);
 189 }
 190
 191 #define HTREE_HBITS_DEF         0
 192
 193 #define osd_ldiskfs_find_entry(dir, dentry, de, lock)   \
 194         ll_ldiskfs_find_entry(dir, dentry, de)
 195 #define osd_ldiskfs_add_entry(handle, child, cinode, lock) \
 196         ldiskfs_add_entry(handle, child, cinode)
 197
 198 #endif /* HAVE_LDISKFS_PDO */
 199
 200 #define OSD_OTABLE_IT_CACHE_SIZE        128
 201 #define OSD_OTABLE_IT_CACHE_MASK        (~(OSD_OTABLE_IT_CACHE_SIZE - 1))
 202
 203 struct osd_inconsistent_item {
 204         /* link into osd_scrub::os_inconsistent_items,
 205          * protected by osd_scrub::os_lock. */
 206         cfs_list_t             oii_list;
 207
 208         /* The right FID <=> ino#/gen mapping. */
 209         struct osd_idmap_cache oii_cache;
 210
 211         unsigned int           oii_insert:1; /* insert or update mapping. */
 212 };
 213
 214 struct osd_otable_cache {
 215         struct osd_idmap_cache ooc_cache[OSD_OTABLE_IT_CACHE_SIZE];
 216
 217         /* Index for next cache slot to be filled. */
 218         int                    ooc_producer_idx;
 219
 220         /* Index for next cache slot to be returned by it::next(). */
 221         int                    ooc_consumer_idx;
 222
 223         /* How many items in ooc_cache. */
 224         int                    ooc_cached_items;
 225
 226         /* Position for up layer LFSCK iteration pre-loading. */
 227         __u32                  ooc_pos_preload;
 228 };
 229
 230 struct osd_otable_it {
 231         struct osd_device       *ooi_dev;
 232         struct osd_otable_cache  ooi_cache;
 233
 234         /* For osd_otable_it_key. */
 235         __u8                     ooi_key[16];
 236
 237         /* The following bits can be updated/checked w/o lock protection.
 238          * If more bits will be introduced in the future and need lock to
 239          * protect, please add comment. */
 240         unsigned long            ooi_used_outside:1, /* Some user out of OSD
 241                                                       * uses the iteration. */
 242                                  ooi_all_cached:1, /* No more entries can be
 243                                                     * filled into cache. */
 244                                  ooi_user_ready:1, /* The user out of OSD is
 245                                                     * ready to iterate. */
 246                                  ooi_waiting:1; /* it::next is waiting. */
 247 };
 248
 249 extern const int osd_dto_credits_noquota[];
 250
 251 /*
 252  * osd device.
 253  */
 254 struct osd_device {
 255         /* super-class */
 256         struct dt_device          od_dt_dev;
 257         /* information about underlying file system */
 258         struct vfsmount          *od_mnt;
 259         /* object index */
 260         struct osd_oi           **od_oi_table;
 261         /* total number of OI containers */
 262         int                       od_oi_count;
 263         /*
 264          * Fid Capability
 265          */
 266         unsigned int              od_fl_capa:1,
 267                                   od_is_md:1; /* set in ->ldo_prepare */
 268         unsigned long             od_capa_timeout;
 269         __u32                     od_capa_alg;
 270         struct lustre_capa_key   *od_capa_keys;
 271         cfs_hlist_head_t         *od_capa_hash;
 272
 273         cfs_proc_dir_entry_t     *od_proc_entry;
 274         struct lprocfs_stats     *od_stats;
 275         /*
 276          * statfs optimization: we cache a bit.
 277          */
 278         cfs_time_t                od_osfs_age;
 279         struct obd_statfs         od_statfs;
 280         cfs_spinlock_t            od_osfs_lock;
 281
 282         /**
 283          * The following flag indicates, if it is interop mode or not.
 284          * It will be initialized, using mount param.
 285          */
 286         __u32                     od_iop_mode;
 287
 288         struct fsfilt_operations *od_fsops;
 289         int                       od_connects;
 290         struct lu_site            od_site;
 291
 292         /*
 293          * mapping for legacy OST objids
 294          */
 295         struct osd_compat_objid  *od_ost_map;
 296
 297         unsigned long long        od_readcache_max_filesize;
 298         int                       od_read_cache;
 299         int                       od_writethrough_cache;
 300
 301         struct brw_stats          od_brw_stats;
 302         cfs_atomic_t              od_r_in_flight;
 303         cfs_atomic_t              od_w_in_flight;
 304
 305         cfs_mutex_t               od_otable_mutex;
 306         struct osd_otable_it     *od_otable_it;
 307         struct osd_scrub          od_scrub;
 308
 309         /* service name associated with the osd device */
 310         char                      od_svname[MAX_OBD_NAME];
 311
 312         /* quota slave instance */
 313         struct qsd_instance      *od_quota_slave;
 314 };
 315
 316 #define OSD_TRACK_DECLARES
 317 #ifdef OSD_TRACK_DECLARES
 318 #define OSD_DECLARE_OP(oh, op)   {                               \
 319         LASSERT(oh->ot_handle == NULL);                          \
 320         ((oh)->ot_declare_ ##op)++; }
 321 #define OSD_EXEC_OP(handle,op)      {                            \
 322         struct osd_thandle *oh;                                  \
 323         oh = container_of0(handle, struct osd_thandle, ot_super);\
 324         if (((oh)->ot_declare_ ##op) > 0) {                      \
 325                 ((oh)->ot_declare_ ##op)--;                      \
 326         }                                                        \
 327         }
 328 #else
 329 #define OSD_DECLARE_OP(oh, op)
 330 #define OSD_EXEC_OP(oh, op)
 331 #endif
 332
 333 /* There are at most 10 uid/gids are affected in a transaction, and
 334  * that's rename case:
 335  * - 2 for source parent uid & gid;
 336  * - 2 for source child uid & gid ('..' entry update when the child
 337  *   is directory);
 338  * - 2 for target parent uid & gid;
 339  * - 2 for target child uid & gid (if the target child exists);
 340  * - 2 for root uid & gid (last_rcvd, llog, etc);
 341  *
 342  * The 0 to (OSD_MAX_UGID_CNT - 1) bits of ot_id_type is for indicating
 343  * the id type of each id in the ot_id_array.
 344  */
 345 #define OSD_MAX_UGID_CNT        10
 346
 347 struct osd_thandle {
 348         struct thandle          ot_super;
 349         handle_t               *ot_handle;
 350         struct journal_callback ot_jcb;
 351         cfs_list_t              ot_dcb_list;
 352         /* Link to the device, for debugging. */
 353         struct lu_ref_link     *ot_dev_link;
 354         unsigned short          ot_credits;
 355         unsigned short          ot_id_cnt;
 356         unsigned short          ot_id_type;
 357         uid_t                   ot_id_array[OSD_MAX_UGID_CNT];
 358         struct lquota_trans    *ot_quota_trans;
 359
 360 #ifdef OSD_TRACK_DECLARES
 361         unsigned char           ot_declare_attr_set;
 362         unsigned char           ot_declare_punch;
 363         unsigned char           ot_declare_xattr_set;
 364         unsigned char           ot_declare_create;
 365         unsigned char           ot_declare_destroy;
 366         unsigned char           ot_declare_ref_add;
 367         unsigned char           ot_declare_ref_del;
 368         unsigned char           ot_declare_write;
 369         unsigned char           ot_declare_insert;
 370         unsigned char           ot_declare_delete;
 371 #endif
 372
 373 #if OSD_THANDLE_STATS
 374         /** time when this handle was allocated */
 375         cfs_time_t oth_alloced;
 376
 377         /** time when this thanle was started */
 378         cfs_time_t oth_started;
 379 #endif
 380 };
 381
 382 /**
 383  * Basic transaction credit op
 384  */
 385 enum dt_txn_op {
 386         DTO_INDEX_INSERT,
 387         DTO_INDEX_DELETE,
 388         DTO_INDEX_UPDATE,
 389         DTO_OBJECT_CREATE,
 390         DTO_OBJECT_DELETE,
 391         DTO_ATTR_SET_BASE,
 392         DTO_XATTR_SET,
 393         DTO_LOG_REC, /**< XXX temporary: dt layer knows nothing about llog. */
 394         DTO_WRITE_BASE,
 395         DTO_WRITE_BLOCK,
 396         DTO_ATTR_SET_CHOWN,
 397
 398         DTO_NR
 399 };
 400
 401 /*
 402  * osd dev stats
 403  */
 404
 405 #ifdef LPROCFS
 406 enum {
 407         LPROC_OSD_READ_BYTES    = 0,
 408         LPROC_OSD_WRITE_BYTES   = 1,
 409         LPROC_OSD_GET_PAGE      = 2,
 410         LPROC_OSD_NO_PAGE       = 3,
 411         LPROC_OSD_CACHE_ACCESS  = 4,
 412         LPROC_OSD_CACHE_HIT     = 5,
 413         LPROC_OSD_CACHE_MISS    = 6,
 414
 415 #if OSD_THANDLE_STATS
 416         LPROC_OSD_THANDLE_STARTING,
 417         LPROC_OSD_THANDLE_OPEN,
 418         LPROC_OSD_THANDLE_CLOSING,
 419 #endif
 420         LPROC_OSD_LAST,
 421 };
 422 #endif
 423
 424 /**
 425  * Storage representation for fids.
 426  *
 427  * Variable size, first byte contains the length of the whole record.
 428  */
 429 struct osd_fid_pack {
 430         unsigned char fp_len;
 431         char fp_area[sizeof(struct lu_fid)];
 432 };
 433
 434 struct osd_it_ea_dirent {
 435         struct lu_fid   oied_fid;
 436         __u64           oied_ino;
 437         __u64           oied_off;
 438         unsigned short  oied_namelen;
 439         unsigned int    oied_type;
 440         char            oied_name[0];
 441 } __attribute__((packed));
 442
 443 /**
 444  * as osd_it_ea_dirent (in memory dirent struct for osd) is greater
 445  * than lu_dirent struct. osd readdir reads less number of dirent than
 446  * required for mdd dir page. so buffer size need to be increased so that
 447  * there  would be one ext3 readdir for every mdd readdir page.
 448  */
 449
 450 #define OSD_IT_EA_BUFSIZE       (CFS_PAGE_SIZE + CFS_PAGE_SIZE/4)
 451
 452 /**
 453  * This is iterator's in-memory data structure in interoperability
 454  * mode (i.e. iterator over ldiskfs style directory)
 455  */
 456 struct osd_it_ea {
 457         struct osd_object   *oie_obj;
 458         /** used in ldiskfs iterator, to stored file pointer */
 459         struct file          oie_file;
 460         /** how many entries have been read-cached from storage */
 461         int                  oie_rd_dirent;
 462         /** current entry is being iterated by caller */
 463         int                  oie_it_dirent;
 464         /** current processing entry */
 465         struct osd_it_ea_dirent *oie_dirent;
 466         /** buffer to hold entries, size == OSD_IT_EA_BUFSIZE */
 467         void                *oie_buf;
 468 };
 469
 470 /**
 471  * Iterator's in-memory data structure for IAM mode.
 472  */
 473 struct osd_it_iam {
 474         struct osd_object     *oi_obj;
 475         struct iam_path_descr *oi_ipd;
 476         struct iam_iterator    oi_it;
 477 };
 478
 479 struct osd_quota_leaf {
 480         cfs_list_t      oql_link;
 481         uint            oql_blk;
 482 };
 483
 484 /**
 485  * Iterator's in-memory data structure for quota file.
 486  */
 487 struct osd_it_quota {
 488         struct osd_object       *oiq_obj;
 489         /** tree blocks path to where the entry is stored */
 490         uint                     oiq_blk[LUSTRE_DQTREEDEPTH + 1];
 491         /** on-disk offset for current key where quota record can be found */
 492         loff_t                   oiq_offset;
 493         /** identifier for current quota record */
 494         __u64                    oiq_id;
 495         /** the record index in the leaf/index block */
 496         uint                     oiq_index[LUSTRE_DQTREEDEPTH + 1];
 497         /** list of already processed leaf blocks */
 498         cfs_list_t               oiq_list;
 499 };
 500
 501 #define MAX_BLOCKS_PER_PAGE (CFS_PAGE_SIZE / 512)
 502
 503 struct osd_iobuf {
 504         cfs_waitq_t        dr_wait;
 505         cfs_atomic_t       dr_numreqs;  /* number of reqs being processed */
 506         int                dr_max_pages;
 507         int                dr_npages;
 508         int                dr_error;
 509         int                dr_frags;
 510         unsigned int       dr_ignore_quota:1;
 511         unsigned int       dr_elapsed_valid:1; /* we really did count time */
 512         unsigned int       dr_rw:1;
 513         struct page       *dr_pages[PTLRPC_MAX_BRW_PAGES];
 514         unsigned long      dr_blocks[PTLRPC_MAX_BRW_PAGES*MAX_BLOCKS_PER_PAGE];
 515         unsigned long      dr_start_time;
 516         unsigned long      dr_elapsed;  /* how long io took */
 517         struct osd_device *dr_dev;
 518 };
 519
 520 struct osd_thread_info {
 521         const struct lu_env   *oti_env;
 522         /**
 523          * used for index operations.
 524          */
 525         struct dentry          oti_obj_dentry;
 526         struct dentry          oti_child_dentry;
 527
 528         /** dentry for Iterator context. */
 529         struct dentry          oti_it_dentry;
 530         struct htree_lock     *oti_hlock;
 531
 532         struct lu_fid          oti_fid;
 533         struct lu_fid          oti_fid2;
 534         struct osd_inode_id    oti_id;
 535         struct osd_inode_id    oti_id2;
 536         struct ost_id          oti_ostid;
 537
 538         /*
 539          * XXX temporary: for ->i_op calls.
 540          */
 541         struct timespec        oti_time;
 542         /*
 543          * XXX temporary: fake struct file for osd_object_sync
 544          */
 545         struct file            oti_file;
 546         /*
 547          * XXX temporary: for capa operations.
 548          */
 549         struct lustre_capa_key oti_capa_key;
 550         struct lustre_capa     oti_capa;
 551
 552         /** osd_device reference, initialized in osd_trans_start() and
 553             used in osd_trans_stop() */
 554         struct osd_device     *oti_dev;
 555
 556         /**
 557          * following ipd and it structures are used for osd_index_iam_lookup()
 558          * these are defined separately as we might do index operation
 559          * in open iterator session.
 560          */
 561
 562         /** osd iterator context used for iterator session */
 563
 564         union {
 565                 struct osd_it_iam       oti_it;
 566                 /* ldiskfs iterator data structure,
 567                  * see osd_it_ea_{init, fini} */
 568                 struct osd_it_ea        oti_it_ea;
 569                 struct osd_it_quota     oti_it_quota;
 570         };
 571
 572         /** pre-allocated buffer used by oti_it_ea, size OSD_IT_EA_BUFSIZE */
 573         void                  *oti_it_ea_buf;
 574
 575         cfs_kstatfs_t          oti_ksfs;
 576
 577         /** IAM iterator for index operation. */
 578         struct iam_iterator    oti_idx_it;
 579
 580         /** union to guarantee that ->oti_ipd[] has proper alignment. */
 581         union {
 582                 char           oti_it_ipd[DX_IPD_MAX_SIZE];
 583                 long long      oti_alignment_lieutenant;
 584         };
 585
 586         union {
 587                 char           oti_idx_ipd[DX_IPD_MAX_SIZE];
 588                 long long      oti_alignment_lieutenant_colonel;
 589         };
 590
 591         struct osd_idmap_cache oti_cache;
 592
 593         int                    oti_r_locks;
 594         int                    oti_w_locks;
 595         int                    oti_txns;
 596         /** used in osd_fid_set() to put xattr */
 597         struct lu_buf          oti_buf;
 598         /** used in osd_ea_fid_set() to set fid into common ea */
 599         struct lustre_mdt_attrs oti_mdt_attrs;
 600         /** 0-copy IO */
 601         struct osd_iobuf       oti_iobuf;
 602         struct inode           oti_inode;
 603         int                    oti_created[PTLRPC_MAX_BRW_PAGES];
 604 #ifdef HAVE_QUOTA_SUPPORT
 605         struct osd_ctxt        oti_ctxt;
 606 #endif
 607         struct lu_env          oti_obj_delete_tx_env;
 608 #define OSD_FID_REC_SZ 32
 609         char                   oti_ldp[OSD_FID_REC_SZ];
 610         char                   oti_ldp2[OSD_FID_REC_SZ];
 611
 612         /* used by quota code */
 613         union {
 614                 struct if_dqblk         oti_dqblk;
 615                 struct if_dqinfo        oti_dqinfo;
 616         };
 617         struct lquota_id_info   oti_qi;
 618         struct lquota_trans     oti_quota_trans;
 619         union lquota_rec        oti_quota_rec;
 620         __u64                   oti_quota_id;
 621 };
 622
 623 extern int ldiskfs_pdo;
 624
 625 #ifdef LPROCFS
 626 /* osd_lproc.c */
 627 void lprocfs_osd_init_vars(struct lprocfs_static_vars *lvars);
 628 int osd_procfs_init(struct osd_device *osd, const char *name);
 629 int osd_procfs_fini(struct osd_device *osd);
 630 void osd_lprocfs_time_start(const struct lu_env *env);
 631 void osd_lprocfs_time_end(const struct lu_env *env,
 632                           struct osd_device *osd, int op);
 633 void osd_brw_stats_update(struct osd_device *osd, struct osd_iobuf *iobuf);
 634
 635 #endif
 636 int osd_statfs(const struct lu_env *env, struct dt_device *dev,
 637                struct obd_statfs *sfs);
 638 int osd_object_auth(const struct lu_env *env, struct dt_object *dt,
 639                     struct lustre_capa *capa, __u64 opc);
 640 struct inode *osd_iget(struct osd_thread_info *info, struct osd_device *dev,
 641                        struct osd_inode_id *id);
 642 struct inode *osd_iget_fid(struct osd_thread_info *info, struct osd_device *dev,
 643                            struct osd_inode_id *id, struct lu_fid *fid);
 644
 645 int osd_compat_init(struct osd_device *dev);
 646 void osd_compat_fini(struct osd_device *dev);
 647 int osd_compat_objid_lookup(struct osd_thread_info *info,
 648                             struct osd_device *osd,
 649                             const struct lu_fid *fid, struct osd_inode_id *id);
 650 int osd_compat_objid_insert(struct osd_thread_info *info,
 651                             struct osd_device *osd,
 652                             const struct lu_fid *fid,
 653                             const struct osd_inode_id *id, struct thandle *th);
 654 int osd_compat_objid_delete(struct osd_thread_info *info,
 655                             struct osd_device *osd,
 656                             const struct lu_fid *fid, struct thandle *th);
 657 int osd_compat_spec_lookup(struct osd_thread_info *info,
 658                            struct osd_device *osd,
 659                            const struct lu_fid *fid, struct osd_inode_id *id);
 660 int osd_compat_spec_insert(struct osd_thread_info *info,
 661                            struct osd_device *osd,
 662                            const struct lu_fid *fid,
 663                            const struct osd_inode_id *id, struct thandle *th);
 664
 665 void osd_scrub_file_reset(struct osd_scrub *scrub, __u8 *uuid, __u64 flags);
 666 int osd_scrub_file_store(struct osd_scrub *scrub);
 667 int osd_scrub_start(struct osd_device *dev);
 668 int osd_scrub_setup(const struct lu_env *env, struct osd_device *dev);
 669 void osd_scrub_cleanup(const struct lu_env *env, struct osd_device *dev);
 670 int osd_oii_insert(struct osd_device *dev, struct osd_idmap_cache *oic,
 671                    int insert);
 672 int osd_oii_lookup(struct osd_device *dev, const struct lu_fid *fid,
 673                    struct osd_inode_id *id);
 674 int osd_scrub_dump(struct osd_device *dev, char *buf, int len);
 675
 676 /* osd_quota_fmt.c */
 677 int walk_tree_dqentry(const struct lu_env *env, struct osd_object *obj,
 678                       int type, uint blk, int depth, uint index,
 679                       struct osd_it_quota *it);
 680 int walk_block_dqentry(const struct lu_env *env, struct osd_object *obj,
 681                        int type, uint blk, uint index,
 682                        struct osd_it_quota *it);
 683 loff_t find_tree_dqentry(const struct lu_env *env,
 684                          struct osd_object *obj, int type,
 685                          qid_t dqid, uint blk, int depth,
 686                          struct osd_it_quota *it);
 687 /* osd_quota.c */
 688 int osd_declare_qid(const struct lu_env *env, struct osd_thandle *oh,
 689                     struct lquota_id_info *qi, bool allocated, int *flags);
 690 int osd_declare_inode_qid(const struct lu_env *env, qid_t uid, qid_t gid,
 691                           long long space, struct osd_thandle *oh,
 692                           bool is_blk, bool allocated, int *flags, bool force);
 693 const struct dt_rec *osd_quota_pack(struct osd_object *obj,
 694                                     const struct dt_rec *rec,
 695                                     union lquota_rec *quota_rec);
 696 void osd_quota_unpack(struct osd_object *obj, const struct dt_rec *rec);
 697 int osd_quota_migration(const struct lu_env *env, struct dt_object *dt,
 698                         const struct dt_index_features *feat);
 699
 700 static inline bool is_quota_glb_feat(const struct dt_index_features *feat)
 701 {
 702         return (feat == &dt_quota_iusr_features ||
 703                 feat == &dt_quota_busr_features ||
 704                 feat == &dt_quota_igrp_features ||
 705                 feat == &dt_quota_bgrp_features) ? true : false;
 706 }
 707
 708 /*
 709  * Invariants, assertions.
 710  */
 711
 712 /*
 713  * XXX: do not enable this, until invariant checking code is made thread safe
 714  * in the face of pdirops locking.
 715  */
 716 #define OSD_INVARIANT_CHECKS (0)
 717
 718 #if OSD_INVARIANT_CHECKS
 719 static inline int osd_invariant(const struct osd_object *obj)
 720 {
 721         return
 722                 obj != NULL &&
 723                 ergo(obj->oo_inode != NULL,
 724                      obj->oo_inode->i_sb == osd_sb(osd_obj2dev(obj)) &&
 725                      atomic_read(&obj->oo_inode->i_count) > 0) &&
 726                 ergo(obj->oo_dir != NULL &&
 727                      obj->oo_dir->od_conationer.ic_object != NULL,
 728                      obj->oo_dir->od_conationer.ic_object == obj->oo_inode);
 729 }
 730 #else
 731 #define osd_invariant(obj) (1)
 732 #endif
 733
 734 extern const struct dt_index_operations osd_otable_ops;
 735
 736 static inline int osd_oi_fid2idx(struct osd_device *dev,
 737                                  const struct lu_fid *fid)
 738 {
 739         return fid->f_seq & (dev->od_oi_count - 1);
 740 }
 741
 742 static inline struct osd_oi *osd_fid2oi(struct osd_device *osd,
 743                                         const struct lu_fid *fid)
 744 {
 745         LASSERTF(!fid_is_idif(fid), DFID"\n", PFID(fid));
 746         LASSERTF(!fid_is_igif(fid), DFID"\n", PFID(fid));
 747         LASSERT(osd->od_oi_table != NULL && osd->od_oi_count >= 1);
 748         /* It can work even od_oi_count equals to 1 although it's unexpected,
 749          * the only reason we set it to 1 is for performance measurement */
 750         return osd->od_oi_table[osd_oi_fid2idx(osd, fid)];
 751 }
 752
 753 extern const struct lu_device_operations  osd_lu_ops;
 754
 755 static inline int lu_device_is_osd(const struct lu_device *d)
 756 {
 757         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
 758 }
 759
 760 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
 761 {
 762         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
 763         return container_of0(d, struct osd_device, od_dt_dev);
 764 }
 765
 766 static inline struct osd_device *osd_dev(const struct lu_device *d)
 767 {
 768         LASSERT(lu_device_is_osd(d));
 769         return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
 770 }
 771
 772 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
 773 {
 774         return osd_dev(o->oo_dt.do_lu.lo_dev);
 775 }
 776
 777 static inline struct super_block *osd_sb(const struct osd_device *dev)
 778 {
 779         return dev->od_mnt->mnt_sb;
 780 }
 781
 782 static inline int osd_object_is_root(const struct osd_object *obj)
 783 {
 784         return osd_sb(osd_obj2dev(obj))->s_root->d_inode == obj->oo_inode;
 785 }
 786
 787 static inline struct osd_object *osd_obj(const struct lu_object *o)
 788 {
 789         LASSERT(lu_device_is_osd(o->lo_dev));
 790         return container_of0(o, struct osd_object, oo_dt.do_lu);
 791 }
 792
 793 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
 794 {
 795         return osd_obj(&d->do_lu);
 796 }
 797
 798 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
 799 {
 800         return &osd->od_dt_dev.dd_lu_dev;
 801 }
 802
 803 static inline journal_t *osd_journal(const struct osd_device *dev)
 804 {
 805         return LDISKFS_SB(osd_sb(dev))->s_journal;
 806 }
 807
 808 extern const struct dt_body_operations osd_body_ops;
 809 extern struct lu_context_key osd_key;
 810
 811 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
 812 {
 813         return lu_context_key_get(&env->le_ctx, &osd_key);
 814 }
 815
 816 extern const struct dt_body_operations osd_body_ops_new;
 817
 818 /**
 819  * IAM Iterator
 820  */
 821 static inline
 822 struct iam_path_descr *osd_it_ipd_get(const struct lu_env *env,
 823                                       const struct iam_container *bag)
 824 {
 825         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
 826                                            osd_oti_get(env)->oti_it_ipd);
 827 }
 828
 829 static inline
 830 struct iam_path_descr *osd_idx_ipd_get(const struct lu_env *env,
 831                                        const struct iam_container *bag)
 832 {
 833         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
 834                                            osd_oti_get(env)->oti_idx_ipd);
 835 }
 836
 837 static inline void osd_ipd_put(const struct lu_env *env,
 838                                const struct iam_container *bag,
 839                                struct iam_path_descr *ipd)
 840 {
 841         bag->ic_descr->id_ops->id_ipd_free(ipd);
 842 }
 843
 844 int osd_ldiskfs_read(struct inode *inode, void *buf, int size, loff_t *offs);
 845 int osd_ldiskfs_write_record(struct inode *inode, void *buf, int bufsize,
 846                              int write_NUL, loff_t *offs, handle_t *handle);
 847
 848 static inline
 849 struct dentry *osd_child_dentry_by_inode(const struct lu_env *env,
 850                                          struct inode *inode,
 851                                          const char *name, const int namelen)
 852 {
 853         struct osd_thread_info *info = osd_oti_get(env);
 854         struct dentry *child_dentry = &info->oti_child_dentry;
 855         struct dentry *obj_dentry = &info->oti_obj_dentry;
 856
 857         obj_dentry->d_inode = inode;
 858         obj_dentry->d_sb = inode->i_sb;
 859         obj_dentry->d_name.hash = 0;
 860
 861         child_dentry->d_name.hash = 0;
 862         child_dentry->d_parent = obj_dentry;
 863         child_dentry->d_name.name = name;
 864         child_dentry->d_name.len = namelen;
 865         return child_dentry;
 866 }
 867
 868 /**
 869  * Helper function to pack the fid, ldiskfs stores fid in packed format.
 870  */
 871 static inline
 872 void osd_fid_pack(struct osd_fid_pack *pack, const struct dt_rec *fid,
 873                   struct lu_fid *befider)
 874 {
 875         fid_cpu_to_be(befider, (struct lu_fid *)fid);
 876         memcpy(pack->fp_area, befider, sizeof(*befider));
 877         pack->fp_len =  sizeof(*befider) + 1;
 878 }
 879
 880 static inline
 881 int osd_fid_unpack(struct lu_fid *fid, const struct osd_fid_pack *pack)
 882 {
 883         int result;
 884
 885         result = 0;
 886         switch (pack->fp_len) {
 887         case sizeof *fid + 1:
 888                 memcpy(fid, pack->fp_area, sizeof *fid);
 889                 fid_be_to_cpu(fid, fid);
 890                 break;
 891         default:
 892                 CERROR("Unexpected packed fid size: %d\n", pack->fp_len);
 893                 result = -EIO;
 894         }
 895         return result;
 896 }
 897
 898 /**
 899  * Quota/Accounting handling
 900  */
 901 extern const struct dt_index_operations osd_acct_index_ops;
 902 int osd_acct_obj_lookup(struct osd_thread_info *info, struct osd_device *osd,
 903                         const struct lu_fid *fid, struct osd_inode_id *id);
 904
 905 /* copy from fs/ext4/dir.c */
 906 static inline int is_32bit_api(void)
 907 {
 908 #ifdef CONFIG_COMPAT
 909         return is_compat_task();
 910 #else
 911         return (BITS_PER_LONG == 32);
 912 #endif
 913 }
 914
 915 static inline loff_t ldiskfs_get_htree_eof(struct file *filp)
 916 {
 917         if ((filp->f_mode & FMODE_32BITHASH) ||
 918             (!(filp->f_mode & FMODE_64BITHASH) && is_32bit_api()))
 919                 return LDISKFS_HTREE_EOF_32BIT;
 920         else
 921                 return LDISKFS_HTREE_EOF_64BIT;
 922 }
 923
 924 #endif /* __KERNEL__ */
 925 #endif /* _OSD_INTERNAL_H */