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