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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/mdt/mdt_internal.h
38 * Lustre Metadata Target (mdt) request handler
40 * Author: Peter Braam <braam@clusterfs.com>
41 * Author: Andreas Dilger <adilger@clusterfs.com>
42 * Author: Phil Schwan <phil@clusterfs.com>
43 * Author: Mike Shaver <shaver@clusterfs.com>
44 * Author: Nikita Danilov <nikita@clusterfs.com>
45 * Author: Huang Hua <huanghua@clusterfs.com>
48 #ifndef _MDT_INTERNAL_H
49 #define _MDT_INTERNAL_H
51 #if defined(__KERNEL__)
53 #include <lustre_net.h>
54 #include <lustre/lustre_idl.h>
55 #include <obd_class.h>
56 #include <lustre_disk.h>
57 #include <lu_target.h>
58 #include <md_object.h>
59 #include <lustre_fid.h>
60 #include <lustre_fld.h>
61 #include <lustre_req_layout.h>
62 #include <lustre_sec.h>
63 #include <lustre_idmap.h>
64 #include <lustre_eacl.h>
65 #include <lustre_quota.h>
67 /* check if request's xid is equal to last one or not*/
68 static inline int req_xid_is_last(struct ptlrpc_request *req)
70 struct lsd_client_data *lcd = req->rq_export->exp_target_data.ted_lcd;
71 return (req->rq_xid == lcd->lcd_last_xid ||
72 req->rq_xid == lcd->lcd_last_close_xid);
77 /* file data for open files on MDS */
78 struct mdt_file_data {
79 struct portals_handle mfd_handle; /* must be first */
80 __u64 mfd_mode; /* open mode provided by client */
81 cfs_list_t mfd_list; /* protected by med_open_lock */
82 __u64 mfd_xid; /* xid of the open request */
83 struct lustre_handle mfd_old_handle; /* old handle in replay case */
84 struct mdt_object *mfd_object; /* point to opened object */
87 #define CDT_NONBLOCKING_RESTORE 0x0000000000000001ULL
88 #define CDT_NORETRY_ACTION 0x0000000000000002ULL
89 #define CDT_POLICY_MASK CDT_NONBLOCKING_RESTORE | \
92 /* when adding a new policy, do not forget to update
93 * lustre/mdt/mdt_coordinator.c::hsm_policy_names[]
95 #define CDT_DEFAULT_POLICY CDT_NORETRY_ACTION
97 enum cdt_states { CDT_STOPPED = 0,
103 /* when multiple lock are needed, the lock order is
111 struct ptlrpc_thread cdt_thread; /**< coordinator thread */
112 struct lu_env cdt_env; /**< coordinator lustre
114 struct lu_context cdt_session; /** session for lu_ucred */
115 struct proc_dir_entry *cdt_proc_dir; /**< cdt /proc directory */
116 __u64 cdt_policy; /**< flags to defined
118 enum cdt_states cdt_state; /**< state */
119 atomic_t cdt_compound_id; /**< compound id counter */
120 __u64 cdt_last_cookie; /**< last cookie allocated */
121 struct mutex cdt_llog_lock; /**< protect llog access */
122 struct rw_semaphore cdt_agent_lock; /**< protect agent list */
123 struct rw_semaphore cdt_request_lock; /**< protect request list */
124 struct mutex cdt_restore_lock; /**< protect restore list */
125 cfs_time_t cdt_loop_period; /**< llog scan period */
126 cfs_time_t cdt_delay; /**< request grace delay */
127 cfs_time_t cdt_timeout; /**< request timeout */
128 __u32 cdt_archive_id; /** archive id used when
129 * none are specified */
130 __u64 cdt_max_request; /**< max count of started
132 atomic_t cdt_request_count; /**< current count of
133 * started requests */
134 struct list_head cdt_requests; /**< list of started
136 struct list_head cdt_agents; /**< list of register
138 struct list_head cdt_restore_hdl; /**< list of restore lock
142 /* mdt state flag bits */
143 #define MDT_FL_CFGLOG 0
144 #define MDT_FL_SYNCED 1
148 struct lu_device mdt_lu_dev;
149 struct seq_server_site mdt_seq_site;
150 /* DLM name-space for meta-data locks maintained by this server */
151 struct ldlm_namespace *mdt_namespace;
152 /* ptlrpc handle for MDS->client connections (for lock ASTs). */
153 struct ptlrpc_client *mdt_ldlm_client;
154 /* underlying device */
155 struct obd_export *mdt_child_exp;
156 struct md_device *mdt_child;
157 struct dt_device *mdt_bottom;
158 struct obd_export *mdt_bottom_exp;
160 struct lu_target mdt_lut;
162 * Options bit-fields.
165 unsigned int mo_user_xattr:1,
173 /* mdt state flags */
174 unsigned long mdt_state;
175 /* lock to protect IOepoch */
176 spinlock_t mdt_ioepoch_lock;
179 /* transaction callbacks */
180 struct dt_txn_callback mdt_txn_cb;
182 /* these values should be updated from lov if necessary.
183 * or should be placed somewhere else. */
185 int mdt_max_cookiesize;
189 struct upcall_cache *mdt_identity_cache;
192 rwlock_t mdt_sptlrpc_lock;
193 struct sptlrpc_rule_set mdt_sptlrpc_rset;
195 /* capability keys */
196 unsigned long mdt_capa_timeout;
198 struct dt_object *mdt_ck_obj;
199 unsigned long mdt_ck_timeout;
200 unsigned long mdt_ck_expiry;
201 cfs_timer_t mdt_ck_timer;
202 struct ptlrpc_thread mdt_ck_thread;
203 struct lustre_capa_key mdt_capa_keys[2];
204 unsigned int mdt_capa_conf:1,
206 /* Enable remote dir on non-MDT0 */
207 mdt_enable_remote_dir:1;
209 gid_t mdt_enable_remote_dir_gid;
210 /* statfs optimization: we cache a bit */
211 struct obd_statfs mdt_osfs;
213 spinlock_t mdt_osfs_lock;
216 uid_t mdt_squash_uid;
217 gid_t mdt_squash_gid;
218 cfs_list_t mdt_nosquash_nids;
219 char *mdt_nosquash_str;
220 int mdt_nosquash_strlen;
221 struct rw_semaphore mdt_squash_sem;
224 struct rename_stats mdt_rename_stats;
225 struct lu_fid mdt_md_root_fid;
227 /* connection to quota master */
228 struct obd_export *mdt_qmt_exp;
229 /* quota master device associated with this MDT */
230 struct lu_device *mdt_qmt_dev;
232 struct coordinator mdt_coordinator;
235 #define MDT_SERVICE_WATCHDOG_FACTOR (2)
236 #define MDT_ROCOMPAT_SUPP (OBD_ROCOMPAT_LOVOBJID)
237 #define MDT_INCOMPAT_SUPP (OBD_INCOMPAT_MDT | OBD_INCOMPAT_COMMON_LR | \
238 OBD_INCOMPAT_FID | OBD_INCOMPAT_IAM_DIR | \
239 OBD_INCOMPAT_LMM_VER | OBD_INCOMPAT_MULTI_OI)
240 #define MDT_COS_DEFAULT (0)
243 struct lu_object_header mot_header;
244 struct lu_object mot_obj;
247 int mot_ioepoch_count;
249 /* Lock to protect object's IO epoch. */
250 struct mutex mot_ioepoch_mutex;
251 /* Lock to protect create_data */
252 struct mutex mot_lov_mutex;
253 /* Lock to protect lease open.
254 * Lease open acquires write lock; normal open acquires read lock */
255 struct rw_semaphore mot_open_sem;
256 atomic_t mot_lease_count;
257 atomic_t mot_open_count;
258 /* A lock to protect EA data from racing setxattr and getxattrall */
259 struct rw_semaphore mot_xattr_sem;
262 enum mdt_object_flags {
263 /** SOM attributes are changed. */
264 MOF_SOM_CHANGE = (1 << 0),
266 * The SOM recovery state for mdt object.
267 * This state is an in-memory equivalent of an absent SOM EA, used
268 * instead of invalidating SOM EA while IOEpoch is still opened when
269 * a client eviction occurs or a client fails to obtain SOM attributes.
270 * It indicates that the last IOEpoch holder will need to obtain SOM
271 * attributes under [0;EOF] extent lock to flush all the client's
272 * cached of evicted from MDS clients (but not necessary evicted from
273 * OST) before taking ost attributes.
275 MOF_SOM_RECOV = (1 << 1),
276 /** File has been just created. */
277 MOF_SOM_CREATED = (1 << 2),
278 /** lov object has been created. */
279 MOF_LOV_CREATED = (1 << 3),
282 struct mdt_lock_handle {
283 /* Lock type, reg for cross-ref use or pdo lock. */
287 struct lustre_handle mlh_reg_lh;
288 ldlm_mode_t mlh_reg_mode;
291 struct lustre_handle mlh_pdo_lh;
292 ldlm_mode_t mlh_pdo_mode;
293 unsigned int mlh_pdo_hash;
295 /* Remote regular lock */
296 struct lustre_handle mlh_rreg_lh;
297 ldlm_mode_t mlh_rreg_mode;
301 MDT_LH_PARENT, /* parent lockh */
302 MDT_LH_CHILD, /* child lockh */
303 MDT_LH_OLD, /* old lockh for rename */
304 MDT_LH_LAYOUT = MDT_LH_OLD, /* layout lock */
305 MDT_LH_NEW, /* new lockh for rename */
306 MDT_LH_RMT, /* used for return lh to caller */
307 MDT_LH_LOCAL, /* local lock never return to client */
316 struct mdt_reint_record {
317 mdt_reint_t rr_opcode;
318 const struct lustre_handle *rr_handle;
319 const struct lu_fid *rr_fid1;
320 const struct lu_fid *rr_fid2;
325 const void *rr_eadata;
328 const struct llog_cookie *rr_logcookies;
332 enum mdt_reint_flag {
333 MRF_OPEN_TRUNC = 1 << 0,
336 struct mdt_thread_info;
338 typedef int (*tx_exec_func_t)(const struct lu_env *, struct thandle *,
342 tx_exec_func_t exec_fn;
343 tx_exec_func_t undo_fn;
344 struct dt_object *object;
346 struct update_reply *reply;
351 const struct dt_rec *rec;
352 const struct dt_key *key;
367 struct dt_allocation_hint hint;
368 struct dt_object_format dof;
376 struct ost_body *body;
381 #define TX_MAX_OPS 10
382 struct thandle_exec_args {
383 struct thandle *ta_handle;
384 struct dt_device *ta_dev;
386 struct tx_arg ta_args[TX_MAX_OPS];
387 int ta_argno; /* used args */
391 * Common data shared by mdt-level handlers. This is allocated per-thread to
392 * reduce stack consumption.
394 struct mdt_thread_info {
397 * The following members will be filled explicitly
398 * with specific data in mdt_thread_info_init().
400 /* TODO: move this into mdt_session_key(with LCT_SESSION), because
401 * request handling may migrate from one server thread to another.
403 struct req_capsule *mti_pill;
405 /* although we have export in req, there are cases when it is not
406 * available, e.g. closing files upon export destroy */
407 struct obd_export *mti_exp;
409 * A couple of lock handles.
411 struct mdt_lock_handle mti_lh[MDT_LH_NR];
413 struct mdt_device *mti_mdt;
414 const struct lu_env *mti_env;
415 /* XXX: temporary flag to have healthy mti during OUT calls
416 * to be removed upon moving MDT to the unified target code */
420 * Additional fail id that can be set by handler. Passed to
421 * target_send_reply().
425 /* transaction number of current request */
431 * The following members will be filled expilictly
432 * with zero in mdt_thread_info_init(). These members may be used
439 struct md_attr mti_attr;
441 * Body for "habeo corpus" operations.
443 const struct mdt_body *mti_body;
445 * Host object. This is released at the end of mdt_handler().
447 struct mdt_object *mti_object;
449 * Lock request for "habeo clavis" operations.
451 const struct ldlm_request *mti_dlm_req;
453 __u32 mti_has_trans:1, /* has txn already? */
456 /* opdata for mdt_reint_open(), has the same as
457 * ldlm_reply:lock_policy_res1. mdt_update_last_rcvd() stores this
458 * value onto disk for recovery when mdt_trans_stop_cb() is called.
464 * The following members will be filled explicitly
465 * with zero in mdt_reint_unpack(), because they are only used
466 * by reint requests (including mdt_reint_open()).
470 * reint record. contains information for reint operations.
472 struct mdt_reint_record mti_rr;
474 /** md objects included in operation */
475 struct mdt_object *mti_mos;
476 __u64 mti_ver[PTLRPC_NUM_VERSIONS];
478 * Operation specification (currently create and lookup)
480 struct md_op_spec mti_spec;
484 * The following members will _NOT_ be initialized at all.
485 * DO NOT expect them to contain any valid value.
486 * They should be initialized explicitly by the user themselves.
489 /* XXX: If something is in a union, make sure they do not conflict */
491 struct lu_fid mti_tmp_fid1;
492 struct lu_fid mti_tmp_fid2;
493 ldlm_policy_data_t mti_policy; /* for mdt_object_lock() and
494 * mdt_rename_lock() */
495 struct ldlm_res_id mti_res_id; /* for mdt_object_lock() and
498 struct obd_uuid uuid[2]; /* for mdt_seq_init_cli() */
499 char ns_name[48]; /* for mdt_init0() */
500 struct lustre_cfg_bufs bufs; /* for mdt_stack_fini() */
501 struct obd_statfs osfs; /* for mdt_statfs() */
503 /* for mdt_readpage() */
504 struct lu_rdpg mti_rdpg;
505 /* for mdt_sendpage() */
506 struct l_wait_info mti_wait_info;
510 struct md_som_data data;
513 struct dt_object_format mti_update_dof;
514 struct update_reply *mti_update_reply;
515 struct update *mti_update;
516 int mti_update_reply_index;
517 struct obdo mti_obdo;
518 struct dt_object *mti_dt_object;
522 /* IO epoch related stuff. */
523 struct mdt_ioepoch *mti_ioepoch;
524 __u64 mti_replayepoch;
527 struct lu_buf mti_buf;
528 struct lu_buf mti_big_buf;
529 struct lustre_capa_key mti_capa_key;
531 /* Ops object filename */
532 struct lu_name mti_name;
533 /* per-thread values, can be re-used */
536 /* big_lmm buffer was used and must be used in reply */
537 int mti_big_lmm_used;
538 /* should be enough to fit lustre_mdt_attrs */
539 char mti_xattr_buf[128];
540 struct thandle_exec_args mti_handle;
541 struct ldlm_enqueue_info mti_einfo;
544 /* ptlrpc request handler for MDT. All handlers are
545 * grouped into several slices - struct mdt_opc_slice,
546 * and stored in an array - mdt_handlers[].
549 /* The name of this handler. */
551 /* Fail id for this handler, checked at the beginning of this handler*/
553 /* Operation code for this handler */
555 /* flags are listed in enum mdt_handler_flags below. */
557 /* The actual handler function to execute. */
558 int (*mh_act)(struct mdt_thread_info *info);
559 /* Request format for this request. */
560 const struct req_format *mh_fmt;
563 struct mdt_opc_slice {
566 struct mdt_handler *mos_hs;
569 struct cdt_req_progress {
570 struct mutex crp_lock; /**< protect tree */
571 struct interval_node *crp_root; /**< tree to track extent
573 struct interval_node **crp_node; /**< buffer for tree nodes
574 * vector of fixed size
576 int crp_cnt; /**< # of used nodes */
577 int crp_max; /**< # of allocated nodes */
580 struct cdt_agent_req {
581 cfs_list_t car_request_list; /**< to chain all the req. */
582 atomic_t car_refcount; /**< reference counter */
583 __u64 car_compound_id; /**< compound id */
584 __u64 car_flags; /**< request original flags */
585 struct obd_uuid car_uuid; /**< agent doing the req. */
586 __u32 car_archive_id; /**< archive id */
587 int car_canceled; /**< request was canceled */
588 cfs_time_t car_req_start; /**< start time */
589 cfs_time_t car_req_update; /**< last update time */
590 struct hsm_action_item *car_hai; /**< req. to the agent */
591 struct cdt_req_progress car_progress; /**< track data mvt
594 extern struct kmem_cache *mdt_hsm_car_kmem;
597 cfs_list_t ha_list; /**< to chain the agents */
598 struct obd_uuid ha_uuid; /**< agent uuid */
599 __u32 *ha_archive_id; /**< archive id */
600 int ha_archive_cnt; /**< number of archive entries
601 * 0 means any archive */
602 atomic_t ha_requests; /**< current request count */
603 atomic_t ha_success; /**< number of successful
605 atomic_t ha_failure; /**< number of failed actions */
608 struct cdt_restore_handle {
609 cfs_list_t crh_list; /**< to chain the handle */
610 struct lu_fid crh_fid; /**< fid of the object */
611 struct ldlm_extent crh_extent; /**< extent of the restore */
612 struct mdt_lock_handle crh_lh; /**< lock handle */
614 extern struct kmem_cache *mdt_hsm_cdt_kmem; /** restore handle slab cache */
616 static inline const struct md_device_operations *
617 mdt_child_ops(struct mdt_device * m)
619 LASSERT(m->mdt_child);
620 return m->mdt_child->md_ops;
623 static inline struct md_object *mdt_object_child(struct mdt_object *o)
626 return lu2md(lu_object_next(&o->mot_obj));
629 static inline struct ptlrpc_request *mdt_info_req(struct mdt_thread_info *info)
631 return info->mti_pill ? info->mti_pill->rc_req : NULL;
634 static inline __u64 mdt_conn_flags(struct mdt_thread_info *info)
636 LASSERT(info->mti_exp);
637 return exp_connect_flags(info->mti_exp);
640 static inline void mdt_object_get(const struct lu_env *env,
641 struct mdt_object *o)
644 lu_object_get(&o->mot_obj);
648 static inline void mdt_object_put(const struct lu_env *env,
649 struct mdt_object *o)
652 lu_object_put(env, &o->mot_obj);
656 static inline int mdt_object_exists(const struct mdt_object *o)
658 return lu_object_exists(&o->mot_obj);
661 static inline int mdt_object_remote(const struct mdt_object *o)
663 return lu_object_remote(&o->mot_obj);
666 static inline const struct lu_fid *mdt_object_fid(const struct mdt_object *o)
668 return lu_object_fid(&o->mot_obj);
671 static inline struct lu_site *mdt_lu_site(const struct mdt_device *mdt)
673 return mdt->mdt_lu_dev.ld_site;
676 static inline struct seq_server_site *mdt_seq_site(struct mdt_device *mdt)
678 return &mdt->mdt_seq_site;
681 static inline void mdt_export_evict(struct obd_export *exp)
683 class_fail_export(exp);
684 class_export_put(exp);
687 /* Here we use LVB_TYPE to check dne client, because it is
688 * also landed on 2.4. */
689 static inline int mdt_is_dne_client(struct obd_export *exp)
691 return !!(exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE);
694 int mdt_get_disposition(struct ldlm_reply *rep, int flag);
695 void mdt_set_disposition(struct mdt_thread_info *info,
696 struct ldlm_reply *rep, int flag);
697 void mdt_clear_disposition(struct mdt_thread_info *info,
698 struct ldlm_reply *rep, int flag);
700 void mdt_lock_pdo_init(struct mdt_lock_handle *lh,
701 ldlm_mode_t lm, const char *name,
704 void mdt_lock_reg_init(struct mdt_lock_handle *lh,
707 int mdt_lock_setup(struct mdt_thread_info *info,
708 struct mdt_object *o,
709 struct mdt_lock_handle *lh);
711 int mdt_object_lock(struct mdt_thread_info *,
713 struct mdt_lock_handle *,
716 int mdt_object_lock_try(struct mdt_thread_info *,
718 struct mdt_lock_handle *,
721 void mdt_object_unlock(struct mdt_thread_info *,
723 struct mdt_lock_handle *,
726 struct mdt_object *mdt_object_new(const struct lu_env *,
728 const struct lu_fid *);
729 struct mdt_object *mdt_object_find(const struct lu_env *,
731 const struct lu_fid *);
732 struct mdt_object *mdt_object_find_lock(struct mdt_thread_info *,
733 const struct lu_fid *,
734 struct mdt_lock_handle *,
736 void mdt_object_unlock_put(struct mdt_thread_info *,
738 struct mdt_lock_handle *,
741 void mdt_client_compatibility(struct mdt_thread_info *info);
743 int mdt_remote_object_lock(struct mdt_thread_info *mti,
744 struct mdt_object *o, struct lustre_handle *lh,
745 ldlm_mode_t mode, __u64 ibits);
746 int mdt_close_unpack(struct mdt_thread_info *info);
747 int mdt_reint_unpack(struct mdt_thread_info *info, __u32 op);
748 int mdt_reint_rec(struct mdt_thread_info *, struct mdt_lock_handle *);
749 void mdt_pack_attr2body(struct mdt_thread_info *info, struct mdt_body *b,
750 const struct lu_attr *attr, const struct lu_fid *fid);
752 int mdt_getxattr(struct mdt_thread_info *info);
753 int mdt_reint_setxattr(struct mdt_thread_info *info,
754 struct mdt_lock_handle *lh);
756 void mdt_lock_handle_init(struct mdt_lock_handle *lh);
757 void mdt_lock_handle_fini(struct mdt_lock_handle *lh);
759 void mdt_reconstruct(struct mdt_thread_info *, struct mdt_lock_handle *);
760 void mdt_reconstruct_generic(struct mdt_thread_info *mti,
761 struct mdt_lock_handle *lhc);
763 extern void target_recovery_fini(struct obd_device *obd);
764 extern void target_recovery_init(struct lu_target *lut,
765 svc_handler_t handler);
766 int mdt_fs_setup(const struct lu_env *, struct mdt_device *,
767 struct obd_device *, struct lustre_sb_info *lsi);
768 void mdt_fs_cleanup(const struct lu_env *, struct mdt_device *);
770 int mdt_export_stats_init(struct obd_device *obd,
771 struct obd_export *exp,
774 int mdt_pin(struct mdt_thread_info* info);
776 int mdt_lock_new_child(struct mdt_thread_info *info,
777 struct mdt_object *o,
778 struct mdt_lock_handle *child_lockh);
780 void mdt_mfd_set_mode(struct mdt_file_data *mfd,
783 int mdt_reint_open(struct mdt_thread_info *info,
784 struct mdt_lock_handle *lhc);
786 struct mdt_file_data *mdt_handle2mfd(struct mdt_export_data *med,
787 const struct lustre_handle *handle,
791 MDT_IOEPOCH_CLOSED = 0,
792 MDT_IOEPOCH_OPENED = 1,
793 MDT_IOEPOCH_GETATTR = 2,
801 int mdt_attr_get_complex(struct mdt_thread_info *info,
802 struct mdt_object *o, struct md_attr *ma);
803 int mdt_ioepoch_open(struct mdt_thread_info *info, struct mdt_object *o,
805 int mdt_object_is_som_enabled(struct mdt_object *mo);
806 int mdt_write_get(struct mdt_object *o);
807 void mdt_write_put(struct mdt_object *o);
808 int mdt_write_read(struct mdt_object *o);
809 struct mdt_file_data *mdt_mfd_new(const struct mdt_export_data *med);
810 int mdt_mfd_close(struct mdt_thread_info *info, struct mdt_file_data *mfd);
811 void mdt_mfd_free(struct mdt_file_data *mfd);
812 int mdt_close(struct mdt_thread_info *info);
813 int mdt_attr_set(struct mdt_thread_info *info, struct mdt_object *mo,
814 struct md_attr *ma, int flags);
815 int mdt_add_dirty_flag(struct mdt_thread_info *info, struct mdt_object *mo,
817 int mdt_done_writing(struct mdt_thread_info *info);
818 int mdt_fix_reply(struct mdt_thread_info *info);
819 int mdt_handle_last_unlink(struct mdt_thread_info *, struct mdt_object *,
820 const struct md_attr *);
821 void mdt_reconstruct_open(struct mdt_thread_info *, struct mdt_lock_handle *);
823 struct lu_buf *mdt_buf(const struct lu_env *env, void *area, ssize_t len);
824 const struct lu_buf *mdt_buf_const(const struct lu_env *env,
825 const void *area, ssize_t len);
827 void mdt_dump_lmm(int level, const struct lov_mds_md *lmm);
829 int mdt_check_ucred(struct mdt_thread_info *);
830 int mdt_init_ucred(struct mdt_thread_info *, struct mdt_body *);
831 int mdt_init_ucred_reint(struct mdt_thread_info *);
832 void mdt_exit_ucred(struct mdt_thread_info *);
833 int mdt_version_get_check(struct mdt_thread_info *, struct mdt_object *, int);
834 void mdt_version_get_save(struct mdt_thread_info *, struct mdt_object *, int);
835 int mdt_version_get_check_save(struct mdt_thread_info *, struct mdt_object *,
837 int mdt_handle_common(struct ptlrpc_request *req,
838 struct mdt_opc_slice *supported);
839 int mdt_connect(struct mdt_thread_info *info);
840 int mdt_disconnect(struct mdt_thread_info *info);
841 int mdt_set_info(struct mdt_thread_info *info);
842 int mdt_get_info(struct mdt_thread_info *info);
843 int mdt_getstatus(struct mdt_thread_info *info);
844 int mdt_getattr(struct mdt_thread_info *info);
845 int mdt_getattr_name(struct mdt_thread_info *info);
846 int mdt_statfs(struct mdt_thread_info *info);
847 int mdt_reint(struct mdt_thread_info *info);
848 int mdt_sync(struct mdt_thread_info *info);
849 int mdt_is_subdir(struct mdt_thread_info *info);
850 int mdt_obd_ping(struct mdt_thread_info *info);
851 int mdt_obd_log_cancel(struct mdt_thread_info *info);
852 int mdt_obd_qc_callback(struct mdt_thread_info *info);
853 int mdt_enqueue(struct mdt_thread_info *info);
854 int mdt_convert(struct mdt_thread_info *info);
855 int mdt_bl_callback(struct mdt_thread_info *info);
856 int mdt_cp_callback(struct mdt_thread_info *info);
857 int mdt_llog_create(struct mdt_thread_info *info);
858 int mdt_llog_destroy(struct mdt_thread_info *info);
859 int mdt_llog_read_header(struct mdt_thread_info *info);
860 int mdt_llog_next_block(struct mdt_thread_info *info);
861 int mdt_llog_prev_block(struct mdt_thread_info *info);
862 int mdt_sec_ctx_handle(struct mdt_thread_info *info);
863 int mdt_readpage(struct mdt_thread_info *info);
864 int mdt_obd_idx_read(struct mdt_thread_info *info);
865 int mdt_tgt_connect(struct tgt_session_info *tsi);
866 void mdt_thread_info_init(struct ptlrpc_request *req,
867 struct mdt_thread_info *mti);
868 void mdt_thread_info_fini(struct mdt_thread_info *mti);
870 extern struct mdt_opc_slice mdt_regular_handlers[];
871 extern struct mdt_opc_slice mdt_seq_handlers[];
872 extern struct mdt_opc_slice mdt_fld_handlers[];
874 int mdt_quotacheck(struct mdt_thread_info *info);
875 int mdt_quotactl(struct mdt_thread_info *info);
876 int mdt_quota_dqacq(struct mdt_thread_info *info);
877 int mdt_swap_layouts(struct mdt_thread_info *info);
879 extern struct lprocfs_vars lprocfs_mds_module_vars[];
880 extern struct lprocfs_vars lprocfs_mds_obd_vars[];
882 int mdt_hsm_attr_set(struct mdt_thread_info *info, struct mdt_object *obj,
883 const struct md_hsm *mh);
885 struct mdt_handler *mdt_handler_find(__u32 opc,
886 struct mdt_opc_slice *supported);
888 int mdt_init_sec_level(struct mdt_thread_info *);
889 int mdt_init_idmap(struct mdt_thread_info *);
890 void mdt_cleanup_idmap(struct mdt_export_data *);
891 int mdt_handle_idmap(struct mdt_thread_info *);
892 int ptlrpc_user_desc_do_idmap(struct ptlrpc_request *,
893 struct ptlrpc_user_desc *);
894 void mdt_body_reverse_idmap(struct mdt_thread_info *,
896 int mdt_remote_perm_reverse_idmap(struct ptlrpc_request *,
897 struct mdt_remote_perm *);
898 int mdt_fix_attr_ucred(struct mdt_thread_info *, __u32);
900 static inline struct mdt_device *mdt_dev(struct lu_device *d)
902 return container_of0(d, struct mdt_device, mdt_lu_dev);
905 static inline struct dt_object *mdt_obj2dt(struct mdt_object *mo)
907 struct lu_object *lo;
908 struct mdt_device *mdt = mdt_dev(mo->mot_obj.lo_dev);
910 lo = lu_object_locate(mo->mot_obj.lo_header,
911 mdt->mdt_bottom->dd_lu_dev.ld_type);
916 /* mdt/mdt_identity.c */
917 #define MDT_IDENTITY_UPCALL_PATH "/usr/sbin/l_getidentity"
919 extern struct upcall_cache_ops mdt_identity_upcall_cache_ops;
921 struct md_identity *mdt_identity_get(struct upcall_cache *, __u32);
923 void mdt_identity_put(struct upcall_cache *, struct md_identity *);
925 void mdt_flush_identity(struct upcall_cache *, int);
927 __u32 mdt_identity_get_perm(struct md_identity *, __u32, lnet_nid_t);
929 int mdt_pack_remote_perm(struct mdt_thread_info *, struct mdt_object *, void *);
932 int mdt_hsm_state_get(struct mdt_thread_info *info);
933 int mdt_hsm_state_set(struct mdt_thread_info *info);
934 int mdt_hsm_action(struct mdt_thread_info *info);
935 int mdt_hsm_progress(struct mdt_thread_info *info);
936 int mdt_hsm_ct_register(struct mdt_thread_info *info);
937 int mdt_hsm_ct_unregister(struct mdt_thread_info *info);
938 int mdt_hsm_request(struct mdt_thread_info *info);
939 /* mdt/mdt_hsm_cdt_actions.c */
940 extern const struct file_operations mdt_agent_actions_fops;
941 void dump_llog_agent_req_rec(const char *prefix,
942 const struct llog_agent_req_rec *larr);
943 int cdt_llog_process(const struct lu_env *env, struct mdt_device *mdt,
944 llog_cb_t cb, void *data);
945 int mdt_agent_record_add(const struct lu_env *env, struct mdt_device *mdt,
946 __u64 compound_id, __u32 archive_id,
947 __u64 flags, struct hsm_action_item *hai);
948 int mdt_agent_record_update(const struct lu_env *env,
949 struct mdt_device *mdt, __u64 *cookies,
950 int cookies_count, enum agent_req_status status);
951 int mdt_agent_llog_update_rec(const struct lu_env *env, struct mdt_device *mdt,
952 struct llog_handle *llh,
953 struct llog_agent_req_rec *larr);
955 /* mdt/mdt_hsm_cdt_agent.c */
956 extern const struct file_operations mdt_hsm_agent_fops;
957 int mdt_hsm_agent_register(struct mdt_thread_info *info,
958 const struct obd_uuid *uuid,
959 int nr_archives, __u32 *archive_num);
960 int mdt_hsm_agent_register_mask(struct mdt_thread_info *info,
961 const struct obd_uuid *uuid,
963 int mdt_hsm_agent_unregister(struct mdt_thread_info *info,
964 const struct obd_uuid *uuid);
965 int mdt_hsm_agent_update_statistics(struct coordinator *cdt,
966 int succ_rq, int fail_rq, int new_rq,
967 const struct obd_uuid *uuid);
968 int mdt_hsm_find_best_agent(struct coordinator *cdt, __u32 archive,
969 struct obd_uuid *uuid);
970 int mdt_hsm_agent_send(struct mdt_thread_info *mti, struct hsm_action_list *hal,
972 int mdt_hsm_coordinator_update(struct mdt_thread_info *mti,
973 struct hsm_progress_kernel *pgs);
974 /* mdt/mdt_hsm_cdt_client.c */
975 int mdt_hsm_add_actions(struct mdt_thread_info *info,
976 struct hsm_action_list *hal, __u64 *compound_id);
977 int mdt_hsm_get_actions(struct mdt_thread_info *mti,
978 struct hsm_action_list *hal);
979 int mdt_hsm_get_running(struct mdt_thread_info *mti,
980 struct hsm_action_list *hal);
981 bool mdt_hsm_restore_is_running(struct mdt_thread_info *mti,
982 const struct lu_fid *fid);
983 /* mdt/mdt_hsm_cdt_requests.c */
984 extern const struct file_operations mdt_hsm_request_fops;
985 void dump_requests(char *prefix, struct coordinator *cdt);
986 struct cdt_agent_req *mdt_cdt_alloc_request(__u64 compound_id, __u32 archive_id,
987 __u64 flags, struct obd_uuid *uuid,
988 struct hsm_action_item *hai);
989 void mdt_cdt_free_request(struct cdt_agent_req *car);
990 int mdt_cdt_add_request(struct coordinator *cdt, struct cdt_agent_req *new_car);
991 struct cdt_agent_req *mdt_cdt_find_request(struct coordinator *cdt,
993 const struct lu_fid *fid);
994 void mdt_cdt_get_work_done(struct cdt_agent_req *car, __u64 *done_sz);
995 void mdt_cdt_get_request(struct cdt_agent_req *car);
996 void mdt_cdt_put_request(struct cdt_agent_req *car);
997 struct cdt_agent_req *mdt_cdt_update_request(struct coordinator *cdt,
998 const struct hsm_progress_kernel *pgs);
999 int mdt_cdt_remove_request(struct coordinator *cdt, __u64 cookie);
1000 /* mdt/mdt_coordinator.c */
1001 void mdt_hsm_dump_hal(int level, const char *prefix,
1002 struct hsm_action_list *hal);
1003 /* coordinator management */
1004 int mdt_hsm_cdt_init(struct mdt_device *mdt);
1005 int mdt_hsm_cdt_start(struct mdt_device *mdt);
1006 int mdt_hsm_cdt_stop(struct mdt_device *mdt);
1007 int mdt_hsm_cdt_fini(struct mdt_device *mdt);
1008 int mdt_hsm_cdt_wakeup(struct mdt_device *mdt);
1010 /* coordinator control /proc interface */
1011 int lprocfs_wr_hsm_cdt_control(struct file *file, const char *buffer,
1012 unsigned long count, void *data);
1013 int lprocfs_rd_hsm_cdt_control(char *page, char **start, off_t off,
1014 int count, int *eof, void *data);
1015 /* md_hsm helpers */
1016 struct mdt_object *mdt_hsm_get_md_hsm(struct mdt_thread_info *mti,
1017 const struct lu_fid *fid,
1018 struct md_hsm *hsm);
1019 /* actions/request helpers */
1020 int mdt_hsm_add_hal(struct mdt_thread_info *mti,
1021 struct hsm_action_list *hal, struct obd_uuid *uuid);
1022 bool mdt_hsm_is_action_compat(const struct hsm_action_item *hai,
1023 const int hal_an, const __u64 rq_flags,
1024 const struct md_hsm *hsm);
1025 int mdt_hsm_update_request_state(struct mdt_thread_info *mti,
1026 struct hsm_progress_kernel *pgs,
1027 const int update_record);
1029 extern struct lu_context_key mdt_thread_key;
1030 /* debug issues helper starts here*/
1031 static inline int mdt_fail_write(const struct lu_env *env,
1032 struct dt_device *dd, int id)
1034 if (OBD_FAIL_CHECK_ORSET(id, OBD_FAIL_ONCE)) {
1035 CERROR(LUSTRE_MDT_NAME": cfs_fail_loc=%x, fail write ops\n",
1037 return dd->dd_ops->dt_ro(env, dd);
1038 /* We set FAIL_ONCE because we never "un-fail" a device */
1044 static inline struct mdt_export_data *mdt_req2med(struct ptlrpc_request *req)
1046 return &req->rq_export->exp_mdt_data;
1049 typedef void (*mdt_reconstruct_t)(struct mdt_thread_info *mti,
1050 struct mdt_lock_handle *lhc);
1051 static inline int mdt_check_resent(struct mdt_thread_info *info,
1052 mdt_reconstruct_t reconstruct,
1053 struct mdt_lock_handle *lhc)
1055 struct ptlrpc_request *req = mdt_info_req(info);
1058 if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) {
1059 if (req_xid_is_last(req)) {
1060 reconstruct(info, lhc);
1063 DEBUG_REQ(D_HA, req, "no reply for RESENT req (have "LPD64")",
1064 req->rq_export->exp_target_data.ted_lcd->lcd_last_xid);
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 /* Issues dlm lock on passed @ns, @f stores it lock handle into @lh. */
1080 static inline int mdt_fid_lock(struct ldlm_namespace *ns,
1081 struct lustre_handle *lh,
1083 ldlm_policy_data_t *policy,
1084 const struct ldlm_res_id *res_id,
1085 __u64 flags, const __u64 *client_cookie)
1089 LASSERT(ns != NULL);
1090 LASSERT(lh != NULL);
1092 rc = ldlm_cli_enqueue_local(ns, res_id, LDLM_IBITS, policy,
1093 mode, &flags, mdt_blocking_ast,
1094 ldlm_completion_ast, NULL, NULL, 0,
1095 LVB_T_NONE, client_cookie, lh);
1096 return rc == ELDLM_OK ? 0 : -EIO;
1099 static inline void mdt_fid_unlock(struct lustre_handle *lh,
1102 ldlm_lock_decref(lh, mode);
1105 extern mdl_mode_t mdt_mdl_lock_modes[];
1106 extern ldlm_mode_t mdt_dlm_lock_modes[];
1108 static inline mdl_mode_t mdt_dlm_mode2mdl_mode(ldlm_mode_t mode)
1110 LASSERT(IS_PO2(mode));
1111 return mdt_mdl_lock_modes[mode];
1114 static inline ldlm_mode_t mdt_mdl_mode2dlm_mode(mdl_mode_t mode)
1116 LASSERT(IS_PO2(mode));
1117 return mdt_dlm_lock_modes[mode];
1121 extern struct ldlm_valblock_ops mdt_lvbo;
1123 static inline struct lu_name *mdt_name(const struct lu_env *env,
1124 char *name, int namelen)
1126 struct lu_name *lname;
1127 struct mdt_thread_info *mti;
1129 LASSERT(namelen > 0);
1130 /* trailing '\0' in buffer */
1131 LASSERT(name[namelen] == '\0');
1133 mti = lu_context_key_get(&env->le_ctx, &mdt_thread_key);
1134 lname = &mti->mti_name;
1135 lname->ln_name = name;
1136 lname->ln_namelen = namelen;
1140 static inline struct lu_name *mdt_name_copy(struct lu_name *tlname,
1141 struct lu_name *slname)
1146 tlname->ln_name = slname->ln_name;
1147 tlname->ln_namelen = slname->ln_namelen;
1151 void mdt_enable_cos(struct mdt_device *, int);
1152 int mdt_cos_is_enabled(struct mdt_device *);
1170 LPROC_MDT_SAMEDIR_RENAME,
1171 LPROC_MDT_CROSSDIR_RENAME,
1174 void mdt_counter_incr(struct ptlrpc_request *req, int opcode);
1175 void mdt_stats_counter_init(struct lprocfs_stats *stats);
1176 void lprocfs_mdt_init_vars(struct lprocfs_static_vars *lvars);
1177 void lprocfs_mds_init_vars(struct lprocfs_static_vars *lvars);
1178 int mdt_procfs_init(struct mdt_device *mdt, const char *name);
1179 void mdt_procfs_fini(struct mdt_device *mdt);
1180 void mdt_rename_counter_tally(struct mdt_thread_info *info,
1181 struct mdt_device *mdt,
1182 struct ptlrpc_request *req,
1183 struct mdt_object *src, struct mdt_object *tgt);
1186 int mdt_ck_thread_start(struct mdt_device *mdt);
1187 void mdt_ck_thread_stop(struct mdt_device *mdt);
1188 void mdt_ck_timer_callback(unsigned long castmeharder);
1189 int mdt_capa_keys_init(const struct lu_env *env, struct mdt_device *mdt);
1190 void mdt_set_capainfo(struct mdt_thread_info *info, int offset,
1191 const struct lu_fid *fid, struct lustre_capa *capa);
1192 void mdt_dump_capainfo(struct mdt_thread_info *info);
1194 static inline struct obd_device *mdt2obd_dev(const struct mdt_device *mdt)
1196 return mdt->mdt_lu_dev.ld_obd;
1199 extern const struct lu_device_operations mdt_lu_ops;
1201 static inline int lu_device_is_mdt(struct lu_device *d)
1203 return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &mdt_lu_ops);
1206 static inline struct mdt_device *lu2mdt_dev(struct lu_device *d)
1208 LASSERTF(lu_device_is_mdt(d), "It is %s instead of MDT %p %p\n",
1209 d->ld_type->ldt_name, d->ld_ops, &mdt_lu_ops);
1210 return container_of0(d, struct mdt_device, mdt_lu_dev);
1213 static inline char *mdt_obd_name(struct mdt_device *mdt)
1215 return mdt->mdt_lu_dev.ld_obd->obd_name;
1218 int mds_mod_init(void);
1219 void mds_mod_exit(void);
1221 #endif /* __KERNEL__ */