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, Whamcloud, Inc.
  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 <lquota.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 /* Lustre special inode::i_state to indicate OI scrub skip this inode. */
  87 #define I_LUSTRE_NOSCRUB        (1 << 31)
  88
  89 /** Enable thandle usage statistics */
  90 #define OSD_THANDLE_STATS (0)
  91
  92 #ifdef HAVE_QUOTA_SUPPORT
  93 struct osd_ctxt {
  94         __u32 oc_uid;
  95         __u32 oc_gid;
  96         cfs_kernel_cap_t oc_cap;
  97 };
  98 #endif
  99
 100 struct osd_directory {
 101         struct iam_container od_container;
 102         struct iam_descr     od_descr;
 103 };
 104
 105 /*
 106  * Object Index (oi) instance.
 107  */
 108 struct osd_oi {
 109         /*
 110          * underlying index object, where fid->id mapping in stored.
 111          */
 112         struct inode         *oi_inode;
 113         struct osd_directory  oi_dir;
 114 };
 115
 116 extern const int osd_dto_credits_noquota[];
 117
 118 struct osd_object {
 119         struct dt_object        oo_dt;
 120         /**
 121          * Inode for file system object represented by this osd_object. This
 122          * inode is pinned for the whole duration of lu_object life.
 123          *
 124          * Not modified concurrently (either setup early during object
 125          * creation, or assigned by osd_object_create() under write lock).
 126          */
 127         struct inode           *oo_inode;
 128         /**
 129          * to protect index ops.
 130          */
 131         struct htree_lock_head *oo_hl_head;
 132         cfs_rw_semaphore_t      oo_ext_idx_sem;
 133         cfs_rw_semaphore_t      oo_sem;
 134         struct osd_directory   *oo_dir;
 135         /** protects inode attributes. */
 136         cfs_spinlock_t          oo_guard;
 137         /**
 138          * Following two members are used to indicate the presence of dot and
 139          * dotdot in the given directory. This is required for interop mode
 140          * (b11826).
 141          */
 142         int                     oo_compat_dot_created;
 143         int                     oo_compat_dotdot_created;
 144
 145         const struct lu_env    *oo_owner;
 146 #ifdef CONFIG_LOCKDEP
 147         struct lockdep_map      oo_dep_map;
 148 #endif
 149 };
 150
 151 #ifdef HAVE_LDISKFS_PDO
 152
 153 #define osd_ldiskfs_find_entry(dir, dentry, de, lock)   \
 154         ll_ldiskfs_find_entry(dir, dentry, de, lock)
 155 #define osd_ldiskfs_add_entry(handle, child, cinode, hlock) \
 156         ldiskfs_add_entry(handle, child, cinode, hlock)
 157
 158 #else /* HAVE_LDISKFS_PDO */
 159
 160 struct htree_lock {
 161         int     dummy;
 162 };
 163
 164 struct htree_lock_head {
 165         int     dummy;
 166 };
 167
 168 #define ldiskfs_htree_lock(lock, head, inode, op)  do { LBUG(); } while (0)
 169 #define ldiskfs_htree_unlock(lock)                 do { LBUG(); } while (0)
 170
 171 static inline struct htree_lock_head *ldiskfs_htree_lock_head_alloc(int dep)
 172 {
 173         LBUG();
 174         return NULL;
 175 }
 176
 177 #define ldiskfs_htree_lock_head_free(lh)           do { LBUG(); } while (0)
 178
 179 #define LDISKFS_DUMMY_HTREE_LOCK        0xbabecafe
 180
 181 static inline struct htree_lock *ldiskfs_htree_lock_alloc(void)
 182 {
 183         return (struct htree_lock *)LDISKFS_DUMMY_HTREE_LOCK;
 184 }
 185
 186 static inline void ldiskfs_htree_lock_free(struct htree_lock *lk)
 187 {
 188         LASSERT((unsigned long)lk == LDISKFS_DUMMY_HTREE_LOCK);
 189 }
 190
 191 #define HTREE_HBITS_DEF         0
 192
 193 #define osd_ldiskfs_find_entry(dir, dentry, de, lock)   \
 194         ll_ldiskfs_find_entry(dir, dentry, de)
 195 #define osd_ldiskfs_add_entry(handle, child, cinode, lock) \
 196         ldiskfs_add_entry(handle, child, cinode)
 197
 198 #endif /* HAVE_LDISKFS_PDO */
 199
 200 #define OSD_OTABLE_IT_CACHE_SIZE        128
 201 #define OSD_OTABLE_IT_CACHE_MASK        (~(OSD_OTABLE_IT_CACHE_SIZE - 1))
 202
 203 struct osd_inconsistent_item {
 204         /* link into osd_scrub::os_inconsistent_items,
 205          * protected by osd_scrub::os_lock. */
 206         cfs_list_t             oii_list;
 207
 208         /* The right FID <=> ino#/gen mapping. */
 209         struct osd_idmap_cache oii_cache;
 210
 211         unsigned int           oii_insert:1; /* insert or update mapping. */
 212 };
 213
 214 struct osd_otable_cache {
 215         struct osd_idmap_cache ooc_cache[OSD_OTABLE_IT_CACHE_SIZE];
 216
 217         /* Index for next cache slot to be filled. */
 218         int                    ooc_producer_idx;
 219
 220         /* Index for next cache slot to be returned by it::next(). */
 221         int                    ooc_consumer_idx;
 222
 223         /* How many items in ooc_cache. */
 224         int                    ooc_cached_items;
 225
 226         /* Position for up layer LFSCK iteration pre-loading. */
 227         __u32                  ooc_pos_preload;
 228 };
 229
 230 struct osd_otable_it {
 231         struct osd_device       *ooi_dev;
 232         struct osd_otable_cache  ooi_cache;
 233
 234         /* For osd_otable_it_key. */
 235         __u8                     ooi_key[16];
 236
 237         /* The following bits can be updated/checked w/o lock protection.
 238          * If more bits will be introduced in the future and need lock to
 239          * protect, please add comment. */
 240         unsigned long            ooi_used_outside:1, /* Some user out of OSD
 241                                                       * uses the iteration. */
 242                                  ooi_all_cached:1, /* No more entries can be
 243                                                     * filled into cache. */
 244                                  ooi_user_ready:1, /* The user out of OSD is
 245                                                     * ready to iterate. */
 246                                  ooi_waiting:1; /* it::next is waiting. */
 247 };
 248
 249 extern const int osd_dto_credits_noquota[];
 250
 251 /*
 252  * osd device.
 253  */
 254 struct osd_device {
 255         /* super-class */
 256         struct dt_device          od_dt_dev;
 257         /* information about underlying file system */
 258         struct lustre_mount_info *od_mount;
 259         struct vfsmount          *od_mnt;
 260         /* object index */
 261         struct osd_oi           **od_oi_table;
 262         /* total number of OI containers */
 263         int                       od_oi_count;
 264         /*
 265          * Fid Capability
 266          */
 267         unsigned int              od_fl_capa:1,
 268                                   od_is_md:1; /* set in ->ldo_prepare */
 269         unsigned long             od_capa_timeout;
 270         __u32                     od_capa_alg;
 271         struct lustre_capa_key   *od_capa_keys;
 272         cfs_hlist_head_t         *od_capa_hash;
 273
 274         cfs_proc_dir_entry_t     *od_proc_entry;
 275         struct lprocfs_stats     *od_stats;
 276         /*
 277          * statfs optimization: we cache a bit.
 278          */
 279         cfs_time_t                od_osfs_age;
 280         struct obd_statfs         od_statfs;
 281         cfs_spinlock_t            od_osfs_lock;
 282
 283         /**
 284          * The following flag indicates, if it is interop mode or not.
 285          * It will be initialized, using mount param.
 286          */
 287         __u32                     od_iop_mode;
 288
 289         struct fsfilt_operations *od_fsops;
 290
 291         /*
 292          * mapping for legacy OST objids
 293          */
 294         struct osd_compat_objid  *od_ost_map;
 295
 296         unsigned long long        od_readcache_max_filesize;
 297         int                       od_read_cache;
 298         int                       od_writethrough_cache;
 299
 300         struct brw_stats          od_brw_stats;
 301         cfs_atomic_t              od_r_in_flight;
 302         cfs_atomic_t              od_w_in_flight;
 303
 304         cfs_mutex_t               od_otable_mutex;
 305         struct osd_otable_it     *od_otable_it;
 306         struct osd_scrub          od_scrub;
 307
 308         /* service name associated with the osd device */
 309         char                      od_svname[MAX_OBD_NAME];
 310
 311         /* quota slave instance */
 312         struct qsd_instance      *od_quota_slave;
 313 };
 314
 315 #define OSD_TRACK_DECLARES
 316 #ifdef OSD_TRACK_DECLARES
 317 #define OSD_DECLARE_OP(oh, op)   {                               \
 318         LASSERT(oh->ot_handle == NULL);                          \
 319         ((oh)->ot_declare_ ##op)++; }
 320 #define OSD_EXEC_OP(handle,op)      {                            \
 321         struct osd_thandle *oh;                                  \
 322         oh = container_of0(handle, struct osd_thandle, ot_super);\
 323         if (((oh)->ot_declare_ ##op) > 0) {                      \
 324                 ((oh)->ot_declare_ ##op)--;                      \
 325         }                                                        \
 326         }
 327 #else
 328 #define OSD_DECLARE_OP(oh, op)
 329 #define OSD_EXEC_OP(oh, op)
 330 #endif
 331
 332 /* There are at most 10 uid/gids are affected in a transaction, and
 333  * that's rename case:
 334  * - 2 for source parent uid & gid;
 335  * - 2 for source child uid & gid ('..' entry update when the child
 336  *   is directory);
 337  * - 2 for target parent uid & gid;
 338  * - 2 for target child uid & gid (if the target child exists);
 339  * - 2 for root uid & gid (last_rcvd, llog, etc);
 340  *
 341  * The 0 to (OSD_MAX_UGID_CNT - 1) bits of ot_id_type is for indicating
 342  * the id type of each id in the ot_id_array.
 343  */
 344 #define OSD_MAX_UGID_CNT        10
 345
 346 struct osd_thandle {
 347         struct thandle          ot_super;
 348         handle_t               *ot_handle;
 349         struct journal_callback ot_jcb;
 350         cfs_list_t              ot_dcb_list;
 351         /* Link to the device, for debugging. */
 352         struct lu_ref_link     *ot_dev_link;
 353         unsigned short          ot_credits;
 354         unsigned short          ot_id_cnt;
 355         unsigned short          ot_id_type;
 356         uid_t                   ot_id_array[OSD_MAX_UGID_CNT];
 357
 358 #ifdef OSD_TRACK_DECLARES
 359         unsigned char           ot_declare_attr_set;
 360         unsigned char           ot_declare_punch;
 361         unsigned char           ot_declare_xattr_set;
 362         unsigned char           ot_declare_create;
 363         unsigned char           ot_declare_destroy;
 364         unsigned char           ot_declare_ref_add;
 365         unsigned char           ot_declare_ref_del;
 366         unsigned char           ot_declare_write;
 367         unsigned char           ot_declare_insert;
 368         unsigned char           ot_declare_delete;
 369 #endif
 370
 371 #if OSD_THANDLE_STATS
 372         /** time when this handle was allocated */
 373         cfs_time_t oth_alloced;
 374
 375         /** time when this thanle was started */
 376         cfs_time_t oth_started;
 377 #endif
 378 };
 379
 380 /**
 381  * Basic transaction credit op
 382  */
 383 enum dt_txn_op {
 384         DTO_INDEX_INSERT,
 385         DTO_INDEX_DELETE,
 386         DTO_INDEX_UPDATE,
 387         DTO_OBJECT_CREATE,
 388         DTO_OBJECT_DELETE,
 389         DTO_ATTR_SET_BASE,
 390         DTO_XATTR_SET,
 391         DTO_LOG_REC, /**< XXX temporary: dt layer knows nothing about llog. */
 392         DTO_WRITE_BASE,
 393         DTO_WRITE_BLOCK,
 394         DTO_ATTR_SET_CHOWN,
 395
 396         DTO_NR
 397 };
 398
 399 /*
 400  * osd dev stats
 401  */
 402
 403 #ifdef LPROCFS
 404 enum {
 405         LPROC_OSD_READ_BYTES    = 0,
 406         LPROC_OSD_WRITE_BYTES   = 1,
 407         LPROC_OSD_GET_PAGE      = 2,
 408         LPROC_OSD_NO_PAGE       = 3,
 409         LPROC_OSD_CACHE_ACCESS  = 4,
 410         LPROC_OSD_CACHE_HIT     = 5,
 411         LPROC_OSD_CACHE_MISS    = 6,
 412
 413 #if OSD_THANDLE_STATS
 414         LPROC_OSD_THANDLE_STARTING,
 415         LPROC_OSD_THANDLE_OPEN,
 416         LPROC_OSD_THANDLE_CLOSING,
 417 #endif
 418         LPROC_OSD_LAST,
 419 };
 420 #endif
 421
 422 /**
 423  * Storage representation for fids.
 424  *
 425  * Variable size, first byte contains the length of the whole record.
 426  */
 427 struct osd_fid_pack {
 428         unsigned char fp_len;
 429         char fp_area[sizeof(struct lu_fid)];
 430 };
 431
 432 struct osd_it_ea_dirent {
 433         struct lu_fid   oied_fid;
 434         __u64           oied_ino;
 435         __u64           oied_off;
 436         unsigned short  oied_namelen;
 437         unsigned int    oied_type;
 438         char            oied_name[0];
 439 } __attribute__((packed));
 440
 441 /**
 442  * as osd_it_ea_dirent (in memory dirent struct for osd) is greater
 443  * than lu_dirent struct. osd readdir reads less number of dirent than
 444  * required for mdd dir page. so buffer size need to be increased so that
 445  * there  would be one ext3 readdir for every mdd readdir page.
 446  */
 447
 448 #define OSD_IT_EA_BUFSIZE       (CFS_PAGE_SIZE + CFS_PAGE_SIZE/4)
 449
 450 /**
 451  * This is iterator's in-memory data structure in interoperability
 452  * mode (i.e. iterator over ldiskfs style directory)
 453  */
 454 struct osd_it_ea {
 455         struct osd_object   *oie_obj;
 456         /** used in ldiskfs iterator, to stored file pointer */
 457         struct file          oie_file;
 458         /** how many entries have been read-cached from storage */
 459         int                  oie_rd_dirent;
 460         /** current entry is being iterated by caller */
 461         int                  oie_it_dirent;
 462         /** current processing entry */
 463         struct osd_it_ea_dirent *oie_dirent;
 464         /** buffer to hold entries, size == OSD_IT_EA_BUFSIZE */
 465         void                *oie_buf;
 466 };
 467
 468 /**
 469  * Iterator's in-memory data structure for IAM mode.
 470  */
 471 struct osd_it_iam {
 472         struct osd_object     *oi_obj;
 473         struct iam_path_descr *oi_ipd;
 474         struct iam_iterator    oi_it;
 475 };
 476
 477 /**
 478  * Iterator's in-memory data structure for quota file.
 479  */
 480 struct osd_it_quota {
 481         struct osd_object       *oiq_obj;
 482         /** tree blocks path to where the entry is stored */
 483         uint                     oiq_blk[LUSTRE_DQTREEDEPTH];
 484         /** on-disk offset for current key where quota record can be found */
 485         loff_t                   oiq_offset;
 486         /** identifier for current quota record */
 487         __u64                    oiq_id;
 488 };
 489
 490 #define MAX_BLOCKS_PER_PAGE (CFS_PAGE_SIZE / 512)
 491
 492 struct osd_iobuf {
 493         cfs_waitq_t        dr_wait;
 494         cfs_atomic_t       dr_numreqs;  /* number of reqs being processed */
 495         int                dr_max_pages;
 496         int                dr_npages;
 497         int                dr_error;
 498         int                dr_frags;
 499         unsigned int       dr_ignore_quota:1;
 500         unsigned int       dr_elapsed_valid:1; /* we really did count time */
 501         unsigned int       dr_rw:1;
 502         struct page       *dr_pages[PTLRPC_MAX_BRW_PAGES];
 503         unsigned long      dr_blocks[PTLRPC_MAX_BRW_PAGES*MAX_BLOCKS_PER_PAGE];
 504         unsigned long      dr_start_time;
 505         unsigned long      dr_elapsed;  /* how long io took */
 506         struct osd_device *dr_dev;
 507 };
 508
 509 struct osd_thread_info {
 510         const struct lu_env   *oti_env;
 511         /**
 512          * used for index operations.
 513          */
 514         struct dentry          oti_obj_dentry;
 515         struct dentry          oti_child_dentry;
 516
 517         /** dentry for Iterator context. */
 518         struct dentry          oti_it_dentry;
 519         struct htree_lock     *oti_hlock;
 520
 521         struct lu_fid          oti_fid;
 522         struct lu_fid          oti_fid2;
 523         struct osd_inode_id    oti_id;
 524         struct osd_inode_id    oti_id2;
 525         struct ost_id          oti_ostid;
 526
 527         /*
 528          * XXX temporary: for ->i_op calls.
 529          */
 530         struct timespec        oti_time;
 531         /*
 532          * XXX temporary: fake struct file for osd_object_sync
 533          */
 534         struct file            oti_file;
 535         /*
 536          * XXX temporary: for capa operations.
 537          */
 538         struct lustre_capa_key oti_capa_key;
 539         struct lustre_capa     oti_capa;
 540
 541         /** osd_device reference, initialized in osd_trans_start() and
 542             used in osd_trans_stop() */
 543         struct osd_device     *oti_dev;
 544
 545         /**
 546          * following ipd and it structures are used for osd_index_iam_lookup()
 547          * these are defined separately as we might do index operation
 548          * in open iterator session.
 549          */
 550
 551         /** osd iterator context used for iterator session */
 552
 553         union {
 554                 struct osd_it_iam       oti_it;
 555                 /* ldiskfs iterator data structure,
 556                  * see osd_it_ea_{init, fini} */
 557                 struct osd_it_ea        oti_it_ea;
 558                 struct osd_it_quota     oti_it_quota;
 559         };
 560
 561         /** pre-allocated buffer used by oti_it_ea, size OSD_IT_EA_BUFSIZE */
 562         void                  *oti_it_ea_buf;
 563
 564         cfs_kstatfs_t          oti_ksfs;
 565
 566         /** IAM iterator for index operation. */
 567         struct iam_iterator    oti_idx_it;
 568
 569         /** union to guarantee that ->oti_ipd[] has proper alignment. */
 570         union {
 571                 char           oti_it_ipd[DX_IPD_MAX_SIZE];
 572                 long long      oti_alignment_lieutenant;
 573         };
 574
 575         union {
 576                 char           oti_idx_ipd[DX_IPD_MAX_SIZE];
 577                 long long      oti_alignment_lieutenant_colonel;
 578         };
 579
 580         struct osd_idmap_cache oti_cache;
 581
 582         int                    oti_r_locks;
 583         int                    oti_w_locks;
 584         int                    oti_txns;
 585         /** used in osd_fid_set() to put xattr */
 586         struct lu_buf          oti_buf;
 587         /** used in osd_ea_fid_set() to set fid into common ea */
 588         struct lustre_mdt_attrs oti_mdt_attrs;
 589         /** 0-copy IO */
 590         struct osd_iobuf       oti_iobuf;
 591         struct inode           oti_inode;
 592         int                    oti_created[PTLRPC_MAX_BRW_PAGES];
 593 #ifdef HAVE_QUOTA_SUPPORT
 594         struct osd_ctxt        oti_ctxt;
 595 #endif
 596         struct lu_env          oti_obj_delete_tx_env;
 597 #define OSD_FID_REC_SZ 32
 598         char                   oti_ldp[OSD_FID_REC_SZ];
 599         char                   oti_ldp2[OSD_FID_REC_SZ];
 600
 601         /* used by quota code */
 602         union {
 603                 struct if_dqblk         oti_dqblk;
 604                 struct if_dqinfo        oti_dqinfo;
 605         };
 606 };
 607
 608 extern int ldiskfs_pdo;
 609
 610 #ifdef LPROCFS
 611 /* osd_lproc.c */
 612 void lprocfs_osd_init_vars(struct lprocfs_static_vars *lvars);
 613 int osd_procfs_init(struct osd_device *osd, const char *name);
 614 int osd_procfs_fini(struct osd_device *osd);
 615 void osd_lprocfs_time_start(const struct lu_env *env);
 616 void osd_lprocfs_time_end(const struct lu_env *env,
 617                           struct osd_device *osd, int op);
 618 void osd_brw_stats_update(struct osd_device *osd, struct osd_iobuf *iobuf);
 619
 620 #endif
 621 int osd_statfs(const struct lu_env *env, struct dt_device *dev,
 622                struct obd_statfs *sfs);
 623 int osd_object_auth(const struct lu_env *env, struct dt_object *dt,
 624                     struct lustre_capa *capa, __u64 opc);
 625 void osd_declare_qid(struct dt_object *dt, struct osd_thandle *oh,
 626                      int type, uid_t id, struct inode *inode);
 627 struct inode *osd_iget(struct osd_thread_info *info, struct osd_device *dev,
 628                        struct osd_inode_id *id);
 629 struct inode *osd_iget_fid(struct osd_thread_info *info, struct osd_device *dev,
 630                            struct osd_inode_id *id, struct lu_fid *fid);
 631
 632 int osd_compat_init(struct osd_device *dev);
 633 void osd_compat_fini(struct osd_device *dev);
 634 int osd_compat_objid_lookup(struct osd_thread_info *info,
 635                             struct osd_device *osd,
 636                             const struct lu_fid *fid, struct osd_inode_id *id);
 637 int osd_compat_objid_insert(struct osd_thread_info *info,
 638                             struct osd_device *osd,
 639                             const struct lu_fid *fid,
 640                             const struct osd_inode_id *id, struct thandle *th);
 641 int osd_compat_objid_delete(struct osd_thread_info *info,
 642                             struct osd_device *osd,
 643                             const struct lu_fid *fid, struct thandle *th);
 644 int osd_compat_spec_lookup(struct osd_thread_info *info,
 645                            struct osd_device *osd,
 646                            const struct lu_fid *fid, struct osd_inode_id *id);
 647 int osd_compat_spec_insert(struct osd_thread_info *info,
 648                            struct osd_device *osd,
 649                            const struct lu_fid *fid,
 650                            const struct osd_inode_id *id, struct thandle *th);
 651
 652 void osd_scrub_file_reset(struct osd_scrub *scrub, __u8 *uuid, __u64 flags);
 653 int osd_scrub_file_store(struct osd_scrub *scrub);
 654 int osd_scrub_start(struct osd_device *dev);
 655 int osd_scrub_setup(const struct lu_env *env, struct osd_device *dev);
 656 void osd_scrub_cleanup(const struct lu_env *env, struct osd_device *dev);
 657 int osd_oii_insert(struct osd_device *dev, struct osd_idmap_cache *oic,
 658                    int insert);
 659 int osd_oii_lookup(struct osd_device *dev, const struct lu_fid *fid,
 660                    struct osd_inode_id *id);
 661 int osd_scrub_dump(struct osd_device *dev, char *buf, int len);
 662
 663 /* osd_quota_fmt.c */
 664 int walk_tree_dqentry(const struct lu_env *env, struct osd_object *obj,
 665                       int type, uint blk, int depth, uint index,
 666                       struct osd_it_quota *it);
 667 int walk_block_dqentry(const struct lu_env *env, struct osd_object *obj,
 668                        int type, uint blk, uint index,
 669                        struct osd_it_quota *it);
 670 loff_t find_tree_dqentry(const struct lu_env *env,
 671                          struct osd_object *obj, int type,
 672                          qid_t dqid, uint blk, int depth,
 673                          struct osd_it_quota *it);
 674 /*
 675  * Invariants, assertions.
 676  */
 677
 678 /*
 679  * XXX: do not enable this, until invariant checking code is made thread safe
 680  * in the face of pdirops locking.
 681  */
 682 #define OSD_INVARIANT_CHECKS (0)
 683
 684 #if OSD_INVARIANT_CHECKS
 685 static inline int osd_invariant(const struct osd_object *obj)
 686 {
 687         return
 688                 obj != NULL &&
 689                 ergo(obj->oo_inode != NULL,
 690                      obj->oo_inode->i_sb == osd_sb(osd_obj2dev(obj)) &&
 691                      atomic_read(&obj->oo_inode->i_count) > 0) &&
 692                 ergo(obj->oo_dir != NULL &&
 693                      obj->oo_dir->od_conationer.ic_object != NULL,
 694                      obj->oo_dir->od_conationer.ic_object == obj->oo_inode);
 695 }
 696 #else
 697 #define osd_invariant(obj) (1)
 698 #endif
 699
 700 extern const struct dt_index_operations osd_otable_ops;
 701
 702 static inline int osd_oi_fid2idx(struct osd_device *dev,
 703                                  const struct lu_fid *fid)
 704 {
 705         return fid->f_seq & (dev->od_oi_count - 1);
 706 }
 707
 708 static inline struct osd_oi *osd_fid2oi(struct osd_device *osd,
 709                                         const struct lu_fid *fid)
 710 {
 711         LASSERTF(!fid_is_idif(fid), DFID"\n", PFID(fid));
 712         LASSERTF(!fid_is_igif(fid), DFID"\n", PFID(fid));
 713         LASSERT(osd->od_oi_table != NULL && osd->od_oi_count >= 1);
 714         /* It can work even od_oi_count equals to 1 although it's unexpected,
 715          * the only reason we set it to 1 is for performance measurement */
 716         return osd->od_oi_table[osd_oi_fid2idx(osd, fid)];
 717 }
 718
 719 extern const struct lu_device_operations  osd_lu_ops;
 720
 721 static inline int lu_device_is_osd(const struct lu_device *d)
 722 {
 723         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
 724 }
 725
 726 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
 727 {
 728         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
 729         return container_of0(d, struct osd_device, od_dt_dev);
 730 }
 731
 732 static inline struct osd_device *osd_dev(const struct lu_device *d)
 733 {
 734         LASSERT(lu_device_is_osd(d));
 735         return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
 736 }
 737
 738 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
 739 {
 740         return osd_dev(o->oo_dt.do_lu.lo_dev);
 741 }
 742
 743 static inline struct super_block *osd_sb(const struct osd_device *dev)
 744 {
 745         return dev->od_mount->lmi_mnt->mnt_sb;
 746 }
 747
 748 static inline int osd_object_is_root(const struct osd_object *obj)
 749 {
 750         return osd_sb(osd_obj2dev(obj))->s_root->d_inode == obj->oo_inode;
 751 }
 752
 753 static inline struct osd_object *osd_obj(const struct lu_object *o)
 754 {
 755         LASSERT(lu_device_is_osd(o->lo_dev));
 756         return container_of0(o, struct osd_object, oo_dt.do_lu);
 757 }
 758
 759 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
 760 {
 761         return osd_obj(&d->do_lu);
 762 }
 763
 764 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
 765 {
 766         return &osd->od_dt_dev.dd_lu_dev;
 767 }
 768
 769 static inline journal_t *osd_journal(const struct osd_device *dev)
 770 {
 771         return LDISKFS_SB(osd_sb(dev))->s_journal;
 772 }
 773
 774 extern const struct dt_body_operations osd_body_ops;
 775 extern struct lu_context_key osd_key;
 776
 777 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
 778 {
 779         return lu_context_key_get(&env->le_ctx, &osd_key);
 780 }
 781
 782 extern const struct dt_body_operations osd_body_ops_new;
 783
 784 /**
 785  * IAM Iterator
 786  */
 787 static inline
 788 struct iam_path_descr *osd_it_ipd_get(const struct lu_env *env,
 789                                       const struct iam_container *bag)
 790 {
 791         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
 792                                            osd_oti_get(env)->oti_it_ipd);
 793 }
 794
 795 static inline
 796 struct iam_path_descr *osd_idx_ipd_get(const struct lu_env *env,
 797                                        const struct iam_container *bag)
 798 {
 799         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
 800                                            osd_oti_get(env)->oti_idx_ipd);
 801 }
 802
 803 static inline void osd_ipd_put(const struct lu_env *env,
 804                                const struct iam_container *bag,
 805                                struct iam_path_descr *ipd)
 806 {
 807         bag->ic_descr->id_ops->id_ipd_free(ipd);
 808 }
 809
 810 int osd_ldiskfs_read(struct inode *inode, void *buf, int size, loff_t *offs);
 811 int osd_ldiskfs_write_record(struct inode *inode, void *buf, int bufsize,
 812                              loff_t *offs, handle_t *handle);
 813
 814 static inline
 815 struct dentry *osd_child_dentry_by_inode(const struct lu_env *env,
 816                                          struct inode *inode,
 817                                          const char *name, const int namelen)
 818 {
 819         struct osd_thread_info *info = osd_oti_get(env);
 820         struct dentry *child_dentry = &info->oti_child_dentry;
 821         struct dentry *obj_dentry = &info->oti_obj_dentry;
 822
 823         obj_dentry->d_inode = inode;
 824         obj_dentry->d_sb = inode->i_sb;
 825         obj_dentry->d_name.hash = 0;
 826
 827         child_dentry->d_name.hash = 0;
 828         child_dentry->d_parent = obj_dentry;
 829         child_dentry->d_name.name = name;
 830         child_dentry->d_name.len = namelen;
 831         return child_dentry;
 832 }
 833
 834 /**
 835  * Helper function to pack the fid, ldiskfs stores fid in packed format.
 836  */
 837 static inline
 838 void osd_fid_pack(struct osd_fid_pack *pack, const struct dt_rec *fid,
 839                   struct lu_fid *befider)
 840 {
 841         fid_cpu_to_be(befider, (struct lu_fid *)fid);
 842         memcpy(pack->fp_area, befider, sizeof(*befider));
 843         pack->fp_len =  sizeof(*befider) + 1;
 844 }
 845
 846 static inline
 847 int osd_fid_unpack(struct lu_fid *fid, const struct osd_fid_pack *pack)
 848 {
 849         int result;
 850
 851         result = 0;
 852         switch (pack->fp_len) {
 853         case sizeof *fid + 1:
 854                 memcpy(fid, pack->fp_area, sizeof *fid);
 855                 fid_be_to_cpu(fid, fid);
 856                 break;
 857         default:
 858                 CERROR("Unexpected packed fid size: %d\n", pack->fp_len);
 859                 result = -EIO;
 860         }
 861         return result;
 862 }
 863
 864 /**
 865  * Quota/Accounting handling
 866  */
 867 extern const struct dt_index_operations osd_acct_index_ops;
 868 int osd_acct_obj_lookup(struct osd_thread_info *info, struct osd_device *osd,
 869                         const struct lu_fid *fid, struct osd_inode_id *id);
 870
 871 #endif /* __KERNEL__ */
 872 #endif /* _OSD_INTERNAL_H */