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         struct dentry           oie_dentry;
 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 int osd_security_file_alloc(struct file *file);
 589
 590 #define osd_dirty_inode(inode, flag)  (inode)->i_sb->s_op->dirty_inode((inode), flag)
 591
 592 #ifdef HAVE_INODE_TIMESPEC64
 593 # define osd_timespec                   timespec64
 594 #else
 595 # define osd_timespec                   timespec
 596 #endif
 597
 598 static inline struct osd_timespec osd_inode_time(struct inode *inode,
 599                                                  s64 seconds)
 600 {
 601         struct osd_timespec ts = { .tv_sec = seconds };
 602
 603         return ts;
 604 }
 605
 606 #define OSD_INS_CACHE_SIZE      8
 607
 608 struct osd_thread_info {
 609         const struct lu_env   *oti_env;
 610         /**
 611          * used for index operations.
 612          */
 613         struct dentry          oti_obj_dentry;
 614         struct dentry          oti_child_dentry;
 615
 616         /** dentry for Iterator context. */
 617         struct dentry           oti_it_dentry;
 618
 619         union {
 620                 /* fake struct file for osd_object_sync */
 621                 struct file             oti_file;
 622                 /* osd_statfs() */
 623                 struct kstatfs          oti_ksfs;
 624         };
 625
 626         struct htree_lock     *oti_hlock;
 627
 628         struct lu_fid          oti_fid;
 629         struct lu_fid          oti_fid2;
 630         struct lu_fid          oti_fid3;
 631         struct osd_inode_id    oti_id;
 632         struct osd_inode_id    oti_id2;
 633         struct osd_inode_id    oti_id3;
 634         struct ost_id          oti_ostid;
 635
 636         /**
 637          * following ipd and it structures are used for osd_index_iam_lookup()
 638          * these are defined separately as we might do index operation
 639          * in open iterator session.
 640          */
 641
 642         /** pre-allocated buffer used by oti_it_ea, size OSD_IT_EA_BUFSIZE */
 643         void                    *oti_it_ea_buf;
 644         unsigned int            oti_it_ea_buf_used:1;
 645
 646         /* IAM iterator for index operation. */
 647         struct iam_iterator    oti_idx_it;
 648
 649         /** union to guarantee that ->oti_ipd[] has proper alignment. */
 650         union {
 651                 char           oti_name[48];
 652                 char           oti_it_ipd[DX_IPD_MAX_SIZE];
 653                 long long      oti_alignment_lieutenant;
 654         };
 655
 656         union {
 657                 char           oti_idx_ipd[DX_IPD_MAX_SIZE];
 658                 long long      oti_alignment_lieutenant_colonel;
 659         };
 660
 661         struct osd_idmap_cache oti_cache;
 662
 663         /* dedicated OI cache for insert (which needs inum) */
 664         struct osd_idmap_cache          *oti_ins_cache;
 665         int                             oti_ins_cache_size;
 666         int                             oti_ins_cache_used;
 667         /* inc by osd_trans_create and dec by osd_trans_stop */
 668         int                             oti_ins_cache_depth;
 669
 670         int                             oti_r_locks;
 671         int                             oti_w_locks;
 672         int                             oti_txns;
 673         /** used in osd_fid_set() to put xattr */
 674         struct lu_buf                   oti_buf;
 675         struct lu_buf                   oti_big_buf;
 676         /** used in osd_ea_fid_set() to set fid into common ea */
 677         union {
 678                 struct lustre_ost_attrs oti_ost_attrs;
 679                 struct filter_fid_18_23 oti_ff_old;
 680                 struct filter_fid       oti_ff;
 681         };
 682         /** 0-copy IO */
 683         struct osd_iobuf                oti_iobuf;
 684         /* used to access objects in /O */
 685         struct inode                    *oti_inode;
 686 #define OSD_FID_REC_SZ 32
 687         char                            oti_ldp[OSD_FID_REC_SZ];
 688         char                            oti_ldp2[OSD_FID_REC_SZ];
 689
 690         /* used by quota code */
 691         union {
 692 #if defined(HAVE_DQUOT_QC_DQBLK)
 693                 struct qc_dqblk         oti_qdq;
 694 #else
 695                 struct fs_disk_quota    oti_fdq;
 696 #endif
 697                 struct if_dqinfo        oti_dqinfo;
 698         };
 699         struct lquota_id_info   oti_qi;
 700         struct lquota_trans     oti_quota_trans;
 701         union lquota_rec        oti_quota_rec;
 702         __u64                   oti_quota_id;
 703         struct lu_seq_range     oti_seq_range;
 704
 705         /* Tracking for transaction credits, to allow debugging and optimizing
 706          * cases where a large number of credits are being allocated for
 707          * single transaction. */
 708         unsigned int            oti_credits_before;
 709         unsigned int            oti_declare_ops[OSD_OT_MAX];
 710         unsigned int            oti_declare_ops_cred[OSD_OT_MAX];
 711         unsigned int            oti_declare_ops_used[OSD_OT_MAX];
 712         struct osd_directory    oti_iam;
 713
 714         struct page             **oti_dio_pages;
 715         int                     oti_dio_pages_used;
 716
 717         struct osd_it_ea_dirent *oti_seq_dirent;
 718         struct osd_it_ea_dirent *oti_dir_dirent;
 719 };
 720
 721 extern int ldiskfs_pdo;
 722
 723 /* autoconf test is in lustre-build-ldiskfs.m4 */
 724 #ifdef HAVE_BVEC_ITER_ALL
 725 #define DECLARE_BVEC_ITER_ALL(iter) struct bvec_iter_all iter
 726 #else
 727 #define DECLARE_BVEC_ITER_ALL(iter) int iter
 728 #endif
 729
 730 static inline int __osd_xattr_get(struct inode *inode, struct dentry *dentry,
 731                                   const char *name, void *buf, int len)
 732 {
 733         if (inode == NULL)
 734                 return -EINVAL;
 735
 736         dentry->d_inode = inode;
 737         dentry->d_sb = inode->i_sb;
 738         return ll_vfs_getxattr(dentry, inode, name, buf, len);
 739 }
 740
 741 static inline int __osd_xattr_set(struct osd_thread_info *info,
 742                                   struct inode *inode, const char *name,
 743                                   const void *buf, int buflen, int fl)
 744 {
 745         struct dentry *dentry = &info->oti_child_dentry;
 746
 747         dquot_initialize(inode);
 748         dentry->d_inode = inode;
 749         dentry->d_sb = inode->i_sb;
 750         return ll_vfs_setxattr(dentry, inode, name, buf, buflen, fl);
 751 }
 752
 753 static inline char *osd_oid_name(char *name, size_t name_size,
 754                                  const struct lu_fid *fid, u64 id)
 755 {
 756         snprintf(name, name_size,
 757                  (fid_seq_is_rsvd(fid_seq(fid)) ||
 758                   fid_seq_is_mdt0(fid_seq(fid)) ||
 759                   fid_seq_is_idif(fid_seq(fid))) ? "%llu" : "%llx", id);
 760
 761         return name;
 762 }
 763
 764 #ifdef CONFIG_PROC_FS
 765 /* osd_lproc.c */
 766 extern struct lprocfs_vars lprocfs_osd_obd_vars[];
 767 int osd_procfs_init(struct osd_device *osd, const char *name);
 768 int osd_procfs_fini(struct osd_device *osd);
 769 void osd_brw_stats_update(struct osd_device *osd, struct osd_iobuf *iobuf);
 770 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(3, 0, 52, 0)
 771 int osd_register_proc_index_in_idif(struct osd_device *osd);
 772 #endif
 773
 774 #endif
 775 int osd_statfs(const struct lu_env *env, struct dt_device *dev,
 776                struct obd_statfs *sfs, struct obd_statfs_info *info);
 777 struct inode *osd_iget(struct osd_thread_info *info, struct osd_device *dev,
 778                        struct osd_inode_id *id);
 779 struct inode *
 780 osd_iget_fid(struct osd_thread_info *info, struct osd_device *dev,
 781              struct osd_inode_id *id, struct lu_fid *fid);
 782 int osd_ea_fid_set(struct osd_thread_info *info, struct inode *inode,
 783                    const struct lu_fid *fid, __u32 compat, __u32 incompat);
 784 struct osd_obj_seq *osd_seq_load(struct osd_thread_info *info,
 785                                  struct osd_device *osd, u64 seq);
 786 int osd_get_lma(struct osd_thread_info *info, struct inode *inode,
 787                 struct dentry *dentry, struct lustre_ost_attrs *loa);
 788 void osd_add_oi_cache(struct osd_thread_info *info, struct osd_device *osd,
 789                       struct osd_inode_id *id, const struct lu_fid *fid);
 790 int osd_get_idif(struct osd_thread_info *info, struct inode *inode,
 791                  struct dentry *dentry, struct lu_fid *fid);
 792 struct osd_it_ea *osd_it_dir_init(const struct lu_env *env, struct inode *inode,
 793                                   __u32 attr);
 794 void osd_it_dir_fini(const struct lu_env *env, struct osd_it_ea *oie,
 795                      struct inode *inode);
 796 int osd_ldiskfs_it_fill(const struct lu_env *env, const struct dt_it *di);
 797
 798 int osd_obj_map_init(const struct lu_env *env, struct osd_device *osd);
 799 void osd_obj_map_fini(struct osd_device *dev);
 800 int osd_obj_map_lookup(struct osd_thread_info *info, struct osd_device *osd,
 801                         const struct lu_fid *fid, struct osd_inode_id *id);
 802 int osd_obj_map_insert(struct osd_thread_info *info, struct osd_device *osd,
 803                        const struct lu_fid *fid, const struct osd_inode_id *id,
 804                        handle_t *th);
 805 int osd_obj_map_delete(struct osd_thread_info *info, struct osd_device *osd,
 806                         const struct lu_fid *fid, handle_t *th);
 807 int osd_obj_map_update(struct osd_thread_info *info, struct osd_device *osd,
 808                        const struct lu_fid *fid, const struct osd_inode_id *id,
 809                        handle_t *th);
 810 int osd_obj_map_recover(struct osd_thread_info *info, struct osd_device *osd,
 811                         struct inode *src_parent, struct dentry *src_child,
 812                         const struct lu_fid *fid);
 813 int osd_obj_spec_lookup(struct osd_thread_info *info, struct osd_device *osd,
 814                         const struct lu_fid *fid, struct osd_inode_id *id,
 815                         enum oi_check_flags flags);
 816 int osd_obj_spec_insert(struct osd_thread_info *info, struct osd_device *osd,
 817                         const struct lu_fid *fid, const struct osd_inode_id *id,
 818                         handle_t *th);
 819 int osd_obj_spec_update(struct osd_thread_info *info, struct osd_device *osd,
 820                         const struct lu_fid *fid, const struct osd_inode_id *id,
 821                         handle_t *th);
 822 int osd_obj_del_entry(struct osd_thread_info *info, struct osd_device *osd,
 823                       struct dentry *dird, char *name, int namelen,
 824                       handle_t *th);
 825
 826 char *osd_lf_fid2name(const struct lu_fid *fid);
 827 int osd_scrub_start(const struct lu_env *env, struct osd_device *dev,
 828                     __u32 flags);
 829 void osd_scrub_stop(struct osd_device *dev);
 830 int osd_scrub_setup(const struct lu_env *env, struct osd_device *dev,
 831                     bool restored);
 832 void osd_scrub_cleanup(const struct lu_env *env, struct osd_device *dev);
 833 int osd_oii_insert(struct osd_device *dev, const struct lu_fid *fid,
 834                    struct osd_inode_id *id, int insert);
 835 int osd_oii_lookup(struct osd_device *dev, const struct lu_fid *fid,
 836                    struct osd_inode_id *id);
 837 void osd_scrub_dump(struct seq_file *m, struct osd_device *dev);
 838
 839 struct dentry *osd_lookup_one_len_unlocked(struct osd_device *dev,
 840                                            const char *name,
 841                                            struct dentry *base, int len);
 842 struct dentry *osd_lookup_one_len(struct osd_device *dev, const char *name,
 843                                   struct dentry *base, int len);
 844
 845 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
 846                    u64 seq, struct lu_seq_range *range);
 847
 848 int osd_delete_from_remote_parent(const struct lu_env *env,
 849                                   struct osd_device *osd,
 850                                   struct osd_object *obj,
 851                                   struct osd_thandle *oh, bool destroy);
 852 int osd_add_to_remote_parent(const struct lu_env *env, struct osd_device *osd,
 853                              struct osd_object *obj, struct osd_thandle *oh);
 854 int osd_lookup_in_remote_parent(struct osd_thread_info *oti,
 855                                 struct osd_device *osd,
 856                                 const struct lu_fid *fid,
 857                                 struct osd_inode_id *id);
 858
 859 int osd_ost_seq_exists(struct osd_thread_info *info, struct osd_device *osd,
 860                        __u64 seq);
 861 int osd_scrub_refresh_mapping(struct osd_thread_info *info,
 862                               struct osd_device *dev,
 863                               const struct lu_fid *fid,
 864                               const struct osd_inode_id *id,
 865                               int ops, bool force,
 866                               enum oi_check_flags flags, bool *exist);
 867
 868 /* osd_quota_fmt.c */
 869 int walk_tree_dqentry(const struct lu_env *env, struct osd_object *obj,
 870                       int type, uint blk, int depth, uint index,
 871                       struct osd_it_quota *it);
 872 int walk_block_dqentry(const struct lu_env *env, struct osd_object *obj,
 873                        int type, uint blk, uint index,
 874                        struct osd_it_quota *it);
 875 loff_t find_tree_dqentry(const struct lu_env *env,
 876                          struct osd_object *obj, int type,
 877                          qid_t dqid, uint blk, int depth,
 878                          struct osd_it_quota *it);
 879 /* osd_quota.c */
 880 int osd_declare_qid(const struct lu_env *env, struct osd_thandle *oh,
 881                     struct lquota_id_info *qi, struct osd_object *obj,
 882                     bool enforce, enum osd_quota_local_flags *local_flags);
 883 int osd_declare_inode_qid(const struct lu_env *env, qid_t uid, qid_t gid,
 884                           __u32 projid, long long space, struct osd_thandle *oh,
 885                           struct osd_object *obj,
 886                           enum osd_quota_local_flags *local_flags,
 887                           enum osd_qid_declare_flags);
 888 const struct dt_rec *osd_quota_pack(struct osd_object *obj,
 889                                     const struct dt_rec *rec,
 890                                     union lquota_rec *quota_rec);
 891 void osd_quota_unpack(struct osd_object *obj, const struct dt_rec *rec);
 892
 893 #ifdef HAVE_PROJECT_QUOTA
 894 static inline __u32 i_projid_read(struct inode *inode)
 895 {
 896         return (__u32)from_kprojid(&init_user_ns, LDISKFS_I(inode)->i_projid);
 897 }
 898
 899 static inline void i_projid_write(struct inode *inode, __u32 projid)
 900 {
 901         kprojid_t kprojid;
 902         kprojid = make_kprojid(&init_user_ns, (projid_t)projid);
 903         LDISKFS_I(inode)->i_projid = kprojid;
 904 }
 905 #else
 906 static inline uid_t i_projid_read(struct inode *inode)
 907 {
 908         return 0;
 909 }
 910 static inline void i_projid_write(struct inode *inode, __u32 projid)
 911 {
 912         return;
 913 }
 914 #endif
 915
 916 #ifdef HAVE_LDISKFS_IGET_WITH_FLAGS
 917 # define osd_ldiskfs_iget(sb, ino) \
 918                 ldiskfs_iget((sb), (ino), \
 919                              LDISKFS_IGET_HANDLE | LDISKFS_IGET_SPECIAL)
 920 #else
 921 # define osd_ldiskfs_iget(sb, ino) ldiskfs_iget((sb), (ino))
 922 #endif
 923
 924 #ifdef HAVE_LDISKFS_INFO_JINODE
 925 # define osd_attach_jinode(inode) ldiskfs_inode_attach_jinode(inode)
 926 #else  /* HAVE_LDISKFS_INFO_JINODE */
 927 # define osd_attach_jinode(inode) 0
 928 #endif /* HAVE_LDISKFS_INFO_JINODE */
 929
 930 #ifdef LDISKFS_HT_MISC
 931 # define osd_journal_start_sb(sb, type, nblock) \
 932                 ldiskfs_journal_start_sb(sb, type, nblock)
 933 static inline struct buffer_head *osd_ldiskfs_append(handle_t *handle,
 934                                                      struct inode *inode,
 935                                                      ldiskfs_lblk_t *nblock)
 936 {
 937         int rc;
 938
 939         rc = osd_attach_jinode(inode);
 940         if (rc)
 941                 return ERR_PTR(rc);
 942         return ldiskfs_append(handle, inode, nblock);
 943 }
 944
 945 # ifdef HAVE___LDISKFS_FIND_ENTRY
 946 #  define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
 947                 (__ldiskfs_find_entry(dir, name, de, inlined, lock) ?: \
 948                  ERR_PTR(-ENOENT))
 949 # else
 950 #  define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
 951                 (ldiskfs_find_entry_locked(dir, name, de, inlined, lock) ?: \
 952                  ERR_PTR(-ENOENT))
 953 # endif
 954
 955 # define osd_journal_start(inode, type, nblocks) \
 956                 ldiskfs_journal_start(inode, type, nblocks)
 957 # define osd_transaction_size(dev) \
 958                 (osd_journal(dev)->j_max_transaction_buffers / 2)
 959 #else /* ! defined LDISKFS_HT_MISC */
 960 # define LDISKFS_HT_MISC        0
 961 # define osd_journal_start_sb(sb, type, nblock) \
 962                 ldiskfs_journal_start_sb(sb, nblock)
 963
 964 static inline struct buffer_head *osd_ldiskfs_append(handle_t *handle,
 965                                                      struct inode *inode,
 966                                                      ldiskfs_lblk_t *nblock)
 967 {
 968         struct buffer_head *bh;
 969         int err = 0;
 970
 971         bh = ldiskfs_append(handle, inode, nblock, &err);
 972         if (bh == NULL)
 973                 bh = ERR_PTR(err);
 974
 975         return bh;
 976 }
 977
 978 # ifdef HAVE___LDISKFS_FIND_ENTRY
 979 #  define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
 980                 (__ldiskfs_find_entry(dir, name, de, lock) ?: \
 981                  ERR_PTR(-ENOENT))
 982 # else
 983 #  define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
 984                 (ldiskfs_find_entry_locked(dir, name, de, lock) ?: \
 985                  ERR_PTR(-ENOENT))
 986 # endif
 987 # define osd_journal_start(inode, type, nblocks) \
 988                 ldiskfs_journal_start(inode, nblocks)
 989 # define osd_transaction_size(dev) \
 990                 (osd_journal(dev)->j_max_transaction_buffers)
 991 #endif /* LDISKFS_HT_MISC */
 992
 993 #ifndef HAVE___LDISKFS_FIND_ENTRY
 994 # define __ldiskfs_add_entry(handle, child, inode, hlock) \
 995                 ldiskfs_add_entry_locked(handle, child, inode, hlock)
 996 #endif
 997
 998 /*
 999  * Invariants, assertions.
1000  */
1001
1002 /*
1003  * XXX: do not enable this, until invariant checking code is made thread safe
1004  * in the face of pdirops locking.
1005  */
1006 #define OSD_INVARIANT_CHECKS (0)
1007
1008 #if OSD_INVARIANT_CHECKS
1009 static inline int osd_invariant(const struct osd_object *obj)
1010 {
1011         return
1012                 obj != NULL &&
1013                 ergo(obj->oo_inode != NULL,
1014                      obj->oo_inode->i_sb == osd_sb(osd_obj2dev(obj)) &&
1015                      atomic_read(&obj->oo_inode->i_count) > 0) &&
1016                 ergo(obj->oo_dir != NULL &&
1017                      obj->oo_dir->od_conationer.ic_object != NULL,
1018                      obj->oo_dir->od_conationer.ic_object == obj->oo_inode);
1019 }
1020 #else
1021 #define osd_invariant(obj) (1)
1022 #endif
1023
1024 #define OSD_MAX_CACHE_SIZE OBD_OBJECT_EOF
1025 #define OSD_READCACHE_MAX_IO_MB         8
1026 #define OSD_WRITECACHE_MAX_IO_MB        8
1027
1028 extern const struct dt_index_operations osd_otable_ops;
1029
1030 static inline int osd_oi_fid2idx(struct osd_device *dev,
1031                                  const struct lu_fid *fid)
1032 {
1033         return fid->f_seq & (dev->od_oi_count - 1);
1034 }
1035
1036 static inline struct osd_oi *osd_fid2oi(struct osd_device *osd,
1037                                         const struct lu_fid *fid)
1038 {
1039         LASSERTF(!fid_is_idif(fid), DFID"\n", PFID(fid));
1040         LASSERTF(!fid_is_last_id(fid), DFID"\n", PFID(fid));
1041         LASSERTF(osd->od_oi_table != NULL && osd->od_oi_count >= 1,
1042                  DFID"\n", PFID(fid));
1043         /* It can work even od_oi_count equals to 1 although it's unexpected,
1044          * the only reason we set it to 1 is for performance measurement */
1045         return osd->od_oi_table[osd_oi_fid2idx(osd, fid)];
1046 }
1047
1048 extern const struct lu_device_operations  osd_lu_ops;
1049
1050 static inline int lu_device_is_osd(const struct lu_device *d)
1051 {
1052         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
1053 }
1054
1055 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
1056 {
1057         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
1058         return container_of(d, struct osd_device, od_dt_dev);
1059 }
1060
1061 static inline struct osd_device *osd_dev(const struct lu_device *d)
1062 {
1063         LASSERT(lu_device_is_osd(d));
1064         return osd_dt_dev(container_of(d, struct dt_device, dd_lu_dev));
1065 }
1066
1067 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
1068 {
1069         return osd_dev(o->oo_dt.do_lu.lo_dev);
1070 }
1071
1072 static inline struct super_block *osd_sb(const struct osd_device *dev)
1073 {
1074         return dev->od_mnt->mnt_sb;
1075 }
1076
1077 static inline const char *osd_sb2name(const struct super_block *sb)
1078 {
1079         /* this is LDISKFS_SB(sb), but preserves "const" */
1080         const struct ldiskfs_sb_info *sbi = sb->s_fs_info;
1081
1082         return sbi->s_es->s_volume_name;
1083 }
1084
1085 static inline const char *osd_dev2name(const struct osd_device *dev)
1086 {
1087         return osd_sb2name(osd_sb(dev));
1088 }
1089
1090 static inline const char *osd_ino2name(const struct inode *inode)
1091 {
1092         return osd_sb2name(inode->i_sb);
1093 }
1094
1095 /**
1096  * Put the osd object once done with it.
1097  *
1098  * \param obj osd object that needs to be put
1099  */
1100 static inline void osd_object_put(const struct lu_env *env,
1101                                   struct osd_object *obj)
1102 {
1103         dt_object_put(env, &obj->oo_dt);
1104 }
1105
1106 static inline int osd_object_is_root(const struct osd_object *obj)
1107 {
1108         return obj->oo_inode && is_root_inode(obj->oo_inode);
1109 }
1110
1111 static inline struct osd_object *osd_obj(const struct lu_object *o)
1112 {
1113         LASSERT(lu_device_is_osd(o->lo_dev));
1114         return container_of(o, struct osd_object, oo_dt.do_lu);
1115 }
1116
1117 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
1118 {
1119         return osd_obj(&d->do_lu);
1120 }
1121
1122 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
1123 {
1124         return &osd->od_dt_dev.dd_lu_dev;
1125 }
1126
1127 static inline journal_t *osd_journal(const struct osd_device *dev)
1128 {
1129         return LDISKFS_SB(osd_sb(dev))->s_journal;
1130 }
1131
1132 static inline struct seq_server_site *osd_seq_site(struct osd_device *osd)
1133 {
1134         return osd->od_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
1135 }
1136
1137 static inline char *osd_name(struct osd_device *osd)
1138 {
1139         return osd->od_svname;
1140 }
1141
1142 static inline bool osd_is_ea_inode(struct inode *inode)
1143 {
1144         return !!(LDISKFS_I(inode)->i_flags & LDISKFS_EA_INODE_FL);
1145 }
1146
1147 extern const struct dt_body_operations osd_body_ops;
1148 extern struct lu_context_key osd_key;
1149
1150 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
1151 {
1152         return lu_context_key_get(&env->le_ctx, &osd_key);
1153 }
1154
1155 extern const struct dt_body_operations osd_body_ops_new;
1156
1157 /**
1158  * IAM Iterator
1159  */
1160 static inline
1161 struct iam_path_descr *osd_it_ipd_get(const struct lu_env *env,
1162                                       const struct iam_container *bag)
1163 {
1164         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
1165                                            osd_oti_get(env)->oti_it_ipd);
1166 }
1167
1168 static inline
1169 struct iam_path_descr *osd_idx_ipd_get(const struct lu_env *env,
1170                                        const struct iam_container *bag)
1171 {
1172         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
1173                                            osd_oti_get(env)->oti_idx_ipd);
1174 }
1175
1176 static inline void osd_ipd_put(const struct lu_env *env,
1177                                const struct iam_container *bag,
1178                                struct iam_path_descr *ipd)
1179 {
1180         bag->ic_descr->id_ops->id_ipd_free(ipd);
1181 }
1182
1183 int osd_calc_bkmap_credits(struct super_block *sb, struct inode *inode,
1184                            const loff_t size, const loff_t pos,
1185                            const int blocks);
1186
1187 int osd_ldiskfs_read(struct inode *inode, void *buf, int size, loff_t *offs);
1188
1189 static inline
1190 struct dentry *osd_child_dentry_by_inode(const struct lu_env *env,
1191                                          struct inode *inode,
1192                                          const char *name, const int namelen)
1193 {
1194         struct osd_thread_info *info = osd_oti_get(env);
1195         struct dentry *child_dentry = &info->oti_child_dentry;
1196         struct dentry *obj_dentry = &info->oti_obj_dentry;
1197
1198         obj_dentry->d_inode = inode;
1199         obj_dentry->d_sb = inode->i_sb;
1200         obj_dentry->d_name.hash = 0;
1201
1202         child_dentry->d_name.hash = 0;
1203         child_dentry->d_parent = obj_dentry;
1204         child_dentry->d_name.name = name;
1205         child_dentry->d_name.len = namelen;
1206         return child_dentry;
1207 }
1208
1209 /* build quasi file structure when it is needed to call an inode i_fop */
1210 static inline struct file *osd_quasi_file_init(const struct lu_env *env,
1211                                                struct dentry *dentry,
1212                                                struct inode *inode)
1213 {
1214         struct osd_thread_info *info = osd_oti_get(env);
1215
1216         info->oti_file.f_path.dentry = dentry;
1217         info->oti_file.f_mapping = inode->i_mapping;
1218         info->oti_file.f_op = inode->i_fop;
1219         info->oti_file.f_inode = inode;
1220         info->oti_file.f_pos = 0;
1221         info->oti_file.private_data = NULL;
1222         info->oti_file.f_cred = current_cred();
1223         info->oti_file.f_flags = O_NOATIME;
1224         info->oti_file.f_mode = FMODE_64BITHASH | FMODE_NONOTIFY;
1225
1226         return &info->oti_file;
1227 }
1228
1229 static inline struct file *osd_quasi_file(const struct lu_env *env,
1230                                           struct inode *inode)
1231 {
1232         struct osd_thread_info *info = osd_oti_get(env);
1233
1234         info->oti_obj_dentry.d_inode = inode;
1235         info->oti_obj_dentry.d_sb = inode->i_sb;
1236
1237         return osd_quasi_file_init(env, &info->oti_obj_dentry, inode);
1238 }
1239
1240 static inline struct file *osd_quasi_file_by_dentry(const struct lu_env *env,
1241                                                     struct dentry *dentry)
1242 {
1243         return osd_quasi_file_init(env, dentry, dentry->d_inode);
1244 }
1245
1246 extern int osd_trans_declare_op2rb[];
1247 extern int ldiskfs_track_declares_assert;
1248 void osd_trans_dump_creds(const struct lu_env *env, struct thandle *th);
1249
1250 static inline void osd_trans_declare_op(const struct lu_env *env,
1251                                         struct osd_thandle *oh,
1252                                         enum osd_op_type op, int credits)
1253 {
1254         struct osd_thread_info *oti = osd_oti_get(env);
1255
1256         LASSERT(oh->ot_handle == NULL);
1257         if (unlikely(op >= OSD_OT_MAX)) {
1258                 if (unlikely(ldiskfs_track_declares_assert)) {
1259                         LASSERT(op < OSD_OT_MAX);
1260                 } else {
1261                         CWARN("%s: Invalid operation index %d\n",
1262                               osd_name(osd_dt_dev(oh->ot_super.th_dev)), op);
1263                         libcfs_debug_dumpstack(NULL);
1264                 }
1265         } else {
1266                 oti->oti_declare_ops[op]++;
1267                 oti->oti_declare_ops_cred[op] += credits;
1268         }
1269         oh->ot_credits += credits;
1270 }
1271
1272 /* linux: v5.4-rc3-21-g933f1c1e0b75 renamed h_buffer_credits */
1273 #ifdef HAVE_JOURNAL_TOTAL_CREDITS
1274 #define h_buffer_credits h_total_credits
1275 #endif
1276
1277 static inline void osd_trans_exec_op(const struct lu_env *env,
1278                                      struct thandle *th,
1279                                      enum osd_op_type op)
1280 {
1281         struct osd_thread_info *oti = osd_oti_get(env);
1282         struct osd_thandle     *oh  = container_of(th, struct osd_thandle,
1283                                                    ot_super);
1284         unsigned int            rb, left;
1285
1286         LASSERT(oh->ot_handle != NULL);
1287         if (unlikely(op >= OSD_OT_MAX)) {
1288                 if (unlikely(ldiskfs_track_declares_assert))
1289                         LASSERT(op < OSD_OT_MAX);
1290                 else {
1291                         CWARN("%s: opcode %u: invalid value >= %u\n",
1292                               osd_name(osd_dt_dev(oh->ot_super.th_dev)),
1293                               op, OSD_OT_MAX);
1294                         libcfs_debug_dumpstack(NULL);
1295                         return;
1296                 }
1297         }
1298
1299         /* find rollback (or reverse) operation for the given one
1300          * such an operation doesn't require additional credits
1301          * as the same set of blocks are modified */
1302         rb = osd_trans_declare_op2rb[op];
1303
1304         /* check whether credits for this operation were reserved at all */
1305         if (unlikely(oti->oti_declare_ops_cred[op] == 0 &&
1306                      oti->oti_declare_ops_cred[rb] == 0)) {
1307                 /* the API is not perfect yet: CREATE does REF_ADD internally
1308                  * while DESTROY does not. To rollback CREATE the callers
1309                  * needs to call REF_DEL+DESTROY which is hard to detect using
1310                  * a simple table of rollback operations */
1311                 if (op == OSD_OT_REF_DEL &&
1312                     oti->oti_declare_ops_cred[OSD_OT_CREATE] > 0)
1313                         goto proceed;
1314                 if (op == OSD_OT_REF_ADD &&
1315                     oti->oti_declare_ops_cred[OSD_OT_DESTROY] > 0)
1316                         goto proceed;
1317                 CWARN("%s: opcode %u: credits = 0, rollback = %u\n",
1318                       osd_name(osd_dt_dev(oh->ot_super.th_dev)), op, rb);
1319                 osd_trans_dump_creds(env, th);
1320                 LASSERT(!ldiskfs_track_declares_assert);
1321         }
1322
1323 proceed:
1324         /* remember how many credits we have unused before the operation */
1325         oti->oti_credits_before = oh->ot_handle->h_buffer_credits;
1326         left = oti->oti_declare_ops_cred[op] - oti->oti_declare_ops_used[op];
1327         if (unlikely(oti->oti_credits_before < left)) {
1328                 CWARN("%s: opcode %u: before %u < left %u, rollback = %u\n",
1329                       osd_name(osd_dt_dev(oh->ot_super.th_dev)), op,
1330                       oti->oti_credits_before, left, rb);
1331                 osd_trans_dump_creds(env, th);
1332                 /* on a very small fs (testing?) it's possible that
1333                  * the transaction can't fit 1/4 of journal, so we
1334                  * just request less credits (see osd_trans_start()).
1335                  * ignore the same case here */
1336                 rb = osd_transaction_size(osd_dt_dev(th->th_dev));
1337                 if (unlikely(oh->ot_credits < rb))
1338                         LASSERT(!ldiskfs_track_declares_assert);
1339         }
1340 }
1341
1342 static inline void osd_trans_exec_check(const struct lu_env *env,
1343                                         struct thandle *th,
1344                                         enum osd_op_type op)
1345 {
1346         struct osd_thread_info *oti = osd_oti_get(env);
1347         struct osd_thandle     *oh  = container_of(th, struct osd_thandle,
1348                                                    ot_super);
1349         int                     used, over, quota;
1350
1351         /* how many credits have been used by the operation */
1352         used = oti->oti_credits_before - oh->ot_handle->h_buffer_credits;
1353
1354         if (unlikely(used < 0)) {
1355                 /* if some block was allocated and released in the same
1356                  * transaction, then it won't be a part of the transaction
1357                  * and delta can be negative */
1358                 return;
1359         }
1360
1361         if (used == 0) {
1362                 /* rollback operations (e.g. when we destroy just created
1363                  * object) should not consume any credits. there is no point
1364                  * to confuse the checks below */
1365                 return;
1366         }
1367
1368         oti->oti_declare_ops_used[op] += used;
1369         if (oti->oti_declare_ops_used[op] <= oti->oti_declare_ops_cred[op])
1370                 return;
1371
1372         /* we account quota for a whole transaction and any operation can
1373          * consume corresponding credits */
1374         over = oti->oti_declare_ops_used[op] -
1375                 oti->oti_declare_ops_cred[op];
1376         quota = oti->oti_declare_ops_cred[OSD_OT_QUOTA] -
1377                 oti->oti_declare_ops_used[OSD_OT_QUOTA];
1378         if (over <= quota) {
1379                 /* probably that credits were consumed by
1380                  * quota indirectly (in the depths of ldiskfs) */
1381                 oti->oti_declare_ops_used[OSD_OT_QUOTA] += over;
1382                 oti->oti_declare_ops_used[op] -= over;
1383         } else {
1384                 CWARN("%s: opcode %d: used %u, used now %u, reserved %u\n",
1385                       osd_name(osd_dt_dev(oh->ot_super.th_dev)), op,
1386                       oti->oti_declare_ops_used[op], used,
1387                       oti->oti_declare_ops_cred[op]);
1388                 osd_trans_dump_creds(env, th);
1389                 if (unlikely(ldiskfs_track_declares_assert))
1390                         LBUG();
1391         }
1392 }
1393
1394 /**
1395  * Helper function to pack the fid, ldiskfs stores fid in packed format.
1396  */
1397 static inline
1398 void osd_fid_pack(struct osd_fid_pack *pack, const struct dt_rec *fid,
1399                   struct lu_fid *befider)
1400 {
1401         fid_cpu_to_be(befider, (struct lu_fid *)fid);
1402         memcpy(pack->fp_area, befider, sizeof(*befider));
1403         pack->fp_len =  sizeof(*befider) + 1;
1404 }
1405
1406 static inline
1407 int osd_fid_unpack(struct lu_fid *fid, const struct osd_fid_pack *pack)
1408 {
1409         int result;
1410
1411         result = 0;
1412         switch (pack->fp_len) {
1413         case sizeof *fid + 1:
1414                 memcpy(fid, pack->fp_area, sizeof *fid);
1415                 fid_be_to_cpu(fid, fid);
1416                 break;
1417         default:
1418                 CERROR("Unexpected packed fid size: %d\n", pack->fp_len);
1419                 result = -EIO;
1420         }
1421         return result;
1422 }
1423
1424 /**
1425  * Quota/Accounting handling
1426  */
1427 extern const struct dt_index_operations osd_acct_index_ops;
1428 int osd_acct_obj_lookup(struct osd_thread_info *info, struct osd_device *osd,
1429                         const struct lu_fid *fid, struct osd_inode_id *id);
1430
1431 /* copy from fs/ext4/dir.c */
1432 static inline int is_32bit_api(void)
1433 {
1434 #ifdef CONFIG_COMPAT
1435         return in_compat_syscall();
1436 #else
1437         return (BITS_PER_LONG == 32);
1438 #endif
1439 }
1440
1441 static inline loff_t ldiskfs_get_htree_eof(struct file *filp)
1442 {
1443         if ((filp->f_mode & FMODE_32BITHASH) ||
1444             (!(filp->f_mode & FMODE_64BITHASH) && is_32bit_api()))
1445                 return LDISKFS_HTREE_EOF_32BIT;
1446         else
1447                 return LDISKFS_HTREE_EOF_64BIT;
1448 }
1449
1450 static inline int fid_is_internal(const struct lu_fid *fid)
1451 {
1452         return (!fid_is_namespace_visible(fid) && !fid_is_idif(fid));
1453 }
1454
1455 static inline bool is_remote_parent_ino(struct osd_device *o, unsigned long ino)
1456 {
1457         if (o->od_is_ost)
1458                 return false;
1459
1460         LASSERT(o->od_mdt_map != NULL);
1461
1462         return ino == o->od_mdt_map->omm_remote_parent->d_inode->i_ino;
1463 }
1464
1465 /**
1466  * ext4_bread/ldiskfs_bread has either 5 or 4 parameters. The error
1467  * return code has been removed and integrated into the pointer in the
1468  * kernel 3.18.
1469  */
1470 static inline struct buffer_head *__ldiskfs_bread(handle_t *handle,
1471                                                   struct inode *inode,
1472                                                   ldiskfs_lblk_t block,
1473                                                   int create)
1474 {
1475         int rc = 0;
1476         struct buffer_head *bh;
1477
1478         if (create) {
1479                 rc = osd_attach_jinode(inode);
1480                 if (rc)
1481                         return ERR_PTR(rc);
1482         }
1483 #ifdef HAVE_EXT4_BREAD_4ARGS
1484         bh = ldiskfs_bread(handle, inode, block, create);
1485 #else
1486
1487         bh = ldiskfs_bread(handle, inode, block, create, &rc);
1488         if (bh == NULL && rc != 0)
1489                 bh = ERR_PTR(rc);
1490 #endif
1491         return bh;
1492 }
1493
1494 #ifndef HAVE_BIO_INTEGRITY_ENABLED
1495 bool bio_integrity_enabled(struct bio *bio);
1496 #endif
1497
1498 #ifdef HAVE_BI_BDEV
1499 # define bio_get_dev(bio)       ((bio)->bi_bdev)
1500 # define bio_get_disk(bio)      (bio_get_dev(bio)->bd_disk)
1501 # define bio_get_queue(bio)     bdev_get_queue(bio_get_dev(bio))
1502 # define bio_set_dev(bio, bdev) (bio_get_dev(bio) = (bdev))
1503 #else
1504 # define bio_get_disk(bio)      ((bio)->bi_disk)
1505 # define bio_get_queue(bio)     (bio_get_disk(bio)->queue)
1506 #endif
1507
1508 void ldiskfs_inc_count(handle_t *handle, struct inode *inode);
1509 void ldiskfs_dec_count(handle_t *handle, struct inode *inode);
1510
1511 void osd_fini_iobuf(struct osd_device *d, struct osd_iobuf *iobuf);
1512
1513 static inline int
1514 osd_index_register(struct osd_device *osd, const struct lu_fid *fid,
1515                    __u32 keysize, __u32 recsize)
1516 {
1517         return lustre_index_register(&osd->od_dt_dev, osd_name(osd),
1518                                      &osd->od_index_backup_list, &osd->od_lock,
1519                                      &osd->od_index_backup_stop,
1520                                      fid, keysize, recsize);
1521 }
1522
1523 static inline void
1524 osd_index_backup(const struct lu_env *env, struct osd_device *osd, bool backup)
1525 {
1526         struct osd_thread_info *info = osd_oti_get(env);
1527         struct lu_fid *fid = &info->oti_fid3;
1528         struct osd_inode_id *id = &info->oti_id3;
1529
1530         lu_local_obj_fid(fid, INDEX_BACKUP_OID);
1531         osd_id_gen(id, osd->od_index_backup_inode->i_ino,
1532                    osd->od_index_backup_inode->i_generation);
1533         osd_add_oi_cache(info, osd, id, fid);
1534
1535         lustre_index_backup(env, &osd->od_dt_dev, osd_name(osd),
1536                             &osd->od_index_backup_list, &osd->od_lock,
1537                             &osd->od_index_backup_stop, backup);
1538 }
1539
1540 #ifdef LDISKFS_HAS_INCOMPAT_FEATURE
1541
1542 # ifdef LDISKFS_FEATURE_INCOMPAT_EXTENTS
1543 # define ldiskfs_has_feature_extents(sb) \
1544         LDISKFS_HAS_INCOMPAT_FEATURE(sb, LDISKFS_FEATURE_INCOMPAT_EXTENTS)
1545 # endif
1546 # ifdef LDISKFS_FEATURE_INCOMPAT_EA_INODE
1547 # define ldiskfs_has_feature_ea_inode(sb) \
1548         LDISKFS_HAS_INCOMPAT_FEATURE(sb, LDISKFS_FEATURE_INCOMPAT_EA_INODE)
1549 # endif
1550 # ifdef LDISKFS_FEATURE_INCOMPAT_DIRDATA
1551 # define ldiskfs_has_feature_dirdata(sb) \
1552         LDISKFS_HAS_INCOMPAT_FEATURE(sb, LDISKFS_FEATURE_INCOMPAT_DIRDATA)
1553 # endif
1554 # ifdef LDISKFS_FEATURE_INCOMPAT_LARGEDIR
1555 # define ldiskfs_has_feature_largedir(sb) \
1556         LDISKFS_HAS_INCOMPAT_FEATURE(sb, LDISKFS_FEATURE_INCOMPAT_LARGEDIR)
1557 # define ldiskfs_set_feature_largedir(sb) \
1558         LDISKFS_SET_INCOMPAT_FEATURE(sb, LDISKFS_FEATURE_INCOMPAT_LARGEDIR)
1559 # endif
1560 # ifdef LDISKFS_FEATURE_COMPAT_HAS_JOURNAL
1561 # define ldiskfs_has_feature_journal(sb) \
1562         LDISKFS_HAS_COMPAT_FEATURE(sb, LDISKFS_FEATURE_COMPAT_HAS_JOURNAL)
1563 # endif
1564 # ifdef LDISKFS_FEATURE_RO_COMPAT_QUOTA
1565 # define ldiskfs_has_feature_quota(sb) \
1566         LDISKFS_HAS_RO_COMPAT_FEATURE(sb, LDISKFS_FEATURE_RO_COMPAT_QUOTA)
1567 # endif
1568 # ifdef LDISKFS_FEATURE_RO_COMPAT_PROJECT
1569 # define ldiskfs_has_feature_project(sb) \
1570         LDISKFS_HAS_RO_COMPAT_FEATURE(sb, LDISKFS_FEATURE_RO_COMPAT_PROJECT)
1571 # endif
1572
1573 #endif
1574
1575 int osd_trunc_lock(struct osd_object *obj, struct osd_thandle *oh,
1576                    bool shared);
1577 void osd_trunc_unlock_all(const struct lu_env *env, struct list_head *list);
1578 void osd_process_truncates(const struct lu_env *env, struct list_head *list);
1579 void osd_execute_truncate(struct osd_object *obj);
1580
1581 #ifdef HAVE_BIO_ENDIO_USES_ONE_ARG
1582 #define osd_dio_complete_routine(bio, error) dio_complete_routine(bio)
1583 #else
1584 #define osd_dio_complete_routine(bio, error) dio_complete_routine(bio, error)
1585 #endif
1586
1587 #ifndef HAVE___BI_CNT
1588 #define __bi_cnt bi_cnt
1589 #endif
1590
1591 #ifndef HAVE_BI_OPF
1592 #define bi_opf bi_rw
1593 #endif
1594
1595 #ifndef HAVE_CLEAN_BDEV_ALIASES
1596 #define clean_bdev_aliases(bdev, block, len)    \
1597         unmap_underlying_metadata((bdev), (block))
1598 #endif
1599
1600 #ifndef HAVE_BI_STATUS
1601 #define bi_status bi_error
1602 #endif
1603
1604 /*
1605  * Maximum size of xattr attributes for FEATURE_INCOMPAT_EA_INODE 1Mb
1606  * This limit is arbitrary, but is reasonable for the xattr API.
1607  */
1608 #define LDISKFS_XATTR_MAX_LARGE_EA_SIZE    (1024 * 1024)
1609
1610 struct osd_bio_private {
1611         struct osd_iobuf        *obp_iobuf;
1612         /* Start page index in the obp_iobuf for the bio */
1613         int                      obp_start_page_idx;
1614 };
1615
1616 #ifdef HAVE_BIO_INTEGRITY_PREP_FN
1617 int osd_get_integrity_profile(struct osd_device *osd,
1618                               integrity_gen_fn **generate_fn,
1619                               integrity_vrfy_fn **verify_fn);
1620 #else
1621 #define integrity_gen_fn void
1622 #define integrity_vrfy_fn int
1623 static inline int osd_get_integrity_profile(struct osd_device *osd,
1624                                             integrity_gen_fn **generate_fn,
1625                                             integrity_vrfy_fn **verify_fn)
1626 {
1627         return 0;
1628 }
1629
1630 static inline bool bio_integrity_prep_fn(struct bio *bio,
1631                                          integrity_gen_fn *generate_fn,
1632                                          integrity_vrfy_fn *verify_fn)
1633 {
1634         return bio_integrity_prep(bio);
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 #endif /* _OSD_INTERNAL_H */