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