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, 2016, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lustre/mdt/mdt_internal.h
  33  *
  34  * Lustre Metadata Target (mdt) request handler
  35  *
  36  * Author: Peter Braam <braam@clusterfs.com>
  37  * Author: Andreas Dilger <adilger@clusterfs.com>
  38  * Author: Phil Schwan <phil@clusterfs.com>
  39  * Author: Mike Shaver <shaver@clusterfs.com>
  40  * Author: Nikita Danilov <nikita@clusterfs.com>
  41  * Author: Huang Hua <huanghua@clusterfs.com>
  42  */
  43
  44 #ifndef _MDT_INTERNAL_H
  45 #define _MDT_INTERNAL_H
  46
  47
  48 #include <upcall_cache.h>
  49 #include <lustre_net.h>
  50 #include <lustre/lustre_idl.h>
  51 #include <obd_class.h>
  52 #include <lustre_disk.h>
  53 #include <lu_target.h>
  54 #include <md_object.h>
  55 #include <lustre_fid.h>
  56 #include <lustre_fld.h>
  57 #include <lustre_req_layout.h>
  58 #include <lustre_sec.h>
  59 #include <lustre_idmap.h>
  60 #include <lustre_eacl.h>
  61 #include <lustre_quota.h>
  62 #include <lustre_linkea.h>
  63
  64 struct mdt_object;
  65
  66 /* file data for open files on MDS */
  67 struct mdt_file_data {
  68         /**  portals handle must be first */
  69         struct portals_handle   mfd_handle;
  70         /** open mode provided by client */
  71         __u64                   mfd_mode;
  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_old_handle;
  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 enum cdt_states { CDT_STOPPED = 0,
  95                   CDT_INIT,
  96                   CDT_RUNNING,
  97                   CDT_DISABLE,
  98                   CDT_STOPPING };
  99
 100 /* when multiple lock are needed, the lock order is
 101  * cdt_llog_lock
 102  * cdt_agent_lock
 103  * cdt_counter_lock
 104  * cdt_restore_lock
 105  * cdt_request_lock
 106  */
 107 struct coordinator {
 108         struct ptlrpc_thread     cdt_thread;         /**< coordinator thread */
 109         struct lu_env            cdt_env;            /**< coordinator lustre
 110                                                       * env */
 111         struct lu_context        cdt_session;        /** session for lu_ucred */
 112         struct proc_dir_entry   *cdt_proc_dir;       /**< cdt /proc directory */
 113         __u64                    cdt_policy;         /**< policy flags */
 114         enum cdt_states          cdt_state;           /**< state */
 115         atomic_t                 cdt_compound_id;     /**< compound id
 116                                                        * counter */
 117         __u64                    cdt_last_cookie;     /**< last cookie
 118                                                        * allocated */
 119         struct mutex             cdt_llog_lock;       /**< protect llog
 120                                                        * access */
 121         struct rw_semaphore      cdt_agent_lock;      /**< protect agent list */
 122         struct rw_semaphore      cdt_request_lock;    /**< protect request
 123                                                        * list */
 124         struct mutex             cdt_restore_lock;    /**< protect restore
 125                                                        * list */
 126         cfs_time_t               cdt_loop_period;     /**< llog scan period */
 127         cfs_time_t               cdt_grace_delay;     /**< request grace
 128                                                        * delay */
 129         cfs_time_t               cdt_active_req_timeout; /**< request timeout */
 130         __u32                    cdt_default_archive_id; /**< archive id used
 131                                                        * when none are
 132                                                        * specified */
 133         __u64                    cdt_max_requests;    /**< max count of started
 134                                                        * requests */
 135         atomic_t                 cdt_request_count;   /**< current count of
 136                                                        * started requests */
 137         struct list_head         cdt_requests;        /**< list of started
 138                                                        * requests */
 139         struct list_head         cdt_agents;          /**< list of register
 140                                                        * agents */
 141         struct list_head         cdt_restore_hdl;     /**< list of restore lock
 142                                                        * handles */
 143         /* Bitmasks indexed by the HSMA_XXX constants. */
 144         __u64                    cdt_user_request_mask;
 145         __u64                    cdt_group_request_mask;
 146         __u64                    cdt_other_request_mask;
 147 };
 148
 149 /* mdt state flag bits */
 150 #define MDT_FL_CFGLOG 0
 151 #define MDT_FL_SYNCED 1
 152
 153 struct mdt_device {
 154         /* super-class */
 155         struct lu_device           mdt_lu_dev;
 156         struct seq_server_site     mdt_seq_site;
 157         /* DLM name-space for meta-data locks maintained by this server */
 158         struct ldlm_namespace     *mdt_namespace;
 159         /* ptlrpc handle for MDS->client connections (for lock ASTs). */
 160         struct ptlrpc_client      *mdt_ldlm_client;
 161         /* underlying device */
 162         struct obd_export         *mdt_child_exp;
 163         struct md_device          *mdt_child;
 164         struct dt_device          *mdt_bottom;
 165         struct obd_export         *mdt_bottom_exp;
 166         /** target device */
 167         struct lu_target           mdt_lut;
 168         /*
 169          * Options bit-fields.
 170          */
 171         struct {
 172                 unsigned int       mo_user_xattr:1,
 173                                    mo_acl:1,
 174                                    mo_cos:1,
 175                                    mo_evict_tgt_nids:1,
 176                                    mo_coordinator:1;
 177         } mdt_opts;
 178         /* mdt state flags */
 179         unsigned long              mdt_state;
 180
 181         /* transaction callbacks */
 182         struct dt_txn_callback     mdt_txn_cb;
 183
 184         /* these values should be updated from lov if necessary.
 185          * or should be placed somewhere else. */
 186         int                        mdt_max_mdsize;
 187
 188         int                        mdt_max_ea_size;
 189
 190         struct upcall_cache        *mdt_identity_cache;
 191
 192         unsigned int               mdt_capa_conf:1,
 193                                    /* Enable remote dir on non-MDT0 */
 194                                    mdt_enable_remote_dir:1,
 195                                    mdt_skip_lfsck:1;
 196
 197         gid_t                      mdt_enable_remote_dir_gid;
 198
 199         /* lock for osfs and md_root */
 200         spinlock_t                 mdt_lock;
 201
 202         /* statfs optimization: we cache a bit  */
 203         struct obd_statfs          mdt_osfs;
 204         __u64                      mdt_osfs_age;
 205
 206         /* root squash */
 207         struct root_squash_info    mdt_squash;
 208
 209         struct rename_stats        mdt_rename_stats;
 210         struct lu_fid              mdt_md_root_fid;
 211
 212         /* connection to quota master */
 213         struct obd_export         *mdt_qmt_exp;
 214         /* quota master device associated with this MDT */
 215         struct lu_device          *mdt_qmt_dev;
 216
 217         struct coordinator         mdt_coordinator;
 218
 219         /* inter-MDT connection count */
 220         atomic_t                   mdt_mds_mds_conns;
 221
 222         /* MDT device async commit count, used for debug and sanity test */
 223         atomic_t                   mdt_async_commit_count;
 224
 225         struct mdt_object         *mdt_md_root;
 226 };
 227
 228 #define MDT_SERVICE_WATCHDOG_FACTOR     (2)
 229 #define MDT_COS_DEFAULT         (0)
 230
 231 struct mdt_object {
 232         struct lu_object_header mot_header;
 233         struct lu_object        mot_obj;
 234         unsigned int            mot_lov_created:1,  /* lov object created */
 235                                 mot_cache_attr:1;   /* enable remote object
 236                                                      * attribute cache */
 237         int                     mot_write_count;
 238         spinlock_t              mot_write_lock;
 239         /* Lock to protect create_data */
 240         struct mutex            mot_lov_mutex;
 241         /* Lock to protect lease open.
 242          * Lease open acquires write lock; normal open acquires read lock */
 243         struct rw_semaphore     mot_open_sem;
 244         atomic_t                mot_lease_count;
 245         atomic_t                mot_open_count;
 246 };
 247
 248 struct mdt_lock_handle {
 249         /* Lock type, reg for cross-ref use or pdo lock. */
 250         mdl_type_t              mlh_type;
 251
 252         /* Regular lock */
 253         struct lustre_handle    mlh_reg_lh;
 254         enum ldlm_mode          mlh_reg_mode;
 255
 256         /* Pdirops lock */
 257         struct lustre_handle    mlh_pdo_lh;
 258         enum ldlm_mode          mlh_pdo_mode;
 259         unsigned int            mlh_pdo_hash;
 260
 261         /* Remote regular lock */
 262         struct lustre_handle    mlh_rreg_lh;
 263         enum ldlm_mode          mlh_rreg_mode;
 264 };
 265
 266 enum {
 267         MDT_LH_PARENT,  /* parent lockh */
 268         MDT_LH_CHILD,   /* child lockh */
 269         MDT_LH_OLD,     /* old lockh for rename */
 270         MDT_LH_LAYOUT = MDT_LH_OLD, /* layout lock */
 271         MDT_LH_NEW,     /* new lockh for rename */
 272         MDT_LH_RMT,     /* used for return lh to caller */
 273         MDT_LH_LOCAL,   /* local lock never return to client */
 274         MDT_LH_NR
 275 };
 276
 277 enum {
 278         MDT_LOCAL_LOCK,
 279         MDT_CROSS_LOCK
 280 };
 281
 282 /* Special magical errno for communicaiton between mdt_reint_open()
 283  * and mdt_intent_reint() which means return the lock to the client
 284  * for subsequent cross ref open. Previously we used plain -EREMOTE
 285  * but other functions called in that path might return it too and
 286  * confuse us. This is not returned to the client. See LU-5370. */
 287 #define MDT_EREMOTE_OPEN (EREMOTE + 1024)
 288
 289 struct mdt_reint_record {
 290         mdt_reint_t                      rr_opcode;
 291         const struct lustre_handle      *rr_handle;
 292         const struct lu_fid             *rr_fid1;
 293         const struct lu_fid             *rr_fid2;
 294         struct lu_name                   rr_name;
 295         struct lu_name                   rr_tgt_name;
 296         void                            *rr_eadata;
 297         int                              rr_eadatalen;
 298         __u32                            rr_flags;
 299 };
 300
 301 enum mdt_reint_flag {
 302         MRF_OPEN_TRUNC = 1 << 0,
 303 };
 304
 305 /*
 306  * Common data shared by mdt-level handlers. This is allocated per-thread to
 307  * reduce stack consumption.
 308  */
 309 struct mdt_thread_info {
 310         /*
 311          * XXX: Part One:
 312          * The following members will be filled explicitly
 313          * with specific data in mdt_thread_info_init().
 314          */
 315         /* TODO: move this into mdt_session_key(with LCT_SESSION), because
 316          * request handling may migrate from one server thread to another.
 317          */
 318         struct req_capsule        *mti_pill;
 319
 320         /* although we have export in req, there are cases when it is not
 321          * available, e.g. closing files upon export destroy */
 322         struct obd_export          *mti_exp;
 323         /*
 324          * A couple of lock handles.
 325          */
 326         struct mdt_lock_handle     mti_lh[MDT_LH_NR];
 327
 328         struct mdt_device         *mti_mdt;
 329         const struct lu_env       *mti_env;
 330
 331         /* transaction number of current request */
 332         __u64                      mti_transno;
 333
 334
 335         /*
 336          * XXX: Part Two:
 337          * The following members will be filled expilictly
 338          * with zero in mdt_thread_info_init(). These members may be used
 339          * by all requests.
 340          */
 341
 342         /*
 343          * Object attributes.
 344          */
 345         struct md_attr             mti_attr;
 346         /*
 347          * Body for "habeo corpus" operations.
 348          */
 349         const struct mdt_body     *mti_body;
 350         /*
 351          * Host object. This is released at the end of mdt_handler().
 352          */
 353         struct mdt_object         *mti_object;
 354         /*
 355          * Lock request for "habeo clavis" operations.
 356          */
 357         const struct ldlm_request *mti_dlm_req;
 358
 359         __u32                      mti_has_trans:1, /* has txn already? */
 360                                    mti_cross_ref:1;
 361
 362         /* opdata for mdt_reint_open(), has the same as
 363          * ldlm_reply:lock_policy_res1.  mdt_update_last_rcvd() stores this
 364          * value onto disk for recovery when mdt_trans_stop_cb() is called.
 365          */
 366         __u64                      mti_opdata;
 367
 368         /*
 369          * XXX: Part Three:
 370          * The following members will be filled explicitly
 371          * with zero in mdt_reint_unpack(), because they are only used
 372          * by reint requests (including mdt_reint_open()).
 373          */
 374
 375         /*
 376          * reint record. contains information for reint operations.
 377          */
 378         struct mdt_reint_record    mti_rr;
 379
 380         __u64                      mti_ver[PTLRPC_NUM_VERSIONS];
 381         /*
 382          * Operation specification (currently create and lookup)
 383          */
 384         struct md_op_spec          mti_spec;
 385
 386         /*
 387          * XXX: Part Four:
 388          * The following members will _NOT_ be initialized at all.
 389          * DO NOT expect them to contain any valid value.
 390          * They should be initialized explicitly by the user themselves.
 391          */
 392
 393         /* XXX: If something is in a union, make sure they do not conflict */
 394         struct lu_fid                   mti_tmp_fid1;
 395         struct lu_fid                   mti_tmp_fid2;
 396         union ldlm_policy_data          mti_policy; /* for mdt_object_lock() */
 397         struct ldlm_res_id              mti_res_id; /* and mdt_rename_lock() */
 398         union {
 399                 struct obd_uuid         uuid[2];    /* for mdt_seq_init_cli() */
 400                 char                    ns_name[48];/* for mdt_init0()        */
 401                 struct lustre_cfg_bufs  bufs;       /* for mdt_stack_fini()   */
 402                 struct obd_statfs       osfs;       /* for mdt_statfs()       */
 403                 struct {
 404                         /* for mdt_readpage()      */
 405                         struct lu_rdpg     mti_rdpg;
 406                         /* for mdt_sendpage()      */
 407                         struct l_wait_info mti_wait_info;
 408                 } rdpg;
 409                 struct {
 410                         struct md_attr attr;
 411                 } hsm;
 412         } mti_u;
 413
 414         struct lustre_handle       mti_close_handle;
 415         loff_t                     mti_off;
 416         struct lu_buf              mti_buf;
 417         struct lu_buf              mti_big_buf;
 418
 419         /* Ops object filename */
 420         struct lu_name             mti_name;
 421         /* per-thread values, can be re-used, may be vmalloc'd */
 422         void                      *mti_big_lmm;
 423         int                        mti_big_lmmsize;
 424         /* big_lmm buffer was used and must be used in reply */
 425         int                        mti_big_lmm_used;
 426         /* should be enough to fit lustre_mdt_attrs */
 427         char                       mti_xattr_buf[128];
 428         struct ldlm_enqueue_info   mti_einfo;
 429         struct tg_reply_data      *mti_reply_data;
 430 };
 431
 432 extern struct lu_context_key mdt_thread_key;
 433
 434 static inline struct mdt_thread_info *mdt_th_info(const struct lu_env *env)
 435 {
 436         struct mdt_thread_info *mti;
 437
 438         lu_env_refill((void *)env);
 439         mti = lu_context_key_get(&env->le_ctx, &mdt_thread_key);
 440         LASSERT(mti);
 441         return mti;
 442 }
 443
 444 struct cdt_req_progress {
 445         struct mutex             crp_lock;      /**< protect tree */
 446         struct interval_node    *crp_root;      /**< tree to track extent
 447                                                  *   moved */
 448         struct interval_node    **crp_node;     /**< buffer for tree nodes
 449                                                  *   vector of fixed size
 450                                                  *   vectors */
 451         int                      crp_cnt;       /**< # of used nodes */
 452         int                      crp_max;       /**< # of allocated nodes */
 453 };
 454
 455 struct cdt_agent_req {
 456         struct list_head         car_request_list; /**< to chain all the req. */
 457         atomic_t                 car_refcount;     /**< reference counter */
 458         __u64                    car_compound_id;  /**< compound id */
 459         __u64                    car_flags;        /**< request original flags */
 460         struct obd_uuid          car_uuid;         /**< agent doing the req. */
 461         __u32                    car_archive_id;   /**< archive id */
 462         int                      car_canceled;     /**< request was canceled */
 463         cfs_time_t               car_req_start;    /**< start time */
 464         cfs_time_t               car_req_update;   /**< last update time */
 465         struct hsm_action_item  *car_hai;          /**< req. to the agent */
 466         struct cdt_req_progress  car_progress;     /**< track data mvt
 467                                                     *   progress */
 468 };
 469 extern struct kmem_cache *mdt_hsm_car_kmem;
 470
 471 struct hsm_agent {
 472         struct list_head ha_list;               /**< to chain the agents */
 473         struct obd_uuid  ha_uuid;               /**< agent uuid */
 474         __u32           *ha_archive_id;         /**< archive id */
 475         int              ha_archive_cnt;        /**< number of archive entries
 476                                                  *   0 means any archive */
 477         atomic_t         ha_requests;           /**< current request count */
 478         atomic_t         ha_success;            /**< number of successful
 479                                                  * actions */
 480         atomic_t         ha_failure;            /**< number of failed actions */
 481 };
 482
 483 struct cdt_restore_handle {
 484         struct list_head        crh_list;       /**< to chain the handle */
 485         struct lu_fid           crh_fid;        /**< fid of the object */
 486         struct ldlm_extent      crh_extent;     /**< extent of the restore */
 487         struct mdt_lock_handle  crh_lh;         /**< lock handle */
 488 };
 489 extern struct kmem_cache *mdt_hsm_cdt_kmem;     /** restore handle slab cache */
 490
 491 static inline const struct md_device_operations *
 492 mdt_child_ops(struct mdt_device * m)
 493 {
 494         LASSERT(m->mdt_child);
 495         return m->mdt_child->md_ops;
 496 }
 497
 498 static inline struct md_object *mdt_object_child(struct mdt_object *o)
 499 {
 500         LASSERT(o);
 501         return lu2md(lu_object_next(&o->mot_obj));
 502 }
 503
 504 static inline struct ptlrpc_request *mdt_info_req(struct mdt_thread_info *info)
 505 {
 506          return info->mti_pill ? info->mti_pill->rc_req : NULL;
 507 }
 508
 509 static inline __u64 mdt_conn_flags(struct mdt_thread_info *info)
 510 {
 511         LASSERT(info->mti_exp);
 512         return exp_connect_flags(info->mti_exp);
 513 }
 514
 515 static inline void mdt_object_get(const struct lu_env *env,
 516                                   struct mdt_object *o)
 517 {
 518         ENTRY;
 519         lu_object_get(&o->mot_obj);
 520         EXIT;
 521 }
 522
 523 static inline void mdt_object_put(const struct lu_env *env,
 524                                   struct mdt_object *o)
 525 {
 526         ENTRY;
 527         lu_object_put(env, &o->mot_obj);
 528         EXIT;
 529 }
 530
 531 static inline int mdt_object_exists(const struct mdt_object *o)
 532 {
 533         return lu_object_exists(&o->mot_obj);
 534 }
 535
 536 static inline int mdt_object_remote(const struct mdt_object *o)
 537 {
 538         return lu_object_remote(&o->mot_obj);
 539 }
 540
 541 static inline const struct lu_fid *mdt_object_fid(const struct mdt_object *o)
 542 {
 543         return lu_object_fid(&o->mot_obj);
 544 }
 545
 546 static inline struct lu_site *mdt_lu_site(const struct mdt_device *mdt)
 547 {
 548         return mdt->mdt_lu_dev.ld_site;
 549 }
 550
 551 static inline struct seq_server_site *mdt_seq_site(struct mdt_device *mdt)
 552 {
 553         return &mdt->mdt_seq_site;
 554 }
 555
 556 static inline void mdt_export_evict(struct obd_export *exp)
 557 {
 558         class_fail_export(exp);
 559 }
 560
 561 /* Here we use LVB_TYPE to check dne client, because it is
 562  * also landed on 2.4. */
 563 static inline bool mdt_is_dne_client(struct obd_export *exp)
 564 {
 565         return !!(exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE);
 566 }
 567
 568 static inline bool mdt_is_striped_client(struct obd_export *exp)
 569 {
 570         return exp_connect_flags(exp) & OBD_CONNECT_DIR_STRIPE;
 571 }
 572
 573 __u64 mdt_get_disposition(struct ldlm_reply *rep, __u64 op_flag);
 574 void mdt_set_disposition(struct mdt_thread_info *info,
 575                          struct ldlm_reply *rep, __u64 op_flag);
 576 void mdt_clear_disposition(struct mdt_thread_info *info,
 577                            struct ldlm_reply *rep, __u64 op_flag);
 578
 579 void mdt_lock_pdo_init(struct mdt_lock_handle *lh, enum ldlm_mode lock_mode,
 580                        const struct lu_name *lname);
 581
 582 void mdt_lock_reg_init(struct mdt_lock_handle *lh, enum ldlm_mode lm);
 583
 584 int mdt_lock_setup(struct mdt_thread_info *info, struct mdt_object *mo,
 585                    struct mdt_lock_handle *lh);
 586
 587 int mdt_check_resent_lock(struct mdt_thread_info *info, struct mdt_object *mo,
 588                           struct mdt_lock_handle *lhc);
 589
 590 int mdt_object_lock(struct mdt_thread_info *info, struct mdt_object *mo,
 591                     struct mdt_lock_handle *lh, __u64 ibits);
 592
 593 int mdt_reint_object_lock(struct mdt_thread_info *info, struct mdt_object *o,
 594                           struct mdt_lock_handle *lh, __u64 ibits,
 595                           bool cos_incompat);
 596
 597 int mdt_object_lock_try(struct mdt_thread_info *info, struct mdt_object *mo,
 598                         struct mdt_lock_handle *lh, __u64 ibits);
 599
 600 int mdt_reint_object_lock_try(struct mdt_thread_info *info,
 601                               struct mdt_object *o, struct mdt_lock_handle *lh,
 602                               __u64 ibits, bool cos_incompat);
 603
 604 void mdt_object_unlock(struct mdt_thread_info *info, struct mdt_object *mo,
 605                        struct mdt_lock_handle *lh, int decref);
 606
 607 struct mdt_object *mdt_object_new(const struct lu_env *env,
 608                                   struct mdt_device *,
 609                                   const struct lu_fid *);
 610 struct mdt_object *mdt_object_find(const struct lu_env *,
 611                                    struct mdt_device *,
 612                                    const struct lu_fid *);
 613 struct mdt_object *mdt_object_find_lock(struct mdt_thread_info *,
 614                                         const struct lu_fid *,
 615                                         struct mdt_lock_handle *,
 616                                         __u64);
 617 void mdt_object_unlock_put(struct mdt_thread_info *,
 618                            struct mdt_object *,
 619                            struct mdt_lock_handle *,
 620                            int decref);
 621
 622 void mdt_client_compatibility(struct mdt_thread_info *info);
 623
 624 int mdt_remote_object_lock(struct mdt_thread_info *mti,
 625                            struct mdt_object *o, const struct lu_fid *fid,
 626                            struct lustre_handle *lh,
 627                            enum ldlm_mode mode, __u64 ibits, bool nonblock,
 628                            bool cache);
 629
 630 enum mdt_name_flags {
 631         MNF_FIX_ANON = 1,
 632 };
 633
 634 int mdt_name_unpack(struct req_capsule *pill,
 635                     const struct req_msg_field *field,
 636                     struct lu_name *ln,
 637                     enum mdt_name_flags flags);
 638 int mdt_close_unpack(struct mdt_thread_info *info);
 639 int mdt_reint_unpack(struct mdt_thread_info *info, __u32 op);
 640 int mdt_reint_rec(struct mdt_thread_info *, struct mdt_lock_handle *);
 641 #ifdef CONFIG_FS_POSIX_ACL
 642 int mdt_pack_acl2body(struct mdt_thread_info *info, struct mdt_body *repbody,
 643                       struct mdt_object *o, struct lu_nodemap *nodemap);
 644 #endif
 645 void mdt_pack_attr2body(struct mdt_thread_info *info, struct mdt_body *b,
 646                         const struct lu_attr *attr, const struct lu_fid *fid);
 647
 648 int mdt_getxattr(struct mdt_thread_info *info);
 649 int mdt_reint_setxattr(struct mdt_thread_info *info,
 650                        struct mdt_lock_handle *lh);
 651
 652 void mdt_lock_handle_init(struct mdt_lock_handle *lh);
 653 void mdt_lock_handle_fini(struct mdt_lock_handle *lh);
 654
 655 void mdt_reconstruct(struct mdt_thread_info *, struct mdt_lock_handle *);
 656 void mdt_reconstruct_generic(struct mdt_thread_info *mti,
 657                              struct mdt_lock_handle *lhc);
 658
 659 extern void target_recovery_fini(struct obd_device *obd);
 660 extern void target_recovery_init(struct lu_target *lut,
 661                                  svc_handler_t handler);
 662 int mdt_fs_setup(const struct lu_env *, struct mdt_device *,
 663                  struct obd_device *, struct lustre_sb_info *lsi);
 664 void mdt_fs_cleanup(const struct lu_env *, struct mdt_device *);
 665
 666 int mdt_export_stats_init(struct obd_device *obd,
 667                           struct obd_export *exp,
 668                           void *client_nid);
 669
 670 int mdt_lock_new_child(struct mdt_thread_info *info,
 671                        struct mdt_object *o,
 672                        struct mdt_lock_handle *child_lockh);
 673
 674 void mdt_mfd_set_mode(struct mdt_file_data *mfd,
 675                       __u64 mode);
 676
 677 int mdt_reint_open(struct mdt_thread_info *info,
 678                    struct mdt_lock_handle *lhc);
 679
 680 struct mdt_file_data *mdt_handle2mfd(struct mdt_export_data *med,
 681                                      const struct lustre_handle *handle,
 682                                      bool is_replay);
 683
 684 int mdt_get_info(struct tgt_session_info *tsi);
 685 int mdt_attr_get_complex(struct mdt_thread_info *info,
 686                          struct mdt_object *o, struct md_attr *ma);
 687 int mdt_big_xattr_get(struct mdt_thread_info *info, struct mdt_object *o,
 688                       const char *name);
 689 int mdt_stripe_get(struct mdt_thread_info *info, struct mdt_object *o,
 690                    struct md_attr *ma, const char *name);
 691 int mdt_write_get(struct mdt_object *o);
 692 void mdt_write_put(struct mdt_object *o);
 693 int mdt_write_read(struct mdt_object *o);
 694 struct mdt_file_data *mdt_mfd_new(const struct mdt_export_data *med);
 695 int mdt_mfd_close(struct mdt_thread_info *info, struct mdt_file_data *mfd);
 696 void mdt_mfd_free(struct mdt_file_data *mfd);
 697 int mdt_close(struct tgt_session_info *tsi);
 698 int mdt_add_dirty_flag(struct mdt_thread_info *info, struct mdt_object *mo,
 699                         struct md_attr *ma);
 700 int mdt_fix_reply(struct mdt_thread_info *info);
 701 int mdt_handle_last_unlink(struct mdt_thread_info *, struct mdt_object *,
 702                            const struct md_attr *);
 703 void mdt_reconstruct_open(struct mdt_thread_info *, struct mdt_lock_handle *);
 704
 705 struct lu_buf *mdt_buf(const struct lu_env *env, void *area, ssize_t len);
 706 const struct lu_buf *mdt_buf_const(const struct lu_env *env,
 707                                    const void *area, ssize_t len);
 708
 709 void mdt_dump_lmm(int level, const struct lov_mds_md *lmm, __u64 valid);
 710 void mdt_dump_lmv(unsigned int level, const union lmv_mds_md *lmv);
 711
 712 bool allow_client_chgrp(struct mdt_thread_info *info, struct lu_ucred *uc);
 713 int mdt_check_ucred(struct mdt_thread_info *);
 714 int mdt_init_ucred(struct mdt_thread_info *, struct mdt_body *);
 715 int mdt_init_ucred_intent_getattr(struct mdt_thread_info *, struct mdt_body *);
 716 int mdt_init_ucred_reint(struct mdt_thread_info *);
 717 void mdt_exit_ucred(struct mdt_thread_info *);
 718 int mdt_version_get_check(struct mdt_thread_info *, struct mdt_object *, int);
 719 void mdt_version_get_save(struct mdt_thread_info *, struct mdt_object *, int);
 720 int mdt_version_get_check_save(struct mdt_thread_info *, struct mdt_object *,
 721                                int);
 722 void mdt_thread_info_init(struct ptlrpc_request *req,
 723                           struct mdt_thread_info *mti);
 724 void mdt_thread_info_fini(struct mdt_thread_info *mti);
 725 struct mdt_thread_info *tsi2mdt_info(struct tgt_session_info *tsi);
 726
 727 int mdt_hsm_attr_set(struct mdt_thread_info *info, struct mdt_object *obj,
 728                      const struct md_hsm *mh);
 729
 730 int mdt_remote_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
 731                             void *data, int flag);
 732 int mdt_links_read(struct mdt_thread_info *info,
 733                    struct mdt_object *mdt_obj,
 734                    struct linkea_data *ldata);
 735 int mdt_close_internal(struct mdt_thread_info *info, struct ptlrpc_request *req,
 736                        struct mdt_body *repbody);
 737
 738 static inline struct mdt_device *mdt_dev(struct lu_device *d)
 739 {
 740         return container_of0(d, struct mdt_device, mdt_lu_dev);
 741 }
 742
 743 static inline struct mdt_object *mdt_obj(struct lu_object *o)
 744 {
 745         return container_of0(o, struct mdt_object, mot_obj);
 746 }
 747
 748 static inline struct dt_object *mdt_obj2dt(struct mdt_object *mo)
 749 {
 750         struct lu_object        *lo;
 751         struct mdt_device       *mdt = mdt_dev(mo->mot_obj.lo_dev);
 752
 753         lo = lu_object_locate(mo->mot_obj.lo_header,
 754                               mdt->mdt_bottom->dd_lu_dev.ld_type);
 755
 756         return lu2dt(lo);
 757 }
 758
 759 static inline bool agent_req_in_final_state(enum agent_req_status ars)
 760 {
 761         return ((ars == ARS_SUCCEED) || (ars == ARS_FAILED) ||
 762                 (ars == ARS_CANCELED));
 763 }
 764
 765 /* mdt/mdt_identity.c */
 766 #define MDT_IDENTITY_UPCALL_PATH        "/usr/sbin/l_getidentity"
 767
 768 extern struct upcall_cache_ops mdt_identity_upcall_cache_ops;
 769
 770 struct md_identity *mdt_identity_get(struct upcall_cache *, __u32);
 771
 772 void mdt_identity_put(struct upcall_cache *, struct md_identity *);
 773
 774 void mdt_flush_identity(struct upcall_cache *, int);
 775
 776 __u32 mdt_identity_get_perm(struct md_identity *, lnet_nid_t);
 777
 778 /* mdt/mdt_recovery.c */
 779 __u64 mdt_req_from_lrd(struct ptlrpc_request *req, struct tg_reply_data *trd);
 780
 781 /* mdt/mdt_hsm.c */
 782 int mdt_hsm_state_get(struct tgt_session_info *tsi);
 783 int mdt_hsm_state_set(struct tgt_session_info *tsi);
 784 int mdt_hsm_action(struct tgt_session_info *tsi);
 785 int mdt_hsm_progress(struct tgt_session_info *tsi);
 786 int mdt_hsm_ct_register(struct tgt_session_info *tsi);
 787 int mdt_hsm_ct_unregister(struct tgt_session_info *tsi);
 788 int mdt_hsm_request(struct tgt_session_info *tsi);
 789
 790 /* mdt/mdt_hsm_cdt_actions.c */
 791 extern const struct file_operations mdt_hsm_actions_fops;
 792 void dump_llog_agent_req_rec(const char *prefix,
 793                              const struct llog_agent_req_rec *larr);
 794 int cdt_llog_process(const struct lu_env *env, struct mdt_device *mdt,
 795                      llog_cb_t cb, void *data);
 796 int mdt_agent_record_add(const struct lu_env *env, struct mdt_device *mdt,
 797                          __u64 compound_id, __u32 archive_id,
 798                          __u64 flags, struct hsm_action_item *hai);
 799 int mdt_agent_record_update(const struct lu_env *env,
 800                             struct mdt_device *mdt, __u64 *cookies,
 801                             int cookies_count, enum agent_req_status status);
 802
 803 /* mdt/mdt_hsm_cdt_agent.c */
 804 extern const struct file_operations mdt_hsm_agent_fops;
 805 int mdt_hsm_agent_register(struct mdt_thread_info *info,
 806                            const struct obd_uuid *uuid,
 807                            int nr_archives, __u32 *archive_num);
 808 int mdt_hsm_agent_register_mask(struct mdt_thread_info *info,
 809                                 const struct obd_uuid *uuid,
 810                                 __u32 archive_mask);
 811 int mdt_hsm_agent_unregister(struct mdt_thread_info *info,
 812                              const struct obd_uuid *uuid);
 813 int mdt_hsm_agent_update_statistics(struct coordinator *cdt,
 814                                     int succ_rq, int fail_rq, int new_rq,
 815                                     const struct obd_uuid *uuid);
 816 int mdt_hsm_find_best_agent(struct coordinator *cdt, __u32 archive,
 817                             struct obd_uuid *uuid);
 818 int mdt_hsm_agent_send(struct mdt_thread_info *mti, struct hsm_action_list *hal,
 819                        bool purge);
 820 int mdt_hsm_coordinator_update(struct mdt_thread_info *mti,
 821                                struct hsm_progress_kernel *pgs);
 822 /* mdt/mdt_hsm_cdt_client.c */
 823 int mdt_hsm_add_actions(struct mdt_thread_info *info,
 824                         struct hsm_action_list *hal);
 825 int mdt_hsm_get_actions(struct mdt_thread_info *mti,
 826                         struct hsm_action_list *hal);
 827 int mdt_hsm_get_running(struct mdt_thread_info *mti,
 828                         struct hsm_action_list *hal);
 829 bool mdt_hsm_restore_is_running(struct mdt_thread_info *mti,
 830                                 const struct lu_fid *fid);
 831 /* mdt/mdt_hsm_cdt_requests.c */
 832 extern const struct file_operations mdt_hsm_active_requests_fops;
 833 void dump_requests(char *prefix, struct coordinator *cdt);
 834 struct cdt_agent_req *mdt_cdt_alloc_request(__u64 compound_id, __u32 archive_id,
 835                                             __u64 flags, struct obd_uuid *uuid,
 836                                             struct hsm_action_item *hai);
 837 void mdt_cdt_free_request(struct cdt_agent_req *car);
 838 int mdt_cdt_add_request(struct coordinator *cdt, struct cdt_agent_req *new_car);
 839 struct cdt_agent_req *mdt_cdt_find_request(struct coordinator *cdt,
 840                                            const __u64 cookie,
 841                                            const struct lu_fid *fid);
 842 void mdt_cdt_get_work_done(struct cdt_agent_req *car, __u64 *done_sz);
 843 void mdt_cdt_get_request(struct cdt_agent_req *car);
 844 void mdt_cdt_put_request(struct cdt_agent_req *car);
 845 struct cdt_agent_req *mdt_cdt_update_request(struct coordinator *cdt,
 846                                          const struct hsm_progress_kernel *pgs);
 847 int mdt_cdt_remove_request(struct coordinator *cdt, __u64 cookie);
 848 /* mdt/mdt_coordinator.c */
 849 void mdt_hsm_dump_hal(int level, const char *prefix,
 850                       struct hsm_action_list *hal);
 851 struct cdt_restore_handle *mdt_hsm_restore_hdl_find(struct coordinator *cdt,
 852                                                 const struct lu_fid *fid);
 853 /* coordinator management */
 854 int mdt_hsm_cdt_init(struct mdt_device *mdt);
 855 int mdt_hsm_cdt_stop(struct mdt_device *mdt);
 856 int mdt_hsm_cdt_fini(struct mdt_device *mdt);
 857 int mdt_hsm_cdt_wakeup(struct mdt_device *mdt);
 858
 859 /* coordinator control /proc interface */
 860 ssize_t mdt_hsm_cdt_control_seq_write(struct file *file,
 861                                       const char __user *buffer,
 862                                       size_t count, loff_t *off);
 863 int mdt_hsm_cdt_control_seq_show(struct seq_file *m, void *data);
 864 int hsm_cdt_procfs_init(struct mdt_device *mdt);
 865 void hsm_cdt_procfs_fini(struct mdt_device *mdt);
 866 struct lprocfs_vars *hsm_cdt_get_proc_vars(void);
 867 /* md_hsm helpers */
 868 struct mdt_object *mdt_hsm_get_md_hsm(struct mdt_thread_info *mti,
 869                                       const struct lu_fid *fid,
 870                                       struct md_hsm *hsm);
 871 /* actions/request helpers */
 872 int mdt_hsm_add_hal(struct mdt_thread_info *mti,
 873                     struct hsm_action_list *hal, struct obd_uuid *uuid);
 874 bool mdt_hsm_is_action_compat(const struct hsm_action_item *hai,
 875                               const int hal_an, const __u64 rq_flags,
 876                               const struct md_hsm *hsm);
 877 int mdt_hsm_update_request_state(struct mdt_thread_info *mti,
 878                                  struct hsm_progress_kernel *pgs,
 879                                  const int update_record);
 880
 881 int mdt_close_swap_layouts(struct mdt_thread_info *info,
 882                            struct mdt_object *o, struct md_attr *ma);
 883
 884 extern struct lu_context_key       mdt_thread_key;
 885
 886 /* debug issues helper starts here*/
 887 static inline int mdt_fail_write(const struct lu_env *env,
 888                                  struct dt_device *dd, int id)
 889 {
 890         if (OBD_FAIL_CHECK_ORSET(id, OBD_FAIL_ONCE)) {
 891                 CERROR(LUSTRE_MDT_NAME": cfs_fail_loc=%x, fail write ops\n",
 892                        id);
 893                 return dt_ro(env, dd);
 894                 /* We set FAIL_ONCE because we never "un-fail" a device */
 895         }
 896
 897         return 0;
 898 }
 899
 900 static inline struct mdt_export_data *mdt_req2med(struct ptlrpc_request *req)
 901 {
 902         return &req->rq_export->exp_mdt_data;
 903 }
 904
 905 static inline struct mdt_device *mdt_exp2dev(struct obd_export *exp)
 906 {
 907         return mdt_dev(exp->exp_obd->obd_lu_dev);
 908 }
 909
 910 typedef void (*mdt_reconstruct_t)(struct mdt_thread_info *mti,
 911                                   struct mdt_lock_handle *lhc);
 912 static inline int mdt_check_resent(struct mdt_thread_info *info,
 913                                    mdt_reconstruct_t reconstruct,
 914                                    struct mdt_lock_handle *lhc)
 915 {
 916         struct ptlrpc_request *req = mdt_info_req(info);
 917         int rc = 0;
 918         ENTRY;
 919
 920         if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) {
 921                 OBD_ALLOC_PTR(info->mti_reply_data);
 922                 if (info->mti_reply_data == NULL)
 923                         RETURN(-ENOMEM);
 924
 925                 if (req_can_reconstruct(req, info->mti_reply_data)) {
 926                         reconstruct(info, lhc);
 927                         rc = 1;
 928                 } else {
 929                         DEBUG_REQ(D_HA, req,
 930                                   "no reply data found for RESENT req");
 931                         rc = 0;
 932                 }
 933                 OBD_FREE_PTR(info->mti_reply_data);
 934                 info->mti_reply_data = NULL;
 935         }
 936         RETURN(rc);
 937 }
 938
 939 struct lu_ucred *mdt_ucred(const struct mdt_thread_info *info);
 940 struct lu_ucred *mdt_ucred_check(const struct mdt_thread_info *info);
 941
 942 static inline int is_identity_get_disabled(struct upcall_cache *cache)
 943 {
 944         return cache ? (strcmp(cache->uc_upcall, "NONE") == 0) : 1;
 945 }
 946
 947 int mdt_blocking_ast(struct ldlm_lock*, struct ldlm_lock_desc*, void*, int);
 948
 949 /* Issues dlm lock on passed @ns, @f stores it lock handle into @lh. */
 950 static inline int mdt_fid_lock(struct ldlm_namespace *ns,
 951                                struct lustre_handle *lh, enum ldlm_mode mode,
 952                                union ldlm_policy_data *policy,
 953                                const struct ldlm_res_id *res_id,
 954                                __u64 flags, const __u64 *client_cookie)
 955 {
 956         int rc;
 957
 958         LASSERT(ns != NULL);
 959         LASSERT(lh != NULL);
 960
 961         rc = ldlm_cli_enqueue_local(ns, res_id, LDLM_IBITS, policy,
 962                                     mode, &flags, mdt_blocking_ast,
 963                                     ldlm_completion_ast, NULL, NULL, 0,
 964                                     LVB_T_NONE, client_cookie, lh);
 965         return rc == ELDLM_OK ? 0 : -EIO;
 966 }
 967
 968 static inline void mdt_fid_unlock(struct lustre_handle *lh, enum ldlm_mode mode)
 969 {
 970         ldlm_lock_decref(lh, mode);
 971 }
 972
 973 static inline bool mdt_slc_is_enabled(struct mdt_device *mdt)
 974 {
 975         return mdt->mdt_lut.lut_sync_lock_cancel == BLOCKING_SYNC_ON_CANCEL;
 976 }
 977
 978 extern mdl_mode_t mdt_mdl_lock_modes[];
 979 extern enum ldlm_mode mdt_dlm_lock_modes[];
 980
 981 static inline mdl_mode_t mdt_dlm_mode2mdl_mode(enum ldlm_mode mode)
 982 {
 983         LASSERT(IS_PO2(mode));
 984         return mdt_mdl_lock_modes[mode];
 985 }
 986
 987 static inline enum ldlm_mode mdt_mdl_mode2dlm_mode(mdl_mode_t mode)
 988 {
 989         LASSERT(IS_PO2(mode));
 990         return mdt_dlm_lock_modes[mode];
 991 }
 992
 993 /* mdt_lvb.c */
 994 extern struct ldlm_valblock_ops mdt_lvbo;
 995
 996 void mdt_enable_cos(struct mdt_device *, int);
 997 int mdt_cos_is_enabled(struct mdt_device *);
 998
 999 /* lprocfs stuff */
