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