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