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, 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 <net/tipc/tipc_msg.h> 43 #include <net/tipc/tipc_port.h> 44 #include <net/tipc/tipc_bearer.h> 45 #include <net/tipc/tipc.h> 46 #include <linux/types.h> 47 #include <linux/kernel.h> 48 #include <linux/errno.h> 49 #include <linux/mm.h> 50 #include <linux/timer.h> 51 #include <linux/string.h> 52 #include <asm/uaccess.h> 53 #include <linux/interrupt.h> 54 #include <asm/atomic.h> 55 #include <asm/hardirq.h> 56 #include <linux/netdevice.h> 57 #include <linux/in.h> 58 #include <linux/list.h> 59 #include <linux/slab.h> 60 #include <linux/vmalloc.h> 61 62 63 #define TIPC_MOD_VER "2.0.0" 64 65 /* 66 * TIPC sanity test macros 67 */ 68 69 #define assert(i) BUG_ON(!(i)) 70 71 /* 72 * TIPC system monitoring code 73 */ 74 75 /* 76 * TIPC's print buffer subsystem supports the following print buffers: 77 * 78 * TIPC_NULL : null buffer (i.e. print nowhere) 79 * TIPC_CONS : system console 80 * TIPC_LOG : TIPC log buffer 81 * &buf : user-defined buffer (struct print_buf *) 82 * 83 * Note: TIPC_LOG is configured to echo its output to the system console; 84 * user-defined buffers can be configured to do the same thing. 85 */ 86 extern struct print_buf *const TIPC_NULL; 87 extern struct print_buf *const TIPC_LOG; 88 89 void tipc_printf(struct print_buf *, const char *fmt, ...); 90 91 /* 92 * TIPC_OUTPUT is the destination print buffer for system messages. 93 */ 94 95 #ifndef TIPC_OUTPUT 96 #define TIPC_OUTPUT TIPC_LOG 97 #endif 98 99 /* 100 * TIPC can be configured to send system messages to TIPC_OUTPUT 101 * or to the system console only. 102 */ 103 104 #ifdef CONFIG_TIPC_DEBUG 105 106 #define err(fmt, arg...) tipc_printf(TIPC_OUTPUT, \ 107 KERN_ERR "TIPC: " fmt, ## arg) 108 #define warn(fmt, arg...) tipc_printf(TIPC_OUTPUT, \ 109 KERN_WARNING "TIPC: " fmt, ## arg) 110 #define info(fmt, arg...) tipc_printf(TIPC_OUTPUT, \ 111 KERN_NOTICE "TIPC: " fmt, ## arg) 112 113 #else 114 115 #define err(fmt, arg...) printk(KERN_ERR "TIPC: " fmt , ## arg) 116 #define info(fmt, arg...) printk(KERN_INFO "TIPC: " fmt , ## arg) 117 #define warn(fmt, arg...) printk(KERN_WARNING "TIPC: " fmt , ## arg) 118 119 #endif 120 121 /* 122 * DBG_OUTPUT is the destination print buffer for debug messages. 123 * It defaults to the the null print buffer, but can be redefined 124 * (typically in the individual .c files being debugged) to allow 125 * selected debug messages to be generated where needed. 126 */ 127 128 #ifndef DBG_OUTPUT 129 #define DBG_OUTPUT TIPC_NULL 130 #endif 131 132 /* 133 * TIPC can be configured to send debug messages to the specified print buffer 134 * (typically DBG_OUTPUT) or to suppress them entirely. 135 */ 136 137 #ifdef CONFIG_TIPC_DEBUG 138 139 #define dbg(fmt, arg...) \ 140 do { \ 141 if (DBG_OUTPUT != TIPC_NULL) \ 142 tipc_printf(DBG_OUTPUT, fmt, ## arg); \ 143 } while (0) 144 #define msg_dbg(msg, txt) \ 145 do { \ 146 if (DBG_OUTPUT != TIPC_NULL) \ 147 tipc_msg_dbg(DBG_OUTPUT, msg, txt); \ 148 } while (0) 149 #define dump(fmt, arg...) \ 150 do { \ 151 if (DBG_OUTPUT != TIPC_NULL) \ 152 tipc_dump_dbg(DBG_OUTPUT, fmt, ##arg); \ 153 } while (0) 154 155 void tipc_msg_dbg(struct print_buf *, struct tipc_msg *, const char *); 156 void tipc_dump_dbg(struct print_buf *, const char *fmt, ...); 157 158 #else 159 160 #define dbg(fmt, arg...) do {} while (0) 161 #define msg_dbg(msg, txt) do {} while (0) 162 #define dump(fmt, arg...) do {} while (0) 163 164 #define tipc_msg_dbg(...) do {} while (0) 165 #define tipc_dump_dbg(...) do {} while (0) 166 167 #endif 168 169 170 /* 171 * TIPC-specific error codes 172 */ 173 174 #define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */ 175 176 /* 177 * Global configuration variables 178 */ 179 180 extern u32 tipc_own_addr; 181 extern int tipc_max_zones; 182 extern int tipc_max_clusters; 183 extern int tipc_max_nodes; 184 extern int tipc_max_slaves; 185 extern int tipc_max_ports; 186 extern int tipc_max_subscriptions; 187 extern int tipc_max_publications; 188 extern int tipc_net_id; 189 extern int tipc_remote_management; 190 191 /* 192 * Other global variables 193 */ 194 195 extern int tipc_mode; 196 extern int tipc_random; 197 extern const char tipc_alphabet[]; 198 extern atomic_t tipc_user_count; 199 200 201 /* 202 * Routines available to privileged subsystems 203 */ 204 205 extern int tipc_core_start_net(unsigned long); 206 extern int tipc_handler_start(void); 207 extern void tipc_handler_stop(void); 208 extern int tipc_netlink_start(void); 209 extern void tipc_netlink_stop(void); 210 extern int tipc_socket_init(void); 211 extern void tipc_socket_stop(void); 212 213 static inline int delimit(int val, int min, int max) 214 { 215 if (val > max) 216 return max; 217 if (val < min) 218 return min; 219 return val; 220 } 221 222 223 /* 224 * TIPC timer and signal code 225 */ 226 227 typedef void (*Handler) (unsigned long); 228 229 u32 tipc_k_signal(Handler routine, unsigned long argument); 230 231 /** 232 * k_init_timer - initialize a timer 233 * @timer: pointer to timer structure 234 * @routine: pointer to routine to invoke when timer expires 235 * @argument: value to pass to routine when timer expires 236 * 237 * Timer must be initialized before use (and terminated when no longer needed). 238 */ 239 240 static inline void k_init_timer(struct timer_list *timer, Handler routine, 241 unsigned long argument) 242 { 243 dbg("initializing timer %p\n", timer); 244 setup_timer(timer, routine, argument); 245 } 246 247 /** 248 * k_start_timer - start a timer 249 * @timer: pointer to timer structure 250 * @msec: time to delay (in ms) 251 * 252 * Schedules a previously initialized timer for later execution. 253 * If timer is already running, the new timeout overrides the previous request. 254 * 255 * To ensure the timer doesn't expire before the specified delay elapses, 256 * the amount of delay is rounded up when converting to the jiffies 257 * then an additional jiffy is added to account for the fact that 258 * the starting time may be in the middle of the current jiffy. 259 */ 260 261 static inline void k_start_timer(struct timer_list *timer, unsigned long msec) 262 { 263 dbg("starting timer %p for %u\n", timer, msec); 264 mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1); 265 } 266 267 /** 268 * k_cancel_timer - cancel a timer 269 * @timer: pointer to timer structure 270 * 271 * Cancels a previously initialized timer. 272 * Can be called safely even if the timer is already inactive. 273 * 274 * WARNING: Must not be called when holding locks required by the timer's 275 * timeout routine, otherwise deadlock can occur on SMP systems! 276 */ 277 278 static inline void k_cancel_timer(struct timer_list *timer) 279 { 280 dbg("cancelling timer %p\n", timer); 281 del_timer_sync(timer); 282 } 283 284 /** 285 * k_term_timer - terminate a timer 286 * @timer: pointer to timer structure 287 * 288 * Prevents further use of a previously initialized timer. 289 * 290 * WARNING: Caller must ensure timer isn't currently running. 291 * 292 * (Do not "enhance" this routine to automatically cancel an active timer, 293 * otherwise deadlock can arise when a timeout routine calls k_term_timer.) 294 */ 295 296 static inline void k_term_timer(struct timer_list *timer) 297 { 298 dbg("terminating timer %p\n", timer); 299 } 300 301 302 /* 303 * TIPC message buffer code 304 * 305 * TIPC message buffer headroom reserves space for the worst-case 306 * link-level device header (in case the message is sent off-node). 307 * 308 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields 309 * are word aligned for quicker access 310 */ 311 312 #define BUF_HEADROOM LL_MAX_HEADER 313 314 struct tipc_skb_cb { 315 void *handle; 316 }; 317 318 #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0])) 319 320 321 static inline struct tipc_msg *buf_msg(struct sk_buff *skb) 322 { 323 return (struct tipc_msg *)skb->data; 324 } 325 326 extern struct sk_buff *tipc_buf_acquire(u32 size); 327 328 /** 329 * buf_discard - frees a TIPC message buffer 330 * @skb: message buffer 331 * 332 * Frees a message buffer. If passed NULL, just returns. 333 */ 334 335 static inline void buf_discard(struct sk_buff *skb) 336 { 337 kfree_skb(skb); 338 } 339 340 /** 341 * buf_linearize - convert a TIPC message buffer into a single contiguous piece 342 * @skb: message buffer 343 * 344 * Returns 0 on success. 345 */ 346 347 static inline int buf_linearize(struct sk_buff *skb) 348 { 349 return skb_linearize(skb); 350 } 351 352 #endif 353