Whamcloud - gitweb
b11a29f7a33f7939e6bf57d5218a74697a5a4c31
[fs/lustre-release.git] / lustre / mdt / mdt_internal.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  *
31  * lustre/mdt/mdt_internal.h
32  *
33  * Lustre Metadata Target (mdt) request handler
34  *
35  * Author: Peter Braam <braam@clusterfs.com>
36  * Author: Andreas Dilger <adilger@clusterfs.com>
37  * Author: Phil Schwan <phil@clusterfs.com>
38  * Author: Mike Shaver <shaver@clusterfs.com>
39  * Author: Nikita Danilov <nikita@clusterfs.com>
40  * Author: Huang Hua <huanghua@clusterfs.com>
41  */
42
43 #ifndef _MDT_INTERNAL_H
44 #define _MDT_INTERNAL_H
45
46 #include <libcfs/libcfs.h>
47 #include <libcfs/libcfs_hash.h>
48 #include <upcall_cache.h>
49 #include <obd_class.h>
50 #include <lustre_disk.h>
51 #include <lu_target.h>
52 #include <md_object.h>
53 #include <lustre_fid.h>
54 #include <lustre_fld.h>
55 #include <lustre_req_layout.h>
56 #include <lustre_sec.h>
57 #include <lustre_idmap.h>
58 #include <lustre_quota.h>
59 #include <lustre_linkea.h>
60 #include <lustre_lmv.h>
61
62 struct mdt_object;
63
64 /* file data for open files on MDS */
65 struct mdt_file_data {
66         /**  portals handle must be first */
67         struct portals_handle   mfd_open_handle;
68         /* export data of portals_handle */
69         const struct mdt_export_data    *mfd_owner;
70         /** open mode provided by client */
71         u64                     mfd_open_flags;
72         /** protected by med_open_lock */
73         struct list_head        mfd_list;
74         /** xid of the open request */
75         __u64                   mfd_xid;
76         /** old handle in replay case */
77         struct lustre_handle    mfd_open_handle_old;
78         /** point to opened object */
79         struct mdt_object       *mfd_object;
80 };
81
82 #define CDT_NONBLOCKING_RESTORE         (1ULL << 0)
83 #define CDT_NORETRY_ACTION              (1ULL << 1)
84 #define CDT_POLICY_LAST                 CDT_NORETRY_ACTION
85 #define CDT_POLICY_SHIFT_COUNT          2
86 #define CDT_POLICY_ALL                  (CDT_NONBLOCKING_RESTORE | \
87                                         CDT_NORETRY_ACTION)
88
89 /* when adding a new policy, do not forget to update
90  * lustre/mdt/mdt_coordinator.c::hsm_policy_names[]
91  */
92 #define CDT_DEFAULT_POLICY              CDT_NORETRY_ACTION
93
94 /* Coordinator states. Keep the cdt_transition table in sync. */
95 enum cdt_states { CDT_STOPPED = 0,
96                   CDT_INIT,
97                   CDT_RUNNING,
98                   CDT_DISABLE,
99                   CDT_STOPPING,
100
101                   CDT_STATES_COUNT
102 };
103
104 static inline char *cdt_mdt_state2str(int state)
105 {
106         switch (state) {
107         case CDT_INIT:
108                 return "init";
109         case CDT_RUNNING:
110                 return "enabled";
111         case CDT_STOPPING:
112                 return "stopping";
113         case CDT_STOPPED:
114                 return "stopped";
115         case CDT_DISABLE:
116                 return "disabled";
117         default:
118                 return "unknown";
119         }
120 }
121
122 /* when multiple lock are needed, the lock order is
123  * cdt_llog_lock
124  * cdt_agent_lock
125  * cdt_counter_lock
126  * cdt_restore_lock
127  * cdt_request_lock
128  */
129 struct coordinator {
130         wait_queue_head_t        cdt_waitq;          /**< cdt wait queue */
131         bool                     cdt_event;          /**< coordinator event */
132         struct task_struct      *cdt_task;           /**< cdt thread handle */
133         struct lu_env            cdt_env;            /**< coordinator lustre
134                                                       * env */
135         struct lu_context        cdt_session;        /** session for lu_ucred */
136         struct dentry           *cdt_debugfs_dir;       /**< cdt debugfs directory */
137         struct completion        cdt_kobj_unregister;
138         struct kobject           cdt_hsm_kobj;          /* hsm sysfs object */
139         __u64                    cdt_policy;         /**< policy flags */
140         enum cdt_states          cdt_state;           /**< state */
141         struct mutex             cdt_state_lock;      /**< cdt_state lock */
142         __u64                    cdt_last_cookie;     /**< last cookie
143                                                        * allocated */
144         struct rw_semaphore      cdt_llog_lock;       /**< protect llog
145                                                        * access */
146         struct rw_semaphore      cdt_agent_lock;      /**< protect agent list */
147         struct rw_semaphore      cdt_request_lock;    /**< protect request
148                                                        * list */
149         struct mutex             cdt_restore_lock;    /**< protect restore
150                                                        * list */
151         timeout_t                cdt_loop_period;     /**< llog scan period */
152         timeout_t                cdt_grace_delay;     /**< request grace
153                                                        * delay */
154         timeout_t                cdt_active_req_timeout; /**< request timeout */
155         __u32                    cdt_default_archive_id; /**< archive id used
156                                                        * when none are
157                                                        * specified */
158         u64                      cdt_max_requests;    /**< max count of started
159                                                        * requests */
160         /** Current count of active requests */
161         atomic_t                 cdt_request_count;   /** total */
162         atomic_t                 cdt_archive_count;
163         atomic_t                 cdt_restore_count;
164         atomic_t                 cdt_remove_count;
165
166         /* started requests (struct cdt_agent_req:car_cookie_hash)
167          * indexed by cookie */
168         struct cfs_hash         *cdt_request_cookie_hash;
169         /* started requests (struct cdt_agent_req:car_request_list) */
170         struct list_head         cdt_request_list;
171         struct list_head         cdt_agents;          /**< list of register
172                                                        * agents */
173         struct list_head         cdt_restore_handle_list;
174
175         /* Hash of cookies to locations of record locations in agent
176          * request log. */
177         struct cfs_hash         *cdt_agent_record_hash;
178
179         /* Bitmasks indexed by the HSMA_XXX constants. */
180         __u64                    cdt_user_request_mask;
181         __u64                    cdt_group_request_mask;
182         __u64                    cdt_other_request_mask;
183
184         /* Remove archive on last unlink policy */
185         bool                     cdt_remove_archive_on_last_unlink;
186
187         bool                     cdt_wakeup_coordinator;
188 };
189
190 /* mdt state flag bits */
191 #define MDT_FL_CFGLOG 0
192 #define MDT_FL_SYNCED 1
193
194 /* possible values for mo_dom_lock */
195 enum {
196         NO_DOM_LOCK_ON_OPEN = 0,
197         TRYLOCK_DOM_ON_OPEN = 1,
198         /* not used anymore, left here for compatibility */
199         ALWAYS_DOM_LOCK_ON_OPEN = 2,
200         NUM_DOM_LOCK_ON_OPEN_MODES
201 };
202
203 struct mdt_statfs_cache {
204         struct obd_statfs msf_osfs;
205         __u64 msf_age;
206 };
207
208 enum mdt_rename_type {
209         RENAME_SAMEDIR_SIZE = 0,
210         RENAME_CROSSDIR_SRC_SIZE,
211         RENAME_CROSSDIR_TGT_SIZE,
212         RENAME_LAST
213 };
214
215 struct rename_stats {
216         ktime_t                 rs_init;
217         struct obd_histogram    rs_hist[RENAME_LAST];
218 };
219
220 /* split directory automatically when sub file count exceeds 50k */
221 #define DIR_SPLIT_COUNT_DEFAULT 50000
222
223 /* directory auto-split allocate delta new stripes each time */
224 #define DIR_SPLIT_DELTA_DEFAULT 4
225
226 struct mdt_dir_restriper {
227         struct lu_env           mdr_env;
228         struct lu_context       mdr_session;
229         struct task_struct     *mdr_task;
230         /* lock for below fields */
231         spinlock_t              mdr_lock;
232         /* auto split when plain dir/shard sub files exceed threshold */
233         u64                     mdr_dir_split_count;
234         /* auto split growth delta */
235         u32                     mdr_dir_split_delta;
236         /* directories to split */
237         struct list_head        mdr_auto_splitting;
238         /* directories under which sub files are migrating */
239         struct list_head        mdr_migrating;
240         /* directories waiting to update layout after migration */
241         struct list_head        mdr_updating;
242         /* time to update directory layout after migration */
243         time64_t                mdr_update_time;
244         /* lum used in split/migrate/layout_change */
245         union lmv_mds_md        mdr_lmv;
246         /* page used in readdir */
247         struct page            *mdr_page;
248 };
249
250 struct mdt_device {
251         /* super-class */
252         struct lu_device           mdt_lu_dev;
253         struct seq_server_site     mdt_seq_site;
254         /* DLM name-space for meta-data locks maintained by this server */
255         struct ldlm_namespace     *mdt_namespace;
256         /* ptlrpc handle for MDS->client connections (for lock ASTs). */
257         struct ptlrpc_client      *mdt_ldlm_client;
258         /* underlying device */
259         struct obd_export         *mdt_child_exp;
260         struct md_device          *mdt_child;
261         struct dt_device          *mdt_bottom;
262         struct obd_export         *mdt_bottom_exp;
263         struct local_oid_storage  *mdt_los;
264         /** target device */
265         struct lu_target           mdt_lut;
266         /*
267          * Options bit-fields.
268          */
269         struct {
270                 unsigned int       mo_user_xattr:1,
271                                    mo_acl:1,
272                                    mo_cos:1,
273                                    mo_evict_tgt_nids:1,
274                                    mo_dom_read_open:1,
275                                    mo_migrate_hsm_allowed:1,
276                                    mo_enable_strict_som:1;
277                 unsigned int       mo_dom_lock;
278         } mdt_opts;
279         /* mdt state flags */
280         unsigned long              mdt_state;
281
282         /* transaction callbacks */
283         struct dt_txn_callback     mdt_txn_cb;
284
285         /* these values should be updated from lov if necessary.
286          * or should be placed somewhere else. */
287         int                        mdt_max_mdsize;
288
289         int                        mdt_max_ea_size;
290
291         /* Max modify RPCs, replaces max_mod_rpcs_per_client module param */
292         unsigned int                       mdt_max_mod_rpcs_in_flight;
293
294         /* preferred BRW size, decided by storage type and capability */
295         __u32                      mdt_brw_size;
296
297         struct upcall_cache       *mdt_identity_cache;
298
299         unsigned int               mdt_capa_conf:1,
300                                    /* Enable remote dir on non-MDT0 */
301                                    mdt_enable_dir_migration:1,
302                                    mdt_enable_dir_restripe:1,
303                                    mdt_enable_dir_auto_split:1,
304                                    mdt_enable_parallel_rename_dir:1,
305                                    mdt_enable_parallel_rename_file:1,
306                                    mdt_enable_remote_dir:1,
307                                    mdt_enable_remote_rename:1,
308                                    mdt_enable_striped_dir:1,
309                                    mdt_readonly:1,
310                                    mdt_skip_lfsck:1,
311                                    /* dir restripe migrate dirent only */
312                                    mdt_dir_restripe_nsonly:1;
313
314                                    /* user with gid can create remote/striped
315                                     * dir, and set default dir stripe */
316         gid_t                      mdt_enable_remote_dir_gid;
317                                    /* user with this gid can change projid */
318         gid_t                      mdt_enable_chprojid_gid;
319
320         /* lock for osfs and md_root */
321         spinlock_t                 mdt_lock;
322
323         /* statfs optimization: we cache a bit  */
324         struct mdt_statfs_cache    mdt_sum_osfs;
325         struct mdt_statfs_cache    mdt_osfs;
326
327         /* root squash */
328         struct root_squash_info    mdt_squash;
329
330         struct rename_stats        mdt_rename_stats;
331         struct lu_fid              mdt_md_root_fid;
332
333         /* connection to quota master */
334         struct obd_export         *mdt_qmt_exp;
335         /* quota master device associated with this MDT */
336         struct lu_device          *mdt_qmt_dev;
337
338         struct coordinator         mdt_coordinator;
339
340         /* inter-MDT connection count */
341         atomic_t                   mdt_mds_mds_conns;
342
343         /* MDT device async commit count, used for debug and sanity test */
344         atomic_t                   mdt_async_commit_count;
345
346         struct mdt_object         *mdt_md_root;
347
348         struct mdt_dir_restriper   mdt_restriper;
349 };
350
351 #define MDT_SERVICE_WATCHDOG_FACTOR     (2)
352 #define MDT_COS_DEFAULT         (0)
353
354 #define ENOENT_VERSION 1        /** 'virtual' version of non-existent object */
355
356 struct mdt_object {
357         struct lu_object_header mot_header;
358         struct lu_object        mot_obj;
359         unsigned int            mot_lov_created:1,  /* lov object created */
360                                 mot_cache_attr:1,   /* enable remote object
361                                                      * attribute cache */
362                                 mot_restriping:1,   /* dir restriping */
363                                 /* dir auto-split disabled */
364                                 mot_auto_split_disabled:1,
365                                 mot_lsom_inited:1; /* lsom was inited */
366         int                     mot_write_count;
367         spinlock_t              mot_write_lock;
368         /* Lock to protect create_data */
369         struct mutex            mot_lov_mutex;
370         /* Lock to protect object's SOM update. */
371         struct mutex            mot_som_mutex;
372         __u64                   mot_lsom_size;
373         __u64                   mot_lsom_blocks;
374         /* lock to protect read/write stages for Data-on-MDT files */
375         struct rw_semaphore     mot_dom_sem;
376         /* Lock to protect lease open.
377          * Lease open acquires write lock; normal open acquires read lock */
378         struct rw_semaphore     mot_open_sem;
379         atomic_t                mot_lease_count;
380         atomic_t                mot_open_count;
381         /* directory offset, used in sub file migration in dir restripe */
382         loff_t                  mot_restripe_offset;
383         /* link to mdt_restriper auto_splitting/migrating/updating */
384         struct list_head        mot_restripe_linkage;
385 };
386
387 struct mdt_lock_handle {
388         /* Lock type, reg for cross-ref use or pdo lock. */
389         mdl_type_t              mlh_type;
390
391         /* Regular lock */
392         struct lustre_handle    mlh_reg_lh;
393         enum ldlm_mode          mlh_reg_mode;
394         __u64                   mlh_gid;
395
396         /* Pdirops lock */
397         struct lustre_handle    mlh_pdo_lh;
398         enum ldlm_mode          mlh_pdo_mode;
399         unsigned int            mlh_pdo_hash;
400
401         /* Remote regular lock */
402         struct lustre_handle    mlh_rreg_lh;
403         enum ldlm_mode          mlh_rreg_mode;
404 };
405
406 enum {
407         MDT_LH_PARENT,  /* parent lockh */
408         MDT_LH_CHILD,   /* child lockh */
409         MDT_LH_OLD,     /* old lockh for rename */
410         MDT_LH_LAYOUT = MDT_LH_OLD, /* layout lock */
411         MDT_LH_NEW,     /* new lockh for rename */
412         MDT_LH_RMT,     /* used for return lh to caller */
413         MDT_LH_LOCAL,   /* local lock never return to client */
414         MDT_LH_LOOKUP,  /* lookup lock for source object in rename/migrate if
415                          * it's remote object */
416         MDT_LH_NR
417 };
418
419 enum {
420         MDT_LOCAL_LOCK,
421         MDT_CROSS_LOCK
422 };
423
424 /* Special magical errno for communicaiton between mdt_reint_open()
425  * and mdt_intent_reint() which means return the lock to the client
426  * for subsequent cross ref open. Previously we used plain -EREMOTE
427  * but other functions called in that path might return it too and
428  * confuse us. This is not returned to the client. See LU-5370. */
429 #define MDT_EREMOTE_OPEN (EREMOTE + 1024)
430
431 struct mdt_reint_record {
432         enum mds_reint_op                rr_opcode;
433         const struct lustre_handle      *rr_open_handle;
434         const struct lustre_handle      *rr_lease_handle;
435         const struct lu_fid             *rr_fid1;
436         const struct lu_fid             *rr_fid2;
437         struct lu_name                   rr_name;
438         struct lu_name                   rr_tgt_name;
439         void                            *rr_eadata;
440         int                              rr_eadatalen;
441         __u32                            rr_flags;
442         __u16                            rr_mirror_id;
443 };
444
445 enum mdt_reint_flag {
446         MRF_OPEN_TRUNC = BIT(0),
447         MRF_OPEN_RESEND = BIT(1),
448 };
449
450 /*
451  * Common data shared by mdt-level handlers. This is allocated per-thread to
452  * reduce stack consumption.
453  */
454 struct mdt_thread_info {
455         /*
456          * XXX: Part One:
457          * The following members will be filled explicitly
458          * with specific data in mdt_thread_info_init().
459          */
460         /* TODO: move this into mdt_session_key(with LCT_SESSION), because
461          * request handling may migrate from one server thread to another.
462          */
463         struct req_capsule        *mti_pill;
464
465         /*
466          * SUB request pill in a batch request.
467          */
468         struct req_capsule          mti_sub_pill;
469
470         /* although we have export in req, there are cases when it is not
471          * available, e.g. closing files upon export destroy */
472         struct obd_export          *mti_exp;
473         /*
474          * A couple of lock handles.
475          */
476         struct mdt_lock_handle     mti_lh[MDT_LH_NR];
477
478         struct mdt_device         *mti_mdt;
479         const struct lu_env       *mti_env;
480
481         /* transaction number of current request */
482         __u64                      mti_transno;
483
484         /*
485          * XXX: Part Two:
486          * The following members will be filled expilictly
487          * with zero in mdt_thread_info_init(). These members may be used
488          * by all requests.
489          */
490
491         /*
492          * Object attributes.
493          */
494         struct md_attr             mti_attr;
495         struct md_attr             mti_attr2; /* mdt_lvb.c */
496         /*
497          * Body for "habeo corpus" operations.
498          */
499         const struct mdt_body     *mti_body;
500         /*
501          * Host object. This is released at the end of mdt_handler().
502          */
503         struct mdt_object         *mti_object;
504         /*
505          * Lock request for "habeo clavis" operations.
506          */
507         const struct ldlm_request *mti_dlm_req;
508
509         __u32                      mti_cross_ref:1,
510         /* big_lmm buffer was used and must be used in reply */
511                                    mti_big_lmm_used:1,
512                                    mti_big_acl_used:1,
513                                    mti_som_strict:1,
514         /* Batch processing environment */
515                                    mti_batch_env:1;
516
517         /* opdata for mdt_reint_open(), has the same as
518          * ldlm_reply:lock_policy_res1.  mdt_update_last_rcvd() stores this
519          * value onto disk for recovery when mdt_trans_stop_cb() is called.
520          */
521         __u64                      mti_opdata;
522
523         /*
524          * XXX: Part Three:
525          * The following members will be filled explicitly
526          * with zero in mdt_reint_unpack(), because they are only used
527          * by reint requests (including mdt_reint_open()).
528          */
529
530         /*
531          * reint record. contains information for reint operations.
532          */
533         struct mdt_reint_record    mti_rr;
534
535         __u64                      mti_ver[PTLRPC_NUM_VERSIONS];
536         /*
537          * Operation specification (currently create and lookup)
538          */
539         struct md_op_spec          mti_spec;
540
541         /*
542          * XXX: Part Four:
543          * The following members will _NOT_ be initialized at all.
544          * DO NOT expect them to contain any valid value.
545          * They should be initialized explicitly by the user themselves.
546          */
547
548         /* XXX: If something is in a union, make sure they do not conflict */
549         struct lu_fid                   mti_tmp_fid1;
550         struct lu_fid                   mti_tmp_fid2;
551         union ldlm_policy_data          mti_policy; /* for mdt_object_lock() */
552         struct ldlm_res_id              mti_res_id; /* and mdt_rename_lock() */
553         union {
554                 struct obd_uuid         uuid[2];    /* for mdt_seq_init_cli() */
555                 char                    ns_name[48];/* for mdt_init0()        */
556                 struct lustre_cfg_bufs  bufs;       /* for mdt_stack_fini()   */
557                 struct obd_statfs       osfs;       /* for mdt_statfs()       */
558                 struct {
559                         /* for mdt_readpage()      */
560                         struct lu_rdpg     mti_rdpg;
561                 } rdpg;
562                 struct {
563                         struct md_attr attr;
564                 } hsm;
565                 struct {
566                         struct md_attr attr;
567                 } som;
568         } mti_u;
569
570         struct lustre_handle       mti_open_handle;
571         loff_t                     mti_off;
572         struct lu_buf              mti_buf;
573         struct lu_buf              mti_big_buf;
574
575         /* Ops object filename */
576         struct lu_name             mti_name;
577         char                       mti_filename[NAME_MAX + 1];
578         /* per-thread values, can be re-used, may be vmalloc'd */
579         void                      *mti_big_lmm;
580         void                      *mti_big_acl;
581         int                        mti_big_lmmsize;
582         int                        mti_big_aclsize;
583         /* should be enough to fit lustre_mdt_attrs */
584         char                       mti_xattr_buf[128];
585         struct ldlm_enqueue_info   mti_einfo;
586         /* einfo used by mdt_remote_object_lock_try() */
587         struct ldlm_enqueue_info   mti_remote_einfo;
588         struct tg_reply_data      *mti_reply_data;
589
590         /* FLR: layout change API */
591         struct md_layout_change    mti_mlc;
592
593         struct lu_seq_range        mti_range;
594 };
595
596 extern struct lu_context_key mdt_thread_key;
597
598 static inline struct mdt_thread_info *mdt_th_info(const struct lu_env *env)
599 {
600         return lu_env_info(env, &mdt_thread_key);
601 }
602
603 struct cdt_req_progress {
604         spinlock_t               crp_lock;      /**< protect tree */
605         struct interval_tree_root crp_root;     /**< tree to track extent
606                                                  *   moved */
607         __u64                    crp_total;
608 };
609
610 struct cdt_agent_req {
611         struct hlist_node        car_cookie_hash;  /**< find req by cookie */
612         struct list_head         car_request_list; /**< to chain all the req. */
613         atomic_t                 car_refcount;     /**< reference counter */
614         __u64                    car_flags;        /**< request original flags */
615         struct obd_uuid          car_uuid;         /**< agent doing the req. */
616         __u32                    car_archive_id;   /**< archive id */
617         int                      car_canceled;     /**< request was canceled */
618         time64_t                 car_req_start;    /**< start time */
619         time64_t                 car_req_update;   /**< last update time */
620         struct hsm_action_item  *car_hai;          /**< req. to the agent */
621         struct cdt_req_progress  car_progress;     /**< track data mvt
622                                                     *   progress */
623 };
624 extern struct kmem_cache *mdt_hsm_car_kmem;
625
626 struct hsm_agent {
627         struct list_head ha_list;               /**< to chain the agents */
628         struct obd_uuid  ha_uuid;               /**< agent uuid */
629         __u32           *ha_archive_id;         /**< archive id */
630         int              ha_archive_cnt;        /**< number of archive entries
631                                                  *   0 means any archive */
632         atomic_t         ha_requests;           /**< current request count */
633         atomic_t         ha_success;            /**< number of successful
634                                                  * actions */
635         atomic_t         ha_failure;            /**< number of failed actions */
636 };
637
638 struct cdt_restore_handle {
639         struct list_head        crh_list;       /**< to chain the handle */
640         struct lu_fid           crh_fid;        /**< fid of the object */
641         struct ldlm_extent      crh_extent;     /**< extent of the restore */
642         struct mdt_lock_handle  crh_lh;         /**< lock handle */
643 };
644 extern struct kmem_cache *mdt_hsm_cdt_kmem;     /** restore handle slab cache */
645
646 struct hsm_record_update {
647         __u64 cookie;
648         enum agent_req_status status;
649 };
650
651 static inline const struct md_device_operations *
652 mdt_child_ops(struct mdt_device * m)
653 {
654         LASSERT(m->mdt_child);
655         return m->mdt_child->md_ops;
656 }
657
658 static inline struct md_object *mdt_object_child(struct mdt_object *o)
659 {
660         LASSERT(o);
661         return lu2md(lu_object_next(&o->mot_obj));
662 }
663
664 static inline struct ptlrpc_request *mdt_info_req(struct mdt_thread_info *info)
665 {
666          return info->mti_pill ? info->mti_pill->rc_req : NULL;
667 }
668
669 static inline __u64 mdt_conn_flags(struct mdt_thread_info *info)
670 {
671         LASSERT(info->mti_exp);
672         return exp_connect_flags(info->mti_exp);
673 }
674
675 static inline void mdt_object_get(const struct lu_env *env,
676                                   struct mdt_object *o)
677 {
678         ENTRY;
679         lu_object_get(&o->mot_obj);
680         EXIT;
681 }
682
683 static inline void mdt_object_put(const struct lu_env *env,
684                                   struct mdt_object *o)
685 {
686         ENTRY;
687         lu_object_put(env, &o->mot_obj);
688         EXIT;
689 }
690
691 static inline int mdt_object_exists(const struct mdt_object *o)
692 {
693         return lu_object_exists(&o->mot_obj);
694 }
695
696 static inline int mdt_object_remote(const struct mdt_object *o)
697 {
698         return lu_object_remote(&o->mot_obj);
699 }
700
701 static inline const struct lu_fid *mdt_object_fid(const struct mdt_object *o)
702 {
703         return lu_object_fid(&o->mot_obj);
704 }
705
706 static inline struct lu_site *mdt_lu_site(const struct mdt_device *mdt)
707 {
708         return mdt->mdt_lu_dev.ld_site;
709 }
710
711 static inline struct seq_server_site *mdt_seq_site(struct mdt_device *mdt)
712 {
713         return &mdt->mdt_seq_site;
714 }
715
716 static inline void mdt_export_evict(struct obd_export *exp)
717 {
718         class_fail_export(exp);
719 }
720
721 /* Here we use LVB_TYPE to check dne client, because it is
722  * also landed on 2.4. */
723 static inline bool mdt_is_dne_client(struct obd_export *exp)
724 {
725         return !!(exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE);
726 }
727
728 static inline bool mdt_is_striped_client(struct obd_export *exp)
729 {
730         return exp_connect_flags(exp) & OBD_CONNECT_DIR_STRIPE;
731 }
732
733 __u32 mdt_lmm_dom_entry_check(struct lov_mds_md *lmm, int *dom_only);
734
735 static inline bool mdt_lmm_dom_only(struct lov_mds_md *lmm)
736 {
737         int dom_only = 0;
738
739         mdt_lmm_dom_entry_check(lmm, &dom_only);
740         return dom_only;
741 }
742
743 static inline __u32 mdt_lmm_dom_stripesize(struct lov_mds_md *lmm)
744 {
745         return mdt_lmm_dom_entry_check(lmm, NULL);
746 }
747
748 static inline bool mdt_lmm_is_flr(struct lov_mds_md *lmm)
749 {
750         struct lov_comp_md_v1 *lcm = (typeof(lcm))lmm;
751
752         return le32_to_cpu(lmm->lmm_magic) == LOV_MAGIC_COMP_V1 &&
753                le16_to_cpu(lcm->lcm_mirror_count) > 0;
754 }
755
756 static inline bool lmm_is_overstriping(struct lov_mds_md *lmm)
757 {
758         if (le32_to_cpu(lmm->lmm_magic) == LOV_MAGIC_V1 ||
759             le32_to_cpu(lmm->lmm_magic) == LOV_MAGIC_V3)
760                 return le16_to_cpu(lmm->lmm_pattern) & LOV_PATTERN_OVERSTRIPING;
761
762         return false;
763 }
764
765 static inline bool mdt_lmm_comp_overstriping(struct lov_mds_md *lmm)
766 {
767         struct lov_comp_md_v1 *comp_v1;
768         struct lov_mds_md *v1;
769         __u32 off;
770         int i;
771
772         comp_v1 = (struct lov_comp_md_v1 *)lmm;
773
774         for (i = 0; i < le16_to_cpu(comp_v1->lcm_entry_count); i++) {
775                 off = le32_to_cpu(comp_v1->lcm_entries[i].lcme_offset);
776                 v1 = (struct lov_mds_md *)((char *)comp_v1 + off);
777
778                 if (lmm_is_overstriping(v1))
779                         return true;
780         }
781
782         return false;
783 }
784
785 static inline bool mdt_lmm_is_overstriping(struct lov_mds_md *lmm)
786 {
787         if (le32_to_cpu(lmm->lmm_magic) == LOV_MAGIC_COMP_V1)
788                 return mdt_lmm_comp_overstriping(lmm);
789
790         return lmm_is_overstriping(lmm);
791 }
792
793 static inline bool mdt_is_sum_statfs_client(struct obd_export *exp)
794 {
795         return exp_connect_flags(exp) & OBD_CONNECT_FLAGS2 &&
796                exp_connect_flags2(exp) & OBD_CONNECT2_SUM_STATFS;
797 }
798
799 __u64 mdt_get_disposition(struct ldlm_reply *rep, __u64 op_flag);
800 void mdt_set_disposition(struct mdt_thread_info *info,
801                          struct ldlm_reply *rep, __u64 op_flag);
802 void mdt_clear_disposition(struct mdt_thread_info *info,
803                            struct ldlm_reply *rep, __u64 op_flag);
804
805 void mdt_lock_pdo_init(struct mdt_lock_handle *lh, enum ldlm_mode lock_mode,
806                        const struct lu_name *lname);
807
808 void mdt_lock_reg_init(struct mdt_lock_handle *lh, enum ldlm_mode lm);
809 void mdt_lh_reg_init(struct mdt_lock_handle *lh, struct ldlm_lock *lock);
810
811 int mdt_lock_setup(struct mdt_thread_info *info, struct mdt_object *mo,
812                    struct mdt_lock_handle *lh);
813
814 int mdt_check_resent_lock(struct mdt_thread_info *info, struct mdt_object *mo,
815                           struct mdt_lock_handle *lhc);
816
817 int mdt_object_lock(struct mdt_thread_info *info, struct mdt_object *obj,
818                     struct mdt_lock_handle *lh, __u64 ibits,
819                     enum ldlm_mode mode, bool cos_incompat);
820 int mdt_parent_lock(struct mdt_thread_info *info, struct mdt_object *o,
821                     struct mdt_lock_handle *lh, const struct lu_name *lname,
822                     enum ldlm_mode mode, bool cos_incompat);
823 int mdt_object_stripes_lock(struct mdt_thread_info *info,
824                             struct mdt_object *pobj, struct mdt_object *o,
825                             struct mdt_lock_handle *lh,
826                             struct ldlm_enqueue_info *einfo, __u64 ibits,
827                             enum ldlm_mode mode, bool cos_incompat);
828 int mdt_object_check_lock(struct mdt_thread_info *info,
829                           struct mdt_object *parent, struct mdt_object *child,
830                           struct mdt_lock_handle *lh, __u64 ibits,
831                           enum ldlm_mode mode, bool cos_incompat);
832 int mdt_object_lock_try(struct mdt_thread_info *info, struct mdt_object *mo,
833                         struct mdt_lock_handle *lh, __u64 *ibits,
834                         __u64 trybits, enum ldlm_mode mode, bool cos_incompat);
835
836 /* below three lock functions are used internally */
837 int mdt_object_lock_internal(struct mdt_thread_info *info,
838                              struct mdt_object *obj, const struct lu_fid *fid,
839                              struct mdt_lock_handle *lh, __u64 *ibits,
840                              __u64 trybits, bool cache, bool cos_incompat);
841 int mdt_object_pdo_lock(struct mdt_thread_info *info, struct mdt_object *obj,
842                         struct mdt_lock_handle *lh, const struct lu_name *name,
843                         enum ldlm_mode mode, bool pdo_lock, bool cos_incompat);
844 int mdt_object_lookup_lock(struct mdt_thread_info *info,
845                            struct mdt_object *pobj, struct mdt_object *obj,
846                            struct mdt_lock_handle *lh, enum ldlm_mode mode,
847                            bool cos_incompat);
848
849 void mdt_object_unlock(struct mdt_thread_info *info, struct mdt_object *mo,
850                        struct mdt_lock_handle *lh, int decref);
851 void mdt_object_stripes_unlock(struct mdt_thread_info *info,
852                                struct mdt_object *o, struct mdt_lock_handle *lh,
853                                struct ldlm_enqueue_info *einfo, int decref);
854
855 struct mdt_object *mdt_object_new(const struct lu_env *env,
856                                   struct mdt_device *,
857                                   const struct lu_fid *);
858 struct mdt_object *mdt_object_find(const struct lu_env *,
859                                    struct mdt_device *,
860                                    const struct lu_fid *);
861 struct mdt_object *mdt_object_find_lock(struct mdt_thread_info *info,
862                                         const struct lu_fid *f,
863                                         struct mdt_lock_handle *lh,
864                                         __u64 ibits, enum ldlm_mode mode);
865 void mdt_object_unlock_put(struct mdt_thread_info *info,
866                            struct mdt_object *o,
867                            struct mdt_lock_handle *lh,
868                            int decref);
869
870 void mdt_client_compatibility(struct mdt_thread_info *info);
871
872 enum mdt_name_flags {
873         MNF_FIX_ANON = 1,
874 };
875
876 int mdt_name_unpack(struct req_capsule *pill,
877                     const struct req_msg_field *field,
878                     struct lu_name *ln,
879                     enum mdt_name_flags flags);
880 int mdt_close_unpack(struct mdt_thread_info *info);
881 int mdt_reint_unpack(struct mdt_thread_info *info, __u32 op);
882 void mdt_fix_lov_magic(struct mdt_thread_info *info, void *eadata);
883 int mdt_reint_rec(struct mdt_thread_info *, struct mdt_lock_handle *);
884 #ifdef CONFIG_LUSTRE_FS_POSIX_ACL
885 int mdt_pack_acl2body(struct mdt_thread_info *info, struct mdt_body *repbody,
886                       struct mdt_object *o, struct lu_nodemap *nodemap);
887 #endif
888 void mdt_pack_attr2body(struct mdt_thread_info *info, struct mdt_body *b,
889                         const struct lu_attr *attr, const struct lu_fid *fid);
890 int mdt_pack_size2body(struct mdt_thread_info *info,
891                         const struct lu_fid *fid,  struct lustre_handle *lh);
892 int mdt_getxattr(struct mdt_thread_info *info);
893 int mdt_reint_setxattr(struct mdt_thread_info *info,
894                        struct mdt_lock_handle *lh);
895
896 void mdt_reconstruct(struct mdt_thread_info *, struct mdt_lock_handle *);
897 void mdt_reconstruct_generic(struct mdt_thread_info *mti,
898                              struct mdt_lock_handle *lhc);
899
900 extern void target_recovery_fini(struct obd_device *obd);
901 extern void target_recovery_init(struct lu_target *lut,
902                                  svc_handler_t handler);
903
904 int mdt_export_stats_init(struct obd_device *obd,
905                           struct obd_export *exp,
906                           void *client_nid);
907
908 int mdt_lock_new_child(struct mdt_thread_info *info,
909                        struct mdt_object *o,
910                        struct mdt_lock_handle *child_lockh);
911 void mdt_mfd_set_mode(struct mdt_file_data *mfd, u64 open_flags);
912 int mdt_reint_open(struct mdt_thread_info *info, struct mdt_lock_handle *lhc);
913 struct mdt_file_data *mdt_open_handle2mfd(struct mdt_export_data *med,
914                                         const struct lustre_handle *open_handle,
915                                         bool is_replay);
916 int mdt_revoke_remote_lookup_lock(struct mdt_thread_info *info,
917                                   struct mdt_object *pobj,
918                                   struct mdt_object *obj);
919
920 int mdt_get_info(struct tgt_session_info *tsi);
921 int mdt_attr_get_complex(struct mdt_thread_info *info,
922                          struct mdt_object *o, struct md_attr *ma);
923 int mdt_big_xattr_get(struct mdt_thread_info *info, struct mdt_object *o,
924                       const char *name);
925 int __mdt_stripe_get(struct mdt_thread_info *info, struct mdt_object *o,
926                      struct md_attr *ma, const char *name);
927 int mdt_stripe_get(struct mdt_thread_info *info, struct mdt_object *o,
928                    struct md_attr *ma, const char *name);
929 int mdt_attr_get_pfid(struct mdt_thread_info *info, struct mdt_object *o,
930                       struct lu_fid *pfid);
931 int mdt_attr_get_pfid_name(struct mdt_thread_info *info, struct mdt_object *o,
932                            struct lu_fid *pfid, struct lu_name *lname);
933 int mdt_write_get(struct mdt_object *o);
934 void mdt_write_put(struct mdt_object *o);
935 int mdt_write_read(struct mdt_object *o);
936 struct mdt_file_data *mdt_mfd_new(const struct mdt_export_data *med);
937 int mdt_mfd_close(struct mdt_thread_info *info, struct mdt_file_data *mfd);
938 void mdt_mfd_free(struct mdt_file_data *mfd);
939 int mdt_close(struct tgt_session_info *tsi);
940 int mdt_add_dirty_flag(struct mdt_thread_info *info, struct mdt_object *mo,
941                         struct md_attr *ma);
942 int mdt_fix_reply(struct mdt_thread_info *info);
943 int mdt_handle_last_unlink(struct mdt_thread_info *, struct mdt_object *,
944                            struct md_attr *);
945 void mdt_reconstruct_open(struct mdt_thread_info *, struct mdt_lock_handle *);
946 int mdt_layout_change(struct mdt_thread_info *info, struct mdt_object *obj,
947                       struct mdt_lock_handle *lhc,
948                       struct md_layout_change *spec);
949 int find_name_matching_hash(struct mdt_thread_info *info, struct lu_name *lname,
950                            struct mdt_object *parent, struct mdt_object *child);
951 int mdt_device_sync(const struct lu_env *env, struct mdt_device *mdt);
952
953 struct lu_buf *mdt_buf(const struct lu_env *env, void *area, ssize_t len);
954 const struct lu_buf *mdt_buf_const(const struct lu_env *env,
955                                    const void *area, ssize_t len);
956
957 void mdt_dump_lmm(int level, const struct lov_mds_md *lmm, __u64 valid);
958 void mdt_dump_lmv(unsigned int level, const union lmv_mds_md *lmv);
959
960 bool allow_client_chgrp(struct mdt_thread_info *info, struct lu_ucred *uc);
961 int mdt_check_ucred(struct mdt_thread_info *);
962 int mdt_init_ucred(struct mdt_thread_info *, struct mdt_body *);
963 int mdt_init_ucred_reint(struct mdt_thread_info *);
964 void mdt_exit_ucred(struct mdt_thread_info *);
965 int mdt_version_get_check(struct mdt_thread_info *, struct mdt_object *, int);
966 void mdt_version_get_save(struct mdt_thread_info *, struct mdt_object *, int);
967 int mdt_version_get_check_save(struct mdt_thread_info *, struct mdt_object *,
968                                int);
969 int mdt_lookup_version_check(struct mdt_thread_info *info,
970                              struct mdt_object *p,
971                              const struct lu_name *lname,
972                              struct lu_fid *fid, int idx);
973 void mdt_thread_info_reset(struct mdt_thread_info *info);
974 void mdt_thread_info_init(struct ptlrpc_request *req,
975                           struct mdt_thread_info *mti);
976 void mdt_thread_info_fini(struct mdt_thread_info *mti);
977 struct mdt_thread_info *tsi2mdt_info(struct tgt_session_info *tsi);
978 void mdt_intent_fixup_resent(struct mdt_thread_info *info,
979                              struct ldlm_lock *new_lock,
980                              struct mdt_lock_handle *lh, __u64 flags);
981 int mdt_intent_lock_replace(struct mdt_thread_info *info,
982                             struct ldlm_lock **lockp,
983                             struct mdt_lock_handle *lh,
984                             __u64 flags, int result);
985
986 int hsm_init_ucred(struct lu_ucred *uc);
987 int mdt_hsm_attr_set(struct mdt_thread_info *info, struct mdt_object *obj,
988                      const struct md_hsm *mh);
989
990 int mdt_remote_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
991                             void *data, int flag);
992 int mdt_links_read(struct mdt_thread_info *info,
993                    struct mdt_object *mdt_obj,
994                    struct linkea_data *ldata);
995 int mdt_close_internal(struct mdt_thread_info *info, struct ptlrpc_request *req,
996                        struct mdt_body *repbody);
997 int mdt_pack_secctx_in_reply(struct mdt_thread_info *info,
998                              struct mdt_object *child);
999 int mdt_pack_encctx_in_reply(struct mdt_thread_info *info,
1000                              struct mdt_object *child);
1001
1002 static inline struct mdt_device *mdt_dev(struct lu_device *d)
1003 {
1004         return container_of_safe(d, struct mdt_device, mdt_lu_dev);
1005 }
1006
1007 static inline struct mdt_object *mdt_obj(struct lu_object *o)
1008 {
1009         return container_of_safe(o, struct mdt_object, mot_obj);
1010 }
1011
1012 static inline struct dt_object *mdt_obj2dt(struct mdt_object *mo)
1013 {
1014         struct lu_object        *lo;
1015         struct mdt_device       *mdt = mdt_dev(mo->mot_obj.lo_dev);
1016
1017         lo = lu_object_locate(mo->mot_obj.lo_header,
1018                               mdt->mdt_bottom->dd_lu_dev.ld_type);
1019
1020         return lu2dt(lo);
1021 }
1022
1023 static inline bool agent_req_in_final_state(enum agent_req_status ars)
1024 {
1025         return ((ars == ARS_SUCCEED) || (ars == ARS_FAILED) ||
1026                 (ars == ARS_CANCELED));
1027 }
1028
1029 /* mdt/mdt_identity.c */
1030 #define MDT_IDENTITY_UPCALL_PATH        "/usr/sbin/l_getidentity"
1031
1032 extern struct upcall_cache_ops mdt_identity_upcall_cache_ops;
1033
1034 struct md_identity *mdt_identity_get(struct upcall_cache *, __u32);
1035
1036 void mdt_identity_put(struct upcall_cache *, struct md_identity *);
1037
1038 void mdt_flush_identity(struct upcall_cache *, int);
1039
1040 __u32 mdt_identity_get_perm(struct md_identity *identity, struct lnet_nid *nid);
1041
1042 /* mdt/mdt_recovery.c */
1043 __u64 mdt_req_from_lrd(struct ptlrpc_request *req, struct tg_reply_data *trd);
1044
1045 /* mdt/mdt_batch.c */
1046 int mdt_batch(struct tgt_session_info *tsi);
1047
1048 /* mdt/mdt_hsm.c */
1049 int mdt_hsm_state_get(struct tgt_session_info *tsi);
1050 int mdt_hsm_state_set(struct tgt_session_info *tsi);
1051 int mdt_hsm_action(struct tgt_session_info *tsi);
1052 int mdt_hsm_progress(struct tgt_session_info *tsi);
1053 int mdt_hsm_ct_register(struct tgt_session_info *tsi);
1054 int mdt_hsm_ct_unregister(struct tgt_session_info *tsi);
1055 int mdt_hsm_request(struct tgt_session_info *tsi);
1056
1057 /* mdt/mdt_hsm_cdt_actions.c */
1058 extern const struct file_operations mdt_hsm_actions_fops;
1059 void dump_llog_agent_req_rec(const char *prefix,
1060                              const struct llog_agent_req_rec *larr);
1061 int cdt_llog_process(const struct lu_env *env, struct mdt_device *mdt,
1062                      llog_cb_t cb, void *data, u32 start_cat_idx,
1063                      u32 start_rec_idx, int rw);
1064 int mdt_agent_record_add(const struct lu_env *env, struct mdt_device *mdt,
1065                          __u32 archive_id, __u64 flags,
1066                          struct hsm_action_item *hai);
1067 int mdt_agent_record_update(struct mdt_thread_info *mti,
1068                             struct hsm_record_update *updates,
1069                             unsigned int updates_count);
1070 void cdt_agent_record_hash_add(struct coordinator *cdt, u64 cookie, u32 cat_idt,
1071                                u32 rec_idx);
1072 void cdt_agent_record_hash_lookup(struct coordinator *cdt, u64 cookie,
1073                                   u32 *cat_idt, u32 *rec_idx);
1074 void cdt_agent_record_hash_del(struct coordinator *cdt, u64 cookie);
1075
1076 /* mdt/mdt_hsm_cdt_agent.c */
1077 extern const struct file_operations mdt_hsm_agent_fops;
1078 int mdt_hsm_agent_register(struct mdt_thread_info *info,
1079                            const struct obd_uuid *uuid,
1080                            int nr_archives, __u32 *archive_num);
1081 int mdt_hsm_agent_register_mask(struct mdt_thread_info *info,
1082                                 const struct obd_uuid *uuid,
1083                                 __u32 archive_mask);
1084 int mdt_hsm_agent_unregister(struct mdt_thread_info *info,
1085                              const struct obd_uuid *uuid);
1086 int mdt_hsm_agent_update_statistics(struct coordinator *cdt,
1087                                     int succ_rq, int fail_rq, int new_rq,
1088                                     const struct obd_uuid *uuid);
1089 int mdt_hsm_find_best_agent(struct coordinator *cdt, __u32 archive,
1090                             struct obd_uuid *uuid);
1091 int mdt_hsm_agent_send(struct mdt_thread_info *mti, struct hsm_action_list *hal,
1092                        bool purge);
1093 /* mdt/mdt_hsm_cdt_client.c */
1094 int mdt_hsm_add_actions(struct mdt_thread_info *info,
1095                         struct hsm_action_list *hal);
1096 int mdt_hsm_get_action(struct mdt_thread_info *mti,
1097                        const struct lu_fid *fid,
1098                        enum hsm_copytool_action *action,
1099                        enum agent_req_status *status,
1100                        struct hsm_extent *extent);
1101 bool mdt_hsm_restore_is_running(struct mdt_thread_info *mti,
1102                                 const struct lu_fid *fid);
1103 /* mdt/mdt_hsm_cdt_requests.c */
1104 extern struct cfs_hash_ops cdt_request_cookie_hash_ops;
1105 extern struct cfs_hash_ops cdt_agent_record_hash_ops;
1106 extern const struct file_operations mdt_hsm_active_requests_fops;
1107 void dump_requests(char *prefix, struct coordinator *cdt);
1108 struct cdt_agent_req *mdt_cdt_alloc_request(__u32 archive_id, __u64 flags,
1109                                             struct obd_uuid *uuid,
1110                                             struct hsm_action_item *hai);
1111 void mdt_cdt_free_request(struct cdt_agent_req *car);
1112 int mdt_cdt_add_request(struct coordinator *cdt, struct cdt_agent_req *new_car);
1113 struct cdt_agent_req *mdt_cdt_find_request(struct coordinator *cdt, u64 cookie);
1114 void mdt_cdt_get_request(struct cdt_agent_req *car);
1115 void mdt_cdt_put_request(struct cdt_agent_req *car);
1116 struct cdt_agent_req *mdt_cdt_update_request(struct coordinator *cdt,
1117                                          const struct hsm_progress_kernel *pgs);
1118 int mdt_cdt_remove_request(struct coordinator *cdt, __u64 cookie);
1119 /* mdt/mdt_coordinator.c */
1120 void mdt_hsm_dump_hal(int level, const char *prefix,
1121                       struct hsm_action_list *hal);
1122 int cdt_restore_handle_add(struct mdt_thread_info *mti, struct coordinator *cdt,
1123                            const struct lu_fid *fid,
1124                            const struct hsm_extent *he);
1125 struct cdt_restore_handle *cdt_restore_handle_find(struct coordinator *cdt,
1126                                                    const struct lu_fid *fid);
1127 void cdt_restore_handle_del(struct mdt_thread_info *mti,
1128                             struct coordinator *cdt, const struct lu_fid *fid);
1129 /* coordinator management */
1130 int mdt_hsm_cdt_init(struct mdt_device *mdt);
1131 int mdt_hsm_cdt_stop(struct mdt_device *mdt);
1132 int mdt_hsm_cdt_fini(struct mdt_device *mdt);
1133
1134 /*
1135  * Signal the coordinator has work to do
1136  * \param cdt [IN] coordinator
1137  */
1138 static inline void mdt_hsm_cdt_event(struct coordinator *cdt)
1139 {
1140         cdt->cdt_event = true;
1141 }
1142
1143 /* coordinator control sysfs interface */
1144 ssize_t hsm_control_show(struct kobject *kobj, struct attribute *attr,
1145                          char *buf);
1146 ssize_t hsm_control_store(struct kobject *kobj, struct attribute *attr,
1147                           const char *buffer, size_t count);
1148 int hsm_cdt_tunables_init(struct mdt_device *mdt);
1149 void hsm_cdt_tunables_fini(struct mdt_device *mdt);
1150 /* md_hsm helpers */
1151 struct mdt_object *mdt_hsm_get_md_hsm(struct mdt_thread_info *mti,
1152                                       const struct lu_fid *fid,
1153                                       struct md_hsm *hsm);
1154 /* actions/request helpers */
1155 int mdt_hsm_add_hal(struct mdt_thread_info *mti,
1156                     struct hsm_action_list *hal, struct obd_uuid *uuid);
1157 bool mdt_hsm_is_action_compat(const struct hsm_action_item *hai,
1158                               u32 archive_id, u64 rq_flags,
1159                               const struct md_hsm *hsm);
1160 int mdt_hsm_update_request_state(struct mdt_thread_info *mti,
1161                                  struct hsm_progress_kernel *pgs);
1162
1163 extern struct lu_context_key       mdt_thread_key;
1164
1165 /* debug issues helper starts here*/
1166 static inline int mdt_fail_write(const struct lu_env *env,
1167                                  struct dt_device *dd, int id)
1168 {
1169         if (CFS_FAIL_CHECK_ORSET(id, CFS_FAIL_ONCE)) {
1170                 CERROR(LUSTRE_MDT_NAME": cfs_fail_loc=%x, fail write ops\n",
1171                        id);
1172                 return dt_ro(env, dd);
1173                 /* We set FAIL_ONCE because we never "un-fail" a device */
1174         }
1175
1176         return 0;
1177 }
1178
1179 static inline struct mdt_export_data *mdt_req2med(struct ptlrpc_request *req)
1180 {
1181         return &req->rq_export->exp_mdt_data;
1182 }
1183
1184 static inline struct mdt_device *mdt_exp2dev(struct obd_export *exp)
1185 {
1186         return mdt_dev(exp->exp_obd->obd_lu_dev);
1187 }
1188
1189 static inline bool mdt_rdonly(struct obd_export *exp)
1190 {
1191         return (exp_connect_flags(exp) & OBD_CONNECT_RDONLY ||
1192                 mdt_exp2dev(exp)->mdt_bottom->dd_rdonly ||
1193                 mdt_exp2dev(exp)->mdt_readonly);
1194 }
1195
1196 typedef void (*mdt_reconstruct_t)(struct mdt_thread_info *mti,
1197                                   struct mdt_lock_handle *lhc);
1198 static inline int mdt_check_resent(struct mdt_thread_info *info,
1199                                    mdt_reconstruct_t reconstruct,
1200                                    struct mdt_lock_handle *lhc)
1201 {
1202         struct ptlrpc_request *req = mdt_info_req(info);
1203         int rc = 0;
1204         ENTRY;
1205
1206         if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) {
1207                 OBD_ALLOC_PTR(info->mti_reply_data);
1208                 if (info->mti_reply_data == NULL)
1209                         RETURN(-ENOMEM);
1210
1211                 rc = req_can_reconstruct(req, info->mti_reply_data);
1212                 if (rc == 1) {
1213                         reconstruct(info, lhc);
1214                 } else {
1215                         DEBUG_REQ(D_HA, req,
1216                                   "no reply data found for RESENT req, rc = %d",
1217                                   rc);
1218                 }
1219                 OBD_FREE_PTR(info->mti_reply_data);
1220                 info->mti_reply_data = NULL;
1221         }
1222         RETURN(rc);
1223 }
1224
1225 struct lu_ucred *mdt_ucred(const struct mdt_thread_info *info);
1226 struct lu_ucred *mdt_ucred_check(const struct mdt_thread_info *info);
1227
1228 static inline int is_identity_get_disabled(struct upcall_cache *cache)
1229 {
1230         return cache ? (strcmp(cache->uc_upcall, "NONE") == 0) : 1;
1231 }
1232
1233 int mdt_blocking_ast(struct ldlm_lock*, struct ldlm_lock_desc*, void*, int);
1234
1235 static int mdt_dom_glimpse_ast(struct ldlm_lock *lock, void *reqp)
1236 {
1237         return -ELDLM_NO_LOCK_DATA;
1238 }
1239
1240 /* Issues dlm lock on passed @ns, @f stores it lock handle into @lh. */
1241 static inline int mdt_fid_lock(const struct lu_env *env,
1242                                struct ldlm_namespace *ns,
1243                                struct lustre_handle *lh, enum ldlm_mode mode,
1244                                union ldlm_policy_data *policy,
1245                                const struct ldlm_res_id *res_id,
1246                                __u64 flags, const __u64 *client_cookie)
1247 {
1248         int rc;
1249         bool glimpse = policy->l_inodebits.bits & MDS_INODELOCK_DOM;
1250
1251         LASSERT(ns != NULL);
1252         LASSERT(lh != NULL);
1253
1254         rc = ldlm_cli_enqueue_local(env, ns, res_id, LDLM_IBITS, policy,
1255                                     mode, &flags, mdt_blocking_ast,
1256                                     ldlm_completion_ast,
1257                                     glimpse ? mdt_dom_glimpse_ast : NULL,
1258                                     NULL, 0, LVB_T_NONE, client_cookie, lh);
1259         return rc == ELDLM_OK ? 0 : -EIO;
1260 }
1261
1262 static inline void mdt_fid_unlock(struct lustre_handle *lh, enum ldlm_mode mode)
1263 {
1264         ldlm_lock_decref(lh, mode);
1265 }
1266
1267 static inline bool mdt_slc_is_enabled(struct mdt_device *mdt)
1268 {
1269         return mdt->mdt_lut.lut_sync_lock_cancel == SYNC_LOCK_CANCEL_BLOCKING;
1270 }
1271
1272 extern mdl_mode_t mdt_mdl_lock_modes[];
1273 extern enum ldlm_mode mdt_dlm_lock_modes[];
1274
1275 /* LCK_MINMODE which is zero returns false for is_power_of_2 */
1276
1277 static inline mdl_mode_t mdt_dlm_mode2mdl_mode(enum ldlm_mode mode)
1278 {
1279         LASSERT(mode == LCK_MINMODE || is_power_of_2(mode));
1280         return mdt_mdl_lock_modes[mode];
1281 }
1282
1283 static inline enum ldlm_mode mdt_mdl_mode2dlm_mode(mdl_mode_t mode)
1284 {
1285         LASSERT(mode == MDL_MINMODE || is_power_of_2(mode));
1286         return mdt_dlm_lock_modes[mode];
1287 }
1288
1289 /* mdt_som.c */
1290 int mdt_set_som(struct mdt_thread_info *info, struct mdt_object *obj,
1291                 enum lustre_som_flags flag, __u64 size, __u64 blocks);
1292 int mdt_get_som(struct mdt_thread_info *info, struct mdt_object *obj,
1293                 struct md_attr *ma);
1294 int mdt_lsom_downgrade(struct mdt_thread_info *info, struct mdt_object *obj);
1295 int mdt_lsom_update(struct mdt_thread_info *info, struct mdt_object *obj,
1296                     bool truncate);
1297
1298 /* mdt_lvb.c */
1299 extern struct ldlm_valblock_ops mdt_lvbo;
1300 int mdt_dom_lvb_is_valid(struct ldlm_resource *res);
1301 int mdt_dom_lvbo_update(struct ldlm_resource *res, struct ldlm_lock *lock,
1302                         struct ptlrpc_request *req, bool increase_only);
1303
1304 void mdt_enable_cos(struct mdt_device *dev, bool enable);
1305 int mdt_cos_is_enabled(struct mdt_device *);
1306
1307 /* lprocfs stuff */
1308 enum mdt_stat_idx {
1309         LPROC_MDT_OPEN,
1310         LPROC_MDT_CLOSE,
1311         LPROC_MDT_MKNOD,
1312         LPROC_MDT_LINK,
1313         LPROC_MDT_UNLINK,
1314         LPROC_MDT_MKDIR,
1315         LPROC_MDT_RMDIR,
1316         LPROC_MDT_RENAME,
1317         LPROC_MDT_GETATTR,
1318         LPROC_MDT_SETATTR,
1319         LPROC_MDT_GETXATTR,
1320         LPROC_MDT_SETXATTR,
1321         LPROC_MDT_STATFS,
1322         LPROC_MDT_SYNC,
1323         LPROC_MDT_RENAME_SAMEDIR,
1324         LPROC_MDT_RENAME_PAR_FILE,
1325         LPROC_MDT_RENAME_PAR_DIR,
1326         LPROC_MDT_RENAME_CROSSDIR,
1327         LPROC_MDT_IO_READ,
1328         LPROC_MDT_IO_WRITE,
1329         LPROC_MDT_IO_READ_BYTES,
1330         LPROC_MDT_IO_WRITE_BYTES,
1331         LPROC_MDT_IO_PUNCH,
1332         LPROC_MDT_MIGRATE,
1333         LPROC_MDT_FALLOCATE,
1334         LPROC_MDT_LAST,
1335 };
1336
1337 void mdt_counter_incr(struct ptlrpc_request *req, int opcode, long amount);
1338 void mdt_stats_counter_init(struct lprocfs_stats *stats, unsigned int offset,
1339                             enum lprocfs_counter_config cntr_umask);
1340 int mdt_tunables_init(struct mdt_device *mdt, const char *name);
1341 void mdt_tunables_fini(struct mdt_device *mdt);
1342
1343 /* lustre/mdt_mdt_lproc.c */
1344 int lprocfs_mdt_open_files_seq_open(struct inode *inode,
1345                                     struct file *file);
1346 void mdt_rename_counter_tally(struct mdt_thread_info *info,
1347                               struct mdt_device *mdt,
1348                               struct ptlrpc_request *req,
1349                               struct mdt_object *src, struct mdt_object *tgt,
1350                               enum mdt_stat_idx msi, s64 count);
1351
1352 static inline struct obd_device *mdt2obd_dev(const struct mdt_device *mdt)
1353 {
1354         return mdt->mdt_lu_dev.ld_obd;
1355 }
1356
1357 extern const struct lu_device_operations mdt_lu_ops;
1358
1359 static inline char *mdt_obd_name(struct mdt_device *mdt)
1360 {
1361         return mdt->mdt_lu_dev.ld_obd->obd_name;
1362 }
1363
1364 int mds_mod_init(void);
1365 void mds_mod_exit(void);
1366
1367 static inline char *mdt_req_get_jobid(struct ptlrpc_request *req)
1368 {
1369         struct obd_export       *exp = req->rq_export;
1370         char                    *jobid = NULL;
1371
1372         if (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS)
1373                 jobid = lustre_msg_get_jobid(req->rq_reqmsg);
1374
1375         return jobid;
1376 }
1377
1378 /* MDT IO */
1379
1380 #define VALID_FLAGS (LA_TYPE | LA_MODE | LA_SIZE | LA_BLOCKS | \
1381                      LA_BLKSIZE | LA_ATIME | LA_MTIME | LA_CTIME)
1382
1383 int mdt_obd_preprw(const struct lu_env *env, int cmd, struct obd_export *exp,
1384                    struct obdo *oa, int objcount, struct obd_ioobj *obj,
1385                    struct niobuf_remote *rnb, int *nr_local,
1386                    struct niobuf_local *lnb);
1387
1388 int mdt_obd_commitrw(const struct lu_env *env, int cmd, struct obd_export *exp,
1389                      struct obdo *oa, int objcount, struct obd_ioobj *obj,
1390                      struct niobuf_remote *rnb, int npages,
1391                      struct niobuf_local *lnb, int old_rc, int nob,
1392                      ktime_t kstart);
1393 int mdt_punch_hdl(struct tgt_session_info *tsi);
1394 int mdt_fallocate_hdl(struct tgt_session_info *tsi);
1395 int mdt_glimpse_enqueue(struct mdt_thread_info *mti, struct ldlm_namespace *ns,
1396                         struct ldlm_lock **lockp, __u64 flags);
1397 int mdt_brw_enqueue(struct mdt_thread_info *info, struct ldlm_namespace *ns,
1398                     struct ldlm_lock **lockp, __u64 flags);
1399 int mdt_dom_read_on_open(struct mdt_thread_info *mti, struct mdt_device *mdt,
1400                          struct lustre_handle *lh);
1401 void mdt_dom_discard_data(struct mdt_thread_info *info, struct mdt_object *mo);
1402 int mdt_dom_disk_lvbo_update(const struct lu_env *env, struct mdt_object *mo,
1403                              struct ldlm_resource *res, bool increase_only);
1404 void mdt_dom_obj_lvb_update(const struct lu_env *env, struct mdt_object *mo,
1405                             struct obdo *oa, bool increase_only);
1406 int mdt_dom_lvb_alloc(struct ldlm_resource *res);
1407
1408 static inline bool mdt_dom_check_for_discard(struct mdt_thread_info *mti,
1409                                              struct mdt_object *mo)
1410 {
1411         return lu_object_is_dying(&mo->mot_header) &&
1412                S_ISREG(lu_object_attr(&mo->mot_obj));
1413 }
1414
1415 int mdt_dom_object_size(const struct lu_env *env, struct mdt_device *mdt,
1416                         const struct lu_fid *fid, struct mdt_body *mb,
1417                         bool dom_lock);
1418 bool mdt_dom_client_has_lock(struct mdt_thread_info *info,
1419                              const struct lu_fid *fid);
1420 void mdt_hp_brw(struct tgt_session_info *tsi);
1421 void mdt_hp_punch(struct tgt_session_info *tsi);
1422 int mdt_data_version_get(struct tgt_session_info *tsi);
1423 int mdt_io_set_info(struct tgt_session_info *tsi);
1424
1425 /* grants */
1426 long mdt_grant_connect(const struct lu_env *env, struct obd_export *exp,
1427                        u64 want, bool conservative);
1428 extern struct kmem_cache *ldlm_glimpse_work_kmem;
1429
1430 static inline bool mdt_changelog_allow(struct mdt_thread_info *info)
1431 {
1432         struct lu_ucred *uc = NULL;
1433         bool is_admin;
1434         int rc;
1435
1436         if (info == NULL || info->mti_body == NULL)
1437 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 17, 3, 0)
1438                 /* return true in case old client did not send mdt body */
1439                 return true;
1440 #else
1441                 return false;
1442 #endif
1443
1444         rc = mdt_init_ucred(info, (struct mdt_body *)info->mti_body);
1445         if (rc < 0)
1446                 return false;
1447
1448         uc = mdt_ucred(info);
1449         is_admin = (uc->uc_uid == 0 && uc->uc_gid == 0 &&
1450                     cap_raised(uc->uc_cap, CAP_SYS_ADMIN) &&
1451                     uc->uc_rbac_chlg_ops);
1452
1453         mdt_exit_ucred(info);
1454
1455         return is_admin;
1456 }
1457
1458 /* We forbid operations from encryption-unaware clients if they try to
1459  * manipulate encrypted files/directories.
1460  */
1461 static inline int mdt_check_enc(struct mdt_thread_info *info,
1462                                 struct mdt_object *obj)
1463 {
1464         struct obd_export *exp;
1465         struct md_attr ma = { 0 };
1466         int rc = 0;
1467
1468         if (!mdt_info_req(info))
1469                 /* no req, so cannot tell about client connection flags:
1470                  * allow access
1471                  */
1472                 return 0;
1473         exp = mdt_info_req(info)->rq_export;
1474         if (exp_connect_encrypt(exp))
1475                 /* client is encryption aware: fine */
1476                 return 0;
1477
1478         ma.ma_need = MA_INODE;
1479         mdt_attr_get_complex(info, obj, &ma);
1480         if (ma.ma_attr.la_valid & LA_FLAGS &&
1481             ma.ma_attr.la_flags & LUSTRE_ENCRYPT_FL)
1482                 rc = -ENOKEY;
1483
1484         if (rc)
1485                 CDEBUG(D_SEC, "%s: operation on encrypted "DFID
1486                        " from encryption-unaware client %s: %d\n",
1487                        mdt_obd_name(info->mti_mdt),
1488                        PFID(lu_object_fid(&obj->mot_obj)),
1489                        libcfs_nidstr(&exp->exp_connection->c_peer.nid), rc);
1490
1491         return rc;
1492 }
1493
1494 int mdt_fids_different_target(struct mdt_thread_info *info,
1495                               const struct lu_fid *fid1,
1496                               const struct lu_fid *fid2);
1497
1498 int mdt_reint_migrate(struct mdt_thread_info *info,
1499                       struct mdt_lock_handle *unused);
1500 int mdt_dir_layout_update(struct mdt_thread_info *info);
1501
1502 /* directory restripe */
1503 int mdt_restripe_internal(struct mdt_thread_info *info,
1504                           struct mdt_object *parent,
1505                           struct mdt_object *child,
1506                           const struct lu_name *lname,
1507                           struct lu_fid *tfid,
1508                           struct md_op_spec *spec,
1509                           struct md_attr *ma);
1510 int mdt_restriper_start(struct mdt_device *mdt);
1511 void mdt_restriper_stop(struct mdt_device *mdt);
1512 void mdt_auto_split_add(struct mdt_thread_info *info, struct mdt_object *o);
1513 void mdt_restripe_migrate_add(struct mdt_thread_info *info,
1514                               struct mdt_object *o);
1515 void mdt_restripe_update_add(struct mdt_thread_info *info,
1516                              struct mdt_object *o);
1517 int mdt_is_remote_object(struct mdt_thread_info *info,
1518                          struct mdt_object *parent,
1519                          struct mdt_object *child);
1520
1521 static unsigned int max_mod_rpcs_per_client = OBD_MAX_RIF_DEFAULT;
1522 #if OBD_OCD_VERSION(3, 0, 53, 0) > LUSTRE_VERSION_CODE
1523 static inline bool mdt_max_mod_rpcs_changed(struct mdt_device *mdt)
1524 {
1525         return max_mod_rpcs_per_client != OBD_MAX_RIF_DEFAULT &&
1526                 mdt->mdt_max_mod_rpcs_in_flight == OBD_MAX_RIF_DEFAULT;
1527 }
1528 #else
1529 #define mdt_max_mod_rpcs_changed(mdt) false
1530 #endif
1531
1532 #endif /* _MDT_INTERNAL_H */