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