]>
Commit | Line | Data |
---|---|---|
1 | /* Copyright (C) 2007-2017 B.A.T.M.A.N. contributors: | |
2 | * | |
3 | * Marek Lindner, Simon Wunderlich | |
4 | * | |
5 | * This program is free software; you can redistribute it and/or | |
6 | * modify it under the terms of version 2 of the GNU General Public | |
7 | * License as published by the Free Software Foundation. | |
8 | * | |
9 | * This program is distributed in the hope that it will be useful, but | |
10 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
12 | * General Public License for more details. | |
13 | * | |
14 | * You should have received a copy of the GNU General Public License | |
15 | * along with this program; if not, see <http://www.gnu.org/licenses/>. | |
16 | */ | |
17 | ||
18 | #ifndef _NET_BATMAN_ADV_MAIN_H_ | |
19 | #define _NET_BATMAN_ADV_MAIN_H_ | |
20 | ||
21 | #define BATADV_DRIVER_AUTHOR "Marek Lindner <mareklindner@neomailbox.ch>, " \ | |
22 | "Simon Wunderlich <sw@simonwunderlich.de>" | |
23 | #define BATADV_DRIVER_DESC "B.A.T.M.A.N. advanced" | |
24 | #define BATADV_DRIVER_DEVICE "batman-adv" | |
25 | ||
26 | #ifndef BATADV_SOURCE_VERSION | |
27 | #define BATADV_SOURCE_VERSION "2017.4" | |
28 | #endif | |
29 | ||
30 | /* B.A.T.M.A.N. parameters */ | |
31 | ||
32 | #define BATADV_TQ_MAX_VALUE 255 | |
33 | #define BATADV_THROUGHPUT_MAX_VALUE 0xFFFFFFFF | |
34 | #define BATADV_JITTER 20 | |
35 | ||
36 | /* Time To Live of broadcast messages */ | |
37 | #define BATADV_TTL 50 | |
38 | ||
39 | /* maximum sequence number age of broadcast messages */ | |
40 | #define BATADV_BCAST_MAX_AGE 64 | |
41 | ||
42 | /* purge originators after time in seconds if no valid packet comes in | |
43 | * -> TODO: check influence on BATADV_TQ_LOCAL_WINDOW_SIZE | |
44 | */ | |
45 | #define BATADV_PURGE_TIMEOUT 200000 /* 200 seconds */ | |
46 | #define BATADV_TT_LOCAL_TIMEOUT 600000 /* in milliseconds */ | |
47 | #define BATADV_TT_CLIENT_ROAM_TIMEOUT 600000 /* in milliseconds */ | |
48 | #define BATADV_TT_CLIENT_TEMP_TIMEOUT 600000 /* in milliseconds */ | |
49 | #define BATADV_TT_WORK_PERIOD 5000 /* 5 seconds */ | |
50 | #define BATADV_ORIG_WORK_PERIOD 1000 /* 1 second */ | |
51 | #define BATADV_MCAST_WORK_PERIOD 500 /* 0.5 seconds */ | |
52 | #define BATADV_DAT_ENTRY_TIMEOUT (5 * 60000) /* 5 mins in milliseconds */ | |
53 | /* sliding packet range of received originator messages in sequence numbers | |
54 | * (should be a multiple of our word size) | |
55 | */ | |
56 | #define BATADV_TQ_LOCAL_WINDOW_SIZE 64 | |
57 | /* milliseconds we have to keep pending tt_req */ | |
58 | #define BATADV_TT_REQUEST_TIMEOUT 3000 | |
59 | ||
60 | #define BATADV_TQ_GLOBAL_WINDOW_SIZE 5 | |
61 | #define BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM 1 | |
62 | #define BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM 1 | |
63 | #define BATADV_TQ_TOTAL_BIDRECT_LIMIT 1 | |
64 | ||
65 | /* B.A.T.M.A.N. V */ | |
66 | #define BATADV_THROUGHPUT_DEFAULT_VALUE 10 /* 1 Mbps */ | |
67 | #define BATADV_ELP_PROBES_PER_NODE 2 | |
68 | #define BATADV_ELP_MIN_PROBE_SIZE 200 /* bytes */ | |
69 | #define BATADV_ELP_PROBE_MAX_TX_DIFF 100 /* milliseconds */ | |
70 | #define BATADV_ELP_MAX_AGE 64 | |
71 | #define BATADV_OGM_MAX_ORIGDIFF 5 | |
72 | #define BATADV_OGM_MAX_AGE 64 | |
73 | ||
74 | /* number of OGMs sent with the last tt diff */ | |
75 | #define BATADV_TT_OGM_APPEND_MAX 3 | |
76 | ||
77 | /* Time in which a client can roam at most ROAMING_MAX_COUNT times in | |
78 | * milliseconds | |
79 | */ | |
80 | #define BATADV_ROAMING_MAX_TIME 20000 | |
81 | #define BATADV_ROAMING_MAX_COUNT 5 | |
82 | ||
83 | #define BATADV_NO_FLAGS 0 | |
84 | ||
85 | #define BATADV_NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */ | |
86 | ||
87 | #define BATADV_NO_MARK 0 | |
88 | ||
89 | /* default interface for multi interface operation. The default interface is | |
90 | * used for communication which originated locally (i.e. is not forwarded) | |
91 | * or where special forwarding is not desired/necessary. | |
92 | */ | |
93 | #define BATADV_IF_DEFAULT ((struct batadv_hard_iface *)NULL) | |
94 | ||
95 | #define BATADV_NUM_WORDS BITS_TO_LONGS(BATADV_TQ_LOCAL_WINDOW_SIZE) | |
96 | ||
97 | #define BATADV_LOG_BUF_LEN 8192 /* has to be a power of 2 */ | |
98 | ||
99 | /* number of packets to send for broadcasts on different interface types */ | |
100 | #define BATADV_NUM_BCASTS_DEFAULT 1 | |
101 | #define BATADV_NUM_BCASTS_WIRELESS 3 | |
102 | #define BATADV_NUM_BCASTS_MAX 3 | |
103 | ||
104 | /* length of the single packet used by the TP meter */ | |
105 | #define BATADV_TP_PACKET_LEN ETH_DATA_LEN | |
106 | ||
107 | /* msecs after which an ARP_REQUEST is sent in broadcast as fallback */ | |
108 | #define ARP_REQ_DELAY 250 | |
109 | /* numbers of originator to contact for any PUT/GET DHT operation */ | |
110 | #define BATADV_DAT_CANDIDATES_NUM 3 | |
111 | ||
112 | /* BATADV_TQ_SIMILARITY_THRESHOLD - TQ points that a secondary metric can differ | |
113 | * at most from the primary one in order to be still considered acceptable | |
114 | */ | |
115 | #define BATADV_TQ_SIMILARITY_THRESHOLD 50 | |
116 | ||
117 | /* should not be bigger than 512 bytes or change the size of | |
118 | * forw_packet->direct_link_flags | |
119 | */ | |
120 | #define BATADV_MAX_AGGREGATION_BYTES 512 | |
121 | #define BATADV_MAX_AGGREGATION_MS 100 | |
122 | ||
123 | #define BATADV_BLA_PERIOD_LENGTH 10000 /* 10 seconds */ | |
124 | #define BATADV_BLA_BACKBONE_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 6) | |
125 | #define BATADV_BLA_CLAIM_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 10) | |
126 | #define BATADV_BLA_WAIT_PERIODS 3 | |
127 | #define BATADV_BLA_LOOPDETECT_PERIODS 6 | |
128 | #define BATADV_BLA_LOOPDETECT_TIMEOUT 3000 /* 3 seconds */ | |
129 | ||
130 | #define BATADV_DUPLIST_SIZE 16 | |
131 | #define BATADV_DUPLIST_TIMEOUT 500 /* 500 ms */ | |
132 | /* don't reset again within 30 seconds */ | |
133 | #define BATADV_RESET_PROTECTION_MS 30000 | |
134 | #define BATADV_EXPECTED_SEQNO_RANGE 65536 | |
135 | ||
136 | #define BATADV_NC_NODE_TIMEOUT 10000 /* Milliseconds */ | |
137 | ||
138 | /** | |
139 | * BATADV_TP_MAX_NUM - maximum number of simultaneously active tp sessions | |
140 | */ | |
141 | #define BATADV_TP_MAX_NUM 5 | |
142 | ||
143 | enum batadv_mesh_state { | |
144 | BATADV_MESH_INACTIVE, | |
145 | BATADV_MESH_ACTIVE, | |
146 | BATADV_MESH_DEACTIVATING, | |
147 | }; | |
148 | ||
149 | #define BATADV_BCAST_QUEUE_LEN 256 | |
150 | #define BATADV_BATMAN_QUEUE_LEN 256 | |
151 | ||
152 | enum batadv_uev_action { | |
153 | BATADV_UEV_ADD = 0, | |
154 | BATADV_UEV_DEL, | |
155 | BATADV_UEV_CHANGE, | |
156 | BATADV_UEV_LOOPDETECT, | |
157 | }; | |
158 | ||
159 | enum batadv_uev_type { | |
160 | BATADV_UEV_GW = 0, | |
161 | BATADV_UEV_BLA, | |
162 | }; | |
163 | ||
164 | #define BATADV_GW_THRESHOLD 50 | |
165 | ||
166 | /* Number of fragment chains for each orig_node */ | |
167 | #define BATADV_FRAG_BUFFER_COUNT 8 | |
168 | /* Maximum number of fragments for one packet */ | |
169 | #define BATADV_FRAG_MAX_FRAGMENTS 16 | |
170 | /* Maxumim size of each fragment */ | |
171 | #define BATADV_FRAG_MAX_FRAG_SIZE 1280 | |
172 | /* Time to keep fragments while waiting for rest of the fragments */ | |
173 | #define BATADV_FRAG_TIMEOUT 10000 | |
174 | ||
175 | #define BATADV_DAT_CANDIDATE_NOT_FOUND 0 | |
176 | #define BATADV_DAT_CANDIDATE_ORIG 1 | |
177 | ||
178 | /* Debug Messages */ | |
179 | #ifdef pr_fmt | |
180 | #undef pr_fmt | |
181 | #endif | |
182 | /* Append 'batman-adv: ' before kernel messages */ | |
183 | #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt | |
184 | ||
185 | /* Kernel headers */ | |
186 | ||
187 | #include <linux/bitops.h> /* for packet.h */ | |
188 | #include <linux/compiler.h> | |
189 | #include <linux/etherdevice.h> | |
190 | #include <linux/if_ether.h> /* for packet.h */ | |
191 | #include <linux/if_vlan.h> | |
192 | #include <linux/jiffies.h> | |
193 | #include <linux/percpu.h> | |
194 | #include <linux/types.h> | |
195 | ||
196 | #include "packet.h" | |
197 | #include "types.h" | |
198 | ||
199 | struct net_device; | |
200 | struct packet_type; | |
201 | struct seq_file; | |
202 | struct sk_buff; | |
203 | ||
204 | /** | |
205 | * batadv_print_vid - return printable version of vid information | |
206 | * @vid: the VLAN identifier | |
207 | * | |
208 | * Return: -1 when no VLAN is used, VLAN id otherwise | |
209 | */ | |
210 | static inline int batadv_print_vid(unsigned short vid) | |
211 | { | |
212 | if (vid & BATADV_VLAN_HAS_TAG) | |
213 | return (int)(vid & VLAN_VID_MASK); | |
214 | else | |
215 | return -1; | |
216 | } | |
217 | ||
218 | extern struct list_head batadv_hardif_list; | |
219 | ||
220 | extern unsigned char batadv_broadcast_addr[]; | |
221 | extern struct workqueue_struct *batadv_event_workqueue; | |
222 | ||
223 | int batadv_mesh_init(struct net_device *soft_iface); | |
224 | void batadv_mesh_free(struct net_device *soft_iface); | |
225 | bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr); | |
226 | struct batadv_hard_iface * | |
227 | batadv_seq_print_text_primary_if_get(struct seq_file *seq); | |
228 | int batadv_max_header_len(void); | |
229 | void batadv_skb_set_priority(struct sk_buff *skb, int offset); | |
230 | int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev, | |
231 | struct packet_type *ptype, | |
232 | struct net_device *orig_dev); | |
233 | int | |
234 | batadv_recv_handler_register(u8 packet_type, | |
235 | int (*recv_handler)(struct sk_buff *, | |
236 | struct batadv_hard_iface *)); | |
237 | void batadv_recv_handler_unregister(u8 packet_type); | |
238 | __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr); | |
239 | ||
240 | /** | |
241 | * batadv_compare_eth - Compare two not u16 aligned Ethernet addresses | |
242 | * @data1: Pointer to a six-byte array containing the Ethernet address | |
243 | * @data2: Pointer other six-byte array containing the Ethernet address | |
244 | * | |
245 | * note: can't use ether_addr_equal() as it requires aligned memory | |
246 | * | |
247 | * Return: true if they are the same ethernet addr | |
248 | */ | |
249 | static inline bool batadv_compare_eth(const void *data1, const void *data2) | |
250 | { | |
251 | return ether_addr_equal_unaligned(data1, data2); | |
252 | } | |
253 | ||
254 | /** | |
255 | * batadv_has_timed_out - compares current time (jiffies) and timestamp + | |
256 | * timeout | |
257 | * @timestamp: base value to compare with (in jiffies) | |
258 | * @timeout: added to base value before comparing (in milliseconds) | |
259 | * | |
260 | * Return: true if current time is after timestamp + timeout | |
261 | */ | |
262 | static inline bool batadv_has_timed_out(unsigned long timestamp, | |
263 | unsigned int timeout) | |
264 | { | |
265 | return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout)); | |
266 | } | |
267 | ||
268 | #define batadv_atomic_dec_not_zero(v) atomic_add_unless((v), -1, 0) | |
269 | ||
270 | /* Returns the smallest signed integer in two's complement with the sizeof x */ | |
271 | #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u))) | |
272 | ||
273 | /* Checks if a sequence number x is a predecessor/successor of y. | |
274 | * they handle overflows/underflows and can correctly check for a | |
275 | * predecessor/successor unless the variable sequence number has grown by | |
276 | * more then 2**(bitwidth(x)-1)-1. | |
277 | * This means that for a u8 with the maximum value 255, it would think: | |
278 | * - when adding nothing - it is neither a predecessor nor a successor | |
279 | * - before adding more than 127 to the starting value - it is a predecessor, | |
280 | * - when adding 128 - it is neither a predecessor nor a successor, | |
281 | * - after adding more than 127 to the starting value - it is a successor | |
282 | */ | |
283 | #define batadv_seq_before(x, y) ({typeof(x)_d1 = (x); \ | |
284 | typeof(y)_d2 = (y); \ | |
285 | typeof(x)_dummy = (_d1 - _d2); \ | |
286 | (void)(&_d1 == &_d2); \ | |
287 | _dummy > batadv_smallest_signed_int(_dummy); }) | |
288 | #define batadv_seq_after(x, y) batadv_seq_before(y, x) | |
289 | ||
290 | /* Stop preemption on local cpu while incrementing the counter */ | |
291 | static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx, | |
292 | size_t count) | |
293 | { | |
294 | this_cpu_add(bat_priv->bat_counters[idx], count); | |
295 | } | |
296 | ||
297 | #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1) | |
298 | ||
299 | /* Define a macro to reach the control buffer of the skb. The members of the | |
300 | * control buffer are defined in struct batadv_skb_cb in types.h. | |
301 | * The macro is inspired by the similar macro TCP_SKB_CB() in tcp.h. | |
302 | */ | |
303 | #define BATADV_SKB_CB(__skb) ((struct batadv_skb_cb *)&((__skb)->cb[0])) | |
304 | ||
305 | unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len); | |
306 | bool batadv_vlan_ap_isola_get(struct batadv_priv *bat_priv, unsigned short vid); | |
307 | ||
308 | #endif /* _NET_BATMAN_ADV_MAIN_H_ */ |