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