Commit | Line | Data |
---|---|---|
b97bf3fd PL |
1 | /* |
2 | * net/tipc/core.h: Include file for TIPC global declarations | |
c4307285 | 3 | * |
593a5f22 | 4 | * Copyright (c) 2005-2006, Ericsson AB |
4132faca | 5 | * Copyright (c) 2005-2007, 2010-2011, Wind River Systems |
b97bf3fd PL |
6 | * All rights reserved. |
7 | * | |
9ea1fd3c | 8 | * Redistribution and use in source and binary forms, with or without |
b97bf3fd PL |
9 | * modification, are permitted provided that the following conditions are met: |
10 | * | |
9ea1fd3c PL |
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. | |
b97bf3fd | 19 | * |
9ea1fd3c PL |
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 | |
b97bf3fd PL |
34 | * POSSIBILITY OF SUCH DAMAGE. |
35 | */ | |
36 | ||
37 | #ifndef _TIPC_CORE_H | |
38 | #define _TIPC_CORE_H | |
39 | ||
5f7c3ff6 JM |
40 | #include <linux/tipc.h> |
41 | #include <linux/tipc_config.h> | |
b97bf3fd PL |
42 | #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> | |
60063497 | 50 | #include <linux/atomic.h> |
b97bf3fd PL |
51 | #include <asm/hardirq.h> |
52 | #include <linux/netdevice.h> | |
c4307285 | 53 | #include <linux/in.h> |
b97bf3fd | 54 | #include <linux/list.h> |
5a0e3ad6 | 55 | #include <linux/slab.h> |
b97bf3fd PL |
56 | #include <linux/vmalloc.h> |
57 | ||
107e7be6 AS |
58 | |
59 | #define TIPC_MOD_VER "2.0.0" | |
60 | ||
d265fef6 | 61 | struct tipc_msg; /* msg.h */ |
f5e75269 | 62 | struct print_buf; /* log.h */ |
d265fef6 | 63 | |
b97bf3fd | 64 | /* |
6063da9d | 65 | * TIPC system monitoring code |
b97bf3fd PL |
66 | */ |
67 | ||
c4307285 | 68 | /* |
6063da9d | 69 | * TIPC's print buffer subsystem supports the following print buffers: |
b97bf3fd | 70 | * |
6063da9d AS |
71 | * 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 *) | |
c8903985 AS |
75 | * |
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. | |
b97bf3fd | 78 | */ |
6063da9d | 79 | extern struct print_buf *const TIPC_NULL; |
6e7e309c | 80 | extern struct print_buf *const TIPC_CONS; |
6063da9d AS |
81 | extern struct print_buf *const TIPC_LOG; |
82 | ||
83 | void tipc_printf(struct print_buf *, const char *fmt, ...); | |
6063da9d AS |
84 | |
85 | /* | |
86 | * TIPC_OUTPUT is the destination print buffer for system messages. | |
87 | */ | |
88 | ||
b97bf3fd | 89 | #ifndef TIPC_OUTPUT |
c8903985 | 90 | #define TIPC_OUTPUT TIPC_LOG |
b97bf3fd PL |
91 | #endif |
92 | ||
6063da9d | 93 | #define err(fmt, arg...) tipc_printf(TIPC_OUTPUT, \ |
6e7e309c | 94 | KERN_ERR "TIPC: " fmt, ## arg) |
6063da9d | 95 | #define warn(fmt, arg...) tipc_printf(TIPC_OUTPUT, \ |
6e7e309c | 96 | KERN_WARNING "TIPC: " fmt, ## arg) |
6063da9d | 97 | #define info(fmt, arg...) tipc_printf(TIPC_OUTPUT, \ |
6e7e309c | 98 | KERN_NOTICE "TIPC: " fmt, ## arg) |
6063da9d | 99 | |
6e7e309c | 100 | #ifdef CONFIG_TIPC_DEBUG |
b97bf3fd | 101 | |
6063da9d AS |
102 | /* |
103 | * DBG_OUTPUT is the destination print buffer for debug messages. | |
6063da9d AS |
104 | */ |
105 | ||
106 | #ifndef DBG_OUTPUT | |
6e7e309c | 107 | #define DBG_OUTPUT TIPC_LOG |
6063da9d | 108 | #endif |
a4e09279 | 109 | |
6e7e309c | 110 | #define dbg(fmt, arg...) tipc_printf(DBG_OUTPUT, KERN_DEBUG fmt, ## arg); |
a4e09279 | 111 | |
6e7e309c | 112 | #define msg_dbg(msg, txt) tipc_msg_dbg(DBG_OUTPUT, msg, txt); |
6063da9d | 113 | |
48c97139 | 114 | void tipc_msg_dbg(struct print_buf *, struct tipc_msg *, const char *); |
48c97139 | 115 | |
6063da9d AS |
116 | #else |
117 | ||
118 | #define dbg(fmt, arg...) do {} while (0) | |
119 | #define msg_dbg(msg, txt) do {} while (0) | |
48c97139 | 120 | |
6e7e309c | 121 | #define tipc_msg_dbg(buf, msg, txt) do {} while (0) |
a4e09279 | 122 | |
c4307285 | 123 | #endif |
b97bf3fd PL |
124 | |
125 | ||
c4307285 | 126 | /* |
b97bf3fd PL |
127 | * TIPC-specific error codes |
128 | */ | |
129 | ||
130 | #define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */ | |
131 | ||
132 | /* | |
133 | * Global configuration variables | |
134 | */ | |
135 | ||
136 | extern u32 tipc_own_addr; | |
b97bf3fd PL |
137 | extern int tipc_max_ports; |
138 | extern int tipc_max_subscriptions; | |
139 | extern int tipc_max_publications; | |
140 | extern int tipc_net_id; | |
141 | extern int tipc_remote_management; | |
142 | ||
143 | /* | |
144 | * Other global variables | |
145 | */ | |
146 | ||
b97bf3fd PL |
147 | extern int tipc_random; |
148 | extern const char tipc_alphabet[]; | |
b97bf3fd PL |
149 | |
150 | ||
151 | /* | |
152 | * Routines available to privileged subsystems | |
153 | */ | |
154 | ||
31e3c3f6 | 155 | extern int tipc_core_start_net(unsigned long); |
0e0609bb AS |
156 | extern int tipc_handler_start(void); |
157 | extern void tipc_handler_stop(void); | |
158 | extern int tipc_netlink_start(void); | |
159 | extern void tipc_netlink_stop(void); | |
160 | extern int tipc_socket_init(void); | |
161 | extern void tipc_socket_stop(void); | |
b97bf3fd | 162 | |
b97bf3fd PL |
163 | /* |
164 | * TIPC timer and signal code | |
165 | */ | |
166 | ||
167 | typedef void (*Handler) (unsigned long); | |
168 | ||
4323add6 | 169 | u32 tipc_k_signal(Handler routine, unsigned long argument); |
b97bf3fd PL |
170 | |
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 | |
c4307285 | 176 | * |
b97bf3fd PL |
177 | * Timer must be initialized before use (and terminated when no longer needed). |
178 | */ | |
179 | ||
c4307285 | 180 | static inline void k_init_timer(struct timer_list *timer, Handler routine, |
b97bf3fd PL |
181 | unsigned long argument) |
182 | { | |
b24b8a24 | 183 | setup_timer(timer, routine, argument); |
b97bf3fd PL |
184 | } |
185 | ||
186 | /** | |
187 | * k_start_timer - start a timer | |
188 | * @timer: pointer to timer structure | |
189 | * @msec: time to delay (in ms) | |
c4307285 | 190 | * |
b97bf3fd PL |
191 | * Schedules a previously initialized timer for later execution. |
192 | * If timer is already running, the new timeout overrides the previous request. | |
c4307285 | 193 | * |
b97bf3fd PL |
194 | * 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 | |
c4307285 | 196 | * then an additional jiffy is added to account for the fact that |
b97bf3fd PL |
197 | * the starting time may be in the middle of the current jiffy. |
198 | */ | |
199 | ||
200 | static inline void k_start_timer(struct timer_list *timer, unsigned long msec) | |
201 | { | |
b97bf3fd PL |
202 | 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 | |
c4307285 YH |
208 | * |
209 | * Cancels a previously initialized timer. | |
b97bf3fd | 210 | * Can be called safely even if the timer is already inactive. |
c4307285 | 211 | * |
b97bf3fd PL |
212 | * 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 | ||
216 | static inline void k_cancel_timer(struct timer_list *timer) | |
217 | { | |
b97bf3fd PL |
218 | del_timer_sync(timer); |
219 | } | |
220 | ||
221 | /** | |
222 | * k_term_timer - terminate a timer | |
223 | * @timer: pointer to timer structure | |
c4307285 | 224 | * |
b97bf3fd | 225 | * Prevents further use of a previously initialized timer. |
c4307285 | 226 | * |
b97bf3fd | 227 | * WARNING: Caller must ensure timer isn't currently running. |
c4307285 | 228 | * |
b97bf3fd PL |
229 | * (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 | ||
233 | static inline void k_term_timer(struct timer_list *timer) | |
234 | { | |
b97bf3fd PL |
235 | } |
236 | ||
237 | ||
238 | /* | |
239 | * TIPC message buffer code | |
240 | * | |
f08269d3 AS |
241 | * TIPC message buffer headroom reserves space for the worst-case |
242 | * link-level device header (in case the message is sent off-node). | |
3a8d1214 | 243 | * |
f08269d3 AS |
244 | * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields |
245 | * are word aligned for quicker access | |
b97bf3fd PL |
246 | */ |
247 | ||
f08269d3 | 248 | #define BUF_HEADROOM LL_MAX_HEADER |
b97bf3fd PL |
249 | |
250 | struct tipc_skb_cb { | |
251 | void *handle; | |
252 | }; | |
253 | ||
254 | #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0])) | |
255 | ||
256 | ||
257 | static inline struct tipc_msg *buf_msg(struct sk_buff *skb) | |
258 | { | |
259 | return (struct tipc_msg *)skb->data; | |
260 | } | |
261 | ||
31e3c3f6 | 262 | extern struct sk_buff *tipc_buf_acquire(u32 size); |
b97bf3fd | 263 | |
c4307285 | 264 | #endif |