1 /* Copyright (C) 2007-2012 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 "2012.3.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 3600000 /* in miliseconds */ 45 #define BATADV_TT_CLIENT_ROAM_TIMEOUT 600000 /* in miliseconds */ 46 /* sliding packet range of received originator messages in sequence numbers 47 * (should be a multiple of our word size) 48 */ 49 #define BATADV_TQ_LOCAL_WINDOW_SIZE 64 50 /* miliseconds we have to keep pending tt_req */ 51 #define BATADV_TT_REQUEST_TIMEOUT 3000 52 53 #define BATADV_TQ_GLOBAL_WINDOW_SIZE 5 54 #define BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM 1 55 #define BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM 1 56 #define BATADV_TQ_TOTAL_BIDRECT_LIMIT 1 57 58 /* number of OGMs sent with the last tt diff */ 59 #define BATADV_TT_OGM_APPEND_MAX 3 60 61 /* Time in which a client can roam at most ROAMING_MAX_COUNT times in 62 * miliseconds 63 */ 64 #define BATADV_ROAMING_MAX_TIME 20000 65 #define BATADV_ROAMING_MAX_COUNT 5 66 67 #define BATADV_NO_FLAGS 0 68 69 #define BATADV_NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */ 70 71 #define BATADV_NUM_WORDS BITS_TO_LONGS(BATADV_TQ_LOCAL_WINDOW_SIZE) 72 73 #define BATADV_LOG_BUF_LEN 8192 /* has to be a power of 2 */ 74 75 #define BATADV_VIS_INTERVAL 5000 /* 5 seconds */ 76 77 /* how much worse secondary interfaces may be to be considered as bonding 78 * candidates 79 */ 80 #define BATADV_BONDING_TQ_THRESHOLD 50 81 82 /* should not be bigger than 512 bytes or change the size of 83 * forw_packet->direct_link_flags 84 */ 85 #define BATADV_MAX_AGGREGATION_BYTES 512 86 #define BATADV_MAX_AGGREGATION_MS 100 87 88 #define BATADV_BLA_PERIOD_LENGTH 10000 /* 10 seconds */ 89 #define BATADV_BLA_BACKBONE_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 3) 90 #define BATADV_BLA_CLAIM_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 10) 91 92 #define BATADV_DUPLIST_SIZE 16 93 #define BATADV_DUPLIST_TIMEOUT 500 /* 500 ms */ 94 /* don't reset again within 30 seconds */ 95 #define BATADV_RESET_PROTECTION_MS 30000 96 #define BATADV_EXPECTED_SEQNO_RANGE 65536 97 98 enum batadv_mesh_state { 99 BATADV_MESH_INACTIVE, 100 BATADV_MESH_ACTIVE, 101 BATADV_MESH_DEACTIVATING, 102 }; 103 104 #define BATADV_BCAST_QUEUE_LEN 256 105 #define BATADV_BATMAN_QUEUE_LEN 256 106 107 enum batadv_uev_action { 108 BATADV_UEV_ADD = 0, 109 BATADV_UEV_DEL, 110 BATADV_UEV_CHANGE, 111 }; 112 113 enum batadv_uev_type { 114 BATADV_UEV_GW = 0, 115 }; 116 117 #define BATADV_GW_THRESHOLD 50 118 119 /* Debug Messages */ 120 #ifdef pr_fmt 121 #undef pr_fmt 122 #endif 123 /* Append 'batman-adv: ' before kernel messages */ 124 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 125 126 /* all messages related to routing / flooding / broadcasting / etc */ 127 enum batadv_dbg_level { 128 BATADV_DBG_BATMAN = 1 << 0, 129 BATADV_DBG_ROUTES = 1 << 1, /* route added / changed / deleted */ 130 BATADV_DBG_TT = 1 << 2, /* translation table operations */ 131 BATADV_DBG_BLA = 1 << 3, /* bridge loop avoidance */ 132 BATADV_DBG_ALL = 15, 133 }; 134 135 /* Kernel headers */ 136 137 #include <linux/mutex.h> /* mutex */ 138 #include <linux/module.h> /* needed by all modules */ 139 #include <linux/netdevice.h> /* netdevice */ 140 #include <linux/etherdevice.h> /* ethernet address classification */ 141 #include <linux/if_ether.h> /* ethernet header */ 142 #include <linux/poll.h> /* poll_table */ 143 #include <linux/kthread.h> /* kernel threads */ 144 #include <linux/pkt_sched.h> /* schedule types */ 145 #include <linux/workqueue.h> /* workqueue */ 146 #include <linux/percpu.h> 147 #include <linux/slab.h> 148 #include <net/sock.h> /* struct sock */ 149 #include <linux/jiffies.h> 150 #include <linux/seq_file.h> 151 #include "types.h" 152 153 extern char batadv_routing_algo[]; 154 extern struct list_head batadv_hardif_list; 155 156 extern unsigned char batadv_broadcast_addr[]; 157 extern struct workqueue_struct *batadv_event_workqueue; 158 159 int batadv_mesh_init(struct net_device *soft_iface); 160 void batadv_mesh_free(struct net_device *soft_iface); 161 void batadv_inc_module_count(void); 162 void batadv_dec_module_count(void); 163 int batadv_is_my_mac(const uint8_t *addr); 164 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev, 165 struct packet_type *ptype, 166 struct net_device *orig_dev); 167 int 168 batadv_recv_handler_register(uint8_t packet_type, 169 int (*recv_handler)(struct sk_buff *, 170 struct batadv_hard_iface *)); 171 void batadv_recv_handler_unregister(uint8_t packet_type); 172 int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops); 173 int batadv_algo_select(struct batadv_priv *bat_priv, char *name); 174 int batadv_algo_seq_print_text(struct seq_file *seq, void *offset); 175 176 #ifdef CONFIG_BATMAN_ADV_DEBUG 177 int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...) 178 __printf(2, 3); 179 180 #define batadv_dbg(type, bat_priv, fmt, arg...) \ 181 do { \ 182 if (atomic_read(&bat_priv->log_level) & type) \ 183 batadv_debug_log(bat_priv, fmt, ## arg);\ 184 } \ 185 while (0) 186 #else /* !CONFIG_BATMAN_ADV_DEBUG */ 187 __printf(3, 4) 188 static inline void batadv_dbg(int type __always_unused, 189 struct batadv_priv *bat_priv __always_unused, 190 const char *fmt __always_unused, ...) 191 { 192 } 193 #endif 194 195 #define batadv_info(net_dev, fmt, arg...) \ 196 do { \ 197 struct net_device *_netdev = (net_dev); \ 198 struct batadv_priv *_batpriv = netdev_priv(_netdev); \ 199 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \ 200 pr_info("%s: " fmt, _netdev->name, ## arg); \ 201 } while (0) 202 #define batadv_err(net_dev, fmt, arg...) \ 203 do { \ 204 struct net_device *_netdev = (net_dev); \ 205 struct batadv_priv *_batpriv = netdev_priv(_netdev); \ 206 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \ 207 pr_err("%s: " fmt, _netdev->name, ## arg); \ 208 } while (0) 209 210 /* returns 1 if they are the same ethernet addr 211 * 212 * note: can't use compare_ether_addr() as it requires aligned memory 213 */ 214 static inline int batadv_compare_eth(const void *data1, const void *data2) 215 { 216 return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0); 217 } 218 219 /** 220 * has_timed_out - compares current time (jiffies) and timestamp + timeout 221 * @timestamp: base value to compare with (in jiffies) 222 * @timeout: added to base value before comparing (in milliseconds) 223 * 224 * Returns true if current time is after timestamp + timeout 225 */ 226 static inline bool batadv_has_timed_out(unsigned long timestamp, 227 unsigned int timeout) 228 { 229 return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout)); 230 } 231 232 #define batadv_atomic_dec_not_zero(v) atomic_add_unless((v), -1, 0) 233 234 /* Returns the smallest signed integer in two's complement with the sizeof x */ 235 #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u))) 236 237 /* Checks if a sequence number x is a predecessor/successor of y. 238 * they handle overflows/underflows and can correctly check for a 239 * predecessor/successor unless the variable sequence number has grown by 240 * more then 2**(bitwidth(x)-1)-1. 241 * This means that for a uint8_t with the maximum value 255, it would think: 242 * - when adding nothing - it is neither a predecessor nor a successor 243 * - before adding more than 127 to the starting value - it is a predecessor, 244 * - when adding 128 - it is neither a predecessor nor a successor, 245 * - after adding more than 127 to the starting value - it is a successor 246 */ 247 #define batadv_seq_before(x, y) ({typeof(x) _d1 = (x); \ 248 typeof(y) _d2 = (y); \ 249 typeof(x) _dummy = (_d1 - _d2); \ 250 (void) (&_d1 == &_d2); \ 251 _dummy > batadv_smallest_signed_int(_dummy); }) 252 #define batadv_seq_after(x, y) batadv_seq_before(y, x) 253 254 /* Stop preemption on local cpu while incrementing the counter */ 255 static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx, 256 size_t count) 257 { 258 int cpu = get_cpu(); 259 per_cpu_ptr(bat_priv->bat_counters, cpu)[idx] += count; 260 put_cpu(); 261 } 262 263 #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1) 264 265 /* Sum and return the cpu-local counters for index 'idx' */ 266 static inline uint64_t batadv_sum_counter(struct batadv_priv *bat_priv, 267 size_t idx) 268 { 269 uint64_t *counters, sum = 0; 270 int cpu; 271 272 for_each_possible_cpu(cpu) { 273 counters = per_cpu_ptr(bat_priv->bat_counters, cpu); 274 sum += counters[idx]; 275 } 276 277 return sum; 278 } 279 280 #endif /* _NET_BATMAN_ADV_MAIN_H_ */ 281