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