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