mesh.h 12.6 KB
Newer Older
1
/*
2
 * Copyright (c) 2008, 2009 open80211s Ltd.
3 4 5 6 7 8 9 10 11 12 13
 * Authors:    Luis Carlos Cobo <luisca@cozybit.com>
 *             Javier Cardona <javier@cozybit.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef IEEE80211S_H
#define IEEE80211S_H

Johannes Berg's avatar
Johannes Berg committed
14
#include <linux/types.h>
15
#include <linux/jhash.h>
Johannes Berg's avatar
Johannes Berg committed
16
#include "ieee80211_i.h"
17 18 19 20 21 22 23


/* Data structures */

/**
 * enum mesh_path_flags - mac80211 mesh path flags
 *
24 25
 * @MESH_PATH_ACTIVE: the mesh path can be used for forwarding
 * @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
Johannes Berg's avatar
Johannes Berg committed
27
 *	number
28
 * @MESH_PATH_FIXED: the mesh path has been manually set and should not be
Johannes Berg's avatar
Johannes Berg committed
29
 *	modified
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
Johannes Berg's avatar
Johannes Berg committed
32
 *	already queued up, waiting for the discovery process to start.
33 34
 * @MESH_PATH_DELETED: the mesh path has been deleted and should no longer
 *	be used
35
 *
36
 * MESH_PATH_RESOLVED is used by the mesh path timer to
37 38 39 40 41
 * decide when to stop or cancel the mesh path discovery.
 */
enum mesh_path_flags {
	MESH_PATH_ACTIVE =	BIT(0),
	MESH_PATH_RESOLVING =	BIT(1),
42
	MESH_PATH_SN_VALID =	BIT(2),
43 44
	MESH_PATH_FIXED	=	BIT(3),
	MESH_PATH_RESOLVED =	BIT(4),
45
	MESH_PATH_REQ_QUEUED =	BIT(5),
46
	MESH_PATH_DELETED =	BIT(6),
47 48
};

49 50 51 52 53 54
/**
 * enum mesh_deferred_task_flags - mac80211 mesh deferred tasks
 *
 *
 *
 * @MESH_WORK_HOUSEKEEPING: run the periodic mesh housekeeping tasks
55
 * @MESH_WORK_ROOT: the mesh root station needs to send a frame
56 57
 * @MESH_WORK_DRIFT_ADJUST: time to compensate for clock drift relative to other
 * mesh nodes
58
 * @MESH_WORK_MBSS_CHANGED: rebuild beacon and notify driver of BSS changes
59 60 61
 */
enum mesh_deferred_task_flags {
	MESH_WORK_HOUSEKEEPING,
62
	MESH_WORK_ROOT,
63
	MESH_WORK_DRIFT_ADJUST,
64
	MESH_WORK_MBSS_CHANGED,
65 66
};

67 68 69 70
/**
 * struct mesh_path - mac80211 mesh path structure
 *
 * @dst: mesh path destination mac address
71 72 73
 * @mpp: mesh proxy mac address
 * @rhash: rhashtable list pointer
 * @gate_list: list pointer for known gates list
74
 * @sdata: mesh subif
75
 * @next_hop: mesh neighbor to which frames for this destination will be
Johannes Berg's avatar
Johannes Berg committed
76
 *	forwarded
77 78
 * @timer: mesh path discovery timer
 * @frame_queue: pending queue for frames sent to this destination while the
Johannes Berg's avatar
Johannes Berg committed
79
 *	path is unresolved
80
 * @rcu: rcu head for freeing mesh path
81
 * @sn: target sequence number
82 83 84 85
 * @metric: current metric to this destination
 * @hop_count: hops to destination
 * @exp_time: in jiffies, when the path will expire or when it expired
 * @discovery_timeout: timeout (lapse in jiffies) used for the last discovery
Johannes Berg's avatar
Johannes Berg committed
86
 *	retry
87 88
 * @discovery_retries: number of discovery retries
 * @flags: mesh path flags, as specified on &enum mesh_path_flags
89 90 91
 * @state_lock: mesh path state lock used to protect changes to the
 * mpath itself.  No need to take this lock when adding or removing
 * an mpath to a hash bucket on a path table.
92
 * @rann_snd_addr: the RANN sender address
93
 * @rann_metric: the aggregated path metric towards the root node
94
 * @last_preq_to_root: Timestamp of last PREQ sent to root
95
 * @is_root: the destination station of this path is a root node
96
 * @is_gate: the destination station of this path is a mesh gate
97 98
 *
 *
99 100 101 102
 * The dst address is unique in the mesh path table. Since the mesh_path is
 * protected by RCU, deleting the next_hop STA must remove / substitute the
 * mesh_path structure and wait until that is no longer reachable before
 * destroying the STA completely.
103 104 105
 */
