1 /* Copyright (C) 2007-2015 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 "2015.2" 28 #endif 29 30 /* B.A.T.M.A.N. parameters */ 31 32 #define BATADV_TQ_MAX_VALUE 255 33 #define BATADV_JITTER 20 34 35 /* Time To Live of broadcast messages */ 36 #define BATADV_TTL 50 37 38 /* purge originators after time in seconds if no valid packet comes in 39 * -> TODO: check influence on BATADV_TQ_LOCAL_WINDOW_SIZE 40 */ 41 #define BATADV_PURGE_TIMEOUT 200000 /* 200 seconds */ 42 #define BATADV_TT_LOCAL_TIMEOUT 600000 /* in milliseconds */ 43 #define BATADV_TT_CLIENT_ROAM_TIMEOUT 600000 /* in milliseconds */ 44 #define BATADV_TT_CLIENT_TEMP_TIMEOUT 600000 /* in milliseconds */ 45 #define BATADV_TT_WORK_PERIOD 5000 /* 5 seconds */ 46 #define BATADV_ORIG_WORK_PERIOD 1000 /* 1 second */ 47 #define BATADV_DAT_ENTRY_TIMEOUT (5 * 60000) /* 5 mins in milliseconds */ 48 /* sliding packet range of received originator messages in sequence numbers 49 * (should be a multiple of our word size) 50 */ 51 #define BATADV_TQ_LOCAL_WINDOW_SIZE 64 52 /* milliseconds we have to keep pending tt_req */ 53 #define BATADV_TT_REQUEST_TIMEOUT 3000 54 55 #define BATADV_TQ_GLOBAL_WINDOW_SIZE 5 56 #define BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM 1 57 #define BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM 1 58 #define BATADV_TQ_TOTAL_BIDRECT_LIMIT 1 59 60 /* number of OGMs sent with the last tt diff */ 61 #define BATADV_TT_OGM_APPEND_MAX 3 62 63 /* Time in which a client can roam at most ROAMING_MAX_COUNT times in 64 * milliseconds 65 */ 66 #define BATADV_ROAMING_MAX_TIME 20000 67 #define BATADV_ROAMING_MAX_COUNT 5 68 69 #define BATADV_NO_FLAGS 0 70 71 #define BATADV_NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */ 72 73 #define BATADV_NO_MARK 0 74 75 /* default interface for multi interface operation. The default interface is 76 * used for communication which originated locally (i.e. is not forwarded) 77 * or where special forwarding is not desired/necessary. 78 */ 79 #define BATADV_IF_DEFAULT ((struct batadv_hard_iface *)NULL) 80 81 #define BATADV_NUM_WORDS BITS_TO_LONGS(BATADV_TQ_LOCAL_WINDOW_SIZE) 82 83 #define BATADV_LOG_BUF_LEN 8192 /* has to be a power of 2 */ 84 85 /* number of packets to send for broadcasts on different interface types */ 86 #define BATADV_NUM_BCASTS_DEFAULT 1 87 #define BATADV_NUM_BCASTS_WIRELESS 3 88 #define BATADV_NUM_BCASTS_MAX 3 89 90 /* msecs after which an ARP_REQUEST is sent in broadcast as fallback */ 91 #define ARP_REQ_DELAY 250 92 /* numbers of originator to contact for any PUT/GET DHT operation */ 93 #define BATADV_DAT_CANDIDATES_NUM 3 94 95 /* BATADV_TQ_SIMILARITY_THRESHOLD - TQ points that a secondary metric can differ 96 * at most from the primary one in order to be still considered acceptable 97 */ 98 #define BATADV_TQ_SIMILARITY_THRESHOLD 50 99 100 /* how much worse secondary interfaces may be to be considered as bonding 101 * candidates 102 */ 103 #define BATADV_BONDING_TQ_THRESHOLD 50 104 105 /* should not be bigger than 512 bytes or change the size of 106 * forw_packet->direct_link_flags 107 */ 108 #define BATADV_MAX_AGGREGATION_BYTES 512 109 #define BATADV_MAX_AGGREGATION_MS 100 110 111 #define BATADV_BLA_PERIOD_LENGTH 10000 /* 10 seconds */ 112 #define BATADV_BLA_BACKBONE_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 3) 113 #define BATADV_BLA_CLAIM_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 10) 114 #define BATADV_BLA_WAIT_PERIODS 3 115 116 #define BATADV_DUPLIST_SIZE 16 117 #define BATADV_DUPLIST_TIMEOUT 500 /* 500 ms */ 118 /* don't reset again within 30 seconds */ 119 #define BATADV_RESET_PROTECTION_MS 30000 120 #define BATADV_EXPECTED_SEQNO_RANGE 65536 121 122 #define BATADV_NC_NODE_TIMEOUT 10000 /* Milliseconds */ 123 124 enum batadv_mesh_state { 125 BATADV_MESH_INACTIVE, 126 BATADV_MESH_ACTIVE, 127 BATADV_MESH_DEACTIVATING, 128 }; 129 130 #define BATADV_BCAST_QUEUE_LEN 256 131 #define BATADV_BATMAN_QUEUE_LEN 256 132 133 enum batadv_uev_action { 134 BATADV_UEV_ADD = 0, 135 BATADV_UEV_DEL, 136 BATADV_UEV_CHANGE, 137 }; 138 139 enum batadv_uev_type { 140 BATADV_UEV_GW = 0, 141 }; 142 143 #define BATADV_GW_THRESHOLD 50 144 145 /* Number of fragment chains for each orig_node */ 146 #define BATADV_FRAG_BUFFER_COUNT 8 147 /* Maximum number of fragments for one packet */ 148 #define BATADV_FRAG_MAX_FRAGMENTS 16 149 /* Maxumim size of each fragment */ 150 #define BATADV_FRAG_MAX_FRAG_SIZE 1400 151 /* Time to keep fragments while waiting for rest of the fragments */ 152 #define BATADV_FRAG_TIMEOUT 10000 153 154 #define BATADV_DAT_CANDIDATE_NOT_FOUND 0 155 #define BATADV_DAT_CANDIDATE_ORIG 1 156 157 /* Debug Messages */ 158 #ifdef pr_fmt 159 #undef pr_fmt 160 #endif 161 /* Append 'batman-adv: ' before kernel messages */ 162 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 163 164 /* Kernel headers */ 165 166 #include <linux/atomic.h> 167 #include <linux/bitops.h> /* for packet.h */ 168 #include <linux/compiler.h> 169 #include <linux/cpumask.h> 170 #include <linux/etherdevice.h> 171 #include <linux/if_ether.h> /* for packet.h */ 172 #include <linux/netdevice.h> 173 #include <linux/printk.h> 174 #include <linux/types.h> 175 #include <linux/percpu.h> 176 #include <linux/jiffies.h> 177 #include <linux/if_vlan.h> 178 179 #include "types.h" 180 181 struct batadv_ogm_packet; 182 struct seq_file; 183 struct sk_buff; 184 185 #define BATADV_PRINT_VID(vid) ((vid & BATADV_VLAN_HAS_TAG) ? \ 186 (int)(vid & VLAN_VID_MASK) : -1) 187 188 extern char batadv_routing_algo[]; 189 extern struct list_head batadv_hardif_list; 190 191 extern unsigned char batadv_broadcast_addr[]; 192 extern struct workqueue_struct *batadv_event_workqueue; 193 194 int batadv_mesh_init(struct net_device *soft_iface); 195 void batadv_mesh_free(struct net_device *soft_iface); 196 bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr); 197 struct batadv_hard_iface * 198 batadv_seq_print_text_primary_if_get(struct seq_file *seq); 199 int batadv_max_header_len(void); 200 void batadv_skb_set_priority(struct sk_buff *skb, int offset); 201 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev, 202 struct packet_type *ptype, 203 struct net_device *orig_dev); 204 int 205 batadv_recv_handler_register(u8 packet_type, 206 int (*recv_handler)(struct sk_buff *, 207 struct batadv_hard_iface *)); 208 void batadv_recv_handler_unregister(u8 packet_type); 209 int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops); 210 int batadv_algo_select(struct batadv_priv *bat_priv, char *name); 211 int batadv_algo_seq_print_text(struct seq_file *seq, void *offset); 212 __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr); 213 214 /** 215 * enum batadv_dbg_level - available log levels 216 * @BATADV_DBG_BATMAN: OGM and TQ computations related messages 217 * @BATADV_DBG_ROUTES: route added / changed / deleted 218 * @BATADV_DBG_TT: translation table messages 219 * @BATADV_DBG_BLA: bridge loop avoidance messages 220 * @BATADV_DBG_DAT: ARP snooping and DAT related messages 221 * @BATADV_DBG_NC: network coding related messages 222 * @BATADV_DBG_ALL: the union of all the above log levels 223 */ 224 enum batadv_dbg_level { 225 BATADV_DBG_BATMAN = BIT(0), 226 BATADV_DBG_ROUTES = BIT(1), 227 BATADV_DBG_TT = BIT(2), 228 BATADV_DBG_BLA = BIT(3), 229 BATADV_DBG_DAT = BIT(4), 230 BATADV_DBG_NC = BIT(5), 231 BATADV_DBG_ALL = 63, 232 }; 233 234 #ifdef CONFIG_BATMAN_ADV_DEBUG 235 int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...) 236 __printf(2, 3); 237 238 /* possibly ratelimited debug output */ 239 #define _batadv_dbg(type, bat_priv, ratelimited, fmt, arg...) \ 240 do { \ 241 if (atomic_read(&bat_priv->log_level) & type && \ 242 (!ratelimited || net_ratelimit())) \ 243 batadv_debug_log(bat_priv, fmt, ## arg);\ 244 } \ 245 while (0) 246 #else /* !CONFIG_BATMAN_ADV_DEBUG */ 247 __printf(4, 5) 248 static inline void _batadv_dbg(int type __always_unused, 249 struct batadv_priv *bat_priv __always_unused, 250 int ratelimited __always_unused, 251 const char *fmt __always_unused, ...) 252 { 253 } 254 #endif 255 256 #define batadv_dbg(type, bat_priv, arg...) \ 257 _batadv_dbg(type, bat_priv, 0, ## arg) 258 #define batadv_dbg_ratelimited(type, bat_priv, arg...) \ 259 _batadv_dbg(type, bat_priv, 1, ## arg) 260 261 #define batadv_info(net_dev, fmt, arg...) \ 262 do { \ 263 struct net_device *_netdev = (net_dev); \ 264 struct batadv_priv *_batpriv = netdev_priv(_netdev); \ 265 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \ 266 pr_info("%s: " fmt, _netdev->name, ## arg); \ 267 } while (0) 268 #define batadv_err(net_dev, fmt, arg...) \ 269 do { \ 270 struct net_device *_netdev = (net_dev); \ 271 struct batadv_priv *_batpriv = netdev_priv(_netdev); \ 272 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \ 273 pr_err("%s: " fmt, _netdev->name, ## arg); \ 274 } while (0) 275 276 /* returns 1 if they are the same ethernet addr 277 * 278 * note: can't use ether_addr_equal() as it requires aligned memory 279 */ 280 static inline bool batadv_compare_eth(const void *data1, const void *data2) 281 { 282 return ether_addr_equal_unaligned(data1, data2); 283 } 284 285 /** 286 * has_timed_out - compares current time (jiffies) and timestamp + timeout 287 * @timestamp: base value to compare with (in jiffies) 288 * @timeout: added to base value before comparing (in milliseconds) 289 * 290 * Returns true if current time is after timestamp + timeout 291 */ 292 static inline bool batadv_has_timed_out(unsigned long timestamp, 293 unsigned int timeout) 294 { 295 return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout)); 296 } 297 298 #define batadv_atomic_dec_not_zero(v) atomic_add_unless((v), -1, 0) 299 300 /* Returns the smallest signed integer in two's complement with the sizeof x */ 301 #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u))) 302 303 /* Checks if a sequence number x is a predecessor/successor of y. 304 * they handle overflows/underflows and can correctly check for a 305 * predecessor/successor unless the variable sequence number has grown by 306 * more then 2**(bitwidth(x)-1)-1. 307 * This means that for a u8 with the maximum value 255, it would think: 308 * - when adding nothing - it is neither a predecessor nor a successor 309 * - before adding more than 127 to the starting value - it is a predecessor, 310 * - when adding 128 - it is neither a predecessor nor a successor, 311 * - after adding more than 127 to the starting value - it is a successor 312 */ 313 #define batadv_seq_before(x, y) ({typeof(x)_d1 = (x); \ 314 typeof(y)_d2 = (y); \ 315 typeof(x)_dummy = (_d1 - _d2); \ 316 (void)(&_d1 == &_d2); \ 317 _dummy > batadv_smallest_signed_int(_dummy); }) 318 #define batadv_seq_after(x, y) batadv_seq_before(y, x) 319 320 /* Stop preemption on local cpu while incrementing the counter */ 321 static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx, 322 size_t count) 323 { 324 this_cpu_add(bat_priv->bat_counters[idx], count); 325 } 326 327 #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1) 328 329 /* Sum and return the cpu-local counters for index 'idx' */ 330 static inline u64 batadv_sum_counter(struct batadv_priv *bat_priv, size_t idx) 331 { 332 u64 *counters, sum = 0; 333 int cpu; 334 335 for_each_possible_cpu(cpu) { 336 counters = per_cpu_ptr(bat_priv->bat_counters, cpu); 337 sum += counters[idx]; 338 } 339 340 return sum; 341 } 342 343 /* Define a macro to reach the control buffer of the skb. The members of the 344 * control buffer are defined in struct batadv_skb_cb in types.h. 345 * The macro is inspired by the similar macro TCP_SKB_CB() in tcp.h. 346 */ 347 #define BATADV_SKB_CB(__skb) ((struct batadv_skb_cb *)&((__skb)->cb[0])) 348 349 void batadv_tvlv_container_register(struct batadv_priv *bat_priv, 350 u8 type, u8 version, 351 void *tvlv_value, u16 tvlv_value_len); 352 u16 batadv_tvlv_container_ogm_append(struct batadv_priv *bat_priv, 353 unsigned char **packet_buff, 354 int *packet_buff_len, int packet_min_len); 355 void batadv_tvlv_ogm_receive(struct batadv_priv *bat_priv, 356 struct batadv_ogm_packet *batadv_ogm_packet, 357 struct batadv_orig_node *orig_node); 358 void batadv_tvlv_container_unregister(struct batadv_priv *bat_priv, 359 u8 type, u8 version); 360 361 void batadv_tvlv_handler_register(struct batadv_priv *bat_priv, 362 void (*optr)(struct batadv_priv *bat_priv, 363 struct batadv_orig_node *orig, 364 u8 flags, 365 void *tvlv_value, 366 u16 tvlv_value_len), 367 int (*uptr)(struct batadv_priv *bat_priv, 368 u8 *src, u8 *dst, 369 void *tvlv_value, 370 u16 tvlv_value_len), 371 u8 type, u8 version, u8 flags); 372 void batadv_tvlv_handler_unregister(struct batadv_priv *bat_priv, 373 u8 type, u8 version); 374 int batadv_tvlv_containers_process(struct batadv_priv *bat_priv, 375 bool ogm_source, 376 struct batadv_orig_node *orig_node, 377 u8 *src, u8 *dst, 378 void *tvlv_buff, u16 tvlv_buff_len); 379 void batadv_tvlv_unicast_send(struct batadv_priv *bat_priv, u8 *src, 380 u8 *dst, u8 type, u8 version, 381 void *tvlv_value, u16 tvlv_value_len); 382 unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len); 383 bool batadv_vlan_ap_isola_get(struct batadv_priv *bat_priv, unsigned short vid); 384 385 #endif /* _NET_BATMAN_ADV_MAIN_H_ */ 386