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