Commit | Line | Data |
---|---|---|
b97bf3fd PL |
1 | /* |
2 | * net/tipc/core.h: Include file for TIPC global declarations | |
c4307285 | 3 | * |
c5fa7b3c YX |
4 | * Copyright (c) 2005-2006, 2013 Ericsson AB |
5 | * Copyright (c) 2005-2007, 2010-2013, Wind River Systems | |
b97bf3fd PL |
6 | * All rights reserved. |
7 | * | |
9ea1fd3c | 8 | * Redistribution and use in source and binary forms, with or without |
b97bf3fd PL |
9 | * modification, are permitted provided that the following conditions are met: |
10 | * | |
9ea1fd3c PL |
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. | |
b97bf3fd | 19 | * |
9ea1fd3c PL |
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 | |
b97bf3fd PL |
34 | * POSSIBILITY OF SUCH DAMAGE. |
35 | */ | |
36 | ||
37 | #ifndef _TIPC_CORE_H | |
38 | #define _TIPC_CORE_H | |
39 | ||
2cf8aa19 EH |
40 | #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt |
41 | ||
5f7c3ff6 JM |
42 | #include <linux/tipc.h> |
43 | #include <linux/tipc_config.h> | |
b97bf3fd PL |
44 | #include <linux/types.h> |
45 | #include <linux/kernel.h> | |
46 | #include <linux/errno.h> | |
47 | #include <linux/mm.h> | |
48 | #include <linux/timer.h> | |
49 | #include <linux/string.h> | |
776a74ce | 50 | #include <linux/uaccess.h> |
b97bf3fd | 51 | #include <linux/interrupt.h> |
60063497 | 52 | #include <linux/atomic.h> |
b97bf3fd PL |
53 | #include <asm/hardirq.h> |
54 | #include <linux/netdevice.h> | |
c4307285 | 55 | #include <linux/in.h> |
b97bf3fd | 56 | #include <linux/list.h> |
5a0e3ad6 | 57 | #include <linux/slab.h> |
b97bf3fd PL |
58 | #include <linux/vmalloc.h> |
59 | ||
107e7be6 AS |
60 | |
61 | #define TIPC_MOD_VER "2.0.0" | |
62 | ||
34f256cc YX |
63 | #define ULTRA_STRING_MAX_LEN 32768 |
64 | #define TIPC_MAX_SUBSCRIPTIONS 65535 | |
e6a04b1d | 65 | #define TIPC_MAX_PUBLICATIONS 65535 |
dc1aed37 | 66 | |
d265fef6 | 67 | struct tipc_msg; /* msg.h */ |
6063da9d | 68 | |
dc1aed37 | 69 | int tipc_snprintf(char *buf, int len, const char *fmt, ...); |
6063da9d | 70 | |
c4307285 | 71 | /* |
b97bf3fd PL |
72 | * TIPC-specific error codes |
73 | */ | |
b97bf3fd PL |
74 | #define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */ |
75 | ||
76 | /* | |
77 | * Global configuration variables | |
78 | */ | |
61cdd4d8 YX |
79 | extern u32 tipc_own_addr __read_mostly; |
80 | extern int tipc_max_ports __read_mostly; | |
61cdd4d8 | 81 | extern int tipc_net_id __read_mostly; |
cc79dd1b | 82 | extern int sysctl_tipc_rmem[3] __read_mostly; |
b97bf3fd PL |
83 | |
84 | /* | |
85 | * Other global variables | |
86 | */ | |
61cdd4d8 | 87 | extern int tipc_random __read_mostly; |
b97bf3fd PL |
88 | |
89 | /* | |
90 | * Routines available to privileged subsystems | |
91 | */ | |
c1b1203d JP |
92 | int tipc_handler_start(void); |
93 | void tipc_handler_stop(void); | |
94 | int tipc_netlink_start(void); | |
95 | void tipc_netlink_stop(void); | |
96 | int tipc_socket_init(void); | |
97 | void tipc_socket_stop(void); | |
98 | int tipc_sock_create_local(int type, struct socket **res); | |
99 | void tipc_sock_release_local(struct socket *sock); | |
100 | int tipc_sock_accept_local(struct socket *sock, struct socket **newsock, | |
101 | int flags); | |
b97bf3fd | 102 | |
cc79dd1b | 103 | #ifdef CONFIG_SYSCTL |
c1b1203d JP |
104 | int tipc_register_sysctl(void); |
105 | void tipc_unregister_sysctl(void); | |
cc79dd1b YX |
106 | #else |
107 | #define tipc_register_sysctl() 0 | |
108 | #define tipc_unregister_sysctl() | |
109 | #endif | |
110 | ||
b97bf3fd PL |
111 | /* |
112 | * TIPC timer and signal code | |
113 | */ | |
b97bf3fd PL |
114 | typedef void (*Handler) (unsigned long); |
115 | ||
4323add6 | 116 | u32 tipc_k_signal(Handler routine, unsigned long argument); |
b97bf3fd PL |
117 | |
118 | /** | |
119 | * k_init_timer - initialize a timer | |
120 | * @timer: pointer to timer structure | |
121 | * @routine: pointer to routine to invoke when timer expires | |
122 | * @argument: value to pass to routine when timer expires | |
c4307285 | 123 | * |
b97bf3fd PL |
124 | * Timer must be initialized before use (and terminated when no longer needed). |
125 | */ | |
c4307285 | 126 | static inline void k_init_timer(struct timer_list *timer, Handler routine, |
b97bf3fd PL |
127 | unsigned long argument) |
128 | { | |
b24b8a24 | 129 | setup_timer(timer, routine, argument); |
b97bf3fd PL |
130 | } |
131 | ||
132 | /** | |
133 | * k_start_timer - start a timer | |
134 | * @timer: pointer to timer structure | |
135 | * @msec: time to delay (in ms) | |
c4307285 | 136 | * |
b97bf3fd PL |
137 | * Schedules a previously initialized timer for later execution. |
138 | * If timer is already running, the new timeout overrides the previous request. | |
c4307285 | 139 | * |
b97bf3fd PL |
140 | * To ensure the timer doesn't expire before the specified delay elapses, |
141 | * the amount of delay is rounded up when converting to the jiffies | |
c4307285 | 142 | * then an additional jiffy is added to account for the fact that |
b97bf3fd PL |
143 | * the starting time may be in the middle of the current jiffy. |
144 | */ | |
b97bf3fd PL |
145 | static inline void k_start_timer(struct timer_list *timer, unsigned long msec) |
146 | { | |
b97bf3fd PL |
147 | mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1); |
148 | } | |
149 | ||
150 | /** | |
151 | * k_cancel_timer - cancel a timer | |
152 | * @timer: pointer to timer structure | |
c4307285 YH |
153 | * |
154 | * Cancels a previously initialized timer. | |
b97bf3fd | 155 | * Can be called safely even if the timer is already inactive. |
c4307285 | 156 | * |
b97bf3fd PL |
157 | * WARNING: Must not be called when holding locks required by the timer's |
158 | * timeout routine, otherwise deadlock can occur on SMP systems! | |
159 | */ | |
b97bf3fd PL |
160 | static inline void k_cancel_timer(struct timer_list *timer) |
161 | { | |
b97bf3fd PL |
162 | del_timer_sync(timer); |
163 | } | |
164 | ||
165 | /** | |
166 | * k_term_timer - terminate a timer | |
167 | * @timer: pointer to timer structure | |
c4307285 | 168 | * |
b97bf3fd | 169 | * Prevents further use of a previously initialized timer. |
c4307285 | 170 | * |
b97bf3fd | 171 | * WARNING: Caller must ensure timer isn't currently running. |
c4307285 | 172 | * |
b97bf3fd PL |
173 | * (Do not "enhance" this routine to automatically cancel an active timer, |
174 | * otherwise deadlock can arise when a timeout routine calls k_term_timer.) | |
175 | */ | |
b97bf3fd PL |
176 | static inline void k_term_timer(struct timer_list *timer) |
177 | { | |
b97bf3fd PL |
178 | } |
179 | ||
b97bf3fd PL |
180 | /* |
181 | * TIPC message buffer code | |
182 | * | |
f08269d3 AS |
183 | * TIPC message buffer headroom reserves space for the worst-case |
184 | * link-level device header (in case the message is sent off-node). | |
3a8d1214 | 185 | * |
f08269d3 AS |
186 | * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields |
187 | * are word aligned for quicker access | |
b97bf3fd | 188 | */ |
f08269d3 | 189 | #define BUF_HEADROOM LL_MAX_HEADER |
b97bf3fd PL |
190 | |
191 | struct tipc_skb_cb { | |
192 | void *handle; | |
64380a04 | 193 | bool deferred; |
b97bf3fd PL |
194 | }; |
195 | ||
196 | #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0])) | |
197 | ||
b97bf3fd PL |
198 | static inline struct tipc_msg *buf_msg(struct sk_buff *skb) |
199 | { | |
200 | return (struct tipc_msg *)skb->data; | |
201 | } | |
202 | ||
c1b1203d | 203 | struct sk_buff *tipc_buf_acquire(u32 size); |
b97bf3fd | 204 | |
c4307285 | 205 | #endif |