struct mesh_path {
	u8 dst[ETH_ALEN];
106
	u8 mpp[ETH_ALEN];	/* used for MPP or MAP */
107
	struct rhash_head rhash;
108
	struct hlist_node gate_list;
109
	struct ieee80211_sub_if_data *sdata;
110
	struct sta_info __rcu *next_hop;
111 112 113
	struct timer_list timer;
	struct sk_buff_head frame_queue;
	struct rcu_head rcu;
114
	u32 sn;
115 116 117 118 119 120 121
	u32 metric;
	u8 hop_count;
	unsigned long exp_time;
	u32 discovery_timeout;
	u8 discovery_retries;
	enum mesh_path_flags flags;
	spinlock_t state_lock;
122
	u8 rann_snd_addr[ETH_ALEN];
123
	u32 rann_metric;
124
	unsigned long last_preq_to_root;
125
	bool is_root;
126
	bool is_gate;
127 128 129 130 131
};

/**
 * struct mesh_table
 *
132 133
 * @known_gates: list of known mesh gates and their mpaths by the station. The
 * gate's mpath may or may not be resolved and active.
134 135 136
 * @gates_lock: protects updates to known_gates
 * @rhead: the rhashtable containing struct mesh_paths, keyed by dest addr
 * @entries: number of entries in the table
137 138
 */
struct mesh_table {
139
	struct hlist_head known_gates;
140
	spinlock_t gates_lock;
141
	struct rhashtable rhead;
142
	atomic_t entries;		/* Up to MAX_MESH_NEIGHBOURS */
143 144 145 146 147 148 149 150 151 152 153 154 155 156
};

/* Recent multicast cache */
/* RMC_BUCKETS must be a power of 2, maximum 256 */
#define RMC_BUCKETS		256
#define RMC_QUEUE_MAX_LEN	4
#define RMC_TIMEOUT		(3 * HZ)

/**
 * struct rmc_entry - entry in the Recent Multicast Cache
 *
 * @seqnum: mesh sequence number of the frame
 * @exp_time: expiration time of the entry, in jiffies
 * @sa: source address of the frame
157
 * @list: hashtable list pointer
158 159 160 161 162 163
 *
 * The Recent Multicast Cache keeps track of the latest multicast frames that
 * have been received by a mesh interface and discards received multicast frames
 * that are found in the cache.
 */
struct rmc_entry {
164
	struct hlist_node list;
165
	unsigned long exp_time;
166
	u32 seqnum;
167 168 169 170
	u8 sa[ETH_ALEN];
};

struct mesh_rmc {
171
	struct hlist_head bucket[RMC_BUCKETS];
172
	u32 idx_mask;
173 174
};

175
#define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ)
176 177 178 179 180 181 182 183 184

#define MESH_PATH_EXPIRE (600 * HZ)

/* Default maximum number of plinks per interface */
#define MESH_MAX_PLINKS		256

/* Maximum number of paths per interface */
#define MESH_MAX_MPATHS		1024

185 186 187
/* Number of frames buffered per destination for unresolved destinations */
#define MESH_FRAME_QUEUE_LEN	10

188 189
/* Public interfaces */
/* Various */
190
int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc,
191
				  const u8 *da, const u8 *sa);
192 193 194
unsigned int ieee80211_new_mesh_header(struct ieee80211_sub_if_data *sdata,
				       struct ieee80211s_hdr *meshhdr,
				       const char *addr4or5, const char *addr6);
Johannes Berg's avatar
Johannes Berg committed
195 196
int mesh_rmc_check(struct ieee80211_sub_if_data *sdata,
		   const u8 *addr, struct ieee80211s_hdr *mesh_hdr);
