1 /* Copyright (C) 2007-2012 B.A.T.M.A.N. contributors:
3 * Marek Lindner, Simon Wunderlich
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.
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.
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
20 #ifndef _NET_BATMAN_ADV_MAIN_H_
21 #define _NET_BATMAN_ADV_MAIN_H_
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"
28 #ifndef BATADV_SOURCE_VERSION
29 #define BATADV_SOURCE_VERSION "2012.4.0"
32 /* B.A.T.M.A.N. parameters */
34 #define BATADV_TQ_MAX_VALUE 255
35 #define BATADV_JITTER 20
37 /* Time To Live of broadcast messages */
40 /* purge originators after time in seconds if no valid packet comes in
41 * -> TODO: check influence on BATADV_TQ_LOCAL_WINDOW_SIZE
43 #define BATADV_PURGE_TIMEOUT 200000 /* 200 seconds */
44 #define BATADV_TT_LOCAL_TIMEOUT 3600000 /* 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_DAT_ENTRY_TIMEOUT (5*60000) /* 5 mins in milliseconds */
48 /* sliding packet range of received originator messages in sequence numbers
49 * (should be a multiple of our word size)
51 #define BATADV_TQ_LOCAL_WINDOW_SIZE 64
52 /* milliseconds we have to keep pending tt_req */
53 #define BATADV_TT_REQUEST_TIMEOUT 3000
55 #define BATADV_TQ_GLOBAL_WINDOW_SIZE 5
56 #define BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM 1
57 #define BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM 1
58 #define BATADV_TQ_TOTAL_BIDRECT_LIMIT 1
60 /* number of OGMs sent with the last tt diff */
61 #define BATADV_TT_OGM_APPEND_MAX 3
63 /* Time in which a client can roam at most ROAMING_MAX_COUNT times in
66 #define BATADV_ROAMING_MAX_TIME 20000
67 #define BATADV_ROAMING_MAX_COUNT 5
69 #define BATADV_NO_FLAGS 0
71 #define BATADV_NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */
73 #define BATADV_NUM_WORDS BITS_TO_LONGS(BATADV_TQ_LOCAL_WINDOW_SIZE)
75 #define BATADV_LOG_BUF_LEN 8192 /* has to be a power of 2 */
77 /* msecs after which an ARP_REQUEST is sent in broadcast as fallback */
78 #define ARP_REQ_DELAY 250
79 /* numbers of originator to contact for any PUT/GET DHT operation */
80 #define BATADV_DAT_CANDIDATES_NUM 3
82 #define BATADV_VIS_INTERVAL 5000 /* 5 seconds */
84 /* how much worse secondary interfaces may be to be considered as bonding
87 #define BATADV_BONDING_TQ_THRESHOLD 50
89 /* should not be bigger than 512 bytes or change the size of
90 * forw_packet->direct_link_flags
92 #define BATADV_MAX_AGGREGATION_BYTES 512
93 #define BATADV_MAX_AGGREGATION_MS 100
95 #define BATADV_BLA_PERIOD_LENGTH 10000 /* 10 seconds */
96 #define BATADV_BLA_BACKBONE_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 3)
97 #define BATADV_BLA_CLAIM_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 10)
99 #define BATADV_DUPLIST_SIZE 16
100 #define BATADV_DUPLIST_TIMEOUT 500 /* 500 ms */
101 /* don't reset again within 30 seconds */
102 #define BATADV_RESET_PROTECTION_MS 30000
103 #define BATADV_EXPECTED_SEQNO_RANGE 65536
105 enum batadv_mesh_state {
106 BATADV_MESH_INACTIVE,
108 BATADV_MESH_DEACTIVATING,
111 #define BATADV_BCAST_QUEUE_LEN 256
112 #define BATADV_BATMAN_QUEUE_LEN 256
114 enum batadv_uev_action {
120 enum batadv_uev_type {
124 #define BATADV_GW_THRESHOLD 50
126 #define BATADV_DAT_CANDIDATE_NOT_FOUND 0
127 #define BATADV_DAT_CANDIDATE_ORIG 1
133 /* Append 'batman-adv: ' before kernel messages */
134 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
138 #include <linux/mutex.h> /* mutex */
139 #include <linux/module.h> /* needed by all modules */
140 #include <linux/netdevice.h> /* netdevice */
141 #include <linux/etherdevice.h> /* ethernet address classification */
142 #include <linux/if_ether.h> /* ethernet header */
143 #include <linux/poll.h> /* poll_table */
144 #include <linux/kthread.h> /* kernel threads */
145 #include <linux/pkt_sched.h> /* schedule types */
146 #include <linux/workqueue.h> /* workqueue */
147 #include <linux/percpu.h>
148 #include <linux/slab.h>
149 #include <net/sock.h> /* struct sock */
150 #include <linux/jiffies.h>
151 #include <linux/seq_file.h>
154 extern char batadv_routing_algo[];
155 extern struct list_head batadv_hardif_list;
157 extern unsigned char batadv_broadcast_addr[];
158 extern struct workqueue_struct *batadv_event_workqueue;
160 int batadv_mesh_init(struct net_device *soft_iface);
161 void batadv_mesh_free(struct net_device *soft_iface);
162 int batadv_is_my_mac(const uint8_t *addr);
163 struct batadv_hard_iface *
164 batadv_seq_print_text_primary_if_get(struct seq_file *seq);
165 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
166 struct packet_type *ptype,
167 struct net_device *orig_dev);
169 batadv_recv_handler_register(uint8_t packet_type,
170 int (*recv_handler)(struct sk_buff *,
171 struct batadv_hard_iface *));
172 void batadv_recv_handler_unregister(uint8_t packet_type);
173 int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops);
174 int batadv_algo_select(struct batadv_priv *bat_priv, char *name);
175 int batadv_algo_seq_print_text(struct seq_file *seq, void *offset);
178 * enum batadv_dbg_level - available log levels
179 * @BATADV_DBG_BATMAN: OGM and TQ computations related messages
180 * @BATADV_DBG_ROUTES: route added / changed / deleted
181 * @BATADV_DBG_TT: translation table messages
182 * @BATADV_DBG_BLA: bridge loop avoidance messages
183 * @BATADV_DBG_DAT: ARP snooping and DAT related messages
184 * @BATADV_DBG_ALL: the union of all the above log levels
186 enum batadv_dbg_level {
187 BATADV_DBG_BATMAN = BIT(0),
188 BATADV_DBG_ROUTES = BIT(1),
189 BATADV_DBG_TT = BIT(2),
190 BATADV_DBG_BLA = BIT(3),
191 BATADV_DBG_DAT = BIT(4),
195 #ifdef CONFIG_BATMAN_ADV_DEBUG
196 int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
199 #define batadv_dbg(type, bat_priv, fmt, arg...) \
201 if (atomic_read(&bat_priv->log_level) & type) \
202 batadv_debug_log(bat_priv, fmt, ## arg);\
205 #else /* !CONFIG_BATMAN_ADV_DEBUG */
207 static inline void batadv_dbg(int type __always_unused,
208 struct batadv_priv *bat_priv __always_unused,
209 const char *fmt __always_unused, ...)
214 #define batadv_info(net_dev, fmt, arg...) \
216 struct net_device *_netdev = (net_dev); \
217 struct batadv_priv *_batpriv = netdev_priv(_netdev); \
218 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \
219 pr_info("%s: " fmt, _netdev->name, ## arg); \
221 #define batadv_err(net_dev, fmt, arg...) \
223 struct net_device *_netdev = (net_dev); \
224 struct batadv_priv *_batpriv = netdev_priv(_netdev); \
225 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \
226 pr_err("%s: " fmt, _netdev->name, ## arg); \
229 /* returns 1 if they are the same ethernet addr
231 * note: can't use compare_ether_addr() as it requires aligned memory
233 static inline int batadv_compare_eth(const void *data1, const void *data2)
235 return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0);
239 * has_timed_out - compares current time (jiffies) and timestamp + timeout
240 * @timestamp: base value to compare with (in jiffies)
241 * @timeout: added to base value before comparing (in milliseconds)
243 * Returns true if current time is after timestamp + timeout
245 static inline bool batadv_has_timed_out(unsigned long timestamp,
246 unsigned int timeout)
248 return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout));
251 #define batadv_atomic_dec_not_zero(v) atomic_add_unless((v), -1, 0)
253 /* Returns the smallest signed integer in two's complement with the sizeof x */
254 #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u)))
256 /* Checks if a sequence number x is a predecessor/successor of y.
257 * they handle overflows/underflows and can correctly check for a
258 * predecessor/successor unless the variable sequence number has grown by
259 * more then 2**(bitwidth(x)-1)-1.
260 * This means that for a uint8_t with the maximum value 255, it would think:
261 * - when adding nothing - it is neither a predecessor nor a successor
262 * - before adding more than 127 to the starting value - it is a predecessor,
263 * - when adding 128 - it is neither a predecessor nor a successor,
264 * - after adding more than 127 to the starting value - it is a successor
266 #define batadv_seq_before(x, y) ({typeof(x) _d1 = (x); \
267 typeof(y) _d2 = (y); \
268 typeof(x) _dummy = (_d1 - _d2); \
269 (void) (&_d1 == &_d2); \
270 _dummy > batadv_smallest_signed_int(_dummy); })
271 #define batadv_seq_after(x, y) batadv_seq_before(y, x)
273 /* Stop preemption on local cpu while incrementing the counter */
274 static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx,
278 per_cpu_ptr(bat_priv->bat_counters, cpu)[idx] += count;
282 #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1)
284 /* Sum and return the cpu-local counters for index 'idx' */
285 static inline uint64_t batadv_sum_counter(struct batadv_priv *bat_priv,
288 uint64_t *counters, sum = 0;
291 for_each_possible_cpu(cpu) {
292 counters = per_cpu_ptr(bat_priv->bat_counters, cpu);
293 sum += counters[idx];
299 #endif /* _NET_BATMAN_ADV_MAIN_H_ */