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