blob: 37544d9f73e18e381ec4cef5503a561c0effff0f [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/core.h: Include file for TIPC global declarations
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Per Liden593a5f22006-01-11 19:14:19 +01004 * Copyright (c) 2005-2006, Ericsson AB
Allan Stephens4132fac2011-01-07 13:12:12 -05005 * Copyright (c) 2005-2007, 2010-2011, 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>
Per Lidenb97bf3f2006-01-02 19:04:38 +010042#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>
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090053#include <linux/in.h>
Per Lidenb97bf3f2006-01-02 19:04:38 +010054#include <linux/list.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090055#include <linux/slab.h>
Per Lidenb97bf3f2006-01-02 19:04:38 +010056#include <linux/vmalloc.h>
57
Allan Stephens107e7be2010-05-11 14:30:08 +000058
59#define TIPC_MOD_VER "2.0.0"
60
Allan Stephensd265fef2010-11-30 12:00:53 +000061struct tipc_msg; /* msg.h */
Allan Stephensf5e75262010-12-31 18:59:24 +000062struct print_buf; /* log.h */
Allan Stephensd265fef2010-11-30 12:00:53 +000063
Per Lidenb97bf3f2006-01-02 19:04:38 +010064/*
Allan Stephens6063da92008-05-05 01:23:34 -070065 * TIPC sanity test macros
Per Lidenb97bf3f2006-01-02 19:04:38 +010066 */
67
68#define assert(i) BUG_ON(!(i))
69
Per Lidenb97bf3f2006-01-02 19:04:38 +010070/*
Allan Stephens6063da92008-05-05 01:23:34 -070071 * TIPC system monitoring code
Per Lidenb97bf3f2006-01-02 19:04:38 +010072 */
73
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090074/*
Allan Stephens6063da92008-05-05 01:23:34 -070075 * TIPC's print buffer subsystem supports the following print buffers:
Per Lidenb97bf3f2006-01-02 19:04:38 +010076 *
Allan Stephens6063da92008-05-05 01:23:34 -070077 * 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 *)
Allan Stephensc8903982008-05-05 01:22:30 -070081 *
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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010084 */
Allan Stephens6063da92008-05-05 01:23:34 -070085extern struct print_buf *const TIPC_NULL;
Allan Stephens6e7e3092010-12-31 18:59:28 +000086extern struct print_buf *const TIPC_CONS;
Allan Stephens6063da92008-05-05 01:23:34 -070087extern struct print_buf *const TIPC_LOG;
88
89void tipc_printf(struct print_buf *, const char *fmt, ...);
Allan Stephens6063da92008-05-05 01:23:34 -070090
91/*
92 * TIPC_OUTPUT is the destination print buffer for system messages.
93 */
94
Per Lidenb97bf3f2006-01-02 19:04:38 +010095#ifndef TIPC_OUTPUT
Allan Stephensc8903982008-05-05 01:22:30 -070096#define TIPC_OUTPUT TIPC_LOG
Per Lidenb97bf3f2006-01-02 19:04:38 +010097#endif
98
Allan Stephens6e7e3092010-12-31 18:59:28 +000099#define err(fmt, arg...) tipc_printf(TIPC_OUTPUT, \
100 KERN_ERR "TIPC: " fmt, ## arg)
101#define warn(fmt, arg...) tipc_printf(TIPC_OUTPUT, \
102 KERN_WARNING "TIPC: " fmt, ## arg)
103#define info(fmt, arg...) tipc_printf(TIPC_OUTPUT, \
104 KERN_NOTICE "TIPC: " fmt, ## arg)
Allan Stephens6063da92008-05-05 01:23:34 -0700105
106#ifdef CONFIG_TIPC_DEBUG
107
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900108/*
Allan Stephens6063da92008-05-05 01:23:34 -0700109 * DBG_OUTPUT is the destination print buffer for debug messages.
Allan Stephensa4e09272006-06-25 23:40:35 -0700110 */
111
Allan Stephens6063da92008-05-05 01:23:34 -0700112#ifndef DBG_OUTPUT
Allan Stephens6e7e3092010-12-31 18:59:28 +0000113#define DBG_OUTPUT TIPC_LOG
Allan Stephens6063da92008-05-05 01:23:34 -0700114#endif
115
Allan Stephens6e7e3092010-12-31 18:59:28 +0000116#define dbg(fmt, arg...) tipc_printf(DBG_OUTPUT, KERN_DEBUG fmt, ## arg);
Allan Stephens6063da92008-05-05 01:23:34 -0700117
Allan Stephens6e7e3092010-12-31 18:59:28 +0000118#define msg_dbg(msg, txt) tipc_msg_dbg(DBG_OUTPUT, msg, txt);
Allan Stephens6063da92008-05-05 01:23:34 -0700119
Allan Stephens48c97132008-05-05 01:24:06 -0700120void tipc_msg_dbg(struct print_buf *, struct tipc_msg *, const char *);
Allan Stephens48c97132008-05-05 01:24:06 -0700121
Allan Stephens6063da92008-05-05 01:23:34 -0700122#else
123
124#define dbg(fmt, arg...) do {} while (0)
125#define msg_dbg(msg, txt) do {} while (0)
Allan Stephensa4e09272006-06-25 23:40:35 -0700126
Allan Stephens6e7e3092010-12-31 18:59:28 +0000127#define tipc_msg_dbg(buf, msg, txt) do {} while (0)
Allan Stephens48c97132008-05-05 01:24:06 -0700128
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900129#endif
Per Lidenb97bf3f2006-01-02 19:04:38 +0100130
131
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900132/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100133 * TIPC-specific error codes
134 */
135
136#define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */
137
138/*
Allan Stephensd265fef2010-11-30 12:00:53 +0000139 * TIPC operating mode routines
140 */
141#define TIPC_NOT_RUNNING 0
142#define TIPC_NODE_MODE 1
143#define TIPC_NET_MODE 2
144
145/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100146 * Global configuration variables
147 */
148
149extern u32 tipc_own_addr;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100150extern int tipc_max_nodes;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100151extern int tipc_max_ports;
152extern int tipc_max_subscriptions;
153extern int tipc_max_publications;
154extern int tipc_net_id;
155extern int tipc_remote_management;
156
157/*
158 * Other global variables
159 */
160
161extern int tipc_mode;
162extern int tipc_random;
163extern const char tipc_alphabet[];
Per Lidenb97bf3f2006-01-02 19:04:38 +0100164
165
166/*
167 * Routines available to privileged subsystems
168 */
169
stephen hemminger31e3c3f2010-10-13 13:20:35 +0000170extern int tipc_core_start_net(unsigned long);
Allan Stephens0e0609b2008-03-06 15:06:06 -0800171extern int tipc_handler_start(void);
172extern void tipc_handler_stop(void);
173extern int tipc_netlink_start(void);
174extern void tipc_netlink_stop(void);
175extern int tipc_socket_init(void);
176extern void tipc_socket_stop(void);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100177
178static 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
192typedef void (*Handler) (unsigned long);
193
Per Liden4323add2006-01-18 00:38:21 +0100194u32 tipc_k_signal(Handler routine, unsigned long argument);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100195
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
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900201 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100202 * Timer must be initialized before use (and terminated when no longer needed).
203 */
204
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900205static inline void k_init_timer(struct timer_list *timer, Handler routine,
Per Lidenb97bf3f2006-01-02 19:04:38 +0100206 unsigned long argument)
207{
Pavel Emelyanovb24b8a22008-01-23 21:20:07 -0800208 setup_timer(timer, routine, argument);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100209}
210
211/**
212 * k_start_timer - start a timer
213 * @timer: pointer to timer structure
214 * @msec: time to delay (in ms)
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900215 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100216 * Schedules a previously initialized timer for later execution.
217 * If timer is already running, the new timeout overrides the previous request.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900218 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100219 * 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
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900221 * then an additional jiffy is added to account for the fact that
Per Lidenb97bf3f2006-01-02 19:04:38 +0100222 * the starting time may be in the middle of the current jiffy.
223 */
224
225static inline void k_start_timer(struct timer_list *timer, unsigned long msec)
226{
Per Lidenb97bf3f2006-01-02 19:04:38 +0100227 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
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900233 *
234 * Cancels a previously initialized timer.
Per Lidenb97bf3f2006-01-02 19:04:38 +0100235 * Can be called safely even if the timer is already inactive.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900236 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100237 * 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
241static inline void k_cancel_timer(struct timer_list *timer)
242{
Per Lidenb97bf3f2006-01-02 19:04:38 +0100243 del_timer_sync(timer);
244}
245
246/**
247 * k_term_timer - terminate a timer
248 * @timer: pointer to timer structure
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900249 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100250 * Prevents further use of a previously initialized timer.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900251 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100252 * WARNING: Caller must ensure timer isn't currently running.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900253 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100254 * (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
258static inline void k_term_timer(struct timer_list *timer)
259{
Per Lidenb97bf3f2006-01-02 19:04:38 +0100260}
261
262
263/*
264 * TIPC message buffer code
265 *
Allan Stephensf08269d2008-05-08 21:38:24 -0700266 * TIPC message buffer headroom reserves space for the worst-case
267 * link-level device header (in case the message is sent off-node).
Allan Stephens3a8d1212006-10-16 21:50:20 -0700268 *
Allan Stephensf08269d2008-05-08 21:38:24 -0700269 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
270 * are word aligned for quicker access
Per Lidenb97bf3f2006-01-02 19:04:38 +0100271 */
272
Allan Stephensf08269d2008-05-08 21:38:24 -0700273#define BUF_HEADROOM LL_MAX_HEADER
Per Lidenb97bf3f2006-01-02 19:04:38 +0100274
275struct tipc_skb_cb {
276 void *handle;
277};
278
279#define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
280
281
282static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
283{
284 return (struct tipc_msg *)skb->data;
285}
286
stephen hemminger31e3c3f2010-10-13 13:20:35 +0000287extern struct sk_buff *tipc_buf_acquire(u32 size);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100288
289/**
290 * buf_discard - frees a TIPC message buffer
291 * @skb: message buffer
292 *
Allan Stephens8b1f0a92006-06-25 23:42:19 -0700293 * Frees a message buffer. If passed NULL, just returns.
Per Lidenb97bf3f2006-01-02 19:04:38 +0100294 */
295
296static inline void buf_discard(struct sk_buff *skb)
297{
Allan Stephens11ecede2008-04-15 19:01:43 -0700298 kfree_skb(skb);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100299}
300
Allan Stephensfe13dda2008-04-15 19:03:23 -0700301/**
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
308static inline int buf_linearize(struct sk_buff *skb)
309{
310 return skb_linearize(skb);
311}
312
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900313#endif