core.h 8.01 KB
Newer Older
Per Liden's avatar
Per Liden committed
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, 2010-2011, Wind River Systems
Per Liden's avatar
Per Liden committed
6
7
 * All rights reserved.
 *
Per Liden's avatar
Per Liden committed
8
 * Redistribution and use in source and binary forms, with or without
Per Liden's avatar
Per Liden committed
9
10
 * modification, are permitted provided that the following conditions are met:
 *
Per Liden's avatar
Per Liden committed
11
12
13
14
15
16
17
18
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the names of the copyright holders nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
Per Liden's avatar
Per Liden committed
19
 *
Per Liden's avatar
Per Liden committed
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
Per Liden's avatar
Per Liden committed
34
35
36
37
38
39
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _TIPC_CORE_H
#define _TIPC_CORE_H

Jon Maloy's avatar
Jon Maloy committed
40
41
#include <linux/tipc.h>
#include <linux/tipc_config.h>
Per Liden's avatar
Per Liden committed
42
43
44
45
46
47
48
49
50
51
52
#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/mm.h>
#include <linux/timer.h>
#include <linux/string.h>
#include <asm/uaccess.h>
#include <linux/interrupt.h>
#include <asm/atomic.h>
#include <asm/hardirq.h>
#include <linux/netdevice.h>
53
#include <linux/in.h>
Per Liden's avatar
Per Liden committed
54
#include <linux/list.h>
55
#include <linux/slab.h>
Per Liden's avatar
Per Liden committed
56
57
#include <linux/vmalloc.h>

58
59
60

#define TIPC_MOD_VER "2.0.0"

61
struct tipc_msg;	/* msg.h */
62
struct print_buf;	/* log.h */
63

Per Liden's avatar
Per Liden committed
64
/*
65
 * TIPC system monitoring code
Per Liden's avatar
Per Liden committed
66
67
 */

68
/*
69
 * TIPC's print buffer subsystem supports the following print buffers:
Per Liden's avatar
Per Liden committed
70
 *
71
72
73
74
 * TIPC_NULL : null buffer (i.e. print nowhere)
 * TIPC_CONS : system console
 * TIPC_LOG  : TIPC log buffer
 * &buf	     : user-defined buffer (struct print_buf *)
75
76
77
 *
 * Note: TIPC_LOG is configured to echo its output to the system console;
 *       user-defined buffers can be configured to do the same thing.
Per Liden's avatar
Per Liden committed
78
 */
79
extern struct print_buf *const TIPC_NULL;
80
extern struct print_buf *const TIPC_CONS;
81
82
83
84
85
86
87
88
extern struct print_buf *const TIPC_LOG;

void tipc_printf(struct print_buf *, const char *fmt, ...);

/*
 * TIPC_OUTPUT is the destination print buffer for system messages.
 */

Per Liden's avatar
Per Liden committed
89
#ifndef TIPC_OUTPUT
90
#define TIPC_OUTPUT TIPC_LOG
Per Liden's avatar
Per Liden committed
91
92
#endif

93
#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)
99

100
#ifdef CONFIG_TIPC_DEBUG
Per Liden's avatar
Per Liden committed
101

102
103
104
105
106
/*
 * DBG_OUTPUT is the destination print buffer for debug messages.
 */

#ifndef DBG_OUTPUT
107
#define DBG_OUTPUT TIPC_LOG
108
#endif
109

110
#define dbg(fmt, arg...)  tipc_printf(DBG_OUTPUT, KERN_DEBUG fmt, ## arg);
111

112
#define msg_dbg(msg, txt) tipc_msg_dbg(DBG_OUTPUT, msg, txt);
113

114
115
void tipc_msg_dbg(struct print_buf *, struct tipc_msg *, const char *);

116
117
118
119
#else

#define dbg(fmt, arg...)	do {} while (0)
#define msg_dbg(msg, txt)	do {} while (0)
120

121
#define tipc_msg_dbg(buf, msg, txt) do {} while (0)
122

123
#endif
Per Liden's avatar
Per Liden committed
124
125


126
/*
Per Liden's avatar
Per Liden committed
127
128
129
130
131
 * TIPC-specific error codes
 */

#define ELINKCONG EAGAIN	/* link congestion <=> resource unavailable */

132
133
134
135
136
137
138
/*
 * TIPC operating mode routines
 */
#define TIPC_NOT_RUNNING  0
#define TIPC_NODE_MODE    1
#define TIPC_NET_MODE     2

Per Liden's avatar
Per Liden committed
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
/*
 * Global configuration variables
 */

extern u32 tipc_own_addr;
extern int tipc_max_ports;
extern int tipc_max_subscriptions;
extern int tipc_max_publications;
extern int tipc_net_id;
extern int tipc_remote_management;

/*
 * Other global variables
 */

extern int tipc_mode;
extern int tipc_random;
extern const char tipc_alphabet[];


/*
 * Routines available to privileged subsystems
 */

