mac80211: refactor mesh peer initialization
[deliverable/linux.git] / net / mac80211 / mesh.h
CommitLineData
ccf80ddf 1/*
264d9b7d 2 * Copyright (c) 2008, 2009 open80211s Ltd.
ccf80ddf
LCC
3 * 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
902acc78 14#include <linux/types.h>
ccf80ddf 15#include <linux/jhash.h>
902acc78 16#include "ieee80211_i.h"
ccf80ddf 17
ccf80ddf
LCC
18
19/* Data structures */
20
dbf498fb
JC
21/**
22 * enum mesh_config_capab_flags - mesh config IE capability flags
23 *
24 * @MESHCONF_CAPAB_ACCEPT_PLINKS: STA is willing to establish
25 * additional mesh peerings with other mesh STAs
26 * @MESHCONF_CAPAB_FORWARDING: the STA forwards MSDUs
27 * @MESHCONF_CAPAB_TBTT_ADJUSTING: TBTT adjustment procedure is ongoing
28 */
29enum mesh_config_capab_flags {
30 MESHCONF_CAPAB_ACCEPT_PLINKS = BIT(0),
31 MESHCONF_CAPAB_FORWARDING = BIT(3),
32 MESHCONF_CAPAB_TBTT_ADJUSTING = BIT(5),
33};
34
ccf80ddf
LCC
35/**
36 * enum mesh_path_flags - mac80211 mesh path flags
37 *
38 *
39 *
eb80ed8d
RR
40 * @MESH_PATH_ACTIVE: the mesh path can be used for forwarding
41 * @MESH_PATH_RESOLVING: the discovery process is running for this mesh path
d19b3bf6 42 * @MESH_PATH_SN_VALID: the mesh path contains a valid destination sequence
ccf80ddf
LCC
43 * number
44 * @MESH_PATH_FIXED: the mesh path has been manually set and should not be
45 * modified
46 * @MESH_PATH_RESOLVED: the mesh path can has been resolved
f3011cf9
JC
47 * @MESH_PATH_REQ_QUEUED: there is an unsent path request for this destination
48 * already queued up, waiting for the discovery process to start.
ccf80ddf 49 *
eb80ed8d 50 * MESH_PATH_RESOLVED is used by the mesh path timer to
ccf80ddf
LCC
51 * decide when to stop or cancel the mesh path discovery.
52 */
53enum mesh_path_flags {
54 MESH_PATH_ACTIVE = BIT(0),
55 MESH_PATH_RESOLVING = BIT(1),
d19b3bf6 56 MESH_PATH_SN_VALID = BIT(2),
ccf80ddf
LCC
57 MESH_PATH_FIXED = BIT(3),
58 MESH_PATH_RESOLVED = BIT(4),
f3011cf9 59 MESH_PATH_REQ_QUEUED = BIT(5),
ccf80ddf
LCC
60};
61
18889231
JC
62/**
63 * enum mesh_deferred_task_flags - mac80211 mesh deferred tasks
64 *
65 *
66 *
67 * @MESH_WORK_HOUSEKEEPING: run the periodic mesh housekeeping tasks
68 * @MESH_WORK_GROW_MPATH_TABLE: the mesh path table is full and needs
69 * to grow.
70 * @MESH_WORK_GROW_MPP_TABLE: the mesh portals table is full and needs to
71 * grow
e304bfd3 72 * @MESH_WORK_ROOT: the mesh root station needs to send a frame
dbf498fb
JC
73 * @MESH_WORK_DRIFT_ADJUST: time to compensate for clock drift relative to other
74 * mesh nodes
18889231
JC
75 */
76enum mesh_deferred_task_flags {
77 MESH_WORK_HOUSEKEEPING,
78 MESH_WORK_GROW_MPATH_TABLE,
79 MESH_WORK_GROW_MPP_TABLE,
e304bfd3 80 MESH_WORK_ROOT,
dbf498fb 81 MESH_WORK_DRIFT_ADJUST,
18889231
JC
82};
83
ccf80ddf
LCC
84/**
85 * struct mesh_path - mac80211 mesh path structure
86 *
87 * @dst: mesh path destination mac address
f698d856 88 * @sdata: mesh subif
ccf80ddf
LCC
89 * @next_hop: mesh neighbor to which frames for this destination will be
90 * forwarded
91 * @timer: mesh path discovery timer
92 * @frame_queue: pending queue for frames sent to this destination while the
93 * path is unresolved
d19b3bf6 94 * @sn: target sequence number
ccf80ddf
LCC
95 * @metric: current metric to this destination
96 * @hop_count: hops to destination
97 * @exp_time: in jiffies, when the path will expire or when it expired
98 * @discovery_timeout: timeout (lapse in jiffies) used for the last discovery
99 * retry
100 * @discovery_retries: number of discovery retries
101 * @flags: mesh path flags, as specified on &enum mesh_path_flags
f5e50cd0
JC
102 * @state_lock: mesh path state lock used to protect changes to the
103 * mpath itself. No need to take this lock when adding or removing
104 * an mpath to a hash bucket on a path table.
3d045a54 105 * @rann_snd_addr: the RANN sender address
d2a079fd 106 * @rann_metric: the aggregated path metric towards the root node
3d045a54 107 * @is_root: the destination station of this path is a root node
5ee68e5b 108 * @is_gate: the destination station of this path is a mesh gate
ccf80ddf
LCC
109 *
110 *
f698d856 111 * The combination of dst and sdata is unique in the mesh path table. Since the
d0709a65
JB
112 * next_hop STA is only protected by RCU as well, deleting the STA must also
113 * remove/substitute the mesh_path structure and wait until that is no longer
114 * reachable before destroying the STA completely.
ccf80ddf
LCC
115 */
116struct mesh_path {
117 u8 dst[ETH_ALEN];
79617dee 118 u8 mpp[ETH_ALEN]; /* used for MPP or MAP */
f698d856 119 struct ieee80211_sub_if_data *sdata;
40b275b6 120 struct sta_info __rcu *next_hop;
ccf80ddf
LCC
121 struct timer_list timer;
122 struct sk_buff_head frame_queue;
123 struct rcu_head rcu;
d19b3bf6 124 u32 sn;
ccf80ddf
LCC
125 u32 metric;
126 u8 hop_count;
127 unsigned long exp_time;
128 u32 discovery_timeout;
129 u8 discovery_retries;
130 enum mesh_path_flags flags;
131 spinlock_t state_lock;
3d045a54 132 u8 rann_snd_addr[ETH_ALEN];
d2a079fd 133 u32 rann_metric;
3d045a54 134 bool is_root;
5ee68e5b 135 bool is_gate;
ccf80ddf
LCC
136};
137
138/**
139 * struct mesh_table
140 *
141 * @hash_buckets: array of hash buckets of the table
142 * @hashwlock: array of locks to protect write operations, one per bucket
143 * @hash_mask: 2^size_order - 1, used to compute hash idx
144 * @hash_rnd: random value used for hash computations
145 * @entries: number of entries in the table
146 * @free_node: function to free nodes of the table
eef35c2d 147 * @copy_node: function to copy nodes of the table
ccf80ddf
LCC
148 * @size_order: determines size of the table, there will be 2^size_order hash
149 * buckets
150 * @mean_chain_len: maximum average length for the hash buckets' list, if it is
151 * reached, the table will grow
5ee68e5b
JC
152 * @known_gates: list of known mesh gates and their mpaths by the station. The
153 * gate's mpath may or may not be resolved and active.
154 *
1928ecab 155 * rcu_head: RCU head to free the table
ccf80ddf
LCC
156 */
157struct mesh_table {
158 /* Number of buckets will be 2^N */
159 struct hlist_head *hash_buckets;
160 spinlock_t *hashwlock; /* One per bucket, for add/del */
161 unsigned int hash_mask; /* (2^size_order) - 1 */
162 __u32 hash_rnd; /* Used for hash generation */
163 atomic_t entries; /* Up to MAX_MESH_NEIGHBOURS */
164 void (*free_node) (struct hlist_node *p, bool free_leafs);
4caf86c6 165 int (*copy_node) (struct hlist_node *p, struct mesh_table *newtbl);
ccf80ddf
LCC
166 int size_order;
167 int mean_chain_len;
5ee68e5b
JC
168 struct hlist_head *known_gates;
169 spinlock_t gates_lock;
1928ecab
JB
170
171 struct rcu_head rcu_head;
ccf80ddf
LCC
172};
173
174/* Recent multicast cache */
175/* RMC_BUCKETS must be a power of 2, maximum 256 */
176#define RMC_BUCKETS 256
177#define RMC_QUEUE_MAX_LEN 4
178#define RMC_TIMEOUT (3 * HZ)
179
180/**
181 * struct rmc_entry - entry in the Recent Multicast Cache
182 *
183 * @seqnum: mesh sequence number of the frame
184 * @exp_time: expiration time of the entry, in jiffies
185 * @sa: source address of the frame
186 *
187 * The Recent Multicast Cache keeps track of the latest multicast frames that
188 * have been received by a mesh interface and discards received multicast frames
189 * that are found in the cache.
190 */
191struct rmc_entry {
192 struct list_head list;
193 u32 seqnum;
194 unsigned long exp_time;
195 u8 sa[ETH_ALEN];
196};
197
198struct mesh_rmc {
199 struct rmc_entry bucket[RMC_BUCKETS];
51ceddad 200 u32 idx_mask;
ccf80ddf
LCC
201};
202
25d49e4d
TP
203#define IEEE80211_MESH_PEER_INACTIVITY_LIMIT (1800 * HZ)
204#define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ)
ccf80ddf 205
5b365834 206#define MESH_DEFAULT_BEACON_INTERVAL 1000 /* in 1024 us units */
ccf80ddf 207
ccf80ddf
LCC
208#define MESH_PATH_EXPIRE (600 * HZ)
209
ccf80ddf
LCC
210/* Default maximum number of plinks per interface */
211#define MESH_MAX_PLINKS 256
212
213/* Maximum number of paths per interface */
214#define MESH_MAX_MPATHS 1024
215
ccf80ddf
LCC
216/* Public interfaces */
217/* Various */
3c5772a5 218int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc,
15ff6365 219 const u8 *da, const u8 *sa);
ccf80ddf 220int ieee80211_new_mesh_header(struct ieee80211s_hdr *meshhdr,
61ad5394
JC
221 struct ieee80211_sub_if_data *sdata, char *addr4or5,
222 char *addr6);
ccf80ddf 223int mesh_rmc_check(u8 *addr, struct ieee80211s_hdr *mesh_hdr,
f698d856
JBG
224 struct ieee80211_sub_if_data *sdata);
225bool mesh_matches_local(struct ieee802_11_elems *ie,
fe40cb62 226 struct ieee80211_sub_if_data *sdata, u32 basic_rates);
472dbc45 227void mesh_ids_set_default(struct ieee80211_if_mesh *mesh);
f698d856
JBG
228void mesh_mgmt_ies_add(struct sk_buff *skb,
229 struct ieee80211_sub_if_data *sdata);
082ebb0c
TP
230int mesh_add_meshconf_ie(struct sk_buff *skb,
231 struct ieee80211_sub_if_data *sdata);
232int mesh_add_meshid_ie(struct sk_buff *skb,
233 struct ieee80211_sub_if_data *sdata);
234int mesh_add_rsn_ie(struct sk_buff *skb,
235 struct ieee80211_sub_if_data *sdata);
236int mesh_add_vendor_ies(struct sk_buff *skb,
237 struct ieee80211_sub_if_data *sdata);
082ebb0c
TP
238int mesh_add_ds_params_ie(struct sk_buff *skb,
239 struct ieee80211_sub_if_data *sdata);
176f3608
TP
240int mesh_add_ht_cap_ie(struct sk_buff *skb,
241 struct ieee80211_sub_if_data *sdata);
074d46d1 242int mesh_add_ht_oper_ie(struct sk_buff *skb,
176f3608 243 struct ieee80211_sub_if_data *sdata);
f698d856
JBG
244void mesh_rmc_free(struct ieee80211_sub_if_data *sdata);
245int mesh_rmc_init(struct ieee80211_sub_if_data *sdata);
ccf80ddf 246void ieee80211s_init(void);
bfc32e6a
JC
247void ieee80211s_update_metric(struct ieee80211_local *local,
248 struct sta_info *stainfo, struct sk_buff *skb);
ccf80ddf 249void ieee80211s_stop(void);
902acc78 250void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata);
472dbc45
JB
251void ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata);
252void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata);
63c5723b 253void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh);
dbf498fb 254struct ieee80211_mesh_sync_ops *ieee80211_mesh_sync_ops_get(u8 method);
902acc78 255
ccf80ddf 256/* Mesh paths */
f698d856
JBG
257int mesh_nexthop_lookup(struct sk_buff *skb,
258 struct ieee80211_sub_if_data *sdata);
0cfda851
TP
259int mesh_nexthop_resolve(struct sk_buff *skb,
260 struct ieee80211_sub_if_data *sdata);
f698d856
JBG
261void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata);
262struct mesh_path *mesh_path_lookup(u8 *dst,
263 struct ieee80211_sub_if_data *sdata);
79617dee
Y
264struct mesh_path *mpp_path_lookup(u8 *dst,
265 struct ieee80211_sub_if_data *sdata);
266int mpp_path_add(u8 *dst, u8 *mpp, struct ieee80211_sub_if_data *sdata);
f698d856
JBG
267struct mesh_path *mesh_path_lookup_by_idx(int idx,
268 struct ieee80211_sub_if_data *sdata);
ccf80ddf 269void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop);
f698d856 270void mesh_path_expire(struct ieee80211_sub_if_data *sdata);
f698d856
JBG
271void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata,
272 struct ieee80211_mgmt *mgmt, size_t len);
273int mesh_path_add(u8 *dst, struct ieee80211_sub_if_data *sdata);
5ee68e5b
JC
274
275int mesh_path_add_gate(struct mesh_path *mpath);
276int mesh_path_send_to_gates(struct mesh_path *mpath);
277int mesh_gate_num(struct ieee80211_sub_if_data *sdata);
ccf80ddf 278/* Mesh plinks */
881d948c 279void mesh_neighbour_update(u8 *hw_addr, u32 rates,
1570ca59
JC
280 struct ieee80211_sub_if_data *sdata,
281 struct ieee802_11_elems *ie);
f698d856 282bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie);
d0709a65 283void mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata);
ccf80ddf
LCC
284void mesh_plink_broken(struct sta_info *sta);
285void mesh_plink_deactivate(struct sta_info *sta);
286int mesh_plink_open(struct sta_info *sta);
ccf80ddf 287void mesh_plink_block(struct sta_info *sta);
f698d856
JBG
288void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata,
289 struct ieee80211_mgmt *mgmt, size_t len,
290 struct ieee80211_rx_status *rx_status);
ccf80ddf
LCC
291
292/* Private interfaces */
293/* Mesh tables */
18889231
JC
294void mesh_mpath_table_grow(void);
295void mesh_mpp_table_grow(void);
ccf80ddf 296/* Mesh paths */
d19b3bf6 297int mesh_path_error_tx(u8 ttl, u8 *target, __le32 target_sn, __le16 target_rcode,
15ff6365 298 const u8 *ra, struct ieee80211_sub_if_data *sdata);
ccf80ddf
LCC
299void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta);
300void mesh_path_flush_pending(struct mesh_path *mpath);
301void mesh_path_tx_pending(struct mesh_path *mpath);
302int mesh_pathtbl_init(void);
303void mesh_pathtbl_unregister(void);
f698d856 304int mesh_path_del(u8 *addr, struct ieee80211_sub_if_data *sdata);
ccf80ddf
LCC
305void mesh_path_timer(unsigned long data);
306void mesh_path_flush_by_nexthop(struct sta_info *sta);
ece1a2e7 307void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata);
f698d856
JBG
308void mesh_path_discard_frame(struct sk_buff *skb,
309 struct ieee80211_sub_if_data *sdata);
5bb644a0
JB
310void mesh_path_quiesce(struct ieee80211_sub_if_data *sdata);
311void mesh_path_restart(struct ieee80211_sub_if_data *sdata);
e304bfd3 312void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata);
ccf80ddf 313
25d49e4d 314bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt);
f5ea9120
JB
315extern int mesh_paths_generation;
316
902acc78
JB
317#ifdef CONFIG_MAC80211_MESH
318extern int mesh_allocated;
319
ccf80ddf
LCC
320static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata)
321{
472dbc45
JB
322 return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks -
323 atomic_read(&sdata->u.mesh.mshstats.estab_plinks);
ccf80ddf
LCC
324}
325
326static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata)
327{
d0709a65 328 return (min_t(long, mesh_plink_free_count(sdata),
ccf80ddf
LCC
329 MESH_MAX_PLINKS - sdata->local->num_sta)) > 0;
330}
331
332static inline void mesh_path_activate(struct mesh_path *mpath)
333{
334 mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED;
335}
336
c7108a71
JC
337static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
338{
339 return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP;
340}
341
472dbc45
JB
342void ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local);
343
5bb644a0
JB
344void ieee80211_mesh_quiesce(struct ieee80211_sub_if_data *sdata);
345void ieee80211_mesh_restart(struct ieee80211_sub_if_data *sdata);
346void mesh_plink_quiesce(struct sta_info *sta);
347void mesh_plink_restart(struct sta_info *sta);
dbf498fb 348void mesh_sync_adjust_tbtt(struct ieee80211_sub_if_data *sdata);
902acc78
JB
349#else
350#define mesh_allocated 0
472dbc45
JB
351static inline void
352ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local) {}
5bb644a0
JB
353static inline void ieee80211_mesh_quiesce(struct ieee80211_sub_if_data *sdata)
354{}
355static inline void ieee80211_mesh_restart(struct ieee80211_sub_if_data *sdata)
356{}
357static inline void mesh_plink_quiesce(struct sta_info *sta) {}
358static inline void mesh_plink_restart(struct sta_info *sta) {}
c7108a71
JC
359static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
360{ return false; }
902acc78
JB
361#endif
362
ccf80ddf 363#endif /* IEEE80211S_H */
This page took 0.321035 seconds and 5 git commands to generate.