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