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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  *
  31  * lustre/osd/osd_internal.h
  32  *
  33  * Shared definitions and declarations for osd module
  34  *
  35  * Author: Nikita Danilov <nikita@clusterfs.com>
  36  */
  37
  38 #ifndef _OSD_INTERNAL_H
  39 #define _OSD_INTERNAL_H
  40
  41
  42 /* struct mutex */
  43 #include <linux/mutex.h>
  44 /* struct rw_semaphore */
  45 #include <linux/rwsem.h>
  46 /* struct dentry */
  47 #include <linux/dcache.h>
  48 /* struct dirent64 */
  49 #include <linux/dirent.h>
  50 #include <linux/statfs.h>
  51 #include <linux/bio.h>
  52 #include <linux/file.h>
  53 #include <ldiskfs/ldiskfs.h>
  54 #include <ldiskfs/ldiskfs_jbd2.h>
  55
  56 /* LUSTRE_OSD_NAME */
  57 #include <obd.h>
  58 /* class_register_type(), class_unregister_type() */
  59 #include <obd_class.h>
  60 #include <lustre_disk.h>
  61 #include <dt_object.h>
  62 #include <lustre_quota.h>
  63
  64 #include "osd_oi.h"
  65 #include "osd_iam.h"
  66 #include "osd_scrub.h"
  67 #include "osd_quota_fmt.h"
  68
  69 struct inode;
  70 extern struct kmem_cache *dynlock_cachep;
  71
  72 #define OSD_COUNTERS (0)
  73
  74 /* ldiskfs special inode::i_state_flags need to be accessed with
  75  * ldiskfs_{set,clear,test}_inode_state() only */
  76
  77 /* OI scrub should skip this inode. */
  78 #define LDISKFS_STATE_LUSTRE_NOSCRUB    31
  79 #define LDISKFS_STATE_LUSTRE_DESTROY    30
  80
  81 /** Enable thandle usage statistics */
  82 #define OSD_THANDLE_STATS (0)
  83
  84 #define MAX_OBJID_GROUP (FID_SEQ_ECHO + 1)
  85
  86 #define OBJECTS         "OBJECTS"
  87 #define ADMIN_USR       "admin_quotafile_v2.usr"
  88 #define ADMIN_GRP       "admin_quotafile_v2.grp"
  89
  90 /* Statfs space reservation for fragmentation and local objects */
  91 #define OSD_STATFS_RESERVED             (1ULL << 23) /* 8MB */
  92 #define OSD_STATFS_RESERVED_SHIFT       (7) /* reserve 0.78% of all space */
  93
  94 /* Default extent bytes when declaring write commit */
  95 #define OSD_DEFAULT_EXTENT_BYTES        (1U << 20)
  96
  97 /* check if ldiskfs support project quota */
  98 #ifndef LDISKFS_IOC_FSSETXATTR
  99 #undef HAVE_PROJECT_QUOTA
 100 #endif
 101
 102 #define OBD_BRW_MAPPED  OBD_BRW_LOCAL1
 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_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         /**
 143          * Following two members *compat_dot* are used to indicate
 144          * the presence of dot and dotdot in the given directory.
 145          * This is required for interop mode (b11826).
 146          */
 147         __u32                   oo_destroyed:1,
 148                                 oo_pfid_in_lma:1,
 149                                 oo_compat_dot_created:1,
 150                                 oo_compat_dotdot_created:1;
 151
 152         /* the i_flags in LMA */
 153         __u32                   oo_lma_flags;
 154
 155         const struct lu_env    *oo_owner;
 156
 157         struct list_head        oo_xattr_list;
 158         struct lu_object_header *oo_header;
 159         __u64                   oo_dirent_count;
 160 };
 161
 162 struct osd_obj_seq {
 163         /* protects on-fly initialization */
 164         int              oos_subdir_count; /* subdir count for each seq */
 165         struct dentry    *oos_root;        /* O/<seq> */
 166         struct dentry    **oos_dirs;       /* O/<seq>/d0-dXX */
 167         u64              oos_seq;          /* seq number */
 168         struct list_head oos_seq_list;     /* list to seq_list */
 169 };
 170
 171 struct osd_obj_map {
 172         struct dentry    *om_root;        /* dentry for /O */
 173         rwlock_t         om_seq_list_lock; /* lock for seq_list */
 174         struct list_head om_seq_list;      /* list head for seq */
 175         int              om_subdir_count;
 176         struct mutex     om_dir_init_mutex;
 177 };
 178
 179 struct osd_mdobj {
 180         struct dentry   *om_root;      /* AGENT/<index> */
 181         u64              om_index;     /* mdt index */
 182         struct list_head om_list;      /* list to omm_list */
 183 };
 184
 185 struct osd_mdobj_map {
 186         struct dentry   *omm_remote_parent;
 187 };
 188 int osd_ldiskfs_add_entry(struct osd_thread_info *info, struct osd_device *osd,
 189                           handle_t *handle, struct dentry *child,
 190                           struct inode *inode, struct htree_lock *hlock);
 191
 192 #define OSD_OTABLE_IT_CACHE_SIZE        64
 193 #define OSD_OTABLE_IT_CACHE_MASK        (~(OSD_OTABLE_IT_CACHE_SIZE - 1))
 194
 195 struct osd_inconsistent_item {
 196         /* link into lustre_scrub::os_inconsistent_items,
 197          * protected by lustre_scrub::os_lock. */
 198         struct list_head       oii_list;
 199
 200         /* The right FID <=> ino#/gen mapping. */
 201         struct osd_idmap_cache oii_cache;
 202
 203         unsigned int           oii_insert:1; /* insert or update mapping. */
 204 };
 205
 206 struct osd_otable_cache {
 207         struct osd_idmap_cache ooc_cache[OSD_OTABLE_IT_CACHE_SIZE];
 208
 209         /* Index for next cache slot to be filled. */
 210         int                    ooc_producer_idx;
 211
 212         /* Index for next cache slot to be returned by it::next(). */
 213         int                    ooc_consumer_idx;
 214
 215         /* How many items in ooc_cache. */
 216         __u64                  ooc_cached_items;
 217
 218         /* Position for up layer LFSCK iteration pre-loading. */
 219         __u64                  ooc_pos_preload;
 220 };
 221
 222 struct osd_otable_it {
 223         struct osd_device       *ooi_dev;
 224         struct osd_otable_cache  ooi_cache;
 225         struct osd_iit_param     ooi_iit_param;
 226
 227         /* The following bits can be updated/checked w/o lock protection.
 228          * If more bits will be introduced in the future and need lock to
 229          * protect, please add comment. */
 230         unsigned long            ooi_used_outside:1, /* Some user out of OSD
 231                                                       * uses the iteration. */
 232                                  ooi_all_cached:1, /* No more entries can be
 233                                                     * filled into cache. */
 234                                  ooi_user_ready:1, /* The user out of OSD is
 235                                                     * ready to iterate. */
 236                                  ooi_waiting:1; /* it::next is waiting. */
 237 };
 238
 239 struct osd_obj_orphan {
 240         struct list_head oor_list;
 241         struct lu_env   *oor_env; /* to identify "own" records */
 242         __u32 oor_ino;
 243 };
 244
 245 enum osd_t10_type {
 246         OSD_T10_TYPE_UNKNOWN    = 0,
 247         OSD_T10_TYPE1           = 0x1,
 248         OSD_T10_TYPE3           = 0x2,
 249         OSD_T10_TYPE_CRC        = 0x4,
 250         OSD_T10_TYPE1_CRC       = OSD_T10_TYPE1 | OSD_T10_TYPE_CRC,
 251         OSD_T10_TYPE3_CRC       = OSD_T10_TYPE3 | OSD_T10_TYPE_CRC,
 252         OSD_T10_TYPE1_IP        = OSD_T10_TYPE1,
 253         OSD_T10_TYPE3_IP        = OSD_T10_TYPE3,
 254 };
 255
 256 /*
 257  * osd device.
 258  */
 259 struct osd_device {
 260         /* super-class */
 261         struct dt_device          od_dt_dev;
 262         /* information about underlying file system */
 263         struct vfsmount          *od_mnt;
 264         /* object index */
 265         struct osd_oi           **od_oi_table;
 266         /* total number of OI containers */
 267         int                       od_oi_count;
 268         /*
 269          * Fid Capability
 270          */
 271         unsigned int              od_fl_capa:1,
 272                                   od_maybe_new:1,
 273                                   od_igif_inoi:1,
 274                                   od_check_ff:1,
 275                                   od_is_ost:1,
 276                                   od_in_init:1,
 277                                   od_index_in_idif:1,
 278         /* Other flags */
 279                                   od_read_cache:1,
 280                                   od_writethrough_cache:1,
 281                                   od_nonrotational:1;
 282
 283
 284         __u32                     od_dirent_journal;
 285         int                       od_index;
 286         struct proc_dir_entry    *od_proc_entry;
 287         struct lprocfs_stats     *od_stats;
 288
 289         spinlock_t                od_osfs_lock;
 290
 291         int                       od_fallocate_zero_blocks;
 292         int                       od_connects;
 293         struct lu_site            od_site;
 294
 295         struct osd_obj_map      *od_ost_map;
 296         struct osd_mdobj_map    *od_mdt_map;
 297
 298         /* objects with size > od_readcache_max_filesize will be
 299          * served bypassing pagecache unless already cached */
 300         unsigned long long      od_readcache_max_filesize;
 301
 302         /* reads > od_readcache_max_iosize will be
 303          * served bypassing pagecache unless already cached */
 304         unsigned long           od_readcache_max_iosize;
 305
 306         /* writes > od_writethough_max_iosize will be
 307          * served bypassing pagecache unless already cached */
 308         unsigned long           od_writethrough_max_iosize;
 309
 310         struct brw_stats        od_brw_stats;
 311         atomic_t                od_r_in_flight;
 312         atomic_t                od_w_in_flight;
 313
 314         struct mutex              od_otable_mutex;
 315         struct osd_otable_it     *od_otable_it;
 316         struct osd_scrub          od_scrub;
 317         struct list_head                  od_ios_list;
 318
 319         /* service name associated with the osd device */
 320         char                      od_svname[MAX_OBD_NAME];
 321         char                      od_mntdev[MAX_OBD_NAME];
 322         uuid_t                  od_uuid;
 323
 324         /* quota slave instance for inode */
 325         struct qsd_instance      *od_quota_slave_md;
 326
 327         /* quota slave instance for block */
 328         struct qsd_instance      *od_quota_slave_dt;
 329
 330         /* osd seq instance */
 331         struct lu_client_seq    *od_cl_seq;
 332         /* If the ratio of "the total OI mappings count" vs
 333          * "the bad OI mappings count" is lower than the
 334          * osd_device::od_full_scrub_ratio, then trigger
 335          * OI scrub to scan the whole the device. */
 336         __u64                    od_full_scrub_ratio;
 337         /* If the speed of found bad OI mappings (per minute)
 338          * exceeds the osd_device::od_full_scrub_threshold_rate,
 339          * then trigger OI scrub to scan the whole device. */
 340         __u64                    od_full_scrub_threshold_rate;
 341
 342         /* a list of orphaned agent inodes, protected with od_osfs_lock */
 343         struct list_head         od_orphan_list;
 344         struct list_head         od_index_backup_list;
 345         struct list_head         od_index_restore_list;
 346         spinlock_t               od_lock;
 347         struct inode            *od_index_backup_inode;
 348         enum lustre_index_backup_policy od_index_backup_policy;
 349         int                      od_index_backup_stop;
 350         /* T10PI type, zero if not supported  */
 351         enum osd_t10_type        od_t10_type;
 352         atomic_t                 od_commit_cb_in_flight;
 353         wait_queue_head_t        od_commit_cb_done;
 354         unsigned int __percpu   *od_extent_bytes_percpu;
 355 };
 356
 357 static inline struct qsd_instance *osd_def_qsd(struct osd_device *osd)
 358 {
 359         if (osd->od_is_ost)
 360                 return osd->od_quota_slave_dt;
 361         else
 362                 return osd->od_quota_slave_md;
 363 }
 364
 365 enum osd_full_scrub_ratio {
 366         /* Trigger OI scrub to scan the whole device directly. */
 367         OFSR_DIRECTLY   = 0,
 368
 369         /* Because the bad OI mappings count cannot be larger than
 370          * the total OI mappints count, then setting OFSR_NEVER means
 371          * that the whole device scanning cannot be triggered by auto
 372          * detected bad OI mappings during the RPC services. */
 373         OFSR_NEVER      = 1,
 374         OFSR_DEFAULT    = 10000,
 375 };
 376
 377 #define FULL_SCRUB_THRESHOLD_RATE_DEFAULT       60
 378
 379 /* There are at most 15 uid/gid/projids are affected in a transaction, and
 380  * that's rename case:
 381  * - 3 for source parent uid & gid & projid;
 382  * - 3 for source child uid & gid & projid ('..' entry update when
 383  * child is directory);
 384  * - 3 for target parent uid & gid & projid;
 385  * - 3 for target child uid & gid & projid(if the target child exists);
 386  * - 3 for root uid & gid(last_rcvd, llog, etc);
 387  *
 388  */
 389 #define OSD_MAX_UGID_CNT        15
 390
 391 enum osd_op_type {
 392         OSD_OT_ATTR_SET         = 0,
 393         OSD_OT_PUNCH,
 394         OSD_OT_XATTR_SET,
 395         OSD_OT_CREATE,
 396         OSD_OT_DESTROY,
 397         OSD_OT_REF_ADD,
 398         OSD_OT_REF_DEL,
 399         OSD_OT_WRITE,
 400         OSD_OT_INSERT,
 401         OSD_OT_DELETE,
 402         OSD_OT_QUOTA,
 403         OSD_OT_PREALLOC,
 404         OSD_OT_MAX
 405 };
 406
 407 struct osd_access_lock {
 408         struct list_head         tl_list;
 409         struct osd_object       *tl_obj;
 410         loff_t                   tl_start;
 411         loff_t                   tl_end;
 412         int                      tl_mode;
 413         bool                     tl_shared;
 414         bool                     tl_truncate;
 415         bool                     tl_punch;
 416 };
 417
 418 struct osd_thandle {
 419         struct thandle          ot_super;
 420         handle_t               *ot_handle;
 421         struct ldiskfs_journal_cb_entry ot_jcb;
 422         struct list_head       ot_commit_dcb_list;
 423         struct list_head       ot_stop_dcb_list;
 424         /* Link to the device, for debugging. */
 425         struct lu_ref_link      ot_dev_link;
 426         unsigned int            ot_credits;
 427         unsigned int            oh_declared_ext;
 428
 429         /* quota IDs related to the transaction */
 430         unsigned short          ot_id_cnt;
 431         __u8                    ot_id_res[OSD_MAX_UGID_CNT];
 432         __u8                    ot_id_types[OSD_MAX_UGID_CNT];
 433         uid_t                   ot_id_array[OSD_MAX_UGID_CNT];
 434         struct lquota_trans    *ot_quota_trans;
 435
 436         unsigned int            ot_remove_agents:1;
 437 #if OSD_THANDLE_STATS
 438         /** time when this handle was allocated */
 439         ktime_t oth_alloced;
 440
 441         /** time when this thanle was started */
 442         ktime_t oth_started;
 443 #endif
 444         struct list_head        ot_trunc_locks;
 445 };
 446
 447 /**
 448  * Basic transaction credit op
 449  */
 450 enum dt_txn_op {
 451         DTO_INDEX_INSERT,
 452         DTO_INDEX_DELETE,
 453         DTO_INDEX_UPDATE,
 454         DTO_OBJECT_CREATE,
 455         DTO_OBJECT_DELETE,
 456         DTO_ATTR_SET_BASE,
 457         DTO_XATTR_SET,
 458         DTO_WRITE_BASE,
 459         DTO_WRITE_BLOCK,
 460         DTO_ATTR_SET_CHOWN,
 461
 462         DTO_NR
 463 };
 464
 465 /*
 466  * osd dev stats
 467  */
 468
 469 #ifdef CONFIG_PROC_FS
 470 enum {
 471         LPROC_OSD_READ_BYTES    = 0,
 472         LPROC_OSD_WRITE_BYTES   = 1,
 473         LPROC_OSD_GET_PAGE      = 2,
 474         LPROC_OSD_NO_PAGE       = 3,
 475         LPROC_OSD_CACHE_ACCESS  = 4,
 476         LPROC_OSD_CACHE_HIT     = 5,
 477         LPROC_OSD_CACHE_MISS    = 6,
 478
 479 #if OSD_THANDLE_STATS
 480         LPROC_OSD_THANDLE_STARTING,
 481         LPROC_OSD_THANDLE_OPEN,
 482         LPROC_OSD_THANDLE_CLOSING,
 483 #endif
 484         LPROC_OSD_LAST,
 485 };
 486 #endif
 487
 488 /**
 489  * Storage representation for fids.
 490  *
 491  * Variable size, first byte contains the length of the whole record.
 492  */
 493 struct osd_fid_pack {
 494         unsigned char fp_len;
 495         char fp_area[sizeof(struct lu_fid)];
 496 };
 497
 498 struct osd_it_ea_dirent {
 499         struct lu_fid   oied_fid;
 500         __u64           oied_ino;
 501         __u64           oied_off;
 502         unsigned short  oied_namelen;
 503         unsigned int    oied_type;
 504         char            oied_name[0];
 505 } __attribute__((packed));
 506
 507 /**
 508  * as osd_it_ea_dirent (in memory dirent struct for osd) is greater
 509  * than lu_dirent struct. osd readdir reads less number of dirent than
 510  * required for mdd dir page. so buffer size need to be increased so that
 511  * there  would be one ext3 readdir for every mdd readdir page.
 512  */
 513
 514 #define OSD_IT_EA_BUFSIZE       (PAGE_SIZE + PAGE_SIZE/4)
 515
 516 /**
 517  * This is iterator's in-memory data structure in interoperability
 518  * mode (i.e. iterator over ldiskfs style directory)
 519  */
 520 struct osd_it_ea {
 521         struct osd_object       *oie_obj;
 522         /** used in ldiskfs iterator, to stored file pointer */
 523         struct file             *oie_file;
 524         /** how many entries have been read-cached from storage */
 525         int                     oie_rd_dirent;
 526         /** current entry is being iterated by caller */
 527         int                     oie_it_dirent;
 528         /** current processing entry */
 529         struct osd_it_ea_dirent *oie_dirent;
 530         /** buffer to hold entries, size == OSD_IT_EA_BUFSIZE */
 531         void                    *oie_buf;
 532 };
 533
 534 /**
 535  * Iterator's in-memory data structure for IAM mode.
 536  */
 537 struct osd_it_iam {
 538         struct osd_object     *oi_obj;
 539         struct iam_path_descr *oi_ipd;
 540         struct iam_iterator    oi_it;
 541 };
 542
 543 struct osd_quota_leaf {
 544         struct list_head        oql_link;
 545         uint            oql_blk;
 546 };
 547
 548 /**
 549  * Iterator's in-memory data structure for quota file.
 550  */
 551 struct osd_it_quota {
 552         struct osd_object       *oiq_obj;
 553         /** tree blocks path to where the entry is stored */
 554         uint                     oiq_blk[LUSTRE_DQTREEDEPTH + 1];
 555         /** on-disk offset for current key where quota record can be found */
 556         loff_t                   oiq_offset;
 557         /** identifier for current quota record */
 558         __u64                    oiq_id;
 559         /** the record index in the leaf/index block */
 560         uint                     oiq_index[LUSTRE_DQTREEDEPTH + 1];
 561         /** list of already processed leaf blocks */
 562         struct list_head         oiq_list;
 563 };
 564
 565 #define MAX_BLOCKS_PER_PAGE (PAGE_SIZE / 512)
 566
 567 struct osd_iobuf {
 568         wait_queue_head_t  dr_wait;
 569         atomic_t       dr_numreqs;  /* number of reqs being processed */
 570         int                dr_max_pages;
 571         int                dr_npages;
 572         int                dr_error;
 573         int                dr_frags;
 574         unsigned int       dr_elapsed_valid:1; /* we really did count time */
 575         unsigned int       dr_rw:1;
 576         struct lu_buf      dr_pg_buf;
 577         struct page      **dr_pages;
 578         struct niobuf_local     **dr_lnbs;
 579         struct lu_buf      dr_bl_buf;
 580         struct lu_buf      dr_lnb_buf;
 581         sector_t          *dr_blocks;
 582         ktime_t            dr_start_time;
 583         ktime_t            dr_elapsed;  /* how long io took */
 584         struct osd_device *dr_dev;
 585         unsigned int       dr_init_at;  /* the line iobuf was initialized */
 586 };
 587
 588 #define osd_dirty_inode(inode, flag)  (inode)->i_sb->s_op->dirty_inode((inode), flag)
 589
 590 #ifndef HAVE_ALLOC_FILE_PSEUDO
 591
 592 #define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
 593                                             (flag & __FMODE_NONOTIFY)))
 594 static inline
 595 struct file *alloc_file_pseudo(struct inode *inode, struct vfsmount *mnt,
 596                                const char *name, int flags,
 597                                const struct file_operations *fops)
 598 {
 599         struct qstr this = QSTR_INIT(name, strlen(name));
 600         struct path path;
 601         struct file *file;
 602
 603         path.dentry = d_alloc_pseudo(mnt->mnt_sb, &this);
 604         if (!path.dentry)
 605                 return ERR_PTR(-ENOMEM);
 606         path.mnt = mntget(mnt);
 607         d_instantiate(path.dentry, inode);
 608         file = alloc_file(&path, OPEN_FMODE(flags), fops);
 609         if (IS_ERR(file)) {
 610                 ihold(inode);
 611                 path_put(&path);
 612         } else {
 613                 file->f_flags = flags;
 614         }
 615         return file;
 616 }
 617 #endif /* !HAVE_ALLOC_FILE_PSEUDO */
 618
 619 #ifdef HAVE_INODE_TIMESPEC64
 620 # define osd_timespec                   timespec64
 621 #else
 622 # define osd_timespec                   timespec
 623 #endif
 624
 625 static inline struct osd_timespec osd_inode_time(struct inode *inode,
 626                                                  s64 seconds)
 627 {
 628         struct osd_timespec ts = { .tv_sec = seconds };
 629
 630         return ts;
 631 }
 632
 633 #define OSD_INS_CACHE_SIZE      8
 634
 635 struct osd_thread_info {
 636         const struct lu_env   *oti_env;
 637         /**
 638          * used for index operations.
 639          */
 640         struct dentry          oti_obj_dentry;
 641         struct dentry          oti_child_dentry;
 642
 643         /** dentry for Iterator context. */
 644         struct dentry           oti_it_dentry;
 645
 646         /* osd_statfs() */
 647         struct kstatfs          oti_ksfs;
 648
 649         struct htree_lock     *oti_hlock;
 650
 651         struct lu_fid          oti_fid;
 652         struct lu_fid          oti_fid2;
 653         struct lu_fid          oti_fid3;
 654         struct osd_inode_id    oti_id;
 655         struct osd_inode_id    oti_id2;
 656         struct osd_inode_id    oti_id3;
 657         struct ost_id          oti_ostid;
 658
 659         /**
 660          * following ipd and it structures are used for osd_index_iam_lookup()
 661          * these are defined separately as we might do index operation
 662          * in open iterator session.
 663          */
 664
 665         /** pre-allocated buffer used by oti_it_ea, size OSD_IT_EA_BUFSIZE */
 666         void                    *oti_it_ea_buf;
 667         unsigned int            oti_it_ea_buf_used:1;
 668
 669         /* IAM iterator for index operation. */
 670         struct iam_iterator    oti_idx_it;
 671
 672         /** union to guarantee that ->oti_ipd[] has proper alignment. */
 673         union {
 674                 char           oti_name[48];
 675                 char           oti_it_ipd[DX_IPD_MAX_SIZE];
 676                 long long      oti_alignment_lieutenant;
 677         };
 678
 679         union {
 680                 char           oti_idx_ipd[DX_IPD_MAX_SIZE];
 681                 long long      oti_alignment_lieutenant_colonel;
 682         };
 683
 684         struct osd_idmap_cache oti_cache;
 685
 686         /* dedicated OI cache for insert (which needs inum) */
 687         struct osd_idmap_cache          *oti_ins_cache;
 688         int                             oti_ins_cache_size;
 689         int                             oti_ins_cache_used;
 690         /* inc by osd_trans_create and dec by osd_trans_stop */
 691         int                             oti_ins_cache_depth;
 692
 693         int                             oti_r_locks;
 694         int                             oti_w_locks;
 695         int                             oti_txns;
 696         /** used in osd_fid_set() to put xattr */
 697         struct lu_buf                   oti_buf;
 698         struct lu_buf                   oti_big_buf;
 699         /** used in osd_ea_fid_set() to set fid into common ea */
 700         union {
 701                 struct lustre_ost_attrs oti_ost_attrs;
 702                 struct filter_fid_18_23 oti_ff_old;
 703                 struct filter_fid       oti_ff;
 704         };
 705         /** 0-copy IO */
 706         struct osd_iobuf                oti_iobuf;
 707         /* used to access objects in /O */
 708         struct inode                    *oti_inode;
 709 #define OSD_FID_REC_SZ 32
 710         char                            oti_ldp[OSD_FID_REC_SZ];
 711         char                            oti_ldp2[OSD_FID_REC_SZ];
 712
 713         /* used by quota code */
 714         union {
 715 #if defined(HAVE_DQUOT_QC_DQBLK)
 716                 struct qc_dqblk         oti_qdq;
 717 #else
 718                 struct fs_disk_quota    oti_fdq;
 719 #endif
 720                 struct if_dqinfo        oti_dqinfo;
 721         };
 722         struct lquota_id_info   oti_qi;
 723         struct lquota_trans     oti_quota_trans;
 724         union lquota_rec        oti_quota_rec;
 725         __u64                   oti_quota_id;
 726         struct lu_seq_range     oti_seq_range;
 727
 728         /* Tracking for transaction credits, to allow debugging and optimizing
 729          * cases where a large number of credits are being allocated for
 730          * single transaction. */
 731         unsigned int            oti_credits_before;
 732         unsigned int            oti_declare_ops[OSD_OT_MAX];
 733         unsigned int            oti_declare_ops_cred[OSD_OT_MAX];
 734         unsigned int            oti_declare_ops_used[OSD_OT_MAX];
 735         struct osd_directory    oti_iam;
 736
 737         struct page             **oti_dio_pages;
 738         int                     oti_dio_pages_used;
 739
 740         struct osd_it_ea_dirent *oti_seq_dirent;
 741         struct osd_it_ea_dirent *oti_dir_dirent;
 742 };
 743
 744 extern int ldiskfs_pdo;
 745
 746 /* autoconf test is in lustre-build-ldiskfs.m4 */
 747 #ifdef HAVE_BVEC_ITER_ALL
 748 #define DECLARE_BVEC_ITER_ALL(iter) struct bvec_iter_all iter
 749 #else
 750 #define DECLARE_BVEC_ITER_ALL(iter) int iter
 751 #endif
 752
 753 static inline int __osd_xattr_get(struct inode *inode, struct dentry *dentry,
 754                                   const char *name, void *buf, int len)
 755 {
 756         if (inode == NULL)
 757                 return -EINVAL;
 758
 759         dentry->d_inode = inode;
 760         dentry->d_sb = inode->i_sb;
 761         return ll_vfs_getxattr(dentry, inode, name, buf, len);
 762 }
 763
 764 static inline int __osd_xattr_set(struct osd_thread_info *info,
 765                                   struct inode *inode, const char *name,
 766                                   const void *buf, int buflen, int fl)
 767 {
 768         struct dentry *dentry = &info->oti_child_dentry;
 769
 770         dquot_initialize(inode);
 771         dentry->d_inode = inode;
 772         dentry->d_sb = inode->i_sb;
 773         return ll_vfs_setxattr(dentry, inode, name, buf, buflen, fl);
 774 }
 775
 776 static inline char *osd_oid_name(char *name, size_t name_size,
 777                                  const struct lu_fid *fid, u64 id)
 778 {
 779         snprintf(name, name_size,
 780                  (fid_seq_is_rsvd(fid_seq(fid)) ||
 781                   fid_seq_is_mdt0(fid_seq(fid)) ||
 782                   fid_seq_is_idif(fid_seq(fid))) ? "%llu" : "%llx", id);
 783
 784         return name;
 785 }
 786
 787 #ifdef CONFIG_PROC_FS
 788 /* osd_lproc.c */
 789 extern struct lprocfs_vars lprocfs_osd_obd_vars[];
 790 int osd_procfs_init(struct osd_device *osd, const char *name);
 791 int osd_procfs_fini(struct osd_device *osd);
 792 void osd_brw_stats_update(struct osd_device *osd, struct osd_iobuf *iobuf);
 793 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(3, 0, 52, 0)
 794 int osd_register_proc_index_in_idif(struct osd_device *osd);
 795 #endif
 796
 797 #endif
 798 int osd_statfs(const struct lu_env *env, struct dt_device *dev,
 799                struct obd_statfs *sfs, struct obd_statfs_info *info);
 800 struct inode *osd_iget(struct osd_thread_info *info, struct osd_device *dev,
 801                        struct osd_inode_id *id);
 802 struct inode *
 803 osd_iget_fid(struct osd_thread_info *info, struct osd_device *dev,
 804              struct osd_inode_id *id, struct lu_fid *fid);
 805 int osd_ea_fid_set(struct osd_thread_info *info, struct inode *inode,
 806                    const struct lu_fid *fid, __u32 compat, __u32 incompat);
 807 struct osd_obj_seq *osd_seq_load(struct osd_thread_info *info,
 808                                  struct osd_device *osd, u64 seq);
 809 int osd_get_lma(struct osd_thread_info *info, struct inode *inode,
 810                 struct dentry *dentry, struct lustre_ost_attrs *loa);
 811 void osd_add_oi_cache(struct osd_thread_info *info, struct osd_device *osd,
 812                       struct osd_inode_id *id, const struct lu_fid *fid);
 813 int osd_get_idif(struct osd_thread_info *info, struct inode *inode,
 814                  struct dentry *dentry, struct lu_fid *fid);
 815 struct osd_it_ea *osd_it_dir_init(const struct lu_env *env,
 816                                   struct osd_device *dev, struct inode *inode,
 817                                   u32 attr);
 818 void osd_it_dir_fini(const struct lu_env *env, struct osd_it_ea *oie,
 819                      struct inode *inode);
 820 int osd_ldiskfs_it_fill(const struct lu_env *env, const struct dt_it *di);
 821
 822 int osd_obj_map_init(const struct lu_env *env, struct osd_device *osd);
 823 void osd_obj_map_fini(struct osd_device *dev);
 824 int osd_obj_map_lookup(struct osd_thread_info *info, struct osd_device *osd,
 825                         const struct lu_fid *fid, struct osd_inode_id *id);
 826 int osd_obj_map_insert(struct osd_thread_info *info, struct osd_device *osd,
 827                        const struct lu_fid *fid, const struct osd_inode_id *id,
 828                        handle_t *th);
 829 int osd_obj_map_delete(struct osd_thread_info *info, struct osd_device *osd,
 830                         const struct lu_fid *fid, handle_t *th);
 831 int osd_obj_map_update(struct osd_thread_info *info, struct osd_device *osd,
 832                        const struct lu_fid *fid, const struct osd_inode_id *id,
 833                        handle_t *th);
 834 int osd_obj_map_recover(struct osd_thread_info *info, struct osd_device *osd,
 835                         struct inode *src_parent, struct dentry *src_child,
 836                         const struct lu_fid *fid);
 837 int osd_obj_spec_lookup(struct osd_thread_info *info, struct osd_device *osd,
 838                         const struct lu_fid *fid, struct osd_inode_id *id,
 839                         enum oi_check_flags flags);
 840 int osd_obj_spec_insert(struct osd_thread_info *info, struct osd_device *osd,
 841                         const struct lu_fid *fid, const struct osd_inode_id *id,
 842                         handle_t *th);
 843 int osd_obj_spec_update(struct osd_thread_info *info, struct osd_device *osd,
 844                         const struct lu_fid *fid, const struct osd_inode_id *id,
 845                         handle_t *th);
 846 int osd_obj_del_entry(struct osd_thread_info *info, struct osd_device *osd,
 847                       struct dentry *dird, char *name, int namelen,
 848                       handle_t *th);
 849
 850 char *osd_lf_fid2name(const struct lu_fid *fid);
 851 int osd_scrub_start(const struct lu_env *env, struct osd_device *dev,
 852                     __u32 flags);
 853 void osd_scrub_stop(struct osd_device *dev);
 854 int osd_scrub_setup(const struct lu_env *env, struct osd_device *dev,
 855                     bool restored);
 856 void osd_scrub_cleanup(const struct lu_env *env, struct osd_device *dev);
 857 int osd_oii_insert(struct osd_device *dev, const struct lu_fid *fid,
 858                    struct osd_inode_id *id, int insert);
 859 int osd_oii_lookup(struct osd_device *dev, const struct lu_fid *fid,
 860                    struct osd_inode_id *id);
 861 void osd_scrub_dump(struct seq_file *m, struct osd_device *dev);
 862
 863 struct dentry *osd_lookup_one_len_unlocked(struct osd_device *dev,
 864                                            const char *name,
 865                                            struct dentry *base, int len);
 866 struct dentry *osd_lookup_one_len(struct osd_device *dev, const char *name,
 867                                   struct dentry *base, int len);
 868
 869 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
 870                    u64 seq, struct lu_seq_range *range);
 871
 872 int osd_delete_from_remote_parent(const struct lu_env *env,
 873                                   struct osd_device *osd,
 874                                   struct osd_object *obj,
 875                                   struct osd_thandle *oh, bool destroy);
 876 int osd_add_to_remote_parent(const struct lu_env *env, struct osd_device *osd,
 877                              struct osd_object *obj, struct osd_thandle *oh);
 878 int osd_lookup_in_remote_parent(struct osd_thread_info *oti,
 879                                 struct osd_device *osd,
 880                                 const struct lu_fid *fid,
 881                                 struct osd_inode_id *id);
 882
 883 int osd_ost_seq_exists(struct osd_thread_info *info, struct osd_device *osd,
 884                        __u64 seq);
 885 int osd_scrub_refresh_mapping(struct osd_thread_info *info,
 886                               struct osd_device *dev,
 887                               const struct lu_fid *fid,
 888                               const struct osd_inode_id *id,
 889                               int ops, bool force,
 890                               enum oi_check_flags flags, bool *exist);
 891
 892 /* osd_quota_fmt.c */
 893 int walk_tree_dqentry(const struct lu_env *env, struct osd_object *obj,
 894                       int type, uint blk, int depth, uint index,
 895                       struct osd_it_quota *it);
 896 int walk_block_dqentry(const struct lu_env *env, struct osd_object *obj,
 897                        int type, uint blk, uint index,
 898                        struct osd_it_quota *it);
 899 loff_t find_tree_dqentry(const struct lu_env *env,
 900                          struct osd_object *obj, int type,
 901                          qid_t dqid, uint blk, int depth,
 902                          struct osd_it_quota *it);
 903 /* osd_quota.c */
 904 int osd_declare_qid(const struct lu_env *env, struct osd_thandle *oh,
 905                     struct lquota_id_info *qi, struct osd_object *obj,
 906                     bool enforce, enum osd_quota_local_flags *local_flags);
 907 int osd_declare_inode_qid(const struct lu_env *env, qid_t uid, qid_t gid,
 908                           __u32 projid, long long space, struct osd_thandle *oh,
 909                           struct osd_object *obj,
 910                           enum osd_quota_local_flags *local_flags,
 911                           enum osd_qid_declare_flags);
 912 const struct dt_rec *osd_quota_pack(struct osd_object *obj,
 913                                     const struct dt_rec *rec,
 914                                     union lquota_rec *quota_rec);
 915 void osd_quota_unpack(struct osd_object *obj, const struct dt_rec *rec);
 916
 917 #ifdef HAVE_PROJECT_QUOTA
 918 static inline __u32 i_projid_read(struct inode *inode)
 919 {
 920         return (__u32)from_kprojid(&init_user_ns, LDISKFS_I(inode)->i_projid);
 921 }
 922
 923 static inline void i_projid_write(struct inode *inode, __u32 projid)
 924 {
 925         kprojid_t kprojid;
 926         kprojid = make_kprojid(&init_user_ns, (projid_t)projid);
 927         LDISKFS_I(inode)->i_projid = kprojid;
 928 }
 929 #else
 930 static inline uid_t i_projid_read(struct inode *inode)
 931 {
 932         return 0;
 933 }
 934 static inline void i_projid_write(struct inode *inode, __u32 projid)
 935 {
 936         return;
 937 }
 938 #endif
 939
 940 #ifdef HAVE_LDISKFS_IGET_WITH_FLAGS
 941 # define osd_ldiskfs_iget(sb, ino) \
 942                 ldiskfs_iget((sb), (ino), \
 943                              LDISKFS_IGET_HANDLE | LDISKFS_IGET_SPECIAL)
 944 #else
 945 # define osd_ldiskfs_iget(sb, ino) ldiskfs_iget((sb), (ino))
 946 #endif
 947
 948 #ifdef HAVE_LDISKFS_INFO_JINODE
 949 # define osd_attach_jinode(inode) ldiskfs_inode_attach_jinode(inode)
 950 #else  /* HAVE_LDISKFS_INFO_JINODE */
 951 # define osd_attach_jinode(inode) 0
 952 #endif /* HAVE_LDISKFS_INFO_JINODE */
 953
 954 #ifdef LDISKFS_HT_MISC
 955 # define osd_journal_start_sb(sb, type, nblock) \
 956                 ldiskfs_journal_start_sb(sb, type, nblock)
 957 static inline struct buffer_head *osd_ldiskfs_append(handle_t *handle,
 958                                                      struct inode *inode,
 959                                                      ldiskfs_lblk_t *nblock)
 960 {
 961         int rc;
 962
 963         rc = osd_attach_jinode(inode);
 964         if (rc)
 965                 return ERR_PTR(rc);
 966         return ldiskfs_append(handle, inode, nblock);
 967 }
 968
 969 # ifdef HAVE___LDISKFS_FIND_ENTRY
 970 #  define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
 971                 (__ldiskfs_find_entry(dir, name, de, inlined, lock) ?: \
 972                  ERR_PTR(-ENOENT))
 973 # else
 974 #  define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
 975                 (ldiskfs_find_entry_locked(dir, name, de, inlined, lock) ?: \
 976                  ERR_PTR(-ENOENT))
 977 # endif
 978
 979 # define osd_journal_start(inode, type, nblocks) \
 980                 ldiskfs_journal_start(inode, type, nblocks)
 981 # define osd_transaction_size(dev) \
 982                 (osd_journal(dev)->j_max_transaction_buffers / 2)
 983 #else /* ! defined LDISKFS_HT_MISC */
 984 # define LDISKFS_HT_MISC        0
 985 # define osd_journal_start_sb(sb, type, nblock) \
 986                 ldiskfs_journal_start_sb(sb, nblock)
 987
 988 static inline struct buffer_head *osd_ldiskfs_append(handle_t *handle,
 989                                                      struct inode *inode,
 990                                                      ldiskfs_lblk_t *nblock)
 991 {
 992         struct buffer_head *bh;
 993         int err = 0;
 994
 995         bh = ldiskfs_append(handle, inode, nblock, &err);
 996         if (bh == NULL)
 997                 bh = ERR_PTR(err);
 998
 999         return bh;
1000 }
1001
1002 # ifdef HAVE___LDISKFS_FIND_ENTRY
1003 #  define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
1004                 (__ldiskfs_find_entry(dir, name, de, lock) ?: \
1005                  ERR_PTR(-ENOENT))
1006 # else
1007 #  define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
1008                 (ldiskfs_find_entry_locked(dir, name, de, lock) ?: \
1009                  ERR_PTR(-ENOENT))
1010 # endif
1011 # define osd_journal_start(inode, type, nblocks) \
1012                 ldiskfs_journal_start(inode, nblocks)
1013 # define osd_transaction_size(dev) \
1014                 (osd_journal(dev)->j_max_transaction_buffers)
1015 #endif /* LDISKFS_HT_MISC */
1016
1017 #ifndef HAVE___LDISKFS_FIND_ENTRY
1018 # define __ldiskfs_add_entry(handle, child, inode, hlock) \
1019                 ldiskfs_add_entry_locked(handle, child, inode, hlock)
1020 #endif
1021
1022 /*
1023  * Invariants, assertions.
1024  */
1025
1026 /*
1027  * XXX: do not enable this, until invariant checking code is made thread safe
1028  * in the face of pdirops locking.
1029  */
1030 #define OSD_INVARIANT_CHECKS (0)
1031
1032 #if OSD_INVARIANT_CHECKS
1033 static inline int osd_invariant(const struct osd_object *obj)
1034 {
1035         return
1036                 obj != NULL &&
1037                 ergo(obj->oo_inode != NULL,
1038                      obj->oo_inode->i_sb == osd_sb(osd_obj2dev(obj)) &&
1039                      atomic_read(&obj->oo_inode->i_count) > 0) &&
1040                 ergo(obj->oo_dir != NULL &&
1041                      obj->oo_dir->od_conationer.ic_object != NULL,
1042                      obj->oo_dir->od_conationer.ic_object == obj->oo_inode);
1043 }
1044 #else
1045 #define osd_invariant(obj) (1)
1046 #endif
1047
1048 #define OSD_MAX_CACHE_SIZE OBD_OBJECT_EOF
1049 #define OSD_READCACHE_MAX_IO_MB         8
1050 #define OSD_WRITECACHE_MAX_IO_MB        8
1051
1052 extern const struct dt_index_operations osd_otable_ops;
1053
1054 static inline int osd_oi_fid2idx(struct osd_device *dev,
1055                                  const struct lu_fid *fid)
1056 {
1057         return fid->f_seq & (dev->od_oi_count - 1);
1058 }
1059
1060 static inline struct osd_oi *osd_fid2oi(struct osd_device *osd,
1061                                         const struct lu_fid *fid)
1062 {
1063         LASSERTF(!fid_is_idif(fid), DFID"\n", PFID(fid));
1064         LASSERTF(!fid_is_last_id(fid), DFID"\n", PFID(fid));
1065         LASSERTF(osd->od_oi_table != NULL && osd->od_oi_count >= 1,
1066                  DFID"\n", PFID(fid));
1067         /* It can work even od_oi_count equals to 1 although it's unexpected,
1068          * the only reason we set it to 1 is for performance measurement */
1069         return osd->od_oi_table[osd_oi_fid2idx(osd, fid)];
1070 }
1071
1072 extern const struct lu_device_operations  osd_lu_ops;
1073
1074 static inline int lu_device_is_osd(const struct lu_device *d)
1075 {
1076         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
1077 }
1078
1079 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
1080 {
1081         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
1082         return container_of(d, struct osd_device, od_dt_dev);
1083 }
1084
1085 static inline struct osd_device *osd_dev(const struct lu_device *d)
1086 {
1087         LASSERT(lu_device_is_osd(d));
1088         return osd_dt_dev(container_of(d, struct dt_device, dd_lu_dev));
1089 }
1090
1091 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
1092 {
1093         return osd_dev(o->oo_dt.do_lu.lo_dev);
1094 }
1095
1096 static inline struct super_block *osd_sb(const struct osd_device *dev)
1097 {
1098         return dev->od_mnt->mnt_sb;
1099 }
1100
1101 static inline const char *osd_sb2name(const struct super_block *sb)
1102 {
1103         /* this is LDISKFS_SB(sb), but preserves "const" */
1104         const struct ldiskfs_sb_info *sbi = sb->s_fs_info;
1105
1106         return sbi->s_es->s_volume_name;
1107 }
1108
1109 static inline const char *osd_dev2name(const struct osd_device *dev)
1110 {
1111         return osd_sb2name(osd_sb(dev));
1112 }
1113
1114 static inline const char *osd_ino2name(const struct inode *inode)
1115 {
1116         return osd_sb2name(inode->i_sb);
1117 }
1118
1119 /**
1120  * Put the osd object once done with it.
1121  *
1122  * \param obj osd object that needs to be put
1123  */
1124 static inline void osd_object_put(const struct lu_env *env,
1125                                   struct osd_object *obj)
1126 {
1127         dt_object_put(env, &obj->oo_dt);
1128 }
1129
1130 static inline int osd_object_is_root(const struct osd_object *obj)
1131 {
1132         return obj->oo_inode && is_root_inode(obj->oo_inode);
1133 }
1134
1135 static inline struct osd_object *osd_obj(const struct lu_object *o)
1136 {
1137         LASSERT(lu_device_is_osd(o->lo_dev));
1138         return container_of(o, struct osd_object, oo_dt.do_lu);
1139 }
1140
1141 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
1142 {
1143         return osd_obj(&d->do_lu);
1144 }
1145
1146 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
1147 {
1148         return &osd->od_dt_dev.dd_lu_dev;
1149 }
1150
1151 static inline journal_t *osd_journal(const struct osd_device *dev)
1152 {
1153         return LDISKFS_SB(osd_sb(dev))->s_journal;
1154 }
1155
1156 static inline struct seq_server_site *osd_seq_site(struct osd_device *osd)
1157 {
1158         return osd->od_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
1159 }
1160
1161 static inline char *osd_name(struct osd_device *osd)
1162 {
1163         return osd->od_svname;
1164 }
1165
1166 static inline bool osd_is_ea_inode(struct inode *inode)
1167 {
1168         return !!(LDISKFS_I(inode)->i_flags & LDISKFS_EA_INODE_FL);
1169 }
1170
1171 extern const struct dt_body_operations osd_body_ops;
1172 extern struct lu_context_key osd_key;
1173
1174 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
1175 {
1176         return lu_context_key_get(&env->le_ctx, &osd_key);
1177 }
1178
1179 extern const struct dt_body_operations osd_body_ops_new;
1180
1181 /**
1182  * IAM Iterator
1183  */
1184 static inline
1185 struct iam_path_descr *osd_it_ipd_get(const struct lu_env *env,
1186                                       const struct iam_container *bag)
1187 {
1188         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
1189                                            osd_oti_get(env)->oti_it_ipd);
1190 }
1191
1192 static inline
1193 struct iam_path_descr *osd_idx_ipd_get(const struct lu_env *env,
1194                                        const struct iam_container *bag)
1195 {
1196         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
1197                                            osd_oti_get(env)->oti_idx_ipd);
1198 }
1199
1200 static inline void osd_ipd_put(const struct lu_env *env,
1201                                const struct iam_container *bag,
1202                                struct iam_path_descr *ipd)
1203 {
1204         bag->ic_descr->id_ops->id_ipd_free(ipd);
1205 }
1206
1207 int osd_calc_bkmap_credits(struct super_block *sb, struct inode *inode,
1208                            const loff_t size, const loff_t pos,
1209                            const int blocks);
1210
1211 int osd_ldiskfs_read(struct inode *inode, void *buf, int size, loff_t *offs);
1212
1213 static inline
1214 struct dentry *osd_child_dentry_by_inode(const struct lu_env *env,
1215                                          struct inode *inode,
1216                                          const char *name, const int namelen)
1217 {
1218         struct osd_thread_info *info = osd_oti_get(env);
1219         struct dentry *child_dentry = &info->oti_child_dentry;
1220         struct dentry *obj_dentry = &info->oti_obj_dentry;
1221
1222         obj_dentry->d_inode = inode;
1223         obj_dentry->d_sb = inode->i_sb;
1224         obj_dentry->d_name.hash = 0;
1225
1226         child_dentry->d_name.hash = 0;
1227         child_dentry->d_parent = obj_dentry;
1228         child_dentry->d_name.name = name;
1229         child_dentry->d_name.len = namelen;
1230         return child_dentry;
1231 }
1232
1233 extern int osd_trans_declare_op2rb[];
1234 extern int ldiskfs_track_declares_assert;
1235 void osd_trans_dump_creds(const struct lu_env *env, struct thandle *th);
1236
1237 static inline void osd_trans_declare_op(const struct lu_env *env,
1238                                         struct osd_thandle *oh,
1239                                         enum osd_op_type op, int credits)
1240 {
1241         struct osd_thread_info *oti = osd_oti_get(env);
1242
1243         LASSERT(oh->ot_handle == NULL);
1244         if (unlikely(op >= OSD_OT_MAX)) {
1245                 if (unlikely(ldiskfs_track_declares_assert)) {
1246                         LASSERT(op < OSD_OT_MAX);
1247                 } else {
1248                         CWARN("%s: Invalid operation index %d\n",
1249                               osd_name(osd_dt_dev(oh->ot_super.th_dev)), op);
1250                         libcfs_debug_dumpstack(NULL);
1251                 }
1252         } else {
1253                 oti->oti_declare_ops[op]++;
1254                 oti->oti_declare_ops_cred[op] += credits;
1255         }
1256         oh->ot_credits += credits;
1257 }
1258
1259 /* linux: v5.4-rc3-21-g933f1c1e0b75 renamed h_buffer_credits */
1260 #ifdef HAVE_JOURNAL_TOTAL_CREDITS
1261 #define h_buffer_credits h_total_credits
1262 #endif
1263
1264 static inline void osd_trans_exec_op(const struct lu_env *env,
1265                                      struct thandle *th,
1266                                      enum osd_op_type op)
1267 {
1268         struct osd_thread_info *oti = osd_oti_get(env);
1269         struct osd_thandle     *oh  = container_of(th, struct osd_thandle,
1270                                                    ot_super);
1271         unsigned int            rb, left;
1272
1273         LASSERT(oh->ot_handle != NULL);
1274         if (unlikely(op >= OSD_OT_MAX)) {
1275                 if (unlikely(ldiskfs_track_declares_assert))
1276                         LASSERT(op < OSD_OT_MAX);
1277                 else {
1278                         CWARN("%s: opcode %u: invalid value >= %u\n",
1279                               osd_name(osd_dt_dev(oh->ot_super.th_dev)),
1280                               op, OSD_OT_MAX);
1281                         libcfs_debug_dumpstack(NULL);
1282                         return;
1283                 }
1284         }
1285
1286         /* find rollback (or reverse) operation for the given one
1287          * such an operation doesn't require additional credits
1288          * as the same set of blocks are modified */
1289         rb = osd_trans_declare_op2rb[op];
1290
1291         /* check whether credits for this operation were reserved at all */
1292         if (unlikely(oti->oti_declare_ops_cred[op] == 0 &&
1293                      oti->oti_declare_ops_cred[rb] == 0)) {
1294                 /* the API is not perfect yet: CREATE does REF_ADD internally
1295                  * while DESTROY does not. To rollback CREATE the callers
1296                  * needs to call REF_DEL+DESTROY which is hard to detect using
1297                  * a simple table of rollback operations */
1298                 if (op == OSD_OT_REF_DEL &&
1299                     oti->oti_declare_ops_cred[OSD_OT_CREATE] > 0)
1300                         goto proceed;
1301                 if (op == OSD_OT_REF_ADD &&
1302                     oti->oti_declare_ops_cred[OSD_OT_DESTROY] > 0)
1303                         goto proceed;
1304                 CWARN("%s: opcode %u: credits = 0, rollback = %u\n",
1305                       osd_name(osd_dt_dev(oh->ot_super.th_dev)), op, rb);
1306                 osd_trans_dump_creds(env, th);
1307                 LASSERT(!ldiskfs_track_declares_assert);
1308         }
1309
1310 proceed:
1311         /* remember how many credits we have unused before the operation */
1312         oti->oti_credits_before = oh->ot_handle->h_buffer_credits;
1313         left = oti->oti_declare_ops_cred[op] - oti->oti_declare_ops_used[op];
1314         if (unlikely(oti->oti_credits_before < left)) {
1315                 CWARN("%s: opcode %u: before %u < left %u, rollback = %u\n",
1316                       osd_name(osd_dt_dev(oh->ot_super.th_dev)), op,
1317                       oti->oti_credits_before, left, rb);
1318                 osd_trans_dump_creds(env, th);
1319                 /* on a very small fs (testing?) it's possible that
1320                  * the transaction can't fit 1/4 of journal, so we
1321                  * just request less credits (see osd_trans_start()).
1322                  * ignore the same case here */
1323                 rb = osd_transaction_size(osd_dt_dev(th->th_dev));
1324                 if (unlikely(oh->ot_credits < rb))
1325                         LASSERT(!ldiskfs_track_declares_assert);
1326         }
1327 }
1328
1329 static inline void osd_trans_exec_check(const struct lu_env *env,
1330                                         struct thandle *th,
1331                                         enum osd_op_type op)
1332 {
1333         struct osd_thread_info *oti = osd_oti_get(env);
1334         struct osd_thandle     *oh  = container_of(th, struct osd_thandle,
1335                                                    ot_super);
1336         int                     used, over, quota;
1337
1338         /* how many credits have been used by the operation */
1339         used = oti->oti_credits_before - oh->ot_handle->h_buffer_credits;
1340
1341         if (unlikely(used < 0)) {
1342                 /* if some block was allocated and released in the same
1343                  * transaction, then it won't be a part of the transaction
1344                  * and delta can be negative */
1345                 return;
1346         }
1347
1348         if (used == 0) {
1349                 /* rollback operations (e.g. when we destroy just created
1350                  * object) should not consume any credits. there is no point
1351                  * to confuse the checks below */
1352                 return;
1353         }
1354
1355         oti->oti_declare_ops_used[op] += used;
1356         if (oti->oti_declare_ops_used[op] <= oti->oti_declare_ops_cred[op])
1357                 return;
1358
1359         /* we account quota for a whole transaction and any operation can
1360          * consume corresponding credits */
1361         over = oti->oti_declare_ops_used[op] -
1362                 oti->oti_declare_ops_cred[op];
1363         quota = oti->oti_declare_ops_cred[OSD_OT_QUOTA] -
1364                 oti->oti_declare_ops_used[OSD_OT_QUOTA];
1365         if (over <= quota) {
1366                 /* probably that credits were consumed by
1367                  * quota indirectly (in the depths of ldiskfs) */
1368                 oti->oti_declare_ops_used[OSD_OT_QUOTA] += over;
1369                 oti->oti_declare_ops_used[op] -= over;
1370         } else {
1371                 CWARN("%s: opcode %d: used %u, used now %u, reserved %u\n",
1372                       osd_name(osd_dt_dev(oh->ot_super.th_dev)), op,
1373                       oti->oti_declare_ops_used[op], used,
1374                       oti->oti_declare_ops_cred[op]);
1375                 osd_trans_dump_creds(env, th);
1376                 if (unlikely(ldiskfs_track_declares_assert))
1377                         LBUG();
1378         }
1379 }
1380
1381 /**
1382  * Helper function to pack the fid, ldiskfs stores fid in packed format.
1383  */
1384 static inline
1385 void osd_fid_pack(struct osd_fid_pack *pack, const struct dt_rec *fid,
1386                   struct lu_fid *befider)
1387 {
1388         fid_cpu_to_be(befider, (struct lu_fid *)fid);
1389         memcpy(pack->fp_area, befider, sizeof(*befider));
1390         pack->fp_len =  sizeof(*befider) + 1;
1391 }
1392
1393 static inline
1394 int osd_fid_unpack(struct lu_fid *fid, const struct osd_fid_pack *pack)
1395 {
1396         int result;
1397
1398         result = 0;
1399         switch (pack->fp_len) {
1400         case sizeof *fid + 1:
1401                 memcpy(fid, pack->fp_area, sizeof *fid);
1402                 fid_be_to_cpu(fid, fid);
1403                 break;
1404         default:
1405                 CERROR("Unexpected packed fid size: %d\n", pack->fp_len);
1406                 result = -EIO;
1407         }
1408         return result;
1409 }
1410
1411 /**
1412  * Quota/Accounting handling
1413  */
1414 extern const struct dt_index_operations osd_acct_index_ops;
1415 int osd_acct_obj_lookup(struct osd_thread_info *info, struct osd_device *osd,
1416                         const struct lu_fid *fid, struct osd_inode_id *id);
1417
1418 /* copy from fs/ext4/dir.c */
1419 static inline int is_32bit_api(void)
1420 {
1421 #ifdef CONFIG_COMPAT
1422         return in_compat_syscall();
1423 #else
1424         return (BITS_PER_LONG == 32);
1425 #endif
1426 }
1427
1428 static inline loff_t ldiskfs_get_htree_eof(struct file *filp)
1429 {
1430         if ((filp->f_mode & FMODE_32BITHASH) ||
1431             (!(filp->f_mode & FMODE_64BITHASH) && is_32bit_api()))
1432                 return LDISKFS_HTREE_EOF_32BIT;
1433         else
1434                 return LDISKFS_HTREE_EOF_64BIT;
1435 }
1436
1437 static inline int fid_is_internal(const struct lu_fid *fid)
1438 {
1439         return (!fid_is_namespace_visible(fid) && !fid_is_idif(fid));
1440 }
1441
1442 static inline bool is_remote_parent_ino(struct osd_device *o, unsigned long ino)
1443 {
1444         if (o->od_is_ost)
1445                 return false;
1446
1447         LASSERT(o->od_mdt_map != NULL);
1448
1449         return ino == o->od_mdt_map->omm_remote_parent->d_inode->i_ino;
1450 }
1451
1452 /**
1453  * ext4_bread/ldiskfs_bread has either 5 or 4 parameters. The error
1454  * return code has been removed and integrated into the pointer in the
1455  * kernel 3.18.
1456  */
1457 static inline struct buffer_head *__ldiskfs_bread(handle_t *handle,
1458                                                   struct inode *inode,
1459                                                   ldiskfs_lblk_t block,
1460                                                   int create)
1461 {
1462         int rc = 0;
1463         struct buffer_head *bh;
1464
1465         if (create) {
1466                 rc = osd_attach_jinode(inode);
1467                 if (rc)
1468                         return ERR_PTR(rc);
1469         }
1470 #ifdef HAVE_EXT4_BREAD_4ARGS
1471         bh = ldiskfs_bread(handle, inode, block, create);
1472 #else
1473
1474         bh = ldiskfs_bread(handle, inode, block, create, &rc);
1475         if (bh == NULL && rc != 0)
1476                 bh = ERR_PTR(rc);
1477 #endif
1478         return bh;
1479 }
1480
1481 #ifndef HAVE_BIO_INTEGRITY_ENABLED
1482 bool bio_integrity_enabled(struct bio *bio);
1483 #endif
1484
1485 #ifdef HAVE_BI_BDEV
1486 # define bio_get_dev(bio)       ((bio)->bi_bdev)
1487 # define bio_get_disk(bio)      (bio_get_dev(bio)->bd_disk)
1488 # define bio_get_queue(bio)     bdev_get_queue(bio_get_dev(bio))
1489 # define bio_set_dev(bio, bdev) (bio_get_dev(bio) = (bdev))
1490 #else
1491 # define bio_get_disk(bio)      ((bio)->bi_disk)
1492 # define bio_get_queue(bio)     (bio_get_disk(bio)->queue)
1493 #endif
1494
1495 void ldiskfs_inc_count(handle_t *handle, struct inode *inode);
1496 void ldiskfs_dec_count(handle_t *handle, struct inode *inode);
1497
1498 void osd_fini_iobuf(struct osd_device *d, struct osd_iobuf *iobuf);
1499
1500 static inline int
1501 osd_index_register(struct osd_device *osd, const struct lu_fid *fid,
1502                    __u32 keysize, __u32 recsize)
1503 {
1504         return lustre_index_register(&osd->od_dt_dev, osd_name(osd),
1505                                      &osd->od_index_backup_list, &osd->od_lock,
1506                                      &osd->od_index_backup_stop,
1507                                      fid, keysize, recsize);
1508 }
1509
1510 static inline void
1511 osd_index_backup(const struct lu_env *env, struct osd_device *osd, bool backup)
1512 {
1513         struct osd_thread_info *info = osd_oti_get(env);
1514         struct lu_fid *fid = &info->oti_fid3;
1515         struct osd_inode_id *id = &info->oti_id3;
1516
1517         lu_local_obj_fid(fid, INDEX_BACKUP_OID);
1518         osd_id_gen(id, osd->od_index_backup_inode->i_ino,
1519                    osd->od_index_backup_inode->i_generation);
1520         osd_add_oi_cache(info, osd, id, fid);
1521
1522         lustre_index_backup(env, &osd->od_dt_dev, osd_name(osd),
1523                             &osd->od_index_backup_list, &osd->od_lock,
1524                             &osd->od_index_backup_stop, backup);
1525 }
1526
1527 #ifdef LDISKFS_HAS_INCOMPAT_FEATURE
1528
1529 # ifdef LDISKFS_FEATURE_INCOMPAT_EXTENTS
1530 # define ldiskfs_has_feature_extents(sb) \
1531         LDISKFS_HAS_INCOMPAT_FEATURE(sb, LDISKFS_FEATURE_INCOMPAT_EXTENTS)
1532 # endif
1533 # ifdef LDISKFS_FEATURE_INCOMPAT_EA_INODE
1534 # define ldiskfs_has_feature_ea_inode(sb) \
1535         LDISKFS_HAS_INCOMPAT_FEATURE(sb, LDISKFS_FEATURE_INCOMPAT_EA_INODE)
1536 # endif
1537 # ifdef LDISKFS_FEATURE_INCOMPAT_DIRDATA
1538 # define ldiskfs_has_feature_dirdata(sb) \
1539         LDISKFS_HAS_INCOMPAT_FEATURE(sb, LDISKFS_FEATURE_INCOMPAT_DIRDATA)
1540 # endif
1541 # ifdef LDISKFS_FEATURE_INCOMPAT_LARGEDIR
1542 # define ldiskfs_has_feature_largedir(sb) \
1543         LDISKFS_HAS_INCOMPAT_FEATURE(sb, LDISKFS_FEATURE_INCOMPAT_LARGEDIR)
1544 # define ldiskfs_set_feature_largedir(sb) \
1545         LDISKFS_SET_INCOMPAT_FEATURE(sb, LDISKFS_FEATURE_INCOMPAT_LARGEDIR)
1546 # endif
1547 # ifdef LDISKFS_FEATURE_COMPAT_HAS_JOURNAL
1548 # define ldiskfs_has_feature_journal(sb) \
1549         LDISKFS_HAS_COMPAT_FEATURE(sb, LDISKFS_FEATURE_COMPAT_HAS_JOURNAL)
1550 # endif
1551 # ifdef LDISKFS_FEATURE_RO_COMPAT_QUOTA
1552 # define ldiskfs_has_feature_quota(sb) \
1553         LDISKFS_HAS_RO_COMPAT_FEATURE(sb, LDISKFS_FEATURE_RO_COMPAT_QUOTA)
1554 # endif
1555 # ifdef LDISKFS_FEATURE_RO_COMPAT_PROJECT
1556 # define ldiskfs_has_feature_project(sb) \
1557         LDISKFS_HAS_RO_COMPAT_FEATURE(sb, LDISKFS_FEATURE_RO_COMPAT_PROJECT)
1558 # endif
1559 # ifdef LDISKFS_FEATURE_COMPAT_FAST_COMMIT
1560 # define ldiskfs_has_feature_fast_commit(sb) \
1561         LDISKFS_HAS_INCOMPAT_FEATURE(sb, LDISKFS_FEATURE_COMPAT_FAST_COMMIT)
1562 # endif
1563 #endif
1564
1565 #ifndef ldiskfs_has_feature_fast_commit
1566 #define ldiskfs_has_feature_fast_commit(sb)  false
1567 #endif
1568
1569 int osd_trunc_lock(struct osd_object *obj, struct osd_thandle *oh,
1570                    bool shared);
1571 void osd_trunc_unlock_all(const struct lu_env *env, struct list_head *list);
1572 int osd_process_truncates(const struct lu_env *env, struct list_head *list);
1573 void osd_execute_truncate(struct osd_object *obj);
1574
1575 #ifdef HAVE_BIO_ENDIO_USES_ONE_ARG
1576 #define osd_dio_complete_routine(bio, error) dio_complete_routine(bio)
1577 #else
1578 #define osd_dio_complete_routine(bio, error) dio_complete_routine(bio, error)
1579 #endif
1580
1581 #ifndef HAVE___BI_CNT
1582 #define __bi_cnt bi_cnt
1583 #endif
1584
1585 #ifndef HAVE_BI_OPF
1586 #define bi_opf bi_rw
1587 #endif
1588
1589 #ifndef HAVE_CLEAN_BDEV_ALIASES
1590 #define clean_bdev_aliases(bdev, block, len)    \
1591         unmap_underlying_metadata((bdev), (block))
1592 #endif
1593
1594 #ifndef HAVE_BI_STATUS
1595 #define bi_status bi_error
1596 #endif
1597
1598 /*
1599  * Maximum size of xattr attributes for FEATURE_INCOMPAT_EA_INODE 1Mb
1600  * This limit is arbitrary, but is reasonable for the xattr API.
1601  */
1602 #define LDISKFS_XATTR_MAX_LARGE_EA_SIZE    (1024 * 1024)
1603
1604 struct osd_bio_private {
1605         struct osd_iobuf        *obp_iobuf;
1606         /* Start page index in the obp_iobuf for the bio */
1607         int                      obp_start_page_idx;
1608 };
1609
1610 #ifdef HAVE_BIO_INTEGRITY_PREP_FN
1611 int osd_get_integrity_profile(struct osd_device *osd,
1612                               integrity_gen_fn **generate_fn,
1613                               integrity_vrfy_fn **verify_fn);
1614 #else
1615 #define integrity_gen_fn void
1616 #define integrity_vrfy_fn int
1617 static inline int osd_get_integrity_profile(struct osd_device *osd,
1618                                             integrity_gen_fn **generate_fn,
1619                                             integrity_vrfy_fn **verify_fn)
1620 {
1621         return 0;
1622 }
1623
1624 static inline int bio_integrity_prep_fn(struct bio *bio,
1625                                          integrity_gen_fn *generate_fn,
1626                                          integrity_vrfy_fn *verify_fn)
1627 {
1628 #ifdef HAVE_BIO_INTEGRITY_PREP_FN_RETURNS_BOOL
1629         if (bio_integrity_prep(bio))
1630                 return 0;
1631         else
1632                 return -EIO;
1633 #else
1634         return bio_integrity_prep(bio);
1635 #endif
1636 }
1637 #endif
1638
1639 #ifdef HAVE_BIO_BI_PHYS_SEGMENTS
1640 #define osd_bio_nr_segs(bio)            ((bio)->bi_phys_segments)
1641 #else
1642 #define osd_bio_nr_segs(bio)            bio_segments((bio))
1643 #endif /* HAVE_BIO_BI_PHYS_SEGMENTS */
1644
1645 #ifdef HAVE_GET_INODE_USAGE
1646 #define lock_dquot_transfer(inode) down_read(&LDISKFS_I(inode)->xattr_sem)
1647 #define unlock_dquot_transfer(inode) up_read(&LDISKFS_I(inode)->xattr_sem)
1648 #else
1649 #define lock_dquot_transfer(inode) do {} while (0)
1650 #define unlock_dquot_transfer(inode) do {} while (0)
1651 #endif
1652
1653 #endif /* _OSD_INTERNAL_H */