+// SPDX-License-Identifier: GPL-2.0
/*
* Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
* Use is subject to license terms.
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
- * You should have received a copy of the GNU General Public License
- * along with Lustre; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
*/
#ifndef __LUSTRE_LU_REF_H
* who acquired references to instance of struct foo, add lu_ref field to it:
*
* \code
- * struct foo {
- * atomic_t foo_refcount;
- * struct lu_ref foo_reference;
- * ...
- * };
+ * struct foo {
+ * atomic_t foo_refcount;
+ * struct lu_ref foo_reference;
+ * ...
+ * };
* \endcode
*
* foo::foo_reference has to be initialized by calling
* usages are:
*
* \code
- * struct bar *bar;
+ * struct bar *bar;
*
- * // bar owns a reference to foo.
- * bar->bar_foo = foo_get(foo);
- * lu_ref_add(&foo->foo_reference, "bar", bar);
+ * // bar owns a reference to foo.
+ * bar->bar_foo = foo_get(foo);
+ * lu_ref_add(&foo->foo_reference, "bar", bar);
*
- * ...
+ * ...
*
- * // reference from bar to foo is released.
- * lu_ref_del(&foo->foo_reference, "bar", bar);
- * foo_put(bar->bar_foo);
+ * // reference from bar to foo is released.
+ * lu_ref_del(&foo->foo_reference, "bar", bar);
+ * foo_put(bar->bar_foo);
*
*
- * // current thread acquired a temporary reference to foo.
- * foo_get(foo);
- * lu_ref_add(&foo->reference, __FUNCTION__, current);
+ * // current thread acquired a temporary reference to foo.
+ * foo_get(foo);
+ * lu_ref_add(&foo->reference, __func__, current);
*
- * ...
+ * ...
*
- * // temporary reference is released.
- * lu_ref_del(&foo->reference, __FUNCTION__, current);
- * foo_put(foo);
+ * // temporary reference is released.
+ * lu_ref_del(&foo->reference, __func__, current);
+ * foo_put(foo);
* \endcode
*
* \e Et \e cetera. Often it makes sense to include lu_ref_add() and
* lu_ref_del_at():
*
* \code
- * // There is a large number of bar's for a single foo.
- * bar->bar_foo = foo_get(foo);
- * bar->bar_foo_ref = lu_ref_add(&foo->foo_reference, "bar", bar);
+ * // There is a large number of bar's for a single foo.
+ * bar->bar_foo = foo_get(foo);
+ * bar->bar_foo_ref = lu_ref_add(&foo->foo_reference, "bar", bar);
*
- * ...
+ * ...
*
- * // reference from bar to foo is released.
- * lu_ref_del_at(&foo->foo_reference, bar->bar_foo_ref, "bar", bar);
- * foo_put(bar->bar_foo);
+ * // reference from bar to foo is released.
+ * lu_ref_del_at(&foo->foo_reference, bar->bar_foo_ref, "bar", bar);
+ * foo_put(bar->bar_foo);
* \endcode
*
* lu_ref interface degrades gracefully in case of memory shortages.
* @{
*/
-#ifdef USE_LU_REF
+#ifdef CONFIG_LUSTRE_DEBUG_LU_REF
/**
* Data-structure to keep track of references to a given object. This is used
* lu_ref_link), pointing to this object.
*/
struct list_head lf_list;
- /**
- * # of links.
- */
- short lf_refs;
- /**
- * Flag set when lu_ref_add() failed to allocate lu_ref_link. It is
- * used to mask spurious failure of the following lu_ref_del().
- */
- short lf_failed;
- /**
- * flags - attribute for the lu_ref, for pad and future use.
- */
- short lf_flags;
- /**
- * Where was I initialized?
- */
- short lf_line;
- const char *lf_func;
- /**
- * Linkage into a global list of all lu_ref's (lu_ref_refs).
- */
+ /**
+ * # of links.
+ */
+ short lf_refs;
+ /**
+ * Flag set when lu_ref_add() failed to allocate lu_ref_link. It is
+ * used to mask spurious failure of the following lu_ref_del().
+ */
+ short lf_failed;
+ /**
+ * flags - attribute for the lu_ref, for pad and future use.
+ */
+ short lf_flags;
+ /**
+ * Where was I initialized?
+ */
+ short lf_line;
+ const char *lf_func;
+ /**
+ * Linkage into a global list of all lu_ref's (lu_ref_refs).
+ */
struct list_head lf_linkage;
};
};
void lu_ref_init_loc(struct lu_ref *ref, const char *func, const int line);
-void lu_ref_fini (struct lu_ref *ref);
-#define lu_ref_init(ref) lu_ref_init_loc(ref, __FUNCTION__, __LINE__)
+void lu_ref_fini(struct lu_ref *ref);
+#define lu_ref_init(ref) lu_ref_init_loc(ref, __func__, __LINE__)
void lu_ref_add(struct lu_ref *ref, const char *scope, const void *source);
void lu_ref_global_fini(void);
-#else /* !USE_LU_REF */
+#else /* !CONFIG_LUSTRE_DEBUG_LU_REF */
struct lu_ref {
};
}
static inline void lu_ref_del(struct lu_ref *ref, const char *scope,
- const void *source)
+ const void *source)
{
}
static inline void lu_ref_set_at(struct lu_ref *ref, struct lu_ref_link *link,
- const char *scope, const void *source0,
- const void *source1)
+ const char *scope, const void *source0,
+ const void *source1)
{
}
static inline void lu_ref_del_at(struct lu_ref *ref, struct lu_ref_link *link,
- const char *scope, const void *source)
+ const char *scope, const void *source)
{
}
static inline int lu_ref_global_init(void)
{
- return 0;
+ return 0;
}
static inline void lu_ref_global_fini(void)
static inline void lu_ref_print_all(void)
{
}
-#endif /* USE_LU_REF */
+#endif /* CONFIG_LUSTRE_DEBUG_LU_REF */
/** @} lu */
+// SPDX-License-Identifier: GPL-2.0
/*
* GPL HEADER START
*
#define DEBUG_SUBSYSTEM S_CLASS
-#include <libcfs/libcfs.h>
#include <obd.h>
#include <obd_class.h>
#include <obd_support.h>
#include <lu_ref.h>
-#ifdef USE_LU_REF
-
+#ifdef CONFIG_LUSTRE_DEBUG_LU_REF
/**
* Asserts a condition for a given lu_ref. Must be called with
* lu_ref::lf_guard held.
struct lu_ref_link *link;
link = NULL;
- if (lu_ref_link_kmem != NULL) {
+ if (lu_ref_link_kmem) {
OBD_SLAB_ALLOC_PTR_GFP(link, lu_ref_link_kmem, flags);
- if (link != NULL) {
+ if (link) {
link->ll_ref = ref;
link->ll_scope = scope;
link->ll_source = source;
}
}
- if (link == NULL) {
+ if (!link) {
spin_lock(&ref->lf_guard);
ref->lf_failed++;
spin_unlock(&ref->lf_guard);
/**
* Maximal chain length seen so far.
*/
-static unsigned lu_ref_chain_max_length = 127;
+static unsigned int lu_ref_chain_max_length = 127;
/**
* Searches for a lu_ref_link with given [scope, source] within given lu_ref.
*/
static struct lu_ref_link *lu_ref_find(struct lu_ref *ref, const char *scope,
- const void *source)
+ const void *source)
{
struct lu_ref_link *link;
unsigned int iterations;
spin_lock(&ref->lf_guard);
link = lu_ref_find(ref, scope, source);
- if (link != NULL) {
+ if (link) {
list_del(&link->ll_linkage);
ref->lf_refs--;
spin_unlock(&ref->lf_guard);
const void *source0, const void *source1)
{
spin_lock(&ref->lf_guard);
- REFASSERT(ref, link != NULL && !IS_ERR(link));
+ REFASSERT(ref, !IS_ERR_OR_NULL(link));
REFASSERT(ref, link->ll_ref == ref);
REFASSERT(ref, lu_ref_link_eq(link, scope, source0));
link->ll_source = source1;
const char *scope, const void *source)
{
spin_lock(&ref->lf_guard);
- REFASSERT(ref, link != NULL && !IS_ERR(link));
+ REFASSERT(ref, !IS_ERR_OR_NULL(link));
REFASSERT(ref, link->ll_ref == ref);
REFASSERT(ref, lu_ref_link_eq(link, scope, source));
list_del(&link->ll_linkage);
}
static const struct seq_operations lu_ref_seq_ops = {
- .start = lu_ref_seq_start,
- .stop = lu_ref_seq_stop,
- .next = lu_ref_seq_next,
- .show = lu_ref_seq_show
+ .start = lu_ref_seq_start,
+ .stop = lu_ref_seq_stop,
+ .next = lu_ref_seq_next,
+ .show = lu_ref_seq_show
};
static int lu_ref_seq_open(struct inode *inode, struct file *file)
lu_kmem_fini(lu_ref_caches);
}
-#endif /* USE_LU_REF */
+#endif /* CONFIG_LUSTRE_DEBUG_LU_REF */
git://git.whamcloud.com / fs / lustre-release.git / commitdiff