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