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.4"
  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 /* length of the single packet used by the TP meter */
 104 #define BATADV_TP_PACKET_LEN ETH_DATA_LEN
 105
 106 /* msecs after which an ARP_REQUEST is sent in broadcast as fallback */
 107 #define ARP_REQ_DELAY 250
 108 /* numbers of originator to contact for any PUT/GET DHT operation */
 109 #define BATADV_DAT_CANDIDATES_NUM 3
 110
 111 /* BATADV_TQ_SIMILARITY_THRESHOLD - TQ points that a secondary metric can differ
 112  * at most from the primary one in order to be still considered acceptable
 113  */
 114 #define BATADV_TQ_SIMILARITY_THRESHOLD 50
 115
 116 /* should not be bigger than 512 bytes or change the size of
 117  * forw_packet->direct_link_flags
 118  */
 119 #define BATADV_MAX_AGGREGATION_BYTES 512
 120 #define BATADV_MAX_AGGREGATION_MS 100
 121
 122 #define BATADV_BLA_PERIOD_LENGTH        10000   /* 10 seconds */
 123 #define BATADV_BLA_BACKBONE_TIMEOUT     (BATADV_BLA_PERIOD_LENGTH * 6)
 124 #define BATADV_BLA_CLAIM_TIMEOUT        (BATADV_BLA_PERIOD_LENGTH * 10)
 125 #define BATADV_BLA_WAIT_PERIODS         3
 126 #define BATADV_BLA_LOOPDETECT_PERIODS   6
 127 #define BATADV_BLA_LOOPDETECT_TIMEOUT   3000    /* 3 seconds */
 128
 129 #define BATADV_DUPLIST_SIZE             16
 130 #define BATADV_DUPLIST_TIMEOUT          500     /* 500 ms */
 131 /* don't reset again within 30 seconds */
 132 #define BATADV_RESET_PROTECTION_MS 30000
 133 #define BATADV_EXPECTED_SEQNO_RANGE     65536
 134
 135 #define BATADV_NC_NODE_TIMEOUT 10000 /* Milliseconds */
 136
 137 /**
 138  * BATADV_TP_MAX_NUM - maximum number of simultaneously active tp sessions
 139  */
 140 #define BATADV_TP_MAX_NUM 5
 141
 142 enum batadv_mesh_state {
 143         BATADV_MESH_INACTIVE,
 144         BATADV_MESH_ACTIVE,
 145         BATADV_MESH_DEACTIVATING,
 146 };
 147
 148 #define BATADV_BCAST_QUEUE_LEN          256
 149 #define BATADV_BATMAN_QUEUE_LEN 256
 150
 151 enum batadv_uev_action {
 152         BATADV_UEV_ADD = 0,
 153         BATADV_UEV_DEL,
 154         BATADV_UEV_CHANGE,
 155         BATADV_UEV_LOOPDETECT,
 156 };
 157
 158 enum batadv_uev_type {
 159         BATADV_UEV_GW = 0,
 160         BATADV_UEV_BLA,
 161 };
 162
 163 #define BATADV_GW_THRESHOLD     50
 164
 165 /* Number of fragment chains for each orig_node */
 166 #define BATADV_FRAG_BUFFER_COUNT 8
 167 /* Maximum number of fragments for one packet */
 168 #define BATADV_FRAG_MAX_FRAGMENTS 16
 169 /* Maxumim size of each fragment */
 170 #define BATADV_FRAG_MAX_FRAG_SIZE 1400
 171 /* Time to keep fragments while waiting for rest of the fragments */
 172 #define BATADV_FRAG_TIMEOUT 10000
 173
 174 #define BATADV_DAT_CANDIDATE_NOT_FOUND  0
 175 #define BATADV_DAT_CANDIDATE_ORIG       1
 176
 177 /* Debug Messages */
 178 #ifdef pr_fmt
 179 #undef pr_fmt
 180 #endif
 181 /* Append 'batman-adv: ' before kernel messages */
 182 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
 183
 184 /* Kernel headers */
 185
 186 #include <linux/bitops.h> /* for packet.h */
 187 #include <linux/compiler.h>
 188 #include <linux/cpumask.h>
 189 #include <linux/etherdevice.h>
 190 #include <linux/if_ether.h> /* for packet.h */
 191 #include <linux/if_vlan.h>
 192 #include <linux/jiffies.h>
 193 #include <linux/percpu.h>
 194 #include <linux/types.h>
 195
 196 #include "types.h"
 197
 198 struct net_device;
 199 struct packet_type;
 200 struct seq_file;
 201 struct sk_buff;
 202
 203 #define BATADV_PRINT_VID(vid) ((vid & BATADV_VLAN_HAS_TAG) ? \
 204                                (int)(vid & VLAN_VID_MASK) : -1)
 205
 206 extern struct list_head batadv_hardif_list;
 207
 208 extern unsigned char batadv_broadcast_addr[];
 209 extern struct workqueue_struct *batadv_event_workqueue;
 210
 211 int batadv_mesh_init(struct net_device *soft_iface);
 212 void batadv_mesh_free(struct net_device *soft_iface);
 213 bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr);
 214 struct batadv_hard_iface *
 215 batadv_seq_print_text_primary_if_get(struct seq_file *seq);
 216 int batadv_max_header_len(void);
 217 void batadv_skb_set_priority(struct sk_buff *skb, int offset);
 218 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
 219                            struct packet_type *ptype,
 220                            struct net_device *orig_dev);
 221 int
 222 batadv_recv_handler_register(u8 packet_type,
 223                              int (*recv_handler)(struct sk_buff *,
 224                                                  struct batadv_hard_iface *));
 225 void batadv_recv_handler_unregister(u8 packet_type);
 226 __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr);
 227
 228 /**
 229  * batadv_compare_eth - Compare two not u16 aligned Ethernet addresses
 230  * @data1: Pointer to a six-byte array containing the Ethernet address
 231  * @data2: Pointer other six-byte array containing the Ethernet address
 232  *
 233  * note: can't use ether_addr_equal() as it requires aligned memory
 234  *
 235  * Return: true if they are the same ethernet addr
 236  */
 237 static inline bool batadv_compare_eth(const void *data1, const void *data2)
 238 {
 239         return ether_addr_equal_unaligned(data1, data2);
 240 }
 241
 242 /**
 243  * batadv_has_timed_out - compares current time (jiffies) and timestamp +
 244  *  timeout
 245  * @timestamp:          base value to compare with (in jiffies)
 246  * @timeout:            added to base value before comparing (in milliseconds)
 247  *
 248  * Return: true if current time is after timestamp + timeout
 249  */
 250 static inline bool batadv_has_timed_out(unsigned long timestamp,
 251                                         unsigned int timeout)
 252 {
 253         return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout));
 254 }
 255
 256 #define batadv_atomic_dec_not_zero(v)   atomic_add_unless((v), -1, 0)
 257
 258 /* Returns the smallest signed integer in two's complement with the sizeof x */
 259 #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u)))
 260
 261 /* Checks if a sequence number x is a predecessor/successor of y.
 262  * they handle overflows/underflows and can correctly check for a
 263  * predecessor/successor unless the variable sequence number has grown by
 264  * more then 2**(bitwidth(x)-1)-1.
 265  * This means that for a u8 with the maximum value 255, it would think:
 266  *  - when adding nothing - it is neither a predecessor nor a successor
 267  *  - before adding more than 127 to the starting value - it is a predecessor,
 268  *  - when adding 128 - it is neither a predecessor nor a successor,
 269  *  - after adding more than 127 to the starting value - it is a successor
 270  */
 271 #define batadv_seq_before(x, y) ({typeof(x)_d1 = (x); \
 272                                  typeof(y)_d2 = (y); \
 273                                  typeof(x)_dummy = (_d1 - _d2); \
 274                                  (void)(&_d1 == &_d2); \
 275                                  _dummy > batadv_smallest_signed_int(_dummy); })
 276 #define batadv_seq_after(x, y) batadv_seq_before(y, x)
 277
 278 /* Stop preemption on local cpu while incrementing the counter */
 279 static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx,
 280                                       size_t count)
 281 {
 282         this_cpu_add(bat_priv->bat_counters[idx], count);
 283 }
 284
 285 #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1)
 286
 287 /**
 288  * batadv_sum_counter - Sum the cpu-local counters for index 'idx'
 289  * @bat_priv: the bat priv with all the soft interface information
 290  * @idx: index of counter to sum up
 291  *
 292  * Return: sum of all cpu-local counters
 293  */
 294 static inline u64 batadv_sum_counter(struct batadv_priv *bat_priv,  size_t idx)
 295 {
 296         u64 *counters, sum = 0;
 297         int cpu;
 298
 299         for_each_possible_cpu(cpu) {
 300                 counters = per_cpu_ptr(bat_priv->bat_counters, cpu);
 301                 sum += counters[idx];
 302         }
 303
 304         return sum;
 305 }
 306
 307 /* Define a macro to reach the control buffer of the skb. The members of the
 308  * control buffer are defined in struct batadv_skb_cb in types.h.
 309  * The macro is inspired by the similar macro TCP_SKB_CB() in tcp.h.
 310  */
 311 #define BATADV_SKB_CB(__skb)       ((struct batadv_skb_cb *)&((__skb)->cb[0]))
 312
 313 unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len);
 314 bool batadv_vlan_ap_isola_get(struct batadv_priv *bat_priv, unsigned short vid);
 315
 316 #endif /* _NET_BATMAN_ADV_MAIN_H_ */