Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 1 | /* |
Sven Eckelmann | 64afe35 | 2011-01-27 10:38:15 +0100 | [diff] [blame] | 2 | * Copyright (C) 2007-2011 B.A.T.M.A.N. contributors: |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 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 | |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 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 | |
Sven Eckelmann | 44c4349 | 2011-07-05 10:42:51 +0200 | [diff] [blame] | 30 | #ifndef SOURCE_VERSION |
Sven Eckelmann | 45485ad | 2011-08-21 15:34:38 +0200 | [diff] [blame] | 31 | #define SOURCE_VERSION "2011.4.0" |
Sven Eckelmann | 44c4349 | 2011-07-05 10:42:51 +0200 | [diff] [blame] | 32 | #endif |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 33 | |
| 34 | /* B.A.T.M.A.N. parameters */ |
| 35 | |
| 36 | #define TQ_MAX_VALUE 255 |
| 37 | #define JITTER 20 |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 38 | |
Sven Eckelmann | 6e215fd | 2011-05-08 12:45:45 +0200 | [diff] [blame] | 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 200 |
Antonio Quartulli | 2dafb49 | 2011-05-05 08:42:45 +0200 | [diff] [blame] | 45 | #define TT_LOCAL_TIMEOUT 3600 /* in seconds */ |
Antonio Quartulli | cc47f66 | 2011-04-27 14:27:57 +0200 | [diff] [blame] | 46 | #define TT_CLIENT_ROAM_TIMEOUT 600 |
Antonio Quartulli | 015758d | 2011-07-09 17:52:13 +0200 | [diff] [blame] | 47 | /* sliding packet range of received originator messages in sequence numbers |
Sven Eckelmann | 6e215fd | 2011-05-08 12:45:45 +0200 | [diff] [blame] | 48 | * (should be a multiple of our word size) */ |
| 49 | #define TQ_LOCAL_WINDOW_SIZE 64 |
Antonio Quartulli | a73105b | 2011-04-27 14:27:44 +0200 | [diff] [blame] | 50 | #define TT_REQUEST_TIMEOUT 3 /* seconds we have to keep pending tt_req */ |
| 51 | |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 52 | #define TQ_GLOBAL_WINDOW_SIZE 5 |
| 53 | #define TQ_LOCAL_BIDRECT_SEND_MINIMUM 1 |
| 54 | #define TQ_LOCAL_BIDRECT_RECV_MINIMUM 1 |
| 55 | #define TQ_TOTAL_BIDRECT_LIMIT 1 |
| 56 | |
Antonio Quartulli | a73105b | 2011-04-27 14:27:44 +0200 | [diff] [blame] | 57 | #define TT_OGM_APPEND_MAX 3 /* number of OGMs sent with the last tt diff */ |
| 58 | |
Antonio Quartulli | cc47f66 | 2011-04-27 14:27:57 +0200 | [diff] [blame] | 59 | #define ROAMING_MAX_TIME 20 /* Time in which a client can roam at most |
| 60 | * ROAMING_MAX_COUNT times */ |
| 61 | #define ROAMING_MAX_COUNT 5 |
| 62 | |
Marek Lindner | ecbd532 | 2011-06-09 17:13:09 +0200 | [diff] [blame] | 63 | #define NO_FLAGS 0 |
| 64 | |
Antonio Quartulli | bc27908 | 2011-07-07 15:35:35 +0200 | [diff] [blame] | 65 | #define NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */ |
| 66 | |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 67 | #define NUM_WORDS (TQ_LOCAL_WINDOW_SIZE / WORD_BIT_SIZE) |
| 68 | |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 69 | #define LOG_BUF_LEN 8192 /* has to be a power of 2 */ |
| 70 | |
| 71 | #define VIS_INTERVAL 5000 /* 5 seconds */ |
| 72 | |
Sven Eckelmann | 6e215fd | 2011-05-08 12:45:45 +0200 | [diff] [blame] | 73 | /* how much worse secondary interfaces may be to be considered as bonding |
| 74 | * candidates */ |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 75 | #define BONDING_TQ_THRESHOLD 50 |
| 76 | |
Sven Eckelmann | 6e215fd | 2011-05-08 12:45:45 +0200 | [diff] [blame] | 77 | /* should not be bigger than 512 bytes or change the size of |
| 78 | * forw_packet->direct_link_flags */ |
| 79 | #define MAX_AGGREGATION_BYTES 512 |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 80 | #define MAX_AGGREGATION_MS 100 |
| 81 | |
| 82 | #define SOFTIF_NEIGH_TIMEOUT 180000 /* 3 minutes */ |
| 83 | |
Sven Eckelmann | 6e215fd | 2011-05-08 12:45:45 +0200 | [diff] [blame] | 84 | /* don't reset again within 30 seconds */ |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 85 | #define RESET_PROTECTION_MS 30000 |
| 86 | #define EXPECTED_SEQNO_RANGE 65536 |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 87 | |
Sven Eckelmann | e8958db | 2011-06-04 11:26:00 +0200 | [diff] [blame] | 88 | enum mesh_state { |
| 89 | MESH_INACTIVE, |
| 90 | MESH_ACTIVE, |
| 91 | MESH_DEACTIVATING |
| 92 | }; |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 93 | |
| 94 | #define BCAST_QUEUE_LEN 256 |
| 95 | #define BATMAN_QUEUE_LEN 256 |
| 96 | |
Antonio Quartulli | c6bda68 | 2011-04-26 18:26:01 +0200 | [diff] [blame] | 97 | enum uev_action { |
| 98 | UEV_ADD = 0, |
| 99 | UEV_DEL, |
| 100 | UEV_CHANGE |
| 101 | }; |
| 102 | |
| 103 | enum uev_type { |
| 104 | UEV_GW = 0 |
| 105 | }; |
| 106 | |
Antonio Quartulli | 43676ab5 | 2011-04-26 21:31:45 +0200 | [diff] [blame] | 107 | #define GW_THRESHOLD 50 |
| 108 | |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 109 | /* |
| 110 | * Debug Messages |
| 111 | */ |
| 112 | #ifdef pr_fmt |
| 113 | #undef pr_fmt |
| 114 | #endif |
Sven Eckelmann | 6e215fd | 2011-05-08 12:45:45 +0200 | [diff] [blame] | 115 | /* Append 'batman-adv: ' before kernel messages */ |
| 116 | #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 117 | |
Sven Eckelmann | 6e215fd | 2011-05-08 12:45:45 +0200 | [diff] [blame] | 118 | /* all messages related to routing / flooding / broadcasting / etc */ |
Sven Eckelmann | e8958db | 2011-06-04 11:26:00 +0200 | [diff] [blame] | 119 | enum dbg_level { |
| 120 | DBG_BATMAN = 1 << 0, |
| 121 | DBG_ROUTES = 1 << 1, /* route added / changed / deleted */ |
Antonio Quartulli | a73105b | 2011-04-27 14:27:44 +0200 | [diff] [blame] | 122 | DBG_TT = 1 << 2, /* translation table operations */ |
| 123 | DBG_ALL = 7 |
Sven Eckelmann | e8958db | 2011-06-04 11:26:00 +0200 | [diff] [blame] | 124 | }; |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 125 | |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 126 | |
| 127 | /* |
| 128 | * Vis |
| 129 | */ |
| 130 | |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 131 | /* |
| 132 | * Kernel headers |
| 133 | */ |
| 134 | |
| 135 | #include <linux/mutex.h> /* mutex */ |
| 136 | #include <linux/module.h> /* needed by all modules */ |
| 137 | #include <linux/netdevice.h> /* netdevice */ |
Antonio Quartulli | 015758d | 2011-07-09 17:52:13 +0200 | [diff] [blame] | 138 | #include <linux/etherdevice.h> /* ethernet address classification */ |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 139 | #include <linux/if_ether.h> /* ethernet header */ |
| 140 | #include <linux/poll.h> /* poll_table */ |
| 141 | #include <linux/kthread.h> /* kernel threads */ |
| 142 | #include <linux/pkt_sched.h> /* schedule types */ |
| 143 | #include <linux/workqueue.h> /* workqueue */ |
| 144 | #include <linux/slab.h> |
| 145 | #include <net/sock.h> /* struct sock */ |
| 146 | #include <linux/jiffies.h> |
| 147 | #include <linux/seq_file.h> |
| 148 | #include "types.h" |
| 149 | |
Marek Lindner | 4389e47 | 2011-02-18 12:33:19 +0000 | [diff] [blame] | 150 | extern struct list_head hardif_list; |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 151 | |
| 152 | extern unsigned char broadcast_addr[]; |
| 153 | extern struct workqueue_struct *bat_event_workqueue; |
| 154 | |
| 155 | int mesh_init(struct net_device *soft_iface); |
| 156 | void mesh_free(struct net_device *soft_iface); |
| 157 | void inc_module_count(void); |
| 158 | void dec_module_count(void); |
Sven Eckelmann | 747e422 | 2011-05-14 23:14:50 +0200 | [diff] [blame] | 159 | int is_my_mac(const uint8_t *addr); |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 160 | |
| 161 | #ifdef CONFIG_BATMAN_ADV_DEBUG |
Sven Eckelmann | 747e422 | 2011-05-14 23:14:50 +0200 | [diff] [blame] | 162 | int debug_log(struct bat_priv *bat_priv, const char *fmt, ...) __printf(2, 3); |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 163 | |
| 164 | #define bat_dbg(type, bat_priv, fmt, arg...) \ |
| 165 | do { \ |
| 166 | if (atomic_read(&bat_priv->log_level) & type) \ |
| 167 | debug_log(bat_priv, fmt, ## arg); \ |
| 168 | } \ |
| 169 | while (0) |
| 170 | #else /* !CONFIG_BATMAN_ADV_DEBUG */ |
Sven Eckelmann | d3a547b | 2011-05-14 23:14:46 +0200 | [diff] [blame] | 171 | __printf(3, 4) |
Sven Eckelmann | b4e1705 | 2011-06-15 09:41:37 +0200 | [diff] [blame] | 172 | static inline void bat_dbg(int type __always_unused, |
Sven Eckelmann | aa0adb1 | 2011-01-15 14:39:43 +0000 | [diff] [blame] | 173 | struct bat_priv *bat_priv __always_unused, |
Sven Eckelmann | 747e422 | 2011-05-14 23:14:50 +0200 | [diff] [blame] | 174 | const char *fmt __always_unused, ...) |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 175 | { |
| 176 | } |
| 177 | #endif |
| 178 | |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 179 | #define bat_info(net_dev, fmt, arg...) \ |
| 180 | do { \ |
| 181 | struct net_device *_netdev = (net_dev); \ |
| 182 | struct bat_priv *_batpriv = netdev_priv(_netdev); \ |
| 183 | bat_dbg(DBG_ALL, _batpriv, fmt, ## arg); \ |
| 184 | pr_info("%s: " fmt, _netdev->name, ## arg); \ |
| 185 | } while (0) |
| 186 | #define bat_err(net_dev, fmt, arg...) \ |
| 187 | do { \ |
| 188 | struct net_device *_netdev = (net_dev); \ |
| 189 | struct bat_priv *_batpriv = netdev_priv(_netdev); \ |
| 190 | bat_dbg(DBG_ALL, _batpriv, fmt, ## arg); \ |
| 191 | pr_err("%s: " fmt, _netdev->name, ## arg); \ |
| 192 | } while (0) |
| 193 | |
Marek Lindner | 39901e7 | 2011-02-18 12:28:08 +0000 | [diff] [blame] | 194 | /** |
| 195 | * returns 1 if they are the same ethernet addr |
| 196 | * |
| 197 | * note: can't use compare_ether_addr() as it requires aligned memory |
| 198 | */ |
Sven Eckelmann | 747e422 | 2011-05-14 23:14:50 +0200 | [diff] [blame] | 199 | |
| 200 | static inline int compare_eth(const void *data1, const void *data2) |
Marek Lindner | 39901e7 | 2011-02-18 12:28:08 +0000 | [diff] [blame] | 201 | { |
| 202 | return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0); |
| 203 | } |
| 204 | |
Sven Eckelmann | 747e422 | 2011-05-14 23:14:50 +0200 | [diff] [blame] | 205 | |
Antonio Quartulli | 5f657ec | 2011-04-20 09:52:56 +0200 | [diff] [blame] | 206 | #define atomic_dec_not_zero(v) atomic_add_unless((v), -1, 0) |
| 207 | |
Antonio Quartulli | f5d33d3 | 2011-05-18 09:20:50 +0200 | [diff] [blame] | 208 | /* Returns the smallest signed integer in two's complement with the sizeof x */ |
| 209 | #define smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u))) |
| 210 | |
| 211 | /* Checks if a sequence number x is a predecessor/successor of y. |
| 212 | * they handle overflows/underflows and can correctly check for a |
| 213 | * predecessor/successor unless the variable sequence number has grown by |
| 214 | * more then 2**(bitwidth(x)-1)-1. |
| 215 | * This means that for a uint8_t with the maximum value 255, it would think: |
| 216 | * - when adding nothing - it is neither a predecessor nor a successor |
| 217 | * - before adding more than 127 to the starting value - it is a predecessor, |
| 218 | * - when adding 128 - it is neither a predecessor nor a successor, |
| 219 | * - after adding more than 127 to the starting value - it is a successor */ |
Sven Eckelmann | 0bb8575 | 2011-05-19 21:43:08 +0200 | [diff] [blame] | 220 | #define seq_before(x, y) ({typeof(x) _d1 = (x); \ |
| 221 | typeof(y) _d2 = (y); \ |
| 222 | typeof(x) _dummy = (_d1 - _d2); \ |
| 223 | (void) (&_d1 == &_d2); \ |
| 224 | _dummy > smallest_signed_int(_dummy); }) |
Antonio Quartulli | f5d33d3 | 2011-05-18 09:20:50 +0200 | [diff] [blame] | 225 | #define seq_after(x, y) seq_before(y, x) |
| 226 | |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 227 | #endif /* _NET_BATMAN_ADV_MAIN_H_ */ |