blob: ebd3f1d9d88954c296fba7ca03959cadc42ab223 [file] [log] [blame]
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +01001/*
Rui Paulo264d9b72009-11-09 23:46:58 +00002 * Copyright (c) 2008, 2009 open80211s Ltd.
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +01003 * Authors: Luis Carlos Cobo <luisca@cozybit.com>
4 * Javier Cardona <javier@cozybit.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 */
10
11#ifndef IEEE80211S_H
12#define IEEE80211S_H
13
Johannes Berg902acc72008-02-23 15:17:19 +010014#include <linux/types.h>
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010015#include <linux/jhash.h>
Al Virof375d552008-04-27 06:19:18 +010016#include <asm/unaligned.h>
Johannes Berg902acc72008-02-23 15:17:19 +010017#include "ieee80211_i.h"
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010018
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010019
20/* Data structures */
21
22/**
23 * enum mesh_path_flags - mac80211 mesh path flags
24 *
25 *
26 *
Rami Roseneb80ed82009-01-19 13:50:32 +020027 * @MESH_PATH_ACTIVE: the mesh path can be used for forwarding
28 * @MESH_PATH_RESOLVING: the discovery process is running for this mesh path
Rui Paulod19b3bf2009-11-09 23:46:55 +000029 * @MESH_PATH_SN_VALID: the mesh path contains a valid destination sequence
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010030 * number
31 * @MESH_PATH_FIXED: the mesh path has been manually set and should not be
32 * modified
33 * @MESH_PATH_RESOLVED: the mesh path can has been resolved
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010034 *
Rami Roseneb80ed82009-01-19 13:50:32 +020035 * MESH_PATH_RESOLVED is used by the mesh path timer to
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010036 * decide when to stop or cancel the mesh path discovery.
37 */
38enum mesh_path_flags {
39 MESH_PATH_ACTIVE = BIT(0),
40 MESH_PATH_RESOLVING = BIT(1),
Rui Paulod19b3bf2009-11-09 23:46:55 +000041 MESH_PATH_SN_VALID = BIT(2),
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010042 MESH_PATH_FIXED = BIT(3),
43 MESH_PATH_RESOLVED = BIT(4),
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010044};
45
46/**
Javier Cardona18889232009-08-10 12:15:52 -070047 * enum mesh_deferred_task_flags - mac80211 mesh deferred tasks
48 *
49 *
50 *
51 * @MESH_WORK_HOUSEKEEPING: run the periodic mesh housekeeping tasks
52 * @MESH_WORK_GROW_MPATH_TABLE: the mesh path table is full and needs
53 * to grow.
54 * @MESH_WORK_GROW_MPP_TABLE: the mesh portals table is full and needs to
55 * grow
Rui Pauloe304bfd2009-11-09 23:46:56 +000056 * @MESH_WORK_ROOT: the mesh root station needs to send a frame
Javier Cardona18889232009-08-10 12:15:52 -070057 */
58enum mesh_deferred_task_flags {
59 MESH_WORK_HOUSEKEEPING,
60 MESH_WORK_GROW_MPATH_TABLE,
61 MESH_WORK_GROW_MPP_TABLE,
Rui Pauloe304bfd2009-11-09 23:46:56 +000062 MESH_WORK_ROOT,
Javier Cardona18889232009-08-10 12:15:52 -070063};
64
65/**
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010066 * struct mesh_path - mac80211 mesh path structure
67 *
68 * @dst: mesh path destination mac address
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +120069 * @sdata: mesh subif
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010070 * @next_hop: mesh neighbor to which frames for this destination will be
71 * forwarded
72 * @timer: mesh path discovery timer
73 * @frame_queue: pending queue for frames sent to this destination while the
74 * path is unresolved
Rui Paulod19b3bf2009-11-09 23:46:55 +000075 * @sn: target sequence number
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010076 * @metric: current metric to this destination
77 * @hop_count: hops to destination
78 * @exp_time: in jiffies, when the path will expire or when it expired
79 * @discovery_timeout: timeout (lapse in jiffies) used for the last discovery
80 * retry
81 * @discovery_retries: number of discovery retries
82 * @flags: mesh path flags, as specified on &enum mesh_path_flags
Javier Cardonafe583432009-08-10 12:15:46 -070083 * @state_lock: mesh path state lock
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010084 *
85 *
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +120086 * The combination of dst and sdata is unique in the mesh path table. Since the
Johannes Bergd0709a62008-02-25 16:27:46 +010087 * next_hop STA is only protected by RCU as well, deleting the STA must also
88 * remove/substitute the mesh_path structure and wait until that is no longer
89 * reachable before destroying the STA completely.
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010090 */
91struct mesh_path {
92 u8 dst[ETH_ALEN];
YanBo79617de2008-09-22 13:30:32 +080093 u8 mpp[ETH_ALEN]; /* used for MPP or MAP */
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +120094 struct ieee80211_sub_if_data *sdata;
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010095 struct sta_info *next_hop;
96 struct timer_list timer;
97 struct sk_buff_head frame_queue;
98 struct rcu_head rcu;
Rui Paulod19b3bf2009-11-09 23:46:55 +000099 u32 sn;
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100100 u32 metric;
101 u8 hop_count;
102 unsigned long exp_time;
103 u32 discovery_timeout;
104 u8 discovery_retries;
105 enum mesh_path_flags flags;
106 spinlock_t state_lock;
107};
108
109/**
110 * struct mesh_table
111 *
112 * @hash_buckets: array of hash buckets of the table
113 * @hashwlock: array of locks to protect write operations, one per bucket
114 * @hash_mask: 2^size_order - 1, used to compute hash idx
115 * @hash_rnd: random value used for hash computations
116 * @entries: number of entries in the table
117 * @free_node: function to free nodes of the table
118 * @copy_node: fuction to copy nodes of the table
119 * @size_order: determines size of the table, there will be 2^size_order hash
120 * buckets
121 * @mean_chain_len: maximum average length for the hash buckets' list, if it is
122 * reached, the table will grow
123 */
124struct mesh_table {
125 /* Number of buckets will be 2^N */
126 struct hlist_head *hash_buckets;
127 spinlock_t *hashwlock; /* One per bucket, for add/del */
128 unsigned int hash_mask; /* (2^size_order) - 1 */
129 __u32 hash_rnd; /* Used for hash generation */
130 atomic_t entries; /* Up to MAX_MESH_NEIGHBOURS */
131 void (*free_node) (struct hlist_node *p, bool free_leafs);
Pavel Emelyanov4caf86c2008-05-07 19:47:01 +0400132 int (*copy_node) (struct hlist_node *p, struct mesh_table *newtbl);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100133 int size_order;
134 int mean_chain_len;
135};
136
137/* Recent multicast cache */
138/* RMC_BUCKETS must be a power of 2, maximum 256 */
139#define RMC_BUCKETS 256
140#define RMC_QUEUE_MAX_LEN 4
141#define RMC_TIMEOUT (3 * HZ)
142
143/**
144 * struct rmc_entry - entry in the Recent Multicast Cache
145 *
146 * @seqnum: mesh sequence number of the frame
147 * @exp_time: expiration time of the entry, in jiffies
148 * @sa: source address of the frame
149 *
150 * The Recent Multicast Cache keeps track of the latest multicast frames that
151 * have been received by a mesh interface and discards received multicast frames
152 * that are found in the cache.
153 */
154struct rmc_entry {
155 struct list_head list;
156 u32 seqnum;
157 unsigned long exp_time;
158 u8 sa[ETH_ALEN];
159};
160
161struct mesh_rmc {
162 struct rmc_entry bucket[RMC_BUCKETS];
Luis Carlos Cobo51cedda2008-04-23 12:15:29 -0700163 u32 idx_mask;
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100164};
165
166
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100167/*
168 * MESH_CFG_COMP_LEN Includes:
169 * - Active path selection protocol ID.
170 * - Active path selection metric ID.
171 * - Congestion control mode identifier.
172 * - Channel precedence.
173 * Does not include mesh capabilities, which may vary across nodes in the same
174 * mesh
175 */
Johannes Berg1239cd52008-10-28 11:12:57 +0100176#define MESH_CFG_CMP_LEN (IEEE80211_MESH_CONFIG_LEN - 2)
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100177
178/* Default values, timeouts in ms */
Rui Pauloa1935212009-11-09 23:46:40 +0000179#define MESH_TTL 31
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100180#define MESH_MAX_RETR 3
181#define MESH_RET_T 100
182#define MESH_CONF_T 100
183#define MESH_HOLD_T 100
184
185#define MESH_PATH_TIMEOUT 5000
186/* Minimum interval between two consecutive PREQs originated by the same
187 * interface
188 */
189#define MESH_PREQ_MIN_INT 10
190#define MESH_DIAM_TRAVERSAL_TIME 50
Javier Cardona7b324d22009-12-09 18:43:01 -0800191/* A path will be refreshed if it is used PATH_REFRESH_TIME milliseconds before
192 * timing out. This way it will remain ACTIVE and no data frames will be
193 * unnecesarily held in the pending queue.
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100194 */
195#define MESH_PATH_REFRESH_TIME 1000
196#define MESH_MIN_DISCOVERY_TIMEOUT (2 * MESH_DIAM_TRAVERSAL_TIME)
Javier Cardona5b365832009-08-10 12:15:51 -0700197#define MESH_DEFAULT_BEACON_INTERVAL 1000 /* in 1024 us units */
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100198
199#define MESH_MAX_PREQ_RETRIES 4
200#define MESH_PATH_EXPIRE (600 * HZ)
201
202/* Default maximum number of established plinks per interface */
203#define MESH_MAX_ESTAB_PLINKS 32
204
205/* Default maximum number of plinks per interface */
206#define MESH_MAX_PLINKS 256
207
208/* Maximum number of paths per interface */
209#define MESH_MAX_MPATHS 1024
210
211/* Pending ANA approval */
Rui Paulo095de012009-11-09 23:46:44 +0000212#define MESH_PATH_SEL_ACTION 0
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100213
Rui Paulod611f062009-11-09 23:46:50 +0000214/* PERR reason codes */
215#define PEER_RCODE_UNSPECIFIED 11
216#define PERR_RCODE_NO_ROUTE 12
217#define PERR_RCODE_DEST_UNREACH 13
218
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100219/* Public interfaces */
220/* Various */
Javier Cardona3c5772a2009-08-10 12:15:48 -0700221int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc,
Johannes Berg15ff6362009-11-17 13:34:04 +0100222 const u8 *da, const u8 *sa);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100223int ieee80211_new_mesh_header(struct ieee80211s_hdr *meshhdr,
Javier Cardona3c5772a2009-08-10 12:15:48 -0700224 struct ieee80211_sub_if_data *sdata, char *addr4,
225 char *addr5, char *addr6);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100226int mesh_rmc_check(u8 *addr, struct ieee80211s_hdr *mesh_hdr,
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200227 struct ieee80211_sub_if_data *sdata);
228bool mesh_matches_local(struct ieee802_11_elems *ie,
229 struct ieee80211_sub_if_data *sdata);
Johannes Berg472dbc42008-09-11 00:01:49 +0200230void mesh_ids_set_default(struct ieee80211_if_mesh *mesh);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200231void mesh_mgmt_ies_add(struct sk_buff *skb,
232 struct ieee80211_sub_if_data *sdata);
233void mesh_rmc_free(struct ieee80211_sub_if_data *sdata);
234int mesh_rmc_init(struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100235void ieee80211s_init(void);
Javier Cardonabfc32e62009-08-17 17:15:55 -0700236void ieee80211s_update_metric(struct ieee80211_local *local,
237 struct sta_info *stainfo, struct sk_buff *skb);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100238void ieee80211s_stop(void);
Johannes Berg902acc72008-02-23 15:17:19 +0100239void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata);
Johannes Berg472dbc42008-09-11 00:01:49 +0200240void ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata);
241void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata);
Rui Paulo63c57232009-11-09 23:46:57 +0000242void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh);
Johannes Berg902acc72008-02-23 15:17:19 +0100243
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100244/* Mesh paths */
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200245int mesh_nexthop_lookup(struct sk_buff *skb,
246 struct ieee80211_sub_if_data *sdata);
247void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata);
248struct mesh_path *mesh_path_lookup(u8 *dst,
249 struct ieee80211_sub_if_data *sdata);
YanBo79617de2008-09-22 13:30:32 +0800250struct mesh_path *mpp_path_lookup(u8 *dst,
251 struct ieee80211_sub_if_data *sdata);
252int mpp_path_add(u8 *dst, u8 *mpp, struct ieee80211_sub_if_data *sdata);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200253struct mesh_path *mesh_path_lookup_by_idx(int idx,
254 struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100255void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200256void mesh_path_expire(struct ieee80211_sub_if_data *sdata);
257void mesh_path_flush(struct ieee80211_sub_if_data *sdata);
258void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata,
259 struct ieee80211_mgmt *mgmt, size_t len);
260int mesh_path_add(u8 *dst, struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100261/* Mesh plinks */
Johannes Berg881d9482009-01-21 15:13:48 +0100262void mesh_neighbour_update(u8 *hw_addr, u32 rates,
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200263 struct ieee80211_sub_if_data *sdata, bool add);
264bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie);
Johannes Bergd0709a62008-02-25 16:27:46 +0100265void mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100266void mesh_plink_broken(struct sta_info *sta);
267void mesh_plink_deactivate(struct sta_info *sta);
268int mesh_plink_open(struct sta_info *sta);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100269void mesh_plink_block(struct sta_info *sta);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200270void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata,
271 struct ieee80211_mgmt *mgmt, size_t len,
272 struct ieee80211_rx_status *rx_status);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100273
274/* Private interfaces */
275/* Mesh tables */
276struct mesh_table *mesh_table_alloc(int size_order);
277void mesh_table_free(struct mesh_table *tbl, bool free_leafs);
Javier Cardona18889232009-08-10 12:15:52 -0700278void mesh_mpath_table_grow(void);
279void mesh_mpp_table_grow(void);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200280u32 mesh_table_hash(u8 *addr, struct ieee80211_sub_if_data *sdata,
281 struct mesh_table *tbl);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100282/* Mesh paths */
Rui Paulod19b3bf2009-11-09 23:46:55 +0000283int mesh_path_error_tx(u8 ttl, u8 *target, __le32 target_sn, __le16 target_rcode,
Johannes Berg15ff6362009-11-17 13:34:04 +0100284 const u8 *ra, struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100285void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta);
286void mesh_path_flush_pending(struct mesh_path *mpath);
287void mesh_path_tx_pending(struct mesh_path *mpath);
288int mesh_pathtbl_init(void);
289void mesh_pathtbl_unregister(void);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200290int mesh_path_del(u8 *addr, struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100291void mesh_path_timer(unsigned long data);
292void mesh_path_flush_by_nexthop(struct sta_info *sta);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200293void mesh_path_discard_frame(struct sk_buff *skb,
294 struct ieee80211_sub_if_data *sdata);
Johannes Berg5bb644a2009-05-17 11:40:42 +0200295void mesh_path_quiesce(struct ieee80211_sub_if_data *sdata);
296void mesh_path_restart(struct ieee80211_sub_if_data *sdata);
Rui Pauloe304bfd2009-11-09 23:46:56 +0000297void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100298
Johannes Bergf5ea9122009-08-07 16:17:38 +0200299extern int mesh_paths_generation;
300
Johannes Berg902acc72008-02-23 15:17:19 +0100301#ifdef CONFIG_MAC80211_MESH
302extern int mesh_allocated;
303
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100304static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata)
305{
Johannes Berg472dbc42008-09-11 00:01:49 +0200306 return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks -
307 atomic_read(&sdata->u.mesh.mshstats.estab_plinks);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100308}
309
310static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata)
311{
Johannes Bergd0709a62008-02-25 16:27:46 +0100312 return (min_t(long, mesh_plink_free_count(sdata),
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100313 MESH_MAX_PLINKS - sdata->local->num_sta)) > 0;
314}
315
316static inline void mesh_path_activate(struct mesh_path *mpath)
317{
318 mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED;
319}
320
321#define for_each_mesh_entry(x, p, node, i) \
322 for (i = 0; i <= x->hash_mask; i++) \
323 hlist_for_each_entry_rcu(node, p, &x->hash_buckets[i], list)
324
Johannes Berg472dbc42008-09-11 00:01:49 +0200325void ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local);
326
Johannes Berg5bb644a2009-05-17 11:40:42 +0200327void ieee80211_mesh_quiesce(struct ieee80211_sub_if_data *sdata);
328void ieee80211_mesh_restart(struct ieee80211_sub_if_data *sdata);
329void mesh_plink_quiesce(struct sta_info *sta);
330void mesh_plink_restart(struct sta_info *sta);
Johannes Berg902acc72008-02-23 15:17:19 +0100331#else
332#define mesh_allocated 0
Johannes Berg472dbc42008-09-11 00:01:49 +0200333static inline void
334ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local) {}
Johannes Berg5bb644a2009-05-17 11:40:42 +0200335static inline void ieee80211_mesh_quiesce(struct ieee80211_sub_if_data *sdata)
336{}
337static inline void ieee80211_mesh_restart(struct ieee80211_sub_if_data *sdata)
338{}
339static inline void mesh_plink_quiesce(struct sta_info *sta) {}
340static inline void mesh_plink_restart(struct sta_info *sta) {}
Johannes Berg902acc72008-02-23 15:17:19 +0100341#endif
342
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100343#endif /* IEEE80211S_H */