blob: 622cc96eb4dea8fa900e9f17f8c29371a9768c1a [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
Javier Cardonaf3011cf2011-11-03 21:11:10 -070034 * @MESH_PATH_REQ_QUEUED: there is an unsent path request for this destination
35 * already queued up, waiting for the discovery process to start.
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010036 *
Rami Roseneb80ed82009-01-19 13:50:32 +020037 * MESH_PATH_RESOLVED is used by the mesh path timer to
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010038 * decide when to stop or cancel the mesh path discovery.
39 */
40enum mesh_path_flags {
41 MESH_PATH_ACTIVE = BIT(0),
42 MESH_PATH_RESOLVING = BIT(1),
Rui Paulod19b3bf2009-11-09 23:46:55 +000043 MESH_PATH_SN_VALID = BIT(2),
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010044 MESH_PATH_FIXED = BIT(3),
45 MESH_PATH_RESOLVED = BIT(4),
Javier Cardonaf3011cf2011-11-03 21:11:10 -070046 MESH_PATH_REQ_QUEUED = BIT(5),
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010047};
48
49/**
Javier Cardona18889232009-08-10 12:15:52 -070050 * enum mesh_deferred_task_flags - mac80211 mesh deferred tasks
51 *
52 *
53 *
54 * @MESH_WORK_HOUSEKEEPING: run the periodic mesh housekeeping tasks
55 * @MESH_WORK_GROW_MPATH_TABLE: the mesh path table is full and needs
56 * to grow.
57 * @MESH_WORK_GROW_MPP_TABLE: the mesh portals table is full and needs to
58 * grow
Rui Pauloe304bfd2009-11-09 23:46:56 +000059 * @MESH_WORK_ROOT: the mesh root station needs to send a frame
Javier Cardona18889232009-08-10 12:15:52 -070060 */
61enum mesh_deferred_task_flags {
62 MESH_WORK_HOUSEKEEPING,
63 MESH_WORK_GROW_MPATH_TABLE,
64 MESH_WORK_GROW_MPP_TABLE,
Rui Pauloe304bfd2009-11-09 23:46:56 +000065 MESH_WORK_ROOT,
Javier Cardona18889232009-08-10 12:15:52 -070066};
67
68/**
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010069 * struct mesh_path - mac80211 mesh path structure
70 *
71 * @dst: mesh path destination mac address
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +120072 * @sdata: mesh subif
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010073 * @next_hop: mesh neighbor to which frames for this destination will be
74 * forwarded
75 * @timer: mesh path discovery timer
76 * @frame_queue: pending queue for frames sent to this destination while the
77 * path is unresolved
Rui Paulod19b3bf2009-11-09 23:46:55 +000078 * @sn: target sequence number
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010079 * @metric: current metric to this destination
80 * @hop_count: hops to destination
81 * @exp_time: in jiffies, when the path will expire or when it expired
82 * @discovery_timeout: timeout (lapse in jiffies) used for the last discovery
83 * retry
84 * @discovery_retries: number of discovery retries
85 * @flags: mesh path flags, as specified on &enum mesh_path_flags
Javier Cardonaf5e50cd2011-08-29 13:23:05 -070086 * @state_lock: mesh path state lock used to protect changes to the
87 * mpath itself. No need to take this lock when adding or removing
88 * an mpath to a hash bucket on a path table.
Javier Cardona5ee68e52011-08-09 16:45:08 -070089 * @is_gate: the destination station of this path is a mesh gate
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010090 *
91 *
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +120092 * The combination of dst and sdata is unique in the mesh path table. Since the
Johannes Bergd0709a62008-02-25 16:27:46 +010093 * next_hop STA is only protected by RCU as well, deleting the STA must also
94 * remove/substitute the mesh_path structure and wait until that is no longer
95 * reachable before destroying the STA completely.
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010096 */
97struct mesh_path {
98 u8 dst[ETH_ALEN];
YanBo79617de2008-09-22 13:30:32 +080099 u8 mpp[ETH_ALEN]; /* used for MPP or MAP */
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200100 struct ieee80211_sub_if_data *sdata;
Johannes Berg40b275b2011-05-13 14:15:49 +0200101 struct sta_info __rcu *next_hop;
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100102 struct timer_list timer;
103 struct sk_buff_head frame_queue;
104 struct rcu_head rcu;
Rui Paulod19b3bf2009-11-09 23:46:55 +0000105 u32 sn;
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100106 u32 metric;
107 u8 hop_count;
108 unsigned long exp_time;
109 u32 discovery_timeout;
110 u8 discovery_retries;
111 enum mesh_path_flags flags;
112 spinlock_t state_lock;
Javier Cardona5ee68e52011-08-09 16:45:08 -0700113 bool is_gate;
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100114};
115
116/**
117 * struct mesh_table
118 *
119 * @hash_buckets: array of hash buckets of the table
120 * @hashwlock: array of locks to protect write operations, one per bucket
121 * @hash_mask: 2^size_order - 1, used to compute hash idx
122 * @hash_rnd: random value used for hash computations
123 * @entries: number of entries in the table
124 * @free_node: function to free nodes of the table
Stefan Weileef35c22010-08-06 21:11:15 +0200125 * @copy_node: function to copy nodes of the table
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100126 * @size_order: determines size of the table, there will be 2^size_order hash
127 * buckets
128 * @mean_chain_len: maximum average length for the hash buckets' list, if it is
129 * reached, the table will grow
Javier Cardona5ee68e52011-08-09 16:45:08 -0700130 * @known_gates: list of known mesh gates and their mpaths by the station. The
131 * gate's mpath may or may not be resolved and active.
132 *
Johannes Berg1928eca2011-05-14 11:00:52 +0200133 * rcu_head: RCU head to free the table
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100134 */
135struct mesh_table {
136 /* Number of buckets will be 2^N */
137 struct hlist_head *hash_buckets;
138 spinlock_t *hashwlock; /* One per bucket, for add/del */
139 unsigned int hash_mask; /* (2^size_order) - 1 */
140 __u32 hash_rnd; /* Used for hash generation */
141 atomic_t entries; /* Up to MAX_MESH_NEIGHBOURS */
142 void (*free_node) (struct hlist_node *p, bool free_leafs);
Pavel Emelyanov4caf86c2008-05-07 19:47:01 +0400143 int (*copy_node) (struct hlist_node *p, struct mesh_table *newtbl);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100144 int size_order;
145 int mean_chain_len;
Javier Cardona5ee68e52011-08-09 16:45:08 -0700146 struct hlist_head *known_gates;
147 spinlock_t gates_lock;
Johannes Berg1928eca2011-05-14 11:00:52 +0200148
149 struct rcu_head rcu_head;
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100150};
151
152/* Recent multicast cache */
153/* RMC_BUCKETS must be a power of 2, maximum 256 */
154#define RMC_BUCKETS 256
155#define RMC_QUEUE_MAX_LEN 4
156#define RMC_TIMEOUT (3 * HZ)
157
158/**
159 * struct rmc_entry - entry in the Recent Multicast Cache
160 *
161 * @seqnum: mesh sequence number of the frame
162 * @exp_time: expiration time of the entry, in jiffies
163 * @sa: source address of the frame
164 *
165 * The Recent Multicast Cache keeps track of the latest multicast frames that
166 * have been received by a mesh interface and discards received multicast frames
167 * that are found in the cache.
168 */
169struct rmc_entry {
170 struct list_head list;
171 u32 seqnum;
172 unsigned long exp_time;
173 u8 sa[ETH_ALEN];
174};
175
176struct mesh_rmc {
177 struct rmc_entry bucket[RMC_BUCKETS];
Luis Carlos Cobo51cedda2008-04-23 12:15:29 -0700178 u32 idx_mask;
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100179};
180
Thomas Pedersen25d49e42011-08-11 19:35:15 -0700181#define IEEE80211_MESH_PEER_INACTIVITY_LIMIT (1800 * HZ)
182#define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ)
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100183
Javier Cardona5b365832009-08-10 12:15:51 -0700184#define MESH_DEFAULT_BEACON_INTERVAL 1000 /* in 1024 us units */
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100185
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100186#define MESH_PATH_EXPIRE (600 * HZ)
187
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100188/* Default maximum number of plinks per interface */
189#define MESH_MAX_PLINKS 256
190
191/* Maximum number of paths per interface */
192#define MESH_MAX_MPATHS 1024
193
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100194/* Public interfaces */
195/* Various */
Javier Cardona3c5772a2009-08-10 12:15:48 -0700196int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc,
Johannes Berg15ff6362009-11-17 13:34:04 +0100197 const u8 *da, const u8 *sa);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100198int ieee80211_new_mesh_header(struct ieee80211s_hdr *meshhdr,
Javier Cardona61ad5392010-12-16 17:23:34 -0800199 struct ieee80211_sub_if_data *sdata, char *addr4or5,
200 char *addr6);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100201int mesh_rmc_check(u8 *addr, struct ieee80211s_hdr *mesh_hdr,
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200202 struct ieee80211_sub_if_data *sdata);
203bool mesh_matches_local(struct ieee802_11_elems *ie,
204 struct ieee80211_sub_if_data *sdata);
Johannes Berg472dbc42008-09-11 00:01:49 +0200205void mesh_ids_set_default(struct ieee80211_if_mesh *mesh);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200206void mesh_mgmt_ies_add(struct sk_buff *skb,
207 struct ieee80211_sub_if_data *sdata);
Thomas Pedersen082ebb02011-08-11 19:35:10 -0700208int mesh_add_meshconf_ie(struct sk_buff *skb,
209 struct ieee80211_sub_if_data *sdata);
210int mesh_add_meshid_ie(struct sk_buff *skb,
211 struct ieee80211_sub_if_data *sdata);
212int mesh_add_rsn_ie(struct sk_buff *skb,
213 struct ieee80211_sub_if_data *sdata);
214int mesh_add_vendor_ies(struct sk_buff *skb,
215 struct ieee80211_sub_if_data *sdata);
Thomas Pedersen082ebb02011-08-11 19:35:10 -0700216int mesh_add_ds_params_ie(struct sk_buff *skb,
217 struct ieee80211_sub_if_data *sdata);
Thomas Pedersen176f3602011-10-26 14:47:27 -0700218int mesh_add_ht_cap_ie(struct sk_buff *skb,
219 struct ieee80211_sub_if_data *sdata);
220int mesh_add_ht_info_ie(struct sk_buff *skb,
221 struct ieee80211_sub_if_data *sdata);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200222void mesh_rmc_free(struct ieee80211_sub_if_data *sdata);
223int mesh_rmc_init(struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100224void ieee80211s_init(void);
Javier Cardonabfc32e62009-08-17 17:15:55 -0700225void ieee80211s_update_metric(struct ieee80211_local *local,
226 struct sta_info *stainfo, struct sk_buff *skb);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100227void ieee80211s_stop(void);
Johannes Berg902acc72008-02-23 15:17:19 +0100228void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata);
Johannes Berg472dbc42008-09-11 00:01:49 +0200229void ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata);
230void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata);
Rui Paulo63c57232009-11-09 23:46:57 +0000231void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh);
Johannes Berg902acc72008-02-23 15:17:19 +0100232
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100233/* Mesh paths */
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200234int mesh_nexthop_lookup(struct sk_buff *skb,
235 struct ieee80211_sub_if_data *sdata);
236void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata);
237struct mesh_path *mesh_path_lookup(u8 *dst,
238 struct ieee80211_sub_if_data *sdata);
YanBo79617de2008-09-22 13:30:32 +0800239struct mesh_path *mpp_path_lookup(u8 *dst,
240 struct ieee80211_sub_if_data *sdata);
241int mpp_path_add(u8 *dst, u8 *mpp, struct ieee80211_sub_if_data *sdata);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200242struct mesh_path *mesh_path_lookup_by_idx(int idx,
243 struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100244void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200245void mesh_path_expire(struct ieee80211_sub_if_data *sdata);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200246void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata,
247 struct ieee80211_mgmt *mgmt, size_t len);
248int mesh_path_add(u8 *dst, struct ieee80211_sub_if_data *sdata);
Javier Cardona5ee68e52011-08-09 16:45:08 -0700249
250int mesh_path_add_gate(struct mesh_path *mpath);
251int mesh_path_send_to_gates(struct mesh_path *mpath);
252int mesh_gate_num(struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100253/* Mesh plinks */
Johannes Berg881d9482009-01-21 15:13:48 +0100254void mesh_neighbour_update(u8 *hw_addr, u32 rates,
Javier Cardona1570ca52011-04-07 15:08:35 -0700255 struct ieee80211_sub_if_data *sdata,
256 struct ieee802_11_elems *ie);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200257bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie);
Johannes Bergd0709a62008-02-25 16:27:46 +0100258void mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100259void mesh_plink_broken(struct sta_info *sta);
260void mesh_plink_deactivate(struct sta_info *sta);
261int mesh_plink_open(struct sta_info *sta);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100262void mesh_plink_block(struct sta_info *sta);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200263void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata,
264 struct ieee80211_mgmt *mgmt, size_t len,
265 struct ieee80211_rx_status *rx_status);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100266
267/* Private interfaces */
268/* Mesh tables */
Javier Cardona18889232009-08-10 12:15:52 -0700269void mesh_mpath_table_grow(void);
270void mesh_mpp_table_grow(void);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100271/* Mesh paths */
Rui Paulod19b3bf2009-11-09 23:46:55 +0000272int mesh_path_error_tx(u8 ttl, u8 *target, __le32 target_sn, __le16 target_rcode,
Johannes Berg15ff6362009-11-17 13:34:04 +0100273 const u8 *ra, struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100274void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta);
275void mesh_path_flush_pending(struct mesh_path *mpath);
276void mesh_path_tx_pending(struct mesh_path *mpath);
277int mesh_pathtbl_init(void);
278void mesh_pathtbl_unregister(void);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200279int mesh_path_del(u8 *addr, struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100280void mesh_path_timer(unsigned long data);
281void mesh_path_flush_by_nexthop(struct sta_info *sta);
Javier Cardonaece1a2e2011-08-29 13:23:04 -0700282void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200283void mesh_path_discard_frame(struct sk_buff *skb,
284 struct ieee80211_sub_if_data *sdata);
Johannes Berg5bb644a2009-05-17 11:40:42 +0200285void mesh_path_quiesce(struct ieee80211_sub_if_data *sdata);
286void mesh_path_restart(struct ieee80211_sub_if_data *sdata);
Rui Pauloe304bfd2009-11-09 23:46:56 +0000287void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100288
Thomas Pedersen25d49e42011-08-11 19:35:15 -0700289bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt);
Johannes Bergf5ea9122009-08-07 16:17:38 +0200290extern int mesh_paths_generation;
291
Johannes Berg902acc72008-02-23 15:17:19 +0100292#ifdef CONFIG_MAC80211_MESH
293extern int mesh_allocated;
294
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100295static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata)
296{
Johannes Berg472dbc42008-09-11 00:01:49 +0200297 return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks -
298 atomic_read(&sdata->u.mesh.mshstats.estab_plinks);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100299}
300
301static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata)
302{
Johannes Bergd0709a62008-02-25 16:27:46 +0100303 return (min_t(long, mesh_plink_free_count(sdata),
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100304 MESH_MAX_PLINKS - sdata->local->num_sta)) > 0;
305}
306
307static inline void mesh_path_activate(struct mesh_path *mpath)
308{
309 mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED;
310}
311
Javier Cardonac7108a72010-12-16 17:37:50 -0800312static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
313{
314 return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP;
315}
316
Johannes Berg472dbc42008-09-11 00:01:49 +0200317void ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local);
318
Johannes Berg5bb644a2009-05-17 11:40:42 +0200319void ieee80211_mesh_quiesce(struct ieee80211_sub_if_data *sdata);
320void ieee80211_mesh_restart(struct ieee80211_sub_if_data *sdata);
321void mesh_plink_quiesce(struct sta_info *sta);
322void mesh_plink_restart(struct sta_info *sta);
Johannes Berg902acc72008-02-23 15:17:19 +0100323#else
324#define mesh_allocated 0
Johannes Berg472dbc42008-09-11 00:01:49 +0200325static inline void
326ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local) {}
Johannes Berg5bb644a2009-05-17 11:40:42 +0200327static inline void ieee80211_mesh_quiesce(struct ieee80211_sub_if_data *sdata)
328{}
329static inline void ieee80211_mesh_restart(struct ieee80211_sub_if_data *sdata)
330{}
331static inline void mesh_plink_quiesce(struct sta_info *sta) {}
332static inline void mesh_plink_restart(struct sta_info *sta) {}
Javier Cardonac7108a72010-12-16 17:37:50 -0800333static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
334{ return false; }
Johannes Berg902acc72008-02-23 15:17:19 +0100335#endif
336
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100337#endif /* IEEE80211S_H */