Whamcloud - gitweb
86a87b2a633832787be1934ec837221b6f1141f4
[fs/lustre-release.git] / lustre / mdt / mdt_internal.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2016, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * lustre/mdt/mdt_internal.h
33  *
34  * Lustre Metadata Target (mdt) request handler
35  *
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>
42  */
43
44 #ifndef _MDT_INTERNAL_H
45 #define _MDT_INTERNAL_H
46
47 #include <libcfs/libcfs.h>
48 #include <libcfs/libcfs_hash.h>
49 #include <upcall_cache.h>
50 #include <lustre/lustre_idl.h>
51 #include <obd_class.h>
52 #include <lustre_disk.h>
53 #include <lu_target.h>
54 #include <md_object.h>
55 #include <lustre_fid.h>
56 #include <lustre_fld.h>
57 #include <lustre_req_layout.h>
58 #include <lustre_sec.h>
59 #include <lustre_idmap.h>
60 #include <lustre_eacl.h>
61 #include <lustre_quota.h>
62 #include <lustre_linkea.h>
63
64 struct mdt_object;
65
66 /* file data for open files on MDS */
67 struct mdt_file_data {
68         /**  portals handle must be first */
69         struct portals_handle   mfd_handle;
70         /** open mode provided by client */
71         __u64                   mfd_mode;
72         /** protected by med_open_lock */
73         struct list_head        mfd_list;
74         /** xid of the open request */
75         __u64                   mfd_xid;
76         /** old handle in replay case */
77         struct lustre_handle    mfd_old_handle;
78         /** point to opened object */
79         struct mdt_object       *mfd_object;
80 };
81
82 #define CDT_NONBLOCKING_RESTORE         (1ULL << 0)
83 #define CDT_NORETRY_ACTION              (1ULL << 1)
84 #define CDT_POLICY_LAST                 CDT_NORETRY_ACTION
85 #define CDT_POLICY_SHIFT_COUNT          2
86 #define CDT_POLICY_ALL                  (CDT_NONBLOCKING_RESTORE | \
87                                         CDT_NORETRY_ACTION)
88
89 /* when adding a new policy, do not forget to update
90  * lustre/mdt/mdt_coordinator.c::hsm_policy_names[]
91  */
92 #define CDT_DEFAULT_POLICY              CDT_NORETRY_ACTION
93
94 /* Coordinator states. Keep the cdt_transition table in sync. */
95 enum cdt_states { CDT_STOPPED = 0,
96                   CDT_INIT,
97                   CDT_RUNNING,
98                   CDT_DISABLE,
99                   CDT_STOPPING,
100
101                   CDT_STATES_COUNT
102 };
103
104 static inline char *cdt_mdt_state2str(int state)
105 {
106         switch (state) {
107         case CDT_INIT:
108                 return "init";
109         case CDT_RUNNING:
110                 return "enabled";
111         case CDT_STOPPING:
112                 return "stopping";
113         case CDT_STOPPED:
114                 return "stopped";
115         case CDT_DISABLE:
116                 return "disabled";
117         default:
118                 return "unknown";
119         }
120 }
121
122 /* when multiple lock are needed, the lock order is
123  * cdt_llog_lock
124  * cdt_agent_lock
125  * cdt_counter_lock
126  * cdt_restore_lock
127  * cdt_request_lock
128  */
129 struct coordinator {
130         wait_queue_head_t        cdt_waitq;          /**< cdt wait queue */
131         bool                     cdt_event;          /**< coordinator event */
132         struct task_struct      *cdt_task;           /**< cdt thread handle */
133         struct lu_env            cdt_env;            /**< coordinator lustre
134                                                       * env */
135         struct lu_context        cdt_session;        /** session for lu_ucred */
136         struct proc_dir_entry   *cdt_proc_dir;       /**< cdt /proc directory */
137         __u64                    cdt_policy;         /**< policy flags */
138         enum cdt_states          cdt_state;           /**< state */
139         spinlock_t               cdt_state_lock;      /**< cdt_state lock */
140         atomic_t                 cdt_compound_id;     /**< compound id
141                                                        * counter */
142         __u64                    cdt_last_cookie;     /**< last cookie
143                                                        * allocated */
144         struct rw_semaphore      cdt_llog_lock;       /**< protect llog
145                                                        * access */
146         struct rw_semaphore      cdt_agent_lock;      /**< protect agent list */
147         struct rw_semaphore      cdt_request_lock;    /**< protect request
148                                                        * list */
149         struct mutex             cdt_restore_lock;    /**< protect restore
150                                                        * list */
151         cfs_time_t               cdt_loop_period;     /**< llog scan period */
152         cfs_time_t               cdt_grace_delay;     /**< request grace
153                                                        * delay */
154         cfs_time_t               cdt_active_req_timeout; /**< request timeout */
155         __u32                    cdt_default_archive_id; /**< archive id used
156                                                        * when none are
157                                                        * specified */
158         __u64                    cdt_max_requests;    /**< max count of started
159                                                        * requests */
160         atomic_t                 cdt_request_count;   /**< current count of
161                                                        * started requests */
162         /* started requests (struct cdt_agent_req:car_cookie_hash)
163          * indexed by cookie */
164         struct cfs_hash         *cdt_request_cookie_hash;
165         /* started requests (struct cdt_agent_req:car_request_list) */
166         struct list_head         cdt_request_list;
167         struct list_head         cdt_agents;          /**< list of register
168                                                        * agents */
169         struct list_head         cdt_restore_hdl;     /**< list of restore lock
170                                                        * handles */
171
172         /* Hash of cookies to locations of record locations in agent
173          * request log. */
174         struct cfs_hash         *cdt_agent_record_hash;
175
176         /* Bitmasks indexed by the HSMA_XXX constants. */
177         __u64                    cdt_user_request_mask;
178         __u64                    cdt_group_request_mask;
179         __u64                    cdt_other_request_mask;
180
181         /* Remove archive on last unlink policy */
182         bool                     cdt_remove_archive_on_last_unlink;
183 };
184
185 /* mdt state flag bits */
186 #define MDT_FL_CFGLOG 0
187 #define MDT_FL_SYNCED 1
188
189 struct mdt_device {
190         /* super-class */
191         struct lu_device           mdt_lu_dev;
192         struct seq_server_site     mdt_seq_site;
193         /* DLM name-space for meta-data locks maintained by this server */
194         struct ldlm_namespace     *mdt_namespace;
195         /* ptlrpc handle for MDS->client connections (for lock ASTs). */
196         struct ptlrpc_client      *mdt_ldlm_client;
197         /* underlying device */
198         struct obd_export         *mdt_child_exp;
199         struct md_device          *mdt_child;
200         struct dt_device          *mdt_bottom;
201         struct obd_export         *mdt_bottom_exp;
202         /** target device */
203         struct lu_target           mdt_lut;
204         /*
205          * Options bit-fields.
206          */
207         struct {
208                 unsigned int       mo_user_xattr:1,
209                                    mo_acl:1,
210                                    mo_cos:1,
211                                    mo_evict_tgt_nids:1;
212         } mdt_opts;
213         /* mdt state flags */
214         unsigned long              mdt_state;
215
216         /* transaction callbacks */
217         struct dt_txn_callback     mdt_txn_cb;
218
219         /* these values should be updated from lov if necessary.
220          * or should be placed somewhere else. */
221         int                        mdt_max_mdsize;
222
223         int                        mdt_max_ea_size;
224
225         struct upcall_cache        *mdt_identity_cache;
226
227         unsigned int               mdt_capa_conf:1,
228                                    /* Enable remote dir on non-MDT0 */
229                                    mdt_enable_remote_dir:1,
230                                    mdt_skip_lfsck:1;
231
232         gid_t                      mdt_enable_remote_dir_gid;
233
234         /* lock for osfs and md_root */
235         spinlock_t                 mdt_lock;
236
237         /* statfs optimization: we cache a bit  */
238         struct obd_statfs          mdt_osfs;
239         __u64                      mdt_osfs_age;
240
241         /* root squash */
242         struct root_squash_info    mdt_squash;
243
244         struct rename_stats        mdt_rename_stats;
245         struct lu_fid              mdt_md_root_fid;
246
247         /* connection to quota master */
248         struct obd_export         *mdt_qmt_exp;
249         /* quota master device associated with this MDT */
250         struct lu_device          *mdt_qmt_dev;
251
252         struct coordinator         mdt_coordinator;
253
254         /* inter-MDT connection count */
255         atomic_t                   mdt_mds_mds_conns;
256
257         /* MDT device async commit count, used for debug and sanity test */
258         atomic_t                   mdt_async_commit_count;
259
260         struct mdt_object         *mdt_md_root;
261 };
262
263 #define MDT_SERVICE_WATCHDOG_FACTOR     (2)
264 #define MDT_COS_DEFAULT         (0)
265
266 struct mdt_object {
267         struct lu_object_header mot_header;
268         struct lu_object        mot_obj;
269         unsigned int            mot_lov_created:1,  /* lov object created */
270                                 mot_cache_attr:1;   /* enable remote object
271                                                      * attribute cache */
272         int                     mot_write_count;
273         spinlock_t              mot_write_lock;
274         /* Lock to protect create_data */
275         struct mutex            mot_lov_mutex;
276         /* Lock to protect lease open.
277          * Lease open acquires write lock; normal open acquires read lock */
278         struct rw_semaphore     mot_open_sem;
279         atomic_t                mot_lease_count;
280         atomic_t                mot_open_count;
281 };
282
283 struct mdt_lock_handle {
284         /* Lock type, reg for cross-ref use or pdo lock. */
285         mdl_type_t              mlh_type;
286
287         /* Regular lock */
288         struct lustre_handle    mlh_reg_lh;
289         enum ldlm_mode          mlh_reg_mode;
290
291         /* Pdirops lock */
292         struct lustre_handle    mlh_pdo_lh;
293         enum ldlm_mode          mlh_pdo_mode;
294         unsigned int            mlh_pdo_hash;
295
296         /* Remote regular lock */
297         struct lustre_handle    mlh_rreg_lh;
298         enum ldlm_mode          mlh_rreg_mode;
299 };
300
301 enum {
302         MDT_LH_PARENT,  /* parent lockh */
303         MDT_LH_CHILD,   /* child lockh */
304         MDT_LH_OLD,     /* old lockh for rename */
305         MDT_LH_LAYOUT = MDT_LH_OLD, /* layout lock */
306         MDT_LH_NEW,     /* new lockh for rename */
307         MDT_LH_RMT,     /* used for return lh to caller */
308         MDT_LH_LOCAL,   /* local lock never return to client */
309         MDT_LH_NR
310 };
311
312 enum {
313         MDT_LOCAL_LOCK,
314         MDT_CROSS_LOCK
315 };
316
317 /* Special magical errno for communicaiton between mdt_reint_open()
318  * and mdt_intent_reint() which means return the lock to the client
319  * for subsequent cross ref open. Previously we used plain -EREMOTE
320  * but other functions called in that path might return it too and
321  * confuse us. This is not returned to the client. See LU-5370. */
322 #define MDT_EREMOTE_OPEN (EREMOTE + 1024)
323
324 struct mdt_reint_record {
325         mdt_reint_t                      rr_opcode;
326         const struct lustre_handle      *rr_handle;
327         const struct lu_fid             *rr_fid1;
328         const struct lu_fid             *rr_fid2;
329         struct lu_name                   rr_name;
330         struct lu_name                   rr_tgt_name;
331         void                            *rr_eadata;
332         int                              rr_eadatalen;
333         __u32                            rr_flags;
334 };
335
336 enum mdt_reint_flag {
337         MRF_OPEN_TRUNC = 1 << 0,
338 };
339
340 /*
341  * Common data shared by mdt-level handlers. This is allocated per-thread to
342  * reduce stack consumption.
343  */
344 struct mdt_thread_info {
345         /*
346          * XXX: Part One:
347          * The following members will be filled explicitly
348          * with specific data in mdt_thread_info_init().
349          */
350         /* TODO: move this into mdt_session_key(with LCT_SESSION), because
351          * request handling may migrate from one server thread to another.
352          */
353         struct req_capsule        *mti_pill;
354
355         /* although we have export in req, there are cases when it is not
356          * available, e.g. closing files upon export destroy */
357         struct obd_export          *mti_exp;
358         /*
359          * A couple of lock handles.
360          */
361         struct mdt_lock_handle     mti_lh[MDT_LH_NR];
362
363         struct mdt_device         *mti_mdt;
364         const struct lu_env       *mti_env;
365
366         /* transaction number of current request */
367         __u64                      mti_transno;
368
369
370         /*
371          * XXX: Part Two:
372          * The following members will be filled expilictly
373          * with zero in mdt_thread_info_init(). These members may be used
374          * by all requests.
375          */
376
377         /*
378          * Object attributes.
379          */
380         struct md_attr             mti_attr;
381         /*
382          * Body for "habeo corpus" operations.
383          */
384         const struct mdt_body     *mti_body;
385         /*
386          * Host object. This is released at the end of mdt_handler().
387          */
388         struct mdt_object         *mti_object;
389         /*
390          * Lock request for "habeo clavis" operations.
391          */
392         const struct ldlm_request *mti_dlm_req;
393
394         __u32                      mti_has_trans:1, /* has txn already? */
395                                    mti_cross_ref:1,
396         /* big_lmm buffer was used and must be used in reply */
397                                    mti_big_lmm_used:1,
398                                    mti_big_acl_used:1;
399
400         /* opdata for mdt_reint_open(), has the same as
401          * ldlm_reply:lock_policy_res1.  mdt_update_last_rcvd() stores this
402          * value onto disk for recovery when mdt_trans_stop_cb() is called.
403          */
404         __u64                      mti_opdata;
405
406         /*
407          * XXX: Part Three:
408          * The following members will be filled explicitly
409          * with zero in mdt_reint_unpack(), because they are only used
410          * by reint requests (including mdt_reint_open()).
411          */
412
413         /*
414          * reint record. contains information for reint operations.
415          */
416         struct mdt_reint_record    mti_rr;
417
418         __u64                      mti_ver[PTLRPC_NUM_VERSIONS];
419         /*
420          * Operation specification (currently create and lookup)
421          */
422         struct md_op_spec          mti_spec;
423
424         /*
425          * XXX: Part Four:
426          * The following members will _NOT_ be initialized at all.
427          * DO NOT expect them to contain any valid value.
428          * They should be initialized explicitly by the user themselves.
429          */
430
431         /* XXX: If something is in a union, make sure they do not conflict */
432         struct lu_fid                   mti_tmp_fid1;
433         struct lu_fid                   mti_tmp_fid2;
434         union ldlm_policy_data          mti_policy; /* for mdt_object_lock() */
435         struct ldlm_res_id              mti_res_id; /* and mdt_rename_lock() */
436         union {
437                 struct obd_uuid         uuid[2];    /* for mdt_seq_init_cli() */
438                 char                    ns_name[48];/* for mdt_init0()        */
439                 struct lustre_cfg_bufs  bufs;       /* for mdt_stack_fini()   */
440                 struct obd_statfs       osfs;       /* for mdt_statfs()       */
441                 struct {
442                         /* for mdt_readpage()      */
443                         struct lu_rdpg     mti_rdpg;
444                         /* for mdt_sendpage()      */
445                         struct l_wait_info mti_wait_info;
446                 } rdpg;
447                 struct {
448                         struct md_attr attr;
449                 } hsm;
450         } mti_u;
451
452         struct lustre_handle       mti_close_handle;
453         loff_t                     mti_off;
454         struct lu_buf              mti_buf;
455         struct lu_buf              mti_big_buf;
456
457         /* Ops object filename */
458         struct lu_name             mti_name;
459         /* per-thread values, can be re-used, may be vmalloc'd */
460         void                      *mti_big_lmm;
461         void                      *mti_big_acl;
462         int                        mti_big_lmmsize;
463         int                        mti_big_aclsize;
464         /* should be enough to fit lustre_mdt_attrs */
465         char                       mti_xattr_buf[128];
466         struct ldlm_enqueue_info   mti_einfo;
467         struct tg_reply_data      *mti_reply_data;
468 };
469
470 extern struct lu_context_key mdt_thread_key;
471
472 static inline struct mdt_thread_info *mdt_th_info(const struct lu_env *env)
473 {
474         struct mdt_thread_info *mti;
475
476         lu_env_refill((void *)env);
477         mti = lu_context_key_get(&env->le_ctx, &mdt_thread_key);
478         LASSERT(mti);
479         return mti;
480 }
481
482 struct cdt_req_progress {
483         struct mutex             crp_lock;      /**< protect tree */
484         struct interval_node    *crp_root;      /**< tree to track extent
485                                                  *   moved */
486         struct interval_node    **crp_node;     /**< buffer for tree nodes
487                                                  *   vector of fixed size
488                                                  *   vectors */
489         int                      crp_cnt;       /**< # of used nodes */
490         int                      crp_max;       /**< # of allocated nodes */
491 };
492
493 struct cdt_agent_req {
494         struct hlist_node        car_cookie_hash;  /**< find req by cookie */
495         struct list_head         car_request_list; /**< to chain all the req. */
496         atomic_t                 car_refcount;     /**< reference counter */
497         __u64                    car_compound_id;  /**< compound id */
498         __u64                    car_flags;        /**< request original flags */
499         struct obd_uuid          car_uuid;         /**< agent doing the req. */
500         __u32                    car_archive_id;   /**< archive id */
501         int                      car_canceled;     /**< request was canceled */
502         cfs_time_t               car_req_start;    /**< start time */
503         cfs_time_t               car_req_update;   /**< last update time */
504         struct hsm_action_item  *car_hai;          /**< req. to the agent */
505         struct cdt_req_progress  car_progress;     /**< track data mvt
506                                                     *   progress */
507 };
508 extern struct kmem_cache *mdt_hsm_car_kmem;
509
510 struct hsm_agent {
511         struct list_head ha_list;               /**< to chain the agents */
512         struct obd_uuid  ha_uuid;               /**< agent uuid */
513         __u32           *ha_archive_id;         /**< archive id */
514         int              ha_archive_cnt;        /**< number of archive entries
515                                                  *   0 means any archive */
516         atomic_t         ha_requests;           /**< current request count */
517         atomic_t         ha_success;            /**< number of successful
518                                                  * actions */
519         atomic_t         ha_failure;            /**< number of failed actions */
520 };
521
522 struct cdt_restore_handle {
523         struct list_head        crh_list;       /**< to chain the handle */
524         struct lu_fid           crh_fid;        /**< fid of the object */
525         struct ldlm_extent      crh_extent;     /**< extent of the restore */
526         struct mdt_lock_handle  crh_lh;         /**< lock handle */
527 };
528 extern struct kmem_cache *mdt_hsm_cdt_kmem;     /** restore handle slab cache */
529
530 static inline const struct md_device_operations *
531 mdt_child_ops(struct mdt_device * m)
532 {
533         LASSERT(m->mdt_child);
534         return m->mdt_child->md_ops;
535 }
536
537 static inline struct md_object *mdt_object_child(struct mdt_object *o)
538 {
539         LASSERT(o);
540         return lu2md(lu_object_next(&o->mot_obj));
541 }
542
543 static inline struct ptlrpc_request *mdt_info_req(struct mdt_thread_info *info)
544 {
545          return info->mti_pill ? info->mti_pill->rc_req : NULL;
546 }
547
548 static inline __u64 mdt_conn_flags(struct mdt_thread_info *info)
549 {
550         LASSERT(info->mti_exp);
551         return exp_connect_flags(info->mti_exp);
552 }
553
554 static inline void mdt_object_get(const struct lu_env *env,
555                                   struct mdt_object *o)
556 {
557         ENTRY;
558         lu_object_get(&o->mot_obj);
559         EXIT;
560 }
561
562 static inline void mdt_object_put(const struct lu_env *env,
563                                   struct mdt_object *o)
564 {
565         ENTRY;
566         lu_object_put(env, &o->mot_obj);
567         EXIT;
568 }
569
570 static inline int mdt_object_exists(const struct mdt_object *o)
571 {
572         return lu_object_exists(&o->mot_obj);
573 }
574
575 static inline int mdt_object_remote(const struct mdt_object *o)
576 {
577         return lu_object_remote(&o->mot_obj);
578 }
579
580 static inline const struct lu_fid *mdt_object_fid(const struct mdt_object *o)
581 {
582         return lu_object_fid(&o->mot_obj);
583 }
584
585 static inline struct lu_site *mdt_lu_site(const struct mdt_device *mdt)
586 {
587         return mdt->mdt_lu_dev.ld_site;
588 }
589
590 static inline struct seq_server_site *mdt_seq_site(struct mdt_device *mdt)
591 {
592         return &mdt->mdt_seq_site;
593 }
594
595 static inline void mdt_export_evict(struct obd_export *exp)
596 {
597         class_fail_export(exp);
598 }
599
600 /* Here we use LVB_TYPE to check dne client, because it is
601  * also landed on 2.4. */
602 static inline bool mdt_is_dne_client(struct obd_export *exp)
603 {
604         return !!(exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE);
605 }
606
607 static inline bool mdt_is_striped_client(struct obd_export *exp)
608 {
609         return exp_connect_flags(exp) & OBD_CONNECT_DIR_STRIPE;
610 }
611
612 __u64 mdt_get_disposition(struct ldlm_reply *rep, __u64 op_flag);
613 void mdt_set_disposition(struct mdt_thread_info *info,
614                          struct ldlm_reply *rep, __u64 op_flag);
615 void mdt_clear_disposition(struct mdt_thread_info *info,
616                            struct ldlm_reply *rep, __u64 op_flag);
617
618 void mdt_lock_pdo_init(struct mdt_lock_handle *lh, enum ldlm_mode lock_mode,
619                        const struct lu_name *lname);
620
621 void mdt_lock_reg_init(struct mdt_lock_handle *lh, enum ldlm_mode lm);
622
623 int mdt_lock_setup(struct mdt_thread_info *info, struct mdt_object *mo,
624                    struct mdt_lock_handle *lh);
625
626 int mdt_check_resent_lock(struct mdt_thread_info *info, struct mdt_object *mo,
627                           struct mdt_lock_handle *lhc);
628
629 int mdt_object_lock(struct mdt_thread_info *info, struct mdt_object *mo,
630                     struct mdt_lock_handle *lh, __u64 ibits);
631
632 int mdt_reint_object_lock(struct mdt_thread_info *info, struct mdt_object *o,
633                           struct mdt_lock_handle *lh, __u64 ibits,
634                           bool cos_incompat);
635
636 int mdt_object_lock_try(struct mdt_thread_info *info, struct mdt_object *mo,
637                         struct mdt_lock_handle *lh, __u64 *ibits,
638                         __u64 trybits, bool cos_incompat);
639
640 void mdt_object_unlock(struct mdt_thread_info *info, struct mdt_object *mo,
641                        struct mdt_lock_handle *lh, int decref);
642
643 struct mdt_object *mdt_object_new(const struct lu_env *env,
644                                   struct mdt_device *,
645                                   const struct lu_fid *);
646 struct mdt_object *mdt_object_find(const struct lu_env *,
647                                    struct mdt_device *,
648                                    const struct lu_fid *);
649 struct mdt_object *mdt_object_find_lock(struct mdt_thread_info *,
650                                         const struct lu_fid *,
651                                         struct mdt_lock_handle *,
652                                         __u64);
653 void mdt_object_unlock_put(struct mdt_thread_info *,
654                            struct mdt_object *,
655                            struct mdt_lock_handle *,
656                            int decref);
657
658 void mdt_client_compatibility(struct mdt_thread_info *info);
659
660 int mdt_remote_object_lock(struct mdt_thread_info *mti,
661                            struct mdt_object *o, const struct lu_fid *fid,
662                            struct lustre_handle *lh,
663                            enum ldlm_mode mode, __u64 ibits, bool cache);
664
665 enum mdt_name_flags {
666         MNF_FIX_ANON = 1,
667 };
668
669 int mdt_name_unpack(struct req_capsule *pill,
670                     const struct req_msg_field *field,
671                     struct lu_name *ln,
672                     enum mdt_name_flags flags);
673 int mdt_close_unpack(struct mdt_thread_info *info);
674 int mdt_reint_unpack(struct mdt_thread_info *info, __u32 op);
675 void mdt_fix_lov_magic(struct mdt_thread_info *info, void *eadata);
676 int mdt_reint_rec(struct mdt_thread_info *, struct mdt_lock_handle *);
677 #ifdef CONFIG_FS_POSIX_ACL
678 int mdt_pack_acl2body(struct mdt_thread_info *info, struct mdt_body *repbody,
679                       struct mdt_object *o, struct lu_nodemap *nodemap);
680 #endif
681 void mdt_pack_attr2body(struct mdt_thread_info *info, struct mdt_body *b,
682                         const struct lu_attr *attr, const struct lu_fid *fid);
683
684 int mdt_getxattr(struct mdt_thread_info *info);
685 int mdt_reint_setxattr(struct mdt_thread_info *info,
686                        struct mdt_lock_handle *lh);
687
688 void mdt_lock_handle_init(struct mdt_lock_handle *lh);
689 void mdt_lock_handle_fini(struct mdt_lock_handle *lh);
690
691 void mdt_reconstruct(struct mdt_thread_info *, struct mdt_lock_handle *);
692 void mdt_reconstruct_generic(struct mdt_thread_info *mti,
693                              struct mdt_lock_handle *lhc);
694
695 extern void target_recovery_fini(struct obd_device *obd);
696 extern void target_recovery_init(struct lu_target *lut,
697                                  svc_handler_t handler);
698 int mdt_fs_setup(const struct lu_env *, struct mdt_device *,
699                  struct obd_device *, struct lustre_sb_info *lsi);
700 void mdt_fs_cleanup(const struct lu_env *, struct mdt_device *);
701
702 int mdt_export_stats_init(struct obd_device *obd,
703                           struct obd_export *exp,
704                           void *client_nid);
705
706 int mdt_lock_new_child(struct mdt_thread_info *info,
707                        struct mdt_object *o,
708                        struct mdt_lock_handle *child_lockh);
709
710 void mdt_mfd_set_mode(struct mdt_file_data *mfd,
711                       __u64 mode);
712
713 int mdt_reint_open(struct mdt_thread_info *info,
714                    struct mdt_lock_handle *lhc);
715
716 struct mdt_file_data *mdt_handle2mfd(struct mdt_export_data *med,
717                                      const struct lustre_handle *handle,
718                                      bool is_replay);
719
720 int mdt_get_info(struct tgt_session_info *tsi);
721 int mdt_attr_get_complex(struct mdt_thread_info *info,
722                          struct mdt_object *o, struct md_attr *ma);
723 int mdt_big_xattr_get(struct mdt_thread_info *info, struct mdt_object *o,
724                       const char *name);
725 int mdt_stripe_get(struct mdt_thread_info *info, struct mdt_object *o,
726                    struct md_attr *ma, const char *name);
727 int mdt_write_get(struct mdt_object *o);
728 void mdt_write_put(struct mdt_object *o);
729 int mdt_write_read(struct mdt_object *o);
730 struct mdt_file_data *mdt_mfd_new(const struct mdt_export_data *med);
731 int mdt_mfd_close(struct mdt_thread_info *info, struct mdt_file_data *mfd);
732 void mdt_mfd_free(struct mdt_file_data *mfd);
733 int mdt_close(struct tgt_session_info *tsi);
734 int mdt_add_dirty_flag(struct mdt_thread_info *info, struct mdt_object *mo,
735                         struct md_attr *ma);
736 int mdt_fix_reply(struct mdt_thread_info *info);
737 int mdt_handle_last_unlink(struct mdt_thread_info *, struct mdt_object *,
738                            struct md_attr *);
739 void mdt_reconstruct_open(struct mdt_thread_info *, struct mdt_lock_handle *);
740
741 struct lu_buf *mdt_buf(const struct lu_env *env, void *area, ssize_t len);
742 const struct lu_buf *mdt_buf_const(const struct lu_env *env,
743                                    const void *area, ssize_t len);
744
745 void mdt_dump_lmm(int level, const struct lov_mds_md *lmm, __u64 valid);
746 void mdt_dump_lmv(unsigned int level, const union lmv_mds_md *lmv);
747
748 bool allow_client_chgrp(struct mdt_thread_info *info, struct lu_ucred *uc);
749 int mdt_check_ucred(struct mdt_thread_info *);
750 int mdt_init_ucred(struct mdt_thread_info *, struct mdt_body *);
751 int mdt_init_ucred_intent_getattr(struct mdt_thread_info *, struct mdt_body *);
752 int mdt_init_ucred_reint(struct mdt_thread_info *);
753 void mdt_exit_ucred(struct mdt_thread_info *);
754 int mdt_version_get_check(struct mdt_thread_info *, struct mdt_object *, int);
755 void mdt_version_get_save(struct mdt_thread_info *, struct mdt_object *, int);
756 int mdt_version_get_check_save(struct mdt_thread_info *, struct mdt_object *,
757                                int);
758 void mdt_thread_info_init(struct ptlrpc_request *req,
759                           struct mdt_thread_info *mti);
760 void mdt_thread_info_fini(struct mdt_thread_info *mti);
761 struct mdt_thread_info *tsi2mdt_info(struct tgt_session_info *tsi);
762
763 int mdt_hsm_attr_set(struct mdt_thread_info *info, struct mdt_object *obj,
764                      const struct md_hsm *mh);
765
766 int mdt_remote_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
767                             void *data, int flag);
768 int mdt_links_read(struct mdt_thread_info *info,
769                    struct mdt_object *mdt_obj,
770                    struct linkea_data *ldata);
771 int mdt_close_internal(struct mdt_thread_info *info, struct ptlrpc_request *req,
772                        struct mdt_body *repbody);
773
774 static inline struct mdt_device *mdt_dev(struct lu_device *d)
775 {
776         return container_of0(d, struct mdt_device, mdt_lu_dev);
777 }
778
779 static inline struct mdt_object *mdt_obj(struct lu_object *o)
780 {
781         return container_of0(o, struct mdt_object, mot_obj);
782 }
783
784 static inline struct dt_object *mdt_obj2dt(struct mdt_object *mo)
785 {
786         struct lu_object        *lo;
787         struct mdt_device       *mdt = mdt_dev(mo->mot_obj.lo_dev);
788
789         lo = lu_object_locate(mo->mot_obj.lo_header,
790                               mdt->mdt_bottom->dd_lu_dev.ld_type);
791
792         return lu2dt(lo);
793 }
794
795 static inline bool agent_req_in_final_state(enum agent_req_status ars)
796 {
797         return ((ars == ARS_SUCCEED) || (ars == ARS_FAILED) ||
798                 (ars == ARS_CANCELED));
799 }
800
801 /* mdt/mdt_identity.c */
802 #define MDT_IDENTITY_UPCALL_PATH        "/usr/sbin/l_getidentity"
803
804 extern struct upcall_cache_ops mdt_identity_upcall_cache_ops;
805
806 struct md_identity *mdt_identity_get(struct upcall_cache *, __u32);
807
808 void mdt_identity_put(struct upcall_cache *, struct md_identity *);
809
810 void mdt_flush_identity(struct upcall_cache *, int);
811
812 __u32 mdt_identity_get_perm(struct md_identity *, lnet_nid_t);
813
814 /* mdt/mdt_recovery.c */
815 __u64 mdt_req_from_lrd(struct ptlrpc_request *req, struct tg_reply_data *trd);
816
817 /* mdt/mdt_hsm.c */
818 int mdt_hsm_state_get(struct tgt_session_info *tsi);
819 int mdt_hsm_state_set(struct tgt_session_info *tsi);
820 int mdt_hsm_action(struct tgt_session_info *tsi);
821 int mdt_hsm_progress(struct tgt_session_info *tsi);
822 int mdt_hsm_ct_register(struct tgt_session_info *tsi);
823 int mdt_hsm_ct_unregister(struct tgt_session_info *tsi);
824 int mdt_hsm_request(struct tgt_session_info *tsi);
825
826 /* mdt/mdt_hsm_cdt_actions.c */
827 extern const struct file_operations mdt_hsm_actions_fops;
828 void dump_llog_agent_req_rec(const char *prefix,
829                              const struct llog_agent_req_rec *larr);
830 int cdt_llog_process(const struct lu_env *env, struct mdt_device *mdt,
831                      llog_cb_t cb, void *data, u32 start_cat_idx,
832                      u32 start_rec_idx, int rw);
833 int mdt_agent_record_add(const struct lu_env *env, struct mdt_device *mdt,
834                          __u64 compound_id, __u32 archive_id,
835                          __u64 flags, struct hsm_action_item *hai);
836 int mdt_agent_record_update(const struct lu_env *env,
837                             struct mdt_device *mdt, __u64 *cookies,
838                             int cookies_count, enum agent_req_status status);
839 void cdt_agent_record_hash_add(struct coordinator *cdt, u64 cookie, u32 cat_idt,
840                                u32 rec_idx);
841 void cdt_agent_record_hash_lookup(struct coordinator *cdt, u64 cookie,
842                                   u32 *cat_idt, u32 *rec_idx);
843 void cdt_agent_record_hash_del(struct coordinator *cdt, u64 cookie);
844
845 /* mdt/mdt_hsm_cdt_agent.c */
846 extern const struct file_operations mdt_hsm_agent_fops;
847 int mdt_hsm_agent_register(struct mdt_thread_info *info,
848                            const struct obd_uuid *uuid,
849                            int nr_archives, __u32 *archive_num);
850 int mdt_hsm_agent_register_mask(struct mdt_thread_info *info,
851                                 const struct obd_uuid *uuid,
852                                 __u32 archive_mask);
853 int mdt_hsm_agent_unregister(struct mdt_thread_info *info,
854                              const struct obd_uuid *uuid);
855 int mdt_hsm_agent_update_statistics(struct coordinator *cdt,
856                                     int succ_rq, int fail_rq, int new_rq,
857                                     const struct obd_uuid *uuid);
858 int mdt_hsm_find_best_agent(struct coordinator *cdt, __u32 archive,
859                             struct obd_uuid *uuid);
860 int mdt_hsm_agent_send(struct mdt_thread_info *mti, struct hsm_action_list *hal,
861                        bool purge);
862 int mdt_hsm_coordinator_update(struct mdt_thread_info *mti,
863                                struct hsm_progress_kernel *pgs);
864 /* mdt/mdt_hsm_cdt_client.c */
865 int mdt_hsm_add_actions(struct mdt_thread_info *info,
866                         struct hsm_action_list *hal);
867 int mdt_hsm_get_actions(struct mdt_thread_info *mti,
868                         struct hsm_action_list *hal);
869 bool mdt_hsm_restore_is_running(struct mdt_thread_info *mti,
870                                 const struct lu_fid *fid);
871 /* mdt/mdt_hsm_cdt_requests.c */
872 extern struct cfs_hash_ops cdt_request_cookie_hash_ops;
873 extern struct cfs_hash_ops cdt_agent_record_hash_ops;
874 extern const struct file_operations mdt_hsm_active_requests_fops;
875 void dump_requests(char *prefix, struct coordinator *cdt);
876 struct cdt_agent_req *mdt_cdt_alloc_request(__u64 compound_id, __u32 archive_id,
877                                             __u64 flags, struct obd_uuid *uuid,
878                                             struct hsm_action_item *hai);
879 void mdt_cdt_free_request(struct cdt_agent_req *car);
880 int mdt_cdt_add_request(struct coordinator *cdt, struct cdt_agent_req *new_car);
881 struct cdt_agent_req *mdt_cdt_find_request(struct coordinator *cdt, u64 cookie);
882 void mdt_cdt_get_work_done(struct cdt_agent_req *car, __u64 *done_sz);
883 void mdt_cdt_get_request(struct cdt_agent_req *car);
884 void mdt_cdt_put_request(struct cdt_agent_req *car);
885 struct cdt_agent_req *mdt_cdt_update_request(struct coordinator *cdt,
886                                          const struct hsm_progress_kernel *pgs);
887 int mdt_cdt_remove_request(struct coordinator *cdt, __u64 cookie);
888 /* mdt/mdt_coordinator.c */
889 void mdt_hsm_dump_hal(int level, const char *prefix,
890                       struct hsm_action_list *hal);
891 struct cdt_restore_handle *mdt_hsm_restore_hdl_find(struct coordinator *cdt,
892                                                 const struct lu_fid *fid);
893 /* coordinator management */
894 int mdt_hsm_cdt_init(struct mdt_device *mdt);
895 int mdt_hsm_cdt_stop(struct mdt_device *mdt);
896 int mdt_hsm_cdt_fini(struct mdt_device *mdt);
897 int mdt_hsm_cdt_wakeup(struct mdt_device *mdt);
898
899 /* coordinator control /proc interface */
900 ssize_t mdt_hsm_cdt_control_seq_write(struct file *file,
901                                       const char __user *buffer,
902                                       size_t count, loff_t *off);
903 int mdt_hsm_cdt_control_seq_show(struct seq_file *m, void *data);
904 int hsm_cdt_procfs_init(struct mdt_device *mdt);
905 void hsm_cdt_procfs_fini(struct mdt_device *mdt);
906 struct lprocfs_vars *hsm_cdt_get_proc_vars(void);
907 /* md_hsm helpers */
908 struct mdt_object *mdt_hsm_get_md_hsm(struct mdt_thread_info *mti,
909                                       const struct lu_fid *fid,
910                                       struct md_hsm *hsm);
911 /* actions/request helpers */
912 int mdt_hsm_add_hal(struct mdt_thread_info *mti,
913                     struct hsm_action_list *hal, struct obd_uuid *uuid);
914 bool mdt_hsm_is_action_compat(const struct hsm_action_item *hai,
915                               u32 archive_id, u64 rq_flags,
916                               const struct md_hsm *hsm);
917 int mdt_hsm_update_request_state(struct mdt_thread_info *mti,
918                                  struct hsm_progress_kernel *pgs,
919                                  const int update_record);
920
921 int mdt_close_swap_layouts(struct mdt_thread_info *info,
922                            struct mdt_object *o, struct md_attr *ma);
923
924 extern struct lu_context_key       mdt_thread_key;
925
926 /* debug issues helper starts here*/
927 static inline int mdt_fail_write(const struct lu_env *env,
928                                  struct dt_device *dd, int id)
929 {
930         if (OBD_FAIL_CHECK_ORSET(id, OBD_FAIL_ONCE)) {
931                 CERROR(LUSTRE_MDT_NAME": cfs_fail_loc=%x, fail write ops\n",
932                        id);
933                 return dt_ro(env, dd);
934                 /* We set FAIL_ONCE because we never "un-fail" a device */
935         }
936
937         return 0;
938 }
939
940 static inline struct mdt_export_data *mdt_req2med(struct ptlrpc_request *req)
941 {
942         return &req->rq_export->exp_mdt_data;
943 }
944
945 static inline struct mdt_device *mdt_exp2dev(struct obd_export *exp)
946 {
947         return mdt_dev(exp->exp_obd->obd_lu_dev);
948 }
949
950 static inline bool mdt_rdonly(struct obd_export *exp)
951 {
952         if (exp_connect_flags(exp) & OBD_CONNECT_RDONLY ||
953             mdt_exp2dev(exp)->mdt_bottom->dd_rdonly)
954                 return true;
955         return false;
956 }
957
958 typedef void (*mdt_reconstruct_t)(struct mdt_thread_info *mti,
959                                   struct mdt_lock_handle *lhc);
960 static inline int mdt_check_resent(struct mdt_thread_info *info,
961                                    mdt_reconstruct_t reconstruct,
962                                    struct mdt_lock_handle *lhc)
963 {
964         struct ptlrpc_request *req = mdt_info_req(info);
965         int rc = 0;
966         ENTRY;
967
968         if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) {
969                 OBD_ALLOC_PTR(info->mti_reply_data);
970                 if (info->mti_reply_data == NULL)
971                         RETURN(-ENOMEM);
972
973                 if (req_can_reconstruct(req, info->mti_reply_data)) {
974                         reconstruct(info, lhc);
975                         rc = 1;
976                 } else {
977                         DEBUG_REQ(D_HA, req,
978                                   "no reply data found for RESENT req");
979                         rc = 0;
980                 }
981                 OBD_FREE_PTR(info->mti_reply_data);
982                 info->mti_reply_data = NULL;
983         }
984         RETURN(rc);
985 }
986
987 struct lu_ucred *mdt_ucred(const struct mdt_thread_info *info);
988 struct lu_ucred *mdt_ucred_check(const struct mdt_thread_info *info);
989
990 static inline int is_identity_get_disabled(struct upcall_cache *cache)
991 {
992         return cache ? (strcmp(cache->uc_upcall, "NONE") == 0) : 1;
993 }
994
995 int mdt_blocking_ast(struct ldlm_lock*, struct ldlm_lock_desc*, void*, int);
996
997 /* Issues dlm lock on passed @ns, @f stores it lock handle into @lh. */
998 static inline int mdt_fid_lock(struct ldlm_namespace *ns,
999                                struct lustre_handle *lh, enum ldlm_mode mode,
1000                                union ldlm_policy_data *policy,
1001                                const struct ldlm_res_id *res_id,
1002                                __u64 flags, const __u64 *client_cookie)
1003 {
1004         int rc;
1005
1006         LASSERT(ns != NULL);
1007         LASSERT(lh != NULL);
1008
1009         rc = ldlm_cli_enqueue_local(ns, res_id, LDLM_IBITS, policy,
1010                                     mode, &flags, mdt_blocking_ast,
1011                                     ldlm_completion_ast, NULL, NULL, 0,
1012                                     LVB_T_NONE, client_cookie, lh);
1013         return rc == ELDLM_OK ? 0 : -EIO;
1014 }
1015
1016 static inline void mdt_fid_unlock(struct lustre_handle *lh, enum ldlm_mode mode)
1017 {
1018         ldlm_lock_decref(lh, mode);
1019 }
1020
1021 static inline bool mdt_slc_is_enabled(struct mdt_device *mdt)
1022 {
1023         return mdt->mdt_lut.lut_sync_lock_cancel == BLOCKING_SYNC_ON_CANCEL;
1024 }
1025
1026 extern mdl_mode_t mdt_mdl_lock_modes[];
1027 extern enum ldlm_mode mdt_dlm_lock_modes[];
1028
1029 /* LCK_MINMODE which is zero returns false for is_power_of_2 */
1030
1031 static inline mdl_mode_t mdt_dlm_mode2mdl_mode(enum ldlm_mode mode)
1032 {
1033         LASSERT(mode == LCK_MINMODE || is_power_of_2(mode));
1034         return mdt_mdl_lock_modes[mode];
1035 }
1036
1037 static inline enum ldlm_mode mdt_mdl_mode2dlm_mode(mdl_mode_t mode)
1038 {
1039         LASSERT(mode == MDL_MINMODE || is_power_of_2(mode));
1040         return mdt_dlm_lock_modes[mode];
1041 }
1042
1043 /* mdt_lvb.c */
1044 extern struct ldlm_valblock_ops mdt_lvbo;
1045
1046 void mdt_enable_cos(struct mdt_device *, int);
1047 int mdt_cos_is_enabled(struct mdt_device *);
1048
1049 /* lprocfs stuff */
1050 enum {
1051         LPROC_MDT_OPEN = 0,
1052         LPROC_MDT_CLOSE,
1053         LPROC_MDT_MKNOD,
1054         LPROC_MDT_LINK,
1055         LPROC_MDT_UNLINK,
1056         LPROC_MDT_MKDIR,
1057         LPROC_MDT_RMDIR,
1058         LPROC_MDT_RENAME,
1059         LPROC_MDT_GETATTR,
1060         LPROC_MDT_SETATTR,
1061         LPROC_MDT_GETXATTR,
1062         LPROC_MDT_SETXATTR,
1063         LPROC_MDT_STATFS,
1064         LPROC_MDT_SYNC,
1065         LPROC_MDT_SAMEDIR_RENAME,
1066         LPROC_MDT_CROSSDIR_RENAME,
1067         LPROC_MDT_LAST,
1068 };
1069 void mdt_counter_incr(struct ptlrpc_request *req, int opcode);
1070 void mdt_stats_counter_init(struct lprocfs_stats *stats);
1071 int mdt_procfs_init(struct mdt_device *mdt, const char *name);
1072 void mdt_procfs_fini(struct mdt_device *mdt);
1073
1074 /* lustre/mdt_mdt_lproc.c */
1075 int lprocfs_mdt_open_files_seq_open(struct inode *inode,
1076                                     struct file *file);
1077 void mdt_rename_counter_tally(struct mdt_thread_info *info,
1078                               struct mdt_device *mdt,
1079                               struct ptlrpc_request *req,
1080                               struct mdt_object *src, struct mdt_object *tgt);
1081
1082 static inline struct obd_device *mdt2obd_dev(const struct mdt_device *mdt)
1083 {
1084         return mdt->mdt_lu_dev.ld_obd;
1085 }
1086
1087 extern const struct lu_device_operations mdt_lu_ops;
1088
1089 static inline char *mdt_obd_name(struct mdt_device *mdt)
1090 {
1091         return mdt->mdt_lu_dev.ld_obd->obd_name;
1092 }
1093
1094 int mds_mod_init(void);
1095 void mds_mod_exit(void);
1096
1097 static inline char *mdt_req_get_jobid(struct ptlrpc_request *req)
1098 {
1099         struct obd_export       *exp = req->rq_export;
1100         char                    *jobid = NULL;
1101
1102         if (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS)
1103                 jobid = lustre_msg_get_jobid(req->rq_reqmsg);
1104
1105         return jobid;
1106 }
1107
1108 #endif /* _MDT_INTERNAL_H */