2 * Copyright (c) 2008, 2009 open80211s Ltd.
3 * Authors: Luis Carlos Cobo <luisca@cozybit.com>
4 * Javier Cardona <javier@cozybit.com>
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.
14 #include <linux/types.h>
15 #include <linux/jhash.h>
16 #include "ieee80211_i.h"
22 * enum mesh_path_flags - mac80211 mesh path flags
24 * @MESH_PATH_ACTIVE: the mesh path can be used for forwarding
25 * @MESH_PATH_RESOLVING: the discovery process is running for this mesh path
26 * @MESH_PATH_SN_VALID: the mesh path contains a valid destination sequence
28 * @MESH_PATH_FIXED: the mesh path has been manually set and should not be
30 * @MESH_PATH_RESOLVED: the mesh path can has been resolved
31 * @MESH_PATH_REQ_QUEUED: there is an unsent path request for this destination
32 * already queued up, waiting for the discovery process to start.
33 * @MESH_PATH_DELETED: the mesh path has been deleted and should no longer
36 * MESH_PATH_RESOLVED is used by the mesh path timer to
37 * decide when to stop or cancel the mesh path discovery.
39 enum mesh_path_flags {
40 MESH_PATH_ACTIVE = BIT(0),
41 MESH_PATH_RESOLVING = BIT(1),
42 MESH_PATH_SN_VALID = BIT(2),
43 MESH_PATH_FIXED = BIT(3),
44 MESH_PATH_RESOLVED = BIT(4),
45 MESH_PATH_REQ_QUEUED = BIT(5),
46 MESH_PATH_DELETED = BIT(6),
50 * enum mesh_deferred_task_flags - mac80211 mesh deferred tasks
54 * @MESH_WORK_HOUSEKEEPING: run the periodic mesh housekeeping tasks
55 * @MESH_WORK_ROOT: the mesh root station needs to send a frame
56 * @MESH_WORK_DRIFT_ADJUST: time to compensate for clock drift relative to other
58 * @MESH_WORK_MBSS_CHANGED: rebuild beacon and notify driver of BSS changes
60 enum mesh_deferred_task_flags {
61 MESH_WORK_HOUSEKEEPING,
63 MESH_WORK_DRIFT_ADJUST,
64 MESH_WORK_MBSS_CHANGED,
68 * struct mesh_path - mac80211 mesh path structure
70 * @dst: mesh path destination mac address
71 * @mpp: mesh proxy mac address
72 * @rhash: rhashtable list pointer
73 * @walk_list: linked list containing all mesh_path objects.
74 * @gate_list: list pointer for known gates list
76 * @next_hop: mesh neighbor to which frames for this destination will be
78 * @timer: mesh path discovery timer
79 * @frame_queue: pending queue for frames sent to this destination while the
81 * @rcu: rcu head for freeing mesh path
82 * @sn: target sequence number
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
88 * @discovery_retries: number of discovery retries
89 * @flags: mesh path flags, as specified on &enum mesh_path_flags
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.
93 * @rann_snd_addr: the RANN sender address
94 * @rann_metric: the aggregated path metric towards the root node
95 * @last_preq_to_root: Timestamp of last PREQ sent to root
96 * @is_root: the destination station of this path is a root node
97 * @is_gate: the destination station of this path is a mesh gate
100 * The dst address is unique in the mesh path table. Since the mesh_path is
101 * protected by RCU, deleting the next_hop STA must remove / substitute the
102 * mesh_path structure and wait until that is no longer reachable before
103 * destroying the STA completely.
107 u8 mpp[ETH_ALEN]; /* used for MPP or MAP */
108 struct rhash_head rhash;
109 struct hlist_node walk_list;
110 struct hlist_node gate_list;
111 struct ieee80211_sub_if_data *sdata;
112 struct sta_info __rcu *next_hop;
113 struct timer_list timer;
114 struct sk_buff_head frame_queue;
119 unsigned long exp_time;
120 u32 discovery_timeout;
121 u8 discovery_retries;
122 enum mesh_path_flags flags;
123 spinlock_t state_lock;
124 u8 rann_snd_addr[ETH_ALEN];
126 unsigned long last_preq_to_root;
131 /* Recent multicast cache */
132 /* RMC_BUCKETS must be a power of 2, maximum 256 */
133 #define RMC_BUCKETS 256
134 #define RMC_QUEUE_MAX_LEN 4
135 #define RMC_TIMEOUT (3 * HZ)
138 * struct rmc_entry - entry in the Recent Multicast Cache
140 * @seqnum: mesh sequence number of the frame
141 * @exp_time: expiration time of the entry, in jiffies
142 * @sa: source address of the frame
143 * @list: hashtable list pointer
145 * The Recent Multicast Cache keeps track of the latest multicast frames that
146 * have been received by a mesh interface and discards received multicast frames
147 * that are found in the cache.
150 struct hlist_node list;
151 unsigned long exp_time;
157 struct hlist_head bucket[RMC_BUCKETS];
161 #define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ)
163 #define MESH_PATH_EXPIRE (600 * HZ)
165 /* Default maximum number of plinks per interface */
166 #define MESH_MAX_PLINKS 256
168 /* Maximum number of paths per interface */
169 #define MESH_MAX_MPATHS 1024
171 /* Number of frames buffered per destination for unresolved destinations */
172 #define MESH_FRAME_QUEUE_LEN 10
174 /* Public interfaces */
176 int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc,
177 const u8 *da, const u8 *sa);
178 unsigned int ieee80211_new_mesh_header(struct ieee80211_sub_if_data *sdata,
179 struct ieee80211s_hdr *meshhdr,
180 const char *addr4or5, const char *addr6);
181 int mesh_rmc_check(struct ieee80211_sub_if_data *sdata,
182 const u8 *addr, struct ieee80211s_hdr *mesh_hdr);
183 bool mesh_matches_local(struct ieee80211_sub_if_data *sdata,
184 struct ieee802_11_elems *ie);
185 void mesh_ids_set_default(struct ieee80211_if_mesh *mesh);
186 int mesh_add_meshconf_ie(struct ieee80211_sub_if_data *sdata,
187 struct sk_buff *skb);
188 int mesh_add_meshid_ie(struct ieee80211_sub_if_data *sdata,
189 struct sk_buff *skb);
190 int mesh_add_rsn_ie(struct ieee80211_sub_if_data *sdata,
191 struct sk_buff *skb);
192 int mesh_add_vendor_ies(struct ieee80211_sub_if_data *sdata,
193 struct sk_buff *skb);
194 int mesh_add_ht_cap_ie(struct ieee80211_sub_if_data *sdata,
195 struct sk_buff *skb);
196 int mesh_add_ht_oper_ie(struct ieee80211_sub_if_data *sdata,
197 struct sk_buff *skb);
198 int mesh_add_vht_cap_ie(struct ieee80211_sub_if_data *sdata,
199 struct sk_buff *skb);
200 int mesh_add_vht_oper_ie(struct ieee80211_sub_if_data *sdata,
201 struct sk_buff *skb);
202 void mesh_rmc_free(struct ieee80211_sub_if_data *sdata);
203 int mesh_rmc_init(struct ieee80211_sub_if_data *sdata);
204 void ieee80211s_init(void);
205 void ieee80211s_update_metric(struct ieee80211_local *local,
206 struct sta_info *sta,
207 struct ieee80211_tx_status *st);
208 void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata);
209 void ieee80211_mesh_teardown_sdata(struct ieee80211_sub_if_data *sdata);
210 int ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata);
211 void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata);
212 void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh);
213 const struct ieee80211_mesh_sync_ops *ieee80211_mesh_sync_ops_get(u8 method);
214 /* wrapper for ieee80211_bss_info_change_notify() */
215 void ieee80211_mbss_info_change_notify(struct ieee80211_sub_if_data *sdata,
218 /* mesh power save */
219 u32 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata);
220 u32 ieee80211_mps_set_sta_local_pm(struct sta_info *sta,
221 enum nl80211_mesh_power_mode pm);
222 void ieee80211_mps_set_frame_flags(struct ieee80211_sub_if_data *sdata,
223 struct sta_info *sta,
224 struct ieee80211_hdr *hdr);
225 void ieee80211_mps_sta_status_update(struct sta_info *sta);
226 void ieee80211_mps_rx_h_sta_process(struct sta_info *sta,
227 struct ieee80211_hdr *hdr);
228 void ieee80211_mpsp_trigger_process(u8 *qc, struct sta_info *sta,
229 bool tx, bool acked);
230 void ieee80211_mps_frame_release(struct sta_info *sta,
231 struct ieee802_11_elems *elems);
234 int mesh_nexthop_lookup(struct ieee80211_sub_if_data *sdata,
235 struct sk_buff *skb);
236 int mesh_nexthop_resolve(struct ieee80211_sub_if_data *sdata,
237 struct sk_buff *skb);
238 void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata);
239 struct mesh_path *mesh_path_lookup(struct ieee80211_sub_if_data *sdata,
241 struct mesh_path *mpp_path_lookup(struct ieee80211_sub_if_data *sdata,
243 int mpp_path_add(struct ieee80211_sub_if_data *sdata,
244 const u8 *dst, const u8 *mpp);
246 mesh_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
248 mpp_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
249 void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop);
250 void mesh_path_expire(struct ieee80211_sub_if_data *sdata);
251 void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata,
252 struct ieee80211_mgmt *mgmt, size_t len);
254 mesh_path_add(struct ieee80211_sub_if_data *sdata, const u8 *dst);
256 int mesh_path_add_gate(struct mesh_path *mpath);
257 int mesh_path_send_to_gates(struct mesh_path *mpath);
258 int mesh_gate_num(struct ieee80211_sub_if_data *sdata);
261 void mesh_neighbour_update(struct ieee80211_sub_if_data *sdata,
262 u8 *hw_addr, struct ieee802_11_elems *ie);
263 bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie);
264 u32 mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata);
265 void mesh_plink_timer(struct timer_list *t);
266 void mesh_plink_broken(struct sta_info *sta);
267 u32 mesh_plink_deactivate(struct sta_info *sta);
268 u32 mesh_plink_open(struct sta_info *sta);
269 u32 mesh_plink_block(struct sta_info *sta);
270 void 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);
273 void mesh_sta_cleanup(struct sta_info *sta);
275 /* Private interfaces */
277 int mesh_path_error_tx(struct ieee80211_sub_if_data *sdata,
278 u8 ttl, const u8 *target, u32 target_sn,
279 u16 target_rcode, const u8 *ra);
280 void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta);
281 void mesh_path_flush_pending(struct mesh_path *mpath);
282 void mesh_path_tx_pending(struct mesh_path *mpath);
283 void mesh_pathtbl_init(struct ieee80211_sub_if_data *sdata);
284 void mesh_pathtbl_unregister(struct ieee80211_sub_if_data *sdata);
285 int mesh_path_del(struct ieee80211_sub_if_data *sdata, const u8 *addr);
286 void mesh_path_timer(struct timer_list *t);
287 void mesh_path_flush_by_nexthop(struct sta_info *sta);
288 void mesh_path_discard_frame(struct ieee80211_sub_if_data *sdata,
289 struct sk_buff *skb);
290 void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata);
292 bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt);
294 #ifdef CONFIG_MAC80211_MESH
296 u32 mesh_plink_inc_estab_count(struct ieee80211_sub_if_data *sdata)
298 atomic_inc(&sdata->u.mesh.estab_plinks);
299 return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON;
303 u32 mesh_plink_dec_estab_count(struct ieee80211_sub_if_data *sdata)
305 atomic_dec(&sdata->u.mesh.estab_plinks);
306 return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON;
309 static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata)
311 return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks -
312 atomic_read(&sdata->u.mesh.estab_plinks);
315 static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata)
317 return (min_t(long, mesh_plink_free_count(sdata),
318 MESH_MAX_PLINKS - sdata->local->num_sta)) > 0;
321 static inline void mesh_path_activate(struct mesh_path *mpath)
323 mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED;
326 static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
328 return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP;
331 void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata);
332 void mesh_sync_adjust_tsf(struct ieee80211_sub_if_data *sdata);
333 void ieee80211s_stop(void);
335 static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
337 static inline void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata)
339 static inline void ieee80211s_stop(void) {}
342 #endif /* IEEE80211S_H */