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