Whamcloud - gitweb
41670d561d34b4bac4c5758f66ea29612087bd98
[fs/lustre-release.git] / lustre / include / lustre_handles.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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2012, 2014, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  */
32
33 #ifndef __LUSTRE_HANDLES_H_
34 #define __LUSTRE_HANDLES_H_
35
36 /** \defgroup handles handles
37  *
38  * @{
39  */
40
41 #include <linux/rcupdate.h>
42 #ifdef HAVE_REFCOUNT_T
43 #include <linux/refcount.h>
44 #else
45 #include <libcfs/linux/linux-refcount.h>
46 #endif
47 #include <linux/spinlock.h>
48 #include <libcfs/libcfs.h>
49
50 /* These handles are most easily used by having them appear at the very top of
51  * whatever object that you want to make handles for.  ie:
52  *
53  * struct ldlm_lock {
54  *         struct portals_handle handle;
55  *         ...
56  * };
57  *
58  * Now you're able to assign the results of cookie2handle directly to an
59  * ldlm_lock.  If it's not at the top, you'll want to use container_of()
60  * to compute the start of the structure based on the handle field. */
61 struct portals_handle {
62         struct list_head                h_link;
63         __u64                           h_cookie;
64         const char                      *h_owner;
65         refcount_t                      h_ref;
66
67         /* newly added fields to handle the RCU issue. -jxiong */
68         struct rcu_head                 h_rcu;
69         spinlock_t                      h_lock;
70         unsigned int                    h_in:1;
71 };
72
73 /* handles.c */
74
75 /* Add a handle to the hash table */
76 void class_handle_hash(struct portals_handle *, const char *h_owner);
77 void class_handle_unhash(struct portals_handle *);
78 void *class_handle2object(u64 cookie, const char *h_owner);
79 int class_handle_init(void);
80 void class_handle_cleanup(void);
81
82 /** @} handles */
83
84 #endif