4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2016, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/osd/osd_internal.h
34 * Shared definitions and declarations for osd module
36 * Author: Nikita Danilov <nikita@clusterfs.com>
39 #ifndef _OSD_INTERNAL_H
40 #define _OSD_INTERNAL_H
44 #include <linux/mutex.h>
45 /* struct rw_semaphore */
46 #include <linux/rwsem.h>
48 #include <linux/dcache.h>
50 #include <linux/dirent.h>
51 #include <linux/statfs.h>
52 #include <ldiskfs/ldiskfs.h>
53 #include <ldiskfs/ldiskfs_jbd2.h>
57 /* class_register_type(), class_unregister_type(), class_get_type() */
58 #include <obd_class.h>
59 #include <lustre_disk.h>
60 #include <dt_object.h>
61 #include <lustre_quota.h>
65 #include "osd_scrub.h"
66 #include "osd_quota_fmt.h"
69 extern struct kmem_cache *dynlock_cachep;
71 #define OSD_COUNTERS (0)
73 /* ldiskfs special inode::i_state_flags need to be accessed with
74 * ldiskfs_{set,clear,test}_inode_state() only */
76 /* OI scrub should skip this inode. */
77 #define LDISKFS_STATE_LUSTRE_NOSCRUB 31
78 #define LDISKFS_STATE_LUSTRE_DESTROY 30
80 /** Enable thandle usage statistics */
81 #define OSD_THANDLE_STATS (0)
83 #define MAX_OBJID_GROUP (FID_SEQ_ECHO + 1)
85 #define OBJECTS "OBJECTS"
86 #define ADMIN_USR "admin_quotafile_v2.usr"
87 #define ADMIN_GRP "admin_quotafile_v2.grp"
89 /* Statfs space reservation for fragmentation and local objects */
90 #define OSD_STATFS_RESERVED (1ULL << 23) /* 8MB */
91 #define OSD_STATFS_RESERVED_SHIFT (7) /* reserve 0.78% of all space */
93 /* check if ldiskfs support project quota */
94 #ifndef LDISKFS_IOC_FSSETXATTR
95 #undef HAVE_PROJECT_QUOTA
98 struct osd_directory {
99 struct iam_container od_container;
100 struct iam_descr od_descr;
104 * Object Index (oi) instance.
108 * underlying index object, where fid->id mapping in stored.
110 struct inode *oi_inode;
111 struct osd_directory oi_dir;
114 extern const int osd_dto_credits_noquota[];
117 struct dt_object oo_dt;
119 * Inode for file system object represented by this osd_object. This
120 * inode is pinned for the whole duration of lu_object life.
122 * Not modified concurrently (either setup early during object
123 * creation, or assigned by osd_object_create() under write lock).
125 struct inode *oo_inode;
127 * to protect index ops.
129 struct htree_lock_head *oo_hl_head;
130 struct rw_semaphore oo_ext_idx_sem;
131 struct rw_semaphore oo_sem;
132 struct osd_directory *oo_dir;
133 /** protects inode attributes. */
136 __u32 oo_destroyed:1;
138 /* the i_flags in LMA */
141 * Following two members are used to indicate the presence of dot and
142 * dotdot in the given directory. This is required for interop mode
145 int oo_compat_dot_created;
146 int oo_compat_dotdot_created;
148 const struct lu_env *oo_owner;
149 #ifdef CONFIG_LOCKDEP
150 struct lockdep_map oo_dep_map;
153 struct list_head oo_xattr_list;
157 /* protects on-fly initialization */
158 int oos_subdir_count; /* subdir count for each seq */
159 struct dentry *oos_root; /* O/<seq> */
160 struct dentry **oos_dirs; /* O/<seq>/d0-dXX */
161 u64 oos_seq; /* seq number */
162 struct list_head oos_seq_list; /* list to seq_list */
166 struct dentry *om_root; /* dentry for /O */
167 rwlock_t om_seq_list_lock; /* lock for seq_list */
168 struct list_head om_seq_list; /* list head for seq */
170 struct mutex om_dir_init_mutex;
174 struct dentry *om_root; /* AGENT/<index> */
175 u64 om_index; /* mdt index */
176 struct list_head om_list; /* list to omm_list */
179 struct osd_mdobj_map {
180 struct dentry *omm_remote_parent;
182 int osd_ldiskfs_add_entry(struct osd_thread_info *info, struct osd_device *osd,
183 handle_t *handle, struct dentry *child,
184 struct inode *inode, struct htree_lock *hlock);
186 #define OSD_OTABLE_IT_CACHE_SIZE 64
187 #define OSD_OTABLE_IT_CACHE_MASK (~(OSD_OTABLE_IT_CACHE_SIZE - 1))
189 struct osd_inconsistent_item {
190 /* link into osd_scrub::os_inconsistent_items,
191 * protected by osd_scrub::os_lock. */
192 struct list_head oii_list;
194 /* The right FID <=> ino#/gen mapping. */
195 struct osd_idmap_cache oii_cache;
197 unsigned int oii_insert:1; /* insert or update mapping. */
200 struct osd_otable_cache {
201 struct osd_idmap_cache ooc_cache[OSD_OTABLE_IT_CACHE_SIZE];
203 /* Index for next cache slot to be filled. */
204 int ooc_producer_idx;
206 /* Index for next cache slot to be returned by it::next(). */
207 int ooc_consumer_idx;
209 /* How many items in ooc_cache. */
210 int ooc_cached_items;
212 /* Position for up layer LFSCK iteration pre-loading. */
213 __u32 ooc_pos_preload;
216 struct osd_otable_it {
217 struct osd_device *ooi_dev;
218 struct osd_otable_cache ooi_cache;
220 /* The following bits can be updated/checked w/o lock protection.
221 * If more bits will be introduced in the future and need lock to
222 * protect, please add comment. */
223 unsigned long ooi_used_outside:1, /* Some user out of OSD
224 * uses the iteration. */
225 ooi_all_cached:1, /* No more entries can be
226 * filled into cache. */
227 ooi_user_ready:1, /* The user out of OSD is
228 * ready to iterate. */
229 ooi_waiting:1; /* it::next is waiting. */
232 struct osd_obj_orphan {
233 struct list_head oor_list;
234 struct lu_env *oor_env; /* to identify "own" records */
243 struct dt_device od_dt_dev;
244 /* information about underlying file system */
245 struct vfsmount *od_mnt;
247 struct osd_oi **od_oi_table;
248 /* total number of OI containers */
253 unsigned int od_fl_capa:1,
261 __u32 od_dirent_journal;
263 struct proc_dir_entry *od_proc_entry;
264 struct lprocfs_stats *od_stats;
266 spinlock_t od_osfs_lock;
269 struct lu_site od_site;
271 struct osd_obj_map *od_ost_map;
272 struct osd_mdobj_map *od_mdt_map;
274 unsigned long long od_readcache_max_filesize;
276 int od_writethrough_cache;
278 struct brw_stats od_brw_stats;
279 atomic_t od_r_in_flight;
280 atomic_t od_w_in_flight;
282 struct mutex od_otable_mutex;
283 struct osd_otable_it *od_otable_it;
284 struct osd_scrub od_scrub;
285 struct list_head od_ios_list;
287 /* service name associated with the osd device */
288 char od_svname[MAX_OBD_NAME];
289 char od_mntdev[MAX_OBD_NAME];
291 /* quota slave instance */
292 struct qsd_instance *od_quota_slave;
294 /* osd seq instance */
295 struct lu_client_seq *od_cl_seq;
296 /* If the ratio of "the total OI mappings count" vs
297 * "the bad OI mappings count" is lower than the
298 * osd_device::od_full_scrub_ratio, then trigger
299 * OI scrub to scan the whole the device. */
300 __u64 od_full_scrub_ratio;
301 /* If the speed of found bad OI mappings (per minute)
302 * exceeds the osd_device::od_full_scrub_threshold_rate,
303 * then trigger OI scrub to scan the whole device. */
304 __u64 od_full_scrub_threshold_rate;
306 /* a list of orphaned agent inodes, protected with od_osfs_lock */
307 struct list_head od_orphan_list;
310 enum osd_full_scrub_ratio {
311 /* Trigger OI scrub to scan the whole device directly. */
314 /* Because the bad OI mappings count cannot be larger than
315 * the total OI mappints count, then setting OFSR_NEVER means
316 * that the whole device scanning cannot be triggered by auto
317 * detected bad OI mappings during the RPC services. */
319 OFSR_DEFAULT = 10000,
322 #define FULL_SCRUB_THRESHOLD_RATE_DEFAULT 60
324 /* There are at most 15 uid/gid/projids are affected in a transaction, and
325 * that's rename case:
326 * - 3 for source parent uid & gid & projid;
327 * - 3 for source child uid & gid & projid ('..' entry update when
328 * child is directory);
329 * - 3 for target parent uid & gid & projid;
330 * - 3 for target child uid & gid & projid(if the target child exists);
331 * - 3 for root uid & gid(last_rcvd, llog, etc);
334 #define OSD_MAX_UGID_CNT 15
339 OSD_OT_XATTR_SET = 2,
352 struct thandle ot_super;
354 struct ldiskfs_journal_cb_entry ot_jcb;
355 struct list_head ot_commit_dcb_list;
356 struct list_head ot_stop_dcb_list;
357 /* Link to the device, for debugging. */
358 struct lu_ref_link ot_dev_link;
359 unsigned int ot_credits;
360 unsigned short ot_id_cnt;
361 __u8 ot_id_types[OSD_MAX_UGID_CNT];
362 unsigned int ot_remove_agents:1;
363 uid_t ot_id_array[OSD_MAX_UGID_CNT];
364 struct lquota_trans *ot_quota_trans;
365 #if OSD_THANDLE_STATS
366 /** time when this handle was allocated */
369 /** time when this thanle was started */
375 * Basic transaction credit op
396 #ifdef CONFIG_PROC_FS
398 LPROC_OSD_READ_BYTES = 0,
399 LPROC_OSD_WRITE_BYTES = 1,
400 LPROC_OSD_GET_PAGE = 2,
401 LPROC_OSD_NO_PAGE = 3,
402 LPROC_OSD_CACHE_ACCESS = 4,
403 LPROC_OSD_CACHE_HIT = 5,
404 LPROC_OSD_CACHE_MISS = 6,
406 #if OSD_THANDLE_STATS
407 LPROC_OSD_THANDLE_STARTING,
408 LPROC_OSD_THANDLE_OPEN,
409 LPROC_OSD_THANDLE_CLOSING,
416 * Storage representation for fids.
418 * Variable size, first byte contains the length of the whole record.
420 struct osd_fid_pack {
421 unsigned char fp_len;
422 char fp_area[sizeof(struct lu_fid)];
425 struct osd_it_ea_dirent {
426 struct lu_fid oied_fid;
429 unsigned short oied_namelen;
430 unsigned int oied_type;
432 } __attribute__((packed));
435 * as osd_it_ea_dirent (in memory dirent struct for osd) is greater
436 * than lu_dirent struct. osd readdir reads less number of dirent than
437 * required for mdd dir page. so buffer size need to be increased so that
438 * there would be one ext3 readdir for every mdd readdir page.
441 #define OSD_IT_EA_BUFSIZE (PAGE_SIZE + PAGE_SIZE/4)
444 * This is iterator's in-memory data structure in interoperability
445 * mode (i.e. iterator over ldiskfs style directory)
448 struct osd_object *oie_obj;
449 /** used in ldiskfs iterator, to stored file pointer */
450 struct file oie_file;
451 /** how many entries have been read-cached from storage */
453 /** current entry is being iterated by caller */
455 /** current processing entry */
456 struct osd_it_ea_dirent *oie_dirent;
457 /** buffer to hold entries, size == OSD_IT_EA_BUFSIZE */
459 struct dentry oie_dentry;
463 * Iterator's in-memory data structure for IAM mode.
466 struct osd_object *oi_obj;
467 struct iam_path_descr *oi_ipd;
468 struct iam_iterator oi_it;
471 struct osd_quota_leaf {
472 struct list_head oql_link;
477 * Iterator's in-memory data structure for quota file.
479 struct osd_it_quota {
480 struct osd_object *oiq_obj;
481 /** tree blocks path to where the entry is stored */
482 uint oiq_blk[LUSTRE_DQTREEDEPTH + 1];
483 /** on-disk offset for current key where quota record can be found */
485 /** identifier for current quota record */
487 /** the record index in the leaf/index block */
488 uint oiq_index[LUSTRE_DQTREEDEPTH + 1];
489 /** list of already processed leaf blocks */
490 struct list_head oiq_list;
493 #define MAX_BLOCKS_PER_PAGE (PAGE_SIZE / 512)
496 wait_queue_head_t dr_wait;
497 atomic_t dr_numreqs; /* number of reqs being processed */
502 unsigned int dr_ignore_quota:1;
503 unsigned int dr_elapsed_valid:1; /* we really did count time */
504 unsigned int dr_rw:1;
505 struct lu_buf dr_pg_buf;
506 struct page **dr_pages;
507 struct lu_buf dr_bl_buf;
509 unsigned long dr_start_time;
510 unsigned long dr_elapsed; /* how long io took */
511 struct osd_device *dr_dev;
512 unsigned int dr_init_at; /* the line iobuf was initialized */
515 #define OSD_INS_CACHE_SIZE 8
517 struct osd_thread_info {
518 const struct lu_env *oti_env;
520 * used for index operations.
522 struct dentry oti_obj_dentry;
523 struct dentry oti_child_dentry;
525 /** dentry for Iterator context. */
526 struct dentry oti_it_dentry;
529 /* fake struct file for osd_object_sync */
530 struct file oti_file;
532 struct kstatfs oti_ksfs;
535 struct htree_lock *oti_hlock;
537 struct lu_fid oti_fid;
538 struct lu_fid oti_fid2;
539 struct lu_fid oti_fid3;
540 struct osd_inode_id oti_id;
541 struct osd_inode_id oti_id2;
542 struct osd_inode_id oti_id3;
543 struct ost_id oti_ostid;
546 * XXX temporary: for ->i_op calls.
548 struct timespec oti_time;
551 * following ipd and it structures are used for osd_index_iam_lookup()
552 * these are defined separately as we might do index operation
553 * in open iterator session.
556 /** pre-allocated buffer used by oti_it_ea, size OSD_IT_EA_BUFSIZE */
558 unsigned int oti_it_ea_buf_used:1;
560 /* IAM iterator for index operation. */
561 struct iam_iterator oti_idx_it;
563 /** union to guarantee that ->oti_ipd[] has proper alignment. */
566 char oti_it_ipd[DX_IPD_MAX_SIZE];
567 long long oti_alignment_lieutenant;
571 char oti_idx_ipd[DX_IPD_MAX_SIZE];
572 long long oti_alignment_lieutenant_colonel;
575 struct osd_idmap_cache oti_cache;
577 /* dedicated OI cache for insert (which needs inum) */
578 struct osd_idmap_cache *oti_ins_cache;
579 int oti_ins_cache_size;
580 int oti_ins_cache_used;
585 /** used in osd_fid_set() to put xattr */
586 struct lu_buf oti_buf;
587 struct lu_buf oti_big_buf;
588 /** used in osd_ea_fid_set() to set fid into common ea */
590 struct lustre_ost_attrs oti_ost_attrs;
591 struct filter_fid_old oti_ff;
592 struct filter_fid oti_ff_new;
595 struct osd_iobuf oti_iobuf;
596 /* used to access objects in /O */
597 struct inode *oti_inode;
598 #define OSD_FID_REC_SZ 32
599 char oti_ldp[OSD_FID_REC_SZ];
600 char oti_ldp2[OSD_FID_REC_SZ];
602 /* used by quota code */
604 #if defined(HAVE_DQUOT_QC_DQBLK)
605 struct qc_dqblk oti_qdq;
606 #elif defined(HAVE_DQUOT_FS_DISK_QUOTA)
607 struct fs_disk_quota oti_fdq;
609 struct if_dqblk oti_dqblk;
611 struct if_dqinfo oti_dqinfo;
613 struct lquota_id_info oti_qi;
614 struct lquota_trans oti_quota_trans;
615 union lquota_rec oti_quota_rec;
617 struct lu_seq_range oti_seq_range;
619 /* Tracking for transaction credits, to allow debugging and optimizing
620 * cases where a large number of credits are being allocated for
621 * single transaction. */
622 unsigned int oti_credits_before;
623 unsigned int oti_declare_ops[OSD_OT_MAX];
624 unsigned int oti_declare_ops_cred[OSD_OT_MAX];
625 unsigned int oti_declare_ops_used[OSD_OT_MAX];
628 extern int ldiskfs_pdo;
630 static inline int __osd_xattr_get(struct inode *inode, struct dentry *dentry,
631 const char *name, void *buf, int len)
636 dentry->d_inode = inode;
637 dentry->d_sb = inode->i_sb;
638 return inode->i_op->getxattr(dentry, name, buf, len);
641 static inline int __osd_xattr_set(struct osd_thread_info *info,
642 struct inode *inode, const char *name,
643 const void *buf, int buflen, int fl)
645 struct dentry *dentry = &info->oti_child_dentry;
647 ll_vfs_dq_init(inode);
648 dentry->d_inode = inode;
649 dentry->d_sb = inode->i_sb;
650 return inode->i_op->setxattr(dentry, name, buf, buflen, fl);
653 #ifdef CONFIG_PROC_FS
655 extern struct lprocfs_vars lprocfs_osd_obd_vars[];
656 extern struct lprocfs_vars lprocfs_osd_module_vars[];
657 int osd_procfs_init(struct osd_device *osd, const char *name);
658 int osd_procfs_fini(struct osd_device *osd);
659 void osd_brw_stats_update(struct osd_device *osd, struct osd_iobuf *iobuf);
660 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(3, 0, 52, 0)
661 int osd_register_proc_index_in_idif(struct osd_device *osd);
665 int osd_statfs(const struct lu_env *env, struct dt_device *dev,
666 struct obd_statfs *sfs);
667 struct inode *osd_iget(struct osd_thread_info *info, struct osd_device *dev,
668 struct osd_inode_id *id);
669 int osd_ea_fid_set(struct osd_thread_info *info, struct inode *inode,
670 const struct lu_fid *fid, __u32 compat, __u32 incompat);
671 int osd_get_lma(struct osd_thread_info *info, struct inode *inode,
672 struct dentry *dentry, struct lustre_ost_attrs *loa);
673 void osd_add_oi_cache(struct osd_thread_info *info, struct osd_device *osd,
674 struct osd_inode_id *id, const struct lu_fid *fid);
675 int osd_get_idif(struct osd_thread_info *info, struct inode *inode,
676 struct dentry *dentry, struct lu_fid *fid);
678 int osd_obj_map_init(const struct lu_env *env, struct osd_device *osd);
679 void osd_obj_map_fini(struct osd_device *dev);
680 int osd_obj_map_lookup(struct osd_thread_info *info, struct osd_device *osd,
681 const struct lu_fid *fid, struct osd_inode_id *id);
682 int osd_obj_map_insert(struct osd_thread_info *info, struct osd_device *osd,
683 const struct lu_fid *fid, const struct osd_inode_id *id,
685 int osd_obj_map_delete(struct osd_thread_info *info, struct osd_device *osd,
686 const struct lu_fid *fid, handle_t *th);
687 int osd_obj_map_update(struct osd_thread_info *info, struct osd_device *osd,
688 const struct lu_fid *fid, const struct osd_inode_id *id,
690 int osd_obj_map_recover(struct osd_thread_info *info, struct osd_device *osd,
691 struct inode *src_parent, struct dentry *src_child,
692 const struct lu_fid *fid);
693 int osd_obj_spec_lookup(struct osd_thread_info *info, struct osd_device *osd,
694 const struct lu_fid *fid, struct osd_inode_id *id);
695 int osd_obj_spec_insert(struct osd_thread_info *info, struct osd_device *osd,
696 const struct lu_fid *fid, const struct osd_inode_id *id,
698 int osd_obj_spec_update(struct osd_thread_info *info, struct osd_device *osd,
699 const struct lu_fid *fid, const struct osd_inode_id *id,
702 void osd_scrub_file_reset(struct osd_scrub *scrub, __u8 *uuid, __u64 flags);
703 int osd_scrub_file_store(struct osd_scrub *scrub);
704 char *osd_lf_fid2name(const struct lu_fid *fid);
705 int osd_scrub_start(struct osd_device *dev, __u32 flags);
706 int osd_scrub_setup(const struct lu_env *env, struct osd_device *dev);
707 void osd_scrub_cleanup(const struct lu_env *env, struct osd_device *dev);
708 int osd_oii_insert(struct osd_device *dev, struct osd_idmap_cache *oic,
710 int osd_oii_lookup(struct osd_device *dev, const struct lu_fid *fid,
711 struct osd_inode_id *id);
712 int osd_scrub_dump(struct seq_file *m, struct osd_device *dev);
714 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
715 u64 seq, struct lu_seq_range *range);
717 int osd_delete_from_remote_parent(const struct lu_env *env,
718 struct osd_device *osd,
719 struct osd_object *obj,
720 struct osd_thandle *oh);
721 int osd_add_to_remote_parent(const struct lu_env *env, struct osd_device *osd,
722 struct osd_object *obj, struct osd_thandle *oh);
723 int osd_lookup_in_remote_parent(struct osd_thread_info *oti,
724 struct osd_device *osd,
725 const struct lu_fid *fid,
726 struct osd_inode_id *id);
728 int osd_ost_seq_exists(struct osd_thread_info *info, struct osd_device *osd,
730 /* osd_quota_fmt.c */
731 int walk_tree_dqentry(const struct lu_env *env, struct osd_object *obj,
732 int type, uint blk, int depth, uint index,
733 struct osd_it_quota *it);
734 int walk_block_dqentry(const struct lu_env *env, struct osd_object *obj,
735 int type, uint blk, uint index,
736 struct osd_it_quota *it);
737 loff_t find_tree_dqentry(const struct lu_env *env,
738 struct osd_object *obj, int type,
739 qid_t dqid, uint blk, int depth,
740 struct osd_it_quota *it);
742 int osd_declare_qid(const struct lu_env *env, struct osd_thandle *oh,
743 struct lquota_id_info *qi, struct osd_object *obj,
744 bool enforce, int *flags);
745 int osd_declare_inode_qid(const struct lu_env *env, qid_t uid, qid_t gid,
746 __u32 projid, long long space, struct osd_thandle *oh,
747 struct osd_object *obj, bool is_blk, int *flags,
749 const struct dt_rec *osd_quota_pack(struct osd_object *obj,
750 const struct dt_rec *rec,
751 union lquota_rec *quota_rec);
752 void osd_quota_unpack(struct osd_object *obj, const struct dt_rec *rec);
754 #ifndef HAVE_I_UID_READ
755 static inline uid_t i_uid_read(const struct inode *inode)
760 static inline gid_t i_gid_read(const struct inode *inode)
765 static inline void i_uid_write(struct inode *inode, uid_t uid)
770 static inline void i_gid_write(struct inode *inode, gid_t gid)
776 #ifdef HAVE_PROJECT_QUOTA
777 static inline __u32 i_projid_read(struct inode *inode)
779 return (__u32)from_kprojid(&init_user_ns, LDISKFS_I(inode)->i_projid);
782 static inline void i_projid_write(struct inode *inode, __u32 projid)
785 kprojid = make_kprojid(&init_user_ns, (projid_t)projid);
786 LDISKFS_I(inode)->i_projid = kprojid;
789 static inline uid_t i_projid_read(struct inode *inode)
793 static inline void i_projid_write(struct inode *inode, __u32 projid)
799 #ifdef HAVE_LDISKFS_INFO_JINODE
800 # define osd_attach_jinode(inode) ldiskfs_inode_attach_jinode(inode)
801 #else /* HAVE_LDISKFS_INFO_JINODE */
802 # define osd_attach_jinode(inode) 0
803 #endif /* HAVE_LDISKFS_INFO_JINODE */
805 #ifdef LDISKFS_HT_MISC
806 # define osd_journal_start_sb(sb, type, nblock) \
807 ldiskfs_journal_start_sb(sb, type, nblock)
808 static inline struct buffer_head *osd_ldiskfs_append(handle_t *handle,
810 ldiskfs_lblk_t *nblock)
814 rc = osd_attach_jinode(inode);
817 return ldiskfs_append(handle, inode, nblock);
819 # define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
820 (__ldiskfs_find_entry(dir, name, de, inlined, lock) ?: \
822 # define osd_journal_start(inode, type, nblocks) \
823 ldiskfs_journal_start(inode, type, nblocks)
824 # define osd_transaction_size(dev) \
825 (osd_journal(dev)->j_max_transaction_buffers / 2)
827 # define LDISKFS_HT_MISC 0
828 # define osd_journal_start_sb(sb, type, nblock) \
829 ldiskfs_journal_start_sb(sb, nblock)
831 static inline struct buffer_head *osd_ldiskfs_append(handle_t *handle,
833 ldiskfs_lblk_t *nblock)
835 struct buffer_head *bh;
838 bh = ldiskfs_append(handle, inode, nblock, &err);
845 # define osd_ldiskfs_find_entry(dir, name, de, inlined, lock) \
846 (__ldiskfs_find_entry(dir, name, de, lock) ?: \
848 # define osd_journal_start(inode, type, nblocks) \
849 ldiskfs_journal_start(inode, nblocks)
850 # define osd_transaction_size(dev) \
851 (osd_journal(dev)->j_max_transaction_buffers)
855 * Invariants, assertions.
859 * XXX: do not enable this, until invariant checking code is made thread safe
860 * in the face of pdirops locking.
862 #define OSD_INVARIANT_CHECKS (0)
864 #if OSD_INVARIANT_CHECKS
865 static inline int osd_invariant(const struct osd_object *obj)
869 ergo(obj->oo_inode != NULL,
870 obj->oo_inode->i_sb == osd_sb(osd_obj2dev(obj)) &&
871 atomic_read(&obj->oo_inode->i_count) > 0) &&
872 ergo(obj->oo_dir != NULL &&
873 obj->oo_dir->od_conationer.ic_object != NULL,
874 obj->oo_dir->od_conationer.ic_object == obj->oo_inode);
877 #define osd_invariant(obj) (1)
880 #define OSD_MAX_CACHE_SIZE OBD_OBJECT_EOF
882 extern const struct dt_index_operations osd_otable_ops;
884 static inline int osd_oi_fid2idx(struct osd_device *dev,
885 const struct lu_fid *fid)
887 return fid->f_seq & (dev->od_oi_count - 1);
890 static inline struct osd_oi *osd_fid2oi(struct osd_device *osd,
891 const struct lu_fid *fid)
893 LASSERTF(!fid_is_idif(fid), DFID"\n", PFID(fid));
894 LASSERTF(!fid_is_last_id(fid), DFID"\n", PFID(fid));
895 LASSERTF(osd->od_oi_table != NULL && osd->od_oi_count >= 1,
896 DFID"\n", PFID(fid));
897 /* It can work even od_oi_count equals to 1 although it's unexpected,
898 * the only reason we set it to 1 is for performance measurement */
899 return osd->od_oi_table[osd_oi_fid2idx(osd, fid)];
902 extern const struct lu_device_operations osd_lu_ops;
904 static inline int lu_device_is_osd(const struct lu_device *d)
906 return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
909 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
911 LASSERT(lu_device_is_osd(&d->dd_lu_dev));
912 return container_of0(d, struct osd_device, od_dt_dev);
915 static inline struct osd_device *osd_dev(const struct lu_device *d)
917 LASSERT(lu_device_is_osd(d));
918 return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
921 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
923 return osd_dev(o->oo_dt.do_lu.lo_dev);
926 static inline struct super_block *osd_sb(const struct osd_device *dev)
928 return dev->od_mnt->mnt_sb;
932 * Put the osd object once done with it.
934 * \param obj osd object that needs to be put
936 static inline void osd_object_put(const struct lu_env *env,
937 struct osd_object *obj)
939 dt_object_put(env, &obj->oo_dt);
942 static inline int osd_object_is_root(const struct osd_object *obj)
944 return osd_sb(osd_obj2dev(obj))->s_root->d_inode == obj->oo_inode;
947 static inline struct osd_object *osd_obj(const struct lu_object *o)
949 LASSERT(lu_device_is_osd(o->lo_dev));
950 return container_of0(o, struct osd_object, oo_dt.do_lu);
953 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
955 return osd_obj(&d->do_lu);
958 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
960 return &osd->od_dt_dev.dd_lu_dev;
963 static inline journal_t *osd_journal(const struct osd_device *dev)
965 return LDISKFS_SB(osd_sb(dev))->s_journal;
968 static inline struct seq_server_site *osd_seq_site(struct osd_device *osd)
970 return osd->od_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
973 static inline char *osd_name(struct osd_device *osd)
975 return osd->od_svname;
978 static inline bool osd_is_ea_inode(struct inode *inode)
980 return !!(LDISKFS_I(inode)->i_flags & LDISKFS_EA_INODE_FL);
983 extern const struct dt_body_operations osd_body_ops;
984 extern struct lu_context_key osd_key;
986 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
988 return lu_context_key_get(&env->le_ctx, &osd_key);
991 extern const struct dt_body_operations osd_body_ops_new;
997 struct iam_path_descr *osd_it_ipd_get(const struct lu_env *env,
998 const struct iam_container *bag)
1000 return bag->ic_descr->id_ops->id_ipd_alloc(bag,
1001 osd_oti_get(env)->oti_it_ipd);
1005 struct iam_path_descr *osd_idx_ipd_get(const struct lu_env *env,
1006 const struct iam_container *bag)
1008 return bag->ic_descr->id_ops->id_ipd_alloc(bag,
1009 osd_oti_get(env)->oti_idx_ipd);
1012 static inline void osd_ipd_put(const struct lu_env *env,
1013 const struct iam_container *bag,
1014 struct iam_path_descr *ipd)
1016 bag->ic_descr->id_ops->id_ipd_free(ipd);
1019 int osd_calc_bkmap_credits(struct super_block *sb, struct inode *inode,
1020 const loff_t size, const loff_t pos,
1023 int osd_ldiskfs_read(struct inode *inode, void *buf, int size, loff_t *offs);
1024 int osd_ldiskfs_write_record(struct inode *inode, void *buf, int bufsize,
1025 int write_NUL, loff_t *offs, handle_t *handle);
1028 struct dentry *osd_child_dentry_by_inode(const struct lu_env *env,
1029 struct inode *inode,
1030 const char *name, const int namelen)
1032 struct osd_thread_info *info = osd_oti_get(env);
1033 struct dentry *child_dentry = &info->oti_child_dentry;
1034 struct dentry *obj_dentry = &info->oti_obj_dentry;
1036 obj_dentry->d_inode = inode;
1037 obj_dentry->d_sb = inode->i_sb;
1038 obj_dentry->d_name.hash = 0;
1040 child_dentry->d_name.hash = 0;
1041 child_dentry->d_parent = obj_dentry;
1042 child_dentry->d_name.name = name;
1043 child_dentry->d_name.len = namelen;
1044 return child_dentry;
1047 extern int osd_trans_declare_op2rb[];
1048 extern int ldiskfs_track_declares_assert;
1049 void osd_trans_dump_creds(const struct lu_env *env, struct thandle *th);
1051 static inline void osd_trans_declare_op(const struct lu_env *env,
1052 struct osd_thandle *oh,
1053 enum osd_op_type op, int credits)
1055 struct osd_thread_info *oti = osd_oti_get(env);
1057 LASSERT(oh->ot_handle == NULL);
1058 if (unlikely(op >= OSD_OT_MAX)) {
1059 if (unlikely(ldiskfs_track_declares_assert)) {
1060 LASSERT(op < OSD_OT_MAX);
1062 CWARN("%s: Invalid operation index %d\n",
1063 osd_name(osd_dt_dev(oh->ot_super.th_dev)), op);
1064 libcfs_debug_dumpstack(NULL);
1067 oti->oti_declare_ops[op]++;
1068 oti->oti_declare_ops_cred[op] += credits;
1070 oh->ot_credits += credits;
1073 static inline void osd_trans_exec_op(const struct lu_env *env,
1075 enum osd_op_type op)
1077 struct osd_thread_info *oti = osd_oti_get(env);
1078 struct osd_thandle *oh = container_of(th, struct osd_thandle,
1080 unsigned int rb, left;
1082 LASSERT(oh->ot_handle != NULL);
1083 if (unlikely(op >= OSD_OT_MAX)) {
1084 if (unlikely(ldiskfs_track_declares_assert))
1085 LASSERT(op < OSD_OT_MAX);
1087 CWARN("%s: opcode %u: invalid value >= %u\n",
1088 osd_name(osd_dt_dev(oh->ot_super.th_dev)),
1090 libcfs_debug_dumpstack(NULL);
1095 /* find rollback (or reverse) operation for the given one
1096 * such an operation doesn't require additional credits
1097 * as the same set of blocks are modified */
1098 rb = osd_trans_declare_op2rb[op];
1100 /* check whether credits for this operation were reserved at all */
1101 if (unlikely(oti->oti_declare_ops_cred[op] == 0 &&
1102 oti->oti_declare_ops_cred[rb] == 0)) {
1103 /* the API is not perfect yet: CREATE does REF_ADD internally
1104 * while DESTROY does not. To rollback CREATE the callers
1105 * needs to call REF_DEL+DESTROY which is hard to detect using
1106 * a simple table of rollback operations */
1107 if (op == OSD_OT_REF_DEL &&
1108 oti->oti_declare_ops_cred[OSD_OT_CREATE] > 0)
1110 if (op == OSD_OT_REF_ADD &&
1111 oti->oti_declare_ops_cred[OSD_OT_DESTROY] > 0)
1113 CWARN("%s: opcode %u: credits = 0, rollback = %u\n",
1114 osd_name(osd_dt_dev(oh->ot_super.th_dev)), op, rb);
1115 osd_trans_dump_creds(env, th);
1116 LASSERT(!ldiskfs_track_declares_assert);
1120 /* remember how many credits we have unused before the operation */
1121 oti->oti_credits_before = oh->ot_handle->h_buffer_credits;
1122 left = oti->oti_declare_ops_cred[op] - oti->oti_declare_ops_used[op];
1123 if (unlikely(oti->oti_credits_before < left)) {
1124 CWARN("%s: opcode %u: before %u < left %u, rollback = %u\n",
1125 osd_name(osd_dt_dev(oh->ot_super.th_dev)), op,
1126 oti->oti_credits_before, left, rb);
1127 osd_trans_dump_creds(env, th);
1128 /* on a very small fs (testing?) it's possible that
1129 * the transaction can't fit 1/4 of journal, so we
1130 * just request less credits (see osd_trans_start()).
1131 * ignore the same case here */
1132 rb = osd_transaction_size(osd_dt_dev(th->th_dev));
1133 if (unlikely(oh->ot_credits < rb))
1134 LASSERT(!ldiskfs_track_declares_assert);
1138 static inline void osd_trans_exec_check(const struct lu_env *env,
1140 enum osd_op_type op)
1142 struct osd_thread_info *oti = osd_oti_get(env);
1143 struct osd_thandle *oh = container_of(th, struct osd_thandle,
1145 int used, over, quota;
1147 /* how many credits have been used by the operation */
1148 used = oti->oti_credits_before - oh->ot_handle->h_buffer_credits;
1150 if (unlikely(used < 0)) {
1151 /* if some block was allocated and released in the same
1152 * transaction, then it won't be a part of the transaction
1153 * and delta can be negative */
1158 /* rollback operations (e.g. when we destroy just created
1159 * object) should not consume any credits. there is no point
1160 * to confuse the checks below */
1164 oti->oti_declare_ops_used[op] += used;
1165 if (oti->oti_declare_ops_used[op] <= oti->oti_declare_ops_cred[op])
1168 /* we account quota for a whole transaction and any operation can
1169 * consume corresponding credits */
1170 over = oti->oti_declare_ops_used[op] -
1171 oti->oti_declare_ops_cred[op];
1172 quota = oti->oti_declare_ops_cred[OSD_OT_QUOTA] -
1173 oti->oti_declare_ops_used[OSD_OT_QUOTA];
1174 if (over <= quota) {
1175 /* probably that credits were consumed by
1176 * quota indirectly (in the depths of ldiskfs) */
1177 oti->oti_declare_ops_used[OSD_OT_QUOTA] += over;
1178 oti->oti_declare_ops_used[op] -= over;
1180 CWARN("%s: opcode %d: used %u, used now %u, reserved %u\n",
1181 osd_name(osd_dt_dev(oh->ot_super.th_dev)), op,
1182 oti->oti_declare_ops_used[op], used,
1183 oti->oti_declare_ops_cred[op]);
1184 osd_trans_dump_creds(env, th);
1185 if (unlikely(ldiskfs_track_declares_assert))
1191 * Helper function to pack the fid, ldiskfs stores fid in packed format.
1194 void osd_fid_pack(struct osd_fid_pack *pack, const struct dt_rec *fid,
1195 struct lu_fid *befider)
1197 fid_cpu_to_be(befider, (struct lu_fid *)fid);
1198 memcpy(pack->fp_area, befider, sizeof(*befider));
1199 pack->fp_len = sizeof(*befider) + 1;
1203 int osd_fid_unpack(struct lu_fid *fid, const struct osd_fid_pack *pack)
1208 switch (pack->fp_len) {
1209 case sizeof *fid + 1:
1210 memcpy(fid, pack->fp_area, sizeof *fid);
1211 fid_be_to_cpu(fid, fid);
1214 CERROR("Unexpected packed fid size: %d\n", pack->fp_len);
1221 * Quota/Accounting handling
1223 extern const struct dt_index_operations osd_acct_index_ops;
1224 int osd_acct_obj_lookup(struct osd_thread_info *info, struct osd_device *osd,
1225 const struct lu_fid *fid, struct osd_inode_id *id);
1227 /* copy from fs/ext4/dir.c */
1228 static inline int is_32bit_api(void)
1230 #ifdef CONFIG_COMPAT
1231 return in_compat_syscall();
1233 return (BITS_PER_LONG == 32);
1237 static inline loff_t ldiskfs_get_htree_eof(struct file *filp)
1239 if ((filp->f_mode & FMODE_32BITHASH) ||
1240 (!(filp->f_mode & FMODE_64BITHASH) && is_32bit_api()))
1241 return LDISKFS_HTREE_EOF_32BIT;
1243 return LDISKFS_HTREE_EOF_64BIT;
1246 static inline int fid_is_internal(const struct lu_fid *fid)
1248 return (!fid_is_namespace_visible(fid) && !fid_is_idif(fid));
1251 static inline unsigned long osd_remote_parent_ino(struct osd_device *dev)
1253 return dev->od_mdt_map->omm_remote_parent->d_inode->i_ino;
1257 * ext4_bread/ldiskfs_bread has either 5 or 4 parameters. The error
1258 * return code has been removed and integrated into the pointer in the
1261 static inline struct buffer_head *__ldiskfs_bread(handle_t *handle,
1262 struct inode *inode,
1263 ldiskfs_lblk_t block,
1267 struct buffer_head *bh;
1270 rc = osd_attach_jinode(inode);
1274 #ifdef HAVE_EXT4_BREAD_4ARGS
1275 bh = ldiskfs_bread(handle, inode, block, create);
1278 bh = ldiskfs_bread(handle, inode, block, create, &rc);
1279 if (bh == NULL && rc != 0)
1285 void ldiskfs_inc_count(handle_t *handle, struct inode *inode);
1286 void ldiskfs_dec_count(handle_t *handle, struct inode *inode);
1288 void osd_fini_iobuf(struct osd_device *d, struct osd_iobuf *iobuf);
1291 #endif /* _OSD_INTERNAL_H */