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
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
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.
19  *
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
34  * POSSIBILITY OF SUCH DAMAGE.
35  */
36 
37 #ifndef _TIPC_CORE_H
38 #define _TIPC_CORE_H
39 
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>
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>
50 #include <linux/atomic.h>
51 #include <asm/hardirq.h>
52 #include <linux/netdevice.h>
53 #include <linux/in.h>
54 #include <linux/list.h>
55 #include <linux/slab.h>
56 #include <linux/vmalloc.h>
57 
58 
59 #define TIPC_MOD_VER "2.0.0"
60 
61 struct tipc_msg;	/* msg.h */
62 struct print_buf;	/* log.h */
63 
64 /*
65  * TIPC system monitoring code
66  */
67 
68 /*
69  * TIPC's print buffer subsystem supports the following print buffers:
70  *
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 *)
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.
78  */
79 extern struct print_buf *const TIPC_NULL;
80 extern struct print_buf *const TIPC_CONS;
81 extern struct print_buf *const TIPC_LOG;
82 
83 void tipc_printf(struct print_buf *, const char *fmt, ...);
84 
85 /*
86  * TIPC_OUTPUT is the destination print buffer for system messages.
87  */
88 
89 #ifndef TIPC_OUTPUT
90 #define TIPC_OUTPUT TIPC_LOG
91 #endif
92 
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
101 
102 /*
103  * DBG_OUTPUT is the destination print buffer for debug messages.
104  */
105 
106 #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 void tipc_msg_dbg(struct print_buf *, struct tipc_msg *, const char *);
115 
116 #else
117 
118 #define dbg(fmt, arg...)	do {} while (0)
119 #define msg_dbg(msg, txt)	do {} while (0)
120 
121 #define tipc_msg_dbg(buf, msg, txt) do {} while (0)
122 
123 #endif
124 
125 
126 /*
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;
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 
147 extern int tipc_random;
148 extern const char tipc_alphabet[];
149 
150 
151 /*
152  * Routines available to privileged subsystems
153  */
154 
155 extern int tipc_core_start_net(unsigned long);
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);
162 
163 /*
164  * TIPC timer and signal code
165  */
166 
167 typedef void (*Handler) (unsigned long);
168 
169 u32 tipc_k_signal(Handler routine, unsigned long argument);
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
176  *
177  * Timer must be initialized before use (and terminated when no longer needed).
178  */
179 
k_init_timer(struct timer_list * timer,Handler routine,unsigned long argument)180 static inline void k_init_timer(struct timer_list *timer, Handler routine,
181 				unsigned long argument)
182 {
183 	setup_timer(timer, routine, argument);
184 }
185 
186 /**
187  * k_start_timer - start a timer
188  * @timer: pointer to timer structure
189  * @msec: time to delay (in ms)
190  *
191  * Schedules a previously initialized timer for later execution.
192  * If timer is already running, the new timeout overrides the previous request.
193  *
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
196  * then an additional jiffy is added to account for the fact that
197  * the starting time may be in the middle of the current jiffy.
198  */
199 
k_start_timer(struct timer_list * timer,unsigned long msec)200 static inline void k_start_timer(struct timer_list *timer, unsigned long msec)
201 {
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
208  *
209  * Cancels a previously initialized timer.
210  * Can be called safely even if the timer is already inactive.
211  *
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 
k_cancel_timer(struct timer_list * timer)216 static inline void k_cancel_timer(struct timer_list *timer)
217 {
218 	del_timer_sync(timer);
219 }
220 
221 /**
222  * k_term_timer - terminate a timer
223  * @timer: pointer to timer structure
224  *
225  * Prevents further use of a previously initialized timer.
226  *
227  * WARNING: Caller must ensure timer isn't currently running.
228  *
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 
k_term_timer(struct timer_list * timer)233 static inline void k_term_timer(struct timer_list *timer)
234 {
235 }
236 
237 
238 /*
239  * TIPC message buffer code
240  *
241  * TIPC message buffer headroom reserves space for the worst-case
242  * link-level device header (in case the message is sent off-node).
243  *
244  * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
245  *       are word aligned for quicker access
246  */
247 
248 #define BUF_HEADROOM LL_MAX_HEADER
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 
buf_msg(struct sk_buff * skb)257 static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
258 {
259 	return (struct tipc_msg *)skb->data;
260 }
261 
262 extern struct sk_buff *tipc_buf_acquire(u32 size);
263 
264 #endif
265