Whamcloud - gitweb
LU-12542 handle: discard h_lock.
[fs/lustre-release.git] / lustre / include / lustre_handles.h
index cf6b403..e94e1f6 100644 (file)
@@ -1,17 +1,51 @@
+/*
+ * GPL HEADER START
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 only,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License version 2 for more details (a copy is included
+ * 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
+ * http://www.gnu.org/licenses/gpl-2.0.html
+ *
+ * GPL HEADER END
+ */
+/*
+ * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
+ * Use is subject to license terms.
+ *
+ * Copyright (c) 2012, 2014, Intel Corporation.
+ */
+/*
+ * This file is part of Lustre, http://www.lustre.org/
+ * Lustre is a trademark of Sun Microsystems, Inc.
+ */
+
 #ifndef __LUSTRE_HANDLES_H_
 #define __LUSTRE_HANDLES_H_
 
-#if defined(__linux__)
-#include <linux/lustre_handles.h>
-#elif defined(__APPLE__)
-#include <darwin/lustre_handles.h>
-#elif defined(__WINNT__)
-#include <winnt/lustre_handles.h>
+/** \defgroup handles handles
+ *
+ * @{
+ */
+
+#include <linux/rcupdate.h>
+#ifdef HAVE_REFCOUNT_T
+#include <linux/refcount.h>
 #else
-#error Unsupported operating system.
+#include <libcfs/linux/linux-refcount.h>
 #endif
-
-typedef void (*portals_handle_addref_cb)(void *object);
+#include <linux/spinlock.h>
+#include <libcfs/libcfs.h>
 
 /* 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:
@@ -22,32 +56,25 @@ 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;
-
-        /* newly added fields to handle the RCU issue. -jxiong */
-        spinlock_t h_lock;
-        unsigned int h_size;
-        void *h_ptr;
-        void (*h_free_cb)(void *, size_t);
-        struct rcu_head h_rcu;
+       struct hlist_node               h_link;
+       __u64                           h_cookie;
+       const char                      *h_owner;
+       refcount_t                      h_ref;
+       struct rcu_head                 h_rcu;
 };
-#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 *, const char *h_owner);
 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 char *h_owner);
 int class_handle_init(void);
 void class_handle_cleanup(void);
 
+/** @} handles */
+
 #endif