Whamcloud - gitweb
LU-3963 obdclass: convert to linux list api
[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.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) 2012, 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
37 #ifndef __LUSTRE_HANDLES_H_
38 #define __LUSTRE_HANDLES_H_
39
40 /** \defgroup handles handles
41  *
42  * @{
43  */
44
45 #if defined(__linux__)
46 #include <linux/lustre_handles.h>
47 #elif defined(__APPLE__)
48 #include <darwin/lustre_handles.h>
49 #elif defined(__WINNT__)
50 #include <winnt/lustre_handles.h>
51 #else
52 #error Unsupported operating system.
53 #endif
54
55 #include <libcfs/libcfs.h>
56
57 #ifndef __KERNEL__
58 typedef struct {
59         int foo;
60 } cfs_rcu_head_t;
61 #endif
62
63 struct portals_handle_ops {
64         void (*hop_addref)(void *object);
65         void (*hop_free)(void *object, int size);
66 };
67
68 /* These handles are most easily used by having them appear at the very top of
69  * whatever object that you want to make handles for.  ie:
70  *
71  * struct ldlm_lock {
72  *         struct portals_handle handle;
73  *         ...
74  * };
75  *
76  * Now you're able to assign the results of cookie2handle directly to an
77  * ldlm_lock.  If it's not at the top, you'll want to use container_of()
78  * to compute the start of the structure based on the handle field. */
79 struct portals_handle {
80         struct list_head                h_link;
81         __u64                           h_cookie;
82         const void                     *h_owner;
83         struct portals_handle_ops      *h_ops;
84
85         /* newly added fields to handle the RCU issue. -jxiong */
86         cfs_rcu_head_t                  h_rcu;
87         spinlock_t                      h_lock;
88         unsigned int                    h_size:31;
89         unsigned int                    h_in:1;
90 };
91 #define RCU2HANDLE(rcu)    container_of(rcu, struct portals_handle, h_rcu)
92
93 /* handles.c */
94
95 /* Add a handle to the hash table */
96 void class_handle_hash(struct portals_handle *,
97                        struct portals_handle_ops *ops);
98 void class_handle_unhash(struct portals_handle *);
99 void class_handle_hash_back(struct portals_handle *);
100 void *class_handle2object(__u64 cookie, const void *owner);
101 void class_handle_free_cb(cfs_rcu_head_t *);
102 int class_handle_init(void);
103 void class_handle_cleanup(void);
104
105 /** @} handles */
106
107 #endif