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/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_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_old_handle;
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 spinlock_t cdt_state_lock; /**< cdt_state lock */
139 atomic_t cdt_compound_id; /**< compound id
141 __u64 cdt_last_cookie; /**< last cookie
143 struct rw_semaphore cdt_llog_lock; /**< protect llog
145 struct rw_semaphore cdt_agent_lock; /**< protect agent list */
146 struct rw_semaphore cdt_request_lock; /**< protect request
148 struct mutex cdt_restore_lock; /**< protect restore
150 time64_t cdt_loop_period; /**< llog scan period */
151 time64_t cdt_grace_delay; /**< request grace
153 time64_t cdt_active_req_timeout; /**< request timeout */
154 __u32 cdt_default_archive_id; /**< archive id used
157 __u64 cdt_max_requests; /**< max count of started
159 /** Current count of active requests */
160 atomic_t cdt_request_count; /** total */
161 atomic_t cdt_archive_count;
162 atomic_t cdt_restore_count;
163 atomic_t cdt_remove_count;
165 /* started requests (struct cdt_agent_req:car_cookie_hash)
166 * indexed by cookie */
167 struct cfs_hash *cdt_request_cookie_hash;
168 /* started requests (struct cdt_agent_req:car_request_list) */
169 struct list_head cdt_request_list;
170 struct list_head cdt_agents; /**< list of register
172 struct list_head cdt_restore_hdl; /**< list of restore lock
175 /* Hash of cookies to locations of record locations in agent
177 struct cfs_hash *cdt_agent_record_hash;
179 /* Bitmasks indexed by the HSMA_XXX constants. */
180 __u64 cdt_user_request_mask;
181 __u64 cdt_group_request_mask;
182 __u64 cdt_other_request_mask;
184 /* Remove archive on last unlink policy */
185 bool cdt_remove_archive_on_last_unlink;
187 bool cdt_wakeup_coordinator;
190 /* mdt state flag bits */
191 #define MDT_FL_CFGLOG 0
192 #define MDT_FL_SYNCED 1
196 struct lu_device mdt_lu_dev;
197 struct seq_server_site mdt_seq_site;
198 /* DLM name-space for meta-data locks maintained by this server */
199 struct ldlm_namespace *mdt_namespace;
200 /* ptlrpc handle for MDS->client connections (for lock ASTs). */
201 struct ptlrpc_client *mdt_ldlm_client;
202 /* underlying device */
203 struct obd_export *mdt_child_exp;
204 struct md_device *mdt_child;
205 struct dt_device *mdt_bottom;
206 struct obd_export *mdt_bottom_exp;
208 struct lu_target mdt_lut;
210 * Options bit-fields.
213 unsigned int mo_user_xattr:1,
219 /* mdt state flags */
220 unsigned long mdt_state;
222 /* transaction callbacks */
223 struct dt_txn_callback mdt_txn_cb;
225 /* these values should be updated from lov if necessary.
226 * or should be placed somewhere else. */
231 /* preferred BRW size, decided by storage type and capability */
234 struct upcall_cache *mdt_identity_cache;
236 unsigned int mdt_capa_conf:1,
237 /* Enable remote dir on non-MDT0 */
238 mdt_enable_remote_dir:1,
241 gid_t mdt_enable_remote_dir_gid;
243 /* lock for osfs and md_root */
247 struct root_squash_info mdt_squash;
249 struct rename_stats mdt_rename_stats;
250 struct lu_fid mdt_md_root_fid;
252 /* connection to quota master */
253 struct obd_export *mdt_qmt_exp;
254 /* quota master device associated with this MDT */
255 struct lu_device *mdt_qmt_dev;
257 struct coordinator mdt_coordinator;
259 /* inter-MDT connection count */
260 atomic_t mdt_mds_mds_conns;
262 /* MDT device async commit count, used for debug and sanity test */
263 atomic_t mdt_async_commit_count;
265 struct mdt_object *mdt_md_root;
268 #define MDT_SERVICE_WATCHDOG_FACTOR (2)
269 #define MDT_COS_DEFAULT (0)
271 #define ENOENT_VERSION 1 /** 'virtual' version of non-existent object */
274 struct lu_object_header mot_header;
275 struct lu_object mot_obj;
276 unsigned int mot_lov_created:1, /* lov object created */
277 mot_cache_attr:1; /* enable remote object
280 spinlock_t mot_write_lock;
281 /* Lock to protect create_data */
282 struct mutex mot_lov_mutex;
283 /* lock to protect read/write stages for Data-on-MDT files */
284 struct rw_semaphore mot_dom_sem;
285 /* Lock to protect lease open.
286 * Lease open acquires write lock; normal open acquires read lock */
287 struct rw_semaphore mot_open_sem;
288 atomic_t mot_lease_count;
289 atomic_t mot_open_count;
292 struct mdt_lock_handle {
293 /* Lock type, reg for cross-ref use or pdo lock. */
297 struct lustre_handle mlh_reg_lh;
298 enum ldlm_mode mlh_reg_mode;
301 struct lustre_handle mlh_pdo_lh;
302 enum ldlm_mode mlh_pdo_mode;
303 unsigned int mlh_pdo_hash;
305 /* Remote regular lock */
306 struct lustre_handle mlh_rreg_lh;
307 enum ldlm_mode mlh_rreg_mode;
311 MDT_LH_PARENT, /* parent lockh */
312 MDT_LH_CHILD, /* child lockh */
313 MDT_LH_OLD, /* old lockh for rename */
314 MDT_LH_LAYOUT = MDT_LH_OLD, /* layout lock */
315 MDT_LH_NEW, /* new lockh for rename */
316 MDT_LH_RMT, /* used for return lh to caller */
317 MDT_LH_LOCAL, /* local lock never return to client */
326 /* Special magical errno for communicaiton between mdt_reint_open()
327 * and mdt_intent_reint() which means return the lock to the client
328 * for subsequent cross ref open. Previously we used plain -EREMOTE
329 * but other functions called in that path might return it too and
330 * confuse us. This is not returned to the client. See LU-5370. */
331 #define MDT_EREMOTE_OPEN (EREMOTE + 1024)
333 struct mdt_reint_record {
334 enum mds_reint_op rr_opcode;
335 const struct lustre_handle *rr_handle;
336 const struct lu_fid *rr_fid1;
337 const struct lu_fid *rr_fid2;
338 struct lu_name rr_name;
339 struct lu_name rr_tgt_name;
345 enum mdt_reint_flag {
346 MRF_OPEN_TRUNC = 1 << 0,
350 * Common data shared by mdt-level handlers. This is allocated per-thread to
351 * reduce stack consumption.
353 struct mdt_thread_info {
356 * The following members will be filled explicitly
357 * with specific data in mdt_thread_info_init().
359 /* TODO: move this into mdt_session_key(with LCT_SESSION), because
360 * request handling may migrate from one server thread to another.
362 struct req_capsule *mti_pill;
364 /* although we have export in req, there are cases when it is not
365 * available, e.g. closing files upon export destroy */
366 struct obd_export *mti_exp;
368 * A couple of lock handles.
370 struct mdt_lock_handle mti_lh[MDT_LH_NR];
372 struct mdt_device *mti_mdt;
373 const struct lu_env *mti_env;
375 /* transaction number of current request */
381 * The following members will be filled expilictly
382 * with zero in mdt_thread_info_init(). These members may be used
389 struct md_attr mti_attr;
391 * Body for "habeo corpus" operations.
393 const struct mdt_body *mti_body;
395 * Host object. This is released at the end of mdt_handler().
397 struct mdt_object *mti_object;
399 * Lock request for "habeo clavis" operations.
401 const struct ldlm_request *mti_dlm_req;
403 __u32 mti_has_trans:1, /* has txn already? */
405 /* big_lmm buffer was used and must be used in reply */
410 /* opdata for mdt_reint_open(), has the same as
411 * ldlm_reply:lock_policy_res1. mdt_update_last_rcvd() stores this
412 * value onto disk for recovery when mdt_trans_stop_cb() is called.
418 * The following members will be filled explicitly
419 * with zero in mdt_reint_unpack(), because they are only used
420 * by reint requests (including mdt_reint_open()).
424 * reint record. contains information for reint operations.
426 struct mdt_reint_record mti_rr;
428 __u64 mti_ver[PTLRPC_NUM_VERSIONS];
430 * Operation specification (currently create and lookup)
432 struct md_op_spec mti_spec;
436 * The following members will _NOT_ be initialized at all.
437 * DO NOT expect them to contain any valid value.
438 * They should be initialized explicitly by the user themselves.
441 /* XXX: If something is in a union, make sure they do not conflict */
442 struct lu_fid mti_tmp_fid1;
443 struct lu_fid mti_tmp_fid2;
444 union ldlm_policy_data mti_policy; /* for mdt_object_lock() */
445 struct ldlm_res_id mti_res_id; /* and mdt_rename_lock() */
447 struct obd_uuid uuid[2]; /* for mdt_seq_init_cli() */
448 char ns_name[48];/* for mdt_init0() */
449 struct lustre_cfg_bufs bufs; /* for mdt_stack_fini() */
450 struct obd_statfs osfs; /* for mdt_statfs() */
452 /* for mdt_readpage() */
453 struct lu_rdpg mti_rdpg;
454 /* for mdt_sendpage() */
455 struct l_wait_info mti_wait_info;
462 struct lustre_handle mti_close_handle;
464 struct lu_buf mti_buf;
465 struct lu_buf mti_big_buf;
467 /* Ops object filename */
468 struct lu_name mti_name;
469 /* per-thread values, can be re-used, may be vmalloc'd */
474 /* should be enough to fit lustre_mdt_attrs */
475 char mti_xattr_buf[128];
476 struct ldlm_enqueue_info mti_einfo;
477 struct tg_reply_data *mti_reply_data;
479 struct lustre_som_attrs mti_som;
481 /* FLR: layout change API */
482 struct md_layout_change mti_layout;
485 extern struct lu_context_key mdt_thread_key;
487 static inline struct mdt_thread_info *mdt_th_info(const struct lu_env *env)
489 struct mdt_thread_info *mti;
491 lu_env_refill((void *)env);
492 mti = lu_context_key_get(&env->le_ctx, &mdt_thread_key);
497 struct cdt_req_progress {
498 struct mutex crp_lock; /**< protect tree */
499 struct interval_node *crp_root; /**< tree to track extent
501 struct interval_node **crp_node; /**< buffer for tree nodes
502 * vector of fixed size
504 int crp_cnt; /**< # of used nodes */
505 int crp_max; /**< # of allocated nodes */
508 struct cdt_agent_req {
509 struct hlist_node car_cookie_hash; /**< find req by cookie */
510 struct list_head car_request_list; /**< to chain all the req. */
511 atomic_t car_refcount; /**< reference counter */
512 __u64 car_compound_id; /**< compound id */
513 __u64 car_flags; /**< request original flags */
514 struct obd_uuid car_uuid; /**< agent doing the req. */
515 __u32 car_archive_id; /**< archive id */
516 int car_canceled; /**< request was canceled */
517 bool car_delay_update; /**< delay update, wait for
519 time64_t car_req_start; /**< start time */
520 time64_t car_req_update; /**< last update time */
521 struct hsm_action_item *car_hai; /**< req. to the agent */
522 struct cdt_req_progress car_progress; /**< track data mvt
525 extern struct kmem_cache *mdt_hsm_car_kmem;
528 struct list_head ha_list; /**< to chain the agents */
529 struct obd_uuid ha_uuid; /**< agent uuid */
530 __u32 *ha_archive_id; /**< archive id */
531 int ha_archive_cnt; /**< number of archive entries
532 * 0 means any archive */
533 atomic_t ha_requests; /**< current request count */
534 atomic_t ha_success; /**< number of successful
536 atomic_t ha_failure; /**< number of failed actions */
539 struct cdt_restore_handle {
540 struct list_head crh_list; /**< to chain the handle */
541 struct lu_fid crh_fid; /**< fid of the object */
542 struct ldlm_extent crh_extent; /**< extent of the restore */
543 struct mdt_lock_handle crh_lh; /**< lock handle */
545 extern struct kmem_cache *mdt_hsm_cdt_kmem; /** restore handle slab cache */
547 struct hsm_record_update {
549 enum agent_req_status status;
552 static inline const struct md_device_operations *
553 mdt_child_ops(struct mdt_device * m)
555 LASSERT(m->mdt_child);
556 return m->mdt_child->md_ops;
559 static inline struct md_object *mdt_object_child(struct mdt_object *o)
562 return lu2md(lu_object_next(&o->mot_obj));
565 static inline struct ptlrpc_request *mdt_info_req(struct mdt_thread_info *info)
567 return info->mti_pill ? info->mti_pill->rc_req : NULL;
570 static inline __u64 mdt_conn_flags(struct mdt_thread_info *info)
572 LASSERT(info->mti_exp);
573 return exp_connect_flags(info->mti_exp);
576 static inline void mdt_object_get(const struct lu_env *env,
577 struct mdt_object *o)
580 lu_object_get(&o->mot_obj);
584 static inline void mdt_object_put(const struct lu_env *env,
585 struct mdt_object *o)
588 lu_object_put(env, &o->mot_obj);
592 static inline int mdt_object_exists(const struct mdt_object *o)
594 return lu_object_exists(&o->mot_obj);
597 static inline int mdt_object_remote(const struct mdt_object *o)
599 return lu_object_remote(&o->mot_obj);
602 static inline const struct lu_fid *mdt_object_fid(const struct mdt_object *o)
604 return lu_object_fid(&o->mot_obj);
607 static inline struct lu_site *mdt_lu_site(const struct mdt_device *mdt)
609 return mdt->mdt_lu_dev.ld_site;
612 static inline struct seq_server_site *mdt_seq_site(struct mdt_device *mdt)
614 return &mdt->mdt_seq_site;
617 static inline void mdt_export_evict(struct obd_export *exp)
619 class_fail_export(exp);
622 /* Here we use LVB_TYPE to check dne client, because it is
623 * also landed on 2.4. */
624 static inline bool mdt_is_dne_client(struct obd_export *exp)
626 return !!(exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE);
629 static inline bool mdt_is_striped_client(struct obd_export *exp)
631 return exp_connect_flags(exp) & OBD_CONNECT_DIR_STRIPE;
640 /* XXX Look into layout in MDT layer. This must be done in LOD. */
641 static inline int mdt_lmm_dom_entry(struct lov_mds_md *lmm)
643 struct lov_comp_md_v1 *comp_v1;
644 struct lov_mds_md *v1;
647 if (lmm->lmm_magic == LOV_MAGIC_COMP_V1) {
648 comp_v1 = (struct lov_comp_md_v1 *)lmm;
649 v1 = (struct lov_mds_md *)((char *)comp_v1 +
650 comp_v1->lcm_entries[0].lcme_offset);
651 /* DoM entry is the first entry always */
652 if (lov_pattern(v1->lmm_pattern) != LOV_PATTERN_MDT)
655 for (i = 1; i < comp_v1->lcm_entry_count; i++) {
658 v1 = (struct lov_mds_md *)((char *)comp_v1 +
659 comp_v1->lcm_entries[i].lcme_offset);
660 for (j = 0; j < v1->lmm_stripe_count; j++) {
661 /* if there is any object on OST */
662 if (v1->lmm_objects[j].l_ost_idx !=
672 __u64 mdt_get_disposition(struct ldlm_reply *rep, __u64 op_flag);
673 void mdt_set_disposition(struct mdt_thread_info *info,
674 struct ldlm_reply *rep, __u64 op_flag);
675 void mdt_clear_disposition(struct mdt_thread_info *info,
676 struct ldlm_reply *rep, __u64 op_flag);
678 void mdt_lock_pdo_init(struct mdt_lock_handle *lh, enum ldlm_mode lock_mode,
679 const struct lu_name *lname);
681 void mdt_lock_reg_init(struct mdt_lock_handle *lh, enum ldlm_mode lm);
683 int mdt_lock_setup(struct mdt_thread_info *info, struct mdt_object *mo,
684 struct mdt_lock_handle *lh);
686 int mdt_check_resent_lock(struct mdt_thread_info *info, struct mdt_object *mo,
687 struct mdt_lock_handle *lhc);
689 int mdt_object_lock(struct mdt_thread_info *info, struct mdt_object *mo,
690 struct mdt_lock_handle *lh, __u64 ibits);
692 int mdt_reint_object_lock(struct mdt_thread_info *info, struct mdt_object *o,
693 struct mdt_lock_handle *lh, __u64 ibits,
696 int mdt_object_lock_try(struct mdt_thread_info *info, struct mdt_object *mo,
697 struct mdt_lock_handle *lh, __u64 *ibits,
698 __u64 trybits, bool cos_incompat);
700 void mdt_object_unlock(struct mdt_thread_info *info, struct mdt_object *mo,
701 struct mdt_lock_handle *lh, int decref);
702 void mdt_save_lock(struct mdt_thread_info *info, struct lustre_handle *h,
703 enum ldlm_mode mode, int decref);
705 struct mdt_object *mdt_object_new(const struct lu_env *env,
707 const struct lu_fid *);
708 struct mdt_object *mdt_object_find(const struct lu_env *,
710 const struct lu_fid *);
711 struct mdt_object *mdt_object_find_lock(struct mdt_thread_info *,
712 const struct lu_fid *,
713 struct mdt_lock_handle *,
715 void mdt_object_unlock_put(struct mdt_thread_info *,
717 struct mdt_lock_handle *,
720 void mdt_client_compatibility(struct mdt_thread_info *info);
722 int mdt_remote_object_lock(struct mdt_thread_info *mti,
723 struct mdt_object *o, const struct lu_fid *fid,
724 struct lustre_handle *lh,
725 enum ldlm_mode mode, __u64 ibits, bool cache);
727 enum mdt_name_flags {
731 int mdt_name_unpack(struct req_capsule *pill,
732 const struct req_msg_field *field,
734 enum mdt_name_flags flags);
735 int mdt_close_unpack(struct mdt_thread_info *info);
736 int mdt_reint_unpack(struct mdt_thread_info *info, __u32 op);
737 void mdt_fix_lov_magic(struct mdt_thread_info *info, void *eadata);
738 int mdt_reint_rec(struct mdt_thread_info *, struct mdt_lock_handle *);
739 #ifdef CONFIG_FS_POSIX_ACL
740 int mdt_pack_acl2body(struct mdt_thread_info *info, struct mdt_body *repbody,
741 struct mdt_object *o, struct lu_nodemap *nodemap);
743 void mdt_pack_attr2body(struct mdt_thread_info *info, struct mdt_body *b,
744 const struct lu_attr *attr, const struct lu_fid *fid);
745 int mdt_pack_size2body(struct mdt_thread_info *info,
746 const struct lu_fid *fid, bool dom_lock);
747 int mdt_getxattr(struct mdt_thread_info *info);
748 int mdt_reint_setxattr(struct mdt_thread_info *info,
749 struct mdt_lock_handle *lh);
751 void mdt_lock_handle_init(struct mdt_lock_handle *lh);
752 void mdt_lock_handle_fini(struct mdt_lock_handle *lh);
754 void mdt_reconstruct(struct mdt_thread_info *, struct mdt_lock_handle *);
755 void mdt_reconstruct_generic(struct mdt_thread_info *mti,
756 struct mdt_lock_handle *lhc);
758 extern void target_recovery_fini(struct obd_device *obd);
759 extern void target_recovery_init(struct lu_target *lut,
760 svc_handler_t handler);
761 int mdt_fs_setup(const struct lu_env *, struct mdt_device *,
762 struct obd_device *, struct lustre_sb_info *lsi);
763 void mdt_fs_cleanup(const struct lu_env *, struct mdt_device *);
765 int mdt_export_stats_init(struct obd_device *obd,
766 struct obd_export *exp,
769 int mdt_lock_new_child(struct mdt_thread_info *info,
770 struct mdt_object *o,
771 struct mdt_lock_handle *child_lockh);
773 void mdt_mfd_set_mode(struct mdt_file_data *mfd,
776 int mdt_reint_open(struct mdt_thread_info *info,
777 struct mdt_lock_handle *lhc);
779 struct mdt_file_data *mdt_handle2mfd(struct mdt_export_data *med,
780 const struct lustre_handle *handle,
783 int mdt_get_info(struct tgt_session_info *tsi);
784 int mdt_attr_get_complex(struct mdt_thread_info *info,
785 struct mdt_object *o, struct md_attr *ma);
786 int mdt_big_xattr_get(struct mdt_thread_info *info, struct mdt_object *o,
788 int mdt_stripe_get(struct mdt_thread_info *info, struct mdt_object *o,
789 struct md_attr *ma, const char *name);
790 int mdt_write_get(struct mdt_object *o);
791 void mdt_write_put(struct mdt_object *o);
792 int mdt_write_read(struct mdt_object *o);
793 struct mdt_file_data *mdt_mfd_new(const struct mdt_export_data *med);
794 int mdt_mfd_close(struct mdt_thread_info *info, struct mdt_file_data *mfd);
795 void mdt_mfd_free(struct mdt_file_data *mfd);
796 int mdt_close(struct tgt_session_info *tsi);
797 int mdt_add_dirty_flag(struct mdt_thread_info *info, struct mdt_object *mo,
799 int mdt_fix_reply(struct mdt_thread_info *info);
800 int mdt_handle_last_unlink(struct mdt_thread_info *, struct mdt_object *,
802 void mdt_reconstruct_open(struct mdt_thread_info *, struct mdt_lock_handle *);
803 int mdt_layout_change(struct mdt_thread_info *info, struct mdt_object *obj,
804 struct md_layout_change *spec);
806 struct lu_buf *mdt_buf(const struct lu_env *env, void *area, ssize_t len);
807 const struct lu_buf *mdt_buf_const(const struct lu_env *env,
808 const void *area, ssize_t len);
810 void mdt_dump_lmm(int level, const struct lov_mds_md *lmm, __u64 valid);
811 void mdt_dump_lmv(unsigned int level, const union lmv_mds_md *lmv);
813 bool allow_client_chgrp(struct mdt_thread_info *info, struct lu_ucred *uc);
814 int mdt_check_ucred(struct mdt_thread_info *);
815 int mdt_init_ucred(struct mdt_thread_info *, struct mdt_body *);
816 int mdt_init_ucred_intent_getattr(struct mdt_thread_info *, struct mdt_body *);
817 int mdt_init_ucred_reint(struct mdt_thread_info *);
818 void mdt_exit_ucred(struct mdt_thread_info *);
819 int mdt_version_get_check(struct mdt_thread_info *, struct mdt_object *, int);
820 void mdt_version_get_save(struct mdt_thread_info *, struct mdt_object *, int);
821 int mdt_version_get_check_save(struct mdt_thread_info *, struct mdt_object *,
823 void mdt_thread_info_init(struct ptlrpc_request *req,
824 struct mdt_thread_info *mti);
825 void mdt_thread_info_fini(struct mdt_thread_info *mti);
826 struct mdt_thread_info *tsi2mdt_info(struct tgt_session_info *tsi);
827 void mdt_intent_fixup_resent(struct mdt_thread_info *info,
828 struct ldlm_lock *new_lock,
829 struct mdt_lock_handle *lh, __u64 flags);
830 int mdt_intent_lock_replace(struct mdt_thread_info *info,
831 struct ldlm_lock **lockp,
832 struct mdt_lock_handle *lh,
833 __u64 flags, int result);
835 int mdt_hsm_attr_set(struct mdt_thread_info *info, struct mdt_object *obj,
836 const struct md_hsm *mh);
838 int mdt_remote_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
839 void *data, int flag);
840 int mdt_links_read(struct mdt_thread_info *info,
841 struct mdt_object *mdt_obj,
842 struct linkea_data *ldata);
843 int mdt_close_internal(struct mdt_thread_info *info, struct ptlrpc_request *req,
844 struct mdt_body *repbody);
846 static inline struct mdt_device *mdt_dev(struct lu_device *d)
848 return container_of0(d, struct mdt_device, mdt_lu_dev);
851 static inline struct mdt_object *mdt_obj(struct lu_object *o)
853 return container_of0(o, struct mdt_object, mot_obj);
856 static inline struct dt_object *mdt_obj2dt(struct mdt_object *mo)
858 struct lu_object *lo;
859 struct mdt_device *mdt = mdt_dev(mo->mot_obj.lo_dev);
861 lo = lu_object_locate(mo->mot_obj.lo_header,
862 mdt->mdt_bottom->dd_lu_dev.ld_type);
867 static inline bool agent_req_in_final_state(enum agent_req_status ars)
869 return ((ars == ARS_SUCCEED) || (ars == ARS_FAILED) ||
870 (ars == ARS_CANCELED));
873 /* mdt/mdt_identity.c */
874 #define MDT_IDENTITY_UPCALL_PATH "/usr/sbin/l_getidentity"
876 extern struct upcall_cache_ops mdt_identity_upcall_cache_ops;
878 struct md_identity *mdt_identity_get(struct upcall_cache *, __u32);
880 void mdt_identity_put(struct upcall_cache *, struct md_identity *);
882 void mdt_flush_identity(struct upcall_cache *, int);
884 __u32 mdt_identity_get_perm(struct md_identity *, lnet_nid_t);
886 /* mdt/mdt_recovery.c */
887 __u64 mdt_req_from_lrd(struct ptlrpc_request *req, struct tg_reply_data *trd);
890 int mdt_hsm_state_get(struct tgt_session_info *tsi);
891 int mdt_hsm_state_set(struct tgt_session_info *tsi);
892 int mdt_hsm_action(struct tgt_session_info *tsi);
893 int mdt_hsm_progress(struct tgt_session_info *tsi);
894 int mdt_hsm_ct_register(struct tgt_session_info *tsi);
895 int mdt_hsm_ct_unregister(struct tgt_session_info *tsi);
896 int mdt_hsm_request(struct tgt_session_info *tsi);
898 /* mdt/mdt_hsm_cdt_actions.c */
899 extern const struct file_operations mdt_hsm_actions_fops;
900 void dump_llog_agent_req_rec(const char *prefix,
901 const struct llog_agent_req_rec *larr);
902 int cdt_llog_process(const struct lu_env *env, struct mdt_device *mdt,
903 llog_cb_t cb, void *data, u32 start_cat_idx,
904 u32 start_rec_idx, int rw);
905 int mdt_agent_record_add(const struct lu_env *env, struct mdt_device *mdt,
906 __u64 compound_id, __u32 archive_id,
907 __u64 flags, struct hsm_action_item *hai);
908 int mdt_agent_record_update(const struct lu_env *env, struct mdt_device *mdt,
909 struct hsm_record_update *updates,
910 unsigned int updates_count);
911 void cdt_agent_record_hash_add(struct coordinator *cdt, u64 cookie, u32 cat_idt,
913 void cdt_agent_record_hash_lookup(struct coordinator *cdt, u64 cookie,
914 u32 *cat_idt, u32 *rec_idx);
915 void cdt_agent_record_hash_del(struct coordinator *cdt, u64 cookie);
917 /* mdt/mdt_hsm_cdt_agent.c */
918 extern const struct file_operations mdt_hsm_agent_fops;
919 int mdt_hsm_agent_register(struct mdt_thread_info *info,
920 const struct obd_uuid *uuid,
921 int nr_archives, __u32 *archive_num);
922 int mdt_hsm_agent_register_mask(struct mdt_thread_info *info,
923 const struct obd_uuid *uuid,
925 int mdt_hsm_agent_unregister(struct mdt_thread_info *info,
926 const struct obd_uuid *uuid);
927 int mdt_hsm_agent_update_statistics(struct coordinator *cdt,
928 int succ_rq, int fail_rq, int new_rq,
929 const struct obd_uuid *uuid);
930 int mdt_hsm_find_best_agent(struct coordinator *cdt, __u32 archive,
931 struct obd_uuid *uuid);
932 int mdt_hsm_agent_send(struct mdt_thread_info *mti, struct hsm_action_list *hal,
934 int hsm_cancel_agent_requests(struct mdt_device *mdt,
935 const struct obd_uuid *uuid);
936 int mdt_hsm_coordinator_update(struct mdt_thread_info *mti,
937 struct hsm_progress_kernel *pgs);
938 /* mdt/mdt_hsm_cdt_client.c */
939 int mdt_hsm_add_actions(struct mdt_thread_info *info,
940 struct hsm_action_list *hal);
941 int mdt_hsm_get_actions(struct mdt_thread_info *mti,
942 struct hsm_action_list *hal);
943 bool mdt_hsm_restore_is_running(struct mdt_thread_info *mti,
944 const struct lu_fid *fid);
945 /* mdt/mdt_hsm_cdt_requests.c */
946 extern struct cfs_hash_ops cdt_request_cookie_hash_ops;
947 extern struct cfs_hash_ops cdt_agent_record_hash_ops;
948 extern const struct file_operations mdt_hsm_active_requests_fops;
949 void dump_requests(char *prefix, struct coordinator *cdt);
950 struct cdt_agent_req *mdt_cdt_alloc_request(__u64 compound_id, __u32 archive_id,
951 __u64 flags, struct obd_uuid *uuid,
952 struct hsm_action_item *hai);
953 void mdt_cdt_free_request(struct cdt_agent_req *car);
954 int mdt_cdt_add_request(struct coordinator *cdt, struct cdt_agent_req *new_car);
955 struct cdt_agent_req *mdt_cdt_find_request(struct coordinator *cdt, u64 cookie);
956 void mdt_cdt_get_work_done(struct cdt_agent_req *car, __u64 *done_sz);
957 void mdt_cdt_get_request(struct cdt_agent_req *car);
958 void mdt_cdt_put_request(struct cdt_agent_req *car);
959 struct cdt_agent_req *mdt_cdt_update_request(struct coordinator *cdt,
960 const struct hsm_progress_kernel *pgs);
961 int mdt_cdt_remove_request(struct coordinator *cdt, __u64 cookie);
962 /* mdt/mdt_coordinator.c */
963 void mdt_hsm_dump_hal(int level, const char *prefix,
964 struct hsm_action_list *hal);
965 struct cdt_restore_handle *mdt_hsm_restore_hdl_find(struct coordinator *cdt,
966 const struct lu_fid *fid);
967 /* coordinator management */
968 int mdt_hsm_cdt_init(struct mdt_device *mdt);
969 int mdt_hsm_cdt_stop(struct mdt_device *mdt);
970 int mdt_hsm_cdt_fini(struct mdt_device *mdt);
973 * Signal the coordinator has work to do
974 * \param cdt [IN] coordinator
976 static inline void mdt_hsm_cdt_event(struct coordinator *cdt)
978 cdt->cdt_event = true;
981 /* coordinator control /proc interface */
982 ssize_t mdt_hsm_cdt_control_seq_write(struct file *file,
983 const char __user *buffer,
984 size_t count, loff_t *off);
985 int mdt_hsm_cdt_control_seq_show(struct seq_file *m, void *data);
986 int hsm_cdt_procfs_init(struct mdt_device *mdt);
987 void hsm_cdt_procfs_fini(struct mdt_device *mdt);
988 struct lprocfs_vars *hsm_cdt_get_proc_vars(void);
990 struct mdt_object *mdt_hsm_get_md_hsm(struct mdt_thread_info *mti,
991 const struct lu_fid *fid,
993 /* actions/request helpers */
994 int mdt_hsm_add_hal(struct mdt_thread_info *mti,
995 struct hsm_action_list *hal, struct obd_uuid *uuid);
996 bool mdt_hsm_is_action_compat(const struct hsm_action_item *hai,
997 u32 archive_id, u64 rq_flags,
998 const struct md_hsm *hsm);
999 int mdt_hsm_update_request_state(struct mdt_thread_info *mti,
1000 struct hsm_progress_kernel *pgs,
1001 const int update_record);
1003 int mdt_close_swap_layouts(struct mdt_thread_info *info,
1004 struct mdt_object *o, struct md_attr *ma);
1006 extern struct lu_context_key mdt_thread_key;
1008 /* debug issues helper starts here*/
1009 static inline int mdt_fail_write(const struct lu_env *env,
1010 struct dt_device *dd, int id)
1012 if (OBD_FAIL_CHECK_ORSET(id, OBD_FAIL_ONCE)) {
1013 CERROR(LUSTRE_MDT_NAME": cfs_fail_loc=%x, fail write ops\n",
1015 return dt_ro(env, dd);
1016 /* We set FAIL_ONCE because we never "un-fail" a device */
1022 static inline struct mdt_export_data *mdt_req2med(struct ptlrpc_request *req)
1024 return &req->rq_export->exp_mdt_data;
1027 static inline struct mdt_device *mdt_exp2dev(struct obd_export *exp)
1029 return mdt_dev(exp->exp_obd->obd_lu_dev);
1032 static inline bool mdt_rdonly(struct obd_export *exp)
1034 if (exp_connect_flags(exp) & OBD_CONNECT_RDONLY ||
1035 mdt_exp2dev(exp)->mdt_bottom->dd_rdonly)
1040 typedef void (*mdt_reconstruct_t)(struct mdt_thread_info *mti,
1041 struct mdt_lock_handle *lhc);
1042 static inline int mdt_check_resent(struct mdt_thread_info *info,
1043 mdt_reconstruct_t reconstruct,
1044 struct mdt_lock_handle *lhc)
1046 struct ptlrpc_request *req = mdt_info_req(info);
1050 if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) {
1051 OBD_ALLOC_PTR(info->mti_reply_data);
1052 if (info->mti_reply_data == NULL)
1055 if (req_can_reconstruct(req, info->mti_reply_data)) {
1056 reconstruct(info, lhc);
1059 DEBUG_REQ(D_HA, req,
1060 "no reply data found for RESENT req");
1063 OBD_FREE_PTR(info->mti_reply_data);
1064 info->mti_reply_data = NULL;
1069 struct lu_ucred *mdt_ucred(const struct mdt_thread_info *info);
1070 struct lu_ucred *mdt_ucred_check(const struct mdt_thread_info *info);
1072 static inline int is_identity_get_disabled(struct upcall_cache *cache)
1074 return cache ? (strcmp(cache->uc_upcall, "NONE") == 0) : 1;
1077 int mdt_blocking_ast(struct ldlm_lock*, struct ldlm_lock_desc*, void*, int);
1079 static int mdt_dom_glimpse_ast(struct ldlm_lock *lock, void *reqp)
1081 return -ELDLM_NO_LOCK_DATA;
1084 /* Issues dlm lock on passed @ns, @f stores it lock handle into @lh. */
1085 static inline int mdt_fid_lock(struct ldlm_namespace *ns,
1086 struct lustre_handle *lh, enum ldlm_mode mode,
1087 union ldlm_policy_data *policy,
1088 const struct ldlm_res_id *res_id,
1089 __u64 flags, const __u64 *client_cookie)
1092 bool glimpse = policy->l_inodebits.bits & MDS_INODELOCK_DOM;
1094 LASSERT(ns != NULL);
1095 LASSERT(lh != NULL);
1097 rc = ldlm_cli_enqueue_local(ns, res_id, LDLM_IBITS, policy,
1098 mode, &flags, mdt_blocking_ast,
1099 ldlm_completion_ast,
1100 glimpse ? mdt_dom_glimpse_ast : NULL,
1101 NULL, 0, LVB_T_NONE, client_cookie, lh);
1102 return rc == ELDLM_OK ? 0 : -EIO;
1105 static inline void mdt_fid_unlock(struct lustre_handle *lh, enum ldlm_mode mode)
1107 ldlm_lock_decref(lh, mode);
1110 static inline bool mdt_slc_is_enabled(struct mdt_device *mdt)
1112 return mdt->mdt_lut.lut_sync_lock_cancel == BLOCKING_SYNC_ON_CANCEL;
1115 extern mdl_mode_t mdt_mdl_lock_modes[];
1116 extern enum ldlm_mode mdt_dlm_lock_modes[];
1118 /* LCK_MINMODE which is zero returns false for is_power_of_2 */
1120 static inline mdl_mode_t mdt_dlm_mode2mdl_mode(enum ldlm_mode mode)
1122 LASSERT(mode == LCK_MINMODE || is_power_of_2(mode));
1123 return mdt_mdl_lock_modes[mode];
1126 static inline enum ldlm_mode mdt_mdl_mode2dlm_mode(mdl_mode_t mode)
1128 LASSERT(mode == MDL_MINMODE || is_power_of_2(mode));
1129 return mdt_dlm_lock_modes[mode];
1133 int mdt_set_som(struct mdt_thread_info *info, struct mdt_object *obj,
1134 struct lu_attr *attr);
1135 int mdt_get_som(struct mdt_thread_info *info, struct mdt_object *obj,
1136 struct lu_attr *attr);
1139 extern struct ldlm_valblock_ops mdt_lvbo;
1140 int mdt_dom_lvb_is_valid(struct ldlm_resource *res);
1141 int mdt_dom_lvbo_update(struct ldlm_resource *res, struct ldlm_lock *lock,
1142 struct ptlrpc_request *req, bool increase_only);
1144 void mdt_enable_cos(struct mdt_device *, int);
1145 int mdt_cos_is_enabled(struct mdt_device *);
1163 LPROC_MDT_SAMEDIR_RENAME,
1164 LPROC_MDT_CROSSDIR_RENAME,
1170 void mdt_counter_incr(struct ptlrpc_request *req, int opcode);
1171 void mdt_stats_counter_init(struct lprocfs_stats *stats);
1172 int mdt_procfs_init(struct mdt_device *mdt, const char *name);
1173 void mdt_procfs_fini(struct mdt_device *mdt);
1175 /* lustre/mdt_mdt_lproc.c */
1176 int lprocfs_mdt_open_files_seq_open(struct inode *inode,
1178 void mdt_rename_counter_tally(struct mdt_thread_info *info,
1179 struct mdt_device *mdt,
1180 struct ptlrpc_request *req,
1181 struct mdt_object *src, struct mdt_object *tgt);
1183 static inline struct obd_device *mdt2obd_dev(const struct mdt_device *mdt)
1185 return mdt->mdt_lu_dev.ld_obd;
1188 extern const struct lu_device_operations mdt_lu_ops;
1190 static inline char *mdt_obd_name(struct mdt_device *mdt)
1192 return mdt->mdt_lu_dev.ld_obd->obd_name;
1195 int mds_mod_init(void);
1196 void mds_mod_exit(void);
1198 static inline char *mdt_req_get_jobid(struct ptlrpc_request *req)
1200 struct obd_export *exp = req->rq_export;
1203 if (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS)
1204 jobid = lustre_msg_get_jobid(req->rq_reqmsg);
1211 #define VALID_FLAGS (LA_TYPE | LA_MODE | LA_SIZE | LA_BLOCKS | \
1212 LA_BLKSIZE | LA_ATIME | LA_MTIME | LA_CTIME)
1214 int mdt_obd_preprw(const struct lu_env *env, int cmd, struct obd_export *exp,
1215 struct obdo *oa, int objcount, struct obd_ioobj *obj,
1216 struct niobuf_remote *rnb, int *nr_local,
1217 struct niobuf_local *lnb);
1219 int mdt_obd_commitrw(const struct lu_env *env, int cmd, struct obd_export *exp,
1220 struct obdo *oa, int objcount, struct obd_ioobj *obj,
1221 struct niobuf_remote *rnb, int npages,
1222 struct niobuf_local *lnb, int old_rc);
1223 int mdt_punch_hdl(struct tgt_session_info *tsi);
1224 int mdt_glimpse_enqueue(struct mdt_thread_info *mti, struct ldlm_namespace *ns,
1225 struct ldlm_lock **lockp, __u64 flags);
1226 int mdt_brw_enqueue(struct mdt_thread_info *info, struct ldlm_namespace *ns,
1227 struct ldlm_lock **lockp, __u64 flags);
1228 void mdt_dom_discard_data(struct mdt_thread_info *info,
1229 const struct lu_fid *fid);
1230 int mdt_dom_disk_lvbo_update(const struct lu_env *env, struct mdt_object *mo,
1231 struct ldlm_resource *res, bool increase_only);
1232 void mdt_dom_obj_lvb_update(const struct lu_env *env, struct mdt_object *mo,
1233 bool increase_only);
1234 int mdt_dom_lvb_alloc(struct ldlm_resource *res);
1236 static inline void mdt_dom_check_and_discard(struct mdt_thread_info *mti,
1237 struct mdt_object *mo)
1239 if (lu_object_is_dying(&mo->mot_header) &&
1240 S_ISREG(lu_object_attr(&mo->mot_obj)))
1241 mdt_dom_discard_data(mti, mdt_object_fid(mo));
1244 int mdt_dom_object_size(const struct lu_env *env, struct mdt_device *mdt,
1245 const struct lu_fid *fid, struct mdt_body *mb,
1247 bool mdt_dom_client_has_lock(struct mdt_thread_info *info,
1248 const struct lu_fid *fid);
1250 long mdt_grant_connect(const struct lu_env *env, struct obd_export *exp,
1251 u64 want, bool conservative);
1252 extern struct kmem_cache *ldlm_glimpse_work_kmem;
1254 #endif /* _MDT_INTERNAL_H */