blob: 13837e0e56b13267e047a8d4cbc581c5475129f8 [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>
Arun Sharma60063492011-07-26 16:09:06 -070050#include <linux/atomic.h>
Per Lidenb97bf3f2006-01-02 19:04:38 +010051#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 system monitoring code
Per Lidenb97bf3f2006-01-02 19:04:38 +010066 */
67
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090068/*
Allan Stephens6063da92008-05-05 01:23:34 -070069 * TIPC's print buffer subsystem supports the following print buffers:
Per Lidenb97bf3f2006-01-02 19:04:38 +010070 *
Allan Stephens6063da92008-05-05 01:23:34 -070071 * TIPC_NULL : null buffer (i.e. print nowhere)
72 * TIPC_CONS : system console
73 * TIPC_LOG : TIPC log buffer
74 * &buf : user-defined buffer (struct print_buf *)
Allan Stephensc8903982008-05-05 01:22:30 -070075 *
76 * Note: TIPC_LOG is configured to echo its output to the system console;
77 * user-defined buffers can be configured to do the same thing.
Per Lidenb97bf3f2006-01-02 19:04:38 +010078 */
Allan Stephens6063da92008-05-05 01:23:34 -070079extern struct print_buf *const TIPC_NULL;
Allan Stephens6e7e3092010-12-31 18:59:28 +000080extern struct print_buf *const TIPC_CONS;
Allan Stephens6063da92008-05-05 01:23:34 -070081extern struct print_buf *const TIPC_LOG;
82
83void tipc_printf(struct print_buf *, const char *fmt, ...);
Allan Stephens6063da92008-05-05 01:23:34 -070084
85/*
86 * TIPC_OUTPUT is the destination print buffer for system messages.
87 */
88
Per Lidenb97bf3f2006-01-02 19:04:38 +010089#ifndef TIPC_OUTPUT
Allan Stephensc8903982008-05-05 01:22:30 -070090#define TIPC_OUTPUT TIPC_LOG
Per Lidenb97bf3f2006-01-02 19:04:38 +010091#endif
92
Allan Stephens6e7e3092010-12-31 18:59:28 +000093#define err(fmt, arg...) tipc_printf(TIPC_OUTPUT, \
94 KERN_ERR "TIPC: " fmt, ## arg)
95#define warn(fmt, arg...) tipc_printf(TIPC_OUTPUT, \
96 KERN_WARNING "TIPC: " fmt, ## arg)
97#define info(fmt, arg...) tipc_printf(TIPC_OUTPUT, \
98 KERN_NOTICE "TIPC: " fmt, ## arg)
Allan Stephens6063da92008-05-05 01:23:34 -070099
100#ifdef CONFIG_TIPC_DEBUG
101
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900102/*
Allan Stephens6063da92008-05-05 01:23:34 -0700103 * DBG_OUTPUT is the destination print buffer for debug messages.
Allan Stephensa4e09272006-06-25 23:40:35 -0700104 */
105
Allan Stephens6063da92008-05-05 01:23:34 -0700106#ifndef DBG_OUTPUT
Allan Stephens6e7e3092010-12-31 18:59:28 +0000107#define DBG_OUTPUT TIPC_LOG
Allan Stephens6063da92008-05-05 01:23:34 -0700108#endif
109
Allan Stephens6e7e3092010-12-31 18:59:28 +0000110#define dbg(fmt, arg...) tipc_printf(DBG_OUTPUT, KERN_DEBUG fmt, ## arg);
Allan Stephens6063da92008-05-05 01:23:34 -0700111
Allan Stephens6e7e3092010-12-31 18:59:28 +0000112#define msg_dbg(msg, txt) tipc_msg_dbg(DBG_OUTPUT, msg, txt);
Allan Stephens6063da92008-05-05 01:23:34 -0700113
Allan Stephens48c97132008-05-05 01:24:06 -0700114void tipc_msg_dbg(struct print_buf *, struct tipc_msg *, const char *);
Allan Stephens48c97132008-05-05 01:24:06 -0700115
Allan Stephens6063da92008-05-05 01:23:34 -0700116#else
117
118#define dbg(fmt, arg...) do {} while (0)
119#define msg_dbg(msg, txt) do {} while (0)
Allan Stephensa4e09272006-06-25 23:40:35 -0700120
Allan Stephens6e7e3092010-12-31 18:59:28 +0000121#define tipc_msg_dbg(buf, msg, txt) do {} while (0)
Allan Stephens48c97132008-05-05 01:24:06 -0700122
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900123#endif
Per Lidenb97bf3f2006-01-02 19:04:38 +0100124
125
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900126/*
Per Lidenb97bf3f2006-01-02 19:04:38 +0100127 * TIPC-specific error codes
128 */
129
130#define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */
131
132/*
133 * Global configuration variables
134 */
135
136extern u32 tipc_own_addr;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100137extern int tipc_max_ports;
138extern int tipc_max_subscriptions;
139extern int tipc_max_publications;
140extern int tipc_net_id;
141extern int tipc_remote_management;
142
143/*
144 * Other global variables
145 */
146
Per Lidenb97bf3f2006-01-02 19:04:38 +0100147extern int tipc_random;
148extern const char tipc_alphabet[];
Per Lidenb97bf3f2006-01-02 19:04:38 +0100149
150
151/*
152 * Routines available to privileged subsystems
153 */
154
stephen hemminger31e3c3f2010-10-13 13:20:35 +0000155extern int tipc_core_start_net(unsigned long);
Allan Stephens0e0609b2008-03-06 15:06:06 -0800156extern int tipc_handler_start(void);
157extern void tipc_handler_stop(void);
158extern int tipc_netlink_start(void);
159extern void tipc_netlink_stop(void);
160extern int tipc_socket_init(void);
161extern void tipc_socket_stop(void);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100162
Per Lidenb97bf3f2006-01-02 19:04:38 +0100163/*
164 * TIPC timer and signal code
165 */
166
167typedef void (*Handler) (unsigned long);
168
Per Liden4323add2006-01-18 00:38:21 +0100169u32 tipc_k_signal(Handler routine, unsigned long argument);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100170
171/**
172 * k_init_timer - initialize a timer
173 * @timer: pointer to timer structure
174 * @routine: pointer to routine to invoke when timer expires
175 * @argument: value to pass to routine when timer expires
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900176 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100177 * Timer must be initialized before use (and terminated when no longer needed).
178 */
179
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900180static inline void k_init_timer(struct timer_list *timer, Handler routine,
Per Lidenb97bf3f2006-01-02 19:04:38 +0100181 unsigned long argument)
182{
Pavel Emelyanovb24b8a22008-01-23 21:20:07 -0800183 setup_timer(timer, routine, argument);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100184}
185
186/**
187 * k_start_timer - start a timer
188 * @timer: pointer to timer structure
189 * @msec: time to delay (in ms)
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900190 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100191 * Schedules a previously initialized timer for later execution.
192 * If timer is already running, the new timeout overrides the previous request.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900193 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100194 * To ensure the timer doesn't expire before the specified delay elapses,
195 * the amount of delay is rounded up when converting to the jiffies
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900196 * then an additional jiffy is added to account for the fact that
Per Lidenb97bf3f2006-01-02 19:04:38 +0100197 * the starting time may be in the middle of the current jiffy.
198 */
199
200static inline void k_start_timer(struct timer_list *timer, unsigned long msec)
201{
Per Lidenb97bf3f2006-01-02 19:04:38 +0100202 mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1);
203}
204
205/**
206 * k_cancel_timer - cancel a timer
207 * @timer: pointer to timer structure
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900208 *
209 * Cancels a previously initialized timer.
Per Lidenb97bf3f2006-01-02 19:04:38 +0100210 * Can be called safely even if the timer is already inactive.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900211 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100212 * WARNING: Must not be called when holding locks required by the timer's
213 * timeout routine, otherwise deadlock can occur on SMP systems!
214 */
215
216static inline void k_cancel_timer(struct timer_list *timer)
217{
Per Lidenb97bf3f2006-01-02 19:04:38 +0100218 del_timer_sync(timer);
219}
220
221/**
222 * k_term_timer - terminate a timer
223 * @timer: pointer to timer structure
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900224 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100225 * Prevents further use of a previously initialized timer.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900226 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100227 * WARNING: Caller must ensure timer isn't currently running.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900228 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100229 * (Do not "enhance" this routine to automatically cancel an active timer,
230 * otherwise deadlock can arise when a timeout routine calls k_term_timer.)
231 */
232
233static inline void k_term_timer(struct timer_list *timer)
234{
Per Lidenb97bf3f2006-01-02 19:04:38 +0100235}
236
237
238/*
239 * TIPC message buffer code
240 *
Allan Stephensf08269d2008-05-08 21:38:24 -0700241 * TIPC message buffer headroom reserves space for the worst-case
242 * link-level device header (in case the message is sent off-node).
Allan Stephens3a8d1212006-10-16 21:50:20 -0700243 *
Allan Stephensf08269d2008-05-08 21:38:24 -0700244 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
245 * are word aligned for quicker access
Per Lidenb97bf3f2006-01-02 19:04:38 +0100246 */
247
Allan Stephensf08269d2008-05-08 21:38:24 -0700248#define BUF_HEADROOM LL_MAX_HEADER
Per Lidenb97bf3f2006-01-02 19:04:38 +0100249
250struct tipc_skb_cb {
251 void *handle;
252};
253
254#define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
255
256
257static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
258{
259 return (struct tipc_msg *)skb->data;
260}
261
stephen hemminger31e3c3f2010-10-13 13:20:35 +0000262extern struct sk_buff *tipc_buf_acquire(u32 size);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100263
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900264#endif