163
extern int tipc_core_start_net(unsigned long);
164
165
166
167
168
169
extern int  tipc_handler_start(void);
extern void tipc_handler_stop(void);
extern int  tipc_netlink_start(void);
extern void tipc_netlink_stop(void);
extern int  tipc_socket_init(void);
extern void tipc_socket_stop(void);
Per Liden's avatar
Per Liden committed
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186

static inline int delimit(int val, int min, int max)
{
	if (val > max)
		return max;
	if (val < min)
		return min;
	return val;
}


/*
 * TIPC timer and signal code
 */

typedef void (*Handler) (unsigned long);

187
u32 tipc_k_signal(Handler routine, unsigned long argument);
Per Liden's avatar
Per Liden committed
188
189
190
191
192
193

/**
 * k_init_timer - initialize a timer
 * @timer: pointer to timer structure
 * @routine: pointer to routine to invoke when timer expires
 * @argument: value to pass to routine when timer expires
194
 *
Per Liden's avatar
Per Liden committed
195
196
197
 * Timer must be initialized before use (and terminated when no longer needed).
 */

198
static inline void k_init_timer(struct timer_list *timer, Handler routine,
Per Liden's avatar
Per Liden committed
199
200
				unsigned long argument)
{
201
	setup_timer(timer, routine, argument);
Per Liden's avatar
Per Liden committed
202
203
204
205
206
207
}

/**
 * k_start_timer - start a timer
 * @timer: pointer to timer structure
 * @msec: time to delay (in ms)
208
 *
Per Liden's avatar
Per Liden committed
209
210
 * Schedules a previously initialized timer for later execution.
 * If timer is already running, the new timeout overrides the previous request.
211
 *
Per Liden's avatar
Per Liden committed
212
213
 * To ensure the timer doesn't expire before the specified delay elapses,
 * the amount of delay is rounded up when converting to the jiffies
214
 * then an additional jiffy is added to account for the fact that
Per Liden's avatar
Per Liden committed
215
216
217
218
219
220
221
222
223
224
225
 * the starting time may be in the middle of the current jiffy.
 */

static inline void k_start_timer(struct timer_list *timer, unsigned long msec)
{
	mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1);
}

/**
 * k_cancel_timer - cancel a timer
 * @timer: pointer to timer structure
226
227
 *
 * Cancels a previously initialized timer.
Per Liden's avatar
Per Liden committed
228
 * Can be called safely even if the timer is already inactive.
229
 *
Per Liden's avatar
Per Liden committed
230
231
232
233
234
235
236
237
238
239
240
241
 * WARNING: Must not be called when holding locks required by the timer's
 *          timeout routine, otherwise deadlock can occur on SMP systems!
 */

static inline void k_cancel_timer(struct timer_list *timer)
{
	del_timer_sync(timer);
}

/**
 * k_term_timer - terminate a timer
 * @timer: pointer to timer structure
242
 *
Per Liden's avatar
Per Liden committed
243
 * Prevents further use of a previously initialized timer.
244
 *
Per Liden's avatar
Per Liden committed
245
 * WARNING: Caller must ensure timer isn't currently running.
246
 *
Per Liden's avatar
Per Liden committed
247
248
249
250
251
252
253
254
255
256
257
258
 * (Do not "enhance" this routine to automatically cancel an active timer,
 * otherwise deadlock can arise when a timeout routine calls k_term_timer.)
 */

static inline void k_term_timer(struct timer_list *timer)
{
}


/*
 * TIPC message buffer code
 *
259
260
 * TIPC message buffer headroom reserves space for the worst-case
 * link-level device header (in case the message is sent off-node).
261
 *
262
263
 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
 *       are word aligned for quicker access
Per Liden's avatar
Per Liden committed
264
265
 */

266
#define BUF_HEADROOM LL_MAX_HEADER
Per Liden's avatar
Per Liden committed
267
268
269
270
271
272
273
274
275
276
277
278
279

struct tipc_skb_cb {
	void *handle;
};

#define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))


static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
{
	return (struct tipc_msg *)skb->data;
}

280
extern struct sk_buff *tipc_buf_acquire(u32 size);
Per Liden's avatar
Per Liden committed
281
282
283
284
285

/**
 * buf_discard - frees a TIPC message buffer
 * @skb: message buffer
 *
286
 * Frees a message buffer.  If passed NULL, just returns.
Per Liden's avatar
Per Liden committed
287
288
289
290
 */

static inline void buf_discard(struct sk_buff *skb)
{
291
	kfree_skb(skb);
Per Liden's avatar
Per Liden committed
292
293
}

294
295
296
297
298
299
300
301
302
303
304
305
/**
 * buf_linearize - convert a TIPC message buffer into a single contiguous piece
 * @skb: message buffer
 *
 * Returns 0 on success.
 */

static inline int buf_linearize(struct sk_buff *skb)
{
	return skb_linearize(skb);
}

306
#endif