net/batman-adv/main.h

   1 /*
   2  * Copyright (C) 2007-2011 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 #define SOURCE_VERSION "next"
  31
  32
  33 /* B.A.T.M.A.N. parameters */
  34
  35 #define TQ_MAX_VALUE 255
  36 #define JITTER 20
  37
  38  /* Time To Live of broadcast messages */
  39 #define TTL 50
  40
  41 /* purge originators after time in seconds if no valid packet comes in
  42  * -> TODO: check influence on TQ_LOCAL_WINDOW_SIZE */
  43 #define PURGE_TIMEOUT 200
  44 #define TT_LOCAL_TIMEOUT 3600 /* in seconds */
  45
  46 /* sliding packet range of received originator messages in squence numbers
  47  * (should be a multiple of our word size) */
  48 #define TQ_LOCAL_WINDOW_SIZE 64
  49 #define TQ_GLOBAL_WINDOW_SIZE 5
  50 #define TQ_LOCAL_BIDRECT_SEND_MINIMUM 1
  51 #define TQ_LOCAL_BIDRECT_RECV_MINIMUM 1
  52 #define TQ_TOTAL_BIDRECT_LIMIT 1
  53
  54 #define NUM_WORDS (TQ_LOCAL_WINDOW_SIZE / WORD_BIT_SIZE)
  55
  56 #define LOG_BUF_LEN 8192          /* has to be a power of 2 */
  57
  58 #define VIS_INTERVAL 5000       /* 5 seconds */
  59
  60 /* how much worse secondary interfaces may be to be considered as bonding
  61  * candidates */
  62 #define BONDING_TQ_THRESHOLD    50
  63
  64 /* should not be bigger than 512 bytes or change the size of
  65  * forw_packet->direct_link_flags */
  66 #define MAX_AGGREGATION_BYTES 512
  67 #define MAX_AGGREGATION_MS 100
  68
  69 #define SOFTIF_NEIGH_TIMEOUT 180000 /* 3 minutes */
  70
  71 /* don't reset again within 30 seconds */
  72 #define RESET_PROTECTION_MS 30000
  73 #define EXPECTED_SEQNO_RANGE    65536
  74
  75 #define MESH_INACTIVE 0
  76 #define MESH_ACTIVE 1
  77 #define MESH_DEACTIVATING 2
  78
  79 #define BCAST_QUEUE_LEN         256
  80 #define BATMAN_QUEUE_LEN        256
  81
  82 /*
  83  * Debug Messages
  84  */
  85 #ifdef pr_fmt
  86 #undef pr_fmt
  87 #endif
  88 /* Append 'batman-adv: ' before kernel messages */
  89 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  90
  91 /* all messages related to routing / flooding / broadcasting / etc */
  92 #define DBG_BATMAN 1
  93 /* route or tt entry added / changed / deleted */
  94 #define DBG_ROUTES 2
  95 #define DBG_ALL 3
  96
  97
  98 /*
  99  *  Vis
 100  */
 101
 102 /*
 103  * Kernel headers
 104  */
 105
 106 #include <linux/mutex.h>        /* mutex */
 107 #include <linux/module.h>       /* needed by all modules */
 108 #include <linux/netdevice.h>    /* netdevice */
 109 #include <linux/etherdevice.h>  /* ethernet address classifaction */
 110 #include <linux/if_ether.h>     /* ethernet header */
 111 #include <linux/poll.h>         /* poll_table */
 112 #include <linux/kthread.h>      /* kernel threads */
 113 #include <linux/pkt_sched.h>    /* schedule types */
 114 #include <linux/workqueue.h>    /* workqueue */
 115 #include <linux/slab.h>
 116 #include <net/sock.h>           /* struct sock */
 117 #include <linux/jiffies.h>
 118 #include <linux/seq_file.h>
 119 #include "types.h"
 120
 121 #ifndef REVISION_VERSION
 122 #define REVISION_VERSION_STR ""
 123 #else
 124 #define REVISION_VERSION_STR " "REVISION_VERSION
 125 #endif
 126
 127 extern struct list_head hardif_list;
 128
 129 extern unsigned char broadcast_addr[];
 130 extern struct workqueue_struct *bat_event_workqueue;
 131
 132 int mesh_init(struct net_device *soft_iface);
 133 void mesh_free(struct net_device *soft_iface);
 134 void inc_module_count(void);
 135 void dec_module_count(void);
 136 int is_my_mac(uint8_t *addr);
 137
 138 #ifdef CONFIG_BATMAN_ADV_DEBUG
 139 int debug_log(struct bat_priv *bat_priv, char *fmt, ...);
 140
 141 #define bat_dbg(type, bat_priv, fmt, arg...)                    \
 142         do {                                                    \
 143                 if (atomic_read(&bat_priv->log_level) & type)   \
 144                         debug_log(bat_priv, fmt, ## arg);       \
 145         }                                                       \
 146         while (0)
 147 #else /* !CONFIG_BATMAN_ADV_DEBUG */
 148 static inline void bat_dbg(char type __always_unused,
 149                            struct bat_priv *bat_priv __always_unused,
 150                            char *fmt __always_unused, ...)
 151 {
 152 }
 153 #endif
 154
 155 #define bat_info(net_dev, fmt, arg...)                                  \
 156         do {                                                            \
 157                 struct net_device *_netdev = (net_dev);                 \
 158                 struct bat_priv *_batpriv = netdev_priv(_netdev);       \
 159                 bat_dbg(DBG_ALL, _batpriv, fmt, ## arg);                \
 160                 pr_info("%s: " fmt, _netdev->name, ## arg);             \
 161         } while (0)
 162 #define bat_err(net_dev, fmt, arg...)                                   \
 163         do {                                                            \
 164                 struct net_device *_netdev = (net_dev);                 \
 165                 struct bat_priv *_batpriv = netdev_priv(_netdev);       \
 166                 bat_dbg(DBG_ALL, _batpriv, fmt, ## arg);                \
 167                 pr_err("%s: " fmt, _netdev->name, ## arg);              \
 168         } while (0)
 169
 170 /**
 171  * returns 1 if they are the same ethernet addr
 172  *
 173  * note: can't use compare_ether_addr() as it requires aligned memory
 174  */
 175 static inline int compare_eth(void *data1, void *data2)
 176 {
 177         return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0);
 178 }
 179
 180 #define atomic_dec_not_zero(v)  atomic_add_unless((v), -1, 0)
 181
 182 #endif /* _NET_BATMAN_ADV_MAIN_H_ */