projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge branch 'for-4.5/for-jens' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-block.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
21/**
22 * enum mesh_path_flags - mac80211 mesh path flags
23 *
24 *
25 *
eb80ed8d
RR		 26 * @MESH_PATH_ACTIVE: the mesh path can be used for forwarding
27 * @MESH_PATH_RESOLVING: the discovery process is running for this mesh path
d19b3bf6 28 * @MESH_PATH_SN_VALID: the mesh path contains a valid destination sequence
bf7cd94d 29 * number
ccf80ddf 30 * @MESH_PATH_FIXED: the mesh path has been manually set and should not be
bf7cd94d 31 * modified
ccf80ddf 32 * @MESH_PATH_RESOLVED: the mesh path can has been resolved
f3011cf9 33 * @MESH_PATH_REQ_QUEUED: there is an unsent path request for this destination
bf7cd94d 34 * already queued up, waiting for the discovery process to start.
ccf80ddf 35 *
eb80ed8d 36 * MESH_PATH_RESOLVED is used by the mesh path timer to
ccf80ddf
LCC		 37 * decide when to stop or cancel the mesh path discovery.
38 */
39enum mesh_path_flags {
40 MESH_PATH_ACTIVE = BIT(0),
41 MESH_PATH_RESOLVING = BIT(1),
d19b3bf6 42 MESH_PATH_SN_VALID = BIT(2),
ccf80ddf
LCC		 43 MESH_PATH_FIXED = BIT(3),
44 MESH_PATH_RESOLVED = BIT(4),
f3011cf9 45 MESH_PATH_REQ_QUEUED = BIT(5),
ccf80ddf
LCC		 46};
47
18889231
JC		 48/**
49 * enum mesh_deferred_task_flags - mac80211 mesh deferred tasks
50 *
51 *
52 *
53 * @MESH_WORK_HOUSEKEEPING: run the periodic mesh housekeeping tasks
54 * @MESH_WORK_GROW_MPATH_TABLE: the mesh path table is full and needs
55 * to grow.
56 * @MESH_WORK_GROW_MPP_TABLE: the mesh portals table is full and needs to
57 * grow
e304bfd3 58 * @MESH_WORK_ROOT: the mesh root station needs to send a frame
dbf498fb
JC		 59 * @MESH_WORK_DRIFT_ADJUST: time to compensate for clock drift relative to other
60 * mesh nodes
f81a9ded 61 * @MESH_WORK_MBSS_CHANGED: rebuild beacon and notify driver of BSS changes
18889231
JC		 62 */
63enum mesh_deferred_task_flags {
64 MESH_WORK_HOUSEKEEPING,
65 MESH_WORK_GROW_MPATH_TABLE,
66 MESH_WORK_GROW_MPP_TABLE,
e304bfd3 67 MESH_WORK_ROOT,
dbf498fb 68 MESH_WORK_DRIFT_ADJUST,
f81a9ded 69 MESH_WORK_MBSS_CHANGED,
18889231
JC		 70};
71
ccf80ddf
LCC		 72/**
73 * struct mesh_path - mac80211 mesh path structure
74 *
75 * @dst: mesh path destination mac address
f698d856 76 * @sdata: mesh subif
ccf80ddf 77 * @next_hop: mesh neighbor to which frames for this destination will be
bf7cd94d 78 * forwarded
ccf80ddf
LCC		 79 * @timer: mesh path discovery timer
80 * @frame_queue: pending queue for frames sent to this destination while the
bf7cd94d 81 * path is unresolved
d19b3bf6 82 * @sn: target sequence number
ccf80ddf
LCC		 83 * @metric: current metric to this destination
84 * @hop_count: hops to destination
85 * @exp_time: in jiffies, when the path will expire or when it expired
86 * @discovery_timeout: timeout (lapse in jiffies) used for the last discovery
bf7cd94d 87 * retry
ccf80ddf
LCC		 88 * @discovery_retries: number of discovery retries
89 * @flags: mesh path flags, as specified on &enum mesh_path_flags
f5e50cd0
JC		 90 * @state_lock: mesh path state lock used to protect changes to the
91 * mpath itself. No need to take this lock when adding or removing
92 * an mpath to a hash bucket on a path table.
3d045a54 93 * @rann_snd_addr: the RANN sender address
d2a079fd 94 * @rann_metric: the aggregated path metric towards the root node
728b19e5 95 * @last_preq_to_root: Timestamp of last PREQ sent to root
3d045a54 96 * @is_root: the destination station of this path is a root node
5ee68e5b 97 * @is_gate: the destination station of this path is a mesh gate
ccf80ddf
LCC		 98 *
99 *
f698d856 100 * The combination of dst and sdata is unique in the mesh path table. Since the
d0709a65
JB		 101 * next_hop STA is only protected by RCU as well, deleting the STA must also
102 * remove/substitute the mesh_path structure and wait until that is no longer
103 * reachable before destroying the STA completely.
ccf80ddf
LCC		 104 */
105struct mesh_path {
106 u8 dst[ETH_ALEN];
79617dee 107 u8 mpp[ETH_ALEN]; /* used for MPP or MAP */
f698d856 108 struct ieee80211_sub_if_data *sdata;
40b275b6 109 struct sta_info __rcu *next_hop;
ccf80ddf
LCC		 110 struct timer_list timer;
111 struct sk_buff_head frame_queue;
112 struct rcu_head rcu;
d19b3bf6 113 u32 sn;
ccf80ddf
LCC		 114 u32 metric;
115 u8 hop_count;
116 unsigned long exp_time;
117 u32 discovery_timeout;
118 u8 discovery_retries;
119 enum mesh_path_flags flags;
120 spinlock_t state_lock;
3d045a54 121 u8 rann_snd_addr[ETH_ALEN];
d2a079fd 122 u32 rann_metric;
728b19e5 123 unsigned long last_preq_to_root;
3d045a54 124 bool is_root;
5ee68e5b 125 bool is_gate;
ccf80ddf
LCC		 126};
127
128/**
129 * struct mesh_table
130 *
131 * @hash_buckets: array of hash buckets of the table
132 * @hashwlock: array of locks to protect write operations, one per bucket
133 * @hash_mask: 2^size_order - 1, used to compute hash idx
134 * @hash_rnd: random value used for hash computations
135 * @entries: number of entries in the table
136 * @free_node: function to free nodes of the table
eef35c2d 137 * @copy_node: function to copy nodes of the table
ccf80ddf
LCC		 138 * @size_order: determines size of the table, there will be 2^size_order hash
139 * buckets
140 * @mean_chain_len: maximum average length for the hash buckets' list, if it is
141 * reached, the table will grow
5ee68e5b
JC		 142 * @known_gates: list of known mesh gates and their mpaths by the station. The
143 * gate's mpath may or may not be resolved and active.
144 *
1928ecab 145 * rcu_head: RCU head to free the table
ccf80ddf
LCC		 146 */
147struct mesh_table {
148 /* Number of buckets will be 2^N */
149 struct hlist_head *hash_buckets;
150 spinlock_t *hashwlock; /* One per bucket, for add/del */
151 unsigned int hash_mask; /* (2^size_order) - 1 */
152 __u32 hash_rnd; /* Used for hash generation */
153 atomic_t entries; /* Up to MAX_MESH_NEIGHBOURS */
154 void (*free_node) (struct hlist_node *p, bool free_leafs);
4caf86c6 155 int (*copy_node) (struct hlist_node *p, struct mesh_table *newtbl);
ccf80ddf
LCC		 156 int size_order;
157 int mean_chain_len;
5ee68e5b
JC		 158 struct hlist_head *known_gates;
159 spinlock_t gates_lock;
1928ecab
JB		 160
161 struct rcu_head rcu_head;
ccf80ddf
LCC		 162};
163
164/* Recent multicast cache */
165/* RMC_BUCKETS must be a power of 2, maximum 256 */
166#define RMC_BUCKETS 256
167#define RMC_QUEUE_MAX_LEN 4
168#define RMC_TIMEOUT (3 * HZ)
169
170/**
171 * struct rmc_entry - entry in the Recent Multicast Cache
172 *
173 * @seqnum: mesh sequence number of the frame
174 * @exp_time: expiration time of the entry, in jiffies
175 * @sa: source address of the frame
176 *
177 * The Recent Multicast Cache keeps track of the latest multicast frames that
178 * have been received by a mesh interface and discards received multicast frames
179 * that are found in the cache.
180 */
181struct rmc_entry {
182 struct list_head list;
183 u32 seqnum;
184 unsigned long exp_time;
185 u8 sa[ETH_ALEN];
186};
187
188struct mesh_rmc {
b7cfcd11 189 struct list_head bucket[RMC_BUCKETS];
51ceddad 190 u32 idx_mask;
ccf80ddf
LCC		 191};
192
25d49e4d 193#define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ)
ccf80ddf 194
ccf80ddf
LCC		 195#define MESH_PATH_EXPIRE (600 * HZ)
196
ccf80ddf
LCC		 197/* Default maximum number of plinks per interface */
198#define MESH_MAX_PLINKS 256
199
200/* Maximum number of paths per interface */
201#define MESH_MAX_MPATHS 1024
202
4bd4c2dd
TP		 203/* Number of frames buffered per destination for unresolved destinations */
204#define MESH_FRAME_QUEUE_LEN 10
205
ccf80ddf
LCC		 206/* Public interfaces */
207/* Various */
3c5772a5 208int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc,
15ff6365 209 const u8 *da, const u8 *sa);
5edfcee5
AH		 210unsigned int ieee80211_new_mesh_header(struct ieee80211_sub_if_data *sdata,
211 struct ieee80211s_hdr *meshhdr,
212 const char *addr4or5, const char *addr6);
bf7cd94d
JB		 213int mesh_rmc_check(struct ieee80211_sub_if_data *sdata,
214 const u8 *addr, struct ieee80211s_hdr *mesh_hdr);
f743ff49
TP		 215bool mesh_matches_local(struct ieee80211_sub_if_data *sdata,
216 struct ieee802_11_elems *ie);
472dbc45 217void mesh_ids_set_default(struct ieee80211_if_mesh *mesh);
bf7cd94d
JB		 218int mesh_add_meshconf_ie(struct ieee80211_sub_if_data *sdata,
219 struct sk_buff *skb);
220int mesh_add_meshid_ie(struct ieee80211_sub_if_data *sdata,
221 struct sk_buff *skb);
222int mesh_add_rsn_ie(struct ieee80211_sub_if_data *sdata,
223 struct sk_buff *skb);
224int mesh_add_vendor_ies(struct ieee80211_sub_if_data *sdata,
225 struct sk_buff *skb);
226int mesh_add_ht_cap_ie(struct ieee80211_sub_if_data *sdata,
227 struct sk_buff *skb);
228int mesh_add_ht_oper_ie(struct ieee80211_sub_if_data *sdata,
229 struct sk_buff *skb);
c85fb53c
BC		 230int mesh_add_vht_cap_ie(struct ieee80211_sub_if_data *sdata,
231 struct sk_buff *skb);
232int mesh_add_vht_oper_ie(struct ieee80211_sub_if_data *sdata,
233 struct sk_buff *skb);
f698d856
JBG		 234void mesh_rmc_free(struct ieee80211_sub_if_data *sdata);
235int mesh_rmc_init(struct ieee80211_sub_if_data *sdata);
ccf80ddf 236void ieee80211s_init(void);
bfc32e6a 237void ieee80211s_update_metric(struct ieee80211_local *local,
bf7cd94d 238 struct sta_info *sta, struct sk_buff *skb);
902acc78 239void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata);
2b5e1967 240int ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata);
472dbc45 241void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata);
63c5723b 242void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh);
8ba7acf3 243const struct ieee80211_mesh_sync_ops *ieee80211_mesh_sync_ops_get(u8 method);
2b5e1967
TP		 244/* wrapper for ieee80211_bss_info_change_notify() */
245void ieee80211_mbss_info_change_notify(struct ieee80211_sub_if_data *sdata,
246 u32 changed);
902acc78 247
3f52b7e3 248/* mesh power save */
39886b61
TP		 249u32 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata);
250u32 ieee80211_mps_set_sta_local_pm(struct sta_info *sta,
251 enum nl80211_mesh_power_mode pm);
3f52b7e3
MP		 252void ieee80211_mps_set_frame_flags(struct ieee80211_sub_if_data *sdata,
253 struct sta_info *sta,
254 struct ieee80211_hdr *hdr);
255void ieee80211_mps_sta_status_update(struct sta_info *sta);
256void ieee80211_mps_rx_h_sta_process(struct sta_info *sta,
257 struct ieee80211_hdr *hdr);
258void ieee80211_mpsp_trigger_process(u8 *qc, struct sta_info *sta,
259 bool tx, bool acked);
260void ieee80211_mps_frame_release(struct sta_info *sta,
261 struct ieee802_11_elems *elems);
262
ccf80ddf 263/* Mesh paths */
bf7cd94d
JB		 264int mesh_nexthop_lookup(struct ieee80211_sub_if_data *sdata,
265 struct sk_buff *skb);
266int mesh_nexthop_resolve(struct ieee80211_sub_if_data *sdata,
267 struct sk_buff *skb);
f698d856 268void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata);
bf7cd94d
JB		 269struct mesh_path *mesh_path_lookup(struct ieee80211_sub_if_data *sdata,
270 const u8 *dst);
271struct mesh_path *mpp_path_lookup(struct ieee80211_sub_if_data *sdata,
272 const u8 *dst);
273int mpp_path_add(struct ieee80211_sub_if_data *sdata,
274 const u8 *dst, const u8 *mpp);
275struct mesh_path *
276mesh_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
a2db2ed3
HR		 277struct mesh_path *
278mpp_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
ccf80ddf 279void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop);
f698d856 280void mesh_path_expire(struct ieee80211_sub_if_data *sdata);
f698d856 281void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata,
bf7cd94d 282 struct ieee80211_mgmt *mgmt, size_t len);
ae76eef0
BC		 283struct mesh_path *
284mesh_path_add(struct ieee80211_sub_if_data *sdata, const u8 *dst);
5ee68e5b
JC		 285
286int mesh_path_add_gate(struct mesh_path *mpath);
287int mesh_path_send_to_gates(struct mesh_path *mpath);
288int mesh_gate_num(struct ieee80211_sub_if_data *sdata);
bf7cd94d 289
ccf80ddf 290/* Mesh plinks */
f743ff49 291void mesh_neighbour_update(struct ieee80211_sub_if_data *sdata,
bf7cd94d 292 u8 *hw_addr, struct ieee802_11_elems *ie);
f698d856 293bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie);
df323818 294u32 mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata);
ccf80ddf 295void mesh_plink_broken(struct sta_info *sta);
45b5028e 296u32 mesh_plink_deactivate(struct sta_info *sta);
39886b61
TP		 297u32 mesh_plink_open(struct sta_info *sta);
298u32 mesh_plink_block(struct sta_info *sta);
f698d856
JBG		 299void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata,
300 struct ieee80211_mgmt *mgmt, size_t len,
301 struct ieee80211_rx_status *rx_status);
45b5028e 302void mesh_sta_cleanup(struct sta_info *sta);
ccf80ddf
LCC		 303
304/* Private interfaces */
305/* Mesh tables */
18889231
JC		 306void mesh_mpath_table_grow(void);
307void mesh_mpp_table_grow(void);
ccf80ddf 308/* Mesh paths */
bf7cd94d 309int mesh_path_error_tx(struct ieee80211_sub_if_data *sdata,
f63f8421
CYY		 310 u8 ttl, const u8 *target, u32 target_sn,
311 u16 target_rcode, const u8 *ra);
ccf80ddf
LCC		 312void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta);
313void mesh_path_flush_pending(struct mesh_path *mpath);
314void mesh_path_tx_pending(struct mesh_path *mpath);
315int mesh_pathtbl_init(void);
316void mesh_pathtbl_unregister(void);
bf7cd94d 317int mesh_path_del(struct ieee80211_sub_if_data *sdata, const u8 *addr);
ccf80ddf
LCC		 318void mesh_path_timer(unsigned long data);
319void mesh_path_flush_by_nexthop(struct sta_info *sta);
bf7cd94d
JB		 320void mesh_path_discard_frame(struct ieee80211_sub_if_data *sdata,
321 struct sk_buff *skb);
e304bfd3 322void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata);
ccf80ddf 323
25d49e4d 324bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt);
f5ea9120 325extern int mesh_paths_generation;
a2db2ed3 326extern int mpp_paths_generation;
f5ea9120 327
902acc78 328#ifdef CONFIG_MAC80211_MESH
1617bab8
MP		 329static inline
330u32 mesh_plink_inc_estab_count(struct ieee80211_sub_if_data *sdata)
331{
332 atomic_inc(&sdata->u.mesh.estab_plinks);
e05ecccd 333 return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON;
1617bab8
MP		 334}
335
336static inline
337u32 mesh_plink_dec_estab_count(struct ieee80211_sub_if_data *sdata)
338{
339 atomic_dec(&sdata->u.mesh.estab_plinks);
e05ecccd 340 return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON;
1617bab8
MP		 341}
342
ccf80ddf
LCC		 343static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata)
344{
472dbc45 345 return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks -
1258d976 346 atomic_read(&sdata->u.mesh.estab_plinks);
ccf80ddf
LCC		 347}
348
349static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata)
350{
d0709a65 351 return (min_t(long, mesh_plink_free_count(sdata),
ccf80ddf
LCC		 352 MESH_MAX_PLINKS - sdata->local->num_sta)) > 0;
353}
354
355static inline void mesh_path_activate(struct mesh_path *mpath)
356{
357 mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED;
358}
359
c7108a71
JC		 360static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
361{
362 return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP;
363}
364
472dbc45
JB		 365void ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local);
366
94c514fe 367void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata);
dbf498fb 368void mesh_sync_adjust_tbtt(struct ieee80211_sub_if_data *sdata);
bf7cd94d 369void ieee80211s_stop(void);
902acc78 370#else
472dbc45
JB		 371static inline void
372ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local) {}
c7108a71
JC		 373static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
374{ return false; }
94c514fe
AE		 375static inline void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata)
376{}
bf7cd94d 377static inline void ieee80211s_stop(void) {}
902acc78
JB		 378#endif
379
ccf80ddf 380#endif /* IEEE80211S_H */
Linux 6.x block layer and io_uring tree(s)