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