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 /* There are at most 10 uid/gids are affected in a transaction, and
 276  * that's rename case:
 277  * - 2 for source parent uid & gid;
 278  * - 2 for source child uid & gid ('..' entry update when child is directory);
 279  * - 2 for target parent uid & gid;
 280  * - 2 for target child uid & gid (if the target child exists);
 281  * - 2 for root uid & gid (last_rcvd, llog, etc);
 282  *
 283  * The 0 to (OSD_MAX_UGID_CNT - 1) bits of ot_id_type is for indicating
 284  * the id type of each id in the ot_id_array.
 285  */
 286 #define OSD_MAX_UGID_CNT        10
 287
 288 enum {
 289         OSD_OT_ATTR_SET         = 0,
 290         OSD_OT_PUNCH            = 1,
 291         OSD_OT_XATTR_SET        = 2,
 292         OSD_OT_CREATE           = 3,
 293         OSD_OT_DESTROY          = 4,
 294         OSD_OT_REF_ADD          = 5,
 295         OSD_OT_REF_DEL          = 6,
 296         OSD_OT_WRITE            = 7,
 297         OSD_OT_INSERT           = 8,
 298         OSD_OT_DELETE           = 9,
 299         OSD_OT_QUOTA            = 10,
 300         OSD_OT_MAX              = 11
 301 };
 302
 303 #define OSD_TRACK_DECLARES
 304
 305 struct osd_thandle {
 306         struct thandle          ot_super;
 307         handle_t               *ot_handle;
 308         struct journal_callback ot_jcb;
 309         cfs_list_t              ot_dcb_list;
 310         /* Link to the device, for debugging. */
 311         struct lu_ref_link     *ot_dev_link;
 312         unsigned short          ot_credits;
 313         unsigned short          ot_id_cnt;
 314         unsigned short          ot_id_type;
 315         uid_t                   ot_id_array[OSD_MAX_UGID_CNT];
 316         struct lquota_trans    *ot_quota_trans;
 317 #if OSD_THANDLE_STATS
 318         /** time when this handle was allocated */
 319         cfs_time_t oth_alloced;
 320
 321         /** time when this thanle was started */
 322         cfs_time_t oth_started;
 323 #endif
 324 };
 325
 326 /**
 327  * Basic transaction credit op
 328  */
 329 enum dt_txn_op {
 330         DTO_INDEX_INSERT,
 331         DTO_INDEX_DELETE,
 332         DTO_INDEX_UPDATE,
 333         DTO_OBJECT_CREATE,
 334         DTO_OBJECT_DELETE,
 335         DTO_ATTR_SET_BASE,
 336         DTO_XATTR_SET,
 337         DTO_LOG_REC, /**< XXX temporary: dt layer knows nothing about llog. */
 338         DTO_WRITE_BASE,
 339         DTO_WRITE_BLOCK,
 340         DTO_ATTR_SET_CHOWN,
 341
 342         DTO_NR
 343 };
 344
 345 /*
 346  * osd dev stats
 347  */
 348
 349 #ifdef LPROCFS
 350 enum {
 351         LPROC_OSD_READ_BYTES    = 0,
 352         LPROC_OSD_WRITE_BYTES   = 1,
 353         LPROC_OSD_GET_PAGE      = 2,
 354         LPROC_OSD_NO_PAGE       = 3,
 355         LPROC_OSD_CACHE_ACCESS  = 4,
 356         LPROC_OSD_CACHE_HIT     = 5,
 357         LPROC_OSD_CACHE_MISS    = 6,
 358
 359 #if OSD_THANDLE_STATS
 360         LPROC_OSD_THANDLE_STARTING,
 361         LPROC_OSD_THANDLE_OPEN,
 362         LPROC_OSD_THANDLE_CLOSING,
 363 #endif
 364         LPROC_OSD_LAST,
 365 };
 366 #endif
 367
 368 /**
 369  * Storage representation for fids.
 370  *
 371  * Variable size, first byte contains the length of the whole record.
 372  */
 373 struct osd_fid_pack {
 374         unsigned char fp_len;
 375         char fp_area[sizeof(struct lu_fid)];
 376 };
 377
 378 struct osd_it_ea_dirent {
 379         struct lu_fid   oied_fid;
 380         __u64           oied_ino;
 381         __u64           oied_off;
 382         unsigned short  oied_namelen;
 383         unsigned int    oied_type;
 384         char            oied_name[0];
 385 } __attribute__((packed));
 386
 387 /**
 388  * as osd_it_ea_dirent (in memory dirent struct for osd) is greater
 389  * than lu_dirent struct. osd readdir reads less number of dirent than
 390  * required for mdd dir page. so buffer size need to be increased so that
 391  * there  would be one ext3 readdir for every mdd readdir page.
 392  */
 393
 394 #define OSD_IT_EA_BUFSIZE       (CFS_PAGE_SIZE + CFS_PAGE_SIZE/4)
 395
 396 /**
 397  * This is iterator's in-memory data structure in interoperability
 398  * mode (i.e. iterator over ldiskfs style directory)
 399  */
 400 struct osd_it_ea {
 401         struct osd_object   *oie_obj;
 402         /** used in ldiskfs iterator, to stored file pointer */
 403         struct file          oie_file;
 404         /** how many entries have been read-cached from storage */
 405         int                  oie_rd_dirent;
 406         /** current entry is being iterated by caller */
 407         int                  oie_it_dirent;
 408         /** current processing entry */
 409         struct osd_it_ea_dirent *oie_dirent;
 410         /** buffer to hold entries, size == OSD_IT_EA_BUFSIZE */
 411         void                *oie_buf;
 412 };
 413
 414 /**
 415  * Iterator's in-memory data structure for IAM mode.
 416  */
 417 struct osd_it_iam {
 418         struct osd_object     *oi_obj;
 419         struct iam_path_descr *oi_ipd;
 420         struct iam_iterator    oi_it;
 421 };
 422
 423 struct osd_quota_leaf {
 424         cfs_list_t      oql_link;
 425         uint            oql_blk;
 426 };
 427
 428 /**
 429  * Iterator's in-memory data structure for quota file.
 430  */
 431 struct osd_it_quota {
 432         struct osd_object       *oiq_obj;
 433         /** tree blocks path to where the entry is stored */
 434         uint                     oiq_blk[LUSTRE_DQTREEDEPTH + 1];
 435         /** on-disk offset for current key where quota record can be found */
 436         loff_t                   oiq_offset;
 437         /** identifier for current quota record */
 438         __u64                    oiq_id;
 439         /** the record index in the leaf/index block */
 440         uint                     oiq_index[LUSTRE_DQTREEDEPTH + 1];
 441         /** list of already processed leaf blocks */
 442         cfs_list_t               oiq_list;
 443 };
 444
 445 #define MAX_BLOCKS_PER_PAGE (CFS_PAGE_SIZE / 512)
 446
 447 struct osd_iobuf {
 448         cfs_waitq_t        dr_wait;
 449         cfs_atomic_t       dr_numreqs;  /* number of reqs being processed */
 450         int                dr_max_pages;
 451         int                dr_npages;
 452         int                dr_error;
 453         int                dr_frags;
 454         unsigned int       dr_ignore_quota:1;
 455         unsigned int       dr_elapsed_valid:1; /* we really did count time */
 456         unsigned int       dr_rw:1;
 457         struct page       *dr_pages[PTLRPC_MAX_BRW_PAGES];
 458         unsigned long      dr_blocks[PTLRPC_MAX_BRW_PAGES*MAX_BLOCKS_PER_PAGE];
 459         unsigned long      dr_start_time;
 460         unsigned long      dr_elapsed;  /* how long io took */
 461         struct osd_device *dr_dev;
 462         unsigned int       dr_init_at;  /* the line iobuf was initialized */
 463 };
 464
 465 struct osd_thread_info {
 466         const struct lu_env   *oti_env;
 467         /**
 468          * used for index operations.
 469          */
 470         struct dentry          oti_obj_dentry;
 471         struct dentry          oti_child_dentry;
 472
 473         /** dentry for Iterator context. */
 474         struct dentry          oti_it_dentry;
 475         struct htree_lock     *oti_hlock;
 476
 477         struct lu_fid          oti_fid;
 478         struct lu_fid          oti_fid2;
 479         struct osd_inode_id    oti_id;
 480         struct osd_inode_id    oti_id2;
 481         struct ost_id          oti_ostid;
 482
 483         /*
 484          * XXX temporary: for ->i_op calls.
 485          */
 486         struct timespec        oti_time;
 487         /*
 488          * XXX temporary: fake struct file for osd_object_sync
 489          */
 490         struct file            oti_file;
 491         /*
 492          * XXX temporary: for capa operations.
 493          */
 494         struct lustre_capa_key oti_capa_key;
 495         struct lustre_capa     oti_capa;
 496
 497         /** osd_device reference, initialized in osd_trans_start() and
 498             used in osd_trans_stop() */
 499         struct osd_device     *oti_dev;
 500
 501         /**
 502          * following ipd and it structures are used for osd_index_iam_lookup()
 503          * these are defined separately as we might do index operation
 504          * in open iterator session.
 505          */
 506
 507         /** osd iterator context used for iterator session */
 508
 509         union {
 510                 struct osd_it_iam       oti_it;
 511                 /* ldiskfs iterator data structure,
 512                  * see osd_it_ea_{init, fini} */
 513                 struct osd_it_ea        oti_it_ea;
 514                 struct osd_it_quota     oti_it_quota;
 515         };
 516
 517         /** pre-allocated buffer used by oti_it_ea, size OSD_IT_EA_BUFSIZE */
 518         void                  *oti_it_ea_buf;
 519
 520         cfs_kstatfs_t          oti_ksfs;
 521
 522         /** IAM iterator for index operation. */
 523         struct iam_iterator    oti_idx_it;
 524
 525         /** union to guarantee that ->oti_ipd[] has proper alignment. */
 526         union {
 527                 char           oti_it_ipd[DX_IPD_MAX_SIZE];
 528                 long long      oti_alignment_lieutenant;
 529         };
 530
 531         union {
 532                 char           oti_idx_ipd[DX_IPD_MAX_SIZE];
 533                 long long      oti_alignment_lieutenant_colonel;
 534         };
 535
 536         struct osd_idmap_cache oti_cache;
 537
 538         int                    oti_r_locks;
 539         int                    oti_w_locks;
 540         int                    oti_txns;
 541         /** used in osd_fid_set() to put xattr */
 542         struct lu_buf          oti_buf;
 543         /** used in osd_ea_fid_set() to set fid into common ea */
 544         union {
 545                 struct lustre_mdt_attrs oti_mdt_attrs;
 546                 /* old LMA for compatibility */
 547                 char                    oti_mdt_attrs_old[LMA_OLD_SIZE];
 548         };
 549         /** 0-copy IO */
 550         struct osd_iobuf       oti_iobuf;
 551         struct inode           oti_inode;
 552         int                    oti_created[PTLRPC_MAX_BRW_PAGES];
 553         struct lu_env          oti_obj_delete_tx_env;
 554 #define OSD_FID_REC_SZ 32
 555         char                   oti_ldp[OSD_FID_REC_SZ];
 556         char                   oti_ldp2[OSD_FID_REC_SZ];
 557
 558         /* used by quota code */
 559         union {
 560                 struct if_dqblk         oti_dqblk;
 561                 struct if_dqinfo        oti_dqinfo;
 562         };
 563         struct lquota_id_info   oti_qi;
 564         struct lquota_trans     oti_quota_trans;
 565         union lquota_rec        oti_quota_rec;
 566         __u64                   oti_quota_id;
 567         struct lu_seq_range     oti_seq_range;
 568
 569 #ifdef OSD_TRACK_DECLARES
 570         /* Tracking for transaction credits, to allow debugging and optimizing
 571          * cases where a large number of credits are being allocated for
 572          * single transaction. */
 573         unsigned char           oti_declare_ops[OSD_OT_MAX];
 574         unsigned char           oti_declare_ops_rb[OSD_OT_MAX];
 575         unsigned short          oti_declare_ops_cred[OSD_OT_MAX];
 576         bool                    oti_rollback;
 577 #endif
 578
 579 };
 580
 581 extern int ldiskfs_pdo;
 582
 583 #ifdef LPROCFS
 584 /* osd_lproc.c */
 585 void lprocfs_osd_init_vars(struct lprocfs_static_vars *lvars);
 586 int osd_procfs_init(struct osd_device *osd, const char *name);
 587 int osd_procfs_fini(struct osd_device *osd);
 588 void osd_brw_stats_update(struct osd_device *osd, struct osd_iobuf *iobuf);
 589
 590 #endif
 591 int osd_statfs(const struct lu_env *env, struct dt_device *dev,
 592                struct obd_statfs *sfs);
 593 int osd_object_auth(const struct lu_env *env, struct dt_object *dt,
 594                     struct lustre_capa *capa, __u64 opc);
 595 struct inode *osd_iget(struct osd_thread_info *info, struct osd_device *dev,
 596                        struct osd_inode_id *id);
 597 struct inode *osd_iget_fid(struct osd_thread_info *info, struct osd_device *dev,
 598                            struct osd_inode_id *id, struct lu_fid *fid);
 599
 600 int osd_obj_map_init(struct osd_device *osd);
 601 void osd_obj_map_fini(struct osd_device *dev);
 602 int osd_obj_map_lookup(struct osd_thread_info *info, struct osd_device *osd,
 603                         const struct lu_fid *fid, struct osd_inode_id *id);
 604 int osd_obj_map_insert(struct osd_thread_info *info, struct osd_device *osd,
 605                        const struct lu_fid *fid, const struct osd_inode_id *id,
 606                        struct thandle *th);
 607 int osd_obj_map_delete(struct osd_thread_info *info, struct osd_device *osd,
 608                         const struct lu_fid *fid, struct thandle *th);
 609 int osd_obj_spec_lookup(struct osd_thread_info *info, struct osd_device *osd,
 610                         const struct lu_fid *fid, struct osd_inode_id *id);
 611 int osd_obj_spec_insert(struct osd_thread_info *info, struct osd_device *osd,
 612                         const struct lu_fid *fid, const struct osd_inode_id *id,
 613                         struct thandle *th);
 614
 615 void osd_scrub_file_reset(struct osd_scrub *scrub, __u8 *uuid, __u64 flags);
 616 int osd_scrub_file_store(struct osd_scrub *scrub);
 617 int osd_scrub_start(struct osd_device *dev);
 618 int osd_scrub_setup(const struct lu_env *env, struct osd_device *dev);
 619 void osd_scrub_cleanup(const struct lu_env *env, struct osd_device *dev);
 620 int osd_oii_insert(struct osd_device *dev, struct osd_idmap_cache *oic,
 621                    int insert);
 622 int osd_oii_lookup(struct osd_device *dev, const struct lu_fid *fid,
 623                    struct osd_inode_id *id);
 624 int osd_scrub_dump(struct osd_device *dev, char *buf, int len);
 625
 626 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
 627                    const struct lu_fid *fid, struct lu_seq_range *range);
 628 /* osd_quota_fmt.c */
 629 int walk_tree_dqentry(const struct lu_env *env, struct osd_object *obj,
 630                       int type, uint blk, int depth, uint index,
 631                       struct osd_it_quota *it);
 632 int walk_block_dqentry(const struct lu_env *env, struct osd_object *obj,
 633                        int type, uint blk, uint index,
 634                        struct osd_it_quota *it);
 635 loff_t find_tree_dqentry(const struct lu_env *env,
 636                          struct osd_object *obj, int type,
 637                          qid_t dqid, uint blk, int depth,
 638                          struct osd_it_quota *it);
 639 /* osd_quota.c */
 640 int osd_declare_qid(const struct lu_env *env, struct osd_thandle *oh,
 641                     struct lquota_id_info *qi, bool allocated, int *flags);
 642 int osd_declare_inode_qid(const struct lu_env *env, qid_t uid, qid_t gid,
 643                           long long space, struct osd_thandle *oh,
 644                           bool is_blk, bool allocated, int *flags, bool force);
 645 const struct dt_rec *osd_quota_pack(struct osd_object *obj,
 646                                     const struct dt_rec *rec,
 647                                     union lquota_rec *quota_rec);
 648 void osd_quota_unpack(struct osd_object *obj, const struct dt_rec *rec);
 649 int osd_quota_migration(const struct lu_env *env, struct dt_object *dt,
 650                         const struct dt_index_features *feat);
 651
 652 static inline bool is_quota_glb_feat(const struct dt_index_features *feat)
 653 {
 654         return (feat == &dt_quota_iusr_features ||
 655                 feat == &dt_quota_busr_features ||
 656                 feat == &dt_quota_igrp_features ||
 657                 feat == &dt_quota_bgrp_features) ? true : false;
 658 }
 659
 660 /*
 661  * Invariants, assertions.
 662  */
 663
 664 /*
 665  * XXX: do not enable this, until invariant checking code is made thread safe
 666  * in the face of pdirops locking.
 667  */
 668 #define OSD_INVARIANT_CHECKS (0)
 669
 670 #if OSD_INVARIANT_CHECKS
 671 static inline int osd_invariant(const struct osd_object *obj)
 672 {
 673         return
 674                 obj != NULL &&
 675                 ergo(obj->oo_inode != NULL,
 676                      obj->oo_inode->i_sb == osd_sb(osd_obj2dev(obj)) &&
 677                      atomic_read(&obj->oo_inode->i_count) > 0) &&
 678                 ergo(obj->oo_dir != NULL &&
 679                      obj->oo_dir->od_conationer.ic_object != NULL,
 680                      obj->oo_dir->od_conationer.ic_object == obj->oo_inode);
 681 }
 682 #else
 683 #define osd_invariant(obj) (1)
 684 #endif
 685
 686 #define OSD_MAX_CACHE_SIZE OBD_OBJECT_EOF
 687
 688 extern const struct dt_index_operations osd_otable_ops;
 689
 690 static inline int osd_oi_fid2idx(struct osd_device *dev,
 691                                  const struct lu_fid *fid)
 692 {
 693         return fid->f_seq & (dev->od_oi_count - 1);
 694 }
 695
 696 static inline struct osd_oi *osd_fid2oi(struct osd_device *osd,
 697                                         const struct lu_fid *fid)
 698 {
 699         LASSERTF(!fid_is_idif(fid), DFID"\n", PFID(fid));
 700         LASSERTF(!fid_is_last_id(fid), DFID"\n", PFID(fid));
 701         LASSERTF(!fid_is_igif(fid), DFID"\n", PFID(fid));
 702         LASSERT(osd->od_oi_table != NULL && osd->od_oi_count >= 1);
 703         /* It can work even od_oi_count equals to 1 although it's unexpected,
 704          * the only reason we set it to 1 is for performance measurement */
 705         return osd->od_oi_table[osd_oi_fid2idx(osd, fid)];
 706 }
 707
 708 extern const struct lu_device_operations  osd_lu_ops;
 709
 710 static inline int lu_device_is_osd(const struct lu_device *d)
 711 {
 712         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
 713 }
 714
 715 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
 716 {
 717         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
 718         return container_of0(d, struct osd_device, od_dt_dev);
 719 }
 720
 721 static inline struct osd_device *osd_dev(const struct lu_device *d)
 722 {
 723         LASSERT(lu_device_is_osd(d));
 724         return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
 725 }
 726
 727 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
 728 {
 729         return osd_dev(o->oo_dt.do_lu.lo_dev);
 730 }
 731
 732 static inline struct super_block *osd_sb(const struct osd_device *dev)
 733 {
 734         return dev->od_mnt->mnt_sb;
 735 }
 736
 737 static inline int osd_object_is_root(const struct osd_object *obj)
 738 {
 739         return osd_sb(osd_obj2dev(obj))->s_root->d_inode == obj->oo_inode;
 740 }
 741
 742 static inline struct osd_object *osd_obj(const struct lu_object *o)
 743 {
 744         LASSERT(lu_device_is_osd(o->lo_dev));
 745         return container_of0(o, struct osd_object, oo_dt.do_lu);
 746 }
 747
 748 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
 749 {
 750         return osd_obj(&d->do_lu);
 751 }
 752
 753 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
 754 {
 755         return &osd->od_dt_dev.dd_lu_dev;
 756 }
 757
 758 static inline journal_t *osd_journal(const struct osd_device *dev)
 759 {
 760         return LDISKFS_SB(osd_sb(dev))->s_journal;
 761 }
 762
 763 static inline struct seq_server_site *osd_seq_site(struct osd_device *osd)
 764 {
 765         return osd->od_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
 766 }
 767
 768 static inline char *osd_name(struct osd_device *osd)
 769 {
 770         return osd->od_dt_dev.dd_lu_dev.ld_obd->obd_name;
 771 }
 772
 773
 774 extern const struct dt_body_operations osd_body_ops;
 775 extern struct lu_context_key osd_key;
 776
 777 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
 778 {
 779         return lu_context_key_get(&env->le_ctx, &osd_key);
 780 }
 781
 782 extern const struct dt_body_operations osd_body_ops_new;
 783
 784 /**
 785  * IAM Iterator
 786  */
 787 static inline
 788 struct iam_path_descr *osd_it_ipd_get(const struct lu_env *env,
 789                                       const struct iam_container *bag)
 790 {
 791         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
 792                                            osd_oti_get(env)->oti_it_ipd);
 793 }
 794
 795 static inline
 796 struct iam_path_descr *osd_idx_ipd_get(const struct lu_env *env,
 797                                        const struct iam_container *bag)
 798 {
 799         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
 800                                            osd_oti_get(env)->oti_idx_ipd);
 801 }
 802
 803 static inline void osd_ipd_put(const struct lu_env *env,
 804                                const struct iam_container *bag,
 805                                struct iam_path_descr *ipd)
 806 {
 807         bag->ic_descr->id_ops->id_ipd_free(ipd);
 808 }
 809
 810 int osd_ldiskfs_read(struct inode *inode, void *buf, int size, loff_t *offs);
 811 int osd_ldiskfs_write_record(struct inode *inode, void *buf, int bufsize,
 812                              int write_NUL, loff_t *offs, handle_t *handle);
 813
 814 static inline
 815 struct dentry *osd_child_dentry_by_inode(const struct lu_env *env,
 816                                          struct inode *inode,
 817                                          const char *name, const int namelen)
 818 {
 819         struct osd_thread_info *info = osd_oti_get(env);
 820         struct dentry *child_dentry = &info->oti_child_dentry;
 821         struct dentry *obj_dentry = &info->oti_obj_dentry;
 822
 823         obj_dentry->d_inode = inode;
 824         obj_dentry->d_sb = inode->i_sb;
 825         obj_dentry->d_name.hash = 0;
 826
 827         child_dentry->d_name.hash = 0;
 828         child_dentry->d_parent = obj_dentry;
 829         child_dentry->d_name.name = name;
 830         child_dentry->d_name.len = namelen;
 831         return child_dentry;
 832 }
 833
 834 #ifdef OSD_TRACK_DECLARES
 835 extern int osd_trans_declare_op2rb[];
 836
 837 static inline void osd_trans_declare_op(const struct lu_env *env,
 838                                         struct osd_thandle *oh,
 839                                         unsigned int op, int credits)
 840 {
 841         struct osd_thread_info *oti = osd_oti_get(env);
 842
 843         LASSERT(oh->ot_handle == NULL);
 844         LASSERT(op < OSD_OT_MAX);
 845
 846         oti->oti_declare_ops[op]++;
 847         oti->oti_declare_ops_cred[op] += credits;
 848         oh->ot_credits += credits;
 849 }
 850
 851 static inline void osd_trans_exec_op(const struct lu_env *env,
 852                                      struct thandle *th, unsigned int op)
 853 {
 854         struct osd_thread_info *oti = osd_oti_get(env);
 855         struct osd_thandle     *oh  = container_of(th, struct osd_thandle,
 856                                                    ot_super);
 857         unsigned int            rb;
 858
 859         LASSERT(oh->ot_handle != NULL);
 860         LASSERT(op < OSD_OT_MAX);
 861
 862         if (likely(!oti->oti_rollback && oti->oti_declare_ops[op] > 0)) {
 863                 oti->oti_declare_ops[op]--;
 864                 oti->oti_declare_ops_rb[op]++;
 865         } else {
 866                 /* all future updates are considered rollback */
 867                 oti->oti_rollback = true;
 868                 rb = osd_trans_declare_op2rb[op];
 869                 LASSERTF(rb < OSD_OT_MAX, "op = %u\n", op);
 870                 LASSERTF(oti->oti_declare_ops_rb[rb] > 0, "rb = %u\n", rb);
 871                 oti->oti_declare_ops_rb[rb]--;
 872         }
 873 }
 874
 875 static inline void osd_trans_declare_rb(const struct lu_env *env,
 876                                         struct thandle *th, unsigned int op)
 877 {
 878         struct osd_thread_info *oti = osd_oti_get(env);
 879         struct osd_thandle     *oh  = container_of(th, struct osd_thandle,
 880                                                    ot_super);
 881
 882         LASSERT(oh->ot_handle != NULL);
 883         LASSERT(op < OSD_OT_MAX);
 884
 885         oti->oti_declare_ops_rb[op]++;
 886 }
 887 #else
 888 static inline void osd_trans_declare_op(const struct lu_env *env,
 889                                         struct osd_thandle *oh,
 890                                         unsigned int op, int credits)
 891 {
 892         oh->ot_credits += credits;
 893 }
 894
 895 static inline void osd_trans_exec_op(const struct lu_env *env,
 896                                      struct thandle *th, unsigned int op)
 897 {
 898 }
 899
 900 static inline void osd_trans_declare_rb(const struct lu_env *env,
 901                                         struct thandle *th, unsigned int op)
 902 {
 903 }
 904 #endif
 905
 906 /**
 907  * Helper function to pack the fid, ldiskfs stores fid in packed format.
 908  */
 909 static inline
 910 void osd_fid_pack(struct osd_fid_pack *pack, const struct dt_rec *fid,
 911                   struct lu_fid *befider)
 912 {
 913         fid_cpu_to_be(befider, (struct lu_fid *)fid);
 914         memcpy(pack->fp_area, befider, sizeof(*befider));
 915         pack->fp_len =  sizeof(*befider) + 1;
 916 }
 917
 918 static inline
 919 int osd_fid_unpack(struct lu_fid *fid, const struct osd_fid_pack *pack)
 920 {
 921         int result;
 922
 923         result = 0;
 924         switch (pack->fp_len) {
 925         case sizeof *fid + 1:
 926                 memcpy(fid, pack->fp_area, sizeof *fid);
 927                 fid_be_to_cpu(fid, fid);
 928                 break;
 929         default:
 930                 CERROR("Unexpected packed fid size: %d\n", pack->fp_len);
 931                 result = -EIO;
 932         }
 933         return result;
 934 }
 935
 936 /**
 937  * Quota/Accounting handling
 938  */
 939 extern const struct dt_index_operations osd_acct_index_ops;
 940 int osd_acct_obj_lookup(struct osd_thread_info *info, struct osd_device *osd,
 941                         const struct lu_fid *fid, struct osd_inode_id *id);
 942
 943 /* copy from fs/ext4/dir.c */
 944 static inline int is_32bit_api(void)
 945 {
 946 #ifdef CONFIG_COMPAT
 947         return is_compat_task();
 948 #else
 949         return (BITS_PER_LONG == 32);
 950 #endif
 951 }
 952
 953 static inline loff_t ldiskfs_get_htree_eof(struct file *filp)
 954 {
 955         if ((filp->f_mode & FMODE_32BITHASH) ||
 956             (!(filp->f_mode & FMODE_64BITHASH) && is_32bit_api()))
 957                 return LDISKFS_HTREE_EOF_32BIT;
 958         else
 959                 return LDISKFS_HTREE_EOF_64BIT;
 960 }
 961
 962 #endif /* __KERNEL__ */
 963 #endif /* _OSD_INTERNAL_H */