core.h 6.36 KB
Newer Older
Per Liden's avatar
Per Liden committed
1
2
/*
 * net/tipc/core.h: Include file for TIPC global declarations
3
 *
4
5
 * Copyright (c) 2005-2006, 2013 Ericsson AB
 * Copyright (c) 2005-2007, 2010-2013, 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

40
41
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

Jon Maloy's avatar
Jon Maloy committed
42
43
#include <linux/tipc.h>
#include <linux/tipc_config.h>
Per Liden's avatar
Per Liden committed
44
45
46
47
48
49
50
51
#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>
Arun Sharma's avatar
Arun Sharma committed
52
#include <linux/atomic.h>
Per Liden's avatar
Per Liden committed
53
54
#include <asm/hardirq.h>
#include <linux/netdevice.h>
55
#include <linux/in.h>
Per Liden's avatar
Per Liden committed
56
#include <linux/list.h>
57
#include <linux/slab.h>
Per Liden's avatar
Per Liden committed
58
59
#include <linux/vmalloc.h>

60
61
62

#define TIPC_MOD_VER "2.0.0"

63
64
#define ULTRA_STRING_MAX_LEN	32768
#define TIPC_MAX_SUBSCRIPTIONS	65535
65
#define TIPC_MAX_PUBLICATIONS	65535
66

67
struct tipc_msg;	/* msg.h */
68

69
int tipc_snprintf(char *buf, int len, const char *fmt, ...);
70

71
/*
Per Liden's avatar
Per Liden committed
72
73
74
75
76
77
78
 * TIPC-specific error codes
 */
#define ELINKCONG EAGAIN	/* link congestion <=> resource unavailable */

/*
 * Global configuration variables
 */
79
80
81
82
extern u32 tipc_own_addr __read_mostly;
extern int tipc_max_ports __read_mostly;
extern int tipc_net_id __read_mostly;
extern int tipc_remote_management __read_mostly;
83
extern int sysctl_tipc_rmem[3] __read_mostly;
Per Liden's avatar
Per Liden committed
84
85
86
87

/*
 * Other global variables
 */
88
extern int tipc_random __read_mostly;
Per Liden's avatar
Per Liden committed
89
90
91
92

/*
 * Routines available to privileged subsystems
 */
93
extern int tipc_core_start_net(unsigned long);
94
95
96
97
98
99
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);
100
101
102
103
extern int tipc_sock_create_local(int type, struct socket **res);
extern void tipc_sock_release_local(struct socket *sock);
extern int tipc_sock_accept_local(struct socket *sock,
				  struct socket **newsock, int flags);
Per Liden's avatar
Per Liden committed
104

105
106
107
108
109
110
111
112
#ifdef CONFIG_SYSCTL
extern int tipc_register_sysctl(void);
extern void tipc_unregister_sysctl(void);
#else
#define tipc_register_sysctl() 0
#define tipc_unregister_sysctl()
#endif

Per Liden's avatar
Per Liden committed
113
114
115
116
117
/*
 * TIPC timer and signal code
 */
typedef void (*Handler) (unsigned long);

118
u32 tipc_k_signal(Handler routine, unsigned long argument);
Per Liden's avatar
Per Liden committed
119
120
121
122
123
124

/**
 * 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
125
 *
Per Liden's avatar
Per Liden committed
126
127
 * Timer must be initialized before use (and terminated when no longer needed).
 */
128
static inline void k_init_timer(struct timer_list *timer, Handler routine,
Per Liden's avatar
Per Liden committed
129
130
				unsigned long argument)
{
131
	setup_timer(timer, routine, argument);
Per Liden's avatar
Per Liden committed
132
133
134
135
136
137
}

/**
 * k_start_timer - start a timer
 * @timer: pointer to timer structure
 * @msec: time to delay (in ms)
138
 *
Per Liden's avatar
Per Liden committed
139
140
 * Schedules a previously initialized timer for later execution.
 * If timer is already running, the new timeout overrides the previous request.
141
 *
Per Liden's avatar
Per Liden committed
142
143
 * To ensure the timer doesn't expire before the specified delay elapses,
 * the amount of delay is rounded up when converting to the jiffies
144
 * then an additional jiffy is added to account for the fact that
Per Liden's avatar
Per Liden committed
145
146
147
148
149
150
151
152
153
154
 * 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
155
156
 *
 * Cancels a previously initialized timer.
Per Liden's avatar
Per Liden committed
157
 * Can be called safely even if the timer is already inactive.
158
 *
Per Liden's avatar
Per Liden committed
159
160
161
162
163
164
165
166
167
168
169
 * 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
170
 *
Per Liden's avatar
Per Liden committed
171
 * Prevents further use of a previously initialized timer.
172
 *
Per Liden's avatar
Per Liden committed
173
 * WARNING: Caller must ensure timer isn't currently running.
174
 *
Per Liden's avatar
Per Liden committed
175
176
177
178
179
180
181
182
183
184
 * (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
 *
185
186
 * TIPC message buffer headroom reserves space for the worst-case
 * link-level device header (in case the message is sent off-node).
187
 *
188
189
 * 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
190
 */
191
#define BUF_HEADROOM LL_MAX_HEADER
Per Liden's avatar
Per Liden committed
192
193
194
195
196
197
198
199
200
201
202
203

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;
}

204
extern struct sk_buff *tipc_buf_acquire(u32 size);
Per Liden's avatar
Per Liden committed
205

206
#endif