Whamcloud - gitweb
LU-6971 cleanup: not support remote client anymore
[fs/lustre-release.git] / lustre / include / obd_class.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, 2015, 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 #ifndef __CLASS_OBD_H
37 #define __CLASS_OBD_H
38
39
40 #include <obd_support.h>
41 #include <lustre_import.h>
42 #include <lustre_net.h>
43 #include <obd.h>
44 #include <lustre_lib.h>
45 #include <lustre/lustre_idl.h>
46 #include <lprocfs_status.h>
47
48 #define OBD_STATFS_NODELAY      0x0001  /* requests should be send without delay
49                                          * and resends for avoid deadlocks */
50 #define OBD_STATFS_FROM_CACHE   0x0002  /* the statfs callback should not update
51                                          * obd_osfs_age */
52 #define OBD_STATFS_PTLRPCD      0x0004  /* requests will be sent via ptlrpcd
53                                          * instead of a specific set. This
54                                          * means that we cannot rely on the set
55                                          * interpret routine to be called.
56                                          * lov_statfs_fini() must thus be called
57                                          * by the request interpret routine */
58 #define OBD_STATFS_FOR_MDT0     0x0008  /* The statfs is only for retrieving
59                                          * information from MDT0. */
60
61 /* OBD Device Declarations */
62 extern struct obd_device *obd_devs[MAX_OBD_DEVICES];
63 extern struct list_head obd_types;
64 extern spinlock_t obd_types_lock;
65 extern rwlock_t obd_dev_lock;
66
67 /* OBD Operations Declarations */
68 extern struct obd_device *class_conn2obd(struct lustre_handle *);
69 extern struct obd_device *class_exp2obd(struct obd_export *);
70 extern int class_handle_ioctl(unsigned int cmd, unsigned long arg);
71 extern int lustre_get_jobid(char *jobid);
72
73 struct lu_device_type;
74
75 /* genops.c */
76 struct obd_export *class_conn2export(struct lustre_handle *);
77 int class_register_type(struct obd_ops *, struct md_ops *, bool enable_proc,
78                         struct lprocfs_vars *module_vars,
79                         const char *nm, struct lu_device_type *ldt);
80 int class_unregister_type(const char *nm);
81
82 struct obd_device *class_newdev(const char *type_name, const char *name);
83 void class_release_dev(struct obd_device *obd);
84
85 int class_name2dev(const char *name);
86 struct obd_device *class_name2obd(const char *name);
87 int class_uuid2dev(struct obd_uuid *uuid);
88 struct obd_device *class_uuid2obd(struct obd_uuid *uuid);
89 void class_obd_list(void);
90 struct obd_device * class_find_client_obd(struct obd_uuid *tgt_uuid,
91                                           const char * typ_name,
92                                           struct obd_uuid *grp_uuid);
93 struct obd_device * class_devices_in_group(struct obd_uuid *grp_uuid,
94                                            int *next);
95 struct obd_device * class_num2obd(int num);
96 int get_devices_count(void);
97
98 int class_notify_sptlrpc_conf(const char *fsname, int namelen);
99
100 char *obd_export_nid2str(struct obd_export *exp);
101
102 int obd_export_evict_by_nid(struct obd_device *obd, const char *nid);
103 int obd_export_evict_by_uuid(struct obd_device *obd, const char *uuid);
104 int obd_connect_flags2str(char *page, int count, __u64 flags, __u64 flags2,
105                           const char *sep);
106
107 int obd_zombie_impexp_init(void);
108 void obd_zombie_impexp_stop(void);
109 void obd_zombie_impexp_cull(void);
110 void obd_zombie_barrier(void);
111 void obd_exports_barrier(struct obd_device *obd);
112 int kuc_len(int payload_len);
113 struct kuc_hdr * kuc_ptr(void *p);
114 void *kuc_alloc(int payload_len, int transport, int type);
115 void kuc_free(void *p, int payload_len);
116 int obd_get_request_slot(struct client_obd *cli);
117 void obd_put_request_slot(struct client_obd *cli);
118 __u32 obd_get_max_rpcs_in_flight(struct client_obd *cli);
119 int obd_set_max_rpcs_in_flight(struct client_obd *cli, __u32 max);
120 __u16 obd_get_max_mod_rpcs_in_flight(struct client_obd *cli);
121 int obd_set_max_mod_rpcs_in_flight(struct client_obd *cli, __u16 max);
122 int obd_mod_rpc_stats_seq_show(struct client_obd *cli, struct seq_file *seq);
123
124 __u16 obd_get_mod_rpc_slot(struct client_obd *cli, __u32 opc,
125                            struct lookup_intent *it);
126 void obd_put_mod_rpc_slot(struct client_obd *cli, __u32 opc,
127                           struct lookup_intent *it, __u16 tag);
128
129 struct llog_handle;
130 struct llog_rec_hdr;
131 typedef int (*llog_cb_t)(const struct lu_env *, struct llog_handle *,
132                          struct llog_rec_hdr *, void *);
133
134 extern atomic_t         obd_stale_export_num;
135 extern struct list_head obd_stale_exports;
136 extern spinlock_t       obd_stale_export_lock;
137
138 struct obd_export *obd_stale_export_get(void);
139 void obd_stale_export_put(struct obd_export *exp);
140 void obd_stale_export_adjust(struct obd_export *exp);
141
142 /* obd_config.c */
143 struct lustre_cfg *lustre_cfg_rename(struct lustre_cfg *cfg,
144                                      const char *new_name);
145 int class_process_config(struct lustre_cfg *lcfg);
146 int class_process_proc_param(char *prefix, struct lprocfs_vars *lvars,
147                              struct lustre_cfg *lcfg, void *data);
148 int class_attach(struct lustre_cfg *lcfg);
149 int class_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
150 int class_cleanup(struct obd_device *obd, struct lustre_cfg *lcfg);
151 int class_detach(struct obd_device *obd, struct lustre_cfg *lcfg);
152 struct obd_device *class_incref(struct obd_device *obd,
153                                 const char *scope, const void *source);
154 void class_decref(struct obd_device *obd,
155                   const char *scope, const void *source);
156 void dump_exports(struct obd_device *obd, int locks);
157 int class_config_llog_handler(const struct lu_env *env,
158                               struct llog_handle *handle,
159                               struct llog_rec_hdr *rec, void *data);
160 int class_add_conn(struct obd_device *obd, struct lustre_cfg *lcfg);
161 int class_add_uuid(const char *uuid, __u64 nid);
162
163 #define CFG_F_START     0x01   /* Set when we start updating from a log */
164 #define CFG_F_MARKER    0x02   /* We are within a maker */
165 #define CFG_F_SKIP      0x04   /* We should ignore this cfg command */
166 #define CFG_F_COMPAT146 0x08   /* Allow old-style logs */
167 #define CFG_F_EXCLUDE   0x10   /* OST exclusion list */
168
169 /* Passed as data param to class_config_parse_llog */
170 struct config_llog_instance {
171         char                    *cfg_obdname;
172         void                    *cfg_instance;
173         struct super_block      *cfg_sb;
174         struct obd_uuid          cfg_uuid;
175         llog_cb_t                cfg_callback;
176         int                      cfg_last_idx; /* for partial llog processing */
177         int                      cfg_flags;
178         __u32                    cfg_lwp_idx;
179 };
180 int class_config_parse_llog(const struct lu_env *env, struct llog_ctxt *ctxt,
181                             char *name, struct config_llog_instance *cfg);
182
183 enum {
184         CONFIG_T_CONFIG  = 0,
185         CONFIG_T_SPTLRPC = 1,
186         CONFIG_T_RECOVER = 2,
187         CONFIG_T_PARAMS  = 3,
188         CONFIG_T_NODEMAP = 4,
189         CONFIG_T_MAX     = 5
190 };
191
192 #define PARAMS_FILENAME         "params"
193 #define LCTL_UPCALL             "lctl"
194
195 /* list of active configuration logs  */
196 struct config_llog_data {
197         struct ldlm_res_id          cld_resid;
198         struct config_llog_instance cld_cfg;
199         struct list_head            cld_list_chain;
200         atomic_t                    cld_refcount;
201         struct config_llog_data    *cld_sptlrpc;/* depended sptlrpc log */
202         struct config_llog_data    *cld_params; /* common parameters log */
203         struct config_llog_data    *cld_recover;/* imperative recover log */
204         struct config_llog_data    *cld_nodemap;/* nodemap log */
205         struct obd_export          *cld_mgcexp;
206         struct mutex                cld_lock;
207         int                         cld_type;
208         unsigned int                cld_stopping:1, /* we were told to stop
209                                                      * watching */
210                                     cld_lostlock:1; /* lock not requeued */
211         char                        cld_logname[0];
212 };
213
214 struct lustre_profile {
215         struct list_head         lp_list;
216         char                    *lp_profile;
217         char                    *lp_dt;
218         char                    *lp_md;
219         int                      lp_refs;
220         bool                     lp_list_deleted;
221 };
222
223 struct lustre_profile *class_get_profile(const char * prof);
224 void class_del_profile(const char *prof);
225 void class_put_profile(struct lustre_profile *lprof);
226 void class_del_profiles(void);
227
228
229 #if LUSTRE_TRACKS_LOCK_EXP_REFS
230
231 void __class_export_add_lock_ref(struct obd_export *, struct ldlm_lock *);
232 void __class_export_del_lock_ref(struct obd_export *, struct ldlm_lock *);
233 extern void (*class_export_dump_hook)(struct obd_export *);
234
235 #else
236
237 #define __class_export_add_lock_ref(exp, lock)             do {} while(0)
238 #define __class_export_del_lock_ref(exp, lock)             do {} while(0)
239
240 #endif
241
242 #define class_export_rpc_inc(exp)                                       \
243 ({                                                                      \
244         atomic_inc(&(exp)->exp_rpc_count);                              \
245         CDEBUG(D_INFO, "RPC GETting export %p : new rpc_count %d\n",    \
246                (exp), atomic_read(&(exp)->exp_rpc_count));              \
247 })
248
249 #define class_export_rpc_dec(exp)                                       \
250 ({                                                                      \
251         LASSERT_ATOMIC_POS(&exp->exp_rpc_count);                        \
252         atomic_dec(&(exp)->exp_rpc_count);                              \
253         CDEBUG(D_INFO, "RPC PUTting export %p : new rpc_count %d\n",    \
254                (exp), atomic_read(&(exp)->exp_rpc_count));              \
255 })
256
257 #define class_export_lock_get(exp, lock)                                \
258 ({                                                                      \
259         atomic_inc(&(exp)->exp_locks_count);                            \
260         __class_export_add_lock_ref(exp, lock);                         \
261         CDEBUG(D_INFO, "lock GETting export %p : new locks_count %d\n", \
262                (exp), atomic_read(&(exp)->exp_locks_count));            \
263         class_export_get(exp);                                          \
264 })
265
266 #define class_export_lock_put(exp, lock)                                \
267 ({                                                                      \
268         LASSERT_ATOMIC_POS(&exp->exp_locks_count);                      \
269         atomic_dec(&(exp)->exp_locks_count);                            \
270         __class_export_del_lock_ref(exp, lock);                         \
271         CDEBUG(D_INFO, "lock PUTting export %p : new locks_count %d\n", \
272                (exp), atomic_read(&(exp)->exp_locks_count));            \
273         class_export_put(exp);                                          \
274 })
275
276 #define class_export_cb_get(exp)                                        \
277 ({                                                                      \
278         atomic_inc(&(exp)->exp_cb_count);                               \
279         CDEBUG(D_INFO, "callback GETting export %p : new cb_count %d\n",\
280                (exp), atomic_read(&(exp)->exp_cb_count));               \
281         class_export_get(exp);                                          \
282 })
283
284 #define class_export_cb_put(exp)                                        \
285 ({                                                                      \
286         LASSERT_ATOMIC_POS(&exp->exp_cb_count);                         \
287         atomic_dec(&(exp)->exp_cb_count);                               \
288         CDEBUG(D_INFO, "callback PUTting export %p : new cb_count %d\n",\
289                (exp), atomic_read(&(exp)->exp_cb_count));               \
290         class_export_put(exp);                                          \
291 })
292
293 /* genops.c */
294 struct obd_export *class_export_get(struct obd_export *exp);
295 void class_export_put(struct obd_export *exp);
296 struct obd_export *class_new_export(struct obd_device *obddev,
297                                     struct obd_uuid *cluuid);
298 void class_unlink_export(struct obd_export *exp);
299
300 struct obd_import *class_import_get(struct obd_import *);
301 void class_import_put(struct obd_import *);
302 struct obd_import *class_new_import(struct obd_device *obd);
303 void class_destroy_import(struct obd_import *exp);
304
305 struct obd_type *class_search_type(const char *name);
306 struct obd_type *class_get_type(const char *name);
307 void class_put_type(struct obd_type *type);
308 int class_connect(struct lustre_handle *conn, struct obd_device *obd,
309                   struct obd_uuid *cluuid);
310 int class_disconnect(struct obd_export *exp);
311 void class_fail_export(struct obd_export *exp);
312 int class_connected_export(struct obd_export *exp);
313 void class_disconnect_exports(struct obd_device *obddev);
314 int class_manual_cleanup(struct obd_device *obd);
315 void class_disconnect_stale_exports(struct obd_device *,
316                                     int (*test_export)(struct obd_export *));
317 static inline enum obd_option exp_flags_from_obd(struct obd_device *obd)
318 {
319         return ((obd->obd_fail ? OBD_OPT_FAILOVER : 0) |
320                 (obd->obd_force ? OBD_OPT_FORCE : 0) |
321                 (obd->obd_abort_recovery ? OBD_OPT_ABORT_RECOV : 0) |
322                 0);
323 }
324
325 #ifdef HAVE_SERVER_SUPPORT
326 static inline struct lu_target *class_exp2tgt(struct obd_export *exp)
327 {
328         LASSERT(exp->exp_obd);
329         if (exp->exp_obd->u.obt.obt_magic != OBT_MAGIC)
330                 return NULL;
331         return exp->exp_obd->u.obt.obt_lut;
332 }
333
334 static inline struct lr_server_data *class_server_data(struct obd_device *obd)
335 {
336         LASSERT(obd->u.obt.obt_lut);
337         return &obd->u.obt.obt_lut->lut_lsd;
338 }
339 #endif
340
341 /* obdo.c */
342 struct lu_attr;
343 struct inode;
344
345 void obdo_from_la(struct obdo *dst, const struct lu_attr *la, u64 valid);
346 void la_from_obdo(struct lu_attr *la, const struct obdo *dst, u64 valid);
347
348 void obdo_cpy_md(struct obdo *dst, const struct obdo *src, u64 valid);
349 void obdo_to_ioobj(const struct obdo *oa, struct obd_ioobj *ioobj);
350
351 #define OBT(dev)        (dev)->obd_type
352 #define OBP(dev, op)    (dev)->obd_type->typ_dt_ops->o_ ## op
353 #define MDP(dev, op)    (dev)->obd_type->typ_md_ops->m_ ## op
354 #define CTXTP(ctxt, op) (ctxt)->loc_logops->lop_##op
355
356 /* Ensure obd_setup: used for cleanup which must be called
357    while obd is stopping */
358 #define OBD_CHECK_DEV(obd)                                      \
359 do {                                                            \
360         if (!(obd)) {                                           \
361                 CERROR("NULL device\n");                        \
362                 RETURN(-ENODEV);                                \
363         }                                                       \
364 } while (0)
365
366 /* ensure obd_setup and !obd_stopping */
367 #define OBD_CHECK_DEV_ACTIVE(obd)                               \
368 do {                                                            \
369         OBD_CHECK_DEV(obd);                                     \
370         if (!(obd)->obd_set_up || (obd)->obd_stopping) {        \
371                 CERROR("Device %d not setup\n",                 \
372                        (obd)->obd_minor);                       \
373                 RETURN(-ENODEV);                                \
374         }                                                       \
375 } while (0)
376
377
378 #ifdef CONFIG_PROC_FS
379 #define OBD_COUNTER_OFFSET(op)                                                 \
380         ((offsetof(struct obd_ops, o_ ## op) -                                 \
381           offsetof(struct obd_ops, o_iocontrol))                               \
382          / sizeof(((struct obd_ops *)NULL)->o_iocontrol))
383
384 /* The '- 1' below is for o_owner. */
385 #define NUM_OBD_STATS                                                          \
386         (sizeof(struct obd_ops) /                                              \
387          sizeof(((struct obd_ops *)NULL)->o_iocontrol) - 1)
388
389 #define OBD_COUNTER_INCREMENT(obd, op)                                         \
390         lprocfs_counter_incr((obd)->obd_stats,                                 \
391                              (obd)->obd_cntr_base + OBD_COUNTER_OFFSET(op))
392
393 #define EXP_COUNTER_INCREMENT(exp, op)                                         \
394         do {                                                                   \
395                 unsigned int _off;                                             \
396                 _off = (exp)->exp_obd->obd_cntr_base + OBD_COUNTER_OFFSET(op); \
397                 lprocfs_counter_incr((exp)->exp_obd->obd_stats, _off);         \
398                 if ((exp)->exp_obd->obd_uses_nid_stats &&                      \
399                     (exp)->exp_nid_stats != NULL)                              \
400                         lprocfs_counter_incr((exp)->exp_nid_stats->nid_stats,  \
401                                              _off);                            \
402         } while (0)
403
404 #define _MD_COUNTER_OFFSET(m_op)                                               \
405         ((offsetof(struct md_ops, m_op) -                                      \
406           offsetof(struct md_ops, MD_STATS_FIRST_OP)) /                        \
407          sizeof(((struct md_ops *)NULL)->MD_STATS_FIRST_OP))
408
409 #define MD_COUNTER_OFFSET(op) _MD_COUNTER_OFFSET(m_ ## op)
410
411 #define NUM_MD_STATS                                                           \
412         (_MD_COUNTER_OFFSET(MD_STATS_LAST_OP) -                                \
413          _MD_COUNTER_OFFSET(MD_STATS_FIRST_OP) + 1)
414
415 /* Note that we only increment md counters for ops whose offset is less
416  * than NUM_MD_STATS. This is explained in a comment in the definition
417  * of struct md_ops. */
418 #define EXP_MD_COUNTER_INCREMENT(exp, op)                                      \
419         do {                                                                   \
420                 if (MD_COUNTER_OFFSET(op) < NUM_MD_STATS)                      \
421                         lprocfs_counter_incr((exp)->exp_obd->obd_md_stats,     \
422                                         (exp)->exp_obd->obd_md_cntr_base +     \
423                                         MD_COUNTER_OFFSET(op));                \
424         } while (0)
425
426 #else
427 #define OBD_COUNTER_OFFSET(op)
428 #define OBD_COUNTER_INCREMENT(obd, op)
429 #define EXP_COUNTER_INCREMENT(exp, op)
430 #define EXP_MD_COUNTER_INCREMENT(exp, op)
431 #endif
432
433 static inline int lprocfs_nid_ldlm_stats_init(struct nid_stat* tmp)
434 {
435         /* Always add in ldlm_stats */
436         tmp->nid_ldlm_stats = lprocfs_alloc_stats(LDLM_LAST_OPC - LDLM_FIRST_OPC
437                                                   ,LPROCFS_STATS_FLAG_NOPERCPU);
438         if (tmp->nid_ldlm_stats == NULL)
439                 return -ENOMEM;
440
441         lprocfs_init_ldlm_stats(tmp->nid_ldlm_stats);
442
443         return lprocfs_register_stats(tmp->nid_proc, "ldlm_stats",
444                                       tmp->nid_ldlm_stats);
445 }
446
447 #define EXP_CHECK_MD_OP(exp, op)                                \
448 do {                                                            \
449         if ((exp) == NULL) {                                    \
450                 CERROR("obd_" #op ": NULL export\n");           \
451                 RETURN(-ENODEV);                                \
452         }                                                       \
453         if ((exp)->exp_obd == NULL || !OBT((exp)->exp_obd)) {   \
454                 CERROR("obd_" #op ": cleaned up obd\n");        \
455                 RETURN(-EOPNOTSUPP);                            \
456         }                                                       \
457         if (!OBT((exp)->exp_obd) || !MDP((exp)->exp_obd, op)) { \
458                 CERROR("obd_" #op ": dev %s/%d no operation\n", \
459                        (exp)->exp_obd->obd_name,                \
460                        (exp)->exp_obd->obd_minor);              \
461                 RETURN(-EOPNOTSUPP);                            \
462         }                                                       \
463 } while (0)
464
465
466 #define OBD_CHECK_DT_OP(obd, op, err)                           \
467 do {                                                            \
468         if (!OBT(obd) || !OBP((obd), op)) {                     \
469                 if (err)                                        \
470                         CERROR("obd_" #op ": dev %d no operation\n",    \
471                                obd->obd_minor);                 \
472                 RETURN(err);                                    \
473         }                                                       \
474 } while (0)
475
476 #define EXP_CHECK_DT_OP(exp, op)                                \
477 do {                                                            \
478         if ((exp) == NULL) {                                    \
479                 CERROR("obd_" #op ": NULL export\n");           \
480                 RETURN(-ENODEV);                                \
481         }                                                       \
482         if ((exp)->exp_obd == NULL || !OBT((exp)->exp_obd)) {   \
483                 CERROR("obd_" #op ": cleaned up obd\n");        \
484                 RETURN(-EOPNOTSUPP);                            \
485         }                                                       \
486         if (!OBT((exp)->exp_obd) || !OBP((exp)->exp_obd, op)) { \
487                 CERROR("obd_" #op ": dev %d no operation\n",    \
488                        (exp)->exp_obd->obd_minor);              \
489                 RETURN(-EOPNOTSUPP);                            \
490         }                                                       \
491 } while (0)
492
493 #define CTXT_CHECK_OP(ctxt, op, err)                                 \
494 do {                                                                 \
495         if (!OBT(ctxt->loc_obd) || !CTXTP((ctxt), op)) {             \
496                 if (err)                                             \
497                         CERROR("lop_" #op ": dev %d no operation\n", \
498                                ctxt->loc_obd->obd_minor);            \
499                 RETURN(err);                                         \
500         }                                                            \
501 } while (0)
502
503 static inline int class_devno_max(void)
504 {
505         return MAX_OBD_DEVICES;
506 }
507
508 static inline int obd_get_info(const struct lu_env *env, struct obd_export *exp,
509                                __u32 keylen, void *key,
510                                __u32 *vallen, void *val)
511 {
512         int rc;
513         ENTRY;
514
515         EXP_CHECK_DT_OP(exp, get_info);
516         EXP_COUNTER_INCREMENT(exp, get_info);
517
518         rc = OBP(exp->exp_obd, get_info)(env, exp, keylen, key, vallen, val);
519         RETURN(rc);
520 }
521
522 static inline int obd_set_info_async(const struct lu_env *env,
523                                      struct obd_export *exp,
524                                      __u32 keylen, void *key,
525                                      __u32 vallen, void *val,
526                                      struct ptlrpc_request_set *set)
527 {
528         int rc;
529         ENTRY;
530
531         EXP_CHECK_DT_OP(exp, set_info_async);
532         EXP_COUNTER_INCREMENT(exp, set_info_async);
533
534         rc = OBP(exp->exp_obd, set_info_async)(env, exp, keylen, key, vallen,
535                                                val, set);
536         RETURN(rc);
537 }
538
539 /*
540  * obd-lu integration.
541  *
542  * Functionality is being moved into new lu_device-based layering, but some
543  * pieces of configuration process are still based on obd devices.
544  *
545  * Specifically, lu_device_type_operations::ldto_device_alloc() methods fully
546  * subsume ->o_setup() methods of obd devices they replace. The same for
547  * lu_device_operations::ldo_process_config() and ->o_process_config(). As a
548  * result, obd_setup() and obd_process_config() branch and call one XOR
549  * another.
550  *
551  * Yet neither lu_device_type_operations::ldto_device_fini() nor
552  * lu_device_type_operations::ldto_device_free() fully implement the
553  * functionality of ->o_precleanup() and ->o_cleanup() they override. Hence,
554  * obd_precleanup() and obd_cleanup() call both lu_device and obd operations.
555  */
556
557 #define DECLARE_LU_VARS(ldt, d)                 \
558         struct lu_device_type *ldt;       \
559         struct lu_device *d
560
561 static inline int obd_setup(struct obd_device *obd, struct lustre_cfg *cfg)
562 {
563         int rc;
564         DECLARE_LU_VARS(ldt, d);
565         ENTRY;
566
567         ldt = obd->obd_type->typ_lu;
568         if (ldt != NULL) {
569                 struct lu_context  session_ctx;
570                 struct lu_env env;
571                 lu_context_init(&session_ctx, LCT_SESSION | LCT_SERVER_SESSION);
572                 session_ctx.lc_thread = NULL;
573                 lu_context_enter(&session_ctx);
574
575                 rc = lu_env_init(&env, ldt->ldt_ctx_tags);
576                 if (rc == 0) {
577                         env.le_ses = &session_ctx;
578                         d = ldt->ldt_ops->ldto_device_alloc(&env, ldt, cfg);
579                         lu_env_fini(&env);
580                         if (!IS_ERR(d)) {
581                                 obd->obd_lu_dev = d;
582                                 d->ld_obd = obd;
583                                 rc = 0;
584                         } else
585                                 rc = PTR_ERR(d);
586                 }
587                 lu_context_exit(&session_ctx);
588                 lu_context_fini(&session_ctx);
589
590         } else {
591                 OBD_CHECK_DT_OP(obd, setup, -EOPNOTSUPP);
592                 OBD_COUNTER_INCREMENT(obd, setup);
593                 rc = OBP(obd, setup)(obd, cfg);
594         }
595         RETURN(rc);
596 }
597
598 static inline int obd_precleanup(struct obd_device *obd)
599 {
600         int rc;
601         DECLARE_LU_VARS(ldt, d);
602         ENTRY;
603
604         OBD_CHECK_DEV(obd);
605         ldt = obd->obd_type->typ_lu;
606         d = obd->obd_lu_dev;
607         if (ldt != NULL && d != NULL) {
608                 struct lu_env env;
609
610                 rc = lu_env_init(&env, ldt->ldt_ctx_tags);
611                 if (rc == 0) {
612                         ldt->ldt_ops->ldto_device_fini(&env, d);
613                         lu_env_fini(&env);
614                 }
615         }
616         OBD_CHECK_DT_OP(obd, precleanup, 0);
617         OBD_COUNTER_INCREMENT(obd, precleanup);
618
619         rc = OBP(obd, precleanup)(obd);
620         RETURN(rc);
621 }
622
623 static inline int obd_cleanup(struct obd_device *obd)
624 {
625         int rc;
626         DECLARE_LU_VARS(ldt, d);
627         ENTRY;
628
629         OBD_CHECK_DEV(obd);
630
631         ldt = obd->obd_type->typ_lu;
632         d = obd->obd_lu_dev;
633         if (ldt != NULL && d != NULL) {
634                 struct lu_env env;
635
636                 rc = lu_env_init(&env, ldt->ldt_ctx_tags);
637                 if (rc == 0) {
638                         ldt->ldt_ops->ldto_device_free(&env, d);
639                         lu_env_fini(&env);
640                         obd->obd_lu_dev = NULL;
641                 }
642         }
643         OBD_CHECK_DT_OP(obd, cleanup, 0);
644         OBD_COUNTER_INCREMENT(obd, cleanup);
645
646         rc = OBP(obd, cleanup)(obd);
647         RETURN(rc);
648 }
649
650 static inline void obd_cleanup_client_import(struct obd_device *obd)
651 {
652         ENTRY;
653
654         /* If we set up but never connected, the
655            client import will not have been cleaned. */
656         down_write(&obd->u.cli.cl_sem);
657         if (obd->u.cli.cl_import) {
658                 struct obd_import *imp;
659                 imp = obd->u.cli.cl_import;
660                 CDEBUG(D_CONFIG, "%s: client import never connected\n",
661                        obd->obd_name);
662                 ptlrpc_invalidate_import(imp);
663                 client_destroy_import(imp);
664                 obd->u.cli.cl_import = NULL;
665         }
666         up_write(&obd->u.cli.cl_sem);
667
668         EXIT;
669 }
670
671 static inline int
672 obd_process_config(struct obd_device *obd, int datalen, void *data)
673 {
674         int rc;
675         DECLARE_LU_VARS(ldt, d);
676         ENTRY;
677
678         OBD_CHECK_DEV(obd);
679
680         obd->obd_process_conf = 1;
681         ldt = obd->obd_type->typ_lu;
682         d = obd->obd_lu_dev;
683         if (ldt != NULL && d != NULL) {
684                 struct lu_env env;
685
686                 rc = lu_env_init(&env, ldt->ldt_ctx_tags);
687                 if (rc == 0) {
688                         rc = d->ld_ops->ldo_process_config(&env, d, data);
689                         lu_env_fini(&env);
690                 }
691         } else {
692                 OBD_CHECK_DT_OP(obd, process_config, -EOPNOTSUPP);
693                 rc = OBP(obd, process_config)(obd, datalen, data);
694         }
695         OBD_COUNTER_INCREMENT(obd, process_config);
696         obd->obd_process_conf = 0;
697
698         RETURN(rc);
699 }
700
701 static inline int obd_create(const struct lu_env *env, struct obd_export *exp,
702                              struct obdo *obdo)
703 {
704         int rc;
705         ENTRY;
706
707         EXP_CHECK_DT_OP(exp, create);
708         EXP_COUNTER_INCREMENT(exp, create);
709
710         rc = OBP(exp->exp_obd, create)(env, exp, obdo);
711         RETURN(rc);
712 }
713
714 static inline int obd_destroy(const struct lu_env *env, struct obd_export *exp,
715                               struct obdo *obdo)
716 {
717         int rc;
718         ENTRY;
719
720         EXP_CHECK_DT_OP(exp, destroy);
721         EXP_COUNTER_INCREMENT(exp, destroy);
722
723         rc = OBP(exp->exp_obd, destroy)(env, exp, obdo);
724         RETURN(rc);
725 }
726
727 static inline int obd_getattr(const struct lu_env *env, struct obd_export *exp,
728                               struct obdo *oa)
729 {
730         int rc;
731
732         ENTRY;
733         EXP_CHECK_DT_OP(exp, getattr);
734         EXP_COUNTER_INCREMENT(exp, getattr);
735         rc = OBP(exp->exp_obd, getattr)(env, exp, oa);
736
737         RETURN(rc);
738 }
739
740 static inline int obd_setattr(const struct lu_env *env, struct obd_export *exp,
741                               struct obdo *oa)
742 {
743         int rc;
744
745         ENTRY;
746         EXP_CHECK_DT_OP(exp, setattr);
747         EXP_COUNTER_INCREMENT(exp, setattr);
748         rc = OBP(exp->exp_obd, setattr)(env, exp, oa);
749
750         RETURN(rc);
751 }
752
753 static inline int obd_add_conn(struct obd_import *imp, struct obd_uuid *uuid,
754                                int priority)
755 {
756         struct obd_device *obd = imp->imp_obd;
757         int rc;
758         ENTRY;
759
760         OBD_CHECK_DEV_ACTIVE(obd);
761         OBD_CHECK_DT_OP(obd, add_conn, -EOPNOTSUPP);
762         OBD_COUNTER_INCREMENT(obd, add_conn);
763
764         rc = OBP(obd, add_conn)(imp, uuid, priority);
765         RETURN(rc);
766 }
767
768 static inline int obd_del_conn(struct obd_import *imp, struct obd_uuid *uuid)
769 {
770         struct obd_device *obd = imp->imp_obd;
771         int rc;
772         ENTRY;
773
774         OBD_CHECK_DEV_ACTIVE(obd);
775         OBD_CHECK_DT_OP(obd, del_conn, -EOPNOTSUPP);
776         OBD_COUNTER_INCREMENT(obd, del_conn);
777
778         rc = OBP(obd, del_conn)(imp, uuid);
779         RETURN(rc);
780 }
781
782 static inline struct obd_uuid *obd_get_uuid(struct obd_export *exp)
783 {
784         struct obd_uuid *uuid;
785         ENTRY;
786
787         OBD_CHECK_DT_OP(exp->exp_obd, get_uuid, NULL);
788         EXP_COUNTER_INCREMENT(exp, get_uuid);
789
790         uuid = OBP(exp->exp_obd, get_uuid)(exp);
791         RETURN(uuid);
792 }
793
794 /** Create a new /a exp on device /a obd for the uuid /a cluuid
795  * @param exp New export handle
796  * @param d Connect data, supported flags are set, flags also understood
797  *    by obd are returned.
798  */
799 static inline int obd_connect(const struct lu_env *env,
800                               struct obd_export **exp,struct obd_device *obd,
801                               struct obd_uuid *cluuid,
802                               struct obd_connect_data *data,
803                               void *localdata)
804 {
805         int rc;
806         __u64 ocf = data ? data->ocd_connect_flags : 0; /* for post-condition
807                                                    * check */
808         ENTRY;
809
810         OBD_CHECK_DEV_ACTIVE(obd);
811         OBD_CHECK_DT_OP(obd, connect, -EOPNOTSUPP);
812         OBD_COUNTER_INCREMENT(obd, connect);
813
814         rc = OBP(obd, connect)(env, exp, obd, cluuid, data, localdata);
815         /* check that only subset is granted */
816         LASSERT(ergo(data != NULL, (data->ocd_connect_flags & ocf) ==
817                                     data->ocd_connect_flags));
818         RETURN(rc);
819 }
820
821 static inline int obd_reconnect(const struct lu_env *env,
822                                 struct obd_export *exp,
823                                 struct obd_device *obd,
824                                 struct obd_uuid *cluuid,
825                                 struct obd_connect_data *d,
826                                 void *localdata)
827 {
828         int rc;
829         __u64 ocf = d ? d->ocd_connect_flags : 0; /* for post-condition
830                                                    * check */
831
832         ENTRY;
833
834         OBD_CHECK_DEV_ACTIVE(obd);
835         OBD_CHECK_DT_OP(obd, reconnect, 0);
836         OBD_COUNTER_INCREMENT(obd, reconnect);
837
838         rc = OBP(obd, reconnect)(env, exp, obd, cluuid, d, localdata);
839         /* check that only subset is granted */
840         LASSERT(ergo(d != NULL,
841                      (d->ocd_connect_flags & ocf) == d->ocd_connect_flags));
842         RETURN(rc);
843 }
844
845 static inline int obd_disconnect(struct obd_export *exp)
846 {
847         int rc;
848         ENTRY;
849
850         EXP_CHECK_DT_OP(exp, disconnect);
851         EXP_COUNTER_INCREMENT(exp, disconnect);
852
853         rc = OBP(exp->exp_obd, disconnect)(exp);
854         RETURN(rc);
855 }
856
857 static inline int obd_fid_init(struct obd_device *obd, struct obd_export *exp,
858                                enum lu_cli_type type)
859 {
860         int rc;
861         ENTRY;
862
863         OBD_CHECK_DT_OP(obd, fid_init, 0);
864         OBD_COUNTER_INCREMENT(obd, fid_init);
865
866         rc = OBP(obd, fid_init)(obd, exp, type);
867         RETURN(rc);
868 }
869
870 static inline int obd_fid_fini(struct obd_device *obd)
871 {
872         int rc;
873         ENTRY;
874
875         OBD_CHECK_DT_OP(obd, fid_fini, 0);
876         OBD_COUNTER_INCREMENT(obd, fid_fini);
877
878         rc = OBP(obd, fid_fini)(obd);
879         RETURN(rc);
880 }
881
882 static inline int obd_fid_alloc(const struct lu_env *env,
883                                 struct obd_export *exp,
884                                 struct lu_fid *fid,
885                                 struct md_op_data *op_data)
886 {
887         int rc;
888         ENTRY;
889
890         EXP_CHECK_DT_OP(exp, fid_alloc);
891         EXP_COUNTER_INCREMENT(exp, fid_alloc);
892
893         rc = OBP(exp->exp_obd, fid_alloc)(env, exp, fid, op_data);
894         RETURN(rc);
895 }
896
897 static inline int obd_ping(const struct lu_env *env, struct obd_export *exp)
898 {
899         int rc;
900         ENTRY;
901
902         OBD_CHECK_DT_OP(exp->exp_obd, ping, 0);
903         EXP_COUNTER_INCREMENT(exp, ping);
904
905         rc = OBP(exp->exp_obd, ping)(env, exp);
906         RETURN(rc);
907 }
908
909 static inline int obd_pool_new(struct obd_device *obd, char *poolname)
910 {
911         int rc;
912         ENTRY;
913
914         OBD_CHECK_DT_OP(obd, pool_new, -EOPNOTSUPP);
915         OBD_COUNTER_INCREMENT(obd, pool_new);
916
917         rc = OBP(obd, pool_new)(obd, poolname);
918         RETURN(rc);
919 }
920
921 static inline int obd_pool_del(struct obd_device *obd, char *poolname)
922 {
923         int rc;
924         ENTRY;
925
926         OBD_CHECK_DT_OP(obd, pool_del, -EOPNOTSUPP);
927         OBD_COUNTER_INCREMENT(obd, pool_del);
928
929         rc = OBP(obd, pool_del)(obd, poolname);
930         RETURN(rc);
931 }
932
933 static inline int obd_pool_add(struct obd_device *obd, char *poolname, char *ostname)
934 {
935         int rc;
936         ENTRY;
937
938         OBD_CHECK_DT_OP(obd, pool_add, -EOPNOTSUPP);
939         OBD_COUNTER_INCREMENT(obd, pool_add);
940
941         rc = OBP(obd, pool_add)(obd, poolname, ostname);
942         RETURN(rc);
943 }
944
945 static inline int obd_pool_rem(struct obd_device *obd, char *poolname, char *ostname)
946 {
947         int rc;
948         ENTRY;
949
950         OBD_CHECK_DT_OP(obd, pool_rem, -EOPNOTSUPP);
951         OBD_COUNTER_INCREMENT(obd, pool_rem);
952
953         rc = OBP(obd, pool_rem)(obd, poolname, ostname);
954         RETURN(rc);
955 }
956
957 static inline void obd_getref(struct obd_device *obd)
958 {
959         ENTRY;
960         if (OBT(obd) && OBP(obd, getref)) {
961                 OBD_COUNTER_INCREMENT(obd, getref);
962                 OBP(obd, getref)(obd);
963         }
964         EXIT;
965 }
966
967 static inline void obd_putref(struct obd_device *obd)
968 {
969         ENTRY;
970         if (OBT(obd) && OBP(obd, putref)) {
971                 OBD_COUNTER_INCREMENT(obd, putref);
972                 OBP(obd, putref)(obd);
973         }
974         EXIT;
975 }
976
977 static inline int obd_init_export(struct obd_export *exp)
978 {
979         int rc = 0;
980
981         ENTRY;
982         if ((exp)->exp_obd != NULL && OBT((exp)->exp_obd) &&
983             OBP((exp)->exp_obd, init_export))
984                 rc = OBP(exp->exp_obd, init_export)(exp);
985         RETURN(rc);
986 }
987
988 static inline int obd_destroy_export(struct obd_export *exp)
989 {
990         ENTRY;
991         if ((exp)->exp_obd != NULL && OBT((exp)->exp_obd) &&
992             OBP((exp)->exp_obd, destroy_export))
993                 OBP(exp->exp_obd, destroy_export)(exp);
994         RETURN(0);
995 }
996
997 /* @max_age is the oldest time in jiffies that we accept using a cached data.
998  * If the cache is older than @max_age we will get a new value from the
999  * target.  Use a value of "cfs_time_current() + HZ" to guarantee freshness. */
1000 static inline int obd_statfs_async(struct obd_export *exp,
1001                                    struct obd_info *oinfo,
1002                                    __u64 max_age,
1003                                    struct ptlrpc_request_set *rqset)
1004 {
1005         int rc = 0;
1006         struct obd_device *obd;
1007         ENTRY;
1008
1009         if (exp == NULL || exp->exp_obd == NULL)
1010                 RETURN(-EINVAL);
1011
1012         obd = exp->exp_obd;
1013         OBD_CHECK_DT_OP(obd, statfs, -EOPNOTSUPP);
1014         OBD_COUNTER_INCREMENT(obd, statfs);
1015
1016         CDEBUG(D_SUPER, "%s: osfs %p age "LPU64", max_age "LPU64"\n",
1017                obd->obd_name, &obd->obd_osfs, obd->obd_osfs_age, max_age);
1018         if (cfs_time_before_64(obd->obd_osfs_age, max_age)) {
1019                 rc = OBP(obd, statfs_async)(exp, oinfo, max_age, rqset);
1020         } else {
1021                 CDEBUG(D_SUPER,"%s: use %p cache blocks "LPU64"/"LPU64
1022                        " objects "LPU64"/"LPU64"\n",
1023                        obd->obd_name, &obd->obd_osfs,
1024                        obd->obd_osfs.os_bavail, obd->obd_osfs.os_blocks,
1025                        obd->obd_osfs.os_ffree, obd->obd_osfs.os_files);
1026                 spin_lock(&obd->obd_osfs_lock);
1027                 memcpy(oinfo->oi_osfs, &obd->obd_osfs, sizeof(*oinfo->oi_osfs));
1028                 spin_unlock(&obd->obd_osfs_lock);
1029                 oinfo->oi_flags |= OBD_STATFS_FROM_CACHE;
1030                 if (oinfo->oi_cb_up)
1031                         oinfo->oi_cb_up(oinfo, 0);
1032         }
1033         RETURN(rc);
1034 }
1035
1036 static inline int obd_statfs_rqset(struct obd_export *exp,
1037                                    struct obd_statfs *osfs, __u64 max_age,
1038                                    __u32 flags)
1039 {
1040         struct ptlrpc_request_set *set = NULL;
1041         struct obd_info oinfo = {
1042                 .oi_osfs = osfs,
1043                 .oi_flags = flags,
1044         };
1045         int rc = 0;
1046
1047         ENTRY;
1048
1049         set = ptlrpc_prep_set();
1050         if (set == NULL)
1051                 RETURN(-ENOMEM);
1052
1053         rc = obd_statfs_async(exp, &oinfo, max_age, set);
1054         if (rc == 0)
1055                 rc = ptlrpc_set_wait(set);
1056
1057         ptlrpc_set_destroy(set);
1058
1059         RETURN(rc);
1060 }
1061
1062 /* @max_age is the oldest time in jiffies that we accept using a cached data.
1063  * If the cache is older than @max_age we will get a new value from the
1064  * target.  Use a value of "cfs_time_current() + HZ" to guarantee freshness. */
1065 static inline int obd_statfs(const struct lu_env *env, struct obd_export *exp,
1066                              struct obd_statfs *osfs, __u64 max_age,
1067                              __u32 flags)
1068 {
1069         int rc = 0;
1070         struct obd_device *obd = exp->exp_obd;
1071         ENTRY;
1072
1073         if (obd == NULL)
1074                 RETURN(-EINVAL);
1075
1076         OBD_CHECK_DT_OP(obd, statfs, -EOPNOTSUPP);
1077         OBD_COUNTER_INCREMENT(obd, statfs);
1078
1079         CDEBUG(D_SUPER, "osfs "LPU64", max_age "LPU64"\n",
1080                obd->obd_osfs_age, max_age);
1081         if (cfs_time_before_64(obd->obd_osfs_age, max_age)) {
1082                 rc = OBP(obd, statfs)(env, exp, osfs, max_age, flags);
1083                 if (rc == 0) {
1084                         spin_lock(&obd->obd_osfs_lock);
1085                         memcpy(&obd->obd_osfs, osfs, sizeof(obd->obd_osfs));
1086                         obd->obd_osfs_age = cfs_time_current_64();
1087                         spin_unlock(&obd->obd_osfs_lock);
1088                 }
1089         } else {
1090                 CDEBUG(D_SUPER, "%s: use %p cache blocks "LPU64"/"LPU64
1091                        " objects "LPU64"/"LPU64"\n",
1092                        obd->obd_name, &obd->obd_osfs,
1093                        obd->obd_osfs.os_bavail, obd->obd_osfs.os_blocks,
1094                        obd->obd_osfs.os_ffree, obd->obd_osfs.os_files);
1095                 spin_lock(&obd->obd_osfs_lock);
1096                 memcpy(osfs, &obd->obd_osfs, sizeof(*osfs));
1097                 spin_unlock(&obd->obd_osfs_lock);
1098         }
1099         RETURN(rc);
1100 }
1101
1102 static inline int obd_preprw(const struct lu_env *env, int cmd,
1103                              struct obd_export *exp, struct obdo *oa,
1104                              int objcount, struct obd_ioobj *obj,
1105                              struct niobuf_remote *remote, int *pages,
1106                              struct niobuf_local *local)
1107 {
1108         int rc;
1109
1110         ENTRY;
1111         EXP_CHECK_DT_OP(exp, preprw);
1112         EXP_COUNTER_INCREMENT(exp, preprw);
1113         rc = OBP(exp->exp_obd, preprw)(env, cmd, exp, oa, objcount, obj, remote,
1114                                        pages, local);
1115
1116         RETURN(rc);
1117 }
1118
1119 static inline int obd_commitrw(const struct lu_env *env, int cmd,
1120                                struct obd_export *exp, struct obdo *oa,
1121                                int objcount, struct obd_ioobj *obj,
1122                                struct niobuf_remote *rnb, int pages,
1123                                struct niobuf_local *local, int rc)
1124 {
1125         ENTRY;
1126
1127         EXP_CHECK_DT_OP(exp, commitrw);
1128         EXP_COUNTER_INCREMENT(exp, commitrw);
1129         rc = OBP(exp->exp_obd, commitrw)(env, cmd, exp, oa, objcount, obj,
1130                                          rnb, pages, local, rc);
1131
1132         RETURN(rc);
1133 }
1134
1135 static inline int obd_iocontrol(unsigned int cmd, struct obd_export *exp,
1136                                 int len, void *karg, void __user *uarg)
1137 {
1138         int rc;
1139         ENTRY;
1140
1141         EXP_CHECK_DT_OP(exp, iocontrol);
1142         EXP_COUNTER_INCREMENT(exp, iocontrol);
1143
1144         rc = OBP(exp->exp_obd, iocontrol)(cmd, exp, len, karg, uarg);
1145         RETURN(rc);
1146 }
1147
1148 static inline void obd_import_event(struct obd_device *obd,
1149                                     struct obd_import *imp,
1150                                     enum obd_import_event event)
1151 {
1152         ENTRY;
1153         if (!obd) {
1154                 CERROR("NULL device\n");
1155                 EXIT;
1156                 return;
1157         }
1158         if (obd->obd_set_up && OBP(obd, import_event)) {
1159                 OBD_COUNTER_INCREMENT(obd, import_event);
1160                 OBP(obd, import_event)(obd, imp, event);
1161         }
1162         EXIT;
1163 }
1164
1165 static inline int obd_notify(struct obd_device *obd,
1166                              struct obd_device *watched,
1167                              enum obd_notify_event ev,
1168                              void *data)
1169 {
1170         int rc;
1171         ENTRY;
1172         OBD_CHECK_DEV(obd);
1173
1174         if (!obd->obd_set_up) {
1175                 CDEBUG(D_HA, "obd %s not set up\n", obd->obd_name);
1176                 RETURN(-EINVAL);
1177         }
1178
1179         if (!OBP(obd, notify)) {
1180                 CDEBUG(D_HA, "obd %s has no notify handler\n", obd->obd_name);
1181                 RETURN(-ENOSYS);
1182         }
1183
1184         OBD_COUNTER_INCREMENT(obd, notify);
1185         rc = OBP(obd, notify)(obd, watched, ev, data);
1186         RETURN(rc);
1187 }
1188
1189 static inline int obd_notify_observer(struct obd_device *observer,
1190                                       struct obd_device *observed,
1191                                       enum obd_notify_event ev,
1192                                       void *data)
1193 {
1194         int rc1;
1195         int rc2;
1196
1197         struct obd_notify_upcall *onu;
1198
1199         if (observer->obd_observer)
1200                 rc1 = obd_notify(observer->obd_observer, observed, ev, data);
1201         else
1202                 rc1 = 0;
1203         /*
1204          * Also, call non-obd listener, if any
1205          */
1206         onu = &observer->obd_upcall;
1207         if (onu->onu_upcall != NULL)
1208                 rc2 = onu->onu_upcall(observer, observed, ev,
1209                                       onu->onu_owner, NULL);
1210         else
1211                 rc2 = 0;
1212
1213         return rc1 ? rc1 : rc2;
1214 }
1215
1216 static inline int obd_quotactl(struct obd_export *exp,
1217                                struct obd_quotactl *oqctl)
1218 {
1219         int rc;
1220         ENTRY;
1221
1222         EXP_CHECK_DT_OP(exp, quotactl);
1223         EXP_COUNTER_INCREMENT(exp, quotactl);
1224
1225         rc = OBP(exp->exp_obd, quotactl)(exp->exp_obd, exp, oqctl);
1226         RETURN(rc);
1227 }
1228
1229 static inline int obd_health_check(const struct lu_env *env,
1230                                    struct obd_device *obd)
1231 {
1232         /* returns: 0 on healthy
1233          *         >0 on unhealthy + reason code/flag
1234          *            however the only suppored reason == 1 right now
1235          *            We'll need to define some better reasons
1236          *            or flags in the future.
1237          *         <0 on error
1238          */
1239         int rc;
1240         ENTRY;
1241
1242         /* don't use EXP_CHECK_DT_OP, because NULL method is normal here */
1243         if (obd == NULL || !OBT(obd)) {
1244                 CERROR("cleaned up obd\n");
1245                 RETURN(-EOPNOTSUPP);
1246         }
1247         if (!obd->obd_set_up || obd->obd_stopping)
1248                 RETURN(0);
1249         if (!OBP(obd, health_check))
1250                 RETURN(0);
1251
1252         rc = OBP(obd, health_check)(env, obd);
1253         RETURN(rc);
1254 }
1255
1256 static inline int obd_register_observer(struct obd_device *obd,
1257                                         struct obd_device *observer)
1258 {
1259         ENTRY;
1260         OBD_CHECK_DEV(obd);
1261         down_write(&obd->obd_observer_link_sem);
1262         if (obd->obd_observer && observer) {
1263                 up_write(&obd->obd_observer_link_sem);
1264                 RETURN(-EALREADY);
1265         }
1266         obd->obd_observer = observer;
1267         up_write(&obd->obd_observer_link_sem);
1268         RETURN(0);
1269 }
1270
1271 /* metadata helpers */
1272 static inline int md_get_root(struct obd_export *exp, const char *fileset,
1273                               struct lu_fid *fid)
1274 {
1275         int rc;
1276
1277         ENTRY;
1278         EXP_CHECK_MD_OP(exp, get_root);
1279         EXP_MD_COUNTER_INCREMENT(exp, get_root);
1280         rc = MDP(exp->exp_obd, get_root)(exp, fileset, fid);
1281
1282         RETURN(rc);
1283 }
1284
1285 static inline int md_getattr(struct obd_export *exp, struct md_op_data *op_data,
1286                              struct ptlrpc_request **request)
1287 {
1288         int rc;
1289         ENTRY;
1290         EXP_CHECK_MD_OP(exp, getattr);
1291         EXP_MD_COUNTER_INCREMENT(exp, getattr);
1292         rc = MDP(exp->exp_obd, getattr)(exp, op_data, request);
1293         RETURN(rc);
1294 }
1295
1296 static inline int md_null_inode(struct obd_export *exp,
1297                                    const struct lu_fid *fid)
1298 {
1299         int rc;
1300         ENTRY;
1301         EXP_CHECK_MD_OP(exp, null_inode);
1302         EXP_MD_COUNTER_INCREMENT(exp, null_inode);
1303         rc = MDP(exp->exp_obd, null_inode)(exp, fid);
1304         RETURN(rc);
1305 }
1306
1307 static inline int md_close(struct obd_export *exp, struct md_op_data *op_data,
1308                            struct md_open_data *mod,
1309                            struct ptlrpc_request **request)
1310 {
1311         int rc;
1312         ENTRY;
1313         EXP_CHECK_MD_OP(exp, close);
1314         EXP_MD_COUNTER_INCREMENT(exp, close);
1315         rc = MDP(exp->exp_obd, close)(exp, op_data, mod, request);
1316         RETURN(rc);
1317 }
1318
1319 static inline int md_create(struct obd_export *exp, struct md_op_data *op_data,
1320                             const void *data, size_t datalen, umode_t mode,
1321                             uid_t uid, gid_t gid, cfs_cap_t cap_effective,
1322                             __u64 rdev, struct ptlrpc_request **request)
1323 {
1324         int rc;
1325         ENTRY;
1326         EXP_CHECK_MD_OP(exp, create);
1327         EXP_MD_COUNTER_INCREMENT(exp, create);
1328         rc = MDP(exp->exp_obd, create)(exp, op_data, data, datalen, mode,
1329                                        uid, gid, cap_effective, rdev, request);
1330         RETURN(rc);
1331 }
1332
1333 static inline int md_enqueue(struct obd_export *exp,
1334                              struct ldlm_enqueue_info *einfo,
1335                              const union ldlm_policy_data *policy,
1336                              struct lookup_intent *it,
1337                              struct md_op_data *op_data,
1338                              struct lustre_handle *lockh,
1339                              __u64 extra_lock_flags)
1340 {
1341         int rc;
1342         ENTRY;
1343         EXP_CHECK_MD_OP(exp, enqueue);
1344         EXP_MD_COUNTER_INCREMENT(exp, enqueue);
1345         rc = MDP(exp->exp_obd, enqueue)(exp, einfo, policy, it, op_data, lockh,
1346                                         extra_lock_flags);
1347         RETURN(rc);
1348 }
1349
1350 static inline int md_getattr_name(struct obd_export *exp,
1351                                   struct md_op_data *op_data,
1352                                   struct ptlrpc_request **request)
1353 {
1354         int rc;
1355         ENTRY;
1356         EXP_CHECK_MD_OP(exp, getattr_name);
1357         EXP_MD_COUNTER_INCREMENT(exp, getattr_name);
1358         rc = MDP(exp->exp_obd, getattr_name)(exp, op_data, request);
1359         RETURN(rc);
1360 }
1361
1362 static inline int md_intent_lock(struct obd_export *exp,
1363                                  struct md_op_data *op_data,
1364                                  struct lookup_intent *it,
1365                                  struct ptlrpc_request **reqp,
1366                                  ldlm_blocking_callback cb_blocking,
1367                                  __u64 extra_lock_flags)
1368 {
1369         int rc;
1370         ENTRY;
1371         EXP_CHECK_MD_OP(exp, intent_lock);
1372         EXP_MD_COUNTER_INCREMENT(exp, intent_lock);
1373         rc = MDP(exp->exp_obd, intent_lock)(exp, op_data, it, reqp, cb_blocking,
1374                                             extra_lock_flags);
1375         RETURN(rc);
1376 }
1377
1378 static inline int md_link(struct obd_export *exp, struct md_op_data *op_data,
1379                           struct ptlrpc_request **request)
1380 {
1381         int rc;
1382         ENTRY;
1383         EXP_CHECK_MD_OP(exp, link);
1384         EXP_MD_COUNTER_INCREMENT(exp, link);
1385         rc = MDP(exp->exp_obd, link)(exp, op_data, request);
1386         RETURN(rc);
1387 }
1388
1389 static inline int md_rename(struct obd_export *exp, struct md_op_data *op_data,
1390                             const char *old, size_t oldlen, const char *new,
1391                             size_t newlen, struct ptlrpc_request **request)
1392 {
1393         int rc;
1394         ENTRY;
1395         EXP_CHECK_MD_OP(exp, rename);
1396         EXP_MD_COUNTER_INCREMENT(exp, rename);
1397         rc = MDP(exp->exp_obd, rename)(exp, op_data, old, oldlen, new,
1398                                        newlen, request);
1399         RETURN(rc);
1400 }
1401
1402 static inline int md_setattr(struct obd_export *exp, struct md_op_data *op_data,
1403                              void *ea, size_t ealen,
1404                              struct ptlrpc_request **request)
1405 {
1406         int rc;
1407         ENTRY;
1408         EXP_CHECK_MD_OP(exp, setattr);
1409         EXP_MD_COUNTER_INCREMENT(exp, setattr);
1410         rc = MDP(exp->exp_obd, setattr)(exp, op_data, ea, ealen, request);
1411         RETURN(rc);
1412 }
1413
1414 static inline int md_fsync(struct obd_export *exp, const struct lu_fid *fid,
1415                            struct ptlrpc_request **request)
1416 {
1417         int rc;
1418
1419         ENTRY;
1420         EXP_CHECK_MD_OP(exp, fsync);
1421         EXP_MD_COUNTER_INCREMENT(exp, fsync);
1422         rc = MDP(exp->exp_obd, fsync)(exp, fid, request);
1423
1424         RETURN(rc);
1425 }
1426
1427 static inline int md_read_page(struct obd_export *exp,
1428                                struct md_op_data *op_data,
1429                                struct md_callback *cb_op,
1430                                __u64  hash_offset,
1431                                struct page **ppage)
1432 {
1433         int rc;
1434         ENTRY;
1435         EXP_CHECK_MD_OP(exp, read_page);
1436         EXP_MD_COUNTER_INCREMENT(exp, read_page);
1437         rc = MDP(exp->exp_obd, read_page)(exp, op_data, cb_op, hash_offset,
1438                                           ppage);
1439         RETURN(rc);
1440 }
1441
1442 static inline int md_unlink(struct obd_export *exp, struct md_op_data *op_data,
1443                             struct ptlrpc_request **request)
1444 {
1445         int rc;
1446         ENTRY;
1447         EXP_CHECK_MD_OP(exp, unlink);
1448         EXP_MD_COUNTER_INCREMENT(exp, unlink);
1449         rc = MDP(exp->exp_obd, unlink)(exp, op_data, request);
1450         RETURN(rc);
1451 }
1452
1453 static inline int md_get_lustre_md(struct obd_export *exp,
1454                                    struct ptlrpc_request *req,
1455                                    struct obd_export *dt_exp,
1456                                    struct obd_export *md_exp,
1457                                    struct lustre_md *md)
1458 {
1459         ENTRY;
1460         EXP_CHECK_MD_OP(exp, get_lustre_md);
1461         EXP_MD_COUNTER_INCREMENT(exp, get_lustre_md);
1462         RETURN(MDP(exp->exp_obd, get_lustre_md)(exp, req, dt_exp, md_exp, md));
1463 }
1464
1465 static inline int md_free_lustre_md(struct obd_export *exp,
1466                                     struct lustre_md *md)
1467 {
1468         ENTRY;
1469         EXP_CHECK_MD_OP(exp, free_lustre_md);
1470         EXP_MD_COUNTER_INCREMENT(exp, free_lustre_md);
1471         RETURN(MDP(exp->exp_obd, free_lustre_md)(exp, md));
1472 }
1473
1474 static inline int md_merge_attr(struct obd_export *exp,
1475                                 const struct lmv_stripe_md *lsm,
1476                                 struct cl_attr *attr,
1477                                 ldlm_blocking_callback cb)
1478 {
1479         ENTRY;
1480         EXP_CHECK_MD_OP(exp, merge_attr);
1481         EXP_MD_COUNTER_INCREMENT(exp, merge_attr);
1482         RETURN(MDP(exp->exp_obd, merge_attr)(exp, lsm, attr, cb));
1483 }
1484
1485 static inline int md_setxattr(struct obd_export *exp, const struct lu_fid *fid,
1486                               u64 valid, const char *name,
1487                               const char *input, int input_size,
1488                               int output_size, int flags, __u32 suppgid,
1489                               struct ptlrpc_request **request)
1490 {
1491         ENTRY;
1492         EXP_CHECK_MD_OP(exp, setxattr);
1493         EXP_MD_COUNTER_INCREMENT(exp, setxattr);
1494         RETURN(MDP(exp->exp_obd, setxattr)(exp, fid, valid, name, input,
1495                                            input_size, output_size, flags,
1496                                            suppgid, request));
1497 }
1498
1499 static inline int md_getxattr(struct obd_export *exp, const struct lu_fid *fid,
1500                               u64 valid, const char *name,
1501                               const char *input, int input_size,
1502                               int output_size, int flags,
1503                               struct ptlrpc_request **request)
1504 {
1505         ENTRY;
1506         EXP_CHECK_MD_OP(exp, getxattr);
1507         EXP_MD_COUNTER_INCREMENT(exp, getxattr);
1508         RETURN(MDP(exp->exp_obd, getxattr)(exp, fid, valid, name, input,
1509                                            input_size, output_size, flags,
1510                                            request));
1511 }
1512
1513 static inline int md_set_open_replay_data(struct obd_export *exp,
1514                                           struct obd_client_handle *och,
1515                                           struct lookup_intent *it)
1516 {
1517         ENTRY;
1518         EXP_CHECK_MD_OP(exp, set_open_replay_data);
1519         EXP_MD_COUNTER_INCREMENT(exp, set_open_replay_data);
1520         RETURN(MDP(exp->exp_obd, set_open_replay_data)(exp, och, it));
1521 }
1522
1523 static inline int md_clear_open_replay_data(struct obd_export *exp,
1524                                             struct obd_client_handle *och)
1525 {
1526         ENTRY;
1527         EXP_CHECK_MD_OP(exp, clear_open_replay_data);
1528         EXP_MD_COUNTER_INCREMENT(exp, clear_open_replay_data);
1529         RETURN(MDP(exp->exp_obd, clear_open_replay_data)(exp, och));
1530 }
1531
1532 static inline int md_set_lock_data(struct obd_export *exp,
1533                                    __u64 *lockh, void *data, __u64 *bits)
1534 {
1535         ENTRY;
1536         EXP_CHECK_MD_OP(exp, set_lock_data);
1537         EXP_MD_COUNTER_INCREMENT(exp, set_lock_data);
1538         RETURN(MDP(exp->exp_obd, set_lock_data)(exp, lockh, data, bits));
1539 }
1540
1541 static inline
1542 int md_cancel_unused(struct obd_export *exp, const struct lu_fid *fid,
1543                      union ldlm_policy_data *policy, enum ldlm_mode mode,
1544                      enum ldlm_cancel_flags cancel_flags, void *opaque)
1545 {
1546         int rc;
1547         ENTRY;
1548
1549         EXP_CHECK_MD_OP(exp, cancel_unused);
1550         EXP_MD_COUNTER_INCREMENT(exp, cancel_unused);
1551
1552         rc = MDP(exp->exp_obd, cancel_unused)(exp, fid, policy, mode,
1553                                               cancel_flags, opaque);
1554         RETURN(rc);
1555 }
1556
1557 static inline enum ldlm_mode md_lock_match(struct obd_export *exp, __u64 flags,
1558                                            const struct lu_fid *fid,
1559                                            enum ldlm_type type,
1560                                            union ldlm_policy_data *policy,
1561                                            enum ldlm_mode mode,
1562                                            struct lustre_handle *lockh)
1563 {
1564         ENTRY;
1565         EXP_CHECK_MD_OP(exp, lock_match);
1566         EXP_MD_COUNTER_INCREMENT(exp, lock_match);
1567         RETURN(MDP(exp->exp_obd, lock_match)(exp, flags, fid, type,
1568                                              policy, mode, lockh));
1569 }
1570
1571 static inline int md_init_ea_size(struct obd_export *exp, __u32 ea_size,
1572                                   __u32 def_ea_size)
1573 {
1574         ENTRY;
1575         EXP_CHECK_MD_OP(exp, init_ea_size);
1576         EXP_MD_COUNTER_INCREMENT(exp, init_ea_size);
1577         RETURN(MDP(exp->exp_obd, init_ea_size)(exp, ea_size, def_ea_size));
1578 }
1579
1580 static inline int md_intent_getattr_async(struct obd_export *exp,
1581                                           struct md_enqueue_info *minfo)
1582 {
1583         int rc;
1584         ENTRY;
1585         EXP_CHECK_MD_OP(exp, intent_getattr_async);
1586         EXP_MD_COUNTER_INCREMENT(exp, intent_getattr_async);
1587         rc = MDP(exp->exp_obd, intent_getattr_async)(exp, minfo);
1588         RETURN(rc);
1589 }
1590
1591 static inline int md_revalidate_lock(struct obd_export *exp,
1592                                      struct lookup_intent *it,
1593                                      struct lu_fid *fid, __u64 *bits)
1594 {
1595         int rc;
1596         ENTRY;
1597         EXP_CHECK_MD_OP(exp, revalidate_lock);
1598         EXP_MD_COUNTER_INCREMENT(exp, revalidate_lock);
1599         rc = MDP(exp->exp_obd, revalidate_lock)(exp, it, fid, bits);
1600         RETURN(rc);
1601 }
1602
1603 static inline int md_get_fid_from_lsm(struct obd_export *exp,
1604                                       const struct lmv_stripe_md *lsm,
1605                                       const char *name, int namelen,
1606                                       struct lu_fid *fid)
1607 {
1608         int rc;
1609         ENTRY;
1610         EXP_CHECK_MD_OP(exp, get_fid_from_lsm);
1611         EXP_MD_COUNTER_INCREMENT(exp, get_fid_from_lsm);
1612         rc = MDP(exp->exp_obd, get_fid_from_lsm)(exp, lsm, name, namelen, fid);
1613         RETURN(rc);
1614 }
1615
1616
1617 /* Unpack an MD struct from disk to in-memory format.
1618  * Returns +ve size of unpacked MD (0 for free), or -ve error.
1619  *
1620  * If *plsm != NULL and lmm == NULL then *lsm will be freed.
1621  * If *plsm == NULL then it will be allocated.
1622  */
1623 static inline int md_unpackmd(struct obd_export *exp,
1624                               struct lmv_stripe_md **plsm,
1625                               const union lmv_mds_md *lmm, size_t lmm_size)
1626 {
1627         int rc;
1628         ENTRY;
1629         EXP_CHECK_MD_OP(exp, unpackmd);
1630         EXP_MD_COUNTER_INCREMENT(exp, unpackmd);
1631         rc = MDP(exp->exp_obd, unpackmd)(exp, plsm, lmm, lmm_size);
1632         RETURN(rc);
1633 }
1634
1635 /* OBD Metadata Support */
1636
1637 extern int obd_init_caches(void);
1638 extern void obd_cleanup_caches(void);
1639
1640 /* support routines */
1641 extern struct kmem_cache *obdo_cachep;
1642
1643 #define OBDO_ALLOC(ptr)                                                       \
1644 do {                                                                          \
1645         OBD_SLAB_ALLOC_PTR_GFP((ptr), obdo_cachep, GFP_NOFS);             \
1646 } while(0)
1647
1648 #define OBDO_FREE(ptr)                                                        \
1649 do {                                                                          \
1650         OBD_SLAB_FREE_PTR((ptr), obdo_cachep);                                \
1651 } while(0)
1652
1653
1654 typedef int (*register_lwp_cb)(void *data);
1655
1656 struct lwp_register_item {
1657         struct obd_export **lri_exp;
1658         register_lwp_cb     lri_cb_func;
1659         void               *lri_cb_data;
1660         struct list_head    lri_list;
1661         atomic_t            lri_ref;
1662         char                lri_name[MTI_NAME_MAXLEN];
1663 };
1664
1665 /* I'm as embarrassed about this as you are.
1666  *
1667  * <shaver> // XXX do not look into _superhack with remaining eye
1668  * <shaver> // XXX if this were any uglier, I'd get my own show on MTV */
1669 extern int (*ptlrpc_put_connection_superhack)(struct ptlrpc_connection *c);
1670
1671 /* obd_mount.c */
1672 #ifdef HAVE_SERVER_SUPPORT
1673 int lustre_register_lwp_item(const char *lwpname, struct obd_export **exp,
1674                              register_lwp_cb cb_func, void *cb_data);
1675 void lustre_deregister_lwp_item(struct obd_export **exp);
1676 struct obd_export *lustre_find_lwp_by_index(const char *dev, __u32 idx);
1677 void lustre_notify_lwp_list(struct obd_export *exp);
1678 int tgt_name2lwp_name(const char *tgt_name, char *lwp_name, int len, __u32 idx);
1679 #endif /* HAVE_SERVER_SUPPORT */
1680 int lustre_register_fs(void);
1681 int lustre_unregister_fs(void);
1682 int lustre_check_exclusion(struct super_block *sb, char *svname);
1683
1684 /* sysctl.c */
1685 extern void obd_sysctl_init (void);
1686 extern void obd_sysctl_clean (void);
1687
1688 /* uuid.c  */
1689 typedef __u8 class_uuid_t[16];
1690 void class_uuid_unparse(class_uuid_t in, struct obd_uuid *out);
1691
1692 /* lustre_peer.c    */
1693 int lustre_uuid_to_peer(const char *uuid, lnet_nid_t *peer_nid, int index);
1694 int class_add_uuid(const char *uuid, __u64 nid);
1695 int class_del_uuid (const char *uuid);
1696 int class_check_uuid(struct obd_uuid *uuid, __u64 nid);
1697 void class_init_uuidlist(void);
1698 void class_exit_uuidlist(void);
1699
1700 /* class_obd.c */
1701 extern char obd_jobid_node[];
1702
1703 /* prng.c */
1704 #define ll_generate_random_uuid(uuid_out) cfs_get_random_bytes(uuid_out, sizeof(class_uuid_t))
1705
1706 /* statfs_pack.c */
1707 struct kstatfs;
1708 void statfs_pack(struct obd_statfs *osfs, struct kstatfs *sfs);
1709 void statfs_unpack(struct kstatfs *sfs, struct obd_statfs *osfs);
1710
1711 /* root squash info */
1712 struct rw_semaphore;
1713 struct root_squash_info {
1714         uid_t                   rsi_uid;
1715         gid_t                   rsi_gid;
1716         struct list_head        rsi_nosquash_nids;
1717         struct rw_semaphore     rsi_sem;
1718 };
1719
1720 int server_name2index(const char *svname, __u32 *idx, const char **endptr);
1721
1722 /* linux-module.c */
1723 extern struct miscdevice obd_psdev;
1724 int class_procfs_init(void);
1725 int class_procfs_clean(void);
1726
1727 #endif /* __LINUX_OBD_CLASS_H */