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