lustre/osd-ldiskfs/osd_internal.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2014, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/osd/osd_internal.h
  37  *
  38  * Shared definitions and declarations for osd module
  39  *
  40  * Author: Nikita Danilov <nikita@clusterfs.com>
  41  */
  42
  43 #ifndef _OSD_INTERNAL_H
  44 #define _OSD_INTERNAL_H
  45
  46
  47 /* struct mutex */
  48 #include <linux/mutex.h>
  49 /* struct rw_semaphore */
  50 #include <linux/rwsem.h>
  51 /* struct dentry */
  52 #include <linux/dcache.h>
  53 /* struct dirent64 */
  54 #include <linux/dirent.h>
  55 #include <linux/statfs.h>
  56 #include <ldiskfs/ldiskfs.h>
  57 #include <ldiskfs/ldiskfs_jbd2.h>
  58
  59 /* LUSTRE_OSD_NAME */
  60 #include <obd.h>
  61 /* class_register_type(), class_unregister_type(), class_get_type() */
  62 #include <obd_class.h>
  63 #include <lustre_disk.h>
  64 #include <dt_object.h>
  65 #include <lustre_quota.h>
  66
  67 #include "osd_oi.h"
  68 #include "osd_iam.h"
  69 #include "osd_scrub.h"
  70 #include "osd_quota_fmt.h"
  71
  72 struct inode;
  73 extern struct kmem_cache *dynlock_cachep;
  74
  75 #define OSD_COUNTERS (0)
  76
  77 /* ldiskfs special inode::i_state_flags need to be accessed with
  78  * ldiskfs_{set,clear,test}_inode_state() only */
  79
  80 /* OI scrub should skip this inode. */
  81 #define LDISKFS_STATE_LUSTRE_NOSCRUB    31
  82
  83 /** Enable thandle usage statistics */
  84 #define OSD_THANDLE_STATS (0)
  85
  86 #define MAX_OBJID_GROUP (FID_SEQ_ECHO + 1)
  87
  88 #define OBJECTS         "OBJECTS"
  89 #define ADMIN_USR       "admin_quotafile_v2.usr"
  90 #define ADMIN_GRP       "admin_quotafile_v2.grp"
  91
  92 struct osd_directory {
  93         struct iam_container od_container;
  94         struct iam_descr     od_descr;
  95 };
  96
  97 /*
  98  * Object Index (oi) instance.
  99  */
 100 struct osd_oi {
 101         /*
 102          * underlying index object, where fid->id mapping in stored.
 103          */
 104         struct inode         *oi_inode;
 105         struct osd_directory  oi_dir;
 106 };
 107
 108 extern const int osd_dto_credits_noquota[];
 109
 110 struct osd_object {
 111         struct dt_object        oo_dt;
 112         /**
 113          * Inode for file system object represented by this osd_object. This
 114          * inode is pinned for the whole duration of lu_object life.
 115          *
 116          * Not modified concurrently (either setup early during object
 117          * creation, or assigned by osd_object_create() under write lock).
 118          */
 119         struct inode           *oo_inode;
 120         /**
 121          * to protect index ops.
 122          */
 123         struct htree_lock_head *oo_hl_head;
 124         struct rw_semaphore     oo_ext_idx_sem;
 125         struct rw_semaphore     oo_sem;
 126         struct osd_directory    *oo_dir;
 127         /** protects inode attributes. */
 128         spinlock_t              oo_guard;
 129         /**
 130          * Following two members are used to indicate the presence of dot and
 131          * dotdot in the given directory. This is required for interop mode
 132          * (b11826).
 133          */
 134         int                     oo_compat_dot_created;
 135         int                     oo_compat_dotdot_created;
 136
 137         const struct lu_env    *oo_owner;
 138 #ifdef CONFIG_LOCKDEP
 139         struct lockdep_map      oo_dep_map;
 140 #endif
 141 };
 142
 143 struct osd_obj_seq {
 144         /* protects on-fly initialization */
 145         int              oos_subdir_count; /* subdir count for each seq */
 146         struct dentry    *oos_root;        /* O/<seq> */
 147         struct dentry    **oos_dirs;       /* O/<seq>/d0-dXX */
 148         u64              oos_seq;          /* seq number */
 149         struct list_head oos_seq_list;     /* list to seq_list */
 150 };
 151
 152 struct osd_obj_map {
 153         struct dentry    *om_root;        /* dentry for /O */
 154         rwlock_t         om_seq_list_lock; /* lock for seq_list */
 155         struct list_head om_seq_list;      /* list head for seq */
 156         int              om_subdir_count;
 157         struct mutex     om_dir_init_mutex;
 158 };
 159
 160 struct osd_mdobj {
 161         struct dentry   *om_root;      /* AGENT/<index> */
 162         u64              om_index;     /* mdt index */
 163         struct list_head om_list;      /* list to omm_list */
 164 };
 165
 166 struct osd_mdobj_map {
 167         struct dentry   *omm_remote_parent;
 168 };
 169
 170 #define osd_ldiskfs_add_entry(handle, child, cinode, hlock) \
 171         ldiskfs_add_entry(handle, child, cinode, hlock)
 172
 173 #define OSD_OTABLE_IT_CACHE_SIZE        64
 174 #define OSD_OTABLE_IT_CACHE_MASK        (~(OSD_OTABLE_IT_CACHE_SIZE - 1))
 175
 176 struct osd_inconsistent_item {
 177         /* link into osd_scrub::os_inconsistent_items,
 178          * protected by osd_scrub::os_lock. */
 179         struct list_head       oii_list;
 180
 181         /* The right FID <=> ino#/gen mapping. */
 182         struct osd_idmap_cache oii_cache;
 183
 184         unsigned int           oii_insert:1; /* insert or update mapping. */
 185 };
 186
 187 struct osd_otable_cache {
 188         struct osd_idmap_cache ooc_cache[OSD_OTABLE_IT_CACHE_SIZE];
 189
 190         /* Index for next cache slot to be filled. */
 191         int                    ooc_producer_idx;
 192
 193         /* Index for next cache slot to be returned by it::next(). */
 194         int                    ooc_consumer_idx;
 195
 196         /* How many items in ooc_cache. */
 197         int                    ooc_cached_items;
 198
 199         /* Position for up layer LFSCK iteration pre-loading. */
 200         __u32                  ooc_pos_preload;
 201 };
 202
 203 struct osd_otable_it {
 204         struct osd_device       *ooi_dev;
 205         struct osd_otable_cache  ooi_cache;
 206
 207         /* The following bits can be updated/checked w/o lock protection.
 208          * If more bits will be introduced in the future and need lock to
 209          * protect, please add comment. */
 210         unsigned long            ooi_used_outside:1, /* Some user out of OSD
 211                                                       * uses the iteration. */
 212                                  ooi_all_cached:1, /* No more entries can be
 213                                                     * filled into cache. */
 214                                  ooi_user_ready:1, /* The user out of OSD is
 215                                                     * ready to iterate. */
 216                                  ooi_waiting:1; /* it::next is waiting. */
 217 };
 218
 219 /*
 220  * osd device.
 221  */
 222 struct osd_device {
 223         /* super-class */
 224         struct dt_device          od_dt_dev;
 225         /* information about underlying file system */
 226         struct vfsmount          *od_mnt;
 227         /* object index */
 228         struct osd_oi           **od_oi_table;
 229         /* total number of OI containers */
 230         int                       od_oi_count;
 231         /*
 232          * Fid Capability
 233          */
 234         unsigned int              od_fl_capa:1,
 235                                   od_maybe_new:1,
 236                                   od_noscrub:1,
 237                                   od_igif_inoi:1,
 238                                   od_check_ff:1,
 239                                   od_is_ost:1,
 240                                   od_lma_self_repair:1;
 241
 242         unsigned long             od_capa_timeout;
 243         __u32                     od_capa_alg;
 244         __u32                     od_dirent_journal;
 245         struct lustre_capa_key   *od_capa_keys;
 246         struct hlist_head        *od_capa_hash;
 247
 248         struct proc_dir_entry    *od_proc_entry;
 249         struct lprocfs_stats     *od_stats;
 250
 251         spinlock_t                od_osfs_lock;
 252
 253         int                       od_connects;
 254         struct lu_site            od_site;
 255
 256         struct osd_obj_map      *od_ost_map;
 257         struct osd_mdobj_map    *od_mdt_map;
 258
 259         unsigned long long      od_readcache_max_filesize;
 260         int                     od_read_cache;
 261         int                     od_writethrough_cache;
 262
 263         struct brw_stats        od_brw_stats;
 264         atomic_t                od_r_in_flight;
 265         atomic_t                od_w_in_flight;
 266
 267         struct mutex              od_otable_mutex;
 268         struct osd_otable_it     *od_otable_it;
 269         struct osd_scrub          od_scrub;
 270         struct list_head                  od_ios_list;
 271
 272         /* service name associated with the osd device */
 273         char                      od_svname[MAX_OBD_NAME];
 274         char                      od_mntdev[MAX_OBD_NAME];
 275
 276         /* quota slave instance */
 277         struct qsd_instance      *od_quota_slave;
 278
 279         /* osd seq instance */
 280         struct lu_client_seq    *od_cl_seq;
 281         /* If the ratio of "the total OI mappings count" vs
 282          * "the bad OI mappings count" is lower than the
 283          * osd_device::od_full_scrub_ratio, then trigger
 284          * OI scrub to scan the whole the device. */
 285         __u64                    od_full_scrub_ratio;
 286         /* If the speed of found bad OI mappings (per minute)
 287          * exceeds the osd_device::od_full_scrub_threshold_rate,
 288          * then trigger OI scrub to scan the whole device. */
 289         __u64                    od_full_scrub_threshold_rate;
 290 };
 291
 292 enum osd_full_scrub_ratio {
 293         /* Trigger OI scrub to scan the whole device directly. */
 294         OFSR_DIRECTLY   = 0,
 295
 296         /* Because the bad OI mappings count cannot be larger than
 297          * the total OI mappints count, then setting OFSR_NEVER means
 298          * that the whole device scanning cannot be triggered by auto
 299          * detected bad OI mappings during the RPC services. */
 300         OFSR_NEVER      = 1,
 301         OFSR_DEFAULT    = 10000,
 302 };
 303
 304 #define FULL_SCRUB_THRESHOLD_RATE_DEFAULT       60
 305
 306 /* There are at most 10 uid/gids are affected in a transaction, and
 307  * that's rename case:
 308  * - 2 for source parent uid & gid;
 309  * - 2 for source child uid & gid ('..' entry update when child is directory);
 310  * - 2 for target parent uid & gid;
 311  * - 2 for target child uid & gid (if the target child exists);
 312  * - 2 for root uid & gid (last_rcvd, llog, etc);
 313  *
 314  * The 0 to (OSD_MAX_UGID_CNT - 1) bits of ot_id_type is for indicating
 315  * the id type of each id in the ot_id_array.
 316  */
 317 #define OSD_MAX_UGID_CNT        10
 318
 319 enum {
 320         OSD_OT_ATTR_SET         = 0,
 321         OSD_OT_PUNCH            = 1,
 322         OSD_OT_XATTR_SET        = 2,
 323         OSD_OT_CREATE           = 3,
 324         OSD_OT_DESTROY          = 4,
 325         OSD_OT_REF_ADD          = 5,
 326         OSD_OT_REF_DEL          = 6,
 327         OSD_OT_WRITE            = 7,
 328         OSD_OT_INSERT           = 8,
 329         OSD_OT_DELETE           = 9,
 330         OSD_OT_UPDATE           = 10,
 331         OSD_OT_QUOTA            = 11,
 332         OSD_OT_MAX              = 12
 333 };
 334
 335 struct osd_thandle {
 336         struct thandle          ot_super;
 337         handle_t               *ot_handle;
 338         struct ldiskfs_journal_cb_entry ot_jcb;
 339         struct list_head              ot_dcb_list;
 340         /* Link to the device, for debugging. */
 341         struct lu_ref_link      ot_dev_link;
 342         unsigned short          ot_credits;
 343         unsigned short          ot_id_cnt;
 344         unsigned short          ot_id_type;
 345         uid_t                   ot_id_array[OSD_MAX_UGID_CNT];
 346         struct lquota_trans    *ot_quota_trans;
 347 #if OSD_THANDLE_STATS
 348         /** time when this handle was allocated */
 349         cfs_time_t oth_alloced;
 350
 351         /** time when this thanle was started */
 352         cfs_time_t oth_started;
 353 #endif
 354 };
 355
 356 /**
 357  * Basic transaction credit op
 358  */
 359 enum dt_txn_op {
 360         DTO_INDEX_INSERT,
 361         DTO_INDEX_DELETE,
 362         DTO_INDEX_UPDATE,
 363         DTO_OBJECT_CREATE,
 364         DTO_OBJECT_DELETE,
 365         DTO_ATTR_SET_BASE,
 366         DTO_XATTR_SET,
 367         DTO_WRITE_BASE,
 368         DTO_WRITE_BLOCK,
 369         DTO_ATTR_SET_CHOWN,
 370
 371         DTO_NR
 372 };
 373
 374 /*
 375  * osd dev stats
 376  */
 377
 378 #ifdef LPROCFS
 379 enum {
 380         LPROC_OSD_READ_BYTES    = 0,
 381         LPROC_OSD_WRITE_BYTES   = 1,
 382         LPROC_OSD_GET_PAGE      = 2,
 383         LPROC_OSD_NO_PAGE       = 3,
 384         LPROC_OSD_CACHE_ACCESS  = 4,
 385         LPROC_OSD_CACHE_HIT     = 5,
 386         LPROC_OSD_CACHE_MISS    = 6,
 387
 388 #if OSD_THANDLE_STATS
 389         LPROC_OSD_THANDLE_STARTING,
 390         LPROC_OSD_THANDLE_OPEN,
 391         LPROC_OSD_THANDLE_CLOSING,
 392 #endif
 393         LPROC_OSD_LAST,
 394 };
 395 #endif
 396
 397 /**
 398  * Storage representation for fids.
 399  *
 400  * Variable size, first byte contains the length of the whole record.
 401  */
 402 struct osd_fid_pack {
 403         unsigned char fp_len;
 404         char fp_area[sizeof(struct lu_fid)];
 405 };
 406
 407 struct osd_it_ea_dirent {
 408         struct lu_fid   oied_fid;
 409         __u64           oied_ino;
 410         __u64           oied_off;
 411         unsigned short  oied_namelen;
 412         unsigned int    oied_type;
 413         char            oied_name[0];
 414 } __attribute__((packed));
 415
 416 /**
 417  * as osd_it_ea_dirent (in memory dirent struct for osd) is greater
 418  * than lu_dirent struct. osd readdir reads less number of dirent than
 419  * required for mdd dir page. so buffer size need to be increased so that
 420  * there  would be one ext3 readdir for every mdd readdir page.
 421  */
 422
 423 #define OSD_IT_EA_BUFSIZE       (PAGE_CACHE_SIZE + PAGE_CACHE_SIZE/4)
 424
 425 /**
 426  * This is iterator's in-memory data structure in interoperability
 427  * mode (i.e. iterator over ldiskfs style directory)
 428  */
 429 struct osd_it_ea {
 430         struct osd_object   *oie_obj;
 431         /** used in ldiskfs iterator, to stored file pointer */
 432         struct file          oie_file;
 433         /** how many entries have been read-cached from storage */
 434         int                  oie_rd_dirent;
 435         /** current entry is being iterated by caller */
 436         int                  oie_it_dirent;
 437         /** current processing entry */
 438         struct osd_it_ea_dirent *oie_dirent;
 439         /** buffer to hold entries, size == OSD_IT_EA_BUFSIZE */
 440         void                *oie_buf;
 441 };
 442
 443 /**
 444  * Iterator's in-memory data structure for IAM mode.
 445  */
 446 struct osd_it_iam {
 447         struct osd_object     *oi_obj;
 448         struct iam_path_descr *oi_ipd;
 449         struct iam_iterator    oi_it;
 450 };
 451
 452 struct osd_quota_leaf {
 453         struct list_head        oql_link;
 454         uint            oql_blk;
 455 };
 456
 457 /**
 458  * Iterator's in-memory data structure for quota file.
 459  */
 460 struct osd_it_quota {
 461         struct osd_object       *oiq_obj;
 462         /** tree blocks path to where the entry is stored */
 463         uint                     oiq_blk[LUSTRE_DQTREEDEPTH + 1];
 464         /** on-disk offset for current key where quota record can be found */
 465         loff_t                   oiq_offset;
 466         /** identifier for current quota record */
 467         __u64                    oiq_id;
 468         /** the record index in the leaf/index block */
 469         uint                     oiq_index[LUSTRE_DQTREEDEPTH + 1];
 470         /** list of already processed leaf blocks */
 471         struct list_head         oiq_list;
 472 };
 473
 474 #define MAX_BLOCKS_PER_PAGE (PAGE_CACHE_SIZE / 512)
 475
 476 struct osd_iobuf {
 477         wait_queue_head_t  dr_wait;
 478         atomic_t       dr_numreqs;  /* number of reqs being processed */
 479         int                dr_max_pages;
 480         int                dr_npages;
 481         int                dr_error;
 482         int                dr_frags;
 483         unsigned int       dr_ignore_quota:1;
 484         unsigned int       dr_elapsed_valid:1; /* we really did count time */
 485         unsigned int       dr_rw:1;
 486         struct lu_buf      dr_pg_buf;
 487         struct page      **dr_pages;
 488         struct lu_buf      dr_bl_buf;
 489         unsigned long     *dr_blocks;
 490         unsigned long      dr_start_time;
 491         unsigned long      dr_elapsed;  /* how long io took */
 492         struct osd_device *dr_dev;
 493         unsigned int       dr_init_at;  /* the line iobuf was initialized */
 494 };
 495
 496 struct osd_thread_info {
 497         const struct lu_env   *oti_env;
 498         /**
 499          * used for index operations.
 500          */
 501         struct dentry          oti_obj_dentry;
 502         struct dentry          oti_child_dentry;
 503
 504         /** dentry for Iterator context. */
 505         struct dentry          oti_it_dentry;
 506         struct htree_lock     *oti_hlock;
 507
 508         struct lu_fid          oti_fid;
 509         struct lu_fid          oti_fid2;
 510         struct lu_fid          oti_fid3;
 511         struct osd_inode_id    oti_id;
 512         struct osd_inode_id    oti_id2;
 513         struct osd_inode_id    oti_id3;
 514         struct ost_id          oti_ostid;
 515
 516         /*
 517          * XXX temporary: for ->i_op calls.
 518          */
 519         struct timespec        oti_time;
 520         /*
 521          * XXX temporary: fake struct file for osd_object_sync
 522          */
 523         struct file            oti_file;
 524         /*
 525          * XXX temporary: for capa operations.
 526          */
 527         struct lustre_capa_key oti_capa_key;
 528         struct lustre_capa     oti_capa;
 529
 530         /** osd_device reference, initialized in osd_trans_start() and
 531             used in osd_trans_stop() */
 532         struct osd_device     *oti_dev;
 533
 534         /**
 535          * following ipd and it structures are used for osd_index_iam_lookup()
 536          * these are defined separately as we might do index operation
 537          * in open iterator session.
 538          */
 539
 540         /** osd iterator context used for iterator session */
 541
 542         union {
 543                 struct osd_it_iam       oti_it;
 544                 /* ldiskfs iterator data structure,
 545                  * see osd_it_ea_{init, fini} */
 546                 struct osd_it_ea        oti_it_ea;
 547                 struct osd_it_quota     oti_it_quota;
 548         };
 549
 550         /** pre-allocated buffer used by oti_it_ea, size OSD_IT_EA_BUFSIZE */
 551         void                    *oti_it_ea_buf;
 552
 553         struct kstatfs          oti_ksfs;
 554
 555         /** IAM iterator for index operation. */
 556         struct iam_iterator    oti_idx_it;
 557
 558         /** union to guarantee that ->oti_ipd[] has proper alignment. */
 559         union {
 560                 char           oti_it_ipd[DX_IPD_MAX_SIZE];
 561                 long long      oti_alignment_lieutenant;
 562         };
 563
 564         union {
 565                 char           oti_idx_ipd[DX_IPD_MAX_SIZE];
 566                 long long      oti_alignment_lieutenant_colonel;
 567         };
 568
 569         struct osd_idmap_cache oti_cache;
 570
 571         unsigned int           oti_it_inline:1;
 572         int                    oti_r_locks;
 573         int                    oti_w_locks;
 574         int                    oti_txns;
 575         /** used in osd_fid_set() to put xattr */
 576         struct lu_buf          oti_buf;
 577         struct lu_buf          oti_big_buf;
 578         /** used in osd_ea_fid_set() to set fid into common ea */
 579         union {
 580                 struct lustre_mdt_attrs oti_mdt_attrs;
 581                 /* old LMA for compatibility */
 582                 char                    oti_mdt_attrs_old[LMA_OLD_SIZE];
 583         };
 584         /** 0-copy IO */
 585         struct osd_iobuf       oti_iobuf;
 586         struct inode           oti_inode;
 587 #define OSD_FID_REC_SZ 32
 588         char                   oti_ldp[OSD_FID_REC_SZ];
 589         char                   oti_ldp2[OSD_FID_REC_SZ];
 590
 591         /* used by quota code */
 592         union {
 593 #ifdef HAVE_DQUOT_FS_DISK_QUOTA
 594                 struct fs_disk_quota    oti_fdq;
 595 #else
 596                 struct if_dqblk         oti_dqblk;
 597 #endif
 598                 struct if_dqinfo        oti_dqinfo;
 599         };
 600         struct lquota_id_info   oti_qi;
 601         struct lquota_trans     oti_quota_trans;
 602         union lquota_rec        oti_quota_rec;
 603         __u64                   oti_quota_id;
 604         struct lu_seq_range     oti_seq_range;
 605
 606         /* Tracking for transaction credits, to allow debugging and optimizing
 607          * cases where a large number of credits are being allocated for
 608          * single transaction. */
 609         unsigned short          oti_declare_ops[OSD_OT_MAX];
 610         unsigned short          oti_declare_ops_rb[OSD_OT_MAX];
 611         unsigned short          oti_declare_ops_cred[OSD_OT_MAX];
 612         bool                    oti_rollback;
 613
 614         char                    oti_name[48];
 615         union {
 616                 struct filter_fid_old   oti_ff;
 617                 struct filter_fid       oti_ff_new;
 618         };
 619 };
 620
 621 extern int ldiskfs_pdo;
 622
 623 static inline int __osd_xattr_get(struct inode *inode, struct dentry *dentry,
 624                                   const char *name, void *buf, int len)
 625 {
 626         if (inode == NULL)
 627                 return -EINVAL;
 628
 629         dentry->d_inode = inode;
 630         dentry->d_sb = inode->i_sb;
 631         return inode->i_op->getxattr(dentry, name, buf, len);
 632 }
 633
 634 static inline int __osd_xattr_set(struct osd_thread_info *info,
 635                                   struct inode *inode, const char *name,
 636                                   const void *buf, int buflen, int fl)
 637 {
 638         struct dentry *dentry = &info->oti_child_dentry;
 639
 640         ll_vfs_dq_init(inode);
 641         dentry->d_inode = inode;
 642         dentry->d_sb = inode->i_sb;
 643         return inode->i_op->setxattr(dentry, name, buf, buflen, fl);
 644 }
 645
 646 #ifdef LPROCFS
 647 /* osd_lproc.c */
 648 extern struct lprocfs_seq_vars lprocfs_osd_obd_vars[];
 649 extern struct lprocfs_seq_vars lprocfs_osd_module_vars[];
 650 int osd_procfs_init(struct osd_device *osd, const char *name);
 651 int osd_procfs_fini(struct osd_device *osd);
 652 void osd_brw_stats_update(struct osd_device *osd, struct osd_iobuf *iobuf);
 653
 654 #endif
 655 int osd_statfs(const struct lu_env *env, struct dt_device *dev,
 656                struct obd_statfs *sfs);
 657 int osd_object_auth(const struct lu_env *env, struct dt_object *dt,
 658                     struct lustre_capa *capa, __u64 opc);
 659 struct inode *osd_iget(struct osd_thread_info *info, struct osd_device *dev,
 660                        struct osd_inode_id *id);
 661 int osd_ea_fid_set(struct osd_thread_info *info, struct inode *inode,
 662                    const struct lu_fid *fid, __u32 compat, __u32 incompat);
 663 int osd_get_lma(struct osd_thread_info *info, struct inode *inode,
 664                 struct dentry *dentry, struct lustre_mdt_attrs *lma);
 665 void osd_add_oi_cache(struct osd_thread_info *info, struct osd_device *osd,
 666                       struct osd_inode_id *id, const struct lu_fid *fid);
 667 int osd_get_idif(struct osd_thread_info *info, struct inode *inode,
 668                  struct dentry *dentry, struct lu_fid *fid);
 669
 670 int osd_obj_map_init(const struct lu_env *env, struct osd_device *osd);
 671 void osd_obj_map_fini(struct osd_device *dev);
 672 int osd_obj_map_lookup(struct osd_thread_info *info, struct osd_device *osd,
 673                         const struct lu_fid *fid, struct osd_inode_id *id);
 674 int osd_obj_map_insert(struct osd_thread_info *info, struct osd_device *osd,
 675                        const struct lu_fid *fid, const struct osd_inode_id *id,
 676                        handle_t *th);
 677 int osd_obj_map_delete(struct osd_thread_info *info, struct osd_device *osd,
 678                         const struct lu_fid *fid, handle_t *th);
 679 int osd_obj_map_update(struct osd_thread_info *info, struct osd_device *osd,
 680                        const struct lu_fid *fid, const struct osd_inode_id *id,
 681                        handle_t *th);
 682 int osd_obj_map_recover(struct osd_thread_info *info, struct osd_device *osd,
 683                         struct inode *src_parent, struct dentry *src_child,
 684                         const struct lu_fid *fid);
 685 int osd_obj_spec_lookup(struct osd_thread_info *info, struct osd_device *osd,
 686                         const struct lu_fid *fid, struct osd_inode_id *id);
 687 int osd_obj_spec_insert(struct osd_thread_info *info, struct osd_device *osd,
 688                         const struct lu_fid *fid, const struct osd_inode_id *id,
 689                         handle_t *th);
 690 int osd_obj_spec_update(struct osd_thread_info *info, struct osd_device *osd,
 691                         const struct lu_fid *fid, const struct osd_inode_id *id,
 692                         handle_t *th);
 693
 694 void osd_scrub_file_reset(struct osd_scrub *scrub, __u8 *uuid, __u64 flags);
 695 int osd_scrub_file_store(struct osd_scrub *scrub);
 696 char *osd_lf_fid2name(const struct lu_fid *fid);
 697 int osd_scrub_start(struct osd_device *dev, __u32 flags);
 698 int osd_scrub_setup(const struct lu_env *env, struct osd_device *dev);
 699 void osd_scrub_cleanup(const struct lu_env *env, struct osd_device *dev);
 700 int osd_oii_insert(struct osd_device *dev, struct osd_idmap_cache *oic,
 701                    int insert);
 702 int osd_oii_lookup(struct osd_device *dev, const struct lu_fid *fid,
 703                    struct osd_inode_id *id);
 704 int osd_scrub_dump(struct seq_file *m, struct osd_device *dev);
 705
 706 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
 707                    u64 seq, struct lu_seq_range *range);
 708
 709 int osd_delete_from_remote_parent(const struct lu_env *env,
 710                                   struct osd_device *osd,
 711                                   struct osd_object *obj,
 712                                   struct osd_thandle *oh);
 713 int osd_add_to_remote_parent(const struct lu_env *env, struct osd_device *osd,
 714                              struct osd_object *obj, struct osd_thandle *oh);
 715 int osd_lookup_in_remote_parent(struct osd_thread_info *oti,
 716                                 struct osd_device *osd,
 717                                 const struct lu_fid *fid,
 718                                 struct osd_inode_id *id);
 719
 720 int osd_ost_seq_exists(struct osd_thread_info *info, struct osd_device *osd,
 721                        __u64 seq);
 722 /* osd_quota_fmt.c */
 723 int walk_tree_dqentry(const struct lu_env *env, struct osd_object *obj,
 724                       int type, uint blk, int depth, uint index,
 725                       struct osd_it_quota *it);
 726 int walk_block_dqentry(const struct lu_env *env, struct osd_object *obj,
 727                        int type, uint blk, uint index,
 728                        struct osd_it_quota *it);
 729 loff_t find_tree_dqentry(const struct lu_env *env,
 730                          struct osd_object *obj, int type,
 731                          qid_t dqid, uint blk, int depth,
 732                          struct osd_it_quota *it);
 733 /* osd_quota.c */
 734 int osd_declare_qid(const struct lu_env *env, struct osd_thandle *oh,
 735                     struct lquota_id_info *qi, struct osd_object *obj,
 736                     bool enforce, int *flags);
 737 int osd_declare_inode_qid(const struct lu_env *env, qid_t uid, qid_t gid,
 738                           long long space, struct osd_thandle *oh,
 739                           struct osd_object *obj, bool is_blk, int *flags,
 740                           bool force);
 741 const struct dt_rec *osd_quota_pack(struct osd_object *obj,
 742                                     const struct dt_rec *rec,
 743                                     union lquota_rec *quota_rec);
 744 void osd_quota_unpack(struct osd_object *obj, const struct dt_rec *rec);
 745 int osd_quota_migration(const struct lu_env *env, struct dt_object *dt,
 746                         const struct dt_index_features *feat);
 747
 748 static inline bool is_quota_glb_feat(const struct dt_index_features *feat)
 749 {
 750         return (feat == &dt_quota_iusr_features ||
 751                 feat == &dt_quota_busr_features ||
 752                 feat == &dt_quota_igrp_features ||
 753                 feat == &dt_quota_bgrp_features) ? true : false;
 754 }
 755
 756 #ifndef HAVE_I_UID_READ
 757 static inline uid_t i_uid_read(const struct inode *inode)
 758 {
 759         return inode->i_uid;
 760 }
 761
 762 static inline gid_t i_gid_read(const struct inode *inode)
 763 {
 764         return inode->i_gid;
 765 }
 766
 767 static inline void i_uid_write(struct inode *inode, uid_t uid)
 768 {
 769         inode->i_uid = uid;
 770 }
 771
 772 static inline void i_gid_write(struct inode *inode, gid_t gid)
 773 {
 774         inode->i_gid = gid;
 775 }
 776 #endif
 777
 778 /*
 779  * Invariants, assertions.
 780  */
 781
 782 /*
 783  * XXX: do not enable this, until invariant checking code is made thread safe
 784  * in the face of pdirops locking.
 785  */
 786 #define OSD_INVARIANT_CHECKS (0)
 787
 788 #if OSD_INVARIANT_CHECKS
 789 static inline int osd_invariant(const struct osd_object *obj)
 790 {
 791         return
 792                 obj != NULL &&
 793                 ergo(obj->oo_inode != NULL,
 794                      obj->oo_inode->i_sb == osd_sb(osd_obj2dev(obj)) &&
 795                      atomic_read(&obj->oo_inode->i_count) > 0) &&
 796                 ergo(obj->oo_dir != NULL &&
 797                      obj->oo_dir->od_conationer.ic_object != NULL,
 798                      obj->oo_dir->od_conationer.ic_object == obj->oo_inode);
 799 }
 800 #else
 801 #define osd_invariant(obj) (1)
 802 #endif
 803
 804 #define OSD_MAX_CACHE_SIZE OBD_OBJECT_EOF
 805
 806 extern const struct dt_index_operations osd_otable_ops;
 807
 808 static inline int osd_oi_fid2idx(struct osd_device *dev,
 809                                  const struct lu_fid *fid)
 810 {
 811         return fid->f_seq & (dev->od_oi_count - 1);
 812 }
 813
 814 static inline struct osd_oi *osd_fid2oi(struct osd_device *osd,
 815                                         const struct lu_fid *fid)
 816 {
 817         LASSERTF(!fid_is_idif(fid), DFID"\n", PFID(fid));
 818         LASSERTF(!fid_is_last_id(fid), DFID"\n", PFID(fid));
 819         LASSERTF(osd->od_oi_table != NULL && osd->od_oi_count >= 1,
 820                  DFID"\n", PFID(fid));
 821         /* It can work even od_oi_count equals to 1 although it's unexpected,
 822          * the only reason we set it to 1 is for performance measurement */
 823         return osd->od_oi_table[osd_oi_fid2idx(osd, fid)];
 824 }
 825
 826 extern const struct lu_device_operations  osd_lu_ops;
 827
 828 static inline int lu_device_is_osd(const struct lu_device *d)
 829 {
 830         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
 831 }
 832
 833 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
 834 {
 835         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
 836         return container_of0(d, struct osd_device, od_dt_dev);
 837 }
 838
 839 static inline struct osd_device *osd_dev(const struct lu_device *d)
 840 {
 841         LASSERT(lu_device_is_osd(d));
 842         return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
 843 }
 844
 845 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
 846 {
 847         return osd_dev(o->oo_dt.do_lu.lo_dev);
 848 }
 849
 850 static inline struct super_block *osd_sb(const struct osd_device *dev)
 851 {
 852         return dev->od_mnt->mnt_sb;
 853 }
 854
 855 static inline int osd_object_is_root(const struct osd_object *obj)
 856 {
 857         return osd_sb(osd_obj2dev(obj))->s_root->d_inode == obj->oo_inode;
 858 }
 859
 860 static inline struct osd_object *osd_obj(const struct lu_object *o)
 861 {
 862         LASSERT(lu_device_is_osd(o->lo_dev));
 863         return container_of0(o, struct osd_object, oo_dt.do_lu);
 864 }
 865
 866 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
 867 {
 868         return osd_obj(&d->do_lu);
 869 }
 870
 871 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
 872 {
 873         return &osd->od_dt_dev.dd_lu_dev;
 874 }
 875
 876 static inline journal_t *osd_journal(const struct osd_device *dev)
 877 {
 878         return LDISKFS_SB(osd_sb(dev))->s_journal;
 879 }
 880
 881 static inline struct seq_server_site *osd_seq_site(struct osd_device *osd)
 882 {
 883         return osd->od_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
 884 }
 885
 886 static inline char *osd_name(struct osd_device *osd)
 887 {
 888         return osd->od_dt_dev.dd_lu_dev.ld_obd->obd_name;
 889 }
 890
 891 extern const struct dt_body_operations osd_body_ops;
 892 extern struct lu_context_key osd_key;
 893
 894 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
 895 {
 896         return lu_context_key_get(&env->le_ctx, &osd_key);
 897 }
 898
 899 extern const struct dt_body_operations osd_body_ops_new;
 900
 901 /**
 902  * IAM Iterator
 903  */
 904 static inline
 905 struct iam_path_descr *osd_it_ipd_get(const struct lu_env *env,
 906                                       const struct iam_container *bag)
 907 {
 908         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
 909                                            osd_oti_get(env)->oti_it_ipd);
 910 }
 911
 912 static inline
 913 struct iam_path_descr *osd_idx_ipd_get(const struct lu_env *env,
 914                                        const struct iam_container *bag)
 915 {
 916         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
 917                                            osd_oti_get(env)->oti_idx_ipd);
 918 }
 919
 920 static inline void osd_ipd_put(const struct lu_env *env,
 921                                const struct iam_container *bag,
 922                                struct iam_path_descr *ipd)
 923 {
 924         bag->ic_descr->id_ops->id_ipd_free(ipd);
 925 }
 926
 927 int osd_ldiskfs_read(struct inode *inode, void *buf, int size, loff_t *offs);
 928 int osd_ldiskfs_write_record(struct inode *inode, void *buf, int bufsize,
 929                              int write_NUL, loff_t *offs, handle_t *handle);
 930
 931 static inline
 932 struct dentry *osd_child_dentry_by_inode(const struct lu_env *env,
 933                                          struct inode *inode,
 934                                          const char *name, const int namelen)
 935 {
 936         struct osd_thread_info *info = osd_oti_get(env);
 937         struct dentry *child_dentry = &info->oti_child_dentry;
 938         struct dentry *obj_dentry = &info->oti_obj_dentry;
 939
 940         obj_dentry->d_inode = inode;
 941         obj_dentry->d_sb = inode->i_sb;
 942         obj_dentry->d_name.hash = 0;
 943
 944         child_dentry->d_name.hash = 0;
 945         child_dentry->d_parent = obj_dentry;
 946         child_dentry->d_name.name = name;
 947         child_dentry->d_name.len = namelen;
 948         return child_dentry;
 949 }
 950
 951 extern int osd_trans_declare_op2rb[];
 952 extern int ldiskfs_track_declares_assert;
 953
 954 static inline void osd_trans_declare_op(const struct lu_env *env,
 955                                         struct osd_thandle *oh,
 956                                         unsigned int op, int credits)
 957 {
 958         struct osd_thread_info *oti = osd_oti_get(env);
 959
 960         LASSERT(oh->ot_handle == NULL);
 961         if (unlikely(op >= OSD_OT_MAX)) {
 962                 if (unlikely(ldiskfs_track_declares_assert)) {
 963                         LASSERT(op < OSD_OT_MAX);
 964                 } else {
 965                         CWARN("%s: Invalid operation index %d\n",
 966                               osd_name(oti->oti_dev), op);
 967                         libcfs_debug_dumpstack(NULL);
 968                 }
 969         } else {
 970                 oti->oti_declare_ops[op]++;
 971                 oti->oti_declare_ops_cred[op] += credits;
 972         }
 973         oh->ot_credits += credits;
 974 }
 975
 976 static inline void osd_trans_exec_op(const struct lu_env *env,
 977                                      struct thandle *th, unsigned int op)
 978 {
 979         struct osd_thread_info *oti = osd_oti_get(env);
 980         struct osd_thandle     *oh  = container_of(th, struct osd_thandle,
 981                                                    ot_super);
 982         unsigned int            rb;
 983
 984         LASSERT(oh->ot_handle != NULL);
 985         if (unlikely(op >= OSD_OT_MAX)) {
 986                 if (unlikely(ldiskfs_track_declares_assert))
 987                         LASSERT(op < OSD_OT_MAX);
 988                 else {
 989                         CWARN("%s: Invalid operation index %d\n",
 990                               osd_name(oti->oti_dev), op);
 991                         libcfs_debug_dumpstack(NULL);
 992                         return;
 993                 }
 994         }
 995
 996         if (likely(!oti->oti_rollback && oti->oti_declare_ops[op] > 0)) {
 997                 oti->oti_declare_ops[op]--;
 998                 oti->oti_declare_ops_rb[op]++;
 999         } else {
1000                 /* all future updates are considered rollback */
1001                 oti->oti_rollback = true;
1002                 rb = osd_trans_declare_op2rb[op];
1003                 if (unlikely(rb >= OSD_OT_MAX)) {
1004                         if (unlikely(ldiskfs_track_declares_assert))
1005                                 LASSERTF(rb < OSD_OT_MAX, "rb = %u\n", rb);
1006                         else {
1007                                 CWARN("%s: Invalid rollback index %d\n",
1008                                       osd_name(oti->oti_dev), rb);
1009                                 libcfs_debug_dumpstack(NULL);
1010                                 return;
1011                         }
1012                 }
1013                 if (unlikely(oti->oti_declare_ops_rb[rb] == 0)) {
1014                         if (unlikely(ldiskfs_track_declares_assert))
1015                                 LASSERTF(oti->oti_declare_ops_rb[rb] > 0,
1016                                          "rb = %u\n", rb);
1017                         else {
1018                                 CWARN("%s: Overflow in tracking declares for "
1019                                       "index, rb = %d\n",
1020                                       osd_name(oti->oti_dev), rb);
1021                                 libcfs_debug_dumpstack(NULL);
1022                                 return;
1023                         }
1024                 }
1025                 oti->oti_declare_ops_rb[rb]--;
1026         }
1027 }
1028
1029 static inline void osd_trans_declare_rb(const struct lu_env *env,
1030                                         struct thandle *th, unsigned int op)
1031 {
1032         struct osd_thread_info *oti = osd_oti_get(env);
1033         struct osd_thandle     *oh  = container_of(th, struct osd_thandle,
1034                                                    ot_super);
1035
1036         LASSERT(oh->ot_handle != NULL);
1037         if (unlikely(op >= OSD_OT_MAX)) {
1038                 if (unlikely(ldiskfs_track_declares_assert))
1039                         LASSERT(op < OSD_OT_MAX);
1040                 else {
1041                         CWARN("%s: Invalid operation index %d\n",
1042                               osd_name(oti->oti_dev), op);
1043                         libcfs_debug_dumpstack(NULL);
1044                 }
1045
1046         } else {
1047                 oti->oti_declare_ops_rb[op]++;
1048         }
1049 }
1050
1051 /**
1052  * Helper function to pack the fid, ldiskfs stores fid in packed format.
1053  */
1054 static inline
1055 void osd_fid_pack(struct osd_fid_pack *pack, const struct dt_rec *fid,
1056                   struct lu_fid *befider)
1057 {
1058         fid_cpu_to_be(befider, (struct lu_fid *)fid);
1059         memcpy(pack->fp_area, befider, sizeof(*befider));
1060         pack->fp_len =  sizeof(*befider) + 1;
1061 }
1062
1063 static inline
1064 int osd_fid_unpack(struct lu_fid *fid, const struct osd_fid_pack *pack)
1065 {
1066         int result;
1067
1068         result = 0;
1069         switch (pack->fp_len) {
1070         case sizeof *fid + 1:
1071                 memcpy(fid, pack->fp_area, sizeof *fid);
1072                 fid_be_to_cpu(fid, fid);
1073                 break;
1074         default:
1075                 CERROR("Unexpected packed fid size: %d\n", pack->fp_len);
1076                 result = -EIO;
1077         }
1078         return result;
1079 }
1080
1081 /**
1082  * Quota/Accounting handling
1083  */
1084 extern const struct dt_index_operations osd_acct_index_ops;
1085 int osd_acct_obj_lookup(struct osd_thread_info *info, struct osd_device *osd,
1086                         const struct lu_fid *fid, struct osd_inode_id *id);
1087
1088 /* copy from fs/ext4/dir.c */
1089 static inline int is_32bit_api(void)
1090 {
1091 #ifdef CONFIG_COMPAT
1092         return is_compat_task();
1093 #else
1094         return (BITS_PER_LONG == 32);
1095 #endif
1096 }
1097
1098 static inline loff_t ldiskfs_get_htree_eof(struct file *filp)
1099 {
1100         if ((filp->f_mode & FMODE_32BITHASH) ||
1101             (!(filp->f_mode & FMODE_64BITHASH) && is_32bit_api()))
1102                 return LDISKFS_HTREE_EOF_32BIT;
1103         else
1104                 return LDISKFS_HTREE_EOF_64BIT;
1105 }
1106
1107 static inline int fid_is_internal(const struct lu_fid *fid)
1108 {
1109         return (!fid_is_namespace_visible(fid) && !fid_is_idif(fid));
1110 }
1111
1112 static inline unsigned long osd_remote_parent_ino(struct osd_device *dev)
1113 {
1114         return dev->od_mdt_map->omm_remote_parent->d_inode->i_ino;
1115 }
1116
1117 #ifdef JOURNAL_START_HAS_3ARGS
1118 # define osd_journal_start_sb(sb, type, nblock) \
1119                 ldiskfs_journal_start_sb(sb, type, nblock)
1120 # define osd_ldiskfs_append(handle, inode, nblock, err) \
1121                 ldiskfs_append(handle, inode, nblock)
1122 # define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
1123                 ldiskfs_find_entry(dir, name, de, inlined, lock)
1124 # define osd_journal_start(inode, type, nblocks) \
1125                 ldiskfs_journal_start(inode, type, nblocks)
1126 # define osd_transaction_size(dev) \
1127                 (osd_journal(dev)->j_max_transaction_buffers / 2)
1128 #else
1129 # define LDISKFS_HT_MISC        0
1130 # define osd_journal_start_sb(sb, type, nblock) \
1131                 ldiskfs_journal_start_sb(sb, nblock)
1132 # define osd_ldiskfs_append(handle, inode, nblock, err) \
1133                 ldiskfs_append(handle, inode, nblock, err)
1134 # define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
1135                 ldiskfs_find_entry(dir, name, de, lock)
1136 # define osd_journal_start(inode, type, nblocks) \
1137                 ldiskfs_journal_start(inode, nblocks)
1138 # define osd_transaction_size(dev) \
1139                 (osd_journal(dev)->j_max_transaction_buffers)
1140 #endif
1141
1142 void ldiskfs_inc_count(handle_t *handle, struct inode *inode);
1143 void ldiskfs_dec_count(handle_t *handle, struct inode *inode);
1144
1145 void osd_fini_iobuf(struct osd_device *d, struct osd_iobuf *iobuf);
1146
1147 #endif /* _OSD_INTERNAL_H */