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