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/linux/libcfs.h>
49 # define offsetof(typ,memb) ((long)(long_ptr_t)((char *)&(((typ *)0)->memb)))
53 #define ARRAY_SIZE(a) ((sizeof (a)) / (sizeof ((a)[0])))
57 #define swap(x,y) do { typeof(x) z = x; x = y; y = z; } while (0)
60 #if !defined(container_of)
61 /* given a pointer @ptr to the field @member embedded into type (usually
62 * struct) @type, return pointer to the embedding instance of @type. */
63 #define container_of(ptr, type, member) \
64 ((type *)((char *)(ptr)-(char *)(&((type *)0)->member)))
67 static inline int __is_po2(unsigned long long val)
69 return !(val & (val - 1));
72 #define IS_PO2(val) __is_po2((unsigned long long)(val))
74 #define LOWEST_BIT_SET(x) ((x) & ~((x) - 1))
77 * Lustre Error Checksum: calculates checksum
78 * of Hex number by XORing each bit.
80 #define LERRCHKSUM(hexnum) (((hexnum) & 0xf) ^ ((hexnum) >> 4 & 0xf) ^ \
81 ((hexnum) >> 8 & 0xf))
83 #define LUSTRE_SRV_LNET_PID LUSTRE_LNET_PID
85 #include <linux/list.h>
88 int libcfs_ipif_query(char *name, int *up, __u32 *ip, __u32 *mask);
89 int libcfs_ipif_enumerate(char ***names);
90 void libcfs_ipif_free_enumeration(char **names, int n);
91 int libcfs_sock_listen(socket_t **sockp, __u32 ip, int port, int backlog);
92 int libcfs_sock_accept(socket_t **newsockp, socket_t *sock);
93 void libcfs_sock_abort_accept(socket_t *sock);
94 int libcfs_sock_connect(socket_t **sockp, int *fatal,
95 __u32 local_ip, int local_port,
96 __u32 peer_ip, int peer_port);
97 int libcfs_sock_setbuf(socket_t *socket, int txbufsize, int rxbufsize);
98 int libcfs_sock_getbuf(socket_t *socket, int *txbufsize, int *rxbufsize);
99 int libcfs_sock_getaddr(socket_t *socket, int remote, __u32 *ip, int *port);
100 int libcfs_sock_write(socket_t *sock, void *buffer, int nob, int timeout);
101 int libcfs_sock_read(socket_t *sock, void *buffer, int nob, int timeout);
102 void libcfs_sock_release(socket_t *sock);
104 /* need both kernel and user-land acceptor */
105 #define LNET_ACCEPTOR_MIN_RESERVED_PORT 512
106 #define LNET_ACCEPTOR_MAX_RESERVED_PORT 1023
109 * libcfs pseudo device operations
111 * It's just draft now.
114 struct cfs_psdev_file {
117 unsigned long reserved1;
118 unsigned long reserved2;
121 struct cfs_psdev_ops {
122 int (*p_open)(unsigned long, void *);
123 int (*p_close)(unsigned long, void *);
124 int (*p_read)(struct cfs_psdev_file *, char *, unsigned long);
125 int (*p_write)(struct cfs_psdev_file *, char *, unsigned long);
126 int (*p_ioctl)(struct cfs_psdev_file *, unsigned long, void *);
130 * Drop into debugger, if possible. Implementation is provided by platform.
133 void cfs_enter_debugger(void);
136 * Defined by platform
138 int unshare_fs_struct(void);
139 sigset_t cfs_get_blocked_sigs(void);
140 sigset_t cfs_block_allsigs(void);
141 sigset_t cfs_block_sigs(unsigned long sigs);
142 sigset_t cfs_block_sigsinv(unsigned long sigs);
143 void cfs_restore_sigs(sigset_t);
144 int cfs_signal_pending(void);
145 void cfs_clear_sigpending(void);
148 * Random number handling
151 /* returns a random 32-bit integer */
152 unsigned int cfs_rand(void);
153 /* seed the generator */
154 void cfs_srand(unsigned int, unsigned int);
155 void cfs_get_random_bytes(void *buf, int size);
157 #include <linux/libcfs/libcfs_debug.h>
158 #include <linux/libcfs/libcfs_cpu.h>
159 #include <linux/libcfs/libcfs_private.h>
160 #include <linux/libcfs/libcfs_ioctl.h>
161 #include <linux/libcfs/libcfs_prim.h>
162 #include <linux/libcfs/libcfs_time.h>
163 #include <linux/libcfs/libcfs_string.h>
164 #include <linux/libcfs/libcfs_kernelcomm.h>
165 #include <linux/libcfs/libcfs_workitem.h>
166 #include <linux/libcfs/libcfs_hash.h>
167 #include <linux/libcfs/libcfs_heap.h>
168 #include <linux/libcfs/libcfs_fail.h>
169 #include <linux/libcfs/params_tree.h>
170 #include <linux/libcfs/libcfs_crypto.h>
172 /* container_of depends on "likely" which is defined in libcfs_private.h */
173 static inline void *__container_of(void *ptr, unsigned long shift)
175 if (unlikely(IS_ERR(ptr) || ptr == NULL))
178 return (char *)ptr - shift;
181 #define container_of0(ptr, type, member) \
182 ((type *)__container_of((void *)(ptr), offsetof(type, member)))
186 #endif /* _LIBCFS_H */