Blame view
net/tipc/core.h
8.01 KB
b97bf3fd8 [TIPC] Initial merge |
1 2 |
/* * net/tipc/core.h: Include file for TIPC global declarations |
c43072852 [NET] TIPC: Fix w... |
3 |
* |
593a5f22d [TIPC] More updat... |
4 |
* Copyright (c) 2005-2006, Ericsson AB |
4132facae tipc: Remove unus... |
5 |
* Copyright (c) 2005-2007, 2010-2011, Wind River Systems |
b97bf3fd8 [TIPC] Initial merge |
6 7 |
* All rights reserved. * |
9ea1fd3c1 [TIPC] License he... |
8 |
* Redistribution and use in source and binary forms, with or without |
b97bf3fd8 [TIPC] Initial merge |
9 10 |
* modification, are permitted provided that the following conditions are met: * |
9ea1fd3c1 [TIPC] License he... |
11 12 13 14 15 16 17 18 |
* 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the names of the copyright holders nor the names of its * contributors may be used to endorse or promote products derived from * this software without specific prior written permission. |
b97bf3fd8 [TIPC] Initial merge |
19 |
* |
9ea1fd3c1 [TIPC] License he... |
20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
* Alternatively, this software may be distributed under the terms of the * GNU General Public License ("GPL") version 2 as published by the Free * Software Foundation. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
b97bf3fd8 [TIPC] Initial merge |
34 35 36 37 38 |
* POSSIBILITY OF SUCH DAMAGE. */ #ifndef _TIPC_CORE_H #define _TIPC_CORE_H |
5f7c3ff6a [TIPC] Minor chan... |
39 40 |
#include <linux/tipc.h> #include <linux/tipc_config.h> |
b97bf3fd8 [TIPC] Initial merge |
41 42 43 44 45 46 47 48 |
#include <linux/types.h> #include <linux/kernel.h> #include <linux/errno.h> #include <linux/mm.h> #include <linux/timer.h> #include <linux/string.h> #include <asm/uaccess.h> #include <linux/interrupt.h> |
60063497a atomic: use <linu... |
49 |
#include <linux/atomic.h> |
b97bf3fd8 [TIPC] Initial merge |
50 51 |
#include <asm/hardirq.h> #include <linux/netdevice.h> |
c43072852 [NET] TIPC: Fix w... |
52 |
#include <linux/in.h> |
b97bf3fd8 [TIPC] Initial merge |
53 |
#include <linux/list.h> |
5a0e3ad6a include cleanup: ... |
54 |
#include <linux/slab.h> |
b97bf3fd8 [TIPC] Initial merge |
55 |
#include <linux/vmalloc.h> |
107e7be62 tipc: Add support... |
56 57 |
#define TIPC_MOD_VER "2.0.0" |
d265fef6d tipc: Remove obso... |
58 |
struct tipc_msg; /* msg.h */ |
f5e75269f tipc: rename dbg.... |
59 |
struct print_buf; /* log.h */ |
d265fef6d tipc: Remove obso... |
60 |
|
b97bf3fd8 [TIPC] Initial merge |
61 |
/* |
6063da9d7 tipc: Cosmetic cl... |
62 |
* TIPC system monitoring code |
b97bf3fd8 [TIPC] Initial merge |
63 |
*/ |
c43072852 [NET] TIPC: Fix w... |
64 |
/* |
6063da9d7 tipc: Cosmetic cl... |
65 |
* TIPC's print buffer subsystem supports the following print buffers: |
b97bf3fd8 [TIPC] Initial merge |
66 |
* |
6063da9d7 tipc: Cosmetic cl... |
67 68 69 70 |
* TIPC_NULL : null buffer (i.e. print nowhere) * TIPC_CONS : system console * TIPC_LOG : TIPC log buffer * &buf : user-defined buffer (struct print_buf *) |
c89039850 tipc: Elimination... |
71 72 73 |
* * Note: TIPC_LOG is configured to echo its output to the system console; * user-defined buffers can be configured to do the same thing. |
b97bf3fd8 [TIPC] Initial merge |
74 |
*/ |
6063da9d7 tipc: Cosmetic cl... |
75 |
extern struct print_buf *const TIPC_NULL; |
6e7e309c6 tipc: Finish stre... |
76 |
extern struct print_buf *const TIPC_CONS; |
6063da9d7 tipc: Cosmetic cl... |
77 78 79 |
extern struct print_buf *const TIPC_LOG; void tipc_printf(struct print_buf *, const char *fmt, ...); |
6063da9d7 tipc: Cosmetic cl... |
80 81 82 83 |
/* * TIPC_OUTPUT is the destination print buffer for system messages. */ |
b97bf3fd8 [TIPC] Initial merge |
84 |
#ifndef TIPC_OUTPUT |
c89039850 tipc: Elimination... |
85 |
#define TIPC_OUTPUT TIPC_LOG |
b97bf3fd8 [TIPC] Initial merge |
86 |
#endif |
6063da9d7 tipc: Cosmetic cl... |
87 |
#define err(fmt, arg...) tipc_printf(TIPC_OUTPUT, \ |
6e7e309c6 tipc: Finish stre... |
88 |
KERN_ERR "TIPC: " fmt, ## arg) |
6063da9d7 tipc: Cosmetic cl... |
89 |
#define warn(fmt, arg...) tipc_printf(TIPC_OUTPUT, \ |
6e7e309c6 tipc: Finish stre... |
90 |
KERN_WARNING "TIPC: " fmt, ## arg) |
6063da9d7 tipc: Cosmetic cl... |
91 |
#define info(fmt, arg...) tipc_printf(TIPC_OUTPUT, \ |
6e7e309c6 tipc: Finish stre... |
92 |
KERN_NOTICE "TIPC: " fmt, ## arg) |
6063da9d7 tipc: Cosmetic cl... |
93 |
|
6e7e309c6 tipc: Finish stre... |
94 |
#ifdef CONFIG_TIPC_DEBUG |
b97bf3fd8 [TIPC] Initial merge |
95 |
|
6063da9d7 tipc: Cosmetic cl... |
96 97 |
/* * DBG_OUTPUT is the destination print buffer for debug messages. |
6063da9d7 tipc: Cosmetic cl... |
98 99 100 |
*/ #ifndef DBG_OUTPUT |
6e7e309c6 tipc: Finish stre... |
101 |
#define DBG_OUTPUT TIPC_LOG |
6063da9d7 tipc: Cosmetic cl... |
102 |
#endif |
a4e092790 [TIPC]: Allow com... |
103 |
|
6e7e309c6 tipc: Finish stre... |
104 |
#define dbg(fmt, arg...) tipc_printf(DBG_OUTPUT, KERN_DEBUG fmt, ## arg); |
a4e092790 [TIPC]: Allow com... |
105 |
|
6e7e309c6 tipc: Finish stre... |
106 |
#define msg_dbg(msg, txt) tipc_msg_dbg(DBG_OUTPUT, msg, txt); |
6063da9d7 tipc: Cosmetic cl... |
107 |
|
48c971394 tipc: Exclude deb... |
108 |
void tipc_msg_dbg(struct print_buf *, struct tipc_msg *, const char *); |
48c971394 tipc: Exclude deb... |
109 |
|
6063da9d7 tipc: Cosmetic cl... |
110 111 112 113 |
#else #define dbg(fmt, arg...) do {} while (0) #define msg_dbg(msg, txt) do {} while (0) |
48c971394 tipc: Exclude deb... |
114 |
|
6e7e309c6 tipc: Finish stre... |
115 |
#define tipc_msg_dbg(buf, msg, txt) do {} while (0) |
a4e092790 [TIPC]: Allow com... |
116 |
|
c43072852 [NET] TIPC: Fix w... |
117 |
#endif |
b97bf3fd8 [TIPC] Initial merge |
118 |
|
c43072852 [NET] TIPC: Fix w... |
119 |
/* |
b97bf3fd8 [TIPC] Initial merge |
120 121 122 123 124 125 |
* TIPC-specific error codes */ #define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */ /* |
d265fef6d tipc: Remove obso... |
126 127 128 129 130 131 132 |
* TIPC operating mode routines */ #define TIPC_NOT_RUNNING 0 #define TIPC_NODE_MODE 1 #define TIPC_NET_MODE 2 /* |
b97bf3fd8 [TIPC] Initial merge |
133 134 135 136 |
* Global configuration variables */ extern u32 tipc_own_addr; |
b97bf3fd8 [TIPC] Initial merge |
137 138 139 140 141 142 143 144 145 146 147 148 149 |
extern int tipc_max_ports; extern int tipc_max_subscriptions; extern int tipc_max_publications; extern int tipc_net_id; extern int tipc_remote_management; /* * Other global variables */ extern int tipc_mode; extern int tipc_random; extern const char tipc_alphabet[]; |
b97bf3fd8 [TIPC] Initial merge |
150 151 152 153 154 |
/* * Routines available to privileged subsystems */ |
31e3c3f6f tipc: cleanup fun... |
155 |
extern int tipc_core_start_net(unsigned long); |
0e0609bbd [TIPC]: Eliminate... |
156 157 158 159 160 161 |
extern int tipc_handler_start(void); extern void tipc_handler_stop(void); extern int tipc_netlink_start(void); extern void tipc_netlink_stop(void); extern int tipc_socket_init(void); extern void tipc_socket_stop(void); |
b97bf3fd8 [TIPC] Initial merge |
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
static inline int delimit(int val, int min, int max) { if (val > max) return max; if (val < min) return min; return val; } /* * TIPC timer and signal code */ typedef void (*Handler) (unsigned long); |
4323add67 [TIPC] Avoid poll... |
178 |
u32 tipc_k_signal(Handler routine, unsigned long argument); |
b97bf3fd8 [TIPC] Initial merge |
179 180 181 182 183 184 |
/** * k_init_timer - initialize a timer * @timer: pointer to timer structure * @routine: pointer to routine to invoke when timer expires * @argument: value to pass to routine when timer expires |
c43072852 [NET] TIPC: Fix w... |
185 |
* |
b97bf3fd8 [TIPC] Initial merge |
186 187 |
* Timer must be initialized before use (and terminated when no longer needed). */ |
c43072852 [NET] TIPC: Fix w... |
188 |
static inline void k_init_timer(struct timer_list *timer, Handler routine, |
b97bf3fd8 [TIPC] Initial merge |
189 190 |
unsigned long argument) { |
b24b8a247 [NET]: Convert in... |
191 |
setup_timer(timer, routine, argument); |
b97bf3fd8 [TIPC] Initial merge |
192 193 194 195 196 197 |
} /** * k_start_timer - start a timer * @timer: pointer to timer structure * @msec: time to delay (in ms) |
c43072852 [NET] TIPC: Fix w... |
198 |
* |
b97bf3fd8 [TIPC] Initial merge |
199 200 |
* Schedules a previously initialized timer for later execution. * If timer is already running, the new timeout overrides the previous request. |
c43072852 [NET] TIPC: Fix w... |
201 |
* |
b97bf3fd8 [TIPC] Initial merge |
202 203 |
* To ensure the timer doesn't expire before the specified delay elapses, * the amount of delay is rounded up when converting to the jiffies |
c43072852 [NET] TIPC: Fix w... |
204 |
* then an additional jiffy is added to account for the fact that |
b97bf3fd8 [TIPC] Initial merge |
205 206 207 208 209 |
* the starting time may be in the middle of the current jiffy. */ static inline void k_start_timer(struct timer_list *timer, unsigned long msec) { |
b97bf3fd8 [TIPC] Initial merge |
210 211 212 213 214 215 |
mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1); } /** * k_cancel_timer - cancel a timer * @timer: pointer to timer structure |
c43072852 [NET] TIPC: Fix w... |
216 217 |
* * Cancels a previously initialized timer. |
b97bf3fd8 [TIPC] Initial merge |
218 |
* Can be called safely even if the timer is already inactive. |
c43072852 [NET] TIPC: Fix w... |
219 |
* |
b97bf3fd8 [TIPC] Initial merge |
220 221 222 223 224 225 |
* WARNING: Must not be called when holding locks required by the timer's * timeout routine, otherwise deadlock can occur on SMP systems! */ static inline void k_cancel_timer(struct timer_list *timer) { |
b97bf3fd8 [TIPC] Initial merge |
226 227 228 229 230 231 |
del_timer_sync(timer); } /** * k_term_timer - terminate a timer * @timer: pointer to timer structure |
c43072852 [NET] TIPC: Fix w... |
232 |
* |
b97bf3fd8 [TIPC] Initial merge |
233 |
* Prevents further use of a previously initialized timer. |
c43072852 [NET] TIPC: Fix w... |
234 |
* |
b97bf3fd8 [TIPC] Initial merge |
235 |
* WARNING: Caller must ensure timer isn't currently running. |
c43072852 [NET] TIPC: Fix w... |
236 |
* |
b97bf3fd8 [TIPC] Initial merge |
237 238 239 240 241 242 |
* (Do not "enhance" this routine to automatically cancel an active timer, * otherwise deadlock can arise when a timeout routine calls k_term_timer.) */ static inline void k_term_timer(struct timer_list *timer) { |
b97bf3fd8 [TIPC] Initial merge |
243 244 245 246 247 248 |
} /* * TIPC message buffer code * |
f08269d3e tipc: Increase bu... |
249 250 |
* TIPC message buffer headroom reserves space for the worst-case * link-level device header (in case the message is sent off-node). |
3a8d12142 [TIPC]: Add suppo... |
251 |
* |
f08269d3e tipc: Increase bu... |
252 253 |
* Note: Headroom should be a multiple of 4 to ensure the TIPC header fields * are word aligned for quicker access |
b97bf3fd8 [TIPC] Initial merge |
254 |
*/ |
f08269d3e tipc: Increase bu... |
255 |
#define BUF_HEADROOM LL_MAX_HEADER |
b97bf3fd8 [TIPC] Initial merge |
256 257 258 259 260 261 262 263 264 265 266 267 |
struct tipc_skb_cb { void *handle; }; #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0])) static inline struct tipc_msg *buf_msg(struct sk_buff *skb) { return (struct tipc_msg *)skb->data; } |
31e3c3f6f tipc: cleanup fun... |
268 |
extern struct sk_buff *tipc_buf_acquire(u32 size); |
b97bf3fd8 [TIPC] Initial merge |
269 270 271 272 273 |
/** * buf_discard - frees a TIPC message buffer * @skb: message buffer * |
8b1f0a92e [TIPC]: Fix misle... |
274 |
* Frees a message buffer. If passed NULL, just returns. |
b97bf3fd8 [TIPC] Initial merge |
275 276 277 278 |
*/ static inline void buf_discard(struct sk_buff *skb) { |
11ecede78 [TIPC]: Remove re... |
279 |
kfree_skb(skb); |
b97bf3fd8 [TIPC] Initial merge |
280 |
} |
fe13dda2d [TIPC]: Force lin... |
281 282 283 284 285 286 287 288 289 290 291 |
/** * buf_linearize - convert a TIPC message buffer into a single contiguous piece * @skb: message buffer * * Returns 0 on success. */ static inline int buf_linearize(struct sk_buff *skb) { return skb_linearize(skb); } |
c43072852 [NET] TIPC: Fix w... |
292 |
#endif |