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 |
7d3aa712 | 5 | * Copyright (c) 2005-2007, 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; |
6063da9d AS |
86 | extern struct print_buf *const TIPC_LOG; |
87 | ||
88 | void tipc_printf(struct print_buf *, const char *fmt, ...); | |
6063da9d AS |
89 | |
90 | /* | |
91 | * TIPC_OUTPUT is the destination print buffer for system messages. | |
92 | */ | |
93 | ||
b97bf3fd | 94 | #ifndef TIPC_OUTPUT |
c8903985 | 95 | #define TIPC_OUTPUT TIPC_LOG |
b97bf3fd PL |
96 | #endif |
97 | ||
b97bf3fd | 98 | /* |
6063da9d AS |
99 | * TIPC can be configured to send system messages to TIPC_OUTPUT |
100 | * or to the system console only. | |
b97bf3fd PL |
101 | */ |
102 | ||
6063da9d AS |
103 | #ifdef CONFIG_TIPC_DEBUG |
104 | ||
105 | #define err(fmt, arg...) tipc_printf(TIPC_OUTPUT, \ | |
106 | KERN_ERR "TIPC: " fmt, ## arg) | |
107 | #define warn(fmt, arg...) tipc_printf(TIPC_OUTPUT, \ | |
108 | KERN_WARNING "TIPC: " fmt, ## arg) | |
109 | #define info(fmt, arg...) tipc_printf(TIPC_OUTPUT, \ | |
110 | KERN_NOTICE "TIPC: " fmt, ## arg) | |
111 | ||
112 | #else | |
113 | ||
d0a14a9d PL |
114 | #define err(fmt, arg...) printk(KERN_ERR "TIPC: " fmt , ## arg) |
115 | #define info(fmt, arg...) printk(KERN_INFO "TIPC: " fmt , ## arg) | |
116 | #define warn(fmt, arg...) printk(KERN_WARNING "TIPC: " fmt , ## arg) | |
b97bf3fd | 117 | |
6063da9d | 118 | #endif |
b97bf3fd | 119 | |
6063da9d AS |
120 | /* |
121 | * DBG_OUTPUT is the destination print buffer for debug messages. | |
122 | * It defaults to the the null print buffer, but can be redefined | |
123 | * (typically in the individual .c files being debugged) to allow | |
124 | * selected debug messages to be generated where needed. | |
125 | */ | |
126 | ||
127 | #ifndef DBG_OUTPUT | |
128 | #define DBG_OUTPUT TIPC_NULL | |
129 | #endif | |
a4e09279 | 130 | |
c4307285 | 131 | /* |
6063da9d AS |
132 | * TIPC can be configured to send debug messages to the specified print buffer |
133 | * (typically DBG_OUTPUT) or to suppress them entirely. | |
a4e09279 AS |
134 | */ |
135 | ||
6063da9d | 136 | #ifdef CONFIG_TIPC_DEBUG |
a4e09279 | 137 | |
6063da9d AS |
138 | #define dbg(fmt, arg...) \ |
139 | do { \ | |
140 | if (DBG_OUTPUT != TIPC_NULL) \ | |
141 | tipc_printf(DBG_OUTPUT, fmt, ## arg); \ | |
142 | } while (0) | |
143 | #define msg_dbg(msg, txt) \ | |
144 | do { \ | |
145 | if (DBG_OUTPUT != TIPC_NULL) \ | |
48c97139 | 146 | tipc_msg_dbg(DBG_OUTPUT, msg, txt); \ |
6063da9d AS |
147 | } while (0) |
148 | #define dump(fmt, arg...) \ | |
149 | do { \ | |
150 | if (DBG_OUTPUT != TIPC_NULL) \ | |
48c97139 | 151 | tipc_dump_dbg(DBG_OUTPUT, fmt, ##arg); \ |
6063da9d AS |
152 | } while (0) |
153 | ||
48c97139 AS |
154 | void tipc_msg_dbg(struct print_buf *, struct tipc_msg *, const char *); |
155 | void tipc_dump_dbg(struct print_buf *, const char *fmt, ...); | |
156 | ||
6063da9d AS |
157 | #else |
158 | ||
159 | #define dbg(fmt, arg...) do {} while (0) | |
160 | #define msg_dbg(msg, txt) do {} while (0) | |
161 | #define dump(fmt, arg...) do {} while (0) | |
48c97139 AS |
162 | |
163 | #define tipc_msg_dbg(...) do {} while (0) | |
164 | #define tipc_dump_dbg(...) do {} while (0) | |
a4e09279 | 165 | |
c4307285 | 166 | #endif |
b97bf3fd PL |
167 | |
168 | ||
c4307285 | 169 | /* |
b97bf3fd PL |
170 | * TIPC-specific error codes |
171 | */ | |
172 | ||
173 | #define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */ | |
174 | ||
d265fef6 AS |
175 | /* |
176 | * TIPC operating mode routines | |
177 | */ | |
178 | #define TIPC_NOT_RUNNING 0 | |
179 | #define TIPC_NODE_MODE 1 | |
180 | #define TIPC_NET_MODE 2 | |
181 | ||
b97bf3fd PL |
182 | /* |
183 | * Global configuration variables | |
184 | */ | |
185 | ||
186 | extern u32 tipc_own_addr; | |
b97bf3fd | 187 | extern int tipc_max_nodes; |
b97bf3fd PL |
188 | extern int tipc_max_ports; |
189 | extern int tipc_max_subscriptions; | |
190 | extern int tipc_max_publications; | |
191 | extern int tipc_net_id; | |
192 | extern int tipc_remote_management; | |
193 | ||
194 | /* | |
195 | * Other global variables | |
196 | */ | |
197 | ||
198 | extern int tipc_mode; | |
199 | extern int tipc_random; | |
200 | extern const char tipc_alphabet[]; | |
201 | extern atomic_t tipc_user_count; | |
202 | ||
203 | ||
204 | /* | |
205 | * Routines available to privileged subsystems | |
206 | */ | |
207 | ||
31e3c3f6 | 208 | extern int tipc_core_start_net(unsigned long); |
0e0609bb AS |
209 | extern int tipc_handler_start(void); |
210 | extern void tipc_handler_stop(void); | |
211 | extern int tipc_netlink_start(void); | |
212 | extern void tipc_netlink_stop(void); | |
213 | extern int tipc_socket_init(void); | |
214 | extern void tipc_socket_stop(void); | |
b97bf3fd PL |
215 | |
216 | static inline int delimit(int val, int min, int max) | |
217 | { | |
218 | if (val > max) | |
219 | return max; | |
220 | if (val < min) | |
221 | return min; | |
222 | return val; | |
223 | } | |
224 | ||
225 | ||
226 | /* | |
227 | * TIPC timer and signal code | |
228 | */ | |
229 | ||
230 | typedef void (*Handler) (unsigned long); | |
231 | ||
4323add6 | 232 | u32 tipc_k_signal(Handler routine, unsigned long argument); |
b97bf3fd PL |
233 | |
234 | /** | |
235 | * k_init_timer - initialize a timer | |
236 | * @timer: pointer to timer structure | |
237 | * @routine: pointer to routine to invoke when timer expires | |
238 | * @argument: value to pass to routine when timer expires | |
c4307285 | 239 | * |
b97bf3fd PL |
240 | * Timer must be initialized before use (and terminated when no longer needed). |
241 | */ | |
242 | ||
c4307285 | 243 | static inline void k_init_timer(struct timer_list *timer, Handler routine, |
b97bf3fd PL |
244 | unsigned long argument) |
245 | { | |
b24b8a24 | 246 | setup_timer(timer, routine, argument); |
b97bf3fd PL |
247 | } |
248 | ||
249 | /** | |
250 | * k_start_timer - start a timer | |
251 | * @timer: pointer to timer structure | |
252 | * @msec: time to delay (in ms) | |
c4307285 | 253 | * |
b97bf3fd PL |
254 | * Schedules a previously initialized timer for later execution. |
255 | * If timer is already running, the new timeout overrides the previous request. | |
c4307285 | 256 | * |
b97bf3fd PL |
257 | * To ensure the timer doesn't expire before the specified delay elapses, |
258 | * the amount of delay is rounded up when converting to the jiffies | |
c4307285 | 259 | * then an additional jiffy is added to account for the fact that |
b97bf3fd PL |
260 | * the starting time may be in the middle of the current jiffy. |
261 | */ | |
262 | ||
263 | static inline void k_start_timer(struct timer_list *timer, unsigned long msec) | |
264 | { | |
b97bf3fd PL |
265 | mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1); |
266 | } | |
267 | ||
268 | /** | |
269 | * k_cancel_timer - cancel a timer | |
270 | * @timer: pointer to timer structure | |
c4307285 YH |
271 | * |
272 | * Cancels a previously initialized timer. | |
b97bf3fd | 273 | * Can be called safely even if the timer is already inactive. |
c4307285 | 274 | * |
b97bf3fd PL |
275 | * WARNING: Must not be called when holding locks required by the timer's |
276 | * timeout routine, otherwise deadlock can occur on SMP systems! | |
277 | */ | |
278 | ||
279 | static inline void k_cancel_timer(struct timer_list *timer) | |
280 | { | |
b97bf3fd PL |
281 | del_timer_sync(timer); |
282 | } | |
283 | ||
284 | /** | |
285 | * k_term_timer - terminate a timer | |
286 | * @timer: pointer to timer structure | |
c4307285 | 287 | * |
b97bf3fd | 288 | * Prevents further use of a previously initialized timer. |
c4307285 | 289 | * |
b97bf3fd | 290 | * WARNING: Caller must ensure timer isn't currently running. |
c4307285 | 291 | * |
b97bf3fd PL |
292 | * (Do not "enhance" this routine to automatically cancel an active timer, |
293 | * otherwise deadlock can arise when a timeout routine calls k_term_timer.) | |
294 | */ | |
295 | ||
296 | static inline void k_term_timer(struct timer_list *timer) | |
297 | { | |
b97bf3fd PL |
298 | } |
299 | ||
300 | ||
301 | /* | |
302 | * TIPC message buffer code | |
303 | * | |
f08269d3 AS |
304 | * TIPC message buffer headroom reserves space for the worst-case |
305 | * link-level device header (in case the message is sent off-node). | |
3a8d1214 | 306 | * |
f08269d3 AS |
307 | * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields |
308 | * are word aligned for quicker access | |
b97bf3fd PL |
309 | */ |
310 | ||
f08269d3 | 311 | #define BUF_HEADROOM LL_MAX_HEADER |
b97bf3fd PL |
312 | |
313 | struct tipc_skb_cb { | |
314 | void *handle; | |
315 | }; | |
316 | ||
317 | #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0])) | |
318 | ||
319 | ||
320 | static inline struct tipc_msg *buf_msg(struct sk_buff *skb) | |
321 | { | |
322 | return (struct tipc_msg *)skb->data; | |
323 | } | |
324 | ||
31e3c3f6 | 325 | extern struct sk_buff *tipc_buf_acquire(u32 size); |
b97bf3fd PL |
326 | |
327 | /** | |
328 | * buf_discard - frees a TIPC message buffer | |
329 | * @skb: message buffer | |
330 | * | |
8b1f0a92 | 331 | * Frees a message buffer. If passed NULL, just returns. |
b97bf3fd PL |
332 | */ |
333 | ||
334 | static inline void buf_discard(struct sk_buff *skb) | |
335 | { | |
11ecede7 | 336 | kfree_skb(skb); |
b97bf3fd PL |
337 | } |
338 | ||
fe13dda2 AS |
339 | /** |
340 | * buf_linearize - convert a TIPC message buffer into a single contiguous piece | |
341 | * @skb: message buffer | |
342 | * | |
343 | * Returns 0 on success. | |
344 | */ | |
345 | ||
346 | static inline int buf_linearize(struct sk_buff *skb) | |
347 | { | |
348 | return skb_linearize(skb); | |
349 | } | |
350 | ||
c4307285 | 351 | #endif |