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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2013, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/mdt/mdt_internal.h
  37  *
  38  * Lustre Metadata Target (mdt) request handler
  39  *
  40  * Author: Peter Braam <braam@clusterfs.com>
  41  * Author: Andreas Dilger <adilger@clusterfs.com>
  42  * Author: Phil Schwan <phil@clusterfs.com>
  43  * Author: Mike Shaver <shaver@clusterfs.com>
  44  * Author: Nikita Danilov <nikita@clusterfs.com>
  45  * Author: Huang Hua <huanghua@clusterfs.com>
  46  */
  47
  48 #ifndef _MDT_INTERNAL_H
  49 #define _MDT_INTERNAL_H
  50
  51 #if defined(__KERNEL__)
  52
  53 #include <libcfs/lucache.h>
  54 #include <lustre_net.h>
  55 #include <lustre/lustre_idl.h>
  56 #include <obd_class.h>
  57 #include <lustre_disk.h>
  58 #include <lu_target.h>
  59 #include <md_object.h>
  60 #include <lustre_fid.h>
  61 #include <lustre_fld.h>
  62 #include <lustre_req_layout.h>
  63 #include <lustre_sec.h>
  64 #include <lustre_idmap.h>
  65 #include <lustre_eacl.h>
  66 #include <lustre_quota.h>
  67 #include <lustre_linkea.h>
  68
  69 /* check if request's xid is equal to last one or not*/
  70 static inline int req_xid_is_last(struct ptlrpc_request *req)
  71 {
  72         struct lsd_client_data *lcd = req->rq_export->exp_target_data.ted_lcd;
  73         return (req->rq_xid == lcd->lcd_last_xid ||
  74                 req->rq_xid == lcd->lcd_last_close_xid);
  75 }
  76
  77 struct mdt_object;
  78
  79 /* file data for open files on MDS */
  80 struct mdt_file_data {
  81         struct portals_handle mfd_handle; /* must be first */
  82         __u64                 mfd_mode;   /* open mode provided by client */
  83         cfs_list_t            mfd_list;   /* protected by med_open_lock */
  84         __u64                 mfd_xid;    /* xid of the open request */
  85         struct lustre_handle  mfd_old_handle; /* old handle in replay case */
  86         struct mdt_object    *mfd_object; /* point to opened object */
  87 };
  88
  89 #define CDT_NONBLOCKING_RESTORE         (1ULL << 0)
  90 #define CDT_NORETRY_ACTION              (1ULL << 1)
  91 #define CDT_POLICY_LAST                 CDT_NORETRY_ACTION
  92 #define CDT_POLICY_SHIFT_COUNT          2
  93 #define CDT_POLICY_ALL                  (CDT_NONBLOCKING_RESTORE | \
  94                                         CDT_NORETRY_ACTION)
  95
  96 /* when adding a new policy, do not forget to update
  97  * lustre/mdt/mdt_coordinator.c::hsm_policy_names[]
  98  */
  99 #define CDT_DEFAULT_POLICY              CDT_NORETRY_ACTION
 100
 101 enum cdt_states { CDT_STOPPED = 0,
 102                   CDT_INIT,
 103                   CDT_RUNNING,
 104                   CDT_DISABLE,
 105                   CDT_STOPPING };
 106
 107 /* when multiple lock are needed, the lock order is
 108  * cdt_llog_lock
 109  * cdt_agent_lock
 110  * cdt_counter_lock
 111  * cdt_restore_lock
 112  * cdt_request_lock
 113  */
 114 struct coordinator {
 115         struct ptlrpc_thread     cdt_thread;         /**< coordinator thread */
 116         struct lu_env            cdt_env;            /**< coordinator lustre
 117                                                       * env */
 118         struct lu_context        cdt_session;        /** session for lu_ucred */
 119         struct proc_dir_entry   *cdt_proc_dir;       /**< cdt /proc directory */
 120         __u64                    cdt_policy;         /**< policy flags */
 121         enum cdt_states          cdt_state;           /**< state */
 122         atomic_t                 cdt_compound_id;     /**< compound id
 123                                                        * counter */
 124         __u64                    cdt_last_cookie;     /**< last cookie
 125                                                        * allocated */
 126         struct mutex             cdt_llog_lock;       /**< protect llog
 127                                                        * access */
 128         struct rw_semaphore      cdt_agent_lock;      /**< protect agent list */
 129         struct rw_semaphore      cdt_request_lock;    /**< protect request
 130                                                        * list */
 131         struct mutex             cdt_restore_lock;    /**< protect restore
 132                                                        * list */
 133         cfs_time_t               cdt_loop_period;     /**< llog scan period */
 134         cfs_time_t               cdt_grace_delay;     /**< request grace
 135                                                        * delay */
 136         cfs_time_t               cdt_active_req_timeout; /**< request timeout */
 137         __u32                    cdt_default_archive_id; /**< archive id used
 138                                                        * when none are
 139                                                        * specified */
 140         __u64                    cdt_max_requests;    /**< max count of started
 141                                                        * requests */
 142         atomic_t                 cdt_request_count;   /**< current count of
 143                                                        * started requests */
 144         struct list_head         cdt_requests;        /**< list of started
 145                                                        * requests */
 146         struct list_head         cdt_agents;          /**< list of register
 147                                                        * agents */
 148         struct list_head         cdt_restore_hdl;     /**< list of restore lock
 149                                                        * handles */
 150         /* Bitmasks indexed by the HSMA_XXX constants. */
 151         __u64                    cdt_user_request_mask;
 152         __u64                    cdt_group_request_mask;
 153         __u64                    cdt_other_request_mask;
 154 };
 155
 156 /* mdt state flag bits */
 157 #define MDT_FL_CFGLOG 0
 158 #define MDT_FL_SYNCED 1
 159
 160 struct mdt_device {
 161         /* super-class */
 162         struct lu_device           mdt_lu_dev;
 163         struct seq_server_site     mdt_seq_site;
 164         /* DLM name-space for meta-data locks maintained by this server */
 165         struct ldlm_namespace     *mdt_namespace;
 166         /* ptlrpc handle for MDS->client connections (for lock ASTs). */
 167         struct ptlrpc_client      *mdt_ldlm_client;
 168         /* underlying device */
 169         struct obd_export         *mdt_child_exp;
 170         struct md_device          *mdt_child;
 171         struct dt_device          *mdt_bottom;
 172         struct obd_export         *mdt_bottom_exp;
 173         /** target device */
 174         struct lu_target           mdt_lut;
 175         /*
 176          * Options bit-fields.
 177          */
 178         struct {
 179                 unsigned int       mo_user_xattr:1,
 180                                    mo_acl:1,
 181                                    mo_cos:1,
 182                                    mo_coordinator:1;
 183         } mdt_opts;
 184         /* mdt state flags */
 185         unsigned long              mdt_state;
 186         /* lock to protect IOepoch */
 187         spinlock_t                 mdt_ioepoch_lock;
 188         __u64                      mdt_ioepoch;
 189
 190         /* transaction callbacks */
 191         struct dt_txn_callback     mdt_txn_cb;
 192
 193         /* these values should be updated from lov if necessary.
 194          * or should be placed somewhere else. */
 195         int                        mdt_max_mdsize;
 196
 197         int                        mdt_max_ea_size;
 198
 199         struct upcall_cache        *mdt_identity_cache;
 200
 201         /* capability keys */
 202         unsigned long              mdt_capa_timeout;
 203         __u32                      mdt_capa_alg;
 204         struct dt_object          *mdt_ck_obj;
 205         unsigned long              mdt_ck_timeout;
 206         unsigned long              mdt_ck_expiry;
 207         struct timer_list          mdt_ck_timer;
 208         struct ptlrpc_thread       mdt_ck_thread;
 209         struct lustre_capa_key     mdt_capa_keys[2];
 210         unsigned int               mdt_capa_conf:1,
 211                                    mdt_som_conf:1,
 212                                    /* Enable remote dir on non-MDT0 */
 213                                    mdt_enable_remote_dir:1;
 214
 215         gid_t                      mdt_enable_remote_dir_gid;
 216         /* statfs optimization: we cache a bit  */
 217         struct obd_statfs          mdt_osfs;
 218         __u64                      mdt_osfs_age;
 219         spinlock_t                 mdt_osfs_lock;
 220
 221         /* root squash */
 222         uid_t                      mdt_squash_uid;
 223         gid_t                      mdt_squash_gid;
 224         cfs_list_t                 mdt_nosquash_nids;
 225         char                      *mdt_nosquash_str;
 226         int                        mdt_nosquash_strlen;
 227         struct rw_semaphore        mdt_squash_sem;
 228
 229         struct rename_stats        mdt_rename_stats;
 230         struct lu_fid              mdt_md_root_fid;
 231
 232         /* connection to quota master */
 233         struct obd_export         *mdt_qmt_exp;
 234         /* quota master device associated with this MDT */
 235         struct lu_device          *mdt_qmt_dev;
 236
 237         struct coordinator         mdt_coordinator;
 238 };
 239
 240 #define MDT_SERVICE_WATCHDOG_FACTOR     (2)
 241 #define MDT_COS_DEFAULT         (0)
 242
 243 struct mdt_object {
 244         struct lu_object_header mot_header;
 245         struct lu_object        mot_obj;
 246         __u64                   mot_ioepoch;
 247         __u64                   mot_flags;
 248         int                     mot_ioepoch_count;
 249         int                     mot_writecount;
 250         /* Lock to protect object's IO epoch. */
 251         struct mutex            mot_ioepoch_mutex;
 252         /* Lock to protect create_data */
 253         struct mutex            mot_lov_mutex;
 254         /* Lock to protect lease open.
 255          * Lease open acquires write lock; normal open acquires read lock */
 256         struct rw_semaphore     mot_open_sem;
 257         atomic_t                mot_lease_count;
 258         atomic_t                mot_open_count;
 259 };
 260
 261 enum mdt_object_flags {
 262         /** SOM attributes are changed. */
 263         MOF_SOM_CHANGE  = (1 << 0),
 264         /**
 265          * The SOM recovery state for mdt object.
 266          * This state is an in-memory equivalent of an absent SOM EA, used
 267          * instead of invalidating SOM EA while IOEpoch is still opened when
 268          * a client eviction occurs or a client fails to obtain SOM attributes.
 269          * It indicates that the last IOEpoch holder will need to obtain SOM
 270          * attributes under [0;EOF] extent lock to flush all the client's
 271          * cached of evicted from MDS clients (but not necessary evicted from
 272          * OST) before taking ost attributes.
 273          */
 274         MOF_SOM_RECOV   = (1 << 1),
 275         /** File has been just created. */
 276         MOF_SOM_CREATED = (1 << 2),
 277         /** lov object has been created. */
 278         MOF_LOV_CREATED = (1 << 3),
 279 };
 280
 281 struct mdt_lock_handle {
 282         /* Lock type, reg for cross-ref use or pdo lock. */
 283         mdl_type_t              mlh_type;
 284
 285         /* Regular lock */
 286         struct lustre_handle    mlh_reg_lh;
 287         ldlm_mode_t             mlh_reg_mode;
 288
 289         /* Pdirops lock */
 290         struct lustre_handle    mlh_pdo_lh;
 291         ldlm_mode_t             mlh_pdo_mode;
 292         unsigned int            mlh_pdo_hash;
 293
 294         /* Remote regular lock */
 295         struct lustre_handle    mlh_rreg_lh;
 296         ldlm_mode_t          mlh_rreg_mode;
 297 };
 298
 299 enum {
 300         MDT_LH_PARENT,  /* parent lockh */
 301         MDT_LH_CHILD,   /* child lockh */
 302         MDT_LH_OLD,     /* old lockh for rename */
 303         MDT_LH_LAYOUT = MDT_LH_OLD, /* layout lock */
 304         MDT_LH_NEW,     /* new lockh for rename */
 305         MDT_LH_RMT,     /* used for return lh to caller */
 306         MDT_LH_LOCAL,   /* local lock never return to client */
 307         MDT_LH_NR
 308 };
 309
 310 enum {
 311         MDT_LOCAL_LOCK,
 312         MDT_CROSS_LOCK
 313 };
 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         const 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
 388         /* opdata for mdt_reint_open(), has the same as
 389          * ldlm_reply:lock_policy_res1.  mdt_update_last_rcvd() stores this
 390          * value onto disk for recovery when mdt_trans_stop_cb() is called.
 391          */
 392         __u64                      mti_opdata;
 393
 394         /*
 395          * XXX: Part Three:
 396          * The following members will be filled explicitly
 397          * with zero in mdt_reint_unpack(), because they are only used
 398          * by reint requests (including mdt_reint_open()).
 399          */
 400
 401         /*
 402          * reint record. contains information for reint operations.
 403          */
 404         struct mdt_reint_record    mti_rr;
 405
 406         __u64                      mti_ver[PTLRPC_NUM_VERSIONS];
 407         /*
 408          * Operation specification (currently create and lookup)
 409          */
 410         struct md_op_spec          mti_spec;
 411
 412         /*
 413          * XXX: Part Four:
 414          * The following members will _NOT_ be initialized at all.
 415          * DO NOT expect them to contain any valid value.
 416          * They should be initialized explicitly by the user themselves.
 417          */
 418
 419          /* XXX: If something is in a union, make sure they do not conflict */
 420
 421         struct lu_fid              mti_tmp_fid1;
 422         struct lu_fid              mti_tmp_fid2;
 423         ldlm_policy_data_t         mti_policy;    /* for mdt_object_lock() and
 424                                                    * mdt_rename_lock() */
 425         struct ldlm_res_id         mti_res_id;    /* for mdt_object_lock() and
 426                                                      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                         struct md_som_data data;
 441                 } som;
 442         } mti_u;
 443
 444         /* IO epoch related stuff. */
 445         struct mdt_ioepoch        *mti_ioepoch;
 446         __u64                      mti_replayepoch;
 447
 448         loff_t                     mti_off;
 449         struct lu_buf              mti_buf;
 450         struct lu_buf              mti_big_buf;
 451         struct lustre_capa_key     mti_capa_key;
 452
 453         /* Ops object filename */
 454         struct lu_name             mti_name;
 455         /* per-thread values, can be re-used */
 456         void                      *mti_big_lmm;
 457         int                        mti_big_lmmsize;
 458         /* big_lmm buffer was used and must be used in reply */
 459         int                        mti_big_lmm_used;
 460         /* should be enough to fit lustre_mdt_attrs */
 461         char                       mti_xattr_buf[128];
 462         struct ldlm_enqueue_info   mti_einfo;
 463 };
 464
 465 extern struct lu_context_key mdt_thread_key;
 466
 467 static inline struct mdt_thread_info *mdt_th_info(const struct lu_env *env)
 468 {
 469         struct mdt_thread_info *mti;
 470
 471         lu_env_refill((void *)env);
 472         mti = lu_context_key_get(&env->le_ctx, &mdt_thread_key);
 473         LASSERT(mti);
 474         return mti;
 475 }
 476
 477 struct cdt_req_progress {
 478         struct mutex             crp_lock;      /**< protect tree */
 479         struct interval_node    *crp_root;      /**< tree to track extent
 480                                                  *   moved */
 481         struct interval_node    **crp_node;     /**< buffer for tree nodes
 482                                                  *   vector of fixed size
 483                                                  *   vectors */
 484         int                      crp_cnt;       /**< # of used nodes */
 485         int                      crp_max;       /**< # of allocated nodes */
 486 };
 487
 488 struct cdt_agent_req {
 489         cfs_list_t               car_request_list; /**< to chain all the req. */
 490         atomic_t                 car_refcount;     /**< reference counter */
 491         __u64                    car_compound_id;  /**< compound id */
 492         __u64                    car_flags;        /**< request original flags */
 493         struct obd_uuid          car_uuid;         /**< agent doing the req. */
 494         __u32                    car_archive_id;   /**< archive id */
 495         int                      car_canceled;     /**< request was canceled */
 496         cfs_time_t               car_req_start;    /**< start time */
 497         cfs_time_t               car_req_update;   /**< last update time */
 498         struct hsm_action_item  *car_hai;          /**< req. to the agent */
 499         struct cdt_req_progress  car_progress;     /**< track data mvt
 500                                                     *   progress */
 501 };
 502 extern struct kmem_cache *mdt_hsm_car_kmem;
 503
 504 struct hsm_agent {
 505         cfs_list_t       ha_list;               /**< to chain the agents */
 506         struct obd_uuid  ha_uuid;               /**< agent uuid */
 507         __u32           *ha_archive_id;         /**< archive id */
 508         int              ha_archive_cnt;        /**< number of archive entries
 509                                                  *   0 means any archive */
 510         atomic_t         ha_requests;           /**< current request count */
 511         atomic_t         ha_success;            /**< number of successful
 512                                                  * actions */
 513         atomic_t         ha_failure;            /**< number of failed actions */
 514 };
 515
 516 struct cdt_restore_handle {
 517         cfs_list_t               crh_list;      /**< to chain the handle */
 518         struct lu_fid            crh_fid;       /**< fid of the object */
 519         struct ldlm_extent       crh_extent;    /**< extent of the restore */
 520         struct mdt_lock_handle   crh_lh;        /**< lock handle */
 521 };
 522 extern struct kmem_cache *mdt_hsm_cdt_kmem;     /** restore handle slab cache */
 523
 524 static inline const struct md_device_operations *
 525 mdt_child_ops(struct mdt_device * m)
 526 {
 527         LASSERT(m->mdt_child);
 528         return m->mdt_child->md_ops;
 529 }
 530
 531 static inline struct md_object *mdt_object_child(struct mdt_object *o)
 532 {
 533         LASSERT(o);
 534         return lu2md(lu_object_next(&o->mot_obj));
 535 }
 536
 537 static inline struct ptlrpc_request *mdt_info_req(struct mdt_thread_info *info)
 538 {
 539          return info->mti_pill ? info->mti_pill->rc_req : NULL;
 540 }
 541
 542 static inline __u64 mdt_conn_flags(struct mdt_thread_info *info)
 543 {
 544         LASSERT(info->mti_exp);
 545         return exp_connect_flags(info->mti_exp);
 546 }
 547
 548 static inline void mdt_object_get(const struct lu_env *env,
 549                                   struct mdt_object *o)
 550 {
 551         ENTRY;
 552         lu_object_get(&o->mot_obj);
 553         EXIT;
 554 }
 555
 556 static inline void mdt_object_put(const struct lu_env *env,
 557                                   struct mdt_object *o)
 558 {
 559         ENTRY;
 560         lu_object_put(env, &o->mot_obj);
 561         EXIT;
 562 }
 563
 564 static inline int mdt_object_exists(const struct mdt_object *o)
 565 {
 566         return lu_object_exists(&o->mot_obj);
 567 }
 568
 569 static inline int mdt_object_remote(const struct mdt_object *o)
 570 {
 571         return lu_object_remote(&o->mot_obj);
 572 }
 573
 574 static inline const struct lu_fid *mdt_object_fid(const struct mdt_object *o)
 575 {
 576         return lu_object_fid(&o->mot_obj);
 577 }
 578
 579 static inline struct lu_site *mdt_lu_site(const struct mdt_device *mdt)
 580 {
 581         return mdt->mdt_lu_dev.ld_site;
 582 }
 583
 584 static inline struct seq_server_site *mdt_seq_site(struct mdt_device *mdt)
 585 {
 586         return &mdt->mdt_seq_site;
 587 }
 588
 589 static inline void mdt_export_evict(struct obd_export *exp)
 590 {
 591         class_fail_export(exp);
 592         class_export_put(exp);
 593 }
 594
 595 /* Here we use LVB_TYPE to check dne client, because it is
 596  * also landed on 2.4. */
 597 static inline int mdt_is_dne_client(struct obd_export *exp)
 598 {
 599         return !!(exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE);
 600 }
 601
 602 int mdt_get_disposition(struct ldlm_reply *rep, int flag);
 603 void mdt_set_disposition(struct mdt_thread_info *info,
 604                         struct ldlm_reply *rep, int flag);
 605 void mdt_clear_disposition(struct mdt_thread_info *info,
 606                         struct ldlm_reply *rep, int flag);
 607
 608 void mdt_lock_pdo_init(struct mdt_lock_handle *lh,
 609                        ldlm_mode_t lock_mode,
 610                        const struct lu_name *lname);
 611
 612 void mdt_lock_reg_init(struct mdt_lock_handle *lh,
 613                        ldlm_mode_t lm);
 614
 615 int mdt_lock_setup(struct mdt_thread_info *info,
 616                    struct mdt_object *o,
 617                    struct mdt_lock_handle *lh);
 618
 619 int mdt_object_lock(struct mdt_thread_info *,
 620                     struct mdt_object *,
 621                     struct mdt_lock_handle *,
 622                     __u64, int);
 623
 624 int mdt_object_lock_try(struct mdt_thread_info *,
 625                         struct mdt_object *,
 626                         struct mdt_lock_handle *,
 627                         __u64, int);
 628
 629 void mdt_object_unlock(struct mdt_thread_info *,
 630                        struct mdt_object *,
 631                        struct mdt_lock_handle *,
 632                        int decref);
 633
 634 struct mdt_object *mdt_object_new(const struct lu_env *,
 635                                   struct mdt_device *,
 636                                   const struct lu_fid *);
 637 struct mdt_object *mdt_object_find(const struct lu_env *,
 638                                    struct mdt_device *,
 639                                    const struct lu_fid *);
 640 struct mdt_object *mdt_object_find_lock(struct mdt_thread_info *,
 641                                         const struct lu_fid *,
 642                                         struct mdt_lock_handle *,
 643                                         __u64);
 644 void mdt_object_unlock_put(struct mdt_thread_info *,
 645                            struct mdt_object *,
 646                            struct mdt_lock_handle *,
 647                            int decref);
 648
 649 void mdt_client_compatibility(struct mdt_thread_info *info);
 650
 651 int mdt_remote_object_lock(struct mdt_thread_info *mti,
 652                            struct mdt_object *o, const struct lu_fid *fid,
 653                            struct lustre_handle *lh,
 654                            ldlm_mode_t mode, __u64 ibits);
 655
 656 enum mdt_name_flags {
 657         MNF_FIX_ANON = 1,
 658 };
 659
 660 int mdt_name_unpack(struct req_capsule *pill,
 661                     const struct req_msg_field *field,
 662                     struct lu_name *ln,
 663                     enum mdt_name_flags flags);
 664 int mdt_close_unpack(struct mdt_thread_info *info);
 665 int mdt_reint_unpack(struct mdt_thread_info *info, __u32 op);
 666 int mdt_reint_rec(struct mdt_thread_info *, struct mdt_lock_handle *);
 667 void mdt_pack_attr2body(struct mdt_thread_info *info, struct mdt_body *b,
 668                         const struct lu_attr *attr, const struct lu_fid *fid);
 669
 670 int mdt_getxattr(struct mdt_thread_info *info);
 671 int mdt_reint_setxattr(struct mdt_thread_info *info,
 672                        struct mdt_lock_handle *lh);
 673
 674 void mdt_lock_handle_init(struct mdt_lock_handle *lh);
 675 void mdt_lock_handle_fini(struct mdt_lock_handle *lh);
 676
 677 void mdt_reconstruct(struct mdt_thread_info *, struct mdt_lock_handle *);
 678 void mdt_reconstruct_generic(struct mdt_thread_info *mti,
 679                              struct mdt_lock_handle *lhc);
 680
 681 extern void target_recovery_fini(struct obd_device *obd);
 682 extern void target_recovery_init(struct lu_target *lut,
 683                                  svc_handler_t handler);
 684 int mdt_fs_setup(const struct lu_env *, struct mdt_device *,
 685                  struct obd_device *, struct lustre_sb_info *lsi);
 686 void mdt_fs_cleanup(const struct lu_env *, struct mdt_device *);
 687
 688 int mdt_export_stats_init(struct obd_device *obd,
 689                           struct obd_export *exp,
 690                           void *client_nid);
 691
 692 int mdt_lock_new_child(struct mdt_thread_info *info,
 693                        struct mdt_object *o,
 694                        struct mdt_lock_handle *child_lockh);
 695
 696 void mdt_mfd_set_mode(struct mdt_file_data *mfd,
 697                       __u64 mode);
 698
 699 int mdt_reint_open(struct mdt_thread_info *info,
 700                    struct mdt_lock_handle *lhc);
 701
 702 struct mdt_file_data *mdt_handle2mfd(struct mdt_export_data *med,
 703                                      const struct lustre_handle *handle,
 704                                      bool is_replay);
 705
 706 enum {
 707         MDT_IOEPOCH_CLOSED  = 0,
 708         MDT_IOEPOCH_OPENED  = 1,
 709         MDT_IOEPOCH_GETATTR = 2,
 710 };
 711
 712 enum {
 713         MDT_SOM_DISABLE = 0,
 714         MDT_SOM_ENABLE  = 1,
 715 };
 716
 717 int mdt_get_info(struct tgt_session_info *tsi);
 718 int mdt_attr_get_complex(struct mdt_thread_info *info,
 719                          struct mdt_object *o, struct md_attr *ma);
 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_ioepoch_open(struct mdt_thread_info *info, struct mdt_object *o,
 723                      int created);
 724 int mdt_object_is_som_enabled(struct mdt_object *mo);
 725 int mdt_write_get(struct mdt_object *o);
 726 void mdt_write_put(struct mdt_object *o);
 727 int mdt_write_read(struct mdt_object *o);
 728 struct mdt_file_data *mdt_mfd_new(const struct mdt_export_data *med);
 729 int mdt_mfd_close(struct mdt_thread_info *info, struct mdt_file_data *mfd);
 730 void mdt_mfd_free(struct mdt_file_data *mfd);
 731 int mdt_close(struct tgt_session_info *tsi);
 732 int mdt_attr_set(struct mdt_thread_info *info, struct mdt_object *mo,
 733                  struct md_attr *ma, int flags);
 734 int mdt_add_dirty_flag(struct mdt_thread_info *info, struct mdt_object *mo,
 735                         struct md_attr *ma);
 736 int mdt_done_writing(struct tgt_session_info *tsi);
 737 int mdt_fix_reply(struct mdt_thread_info *info);
 738 int mdt_handle_last_unlink(struct mdt_thread_info *, struct mdt_object *,
 739                            const struct md_attr *);
 740 void mdt_reconstruct_open(struct mdt_thread_info *, struct mdt_lock_handle *);
 741
 742 struct lu_buf *mdt_buf(const struct lu_env *env, void *area, ssize_t len);
 743 const struct lu_buf *mdt_buf_const(const struct lu_env *env,
 744                                    const void *area, ssize_t len);
 745
 746 void mdt_dump_lmm(int level, const struct lov_mds_md *lmm, __u64 valid);
 747 void mdt_dump_lmv(unsigned int level, const union lmv_mds_md *lmv);
 748
 749 int mdt_check_ucred(struct mdt_thread_info *);
 750 int mdt_init_ucred(struct mdt_thread_info *, struct mdt_body *);
 751 int mdt_init_ucred_reint(struct mdt_thread_info *);
 752 void mdt_exit_ucred(struct mdt_thread_info *);
 753 int mdt_version_get_check(struct mdt_thread_info *, struct mdt_object *, int);
 754 void mdt_version_get_save(struct mdt_thread_info *, struct mdt_object *, int);
 755 int mdt_version_get_check_save(struct mdt_thread_info *, struct mdt_object *,
 756                                int);
 757 void mdt_thread_info_init(struct ptlrpc_request *req,
 758                           struct mdt_thread_info *mti);
 759 void mdt_thread_info_fini(struct mdt_thread_info *mti);
 760 struct mdt_thread_info *tsi2mdt_info(struct tgt_session_info *tsi);
 761
 762 extern struct lprocfs_vars lprocfs_mds_module_vars[];
 763 extern struct lprocfs_vars lprocfs_mds_obd_vars[];
 764
 765 int mdt_hsm_attr_set(struct mdt_thread_info *info, struct mdt_object *obj,
 766                      const struct md_hsm *mh);
 767
 768 int mdt_remote_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
 769                             void *data, int flag);
 770 int mdt_links_read(struct mdt_thread_info *info,
 771                    struct mdt_object *mdt_obj,
 772                    struct linkea_data *ldata);
 773 /* mdt_idmap.c */
 774 int mdt_init_idmap(struct tgt_session_info *tsi);
 775 void mdt_cleanup_idmap(struct mdt_export_data *);
 776 int mdt_handle_idmap(struct tgt_session_info *tsi);
 777 int ptlrpc_user_desc_do_idmap(struct ptlrpc_request *,
 778                               struct ptlrpc_user_desc *);
 779 void mdt_body_reverse_idmap(struct mdt_thread_info *,
 780                             struct mdt_body *);
 781 int mdt_remote_perm_reverse_idmap(struct ptlrpc_request *,
 782                                   struct mdt_remote_perm *);
 783 int mdt_fix_attr_ucred(struct mdt_thread_info *, __u32);
 784
 785 static inline struct mdt_device *mdt_dev(struct lu_device *d)
 786 {
 787         return container_of0(d, struct mdt_device, mdt_lu_dev);
 788 }
 789
 790 static inline struct mdt_object *mdt_obj(struct lu_object *o)
 791 {
 792         return container_of0(o, struct mdt_object, mot_obj);
 793 }
 794
 795 static inline struct dt_object *mdt_obj2dt(struct mdt_object *mo)
 796 {
 797         struct lu_object        *lo;
 798         struct mdt_device       *mdt = mdt_dev(mo->mot_obj.lo_dev);
 799
 800         lo = lu_object_locate(mo->mot_obj.lo_header,
 801                               mdt->mdt_bottom->dd_lu_dev.ld_type);
 802
 803         return lu2dt(lo);
 804 }
 805
 806 /* mdt/mdt_identity.c */
 807 #define MDT_IDENTITY_UPCALL_PATH        "/usr/sbin/l_getidentity"
 808
 809 extern struct upcall_cache_ops mdt_identity_upcall_cache_ops;
 810
 811 struct md_identity *mdt_identity_get(struct upcall_cache *, __u32);
 812
 813 void mdt_identity_put(struct upcall_cache *, struct md_identity *);
 814
 815 void mdt_flush_identity(struct upcall_cache *, int);
 816
 817 __u32 mdt_identity_get_perm(struct md_identity *, __u32, lnet_nid_t);
 818
 819 int mdt_pack_remote_perm(struct mdt_thread_info *, struct mdt_object *, void *);
 820
 821 /* mdt/mdt_hsm.c */
 822 int mdt_hsm_state_get(struct tgt_session_info *tsi);
 823 int mdt_hsm_state_set(struct tgt_session_info *tsi);
 824 int mdt_hsm_action(struct tgt_session_info *tsi);
 825 int mdt_hsm_progress(struct tgt_session_info *tsi);
 826 int mdt_hsm_ct_register(struct tgt_session_info *tsi);
 827 int mdt_hsm_ct_unregister(struct tgt_session_info *tsi);
 828 int mdt_hsm_request(struct tgt_session_info *tsi);
 829
 830 /* mdt/mdt_hsm_cdt_actions.c */
 831 extern const struct file_operations mdt_hsm_actions_fops;
 832 void dump_llog_agent_req_rec(const char *prefix,
 833                              const struct llog_agent_req_rec *larr);
 834 int cdt_llog_process(const struct lu_env *env, struct mdt_device *mdt,
 835                      llog_cb_t cb, void *data);
 836 int mdt_agent_record_add(const struct lu_env *env, struct mdt_device *mdt,
 837                          __u64 compound_id, __u32 archive_id,
 838                          __u64 flags, struct hsm_action_item *hai);
 839 int mdt_agent_record_update(const struct lu_env *env,
 840                             struct mdt_device *mdt, __u64 *cookies,
 841                             int cookies_count, enum agent_req_status status);
 842 int mdt_agent_llog_update_rec(const struct lu_env *env, struct mdt_device *mdt,
 843                               struct llog_handle *llh,
 844                               struct llog_agent_req_rec *larr);
 845
 846 /* mdt/mdt_hsm_cdt_agent.c */
 847 extern const struct file_operations mdt_hsm_agent_fops;
 848 int mdt_hsm_agent_register(struct mdt_thread_info *info,
 849                            const struct obd_uuid *uuid,
 850                            int nr_archives, __u32 *archive_num);
 851 int mdt_hsm_agent_register_mask(struct mdt_thread_info *info,
 852                                 const struct obd_uuid *uuid,
 853                                 __u32 archive_mask);
 854 int mdt_hsm_agent_unregister(struct mdt_thread_info *info,
 855                              const struct obd_uuid *uuid);
 856 int mdt_hsm_agent_update_statistics(struct coordinator *cdt,
 857                                     int succ_rq, int fail_rq, int new_rq,
 858                                     const struct obd_uuid *uuid);
 859 int mdt_hsm_find_best_agent(struct coordinator *cdt, __u32 archive,
 860                             struct obd_uuid *uuid);
 861 int mdt_hsm_agent_send(struct mdt_thread_info *mti, struct hsm_action_list *hal,
 862                        bool purge);
 863 int mdt_hsm_coordinator_update(struct mdt_thread_info *mti,
 864                                struct hsm_progress_kernel *pgs);
 865 /* mdt/mdt_hsm_cdt_client.c */
 866 int mdt_hsm_add_actions(struct mdt_thread_info *info,
 867                         struct hsm_action_list *hal, __u64 *compound_id);
 868 int mdt_hsm_get_actions(struct mdt_thread_info *mti,
 869                         struct hsm_action_list *hal);
 870 int mdt_hsm_get_running(struct mdt_thread_info *mti,
 871                         struct hsm_action_list *hal);
 872 bool mdt_hsm_restore_is_running(struct mdt_thread_info *mti,
 873                                 const struct lu_fid *fid);
 874 /* mdt/mdt_hsm_cdt_requests.c */
 875 extern const struct file_operations mdt_hsm_active_requests_fops;
 876 void dump_requests(char *prefix, struct coordinator *cdt);
 877 struct cdt_agent_req *mdt_cdt_alloc_request(__u64 compound_id, __u32 archive_id,
 878                                             __u64 flags, struct obd_uuid *uuid,
 879                                             struct hsm_action_item *hai);
 880 void mdt_cdt_free_request(struct cdt_agent_req *car);
 881 int mdt_cdt_add_request(struct coordinator *cdt, struct cdt_agent_req *new_car);
 882 struct cdt_agent_req *mdt_cdt_find_request(struct coordinator *cdt,
 883                                            const __u64 cookie,
 884                                            const struct lu_fid *fid);
 885 void mdt_cdt_get_work_done(struct cdt_agent_req *car, __u64 *done_sz);
 886 void mdt_cdt_get_request(struct cdt_agent_req *car);
 887 void mdt_cdt_put_request(struct cdt_agent_req *car);
 888 struct cdt_agent_req *mdt_cdt_update_request(struct coordinator *cdt,
 889                                          const struct hsm_progress_kernel *pgs);
 890 int mdt_cdt_remove_request(struct coordinator *cdt, __u64 cookie);
 891 /* mdt/mdt_coordinator.c */
 892 void mdt_hsm_dump_hal(int level, const char *prefix,
 893                       struct hsm_action_list *hal);
 894 /* coordinator management */
 895 int mdt_hsm_cdt_init(struct mdt_device *mdt);
 896 int mdt_hsm_cdt_start(struct mdt_device *mdt);
 897 int mdt_hsm_cdt_stop(struct mdt_device *mdt);
 898 int mdt_hsm_cdt_fini(struct mdt_device *mdt);
 899 int mdt_hsm_cdt_wakeup(struct mdt_device *mdt);
 900
 901 /* coordinator control /proc interface */
 902 int lprocfs_wr_hsm_cdt_control(struct file *file, const char *buffer,
 903                                unsigned long count, void *data);
 904 int lprocfs_rd_hsm_cdt_control(char *page, char **start, off_t off,
 905                                int count, int *eof, void *data);
 906 int hsm_cdt_procfs_init(struct mdt_device *mdt);
 907 void hsm_cdt_procfs_fini(struct mdt_device *mdt);
 908 struct lprocfs_vars *hsm_cdt_get_proc_vars(void);
 909 /* md_hsm helpers */
 910 struct mdt_object *mdt_hsm_get_md_hsm(struct mdt_thread_info *mti,
 911                                       const struct lu_fid *fid,
 912                                       struct md_hsm *hsm);
 913 /* actions/request helpers */
 914 int mdt_hsm_add_hal(struct mdt_thread_info *mti,
 915                     struct hsm_action_list *hal, struct obd_uuid *uuid);
 916 bool mdt_hsm_is_action_compat(const struct hsm_action_item *hai,
 917                               const int hal_an, const __u64 rq_flags,
 918                               const struct md_hsm *hsm);
 919 int mdt_hsm_update_request_state(struct mdt_thread_info *mti,
 920                                  struct hsm_progress_kernel *pgs,
 921                                  const int update_record);
 922
 923 extern struct lu_context_key       mdt_thread_key;
 924
 925 /* debug issues helper starts here*/
 926 static inline int mdt_fail_write(const struct lu_env *env,
 927                                  struct dt_device *dd, int id)
 928 {
 929         if (OBD_FAIL_CHECK_ORSET(id, OBD_FAIL_ONCE)) {
 930                 CERROR(LUSTRE_MDT_NAME": cfs_fail_loc=%x, fail write ops\n",
 931                        id);
 932                 return dd->dd_ops->dt_ro(env, dd);
 933                 /* We set FAIL_ONCE because we never "un-fail" a device */
 934         }
 935
 936         return 0;
 937 }
 938
 939 static inline struct mdt_export_data *mdt_req2med(struct ptlrpc_request *req)
 940 {
 941         return &req->rq_export->exp_mdt_data;
 942 }
 943
 944 static inline struct mdt_device *mdt_exp2dev(struct obd_export *exp)
 945 {
 946         return mdt_dev(exp->exp_obd->obd_lu_dev);
 947 }
 948
 949 typedef void (*mdt_reconstruct_t)(struct mdt_thread_info *mti,
 950                                   struct mdt_lock_handle *lhc);
 951 static inline int mdt_check_resent(struct mdt_thread_info *info,
 952                                    mdt_reconstruct_t reconstruct,
 953                                    struct mdt_lock_handle *lhc)
 954 {
 955         struct ptlrpc_request *req = mdt_info_req(info);
 956         ENTRY;
 957
 958         if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) {
 959                 if (req_xid_is_last(req)) {
 960                         reconstruct(info, lhc);
 961                         RETURN(1);
 962                 }
 963                 DEBUG_REQ(D_HA, req, "no reply for RESENT req (have "LPD64")",
 964                           req->rq_export->exp_target_data.ted_lcd->lcd_last_xid);
 965         }
 966         RETURN(0);
 967 }
 968
 969 struct lu_ucred *mdt_ucred(const struct mdt_thread_info *info);
 970 struct lu_ucred *mdt_ucred_check(const struct mdt_thread_info *info);
 971
 972 static inline int is_identity_get_disabled(struct upcall_cache *cache)
 973 {
 974         return cache ? (strcmp(cache->uc_upcall, "NONE") == 0) : 1;
 975 }
 976
 977 int mdt_blocking_ast(struct ldlm_lock*, struct ldlm_lock_desc*, void*, int);
 978
 979 /* Issues dlm lock on passed @ns, @f stores it lock handle into @lh. */
 980 static inline int mdt_fid_lock(struct ldlm_namespace *ns,
 981                                struct lustre_handle *lh,
 982                                ldlm_mode_t mode,
 983                                ldlm_policy_data_t *policy,
 984                                const struct ldlm_res_id *res_id,
 985                                __u64 flags, const __u64 *client_cookie)
 986 {
 987         int rc;
 988
 989         LASSERT(ns != NULL);
 990         LASSERT(lh != NULL);
 991
 992         rc = ldlm_cli_enqueue_local(ns, res_id, LDLM_IBITS, policy,
 993                                     mode, &flags, mdt_blocking_ast,
 994                                     ldlm_completion_ast, NULL, NULL, 0,
 995                                     LVB_T_NONE, client_cookie, lh);
 996         return rc == ELDLM_OK ? 0 : -EIO;
 997 }
 998
 999 static inline void mdt_fid_unlock(struct lustre_handle *lh,
1000                                   ldlm_mode_t mode)
1001 {
1002         ldlm_lock_decref(lh, mode);
1003 }
1004
1005 extern mdl_mode_t mdt_mdl_lock_modes[];
1006 extern ldlm_mode_t mdt_dlm_lock_modes[];
1007
1008 static inline mdl_mode_t mdt_dlm_mode2mdl_mode(ldlm_mode_t mode)
1009 {
1010         LASSERT(IS_PO2(mode));
1011         return mdt_mdl_lock_modes[mode];
1012 }
1013
1014 static inline ldlm_mode_t mdt_mdl_mode2dlm_mode(mdl_mode_t mode)
1015 {
1016         LASSERT(IS_PO2(mode));
1017         return mdt_dlm_lock_modes[mode];
1018 }
1019
1020 /* mdt_lvb.c */
1021 extern struct ldlm_valblock_ops mdt_lvbo;
1022
1023 void mdt_enable_cos(struct mdt_device *, int);
1024 int mdt_cos_is_enabled(struct mdt_device *);
1025
1026 /* lprocfs stuff */
1027 enum {
1028         LPROC_MDT_OPEN = 0,
1029         LPROC_MDT_CLOSE,
1030         LPROC_MDT_MKNOD,
1031         LPROC_MDT_LINK,
1032         LPROC_MDT_UNLINK,
1033         LPROC_MDT_MKDIR,
1034         LPROC_MDT_RMDIR,
1035         LPROC_MDT_RENAME,
1036         LPROC_MDT_GETATTR,
1037         LPROC_MDT_SETATTR,
1038         LPROC_MDT_GETXATTR,
1039         LPROC_MDT_SETXATTR,
1040         LPROC_MDT_STATFS,
1041         LPROC_MDT_SYNC,
1042         LPROC_MDT_SAMEDIR_RENAME,
1043         LPROC_MDT_CROSSDIR_RENAME,
1044         LPROC_MDT_LAST,
1045 };
1046 void mdt_counter_incr(struct ptlrpc_request *req, int opcode);
1047 void mdt_stats_counter_init(struct lprocfs_stats *stats);
1048 void lprocfs_mdt_init_vars(struct lprocfs_static_vars *lvars);
1049 void lprocfs_mds_init_vars(struct lprocfs_static_vars *lvars);
1050 int mdt_procfs_init(struct mdt_device *mdt, const char *name);
1051 void mdt_procfs_fini(struct mdt_device *mdt);
1052
1053 /* lustre/mdt_mdt_lproc.c */
1054 int lprocfs_mdt_open_files_seq_open(struct inode *inode,
1055                                     struct file *file);
1056 void mdt_rename_counter_tally(struct mdt_thread_info *info,
1057                               struct mdt_device *mdt,
1058                               struct ptlrpc_request *req,
1059                               struct mdt_object *src, struct mdt_object *tgt);
1060
1061 /* Capability */
1062 int mdt_ck_thread_start(struct mdt_device *mdt);
1063 void mdt_ck_thread_stop(struct mdt_device *mdt);
1064 void mdt_ck_timer_callback(unsigned long castmeharder);
1065 int mdt_capa_keys_init(const struct lu_env *env, struct mdt_device *mdt);
1066 void mdt_set_capainfo(struct mdt_thread_info *info, int offset,
1067                       const struct lu_fid *fid, struct lustre_capa *capa);
1068 void mdt_dump_capainfo(struct mdt_thread_info *info);
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 #endif /* __KERNEL__ */
1086 #endif /* _MDT_H */