1 /* Copyright (C) 2007-2014 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 "2014.1.0" 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 /** 96 * BATADV_TQ_SIMILARITY_THRESHOLD - TQ points that a secondary metric can differ 97 * at most from the primary one in order to be still considered acceptable 98 */ 99 #define BATADV_TQ_SIMILARITY_THRESHOLD 50 100 101 /* how much worse secondary interfaces may be to be considered as bonding 102 * candidates 103 */ 104 #define BATADV_BONDING_TQ_THRESHOLD 50 105 106 /* should not be bigger than 512 bytes or change the size of 107 * forw_packet->direct_link_flags 108 */ 109 #define BATADV_MAX_AGGREGATION_BYTES 512 110 #define BATADV_MAX_AGGREGATION_MS 100 111 112 #define BATADV_BLA_PERIOD_LENGTH 10000 /* 10 seconds */ 113 #define BATADV_BLA_BACKBONE_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 3) 114 #define BATADV_BLA_CLAIM_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 10) 115 #define BATADV_BLA_WAIT_PERIODS 3 116 117 #define BATADV_DUPLIST_SIZE 16 118 #define BATADV_DUPLIST_TIMEOUT 500 /* 500 ms */ 119 /* don't reset again within 30 seconds */ 120 #define BATADV_RESET_PROTECTION_MS 30000 121 #define BATADV_EXPECTED_SEQNO_RANGE 65536 122 123 #define BATADV_NC_NODE_TIMEOUT 10000 /* Milliseconds */ 124 125 enum batadv_mesh_state { 126 BATADV_MESH_INACTIVE, 127 BATADV_MESH_ACTIVE, 128 BATADV_MESH_DEACTIVATING, 129 }; 130 131 #define BATADV_BCAST_QUEUE_LEN 256 132 #define BATADV_BATMAN_QUEUE_LEN 256 133 134 enum batadv_uev_action { 135 BATADV_UEV_ADD = 0, 136 BATADV_UEV_DEL, 137 BATADV_UEV_CHANGE, 138 }; 139 140 enum batadv_uev_type { 141 BATADV_UEV_GW = 0, 142 }; 143 144 #define BATADV_GW_THRESHOLD 50 145 146 /* Number of fragment chains for each orig_node */ 147 #define BATADV_FRAG_BUFFER_COUNT 8 148 /* Maximum number of fragments for one packet */ 149 #define BATADV_FRAG_MAX_FRAGMENTS 16 150 /* Maxumim size of each fragment */ 151 #define BATADV_FRAG_MAX_FRAG_SIZE 1400 152 /* Time to keep fragments while waiting for rest of the fragments */ 153 #define BATADV_FRAG_TIMEOUT 10000 154 155 #define BATADV_DAT_CANDIDATE_NOT_FOUND 0 156 #define BATADV_DAT_CANDIDATE_ORIG 1 157 158 /* Debug Messages */ 159 #ifdef pr_fmt 160 #undef pr_fmt 161 #endif 162 /* Append 'batman-adv: ' before kernel messages */ 163 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 164 165 /* Kernel headers */ 166 167 #include <linux/mutex.h> /* mutex */ 168 #include <linux/module.h> /* needed by all modules */ 169 #include <linux/netdevice.h> /* netdevice */ 170 #include <linux/etherdevice.h> /* ethernet address classification */ 171 #include <linux/if_ether.h> /* ethernet header */ 172 #include <linux/poll.h> /* poll_table */ 173 #include <linux/kthread.h> /* kernel threads */ 174 #include <linux/pkt_sched.h> /* schedule types */ 175 #include <linux/workqueue.h> /* workqueue */ 176 #include <linux/percpu.h> 177 #include <linux/slab.h> 178 #include <net/sock.h> /* struct sock */ 179 #include <net/rtnetlink.h> 180 #include <linux/jiffies.h> 181 #include <linux/seq_file.h> 182 #include <linux/if_vlan.h> 183 184 #include "types.h" 185 186 #define BATADV_PRINT_VID(vid) (vid & BATADV_VLAN_HAS_TAG ? \ 187 (int)(vid & VLAN_VID_MASK) : -1) 188 189 extern char batadv_routing_algo[]; 190 extern struct list_head batadv_hardif_list; 191 192 extern unsigned char batadv_broadcast_addr[]; 193 extern struct workqueue_struct *batadv_event_workqueue; 194 195 int batadv_mesh_init(struct net_device *soft_iface); 196 void batadv_mesh_free(struct net_device *soft_iface); 197 int batadv_is_my_mac(struct batadv_priv *bat_priv, const uint8_t *addr); 198 struct batadv_hard_iface * 199 batadv_seq_print_text_primary_if_get(struct seq_file *seq); 200 int batadv_max_header_len(void); 201 void batadv_skb_set_priority(struct sk_buff *skb, int offset); 202 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev, 203 struct packet_type *ptype, 204 struct net_device *orig_dev); 205 int 206 batadv_recv_handler_register(uint8_t packet_type, 207 int (*recv_handler)(struct sk_buff *, 208 struct batadv_hard_iface *)); 209 void batadv_recv_handler_unregister(uint8_t packet_type); 210 int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops); 211 int batadv_algo_select(struct batadv_priv *bat_priv, char *name); 212 int batadv_algo_seq_print_text(struct seq_file *seq, void *offset); 213 __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr); 214 215 /** 216 * enum batadv_dbg_level - available log levels 217 * @BATADV_DBG_BATMAN: OGM and TQ computations related messages 218 * @BATADV_DBG_ROUTES: route added / changed / deleted 219 * @BATADV_DBG_TT: translation table messages 220 * @BATADV_DBG_BLA: bridge loop avoidance messages 221 * @BATADV_DBG_DAT: ARP snooping and DAT related messages 222 * @BATADV_DBG_NC: network coding related messages 223 * @BATADV_DBG_ALL: the union of all the above log levels 224 */ 225 enum batadv_dbg_level { 226 BATADV_DBG_BATMAN = BIT(0), 227 BATADV_DBG_ROUTES = BIT(1), 228 BATADV_DBG_TT = BIT(2), 229 BATADV_DBG_BLA = BIT(3), 230 BATADV_DBG_DAT = BIT(4), 231 BATADV_DBG_NC = BIT(5), 232 BATADV_DBG_ALL = 63, 233 }; 234 235 #ifdef CONFIG_BATMAN_ADV_DEBUG 236 int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...) 237 __printf(2, 3); 238 239 #define batadv_dbg(type, bat_priv, fmt, arg...) \ 240 do { \ 241 if (atomic_read(&bat_priv->log_level) & type) \ 242 batadv_debug_log(bat_priv, fmt, ## arg);\ 243 } \ 244 while (0) 245 #else /* !CONFIG_BATMAN_ADV_DEBUG */ 246 __printf(3, 4) 247 static inline void batadv_dbg(int type __always_unused, 248 struct batadv_priv *bat_priv __always_unused, 249 const char *fmt __always_unused, ...) 250 { 251 } 252 #endif 253 254 #define batadv_info(net_dev, fmt, arg...) \ 255 do { \ 256 struct net_device *_netdev = (net_dev); \ 257 struct batadv_priv *_batpriv = netdev_priv(_netdev); \ 258 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \ 259 pr_info("%s: " fmt, _netdev->name, ## arg); \ 260 } while (0) 261 #define batadv_err(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_err("%s: " fmt, _netdev->name, ## arg); \ 267 } while (0) 268 269 /* returns 1 if they are the same ethernet addr 270 * 271 * note: can't use ether_addr_equal() as it requires aligned memory 272 */ 273 static inline int batadv_compare_eth(const void *data1, const void *data2) 274 { 275 return ether_addr_equal_unaligned(data1, data2); 276 } 277 278 /** 279 * has_timed_out - compares current time (jiffies) and timestamp + timeout 280 * @timestamp: base value to compare with (in jiffies) 281 * @timeout: added to base value before comparing (in milliseconds) 282 * 283 * Returns true if current time is after timestamp + timeout 284 */ 285 static inline bool batadv_has_timed_out(unsigned long timestamp, 286 unsigned int timeout) 287 { 288 return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout)); 289 } 290 291 #define batadv_atomic_dec_not_zero(v) atomic_add_unless((v), -1, 0) 292 293 /* Returns the smallest signed integer in two's complement with the sizeof x */ 294 #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u))) 295 296 /* Checks if a sequence number x is a predecessor/successor of y. 297 * they handle overflows/underflows and can correctly check for a 298 * predecessor/successor unless the variable sequence number has grown by 299 * more then 2**(bitwidth(x)-1)-1. 300 * This means that for a uint8_t with the maximum value 255, it would think: 301 * - when adding nothing - it is neither a predecessor nor a successor 302 * - before adding more than 127 to the starting value - it is a predecessor, 303 * - when adding 128 - it is neither a predecessor nor a successor, 304 * - after adding more than 127 to the starting value - it is a successor 305 */ 306 #define batadv_seq_before(x, y) ({typeof(x) _d1 = (x); \ 307 typeof(y) _d2 = (y); \ 308 typeof(x) _dummy = (_d1 - _d2); \ 309 (void) (&_d1 == &_d2); \ 310 _dummy > batadv_smallest_signed_int(_dummy); }) 311 #define batadv_seq_after(x, y) batadv_seq_before(y, x) 312 313 /* Stop preemption on local cpu while incrementing the counter */ 314 static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx, 315 size_t count) 316 { 317 this_cpu_add(bat_priv->bat_counters[idx], count); 318 } 319 320 #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1) 321 322 /* Sum and return the cpu-local counters for index 'idx' */ 323 static inline uint64_t batadv_sum_counter(struct batadv_priv *bat_priv, 324 size_t idx) 325 { 326 uint64_t *counters, sum = 0; 327 int cpu; 328 329 for_each_possible_cpu(cpu) { 330 counters = per_cpu_ptr(bat_priv->bat_counters, cpu); 331 sum += counters[idx]; 332 } 333 334 return sum; 335 } 336 337 /* Define a macro to reach the control buffer of the skb. The members of the 338 * control buffer are defined in struct batadv_skb_cb in types.h. 339 * The macro is inspired by the similar macro TCP_SKB_CB() in tcp.h. 340 */ 341 #define BATADV_SKB_CB(__skb) ((struct batadv_skb_cb *)&((__skb)->cb[0])) 342 343 void batadv_tvlv_container_register(struct batadv_priv *bat_priv, 344 uint8_t type, uint8_t version, 345 void *tvlv_value, uint16_t tvlv_value_len); 346 uint16_t batadv_tvlv_container_ogm_append(struct batadv_priv *bat_priv, 347 unsigned char **packet_buff, 348 int *packet_buff_len, 349 int packet_min_len); 350 void batadv_tvlv_ogm_receive(struct batadv_priv *bat_priv, 351 struct batadv_ogm_packet *batadv_ogm_packet, 352 struct batadv_orig_node *orig_node); 353 void batadv_tvlv_container_unregister(struct batadv_priv *bat_priv, 354 uint8_t type, uint8_t version); 355 356 void batadv_tvlv_handler_register(struct batadv_priv *bat_priv, 357 void (*optr)(struct batadv_priv *bat_priv, 358 struct batadv_orig_node *orig, 359 uint8_t flags, 360 void *tvlv_value, 361 uint16_t tvlv_value_len), 362 int (*uptr)(struct batadv_priv *bat_priv, 363 uint8_t *src, uint8_t *dst, 364 void *tvlv_value, 365 uint16_t tvlv_value_len), 366 uint8_t type, uint8_t version, uint8_t flags); 367 void batadv_tvlv_handler_unregister(struct batadv_priv *bat_priv, 368 uint8_t type, uint8_t version); 369 int batadv_tvlv_containers_process(struct batadv_priv *bat_priv, 370 bool ogm_source, 371 struct batadv_orig_node *orig_node, 372 uint8_t *src, uint8_t *dst, 373 void *tvlv_buff, uint16_t tvlv_buff_len); 374 void batadv_tvlv_unicast_send(struct batadv_priv *bat_priv, uint8_t *src, 375 uint8_t *dst, uint8_t type, uint8_t version, 376 void *tvlv_value, uint16_t tvlv_value_len); 377 unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len); 378 bool batadv_vlan_ap_isola_get(struct batadv_priv *bat_priv, unsigned short vid); 379 380 #endif /* _NET_BATMAN_ADV_MAIN_H_ */ 381