Commit | Line | Data |
---|---|---|
b97bf3fd PL |
1 | /* |
2 | * net/tipc/core.h: Include file for TIPC global declarations | |
c4307285 | 3 | * |
593a5f22 | 4 | * Copyright (c) 2005-2006, Ericsson AB |
4132faca | 5 | * Copyright (c) 2005-2007, 2010-2011, Wind River Systems |
b97bf3fd PL |
6 | * All rights reserved. |
7 | * | |
9ea1fd3c | 8 | * Redistribution and use in source and binary forms, with or without |
b97bf3fd PL |
9 | * modification, are permitted provided that the following conditions are met: |
10 | * | |
9ea1fd3c PL |
11 | * 1. Redistributions of source code must retain the above copyright |
12 | * notice, this list of conditions and the following disclaimer. | |
13 | * 2. Redistributions in binary form must reproduce the above copyright | |
14 | * notice, this list of conditions and the following disclaimer in the | |
15 | * documentation and/or other materials provided with the distribution. | |
16 | * 3. Neither the names of the copyright holders nor the names of its | |
17 | * contributors may be used to endorse or promote products derived from | |
18 | * this software without specific prior written permission. | |
b97bf3fd | 19 | * |
9ea1fd3c PL |
20 | * Alternatively, this software may be distributed under the terms of the |
21 | * GNU General Public License ("GPL") version 2 as published by the Free | |
22 | * Software Foundation. | |
23 | * | |
24 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
25 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
26 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
27 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE | |
28 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |
29 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |
30 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |
31 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |
32 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
33 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
b97bf3fd PL |
34 | * POSSIBILITY OF SUCH DAMAGE. |
35 | */ | |
36 | ||
37 | #ifndef _TIPC_CORE_H | |
38 | #define _TIPC_CORE_H | |
39 | ||
5f7c3ff6 JM |
40 | #include <linux/tipc.h> |
41 | #include <linux/tipc_config.h> | |
b97bf3fd PL |
42 | #include <linux/types.h> |
43 | #include <linux/kernel.h> | |
44 | #include <linux/errno.h> | |
45 | #include <linux/mm.h> | |
46 | #include <linux/timer.h> | |
47 | #include <linux/string.h> | |
48 | #include <asm/uaccess.h> | |
49 | #include <linux/interrupt.h> | |
50 | #include <asm/atomic.h> | |
51 | #include <asm/hardirq.h> | |
52 | #include <linux/netdevice.h> | |
c4307285 | 53 | #include <linux/in.h> |
b97bf3fd | 54 | #include <linux/list.h> |
5a0e3ad6 | 55 | #include <linux/slab.h> |
b97bf3fd PL |
56 | #include <linux/vmalloc.h> |
57 | ||
107e7be6 AS |
58 | |
59 | #define TIPC_MOD_VER "2.0.0" | |
60 | ||
d265fef6 | 61 | struct tipc_msg; /* msg.h */ |
f5e75269 | 62 | struct print_buf; /* log.h */ |
d265fef6 | 63 | |
b97bf3fd | 64 | /* |
6063da9d | 65 | * TIPC sanity test macros |
b97bf3fd PL |
66 | */ |
67 | ||
68 | #define assert(i) BUG_ON(!(i)) | |
69 | ||
b97bf3fd | 70 | /* |
6063da9d | 71 | * TIPC system monitoring code |
b97bf3fd PL |
72 | */ |
73 | ||
c4307285 | 74 | /* |
6063da9d | 75 | * TIPC's print buffer subsystem supports the following print buffers: |
b97bf3fd | 76 | * |
6063da9d AS |
77 | * TIPC_NULL : null buffer (i.e. print nowhere) |
78 | * TIPC_CONS : system console | |
79 | * TIPC_LOG : TIPC log buffer | |
80 | * &buf : user-defined buffer (struct print_buf *) | |
c8903985 AS |
81 | * |
82 | * Note: TIPC_LOG is configured to echo its output to the system console; | |
83 | * user-defined buffers can be configured to do the same thing. | |
b97bf3fd | 84 | */ |
6063da9d | 85 | extern struct print_buf *const TIPC_NULL; |
6e7e309c | 86 | extern struct print_buf *const TIPC_CONS; |
6063da9d AS |
87 | extern struct print_buf *const TIPC_LOG; |
88 | ||
89 | void tipc_printf(struct print_buf *, const char *fmt, ...); | |
6063da9d AS |
90 | |
91 | /* | |
92 | * TIPC_OUTPUT is the destination print buffer for system messages. | |
93 | */ | |
94 | ||
b97bf3fd | 95 | #ifndef TIPC_OUTPUT |
c8903985 | 96 | #define TIPC_OUTPUT TIPC_LOG |
b97bf3fd PL |
97 | #endif |
98 | ||
6063da9d | 99 | #define err(fmt, arg...) tipc_printf(TIPC_OUTPUT, \ |
6e7e309c | 100 | KERN_ERR "TIPC: " fmt, ## arg) |
6063da9d | 101 | #define warn(fmt, arg...) tipc_printf(TIPC_OUTPUT, \ |
6e7e309c | 102 | KERN_WARNING "TIPC: " fmt, ## arg) |
6063da9d | 103 | #define info(fmt, arg...) tipc_printf(TIPC_OUTPUT, \ |
6e7e309c | 104 | KERN_NOTICE "TIPC: " fmt, ## arg) |
6063da9d | 105 | |
6e7e309c | 106 | #ifdef CONFIG_TIPC_DEBUG |
b97bf3fd | 107 | |
6063da9d AS |
108 | /* |
109 | * DBG_OUTPUT is the destination print buffer for debug messages. | |
6063da9d AS |
110 | */ |
111 | ||
112 | #ifndef DBG_OUTPUT | |
6e7e309c | 113 | #define DBG_OUTPUT TIPC_LOG |
6063da9d | 114 | #endif |
a4e09279 | 115 | |
6e7e309c | 116 | #define dbg(fmt, arg...) tipc_printf(DBG_OUTPUT, KERN_DEBUG fmt, ## arg); |
a4e09279 | 117 | |
6e7e309c | 118 | #define msg_dbg(msg, txt) tipc_msg_dbg(DBG_OUTPUT, msg, txt); |
6063da9d | 119 | |
48c97139 | 120 | void tipc_msg_dbg(struct print_buf *, struct tipc_msg *, const char *); |
48c97139 | 121 | |
6063da9d AS |
122 | #else |
123 | ||
124 | #define dbg(fmt, arg...) do {} while (0) | |
125 | #define msg_dbg(msg, txt) do {} while (0) | |
48c97139 | 126 | |
6e7e309c | 127 | #define tipc_msg_dbg(buf, msg, txt) do {} while (0) |
a4e09279 | 128 | |
c4307285 | 129 | #endif |
b97bf3fd PL |
130 | |
131 | ||
c4307285 | 132 | /* |
b97bf3fd PL |
133 | * TIPC-specific error codes |
134 | */ | |
135 | ||
136 | #define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */ | |
137 | ||
d265fef6 AS |
138 | /* |
139 | * TIPC operating mode routines | |
140 | */ | |
141 | #define TIPC_NOT_RUNNING 0 | |
142 | #define TIPC_NODE_MODE 1 | |
143 | #define TIPC_NET_MODE 2 | |
144 | ||
b97bf3fd PL |
145 | /* |
146 | * Global configuration variables | |
147 | */ | |
148 | ||
149 | extern u32 tipc_own_addr; | |
b97bf3fd | 150 | extern int tipc_max_nodes; |
b97bf3fd PL |
151 | extern int tipc_max_ports; |
152 | extern int tipc_max_subscriptions; | |
153 | extern int tipc_max_publications; | |
154 | extern int tipc_net_id; | |
155 | extern int tipc_remote_management; | |
156 | ||
157 | /* | |
158 | * Other global variables | |
159 | */ | |
160 | ||
161 | extern int tipc_mode; | |
162 | extern int tipc_random; | |
163 | extern const char tipc_alphabet[]; | |
b97bf3fd PL |
164 | |
165 | ||
166 | /* | |
167 | * Routines available to privileged subsystems | |
168 | */ | |
169 | ||
31e3c3f6 | 170 | extern int tipc_core_start_net(unsigned long); |
0e0609bb AS |
171 | extern int tipc_handler_start(void); |
172 | extern void tipc_handler_stop(void); | |
173 | extern int tipc_netlink_start(void); | |
174 | extern void tipc_netlink_stop(void); | |
175 | extern int tipc_socket_init(void); | |
176 | extern void tipc_socket_stop(void); | |
b97bf3fd PL |
177 | |
178 | static inline int delimit(int val, int min, int max) | |
179 | { | |
180 | if (val > max) | |
181 | return max; | |
182 | if (val < min) | |
183 | return min; | |
184 | return val; | |
185 | } | |
186 | ||
187 | ||
188 | /* | |
189 | * TIPC timer and signal code | |
190 | */ | |
191 | ||
192 | typedef void (*Handler) (unsigned long); | |
193 | ||
4323add6 | 194 | u32 tipc_k_signal(Handler routine, unsigned long argument); |
b97bf3fd PL |
195 | |
196 | /** | |
197 | * k_init_timer - initialize a timer | |
198 | * @timer: pointer to timer structure | |
199 | * @routine: pointer to routine to invoke when timer expires | |
200 | * @argument: value to pass to routine when timer expires | |
c4307285 | 201 | * |
b97bf3fd PL |
202 | * Timer must be initialized before use (and terminated when no longer needed). |
203 | */ | |
204 | ||
c4307285 | 205 | static inline void k_init_timer(struct timer_list *timer, Handler routine, |
b97bf3fd PL |
206 | unsigned long argument) |
207 | { | |
b24b8a24 | 208 | setup_timer(timer, routine, argument); |
b97bf3fd PL |
209 | } |
210 | ||
211 | /** | |
212 | * k_start_timer - start a timer | |
213 | * @timer: pointer to timer structure | |
214 | * @msec: time to delay (in ms) | |
c4307285 | 215 | * |
b97bf3fd PL |
216 | * Schedules a previously initialized timer for later execution. |
217 | * If timer is already running, the new timeout overrides the previous request. | |
c4307285 | 218 | * |
b97bf3fd PL |
219 | * To ensure the timer doesn't expire before the specified delay elapses, |
220 | * the amount of delay is rounded up when converting to the jiffies | |
c4307285 | 221 | * then an additional jiffy is added to account for the fact that |
b97bf3fd PL |
222 | * the starting time may be in the middle of the current jiffy. |
223 | */ | |
224 | ||
225 | static inline void k_start_timer(struct timer_list *timer, unsigned long msec) | |
226 | { | |
b97bf3fd PL |
227 | mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1); |
228 | } | |
229 | ||
230 | /** | |
231 | * k_cancel_timer - cancel a timer | |
232 | * @timer: pointer to timer structure | |
c4307285 YH |
233 | * |
234 | * Cancels a previously initialized timer. | |
b97bf3fd | 235 | * Can be called safely even if the timer is already inactive. |
c4307285 | 236 | * |
b97bf3fd PL |
237 | * WARNING: Must not be called when holding locks required by the timer's |
238 | * timeout routine, otherwise deadlock can occur on SMP systems! | |
239 | */ | |
240 | ||
241 | static inline void k_cancel_timer(struct timer_list *timer) | |
242 | { | |
b97bf3fd PL |
243 | del_timer_sync(timer); |
244 | } | |
245 | ||
246 | /** | |
247 | * k_term_timer - terminate a timer | |
248 | * @timer: pointer to timer structure | |
c4307285 | 249 | * |
b97bf3fd | 250 | * Prevents further use of a previously initialized timer. |
c4307285 | 251 | * |
b97bf3fd | 252 | * WARNING: Caller must ensure timer isn't currently running. |
c4307285 | 253 | * |
b97bf3fd PL |
254 | * (Do not "enhance" this routine to automatically cancel an active timer, |
255 | * otherwise deadlock can arise when a timeout routine calls k_term_timer.) | |
256 | */ | |
257 | ||
258 | static inline void k_term_timer(struct timer_list *timer) | |
259 | { | |
b97bf3fd PL |
260 | } |
261 | ||
262 | ||
263 | /* | |
264 | * TIPC message buffer code | |
265 | * | |
f08269d3 AS |
266 | * TIPC message buffer headroom reserves space for the worst-case |
267 | * link-level device header (in case the message is sent off-node). | |
3a8d1214 | 268 | * |
f08269d3 AS |
269 | * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields |
270 | * are word aligned for quicker access | |
b97bf3fd PL |
271 | */ |
272 | ||
f08269d3 | 273 | #define BUF_HEADROOM LL_MAX_HEADER |
b97bf3fd PL |
274 | |
275 | struct tipc_skb_cb { | |
276 | void *handle; | |
277 | }; | |
278 | ||
279 | #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0])) | |
280 | ||
281 | ||
282 | static inline struct tipc_msg *buf_msg(struct sk_buff *skb) | |
283 | { | |
284 | return (struct tipc_msg *)skb->data; | |
285 | } | |
286 | ||
31e3c3f6 | 287 | extern struct sk_buff *tipc_buf_acquire(u32 size); |
b97bf3fd PL |
288 | |
289 | /** | |
290 | * buf_discard - frees a TIPC message buffer | |
291 | * @skb: message buffer | |
292 | * | |
8b1f0a92 | 293 | * Frees a message buffer. If passed NULL, just returns. |
b97bf3fd PL |
294 | */ |
295 | ||
296 | static inline void buf_discard(struct sk_buff *skb) | |
297 | { | |
11ecede7 | 298 | kfree_skb(skb); |
b97bf3fd PL |
299 | } |
300 | ||
fe13dda2 AS |
301 | /** |
302 | * buf_linearize - convert a TIPC message buffer into a single contiguous piece | |
303 | * @skb: message buffer | |
304 | * | |
305 | * Returns 0 on success. | |
306 | */ | |
307 | ||
308 | static inline int buf_linearize(struct sk_buff *skb) | |
309 | { | |
310 | return skb_linearize(skb); | |
311 | } | |
312 | ||
c4307285 | 313 | #endif |