net/batman-adv/main.h

   1 /* Copyright (C) 2007-2013 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, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17  * 02110-1301, USA
  18  */
  19
  20 #ifndef _NET_BATMAN_ADV_MAIN_H_
  21 #define _NET_BATMAN_ADV_MAIN_H_
  22
  23 #define BATADV_DRIVER_AUTHOR "Marek Lindner <lindner_marek@yahoo.de>, " \
  24                              "Simon Wunderlich <siwu@hrz.tu-chemnitz.de>"
  25 #define BATADV_DRIVER_DESC   "B.A.T.M.A.N. advanced"
  26 #define BATADV_DRIVER_DEVICE "batman-adv"
  27
  28 #ifndef BATADV_SOURCE_VERSION
  29 #define BATADV_SOURCE_VERSION "2013.3.0"
  30 #endif
  31
  32 /* B.A.T.M.A.N. parameters */
  33
  34 #define BATADV_TQ_MAX_VALUE 255
  35 #define BATADV_JITTER 20
  36
  37 /* Time To Live of broadcast messages */
  38 #define BATADV_TTL 50
  39
  40 /* purge originators after time in seconds if no valid packet comes in
  41  * -> TODO: check influence on BATADV_TQ_LOCAL_WINDOW_SIZE
  42  */
  43 #define BATADV_PURGE_TIMEOUT 200000 /* 200 seconds */
  44 #define BATADV_TT_LOCAL_TIMEOUT 600000 /* in milliseconds */
  45 #define BATADV_TT_CLIENT_ROAM_TIMEOUT 600000 /* in milliseconds */
  46 #define BATADV_TT_CLIENT_TEMP_TIMEOUT 600000 /* in milliseconds */
  47 #define BATADV_TT_WORK_PERIOD 5000 /* 5 seconds */
  48 #define BATADV_ORIG_WORK_PERIOD 1000 /* 1 second */
  49 #define BATADV_DAT_ENTRY_TIMEOUT (5*60000) /* 5 mins in milliseconds */
  50 /* sliding packet range of received originator messages in sequence numbers
  51  * (should be a multiple of our word size)
  52  */
  53 #define BATADV_TQ_LOCAL_WINDOW_SIZE 64
  54 /* milliseconds we have to keep pending tt_req */
  55 #define BATADV_TT_REQUEST_TIMEOUT 3000
  56
  57 #define BATADV_TQ_GLOBAL_WINDOW_SIZE 5
  58 #define BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM 1
  59 #define BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM 1
  60 #define BATADV_TQ_TOTAL_BIDRECT_LIMIT 1
  61
  62 /* number of OGMs sent with the last tt diff */
  63 #define BATADV_TT_OGM_APPEND_MAX 3
  64
  65 /* Time in which a client can roam at most ROAMING_MAX_COUNT times in
  66  * milliseconds
  67  */
  68 #define BATADV_ROAMING_MAX_TIME 20000
  69 #define BATADV_ROAMING_MAX_COUNT 5
  70
  71 #define BATADV_NO_FLAGS 0
  72
  73 #define BATADV_NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */
  74
  75 #define BATADV_NUM_WORDS BITS_TO_LONGS(BATADV_TQ_LOCAL_WINDOW_SIZE)
  76
  77 #define BATADV_LOG_BUF_LEN 8192   /* has to be a power of 2 */
  78
  79 /* number of packets to send for broadcasts on different interface types */
  80 #define BATADV_NUM_BCASTS_DEFAULT 1
  81 #define BATADV_NUM_BCASTS_WIRELESS 3
  82 #define BATADV_NUM_BCASTS_MAX 3
  83
  84 /* msecs after which an ARP_REQUEST is sent in broadcast as fallback */
  85 #define ARP_REQ_DELAY 250
  86 /* numbers of originator to contact for any PUT/GET DHT operation */
  87 #define BATADV_DAT_CANDIDATES_NUM 3
  88
  89 #define BATADV_VIS_INTERVAL 5000        /* 5 seconds */
  90
  91 /* how much worse secondary interfaces may be to be considered as bonding
  92  * candidates
  93  */
  94 #define BATADV_BONDING_TQ_THRESHOLD     50
  95
  96 /* should not be bigger than 512 bytes or change the size of
  97  * forw_packet->direct_link_flags
  98  */
  99 #define BATADV_MAX_AGGREGATION_BYTES 512
 100 #define BATADV_MAX_AGGREGATION_MS 100
 101
 102 #define BATADV_BLA_PERIOD_LENGTH        10000   /* 10 seconds */
 103 #define BATADV_BLA_BACKBONE_TIMEOUT     (BATADV_BLA_PERIOD_LENGTH * 3)
 104 #define BATADV_BLA_CLAIM_TIMEOUT        (BATADV_BLA_PERIOD_LENGTH * 10)
 105 #define BATADV_BLA_WAIT_PERIODS         3
 106
 107 #define BATADV_DUPLIST_SIZE             16
 108 #define BATADV_DUPLIST_TIMEOUT          500     /* 500 ms */
 109 /* don't reset again within 30 seconds */
 110 #define BATADV_RESET_PROTECTION_MS 30000
 111 #define BATADV_EXPECTED_SEQNO_RANGE     65536
 112
 113 #define BATADV_NC_NODE_TIMEOUT 10000 /* Milliseconds */
 114
 115 enum batadv_mesh_state {
 116         BATADV_MESH_INACTIVE,
 117         BATADV_MESH_ACTIVE,
 118         BATADV_MESH_DEACTIVATING,
 119 };
 120
 121 #define BATADV_BCAST_QUEUE_LEN          256
 122 #define BATADV_BATMAN_QUEUE_LEN 256
 123
 124 enum batadv_uev_action {
 125         BATADV_UEV_ADD = 0,
 126         BATADV_UEV_DEL,
 127         BATADV_UEV_CHANGE,
 128 };
 129
 130 enum batadv_uev_type {
 131         BATADV_UEV_GW = 0,
 132 };
 133
 134 #define BATADV_GW_THRESHOLD     50
 135
 136 #define BATADV_DAT_CANDIDATE_NOT_FOUND  0
 137 #define BATADV_DAT_CANDIDATE_ORIG       1
 138
 139 /* Debug Messages */
 140 #ifdef pr_fmt
 141 #undef pr_fmt
 142 #endif
 143 /* Append 'batman-adv: ' before kernel messages */
 144 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
 145
 146 /* Kernel headers */
 147
 148 #include <linux/mutex.h>        /* mutex */
 149 #include <linux/module.h>       /* needed by all modules */
 150 #include <linux/netdevice.h>    /* netdevice */
 151 #include <linux/etherdevice.h>  /* ethernet address classification */
 152 #include <linux/if_ether.h>     /* ethernet header */
 153 #include <linux/poll.h>         /* poll_table */
 154 #include <linux/kthread.h>      /* kernel threads */
 155 #include <linux/pkt_sched.h>    /* schedule types */
 156 #include <linux/workqueue.h>    /* workqueue */
 157 #include <linux/percpu.h>
 158 #include <linux/slab.h>
 159 #include <net/sock.h>           /* struct sock */
 160 #include <net/rtnetlink.h>
 161 #include <linux/jiffies.h>
 162 #include <linux/seq_file.h>
 163 #include "types.h"
 164
 165 /**
 166  * batadv_vlan_flags - flags for the four MSB of any vlan ID field
 167  * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not
 168  */
 169 enum batadv_vlan_flags {
 170         BATADV_VLAN_HAS_TAG     = BIT(15),
 171 };
 172
 173 #define BATADV_PRINT_VID(vid) (vid & BATADV_VLAN_HAS_TAG ? \
 174                                (int)(vid & VLAN_VID_MASK) : -1)
 175
 176 extern char batadv_routing_algo[];
 177 extern struct list_head batadv_hardif_list;
 178
 179 extern unsigned char batadv_broadcast_addr[];
 180 extern struct workqueue_struct *batadv_event_workqueue;
 181
 182 int batadv_mesh_init(struct net_device *soft_iface);
 183 void batadv_mesh_free(struct net_device *soft_iface);
 184 int batadv_is_my_mac(struct batadv_priv *bat_priv, const uint8_t *addr);
 185 struct batadv_hard_iface *
 186 batadv_seq_print_text_primary_if_get(struct seq_file *seq);
 187 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
 188                            struct packet_type *ptype,
 189                            struct net_device *orig_dev);
 190 int
 191 batadv_recv_handler_register(uint8_t packet_type,
 192                              int (*recv_handler)(struct sk_buff *,
 193                                                  struct batadv_hard_iface *));
 194 void batadv_recv_handler_unregister(uint8_t packet_type);
 195 int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops);
 196 int batadv_algo_select(struct batadv_priv *bat_priv, char *name);
 197 int batadv_algo_seq_print_text(struct seq_file *seq, void *offset);
 198 __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr);
 199
 200 /**
 201  * enum batadv_dbg_level - available log levels
 202  * @BATADV_DBG_BATMAN: OGM and TQ computations related messages
 203  * @BATADV_DBG_ROUTES: route added / changed / deleted
 204  * @BATADV_DBG_TT: translation table messages
 205  * @BATADV_DBG_BLA: bridge loop avoidance messages
 206  * @BATADV_DBG_DAT: ARP snooping and DAT related messages
 207  * @BATADV_DBG_NC: network coding related messages
 208  * @BATADV_DBG_ALL: the union of all the above log levels
 209  */
 210 enum batadv_dbg_level {
 211         BATADV_DBG_BATMAN = BIT(0),
 212         BATADV_DBG_ROUTES = BIT(1),
 213         BATADV_DBG_TT     = BIT(2),
 214         BATADV_DBG_BLA    = BIT(3),
 215         BATADV_DBG_DAT    = BIT(4),
 216         BATADV_DBG_NC     = BIT(5),
 217         BATADV_DBG_ALL    = 63,
 218 };
 219
 220 #ifdef CONFIG_BATMAN_ADV_DEBUG
 221 int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
 222 __printf(2, 3);
 223
 224 #define batadv_dbg(type, bat_priv, fmt, arg...)                 \
 225         do {                                                    \
 226                 if (atomic_read(&bat_priv->log_level) & type)   \
 227                         batadv_debug_log(bat_priv, fmt, ## arg);\
 228         }                                                       \
 229         while (0)
 230 #else /* !CONFIG_BATMAN_ADV_DEBUG */
 231 __printf(3, 4)
 232 static inline void batadv_dbg(int type __always_unused,
 233                               struct batadv_priv *bat_priv __always_unused,
 234                               const char *fmt __always_unused, ...)
 235 {
 236 }
 237 #endif
 238
 239 #define batadv_info(net_dev, fmt, arg...)                               \
 240         do {                                                            \
 241                 struct net_device *_netdev = (net_dev);                 \
 242                 struct batadv_priv *_batpriv = netdev_priv(_netdev);    \
 243                 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg);      \
 244                 pr_info("%s: " fmt, _netdev->name, ## arg);             \
 245         } while (0)
 246 #define batadv_err(net_dev, fmt, arg...)                                \
 247         do {                                                            \
 248                 struct net_device *_netdev = (net_dev);                 \
 249                 struct batadv_priv *_batpriv = netdev_priv(_netdev);    \
 250                 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg);      \
 251                 pr_err("%s: " fmt, _netdev->name, ## arg);              \
 252         } while (0)
 253
 254 /* returns 1 if they are the same ethernet addr
 255  *
 256  * note: can't use compare_ether_addr() as it requires aligned memory
 257  */
 258 static inline int batadv_compare_eth(const void *data1, const void *data2)
 259 {
 260         return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0);
 261 }
 262
 263 /**
 264  * has_timed_out - compares current time (jiffies) and timestamp + timeout
 265  * @timestamp:          base value to compare with (in jiffies)
 266  * @timeout:            added to base value before comparing (in milliseconds)
 267  *
 268  * Returns true if current time is after timestamp + timeout
 269  */
 270 static inline bool batadv_has_timed_out(unsigned long timestamp,
 271                                         unsigned int timeout)
 272 {
 273         return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout));
 274 }
 275
 276 #define batadv_atomic_dec_not_zero(v)   atomic_add_unless((v), -1, 0)
 277
 278 /* Returns the smallest signed integer in two's complement with the sizeof x */
 279 #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u)))
 280
 281 /* Checks if a sequence number x is a predecessor/successor of y.
 282  * they handle overflows/underflows and can correctly check for a
 283  * predecessor/successor unless the variable sequence number has grown by
 284  * more then 2**(bitwidth(x)-1)-1.
 285  * This means that for a uint8_t with the maximum value 255, it would think:
 286  *  - when adding nothing - it is neither a predecessor nor a successor
 287  *  - before adding more than 127 to the starting value - it is a predecessor,
 288  *  - when adding 128 - it is neither a predecessor nor a successor,
 289  *  - after adding more than 127 to the starting value - it is a successor
 290  */
 291 #define batadv_seq_before(x, y) ({typeof(x) _d1 = (x); \
 292                                  typeof(y) _d2 = (y); \
 293                                  typeof(x) _dummy = (_d1 - _d2); \
 294                                  (void) (&_d1 == &_d2); \
 295                                  _dummy > batadv_smallest_signed_int(_dummy); })
 296 #define batadv_seq_after(x, y) batadv_seq_before(y, x)
 297
 298 /* Stop preemption on local cpu while incrementing the counter */
 299 static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx,
 300                                       size_t count)
 301 {
 302         this_cpu_add(bat_priv->bat_counters[idx], count);
 303 }
 304
 305 #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1)
 306
 307 /* Sum and return the cpu-local counters for index 'idx' */
 308 static inline uint64_t batadv_sum_counter(struct batadv_priv *bat_priv,
 309                                           size_t idx)
 310 {
 311         uint64_t *counters, sum = 0;
 312         int cpu;
 313
 314         for_each_possible_cpu(cpu) {
 315                 counters = per_cpu_ptr(bat_priv->bat_counters, cpu);
 316                 sum += counters[idx];
 317         }
 318
 319         return sum;
 320 }
 321
 322 /* Define a macro to reach the control buffer of the skb. The members of the
 323  * control buffer are defined in struct batadv_skb_cb in types.h.
 324  * The macro is inspired by the similar macro TCP_SKB_CB() in tcp.h.
 325  */
 326 #define BATADV_SKB_CB(__skb)       ((struct batadv_skb_cb *)&((__skb)->cb[0]))
 327
 328 #endif /* _NET_BATMAN_ADV_MAIN_H_ */