blob: 762aac2572be88f768d6e6d0d2c3337508b7965a [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/core.h: Include file for TIPC global declarations
3 *
Per Liden593a5f22006-01-11 19:14:19 +01004 * Copyright (c) 2005-2006, Ericsson AB
Allan Stephensa4e09272006-06-25 23:40:35 -07005 * Copyright (c) 2005-2006, Wind River Systems
Per Lidenb97bf3f2006-01-02 19:04:38 +01006 * All rights reserved.
7 *
Per Liden9ea1fd32006-01-11 13:30:43 +01008 * Redistribution and use in source and binary forms, with or without
Per Lidenb97bf3f2006-01-02 19:04:38 +01009 * modification, are permitted provided that the following conditions are met:
10 *
Per Liden9ea1fd32006-01-11 13:30:43 +010011 * 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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010019 *
Per Liden9ea1fd32006-01-11 13:30:43 +010020 * 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
Per Lidenb97bf3f2006-01-02 19:04:38 +010034 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_CORE_H
38#define _TIPC_CORE_H
39
Jon Maloy5f7c3ff2006-01-13 10:45:44 +000040#include <linux/tipc.h>
41#include <linux/tipc_config.h>
42#include <net/tipc/tipc_msg.h>
43#include <net/tipc/tipc_port.h>
44#include <net/tipc/tipc_bearer.h>
Per Lidenb97bf3f2006-01-02 19:04:38 +010045#include <net/tipc/tipc.h>
46#include <linux/types.h>
47#include <linux/kernel.h>
48#include <linux/errno.h>
49#include <linux/mm.h>
50#include <linux/timer.h>
51#include <linux/string.h>
52#include <asm/uaccess.h>
53#include <linux/interrupt.h>
54#include <asm/atomic.h>
55#include <asm/hardirq.h>
56#include <linux/netdevice.h>
57#include <linux/in.h>
58#include <linux/list.h>
59#include <linux/vmalloc.h>
60
61/*
62 * TIPC debugging code
63 */
64
65#define assert(i) BUG_ON(!(i))
66
67struct tipc_msg;
Per Liden4323add2006-01-18 00:38:21 +010068extern struct print_buf *TIPC_CONS, *TIPC_LOG;
69extern struct print_buf *TIPC_TEE(struct print_buf *, struct print_buf *);
70void tipc_msg_print(struct print_buf*,struct tipc_msg *,const char*);
Per Lidenb97bf3f2006-01-02 19:04:38 +010071void tipc_printf(struct print_buf *, const char *fmt, ...);
72void tipc_dump(struct print_buf*,const char *fmt, ...);
73
74#ifdef CONFIG_TIPC_DEBUG
75
76/*
77 * TIPC debug support included:
78 * - system messages are printed to TIPC_OUTPUT print buffer
79 * - debug messages are printed to DBG_OUTPUT print buffer
80 */
81
82#define err(fmt, arg...) tipc_printf(TIPC_OUTPUT, KERN_ERR "TIPC: " fmt, ## arg)
83#define warn(fmt, arg...) tipc_printf(TIPC_OUTPUT, KERN_WARNING "TIPC: " fmt, ## arg)
84#define info(fmt, arg...) tipc_printf(TIPC_OUTPUT, KERN_NOTICE "TIPC: " fmt, ## arg)
85
86#define dbg(fmt, arg...) do {if (DBG_OUTPUT) tipc_printf(DBG_OUTPUT, fmt, ## arg);} while(0)
Per Liden4323add2006-01-18 00:38:21 +010087#define msg_dbg(msg, txt) do {if (DBG_OUTPUT) tipc_msg_print(DBG_OUTPUT, msg, txt);} while(0)
Per Lidenb97bf3f2006-01-02 19:04:38 +010088#define dump(fmt, arg...) do {if (DBG_OUTPUT) tipc_dump(DBG_OUTPUT, fmt, ##arg);} while(0)
89
90
91/*
92 * By default, TIPC_OUTPUT is defined to be system console and TIPC log buffer,
93 * while DBG_OUTPUT is the null print buffer. These defaults can be changed
94 * here, or on a per .c file basis, by redefining these symbols. The following
95 * print buffer options are available:
96 *
Per Liden4323add2006-01-18 00:38:21 +010097 * NULL : Output to null print buffer (i.e. print nowhere)
98 * TIPC_CONS : Output to system console
99 * TIPC_LOG : Output to TIPC log buffer
100 * &buf : Output to user-defined buffer (struct print_buf *)
101 * TIPC_TEE(&buf_a,&buf_b) : Output to two print buffers (eg. TIPC_TEE(TIPC_CONS,TIPC_LOG) )
Per Lidenb97bf3f2006-01-02 19:04:38 +0100102 */
103
104#ifndef TIPC_OUTPUT
Per Liden4323add2006-01-18 00:38:21 +0100105#define TIPC_OUTPUT TIPC_TEE(TIPC_CONS,TIPC_LOG)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100106#endif
107
108#ifndef DBG_OUTPUT
109#define DBG_OUTPUT NULL
110#endif
111
112#else
113
Per Lidenb97bf3f2006-01-02 19:04:38 +0100114/*
115 * TIPC debug support not included:
116 * - system messages are printed to system console
117 * - debug messages are not printed
118 */
119
Per Lidend0a14a92006-01-11 13:52:51 +0100120#define err(fmt, arg...) printk(KERN_ERR "TIPC: " fmt , ## arg)
121#define info(fmt, arg...) printk(KERN_INFO "TIPC: " fmt , ## arg)
122#define warn(fmt, arg...) printk(KERN_WARNING "TIPC: " fmt , ## arg)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100123
124#define dbg(fmt, arg...) do {} while (0)
125#define msg_dbg(msg,txt) do {} while (0)
126#define dump(fmt,arg...) do {} while (0)
127
Allan Stephensa4e09272006-06-25 23:40:35 -0700128
129/*
130 * TIPC_OUTPUT is defined to be the system console, while DBG_OUTPUT is
131 * the null print buffer. Thes ensures that any system or debug messages
132 * that are generated without using the above macros are handled correctly.
133 */
134
135#undef TIPC_OUTPUT
136#define TIPC_OUTPUT TIPC_CONS
137
138#undef DBG_OUTPUT
139#define DBG_OUTPUT NULL
140
Per Lidenb97bf3f2006-01-02 19:04:38 +0100141#endif
142
143
144/*
145 * TIPC-specific error codes
146 */
147
148#define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */
149
150/*
151 * Global configuration variables
152 */
153
154extern u32 tipc_own_addr;
155extern int tipc_max_zones;
156extern int tipc_max_clusters;
157extern int tipc_max_nodes;
158extern int tipc_max_slaves;
159extern int tipc_max_ports;
160extern int tipc_max_subscriptions;
161extern int tipc_max_publications;
162extern int tipc_net_id;
163extern int tipc_remote_management;
164
165/*
166 * Other global variables
167 */
168
169extern int tipc_mode;
170extern int tipc_random;
171extern const char tipc_alphabet[];
172extern atomic_t tipc_user_count;
173
174
175/*
176 * Routines available to privileged subsystems
177 */
178
Per Liden4323add2006-01-18 00:38:21 +0100179extern int tipc_core_start(void);
180extern void tipc_core_stop(void);
181extern int tipc_core_start_net(void);
182extern void tipc_core_stop_net(void);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100183
184static inline int delimit(int val, int min, int max)
185{
186 if (val > max)
187 return max;
188 if (val < min)
189 return min;
190 return val;
191}
192
193
194/*
195 * TIPC timer and signal code
196 */
197
198typedef void (*Handler) (unsigned long);
199
Per Liden4323add2006-01-18 00:38:21 +0100200u32 tipc_k_signal(Handler routine, unsigned long argument);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100201
202/**
203 * k_init_timer - initialize a timer
204 * @timer: pointer to timer structure
205 * @routine: pointer to routine to invoke when timer expires
206 * @argument: value to pass to routine when timer expires
207 *
208 * Timer must be initialized before use (and terminated when no longer needed).
209 */
210
211static inline void k_init_timer(struct timer_list *timer, Handler routine,
212 unsigned long argument)
213{
214 dbg("initializing timer %p\n", timer);
215 init_timer(timer);
216 timer->function = routine;
217 timer->data = argument;
218}
219
220/**
221 * k_start_timer - start a timer
222 * @timer: pointer to timer structure
223 * @msec: time to delay (in ms)
224 *
225 * Schedules a previously initialized timer for later execution.
226 * If timer is already running, the new timeout overrides the previous request.
227 *
228 * To ensure the timer doesn't expire before the specified delay elapses,
229 * the amount of delay is rounded up when converting to the jiffies
230 * then an additional jiffy is added to account for the fact that
231 * the starting time may be in the middle of the current jiffy.
232 */
233
234static inline void k_start_timer(struct timer_list *timer, unsigned long msec)
235{
236 dbg("starting timer %p for %u\n", timer, msec);
237 mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1);
238}
239
240/**
241 * k_cancel_timer - cancel a timer
242 * @timer: pointer to timer structure
243 *
244 * Cancels a previously initialized timer.
245 * Can be called safely even if the timer is already inactive.
246 *
247 * WARNING: Must not be called when holding locks required by the timer's
248 * timeout routine, otherwise deadlock can occur on SMP systems!
249 */
250
251static inline void k_cancel_timer(struct timer_list *timer)
252{
253 dbg("cancelling timer %p\n", timer);
254 del_timer_sync(timer);
255}
256
257/**
258 * k_term_timer - terminate a timer
259 * @timer: pointer to timer structure
260 *
261 * Prevents further use of a previously initialized timer.
262 *
263 * WARNING: Caller must ensure timer isn't currently running.
264 *
265 * (Do not "enhance" this routine to automatically cancel an active timer,
266 * otherwise deadlock can arise when a timeout routine calls k_term_timer.)
267 */
268
269static inline void k_term_timer(struct timer_list *timer)
270{
271 dbg("terminating timer %p\n", timer);
272}
273
274
275/*
276 * TIPC message buffer code
277 *
278 * TIPC message buffer headroom leaves room for 14 byte Ethernet header,
279 * while ensuring TIPC header is word aligned for quicker access
280 */
281
282#define BUF_HEADROOM 16u
283
284struct tipc_skb_cb {
285 void *handle;
286};
287
288#define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
289
290
291static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
292{
293 return (struct tipc_msg *)skb->data;
294}
295
296/**
297 * buf_acquire - creates a TIPC message buffer
298 * @size: message size (including TIPC header)
299 *
Allan Stephens863fae62006-07-03 19:39:36 -0700300 * Returns a new buffer with data pointers set to the specified size.
301 *
302 * NOTE: Headroom is reserved to allow prepending of a data link header.
303 * There may also be unrequested tailroom present at the buffer's end.
Per Lidenb97bf3f2006-01-02 19:04:38 +0100304 */
305
306static inline struct sk_buff *buf_acquire(u32 size)
307{
308 struct sk_buff *skb;
309 unsigned int buf_size = (BUF_HEADROOM + size + 3) & ~3u;
310
311 skb = alloc_skb(buf_size, GFP_ATOMIC);
312 if (skb) {
313 skb_reserve(skb, BUF_HEADROOM);
314 skb_put(skb, size);
315 skb->next = NULL;
316 }
317 return skb;
318}
319
320/**
321 * buf_discard - frees a TIPC message buffer
322 * @skb: message buffer
323 *
Allan Stephens8b1f0a92006-06-25 23:42:19 -0700324 * Frees a message buffer. If passed NULL, just returns.
Per Lidenb97bf3f2006-01-02 19:04:38 +0100325 */
326
327static inline void buf_discard(struct sk_buff *skb)
328{
329 if (likely(skb != NULL))
330 kfree_skb(skb);
331}
332
333#endif