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