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