lustre/mdt/mdt_internal.h

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