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 /*
  54  * struct ptlrpc_client
  55  */
  56 #include <lustre_net.h>
  57 #include <obd.h>
  58 /*
  59  * struct obd_connect_data
  60  * struct lustre_handle
  61  */
  62 #include <lustre/lustre_idl.h>
  63 #include <lustre_disk.h>
  64 #include <lu_target.h>
  65 #include <md_object.h>
  66 #include <lustre_fid.h>
  67 #include <lustre_fld.h>
  68 #include <lustre_req_layout.h>
  69 #include <lustre_sec.h>
  70 #include <lvfs.h>
  71 #include <lustre_idmap.h>
  72 #include <lustre_eacl.h>
  73 #include <lustre_fsfilt.h>
  74 #include <lustre_quota.h>
  75
  76 /* check if request's xid is equal to last one or not*/
  77 static inline int req_xid_is_last(struct ptlrpc_request *req)
  78 {
  79         struct lsd_client_data *lcd = req->rq_export->exp_target_data.ted_lcd;
  80         return (req->rq_xid == lcd->lcd_last_xid ||
  81                 req->rq_xid == lcd->lcd_last_close_xid);
  82 }
  83
  84 struct mdt_object;
  85 /* file data for open files on MDS */
  86 struct mdt_file_data {
  87         struct portals_handle mfd_handle; /* must be first */
  88         int                   mfd_mode;   /* open mode provided by client */
  89         cfs_list_t            mfd_list;   /* protected by med_open_lock */
  90         __u64                 mfd_xid;    /* xid of the open request */
  91         struct lustre_handle  mfd_old_handle; /* old handle in replay case */
  92         struct mdt_object    *mfd_object; /* point to opened object */
  93 };
  94
  95 /* mdt state flag bits */
  96 #define MDT_FL_CFGLOG 0
  97 #define MDT_FL_SYNCED 1
  98
  99 struct mdt_device {
 100         /* super-class */
 101         struct md_device           mdt_md_dev;
 102         struct seq_server_site     mdt_seq_site;
 103         struct ptlrpc_service     *mdt_regular_service;
 104         struct ptlrpc_service     *mdt_readpage_service;
 105         struct ptlrpc_service     *mdt_out_service;
 106         struct ptlrpc_service     *mdt_setattr_service;
 107         struct ptlrpc_service     *mdt_mdsc_service;
 108         struct ptlrpc_service     *mdt_mdss_service;
 109         struct ptlrpc_service     *mdt_dtss_service;
 110         struct ptlrpc_service     *mdt_fld_service;
 111         /* DLM name-space for meta-data locks maintained by this server */
 112         struct ldlm_namespace     *mdt_namespace;
 113         /* ptlrpc handle for MDS->client connections (for lock ASTs). */
 114         struct ptlrpc_client      *mdt_ldlm_client;
 115         /* underlying device */
 116         struct obd_export         *mdt_child_exp;
 117         struct md_device          *mdt_child;
 118         struct dt_device          *mdt_bottom;
 119         struct obd_export         *mdt_bottom_exp;
 120         /** target device */
 121         struct lu_target           mdt_lut;
 122         /*
 123          * Options bit-fields.
 124          */
 125         struct {
 126                 signed int         mo_user_xattr :1,
 127                                    mo_acl        :1,
 128                                    mo_compat_resname:1,
 129                                    mo_mds_capa   :1,
 130                                    mo_oss_capa   :1,
 131                                    mo_cos        :1;
 132         } mdt_opts;
 133         /* mdt state flags */
 134         unsigned long              mdt_state;
 135         /* lock to protect IOepoch */
 136         spinlock_t                 mdt_ioepoch_lock;
 137         __u64                      mdt_ioepoch;
 138
 139         /* transaction callbacks */
 140         struct dt_txn_callback     mdt_txn_cb;
 141
 142         /* these values should be updated from lov if necessary.
 143          * or should be placed somewhere else. */
 144         int                        mdt_max_mdsize;
 145         int                        mdt_max_cookiesize;
 146
 147         struct upcall_cache        *mdt_identity_cache;
 148
 149         /* sptlrpc rules */
 150         rwlock_t                   mdt_sptlrpc_lock;
 151         struct sptlrpc_rule_set    mdt_sptlrpc_rset;
 152
 153         /* capability keys */
 154         unsigned long              mdt_capa_timeout;
 155         __u32                      mdt_capa_alg;
 156         struct dt_object          *mdt_ck_obj;
 157         unsigned long              mdt_ck_timeout;
 158         unsigned long              mdt_ck_expiry;
 159         cfs_timer_t                mdt_ck_timer;
 160         struct ptlrpc_thread       mdt_ck_thread;
 161         struct lustre_capa_key     mdt_capa_keys[2];
 162         unsigned int               mdt_capa_conf:1,
 163                                    mdt_som_conf:1;
 164
 165         /* statfs optimization: we cache a bit  */
 166         struct obd_statfs          mdt_osfs;
 167         __u64                      mdt_osfs_age;
 168         spinlock_t                 mdt_osfs_lock;
 169
 170         /* root squash */
 171         uid_t                      mdt_squash_uid;
 172         gid_t                      mdt_squash_gid;
 173         cfs_list_t                 mdt_nosquash_nids;
 174         char                      *mdt_nosquash_str;
 175         int                        mdt_nosquash_strlen;
 176         struct rw_semaphore        mdt_squash_sem;
 177
 178         int                        mdt_sec_level;
 179         struct rename_stats        mdt_rename_stats;
 180         struct lu_fid              mdt_md_root_fid;
 181
 182         /* connection to quota master */
 183         struct obd_export         *mdt_qmt_exp;
 184         /* quota master device associated with this MDT */
 185         struct lu_device          *mdt_qmt_dev;
 186 };
 187
 188 #define MDT_SERVICE_WATCHDOG_FACTOR     (2)
 189 #define MDT_ROCOMPAT_SUPP       (OBD_ROCOMPAT_LOVOBJID)
 190 #define MDT_INCOMPAT_SUPP       (OBD_INCOMPAT_MDT | OBD_INCOMPAT_COMMON_LR | \
 191                                 OBD_INCOMPAT_FID | OBD_INCOMPAT_IAM_DIR | \
 192                                 OBD_INCOMPAT_LMM_VER | OBD_INCOMPAT_MULTI_OI)
 193 #define MDT_COS_DEFAULT         (0)
 194
 195 struct mdt_object {
 196         struct lu_object_header mot_header;
 197         struct md_object        mot_obj;
 198         __u64                   mot_ioepoch;
 199         __u64                   mot_flags;
 200         int                     mot_ioepoch_count;
 201         int                     mot_writecount;
 202         /* Lock to protect object's IO epoch. */
 203         struct mutex            mot_ioepoch_mutex;
 204         /* Lock to protect create_data */
 205         struct mutex            mot_lov_mutex;
 206 };
 207
 208 enum mdt_object_flags {
 209         /** SOM attributes are changed. */
 210         MOF_SOM_CHANGE  = (1 << 0),
 211         /**
 212          * The SOM recovery state for mdt object.
 213          * This state is an in-memory equivalent of an absent SOM EA, used
 214          * instead of invalidating SOM EA while IOEpoch is still opened when
 215          * a client eviction occurs or a client fails to obtain SOM attributes.
 216          * It indicates that the last IOEpoch holder will need to obtain SOM
 217          * attributes under [0;EOF] extent lock to flush all the client's
 218          * cached of evicted from MDS clients (but not necessary evicted from
 219          * OST) before taking ost attributes.
 220          */
 221         MOF_SOM_RECOV   = (1 << 1),
 222         /** File has been just created. */
 223         MOF_SOM_CREATED = (1 << 2),
 224         /** lov object has been created. */
 225         MOF_LOV_CREATED = (1 << 3),
 226 };
 227
 228 struct mdt_lock_handle {
 229         /* Lock type, reg for cross-ref use or pdo lock. */
 230         mdl_type_t              mlh_type;
 231
 232         /* Regular lock */
 233         struct lustre_handle    mlh_reg_lh;
 234         ldlm_mode_t             mlh_reg_mode;
 235
 236         /* Pdirops lock */
 237         struct lustre_handle    mlh_pdo_lh;
 238         ldlm_mode_t             mlh_pdo_mode;
 239         unsigned int            mlh_pdo_hash;
 240 };
 241
 242 enum {
 243         MDT_LH_PARENT, /* parent lockh */
 244         MDT_LH_CHILD,  /* child lockh */
 245         MDT_LH_OLD,    /* old lockh for rename */
 246         MDT_LH_LAYOUT = MDT_LH_OLD, /* layout lock */
 247         MDT_LH_NEW,    /* new lockh for rename */
 248         MDT_LH_RMT,    /* used for return lh to caller */
 249         MDT_LH_NR
 250 };
 251
 252 enum {
 253         MDT_LOCAL_LOCK,
 254         MDT_CROSS_LOCK
 255 };
 256
 257 struct mdt_reint_record {
 258         mdt_reint_t             rr_opcode;
 259         const struct lustre_handle *rr_handle;
 260         const struct lu_fid    *rr_fid1;
 261         const struct lu_fid    *rr_fid2;
 262         const char             *rr_name;
 263         int                     rr_namelen;
 264         const char             *rr_tgt;
 265         int                     rr_tgtlen;
 266         const void             *rr_eadata;
 267         int                     rr_eadatalen;
 268         int                     rr_logcookielen;
 269         const struct llog_cookie  *rr_logcookies;
 270         __u32                   rr_flags;
 271 };
 272
 273 enum mdt_reint_flag {
 274         MRF_OPEN_TRUNC = 1 << 0,
 275 };
 276
 277 struct mdt_thread_info;
 278 struct tx_arg;
 279 typedef int (*tx_exec_func_t)(struct mdt_thread_info *, struct thandle *,
 280                               struct tx_arg *);
 281
 282 struct tx_arg {
 283         tx_exec_func_t          exec_fn;
 284         tx_exec_func_t          undo_fn;
 285         struct dt_object        *object;
 286         char                    *file;
 287         int                     line;
 288         struct update_reply     *reply;
 289         int                     index;
 290         union {
 291                 struct {
 292                         const struct dt_rec     *rec;
 293                         const struct dt_key     *key;
 294                 } insert;
 295                 struct {
 296                 } ref;
 297                 struct {
 298                         struct lu_attr  attr;
 299                 } attr_set;
 300                 struct {
 301                         struct lu_buf   buf;
 302                         const char      *name;
 303                         int             flags;
 304                         __u32           csum;
 305                 } xattr_set;
 306                 struct {
 307                         struct lu_attr                  attr;
 308                         struct dt_allocation_hint       hint;
 309                         struct dt_object_format         dof;
 310                         struct lu_fid                   fid;
 311                 } create;
 312                 struct {
 313                         struct lu_buf   buf;
 314                         loff_t          pos;
 315                 } write;
 316         } u;
 317 };
 318
 319 #define TX_MAX_OPS        10
 320 struct thandle_exec_args {
 321         struct thandle          *ta_handle;
 322         struct dt_device        *ta_dev;
 323         int                     ta_err;
 324         struct tx_arg           ta_args[TX_MAX_OPS];
 325         int                     ta_argno;   /* used args */
 326 };
 327
 328 /*
 329  * Common data shared by mdt-level handlers. This is allocated per-thread to
 330  * reduce stack consumption.
 331  */
 332 struct mdt_thread_info {
 333         /*
 334          * XXX: Part One:
 335          * The following members will be filled explicitly
 336          * with specific data in mdt_thread_info_init().
 337          */
 338         /* TODO: move this into mdt_session_key(with LCT_SESSION), because
 339          * request handling may migrate from one server thread to another.
 340          */
 341         struct req_capsule        *mti_pill;
 342
 343         /* although we have export in req, there are cases when it is not
 344          * available, e.g. closing files upon export destroy */
 345         struct obd_export          *mti_exp;
 346         /*
 347          * A couple of lock handles.
 348          */
 349         struct mdt_lock_handle     mti_lh[MDT_LH_NR];
 350
 351         struct mdt_device         *mti_mdt;
 352         const struct lu_env       *mti_env;
 353
 354         /*
 355          * Additional fail id that can be set by handler. Passed to
 356          * target_send_reply().
 357          */
 358         int                        mti_fail_id;
 359
 360         /* transaction number of current request */
 361         __u64                      mti_transno;
 362
 363
 364         /*
 365          * XXX: Part Two:
 366          * The following members will be filled expilictly
 367          * with zero in mdt_thread_info_init(). These members may be used
 368          * by all requests.
 369          */
 370
 371         /*
 372          * Object attributes.
 373          */
 374         struct md_attr             mti_attr;
 375         /*
 376          * Body for "habeo corpus" operations.
 377          */
 378         const struct mdt_body     *mti_body;
 379         /*
 380          * Host object. This is released at the end of mdt_handler().
 381          */
 382         struct mdt_object         *mti_object;
 383         /*
 384          * Lock request for "habeo clavis" operations.
 385          */
 386         const struct ldlm_request *mti_dlm_req;
 387
 388         __u32                      mti_has_trans:1, /* has txn already? */
 389                                    mti_cross_ref:1;
 390
 391         /* opdata for mdt_reint_open(), has the same as
 392          * ldlm_reply:lock_policy_res1.  mdt_update_last_rcvd() stores this
 393          * value onto disk for recovery when mdt_trans_stop_cb() is called.
 394          */
 395         __u64                      mti_opdata;
 396
 397         /*
 398          * XXX: Part Three:
 399          * The following members will be filled explicitly
 400          * with zero in mdt_reint_unpack(), because they are only used
 401          * by reint requests (including mdt_reint_open()).
 402          */
 403
 404         /*
 405          * reint record. contains information for reint operations.
 406          */
 407         struct mdt_reint_record    mti_rr;
 408
 409         /** md objects included in operation */
 410         struct mdt_object         *mti_mos;
 411         __u64                      mti_ver[PTLRPC_NUM_VERSIONS];
 412         /*
 413          * Operation specification (currently create and lookup)
 414          */
 415         struct md_op_spec          mti_spec;
 416
 417         /*
 418          * XXX: Part Four:
 419          * The following members will _NOT_ be initialized at all.
 420          * DO NOT expect them to contain any valid value.
 421          * They should be initialized explicitly by the user themselves.
 422          */
 423
 424          /* XXX: If something is in a union, make sure they do not conflict */
 425
 426         struct lu_fid              mti_tmp_fid1;
 427         struct lu_fid              mti_tmp_fid2;
 428         ldlm_policy_data_t         mti_policy;    /* for mdt_object_lock() and
 429                                                    * mdt_rename_lock() */
 430         struct ldlm_res_id         mti_res_id;    /* for mdt_object_lock() and
 431                                                      mdt_rename_lock()   */
 432         union {
 433                 struct obd_uuid    uuid[2];       /* for mdt_seq_init_cli()  */
 434                 char               ns_name[48];   /* for mdt_init0()         */
 435                 struct lustre_cfg_bufs bufs;      /* for mdt_stack_fini()    */
 436                 struct obd_statfs  osfs;          /* for mdt_statfs()        */
 437                 struct {
 438                         /* for mdt_readpage()      */
 439                         struct lu_rdpg     mti_rdpg;
 440                         /* for mdt_sendpage()      */
 441                         struct l_wait_info mti_wait_info;
 442                 } rdpg;
 443                 struct {
 444                         struct md_attr attr;
 445                         struct md_som_data data;
 446                 } som;
 447                 struct {
 448                         struct dt_object_format mti_update_dof;
 449                         struct update_reply     *mti_update_reply;
 450                         struct update           *mti_update;
 451                         int                     mti_update_reply_index;
 452                         struct obdo             mti_obdo;
 453                         struct dt_object        *mti_dt_object;
 454                 } update;
 455         } mti_u;
 456
 457         /* IO epoch related stuff. */
 458         struct mdt_ioepoch        *mti_ioepoch;
 459         __u64                      mti_replayepoch;
 460
 461         loff_t                     mti_off;
 462         struct lu_buf              mti_buf;
 463         struct lustre_capa_key     mti_capa_key;
 464
 465         /* Ops object filename */
 466         struct lu_name             mti_name;
 467         /* per-thread values, can be re-used */
 468         void                      *mti_big_lmm;
 469         int                        mti_big_lmmsize;
 470         /* big_lmm buffer was used and must be used in reply */
 471         int                        mti_big_lmm_used;
 472         /* should be enough to fit lustre_mdt_attrs */
 473         char                       mti_xattr_buf[128];
 474         struct thandle_exec_args   mti_handle;
 475         struct ldlm_enqueue_info   mti_einfo;
 476 };
 477
 478 /* ptlrpc request handler for MDT. All handlers are
 479  * grouped into several slices - struct mdt_opc_slice,
 480  * and stored in an array - mdt_handlers[].
 481  */
 482 struct mdt_handler {
 483         /* The name of this handler. */
 484         const char *mh_name;
 485         /* Fail id for this handler, checked at the beginning of this handler*/
 486         int      mh_fail_id;
 487         /* Operation code for this handler */
 488         __u32       mh_opc;
 489         /* flags are listed in enum mdt_handler_flags below. */
 490         __u32       mh_flags;
 491         /* The actual handler function to execute. */
 492         int (*mh_act)(struct mdt_thread_info *info);
 493         /* Request format for this request. */
 494         const struct req_format *mh_fmt;
 495 };
 496
 497 enum mdt_handler_flags {
 498         /*
 499          * struct mdt_body is passed in the incoming message, and object
 500          * identified by this fid exists on disk.
 501          *
 502          * "habeo corpus" == "I have a body"
 503          */
 504         HABEO_CORPUS = (1 << 0),
 505         /*
 506          * struct ldlm_request is passed in the incoming message.
 507          *
 508          * "habeo clavis" == "I have a key"
 509          */
 510         HABEO_CLAVIS = (1 << 1),
 511         /*
 512          * this request has fixed reply format, so that reply message can be
 513          * packed by generic code.
 514          *
 515          * "habeo refero" == "I have a reply"
 516          */
 517         HABEO_REFERO = (1 << 2),
 518         /*
 519          * this request will modify something, so check whether the filesystem
 520          * is readonly or not, then return -EROFS to client asap if necessary.
 521          *
 522          * "mutabor" == "I shall modify"
 523          */
 524         MUTABOR      = (1 << 3)
 525 };
 526
 527 struct mdt_opc_slice {
 528         __u32                   mos_opc_start;
 529         int                     mos_opc_end;
 530         struct mdt_handler      *mos_hs;
 531 };
 532
 533 static inline const struct md_device_operations *
 534 mdt_child_ops(struct mdt_device * m)
 535 {
 536         LASSERT(m->mdt_child);
 537         return m->mdt_child->md_ops;
 538 }
 539
 540 static inline struct md_object *mdt_object_child(struct mdt_object *o)
 541 {
 542         LASSERT(o);
 543         return lu2md(lu_object_next(&o->mot_obj.mo_lu));
 544 }
 545
 546 static inline struct ptlrpc_request *mdt_info_req(struct mdt_thread_info *info)
 547 {
 548          return info->mti_pill ? info->mti_pill->rc_req : NULL;
 549 }
 550
 551 static inline int req_is_replay(struct ptlrpc_request *req)
 552 {
 553         LASSERT(req->rq_reqmsg);
 554         return !!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY);
 555 }
 556
 557 static inline __u64 mdt_conn_flags(struct mdt_thread_info *info)
 558 {
 559         LASSERT(info->mti_exp);
 560         return info->mti_exp->exp_connect_flags;
 561 }
 562
 563 static inline void mdt_object_get(const struct lu_env *env,
 564                                   struct mdt_object *o)
 565 {
 566         ENTRY;
 567         lu_object_get(&o->mot_obj.mo_lu);
 568         EXIT;
 569 }
 570
 571 static inline void mdt_object_put(const struct lu_env *env,
 572                                   struct mdt_object *o)
 573 {
 574         ENTRY;
 575         lu_object_put(env, &o->mot_obj.mo_lu);
 576         EXIT;
 577 }
 578
 579 static inline int mdt_object_exists(const struct mdt_object *o)
 580 {
 581         return lu_object_exists(&o->mot_obj.mo_lu);
 582 }
 583
 584 static inline const struct lu_fid *mdt_object_fid(const struct mdt_object *o)
 585 {
 586         return lu_object_fid(&o->mot_obj.mo_lu);
 587 }
 588
 589 static inline int mdt_object_obf(const struct mdt_object *o)
 590 {
 591         return lu_fid_eq(mdt_object_fid(o), &LU_OBF_FID);
 592 }
 593
 594 static inline struct lu_site *mdt_lu_site(const struct mdt_device *mdt)
 595 {
 596         return mdt->mdt_md_dev.md_lu_dev.ld_site;
 597 }
 598
 599 static inline struct seq_server_site *mdt_seq_site(struct mdt_device *mdt)
 600 {
 601         return &mdt->mdt_seq_site;
 602 }
 603
 604 static inline void mdt_export_evict(struct obd_export *exp)
 605 {
 606         class_fail_export(exp);
 607         class_export_put(exp);
 608 }
 609
 610 int mdt_get_disposition(struct ldlm_reply *rep, int flag);
 611 void mdt_set_disposition(struct mdt_thread_info *info,
 612                         struct ldlm_reply *rep, int flag);
 613 void mdt_clear_disposition(struct mdt_thread_info *info,
 614                         struct ldlm_reply *rep, int flag);
 615
 616 void mdt_lock_pdo_init(struct mdt_lock_handle *lh,
 617                        ldlm_mode_t lm, const char *name,
 618                        int namelen);
 619
 620 void mdt_lock_reg_init(struct mdt_lock_handle *lh,
 621                        ldlm_mode_t lm);
 622
 623 int mdt_lock_setup(struct mdt_thread_info *info,
 624                    struct mdt_object *o,
 625                    struct mdt_lock_handle *lh);
 626
 627 int mdt_object_lock(struct mdt_thread_info *,
 628                     struct mdt_object *,
 629                     struct mdt_lock_handle *,
 630                     __u64, int);
 631
 632 int mdt_object_lock_try(struct mdt_thread_info *,
 633                         struct mdt_object *,
 634                         struct mdt_lock_handle *,
 635                         __u64, int);
 636
 637 void mdt_object_unlock(struct mdt_thread_info *,
 638                        struct mdt_object *,
 639                        struct mdt_lock_handle *,
 640                        int decref);
 641
 642 struct mdt_object *mdt_object_new(const struct lu_env *,
 643                                   struct mdt_device *,
 644                                   const struct lu_fid *);
 645 struct mdt_object *mdt_object_find(const struct lu_env *,
 646                                    struct mdt_device *,
 647                                    const struct lu_fid *);
 648 struct mdt_object *mdt_object_find_lock(struct mdt_thread_info *,
 649                                         const struct lu_fid *,
 650                                         struct mdt_lock_handle *,
 651                                         __u64);
 652 void mdt_object_unlock_put(struct mdt_thread_info *,
 653                            struct mdt_object *,
 654                            struct mdt_lock_handle *,
 655                            int decref);
 656
 657 void mdt_client_compatibility(struct mdt_thread_info *info);
 658
 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_pin(struct mdt_thread_info* info);
 688
 689 int mdt_lock_new_child(struct mdt_thread_info *info,
 690                        struct mdt_object *o,
 691                        struct mdt_lock_handle *child_lockh);
 692
 693 void mdt_mfd_set_mode(struct mdt_file_data *mfd,
 694                       int mode);
 695
 696 int mdt_reint_open(struct mdt_thread_info *info,
 697                    struct mdt_lock_handle *lhc);
 698
 699 struct mdt_file_data *mdt_handle2mfd(struct mdt_thread_info *,
 700                                      const struct lustre_handle *);
 701
 702 enum {
 703         MDT_IOEPOCH_CLOSED  = 0,
 704         MDT_IOEPOCH_OPENED  = 1,
 705         MDT_IOEPOCH_GETATTR = 2,
 706 };
 707
 708 enum {
 709         MDT_SOM_DISABLE = 0,
 710         MDT_SOM_ENABLE  = 1,
 711 };
 712
 713 int mdt_attr_get_complex(struct mdt_thread_info *info,
 714                          struct mdt_object *o, struct md_attr *ma);
 715 int mdt_ioepoch_open(struct mdt_thread_info *info, struct mdt_object *o,
 716                      int created);
 717 int mdt_object_is_som_enabled(struct mdt_object *mo);
 718 int mdt_write_get(struct mdt_object *o);
 719 void mdt_write_put(struct mdt_object *o);
 720 int mdt_write_read(struct mdt_object *o);
 721 struct mdt_file_data *mdt_mfd_new(void);
 722 int mdt_mfd_close(struct mdt_thread_info *info, struct mdt_file_data *mfd);
 723 void mdt_mfd_free(struct mdt_file_data *mfd);
 724 int mdt_close(struct mdt_thread_info *info);
 725 int mdt_attr_set(struct mdt_thread_info *info, struct mdt_object *mo,
 726                  struct md_attr *ma, int flags);
 727 int mdt_add_dirty_flag(struct mdt_thread_info *info, struct mdt_object *mo,
 728                         struct md_attr *ma);
 729 int mdt_done_writing(struct mdt_thread_info *info);
 730 int mdt_fix_reply(struct mdt_thread_info *info);
 731 int mdt_handle_last_unlink(struct mdt_thread_info *, struct mdt_object *,
 732                            const struct md_attr *);
 733 void mdt_reconstruct_open(struct mdt_thread_info *, struct mdt_lock_handle *);
 734
 735 struct lu_buf *mdt_buf(const struct lu_env *env, void *area, ssize_t len);
 736 const struct lu_buf *mdt_buf_const(const struct lu_env *env,
 737                                    const void *area, ssize_t len);
 738
 739 void mdt_dump_lmm(int level, const struct lov_mds_md *lmm);
 740
 741 int mdt_check_ucred(struct mdt_thread_info *);
 742 int mdt_init_ucred(struct mdt_thread_info *, struct mdt_body *);
 743 int mdt_init_ucred_reint(struct mdt_thread_info *);
 744 void mdt_exit_ucred(struct mdt_thread_info *);
 745 int mdt_version_get_check(struct mdt_thread_info *, struct mdt_object *, int);
 746 void mdt_version_get_save(struct mdt_thread_info *, struct mdt_object *, int);
 747 int mdt_version_get_check_save(struct mdt_thread_info *, struct mdt_object *,
 748                                int);
 749 int mdt_handle_common(struct ptlrpc_request *req,
 750                       struct mdt_opc_slice *supported);
 751 int mdt_connect(struct mdt_thread_info *info);
 752 int mdt_disconnect(struct mdt_thread_info *info);
 753 int mdt_set_info(struct mdt_thread_info *info);
 754 int mdt_get_info(struct mdt_thread_info *info);
 755 int mdt_getstatus(struct mdt_thread_info *info);
 756 int mdt_getattr(struct mdt_thread_info *info);
 757 int mdt_getattr_name(struct mdt_thread_info *info);
 758 int mdt_statfs(struct mdt_thread_info *info);
 759 int mdt_reint(struct mdt_thread_info *info);
 760 int mdt_sync(struct mdt_thread_info *info);
 761 int mdt_is_subdir(struct mdt_thread_info *info);
 762 int mdt_obd_ping(struct mdt_thread_info *info);
 763 int mdt_obd_log_cancel(struct mdt_thread_info *info);
 764 int mdt_obd_qc_callback(struct mdt_thread_info *info);
 765 int mdt_enqueue(struct mdt_thread_info *info);
 766 int mdt_convert(struct mdt_thread_info *info);
 767 int mdt_bl_callback(struct mdt_thread_info *info);
 768 int mdt_cp_callback(struct mdt_thread_info *info);
 769 int mdt_llog_create(struct mdt_thread_info *info);
 770 int mdt_llog_destroy(struct mdt_thread_info *info);
 771 int mdt_llog_read_header(struct mdt_thread_info *info);
 772 int mdt_llog_next_block(struct mdt_thread_info *info);
 773 int mdt_llog_prev_block(struct mdt_thread_info *info);
 774 int mdt_sec_ctx_handle(struct mdt_thread_info *info);
 775 int mdt_readpage(struct mdt_thread_info *info);
 776 int mdt_obd_idx_read(struct mdt_thread_info *info);
 777
 778 extern struct mdt_opc_slice mdt_regular_handlers[];
 779 extern struct mdt_opc_slice mdt_seq_handlers[];
 780 extern struct mdt_opc_slice mdt_fld_handlers[];
 781
 782 int mdt_quotacheck(struct mdt_thread_info *info);
 783 int mdt_quotactl(struct mdt_thread_info *info);
 784 int mdt_quota_dqacq(struct mdt_thread_info *info);
 785
 786 extern struct lprocfs_vars lprocfs_mds_module_vars[];
 787 extern struct lprocfs_vars lprocfs_mds_obd_vars[];
 788
 789 int mdt_hsm_attr_set(struct mdt_thread_info *info, struct mdt_object *obj,
 790                      struct md_hsm *mh);
 791
 792 struct mdt_handler *mdt_handler_find(__u32 opc,
 793                                      struct mdt_opc_slice *supported);
 794 /* mdt_idmap.c */
 795 int mdt_init_sec_level(struct mdt_thread_info *);
 796 int mdt_init_idmap(struct mdt_thread_info *);
 797 void mdt_cleanup_idmap(struct mdt_export_data *);
 798 int mdt_handle_idmap(struct mdt_thread_info *);
 799 int ptlrpc_user_desc_do_idmap(struct ptlrpc_request *,
 800                               struct ptlrpc_user_desc *);
 801 void mdt_body_reverse_idmap(struct mdt_thread_info *,
 802                             struct mdt_body *);
 803 int mdt_remote_perm_reverse_idmap(struct ptlrpc_request *,
 804                                   struct mdt_remote_perm *);
 805 int mdt_fix_attr_ucred(struct mdt_thread_info *, __u32);
 806
 807 static inline struct mdt_device *mdt_dev(struct lu_device *d)
 808 {
 809 //        LASSERT(lu_device_is_mdt(d));
 810         return container_of0(d, struct mdt_device, mdt_md_dev.md_lu_dev);
 811 }
 812
 813 static inline struct dt_object *mdt_obj2dt(struct mdt_object *mo)
 814 {
 815         struct lu_object *lo;
 816         struct mdt_device *mdt = mdt_dev(mo->mot_obj.mo_lu.lo_dev);
 817
 818         lo = lu_object_locate(mo->mot_obj.mo_lu.lo_header,
 819                               mdt->mdt_bottom->dd_lu_dev.ld_type);
 820         return lu2dt(lo);
 821 }
 822
 823 /* mdt/mdt_identity.c */
 824 #define MDT_IDENTITY_UPCALL_PATH        "/usr/sbin/l_getidentity"
 825
 826 extern struct upcall_cache_ops mdt_identity_upcall_cache_ops;
 827
 828 struct md_identity *mdt_identity_get(struct upcall_cache *, __u32);
 829
 830 void mdt_identity_put(struct upcall_cache *, struct md_identity *);
 831
 832 void mdt_flush_identity(struct upcall_cache *, int);
 833
 834 __u32 mdt_identity_get_perm(struct md_identity *, __u32, lnet_nid_t);
 835
 836 int mdt_pack_remote_perm(struct mdt_thread_info *, struct mdt_object *, void *);
 837
 838 /* mdt/mdt_hsm.c */
 839 int mdt_hsm_state_get(struct mdt_thread_info *info);
 840 int mdt_hsm_state_set(struct mdt_thread_info *info);
 841 int mdt_hsm_action(struct mdt_thread_info *info);
 842 int mdt_hsm_progress(struct mdt_thread_info *info);
 843 int mdt_hsm_ct_register(struct mdt_thread_info *info);
 844 int mdt_hsm_ct_unregister(struct mdt_thread_info *info);
 845 int mdt_hsm_request(struct mdt_thread_info *info);
 846
 847 extern struct lu_context_key       mdt_thread_key;
 848 /* debug issues helper starts here*/
 849 static inline int mdt_fail_write(const struct lu_env *env,
 850                                  struct dt_device *dd, int id)
 851 {
 852         if (OBD_FAIL_CHECK_ORSET(id, OBD_FAIL_ONCE)) {
 853                 CERROR(LUSTRE_MDT_NAME": cfs_fail_loc=%x, fail write ops\n",
 854                        id);
 855                 return dd->dd_ops->dt_ro(env, dd);
 856                 /* We set FAIL_ONCE because we never "un-fail" a device */
 857         }
 858
 859         return 0;
 860 }
 861
 862 static inline struct mdt_export_data *mdt_req2med(struct ptlrpc_request *req)
 863 {
 864         return &req->rq_export->exp_mdt_data;
 865 }
 866
 867 typedef void (*mdt_reconstruct_t)(struct mdt_thread_info *mti,
 868                                   struct mdt_lock_handle *lhc);
 869 static inline int mdt_check_resent(struct mdt_thread_info *info,
 870                                    mdt_reconstruct_t reconstruct,
 871                                    struct mdt_lock_handle *lhc)
 872 {
 873         struct ptlrpc_request *req = mdt_info_req(info);
 874         ENTRY;
 875
 876         if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) {
 877                 if (req_xid_is_last(req)) {
 878                         reconstruct(info, lhc);
 879                         RETURN(1);
 880                 }
 881                 DEBUG_REQ(D_HA, req, "no reply for RESENT req (have "LPD64")",
 882                           req->rq_export->exp_target_data.ted_lcd->lcd_last_xid);
 883         }
 884         RETURN(0);
 885 }
 886
 887 struct lu_ucred *mdt_ucred(const struct mdt_thread_info *info);
 888 struct lu_ucred *mdt_ucred_check(const struct mdt_thread_info *info);
 889
 890 static inline int is_identity_get_disabled(struct upcall_cache *cache)
 891 {
 892         return cache ? (strcmp(cache->uc_upcall, "NONE") == 0) : 1;
 893 }
 894
 895 int mdt_blocking_ast(struct ldlm_lock*, struct ldlm_lock_desc*, void*, int);
 896
 897 /* Issues dlm lock on passed @ns, @f stores it lock handle into @lh. */
 898 static inline int mdt_fid_lock(struct ldlm_namespace *ns,
 899                                struct lustre_handle *lh,
 900                                ldlm_mode_t mode,
 901                                ldlm_policy_data_t *policy,
 902                                const struct ldlm_res_id *res_id,
 903                                __u64 flags, const __u64 *client_cookie)
 904 {
 905         int rc;
 906
 907         LASSERT(ns != NULL);
 908         LASSERT(lh != NULL);
 909
 910         rc = ldlm_cli_enqueue_local(ns, res_id, LDLM_IBITS, policy,
 911                                     mode, &flags, mdt_blocking_ast,
 912                                     ldlm_completion_ast, NULL, NULL, 0,
 913                                     LVB_T_NONE, client_cookie, lh);
 914         return rc == ELDLM_OK ? 0 : -EIO;
 915 }
 916
 917 static inline void mdt_fid_unlock(struct lustre_handle *lh,
 918                                   ldlm_mode_t mode)
 919 {
 920         ldlm_lock_decref(lh, mode);
 921 }
 922
 923 extern mdl_mode_t mdt_mdl_lock_modes[];
 924 extern ldlm_mode_t mdt_dlm_lock_modes[];
 925
 926 static inline mdl_mode_t mdt_dlm_mode2mdl_mode(ldlm_mode_t mode)
 927 {
 928         LASSERT(IS_PO2(mode));
 929         return mdt_mdl_lock_modes[mode];
 930 }
 931
 932 static inline ldlm_mode_t mdt_mdl_mode2dlm_mode(mdl_mode_t mode)
 933 {
 934         LASSERT(IS_PO2(mode));
 935         return mdt_dlm_lock_modes[mode];
 936 }
 937
 938 /* mdt_lvb.c */
 939 extern struct ldlm_valblock_ops mdt_lvbo;
 940
 941 static inline struct lu_name *mdt_name(const struct lu_env *env,
 942                                        char *name, int namelen)
 943 {
 944         struct lu_name *lname;
 945         struct mdt_thread_info *mti;
 946
 947         LASSERT(namelen > 0);
 948         /* trailing '\0' in buffer */
 949         LASSERT(name[namelen] == '\0');
 950
 951         mti = lu_context_key_get(&env->le_ctx, &mdt_thread_key);
 952         lname = &mti->mti_name;
 953         lname->ln_name = name;
 954         lname->ln_namelen = namelen;
 955         return lname;
 956 }
 957
 958 static inline struct lu_name *mdt_name_copy(struct lu_name *tlname,
 959                                             struct lu_name *slname)
 960 {
 961         LASSERT(tlname);
 962         LASSERT(slname);
 963
 964         tlname->ln_name = slname->ln_name;
 965         tlname->ln_namelen = slname->ln_namelen;
 966         return tlname;
 967 }
 968
 969 void mdt_enable_cos(struct mdt_device *, int);
 970 int mdt_cos_is_enabled(struct mdt_device *);
 971 int mdt_hsm_copytool_send(struct obd_export *exp);
 972
 973 /* lprocfs stuff */
 974 enum {
 975         LPROC_MDT_OPEN = 0,
 976         LPROC_MDT_CLOSE,
 977         LPROC_MDT_MKNOD,
 978         LPROC_MDT_LINK,
 979         LPROC_MDT_UNLINK,
 980         LPROC_MDT_MKDIR,
 981         LPROC_MDT_RMDIR,
 982         LPROC_MDT_RENAME,
 983         LPROC_MDT_GETATTR,
 984         LPROC_MDT_SETATTR,
 985         LPROC_MDT_GETXATTR,
 986         LPROC_MDT_SETXATTR,
 987         LPROC_MDT_STATFS,
 988         LPROC_MDT_SYNC,
 989         LPROC_MDT_SAMEDIR_RENAME,
 990         LPROC_MDT_CROSSDIR_RENAME,
 991         LPROC_MDT_LAST,
 992 };
 993 void mdt_counter_incr(struct ptlrpc_request *req, int opcode);
 994 void mdt_stats_counter_init(struct lprocfs_stats *stats);
 995 void lprocfs_mdt_init_vars(struct lprocfs_static_vars *lvars);
 996 void lprocfs_mds_init_vars(struct lprocfs_static_vars *lvars);
 997 int mdt_procfs_init(struct mdt_device *mdt, const char *name);
 998 int mdt_procfs_fini(struct mdt_device *mdt);
 999 void mdt_rename_counter_tally(struct mdt_thread_info *info,
1000                               struct mdt_device *mdt,
1001                               struct ptlrpc_request *req,
1002                               struct mdt_object *src, struct mdt_object *tgt);
1003
1004 /* Capability */
1005 int mdt_ck_thread_start(struct mdt_device *mdt);
1006 void mdt_ck_thread_stop(struct mdt_device *mdt);
1007 void mdt_ck_timer_callback(unsigned long castmeharder);
1008 int mdt_capa_keys_init(const struct lu_env *env, struct mdt_device *mdt);
1009
1010 static inline void mdt_set_capainfo(struct mdt_thread_info *info, int offset,
1011                                     const struct lu_fid *fid,
1012                                     struct lustre_capa *capa)
1013 {
1014         struct md_capainfo *ci;
1015
1016         LASSERT(offset >= 0 && offset < MD_CAPAINFO_MAX);
1017         if (!info->mti_mdt->mdt_opts.mo_mds_capa ||
1018             !(info->mti_exp->exp_connect_flags & OBD_CONNECT_MDS_CAPA))
1019                 return;
1020
1021         ci = md_capainfo(info->mti_env);
1022         LASSERT(ci);
1023         ci->mc_fid[offset]  = *fid;
1024         ci->mc_capa[offset] = capa;
1025 }
1026
1027 static inline void mdt_dump_capainfo(struct mdt_thread_info *info)
1028 {
1029         struct md_capainfo *ci = md_capainfo(info->mti_env);
1030         int i;
1031
1032         if (!ci)
1033                 return;
1034         for (i = 0; i < MD_CAPAINFO_MAX; i++) {
1035                 if (!ci->mc_capa[i]) {
1036                         CERROR("no capa for index %d "DFID"\n",
1037                                i, PFID(&ci->mc_fid[i]));
1038                         continue;
1039                 }
1040                 if (ci->mc_capa[i] == BYPASS_CAPA) {
1041                         CERROR("bypass for index %d "DFID"\n",
1042                                i, PFID(&ci->mc_fid[i]));
1043                         continue;
1044                 }
1045                 DEBUG_CAPA(D_ERROR, ci->mc_capa[i], "index %d", i);
1046         }
1047 }
1048
1049 static inline struct obd_device *mdt2obd_dev(const struct mdt_device *mdt)
1050 {
1051         return mdt->mdt_md_dev.md_lu_dev.ld_obd;
1052 }
1053
1054 extern const struct lu_device_operations mdt_lu_ops;
1055
1056 static inline int lu_device_is_mdt(struct lu_device *d)
1057 {
1058         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &mdt_lu_ops);
1059 }
1060
1061 static inline struct mdt_device *lu2mdt_dev(struct lu_device *d)
1062 {
1063         LASSERTF(lu_device_is_mdt(d), "It is %s instead of MDT %p %p\n",
1064                  d->ld_type->ldt_name, d->ld_ops, &mdt_lu_ops);
1065         return container_of0(d, struct mdt_device, mdt_md_dev.md_lu_dev);
1066 }
1067
1068 static inline char *mdt_obd_name(struct mdt_device *mdt)
1069 {
1070         return mdt->mdt_md_dev.md_lu_dev.ld_obd->obd_name;
1071 }
1072
1073 int mds_mod_init(void);
1074 void mds_mod_exit(void);
1075
1076 /* Update handlers */
1077 int out_handle(struct mdt_thread_info *info);
1078
1079 #define out_tx_create(info, obj, attr, fid, dof, th, reply, idx) \
1080         __out_tx_create(info, obj, attr, fid, dof, th, reply, idx, \
1081                         __FILE__, __LINE__)
1082
1083 #define out_tx_attr_set(info, obj, attr, th, reply, idx) \
1084         __out_tx_attr_set(info, obj, attr, th, reply, idx, \
1085                           __FILE__, __LINE__)
1086
1087 #define out_tx_xattr_set(info, obj, buf, name, fl, th, reply, idx)      \
1088         __out_tx_xattr_set(info, obj, buf, name, fl, th, reply, idx,    \
1089                            __FILE__, __LINE__)
1090
1091 #define out_tx_ref_add(info, obj, th, reply, idx) \
1092         __out_tx_ref_add(info, obj, th, reply, idx, __FILE__, __LINE__)
1093
1094 #define out_tx_ref_del(info, obj, th, reply, idx) \
1095         __out_tx_ref_del(info, obj, th, reply, idx, __FILE__, __LINE__)
1096
1097 #define out_tx_index_insert(info, obj, th, name, fid, reply, idx) \
1098         __out_tx_index_insert(info, obj, th, name, fid, reply, idx, \
1099                               __FILE__, __LINE__)
1100
1101 #define out_tx_index_delete(info, obj, th, name, reply, idx) \
1102         __out_tx_index_delete(info, obj, th, name, reply, idx, \
1103                               __FILE__, __LINE__)
1104
1105
1106 #endif /* __KERNEL__ */
1107 #endif /* _MDT_H */