197 198
bool mesh_matches_local(struct ieee80211_sub_if_data *sdata,
			struct ieee802_11_elems *ie);
199
void mesh_ids_set_default(struct ieee80211_if_mesh *mesh);
Johannes Berg's avatar
Johannes Berg committed
200 201 202 203 204 205 206 207 208 209 210 211
int mesh_add_meshconf_ie(struct ieee80211_sub_if_data *sdata,
			 struct sk_buff *skb);
int mesh_add_meshid_ie(struct ieee80211_sub_if_data *sdata,
		       struct sk_buff *skb);
int mesh_add_rsn_ie(struct ieee80211_sub_if_data *sdata,
		    struct sk_buff *skb);
int mesh_add_vendor_ies(struct ieee80211_sub_if_data *sdata,
			struct sk_buff *skb);
int mesh_add_ht_cap_ie(struct ieee80211_sub_if_data *sdata,
		       struct sk_buff *skb);
int mesh_add_ht_oper_ie(struct ieee80211_sub_if_data *sdata,
			struct sk_buff *skb);
212 213 214 215
int mesh_add_vht_cap_ie(struct ieee80211_sub_if_data *sdata,
			struct sk_buff *skb);
int mesh_add_vht_oper_ie(struct ieee80211_sub_if_data *sdata,
			 struct sk_buff *skb);
216 217
void mesh_rmc_free(struct ieee80211_sub_if_data *sdata);
int mesh_rmc_init(struct ieee80211_sub_if_data *sdata);
218
void ieee80211s_init(void);
219
void ieee80211s_update_metric(struct ieee80211_local *local,
Johannes Berg's avatar
Johannes Berg committed
220
			      struct sta_info *sta, struct sk_buff *skb);
Johannes Berg's avatar
Johannes Berg committed
221
void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata);
222
void ieee80211_mesh_teardown_sdata(struct ieee80211_sub_if_data *sdata);
223
int ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata);
224
void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata);
225
void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh);
226
const struct ieee80211_mesh_sync_ops *ieee80211_mesh_sync_ops_get(u8 method);
227 228 229
/* wrapper for ieee80211_bss_info_change_notify() */
void ieee80211_mbss_info_change_notify(struct ieee80211_sub_if_data *sdata,
				       u32 changed);
Johannes Berg's avatar
Johannes Berg committed
230

231
/* mesh power save */
232 233 234
u32 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata);
u32 ieee80211_mps_set_sta_local_pm(struct sta_info *sta,
				   enum nl80211_mesh_power_mode pm);
235 236 237 238 239 240 241 242 243 244 245
void ieee80211_mps_set_frame_flags(struct ieee80211_sub_if_data *sdata,
				   struct sta_info *sta,
				   struct ieee80211_hdr *hdr);
void ieee80211_mps_sta_status_update(struct sta_info *sta);
void ieee80211_mps_rx_h_sta_process(struct sta_info *sta,
				    struct ieee80211_hdr *hdr);
void ieee80211_mpsp_trigger_process(u8 *qc, struct sta_info *sta,
				    bool tx, bool acked);
void ieee80211_mps_frame_release(struct sta_info *sta,
				 struct ieee802_11_elems *elems);

246
/* Mesh paths */
Johannes Berg's avatar
Johannes Berg committed
247 248 249 250
int mesh_nexthop_lookup(struct ieee80211_sub_if_data *sdata,
			struct sk_buff *skb);
int mesh_nexthop_resolve(struct ieee80211_sub_if_data *sdata,
			 struct sk_buff *skb);
251
void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata);
Johannes Berg's avatar
Johannes Berg committed
252 253 254 255 256 257 258 259
struct mesh_path *mesh_path_lookup(struct ieee80211_sub_if_data *sdata,
				   const u8 *dst);
struct mesh_path *mpp_path_lookup(struct ieee80211_sub_if_data *sdata,
				  const u8 *dst);
int mpp_path_add(struct ieee80211_sub_if_data *sdata,
		 const u8 *dst, const u8 *mpp);
struct mesh_path *
mesh_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
260 261
struct mesh_path *
mpp_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
262
void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop);
263 264
void mesh_path_expire(struct ieee80211_sub_if_data *sdata);
void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata,
Johannes Berg's avatar
Johannes Berg committed
265
			    struct ieee80211_mgmt *mgmt, size_t len);
