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