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