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