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