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         unsigned long             od_capa_timeout;
 269         __u32                     od_capa_alg;
 270         struct lustre_capa_key   *od_capa_keys;
 271         cfs_hlist_head_t         *od_capa_hash;
 272
 273         cfs_proc_dir_entry_t     *od_proc_entry;
 274         struct lprocfs_stats     *od_stats;
 275         /*
 276          * statfs optimization: we cache a bit.
 277          */
 278         cfs_time_t                od_osfs_age;
 279         struct obd_statfs         od_statfs;
 280         cfs_spinlock_t            od_osfs_lock;
 281
 282         /**
 283          * The following flag indicates, if it is interop mode or not.
 284          * It will be initialized, using mount param.
 285          */
 286         __u32                     od_iop_mode;
 287
 288         struct fsfilt_operations *od_fsops;
 289
 290         /*
 291          * mapping for legacy OST objids
 292          */
 293         struct osd_compat_objid  *od_ost_map;
 294
 295         unsigned long long        od_readcache_max_filesize;
 296         int                       od_read_cache;
 297         int                       od_writethrough_cache;
 298
 299         struct brw_stats          od_brw_stats;
 300         cfs_atomic_t              od_r_in_flight;
 301         cfs_atomic_t              od_w_in_flight;
 302
 303         cfs_mutex_t               od_otable_mutex;
 304         struct osd_otable_it     *od_otable_it;
 305         struct osd_scrub          od_scrub;
 306
 307         /* service name associated with the osd device */
 308         char                      od_svname[MAX_OBD_NAME];
 309
 310         /* quota slave instance */
 311         struct qsd_instance      *od_quota_slave;
 312 };
 313
 314 #define OSD_TRACK_DECLARES
 315 #ifdef OSD_TRACK_DECLARES
 316 #define OSD_DECLARE_OP(oh, op)   {                               \
 317         LASSERT(oh->ot_handle == NULL);                          \
 318         ((oh)->ot_declare_ ##op)++; }
 319 #define OSD_EXEC_OP(handle,op)      {                            \
 320         struct osd_thandle *oh;                                  \
 321         oh = container_of0(handle, struct osd_thandle, ot_super);\
 322         if (((oh)->ot_declare_ ##op) > 0) {                      \
 323                 ((oh)->ot_declare_ ##op)--;                      \
 324         }                                                        \
 325         }
 326 #else
 327 #define OSD_DECLARE_OP(oh, op)
 328 #define OSD_EXEC_OP(oh, op)
 329 #endif
 330
 331 /* There are at most 10 uid/gids are affected in a transaction, and
 332  * that's rename case:
 333  * - 2 for source parent uid & gid;
 334  * - 2 for source child uid & gid ('..' entry update when the child
 335  *   is directory);
 336  * - 2 for target parent uid & gid;
 337  * - 2 for target child uid & gid (if the target child exists);
 338  * - 2 for root uid & gid (last_rcvd, llog, etc);
 339  *
 340  * The 0 to (OSD_MAX_UGID_CNT - 1) bits of ot_id_type is for indicating
 341  * the id type of each id in the ot_id_array.
 342  */
 343 #define OSD_MAX_UGID_CNT        10
 344
 345 struct osd_thandle {
 346         struct thandle          ot_super;
 347         handle_t               *ot_handle;
 348         struct journal_callback ot_jcb;
 349         cfs_list_t              ot_dcb_list;
 350         /* Link to the device, for debugging. */
 351         struct lu_ref_link     *ot_dev_link;
 352         unsigned short          ot_credits;
 353         unsigned short          ot_id_cnt;
 354         unsigned short          ot_id_type;
 355         uid_t                   ot_id_array[OSD_MAX_UGID_CNT];
 356
 357 #ifdef OSD_TRACK_DECLARES
 358         unsigned char           ot_declare_attr_set;
 359         unsigned char           ot_declare_punch;
 360         unsigned char           ot_declare_xattr_set;
 361         unsigned char           ot_declare_create;
 362         unsigned char           ot_declare_destroy;
 363         unsigned char           ot_declare_ref_add;
 364         unsigned char           ot_declare_ref_del;
 365         unsigned char           ot_declare_write;
 366         unsigned char           ot_declare_insert;
 367         unsigned char           ot_declare_delete;
 368 #endif
 369
 370 #if OSD_THANDLE_STATS
 371         /** time when this handle was allocated */
 372         cfs_time_t oth_alloced;
 373
 374         /** time when this thanle was started */
 375         cfs_time_t oth_started;
 376 #endif
 377 };
 378
 379 /**
 380  * Basic transaction credit op
 381  */
 382 enum dt_txn_op {
 383         DTO_INDEX_INSERT,
 384         DTO_INDEX_DELETE,
 385         DTO_INDEX_UPDATE,
 386         DTO_OBJECT_CREATE,
 387         DTO_OBJECT_DELETE,
 388         DTO_ATTR_SET_BASE,
 389         DTO_XATTR_SET,
 390         DTO_LOG_REC, /**< XXX temporary: dt layer knows nothing about llog. */
 391         DTO_WRITE_BASE,
 392         DTO_WRITE_BLOCK,
 393         DTO_ATTR_SET_CHOWN,
 394
 395         DTO_NR
 396 };
 397
 398 /*
 399  * osd dev stats
 400  */
 401
 402 #ifdef LPROCFS
 403 enum {
 404         LPROC_OSD_READ_BYTES    = 0,
 405         LPROC_OSD_WRITE_BYTES   = 1,
 406         LPROC_OSD_GET_PAGE      = 2,
 407         LPROC_OSD_NO_PAGE       = 3,
 408         LPROC_OSD_CACHE_ACCESS  = 4,
 409         LPROC_OSD_CACHE_HIT     = 5,
 410         LPROC_OSD_CACHE_MISS    = 6,
 411
 412 #if OSD_THANDLE_STATS
 413         LPROC_OSD_THANDLE_STARTING,
 414         LPROC_OSD_THANDLE_OPEN,
 415         LPROC_OSD_THANDLE_CLOSING,
 416 #endif
 417         LPROC_OSD_LAST,
 418 };
 419 #endif
 420
 421 /**
 422  * Storage representation for fids.
 423  *
 424  * Variable size, first byte contains the length of the whole record.
 425  */
 426 struct osd_fid_pack {
 427         unsigned char fp_len;
 428         char fp_area[sizeof(struct lu_fid)];
 429 };
 430
 431 struct osd_it_ea_dirent {
 432         struct lu_fid   oied_fid;
 433         __u64           oied_ino;
 434         __u64           oied_off;
 435         unsigned short  oied_namelen;
 436         unsigned int    oied_type;
 437         char            oied_name[0];
 438 } __attribute__((packed));
 439
 440 /**
 441  * as osd_it_ea_dirent (in memory dirent struct for osd) is greater
 442  * than lu_dirent struct. osd readdir reads less number of dirent than
 443  * required for mdd dir page. so buffer size need to be increased so that
 444  * there  would be one ext3 readdir for every mdd readdir page.
 445  */
 446
 447 #define OSD_IT_EA_BUFSIZE       (CFS_PAGE_SIZE + CFS_PAGE_SIZE/4)
 448
 449 /**
 450  * This is iterator's in-memory data structure in interoperability
 451  * mode (i.e. iterator over ldiskfs style directory)
 452  */
 453 struct osd_it_ea {
 454         struct osd_object   *oie_obj;
 455         /** used in ldiskfs iterator, to stored file pointer */
 456         struct file          oie_file;
 457         /** how many entries have been read-cached from storage */
 458         int                  oie_rd_dirent;
 459         /** current entry is being iterated by caller */
 460         int                  oie_it_dirent;
 461         /** current processing entry */
 462         struct osd_it_ea_dirent *oie_dirent;
 463         /** buffer to hold entries, size == OSD_IT_EA_BUFSIZE */
 464         void                *oie_buf;
 465 };
 466
 467 /**
 468  * Iterator's in-memory data structure for IAM mode.
 469  */
 470 struct osd_it_iam {
 471         struct osd_object     *oi_obj;
 472         struct iam_path_descr *oi_ipd;
 473         struct iam_iterator    oi_it;
 474 };
 475
 476 /**
 477  * Iterator's in-memory data structure for quota file.
 478  */
 479 struct osd_it_quota {
 480         struct osd_object       *oiq_obj;
 481         /** tree blocks path to where the entry is stored */
 482         uint                     oiq_blk[LUSTRE_DQTREEDEPTH];
 483         /** on-disk offset for current key where quota record can be found */
 484         loff_t                   oiq_offset;
 485         /** identifier for current quota record */
 486         __u64                    oiq_id;
 487 };
 488
 489 #define MAX_BLOCKS_PER_PAGE (CFS_PAGE_SIZE / 512)
 490
 491 struct osd_iobuf {
 492         cfs_waitq_t        dr_wait;
 493         cfs_atomic_t       dr_numreqs;  /* number of reqs being processed */
 494         int                dr_max_pages;
 495         int                dr_npages;
 496         int                dr_error;
 497         int                dr_frags;
 498         unsigned int       dr_ignore_quota:1;
 499         unsigned int       dr_elapsed_valid:1; /* we really did count time */
 500         unsigned int       dr_rw:1;
 501         struct page       *dr_pages[PTLRPC_MAX_BRW_PAGES];
 502         unsigned long      dr_blocks[PTLRPC_MAX_BRW_PAGES*MAX_BLOCKS_PER_PAGE];
 503         unsigned long      dr_start_time;
 504         unsigned long      dr_elapsed;  /* how long io took */
 505         struct osd_device *dr_dev;
 506 };
 507
 508 struct osd_thread_info {
 509         const struct lu_env   *oti_env;
 510         /**
 511          * used for index operations.
 512          */
 513         struct dentry          oti_obj_dentry;
 514         struct dentry          oti_child_dentry;
 515
 516         /** dentry for Iterator context. */
 517         struct dentry          oti_it_dentry;
 518         struct htree_lock     *oti_hlock;
 519
 520         struct lu_fid          oti_fid;
 521         struct lu_fid          oti_fid2;
 522         struct osd_inode_id    oti_id;
 523         struct osd_inode_id    oti_id2;
 524         struct ost_id          oti_ostid;
 525
 526         /*
 527          * XXX temporary: for ->i_op calls.
 528          */
 529         struct timespec        oti_time;
 530         /*
 531          * XXX temporary: fake struct file for osd_object_sync
 532          */
 533         struct file            oti_file;
 534         /*
 535          * XXX temporary: for capa operations.
 536          */
 537         struct lustre_capa_key oti_capa_key;
 538         struct lustre_capa     oti_capa;
 539
 540         /** osd_device reference, initialized in osd_trans_start() and
 541             used in osd_trans_stop() */
 542         struct osd_device     *oti_dev;
 543
 544         /**
 545          * following ipd and it structures are used for osd_index_iam_lookup()
 546          * these are defined separately as we might do index operation
 547          * in open iterator session.
 548          */
 549
 550         /** osd iterator context used for iterator session */
 551
 552         union {
 553                 struct osd_it_iam       oti_it;
 554                 /* ldiskfs iterator data structure,
 555                  * see osd_it_ea_{init, fini} */
 556                 struct osd_it_ea        oti_it_ea;
 557                 struct osd_it_quota     oti_it_quota;
 558         };
 559
 560         /** pre-allocated buffer used by oti_it_ea, size OSD_IT_EA_BUFSIZE */
 561         void                  *oti_it_ea_buf;
 562
 563         cfs_kstatfs_t          oti_ksfs;
 564
 565         /** IAM iterator for index operation. */
 566         struct iam_iterator    oti_idx_it;
 567
 568         /** union to guarantee that ->oti_ipd[] has proper alignment. */
 569         union {
 570                 char           oti_it_ipd[DX_IPD_MAX_SIZE];
 571                 long long      oti_alignment_lieutenant;
 572         };
 573
 574         union {
 575                 char           oti_idx_ipd[DX_IPD_MAX_SIZE];
 576                 long long      oti_alignment_lieutenant_colonel;
 577         };
 578
 579         struct osd_idmap_cache oti_cache;
 580
 581         int                    oti_r_locks;
 582         int                    oti_w_locks;
 583         int                    oti_txns;
 584         /** used in osd_fid_set() to put xattr */
 585         struct lu_buf          oti_buf;
 586         /** used in osd_ea_fid_set() to set fid into common ea */
 587         struct lustre_mdt_attrs oti_mdt_attrs;
 588         /** 0-copy IO */
 589         struct osd_iobuf       oti_iobuf;
 590         struct inode           oti_inode;
 591         int                    oti_created[PTLRPC_MAX_BRW_PAGES];
 592 #ifdef HAVE_QUOTA_SUPPORT
 593         struct osd_ctxt        oti_ctxt;
 594 #endif
 595         struct lu_env          oti_obj_delete_tx_env;
 596 #define OSD_FID_REC_SZ 32
 597         char                   oti_ldp[OSD_FID_REC_SZ];
 598         char                   oti_ldp2[OSD_FID_REC_SZ];
 599
 600         /* used by quota code */
 601         union {
 602                 struct if_dqblk         oti_dqblk;
 603                 struct if_dqinfo        oti_dqinfo;
 604         };
 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_lprocfs_time_start(const struct lu_env *env);
 615 void osd_lprocfs_time_end(const struct lu_env *env,
 616                           struct osd_device *osd, int op);
 617 void osd_brw_stats_update(struct osd_device *osd, struct osd_iobuf *iobuf);
 618
 619 #endif
 620 int osd_statfs(const struct lu_env *env, struct dt_device *dev,
 621                struct obd_statfs *sfs);
 622 int osd_object_auth(const struct lu_env *env, struct dt_object *dt,
 623                     struct lustre_capa *capa, __u64 opc);
 624 void osd_declare_qid(struct dt_object *dt, struct osd_thandle *oh,
 625                      int type, uid_t id, struct inode *inode);
 626 struct inode *osd_iget(struct osd_thread_info *info, struct osd_device *dev,
 627                        struct osd_inode_id *id);
 628 struct inode *osd_iget_fid(struct osd_thread_info *info, struct osd_device *dev,
 629                            struct osd_inode_id *id, struct lu_fid *fid);
 630
 631 int osd_compat_init(struct osd_device *dev);
 632 void osd_compat_fini(struct osd_device *dev);
 633 int osd_compat_objid_lookup(struct osd_thread_info *info,
 634                             struct osd_device *osd,
 635                             const struct lu_fid *fid, struct osd_inode_id *id);
 636 int osd_compat_objid_insert(struct osd_thread_info *info,
 637                             struct osd_device *osd,
 638                             const struct lu_fid *fid,
 639                             const struct osd_inode_id *id, struct thandle *th);
 640 int osd_compat_objid_delete(struct osd_thread_info *info,
 641                             struct osd_device *osd,
 642                             const struct lu_fid *fid, struct thandle *th);
 643 int osd_compat_spec_lookup(struct osd_thread_info *info,
 644                            struct osd_device *osd,
 645                            const struct lu_fid *fid, struct osd_inode_id *id);
 646 int osd_compat_spec_insert(struct osd_thread_info *info,
 647                            struct osd_device *osd,
 648                            const struct lu_fid *fid,
 649                            const struct osd_inode_id *id, struct thandle *th);
 650
 651 void osd_scrub_file_reset(struct osd_scrub *scrub, __u8 *uuid, __u64 flags);
 652 int osd_scrub_file_store(struct osd_scrub *scrub);
 653 int osd_scrub_start(struct osd_device *dev);
 654 int osd_scrub_setup(const struct lu_env *env, struct osd_device *dev);
 655 void osd_scrub_cleanup(const struct lu_env *env, struct osd_device *dev);
 656 int osd_oii_insert(struct osd_device *dev, struct osd_idmap_cache *oic,
 657                    int insert);
 658 int osd_oii_lookup(struct osd_device *dev, const struct lu_fid *fid,
 659                    struct osd_inode_id *id);
 660 int osd_scrub_dump(struct osd_device *dev, char *buf, int len);
 661
 662 /* osd_quota_fmt.c */
 663 int walk_tree_dqentry(const struct lu_env *env, struct osd_object *obj,
 664                       int type, uint blk, int depth, uint index,
 665                       struct osd_it_quota *it);
 666 int walk_block_dqentry(const struct lu_env *env, struct osd_object *obj,
 667                        int type, uint blk, uint index,
 668                        struct osd_it_quota *it);
 669 loff_t find_tree_dqentry(const struct lu_env *env,
 670                          struct osd_object *obj, int type,
 671                          qid_t dqid, uint blk, int depth,
 672                          struct osd_it_quota *it);
 673 /*
 674  * Invariants, assertions.
 675  */
 676
 677 /*
 678  * XXX: do not enable this, until invariant checking code is made thread safe
 679  * in the face of pdirops locking.
 680  */
 681 #define OSD_INVARIANT_CHECKS (0)
 682
 683 #if OSD_INVARIANT_CHECKS
 684 static inline int osd_invariant(const struct osd_object *obj)
 685 {
 686         return
 687                 obj != NULL &&
 688                 ergo(obj->oo_inode != NULL,
 689                      obj->oo_inode->i_sb == osd_sb(osd_obj2dev(obj)) &&
 690                      atomic_read(&obj->oo_inode->i_count) > 0) &&
 691                 ergo(obj->oo_dir != NULL &&
 692                      obj->oo_dir->od_conationer.ic_object != NULL,
 693                      obj->oo_dir->od_conationer.ic_object == obj->oo_inode);
 694 }
 695 #else
 696 #define osd_invariant(obj) (1)
 697 #endif
 698
 699 extern const struct dt_index_operations osd_otable_ops;
 700
 701 static inline int osd_oi_fid2idx(struct osd_device *dev,
 702                                  const struct lu_fid *fid)
 703 {
 704         return fid->f_seq & (dev->od_oi_count - 1);
 705 }
 706
 707 static inline struct osd_oi *osd_fid2oi(struct osd_device *osd,
 708                                         const struct lu_fid *fid)
 709 {
 710         LASSERTF(!fid_is_idif(fid), DFID"\n", PFID(fid));
 711         LASSERTF(!fid_is_igif(fid), DFID"\n", PFID(fid));
 712         LASSERT(osd->od_oi_table != NULL && osd->od_oi_count >= 1);
 713         /* It can work even od_oi_count equals to 1 although it's unexpected,
 714          * the only reason we set it to 1 is for performance measurement */
 715         return osd->od_oi_table[osd_oi_fid2idx(osd, fid)];
 716 }
 717
 718 extern const struct lu_device_operations  osd_lu_ops;
 719
 720 static inline int lu_device_is_osd(const struct lu_device *d)
 721 {
 722         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
 723 }
 724
 725 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
 726 {
 727         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
 728         return container_of0(d, struct osd_device, od_dt_dev);
 729 }
 730
 731 static inline struct osd_device *osd_dev(const struct lu_device *d)
 732 {
 733         LASSERT(lu_device_is_osd(d));
 734         return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
 735 }
 736
 737 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
 738 {
 739         return osd_dev(o->oo_dt.do_lu.lo_dev);
 740 }
 741
 742 static inline struct super_block *osd_sb(const struct osd_device *dev)
 743 {
 744         return dev->od_mount->lmi_mnt->mnt_sb;
 745 }
 746
 747 static inline int osd_object_is_root(const struct osd_object *obj)
 748 {
 749         return osd_sb(osd_obj2dev(obj))->s_root->d_inode == obj->oo_inode;
 750 }
 751
 752 static inline struct osd_object *osd_obj(const struct lu_object *o)
 753 {
 754         LASSERT(lu_device_is_osd(o->lo_dev));
 755         return container_of0(o, struct osd_object, oo_dt.do_lu);
 756 }
 757
 758 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
 759 {
 760         return osd_obj(&d->do_lu);
 761 }
 762
 763 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
 764 {
 765         return &osd->od_dt_dev.dd_lu_dev;
 766 }
 767
 768 static inline journal_t *osd_journal(const struct osd_device *dev)
 769 {
 770         return LDISKFS_SB(osd_sb(dev))->s_journal;
 771 }
 772
 773 extern const struct dt_body_operations osd_body_ops;
 774 extern struct lu_context_key osd_key;
 775
 776 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
 777 {
 778         return lu_context_key_get(&env->le_ctx, &osd_key);
 779 }
 780
 781 extern const struct dt_body_operations osd_body_ops_new;
 782
 783 /**
 784  * IAM Iterator
 785  */
 786 static inline
 787 struct iam_path_descr *osd_it_ipd_get(const struct lu_env *env,
 788                                       const struct iam_container *bag)
 789 {
 790         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
 791                                            osd_oti_get(env)->oti_it_ipd);
 792 }
 793
 794 static inline
 795 struct iam_path_descr *osd_idx_ipd_get(const struct lu_env *env,
 796                                        const struct iam_container *bag)
 797 {
 798         return bag->ic_descr->id_ops->id_ipd_alloc(bag,
 799                                            osd_oti_get(env)->oti_idx_ipd);
 800 }
 801
 802 static inline void osd_ipd_put(const struct lu_env *env,
 803                                const struct iam_container *bag,
 804                                struct iam_path_descr *ipd)
 805 {
 806         bag->ic_descr->id_ops->id_ipd_free(ipd);
 807 }
 808
 809 int osd_ldiskfs_read(struct inode *inode, void *buf, int size, loff_t *offs);
 810 int osd_ldiskfs_write_record(struct inode *inode, void *buf, int bufsize,
 811                              loff_t *offs, handle_t *handle);
 812
 813 static inline
 814 struct dentry *osd_child_dentry_by_inode(const struct lu_env *env,
 815                                          struct inode *inode,
 816                                          const char *name, const int namelen)
 817 {
 818         struct osd_thread_info *info = osd_oti_get(env);
 819         struct dentry *child_dentry = &info->oti_child_dentry;
 820         struct dentry *obj_dentry = &info->oti_obj_dentry;
 821
 822         obj_dentry->d_inode = inode;
 823         obj_dentry->d_sb = inode->i_sb;
 824         obj_dentry->d_name.hash = 0;
 825
 826         child_dentry->d_name.hash = 0;
 827         child_dentry->d_parent = obj_dentry;
 828         child_dentry->d_name.name = name;
 829         child_dentry->d_name.len = namelen;
 830         return child_dentry;
 831 }
 832
 833 /**
 834  * Helper function to pack the fid, ldiskfs stores fid in packed format.
 835  */
 836 static inline
 837 void osd_fid_pack(struct osd_fid_pack *pack, const struct dt_rec *fid,
 838                   struct lu_fid *befider)
 839 {
 840         fid_cpu_to_be(befider, (struct lu_fid *)fid);
 841         memcpy(pack->fp_area, befider, sizeof(*befider));
 842         pack->fp_len =  sizeof(*befider) + 1;
 843 }
 844
 845 static inline
 846 int osd_fid_unpack(struct lu_fid *fid, const struct osd_fid_pack *pack)
 847 {
 848         int result;
 849
 850         result = 0;
 851         switch (pack->fp_len) {
 852         case sizeof *fid + 1:
 853                 memcpy(fid, pack->fp_area, sizeof *fid);
 854                 fid_be_to_cpu(fid, fid);
 855                 break;
 856         default:
 857                 CERROR("Unexpected packed fid size: %d\n", pack->fp_len);
 858                 result = -EIO;
 859         }
 860         return result;
 861 }
 862
 863 /**
 864  * Quota/Accounting handling
 865  */
 866 extern const struct dt_index_operations osd_acct_index_ops;
 867 int osd_acct_obj_lookup(struct osd_thread_info *info, struct osd_device *osd,
 868                         const struct lu_fid *fid, struct osd_inode_id *id);
 869
 870 #endif /* __KERNEL__ */
 871 #endif /* _OSD_INTERNAL_H */