blob: c7e5c49471e5e8701f3ce602b189eb3acadb88ec [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>
Johannes Berg902acc72008-02-23 15:17:19 +010016#include "ieee80211_i.h"
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010017
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010018
19/* Data structures */
20
21/**
22 * enum mesh_path_flags - mac80211 mesh path flags
23 *
24 *
25 *
Rami Roseneb80ed82009-01-19 13:50:32 +020026 * @MESH_PATH_ACTIVE: the mesh path can be used for forwarding
27 * @MESH_PATH_RESOLVING: the discovery process is running for this mesh path
Rui Paulod19b3bf2009-11-09 23:46:55 +000028 * @MESH_PATH_SN_VALID: the mesh path contains a valid destination sequence
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010029 * number
30 * @MESH_PATH_FIXED: the mesh path has been manually set and should not be
31 * modified
32 * @MESH_PATH_RESOLVED: the mesh path can has been resolved
Javier Cardonaf3011cf2011-11-03 21:11:10 -070033 * @MESH_PATH_REQ_QUEUED: there is an unsent path request for this destination
34 * already queued up, waiting for the discovery process to start.
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010035 *
Rami Roseneb80ed82009-01-19 13:50:32 +020036 * MESH_PATH_RESOLVED is used by the mesh path timer to
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010037 * 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),
Rui Paulod19b3bf2009-11-09 23:46:55 +000042 MESH_PATH_SN_VALID = BIT(2),
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010043 MESH_PATH_FIXED = BIT(3),
44 MESH_PATH_RESOLVED = BIT(4),
Javier Cardonaf3011cf2011-11-03 21:11:10 -070045 MESH_PATH_REQ_QUEUED = BIT(5),
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010046};
47
48/**
Javier Cardona18889232009-08-10 12:15:52 -070049 * 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
Rui Pauloe304bfd2009-11-09 23:46:56 +000058 * @MESH_WORK_ROOT: the mesh root station needs to send a frame
Javier Cardona18889232009-08-10 12:15:52 -070059 */
60enum mesh_deferred_task_flags {
61 MESH_WORK_HOUSEKEEPING,
62 MESH_WORK_GROW_MPATH_TABLE,
63 MESH_WORK_GROW_MPP_TABLE,
Rui Pauloe304bfd2009-11-09 23:46:56 +000064 MESH_WORK_ROOT,
Javier Cardona18889232009-08-10 12:15:52 -070065};
66
67/**
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010068 * struct mesh_path - mac80211 mesh path structure
69 *
70 * @dst: mesh path destination mac address
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +120071 * @sdata: mesh subif
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010072 * @next_hop: mesh neighbor to which frames for this destination will be
73 * forwarded
74 * @timer: mesh path discovery timer
75 * @frame_queue: pending queue for frames sent to this destination while the
76 * path is unresolved
Rui Paulod19b3bf2009-11-09 23:46:55 +000077 * @sn: target sequence number
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010078 * @metric: current metric to this destination
79 * @hop_count: hops to destination
80 * @exp_time: in jiffies, when the path will expire or when it expired
81 * @discovery_timeout: timeout (lapse in jiffies) used for the last discovery
82 * retry
83 * @discovery_retries: number of discovery retries
84 * @flags: mesh path flags, as specified on &enum mesh_path_flags
Javier Cardonaf5e50cd2011-08-29 13:23:05 -070085 * @state_lock: mesh path state lock used to protect changes to the
86 * mpath itself. No need to take this lock when adding or removing
87 * an mpath to a hash bucket on a path table.
Javier Cardona5ee68e52011-08-09 16:45:08 -070088 * @is_gate: the destination station of this path is a mesh gate
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010089 *
90 *
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +120091 * The combination of dst and sdata is unique in the mesh path table. Since the
Johannes Bergd0709a62008-02-25 16:27:46 +010092 * next_hop STA is only protected by RCU as well, deleting the STA must also
93 * remove/substitute the mesh_path structure and wait until that is no longer
94 * reachable before destroying the STA completely.
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +010095 */
96struct mesh_path {
97 u8 dst[ETH_ALEN];
YanBo79617de2008-09-22 13:30:32 +080098 u8 mpp[ETH_ALEN]; /* used for MPP or MAP */
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +120099 struct ieee80211_sub_if_data *sdata;
Johannes Berg40b275b2011-05-13 14:15:49 +0200100 struct sta_info __rcu *next_hop;
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100101 struct timer_list timer;
102 struct sk_buff_head frame_queue;
103 struct rcu_head rcu;
Rui Paulod19b3bf2009-11-09 23:46:55 +0000104 u32 sn;
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100105 u32 metric;
106 u8 hop_count;
107 unsigned long exp_time;
108 u32 discovery_timeout;
109 u8 discovery_retries;
110 enum mesh_path_flags flags;
111 spinlock_t state_lock;
Javier Cardona5ee68e52011-08-09 16:45:08 -0700112 bool is_gate;
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100113};
114
115/**
116 * struct mesh_table
117 *
118 * @hash_buckets: array of hash buckets of the table
119 * @hashwlock: array of locks to protect write operations, one per bucket
120 * @hash_mask: 2^size_order - 1, used to compute hash idx
121 * @hash_rnd: random value used for hash computations
122 * @entries: number of entries in the table
123 * @free_node: function to free nodes of the table
Stefan Weileef35c22010-08-06 21:11:15 +0200124 * @copy_node: function to copy nodes of the table
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100125 * @size_order: determines size of the table, there will be 2^size_order hash
126 * buckets
127 * @mean_chain_len: maximum average length for the hash buckets' list, if it is
128 * reached, the table will grow
Javier Cardona5ee68e52011-08-09 16:45:08 -0700129 * @known_gates: list of known mesh gates and their mpaths by the station. The
130 * gate's mpath may or may not be resolved and active.
131 *
Johannes Berg1928eca2011-05-14 11:00:52 +0200132 * rcu_head: RCU head to free the table
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100133 */
134struct mesh_table {
135 /* Number of buckets will be 2^N */
136 struct hlist_head *hash_buckets;
137 spinlock_t *hashwlock; /* One per bucket, for add/del */
138 unsigned int hash_mask; /* (2^size_order) - 1 */
139 __u32 hash_rnd; /* Used for hash generation */
140 atomic_t entries; /* Up to MAX_MESH_NEIGHBOURS */
141 void (*free_node) (struct hlist_node *p, bool free_leafs);
Pavel Emelyanov4caf86c2008-05-07 19:47:01 +0400142 int (*copy_node) (struct hlist_node *p, struct mesh_table *newtbl);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100143 int size_order;
144 int mean_chain_len;
Javier Cardona5ee68e52011-08-09 16:45:08 -0700145 struct hlist_head *known_gates;
146 spinlock_t gates_lock;
Johannes Berg1928eca2011-05-14 11:00:52 +0200147
148 struct rcu_head rcu_head;
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100149};
150
151/* Recent multicast cache */
152/* RMC_BUCKETS must be a power of 2, maximum 256 */
153#define RMC_BUCKETS 256
154#define RMC_QUEUE_MAX_LEN 4
155#define RMC_TIMEOUT (3 * HZ)
156
157/**
158 * struct rmc_entry - entry in the Recent Multicast Cache
159 *
160 * @seqnum: mesh sequence number of the frame
161 * @exp_time: expiration time of the entry, in jiffies
162 * @sa: source address of the frame
163 *
164 * The Recent Multicast Cache keeps track of the latest multicast frames that
165 * have been received by a mesh interface and discards received multicast frames
166 * that are found in the cache.
167 */
168struct rmc_entry {
169 struct list_head list;
170 u32 seqnum;
171 unsigned long exp_time;
172 u8 sa[ETH_ALEN];
173};
174
175struct mesh_rmc {
176 struct rmc_entry bucket[RMC_BUCKETS];
Luis Carlos Cobo51cedda2008-04-23 12:15:29 -0700177 u32 idx_mask;
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100178};
179
Thomas Pedersen25d49e42011-08-11 19:35:15 -0700180#define IEEE80211_MESH_PEER_INACTIVITY_LIMIT (1800 * HZ)
181#define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ)
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100182
Javier Cardona5b365832009-08-10 12:15:51 -0700183#define MESH_DEFAULT_BEACON_INTERVAL 1000 /* in 1024 us units */
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100184
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100185#define MESH_PATH_EXPIRE (600 * HZ)
186
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100187/* Default maximum number of plinks per interface */
188#define MESH_MAX_PLINKS 256
189
190/* Maximum number of paths per interface */
191#define MESH_MAX_MPATHS 1024
192
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100193/* Public interfaces */
194/* Various */
Javier Cardona3c5772a2009-08-10 12:15:48 -0700195int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc,
Johannes Berg15ff6362009-11-17 13:34:04 +0100196 const u8 *da, const u8 *sa);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100197int ieee80211_new_mesh_header(struct ieee80211s_hdr *meshhdr,
Javier Cardona61ad5392010-12-16 17:23:34 -0800198 struct ieee80211_sub_if_data *sdata, char *addr4or5,
199 char *addr6);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100200int mesh_rmc_check(u8 *addr, struct ieee80211s_hdr *mesh_hdr,
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200201 struct ieee80211_sub_if_data *sdata);
202bool mesh_matches_local(struct ieee802_11_elems *ie,
203 struct ieee80211_sub_if_data *sdata);
Johannes Berg472dbc42008-09-11 00:01:49 +0200204void mesh_ids_set_default(struct ieee80211_if_mesh *mesh);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200205void mesh_mgmt_ies_add(struct sk_buff *skb,
206 struct ieee80211_sub_if_data *sdata);
Thomas Pedersen082ebb02011-08-11 19:35:10 -0700207int mesh_add_meshconf_ie(struct sk_buff *skb,
208 struct ieee80211_sub_if_data *sdata);
209int mesh_add_meshid_ie(struct sk_buff *skb,
210 struct ieee80211_sub_if_data *sdata);
211int mesh_add_rsn_ie(struct sk_buff *skb,
212 struct ieee80211_sub_if_data *sdata);
213int mesh_add_vendor_ies(struct sk_buff *skb,
214 struct ieee80211_sub_if_data *sdata);
Thomas Pedersen082ebb02011-08-11 19:35:10 -0700215int mesh_add_ds_params_ie(struct sk_buff *skb,
216 struct ieee80211_sub_if_data *sdata);
Thomas Pedersen176f3602011-10-26 14:47:27 -0700217int mesh_add_ht_cap_ie(struct sk_buff *skb,
218 struct ieee80211_sub_if_data *sdata);
219int mesh_add_ht_info_ie(struct sk_buff *skb,
220 struct ieee80211_sub_if_data *sdata);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200221void mesh_rmc_free(struct ieee80211_sub_if_data *sdata);
222int mesh_rmc_init(struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100223void ieee80211s_init(void);
Javier Cardonabfc32e62009-08-17 17:15:55 -0700224void ieee80211s_update_metric(struct ieee80211_local *local,
225 struct sta_info *stainfo, struct sk_buff *skb);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100226void ieee80211s_stop(void);
Johannes Berg902acc72008-02-23 15:17:19 +0100227void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata);
Johannes Berg472dbc42008-09-11 00:01:49 +0200228void ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata);
229void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata);
Rui Paulo63c57232009-11-09 23:46:57 +0000230void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh);
Johannes Berg902acc72008-02-23 15:17:19 +0100231
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100232/* Mesh paths */
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200233int mesh_nexthop_lookup(struct sk_buff *skb,
234 struct ieee80211_sub_if_data *sdata);
Thomas Pedersen0cfda852011-11-24 17:15:25 -0800235int mesh_nexthop_resolve(struct sk_buff *skb,
236 struct ieee80211_sub_if_data *sdata);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200237void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata);
238struct mesh_path *mesh_path_lookup(u8 *dst,
239 struct ieee80211_sub_if_data *sdata);
YanBo79617de2008-09-22 13:30:32 +0800240struct mesh_path *mpp_path_lookup(u8 *dst,
241 struct ieee80211_sub_if_data *sdata);
242int mpp_path_add(u8 *dst, u8 *mpp, struct ieee80211_sub_if_data *sdata);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200243struct mesh_path *mesh_path_lookup_by_idx(int idx,
244 struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100245void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200246void mesh_path_expire(struct ieee80211_sub_if_data *sdata);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200247void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata,
248 struct ieee80211_mgmt *mgmt, size_t len);
249int mesh_path_add(u8 *dst, struct ieee80211_sub_if_data *sdata);
Javier Cardona5ee68e52011-08-09 16:45:08 -0700250
251int mesh_path_add_gate(struct mesh_path *mpath);
252int mesh_path_send_to_gates(struct mesh_path *mpath);
253int mesh_gate_num(struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100254/* Mesh plinks */
Johannes Berg881d9482009-01-21 15:13:48 +0100255void mesh_neighbour_update(u8 *hw_addr, u32 rates,
Javier Cardona1570ca52011-04-07 15:08:35 -0700256 struct ieee80211_sub_if_data *sdata,
257 struct ieee802_11_elems *ie);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200258bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie);
Johannes Bergd0709a62008-02-25 16:27:46 +0100259void mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100260void mesh_plink_broken(struct sta_info *sta);
261void mesh_plink_deactivate(struct sta_info *sta);
262int mesh_plink_open(struct sta_info *sta);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100263void mesh_plink_block(struct sta_info *sta);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200264void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata,
265 struct ieee80211_mgmt *mgmt, size_t len,
266 struct ieee80211_rx_status *rx_status);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100267
268/* Private interfaces */
269/* Mesh tables */
Javier Cardona18889232009-08-10 12:15:52 -0700270void mesh_mpath_table_grow(void);
271void mesh_mpp_table_grow(void);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100272/* Mesh paths */
Rui Paulod19b3bf2009-11-09 23:46:55 +0000273int mesh_path_error_tx(u8 ttl, u8 *target, __le32 target_sn, __le16 target_rcode,
Johannes Berg15ff6362009-11-17 13:34:04 +0100274 const u8 *ra, struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100275void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta);
276void mesh_path_flush_pending(struct mesh_path *mpath);
277void mesh_path_tx_pending(struct mesh_path *mpath);
278int mesh_pathtbl_init(void);
279void mesh_pathtbl_unregister(void);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200280int mesh_path_del(u8 *addr, struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100281void mesh_path_timer(unsigned long data);
282void mesh_path_flush_by_nexthop(struct sta_info *sta);
Javier Cardonaece1a2e2011-08-29 13:23:04 -0700283void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata);
Jasper Bryant-Greenef698d852008-08-03 12:04:37 +1200284void mesh_path_discard_frame(struct sk_buff *skb,
285 struct ieee80211_sub_if_data *sdata);
Johannes Berg5bb644a2009-05-17 11:40:42 +0200286void mesh_path_quiesce(struct ieee80211_sub_if_data *sdata);
287void mesh_path_restart(struct ieee80211_sub_if_data *sdata);
Rui Pauloe304bfd2009-11-09 23:46:56 +0000288void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100289
Thomas Pedersen25d49e42011-08-11 19:35:15 -0700290bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt);
Johannes Bergf5ea9122009-08-07 16:17:38 +0200291extern int mesh_paths_generation;
292
Johannes Berg902acc72008-02-23 15:17:19 +0100293#ifdef CONFIG_MAC80211_MESH
294extern int mesh_allocated;
295
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100296static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata)
297{
Johannes Berg472dbc42008-09-11 00:01:49 +0200298 return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks -
299 atomic_read(&sdata->u.mesh.mshstats.estab_plinks);
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100300}
301
302static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata)
303{
Johannes Bergd0709a62008-02-25 16:27:46 +0100304 return (min_t(long, mesh_plink_free_count(sdata),
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100305 MESH_MAX_PLINKS - sdata->local->num_sta)) > 0;
306}
307
308static inline void mesh_path_activate(struct mesh_path *mpath)
309{
310 mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED;
311}
312
Javier Cardonac7108a72010-12-16 17:37:50 -0800313static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
314{
315 return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP;
316}
317
Johannes Berg472dbc42008-09-11 00:01:49 +0200318void ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local);
319
Johannes Berg5bb644a2009-05-17 11:40:42 +0200320void ieee80211_mesh_quiesce(struct ieee80211_sub_if_data *sdata);
321void ieee80211_mesh_restart(struct ieee80211_sub_if_data *sdata);
322void mesh_plink_quiesce(struct sta_info *sta);
323void mesh_plink_restart(struct sta_info *sta);
Johannes Berg902acc72008-02-23 15:17:19 +0100324#else
325#define mesh_allocated 0
Johannes Berg472dbc42008-09-11 00:01:49 +0200326static inline void
327ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local) {}
Johannes Berg5bb644a2009-05-17 11:40:42 +0200328static inline void ieee80211_mesh_quiesce(struct ieee80211_sub_if_data *sdata)
329{}
330static inline void ieee80211_mesh_restart(struct ieee80211_sub_if_data *sdata)
331{}
332static inline void mesh_plink_quiesce(struct sta_info *sta) {}
333static inline void mesh_plink_restart(struct sta_info *sta) {}
Javier Cardonac7108a72010-12-16 17:37:50 -0800334static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
335{ return false; }
Johannes Berg902acc72008-02-23 15:17:19 +0100336#endif
337
Luis Carlos Coboccf80dd2008-02-23 15:17:08 +0100338#endif /* IEEE80211S_H */