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) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
29 *
30 * Copyright (c) 2011, 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 __LIBCFS_LIBCFS_H__
38 #define __LIBCFS_LIBCFS_H__
39
40 #include "linux/libcfs.h"
41 #include <linux/gfp.h>
42
43 #include "curproc.h"
44
__is_po2(unsigned long long val)45 static inline int __is_po2(unsigned long long val)
46 {
47 return !(val & (val - 1));
48 }
49
50 #define IS_PO2(val) __is_po2((unsigned long long)(val))
51
52 #define LOWEST_BIT_SET(x) ((x) & ~((x) - 1))
53
54 /*
55 * Lustre Error Checksum: calculates checksum
56 * of Hex number by XORing each bit.
57 */
58 #define LERRCHKSUM(hexnum) (((hexnum) & 0xf) ^ ((hexnum) >> 4 & 0xf) ^ \
59 ((hexnum) >> 8 & 0xf))
60
61 #define LUSTRE_SRV_LNET_PID LUSTRE_LNET_PID
62
63 #include <linux/list.h>
64
65 /* need both kernel and user-land acceptor */
66 #define LNET_ACCEPTOR_MIN_RESERVED_PORT 512
67 #define LNET_ACCEPTOR_MAX_RESERVED_PORT 1023
68
69 /*
70 * libcfs pseudo device operations
71 *
72 * It's just draft now.
73 */
74
75 struct cfs_psdev_file {
76 unsigned long off;
77 void *private_data;
78 unsigned long reserved1;
79 unsigned long reserved2;
80 };
81
82 struct cfs_psdev_ops {
83 int (*p_open)(unsigned long, void *);
84 int (*p_close)(unsigned long, void *);
85 int (*p_read)(struct cfs_psdev_file *, char *, unsigned long);
86 int (*p_write)(struct cfs_psdev_file *, char *, unsigned long);
87 int (*p_ioctl)(struct cfs_psdev_file *, unsigned long, void *);
88 };
89
90 /*
91 * Drop into debugger, if possible. Implementation is provided by platform.
92 */
93
94 void cfs_enter_debugger(void);
95
96 /*
97 * Defined by platform
98 */
99 int unshare_fs_struct(void);
100 sigset_t cfs_get_blocked_sigs(void);
101 sigset_t cfs_block_allsigs(void);
102 sigset_t cfs_block_sigs(unsigned long sigs);
103 sigset_t cfs_block_sigsinv(unsigned long sigs);
104 void cfs_restore_sigs(sigset_t);
105 int cfs_signal_pending(void);
106 void cfs_clear_sigpending(void);
107
108 /*
109 * Random number handling
110 */
111
112 /* returns a random 32-bit integer */
113 unsigned int cfs_rand(void);
114 /* seed the generator */
115 void cfs_srand(unsigned int, unsigned int);
116 void cfs_get_random_bytes(void *buf, int size);
117
118 #include "libcfs_debug.h"
119 #include "libcfs_cpu.h"
120 #include "libcfs_private.h"
121 #include "libcfs_ioctl.h"
122 #include "libcfs_prim.h"
123 #include "libcfs_time.h"
124 #include "libcfs_string.h"
125 #include "libcfs_kernelcomm.h"
126 #include "libcfs_workitem.h"
127 #include "libcfs_hash.h"
128 #include "libcfs_fail.h"
129 #include "libcfs_crypto.h"
130
131 /* container_of depends on "likely" which is defined in libcfs_private.h */
__container_of(void * ptr,unsigned long shift)132 static inline void *__container_of(void *ptr, unsigned long shift)
133 {
134 if (IS_ERR_OR_NULL(ptr))
135 return ptr;
136 return (char *)ptr - shift;
137 }
138
139 #define container_of0(ptr, type, member) \
140 ((type *)__container_of((void *)(ptr), offsetof(type, member)))
141
142 #define _LIBCFS_H
143
144 void *libcfs_kvzalloc(size_t size, gfp_t flags);
145 void *libcfs_kvzalloc_cpt(struct cfs_cpt_table *cptab, int cpt, size_t size,
146 gfp_t flags);
147
148 extern struct miscdevice libcfs_dev;
149 /**
150 * The path of debug log dump upcall script.
151 */
152 extern char lnet_upcall[1024];
153 extern char lnet_debug_log_upcall[1024];
154
155 extern struct cfs_psdev_ops libcfs_psdev_ops;
156
157 extern struct cfs_wi_sched *cfs_sched_rehash;
158
159 struct lnet_debugfs_symlink_def {
160 char *name;
161 char *target;
162 };
163
164 void lustre_insert_debugfs(struct ctl_table *table,
165 const struct lnet_debugfs_symlink_def *symlinks);
166
167 #endif /* _LIBCFS_H */
168