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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
42 #include <linux/tipc.h>
43 #include <linux/tipc_config.h>
44 #include <linux/types.h>
45 #include <linux/kernel.h>
46 #include <linux/errno.h>
48 #include <linux/timer.h>
49 #include <linux/string.h>
50 #include <asm/uaccess.h>
51 #include <linux/interrupt.h>
52 #include <linux/atomic.h>
53 #include <asm/hardirq.h>
54 #include <linux/netdevice.h>
56 #include <linux/list.h>
57 #include <linux/slab.h>
58 #include <linux/vmalloc.h>
61 #define TIPC_MOD_VER "2.0.0"
63 #define ULTRA_STRING_MAX_LEN 32768
65 struct tipc_msg; /* msg.h */
66 struct print_buf; /* log.h */
69 * TIPC system monitoring code
73 * TIPC's print buffer subsystem supports the following print buffers:
75 * TIPC_NULL : null buffer (i.e. print nowhere)
76 * TIPC_CONS : system console
77 * TIPC_LOG : TIPC log buffer
78 * &buf : user-defined buffer (struct print_buf *)
80 * Note: TIPC_LOG is configured to echo its output to the system console;
81 * user-defined buffers can be configured to do the same thing.
83 extern struct print_buf *const TIPC_NULL;
84 extern struct print_buf *const TIPC_CONS;
85 extern struct print_buf *const TIPC_LOG;
87 int tipc_snprintf(char *buf, int len, const char *fmt, ...);
90 * TIPC_OUTPUT is the destination print buffer for system messages.
93 #define TIPC_OUTPUT TIPC_LOG
97 * TIPC-specific error codes
99 #define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */
102 * Global configuration variables
104 extern u32 tipc_own_addr;
105 extern int tipc_max_ports;
106 extern int tipc_max_subscriptions;
107 extern int tipc_max_publications;
108 extern int tipc_net_id;
109 extern int tipc_remote_management;
112 * Other global variables
114 extern int tipc_random;
115 extern const char tipc_alphabet[];
119 * Routines available to privileged subsystems
121 extern int tipc_core_start_net(unsigned long);
122 extern int tipc_handler_start(void);
123 extern void tipc_handler_stop(void);
124 extern int tipc_netlink_start(void);
125 extern void tipc_netlink_stop(void);
126 extern int tipc_socket_init(void);
127 extern void tipc_socket_stop(void);
130 * TIPC timer and signal code
132 typedef void (*Handler) (unsigned long);
134 u32 tipc_k_signal(Handler routine, unsigned long argument);
137 * k_init_timer - initialize a timer
138 * @timer: pointer to timer structure
139 * @routine: pointer to routine to invoke when timer expires
140 * @argument: value to pass to routine when timer expires
142 * Timer must be initialized before use (and terminated when no longer needed).
144 static inline void k_init_timer(struct timer_list *timer, Handler routine,
145 unsigned long argument)
147 setup_timer(timer, routine, argument);
151 * k_start_timer - start a timer
152 * @timer: pointer to timer structure
153 * @msec: time to delay (in ms)
155 * Schedules a previously initialized timer for later execution.
156 * If timer is already running, the new timeout overrides the previous request.
158 * To ensure the timer doesn't expire before the specified delay elapses,
159 * the amount of delay is rounded up when converting to the jiffies
160 * then an additional jiffy is added to account for the fact that
161 * the starting time may be in the middle of the current jiffy.
163 static inline void k_start_timer(struct timer_list *timer, unsigned long msec)
165 mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1);
169 * k_cancel_timer - cancel a timer
170 * @timer: pointer to timer structure
172 * Cancels a previously initialized timer.
173 * Can be called safely even if the timer is already inactive.
175 * WARNING: Must not be called when holding locks required by the timer's
176 * timeout routine, otherwise deadlock can occur on SMP systems!
178 static inline void k_cancel_timer(struct timer_list *timer)
180 del_timer_sync(timer);
184 * k_term_timer - terminate a timer
185 * @timer: pointer to timer structure
187 * Prevents further use of a previously initialized timer.
189 * WARNING: Caller must ensure timer isn't currently running.
191 * (Do not "enhance" this routine to automatically cancel an active timer,
192 * otherwise deadlock can arise when a timeout routine calls k_term_timer.)
194 static inline void k_term_timer(struct timer_list *timer)
199 * TIPC message buffer code
201 * TIPC message buffer headroom reserves space for the worst-case
202 * link-level device header (in case the message is sent off-node).
204 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
205 * are word aligned for quicker access
207 #define BUF_HEADROOM LL_MAX_HEADER
213 #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
215 static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
217 return (struct tipc_msg *)skb->data;
220 extern struct sk_buff *tipc_buf_acquire(u32 size);