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