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