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