266 267
struct mesh_path *
mesh_path_add(struct ieee80211_sub_if_data *sdata, const u8 *dst);
268 269 270 271

int mesh_path_add_gate(struct mesh_path *mpath);
int mesh_path_send_to_gates(struct mesh_path *mpath);
int mesh_gate_num(struct ieee80211_sub_if_data *sdata);
Johannes Berg's avatar
Johannes Berg committed
272

273
/* Mesh plinks */
274
void mesh_neighbour_update(struct ieee80211_sub_if_data *sdata,
Johannes Berg's avatar
Johannes Berg committed
275
			   u8 *hw_addr, struct ieee802_11_elems *ie);
276
bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie);
277
u32 mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata);
278
void mesh_plink_broken(struct sta_info *sta);
279
u32 mesh_plink_deactivate(struct sta_info *sta);
280 281
u32 mesh_plink_open(struct sta_info *sta);
u32 mesh_plink_block(struct sta_info *sta);
282 283 284
void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata,
			 struct ieee80211_mgmt *mgmt, size_t len,
			 struct ieee80211_rx_status *rx_status);
285
void mesh_sta_cleanup(struct sta_info *sta);
286 287 288

/* Private interfaces */
/* Mesh paths */
Johannes Berg's avatar
Johannes Berg committed
289
int mesh_path_error_tx(struct ieee80211_sub_if_data *sdata,
290 291
		       u8 ttl, const u8 *target, u32 target_sn,
		       u16 target_rcode, const u8 *ra);
292 293 294
void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta);
void mesh_path_flush_pending(struct mesh_path *mpath);
void mesh_path_tx_pending(struct mesh_path *mpath);
295 296
int mesh_pathtbl_init(struct ieee80211_sub_if_data *sdata);
void mesh_pathtbl_unregister(struct ieee80211_sub_if_data *sdata);
Johannes Berg's avatar
Johannes Berg committed
297
int mesh_path_del(struct ieee80211_sub_if_data *sdata, const u8 *addr);
298 299
void mesh_path_timer(unsigned long data);
void mesh_path_flush_by_nexthop(struct sta_info *sta);
Johannes Berg's avatar
Johannes Berg committed
300 301
void mesh_path_discard_frame(struct ieee80211_sub_if_data *sdata,
			     struct sk_buff *skb);
302
void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata);
303

304
bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt);
305

Johannes Berg's avatar
Johannes Berg committed
306
#ifdef CONFIG_MAC80211_MESH
307 308 309 310
static inline
u32 mesh_plink_inc_estab_count(struct ieee80211_sub_if_data *sdata)
{
	atomic_inc(&sdata->u.mesh.estab_plinks);
311
	return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON;
312 313 314 315 316 317
}

static inline
u32 mesh_plink_dec_estab_count(struct ieee80211_sub_if_data *sdata)
{
	atomic_dec(&sdata->u.mesh.estab_plinks);
318
	return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON;
319 320
}

321 322
static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata)
{
323
	return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks -
324
	       atomic_read(&sdata->u.mesh.estab_plinks);
325 326 327 328
}

static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata)
{
329
	return (min_t(long, mesh_plink_free_count(sdata),
330 331 332 333 334 335 336 337
		   MESH_MAX_PLINKS - sdata->local->num_sta)) > 0;
}

static inline void mesh_path_activate(struct mesh_path *mpath)
{
	mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED;
}

338 339 340 341 342
static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
{
	return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP;
}

343
void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata);
344
void mesh_sync_adjust_tbtt(struct ieee80211_sub_if_data *sdata);
Johannes Berg's avatar
Johannes Berg committed
345
void ieee80211s_stop(void);
Johannes Berg's avatar
Johannes Berg committed
346
#else
347 348
static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
{ return false; }
349 350
static inline void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata)
{}
Johannes Berg's avatar
Johannes Berg committed
351
static inline void ieee80211s_stop(void) {}
Johannes Berg's avatar
Johannes Berg committed
352 353
#endif

354
#endif /* IEEE80211S_H */