Whamcloud - gitweb
LU-15527 dne: refactor commit-on-sharing for DNE
[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                                    /* this is enabled by default, but once an
314                                     * old client joins, disable this to handle
315                                     * inherited default LMV on server.
316                                     */
317                                    mdt_enable_dmv_implicit_inherit:1;
318
319                                    /* user with gid can create remote/striped
320                                     * dir, and set default dir stripe */
321         gid_t                      mdt_enable_remote_dir_gid;
322                                    /* user with this gid can change projid */
323         gid_t                      mdt_enable_chprojid_gid;
324
325         /* lock for osfs and md_root */
326         spinlock_t                 mdt_lock;
327
328         /* statfs optimization: we cache a bit  */
329         struct mdt_statfs_cache    mdt_sum_osfs;
330         struct mdt_statfs_cache    mdt_osfs;
331
332         /* root squash */
333         struct root_squash_info    mdt_squash;
334
335         struct rename_stats        mdt_rename_stats;
336         struct lu_fid              mdt_md_root_fid;
337
338         /* connection to quota master */
339         struct obd_export         *mdt_qmt_exp;
340         /* quota master device associated with this MDT */
341         struct lu_device          *mdt_qmt_dev;
342
343         struct coordinator         mdt_coordinator;
344
345         /* inter-MDT connection count */
346         atomic_t                   mdt_mds_mds_conns;
347
348         /* MDT device async commit count, used for debug and sanity test */
349         atomic_t                   mdt_async_commit_count;
350
351         struct mdt_object         *mdt_md_root;
352
353         struct mdt_dir_restriper   mdt_restriper;
354
355         /* count of old clients that doesn't support DMV implicite inherit */
356         atomic_t                   mdt_dmv_old_client_count;
357 };
358
359 #define MDT_SERVICE_WATCHDOG_FACTOR     (2)
360 #define MDT_COS_DEFAULT         (0)
361
362 #define ENOENT_VERSION 1        /** 'virtual' version of non-existent object */
363
364 struct mdt_object {
365         struct lu_object_header mot_header;
366         struct lu_object        mot_obj;
367         unsigned int            mot_lov_created:1,  /* lov object created */
368                                 mot_cache_attr:1,   /* enable remote object
369                                                      * attribute cache */
370                                 mot_restriping:1,   /* dir restriping */
371                                 /* dir auto-split disabled */
372                                 mot_auto_split_disabled:1,
373                                 mot_lsom_inited:1; /* lsom was inited */
374         int                     mot_write_count;
375         spinlock_t              mot_write_lock;
376         /* Lock to protect create_data */
377         struct mutex            mot_lov_mutex;
378         /* Lock to protect object's SOM update. */
379         struct mutex            mot_som_mutex;
380         __u64                   mot_lsom_size;
381         __u64                   mot_lsom_blocks;
382         /* lock to protect read/write stages for Data-on-MDT files */
383         struct rw_semaphore     mot_dom_sem;
384         /* Lock to protect lease open.
385          * Lease open acquires write lock; normal open acquires read lock */
386         struct rw_semaphore     mot_open_sem;
387         atomic_t                mot_lease_count;
388         atomic_t                mot_open_count;
389         /* directory offset, used in sub file migration in dir restripe */
390         loff_t                  mot_restripe_offset;
391         /* link to mdt_restriper auto_splitting/migrating/updating */
392         struct list_head        mot_restripe_linkage;
393 };
394
395 struct mdt_lock_handle {
396         /* Lock type, reg for cross-ref use or pdo lock. */
397         mdl_type_t              mlh_type;
398
399         /* Regular lock */
400         struct lustre_handle    mlh_reg_lh;
401         enum ldlm_mode          mlh_reg_mode;
402         __u64                   mlh_gid;
403
404         /* Pdirops lock */
405         struct lustre_handle    mlh_pdo_lh;
406         enum ldlm_mode          mlh_pdo_mode;
407         unsigned int            mlh_pdo_hash;
408
409         /* Remote regular lock */
410         struct lustre_handle    mlh_rreg_lh;
411         enum ldlm_mode          mlh_rreg_mode;
412 };
413
414 enum {
415         MDT_LH_PARENT,  /* parent lockh */
416         MDT_LH_CHILD,   /* child lockh */
417         MDT_LH_OLD,     /* old lockh for rename */
418         MDT_LH_LAYOUT = MDT_LH_OLD, /* layout lock */
419         MDT_LH_NEW,     /* new lockh for rename */
420         MDT_LH_RMT,     /* used for return lh to caller */
421         MDT_LH_LOCAL,   /* local lock never return to client */
422         MDT_LH_LOOKUP,  /* lookup lock for source object in rename/migrate if
423                          * it's remote object */
424         MDT_LH_NR
425 };
426
427 enum {
428         MDT_LOCAL_LOCK,
429         MDT_CROSS_LOCK
430 };
431
432 /* Special magical errno for communicaiton between mdt_reint_open()
433  * and mdt_intent_reint() which means return the lock to the client
434  * for subsequent cross ref open. Previously we used plain -EREMOTE
435  * but other functions called in that path might return it too and
436  * confuse us. This is not returned to the client. See LU-5370. */
437 #define MDT_EREMOTE_OPEN (EREMOTE + 1024)
438
439 struct mdt_reint_record {
440         enum mds_reint_op                rr_opcode;
441         const struct lustre_handle      *rr_open_handle;
442         const struct lustre_handle      *rr_lease_handle;
443         const struct lu_fid             *rr_fid1;
444         const struct lu_fid             *rr_fid2;
445         struct lu_name                   rr_name;
446         struct lu_name                   rr_tgt_name;
447         void                            *rr_eadata;
448         int                              rr_eadatalen;
449         __u32                            rr_flags;
450         __u16                            rr_mirror_id;
451 };
452
453 enum mdt_reint_flag {
454         MRF_OPEN_TRUNC = BIT(0),
455         MRF_OPEN_RESEND = BIT(1),
456 };
457
458 /*
459  * Common data shared by mdt-level handlers. This is allocated per-thread to
460  * reduce stack consumption.
461  */
462 struct mdt_thread_info {
463         /*
464          * XXX: Part One:
465          * The following members will be filled explicitly
466          * with specific data in mdt_thread_info_init().
467          */
468         /* TODO: move this into mdt_session_key(with LCT_SESSION), because
469          * request handling may migrate from one server thread to another.
470          */
471         struct req_capsule        *mti_pill;
472
473         /*
474          * SUB request pill in a batch request.
475          */
476         struct req_capsule          mti_sub_pill;
477
478         /* although we have export in req, there are cases when it is not
479          * available, e.g. closing files upon export destroy */
480         struct obd_export          *mti_exp;
481         /*
482          * A couple of lock handles.
483          */
484         struct mdt_lock_handle     mti_lh[MDT_LH_NR];
485
486         struct mdt_device         *mti_mdt;
487         const struct lu_env       *mti_env;
488
489         /* transaction number of current request */
490         __u64                      mti_transno;
491
492         /*
493          * XXX: Part Two:
494          * The following members will be filled expilictly
495          * with zero in mdt_thread_info_init(). These members may be used
496          * by all requests.
497          */
498
499         /*
500          * Object attributes.
501          */
502         struct md_attr             mti_attr;
503         struct md_attr             mti_attr2; /* mdt_lvb.c */
504         /*
505          * Body for "habeo corpus" operations.
506          */
507         const struct mdt_body     *mti_body;
508         /*
509          * Host object. This is released at the end of mdt_handler().
510          */
511         struct mdt_object         *mti_object;
512         /*
513          * Lock request for "habeo clavis" operations.
514          */
515         const struct ldlm_request *mti_dlm_req;
516
517         __u32                      mti_cross_ref:1,
518         /* big_lmm buffer was used and must be used in reply */
519                                    mti_big_lmm_used:1,
520                                    mti_big_acl_used:1,
521                                    mti_som_strict:1,
522         /* Batch processing environment */
523                                    mti_batch_env:1;
524
525         /* opdata for mdt_reint_open(), has the same as
526          * ldlm_reply:lock_policy_res1.  mdt_update_last_rcvd() stores this
527          * value onto disk for recovery when mdt_trans_stop_cb() is called.
528          */
529         __u64                      mti_opdata;
530
531         /*
532          * XXX: Part Three:
533          * The following members will be filled explicitly
534          * with zero in mdt_reint_unpack(), because they are only used
535          * by reint requests (including mdt_reint_open()).
536          */
537
538         /*
539          * reint record. contains information for reint operations.
540          */
541         struct mdt_reint_record    mti_rr;
542
543         __u64                      mti_ver[PTLRPC_NUM_VERSIONS];
544         /*
545          * Operation specification (currently create and lookup)
546          */
547         struct md_op_spec          mti_spec;
548
549         /*
550          * XXX: Part Four:
551          * The following members will _NOT_ be initialized at all.
552          * DO NOT expect them to contain any valid value.
553          * They should be initialized explicitly by the user themselves.
554          */
555
556         /* XXX: If something is in a union, make sure they do not conflict */
557         struct lu_fid                   mti_tmp_fid1;
558         struct lu_fid                   mti_tmp_fid2;
559         union ldlm_policy_data          mti_policy; /* for mdt_object_lock() */
560         struct ldlm_res_id              mti_res_id; /* and mdt_rename_lock() */
561         union {
562                 struct obd_uuid         uuid[2];    /* for mdt_seq_init_cli() */
563                 char                    ns_name[48];/* for mdt_init0()        */
564                 struct lustre_cfg_bufs  bufs;       /* for mdt_stack_fini()   */
565                 struct obd_statfs       osfs;       /* for mdt_statfs()       */
566                 struct {
567                         /* for mdt_readpage()      */
568                         struct lu_rdpg     mti_rdpg;
569                 } rdpg;
570                 struct {
571                         struct md_attr attr;
572                 } hsm;
573                 struct {
574                         struct md_attr attr;
575                 } som;
576         } mti_u;
577
578         struct lustre_handle       mti_open_handle;
579         loff_t                     mti_off;
580         struct lu_buf              mti_buf;
581         struct lu_buf              mti_big_buf;
582
583         /* Ops object filename */
584         struct lu_name             mti_name;
585         char                       mti_filename[NAME_MAX + 1];
586         /* per-thread values, can be re-used, may be vmalloc'd */
587         void                      *mti_big_lmm;
588         void                      *mti_big_acl;
589         int                        mti_big_lmmsize;
590         int                        mti_big_aclsize;
591         /* should be enough to fit lustre_mdt_attrs */
592         char                       mti_xattr_buf[128];
593         struct ldlm_enqueue_info   mti_einfo;
594         /* einfo used by mdt_remote_object_lock_try() */
595         struct ldlm_enqueue_info   mti_remote_einfo;
596         struct tg_reply_data      *mti_reply_data;
597
598         /* FLR: layout change API */
599         struct md_layout_change    mti_mlc;
600
601         struct lu_seq_range        mti_range;
602 };
603
604 extern struct lu_context_key mdt_thread_key;
605
606 static inline struct mdt_thread_info *mdt_th_info(const struct lu_env *env)
607 {
608         return lu_env_info(env, &mdt_thread_key);
609 }
610
611 struct cdt_req_progress {
612         spinlock_t               crp_lock;      /**< protect tree */
613         struct interval_tree_root crp_root;     /**< tree to track extent
614                                                  *   moved */
615         __u64                    crp_total;
616 };
617
618 struct cdt_agent_req {
619         struct hlist_node        car_cookie_hash;  /**< find req by cookie */
620         struct list_head         car_request_list; /**< to chain all the req. */
621         atomic_t                 car_refcount;     /**< reference counter */
622         __u64                    car_flags;        /**< request original flags */
623         struct obd_uuid          car_uuid;         /**< agent doing the req. */
624         __u32                    car_archive_id;   /**< archive id */
625         int                      car_canceled;     /**< request was canceled */
626         time64_t                 car_req_start;    /**< start time */
627         time64_t                 car_req_update;   /**< last update time */
628         struct hsm_action_item  *car_hai;          /**< req. to the agent */
629         struct cdt_req_progress  car_progress;     /**< track data mvt
630                                                     *   progress */
631 };
632 extern struct kmem_cache *mdt_hsm_car_kmem;
633
634 struct hsm_agent {
635         struct list_head ha_list;               /**< to chain the agents */
636         struct obd_uuid  ha_uuid;               /**< agent uuid */
637         __u32           *ha_archive_id;         /**< archive id */
638         int              ha_archive_cnt;        /**< number of archive entries
639                                                  *   0 means any archive */
640         atomic_t         ha_requests;           /**< current request count */
641         atomic_t         ha_success;            /**< number of successful
642                                                  * actions */
643         atomic_t         ha_failure;            /**< number of failed actions */
644 };
645
646 struct cdt_restore_handle {
647         struct list_head        crh_list;       /**< to chain the handle */
648         struct lu_fid           crh_fid;        /**< fid of the object */
649         struct ldlm_extent      crh_extent;     /**< extent of the restore */
650         struct mdt_lock_handle  crh_lh;         /**< lock handle */
651 };
652 extern struct kmem_cache *mdt_hsm_cdt_kmem;     /** restore handle slab cache */
653
654 struct hsm_record_update {
655         __u64 cookie;
656         enum agent_req_status status;
657 };
658
659 static inline const struct md_device_operations *
660 mdt_child_ops(struct mdt_device * m)
661 {
662         LASSERT(m->mdt_child);
663         return m->mdt_child->md_ops;
664 }
665
666 static inline struct md_object *mdt_object_child(struct mdt_object *o)
667 {
668         LASSERT(o);
669         return lu2md(lu_object_next(&o->mot_obj));
670 }
671
672 static inline struct ptlrpc_request *mdt_info_req(struct mdt_thread_info *info)
673 {
674          return info->mti_pill ? info->mti_pill->rc_req : NULL;
675 }
676
677 static inline __u64 mdt_conn_flags(struct mdt_thread_info *info)
678 {
679         LASSERT(info->mti_exp);
680         return exp_connect_flags(info->mti_exp);
681 }
682
683 static inline void mdt_object_get(const struct lu_env *env,
684                                   struct mdt_object *o)
685 {
686         ENTRY;
687         lu_object_get(&o->mot_obj);
688         EXIT;
689 }
690
691 static inline void mdt_object_put(const struct lu_env *env,
692                                   struct mdt_object *o)
693 {
694         ENTRY;
695         lu_object_put(env, &o->mot_obj);
696         EXIT;
697 }
698
699 static inline int mdt_object_exists(const struct mdt_object *o)
700 {
701         return lu_object_exists(&o->mot_obj);
702 }
703
704 static inline int mdt_object_remote(const struct mdt_object *o)
705 {
706         return lu_object_remote(&o->mot_obj);
707 }
708
709 static inline const struct lu_fid *mdt_object_fid(const struct mdt_object *o)
710 {
711         return lu_object_fid(&o->mot_obj);
712 }
713
714 static inline struct lu_site *mdt_lu_site(const struct mdt_device *mdt)
715 {
716         return mdt->mdt_lu_dev.ld_site;
717 }
718
719 static inline struct seq_server_site *mdt_seq_site(struct mdt_device *mdt)
720 {
721         return &mdt->mdt_seq_site;
722 }
723
724 static inline u32 mdt_node_id(const struct mdt_device *mdt)
725 {
726         return mdt->mdt_seq_site.ss_node_id;
727 }
728
729 static inline void mdt_export_evict(struct obd_export *exp)
730 {
731         class_fail_export(exp);
732 }
733
734 /* Here we use LVB_TYPE to check dne client, because it is
735  * also landed on 2.4. */
736 static inline bool mdt_is_dne_client(struct obd_export *exp)
737 {
738         return !!(exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE);
739 }
740
741 static inline bool mdt_is_striped_client(struct obd_export *exp)
742 {
743         return exp_connect_flags(exp) & OBD_CONNECT_DIR_STRIPE;
744 }
745
746 __u32 mdt_lmm_dom_entry_check(struct lov_mds_md *lmm, int *dom_only);
747
748 static inline bool mdt_lmm_dom_only(struct lov_mds_md *lmm)
749 {
750         int dom_only = 0;
751
752         mdt_lmm_dom_entry_check(lmm, &dom_only);
753         return dom_only;
754 }
755
756 static inline __u32 mdt_lmm_dom_stripesize(struct lov_mds_md *lmm)
757 {
758         return mdt_lmm_dom_entry_check(lmm, NULL);
759 }
760
761 static inline bool mdt_lmm_is_flr(struct lov_mds_md *lmm)
762 {
763         struct lov_comp_md_v1 *lcm = (typeof(lcm))lmm;
764
765         return le32_to_cpu(lmm->lmm_magic) == LOV_MAGIC_COMP_V1 &&
766                le16_to_cpu(lcm->lcm_mirror_count) > 0;
767 }
768
769 static inline bool lmm_is_overstriping(struct lov_mds_md *lmm)
770 {
771         if (le32_to_cpu(lmm->lmm_magic) == LOV_MAGIC_V1 ||
772             le32_to_cpu(lmm->lmm_magic) == LOV_MAGIC_V3)
773                 return le16_to_cpu(lmm->lmm_pattern) & LOV_PATTERN_OVERSTRIPING;
774
775         return false;
776 }
777
778 static inline bool mdt_lmm_comp_overstriping(struct lov_mds_md *lmm)
779 {
780         struct lov_comp_md_v1 *comp_v1;
781         struct lov_mds_md *v1;
782         __u32 off;
783         int i;
784
785         comp_v1 = (struct lov_comp_md_v1 *)lmm;
786
787         for (i = 0; i < le16_to_cpu(comp_v1->lcm_entry_count); i++) {
788                 off = le32_to_cpu(comp_v1->lcm_entries[i].lcme_offset);
789                 v1 = (struct lov_mds_md *)((char *)comp_v1 + off);
790
791                 if (lmm_is_overstriping(v1))
792                         return true;
793         }
794
795         return false;
796 }
797
798 static inline bool mdt_lmm_is_overstriping(struct lov_mds_md *lmm)
799 {
800         if (le32_to_cpu(lmm->lmm_magic) == LOV_MAGIC_COMP_V1)
801                 return mdt_lmm_comp_overstriping(lmm);
802
803         return lmm_is_overstriping(lmm);
804 }
805
806 static inline bool mdt_is_sum_statfs_client(struct obd_export *exp)
807 {
808         return exp_connect_flags(exp) & OBD_CONNECT_FLAGS2 &&
809                exp_connect_flags2(exp) & OBD_CONNECT2_SUM_STATFS;
810 }
811
812 __u64 mdt_get_disposition(struct ldlm_reply *rep, __u64 op_flag);
813 void mdt_set_disposition(struct mdt_thread_info *info,
814                          struct ldlm_reply *rep, __u64 op_flag);
815 void mdt_clear_disposition(struct mdt_thread_info *info,
816                            struct ldlm_reply *rep, __u64 op_flag);
817
818 void mdt_lock_pdo_init(struct mdt_lock_handle *lh, enum ldlm_mode lock_mode,
819                        const struct lu_name *lname);
820
821 void mdt_lock_reg_init(struct mdt_lock_handle *lh, enum ldlm_mode lm);
822 void mdt_lh_reg_init(struct mdt_lock_handle *lh, struct ldlm_lock *lock);
823
824 int mdt_lock_setup(struct mdt_thread_info *info, struct mdt_object *mo,
825                    struct mdt_lock_handle *lh);
826
827 int mdt_check_resent_lock(struct mdt_thread_info *info, struct mdt_object *mo,
828                           struct mdt_lock_handle *lhc);
829
830 int mdt_object_lock(struct mdt_thread_info *info, struct mdt_object *obj,
831                     struct mdt_lock_handle *lh, __u64 ibits,
832                     enum ldlm_mode mode);
833 int mdt_parent_lock(struct mdt_thread_info *info, struct mdt_object *o,
834                     struct mdt_lock_handle *lh, const struct lu_name *lname,
835                     enum ldlm_mode mode);
836 int mdt_object_stripes_lock(struct mdt_thread_info *info,
837                             struct mdt_object *pobj, struct mdt_object *o,
838                             struct mdt_lock_handle *lh,
839                             struct ldlm_enqueue_info *einfo, __u64 ibits,
840                             enum ldlm_mode mode);
841 int mdt_object_check_lock(struct mdt_thread_info *info,
842                           struct mdt_object *parent, struct mdt_object *child,
843                           struct mdt_lock_handle *lh, __u64 ibits,
844                           enum ldlm_mode mode);
845 int mdt_object_lock_try(struct mdt_thread_info *info, struct mdt_object *mo,
846                         struct mdt_lock_handle *lh, __u64 *ibits,
847                         __u64 trybits, enum ldlm_mode mode);
848
849 /* below three lock functions are used internally */
850 int mdt_object_lock_internal(struct mdt_thread_info *info,
851                              struct mdt_object *obj, const struct lu_fid *fid,
852                              struct mdt_lock_handle *lh, __u64 *ibits,
853                              __u64 trybits, bool cache);
854 int mdt_object_pdo_lock(struct mdt_thread_info *info, struct mdt_object *obj,
855                         struct mdt_lock_handle *lh, const struct lu_name *name,
856                         enum ldlm_mode mode, bool pdo_lock);
857 int mdt_object_lookup_lock(struct mdt_thread_info *info,
858                            struct mdt_object *pobj, struct mdt_object *obj,
859                            struct mdt_lock_handle *lh, enum ldlm_mode mode);
860
861 void mdt_object_unlock(struct mdt_thread_info *info, struct mdt_object *mo,
862                        struct mdt_lock_handle *lh, int decref);
863 void mdt_object_stripes_unlock(struct mdt_thread_info *info,
864                                struct mdt_object *o, struct mdt_lock_handle *lh,
865                                struct ldlm_enqueue_info *einfo, int decref);
866
867 struct mdt_object *mdt_object_new(const struct lu_env *env,
868                                   struct mdt_device *,
869                                   const struct lu_fid *);
870 struct mdt_object *mdt_object_find(const struct lu_env *,
871                                    struct mdt_device *,
872                                    const struct lu_fid *);
873 struct mdt_object *mdt_object_find_lock(struct mdt_thread_info *info,
874                                         const struct lu_fid *f,
875                                         struct mdt_lock_handle *lh,
876                                         __u64 ibits, enum ldlm_mode mode);
877 void mdt_object_unlock_put(struct mdt_thread_info *info,
878                            struct mdt_object *o,
879                            struct mdt_lock_handle *lh,
880                            int decref);
881
882 void mdt_client_compatibility(struct mdt_thread_info *info);
883
884 enum mdt_name_flags {
885         MNF_FIX_ANON = 1,
886 };
887
888 int mdt_name_unpack(struct req_capsule *pill,
889                     const struct req_msg_field *field,
890                     struct lu_name *ln,
891                     enum mdt_name_flags flags);
892 int mdt_close_unpack(struct mdt_thread_info *info);
893 int mdt_reint_unpack(struct mdt_thread_info *info, __u32 op);
894 void mdt_fix_lov_magic(struct mdt_thread_info *info, void *eadata);
895 int mdt_reint_rec(struct mdt_thread_info *, struct mdt_lock_handle *);
896 #ifdef CONFIG_LUSTRE_FS_POSIX_ACL
897 int mdt_pack_acl2body(struct mdt_thread_info *info, struct mdt_body *repbody,
898                       struct mdt_object *o, struct lu_nodemap *nodemap);
899 #endif
900 void mdt_pack_attr2body(struct mdt_thread_info *info, struct mdt_body *b,
901                         const struct lu_attr *attr, const struct lu_fid *fid);
902 int mdt_pack_size2body(struct mdt_thread_info *info,
903                         const struct lu_fid *fid,  struct lustre_handle *lh);
904 int mdt_getxattr(struct mdt_thread_info *info);
905 int mdt_reint_setxattr(struct mdt_thread_info *info,
906                        struct mdt_lock_handle *lh);
907
908 void mdt_reconstruct(struct mdt_thread_info *, struct mdt_lock_handle *);
909 void mdt_reconstruct_generic(struct mdt_thread_info *mti,
910                              struct mdt_lock_handle *lhc);
911
912 extern void target_recovery_fini(struct obd_device *obd);
913 extern void target_recovery_init(struct lu_target *lut,
914                                  svc_handler_t handler);
915
916 int mdt_export_stats_init(struct obd_device *obd,
917                           struct obd_export *exp,
918                           void *client_nid);
919
920 int mdt_lock_new_child(struct mdt_thread_info *info,
921                        struct mdt_object *o,
922                        struct mdt_lock_handle *child_lockh);
923 void mdt_mfd_set_mode(struct mdt_file_data *mfd, u64 open_flags);
924 int mdt_reint_open(struct mdt_thread_info *info, struct mdt_lock_handle *lhc);
925 struct mdt_file_data *mdt_open_handle2mfd(struct mdt_export_data *med,
926                                         const struct lustre_handle *open_handle,
927                                         bool is_replay);
928 int mdt_revoke_remote_lookup_lock(struct mdt_thread_info *info,
929                                   struct mdt_object *pobj,
930                                   struct mdt_object *obj);
931
932 int mdt_get_info(struct tgt_session_info *tsi);
933 int mdt_attr_get_complex(struct mdt_thread_info *info,
934                          struct mdt_object *o, struct md_attr *ma);
935 int mdt_big_xattr_get(struct mdt_thread_info *info, struct mdt_object *o,
936                       const char *name);
937 int __mdt_stripe_get(struct mdt_thread_info *info, struct mdt_object *o,
938                      struct md_attr *ma, const char *name);
939 int mdt_stripe_get(struct mdt_thread_info *info, struct mdt_object *o,
940                    struct md_attr *ma, const char *name);
941 int mdt_attr_get_pfid(struct mdt_thread_info *info, struct mdt_object *o,
942                       struct lu_fid *pfid);
943 int mdt_attr_get_pfid_name(struct mdt_thread_info *info, struct mdt_object *o,
944                            struct lu_fid *pfid, struct lu_name *lname);
945 int mdt_write_get(struct mdt_object *o);
946 void mdt_write_put(struct mdt_object *o);
947 int mdt_write_read(struct mdt_object *o);
948 struct mdt_file_data *mdt_mfd_new(const struct mdt_export_data *med);
949 int mdt_mfd_close(struct mdt_thread_info *info, struct mdt_file_data *mfd);
950 void mdt_mfd_free(struct mdt_file_data *mfd);
951 int mdt_close(struct tgt_session_info *tsi);
952 int mdt_add_dirty_flag(struct mdt_thread_info *info, struct mdt_object *mo,
953                         struct md_attr *ma);
954 int mdt_fix_reply(struct mdt_thread_info *info);
955 int mdt_handle_last_unlink(struct mdt_thread_info *, struct mdt_object *,
956                            struct md_attr *);
957 void mdt_reconstruct_open(struct mdt_thread_info *, struct mdt_lock_handle *);
958 int mdt_layout_change(struct mdt_thread_info *info, struct mdt_object *obj,
959                       struct mdt_lock_handle *lhc,
960                       struct md_layout_change *spec);
961 int find_name_matching_hash(struct mdt_thread_info *info, struct lu_name *lname,
962                            struct mdt_object *parent, struct mdt_object *child);
963 int mdt_device_sync(const struct lu_env *env, struct mdt_device *mdt);
964
965 struct lu_buf *mdt_buf(const struct lu_env *env, void *area, ssize_t len);
966 const struct lu_buf *mdt_buf_const(const struct lu_env *env,
967                                    const void *area, ssize_t len);
968
969 void mdt_dump_lmm(int level, const struct lov_mds_md *lmm, __u64 valid);
970 void mdt_dump_lmv(unsigned int level, const union lmv_mds_md *lmv);
971
972 bool allow_client_chgrp(struct mdt_thread_info *info, struct lu_ucred *uc);
973 int mdt_check_ucred(struct mdt_thread_info *);
974 int mdt_init_ucred(struct mdt_thread_info *, struct mdt_body *);
975 int mdt_init_ucred_reint(struct mdt_thread_info *);
976 void mdt_exit_ucred(struct mdt_thread_info *);
977 int mdt_version_get_check(struct mdt_thread_info *, struct mdt_object *, int);
978 void mdt_version_get_save(struct mdt_thread_info *, struct mdt_object *, int);
979 int mdt_version_get_check_save(struct mdt_thread_info *, struct mdt_object *,
980                                int);
981 int mdt_lookup_version_check(struct mdt_thread_info *info,
982                              struct mdt_object *p,
983                              const struct lu_name *lname,
984                              struct lu_fid *fid, int idx);
985 void mdt_thread_info_reset(struct mdt_thread_info *info);
986 void mdt_thread_info_init(struct ptlrpc_request *req,
987                           struct mdt_thread_info *mti);
988 void mdt_thread_info_fini(struct mdt_thread_info *mti);
989 struct mdt_thread_info *tsi2mdt_info(struct tgt_session_info *tsi);
990 void mdt_intent_fixup_resent(struct mdt_thread_info *info,
991                              struct ldlm_lock *new_lock,
992                              struct mdt_lock_handle *lh, __u64 flags);
993 int mdt_intent_lock_replace(struct mdt_thread_info *info,
994                             struct ldlm_lock **lockp,
995                             struct mdt_lock_handle *lh,
996                             __u64 flags, int result);
997
998 int hsm_init_ucred(struct lu_ucred *uc);
999 int mdt_hsm_attr_set(struct mdt_thread_info *info, struct mdt_object *obj,
1000                      const struct md_hsm *mh);
1001
1002 int mdt_remote_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
1003                             void *data, int flag);
1004 int mdt_links_read(struct mdt_thread_info *info,
1005                    struct mdt_object *mdt_obj,
1006                    struct linkea_data *ldata);
1007 int mdt_close_internal(struct mdt_thread_info *info, struct ptlrpc_request *req,
1008                        struct mdt_body *repbody);
1009 int mdt_pack_secctx_in_reply(struct mdt_thread_info *info,
1010                              struct mdt_object *child);
1011 int mdt_pack_encctx_in_reply(struct mdt_thread_info *info,
1012                              struct mdt_object *child);
1013
1014 static inline struct mdt_device *mdt_dev(struct lu_device *d)
1015 {
1016         return container_of_safe(d, struct mdt_device, mdt_lu_dev);
1017 }
1018
1019 static inline struct mdt_object *mdt_obj(struct lu_object *o)
1020 {
1021         return container_of_safe(o, struct mdt_object, mot_obj);
1022 }
1023
1024 static inline struct dt_object *mdt_obj2dt(struct mdt_object *mo)
1025 {
1026         struct lu_object        *lo;
1027         struct mdt_device       *mdt = mdt_dev(mo->mot_obj.lo_dev);
1028
1029         lo = lu_object_locate(mo->mot_obj.lo_header,
1030                               mdt->mdt_bottom->dd_lu_dev.ld_type);
1031
1032         return lu2dt(lo);
1033 }
1034
1035 static inline bool agent_req_in_final_state(enum agent_req_status ars)
1036 {
1037         return ((ars == ARS_SUCCEED) || (ars == ARS_FAILED) ||
1038                 (ars == ARS_CANCELED));
1039 }
1040
1041 /* mdt/mdt_identity.c */
1042 #define MDT_IDENTITY_UPCALL_PATH        "/usr/sbin/l_getidentity"
1043
1044 extern struct upcall_cache_ops mdt_identity_upcall_cache_ops;
1045
1046 struct md_identity *mdt_identity_get(struct upcall_cache *, __u32);
1047
1048 void mdt_identity_put(struct upcall_cache *, struct md_identity *);
1049
1050 void mdt_flush_identity(struct upcall_cache *, int);
1051
1052 __u32 mdt_identity_get_perm(struct md_identity *identity, struct lnet_nid *nid);
1053
1054 /* mdt/mdt_recovery.c */
1055 __u64 mdt_req_from_lrd(struct ptlrpc_request *req, struct tg_reply_data *trd);
1056
1057 /* mdt/mdt_batch.c */
1058 int mdt_batch(struct tgt_session_info *tsi);
1059
1060 /* mdt/mdt_hsm.c */
1061 int mdt_hsm_state_get(struct tgt_session_info *tsi);
1062 int mdt_hsm_state_set(struct tgt_session_info *tsi);
1063 int mdt_hsm_action(struct tgt_session_info *tsi);
1064 int mdt_hsm_progress(struct tgt_session_info *tsi);
1065 int mdt_hsm_ct_register(struct tgt_session_info *tsi);
1066 int mdt_hsm_ct_unregister(struct tgt_session_info *tsi);
1067 int mdt_hsm_request(struct tgt_session_info *tsi);
1068
1069 /* mdt/mdt_hsm_cdt_actions.c */
1070 extern const struct file_operations mdt_hsm_actions_fops;
1071 void dump_llog_agent_req_rec(const char *prefix,
1072                              const struct llog_agent_req_rec *larr);
1073 int cdt_llog_process(const struct lu_env *env, struct mdt_device *mdt,
1074                      llog_cb_t cb, void *data, u32 start_cat_idx,
1075                      u32 start_rec_idx, int rw);
1076 int mdt_agent_record_add(const struct lu_env *env, struct mdt_device *mdt,
1077                          __u32 archive_id, __u64 flags,
1078                          struct hsm_action_item *hai);
1079 int mdt_agent_record_update(struct mdt_thread_info *mti,
1080                             struct hsm_record_update *updates,
1081                             unsigned int updates_count);
1082 void cdt_agent_record_hash_add(struct coordinator *cdt, u64 cookie, u32 cat_idt,
1083                                u32 rec_idx);
1084 void cdt_agent_record_hash_lookup(struct coordinator *cdt, u64 cookie,
1085                                   u32 *cat_idt, u32 *rec_idx);
1086 void cdt_agent_record_hash_del(struct coordinator *cdt, u64 cookie);
1087
1088 /* mdt/mdt_hsm_cdt_agent.c */
1089 extern const struct file_operations mdt_hsm_agent_fops;
1090 int mdt_hsm_agent_register(struct mdt_thread_info *info,
1091                            const struct obd_uuid *uuid,
1092                            int nr_archives, __u32 *archive_num);
1093 int mdt_hsm_agent_register_mask(struct mdt_thread_info *info,
1094                                 const struct obd_uuid *uuid,
1095                                 __u32 archive_mask);
1096 int mdt_hsm_agent_unregister(struct mdt_thread_info *info,
1097                              const struct obd_uuid *uuid);
1098 int mdt_hsm_agent_update_statistics(struct coordinator *cdt,
1099                                     int succ_rq, int fail_rq, int new_rq,
1100                                     const struct obd_uuid *uuid);
1101 int mdt_hsm_find_best_agent(struct coordinator *cdt, __u32 archive,
1102                             struct obd_uuid *uuid);
1103 int mdt_hsm_agent_send(struct mdt_thread_info *mti, struct hsm_action_list *hal,
1104                        bool purge);
1105 /* mdt/mdt_hsm_cdt_client.c */
1106 int mdt_hsm_add_actions(struct mdt_thread_info *info,
1107                         struct hsm_action_list *hal);
1108 int mdt_hsm_get_action(struct mdt_thread_info *mti,
1109                        const struct lu_fid *fid,
1110                        enum hsm_copytool_action *action,
1111                        enum agent_req_status *status,
1112                        struct hsm_extent *extent);
1113 bool mdt_hsm_restore_is_running(struct mdt_thread_info *mti,
1114                                 const struct lu_fid *fid);
1115 /* mdt/mdt_hsm_cdt_requests.c */
1116 extern struct cfs_hash_ops cdt_request_cookie_hash_ops;
1117 extern struct cfs_hash_ops cdt_agent_record_hash_ops;
1118 extern const struct file_operations mdt_hsm_active_requests_fops;
1119 void dump_requests(char *prefix, struct coordinator *cdt);
1120 struct cdt_agent_req *mdt_cdt_alloc_request(__u32 archive_id, __u64 flags,
1121                                             struct obd_uuid *uuid,
1122                                             struct hsm_action_item *hai);
1123 void mdt_cdt_free_request(struct cdt_agent_req *car);
1124 int mdt_cdt_add_request(struct coordinator *cdt, struct cdt_agent_req *new_car);
1125 struct cdt_agent_req *mdt_cdt_find_request(struct coordinator *cdt, u64 cookie);
1126 void mdt_cdt_get_request(struct cdt_agent_req *car);
1127 void mdt_cdt_put_request(struct cdt_agent_req *car);
1128 struct cdt_agent_req *mdt_cdt_update_request(struct coordinator *cdt,
1129                                          const struct hsm_progress_kernel *pgs);
1130 int mdt_cdt_remove_request(struct coordinator *cdt, __u64 cookie);
1131 /* mdt/mdt_coordinator.c */
1132 void mdt_hsm_dump_hal(int level, const char *prefix,
1133                       struct hsm_action_list *hal);
1134 int cdt_restore_handle_add(struct mdt_thread_info *mti, struct coordinator *cdt,
1135                            const struct lu_fid *fid,
1136                            const struct hsm_extent *he);
1137 struct cdt_restore_handle *cdt_restore_handle_find(struct coordinator *cdt,
1138                                                    const struct lu_fid *fid);
1139 void cdt_restore_handle_del(struct mdt_thread_info *mti,
1140                             struct coordinator *cdt, const struct lu_fid *fid);
1141 /* coordinator management */
1142 int mdt_hsm_cdt_init(struct mdt_device *mdt);
1143 int mdt_hsm_cdt_stop(struct mdt_device *mdt);
1144 int mdt_hsm_cdt_fini(struct mdt_device *mdt);
1145
1146 /*
1147  * Signal the coordinator has work to do
1148  * \param cdt [IN] coordinator
1149  */
1150 static inline void mdt_hsm_cdt_event(struct coordinator *cdt)
1151 {
1152         cdt->cdt_event = true;
1153 }
1154
1155 /* coordinator control sysfs interface */
1156 ssize_t hsm_control_show(struct kobject *kobj, struct attribute *attr,
1157                          char *buf);
1158 ssize_t hsm_control_store(struct kobject *kobj, struct attribute *attr,
1159                           const char *buffer, size_t count);
1160 int hsm_cdt_tunables_init(struct mdt_device *mdt);
1161 void hsm_cdt_tunables_fini(struct mdt_device *mdt);
1162 /* md_hsm helpers */
1163 struct mdt_object *mdt_hsm_get_md_hsm(struct mdt_thread_info *mti,
1164                                       const struct lu_fid *fid,
1165                                       struct md_hsm *hsm);
1166 /* actions/request helpers */
1167 int mdt_hsm_add_hal(struct mdt_thread_info *mti,
1168                     struct hsm_action_list *hal, struct obd_uuid *uuid);
1169 bool mdt_hsm_is_action_compat(const struct hsm_action_item *hai,
1170                               u32 archive_id, u64 rq_flags,
1171                               const struct md_hsm *hsm);
1172 int mdt_hsm_update_request_state(struct mdt_thread_info *mti,
1173                                  struct hsm_progress_kernel *pgs);
1174
1175 extern struct lu_context_key       mdt_thread_key;
1176
1177 /* debug issues helper starts here*/
1178 static inline int mdt_fail_write(const struct lu_env *env,
1179                                  struct dt_device *dd, int id)
1180 {
1181         if (CFS_FAIL_CHECK_ORSET(id, CFS_FAIL_ONCE)) {
1182                 CERROR(LUSTRE_MDT_NAME": cfs_fail_loc=%x, fail write ops\n",
1183                        id);
1184                 return dt_ro(env, dd);
1185                 /* We set FAIL_ONCE because we never "un-fail" a device */
1186         }
1187
1188         return 0;
1189 }
1190
1191 static inline struct mdt_export_data *mdt_req2med(struct ptlrpc_request *req)
1192 {
1193         return &req->rq_export->exp_mdt_data;
1194 }
1195
1196 static inline struct mdt_device *mdt_exp2dev(struct obd_export *exp)
1197 {
1198         return mdt_dev(exp->exp_obd->obd_lu_dev);
1199 }
1200
1201 static inline bool mdt_rdonly(struct obd_export *exp)
1202 {
1203         return (exp_connect_flags(exp) & OBD_CONNECT_RDONLY ||
1204                 mdt_exp2dev(exp)->mdt_bottom->dd_rdonly ||
1205                 mdt_exp2dev(exp)->mdt_readonly);
1206 }
1207
1208 typedef void (*mdt_reconstruct_t)(struct mdt_thread_info *mti,
1209                                   struct mdt_lock_handle *lhc);
1210 static inline int mdt_check_resent(struct mdt_thread_info *info,
1211                                    mdt_reconstruct_t reconstruct,
1212                                    struct mdt_lock_handle *lhc)
1213 {
1214         struct ptlrpc_request *req = mdt_info_req(info);
1215         int rc = 0;
1216         ENTRY;
1217
1218         if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) {
1219                 OBD_ALLOC_PTR(info->mti_reply_data);
1220                 if (info->mti_reply_data == NULL)
1221                         RETURN(-ENOMEM);
1222
1223                 rc = req_can_reconstruct(req, info->mti_reply_data);
1224                 if (rc == 1) {
1225                         reconstruct(info, lhc);
1226                 } else {
1227                         DEBUG_REQ(D_HA, req,
1228                                   "no reply data found for RESENT req, rc = %d",
1229                                   rc);
1230                 }
1231                 OBD_FREE_PTR(info->mti_reply_data);
1232                 info->mti_reply_data = NULL;
1233         }
1234         RETURN(rc);
1235 }
1236
1237 struct lu_ucred *mdt_ucred(const struct mdt_thread_info *info);
1238 struct lu_ucred *mdt_ucred_check(const struct mdt_thread_info *info);
1239
1240 static inline int is_identity_get_disabled(struct upcall_cache *cache)
1241 {
1242         return cache ? (strcmp(cache->uc_upcall, "NONE") == 0) : 1;
1243 }
1244
1245 int mdt_blocking_ast(struct ldlm_lock*, struct ldlm_lock_desc*, void*, int);
1246
1247 static int mdt_dom_glimpse_ast(struct ldlm_lock *lock, void *reqp)
1248 {
1249         return -ELDLM_NO_LOCK_DATA;
1250 }
1251
1252 /* Issues dlm lock on passed @ns, @f stores it lock handle into @lh. */
1253 static inline int mdt_fid_lock(const struct lu_env *env,
1254                                struct ldlm_namespace *ns,
1255                                struct lustre_handle *lh, enum ldlm_mode mode,
1256                                union ldlm_policy_data *policy,
1257                                const struct ldlm_res_id *res_id,
1258                                __u64 flags, const __u64 *client_cookie)
1259 {
1260         int rc;
1261         bool glimpse = policy->l_inodebits.bits & MDS_INODELOCK_DOM;
1262
1263         LASSERT(ns != NULL);
1264         LASSERT(lh != NULL);
1265
1266         rc = ldlm_cli_enqueue_local(env, ns, res_id, LDLM_IBITS, policy,
1267                                     mode, &flags, mdt_blocking_ast,
1268                                     ldlm_completion_ast,
1269                                     glimpse ? mdt_dom_glimpse_ast : NULL,
1270                                     NULL, 0, LVB_T_NONE, client_cookie, lh);
1271         return rc == ELDLM_OK ? 0 : -EIO;
1272 }
1273
1274 static inline void mdt_fid_unlock(struct lustre_handle *lh, enum ldlm_mode mode)
1275 {
1276         ldlm_lock_decref(lh, mode);
1277 }
1278
1279 static inline bool mdt_slc_is_enabled(struct mdt_device *mdt)
1280 {
1281         return mdt->mdt_lut.lut_sync_lock_cancel == SYNC_LOCK_CANCEL_BLOCKING;
1282 }
1283
1284 extern mdl_mode_t mdt_mdl_lock_modes[];
1285 extern enum ldlm_mode mdt_dlm_lock_modes[];
1286
1287 /* LCK_MINMODE which is zero returns false for is_power_of_2 */
1288
1289 static inline mdl_mode_t mdt_dlm_mode2mdl_mode(enum ldlm_mode mode)
1290 {
1291         LASSERT(mode == LCK_MINMODE || is_power_of_2(mode));
1292         return mdt_mdl_lock_modes[mode];
1293 }
1294
1295 static inline enum ldlm_mode mdt_mdl_mode2dlm_mode(mdl_mode_t mode)
1296 {
1297         LASSERT(mode == MDL_MINMODE || is_power_of_2(mode));
1298         return mdt_dlm_lock_modes[mode];
1299 }
1300
1301 /* mdt_som.c */
1302 int mdt_set_som(struct mdt_thread_info *info, struct mdt_object *obj,
1303                 enum lustre_som_flags flag, __u64 size, __u64 blocks);
1304 int mdt_get_som(struct mdt_thread_info *info, struct mdt_object *obj,
1305                 struct md_attr *ma);
1306 int mdt_lsom_downgrade(struct mdt_thread_info *info, struct mdt_object *obj);
1307 int mdt_lsom_update(struct mdt_thread_info *info, struct mdt_object *obj,
1308                     bool truncate);
1309
1310 /* mdt_lvb.c */
1311 extern struct ldlm_valblock_ops mdt_lvbo;
1312 int mdt_dom_lvb_is_valid(struct ldlm_resource *res);
1313 int mdt_dom_lvbo_update(struct ldlm_resource *res, struct ldlm_lock *lock,
1314                         struct ptlrpc_request *req, bool increase_only);
1315
1316 void mdt_enable_cos(struct mdt_device *dev, bool enable);
1317 int mdt_cos_is_enabled(struct mdt_device *);
1318
1319 /* lprocfs stuff */
1320 enum mdt_stat_idx {
1321         LPROC_MDT_OPEN,
1322         LPROC_MDT_CLOSE,
1323         LPROC_MDT_MKNOD,
1324         LPROC_MDT_LINK,
1325         LPROC_MDT_UNLINK,
1326         LPROC_MDT_MKDIR,
1327         LPROC_MDT_RMDIR,
1328         LPROC_MDT_RENAME,
1329         LPROC_MDT_GETATTR,
1330         LPROC_MDT_SETATTR,
1331         LPROC_MDT_GETXATTR,
1332         LPROC_MDT_SETXATTR,
1333         LPROC_MDT_STATFS,
1334         LPROC_MDT_SYNC,
1335         LPROC_MDT_RENAME_SAMEDIR,
1336         LPROC_MDT_RENAME_PAR_FILE,
1337         LPROC_MDT_RENAME_PAR_DIR,
1338         LPROC_MDT_RENAME_CROSSDIR,
1339         LPROC_MDT_IO_READ,
1340         LPROC_MDT_IO_WRITE,
1341         LPROC_MDT_IO_READ_BYTES,
1342         LPROC_MDT_IO_WRITE_BYTES,
1343         LPROC_MDT_IO_PUNCH,
1344         LPROC_MDT_MIGRATE,
1345         LPROC_MDT_FALLOCATE,
1346         LPROC_MDT_LAST,
1347 };
1348
1349 void mdt_counter_incr(struct ptlrpc_request *req, int opcode, long amount);
1350 void mdt_stats_counter_init(struct lprocfs_stats *stats, unsigned int offset,
1351                             enum lprocfs_counter_config cntr_umask);
1352 int mdt_tunables_init(struct mdt_device *mdt, const char *name);
1353 void mdt_tunables_fini(struct mdt_device *mdt);
1354
1355 /* lustre/mdt_mdt_lproc.c */
1356 int lprocfs_mdt_open_files_seq_open(struct inode *inode,
1357                                     struct file *file);
1358 void mdt_rename_counter_tally(struct mdt_thread_info *info,
1359                               struct mdt_device *mdt,
1360                               struct ptlrpc_request *req,
1361                               struct mdt_object *src, struct mdt_object *tgt,
1362                               enum mdt_stat_idx msi, s64 count);
1363
1364 static inline struct obd_device *mdt2obd_dev(const struct mdt_device *mdt)
1365 {
1366         return mdt->mdt_lu_dev.ld_obd;
1367 }
1368
1369 extern const struct lu_device_operations mdt_lu_ops;
1370
1371 static inline char *mdt_obd_name(struct mdt_device *mdt)
1372 {
1373         return mdt->mdt_lu_dev.ld_obd->obd_name;
1374 }
1375
1376 int mds_mod_init(void);
1377 void mds_mod_exit(void);
1378
1379 static inline char *mdt_req_get_jobid(struct ptlrpc_request *req)
1380 {
1381         struct obd_export       *exp = req->rq_export;
1382         char                    *jobid = NULL;
1383
1384         if (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS)
1385                 jobid = lustre_msg_get_jobid(req->rq_reqmsg);
1386
1387         return jobid;
1388 }
1389
1390 /* MDT IO */
1391
1392 #define VALID_FLAGS (LA_TYPE | LA_MODE | LA_SIZE | LA_BLOCKS | \
1393                      LA_BLKSIZE | LA_ATIME | LA_MTIME | LA_CTIME)
1394
1395 int mdt_obd_preprw(const struct lu_env *env, int cmd, struct obd_export *exp,
1396                    struct obdo *oa, int objcount, struct obd_ioobj *obj,
1397                    struct niobuf_remote *rnb, int *nr_local,
1398                    struct niobuf_local *lnb);
1399
1400 int mdt_obd_commitrw(const struct lu_env *env, int cmd, struct obd_export *exp,
1401                      struct obdo *oa, int objcount, struct obd_ioobj *obj,
1402                      struct niobuf_remote *rnb, int npages,
1403                      struct niobuf_local *lnb, int old_rc, int nob,
1404                      ktime_t kstart);
1405 int mdt_punch_hdl(struct tgt_session_info *tsi);
1406 int mdt_fallocate_hdl(struct tgt_session_info *tsi);
1407 int mdt_glimpse_enqueue(struct mdt_thread_info *mti, struct ldlm_namespace *ns,
1408                         struct ldlm_lock **lockp, __u64 flags);
1409 int mdt_brw_enqueue(struct mdt_thread_info *info, struct ldlm_namespace *ns,
1410                     struct ldlm_lock **lockp, __u64 flags);
1411 int mdt_dom_read_on_open(struct mdt_thread_info *mti, struct mdt_device *mdt,
1412                          struct lustre_handle *lh);
1413 void mdt_dom_discard_data(struct mdt_thread_info *info, struct mdt_object *mo);
1414 int mdt_dom_disk_lvbo_update(const struct lu_env *env, struct mdt_object *mo,
1415                              struct ldlm_resource *res, bool increase_only);
1416 void mdt_dom_obj_lvb_update(const struct lu_env *env, struct mdt_object *mo,
1417                             struct obdo *oa, bool increase_only);
1418 int mdt_dom_lvb_alloc(struct ldlm_resource *res);
1419
1420 static inline bool mdt_dom_check_for_discard(struct mdt_thread_info *mti,
1421                                              struct mdt_object *mo)
1422 {
1423         return lu_object_is_dying(&mo->mot_header) &&
1424                S_ISREG(lu_object_attr(&mo->mot_obj));
1425 }
1426
1427 int mdt_dom_object_size(const struct lu_env *env, struct mdt_device *mdt,
1428                         const struct lu_fid *fid, struct mdt_body *mb,
1429                         bool dom_lock);
1430 bool mdt_dom_client_has_lock(struct mdt_thread_info *info,
1431                              const struct lu_fid *fid);
1432 void mdt_hp_brw(struct tgt_session_info *tsi);
1433 void mdt_hp_punch(struct tgt_session_info *tsi);
1434 int mdt_data_version_get(struct tgt_session_info *tsi);
1435 int mdt_io_set_info(struct tgt_session_info *tsi);
1436
1437 /* grants */
1438 long mdt_grant_connect(const struct lu_env *env, struct obd_export *exp,
1439                        u64 want, bool conservative);
1440 extern struct kmem_cache *ldlm_glimpse_work_kmem;
1441
1442 static inline bool mdt_changelog_allow(struct mdt_thread_info *info)
1443 {
1444         struct lu_ucred *uc = NULL;
1445         bool is_admin;
1446         int rc;
1447
1448         if (info == NULL || info->mti_body == NULL)
1449 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 17, 3, 0)
1450                 /* return true in case old client did not send mdt body */
1451                 return true;
1452 #else
1453                 return false;
1454 #endif
1455
1456         rc = mdt_init_ucred(info, (struct mdt_body *)info->mti_body);
1457         if (rc < 0)
1458                 return false;
1459
1460         uc = mdt_ucred(info);
1461         is_admin = (uc->uc_uid == 0 && uc->uc_gid == 0 &&
1462                     cap_raised(uc->uc_cap, CAP_SYS_ADMIN) &&
1463                     uc->uc_rbac_chlg_ops);
1464
1465         mdt_exit_ucred(info);
1466
1467         return is_admin;
1468 }
1469
1470 /* We forbid operations from encryption-unaware clients if they try to
1471  * manipulate encrypted files/directories.
1472  */
1473 static inline int mdt_check_enc(struct mdt_thread_info *info,
1474                                 struct mdt_object *obj)
1475 {
1476         struct obd_export *exp;
1477         struct md_attr ma = { 0 };
1478         int rc = 0;
1479
1480         if (!mdt_info_req(info))
1481                 /* no req, so cannot tell about client connection flags:
1482                  * allow access
1483                  */
1484                 return 0;
1485         exp = mdt_info_req(info)->rq_export;
1486         if (exp_connect_encrypt(exp))
1487                 /* client is encryption aware: fine */
1488                 return 0;
1489
1490         ma.ma_need = MA_INODE;
1491         mdt_attr_get_complex(info, obj, &ma);
1492         if (ma.ma_attr.la_valid & LA_FLAGS &&
1493             ma.ma_attr.la_flags & LUSTRE_ENCRYPT_FL)
1494                 rc = -ENOKEY;
1495
1496         if (rc)
1497                 CDEBUG(D_SEC, "%s: operation on encrypted "DFID
1498                        " from encryption-unaware client %s: %d\n",
1499                        mdt_obd_name(info->mti_mdt),
1500                        PFID(lu_object_fid(&obj->mot_obj)),
1501                        libcfs_nidstr(&exp->exp_connection->c_peer.nid), rc);
1502
1503         return rc;
1504 }
1505
1506 int mdt_fids_different_target(struct mdt_thread_info *info,
1507                               const struct lu_fid *fid1,
1508                               const struct lu_fid *fid2);
1509
1510 int mdt_reint_migrate(struct mdt_thread_info *info,
1511                       struct mdt_lock_handle *unused);
1512 int mdt_dir_layout_update(struct mdt_thread_info *info);
1513
1514 /* directory restripe */
1515 int mdt_restripe_internal(struct mdt_thread_info *info,
1516                           struct mdt_object *parent,
1517                           struct mdt_object *child,
1518                           const struct lu_name *lname,
1519                           struct lu_fid *tfid,
1520                           struct md_op_spec *spec,
1521                           struct md_attr *ma);
1522 int mdt_restriper_start(struct mdt_device *mdt);
1523 void mdt_restriper_stop(struct mdt_device *mdt);
1524 void mdt_auto_split_add(struct mdt_thread_info *info, struct mdt_object *o);
1525 void mdt_restripe_migrate_add(struct mdt_thread_info *info,
1526                               struct mdt_object *o);
1527 void mdt_restripe_update_add(struct mdt_thread_info *info,
1528                              struct mdt_object *o);
1529 int mdt_is_remote_object(struct mdt_thread_info *info,
1530                          struct mdt_object *parent,
1531                          struct mdt_object *child);
1532
1533 static unsigned int max_mod_rpcs_per_client = OBD_MAX_RIF_DEFAULT;
1534 #if OBD_OCD_VERSION(3, 0, 53, 0) > LUSTRE_VERSION_CODE
1535 static inline bool mdt_max_mod_rpcs_changed(struct mdt_device *mdt)
1536 {
1537         return max_mod_rpcs_per_client != OBD_MAX_RIF_DEFAULT &&
1538                 mdt->mdt_max_mod_rpcs_in_flight == OBD_MAX_RIF_DEFAULT;
1539 }
1540 #else
1541 #define mdt_max_mod_rpcs_changed(mdt) false
1542 #endif
1543
1544 #endif /* _MDT_INTERNAL_H */