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 atomic_t cdt_request_count; /**< current count of
160 * started requests */
161 /* started requests (struct cdt_agent_req:car_cookie_hash)
162 * indexed by cookie */
163 struct cfs_hash *cdt_request_cookie_hash;
164 /* started requests (struct cdt_agent_req:car_request_list) */
165 struct list_head cdt_request_list;
166 struct list_head cdt_agents; /**< list of register
168 struct list_head cdt_restore_hdl; /**< list of restore lock
171 /* Hash of cookies to locations of record locations in agent
173 struct cfs_hash *cdt_agent_record_hash;
175 /* Bitmasks indexed by the HSMA_XXX constants. */
176 __u64 cdt_user_request_mask;
177 __u64 cdt_group_request_mask;
178 __u64 cdt_other_request_mask;
180 /* Remove archive on last unlink policy */
181 bool cdt_remove_archive_on_last_unlink;
183 bool cdt_wakeup_coordinator;
186 /* mdt state flag bits */
187 #define MDT_FL_CFGLOG 0
188 #define MDT_FL_SYNCED 1
192 struct lu_device mdt_lu_dev;
193 struct seq_server_site mdt_seq_site;
194 /* DLM name-space for meta-data locks maintained by this server */
195 struct ldlm_namespace *mdt_namespace;
196 /* ptlrpc handle for MDS->client connections (for lock ASTs). */
197 struct ptlrpc_client *mdt_ldlm_client;
198 /* underlying device */
199 struct obd_export *mdt_child_exp;
200 struct md_device *mdt_child;
201 struct dt_device *mdt_bottom;
202 struct obd_export *mdt_bottom_exp;
204 struct lu_target mdt_lut;
206 * Options bit-fields.
209 unsigned int mo_user_xattr:1,
215 /* mdt state flags */
216 unsigned long mdt_state;
218 /* transaction callbacks */
219 struct dt_txn_callback mdt_txn_cb;
221 /* these values should be updated from lov if necessary.
222 * or should be placed somewhere else. */
227 /* preferred BRW size, decided by storage type and capability */
230 struct upcall_cache *mdt_identity_cache;
232 unsigned int mdt_capa_conf:1,
233 /* Enable remote dir on non-MDT0 */
234 mdt_enable_remote_dir:1,
237 gid_t mdt_enable_remote_dir_gid;
239 /* lock for osfs and md_root */
243 struct root_squash_info mdt_squash;
245 struct rename_stats mdt_rename_stats;
246 struct lu_fid mdt_md_root_fid;
248 /* connection to quota master */
249 struct obd_export *mdt_qmt_exp;
250 /* quota master device associated with this MDT */
251 struct lu_device *mdt_qmt_dev;
253 struct coordinator mdt_coordinator;
255 /* inter-MDT connection count */
256 atomic_t mdt_mds_mds_conns;
258 /* MDT device async commit count, used for debug and sanity test */
259 atomic_t mdt_async_commit_count;
261 struct mdt_object *mdt_md_root;
264 #define MDT_SERVICE_WATCHDOG_FACTOR (2)
265 #define MDT_COS_DEFAULT (0)
267 #define ENOENT_VERSION 1 /** 'virtual' version of non-existent object */
270 struct lu_object_header mot_header;
271 struct lu_object mot_obj;
272 unsigned int mot_lov_created:1, /* lov object created */
273 mot_cache_attr:1; /* enable remote object
276 spinlock_t mot_write_lock;
277 /* Lock to protect create_data */
278 struct mutex mot_lov_mutex;
279 /* lock to protect read/write stages for Data-on-MDT files */
280 struct rw_semaphore mot_dom_sem;
281 /* Lock to protect lease open.
282 * Lease open acquires write lock; normal open acquires read lock */
283 struct rw_semaphore mot_open_sem;
284 atomic_t mot_lease_count;
285 atomic_t mot_open_count;
288 struct mdt_lock_handle {
289 /* Lock type, reg for cross-ref use or pdo lock. */
293 struct lustre_handle mlh_reg_lh;
294 enum ldlm_mode mlh_reg_mode;
297 struct lustre_handle mlh_pdo_lh;
298 enum ldlm_mode mlh_pdo_mode;
299 unsigned int mlh_pdo_hash;
301 /* Remote regular lock */
302 struct lustre_handle mlh_rreg_lh;
303 enum ldlm_mode mlh_rreg_mode;
307 MDT_LH_PARENT, /* parent lockh */
308 MDT_LH_CHILD, /* child lockh */
309 MDT_LH_OLD, /* old lockh for rename */
310 MDT_LH_LAYOUT = MDT_LH_OLD, /* layout lock */
311 MDT_LH_NEW, /* new lockh for rename */
312 MDT_LH_RMT, /* used for return lh to caller */
313 MDT_LH_LOCAL, /* local lock never return to client */
322 /* Special magical errno for communicaiton between mdt_reint_open()
323 * and mdt_intent_reint() which means return the lock to the client
324 * for subsequent cross ref open. Previously we used plain -EREMOTE
325 * but other functions called in that path might return it too and
326 * confuse us. This is not returned to the client. See LU-5370. */
327 #define MDT_EREMOTE_OPEN (EREMOTE + 1024)
329 struct mdt_reint_record {
330 enum mds_reint_op rr_opcode;
331 const struct lustre_handle *rr_handle;
332 const struct lu_fid *rr_fid1;
333 const struct lu_fid *rr_fid2;
334 struct lu_name rr_name;
335 struct lu_name rr_tgt_name;
341 enum mdt_reint_flag {
342 MRF_OPEN_TRUNC = 1 << 0,
346 * Common data shared by mdt-level handlers. This is allocated per-thread to
347 * reduce stack consumption.
349 struct mdt_thread_info {
352 * The following members will be filled explicitly
353 * with specific data in mdt_thread_info_init().
355 /* TODO: move this into mdt_session_key(with LCT_SESSION), because
356 * request handling may migrate from one server thread to another.
358 struct req_capsule *mti_pill;
360 /* although we have export in req, there are cases when it is not
361 * available, e.g. closing files upon export destroy */
362 struct obd_export *mti_exp;
364 * A couple of lock handles.
366 struct mdt_lock_handle mti_lh[MDT_LH_NR];
368 struct mdt_device *mti_mdt;
369 const struct lu_env *mti_env;
371 /* transaction number of current request */
377 * The following members will be filled expilictly
378 * with zero in mdt_thread_info_init(). These members may be used
385 struct md_attr mti_attr;
387 * Body for "habeo corpus" operations.
389 const struct mdt_body *mti_body;
391 * Host object. This is released at the end of mdt_handler().
393 struct mdt_object *mti_object;
395 * Lock request for "habeo clavis" operations.
397 const struct ldlm_request *mti_dlm_req;
399 __u32 mti_has_trans:1, /* has txn already? */
401 /* big_lmm buffer was used and must be used in reply */
406 /* opdata for mdt_reint_open(), has the same as
407 * ldlm_reply:lock_policy_res1. mdt_update_last_rcvd() stores this
408 * value onto disk for recovery when mdt_trans_stop_cb() is called.
414 * The following members will be filled explicitly
415 * with zero in mdt_reint_unpack(), because they are only used
416 * by reint requests (including mdt_reint_open()).
420 * reint record. contains information for reint operations.
422 struct mdt_reint_record mti_rr;
424 __u64 mti_ver[PTLRPC_NUM_VERSIONS];
426 * Operation specification (currently create and lookup)
428 struct md_op_spec mti_spec;
432 * The following members will _NOT_ be initialized at all.
433 * DO NOT expect them to contain any valid value.
434 * They should be initialized explicitly by the user themselves.
437 /* XXX: If something is in a union, make sure they do not conflict */
438 struct lu_fid mti_tmp_fid1;
439 struct lu_fid mti_tmp_fid2;
440 union ldlm_policy_data mti_policy; /* for mdt_object_lock() */
441 struct ldlm_res_id mti_res_id; /* and mdt_rename_lock() */
443 struct obd_uuid uuid[2]; /* for mdt_seq_init_cli() */
444 char ns_name[48];/* for mdt_init0() */
445 struct lustre_cfg_bufs bufs; /* for mdt_stack_fini() */
446 struct obd_statfs osfs; /* for mdt_statfs() */
448 /* for mdt_readpage() */
449 struct lu_rdpg mti_rdpg;
450 /* for mdt_sendpage() */
451 struct l_wait_info mti_wait_info;
458 struct lustre_handle mti_close_handle;
460 struct lu_buf mti_buf;
461 struct lu_buf mti_big_buf;
463 /* Ops object filename */
464 struct lu_name mti_name;
465 /* per-thread values, can be re-used, may be vmalloc'd */
470 /* should be enough to fit lustre_mdt_attrs */
471 char mti_xattr_buf[128];
472 struct ldlm_enqueue_info mti_einfo;
473 struct tg_reply_data *mti_reply_data;
475 struct lustre_som_attrs mti_som;
477 /* FLR: layout change API */
478 struct md_layout_change mti_layout;
481 extern struct lu_context_key mdt_thread_key;
483 static inline struct mdt_thread_info *mdt_th_info(const struct lu_env *env)
485 struct mdt_thread_info *mti;
487 lu_env_refill((void *)env);
488 mti = lu_context_key_get(&env->le_ctx, &mdt_thread_key);
493 struct cdt_req_progress {
494 struct mutex crp_lock; /**< protect tree */
495 struct interval_node *crp_root; /**< tree to track extent
497 struct interval_node **crp_node; /**< buffer for tree nodes
498 * vector of fixed size
500 int crp_cnt; /**< # of used nodes */
501 int crp_max; /**< # of allocated nodes */
504 struct cdt_agent_req {
505 struct hlist_node car_cookie_hash; /**< find req by cookie */
506 struct list_head car_request_list; /**< to chain all the req. */
507 atomic_t car_refcount; /**< reference counter */
508 __u64 car_compound_id; /**< compound id */
509 __u64 car_flags; /**< request original flags */
510 struct obd_uuid car_uuid; /**< agent doing the req. */
511 __u32 car_archive_id; /**< archive id */
512 int car_canceled; /**< request was canceled */
513 bool car_delay_update; /**< delay update, wait for
515 time64_t car_req_start; /**< start time */
516 time64_t car_req_update; /**< last update time */
517 struct hsm_action_item *car_hai; /**< req. to the agent */
518 struct cdt_req_progress car_progress; /**< track data mvt
521 extern struct kmem_cache *mdt_hsm_car_kmem;
524 struct list_head ha_list; /**< to chain the agents */
525 struct obd_uuid ha_uuid; /**< agent uuid */
526 __u32 *ha_archive_id; /**< archive id */
527 int ha_archive_cnt; /**< number of archive entries
528 * 0 means any archive */
529 atomic_t ha_requests; /**< current request count */
530 atomic_t ha_success; /**< number of successful
532 atomic_t ha_failure; /**< number of failed actions */
535 struct cdt_restore_handle {
536 struct list_head crh_list; /**< to chain the handle */
537 struct lu_fid crh_fid; /**< fid of the object */
538 struct ldlm_extent crh_extent; /**< extent of the restore */
539 struct mdt_lock_handle crh_lh; /**< lock handle */
541 extern struct kmem_cache *mdt_hsm_cdt_kmem; /** restore handle slab cache */
543 struct hsm_record_update {
545 enum agent_req_status status;
548 static inline const struct md_device_operations *
549 mdt_child_ops(struct mdt_device * m)
551 LASSERT(m->mdt_child);
552 return m->mdt_child->md_ops;
555 static inline struct md_object *mdt_object_child(struct mdt_object *o)
558 return lu2md(lu_object_next(&o->mot_obj));
561 static inline struct ptlrpc_request *mdt_info_req(struct mdt_thread_info *info)
563 return info->mti_pill ? info->mti_pill->rc_req : NULL;
566 static inline __u64 mdt_conn_flags(struct mdt_thread_info *info)
568 LASSERT(info->mti_exp);
569 return exp_connect_flags(info->mti_exp);
572 static inline void mdt_object_get(const struct lu_env *env,
573 struct mdt_object *o)
576 lu_object_get(&o->mot_obj);
580 static inline void mdt_object_put(const struct lu_env *env,
581 struct mdt_object *o)
584 lu_object_put(env, &o->mot_obj);
588 static inline int mdt_object_exists(const struct mdt_object *o)
590 return lu_object_exists(&o->mot_obj);
593 static inline int mdt_object_remote(const struct mdt_object *o)
595 return lu_object_remote(&o->mot_obj);
598 static inline const struct lu_fid *mdt_object_fid(const struct mdt_object *o)
600 return lu_object_fid(&o->mot_obj);
603 static inline struct lu_site *mdt_lu_site(const struct mdt_device *mdt)
605 return mdt->mdt_lu_dev.ld_site;
608 static inline struct seq_server_site *mdt_seq_site(struct mdt_device *mdt)
610 return &mdt->mdt_seq_site;
613 static inline void mdt_export_evict(struct obd_export *exp)
615 class_fail_export(exp);
618 /* Here we use LVB_TYPE to check dne client, because it is
619 * also landed on 2.4. */
620 static inline bool mdt_is_dne_client(struct obd_export *exp)
622 return !!(exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE);
625 static inline bool mdt_is_striped_client(struct obd_export *exp)
627 return exp_connect_flags(exp) & OBD_CONNECT_DIR_STRIPE;
636 /* XXX Look into layout in MDT layer. This must be done in LOD. */
637 static inline int mdt_lmm_dom_entry(struct lov_mds_md *lmm)
639 struct lov_comp_md_v1 *comp_v1;
640 struct lov_mds_md *v1;
643 if (lmm->lmm_magic == LOV_MAGIC_COMP_V1) {
644 comp_v1 = (struct lov_comp_md_v1 *)lmm;
645 v1 = (struct lov_mds_md *)((char *)comp_v1 +
646 comp_v1->lcm_entries[0].lcme_offset);
647 /* DoM entry is the first entry always */
648 if (lov_pattern(v1->lmm_pattern) != LOV_PATTERN_MDT)
651 for (i = 1; i < comp_v1->lcm_entry_count; i++) {
654 v1 = (struct lov_mds_md *)((char *)comp_v1 +
655 comp_v1->lcm_entries[i].lcme_offset);
656 for (j = 0; j < v1->lmm_stripe_count; j++) {
657 /* if there is any object on OST */
658 if (v1->lmm_objects[j].l_ost_idx !=
668 __u64 mdt_get_disposition(struct ldlm_reply *rep, __u64 op_flag);
669 void mdt_set_disposition(struct mdt_thread_info *info,
670 struct ldlm_reply *rep, __u64 op_flag);
671 void mdt_clear_disposition(struct mdt_thread_info *info,
672 struct ldlm_reply *rep, __u64 op_flag);
674 void mdt_lock_pdo_init(struct mdt_lock_handle *lh, enum ldlm_mode lock_mode,
675 const struct lu_name *lname);
677 void mdt_lock_reg_init(struct mdt_lock_handle *lh, enum ldlm_mode lm);
679 int mdt_lock_setup(struct mdt_thread_info *info, struct mdt_object *mo,
680 struct mdt_lock_handle *lh);
682 int mdt_check_resent_lock(struct mdt_thread_info *info, struct mdt_object *mo,
683 struct mdt_lock_handle *lhc);
685 int mdt_object_lock(struct mdt_thread_info *info, struct mdt_object *mo,
686 struct mdt_lock_handle *lh, __u64 ibits);
688 int mdt_reint_object_lock(struct mdt_thread_info *info, struct mdt_object *o,
689 struct mdt_lock_handle *lh, __u64 ibits,
692 int mdt_object_lock_try(struct mdt_thread_info *info, struct mdt_object *mo,
693 struct mdt_lock_handle *lh, __u64 *ibits,
694 __u64 trybits, bool cos_incompat);
696 void mdt_object_unlock(struct mdt_thread_info *info, struct mdt_object *mo,
697 struct mdt_lock_handle *lh, int decref);
698 void mdt_save_lock(struct mdt_thread_info *info, struct lustre_handle *h,
699 enum ldlm_mode mode, int decref);
701 struct mdt_object *mdt_object_new(const struct lu_env *env,
703 const struct lu_fid *);
704 struct mdt_object *mdt_object_find(const struct lu_env *,
706 const struct lu_fid *);
707 struct mdt_object *mdt_object_find_lock(struct mdt_thread_info *,
708 const struct lu_fid *,
709 struct mdt_lock_handle *,
711 void mdt_object_unlock_put(struct mdt_thread_info *,
713 struct mdt_lock_handle *,
716 void mdt_client_compatibility(struct mdt_thread_info *info);
718 int mdt_remote_object_lock(struct mdt_thread_info *mti,
719 struct mdt_object *o, const struct lu_fid *fid,
720 struct lustre_handle *lh,
721 enum ldlm_mode mode, __u64 ibits, bool cache);
723 enum mdt_name_flags {
727 int mdt_name_unpack(struct req_capsule *pill,
728 const struct req_msg_field *field,
730 enum mdt_name_flags flags);
731 int mdt_close_unpack(struct mdt_thread_info *info);
732 int mdt_reint_unpack(struct mdt_thread_info *info, __u32 op);
733 void mdt_fix_lov_magic(struct mdt_thread_info *info, void *eadata);
734 int mdt_reint_rec(struct mdt_thread_info *, struct mdt_lock_handle *);
735 #ifdef CONFIG_FS_POSIX_ACL
736 int mdt_pack_acl2body(struct mdt_thread_info *info, struct mdt_body *repbody,
737 struct mdt_object *o, struct lu_nodemap *nodemap);
739 void mdt_pack_attr2body(struct mdt_thread_info *info, struct mdt_body *b,
740 const struct lu_attr *attr, const struct lu_fid *fid);
741 int mdt_pack_size2body(struct mdt_thread_info *info,
742 const struct lu_fid *fid, bool dom_lock);
743 int mdt_getxattr(struct mdt_thread_info *info);
744 int mdt_reint_setxattr(struct mdt_thread_info *info,
745 struct mdt_lock_handle *lh);
747 void mdt_lock_handle_init(struct mdt_lock_handle *lh);
748 void mdt_lock_handle_fini(struct mdt_lock_handle *lh);
750 void mdt_reconstruct(struct mdt_thread_info *, struct mdt_lock_handle *);
751 void mdt_reconstruct_generic(struct mdt_thread_info *mti,
752 struct mdt_lock_handle *lhc);
754 extern void target_recovery_fini(struct obd_device *obd);
755 extern void target_recovery_init(struct lu_target *lut,
756 svc_handler_t handler);
757 int mdt_fs_setup(const struct lu_env *, struct mdt_device *,
758 struct obd_device *, struct lustre_sb_info *lsi);
759 void mdt_fs_cleanup(const struct lu_env *, struct mdt_device *);
761 int mdt_export_stats_init(struct obd_device *obd,
762 struct obd_export *exp,
765 int mdt_lock_new_child(struct mdt_thread_info *info,
766 struct mdt_object *o,
767 struct mdt_lock_handle *child_lockh);
769 void mdt_mfd_set_mode(struct mdt_file_data *mfd,
772 int mdt_reint_open(struct mdt_thread_info *info,
773 struct mdt_lock_handle *lhc);
775 struct mdt_file_data *mdt_handle2mfd(struct mdt_export_data *med,
776 const struct lustre_handle *handle,
779 int mdt_get_info(struct tgt_session_info *tsi);
780 int mdt_attr_get_complex(struct mdt_thread_info *info,
781 struct mdt_object *o, struct md_attr *ma);
782 int mdt_big_xattr_get(struct mdt_thread_info *info, struct mdt_object *o,
784 int mdt_stripe_get(struct mdt_thread_info *info, struct mdt_object *o,
785 struct md_attr *ma, const char *name);
786 int mdt_write_get(struct mdt_object *o);
787 void mdt_write_put(struct mdt_object *o);
788 int mdt_write_read(struct mdt_object *o);
789 struct mdt_file_data *mdt_mfd_new(const struct mdt_export_data *med);
790 int mdt_mfd_close(struct mdt_thread_info *info, struct mdt_file_data *mfd);
791 void mdt_mfd_free(struct mdt_file_data *mfd);
792 int mdt_close(struct tgt_session_info *tsi);
793 int mdt_add_dirty_flag(struct mdt_thread_info *info, struct mdt_object *mo,
795 int mdt_fix_reply(struct mdt_thread_info *info);
796 int mdt_handle_last_unlink(struct mdt_thread_info *, struct mdt_object *,
798 void mdt_reconstruct_open(struct mdt_thread_info *, struct mdt_lock_handle *);
799 int mdt_layout_change(struct mdt_thread_info *info, struct mdt_object *obj,
800 struct md_layout_change *spec);
802 struct lu_buf *mdt_buf(const struct lu_env *env, void *area, ssize_t len);
803 const struct lu_buf *mdt_buf_const(const struct lu_env *env,
804 const void *area, ssize_t len);
806 void mdt_dump_lmm(int level, const struct lov_mds_md *lmm, __u64 valid);
807 void mdt_dump_lmv(unsigned int level, const union lmv_mds_md *lmv);
809 bool allow_client_chgrp(struct mdt_thread_info *info, struct lu_ucred *uc);
810 int mdt_check_ucred(struct mdt_thread_info *);
811 int mdt_init_ucred(struct mdt_thread_info *, struct mdt_body *);
812 int mdt_init_ucred_intent_getattr(struct mdt_thread_info *, struct mdt_body *);
813 int mdt_init_ucred_reint(struct mdt_thread_info *);
814 void mdt_exit_ucred(struct mdt_thread_info *);
815 int mdt_version_get_check(struct mdt_thread_info *, struct mdt_object *, int);
816 void mdt_version_get_save(struct mdt_thread_info *, struct mdt_object *, int);
817 int mdt_version_get_check_save(struct mdt_thread_info *, struct mdt_object *,
819 void mdt_thread_info_init(struct ptlrpc_request *req,
820 struct mdt_thread_info *mti);
821 void mdt_thread_info_fini(struct mdt_thread_info *mti);
822 struct mdt_thread_info *tsi2mdt_info(struct tgt_session_info *tsi);
823 void mdt_intent_fixup_resent(struct mdt_thread_info *info,
824 struct ldlm_lock *new_lock,
825 struct mdt_lock_handle *lh, __u64 flags);
826 int mdt_intent_lock_replace(struct mdt_thread_info *info,
827 struct ldlm_lock **lockp,
828 struct mdt_lock_handle *lh,
829 __u64 flags, int result);
831 int mdt_hsm_attr_set(struct mdt_thread_info *info, struct mdt_object *obj,
832 const struct md_hsm *mh);
834 int mdt_remote_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
835 void *data, int flag);
836 int mdt_links_read(struct mdt_thread_info *info,
837 struct mdt_object *mdt_obj,
838 struct linkea_data *ldata);
839 int mdt_close_internal(struct mdt_thread_info *info, struct ptlrpc_request *req,
840 struct mdt_body *repbody);
842 static inline struct mdt_device *mdt_dev(struct lu_device *d)
844 return container_of0(d, struct mdt_device, mdt_lu_dev);
847 static inline struct mdt_object *mdt_obj(struct lu_object *o)
849 return container_of0(o, struct mdt_object, mot_obj);
852 static inline struct dt_object *mdt_obj2dt(struct mdt_object *mo)
854 struct lu_object *lo;
855 struct mdt_device *mdt = mdt_dev(mo->mot_obj.lo_dev);
857 lo = lu_object_locate(mo->mot_obj.lo_header,
858 mdt->mdt_bottom->dd_lu_dev.ld_type);
863 static inline bool agent_req_in_final_state(enum agent_req_status ars)
865 return ((ars == ARS_SUCCEED) || (ars == ARS_FAILED) ||
866 (ars == ARS_CANCELED));
869 /* mdt/mdt_identity.c */
870 #define MDT_IDENTITY_UPCALL_PATH "/usr/sbin/l_getidentity"
872 extern struct upcall_cache_ops mdt_identity_upcall_cache_ops;
874 struct md_identity *mdt_identity_get(struct upcall_cache *, __u32);
876 void mdt_identity_put(struct upcall_cache *, struct md_identity *);
878 void mdt_flush_identity(struct upcall_cache *, int);
880 __u32 mdt_identity_get_perm(struct md_identity *, lnet_nid_t);
882 /* mdt/mdt_recovery.c */
883 __u64 mdt_req_from_lrd(struct ptlrpc_request *req, struct tg_reply_data *trd);
886 int mdt_hsm_state_get(struct tgt_session_info *tsi);
887 int mdt_hsm_state_set(struct tgt_session_info *tsi);
888 int mdt_hsm_action(struct tgt_session_info *tsi);
889 int mdt_hsm_progress(struct tgt_session_info *tsi);
890 int mdt_hsm_ct_register(struct tgt_session_info *tsi);
891 int mdt_hsm_ct_unregister(struct tgt_session_info *tsi);
892 int mdt_hsm_request(struct tgt_session_info *tsi);
894 /* mdt/mdt_hsm_cdt_actions.c */
895 extern const struct file_operations mdt_hsm_actions_fops;
896 void dump_llog_agent_req_rec(const char *prefix,
897 const struct llog_agent_req_rec *larr);
898 int cdt_llog_process(const struct lu_env *env, struct mdt_device *mdt,
899 llog_cb_t cb, void *data, u32 start_cat_idx,
900 u32 start_rec_idx, int rw);
901 int mdt_agent_record_add(const struct lu_env *env, struct mdt_device *mdt,
902 __u64 compound_id, __u32 archive_id,
903 __u64 flags, struct hsm_action_item *hai);
904 int mdt_agent_record_update(const struct lu_env *env, struct mdt_device *mdt,
905 struct hsm_record_update *updates,
906 unsigned int updates_count);
907 void cdt_agent_record_hash_add(struct coordinator *cdt, u64 cookie, u32 cat_idt,
909 void cdt_agent_record_hash_lookup(struct coordinator *cdt, u64 cookie,
910 u32 *cat_idt, u32 *rec_idx);
911 void cdt_agent_record_hash_del(struct coordinator *cdt, u64 cookie);
913 /* mdt/mdt_hsm_cdt_agent.c */
914 extern const struct file_operations mdt_hsm_agent_fops;
915 int mdt_hsm_agent_register(struct mdt_thread_info *info,
916 const struct obd_uuid *uuid,
917 int nr_archives, __u32 *archive_num);
918 int mdt_hsm_agent_register_mask(struct mdt_thread_info *info,
919 const struct obd_uuid *uuid,
921 int mdt_hsm_agent_unregister(struct mdt_thread_info *info,
922 const struct obd_uuid *uuid);
923 int mdt_hsm_agent_update_statistics(struct coordinator *cdt,
924 int succ_rq, int fail_rq, int new_rq,
925 const struct obd_uuid *uuid);
926 int mdt_hsm_find_best_agent(struct coordinator *cdt, __u32 archive,
927 struct obd_uuid *uuid);
928 int mdt_hsm_agent_send(struct mdt_thread_info *mti, struct hsm_action_list *hal,
930 int hsm_cancel_agent_requests(struct mdt_device *mdt,
931 const struct obd_uuid *uuid);
932 int mdt_hsm_coordinator_update(struct mdt_thread_info *mti,
933 struct hsm_progress_kernel *pgs);
934 /* mdt/mdt_hsm_cdt_client.c */
935 int mdt_hsm_add_actions(struct mdt_thread_info *info,
936 struct hsm_action_list *hal);
937 int mdt_hsm_get_actions(struct mdt_thread_info *mti,
938 struct hsm_action_list *hal);
939 bool mdt_hsm_restore_is_running(struct mdt_thread_info *mti,
940 const struct lu_fid *fid);
941 /* mdt/mdt_hsm_cdt_requests.c */
942 extern struct cfs_hash_ops cdt_request_cookie_hash_ops;
943 extern struct cfs_hash_ops cdt_agent_record_hash_ops;
944 extern const struct file_operations mdt_hsm_active_requests_fops;
945 void dump_requests(char *prefix, struct coordinator *cdt);
946 struct cdt_agent_req *mdt_cdt_alloc_request(__u64 compound_id, __u32 archive_id,
947 __u64 flags, struct obd_uuid *uuid,
948 struct hsm_action_item *hai);
949 void mdt_cdt_free_request(struct cdt_agent_req *car);
950 int mdt_cdt_add_request(struct coordinator *cdt, struct cdt_agent_req *new_car);
951 struct cdt_agent_req *mdt_cdt_find_request(struct coordinator *cdt, u64 cookie);
952 void mdt_cdt_get_work_done(struct cdt_agent_req *car, __u64 *done_sz);
953 void mdt_cdt_get_request(struct cdt_agent_req *car);
954 void mdt_cdt_put_request(struct cdt_agent_req *car);
955 struct cdt_agent_req *mdt_cdt_update_request(struct coordinator *cdt,
956 const struct hsm_progress_kernel *pgs);
957 int mdt_cdt_remove_request(struct coordinator *cdt, __u64 cookie);
958 /* mdt/mdt_coordinator.c */
959 void mdt_hsm_dump_hal(int level, const char *prefix,
960 struct hsm_action_list *hal);
961 struct cdt_restore_handle *mdt_hsm_restore_hdl_find(struct coordinator *cdt,
962 const struct lu_fid *fid);
963 /* coordinator management */
964 int mdt_hsm_cdt_init(struct mdt_device *mdt);
965 int mdt_hsm_cdt_stop(struct mdt_device *mdt);
966 int mdt_hsm_cdt_fini(struct mdt_device *mdt);
969 * Signal the coordinator has work to do
970 * \param cdt [IN] coordinator
972 static inline void mdt_hsm_cdt_event(struct coordinator *cdt)
974 cdt->cdt_event = true;
977 /* coordinator control /proc interface */
978 ssize_t mdt_hsm_cdt_control_seq_write(struct file *file,
979 const char __user *buffer,
980 size_t count, loff_t *off);
981 int mdt_hsm_cdt_control_seq_show(struct seq_file *m, void *data);
982 int hsm_cdt_procfs_init(struct mdt_device *mdt);
983 void hsm_cdt_procfs_fini(struct mdt_device *mdt);
984 struct lprocfs_vars *hsm_cdt_get_proc_vars(void);
986 struct mdt_object *mdt_hsm_get_md_hsm(struct mdt_thread_info *mti,
987 const struct lu_fid *fid,
989 /* actions/request helpers */
990 int mdt_hsm_add_hal(struct mdt_thread_info *mti,
991 struct hsm_action_list *hal, struct obd_uuid *uuid);
992 bool mdt_hsm_is_action_compat(const struct hsm_action_item *hai,
993 u32 archive_id, u64 rq_flags,
994 const struct md_hsm *hsm);
995 int mdt_hsm_update_request_state(struct mdt_thread_info *mti,
996 struct hsm_progress_kernel *pgs,
997 const int update_record);
999 int mdt_close_swap_layouts(struct mdt_thread_info *info,
1000 struct mdt_object *o, struct md_attr *ma);
1002 extern struct lu_context_key mdt_thread_key;
1004 /* debug issues helper starts here*/
1005 static inline int mdt_fail_write(const struct lu_env *env,
1006 struct dt_device *dd, int id)
1008 if (OBD_FAIL_CHECK_ORSET(id, OBD_FAIL_ONCE)) {
1009 CERROR(LUSTRE_MDT_NAME": cfs_fail_loc=%x, fail write ops\n",
1011 return dt_ro(env, dd);
1012 /* We set FAIL_ONCE because we never "un-fail" a device */
1018 static inline struct mdt_export_data *mdt_req2med(struct ptlrpc_request *req)
1020 return &req->rq_export->exp_mdt_data;
1023 static inline struct mdt_device *mdt_exp2dev(struct obd_export *exp)
1025 return mdt_dev(exp->exp_obd->obd_lu_dev);
1028 static inline bool mdt_rdonly(struct obd_export *exp)
1030 if (exp_connect_flags(exp) & OBD_CONNECT_RDONLY ||
1031 mdt_exp2dev(exp)->mdt_bottom->dd_rdonly)
1036 typedef void (*mdt_reconstruct_t)(struct mdt_thread_info *mti,
1037 struct mdt_lock_handle *lhc);
1038 static inline int mdt_check_resent(struct mdt_thread_info *info,
1039 mdt_reconstruct_t reconstruct,
1040 struct mdt_lock_handle *lhc)
1042 struct ptlrpc_request *req = mdt_info_req(info);
1046 if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) {
1047 OBD_ALLOC_PTR(info->mti_reply_data);
1048 if (info->mti_reply_data == NULL)
1051 if (req_can_reconstruct(req, info->mti_reply_data)) {
1052 reconstruct(info, lhc);
1055 DEBUG_REQ(D_HA, req,
1056 "no reply data found for RESENT req");
1059 OBD_FREE_PTR(info->mti_reply_data);
1060 info->mti_reply_data = NULL;
1065 struct lu_ucred *mdt_ucred(const struct mdt_thread_info *info);
1066 struct lu_ucred *mdt_ucred_check(const struct mdt_thread_info *info);
1068 static inline int is_identity_get_disabled(struct upcall_cache *cache)
1070 return cache ? (strcmp(cache->uc_upcall, "NONE") == 0) : 1;
1073 int mdt_blocking_ast(struct ldlm_lock*, struct ldlm_lock_desc*, void*, int);
1075 static int mdt_dom_glimpse_ast(struct ldlm_lock *lock, void *reqp)
1077 return -ELDLM_NO_LOCK_DATA;
1080 /* Issues dlm lock on passed @ns, @f stores it lock handle into @lh. */
1081 static inline int mdt_fid_lock(struct ldlm_namespace *ns,
1082 struct lustre_handle *lh, enum ldlm_mode mode,
1083 union ldlm_policy_data *policy,
1084 const struct ldlm_res_id *res_id,
1085 __u64 flags, const __u64 *client_cookie)
1088 bool glimpse = policy->l_inodebits.bits & MDS_INODELOCK_DOM;
1090 LASSERT(ns != NULL);
1091 LASSERT(lh != NULL);
1093 rc = ldlm_cli_enqueue_local(ns, res_id, LDLM_IBITS, policy,
1094 mode, &flags, mdt_blocking_ast,
1095 ldlm_completion_ast,
1096 glimpse ? mdt_dom_glimpse_ast : NULL,
1097 NULL, 0, LVB_T_NONE, client_cookie, lh);
1098 return rc == ELDLM_OK ? 0 : -EIO;
1101 static inline void mdt_fid_unlock(struct lustre_handle *lh, enum ldlm_mode mode)
1103 ldlm_lock_decref(lh, mode);
1106 static inline bool mdt_slc_is_enabled(struct mdt_device *mdt)
1108 return mdt->mdt_lut.lut_sync_lock_cancel == BLOCKING_SYNC_ON_CANCEL;
1111 extern mdl_mode_t mdt_mdl_lock_modes[];
1112 extern enum ldlm_mode mdt_dlm_lock_modes[];
1114 /* LCK_MINMODE which is zero returns false for is_power_of_2 */
1116 static inline mdl_mode_t mdt_dlm_mode2mdl_mode(enum ldlm_mode mode)
1118 LASSERT(mode == LCK_MINMODE || is_power_of_2(mode));
1119 return mdt_mdl_lock_modes[mode];
1122 static inline enum ldlm_mode mdt_mdl_mode2dlm_mode(mdl_mode_t mode)
1124 LASSERT(mode == MDL_MINMODE || is_power_of_2(mode));
1125 return mdt_dlm_lock_modes[mode];
1129 int mdt_set_som(struct mdt_thread_info *info, struct mdt_object *obj,
1130 struct lu_attr *attr);
1131 int mdt_get_som(struct mdt_thread_info *info, struct mdt_object *obj,
1132 struct lu_attr *attr);
1135 extern struct ldlm_valblock_ops mdt_lvbo;
1136 int mdt_dom_lvb_is_valid(struct ldlm_resource *res);
1137 int mdt_dom_lvbo_update(struct ldlm_resource *res, struct ldlm_lock *lock,
1138 struct ptlrpc_request *req, bool increase_only);
1140 void mdt_enable_cos(struct mdt_device *, int);
1141 int mdt_cos_is_enabled(struct mdt_device *);
1159 LPROC_MDT_SAMEDIR_RENAME,
1160 LPROC_MDT_CROSSDIR_RENAME,
1166 void mdt_counter_incr(struct ptlrpc_request *req, int opcode);
1167 void mdt_stats_counter_init(struct lprocfs_stats *stats);
1168 int mdt_procfs_init(struct mdt_device *mdt, const char *name);
1169 void mdt_procfs_fini(struct mdt_device *mdt);
1171 /* lustre/mdt_mdt_lproc.c */
1172 int lprocfs_mdt_open_files_seq_open(struct inode *inode,
1174 void mdt_rename_counter_tally(struct mdt_thread_info *info,
1175 struct mdt_device *mdt,
1176 struct ptlrpc_request *req,
1177 struct mdt_object *src, struct mdt_object *tgt);
1179 static inline struct obd_device *mdt2obd_dev(const struct mdt_device *mdt)
1181 return mdt->mdt_lu_dev.ld_obd;
1184 extern const struct lu_device_operations mdt_lu_ops;
1186 static inline char *mdt_obd_name(struct mdt_device *mdt)
1188 return mdt->mdt_lu_dev.ld_obd->obd_name;
1191 int mds_mod_init(void);
1192 void mds_mod_exit(void);
1194 static inline char *mdt_req_get_jobid(struct ptlrpc_request *req)
1196 struct obd_export *exp = req->rq_export;
1199 if (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS)
1200 jobid = lustre_msg_get_jobid(req->rq_reqmsg);
1207 #define VALID_FLAGS (LA_TYPE | LA_MODE | LA_SIZE | LA_BLOCKS | \
1208 LA_BLKSIZE | LA_ATIME | LA_MTIME | LA_CTIME)
1210 int mdt_obd_preprw(const struct lu_env *env, int cmd, struct obd_export *exp,
1211 struct obdo *oa, int objcount, struct obd_ioobj *obj,
1212 struct niobuf_remote *rnb, int *nr_local,
1213 struct niobuf_local *lnb);
1215 int mdt_obd_commitrw(const struct lu_env *env, int cmd, struct obd_export *exp,
1216 struct obdo *oa, int objcount, struct obd_ioobj *obj,
1217 struct niobuf_remote *rnb, int npages,
1218 struct niobuf_local *lnb, int old_rc);
1219 int mdt_punch_hdl(struct tgt_session_info *tsi);
1220 int mdt_glimpse_enqueue(struct mdt_thread_info *mti, struct ldlm_namespace *ns,
1221 struct ldlm_lock **lockp, __u64 flags);
1222 int mdt_brw_enqueue(struct mdt_thread_info *info, struct ldlm_namespace *ns,
1223 struct ldlm_lock **lockp, __u64 flags);
1224 void mdt_dom_discard_data(struct mdt_thread_info *info,
1225 const struct lu_fid *fid);
1226 int mdt_dom_disk_lvbo_update(const struct lu_env *env, struct mdt_object *mo,
1227 struct ldlm_resource *res, bool increase_only);
1228 void mdt_dom_obj_lvb_update(const struct lu_env *env, struct mdt_object *mo,
1229 bool increase_only);
1230 int mdt_dom_lvb_alloc(struct ldlm_resource *res);
1232 static inline void mdt_dom_check_and_discard(struct mdt_thread_info *mti,
1233 struct mdt_object *mo)
1235 if (lu_object_is_dying(&mo->mot_header) &&
1236 S_ISREG(lu_object_attr(&mo->mot_obj)))
1237 mdt_dom_discard_data(mti, mdt_object_fid(mo));
1240 int mdt_dom_object_size(const struct lu_env *env, struct mdt_device *mdt,
1241 const struct lu_fid *fid, struct mdt_body *mb,
1243 bool mdt_dom_client_has_lock(struct mdt_thread_info *info,
1244 const struct lu_fid *fid);
1246 long mdt_grant_connect(const struct lu_env *env, struct obd_export *exp,
1247 u64 want, bool conservative);
1248 extern struct kmem_cache *ldlm_glimpse_work_kmem;
1250 #endif /* _MDT_INTERNAL_H */