net/batman-adv/main.h

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