Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 1 | /* |
| 2 | * net/tipc/core.h: Include file for TIPC global declarations |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 3 | * |
Per Liden | 593a5f2 | 2006-01-11 19:14:19 +0100 | [diff] [blame] | 4 | * Copyright (c) 2005-2006, Ericsson AB |
Allan Stephens | 4132fac | 2011-01-07 13:12:12 -0500 | [diff] [blame] | 5 | * Copyright (c) 2005-2007, 2010-2011, Wind River Systems |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 6 | * All rights reserved. |
| 7 | * |
Per Liden | 9ea1fd3 | 2006-01-11 13:30:43 +0100 | [diff] [blame] | 8 | * Redistribution and use in source and binary forms, with or without |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 9 | * modification, are permitted provided that the following conditions are met: |
| 10 | * |
Per Liden | 9ea1fd3 | 2006-01-11 13:30:43 +0100 | [diff] [blame] | 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. |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 19 | * |
Per Liden | 9ea1fd3 | 2006-01-11 13:30:43 +0100 | [diff] [blame] | 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 |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 34 | * POSSIBILITY OF SUCH DAMAGE. |
| 35 | */ |
| 36 | |
| 37 | #ifndef _TIPC_CORE_H |
| 38 | #define _TIPC_CORE_H |
| 39 | |
Jon Maloy | 5f7c3ff | 2006-01-13 10:45:44 +0000 | [diff] [blame] | 40 | #include <linux/tipc.h> |
| 41 | #include <linux/tipc_config.h> |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 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> |
Arun Sharma | 6006349 | 2011-07-26 16:09:06 -0700 | [diff] [blame] | 50 | #include <linux/atomic.h> |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 51 | #include <asm/hardirq.h> |
| 52 | #include <linux/netdevice.h> |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 53 | #include <linux/in.h> |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 54 | #include <linux/list.h> |
Tejun Heo | 5a0e3ad | 2010-03-24 17:04:11 +0900 | [diff] [blame] | 55 | #include <linux/slab.h> |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 56 | #include <linux/vmalloc.h> |
| 57 | |
Allan Stephens | 107e7be | 2010-05-11 14:30:08 +0000 | [diff] [blame] | 58 | |
| 59 | #define TIPC_MOD_VER "2.0.0" |
| 60 | |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 61 | struct tipc_msg; /* msg.h */ |
Allan Stephens | f5e7526 | 2010-12-31 18:59:24 +0000 | [diff] [blame] | 62 | struct print_buf; /* log.h */ |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 63 | |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 64 | /* |
Allan Stephens | 6063da9 | 2008-05-05 01:23:34 -0700 | [diff] [blame] | 65 | * TIPC system monitoring code |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 66 | */ |
| 67 | |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 68 | /* |
Allan Stephens | 6063da9 | 2008-05-05 01:23:34 -0700 | [diff] [blame] | 69 | * TIPC's print buffer subsystem supports the following print buffers: |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 70 | * |
Allan Stephens | 6063da9 | 2008-05-05 01:23:34 -0700 | [diff] [blame] | 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 *) |
Allan Stephens | c890398 | 2008-05-05 01:22:30 -0700 | [diff] [blame] | 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. |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 78 | */ |
Allan Stephens | 6063da9 | 2008-05-05 01:23:34 -0700 | [diff] [blame] | 79 | extern struct print_buf *const TIPC_NULL; |
Allan Stephens | 6e7e309 | 2010-12-31 18:59:28 +0000 | [diff] [blame] | 80 | extern struct print_buf *const TIPC_CONS; |
Allan Stephens | 6063da9 | 2008-05-05 01:23:34 -0700 | [diff] [blame] | 81 | extern struct print_buf *const TIPC_LOG; |
| 82 | |
| 83 | void tipc_printf(struct print_buf *, const char *fmt, ...); |
Allan Stephens | 6063da9 | 2008-05-05 01:23:34 -0700 | [diff] [blame] | 84 | |
| 85 | /* |
| 86 | * TIPC_OUTPUT is the destination print buffer for system messages. |
| 87 | */ |
| 88 | |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 89 | #ifndef TIPC_OUTPUT |
Allan Stephens | c890398 | 2008-05-05 01:22:30 -0700 | [diff] [blame] | 90 | #define TIPC_OUTPUT TIPC_LOG |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 91 | #endif |
| 92 | |
Allan Stephens | 6e7e309 | 2010-12-31 18:59:28 +0000 | [diff] [blame] | 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) |
Allan Stephens | 6063da9 | 2008-05-05 01:23:34 -0700 | [diff] [blame] | 99 | |
| 100 | #ifdef CONFIG_TIPC_DEBUG |
| 101 | |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 102 | /* |
Allan Stephens | 6063da9 | 2008-05-05 01:23:34 -0700 | [diff] [blame] | 103 | * DBG_OUTPUT is the destination print buffer for debug messages. |
Allan Stephens | a4e0927 | 2006-06-25 23:40:35 -0700 | [diff] [blame] | 104 | */ |
| 105 | |
Allan Stephens | 6063da9 | 2008-05-05 01:23:34 -0700 | [diff] [blame] | 106 | #ifndef DBG_OUTPUT |
Allan Stephens | 6e7e309 | 2010-12-31 18:59:28 +0000 | [diff] [blame] | 107 | #define DBG_OUTPUT TIPC_LOG |
Allan Stephens | 6063da9 | 2008-05-05 01:23:34 -0700 | [diff] [blame] | 108 | #endif |
| 109 | |
Allan Stephens | 6e7e309 | 2010-12-31 18:59:28 +0000 | [diff] [blame] | 110 | #define dbg(fmt, arg...) tipc_printf(DBG_OUTPUT, KERN_DEBUG fmt, ## arg); |
Allan Stephens | 6063da9 | 2008-05-05 01:23:34 -0700 | [diff] [blame] | 111 | |
Allan Stephens | 6e7e309 | 2010-12-31 18:59:28 +0000 | [diff] [blame] | 112 | #define msg_dbg(msg, txt) tipc_msg_dbg(DBG_OUTPUT, msg, txt); |
Allan Stephens | 6063da9 | 2008-05-05 01:23:34 -0700 | [diff] [blame] | 113 | |
Allan Stephens | 48c9713 | 2008-05-05 01:24:06 -0700 | [diff] [blame] | 114 | void tipc_msg_dbg(struct print_buf *, struct tipc_msg *, const char *); |
Allan Stephens | 48c9713 | 2008-05-05 01:24:06 -0700 | [diff] [blame] | 115 | |
Allan Stephens | 6063da9 | 2008-05-05 01:23:34 -0700 | [diff] [blame] | 116 | #else |
| 117 | |
| 118 | #define dbg(fmt, arg...) do {} while (0) |
| 119 | #define msg_dbg(msg, txt) do {} while (0) |
Allan Stephens | a4e0927 | 2006-06-25 23:40:35 -0700 | [diff] [blame] | 120 | |
Allan Stephens | 6e7e309 | 2010-12-31 18:59:28 +0000 | [diff] [blame] | 121 | #define tipc_msg_dbg(buf, msg, txt) do {} while (0) |
Allan Stephens | 48c9713 | 2008-05-05 01:24:06 -0700 | [diff] [blame] | 122 | |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 123 | #endif |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 124 | |
| 125 | |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 126 | /* |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 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; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 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 | |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 147 | extern int tipc_random; |
| 148 | extern const char tipc_alphabet[]; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 149 | |
| 150 | |
| 151 | /* |
| 152 | * Routines available to privileged subsystems |
| 153 | */ |
| 154 | |
stephen hemminger | 31e3c3f | 2010-10-13 13:20:35 +0000 | [diff] [blame] | 155 | extern int tipc_core_start_net(unsigned long); |
Allan Stephens | 0e0609b | 2008-03-06 15:06:06 -0800 | [diff] [blame] | 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); |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 162 | |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 163 | /* |
| 164 | * TIPC timer and signal code |
| 165 | */ |
| 166 | |
| 167 | typedef void (*Handler) (unsigned long); |
| 168 | |
Per Liden | 4323add | 2006-01-18 00:38:21 +0100 | [diff] [blame] | 169 | u32 tipc_k_signal(Handler routine, unsigned long argument); |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 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 |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 176 | * |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 177 | * Timer must be initialized before use (and terminated when no longer needed). |
| 178 | */ |
| 179 | |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 180 | static inline void k_init_timer(struct timer_list *timer, Handler routine, |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 181 | unsigned long argument) |
| 182 | { |
Pavel Emelyanov | b24b8a2 | 2008-01-23 21:20:07 -0800 | [diff] [blame] | 183 | setup_timer(timer, routine, argument); |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 184 | } |
| 185 | |
| 186 | /** |
| 187 | * k_start_timer - start a timer |
| 188 | * @timer: pointer to timer structure |
| 189 | * @msec: time to delay (in ms) |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 190 | * |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 191 | * Schedules a previously initialized timer for later execution. |
| 192 | * If timer is already running, the new timeout overrides the previous request. |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 193 | * |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 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 |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 196 | * then an additional jiffy is added to account for the fact that |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 197 | * the starting time may be in the middle of the current jiffy. |
| 198 | */ |
| 199 | |
| 200 | static inline void k_start_timer(struct timer_list *timer, unsigned long msec) |
| 201 | { |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 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 |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 208 | * |
| 209 | * Cancels a previously initialized timer. |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 210 | * Can be called safely even if the timer is already inactive. |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 211 | * |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 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 | |
| 216 | static inline void k_cancel_timer(struct timer_list *timer) |
| 217 | { |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 218 | del_timer_sync(timer); |
| 219 | } |
| 220 | |
| 221 | /** |
| 222 | * k_term_timer - terminate a timer |
| 223 | * @timer: pointer to timer structure |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 224 | * |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 225 | * Prevents further use of a previously initialized timer. |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 226 | * |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 227 | * WARNING: Caller must ensure timer isn't currently running. |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 228 | * |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 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 | |
| 233 | static inline void k_term_timer(struct timer_list *timer) |
| 234 | { |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 235 | } |
| 236 | |
| 237 | |
| 238 | /* |
| 239 | * TIPC message buffer code |
| 240 | * |
Allan Stephens | f08269d | 2008-05-08 21:38:24 -0700 | [diff] [blame] | 241 | * TIPC message buffer headroom reserves space for the worst-case |
| 242 | * link-level device header (in case the message is sent off-node). |
Allan Stephens | 3a8d121 | 2006-10-16 21:50:20 -0700 | [diff] [blame] | 243 | * |
Allan Stephens | f08269d | 2008-05-08 21:38:24 -0700 | [diff] [blame] | 244 | * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields |
| 245 | * are word aligned for quicker access |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 246 | */ |
| 247 | |
Allan Stephens | f08269d | 2008-05-08 21:38:24 -0700 | [diff] [blame] | 248 | #define BUF_HEADROOM LL_MAX_HEADER |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 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 | |
| 257 | static inline struct tipc_msg *buf_msg(struct sk_buff *skb) |
| 258 | { |
| 259 | return (struct tipc_msg *)skb->data; |
| 260 | } |
| 261 | |
stephen hemminger | 31e3c3f | 2010-10-13 13:20:35 +0000 | [diff] [blame] | 262 | extern struct sk_buff *tipc_buf_acquire(u32 size); |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 263 | |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 264 | #endif |