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