net/batman-adv/main.h

   1 /*
   2  * Copyright (C) 2007-2012 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, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18  * 02110-1301, USA
  19  *
  20  */
  21
  22 #ifndef _NET_BATMAN_ADV_MAIN_H_
  23 #define _NET_BATMAN_ADV_MAIN_H_
  24
  25 #define DRIVER_AUTHOR "Marek Lindner <lindner_marek@yahoo.de>, " \
  26                       "Simon Wunderlich <siwu@hrz.tu-chemnitz.de>"
  27 #define DRIVER_DESC   "B.A.T.M.A.N. advanced"
  28 #define DRIVER_DEVICE "batman-adv"
  29
  30 #ifndef SOURCE_VERSION
  31 #define SOURCE_VERSION "2012.1.0"
  32 #endif
  33
  34 /* B.A.T.M.A.N. parameters */
  35
  36 #define TQ_MAX_VALUE 255
  37 #define JITTER 20
  38
  39  /* Time To Live of broadcast messages */
  40 #define TTL 50
  41
  42 /* purge originators after time in seconds if no valid packet comes in
  43  * -> TODO: check influence on TQ_LOCAL_WINDOW_SIZE */
  44 #define PURGE_TIMEOUT 200000 /* 200 seconds */
  45 #define TT_LOCAL_TIMEOUT 3600000 /* in miliseconds */
  46 #define TT_CLIENT_ROAM_TIMEOUT 600000 /* in miliseconds */
  47 /* sliding packet range of received originator messages in sequence numbers
  48  * (should be a multiple of our word size) */
  49 #define TQ_LOCAL_WINDOW_SIZE 64
  50 #define TT_REQUEST_TIMEOUT 3000 /* miliseconds we have to keep
  51                                  * pending tt_req */
  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 #define ROAMING_MAX_TIME 20000 /* Time in which a client can roam at most
  61                                 * ROAMING_MAX_COUNT times in miliseconds*/
  62 #define ROAMING_MAX_COUNT 5
  63
  64 #define NO_FLAGS 0
  65
  66 #define NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */
  67
  68 #define NUM_WORDS (TQ_LOCAL_WINDOW_SIZE / WORD_BIT_SIZE)
  69
  70 #define LOG_BUF_LEN 8192          /* has to be a power of 2 */
  71
  72 #define VIS_INTERVAL 5000       /* 5 seconds */
  73
  74 /* how much worse secondary interfaces may be to be considered as bonding
  75  * candidates */
  76 #define BONDING_TQ_THRESHOLD    50
  77
  78 /* should not be bigger than 512 bytes or change the size of
  79  * forw_packet->direct_link_flags */
  80 #define MAX_AGGREGATION_BYTES 512
  81 #define MAX_AGGREGATION_MS 100
  82
  83 #define SOFTIF_NEIGH_TIMEOUT 180000 /* 3 minutes */
  84
  85 /* don't reset again within 30 seconds */
  86 #define RESET_PROTECTION_MS 30000
  87 #define EXPECTED_SEQNO_RANGE    65536
  88
  89 enum mesh_state {
  90         MESH_INACTIVE,
  91         MESH_ACTIVE,
  92         MESH_DEACTIVATING
  93 };
  94
  95 #define BCAST_QUEUE_LEN         256
  96 #define BATMAN_QUEUE_LEN        256
  97
  98 enum uev_action {
  99         UEV_ADD = 0,
 100         UEV_DEL,
 101         UEV_CHANGE
 102 };
 103
 104 enum uev_type {
 105         UEV_GW = 0
 106 };
 107
 108 #define GW_THRESHOLD    50
 109
 110 /* Debug Messages */
 111 #ifdef pr_fmt
 112 #undef pr_fmt
 113 #endif
 114 /* Append 'batman-adv: ' before kernel messages */
 115 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
 116
 117 /* all messages related to routing / flooding / broadcasting / etc */
 118 enum dbg_level {
 119         DBG_BATMAN = 1 << 0,
 120         DBG_ROUTES = 1 << 1, /* route added / changed / deleted */
 121         DBG_TT     = 1 << 2, /* translation table operations */
 122         DBG_ALL    = 7
 123 };
 124
 125 /* Kernel headers */
 126
 127 #include <linux/mutex.h>        /* mutex */
 128 #include <linux/module.h>       /* needed by all modules */
 129 #include <linux/netdevice.h>    /* netdevice */
 130 #include <linux/etherdevice.h>  /* ethernet address classification */
 131 #include <linux/if_ether.h>     /* ethernet header */
 132 #include <linux/poll.h>         /* poll_table */
 133 #include <linux/kthread.h>      /* kernel threads */
 134 #include <linux/pkt_sched.h>    /* schedule types */
 135 #include <linux/workqueue.h>    /* workqueue */
 136 #include <linux/slab.h>
 137 #include <net/sock.h>           /* struct sock */
 138 #include <linux/jiffies.h>
 139 #include <linux/seq_file.h>
 140 #include "types.h"
 141
 142 extern char bat_routing_algo[];
 143 extern struct list_head hardif_list;
 144
 145 extern unsigned char broadcast_addr[];
 146 extern struct workqueue_struct *bat_event_workqueue;
 147
 148 int mesh_init(struct net_device *soft_iface);
 149 void mesh_free(struct net_device *soft_iface);
 150 void inc_module_count(void);
 151 void dec_module_count(void);
 152 int is_my_mac(const uint8_t *addr);
 153 int bat_algo_register(struct bat_algo_ops *bat_algo_ops);
 154 int bat_algo_select(struct bat_priv *bat_priv, char *name);
 155 int bat_algo_seq_print_text(struct seq_file *seq, void *offset);
 156
 157 #ifdef CONFIG_BATMAN_ADV_DEBUG
 158 int debug_log(struct bat_priv *bat_priv, const char *fmt, ...) __printf(2, 3);
 159
 160 #define bat_dbg(type, bat_priv, fmt, arg...)                    \
 161         do {                                                    \
 162                 if (atomic_read(&bat_priv->log_level) & type)   \
 163                         debug_log(bat_priv, fmt, ## arg);       \
 164         }                                                       \
 165         while (0)
 166 #else /* !CONFIG_BATMAN_ADV_DEBUG */
 167 __printf(3, 4)
 168 static inline void bat_dbg(int type __always_unused,
 169                            struct bat_priv *bat_priv __always_unused,
 170                            const char *fmt __always_unused, ...)
 171 {
 172 }
 173 #endif
 174
 175 #define bat_info(net_dev, fmt, arg...)                                  \
 176         do {                                                            \
 177                 struct net_device *_netdev = (net_dev);                 \
 178                 struct bat_priv *_batpriv = netdev_priv(_netdev);       \
 179                 bat_dbg(DBG_ALL, _batpriv, fmt, ## arg);                \
 180                 pr_info("%s: " fmt, _netdev->name, ## arg);             \
 181         } while (0)
 182 #define bat_err(net_dev, fmt, arg...)                                   \
 183         do {                                                            \
 184                 struct net_device *_netdev = (net_dev);                 \
 185                 struct bat_priv *_batpriv = netdev_priv(_netdev);       \
 186                 bat_dbg(DBG_ALL, _batpriv, fmt, ## arg);                \
 187                 pr_err("%s: " fmt, _netdev->name, ## arg);              \
 188         } while (0)
 189
 190 /**
 191  * returns 1 if they are the same ethernet addr
 192  *
 193  * note: can't use compare_ether_addr() as it requires aligned memory
 194  */
 195
 196 static inline int compare_eth(const void *data1, const void *data2)
 197 {
 198         return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0);
 199 }
 200
 201 /**
 202  * has_timed_out - compares current time (jiffies) and timestamp + timeout
 203  * @timestamp:          base value to compare with (in jiffies)
 204  * @timeout:            added to base value before comparing (in milliseconds)
 205  *
 206  * Returns true if current time is after timestamp + timeout
 207  */
 208 static inline bool has_timed_out(unsigned long timestamp, unsigned int timeout)
 209 {
 210         return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout));
 211 }
 212
 213 #define atomic_dec_not_zero(v)  atomic_add_unless((v), -1, 0)
 214
 215 /* Returns the smallest signed integer in two's complement with the sizeof x */
 216 #define smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u)))
 217
 218 /* Checks if a sequence number x is a predecessor/successor of y.
 219  * they handle overflows/underflows and can correctly check for a
 220  * predecessor/successor unless the variable sequence number has grown by
 221  * more then 2**(bitwidth(x)-1)-1.
 222  * This means that for a uint8_t with the maximum value 255, it would think:
 223  *  - when adding nothing - it is neither a predecessor nor a successor
 224  *  - before adding more than 127 to the starting value - it is a predecessor,
 225  *  - when adding 128 - it is neither a predecessor nor a successor,
 226  *  - after adding more than 127 to the starting value - it is a successor */
 227 #define seq_before(x, y) ({typeof(x) _d1 = (x); \
 228                           typeof(y) _d2 = (y); \
 229                           typeof(x) _dummy = (_d1 - _d2); \
 230                           (void) (&_d1 == &_d2); \
 231                           _dummy > smallest_signed_int(_dummy); })
 232 #define seq_after(x, y) seq_before(y, x)
 233
 234 #endif /* _NET_BATMAN_ADV_MAIN_H_ */