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