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