2 * net/tipc/core.h: Include file for TIPC global declarations
4 * Copyright (c) 2005-2006, Ericsson AB
5 * Copyright (c) 2005-2007, Wind River Systems
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
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.
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.
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
34 * POSSIBILITY OF SUCH DAMAGE.
40 #include <linux/tipc.h>
41 #include <linux/tipc_config.h>
42 #include <linux/types.h>
43 #include <linux/kernel.h>
44 #include <linux/errno.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>
54 #include <linux/list.h>
55 #include <linux/slab.h>
56 #include <linux/vmalloc.h>
59 #define TIPC_MOD_VER "2.0.0"
61 struct tipc_msg; /* msg.h */
62 struct print_buf; /* dbg.h */
65 * TIPC sanity test macros
68 #define assert(i) BUG_ON(!(i))
71 * TIPC system monitoring code
75 * TIPC's print buffer subsystem supports the following print buffers:
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 *)
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.
85 extern struct print_buf *const TIPC_NULL;
86 extern struct print_buf *const TIPC_LOG;
88 void tipc_printf(struct print_buf *, const char *fmt, ...);
91 * TIPC_OUTPUT is the destination print buffer for system messages.
95 #define TIPC_OUTPUT TIPC_LOG
99 * TIPC can be configured to send system messages to TIPC_OUTPUT
100 * or to the system console only.
103 #ifdef CONFIG_TIPC_DEBUG
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)
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)
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.
128 #define DBG_OUTPUT TIPC_NULL
132 * TIPC can be configured to send debug messages to the specified print buffer
133 * (typically DBG_OUTPUT) or to suppress them entirely.
136 #ifdef CONFIG_TIPC_DEBUG
138 #define dbg(fmt, arg...) \
140 if (DBG_OUTPUT != TIPC_NULL) \
141 tipc_printf(DBG_OUTPUT, fmt, ## arg); \
143 #define msg_dbg(msg, txt) \
145 if (DBG_OUTPUT != TIPC_NULL) \
146 tipc_msg_dbg(DBG_OUTPUT, msg, txt); \
148 #define dump(fmt, arg...) \
150 if (DBG_OUTPUT != TIPC_NULL) \
151 tipc_dump_dbg(DBG_OUTPUT, fmt, ##arg); \
154 void tipc_msg_dbg(struct print_buf *, struct tipc_msg *, const char *);
155 void tipc_dump_dbg(struct print_buf *, const char *fmt, ...);
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)
163 #define tipc_msg_dbg(...) do {} while (0)
164 #define tipc_dump_dbg(...) do {} while (0)
170 * TIPC-specific error codes
173 #define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */
176 * TIPC operating mode routines
178 #define TIPC_NOT_RUNNING 0
179 #define TIPC_NODE_MODE 1
180 #define TIPC_NET_MODE 2
183 * Global configuration variables
186 extern u32 tipc_own_addr;
187 extern int tipc_max_zones;
188 extern int tipc_max_clusters;
189 extern int tipc_max_nodes;
190 extern int tipc_max_slaves;
191 extern int tipc_max_ports;
192 extern int tipc_max_subscriptions;
193 extern int tipc_max_publications;
194 extern int tipc_net_id;
195 extern int tipc_remote_management;
198 * Other global variables
201 extern int tipc_mode;
202 extern int tipc_random;
203 extern const char tipc_alphabet[];
204 extern atomic_t tipc_user_count;
208 * Routines available to privileged subsystems
211 extern int tipc_core_start_net(unsigned long);
212 extern int tipc_handler_start(void);
213 extern void tipc_handler_stop(void);
214 extern int tipc_netlink_start(void);
215 extern void tipc_netlink_stop(void);
216 extern int tipc_socket_init(void);
217 extern void tipc_socket_stop(void);
219 static inline int delimit(int val, int min, int max)
230 * TIPC timer and signal code
233 typedef void (*Handler) (unsigned long);
235 u32 tipc_k_signal(Handler routine, unsigned long argument);
238 * k_init_timer - initialize a timer
239 * @timer: pointer to timer structure
240 * @routine: pointer to routine to invoke when timer expires
241 * @argument: value to pass to routine when timer expires
243 * Timer must be initialized before use (and terminated when no longer needed).
246 static inline void k_init_timer(struct timer_list *timer, Handler routine,
247 unsigned long argument)
249 dbg("initializing timer %p\n", timer);
250 setup_timer(timer, routine, argument);
254 * k_start_timer - start a timer
255 * @timer: pointer to timer structure
256 * @msec: time to delay (in ms)
258 * Schedules a previously initialized timer for later execution.
259 * If timer is already running, the new timeout overrides the previous request.
261 * To ensure the timer doesn't expire before the specified delay elapses,
262 * the amount of delay is rounded up when converting to the jiffies
263 * then an additional jiffy is added to account for the fact that
264 * the starting time may be in the middle of the current jiffy.
267 static inline void k_start_timer(struct timer_list *timer, unsigned long msec)
269 dbg("starting timer %p for %u\n", timer, msec);
270 mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1);
274 * k_cancel_timer - cancel a timer
275 * @timer: pointer to timer structure
277 * Cancels a previously initialized timer.
278 * Can be called safely even if the timer is already inactive.
280 * WARNING: Must not be called when holding locks required by the timer's
281 * timeout routine, otherwise deadlock can occur on SMP systems!
284 static inline void k_cancel_timer(struct timer_list *timer)
286 dbg("cancelling timer %p\n", timer);
287 del_timer_sync(timer);
291 * k_term_timer - terminate a timer
292 * @timer: pointer to timer structure
294 * Prevents further use of a previously initialized timer.
296 * WARNING: Caller must ensure timer isn't currently running.
298 * (Do not "enhance" this routine to automatically cancel an active timer,
299 * otherwise deadlock can arise when a timeout routine calls k_term_timer.)
302 static inline void k_term_timer(struct timer_list *timer)
304 dbg("terminating timer %p\n", timer);
309 * TIPC message buffer code
311 * TIPC message buffer headroom reserves space for the worst-case
312 * link-level device header (in case the message is sent off-node).
314 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
315 * are word aligned for quicker access
318 #define BUF_HEADROOM LL_MAX_HEADER
324 #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
327 static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
329 return (struct tipc_msg *)skb->data;
332 extern struct sk_buff *tipc_buf_acquire(u32 size);
335 * buf_discard - frees a TIPC message buffer
336 * @skb: message buffer
338 * Frees a message buffer. If passed NULL, just returns.
341 static inline void buf_discard(struct sk_buff *skb)
347 * buf_linearize - convert a TIPC message buffer into a single contiguous piece
348 * @skb: message buffer
350 * Returns 0 on success.
353 static inline int buf_linearize(struct sk_buff *skb)
355 return skb_linearize(skb);