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