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