Root/net/tipc/core.h

1/*
2 * net/tipc/core.h: Include file for TIPC global declarations
3 *
4 * Copyright (c) 2005-2006, Ericsson AB
5 * Copyright (c) 2005-2007, Wind River Systems
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
10 *
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.
19 *
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
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_CORE_H
38#define _TIPC_CORE_H
39
40#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>
45#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/slab.h>
60#include <linux/vmalloc.h>
61
62
63#define TIPC_MOD_VER "2.0.0"
64
65/*
66 * TIPC sanity test macros
67 */
68
69#define assert(i) BUG_ON(!(i))
70
71/*
72 * TIPC system monitoring code
73 */
74
75/*
76 * TIPC's print buffer subsystem supports the following print buffers:
77 *
78 * TIPC_NULL : null buffer (i.e. print nowhere)
79 * TIPC_CONS : system console
80 * TIPC_LOG : TIPC log buffer
81 * &buf : user-defined buffer (struct print_buf *)
82 *
83 * Note: TIPC_LOG is configured to echo its output to the system console;
84 * user-defined buffers can be configured to do the same thing.
85 */
86
87extern struct print_buf *const TIPC_NULL;
88extern struct print_buf *const TIPC_CONS;
89extern struct print_buf *const TIPC_LOG;
90
91void tipc_printf(struct print_buf *, const char *fmt, ...);
92
93/*
94 * TIPC_OUTPUT is the destination print buffer for system messages.
95 */
96
97#ifndef TIPC_OUTPUT
98#define TIPC_OUTPUT TIPC_LOG
99#endif
100
101/*
102 * TIPC can be configured to send system messages to TIPC_OUTPUT
103 * or to the system console only.
104 */
105
106#ifdef CONFIG_TIPC_DEBUG
107
108#define err(fmt, arg...) tipc_printf(TIPC_OUTPUT, \
109                    KERN_ERR "TIPC: " fmt, ## arg)
110#define warn(fmt, arg...) tipc_printf(TIPC_OUTPUT, \
111                    KERN_WARNING "TIPC: " fmt, ## arg)
112#define info(fmt, arg...) tipc_printf(TIPC_OUTPUT, \
113                    KERN_NOTICE "TIPC: " fmt, ## arg)
114
115#else
116
117#define err(fmt, arg...) printk(KERN_ERR "TIPC: " fmt , ## arg)
118#define info(fmt, arg...) printk(KERN_INFO "TIPC: " fmt , ## arg)
119#define warn(fmt, arg...) printk(KERN_WARNING "TIPC: " fmt , ## arg)
120
121#endif
122
123/*
124 * DBG_OUTPUT is the destination print buffer for debug messages.
125 * It defaults to the the null print buffer, but can be redefined
126 * (typically in the individual .c files being debugged) to allow
127 * selected debug messages to be generated where needed.
128 */
129
130#ifndef DBG_OUTPUT
131#define DBG_OUTPUT TIPC_NULL
132#endif
133
134/*
135 * TIPC can be configured to send debug messages to the specified print buffer
136 * (typically DBG_OUTPUT) or to suppress them entirely.
137 */
138
139#ifdef CONFIG_TIPC_DEBUG
140
141#define dbg(fmt, arg...) \
142    do { \
143        if (DBG_OUTPUT != TIPC_NULL) \
144            tipc_printf(DBG_OUTPUT, fmt, ## arg); \
145    } while (0)
146#define msg_dbg(msg, txt) \
147    do { \
148        if (DBG_OUTPUT != TIPC_NULL) \
149            tipc_msg_dbg(DBG_OUTPUT, msg, txt); \
150    } while (0)
151#define dump(fmt, arg...) \
152    do { \
153        if (DBG_OUTPUT != TIPC_NULL) \
154            tipc_dump_dbg(DBG_OUTPUT, fmt, ##arg); \
155    } while (0)
156
157void tipc_msg_dbg(struct print_buf *, struct tipc_msg *, const char *);
158void tipc_dump_dbg(struct print_buf *, const char *fmt, ...);
159
160#else
161
162#define dbg(fmt, arg...) do {} while (0)
163#define msg_dbg(msg, txt) do {} while (0)
164#define dump(fmt, arg...) do {} while (0)
165
166#define tipc_msg_dbg(...) do {} while (0)
167#define tipc_dump_dbg(...) do {} while (0)
168
169#endif
170
171
172/*
173 * TIPC-specific error codes
174 */
175
176#define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */
177
178/*
179 * Global configuration variables
180 */
181
182extern u32 tipc_own_addr;
183extern int tipc_max_zones;
184extern int tipc_max_clusters;
185extern int tipc_max_nodes;
186extern int tipc_max_slaves;
187extern int tipc_max_ports;
188extern int tipc_max_subscriptions;
189extern int tipc_max_publications;
190extern int tipc_net_id;
191extern int tipc_remote_management;
192
193/*
194 * Other global variables
195 */
196
197extern int tipc_mode;
198extern int tipc_random;
199extern const char tipc_alphabet[];
200extern atomic_t tipc_user_count;
201
202
203/*
204 * Routines available to privileged subsystems
205 */
206
207extern int tipc_core_start(void);
208extern void tipc_core_stop(void);
209extern int tipc_core_start_net(unsigned long addr);
210extern void tipc_core_stop_net(void);
211extern int tipc_handler_start(void);
212extern void tipc_handler_stop(void);
213extern int tipc_netlink_start(void);
214extern void tipc_netlink_stop(void);
215extern int tipc_socket_init(void);
216extern void tipc_socket_stop(void);
217
218static inline int delimit(int val, int min, int max)
219{
220    if (val > max)
221        return max;
222    if (val < min)
223        return min;
224    return val;
225}
226
227
228/*
229 * TIPC timer and signal code
230 */
231
232typedef void (*Handler) (unsigned long);
233
234u32 tipc_k_signal(Handler routine, unsigned long argument);
235
236/**
237 * k_init_timer - initialize a timer
238 * @timer: pointer to timer structure
239 * @routine: pointer to routine to invoke when timer expires
240 * @argument: value to pass to routine when timer expires
241 *
242 * Timer must be initialized before use (and terminated when no longer needed).
243 */
244
245static inline void k_init_timer(struct timer_list *timer, Handler routine,
246                unsigned long argument)
247{
248    dbg("initializing timer %p\n", timer);
249    setup_timer(timer, routine, argument);
250}
251
252/**
253 * k_start_timer - start a timer
254 * @timer: pointer to timer structure
255 * @msec: time to delay (in ms)
256 *
257 * Schedules a previously initialized timer for later execution.
258 * If timer is already running, the new timeout overrides the previous request.
259 *
260 * To ensure the timer doesn't expire before the specified delay elapses,
261 * the amount of delay is rounded up when converting to the jiffies
262 * then an additional jiffy is added to account for the fact that
263 * the starting time may be in the middle of the current jiffy.
264 */
265
266static inline void k_start_timer(struct timer_list *timer, unsigned long msec)
267{
268    dbg("starting timer %p for %u\n", timer, msec);
269    mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1);
270}
271
272/**
273 * k_cancel_timer - cancel a timer
274 * @timer: pointer to timer structure
275 *
276 * Cancels a previously initialized timer.
277 * Can be called safely even if the timer is already inactive.
278 *
279 * WARNING: Must not be called when holding locks required by the timer's
280 * timeout routine, otherwise deadlock can occur on SMP systems!
281 */
282
283static inline void k_cancel_timer(struct timer_list *timer)
284{
285    dbg("cancelling timer %p\n", timer);
286    del_timer_sync(timer);
287}
288
289/**
290 * k_term_timer - terminate a timer
291 * @timer: pointer to timer structure
292 *
293 * Prevents further use of a previously initialized timer.
294 *
295 * WARNING: Caller must ensure timer isn't currently running.
296 *
297 * (Do not "enhance" this routine to automatically cancel an active timer,
298 * otherwise deadlock can arise when a timeout routine calls k_term_timer.)
299 */
300
301static inline void k_term_timer(struct timer_list *timer)
302{
303    dbg("terminating timer %p\n", timer);
304}
305
306
307/*
308 * TIPC message buffer code
309 *
310 * TIPC message buffer headroom reserves space for the worst-case
311 * link-level device header (in case the message is sent off-node).
312 *
313 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
314 * are word aligned for quicker access
315 */
316
317#define BUF_HEADROOM LL_MAX_HEADER
318
319struct tipc_skb_cb {
320    void *handle;
321};
322
323#define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
324
325
326static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
327{
328    return (struct tipc_msg *)skb->data;
329}
330
331extern struct sk_buff *buf_acquire(u32 size);
332
333/**
334 * buf_discard - frees a TIPC message buffer
335 * @skb: message buffer
336 *
337 * Frees a message buffer. If passed NULL, just returns.
338 */
339
340static inline void buf_discard(struct sk_buff *skb)
341{
342    kfree_skb(skb);
343}
344
345/**
346 * buf_linearize - convert a TIPC message buffer into a single contiguous piece
347 * @skb: message buffer
348 *
349 * Returns 0 on success.
350 */
351
352static inline int buf_linearize(struct sk_buff *skb)
353{
354    return skb_linearize(skb);
355}
356
357#endif
358

Archive Download this file



interactive