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