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