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, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/mdt/mdt_internal.h
34 * Lustre Metadata Target (mdt) request handler
36 * Author: Peter Braam <braam@clusterfs.com>
37 * Author: Andreas Dilger <adilger@clusterfs.com>
38 * Author: Phil Schwan <phil@clusterfs.com>
39 * Author: Mike Shaver <shaver@clusterfs.com>
40 * Author: Nikita Danilov <nikita@clusterfs.com>
41 * Author: Huang Hua <huanghua@clusterfs.com>
44 #ifndef _MDT_INTERNAL_H
45 #define _MDT_INTERNAL_H
47 #include <libcfs/libcfs.h>
48 #include <libcfs/libcfs_hash.h>
49 #include <upcall_cache.h>
50 #include <obd_class.h>
51 #include <lustre_disk.h>
52 #include <lu_target.h>
53 #include <md_object.h>
54 #include <lustre_fid.h>
55 #include <lustre_fld.h>
56 #include <lustre_req_layout.h>
57 #include <lustre_sec.h>
58 #include <lustre_idmap.h>
59 #include <lustre_eacl.h>
60 #include <lustre_quota.h>
61 #include <lustre_linkea.h>
65 /* file data for open files on MDS */
66 struct mdt_file_data {
67 /** portals handle must be first */
68 struct portals_handle mfd_open_handle;
69 /** open mode provided by client */
71 /** protected by med_open_lock */
72 struct list_head mfd_list;
73 /** xid of the open request */
75 /** old handle in replay case */
76 struct lustre_handle mfd_open_handle_old;
77 /** point to opened object */
78 struct mdt_object *mfd_object;
81 #define CDT_NONBLOCKING_RESTORE (1ULL << 0)
82 #define CDT_NORETRY_ACTION (1ULL << 1)
83 #define CDT_POLICY_LAST CDT_NORETRY_ACTION
84 #define CDT_POLICY_SHIFT_COUNT 2
85 #define CDT_POLICY_ALL (CDT_NONBLOCKING_RESTORE | \
88 /* when adding a new policy, do not forget to update
89 * lustre/mdt/mdt_coordinator.c::hsm_policy_names[]
91 #define CDT_DEFAULT_POLICY CDT_NORETRY_ACTION
93 /* Coordinator states. Keep the cdt_transition table in sync. */
94 enum cdt_states { CDT_STOPPED = 0,
103 static inline char *cdt_mdt_state2str(int state)
121 /* when multiple lock are needed, the lock order is
129 wait_queue_head_t cdt_waitq; /**< cdt wait queue */
130 bool cdt_event; /**< coordinator event */
131 struct task_struct *cdt_task; /**< cdt thread handle */
132 struct lu_env cdt_env; /**< coordinator lustre
134 struct lu_context cdt_session; /** session for lu_ucred */
135 struct proc_dir_entry *cdt_proc_dir; /**< cdt /proc directory */
136 __u64 cdt_policy; /**< policy flags */
137 enum cdt_states cdt_state; /**< state */
138 struct mutex cdt_state_lock; /**< cdt_state lock */
139 __u64 cdt_last_cookie; /**< last cookie
141 struct rw_semaphore cdt_llog_lock; /**< protect llog
143 struct rw_semaphore cdt_agent_lock; /**< protect agent list */
144 struct rw_semaphore cdt_request_lock; /**< protect request
146 struct mutex cdt_restore_lock; /**< protect restore
148 time64_t cdt_loop_period; /**< llog scan period */
149 time64_t cdt_grace_delay; /**< request grace
151 time64_t cdt_active_req_timeout; /**< request timeout */
152 __u32 cdt_default_archive_id; /**< archive id used
155 __u64 cdt_max_requests; /**< max count of started
157 /** Current count of active requests */
158 atomic_t cdt_request_count; /** total */
159 atomic_t cdt_archive_count;
160 atomic_t cdt_restore_count;
161 atomic_t cdt_remove_count;
163 /* started requests (struct cdt_agent_req:car_cookie_hash)
164 * indexed by cookie */
165 struct cfs_hash *cdt_request_cookie_hash;
166 /* started requests (struct cdt_agent_req:car_request_list) */
167 struct list_head cdt_request_list;
168 struct list_head cdt_agents; /**< list of register
170 struct list_head cdt_restore_handle_list;
172 /* Hash of cookies to locations of record locations in agent
174 struct cfs_hash *cdt_agent_record_hash;
176 /* Bitmasks indexed by the HSMA_XXX constants. */
177 __u64 cdt_user_request_mask;
178 __u64 cdt_group_request_mask;
179 __u64 cdt_other_request_mask;
181 /* Remove archive on last unlink policy */
182 bool cdt_remove_archive_on_last_unlink;
184 bool cdt_wakeup_coordinator;
187 /* mdt state flag bits */
188 #define MDT_FL_CFGLOG 0
189 #define MDT_FL_SYNCED 1
191 /* possible values for mo_dom_lock */
193 NO_DOM_LOCK_ON_OPEN = 0,
194 TRYLOCK_DOM_ON_OPEN = 1,
195 ALWAYS_DOM_LOCK_ON_OPEN = 2,
196 NUM_DOM_LOCK_ON_OPEN_MODES
199 struct mdt_statfs_cache {
200 struct obd_statfs msf_osfs;
206 struct lu_device mdt_lu_dev;
207 struct seq_server_site mdt_seq_site;
208 /* DLM name-space for meta-data locks maintained by this server */
209 struct ldlm_namespace *mdt_namespace;
210 /* ptlrpc handle for MDS->client connections (for lock ASTs). */
211 struct ptlrpc_client *mdt_ldlm_client;
212 /* underlying device */
213 struct obd_export *mdt_child_exp;
214 struct md_device *mdt_child;
215 struct dt_device *mdt_bottom;
216 struct obd_export *mdt_bottom_exp;
217 struct local_oid_storage *mdt_los;
219 struct lu_target mdt_lut;
221 * Options bit-fields.
224 unsigned int mo_user_xattr:1,
229 mo_migrate_hsm_allowed:1;
230 unsigned int mo_dom_lock;
232 /* mdt state flags */
233 unsigned long mdt_state;
235 /* transaction callbacks */
236 struct dt_txn_callback mdt_txn_cb;
238 /* these values should be updated from lov if necessary.
239 * or should be placed somewhere else. */
244 /* preferred BRW size, decided by storage type and capability */
247 struct upcall_cache *mdt_identity_cache;
249 unsigned int mdt_capa_conf:1,
250 /* Enable remote dir on non-MDT0 */
251 mdt_enable_remote_dir:1,
252 mdt_enable_striped_dir:1,
253 mdt_enable_dir_migration:1,
257 /* user with gid can create remote/striped
258 * dir, and set default dir stripe */
259 gid_t mdt_enable_remote_dir_gid;
261 /* lock for osfs and md_root */
264 /* statfs optimization: we cache a bit */
265 struct mdt_statfs_cache mdt_sum_osfs;
266 struct mdt_statfs_cache mdt_osfs;
269 struct root_squash_info mdt_squash;
271 struct rename_stats mdt_rename_stats;
272 struct lu_fid mdt_md_root_fid;
274 /* connection to quota master */
275 struct obd_export *mdt_qmt_exp;
276 /* quota master device associated with this MDT */
277 struct lu_device *mdt_qmt_dev;
279 struct coordinator mdt_coordinator;
281 /* inter-MDT connection count */
282 atomic_t mdt_mds_mds_conns;
284 /* MDT device async commit count, used for debug and sanity test */
285 atomic_t mdt_async_commit_count;
287 struct mdt_object *mdt_md_root;
290 #define MDT_SERVICE_WATCHDOG_FACTOR (2)
291 #define MDT_COS_DEFAULT (0)
293 #define ENOENT_VERSION 1 /** 'virtual' version of non-existent object */
296 struct lu_object_header mot_header;
297 struct lu_object mot_obj;
298 unsigned int mot_lov_created:1, /* lov object created */
299 mot_cache_attr:1; /* enable remote object
302 spinlock_t mot_write_lock;
303 /* Lock to protect object's SOM update. */
304 struct mutex mot_som_mutex;
305 /* Lock to protect create_data */
306 struct mutex mot_lov_mutex;
307 /* lock to protect read/write stages for Data-on-MDT files */
308 struct rw_semaphore mot_dom_sem;
309 /* Lock to protect lease open.
310 * Lease open acquires write lock; normal open acquires read lock */
311 struct rw_semaphore mot_open_sem;
312 atomic_t mot_lease_count;
313 atomic_t mot_open_count;
316 struct mdt_lock_handle {
317 /* Lock type, reg for cross-ref use or pdo lock. */
321 struct lustre_handle mlh_reg_lh;
322 enum ldlm_mode mlh_reg_mode;
325 struct lustre_handle mlh_pdo_lh;
326 enum ldlm_mode mlh_pdo_mode;
327 unsigned int mlh_pdo_hash;
329 /* Remote regular lock */
330 struct lustre_handle mlh_rreg_lh;
331 enum ldlm_mode mlh_rreg_mode;
335 MDT_LH_PARENT, /* parent lockh */
336 MDT_LH_CHILD, /* child lockh */
337 MDT_LH_OLD, /* old lockh for rename */
338 MDT_LH_LAYOUT = MDT_LH_OLD, /* layout lock */
339 MDT_LH_NEW, /* new lockh for rename */
340 MDT_LH_RMT, /* used for return lh to caller */
341 MDT_LH_LOCAL, /* local lock never return to client */
350 /* Special magical errno for communicaiton between mdt_reint_open()
351 * and mdt_intent_reint() which means return the lock to the client
352 * for subsequent cross ref open. Previously we used plain -EREMOTE
353 * but other functions called in that path might return it too and
354 * confuse us. This is not returned to the client. See LU-5370. */
355 #define MDT_EREMOTE_OPEN (EREMOTE + 1024)
357 struct mdt_reint_record {
358 enum mds_reint_op rr_opcode;
359 const struct lustre_handle *rr_open_handle;
360 const struct lustre_handle *rr_lease_handle;
361 const struct lu_fid *rr_fid1;
362 const struct lu_fid *rr_fid2;
363 struct lu_name rr_name;
364 struct lu_name rr_tgt_name;
371 enum mdt_reint_flag {
372 MRF_OPEN_TRUNC = 1 << 0,
376 * Common data shared by mdt-level handlers. This is allocated per-thread to
377 * reduce stack consumption.
379 struct mdt_thread_info {
382 * The following members will be filled explicitly
383 * with specific data in mdt_thread_info_init().
385 /* TODO: move this into mdt_session_key(with LCT_SESSION), because
386 * request handling may migrate from one server thread to another.
388 struct req_capsule *mti_pill;
390 /* although we have export in req, there are cases when it is not
391 * available, e.g. closing files upon export destroy */
392 struct obd_export *mti_exp;
394 * A couple of lock handles.
396 struct mdt_lock_handle mti_lh[MDT_LH_NR];
398 struct mdt_device *mti_mdt;
399 const struct lu_env *mti_env;
401 /* transaction number of current request */
407 * The following members will be filled expilictly
408 * with zero in mdt_thread_info_init(). These members may be used
415 struct md_attr mti_attr;
416 struct md_attr mti_attr2; /* mdt_lvb.c */
418 * Body for "habeo corpus" operations.
420 const struct mdt_body *mti_body;
422 * Host object. This is released at the end of mdt_handler().
424 struct mdt_object *mti_object;
426 * Lock request for "habeo clavis" operations.
428 const struct ldlm_request *mti_dlm_req;
430 __u32 mti_has_trans:1, /* has txn already? */
432 /* big_lmm buffer was used and must be used in reply */
437 /* opdata for mdt_reint_open(), has the same as
438 * ldlm_reply:lock_policy_res1. mdt_update_last_rcvd() stores this
439 * value onto disk for recovery when mdt_trans_stop_cb() is called.
445 * The following members will be filled explicitly
446 * with zero in mdt_reint_unpack(), because they are only used
447 * by reint requests (including mdt_reint_open()).
451 * reint record. contains information for reint operations.
453 struct mdt_reint_record mti_rr;
455 __u64 mti_ver[PTLRPC_NUM_VERSIONS];
457 * Operation specification (currently create and lookup)
459 struct md_op_spec mti_spec;
463 * The following members will _NOT_ be initialized at all.
464 * DO NOT expect them to contain any valid value.
465 * They should be initialized explicitly by the user themselves.
468 /* XXX: If something is in a union, make sure they do not conflict */
469 struct lu_fid mti_tmp_fid1;
470 struct lu_fid mti_tmp_fid2;
471 union ldlm_policy_data mti_policy; /* for mdt_object_lock() */
472 struct ldlm_res_id mti_res_id; /* and mdt_rename_lock() */
474 struct obd_uuid uuid[2]; /* for mdt_seq_init_cli() */
475 char ns_name[48];/* for mdt_init0() */
476 struct lustre_cfg_bufs bufs; /* for mdt_stack_fini() */
477 struct obd_statfs osfs; /* for mdt_statfs() */
479 /* for mdt_readpage() */
480 struct lu_rdpg mti_rdpg;
481 /* for mdt_sendpage() */
482 struct l_wait_info mti_wait_info;
492 struct lustre_handle mti_open_handle;
494 struct lu_buf mti_buf;
495 struct lu_buf mti_big_buf;
497 /* Ops object filename */
498 struct lu_name mti_name;
499 char mti_filename[NAME_MAX + 1];
500 /* per-thread values, can be re-used, may be vmalloc'd */
505 /* should be enough to fit lustre_mdt_attrs */
506 char mti_xattr_buf[128];
507 struct ldlm_enqueue_info mti_einfo[2];
508 /* einfo used by mdt_remote_object_lock_try() */
509 struct ldlm_enqueue_info mti_remote_einfo;
510 struct tg_reply_data *mti_reply_data;
512 /* FLR: layout change API */
513 struct md_layout_change mti_layout;
516 extern struct lu_context_key mdt_thread_key;
518 static inline struct mdt_thread_info *mdt_th_info(const struct lu_env *env)
520 struct mdt_thread_info *mti;
522 lu_env_refill((void *)env);
523 mti = lu_context_key_get(&env->le_ctx, &mdt_thread_key);
528 struct cdt_req_progress {
529 struct mutex crp_lock; /**< protect tree */
530 struct interval_node *crp_root; /**< tree to track extent
532 struct interval_node **crp_node; /**< buffer for tree nodes
533 * vector of fixed size
535 int crp_cnt; /**< # of used nodes */
536 int crp_max; /**< # of allocated nodes */
539 struct cdt_agent_req {
540 struct hlist_node car_cookie_hash; /**< find req by cookie */
541 struct list_head car_request_list; /**< to chain all the req. */
542 atomic_t car_refcount; /**< reference counter */
543 __u64 car_flags; /**< request original flags */
544 struct obd_uuid car_uuid; /**< agent doing the req. */
545 __u32 car_archive_id; /**< archive id */
546 int car_canceled; /**< request was canceled */
547 time64_t car_req_start; /**< start time */
548 time64_t car_req_update; /**< last update time */
549 struct hsm_action_item *car_hai; /**< req. to the agent */
550 struct cdt_req_progress car_progress; /**< track data mvt
553 extern struct kmem_cache *mdt_hsm_car_kmem;
556 struct list_head ha_list; /**< to chain the agents */
557 struct obd_uuid ha_uuid; /**< agent uuid */
558 __u32 *ha_archive_id; /**< archive id */
559 int ha_archive_cnt; /**< number of archive entries
560 * 0 means any archive */
561 atomic_t ha_requests; /**< current request count */
562 atomic_t ha_success; /**< number of successful
564 atomic_t ha_failure; /**< number of failed actions */
567 struct cdt_restore_handle {
568 struct list_head crh_list; /**< to chain the handle */
569 struct lu_fid crh_fid; /**< fid of the object */
570 struct ldlm_extent crh_extent; /**< extent of the restore */
571 struct mdt_lock_handle crh_lh; /**< lock handle */
573 extern struct kmem_cache *mdt_hsm_cdt_kmem; /** restore handle slab cache */
575 struct hsm_record_update {
577 enum agent_req_status status;
580 static inline const struct md_device_operations *
581 mdt_child_ops(struct mdt_device * m)
583 LASSERT(m->mdt_child);
584 return m->mdt_child->md_ops;
587 static inline struct md_object *mdt_object_child(struct mdt_object *o)
590 return lu2md(lu_object_next(&o->mot_obj));
593 static inline struct ptlrpc_request *mdt_info_req(struct mdt_thread_info *info)
595 return info->mti_pill ? info->mti_pill->rc_req : NULL;
598 static inline __u64 mdt_conn_flags(struct mdt_thread_info *info)
600 LASSERT(info->mti_exp);
601 return exp_connect_flags(info->mti_exp);
604 static inline void mdt_object_get(const struct lu_env *env,
605 struct mdt_object *o)
608 lu_object_get(&o->mot_obj);
612 static inline void mdt_object_put(const struct lu_env *env,
613 struct mdt_object *o)
616 lu_object_put(env, &o->mot_obj);
620 static inline int mdt_object_exists(const struct mdt_object *o)
622 return lu_object_exists(&o->mot_obj);
625 static inline int mdt_object_remote(const struct mdt_object *o)
627 return lu_object_remote(&o->mot_obj);
630 static inline const struct lu_fid *mdt_object_fid(const struct mdt_object *o)
632 return lu_object_fid(&o->mot_obj);
635 static inline struct lu_site *mdt_lu_site(const struct mdt_device *mdt)
637 return mdt->mdt_lu_dev.ld_site;
640 static inline struct seq_server_site *mdt_seq_site(struct mdt_device *mdt)
642 return &mdt->mdt_seq_site;
645 static inline void mdt_export_evict(struct obd_export *exp)
647 class_fail_export(exp);
650 /* Here we use LVB_TYPE to check dne client, because it is
651 * also landed on 2.4. */
652 static inline bool mdt_is_dne_client(struct obd_export *exp)
654 return !!(exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE);
657 static inline bool mdt_is_striped_client(struct obd_export *exp)
659 return exp_connect_flags(exp) & OBD_CONNECT_DIR_STRIPE;
668 /* XXX Look into layout in MDT layer. This must be done in LOD. */
669 static inline int mdt_lmm_dom_entry(struct lov_mds_md *lmm)
671 struct lov_comp_md_v1 *comp_v1;
672 struct lov_mds_md *v1;
676 if (le32_to_cpu(lmm->lmm_magic) != LOV_MAGIC_COMP_V1)
679 comp_v1 = (struct lov_comp_md_v1 *)lmm;
680 off = le32_to_cpu(comp_v1->lcm_entries[0].lcme_offset);
681 v1 = (struct lov_mds_md *)((char *)comp_v1 + off);
683 /* DoM entry is the first entry always */
684 if (lov_pattern(le32_to_cpu(v1->lmm_pattern)) != LOV_PATTERN_MDT)
687 for (i = 1; i < le16_to_cpu(comp_v1->lcm_entry_count); i++) {
690 off = le32_to_cpu(comp_v1->lcm_entries[i].lcme_offset);
691 v1 = (struct lov_mds_md *)((char *)comp_v1 + off);
693 for (j = 0; j < le16_to_cpu(v1->lmm_stripe_count); j++) {
694 /* if there is any object on OST */
695 if (le32_to_cpu(v1->lmm_objects[j].l_ost_idx) !=
703 static inline bool mdt_lmm_is_flr(struct lov_mds_md *lmm)
705 struct lov_comp_md_v1 *lcm = (typeof(lcm))lmm;
707 return le32_to_cpu(lmm->lmm_magic) == LOV_MAGIC_COMP_V1 &&
708 le16_to_cpu(lcm->lcm_mirror_count) > 0;
711 static inline bool mdt_is_sum_statfs_client(struct obd_export *exp)
713 return exp_connect_flags(exp) & OBD_CONNECT_FLAGS2 &&
714 exp_connect_flags2(exp) & OBD_CONNECT2_SUM_STATFS;
717 __u64 mdt_get_disposition(struct ldlm_reply *rep, __u64 op_flag);
718 void mdt_set_disposition(struct mdt_thread_info *info,
719 struct ldlm_reply *rep, __u64 op_flag);
720 void mdt_clear_disposition(struct mdt_thread_info *info,
721 struct ldlm_reply *rep, __u64 op_flag);
723 void mdt_lock_pdo_init(struct mdt_lock_handle *lh, enum ldlm_mode lock_mode,
724 const struct lu_name *lname);
726 void mdt_lock_reg_init(struct mdt_lock_handle *lh, enum ldlm_mode lm);
728 int mdt_lock_setup(struct mdt_thread_info *info, struct mdt_object *mo,
729 struct mdt_lock_handle *lh);
731 int mdt_check_resent_lock(struct mdt_thread_info *info, struct mdt_object *mo,
732 struct mdt_lock_handle *lhc);
734 int mdt_object_lock(struct mdt_thread_info *info, struct mdt_object *mo,
735 struct mdt_lock_handle *lh, __u64 ibits);
737 int mdt_reint_object_lock(struct mdt_thread_info *info, struct mdt_object *o,
738 struct mdt_lock_handle *lh, __u64 ibits,
741 int mdt_object_lock_try(struct mdt_thread_info *info, struct mdt_object *mo,
742 struct mdt_lock_handle *lh, __u64 *ibits,
743 __u64 trybits, bool cos_incompat);
745 void mdt_object_unlock(struct mdt_thread_info *info, struct mdt_object *mo,
746 struct mdt_lock_handle *lh, int decref);
747 void mdt_save_lock(struct mdt_thread_info *info, struct lustre_handle *h,
748 enum ldlm_mode mode, int decref);
750 struct mdt_object *mdt_object_new(const struct lu_env *env,
752 const struct lu_fid *);
753 struct mdt_object *mdt_object_find(const struct lu_env *,
755 const struct lu_fid *);
756 struct mdt_object *mdt_object_find_lock(struct mdt_thread_info *,
757 const struct lu_fid *,
758 struct mdt_lock_handle *,
760 void mdt_object_unlock_put(struct mdt_thread_info *,
762 struct mdt_lock_handle *,
765 void mdt_client_compatibility(struct mdt_thread_info *info);
767 int mdt_remote_object_lock(struct mdt_thread_info *mti,
768 struct mdt_object *o, const struct lu_fid *fid,
769 struct lustre_handle *lh,
770 enum ldlm_mode mode, __u64 ibits, bool cache);
771 int mdt_reint_striped_lock(struct mdt_thread_info *info,
772 struct mdt_object *o,
773 struct mdt_lock_handle *lh,
775 struct ldlm_enqueue_info *einfo,
777 void mdt_reint_striped_unlock(struct mdt_thread_info *info,
778 struct mdt_object *o,
779 struct mdt_lock_handle *lh,
780 struct ldlm_enqueue_info *einfo, int decref);
782 enum mdt_name_flags {
786 int mdt_name_unpack(struct req_capsule *pill,
787 const struct req_msg_field *field,
789 enum mdt_name_flags flags);
790 int mdt_close_unpack(struct mdt_thread_info *info);
791 int mdt_reint_unpack(struct mdt_thread_info *info, __u32 op);
792 void mdt_fix_lov_magic(struct mdt_thread_info *info, void *eadata);
793 int mdt_reint_rec(struct mdt_thread_info *, struct mdt_lock_handle *);
794 #ifdef CONFIG_FS_POSIX_ACL
795 int mdt_pack_acl2body(struct mdt_thread_info *info, struct mdt_body *repbody,
796 struct mdt_object *o, struct lu_nodemap *nodemap);
798 void mdt_pack_attr2body(struct mdt_thread_info *info, struct mdt_body *b,
799 const struct lu_attr *attr, const struct lu_fid *fid);
800 int mdt_pack_size2body(struct mdt_thread_info *info,
801 const struct lu_fid *fid, struct lustre_handle *lh);
802 int mdt_getxattr(struct mdt_thread_info *info);
803 int mdt_reint_setxattr(struct mdt_thread_info *info,
804 struct mdt_lock_handle *lh);
806 void mdt_lock_handle_init(struct mdt_lock_handle *lh);
807 void mdt_lock_handle_fini(struct mdt_lock_handle *lh);
809 void mdt_reconstruct(struct mdt_thread_info *, struct mdt_lock_handle *);
810 void mdt_reconstruct_generic(struct mdt_thread_info *mti,
811 struct mdt_lock_handle *lhc);
813 extern void target_recovery_fini(struct obd_device *obd);
814 extern void target_recovery_init(struct lu_target *lut,
815 svc_handler_t handler);
816 int mdt_fs_setup(const struct lu_env *, struct mdt_device *,
817 struct obd_device *, struct lustre_sb_info *lsi);
818 void mdt_fs_cleanup(const struct lu_env *, struct mdt_device *);
820 int mdt_export_stats_init(struct obd_device *obd,
821 struct obd_export *exp,
824 int mdt_lock_new_child(struct mdt_thread_info *info,
825 struct mdt_object *o,
826 struct mdt_lock_handle *child_lockh);
827 void mdt_mfd_set_mode(struct mdt_file_data *mfd, u64 open_flags);
828 int mdt_reint_open(struct mdt_thread_info *info, struct mdt_lock_handle *lhc);
829 struct mdt_file_data *mdt_open_handle2mfd(struct mdt_export_data *med,
830 const struct lustre_handle *open_handle,
832 int mdt_revoke_remote_lookup_lock(struct mdt_thread_info *info,
833 struct mdt_object *pobj,
834 struct mdt_object *obj);
836 int mdt_get_info(struct tgt_session_info *tsi);
837 int mdt_attr_get_complex(struct mdt_thread_info *info,
838 struct mdt_object *o, struct md_attr *ma);
839 int mdt_big_xattr_get(struct mdt_thread_info *info, struct mdt_object *o,
841 int mdt_stripe_get(struct mdt_thread_info *info, struct mdt_object *o,
842 struct md_attr *ma, const char *name);
843 int mdt_attr_get_pfid(struct mdt_thread_info *info, struct mdt_object *o,
844 struct lu_fid *pfid);
845 int mdt_write_get(struct mdt_object *o);
846 void mdt_write_put(struct mdt_object *o);
847 int mdt_write_read(struct mdt_object *o);
848 struct mdt_file_data *mdt_mfd_new(const struct mdt_export_data *med);
849 int mdt_mfd_close(struct mdt_thread_info *info, struct mdt_file_data *mfd);
850 void mdt_mfd_free(struct mdt_file_data *mfd);
851 int mdt_close(struct tgt_session_info *tsi);
852 int mdt_add_dirty_flag(struct mdt_thread_info *info, struct mdt_object *mo,
854 int mdt_fix_reply(struct mdt_thread_info *info);
855 int mdt_handle_last_unlink(struct mdt_thread_info *, struct mdt_object *,
857 void mdt_reconstruct_open(struct mdt_thread_info *, struct mdt_lock_handle *);
858 int mdt_layout_change(struct mdt_thread_info *info, struct mdt_object *obj,
859 struct md_layout_change *spec);
860 int mdt_device_sync(const struct lu_env *env, struct mdt_device *mdt);
862 struct lu_buf *mdt_buf(const struct lu_env *env, void *area, ssize_t len);
863 const struct lu_buf *mdt_buf_const(const struct lu_env *env,
864 const void *area, ssize_t len);
866 void mdt_dump_lmm(int level, const struct lov_mds_md *lmm, __u64 valid);
867 void mdt_dump_lmv(unsigned int level, const union lmv_mds_md *lmv);
869 bool allow_client_chgrp(struct mdt_thread_info *info, struct lu_ucred *uc);
870 int mdt_check_ucred(struct mdt_thread_info *);
871 int mdt_init_ucred(struct mdt_thread_info *, struct mdt_body *);
872 int mdt_init_ucred_intent_getattr(struct mdt_thread_info *, struct mdt_body *);
873 int mdt_init_ucred_reint(struct mdt_thread_info *);
874 void mdt_exit_ucred(struct mdt_thread_info *);
875 int mdt_version_get_check(struct mdt_thread_info *, struct mdt_object *, int);
876 void mdt_version_get_save(struct mdt_thread_info *, struct mdt_object *, int);
877 int mdt_version_get_check_save(struct mdt_thread_info *, struct mdt_object *,
879 void mdt_thread_info_init(struct ptlrpc_request *req,
880 struct mdt_thread_info *mti);
881 void mdt_thread_info_fini(struct mdt_thread_info *mti);
882 struct mdt_thread_info *tsi2mdt_info(struct tgt_session_info *tsi);
883 void mdt_intent_fixup_resent(struct mdt_thread_info *info,
884 struct ldlm_lock *new_lock,
885 struct mdt_lock_handle *lh, __u64 flags);
886 int mdt_intent_lock_replace(struct mdt_thread_info *info,
887 struct ldlm_lock **lockp,
888 struct mdt_lock_handle *lh,
889 __u64 flags, int result);
891 int mdt_hsm_attr_set(struct mdt_thread_info *info, struct mdt_object *obj,
892 const struct md_hsm *mh);
894 int mdt_remote_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
895 void *data, int flag);
896 int mdt_links_read(struct mdt_thread_info *info,
897 struct mdt_object *mdt_obj,
898 struct linkea_data *ldata);
899 int mdt_close_internal(struct mdt_thread_info *info, struct ptlrpc_request *req,
900 struct mdt_body *repbody);
901 void mdt_pack_secctx_in_reply(struct mdt_thread_info *info,
902 struct mdt_object *child);
904 static inline struct mdt_device *mdt_dev(struct lu_device *d)
906 return container_of0(d, struct mdt_device, mdt_lu_dev);
909 static inline struct mdt_object *mdt_obj(struct lu_object *o)
911 return container_of0(o, struct mdt_object, mot_obj);
914 static inline struct dt_object *mdt_obj2dt(struct mdt_object *mo)
916 struct lu_object *lo;
917 struct mdt_device *mdt = mdt_dev(mo->mot_obj.lo_dev);
919 lo = lu_object_locate(mo->mot_obj.lo_header,
920 mdt->mdt_bottom->dd_lu_dev.ld_type);
925 static inline bool agent_req_in_final_state(enum agent_req_status ars)
927 return ((ars == ARS_SUCCEED) || (ars == ARS_FAILED) ||
928 (ars == ARS_CANCELED));
931 /* mdt/mdt_identity.c */
932 #define MDT_IDENTITY_UPCALL_PATH "/usr/sbin/l_getidentity"
934 extern struct upcall_cache_ops mdt_identity_upcall_cache_ops;
936 struct md_identity *mdt_identity_get(struct upcall_cache *, __u32);
938 void mdt_identity_put(struct upcall_cache *, struct md_identity *);
940 void mdt_flush_identity(struct upcall_cache *, int);
942 __u32 mdt_identity_get_perm(struct md_identity *, lnet_nid_t);
944 /* mdt/mdt_recovery.c */
945 __u64 mdt_req_from_lrd(struct ptlrpc_request *req, struct tg_reply_data *trd);
948 int mdt_hsm_state_get(struct tgt_session_info *tsi);
949 int mdt_hsm_state_set(struct tgt_session_info *tsi);
950 int mdt_hsm_action(struct tgt_session_info *tsi);
951 int mdt_hsm_progress(struct tgt_session_info *tsi);
952 int mdt_hsm_ct_register(struct tgt_session_info *tsi);
953 int mdt_hsm_ct_unregister(struct tgt_session_info *tsi);
954 int mdt_hsm_request(struct tgt_session_info *tsi);
956 /* mdt/mdt_hsm_cdt_actions.c */
957 extern const struct file_operations mdt_hsm_actions_fops;
958 void dump_llog_agent_req_rec(const char *prefix,
959 const struct llog_agent_req_rec *larr);
960 int cdt_llog_process(const struct lu_env *env, struct mdt_device *mdt,
961 llog_cb_t cb, void *data, u32 start_cat_idx,
962 u32 start_rec_idx, int rw);
963 int mdt_agent_record_add(const struct lu_env *env, struct mdt_device *mdt,
964 __u32 archive_id, __u64 flags,
965 struct hsm_action_item *hai);
966 int mdt_agent_record_update(const struct lu_env *env, struct mdt_device *mdt,
967 struct hsm_record_update *updates,
968 unsigned int updates_count);
969 void cdt_agent_record_hash_add(struct coordinator *cdt, u64 cookie, u32 cat_idt,
971 void cdt_agent_record_hash_lookup(struct coordinator *cdt, u64 cookie,
972 u32 *cat_idt, u32 *rec_idx);
973 void cdt_agent_record_hash_del(struct coordinator *cdt, u64 cookie);
975 /* mdt/mdt_hsm_cdt_agent.c */
976 extern const struct file_operations mdt_hsm_agent_fops;
977 int mdt_hsm_agent_register(struct mdt_thread_info *info,
978 const struct obd_uuid *uuid,
979 int nr_archives, __u32 *archive_num);
980 int mdt_hsm_agent_register_mask(struct mdt_thread_info *info,
981 const struct obd_uuid *uuid,
983 int mdt_hsm_agent_unregister(struct mdt_thread_info *info,
984 const struct obd_uuid *uuid);
985 int mdt_hsm_agent_update_statistics(struct coordinator *cdt,
986 int succ_rq, int fail_rq, int new_rq,
987 const struct obd_uuid *uuid);
988 int mdt_hsm_find_best_agent(struct coordinator *cdt, __u32 archive,
989 struct obd_uuid *uuid);
990 int mdt_hsm_agent_send(struct mdt_thread_info *mti, struct hsm_action_list *hal,
992 /* mdt/mdt_hsm_cdt_client.c */
993 int mdt_hsm_add_actions(struct mdt_thread_info *info,
994 struct hsm_action_list *hal);
995 int mdt_hsm_get_action(struct mdt_thread_info *mti,
996 const struct lu_fid *fid,
997 enum hsm_copytool_action *action,
998 enum agent_req_status *status,
999 struct hsm_extent *extent);
1000 bool mdt_hsm_restore_is_running(struct mdt_thread_info *mti,
1001 const struct lu_fid *fid);
1002 /* mdt/mdt_hsm_cdt_requests.c */
1003 extern struct cfs_hash_ops cdt_request_cookie_hash_ops;
1004 extern struct cfs_hash_ops cdt_agent_record_hash_ops;
1005 extern const struct file_operations mdt_hsm_active_requests_fops;
1006 void dump_requests(char *prefix, struct coordinator *cdt);
1007 struct cdt_agent_req *mdt_cdt_alloc_request(__u32 archive_id, __u64 flags,
1008 struct obd_uuid *uuid,
1009 struct hsm_action_item *hai);
1010 void mdt_cdt_free_request(struct cdt_agent_req *car);
1011 int mdt_cdt_add_request(struct coordinator *cdt, struct cdt_agent_req *new_car);
1012 struct cdt_agent_req *mdt_cdt_find_request(struct coordinator *cdt, u64 cookie);
1013 void mdt_cdt_get_work_done(struct cdt_agent_req *car, __u64 *done_sz);
1014 void mdt_cdt_get_request(struct cdt_agent_req *car);
1015 void mdt_cdt_put_request(struct cdt_agent_req *car);
1016 struct cdt_agent_req *mdt_cdt_update_request(struct coordinator *cdt,
1017 const struct hsm_progress_kernel *pgs);
1018 int mdt_cdt_remove_request(struct coordinator *cdt, __u64 cookie);
1019 /* mdt/mdt_coordinator.c */
1020 void mdt_hsm_dump_hal(int level, const char *prefix,
1021 struct hsm_action_list *hal);
1022 int cdt_restore_handle_add(struct mdt_thread_info *mti, struct coordinator *cdt,
1023 const struct lu_fid *fid,
1024 const struct hsm_extent *he);
1025 struct cdt_restore_handle *cdt_restore_handle_find(struct coordinator *cdt,
1026 const struct lu_fid *fid);
1027 void cdt_restore_handle_del(struct mdt_thread_info *mti,
1028 struct coordinator *cdt, const struct lu_fid *fid);
1029 /* coordinator management */
1030 int mdt_hsm_cdt_init(struct mdt_device *mdt);
1031 int mdt_hsm_cdt_stop(struct mdt_device *mdt);
1032 int mdt_hsm_cdt_fini(struct mdt_device *mdt);
1035 * Signal the coordinator has work to do
1036 * \param cdt [IN] coordinator
1038 static inline void mdt_hsm_cdt_event(struct coordinator *cdt)
1040 cdt->cdt_event = true;
1043 /* coordinator control /proc interface */
1044 ssize_t mdt_hsm_cdt_control_seq_write(struct file *file,
1045 const char __user *buffer,
1046 size_t count, loff_t *off);
1047 int mdt_hsm_cdt_control_seq_show(struct seq_file *m, void *data);
1048 int hsm_cdt_procfs_init(struct mdt_device *mdt);
1049 void hsm_cdt_procfs_fini(struct mdt_device *mdt);
1050 struct lprocfs_vars *hsm_cdt_get_proc_vars(void);
1051 /* md_hsm helpers */
1052 struct mdt_object *mdt_hsm_get_md_hsm(struct mdt_thread_info *mti,
1053 const struct lu_fid *fid,
1054 struct md_hsm *hsm);
1055 /* actions/request helpers */
1056 int mdt_hsm_add_hal(struct mdt_thread_info *mti,
1057 struct hsm_action_list *hal, struct obd_uuid *uuid);
1058 bool mdt_hsm_is_action_compat(const struct hsm_action_item *hai,
1059 u32 archive_id, u64 rq_flags,
1060 const struct md_hsm *hsm);
1061 int mdt_hsm_update_request_state(struct mdt_thread_info *mti,
1062 struct hsm_progress_kernel *pgs);
1064 int mdt_close_swap_layouts(struct mdt_thread_info *info,
1065 struct mdt_object *o, struct md_attr *ma);
1067 extern struct lu_context_key mdt_thread_key;
1069 /* debug issues helper starts here*/
1070 static inline int mdt_fail_write(const struct lu_env *env,
1071 struct dt_device *dd, int id)
1073 if (OBD_FAIL_CHECK_ORSET(id, OBD_FAIL_ONCE)) {
1074 CERROR(LUSTRE_MDT_NAME": cfs_fail_loc=%x, fail write ops\n",
1076 return dt_ro(env, dd);
1077 /* We set FAIL_ONCE because we never "un-fail" a device */
1083 static inline struct mdt_export_data *mdt_req2med(struct ptlrpc_request *req)
1085 return &req->rq_export->exp_mdt_data;
1088 static inline struct mdt_device *mdt_exp2dev(struct obd_export *exp)
1090 return mdt_dev(exp->exp_obd->obd_lu_dev);
1093 static inline bool mdt_rdonly(struct obd_export *exp)
1095 return (exp_connect_flags(exp) & OBD_CONNECT_RDONLY ||
1096 mdt_exp2dev(exp)->mdt_bottom->dd_rdonly ||
1097 mdt_exp2dev(exp)->mdt_readonly);
1100 typedef void (*mdt_reconstruct_t)(struct mdt_thread_info *mti,
1101 struct mdt_lock_handle *lhc);
1102 static inline int mdt_check_resent(struct mdt_thread_info *info,
1103 mdt_reconstruct_t reconstruct,
1104 struct mdt_lock_handle *lhc)
1106 struct ptlrpc_request *req = mdt_info_req(info);
1110 if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) {
1111 OBD_ALLOC_PTR(info->mti_reply_data);
1112 if (info->mti_reply_data == NULL)
1115 if (req_can_reconstruct(req, info->mti_reply_data)) {
1116 reconstruct(info, lhc);
1119 DEBUG_REQ(D_HA, req,
1120 "no reply data found for RESENT req");
1123 OBD_FREE_PTR(info->mti_reply_data);
1124 info->mti_reply_data = NULL;
1129 struct lu_ucred *mdt_ucred(const struct mdt_thread_info *info);
1130 struct lu_ucred *mdt_ucred_check(const struct mdt_thread_info *info);
1132 static inline int is_identity_get_disabled(struct upcall_cache *cache)
1134 return cache ? (strcmp(cache->uc_upcall, "NONE") == 0) : 1;
1137 int mdt_blocking_ast(struct ldlm_lock*, struct ldlm_lock_desc*, void*, int);
1139 static int mdt_dom_glimpse_ast(struct ldlm_lock *lock, void *reqp)
1141 return -ELDLM_NO_LOCK_DATA;
1144 /* Issues dlm lock on passed @ns, @f stores it lock handle into @lh. */
1145 static inline int mdt_fid_lock(const struct lu_env *env,
1146 struct ldlm_namespace *ns,
1147 struct lustre_handle *lh, enum ldlm_mode mode,
1148 union ldlm_policy_data *policy,
1149 const struct ldlm_res_id *res_id,
1150 __u64 flags, const __u64 *client_cookie)
1153 bool glimpse = policy->l_inodebits.bits & MDS_INODELOCK_DOM;
1155 LASSERT(ns != NULL);
1156 LASSERT(lh != NULL);
1158 rc = ldlm_cli_enqueue_local(env, ns, res_id, LDLM_IBITS, policy,
1159 mode, &flags, mdt_blocking_ast,
1160 ldlm_completion_ast,
1161 glimpse ? mdt_dom_glimpse_ast : NULL,
1162 NULL, 0, LVB_T_NONE, client_cookie, lh);
1163 return rc == ELDLM_OK ? 0 : -EIO;
1166 static inline void mdt_fid_unlock(struct lustre_handle *lh, enum ldlm_mode mode)
1168 ldlm_lock_decref(lh, mode);
1171 static inline bool mdt_slc_is_enabled(struct mdt_device *mdt)
1173 return mdt->mdt_lut.lut_sync_lock_cancel == BLOCKING_SYNC_ON_CANCEL;
1176 extern mdl_mode_t mdt_mdl_lock_modes[];
1177 extern enum ldlm_mode mdt_dlm_lock_modes[];
1179 /* LCK_MINMODE which is zero returns false for is_power_of_2 */
1181 static inline mdl_mode_t mdt_dlm_mode2mdl_mode(enum ldlm_mode mode)
1183 LASSERT(mode == LCK_MINMODE || is_power_of_2(mode));
1184 return mdt_mdl_lock_modes[mode];
1187 static inline enum ldlm_mode mdt_mdl_mode2dlm_mode(mdl_mode_t mode)
1189 LASSERT(mode == MDL_MINMODE || is_power_of_2(mode));
1190 return mdt_dlm_lock_modes[mode];
1194 int mdt_set_som(struct mdt_thread_info *info, struct mdt_object *obj,
1195 enum lustre_som_flags flag, __u64 size, __u64 blocks);
1196 int mdt_get_som(struct mdt_thread_info *info, struct mdt_object *obj,
1197 struct md_attr *ma);
1198 int mdt_lsom_downgrade(struct mdt_thread_info *info, struct mdt_object *obj);
1199 int mdt_lsom_update(struct mdt_thread_info *info, struct mdt_object *obj,
1203 extern struct ldlm_valblock_ops mdt_lvbo;
1204 int mdt_dom_lvb_is_valid(struct ldlm_resource *res);
1205 int mdt_dom_lvbo_update(const struct lu_env *env, struct ldlm_resource *res,
1206 struct ldlm_lock *lock, struct ptlrpc_request *req,
1207 bool increase_only);
1209 void mdt_enable_cos(struct mdt_device *dev, bool enable);
1210 int mdt_cos_is_enabled(struct mdt_device *);
1228 LPROC_MDT_SAMEDIR_RENAME,
1229 LPROC_MDT_CROSSDIR_RENAME,
1236 void mdt_counter_incr(struct ptlrpc_request *req, int opcode);
1237 void mdt_stats_counter_init(struct lprocfs_stats *stats);
1238 int mdt_procfs_init(struct mdt_device *mdt, const char *name);
1239 void mdt_procfs_fini(struct mdt_device *mdt);
1241 /* lustre/mdt_mdt_lproc.c */
1242 int lprocfs_mdt_open_files_seq_open(struct inode *inode,
1244 void mdt_rename_counter_tally(struct mdt_thread_info *info,
1245 struct mdt_device *mdt,
1246 struct ptlrpc_request *req,
1247 struct mdt_object *src, struct mdt_object *tgt);
1249 static inline struct obd_device *mdt2obd_dev(const struct mdt_device *mdt)
1251 return mdt->mdt_lu_dev.ld_obd;
1254 extern const struct lu_device_operations mdt_lu_ops;
1256 static inline char *mdt_obd_name(struct mdt_device *mdt)
1258 return mdt->mdt_lu_dev.ld_obd->obd_name;
1261 int mds_mod_init(void);
1262 void mds_mod_exit(void);
1264 static inline char *mdt_req_get_jobid(struct ptlrpc_request *req)
1266 struct obd_export *exp = req->rq_export;
1269 if (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS)
1270 jobid = lustre_msg_get_jobid(req->rq_reqmsg);
1277 #define VALID_FLAGS (LA_TYPE | LA_MODE | LA_SIZE | LA_BLOCKS | \
1278 LA_BLKSIZE | LA_ATIME | LA_MTIME | LA_CTIME)
1280 int mdt_obd_preprw(const struct lu_env *env, int cmd, struct obd_export *exp,
1281 struct obdo *oa, int objcount, struct obd_ioobj *obj,
1282 struct niobuf_remote *rnb, int *nr_local,
1283 struct niobuf_local *lnb);
1285 int mdt_obd_commitrw(const struct lu_env *env, int cmd, struct obd_export *exp,
1286 struct obdo *oa, int objcount, struct obd_ioobj *obj,
1287 struct niobuf_remote *rnb, int npages,
1288 struct niobuf_local *lnb, int old_rc);
1289 int mdt_punch_hdl(struct tgt_session_info *tsi);
1290 int mdt_glimpse_enqueue(struct mdt_thread_info *mti, struct ldlm_namespace *ns,
1291 struct ldlm_lock **lockp, __u64 flags);
1292 int mdt_brw_enqueue(struct mdt_thread_info *info, struct ldlm_namespace *ns,
1293 struct ldlm_lock **lockp, __u64 flags);
1294 int mdt_dom_read_on_open(struct mdt_thread_info *mti, struct mdt_device *mdt,
1295 struct lustre_handle *lh);
1296 void mdt_dom_discard_data(struct mdt_thread_info *info,
1297 const struct lu_fid *fid);
1298 int mdt_dom_disk_lvbo_update(const struct lu_env *env, struct mdt_object *mo,
1299 struct ldlm_resource *res, bool increase_only);
1300 void mdt_dom_obj_lvb_update(const struct lu_env *env, struct mdt_object *mo,
1301 bool increase_only);
1302 int mdt_dom_lvb_alloc(struct ldlm_resource *res);
1304 static inline bool mdt_dom_check_for_discard(struct mdt_thread_info *mti,
1305 struct mdt_object *mo)
1307 return lu_object_is_dying(&mo->mot_header) &&
1308 S_ISREG(lu_object_attr(&mo->mot_obj));
1311 int mdt_dom_object_size(const struct lu_env *env, struct mdt_device *mdt,
1312 const struct lu_fid *fid, struct mdt_body *mb,
1314 bool mdt_dom_client_has_lock(struct mdt_thread_info *info,
1315 const struct lu_fid *fid);
1316 void mdt_hp_brw(struct tgt_session_info *tsi);
1317 void mdt_hp_punch(struct tgt_session_info *tsi);
1318 int mdt_data_version_get(struct tgt_session_info *tsi);
1321 long mdt_grant_connect(const struct lu_env *env, struct obd_export *exp,
1322 u64 want, bool conservative);
1323 extern struct kmem_cache *ldlm_glimpse_work_kmem;
1325 #endif /* _MDT_INTERNAL_H */