Whamcloud - gitweb
LU-2062 hsm: llapi hsm calls for CopyTool
[fs/lustre-release.git] / 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_xmds_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 /*
278  * Common data shared by mdt-level handlers. This is allocated per-thread to
279  * reduce stack consumption.
280  */
281 struct mdt_thread_info {
282         /*
283          * XXX: Part One:
284          * The following members will be filled explicitly
285          * with specific data in mdt_thread_info_init().
286          */
287         /* TODO: move this into mdt_session_key(with LCT_SESSION), because
288          * request handling may migrate from one server thread to another.
289          */
290         struct req_capsule        *mti_pill;
291
292         /* although we have export in req, there are cases when it is not
293          * available, e.g. closing files upon export destroy */
294         struct obd_export          *mti_exp;
295         /*
296          * A couple of lock handles.
297          */
298         struct mdt_lock_handle     mti_lh[MDT_LH_NR];
299
300         struct mdt_device         *mti_mdt;
301         const struct lu_env       *mti_env;
302
303         /*
304          * Additional fail id that can be set by handler. Passed to
305          * target_send_reply().
306          */
307         int                        mti_fail_id;
308
309         /* transaction number of current request */
310         __u64                      mti_transno;
311
312
313         /*
314          * XXX: Part Two:
315          * The following members will be filled expilictly
316          * with zero in mdt_thread_info_init(). These members may be used
317          * by all requests.
318          */
319
320         /*
321          * Object attributes.
322          */
323         struct md_attr             mti_attr;
324         /*
325          * Body for "habeo corpus" operations.
326          */
327         const struct mdt_body     *mti_body;
328         /*
329          * Host object. This is released at the end of mdt_handler().
330          */
331         struct mdt_object         *mti_object;
332         /*
333          * Lock request for "habeo clavis" operations.
334          */
335         const struct ldlm_request *mti_dlm_req;
336
337         __u32                      mti_has_trans:1, /* has txn already? */
338                                    mti_cross_ref:1;
339
340         /* opdata for mdt_reint_open(), has the same as
341          * ldlm_reply:lock_policy_res1.  mdt_update_last_rcvd() stores this
342          * value onto disk for recovery when mdt_trans_stop_cb() is called.
343          */
344         __u64                      mti_opdata;
345
346         /*
347          * XXX: Part Three:
348          * The following members will be filled explicitly
349          * with zero in mdt_reint_unpack(), because they are only used
350          * by reint requests (including mdt_reint_open()).
351          */
352
353         /*
354          * reint record. contains information for reint operations.
355          */
356         struct mdt_reint_record    mti_rr;
357
358         /** md objects included in operation */
359         struct mdt_object         *mti_mos;
360         __u64                      mti_ver[PTLRPC_NUM_VERSIONS];
361         /*
362          * Operation specification (currently create and lookup)
363          */
364         struct md_op_spec          mti_spec;
365
366         /*
367          * XXX: Part Four:
368          * The following members will _NOT_ be initialized at all.
369          * DO NOT expect them to contain any valid value.
370          * They should be initialized explicitly by the user themselves.
371          */
372
373          /* XXX: If something is in a union, make sure they do not conflict */
374
375         struct lu_fid              mti_tmp_fid1;
376         struct lu_fid              mti_tmp_fid2;
377         ldlm_policy_data_t         mti_policy;    /* for mdt_object_lock() and
378                                                    * mdt_rename_lock() */
379         struct ldlm_res_id         mti_res_id;    /* for mdt_object_lock() and
380                                                      mdt_rename_lock()   */
381         union {
382                 struct obd_uuid    uuid[2];       /* for mdt_seq_init_cli()  */
383                 char               ns_name[48];   /* for mdt_init0()         */
384                 struct lustre_cfg_bufs bufs;      /* for mdt_stack_fini()    */
385                 struct obd_statfs  osfs;          /* for mdt_statfs()        */
386                 struct {
387                         /* for mdt_readpage()      */
388                         struct lu_rdpg     mti_rdpg;
389                         /* for mdt_sendpage()      */
390                         struct l_wait_info mti_wait_info;
391                 } rdpg;
392                 struct {
393                         struct md_attr attr;
394                         struct md_som_data data;
395                 } som;
396         } mti_u;
397
398         /* IO epoch related stuff. */
399         struct mdt_ioepoch        *mti_ioepoch;
400         __u64                      mti_replayepoch;
401
402         loff_t                     mti_off;
403         struct lu_buf              mti_buf;
404         struct lustre_capa_key     mti_capa_key;
405
406         /* Ops object filename */
407         struct lu_name             mti_name;
408         /* per-thread values, can be re-used */
409         void                      *mti_big_lmm;
410         int                        mti_big_lmmsize;
411         /* big_lmm buffer was used and must be used in reply */
412         int                        mti_big_lmm_used;
413         /* should be enough to fit lustre_mdt_attrs */
414         char                       mti_xattr_buf[128];
415 };
416
417 /* ptlrpc request handler for MDT. All handlers are
418  * grouped into several slices - struct mdt_opc_slice,
419  * and stored in an array - mdt_handlers[].
420  */
421 struct mdt_handler {
422         /* The name of this handler. */
423         const char *mh_name;
424         /* Fail id for this handler, checked at the beginning of this handler*/
425         int      mh_fail_id;
426         /* Operation code for this handler */
427         __u32       mh_opc;
428         /* flags are listed in enum mdt_handler_flags below. */
429         __u32       mh_flags;
430         /* The actual handler function to execute. */
431         int (*mh_act)(struct mdt_thread_info *info);
432         /* Request format for this request. */
433         const struct req_format *mh_fmt;
434 };
435
436 enum mdt_handler_flags {
437         /*
438          * struct mdt_body is passed in the incoming message, and object
439          * identified by this fid exists on disk.
440          *
441          * "habeo corpus" == "I have a body"
442          */
443         HABEO_CORPUS = (1 << 0),
444         /*
445          * struct ldlm_request is passed in the incoming message.
446          *
447          * "habeo clavis" == "I have a key"
448          */
449         HABEO_CLAVIS = (1 << 1),
450         /*
451          * this request has fixed reply format, so that reply message can be
452          * packed by generic code.
453          *
454          * "habeo refero" == "I have a reply"
455          */
456         HABEO_REFERO = (1 << 2),
457         /*
458          * this request will modify something, so check whether the filesystem
459          * is readonly or not, then return -EROFS to client asap if necessary.
460          *
461          * "mutabor" == "I shall modify"
462          */
463         MUTABOR      = (1 << 3)
464 };
465
466 struct mdt_opc_slice {
467         __u32                   mos_opc_start;
468         int                     mos_opc_end;
469         struct mdt_handler      *mos_hs;
470 };
471
472 static inline const struct md_device_operations *
473 mdt_child_ops(struct mdt_device * m)
474 {
475         LASSERT(m->mdt_child);
476         return m->mdt_child->md_ops;
477 }
478
479 static inline struct md_object *mdt_object_child(struct mdt_object *o)
480 {
481         LASSERT(o);
482         return lu2md(lu_object_next(&o->mot_obj.mo_lu));
483 }
484
485 static inline struct ptlrpc_request *mdt_info_req(struct mdt_thread_info *info)
486 {
487          return info->mti_pill ? info->mti_pill->rc_req : NULL;
488 }
489
490 static inline int req_is_replay(struct ptlrpc_request *req)
491 {
492         LASSERT(req->rq_reqmsg);
493         return !!(lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY);
494 }
495
496 static inline __u64 mdt_conn_flags(struct mdt_thread_info *info)
497 {
498         LASSERT(info->mti_exp);
499         return info->mti_exp->exp_connect_flags;
500 }
501
502 static inline void mdt_object_get(const struct lu_env *env,
503                                   struct mdt_object *o)
504 {
505         ENTRY;
506         lu_object_get(&o->mot_obj.mo_lu);
507         EXIT;
508 }
509
510 static inline void mdt_object_put(const struct lu_env *env,
511                                   struct mdt_object *o)
512 {
513         ENTRY;
514         lu_object_put(env, &o->mot_obj.mo_lu);
515         EXIT;
516 }
517
518 static inline int mdt_object_exists(const struct mdt_object *o)
519 {
520         return lu_object_exists(&o->mot_obj.mo_lu);
521 }
522
523 static inline const struct lu_fid *mdt_object_fid(const struct mdt_object *o)
524 {
525         return lu_object_fid(&o->mot_obj.mo_lu);
526 }
527
528 static inline int mdt_object_obf(const struct mdt_object *o)
529 {
530         return lu_fid_eq(mdt_object_fid(o), &LU_OBF_FID);
531 }
532
533 static inline struct lu_site *mdt_lu_site(const struct mdt_device *mdt)
534 {
535         return mdt->mdt_md_dev.md_lu_dev.ld_site;
536 }
537
538 static inline struct seq_server_site *mdt_seq_site(struct mdt_device *mdt)
539 {
540         return &mdt->mdt_seq_site;
541 }
542
543 static inline void mdt_export_evict(struct obd_export *exp)
544 {
545         class_fail_export(exp);
546         class_export_put(exp);
547 }
548
549 int mdt_get_disposition(struct ldlm_reply *rep, int flag);
550 void mdt_set_disposition(struct mdt_thread_info *info,
551                         struct ldlm_reply *rep, int flag);
552 void mdt_clear_disposition(struct mdt_thread_info *info,
553                         struct ldlm_reply *rep, int flag);
554
555 void mdt_lock_pdo_init(struct mdt_lock_handle *lh,
556                        ldlm_mode_t lm, const char *name,
557                        int namelen);
558
559 void mdt_lock_reg_init(struct mdt_lock_handle *lh,
560                        ldlm_mode_t lm);
561
562 int mdt_lock_setup(struct mdt_thread_info *info,
563                    struct mdt_object *o,
564                    struct mdt_lock_handle *lh);
565
566 int mdt_object_lock(struct mdt_thread_info *,
567                     struct mdt_object *,
568                     struct mdt_lock_handle *,
569                     __u64, int);
570
571 int mdt_object_lock_try(struct mdt_thread_info *,
572                         struct mdt_object *,
573                         struct mdt_lock_handle *,
574                         __u64, int);
575
576 void mdt_object_unlock(struct mdt_thread_info *,
577                        struct mdt_object *,
578                        struct mdt_lock_handle *,
579                        int decref);
580
581 struct mdt_object *mdt_object_new(const struct lu_env *,
582                                   struct mdt_device *,
583                                   const struct lu_fid *);
584 struct mdt_object *mdt_object_find(const struct lu_env *,
585                                    struct mdt_device *,
586                                    const struct lu_fid *);
587 struct mdt_object *mdt_object_find_lock(struct mdt_thread_info *,
588                                         const struct lu_fid *,
589                                         struct mdt_lock_handle *,
590                                         __u64);
591 void mdt_object_unlock_put(struct mdt_thread_info *,
592                            struct mdt_object *,
593                            struct mdt_lock_handle *,
594                            int decref);
595
596 void mdt_client_compatibility(struct mdt_thread_info *info);
597
598 int mdt_close_unpack(struct mdt_thread_info *info);
599 int mdt_reint_unpack(struct mdt_thread_info *info, __u32 op);
600 int mdt_reint_rec(struct mdt_thread_info *, struct mdt_lock_handle *);
601 void mdt_pack_attr2body(struct mdt_thread_info *info, struct mdt_body *b,
602                         const struct lu_attr *attr, const struct lu_fid *fid);
603
604 int mdt_getxattr(struct mdt_thread_info *info);
605 int mdt_reint_setxattr(struct mdt_thread_info *info,
606                        struct mdt_lock_handle *lh);
607
608 void mdt_lock_handle_init(struct mdt_lock_handle *lh);
609 void mdt_lock_handle_fini(struct mdt_lock_handle *lh);
610
611 void mdt_reconstruct(struct mdt_thread_info *, struct mdt_lock_handle *);
612 void mdt_reconstruct_generic(struct mdt_thread_info *mti,
613                              struct mdt_lock_handle *lhc);
614
615 extern void target_recovery_fini(struct obd_device *obd);
616 extern void target_recovery_init(struct lu_target *lut,
617                                  svc_handler_t handler);
618 int mdt_fs_setup(const struct lu_env *, struct mdt_device *,
619                  struct obd_device *, struct lustre_sb_info *lsi);
620 void mdt_fs_cleanup(const struct lu_env *, struct mdt_device *);
621
622 int mdt_export_stats_init(struct obd_device *obd,
623                           struct obd_export *exp,
624                           void *client_nid);
625
626 int mdt_pin(struct mdt_thread_info* info);
627
628 int mdt_lock_new_child(struct mdt_thread_info *info,
629                        struct mdt_object *o,
630                        struct mdt_lock_handle *child_lockh);
631
632 void mdt_mfd_set_mode(struct mdt_file_data *mfd,
633                       int mode);
634
635 int mdt_reint_open(struct mdt_thread_info *info,
636                    struct mdt_lock_handle *lhc);
637
638 struct mdt_file_data *mdt_handle2mfd(struct mdt_thread_info *,
639                                      const struct lustre_handle *);
640
641 enum {
642         MDT_IOEPOCH_CLOSED  = 0,
643         MDT_IOEPOCH_OPENED  = 1,
644         MDT_IOEPOCH_GETATTR = 2,
645 };
646
647 enum {
648         MDT_SOM_DISABLE = 0,
649         MDT_SOM_ENABLE  = 1,
650 };
651
652 int mdt_attr_get_complex(struct mdt_thread_info *info,
653                          struct mdt_object *o, struct md_attr *ma);
654 int mdt_ioepoch_open(struct mdt_thread_info *info, struct mdt_object *o,
655                      int created);
656 int mdt_object_is_som_enabled(struct mdt_object *mo);
657 int mdt_write_get(struct mdt_object *o);
658 void mdt_write_put(struct mdt_object *o);
659 int mdt_write_read(struct mdt_object *o);
660 struct mdt_file_data *mdt_mfd_new(void);
661 int mdt_mfd_close(struct mdt_thread_info *info, struct mdt_file_data *mfd);
662 void mdt_mfd_free(struct mdt_file_data *mfd);
663 int mdt_close(struct mdt_thread_info *info);
664 int mdt_attr_set(struct mdt_thread_info *info, struct mdt_object *mo,
665                  struct md_attr *ma, int flags);
666 int mdt_add_dirty_flag(struct mdt_thread_info *info, struct mdt_object *mo,
667                         struct md_attr *ma);
668 int mdt_done_writing(struct mdt_thread_info *info);
669 int mdt_fix_reply(struct mdt_thread_info *info);
670 int mdt_handle_last_unlink(struct mdt_thread_info *, struct mdt_object *,
671                            const struct md_attr *);
672 void mdt_reconstruct_open(struct mdt_thread_info *, struct mdt_lock_handle *);
673
674 struct lu_buf *mdt_buf(const struct lu_env *env, void *area, ssize_t len);
675 const struct lu_buf *mdt_buf_const(const struct lu_env *env,
676                                    const void *area, ssize_t len);
677
678 void mdt_dump_lmm(int level, const struct lov_mds_md *lmm);
679
680 int mdt_check_ucred(struct mdt_thread_info *);
681 int mdt_init_ucred(struct mdt_thread_info *, struct mdt_body *);
682 int mdt_init_ucred_reint(struct mdt_thread_info *);
683 void mdt_exit_ucred(struct mdt_thread_info *);
684 int mdt_version_get_check(struct mdt_thread_info *, struct mdt_object *, int);
685 void mdt_version_get_save(struct mdt_thread_info *, struct mdt_object *, int);
686 int mdt_version_get_check_save(struct mdt_thread_info *, struct mdt_object *,
687                                int);
688 int mdt_handle_common(struct ptlrpc_request *req,
689                       struct mdt_opc_slice *supported);
690 int mdt_connect(struct mdt_thread_info *info);
691 int mdt_disconnect(struct mdt_thread_info *info);
692 int mdt_set_info(struct mdt_thread_info *info);
693 int mdt_get_info(struct mdt_thread_info *info);
694 int mdt_getstatus(struct mdt_thread_info *info);
695 int mdt_getattr(struct mdt_thread_info *info);
696 int mdt_getattr_name(struct mdt_thread_info *info);
697 int mdt_statfs(struct mdt_thread_info *info);
698 int mdt_reint(struct mdt_thread_info *info);
699 int mdt_sync(struct mdt_thread_info *info);
700 int mdt_is_subdir(struct mdt_thread_info *info);
701 int mdt_obd_ping(struct mdt_thread_info *info);
702 int mdt_obd_log_cancel(struct mdt_thread_info *info);
703 int mdt_obd_qc_callback(struct mdt_thread_info *info);
704 int mdt_enqueue(struct mdt_thread_info *info);
705 int mdt_convert(struct mdt_thread_info *info);
706 int mdt_bl_callback(struct mdt_thread_info *info);
707 int mdt_cp_callback(struct mdt_thread_info *info);
708 int mdt_llog_create(struct mdt_thread_info *info);
709 int mdt_llog_destroy(struct mdt_thread_info *info);
710 int mdt_llog_read_header(struct mdt_thread_info *info);
711 int mdt_llog_next_block(struct mdt_thread_info *info);
712 int mdt_llog_prev_block(struct mdt_thread_info *info);
713 int mdt_sec_ctx_handle(struct mdt_thread_info *info);
714 int mdt_readpage(struct mdt_thread_info *info);
715 int mdt_obd_idx_read(struct mdt_thread_info *info);
716
717 extern struct mdt_opc_slice mdt_regular_handlers[];
718 extern struct mdt_opc_slice mdt_seq_handlers[];
719 extern struct mdt_opc_slice mdt_fld_handlers[];
720
721 int mdt_quotacheck(struct mdt_thread_info *info);
722 int mdt_quotactl(struct mdt_thread_info *info);
723 int mdt_quota_dqacq(struct mdt_thread_info *info);
724
725 extern struct lprocfs_vars lprocfs_mds_module_vars[];
726 extern struct lprocfs_vars lprocfs_mds_obd_vars[];
727
728 int mdt_hsm_attr_set(struct mdt_thread_info *info, struct mdt_object *obj,
729                      struct md_hsm *mh);
730
731 /* mdt_idmap.c */
732 int mdt_init_sec_level(struct mdt_thread_info *);
733 int mdt_init_idmap(struct mdt_thread_info *);
734 void mdt_cleanup_idmap(struct mdt_export_data *);
735 int mdt_handle_idmap(struct mdt_thread_info *);
736 int ptlrpc_user_desc_do_idmap(struct ptlrpc_request *,
737                               struct ptlrpc_user_desc *);
738 void mdt_body_reverse_idmap(struct mdt_thread_info *,
739                             struct mdt_body *);
740 int mdt_remote_perm_reverse_idmap(struct ptlrpc_request *,
741                                   struct mdt_remote_perm *);
742 int mdt_fix_attr_ucred(struct mdt_thread_info *, __u32);
743
744 static inline struct mdt_device *mdt_dev(struct lu_device *d)
745 {
746 //        LASSERT(lu_device_is_mdt(d));
747         return container_of0(d, struct mdt_device, mdt_md_dev.md_lu_dev);
748 }
749
750 static inline struct dt_object *mdt_obj2dt(struct mdt_object *mo)
751 {
752         struct lu_object *lo;
753         struct mdt_device *mdt = mdt_dev(mo->mot_obj.mo_lu.lo_dev);
754
755         lo = lu_object_locate(mo->mot_obj.mo_lu.lo_header,
756                               mdt->mdt_bottom->dd_lu_dev.ld_type);
757         return lu2dt(lo);
758 }
759
760 /* mdt/mdt_identity.c */
761 #define MDT_IDENTITY_UPCALL_PATH        "/usr/sbin/l_getidentity"
762
763 extern struct upcall_cache_ops mdt_identity_upcall_cache_ops;
764
765 struct md_identity *mdt_identity_get(struct upcall_cache *, __u32);
766
767 void mdt_identity_put(struct upcall_cache *, struct md_identity *);
768
769 void mdt_flush_identity(struct upcall_cache *, int);
770
771 __u32 mdt_identity_get_perm(struct md_identity *, __u32, lnet_nid_t);
772
773 int mdt_pack_remote_perm(struct mdt_thread_info *, struct mdt_object *, void *);
774
775 /* mdt/mdt_hsm.c */
776 int mdt_hsm_progress(struct mdt_thread_info *info);
777 int mdt_hsm_ct_register(struct mdt_thread_info *info);
778 int mdt_hsm_ct_unregister(struct mdt_thread_info *info);
779
780 extern struct lu_context_key       mdt_thread_key;
781 /* debug issues helper starts here*/
782 static inline int mdt_fail_write(const struct lu_env *env,
783                                  struct dt_device *dd, int id)
784 {
785         if (OBD_FAIL_CHECK_ORSET(id, OBD_FAIL_ONCE)) {
786                 CERROR(LUSTRE_MDT_NAME": cfs_fail_loc=%x, fail write ops\n",
787                        id);
788                 return dd->dd_ops->dt_ro(env, dd);
789                 /* We set FAIL_ONCE because we never "un-fail" a device */
790         }
791
792         return 0;
793 }
794
795 static inline struct mdt_export_data *mdt_req2med(struct ptlrpc_request *req)
796 {
797         return &req->rq_export->exp_mdt_data;
798 }
799
800 typedef void (*mdt_reconstruct_t)(struct mdt_thread_info *mti,
801                                   struct mdt_lock_handle *lhc);
802 static inline int mdt_check_resent(struct mdt_thread_info *info,
803                                    mdt_reconstruct_t reconstruct,
804                                    struct mdt_lock_handle *lhc)
805 {
806         struct ptlrpc_request *req = mdt_info_req(info);
807         ENTRY;
808
809         if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) {
810                 if (req_xid_is_last(req)) {
811                         reconstruct(info, lhc);
812                         RETURN(1);
813                 }
814                 DEBUG_REQ(D_HA, req, "no reply for RESENT req (have "LPD64")",
815                           req->rq_export->exp_target_data.ted_lcd->lcd_last_xid);
816         }
817         RETURN(0);
818 }
819
820 struct lu_ucred *mdt_ucred(const struct mdt_thread_info *info);
821 struct lu_ucred *mdt_ucred_check(const struct mdt_thread_info *info);
822
823 static inline int is_identity_get_disabled(struct upcall_cache *cache)
824 {
825         return cache ? (strcmp(cache->uc_upcall, "NONE") == 0) : 1;
826 }
827
828 int mdt_blocking_ast(struct ldlm_lock*, struct ldlm_lock_desc*, void*, int);
829
830 /* Issues dlm lock on passed @ns, @f stores it lock handle into @lh. */
831 static inline int mdt_fid_lock(struct ldlm_namespace *ns,
832                                struct lustre_handle *lh,
833                                ldlm_mode_t mode,
834                                ldlm_policy_data_t *policy,
835                                const struct ldlm_res_id *res_id,
836                                __u64 flags, const __u64 *client_cookie)
837 {
838         int rc;
839
840         LASSERT(ns != NULL);
841         LASSERT(lh != NULL);
842
843         rc = ldlm_cli_enqueue_local(ns, res_id, LDLM_IBITS, policy,
844                                     mode, &flags, mdt_blocking_ast,
845                                     ldlm_completion_ast, NULL, NULL, 0,
846                                     LVB_T_NONE, client_cookie, lh);
847         return rc == ELDLM_OK ? 0 : -EIO;
848 }
849
850 static inline void mdt_fid_unlock(struct lustre_handle *lh,
851                                   ldlm_mode_t mode)
852 {
853         ldlm_lock_decref(lh, mode);
854 }
855
856 extern mdl_mode_t mdt_mdl_lock_modes[];
857 extern ldlm_mode_t mdt_dlm_lock_modes[];
858
859 static inline mdl_mode_t mdt_dlm_mode2mdl_mode(ldlm_mode_t mode)
860 {
861         LASSERT(IS_PO2(mode));
862         return mdt_mdl_lock_modes[mode];
863 }
864
865 static inline ldlm_mode_t mdt_mdl_mode2dlm_mode(mdl_mode_t mode)
866 {
867         LASSERT(IS_PO2(mode));
868         return mdt_dlm_lock_modes[mode];
869 }
870
871 /* mdt_lvb.c */
872 extern struct ldlm_valblock_ops mdt_lvbo;
873
874 static inline struct lu_name *mdt_name(const struct lu_env *env,
875                                        char *name, int namelen)
876 {
877         struct lu_name *lname;
878         struct mdt_thread_info *mti;
879
880         LASSERT(namelen > 0);
881         /* trailing '\0' in buffer */
882         LASSERT(name[namelen] == '\0');
883
884         mti = lu_context_key_get(&env->le_ctx, &mdt_thread_key);
885         lname = &mti->mti_name;
886         lname->ln_name = name;
887         lname->ln_namelen = namelen;
888         return lname;
889 }
890
891 static inline struct lu_name *mdt_name_copy(struct lu_name *tlname,
892                                             struct lu_name *slname)
893 {
894         LASSERT(tlname);
895         LASSERT(slname);
896
897         tlname->ln_name = slname->ln_name;
898         tlname->ln_namelen = slname->ln_namelen;
899         return tlname;
900 }
901
902 void mdt_enable_cos(struct mdt_device *, int);
903 int mdt_cos_is_enabled(struct mdt_device *);
904 int mdt_hsm_copytool_send(struct obd_export *exp);
905
906 /* lprocfs stuff */
907 enum {
908         LPROC_MDT_OPEN = 0,
909         LPROC_MDT_CLOSE,
910         LPROC_MDT_MKNOD,
911         LPROC_MDT_LINK,
912         LPROC_MDT_UNLINK,
913         LPROC_MDT_MKDIR,
914         LPROC_MDT_RMDIR,
915         LPROC_MDT_RENAME,
916         LPROC_MDT_GETATTR,
917         LPROC_MDT_SETATTR,
918         LPROC_MDT_GETXATTR,
919         LPROC_MDT_SETXATTR,
920         LPROC_MDT_STATFS,
921         LPROC_MDT_SYNC,
922         LPROC_MDT_SAMEDIR_RENAME,
923         LPROC_MDT_CROSSDIR_RENAME,
924         LPROC_MDT_LAST,
925 };
926 void mdt_counter_incr(struct ptlrpc_request *req, int opcode);
927 void mdt_stats_counter_init(struct lprocfs_stats *stats);
928 void lprocfs_mdt_init_vars(struct lprocfs_static_vars *lvars);
929 void lprocfs_mds_init_vars(struct lprocfs_static_vars *lvars);
930 int mdt_procfs_init(struct mdt_device *mdt, const char *name);
931 int mdt_procfs_fini(struct mdt_device *mdt);
932 void mdt_rename_counter_tally(struct mdt_thread_info *info,
933                               struct mdt_device *mdt,
934                               struct ptlrpc_request *req,
935                               struct mdt_object *src, struct mdt_object *tgt);
936
937 /* Capability */
938 int mdt_ck_thread_start(struct mdt_device *mdt);
939 void mdt_ck_thread_stop(struct mdt_device *mdt);
940 void mdt_ck_timer_callback(unsigned long castmeharder);
941 int mdt_capa_keys_init(const struct lu_env *env, struct mdt_device *mdt);
942
943 static inline void mdt_set_capainfo(struct mdt_thread_info *info, int offset,
944                                     const struct lu_fid *fid,
945                                     struct lustre_capa *capa)
946 {
947         struct md_capainfo *ci;
948
949         LASSERT(offset >= 0 && offset < MD_CAPAINFO_MAX);
950         if (!info->mti_mdt->mdt_opts.mo_mds_capa ||
951             !(info->mti_exp->exp_connect_flags & OBD_CONNECT_MDS_CAPA))
952                 return;
953
954         ci = md_capainfo(info->mti_env);
955         LASSERT(ci);
956         ci->mc_fid[offset]  = *fid;
957         ci->mc_capa[offset] = capa;
958 }
959
960 static inline void mdt_dump_capainfo(struct mdt_thread_info *info)
961 {
962         struct md_capainfo *ci = md_capainfo(info->mti_env);
963         int i;
964
965         if (!ci)
966                 return;
967         for (i = 0; i < MD_CAPAINFO_MAX; i++) {
968                 if (!ci->mc_capa[i]) {
969                         CERROR("no capa for index %d "DFID"\n",
970                                i, PFID(&ci->mc_fid[i]));
971                         continue;
972                 }
973                 if (ci->mc_capa[i] == BYPASS_CAPA) {
974                         CERROR("bypass for index %d "DFID"\n",
975                                i, PFID(&ci->mc_fid[i]));
976                         continue;
977                 }
978                 DEBUG_CAPA(D_ERROR, ci->mc_capa[i], "index %d", i);
979         }
980 }
981
982 static inline struct obd_device *mdt2obd_dev(const struct mdt_device *mdt)
983 {
984         return mdt->mdt_md_dev.md_lu_dev.ld_obd;
985 }
986
987 extern const struct lu_device_operations mdt_lu_ops;
988
989 static inline int lu_device_is_mdt(struct lu_device *d)
990 {
991         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &mdt_lu_ops);
992 }
993
994 static inline struct mdt_device *lu2mdt_dev(struct lu_device *d)
995 {
996         LASSERTF(lu_device_is_mdt(d), "It is %s instead of MDT %p %p\n",
997                  d->ld_type->ldt_name, d->ld_ops, &mdt_lu_ops);
998         return container_of0(d, struct mdt_device, mdt_md_dev.md_lu_dev);
999 }
1000
1001 static inline char *mdt_obd_name(struct mdt_device *mdt)
1002 {
1003         return mdt->mdt_md_dev.md_lu_dev.ld_obd->obd_name;
1004 }
1005
1006 int mds_mod_init(void);
1007 void mds_mod_exit(void);
1008
1009 #endif /* __KERNEL__ */
1010 #endif /* _MDT_H */