4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2014, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
33 #ifndef __LUSTRE_HANDLES_H_
34 #define __LUSTRE_HANDLES_H_
36 /** \defgroup handles handles
41 #include <linux/rcupdate.h>
42 #ifdef HAVE_REFCOUNT_T
43 #include <linux/refcount.h>
45 #include <libcfs/linux/linux-refcount.h>
47 #include <linux/spinlock.h>
48 #include <libcfs/libcfs.h>
50 struct portals_handle_ops {
51 void (*hop_free)(void *object, int size);
52 /* hop_type is used for some debugging messages */
56 /* These handles are most easily used by having them appear at the very top of
57 * whatever object that you want to make handles for. ie:
60 * struct portals_handle handle;
64 * Now you're able to assign the results of cookie2handle directly to an
65 * ldlm_lock. If it's not at the top, you'll want to use container_of()
66 * to compute the start of the structure based on the handle field. */
67 struct portals_handle {
68 struct list_head h_link;
70 const struct portals_handle_ops *h_ops;
73 /* newly added fields to handle the RCU issue. -jxiong */
74 struct rcu_head h_rcu;
76 unsigned int h_size:31;
82 /* Add a handle to the hash table */
83 void class_handle_hash(struct portals_handle *,
84 const struct portals_handle_ops *ops);
85 void class_handle_unhash(struct portals_handle *);
86 void *class_handle2object(u64 cookie, const struct portals_handle_ops *ops);
87 void class_handle_free_cb(struct rcu_head *rcu);
88 int class_handle_init(void);
89 void class_handle_cleanup(void);