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 <lindner_marek@yahoo.de>, " \ 24 "Simon Wunderlich <siwu@hrz.tu-chemnitz.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.1.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 /* msecs after which an ARP_REQUEST is sent in broadcast as fallback */ 80 #define ARP_REQ_DELAY 250 81 /* numbers of originator to contact for any PUT/GET DHT operation */ 82 #define BATADV_DAT_CANDIDATES_NUM 3 83 84 #define BATADV_VIS_INTERVAL 5000 /* 5 seconds */ 85 86 /* how much worse secondary interfaces may be to be considered as bonding 87 * candidates 88 */ 89 #define BATADV_BONDING_TQ_THRESHOLD 50 90 91 /* should not be bigger than 512 bytes or change the size of 92 * forw_packet->direct_link_flags 93 */ 94 #define BATADV_MAX_AGGREGATION_BYTES 512 95 #define BATADV_MAX_AGGREGATION_MS 100 96 97 #define BATADV_BLA_PERIOD_LENGTH 10000 /* 10 seconds */ 98 #define BATADV_BLA_BACKBONE_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 3) 99 #define BATADV_BLA_CLAIM_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 10) 100 #define BATADV_BLA_WAIT_PERIODS 3 101 102 #define BATADV_DUPLIST_SIZE 16 103 #define BATADV_DUPLIST_TIMEOUT 500 /* 500 ms */ 104 /* don't reset again within 30 seconds */ 105 #define BATADV_RESET_PROTECTION_MS 30000 106 #define BATADV_EXPECTED_SEQNO_RANGE 65536 107 108 enum batadv_mesh_state { 109 BATADV_MESH_INACTIVE, 110 BATADV_MESH_ACTIVE, 111 BATADV_MESH_DEACTIVATING, 112 }; 113 114 #define BATADV_BCAST_QUEUE_LEN 256 115 #define BATADV_BATMAN_QUEUE_LEN 256 116 117 enum batadv_uev_action { 118 BATADV_UEV_ADD = 0, 119 BATADV_UEV_DEL, 120 BATADV_UEV_CHANGE, 121 }; 122 123 enum batadv_uev_type { 124 BATADV_UEV_GW = 0, 125 }; 126 127 #define BATADV_GW_THRESHOLD 50 128 129 #define BATADV_DAT_CANDIDATE_NOT_FOUND 0 130 #define BATADV_DAT_CANDIDATE_ORIG 1 131 132 /* Debug Messages */ 133 #ifdef pr_fmt 134 #undef pr_fmt 135 #endif 136 /* Append 'batman-adv: ' before kernel messages */ 137 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 138 139 /* Kernel headers */ 140 141 #include <linux/mutex.h> /* mutex */ 142 #include <linux/module.h> /* needed by all modules */ 143 #include <linux/netdevice.h> /* netdevice */ 144 #include <linux/etherdevice.h> /* ethernet address classification */ 145 #include <linux/if_ether.h> /* ethernet header */ 146 #include <linux/poll.h> /* poll_table */ 147 #include <linux/kthread.h> /* kernel threads */ 148 #include <linux/pkt_sched.h> /* schedule types */ 149 #include <linux/workqueue.h> /* workqueue */ 150 #include <linux/percpu.h> 151 #include <linux/slab.h> 152 #include <net/sock.h> /* struct sock */ 153 #include <linux/jiffies.h> 154 #include <linux/seq_file.h> 155 #include "types.h" 156 157 extern char batadv_routing_algo[]; 158 extern struct list_head batadv_hardif_list; 159 160 extern unsigned char batadv_broadcast_addr[]; 161 extern struct workqueue_struct *batadv_event_workqueue; 162 163 int batadv_mesh_init(struct net_device *soft_iface); 164 void batadv_mesh_free(struct net_device *soft_iface); 165 int batadv_is_my_mac(const uint8_t *addr); 166 struct batadv_hard_iface * 167 batadv_seq_print_text_primary_if_get(struct seq_file *seq); 168 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev, 169 struct packet_type *ptype, 170 struct net_device *orig_dev); 171 int 172 batadv_recv_handler_register(uint8_t packet_type, 173 int (*recv_handler)(struct sk_buff *, 174 struct batadv_hard_iface *)); 175 void batadv_recv_handler_unregister(uint8_t packet_type); 176 int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops); 177 int batadv_algo_select(struct batadv_priv *bat_priv, char *name); 178 int batadv_algo_seq_print_text(struct seq_file *seq, void *offset); 179 __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr); 180 181 /** 182 * enum batadv_dbg_level - available log levels 183 * @BATADV_DBG_BATMAN: OGM and TQ computations related messages 184 * @BATADV_DBG_ROUTES: route added / changed / deleted 185 * @BATADV_DBG_TT: translation table messages 186 * @BATADV_DBG_BLA: bridge loop avoidance messages 187 * @BATADV_DBG_DAT: ARP snooping and DAT related messages 188 * @BATADV_DBG_ALL: the union of all the above log levels 189 */ 190 enum batadv_dbg_level { 191 BATADV_DBG_BATMAN = BIT(0), 192 BATADV_DBG_ROUTES = BIT(1), 193 BATADV_DBG_TT = BIT(2), 194 BATADV_DBG_BLA = BIT(3), 195 BATADV_DBG_DAT = BIT(4), 196 BATADV_DBG_ALL = 31, 197 }; 198 199 #ifdef CONFIG_BATMAN_ADV_DEBUG 200 int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...) 201 __printf(2, 3); 202 203 #define batadv_dbg(type, bat_priv, fmt, arg...) \ 204 do { \ 205 if (atomic_read(&bat_priv->log_level) & type) \ 206 batadv_debug_log(bat_priv, fmt, ## arg);\ 207 } \ 208 while (0) 209 #else /* !CONFIG_BATMAN_ADV_DEBUG */ 210 __printf(3, 4) 211 static inline void batadv_dbg(int type __always_unused, 212 struct batadv_priv *bat_priv __always_unused, 213 const char *fmt __always_unused, ...) 214 { 215 } 216 #endif 217 218 #define batadv_info(net_dev, fmt, arg...) \ 219 do { \ 220 struct net_device *_netdev = (net_dev); \ 221 struct batadv_priv *_batpriv = netdev_priv(_netdev); \ 222 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \ 223 pr_info("%s: " fmt, _netdev->name, ## arg); \ 224 } while (0) 225 #define batadv_err(net_dev, fmt, arg...) \ 226 do { \ 227 struct net_device *_netdev = (net_dev); \ 228 struct batadv_priv *_batpriv = netdev_priv(_netdev); \ 229 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \ 230 pr_err("%s: " fmt, _netdev->name, ## arg); \ 231 } while (0) 232 233 /* returns 1 if they are the same ethernet addr 234 * 235 * note: can't use compare_ether_addr() as it requires aligned memory 236 */ 237 static inline int batadv_compare_eth(const void *data1, const void *data2) 238 { 239 return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0); 240 } 241 242 /** 243 * has_timed_out - compares current time (jiffies) and timestamp + timeout 244 * @timestamp: base value to compare with (in jiffies) 245 * @timeout: added to base value before comparing (in milliseconds) 246 * 247 * Returns true if current time is after timestamp + timeout 248 */ 249 static inline bool batadv_has_timed_out(unsigned long timestamp, 250 unsigned int timeout) 251 { 252 return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout)); 253 } 254 255 #define batadv_atomic_dec_not_zero(v) atomic_add_unless((v), -1, 0) 256 257 /* Returns the smallest signed integer in two's complement with the sizeof x */ 258 #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u))) 259 260 /* Checks if a sequence number x is a predecessor/successor of y. 261 * they handle overflows/underflows and can correctly check for a 262 * predecessor/successor unless the variable sequence number has grown by 263 * more then 2**(bitwidth(x)-1)-1. 264 * This means that for a uint8_t with the maximum value 255, it would think: 265 * - when adding nothing - it is neither a predecessor nor a successor 266 * - before adding more than 127 to the starting value - it is a predecessor, 267 * - when adding 128 - it is neither a predecessor nor a successor, 268 * - after adding more than 127 to the starting value - it is a successor 269 */ 270 #define batadv_seq_before(x, y) ({typeof(x) _d1 = (x); \ 271 typeof(y) _d2 = (y); \ 272 typeof(x) _dummy = (_d1 - _d2); \ 273 (void) (&_d1 == &_d2); \ 274 _dummy > batadv_smallest_signed_int(_dummy); }) 275 #define batadv_seq_after(x, y) batadv_seq_before(y, x) 276 277 /* Stop preemption on local cpu while incrementing the counter */ 278 static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx, 279 size_t count) 280 { 281 this_cpu_add(bat_priv->bat_counters[idx], count); 282 } 283 284 #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1) 285 286 /* Sum and return the cpu-local counters for index 'idx' */ 287 static inline uint64_t batadv_sum_counter(struct batadv_priv *bat_priv, 288 size_t idx) 289 { 290 uint64_t *counters, sum = 0; 291 int cpu; 292 293 for_each_possible_cpu(cpu) { 294 counters = per_cpu_ptr(bat_priv->bat_counters, cpu); 295 sum += counters[idx]; 296 } 297 298 return sum; 299 } 300 301 #endif /* _NET_BATMAN_ADV_MAIN_H_ */ 302