1000 enum {
1001         LPROC_MDT_OPEN = 0,
1002         LPROC_MDT_CLOSE,
1003         LPROC_MDT_MKNOD,
1004         LPROC_MDT_LINK,
1005         LPROC_MDT_UNLINK,
1006         LPROC_MDT_MKDIR,
1007         LPROC_MDT_RMDIR,
1008         LPROC_MDT_RENAME,
1009         LPROC_MDT_GETATTR,
1010         LPROC_MDT_SETATTR,
1011         LPROC_MDT_GETXATTR,
1012         LPROC_MDT_SETXATTR,
1013         LPROC_MDT_STATFS,
1014         LPROC_MDT_SYNC,
1015         LPROC_MDT_SAMEDIR_RENAME,
1016         LPROC_MDT_CROSSDIR_RENAME,
1017         LPROC_MDT_LAST,
1018 };
1019 void mdt_counter_incr(struct ptlrpc_request *req, int opcode);
1020 void mdt_stats_counter_init(struct lprocfs_stats *stats);
1021 int mdt_procfs_init(struct mdt_device *mdt, const char *name);
1022 void mdt_procfs_fini(struct mdt_device *mdt);
1023
1024 /* lustre/mdt_mdt_lproc.c */
1025 int lprocfs_mdt_open_files_seq_open(struct inode *inode,
1026                                     struct file *file);
1027 void mdt_rename_counter_tally(struct mdt_thread_info *info,
1028                               struct mdt_device *mdt,
1029                               struct ptlrpc_request *req,
1030                               struct mdt_object *src, struct mdt_object *tgt);
1031
1032 static inline struct obd_device *mdt2obd_dev(const struct mdt_device *mdt)
1033 {
1034         return mdt->mdt_lu_dev.ld_obd;
1035 }
1036
1037 extern const struct lu_device_operations mdt_lu_ops;
1038
1039 static inline char *mdt_obd_name(struct mdt_device *mdt)
1040 {
1041         return mdt->mdt_lu_dev.ld_obd->obd_name;
1042 }
1043
1044 int mds_mod_init(void);
1045 void mds_mod_exit(void);
1046
1047 static inline char *mdt_req_get_jobid(struct ptlrpc_request *req)
1048 {
1049         struct obd_export       *exp = req->rq_export;
1050         char                    *jobid = NULL;
1051
1052         if (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS)
1053                 jobid = lustre_msg_get_jobid(req->rq_reqmsg);
1054
1055         return jobid;
1056 }
1057
1058 #endif /* _MDT_INTERNAL_H */