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