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