LU-3963 obdclass: convert to linux list api

[fs/lustre-release.git] / lustre / include / lustre_handles.h

diff --git a/lustre/include/lustre_handles.h b/lustre/include/lustre_handles.h
index 67af012..ac70270 100644 (file)
--- a/lustre/include/lustre_handles.h
+++ b/lustre/include/lustre_handles.h
@@ -1,6 +1,4 @@
-/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
- * vim:expandtab:shiftwidth=8:tabstop=8:
- *
+/*
  * GPL HEADER START
  *
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
@@ -16,8 +14,8 @@
  * in the LICENSE file that accompanied this code).
  *
  * You should have received a copy of the GNU General Public License
- * version 2 along with this program; If not, see [sun.com URL with a
- * copy of GPLv2].
+ * version 2 along with this program; If not, see
+ * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  *
  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  * CA 95054 USA or visit www.sun.com if you need additional information or
@@ -26,8 +24,10 @@
  * GPL HEADER END
  */
 /*
- * Copyright  2008 Sun Microsystems, Inc. All rights reserved
+ * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
+ *
+ * Copyright (c) 2012, Intel Corporation.
  */
 /*
  * This file is part of Lustre, http://www.lustre.org/
@@ -37,6 +37,11 @@
 #ifndef __LUSTRE_HANDLES_H_
 #define __LUSTRE_HANDLES_H_
 
+/** \defgroup handles handles
+ *
+ * @{
+ */
+
 #if defined(__linux__)
 #include <linux/lustre_handles.h>
 #elif defined(__APPLE__)
@@ -47,7 +52,18 @@
 #error Unsupported operating system.
 #endif
 
-typedef void (*portals_handle_addref_cb)(void *object);
+#include <libcfs/libcfs.h>
+
+#ifndef __KERNEL__
+typedef struct {
+       int foo;
+} cfs_rcu_head_t;
+#endif
+
+struct portals_handle_ops {
+       void (*hop_addref)(void *object);
+       void (*hop_free)(void *object, int size);
+};
 
 /* These handles are most easily used by having them appear at the very top of
  * whatever object that you want to make handles for.  ie:
@@ -58,34 +74,34 @@ typedef void (*portals_handle_addref_cb)(void *object);
  * };
  *
  * Now you're able to assign the results of cookie2handle directly to an
- * ldlm_lock.  If it's not at the top, you'll want to hack up a macro that
- * uses some offsetof() magic. */
-
+ * ldlm_lock.  If it's not at the top, you'll want to use container_of()
+ * to compute the start of the structure based on the handle field. */
 struct portals_handle {
-        struct list_head h_link;
-        __u64 h_cookie;
-        portals_handle_addref_cb h_addref;
+       struct list_head                h_link;
+       __u64                           h_cookie;
+       const void                     *h_owner;
+       struct portals_handle_ops      *h_ops;
 
-        /* newly added fields to handle the RCU issue. -jxiong */
-        spinlock_t h_lock;
-        void *h_ptr;
-        void (*h_free_cb)(void *, size_t);
-        struct rcu_head h_rcu;
-        unsigned int h_size;
-        __u8 h_in:1;
-        __u8 h_unused[3];
+       /* newly added fields to handle the RCU issue. -jxiong */
+       cfs_rcu_head_t                  h_rcu;
+       spinlock_t                      h_lock;
+       unsigned int                    h_size:31;
+       unsigned int                    h_in:1;
 };
 #define RCU2HANDLE(rcu)    container_of(rcu, struct portals_handle, h_rcu)
 
 /* handles.c */
 
 /* Add a handle to the hash table */
-void class_handle_hash(struct portals_handle *, portals_handle_addref_cb);
+void class_handle_hash(struct portals_handle *,
+                      struct portals_handle_ops *ops);
 void class_handle_unhash(struct portals_handle *);
 void class_handle_hash_back(struct portals_handle *);
-void *class_handle2object(__u64 cookie);
-void class_handle_free_cb(struct rcu_head *);
+void *class_handle2object(__u64 cookie, const void *owner);
+void class_handle_free_cb(cfs_rcu_head_t *);
 int class_handle_init(void);
 void class_handle_cleanup(void);
 
+/** @} handles */
+
 #endif