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