1 /* 2 * Copyright (C) 2007-2012 B.A.T.M.A.N. contributors: 3 * 4 * Marek Lindner, Simon Wunderlich 5 * 6 * This program is free software; you can redistribute it and/or 7 * modify it under the terms of version 2 of the GNU General Public 8 * License as published by the Free Software Foundation. 9 * 10 * This program is distributed in the hope that it will be useful, but 11 * WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 * General Public License for more details. 14 * 15 * You should have received a copy of the GNU General Public License 16 * along with this program; if not, write to the Free Software 17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 18 * 02110-1301, USA 19 * 20 */ 21 22 #ifndef _NET_BATMAN_ADV_MAIN_H_ 23 #define _NET_BATMAN_ADV_MAIN_H_ 24 25 #define DRIVER_AUTHOR "Marek Lindner <lindner_marek@yahoo.de>, " \ 26 "Simon Wunderlich <siwu@hrz.tu-chemnitz.de>" 27 #define DRIVER_DESC "B.A.T.M.A.N. advanced" 28 #define DRIVER_DEVICE "batman-adv" 29 30 #ifndef SOURCE_VERSION 31 #define SOURCE_VERSION "2012.3.0" 32 #endif 33 34 /* B.A.T.M.A.N. parameters */ 35 36 #define TQ_MAX_VALUE 255 37 #define JITTER 20 38 39 /* Time To Live of broadcast messages */ 40 #define TTL 50 41 42 /* purge originators after time in seconds if no valid packet comes in 43 * -> TODO: check influence on TQ_LOCAL_WINDOW_SIZE */ 44 #define PURGE_TIMEOUT 200000 /* 200 seconds */ 45 #define TT_LOCAL_TIMEOUT 3600000 /* in miliseconds */ 46 #define TT_CLIENT_ROAM_TIMEOUT 600000 /* in miliseconds */ 47 /* sliding packet range of received originator messages in sequence numbers 48 * (should be a multiple of our word size) */ 49 #define TQ_LOCAL_WINDOW_SIZE 64 50 #define TT_REQUEST_TIMEOUT 3000 /* miliseconds we have to keep 51 * pending tt_req */ 52 53 #define TQ_GLOBAL_WINDOW_SIZE 5 54 #define TQ_LOCAL_BIDRECT_SEND_MINIMUM 1 55 #define TQ_LOCAL_BIDRECT_RECV_MINIMUM 1 56 #define TQ_TOTAL_BIDRECT_LIMIT 1 57 58 #define TT_OGM_APPEND_MAX 3 /* number of OGMs sent with the last tt diff */ 59 60 #define ROAMING_MAX_TIME 20000 /* Time in which a client can roam at most 61 * ROAMING_MAX_COUNT times in miliseconds*/ 62 #define ROAMING_MAX_COUNT 5 63 64 #define NO_FLAGS 0 65 66 #define NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */ 67 68 #define NUM_WORDS BITS_TO_LONGS(TQ_LOCAL_WINDOW_SIZE) 69 70 #define LOG_BUF_LEN 8192 /* has to be a power of 2 */ 71 72 #define VIS_INTERVAL 5000 /* 5 seconds */ 73 74 /* how much worse secondary interfaces may be to be considered as bonding 75 * candidates */ 76 #define BONDING_TQ_THRESHOLD 50 77 78 /* should not be bigger than 512 bytes or change the size of 79 * forw_packet->direct_link_flags */ 80 #define MAX_AGGREGATION_BYTES 512 81 #define MAX_AGGREGATION_MS 100 82 83 #define BLA_PERIOD_LENGTH 10000 /* 10 seconds */ 84 #define BLA_BACKBONE_TIMEOUT (BLA_PERIOD_LENGTH * 3) 85 #define BLA_CLAIM_TIMEOUT (BLA_PERIOD_LENGTH * 10) 86 87 #define DUPLIST_SIZE 16 88 #define DUPLIST_TIMEOUT 500 /* 500 ms */ 89 /* don't reset again within 30 seconds */ 90 #define RESET_PROTECTION_MS 30000 91 #define EXPECTED_SEQNO_RANGE 65536 92 93 enum mesh_state { 94 MESH_INACTIVE, 95 MESH_ACTIVE, 96 MESH_DEACTIVATING 97 }; 98 99 #define BCAST_QUEUE_LEN 256 100 #define BATMAN_QUEUE_LEN 256 101 102 enum uev_action { 103 UEV_ADD = 0, 104 UEV_DEL, 105 UEV_CHANGE 106 }; 107 108 enum uev_type { 109 UEV_GW = 0 110 }; 111 112 #define GW_THRESHOLD 50 113 114 /* Debug Messages */ 115 #ifdef pr_fmt 116 #undef pr_fmt 117 #endif 118 /* Append 'batman-adv: ' before kernel messages */ 119 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 120 121 /* all messages related to routing / flooding / broadcasting / etc */ 122 enum dbg_level { 123 DBG_BATMAN = 1 << 0, 124 DBG_ROUTES = 1 << 1, /* route added / changed / deleted */ 125 DBG_TT = 1 << 2, /* translation table operations */ 126 DBG_BLA = 1 << 3, /* bridge loop avoidance */ 127 DBG_ALL = 15 128 }; 129 130 /* Kernel headers */ 131 132 #include <linux/mutex.h> /* mutex */ 133 #include <linux/module.h> /* needed by all modules */ 134 #include <linux/netdevice.h> /* netdevice */ 135 #include <linux/etherdevice.h> /* ethernet address classification */ 136 #include <linux/if_ether.h> /* ethernet header */ 137 #include <linux/poll.h> /* poll_table */ 138 #include <linux/kthread.h> /* kernel threads */ 139 #include <linux/pkt_sched.h> /* schedule types */ 140 #include <linux/workqueue.h> /* workqueue */ 141 #include <linux/percpu.h> 142 #include <linux/slab.h> 143 #include <net/sock.h> /* struct sock */ 144 #include <linux/jiffies.h> 145 #include <linux/seq_file.h> 146 #include "types.h" 147 148 extern char batadv_routing_algo[]; 149 extern struct list_head batadv_hardif_list; 150 151 extern unsigned char batadv_broadcast_addr[]; 152 extern struct workqueue_struct *batadv_event_workqueue; 153 154 int batadv_mesh_init(struct net_device *soft_iface); 155 void batadv_mesh_free(struct net_device *soft_iface); 156 void batadv_inc_module_count(void); 157 void batadv_dec_module_count(void); 158 int batadv_is_my_mac(const uint8_t *addr); 159 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev, 160 struct packet_type *ptype, 161 struct net_device *orig_dev); 162 int batadv_recv_handler_register(uint8_t packet_type, 163 int (*recv_handler)(struct sk_buff *, 164 struct hard_iface *)); 165 void batadv_recv_handler_unregister(uint8_t packet_type); 166 int batadv_algo_register(struct bat_algo_ops *bat_algo_ops); 167 int batadv_algo_select(struct bat_priv *bat_priv, char *name); 168 int batadv_algo_seq_print_text(struct seq_file *seq, void *offset); 169 170 #ifdef CONFIG_BATMAN_ADV_DEBUG 171 int batadv_debug_log(struct bat_priv *bat_priv, const char *fmt, ...) 172 __printf(2, 3); 173 174 #define bat_dbg(type, bat_priv, fmt, arg...) \ 175 do { \ 176 if (atomic_read(&bat_priv->log_level) & type) \ 177 batadv_debug_log(bat_priv, fmt, ## arg);\ 178 } \ 179 while (0) 180 #else /* !CONFIG_BATMAN_ADV_DEBUG */ 181 __printf(3, 4) 182 static inline void bat_dbg(int type __always_unused, 183 struct bat_priv *bat_priv __always_unused, 184 const char *fmt __always_unused, ...) 185 { 186 } 187 #endif 188 189 #define bat_info(net_dev, fmt, arg...) \ 190 do { \ 191 struct net_device *_netdev = (net_dev); \ 192 struct bat_priv *_batpriv = netdev_priv(_netdev); \ 193 bat_dbg(DBG_ALL, _batpriv, fmt, ## arg); \ 194 pr_info("%s: " fmt, _netdev->name, ## arg); \ 195 } while (0) 196 #define bat_err(net_dev, fmt, arg...) \ 197 do { \ 198 struct net_device *_netdev = (net_dev); \ 199 struct bat_priv *_batpriv = netdev_priv(_netdev); \ 200 bat_dbg(DBG_ALL, _batpriv, fmt, ## arg); \ 201 pr_err("%s: " fmt, _netdev->name, ## arg); \ 202 } while (0) 203 204 /** 205 * returns 1 if they are the same ethernet addr 206 * 207 * note: can't use compare_ether_addr() as it requires aligned memory 208 */ 209 210 static inline int compare_eth(const void *data1, const void *data2) 211 { 212 return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0); 213 } 214 215 /** 216 * has_timed_out - compares current time (jiffies) and timestamp + timeout 217 * @timestamp: base value to compare with (in jiffies) 218 * @timeout: added to base value before comparing (in milliseconds) 219 * 220 * Returns true if current time is after timestamp + timeout 221 */ 222 static inline bool has_timed_out(unsigned long timestamp, unsigned int timeout) 223 { 224 return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout)); 225 } 226 227 #define atomic_dec_not_zero(v) atomic_add_unless((v), -1, 0) 228 229 /* Returns the smallest signed integer in two's complement with the sizeof x */ 230 #define smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u))) 231 232 /* Checks if a sequence number x is a predecessor/successor of y. 233 * they handle overflows/underflows and can correctly check for a 234 * predecessor/successor unless the variable sequence number has grown by 235 * more then 2**(bitwidth(x)-1)-1. 236 * This means that for a uint8_t with the maximum value 255, it would think: 237 * - when adding nothing - it is neither a predecessor nor a successor 238 * - before adding more than 127 to the starting value - it is a predecessor, 239 * - when adding 128 - it is neither a predecessor nor a successor, 240 * - after adding more than 127 to the starting value - it is a successor */ 241 #define seq_before(x, y) ({typeof(x) _d1 = (x); \ 242 typeof(y) _d2 = (y); \ 243 typeof(x) _dummy = (_d1 - _d2); \ 244 (void) (&_d1 == &_d2); \ 245 _dummy > smallest_signed_int(_dummy); }) 246 #define seq_after(x, y) seq_before(y, x) 247 248 /* Stop preemption on local cpu while incrementing the counter */ 249 static inline void batadv_add_counter(struct bat_priv *bat_priv, size_t idx, 250 size_t count) 251 { 252 int cpu = get_cpu(); 253 per_cpu_ptr(bat_priv->bat_counters, cpu)[idx] += count; 254 put_cpu(); 255 } 256 257 #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1) 258 259 /* Sum and return the cpu-local counters for index 'idx' */ 260 static inline uint64_t batadv_sum_counter(struct bat_priv *bat_priv, size_t idx) 261 { 262 uint64_t *counters; 263 int cpu; 264 int sum = 0; 265 266 for_each_possible_cpu(cpu) { 267 counters = per_cpu_ptr(bat_priv->bat_counters, cpu); 268 sum += counters[idx]; 269 } 270 271 return sum; 272 } 273 274 #endif /* _NET_BATMAN_ADV_MAIN_H_ */ 275