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.sun.com/software/products/lustre/docs/GPLv2.pdf
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
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2012, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 #ifndef __LUSTRE_HANDLES_H_
38 #define __LUSTRE_HANDLES_H_
40 /** \defgroup handles handles
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>
52 #error Unsupported operating system.
55 #include <libcfs/libcfs.h>
63 struct portals_handle_ops {
64 void (*hop_addref)(void *object);
65 void (*hop_free)(void *object, int size);
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:
72 * struct portals_handle handle;
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 {
82 struct portals_handle_ops *h_ops;
84 /* newly added fields to handle the RCU issue. -jxiong */
87 unsigned int h_size:31;
90 #define RCU2HANDLE(rcu) container_of(rcu, struct portals_handle, h_rcu)
94 /* Add a handle to the hash table */
95 void class_handle_hash(struct portals_handle *,
96 struct portals_handle_ops *ops);
97 void class_handle_unhash(struct portals_handle *);
98 void class_handle_hash_back(struct portals_handle *);
99 void *class_handle2object(__u64 cookie);
100 void class_handle_free_cb(cfs_rcu_head_t *);
101 int class_handle_init(void);
102 void class_handle_cleanup(void);