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         struct root_squash_info    mdt_squash;
 223
 224         struct rename_stats        mdt_rename_stats;
 225         struct lu_fid              mdt_md_root_fid;
 226
 227         /* connection to quota master */
 228         struct obd_export         *mdt_qmt_exp;
 229         /* quota master device associated with this MDT */
 230         struct lu_device          *mdt_qmt_dev;
 231
 232         struct coordinator         mdt_coordinator;
 233 };
 234
 235 #define MDT_SERVICE_WATCHDOG_FACTOR     (2)
 236 #define MDT_COS_DEFAULT         (0)
 237
 238 struct mdt_object {
 239         struct lu_object_header mot_header;
 240         struct lu_object        mot_obj;
 241         __u64                   mot_ioepoch;
 242         __u64                   mot_flags;
 243         int                     mot_ioepoch_count;
 244         int                     mot_writecount;
 245         /* Lock to protect object's IO epoch. */
 246         struct mutex            mot_ioepoch_mutex;
 247         /* Lock to protect create_data */
 248         struct mutex            mot_lov_mutex;
 249         /* Lock to protect lease open.
 250          * Lease open acquires write lock; normal open acquires read lock */
 251         struct rw_semaphore     mot_open_sem;
 252         atomic_t                mot_lease_count;
 253         atomic_t                mot_open_count;
 254 };
 255
 256 enum mdt_object_flags {
 257         /** SOM attributes are changed. */
 258         MOF_SOM_CHANGE  = (1 << 0),
 259         /**
 260          * The SOM recovery state for mdt object.
 261          * This state is an in-memory equivalent of an absent SOM EA, used
 262          * instead of invalidating SOM EA while IOEpoch is still opened when
 263          * a client eviction occurs or a client fails to obtain SOM attributes.
 264          * It indicates that the last IOEpoch holder will need to obtain SOM
 265          * attributes under [0;EOF] extent lock to flush all the client's
 266          * cached of evicted from MDS clients (but not necessary evicted from
 267          * OST) before taking ost attributes.
 268          */
 269         MOF_SOM_RECOV   = (1 << 1),
 270         /** File has been just created. */
 271         MOF_SOM_CREATED = (1 << 2),
 272         /** lov object has been created. */
 273         MOF_LOV_CREATED = (1 << 3),
 274 };
 275
 276 struct mdt_lock_handle {
 277         /* Lock type, reg for cross-ref use or pdo lock. */
 278         mdl_type_t              mlh_type;
 279
 280         /* Regular lock */
 281         struct lustre_handle    mlh_reg_lh;
 282         ldlm_mode_t             mlh_reg_mode;
 283
 284         /* Pdirops lock */
 285         struct lustre_handle    mlh_pdo_lh;
 286         ldlm_mode_t             mlh_pdo_mode;
 287         unsigned int            mlh_pdo_hash;
 288
 289         /* Remote regular lock */
 290         struct lustre_handle    mlh_rreg_lh;
 291         ldlm_mode_t          mlh_rreg_mode;
 292 };
 293
 294 enum {
 295         MDT_LH_PARENT,  /* parent lockh */
 296         MDT_LH_CHILD,   /* child lockh */
 297         MDT_LH_OLD,     /* old lockh for rename */
 298         MDT_LH_LAYOUT = MDT_LH_OLD, /* layout lock */
 299         MDT_LH_NEW,     /* new lockh for rename */
 300         MDT_LH_RMT,     /* used for return lh to caller */
 301         MDT_LH_LOCAL,   /* local lock never return to client */
 302         MDT_LH_NR
 303 };
 304
 305 enum {
 306         MDT_LOCAL_LOCK,
 307         MDT_CROSS_LOCK
 308 };
 309
 310 struct mdt_reint_record {
 311         mdt_reint_t                      rr_opcode;
 312         const struct lustre_handle      *rr_handle;
 313         const struct lu_fid             *rr_fid1;
 314         const struct lu_fid             *rr_fid2;
 315         struct lu_name                   rr_name;
 316         struct lu_name                   rr_tgt_name;
 317         const void                      *rr_eadata;
 318         int                              rr_eadatalen;
 319         __u32                            rr_flags;
 320 };
 321
 322 enum mdt_reint_flag {
 323         MRF_OPEN_TRUNC = 1 << 0,
 324 };
 325
 326 /*
 327  * Common data shared by mdt-level handlers. This is allocated per-thread to
 328  * reduce stack consumption.
 329  */
 330 struct mdt_thread_info {
 331         /*
 332          * XXX: Part One:
 333          * The following members will be filled explicitly
 334          * with specific data in mdt_thread_info_init().
 335          */
 336         /* TODO: move this into mdt_session_key(with LCT_SESSION), because
 337          * request handling may migrate from one server thread to another.
 338          */
 339         struct req_capsule        *mti_pill;
 340
 341         /* although we have export in req, there are cases when it is not
 342          * available, e.g. closing files upon export destroy */
 343         struct obd_export          *mti_exp;
 344         /*
 345          * A couple of lock handles.
 346          */
 347         struct mdt_lock_handle     mti_lh[MDT_LH_NR];
 348
 349         struct mdt_device         *mti_mdt;
 350         const struct lu_env       *mti_env;
 351
 352         /* transaction number of current request */
 353         __u64                      mti_transno;
 354
 355
 356         /*
 357          * XXX: Part Two:
 358          * The following members will be filled expilictly
 359          * with zero in mdt_thread_info_init(). These members may be used
 360          * by all requests.
 361          */
 362
 363         /*
 364          * Object attributes.
 365          */
 366         struct md_attr             mti_attr;
 367         /*
 368          * Body for "habeo corpus" operations.
 369          */
 370         const struct mdt_body     *mti_body;
 371         /*
 372          * Host object. This is released at the end of mdt_handler().
 373          */
 374         struct mdt_object         *mti_object;
 375         /*
 376          * Lock request for "habeo clavis" operations.
 377          */
 378         const struct ldlm_request *mti_dlm_req;
 379
 380         __u32                      mti_has_trans:1, /* has txn already? */
 381                                    mti_cross_ref:1;
 382
 383         /* opdata for mdt_reint_open(), has the same as
 384          * ldlm_reply:lock_policy_res1.  mdt_update_last_rcvd() stores this
 385          * value onto disk for recovery when mdt_trans_stop_cb() is called.
 386          */
 387         __u64                      mti_opdata;
 388
 389         /*
 390          * XXX: Part Three:
 391          * The following members will be filled explicitly
 392          * with zero in mdt_reint_unpack(), because they are only used
 393          * by reint requests (including mdt_reint_open()).
 394          */
 395
 396         /*
 397          * reint record. contains information for reint operations.
 398          */
 399         struct mdt_reint_record    mti_rr;
 400
 401         __u64                      mti_ver[PTLRPC_NUM_VERSIONS];
 402         /*
 403          * Operation specification (currently create and lookup)
 404          */
 405         struct md_op_spec          mti_spec;
 406
 407         /*
 408          * XXX: Part Four:
 409          * The following members will _NOT_ be initialized at all.
 410          * DO NOT expect them to contain any valid value.
 411          * They should be initialized explicitly by the user themselves.
 412          */
 413
 414          /* XXX: If something is in a union, make sure they do not conflict */
 415
 416         struct lu_fid              mti_tmp_fid1;
 417         struct lu_fid              mti_tmp_fid2;
 418         ldlm_policy_data_t         mti_policy;    /* for mdt_object_lock() and
 419                                                    * mdt_rename_lock() */
 420         struct ldlm_res_id         mti_res_id;    /* for mdt_object_lock() and
 421                                                      mdt_rename_lock()   */
 422         union {
 423                 struct obd_uuid    uuid[2];       /* for mdt_seq_init_cli()  */
 424                 char               ns_name[48];   /* for mdt_init0()         */
 425                 struct lustre_cfg_bufs bufs;      /* for mdt_stack_fini()    */
 426                 struct obd_statfs  osfs;          /* for mdt_statfs()        */
 427                 struct {
 428                         /* for mdt_readpage()      */
 429                         struct lu_rdpg     mti_rdpg;
 430                         /* for mdt_sendpage()      */
 431                         struct l_wait_info mti_wait_info;
 432                 } rdpg;
 433                 struct {
 434                         struct md_attr attr;
 435                         struct md_som_data data;
 436                 } som;
 437         } mti_u;
 438
 439         /* IO epoch related stuff. */
 440         struct mdt_ioepoch        *mti_ioepoch;
 441         __u64                      mti_replayepoch;
 442
 443         loff_t                     mti_off;
 444         struct lu_buf              mti_buf;
 445         struct lu_buf              mti_big_buf;
 446         struct lustre_capa_key     mti_capa_key;
 447
 448         /* Ops object filename */
 449         struct lu_name             mti_name;
 450         /* per-thread values, can be re-used */
 451         void                      *mti_big_lmm;
 452         int                        mti_big_lmmsize;
 453         /* big_lmm buffer was used and must be used in reply */
 454         int                        mti_big_lmm_used;
 455         /* should be enough to fit lustre_mdt_attrs */
 456         char                       mti_xattr_buf[128];
 457         struct ldlm_enqueue_info   mti_einfo;
 458 };
 459
 460 extern struct lu_context_key mdt_thread_key;
 461
 462 static inline struct mdt_thread_info *mdt_th_info(const struct lu_env *env)
 463 {
 464         struct mdt_thread_info *mti;
 465
 466         lu_env_refill((void *)env);
 467         mti = lu_context_key_get(&env->le_ctx, &mdt_thread_key);
 468         LASSERT(mti);
 469         return mti;
 470 }
 471
 472 struct cdt_req_progress {
 473         struct mutex             crp_lock;      /**< protect tree */
 474         struct interval_node    *crp_root;      /**< tree to track extent
 475                                                  *   moved */
 476         struct interval_node    **crp_node;     /**< buffer for tree nodes
 477                                                  *   vector of fixed size
 478                                                  *   vectors */
 479         int                      crp_cnt;       /**< # of used nodes */
 480         int                      crp_max;       /**< # of allocated nodes */
 481 };
 482
 483 struct cdt_agent_req {
 484         cfs_list_t               car_request_list; /**< to chain all the req. */
 485         atomic_t                 car_refcount;     /**< reference counter */
 486         __u64                    car_compound_id;  /**< compound id */
 487         __u64                    car_flags;        /**< request original flags */
 488         struct obd_uuid          car_uuid;         /**< agent doing the req. */
 489         __u32                    car_archive_id;   /**< archive id */
 490         int                      car_canceled;     /**< request was canceled */
 491         cfs_time_t               car_req_start;    /**< start time */
 492         cfs_time_t               car_req_update;   /**< last update time */
 493         struct hsm_action_item  *car_hai;          /**< req. to the agent */
 494         struct cdt_req_progress  car_progress;     /**< track data mvt
 495                                                     *   progress */
 496 };
 497 extern struct kmem_cache *mdt_hsm_car_kmem;
 498
 499 struct hsm_agent {
 500         cfs_list_t       ha_list;               /**< to chain the agents */
 501         struct obd_uuid  ha_uuid;               /**< agent uuid */
 502         __u32           *ha_archive_id;         /**< archive id */
 503         int              ha_archive_cnt;        /**< number of archive entries
 504                                                  *   0 means any archive */
 505         atomic_t         ha_requests;           /**< current request count */
 506         atomic_t         ha_success;            /**< number of successful
 507                                                  * actions */
 508         atomic_t         ha_failure;            /**< number of failed actions */
 509 };
 510
 511 struct cdt_restore_handle {
 512         cfs_list_t               crh_list;      /**< to chain the handle */
 513         struct lu_fid            crh_fid;       /**< fid of the object */
 514         struct ldlm_extent       crh_extent;    /**< extent of the restore */
 515         struct mdt_lock_handle   crh_lh;        /**< lock handle */
 516 };
 517 extern struct kmem_cache *mdt_hsm_cdt_kmem;     /** restore handle slab cache */
 518
 519 static inline const struct md_device_operations *
 520 mdt_child_ops(struct mdt_device * m)
 521 {
 522         LASSERT(m->mdt_child);
 523         return m->mdt_child->md_ops;
 524 }
 525
 526 static inline struct md_object *mdt_object_child(struct mdt_object *o)
 527 {
 528         LASSERT(o);
 529         return lu2md(lu_object_next(&o->mot_obj));
 530 }
 531
 532 static inline struct ptlrpc_request *mdt_info_req(struct mdt_thread_info *info)
 533 {
 534          return info->mti_pill ? info->mti_pill->rc_req : NULL;
 535 }
 536
 537 static inline __u64 mdt_conn_flags(struct mdt_thread_info *info)
 538 {
 539         LASSERT(info->mti_exp);
 540         return exp_connect_flags(info->mti_exp);
 541 }
 542
 543 static inline void mdt_object_get(const struct lu_env *env,
 544                                   struct mdt_object *o)
 545 {
 546         ENTRY;
 547         lu_object_get(&o->mot_obj);
 548         EXIT;
 549 }
 550
 551 static inline void mdt_object_put(const struct lu_env *env,
 552                                   struct mdt_object *o)
 553 {
 554         ENTRY;
 555         lu_object_put(env, &o->mot_obj);
 556         EXIT;
 557 }
 558
 559 static inline int mdt_object_exists(const struct mdt_object *o)
 560 {
 561         return lu_object_exists(&o->mot_obj);
 562 }
 563
 564 static inline int mdt_object_remote(const struct mdt_object *o)
 565 {
 566         return lu_object_remote(&o->mot_obj);
 567 }
 568
 569 static inline const struct lu_fid *mdt_object_fid(const struct mdt_object *o)
 570 {
 571         return lu_object_fid(&o->mot_obj);
 572 }
 573
 574 static inline struct lu_site *mdt_lu_site(const struct mdt_device *mdt)
 575 {
 576         return mdt->mdt_lu_dev.ld_site;
 577 }
 578
 579 static inline struct seq_server_site *mdt_seq_site(struct mdt_device *mdt)
 580 {
 581         return &mdt->mdt_seq_site;
 582 }
 583
 584 static inline void mdt_export_evict(struct obd_export *exp)
 585 {
 586         class_fail_export(exp);
 587         class_export_put(exp);
 588 }
 589
 590 /* Here we use LVB_TYPE to check dne client, because it is
 591  * also landed on 2.4. */
 592 static inline int mdt_is_dne_client(struct obd_export *exp)
 593 {
 594         return !!(exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE);
 595 }
 596
 597 int mdt_get_disposition(struct ldlm_reply *rep, int flag);
 598 void mdt_set_disposition(struct mdt_thread_info *info,
 599                         struct ldlm_reply *rep, int flag);
 600 void mdt_clear_disposition(struct mdt_thread_info *info,
 601                         struct ldlm_reply *rep, int flag);
 602
 603 void mdt_lock_pdo_init(struct mdt_lock_handle *lh,
 604                        ldlm_mode_t lock_mode,
 605                        const struct lu_name *lname);
 606
 607 void mdt_lock_reg_init(struct mdt_lock_handle *lh,
 608                        ldlm_mode_t lm);
 609
 610 int mdt_lock_setup(struct mdt_thread_info *info,
 611                    struct mdt_object *o,
 612                    struct mdt_lock_handle *lh);
 613
 614 int mdt_object_lock(struct mdt_thread_info *,
 615                     struct mdt_object *,
 616                     struct mdt_lock_handle *,
 617                     __u64, int);
 618
 619 int mdt_object_lock_try(struct mdt_thread_info *,
 620                         struct mdt_object *,
 621                         struct mdt_lock_handle *,
 622                         __u64, int);
 623
 624 void mdt_object_unlock(struct mdt_thread_info *,
 625                        struct mdt_object *,
 626                        struct mdt_lock_handle *,
 627                        int decref);
 628
 629 struct mdt_object *mdt_object_new(const struct lu_env *,
 630                                   struct mdt_device *,
 631                                   const struct lu_fid *);
 632 struct mdt_object *mdt_object_find(const struct lu_env *,
 633                                    struct mdt_device *,
 634                                    const struct lu_fid *);
 635 struct mdt_object *mdt_object_find_lock(struct mdt_thread_info *,
 636                                         const struct lu_fid *,
 637                                         struct mdt_lock_handle *,
 638                                         __u64);
 639 void mdt_object_unlock_put(struct mdt_thread_info *,
 640                            struct mdt_object *,
 641                            struct mdt_lock_handle *,
 642                            int decref);
 643
 644 void mdt_client_compatibility(struct mdt_thread_info *info);
 645
 646 int mdt_remote_object_lock(struct mdt_thread_info *mti,
 647                            struct mdt_object *o, const struct lu_fid *fid,
 648                            struct lustre_handle *lh,
 649                            ldlm_mode_t mode, __u64 ibits);
 650
 651 enum mdt_name_flags {
 652         MNF_FIX_ANON = 1,
 653 };
 654
 655 int mdt_name_unpack(struct req_capsule *pill,
 656                     const struct req_msg_field *field,
 657                     struct lu_name *ln,
 658                     enum mdt_name_flags flags);
 659 int mdt_close_unpack(struct mdt_thread_info *info);
 660 int mdt_reint_unpack(struct mdt_thread_info *info, __u32 op);
 661 int mdt_reint_rec(struct mdt_thread_info *, struct mdt_lock_handle *);
 662 void mdt_pack_attr2body(struct mdt_thread_info *info, struct mdt_body *b,
 663                         const struct lu_attr *attr, const struct lu_fid *fid);
 664
 665 int mdt_getxattr(struct mdt_thread_info *info);
 666 int mdt_reint_setxattr(struct mdt_thread_info *info,
 667                        struct mdt_lock_handle *lh);
 668
 669 void mdt_lock_handle_init(struct mdt_lock_handle *lh);
 670 void mdt_lock_handle_fini(struct mdt_lock_handle *lh);
 671
 672 void mdt_reconstruct(struct mdt_thread_info *, struct mdt_lock_handle *);
 673 void mdt_reconstruct_generic(struct mdt_thread_info *mti,
 674                              struct mdt_lock_handle *lhc);
 675
 676 extern void target_recovery_fini(struct obd_device *obd);
 677 extern void target_recovery_init(struct lu_target *lut,
 678                                  svc_handler_t handler);
 679 int mdt_fs_setup(const struct lu_env *, struct mdt_device *,
 680                  struct obd_device *, struct lustre_sb_info *lsi);
 681 void mdt_fs_cleanup(const struct lu_env *, struct mdt_device *);
 682
 683 int mdt_export_stats_init(struct obd_device *obd,
 684                           struct obd_export *exp,
 685                           void *client_nid);
 686
 687 int mdt_lock_new_child(struct mdt_thread_info *info,
 688                        struct mdt_object *o,
 689                        struct mdt_lock_handle *child_lockh);
 690
 691 void mdt_mfd_set_mode(struct mdt_file_data *mfd,
 692                       __u64 mode);
 693
 694 int mdt_reint_open(struct mdt_thread_info *info,
 695                    struct mdt_lock_handle *lhc);
 696
 697 struct mdt_file_data *mdt_handle2mfd(struct mdt_export_data *med,
 698                                      const struct lustre_handle *handle,
 699                                      bool is_replay);
 700
 701 enum {
 702         MDT_IOEPOCH_CLOSED  = 0,
 703         MDT_IOEPOCH_OPENED  = 1,
 704         MDT_IOEPOCH_GETATTR = 2,
 705 };
 706
 707 enum {
 708         MDT_SOM_DISABLE = 0,
 709         MDT_SOM_ENABLE  = 1,
 710 };
 711
 712 int mdt_get_info(struct tgt_session_info *tsi);
 713 int mdt_attr_get_complex(struct mdt_thread_info *info,
 714                          struct mdt_object *o, struct md_attr *ma);
 715 int mdt_big_xattr_get(struct mdt_thread_info *info, struct mdt_object *o,
 716                       const char *name);
 717 int mdt_stripe_get(struct mdt_thread_info *info, struct mdt_object *o,
 718                    struct md_attr *ma, const char *name);
 719 int mdt_ioepoch_open(struct mdt_thread_info *info, struct mdt_object *o,
 720                      int created);
 721 int mdt_object_is_som_enabled(struct mdt_object *mo);
 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_attr_set(struct mdt_thread_info *info, struct mdt_object *mo,
 730                  struct md_attr *ma, int flags);
 731 int mdt_add_dirty_flag(struct mdt_thread_info *info, struct mdt_object *mo,
 732                         struct md_attr *ma);
 733 int mdt_done_writing(struct tgt_session_info *tsi);
 734 int mdt_fix_reply(struct mdt_thread_info *info);
 735 int mdt_handle_last_unlink(struct mdt_thread_info *, struct mdt_object *,
 736                            const struct md_attr *);
 737 void mdt_reconstruct_open(struct mdt_thread_info *, struct mdt_lock_handle *);
 738
 739 struct lu_buf *mdt_buf(const struct lu_env *env, void *area, ssize_t len);
 740 const struct lu_buf *mdt_buf_const(const struct lu_env *env,
 741                                    const void *area, ssize_t len);
 742
 743 void mdt_dump_lmm(int level, const struct lov_mds_md *lmm, __u64 valid);
 744 void mdt_dump_lmv(unsigned int level, const union lmv_mds_md *lmv);
 745
 746 int mdt_check_ucred(struct mdt_thread_info *);
 747 int mdt_init_ucred(struct mdt_thread_info *, struct mdt_body *);
 748 int mdt_init_ucred_reint(struct mdt_thread_info *);
 749 void mdt_exit_ucred(struct mdt_thread_info *);
 750 int mdt_version_get_check(struct mdt_thread_info *, struct mdt_object *, int);
 751 void mdt_version_get_save(struct mdt_thread_info *, struct mdt_object *, int);
 752 int mdt_version_get_check_save(struct mdt_thread_info *, struct mdt_object *,
 753                                int);
 754 void mdt_thread_info_init(struct ptlrpc_request *req,
 755                           struct mdt_thread_info *mti);
 756 void mdt_thread_info_fini(struct mdt_thread_info *mti);
 757 struct mdt_thread_info *tsi2mdt_info(struct tgt_session_info *tsi);
 758
 759 extern struct lprocfs_vars lprocfs_mds_module_vars[];
 760 extern struct lprocfs_vars lprocfs_mds_obd_vars[];
 761
 762 int mdt_hsm_attr_set(struct mdt_thread_info *info, struct mdt_object *obj,
 763                      const struct md_hsm *mh);
 764
 765 int mdt_remote_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
 766                             void *data, int flag);
 767 int mdt_links_read(struct mdt_thread_info *info,
 768                    struct mdt_object *mdt_obj,
 769                    struct linkea_data *ldata);
 770 /* mdt_idmap.c */
 771 int mdt_init_idmap(struct tgt_session_info *tsi);
 772 void mdt_cleanup_idmap(struct mdt_export_data *);
 773 int mdt_handle_idmap(struct tgt_session_info *tsi);
 774 int ptlrpc_user_desc_do_idmap(struct ptlrpc_request *,
 775                               struct ptlrpc_user_desc *);
 776 void mdt_body_reverse_idmap(struct mdt_thread_info *,
 777                             struct mdt_body *);
 778 int mdt_remote_perm_reverse_idmap(struct ptlrpc_request *,
 779                                   struct mdt_remote_perm *);
 780 int mdt_fix_attr_ucred(struct mdt_thread_info *, __u32);
 781
 782 static inline struct mdt_device *mdt_dev(struct lu_device *d)
 783 {
 784         return container_of0(d, struct mdt_device, mdt_lu_dev);
 785 }
 786
 787 static inline struct mdt_object *mdt_obj(struct lu_object *o)
 788 {
 789         return container_of0(o, struct mdt_object, mot_obj);
 790 }
 791
 792 static inline struct dt_object *mdt_obj2dt(struct mdt_object *mo)
 793 {
 794         struct lu_object        *lo;
 795         struct mdt_device       *mdt = mdt_dev(mo->mot_obj.lo_dev);
 796
 797         lo = lu_object_locate(mo->mot_obj.lo_header,
 798                               mdt->mdt_bottom->dd_lu_dev.ld_type);
 799
 800         return lu2dt(lo);
 801 }
 802
 803 /* mdt/mdt_identity.c */
 804 #define MDT_IDENTITY_UPCALL_PATH        "/usr/sbin/l_getidentity"
 805
 806 extern struct upcall_cache_ops mdt_identity_upcall_cache_ops;
 807
 808 struct md_identity *mdt_identity_get(struct upcall_cache *, __u32);
 809
 810 void mdt_identity_put(struct upcall_cache *, struct md_identity *);
 811
 812 void mdt_flush_identity(struct upcall_cache *, int);
 813
 814 __u32 mdt_identity_get_perm(struct md_identity *, __u32, lnet_nid_t);
 815
 816 int mdt_pack_remote_perm(struct mdt_thread_info *, struct mdt_object *, void *);
 817
 818 /* mdt/mdt_hsm.c */
 819 int mdt_hsm_state_get(struct tgt_session_info *tsi);
 820 int mdt_hsm_state_set(struct tgt_session_info *tsi);
 821 int mdt_hsm_action(struct tgt_session_info *tsi);
 822 int mdt_hsm_progress(struct tgt_session_info *tsi);
 823 int mdt_hsm_ct_register(struct tgt_session_info *tsi);
 824 int mdt_hsm_ct_unregister(struct tgt_session_info *tsi);
 825 int mdt_hsm_request(struct tgt_session_info *tsi);
 826
 827 /* mdt/mdt_hsm_cdt_actions.c */
 828 extern const struct file_operations mdt_hsm_actions_fops;
 829 void dump_llog_agent_req_rec(const char *prefix,
 830                              const struct llog_agent_req_rec *larr);
 831 int cdt_llog_process(const struct lu_env *env, struct mdt_device *mdt,
 832                      llog_cb_t cb, void *data);
 833 int mdt_agent_record_add(const struct lu_env *env, struct mdt_device *mdt,
 834                          __u64 compound_id, __u32 archive_id,
 835                          __u64 flags, struct hsm_action_item *hai);
 836 int mdt_agent_record_update(const struct lu_env *env,
 837                             struct mdt_device *mdt, __u64 *cookies,
 838                             int cookies_count, enum agent_req_status status);
 839 int mdt_agent_llog_update_rec(const struct lu_env *env, struct mdt_device *mdt,
 840                               struct llog_handle *llh,
 841                               struct llog_agent_req_rec *larr);
 842
 843 /* mdt/mdt_hsm_cdt_agent.c */
 844 extern const struct file_operations mdt_hsm_agent_fops;
 845 int mdt_hsm_agent_register(struct mdt_thread_info *info,
 846                            const struct obd_uuid *uuid,
 847                            int nr_archives, __u32 *archive_num);
 848 int mdt_hsm_agent_register_mask(struct mdt_thread_info *info,
 849                                 const struct obd_uuid *uuid,
 850                                 __u32 archive_mask);
 851 int mdt_hsm_agent_unregister(struct mdt_thread_info *info,
 852                              const struct obd_uuid *uuid);
 853 int mdt_hsm_agent_update_statistics(struct coordinator *cdt,
 854                                     int succ_rq, int fail_rq, int new_rq,
 855                                     const struct obd_uuid *uuid);
 856 int mdt_hsm_find_best_agent(struct coordinator *cdt, __u32 archive,
 857                             struct obd_uuid *uuid);
 858 int mdt_hsm_agent_send(struct mdt_thread_info *mti, struct hsm_action_list *hal,
 859                        bool purge);
 860 int mdt_hsm_coordinator_update(struct mdt_thread_info *mti,
 861                                struct hsm_progress_kernel *pgs);
 862 /* mdt/mdt_hsm_cdt_client.c */
 863 int mdt_hsm_add_actions(struct mdt_thread_info *info,
 864                         struct hsm_action_list *hal, __u64 *compound_id);
 865 int mdt_hsm_get_actions(struct mdt_thread_info *mti,
 866                         struct hsm_action_list *hal);
 867 int mdt_hsm_get_running(struct mdt_thread_info *mti,
 868                         struct hsm_action_list *hal);
 869 bool mdt_hsm_restore_is_running(struct mdt_thread_info *mti,
 870                                 const struct lu_fid *fid);
 871 /* mdt/mdt_hsm_cdt_requests.c */
 872 extern const struct file_operations mdt_hsm_active_requests_fops;
 873 void dump_requests(char *prefix, struct coordinator *cdt);
 874 struct cdt_agent_req *mdt_cdt_alloc_request(__u64 compound_id, __u32 archive_id,
 875                                             __u64 flags, struct obd_uuid *uuid,
 876                                             struct hsm_action_item *hai);
 877 void mdt_cdt_free_request(struct cdt_agent_req *car);
 878 int mdt_cdt_add_request(struct coordinator *cdt, struct cdt_agent_req *new_car);
 879 struct cdt_agent_req *mdt_cdt_find_request(struct coordinator *cdt,
 880                                            const __u64 cookie,
 881                                            const struct lu_fid *fid);
 882 void mdt_cdt_get_work_done(struct cdt_agent_req *car, __u64 *done_sz);
 883 void mdt_cdt_get_request(struct cdt_agent_req *car);
 884 void mdt_cdt_put_request(struct cdt_agent_req *car);
 885 struct cdt_agent_req *mdt_cdt_update_request(struct coordinator *cdt,
 886                                          const struct hsm_progress_kernel *pgs);
 887 int mdt_cdt_remove_request(struct coordinator *cdt, __u64 cookie);
 888 /* mdt/mdt_coordinator.c */
 889 void mdt_hsm_dump_hal(int level, const char *prefix,
 890                       struct hsm_action_list *hal);
 891 /* coordinator management */
 892 int mdt_hsm_cdt_init(struct mdt_device *mdt);
 893 int mdt_hsm_cdt_start(struct mdt_device *mdt);
 894 int mdt_hsm_cdt_stop(struct mdt_device *mdt);
 895 int mdt_hsm_cdt_fini(struct mdt_device *mdt);
 896 int mdt_hsm_cdt_wakeup(struct mdt_device *mdt);
 897
 898 /* coordinator control /proc interface */
 899 int lprocfs_wr_hsm_cdt_control(struct file *file, const char *buffer,
 900                                unsigned long count, void *data);
 901 int lprocfs_rd_hsm_cdt_control(char *page, char **start, off_t off,
 902                                int count, int *eof, void *data);
 903 int hsm_cdt_procfs_init(struct mdt_device *mdt);
 904 void hsm_cdt_procfs_fini(struct mdt_device *mdt);
 905 struct lprocfs_vars *hsm_cdt_get_proc_vars(void);
 906 /* md_hsm helpers */
 907 struct mdt_object *mdt_hsm_get_md_hsm(struct mdt_thread_info *mti,
 908                                       const struct lu_fid *fid,
 909                                       struct md_hsm *hsm);
 910 /* actions/request helpers */
 911 int mdt_hsm_add_hal(struct mdt_thread_info *mti,
 912                     struct hsm_action_list *hal, struct obd_uuid *uuid);
 913 bool mdt_hsm_is_action_compat(const struct hsm_action_item *hai,
 914                               const int hal_an, const __u64 rq_flags,
 915                               const struct md_hsm *hsm);
 916 int mdt_hsm_update_request_state(struct mdt_thread_info *mti,
 917                                  struct hsm_progress_kernel *pgs,
 918                                  const int update_record);
 919
 920 extern struct lu_context_key       mdt_thread_key;
 921
 922 /* debug issues helper starts here*/
 923 static inline int mdt_fail_write(const struct lu_env *env,
 924                                  struct dt_device *dd, int id)
 925 {
 926         if (OBD_FAIL_CHECK_ORSET(id, OBD_FAIL_ONCE)) {
 927                 CERROR(LUSTRE_MDT_NAME": cfs_fail_loc=%x, fail write ops\n",
 928                        id);
 929                 return dd->dd_ops->dt_ro(env, dd);
 930                 /* We set FAIL_ONCE because we never "un-fail" a device */
 931         }
 932
 933         return 0;
 934 }
 935
 936 static inline struct mdt_export_data *mdt_req2med(struct ptlrpc_request *req)
 937 {
 938         return &req->rq_export->exp_mdt_data;
 939 }
 940
 941 static inline struct mdt_device *mdt_exp2dev(struct obd_export *exp)
 942 {
 943         return mdt_dev(exp->exp_obd->obd_lu_dev);
 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         ENTRY;
 954
 955         if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) {
 956                 if (req_xid_is_last(req)) {
 957                         reconstruct(info, lhc);
 958                         RETURN(1);
 959                 }
 960                 DEBUG_REQ(D_HA, req, "no reply for RESENT req (have "LPD64")",
 961                           req->rq_export->exp_target_data.ted_lcd->lcd_last_xid);
 962         }
 963         RETURN(0);
 964 }
 965
 966 struct lu_ucred *mdt_ucred(const struct mdt_thread_info *info);
 967 struct lu_ucred *mdt_ucred_check(const struct mdt_thread_info *info);
 968
 969 static inline int is_identity_get_disabled(struct upcall_cache *cache)
 970 {
 971         return cache ? (strcmp(cache->uc_upcall, "NONE") == 0) : 1;
 972 }
 973
 974 int mdt_blocking_ast(struct ldlm_lock*, struct ldlm_lock_desc*, void*, int);
 975
 976 /* Issues dlm lock on passed @ns, @f stores it lock handle into @lh. */
 977 static inline int mdt_fid_lock(struct ldlm_namespace *ns,
 978                                struct lustre_handle *lh,
 979                                ldlm_mode_t mode,
 980                                ldlm_policy_data_t *policy,
 981                                const struct ldlm_res_id *res_id,
 982                                __u64 flags, const __u64 *client_cookie)
 983 {
 984         int rc;
 985
 986         LASSERT(ns != NULL);
 987         LASSERT(lh != NULL);
 988
 989         rc = ldlm_cli_enqueue_local(ns, res_id, LDLM_IBITS, policy,
 990                                     mode, &flags, mdt_blocking_ast,
 991                                     ldlm_completion_ast, NULL, NULL, 0,
 992                                     LVB_T_NONE, client_cookie, lh);
 993         return rc == ELDLM_OK ? 0 : -EIO;
 994 }
 995
 996 static inline void mdt_fid_unlock(struct lustre_handle *lh,
 997                                   ldlm_mode_t mode)
 998 {
 999         ldlm_lock_decref(lh, mode);
1000 }
1001
1002 extern mdl_mode_t mdt_mdl_lock_modes[];
1003 extern ldlm_mode_t mdt_dlm_lock_modes[];
1004
1005 static inline mdl_mode_t mdt_dlm_mode2mdl_mode(ldlm_mode_t mode)
1006 {
1007         LASSERT(IS_PO2(mode));
1008         return mdt_mdl_lock_modes[mode];
1009 }
1010
1011 static inline ldlm_mode_t mdt_mdl_mode2dlm_mode(mdl_mode_t mode)
1012 {
1013         LASSERT(IS_PO2(mode));
1014         return mdt_dlm_lock_modes[mode];
1015 }
1016
1017 /* mdt_lvb.c */
1018 extern struct ldlm_valblock_ops mdt_lvbo;
1019
1020 void mdt_enable_cos(struct mdt_device *, int);
1021 int mdt_cos_is_enabled(struct mdt_device *);
1022
1023 /* lprocfs stuff */
1024 enum {
1025         LPROC_MDT_OPEN = 0,
1026         LPROC_MDT_CLOSE,
1027         LPROC_MDT_MKNOD,
1028         LPROC_MDT_LINK,
1029         LPROC_MDT_UNLINK,
1030         LPROC_MDT_MKDIR,
1031         LPROC_MDT_RMDIR,
1032         LPROC_MDT_RENAME,
1033         LPROC_MDT_GETATTR,
1034         LPROC_MDT_SETATTR,
1035         LPROC_MDT_GETXATTR,
1036         LPROC_MDT_SETXATTR,
1037         LPROC_MDT_STATFS,
1038         LPROC_MDT_SYNC,
1039         LPROC_MDT_SAMEDIR_RENAME,
1040         LPROC_MDT_CROSSDIR_RENAME,
1041         LPROC_MDT_LAST,
1042 };
1043 void mdt_counter_incr(struct ptlrpc_request *req, int opcode);
1044 void mdt_stats_counter_init(struct lprocfs_stats *stats);
1045 void lprocfs_mdt_init_vars(struct lprocfs_static_vars *lvars);
1046 void lprocfs_mds_init_vars(struct lprocfs_static_vars *lvars);
1047 int mdt_procfs_init(struct mdt_device *mdt, const char *name);
1048 void mdt_procfs_fini(struct mdt_device *mdt);
1049
1050 /* lustre/mdt_mdt_lproc.c */
1051 int lprocfs_mdt_open_files_seq_open(struct inode *inode,
1052                                     struct file *file);
1053 void mdt_rename_counter_tally(struct mdt_thread_info *info,
1054                               struct mdt_device *mdt,
1055                               struct ptlrpc_request *req,
1056                               struct mdt_object *src, struct mdt_object *tgt);
1057
1058 /* Capability */
1059 int mdt_ck_thread_start(struct mdt_device *mdt);
1060 void mdt_ck_thread_stop(struct mdt_device *mdt);
1061 void mdt_ck_timer_callback(unsigned long castmeharder);
1062 int mdt_capa_keys_init(const struct lu_env *env, struct mdt_device *mdt);
1063 void mdt_set_capainfo(struct mdt_thread_info *info, int offset,
1064                       const struct lu_fid *fid, struct lustre_capa *capa);
1065 void mdt_dump_capainfo(struct mdt_thread_info *info);
1066
1067 static inline struct obd_device *mdt2obd_dev(const struct mdt_device *mdt)
1068 {
1069         return mdt->mdt_lu_dev.ld_obd;
1070 }
1071
1072 extern const struct lu_device_operations mdt_lu_ops;
1073
1074 static inline char *mdt_obd_name(struct mdt_device *mdt)
1075 {
1076         return mdt->mdt_lu_dev.ld_obd->obd_name;
1077 }
1078
1079 int mds_mod_init(void);
1080 void mds_mod_exit(void);
1081
1082 #endif /* __KERNEL__ */
1083 #endif /* _MDT_H */