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