net/batman-adv/main.h

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