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