batman-adv: protect originator nodes with reference counters
[linux-3.10.git] / net / batman-adv / types.h
1 /*
2  * Copyright (C) 2007-2011 B.A.T.M.A.N. contributors:
3  *
4  * Marek Lindner, Simon Wunderlich
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of version 2 of the GNU General Public
8  * License as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18  * 02110-1301, USA
19  *
20  */
21
22
23
24 #ifndef _NET_BATMAN_ADV_TYPES_H_
25 #define _NET_BATMAN_ADV_TYPES_H_
26
27 #include "packet.h"
28 #include "bitarray.h"
29
30 #define BAT_HEADER_LEN (sizeof(struct ethhdr) + \
31         ((sizeof(struct unicast_packet) > sizeof(struct bcast_packet) ? \
32          sizeof(struct unicast_packet) : \
33          sizeof(struct bcast_packet))))
34
35
36 struct batman_if {
37         struct list_head list;
38         int16_t if_num;
39         char if_status;
40         struct net_device *net_dev;
41         atomic_t seqno;
42         atomic_t frag_seqno;
43         unsigned char *packet_buff;
44         int packet_len;
45         struct kobject *hardif_obj;
46         struct kref refcount;
47         struct packet_type batman_adv_ptype;
48         struct net_device *soft_iface;
49         struct rcu_head rcu;
50 };
51
52 /**
53  *      orig_node - structure for orig_list maintaining nodes of mesh
54  *      @primary_addr: hosts primary interface address
55  *      @last_valid: when last packet from this node was received
56  *      @bcast_seqno_reset: time when the broadcast seqno window was reset
57  *      @batman_seqno_reset: time when the batman seqno window was reset
58  *      @gw_flags: flags related to gateway class
59  *      @flags: for now only VIS_SERVER flag
60  *      @last_real_seqno: last and best known squence number
61  *      @last_ttl: ttl of last received packet
62  *      @last_bcast_seqno: last broadcast sequence number received by this host
63  *
64  *      @candidates: how many candidates are available
65  *      @selected: next bonding candidate
66  */
67 struct orig_node {
68         uint8_t orig[ETH_ALEN];
69         uint8_t primary_addr[ETH_ALEN];
70         struct neigh_node *router;
71         unsigned long *bcast_own;
72         uint8_t *bcast_own_sum;
73         uint8_t tq_own;
74         int tq_asym_penalty;
75         unsigned long last_valid;
76         unsigned long bcast_seqno_reset;
77         unsigned long batman_seqno_reset;
78         uint8_t gw_flags;
79         uint8_t flags;
80         unsigned char *hna_buff;
81         int16_t hna_buff_len;
82         uint32_t last_real_seqno;
83         uint8_t last_ttl;
84         unsigned long bcast_bits[NUM_WORDS];
85         uint32_t last_bcast_seqno;
86         struct hlist_head neigh_list;
87         struct list_head frag_list;
88         spinlock_t neigh_list_lock; /* protects neighbor list */
89         struct kref refcount;
90         struct bat_priv *bat_priv;
91         unsigned long last_frag_packet;
92         struct {
93                 uint8_t candidates;
94                 struct neigh_node *selected;
95         } bond;
96 };
97
98 struct gw_node {
99         struct hlist_node list;
100         struct orig_node *orig_node;
101         unsigned long deleted;
102         struct kref refcount;
103         struct rcu_head rcu;
104 };
105
106 /**
107  *      neigh_node
108  *      @last_valid: when last packet via this neighbor was received
109  */
110 struct neigh_node {
111         struct hlist_node list;
112         uint8_t addr[ETH_ALEN];
113         uint8_t real_packet_count;
114         uint8_t tq_recv[TQ_GLOBAL_WINDOW_SIZE];
115         uint8_t tq_index;
116         uint8_t tq_avg;
117         uint8_t last_ttl;
118         struct neigh_node *next_bond_candidate;
119         unsigned long last_valid;
120         unsigned long real_bits[NUM_WORDS];
121         struct kref refcount;
122         struct rcu_head rcu;
123         struct orig_node *orig_node;
124         struct batman_if *if_incoming;
125 };
126
127
128 struct bat_priv {
129         atomic_t mesh_state;
130         struct net_device_stats stats;
131         atomic_t aggregated_ogms;       /* boolean */
132         atomic_t bonding;               /* boolean */
133         atomic_t fragmentation;         /* boolean */
134         atomic_t vis_mode;              /* VIS_TYPE_* */
135         atomic_t gw_mode;               /* GW_MODE_* */
136         atomic_t gw_sel_class;          /* uint */
137         atomic_t gw_bandwidth;          /* gw bandwidth */
138         atomic_t orig_interval;         /* uint */
139         atomic_t hop_penalty;           /* uint */
140         atomic_t log_level;             /* uint */
141         atomic_t bcast_seqno;
142         atomic_t bcast_queue_left;
143         atomic_t batman_queue_left;
144         char num_ifaces;
145         struct hlist_head softif_neigh_list;
146         struct softif_neigh *softif_neigh;
147         struct debug_log *debug_log;
148         struct batman_if *primary_if;
149         struct kobject *mesh_obj;
150         struct dentry *debug_dir;
151         struct hlist_head forw_bat_list;
152         struct hlist_head forw_bcast_list;
153         struct hlist_head gw_list;
154         struct list_head vis_send_list;
155         struct hashtable_t *orig_hash;
156         struct hashtable_t *hna_local_hash;
157         struct hashtable_t *hna_global_hash;
158         struct hashtable_t *vis_hash;
159         spinlock_t orig_hash_lock; /* protects orig_hash */
160         spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
161         spinlock_t forw_bcast_list_lock; /* protects  */
162         spinlock_t hna_lhash_lock; /* protects hna_local_hash */
163         spinlock_t hna_ghash_lock; /* protects hna_global_hash */
164         spinlock_t gw_list_lock; /* protects gw_list */
165         spinlock_t vis_hash_lock; /* protects vis_hash */
166         spinlock_t vis_list_lock; /* protects vis_info::recv_list */
167         spinlock_t softif_neigh_lock; /* protects soft-interface neigh list */
168         int16_t num_local_hna;
169         atomic_t hna_local_changed;
170         struct delayed_work hna_work;
171         struct delayed_work orig_work;
172         struct delayed_work vis_work;
173         struct gw_node *curr_gw;
174         struct vis_info *my_vis_info;
175 };
176
177 struct socket_client {
178         struct list_head queue_list;
179         unsigned int queue_len;
180         unsigned char index;
181         spinlock_t lock; /* protects queue_list, queue_len, index */
182         wait_queue_head_t queue_wait;
183         struct bat_priv *bat_priv;
184 };
185
186 struct socket_packet {
187         struct list_head list;
188         size_t icmp_len;
189         struct icmp_packet_rr icmp_packet;
190 };
191
192 struct hna_local_entry {
193         uint8_t addr[ETH_ALEN];
194         unsigned long last_seen;
195         char never_purge;
196 };
197
198 struct hna_global_entry {
199         uint8_t addr[ETH_ALEN];
200         struct orig_node *orig_node;
201 };
202
203 /**
204  *      forw_packet - structure for forw_list maintaining packets to be
205  *                    send/forwarded
206  */
207 struct forw_packet {
208         struct hlist_node list;
209         unsigned long send_time;
210         uint8_t own;
211         struct sk_buff *skb;
212         uint16_t packet_len;
213         uint32_t direct_link_flags;
214         uint8_t num_packets;
215         struct delayed_work delayed_work;
216         struct batman_if *if_incoming;
217 };
218
219 /* While scanning for vis-entries of a particular vis-originator
220  * this list collects its interfaces to create a subgraph/cluster
221  * out of them later
222  */
223 struct if_list_entry {
224         uint8_t addr[ETH_ALEN];
225         bool primary;
226         struct hlist_node list;
227 };
228
229 struct debug_log {
230         char log_buff[LOG_BUF_LEN];
231         unsigned long log_start;
232         unsigned long log_end;
233         spinlock_t lock; /* protects log_buff, log_start and log_end */
234         wait_queue_head_t queue_wait;
235 };
236
237 struct frag_packet_list_entry {
238         struct list_head list;
239         uint16_t seqno;
240         struct sk_buff *skb;
241 };
242
243 struct vis_info {
244         unsigned long       first_seen;
245         struct list_head    recv_list;
246                             /* list of server-neighbors we received a vis-packet
247                              * from.  we should not reply to them. */
248         struct list_head send_list;
249         struct kref refcount;
250         struct bat_priv *bat_priv;
251         /* this packet might be part of the vis send queue. */
252         struct sk_buff *skb_packet;
253         /* vis_info may follow here*/
254 } __packed;
255
256 struct vis_info_entry {
257         uint8_t  src[ETH_ALEN];
258         uint8_t  dest[ETH_ALEN];
259         uint8_t  quality;       /* quality = 0 means HNA */
260 } __packed;
261
262 struct recvlist_node {
263         struct list_head list;
264         uint8_t mac[ETH_ALEN];
265 };
266
267 struct softif_neigh {
268         struct hlist_node list;
269         uint8_t addr[ETH_ALEN];
270         unsigned long last_seen;
271         short vid;
272         struct kref refcount;
273         struct rcu_head rcu;
274 };
275
276 #endif /* _NET_BATMAN_ADV_TYPES_H_ */