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) 2008, 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 __LIBCFS_LIBCFS_H__
38 #define __LIBCFS_LIBCFS_H__
41 #define __attribute__(x)
44 #include "linux/libcfs.h"
45 #include <linux/gfp.h>
50 # define offsetof(typ, memb) ((long)(long_ptr_t)((char *)&(((typ *)0)->memb)))
54 #define ARRAY_SIZE(a) ((sizeof(a)) / (sizeof((a)[0])))
58 #define swap(x, y) do { typeof(x) z = x; x = y; y = z; } while (0)
61 #if !defined(container_of)
62 /* given a pointer @ptr to the field @member embedded into type (usually
63 * struct) @type, return pointer to the embedding instance of @type. */
64 #define container_of(ptr, type, member) \
65 ((type *)((char *)(ptr)-(char *)(&((type *)0)->member)))
68 static inline int __is_po2(unsigned long long val)
70 return !(val & (val - 1));
73 #define IS_PO2(val) __is_po2((unsigned long long)(val))
75 #define LOWEST_BIT_SET(x) ((x) & ~((x) - 1))
78 * Lustre Error Checksum: calculates checksum
79 * of Hex number by XORing each bit.
81 #define LERRCHKSUM(hexnum) (((hexnum) & 0xf) ^ ((hexnum) >> 4 & 0xf) ^ \
82 ((hexnum) >> 8 & 0xf))
84 #define LUSTRE_SRV_LNET_PID LUSTRE_LNET_PID
86 #include <linux/list.h>
88 int libcfs_arch_init(void);
89 void libcfs_arch_cleanup(void);
92 int libcfs_ipif_query(char *name, int *up, __u32 *ip, __u32 *mask);
93 int libcfs_ipif_enumerate(char ***names);
94 void libcfs_ipif_free_enumeration(char **names, int n);
95 int libcfs_sock_listen(struct socket **sockp, __u32 ip, int port, int backlog);
96 int libcfs_sock_accept(struct socket **newsockp, struct socket *sock);
97 void libcfs_sock_abort_accept(struct socket *sock);
98 int libcfs_sock_connect(struct socket **sockp, int *fatal,
99 __u32 local_ip, int local_port,
100 __u32 peer_ip, int peer_port);
101 int libcfs_sock_setbuf(struct socket *socket, int txbufsize, int rxbufsize);
102 int libcfs_sock_getbuf(struct socket *socket, int *txbufsize, int *rxbufsize);
103 int libcfs_sock_getaddr(struct socket *socket, int remote, __u32 *ip, int *port);
104 int libcfs_sock_write(struct socket *sock, void *buffer, int nob, int timeout);
105 int libcfs_sock_read(struct socket *sock, void *buffer, int nob, int timeout);
106 void libcfs_sock_release(struct socket *sock);
108 /* need both kernel and user-land acceptor */
109 #define LNET_ACCEPTOR_MIN_RESERVED_PORT 512
110 #define LNET_ACCEPTOR_MAX_RESERVED_PORT 1023
113 * libcfs pseudo device operations
115 * It's just draft now.
118 struct cfs_psdev_file {
121 unsigned long reserved1;
122 unsigned long reserved2;
125 struct cfs_psdev_ops {
126 int (*p_open)(unsigned long, void *);
127 int (*p_close)(unsigned long, void *);
128 int (*p_read)(struct cfs_psdev_file *, char *, unsigned long);
129 int (*p_write)(struct cfs_psdev_file *, char *, unsigned long);
130 int (*p_ioctl)(struct cfs_psdev_file *, unsigned long, void *);
134 * Drop into debugger, if possible. Implementation is provided by platform.
137 void cfs_enter_debugger(void);
140 * Defined by platform
142 int unshare_fs_struct(void);
143 sigset_t cfs_get_blocked_sigs(void);
144 sigset_t cfs_block_allsigs(void);
145 sigset_t cfs_block_sigs(unsigned long sigs);
146 sigset_t cfs_block_sigsinv(unsigned long sigs);
147 void cfs_restore_sigs(sigset_t);
148 int cfs_signal_pending(void);
149 void cfs_clear_sigpending(void);
152 * Random number handling
155 /* returns a random 32-bit integer */
156 unsigned int cfs_rand(void);
157 /* seed the generator */
158 void cfs_srand(unsigned int, unsigned int);
159 void cfs_get_random_bytes(void *buf, int size);
161 #include "libcfs_debug.h"
162 #include "libcfs_cpu.h"
163 #include "libcfs_private.h"
164 #include "libcfs_ioctl.h"
165 #include "libcfs_prim.h"
166 #include "libcfs_time.h"
167 #include "libcfs_string.h"
168 #include "libcfs_kernelcomm.h"
169 #include "libcfs_workitem.h"
170 #include "libcfs_hash.h"
171 #include "libcfs_fail.h"
172 #include "libcfs_crypto.h"
174 /* container_of depends on "likely" which is defined in libcfs_private.h */
175 static inline void *__container_of(void *ptr, unsigned long shift)
177 if (unlikely(IS_ERR(ptr) || ptr == NULL))
179 return (char *)ptr - shift;
182 #define container_of0(ptr, type, member) \
183 ((type *)__container_of((void *)(ptr), offsetof(type, member)))
187 #endif /* _LIBCFS_H */