]>
git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blob - net/tipc/core.h
2 * net/tipc/core.h: Include file for TIPC global declarations
4 * Copyright (c) 2005-2006, Ericsson AB
5 * Copyright (c) 2005-2007, 2010-2011, Wind River Systems
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
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.
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.
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
34 * POSSIBILITY OF SUCH DAMAGE.
40 #include <linux/tipc.h>
41 #include <linux/tipc_config.h>
42 #include <linux/types.h>
43 #include <linux/kernel.h>
44 #include <linux/errno.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>
54 #include <linux/list.h>
55 #include <linux/slab.h>
56 #include <linux/vmalloc.h>
59 #define TIPC_MOD_VER "2.0.0"
61 struct tipc_msg
; /* msg.h */
62 struct print_buf
; /* log.h */
65 * TIPC sanity test macros
68 #define assert(i) BUG_ON(!(i))
71 * TIPC system monitoring code
75 * TIPC's print buffer subsystem supports the following print buffers:
77 * 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 *)
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.
85 extern struct print_buf
*const TIPC_NULL
;
86 extern struct print_buf
*const TIPC_CONS
;
87 extern struct print_buf
*const TIPC_LOG
;
89 void tipc_printf(struct print_buf
*, const char *fmt
, ...);
92 * TIPC_OUTPUT is the destination print buffer for system messages.
96 #define TIPC_OUTPUT TIPC_LOG
99 #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)
106 #ifdef CONFIG_TIPC_DEBUG
109 * DBG_OUTPUT is the destination print buffer for debug messages.
113 #define DBG_OUTPUT TIPC_LOG
116 #define dbg(fmt, arg...) tipc_printf(DBG_OUTPUT, KERN_DEBUG fmt, ## arg);
118 #define msg_dbg(msg, txt) tipc_msg_dbg(DBG_OUTPUT, msg, txt);
120 void tipc_msg_dbg(struct print_buf
*, struct tipc_msg
*, const char *);
124 #define dbg(fmt, arg...) do {} while (0)
125 #define msg_dbg(msg, txt) do {} while (0)
127 #define tipc_msg_dbg(buf, msg, txt) do {} while (0)
133 * TIPC-specific error codes
136 #define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */
139 * TIPC operating mode routines
141 #define TIPC_NOT_RUNNING 0
142 #define TIPC_NODE_MODE 1
143 #define TIPC_NET_MODE 2
146 * Global configuration variables
149 extern u32 tipc_own_addr
;
150 extern int tipc_max_nodes
;
151 extern int tipc_max_ports
;
152 extern int tipc_max_subscriptions
;
153 extern int tipc_max_publications
;
154 extern int tipc_net_id
;
155 extern int tipc_remote_management
;
158 * Other global variables
161 extern int tipc_mode
;
162 extern int tipc_random
;
163 extern const char tipc_alphabet
[];
167 * Routines available to privileged subsystems
170 extern int tipc_core_start_net(unsigned long);
171 extern int tipc_handler_start(void);
172 extern void tipc_handler_stop(void);
173 extern int tipc_netlink_start(void);
174 extern void tipc_netlink_stop(void);
175 extern int tipc_socket_init(void);
176 extern void tipc_socket_stop(void);
178 static inline int delimit(int val
, int min
, int max
)
189 * TIPC timer and signal code
192 typedef void (*Handler
) (unsigned long);
194 u32
tipc_k_signal(Handler routine
, unsigned long argument
);
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
202 * Timer must be initialized before use (and terminated when no longer needed).
205 static inline void k_init_timer(struct timer_list
*timer
, Handler routine
,
206 unsigned long argument
)
208 setup_timer(timer
, routine
, argument
);
212 * k_start_timer - start a timer
213 * @timer: pointer to timer structure
214 * @msec: time to delay (in ms)
216 * Schedules a previously initialized timer for later execution.
217 * If timer is already running, the new timeout overrides the previous request.
219 * 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
221 * then an additional jiffy is added to account for the fact that
222 * the starting time may be in the middle of the current jiffy.
225 static inline void k_start_timer(struct timer_list
*timer
, unsigned long msec
)
227 mod_timer(timer
, jiffies
+ msecs_to_jiffies(msec
) + 1);
231 * k_cancel_timer - cancel a timer
232 * @timer: pointer to timer structure
234 * Cancels a previously initialized timer.
235 * Can be called safely even if the timer is already inactive.
237 * WARNING: Must not be called when holding locks required by the timer's
238 * timeout routine, otherwise deadlock can occur on SMP systems!
241 static inline void k_cancel_timer(struct timer_list
*timer
)
243 del_timer_sync(timer
);
247 * k_term_timer - terminate a timer
248 * @timer: pointer to timer structure
250 * Prevents further use of a previously initialized timer.
252 * WARNING: Caller must ensure timer isn't currently running.
254 * (Do not "enhance" this routine to automatically cancel an active timer,
255 * otherwise deadlock can arise when a timeout routine calls k_term_timer.)
258 static inline void k_term_timer(struct timer_list
*timer
)
264 * TIPC message buffer code
266 * TIPC message buffer headroom reserves space for the worst-case
267 * link-level device header (in case the message is sent off-node).
269 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
270 * are word aligned for quicker access
273 #define BUF_HEADROOM LL_MAX_HEADER
279 #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
282 static inline struct tipc_msg
*buf_msg(struct sk_buff
*skb
)
284 return (struct tipc_msg
*)skb
->data
;
287 extern struct sk_buff
*tipc_buf_acquire(u32 size
);
290 * buf_discard - frees a TIPC message buffer
291 * @skb: message buffer
293 * Frees a message buffer. If passed NULL, just returns.
296 static inline void buf_discard(struct sk_buff
*skb
)
302 * buf_linearize - convert a TIPC message buffer into a single contiguous piece
303 * @skb: message buffer
305 * Returns 0 on success.
308 static inline int buf_linearize(struct sk_buff
*skb
)
310 return skb_linearize(skb
);