net/batman-adv/main.h

   1 /* Copyright (C) 2007-2012 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 DRIVER_AUTHOR "Marek Lindner <lindner_marek@yahoo.de>, " \
  24                       "Simon Wunderlich <siwu@hrz.tu-chemnitz.de>"
  25 #define DRIVER_DESC   "B.A.T.M.A.N. advanced"
  26 #define DRIVER_DEVICE "batman-adv"
  27
  28 #ifndef SOURCE_VERSION
  29 #define SOURCE_VERSION "2012.3.0"
  30 #endif
  31
  32 /* B.A.T.M.A.N. parameters */
  33
  34 #define TQ_MAX_VALUE 255
  35 #define JITTER 20
  36
  37 /* Time To Live of broadcast messages */
  38 #define TTL 50
  39
  40 /* purge originators after time in seconds if no valid packet comes in
  41  * -> TODO: check influence on TQ_LOCAL_WINDOW_SIZE
  42  */
  43 #define PURGE_TIMEOUT 200000 /* 200 seconds */
  44 #define TT_LOCAL_TIMEOUT 3600000 /* in miliseconds */
  45 #define TT_CLIENT_ROAM_TIMEOUT 600000 /* in miliseconds */
  46 /* sliding packet range of received originator messages in sequence numbers
  47  * (should be a multiple of our word size)
  48  */
  49 #define TQ_LOCAL_WINDOW_SIZE 64
  50 /* miliseconds we have to keep pending tt_req */
  51 #define TT_REQUEST_TIMEOUT 3000
  52
  53 #define TQ_GLOBAL_WINDOW_SIZE 5
  54 #define TQ_LOCAL_BIDRECT_SEND_MINIMUM 1
  55 #define TQ_LOCAL_BIDRECT_RECV_MINIMUM 1
  56 #define TQ_TOTAL_BIDRECT_LIMIT 1
  57
  58 #define TT_OGM_APPEND_MAX 3 /* number of OGMs sent with the last tt diff */
  59
  60 /* Time in which a client can roam at most ROAMING_MAX_COUNT times in
  61  * miliseconds
  62  */
  63 #define ROAMING_MAX_TIME 20000
  64 #define ROAMING_MAX_COUNT 5
  65
  66 #define NO_FLAGS 0
  67
  68 #define NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */
  69
  70 #define NUM_WORDS BITS_TO_LONGS(TQ_LOCAL_WINDOW_SIZE)
  71
  72 #define LOG_BUF_LEN 8192          /* has to be a power of 2 */
  73
  74 #define VIS_INTERVAL 5000       /* 5 seconds */
  75
  76 /* how much worse secondary interfaces may be to be considered as bonding
  77  * candidates
  78  */
  79 #define BONDING_TQ_THRESHOLD    50
  80
  81 /* should not be bigger than 512 bytes or change the size of
  82  * forw_packet->direct_link_flags
  83  */
  84 #define MAX_AGGREGATION_BYTES 512
  85 #define MAX_AGGREGATION_MS 100
  86
  87 #define BLA_PERIOD_LENGTH       10000   /* 10 seconds */
  88 #define BLA_BACKBONE_TIMEOUT    (BLA_PERIOD_LENGTH * 3)
  89 #define BLA_CLAIM_TIMEOUT       (BLA_PERIOD_LENGTH * 10)
  90
  91 #define DUPLIST_SIZE            16
  92 #define DUPLIST_TIMEOUT         500     /* 500 ms */
  93 /* don't reset again within 30 seconds */
  94 #define RESET_PROTECTION_MS 30000
  95 #define EXPECTED_SEQNO_RANGE    65536
  96
  97 enum mesh_state {
  98         MESH_INACTIVE,
  99         MESH_ACTIVE,
 100         MESH_DEACTIVATING
 101 };
 102
 103 #define BCAST_QUEUE_LEN         256
 104 #define BATMAN_QUEUE_LEN        256
 105
 106 enum uev_action {
 107         UEV_ADD = 0,
 108         UEV_DEL,
 109         UEV_CHANGE
 110 };
 111
 112 enum uev_type {
 113         UEV_GW = 0
 114 };
 115
 116 #define GW_THRESHOLD    50
 117
 118 /* Debug Messages */
 119 #ifdef pr_fmt
 120 #undef pr_fmt
 121 #endif
 122 /* Append 'batman-adv: ' before kernel messages */
 123 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
 124
 125 /* all messages related to routing / flooding / broadcasting / etc */
 126 enum dbg_level {
 127         DBG_BATMAN = 1 << 0,
 128         DBG_ROUTES = 1 << 1, /* route added / changed / deleted */
 129         DBG_TT     = 1 << 2, /* translation table operations */
 130         DBG_BLA    = 1 << 3, /* bridge loop avoidance */
 131         DBG_ALL    = 15
 132 };
 133
 134 /* Kernel headers */
 135
 136 #include <linux/mutex.h>        /* mutex */
 137 #include <linux/module.h>       /* needed by all modules */
 138 #include <linux/netdevice.h>    /* netdevice */
 139 #include <linux/etherdevice.h>  /* ethernet address classification */
 140 #include <linux/if_ether.h>     /* ethernet header */
 141 #include <linux/poll.h>         /* poll_table */
 142 #include <linux/kthread.h>      /* kernel threads */
 143 #include <linux/pkt_sched.h>    /* schedule types */
 144 #include <linux/workqueue.h>    /* workqueue */
 145 #include <linux/percpu.h>
 146 #include <linux/slab.h>
 147 #include <net/sock.h>           /* struct sock */
 148 #include <linux/jiffies.h>
 149 #include <linux/seq_file.h>
 150 #include "types.h"
 151
 152 extern char batadv_routing_algo[];
 153 extern struct list_head batadv_hardif_list;
 154
 155 extern unsigned char batadv_broadcast_addr[];
 156 extern struct workqueue_struct *batadv_event_workqueue;
 157
 158 int batadv_mesh_init(struct net_device *soft_iface);
 159 void batadv_mesh_free(struct net_device *soft_iface);
 160 void batadv_inc_module_count(void);
 161 void batadv_dec_module_count(void);
 162 int batadv_is_my_mac(const uint8_t *addr);
 163 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
 164                            struct packet_type *ptype,
 165                            struct net_device *orig_dev);
 166 int batadv_recv_handler_register(uint8_t packet_type,
 167                                  int (*recv_handler)(struct sk_buff *,
 168                                                      struct hard_iface *));
 169 void batadv_recv_handler_unregister(uint8_t packet_type);
 170 int batadv_algo_register(struct bat_algo_ops *bat_algo_ops);
 171 int batadv_algo_select(struct bat_priv *bat_priv, char *name);
 172 int batadv_algo_seq_print_text(struct seq_file *seq, void *offset);
 173
 174 #ifdef CONFIG_BATMAN_ADV_DEBUG
 175 int batadv_debug_log(struct bat_priv *bat_priv, const char *fmt, ...)
 176 __printf(2, 3);
 177
 178 #define batadv_dbg(type, bat_priv, fmt, arg...)                 \
 179         do {                                                    \
 180                 if (atomic_read(&bat_priv->log_level) & type)   \
 181                         batadv_debug_log(bat_priv, fmt, ## arg);\
 182         }                                                       \
 183         while (0)
 184 #else /* !CONFIG_BATMAN_ADV_DEBUG */
 185 __printf(3, 4)
 186 static inline void batadv_dbg(int type __always_unused,
 187                               struct bat_priv *bat_priv __always_unused,
 188                               const char *fmt __always_unused, ...)
 189 {
 190 }
 191 #endif
 192
 193 #define batadv_info(net_dev, fmt, arg...)                               \
 194         do {                                                            \
 195                 struct net_device *_netdev = (net_dev);                 \
 196                 struct bat_priv *_batpriv = netdev_priv(_netdev);       \
 197                 batadv_dbg(DBG_ALL, _batpriv, fmt, ## arg);             \
 198                 pr_info("%s: " fmt, _netdev->name, ## arg);             \
 199         } while (0)
 200 #define batadv_err(net_dev, fmt, arg...)                                \
 201         do {                                                            \
 202                 struct net_device *_netdev = (net_dev);                 \
 203                 struct bat_priv *_batpriv = netdev_priv(_netdev);       \
 204                 batadv_dbg(DBG_ALL, _batpriv, fmt, ## arg);             \
 205                 pr_err("%s: " fmt, _netdev->name, ## arg);              \
 206         } while (0)
 207
 208 /* returns 1 if they are the same ethernet addr
 209  *
 210  * note: can't use compare_ether_addr() as it requires aligned memory
 211  */
 212 static inline int batadv_compare_eth(const void *data1, const void *data2)
 213 {
 214         return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0);
 215 }
 216
 217 /* has_timed_out - compares current time (jiffies) and timestamp + timeout
 218  * @timestamp:          base value to compare with (in jiffies)
 219  * @timeout:            added to base value before comparing (in milliseconds)
 220  *
 221  * Returns true if current time is after timestamp + timeout
 222  */
 223 static inline bool batadv_has_timed_out(unsigned long timestamp,
 224                                         unsigned int timeout)
 225 {
 226         return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout));
 227 }
 228
 229 #define batadv_atomic_dec_not_zero(v)   atomic_add_unless((v), -1, 0)
 230
 231 /* Returns the smallest signed integer in two's complement with the sizeof x */
 232 #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u)))
 233
 234 /* Checks if a sequence number x is a predecessor/successor of y.
 235  * they handle overflows/underflows and can correctly check for a
 236  * predecessor/successor unless the variable sequence number has grown by
 237  * more then 2**(bitwidth(x)-1)-1.
 238  * This means that for a uint8_t with the maximum value 255, it would think:
 239  *  - when adding nothing - it is neither a predecessor nor a successor
 240  *  - before adding more than 127 to the starting value - it is a predecessor,
 241  *  - when adding 128 - it is neither a predecessor nor a successor,
 242  *  - after adding more than 127 to the starting value - it is a successor
 243  */
 244 #define batadv_seq_before(x, y) ({typeof(x) _d1 = (x); \
 245                                  typeof(y) _d2 = (y); \
 246                                  typeof(x) _dummy = (_d1 - _d2); \
 247                                  (void) (&_d1 == &_d2); \
 248                                  _dummy > batadv_smallest_signed_int(_dummy); })
 249 #define batadv_seq_after(x, y) batadv_seq_before(y, x)
 250
 251 /* Stop preemption on local cpu while incrementing the counter */
 252 static inline void batadv_add_counter(struct bat_priv *bat_priv, size_t idx,
 253                                       size_t count)
 254 {
 255         int cpu = get_cpu();
 256         per_cpu_ptr(bat_priv->bat_counters, cpu)[idx] += count;
 257         put_cpu();
 258 }
 259
 260 #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1)
 261
 262 /* Sum and return the cpu-local counters for index 'idx' */
 263 static inline uint64_t batadv_sum_counter(struct bat_priv *bat_priv, size_t idx)
 264 {
 265         uint64_t *counters;
 266         int cpu;
 267         int sum = 0;
 268
 269         for_each_possible_cpu(cpu) {
 270                 counters = per_cpu_ptr(bat_priv->bat_counters, cpu);
 271                 sum += counters[idx];
 272         }
 273
 274         return sum;
 275 }
 276
 277 #endif /* _NET_BATMAN_ADV_MAIN_H_ */