types.h revision cc47f66e6b9ec7e7d465f74739a6fc9844593894
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 36struct hard_iface { 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 atomic_t 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 */ 67struct orig_node { 68 uint8_t orig[ETH_ALEN]; 69 uint8_t primary_addr[ETH_ALEN]; 70 struct neigh_node __rcu *router; /* rcu protected pointer */ 71 unsigned long *bcast_own; 72 uint8_t *bcast_own_sum; 73 unsigned long last_valid; 74 unsigned long bcast_seqno_reset; 75 unsigned long batman_seqno_reset; 76 uint8_t gw_flags; 77 uint8_t flags; 78 atomic_t last_ttvn; /* last seen translation table version number */ 79 uint16_t tt_crc; 80 unsigned char *tt_buff; 81 int16_t tt_buff_len; 82 spinlock_t tt_buff_lock; /* protects tt_buff */ 83 atomic_t tt_size; 84 /* The tt_poss_change flag is used to detect an ongoing roaming phase. 85 * If true, then I sent a Roaming_adv to this orig_node and I have to 86 * inspect every packet directed to it to check whether it is still 87 * the true destination or not. This flag will be reset to false as 88 * soon as I receive a new TTVN from this orig_node */ 89 bool tt_poss_change; 90 uint32_t last_real_seqno; 91 uint8_t last_ttl; 92 unsigned long bcast_bits[NUM_WORDS]; 93 uint32_t last_bcast_seqno; 94 struct hlist_head neigh_list; 95 struct list_head frag_list; 96 spinlock_t neigh_list_lock; /* protects neigh_list and router */ 97 atomic_t refcount; 98 struct rcu_head rcu; 99 struct hlist_node hash_entry; 100 struct bat_priv *bat_priv; 101 unsigned long last_frag_packet; 102 /* ogm_cnt_lock protects: bcast_own, bcast_own_sum, 103 * neigh_node->real_bits, neigh_node->real_packet_count */ 104 spinlock_t ogm_cnt_lock; 105 /* bcast_seqno_lock protects bcast_bits, last_bcast_seqno */ 106 spinlock_t bcast_seqno_lock; 107 spinlock_t tt_list_lock; /* protects tt_list */ 108 atomic_t bond_candidates; 109 struct list_head bond_list; 110}; 111 112struct gw_node { 113 struct hlist_node list; 114 struct orig_node *orig_node; 115 unsigned long deleted; 116 atomic_t refcount; 117 struct rcu_head rcu; 118}; 119 120/** 121 * neigh_node 122 * @last_valid: when last packet via this neighbor was received 123 */ 124struct neigh_node { 125 struct hlist_node list; 126 uint8_t addr[ETH_ALEN]; 127 uint8_t real_packet_count; 128 uint8_t tq_recv[TQ_GLOBAL_WINDOW_SIZE]; 129 uint8_t tq_index; 130 uint8_t tq_avg; 131 uint8_t last_ttl; 132 struct list_head bonding_list; 133 unsigned long last_valid; 134 unsigned long real_bits[NUM_WORDS]; 135 atomic_t refcount; 136 struct rcu_head rcu; 137 struct orig_node *orig_node; 138 struct hard_iface *if_incoming; 139 spinlock_t tq_lock; /* protects: tq_recv, tq_index */ 140}; 141 142 143struct bat_priv { 144 atomic_t mesh_state; 145 struct net_device_stats stats; 146 atomic_t aggregated_ogms; /* boolean */ 147 atomic_t bonding; /* boolean */ 148 atomic_t fragmentation; /* boolean */ 149 atomic_t vis_mode; /* VIS_TYPE_* */ 150 atomic_t gw_mode; /* GW_MODE_* */ 151 atomic_t gw_sel_class; /* uint */ 152 atomic_t gw_bandwidth; /* gw bandwidth */ 153 atomic_t orig_interval; /* uint */ 154 atomic_t hop_penalty; /* uint */ 155 atomic_t log_level; /* uint */ 156 atomic_t bcast_seqno; 157 atomic_t bcast_queue_left; 158 atomic_t batman_queue_left; 159 atomic_t ttvn; /* tranlation table version number */ 160 atomic_t tt_ogm_append_cnt; 161 atomic_t tt_local_changes; /* changes registered in a OGM interval */ 162 /* The tt_poss_change flag is used to detect an ongoing roaming phase. 163 * If true, then I received a Roaming_adv and I have to inspect every 164 * packet directed to me to check whether I am still the true 165 * destination or not. This flag will be reset to false as soon as I 166 * increase my TTVN */ 167 bool tt_poss_change; 168 char num_ifaces; 169 struct debug_log *debug_log; 170 struct kobject *mesh_obj; 171 struct dentry *debug_dir; 172 struct hlist_head forw_bat_list; 173 struct hlist_head forw_bcast_list; 174 struct hlist_head gw_list; 175 struct hlist_head softif_neigh_vids; 176 struct list_head tt_changes_list; /* tracks changes in a OGM int */ 177 struct list_head vis_send_list; 178 struct hashtable_t *orig_hash; 179 struct hashtable_t *tt_local_hash; 180 struct hashtable_t *tt_global_hash; 181 struct list_head tt_req_list; /* list of pending tt_requests */ 182 struct list_head tt_roam_list; 183 struct hashtable_t *vis_hash; 184 spinlock_t forw_bat_list_lock; /* protects forw_bat_list */ 185 spinlock_t forw_bcast_list_lock; /* protects */ 186 spinlock_t tt_changes_list_lock; /* protects tt_changes */ 187 spinlock_t tt_lhash_lock; /* protects tt_local_hash */ 188 spinlock_t tt_ghash_lock; /* protects tt_global_hash */ 189 spinlock_t tt_req_list_lock; /* protects tt_req_list */ 190 spinlock_t tt_roam_list_lock; /* protects tt_roam_list */ 191 spinlock_t gw_list_lock; /* protects gw_list and curr_gw */ 192 spinlock_t vis_hash_lock; /* protects vis_hash */ 193 spinlock_t vis_list_lock; /* protects vis_info::recv_list */ 194 spinlock_t softif_neigh_lock; /* protects soft-interface neigh list */ 195 spinlock_t softif_neigh_vid_lock; /* protects soft-interface vid list */ 196 atomic_t num_local_tt; 197 /* Checksum of the local table, recomputed before sending a new OGM */ 198 atomic_t tt_crc; 199 unsigned char *tt_buff; 200 int16_t tt_buff_len; 201 spinlock_t tt_buff_lock; /* protects tt_buff */ 202 struct delayed_work tt_work; 203 struct delayed_work orig_work; 204 struct delayed_work vis_work; 205 struct gw_node __rcu *curr_gw; /* rcu protected pointer */ 206 struct hard_iface __rcu *primary_if; /* rcu protected pointer */ 207 struct vis_info *my_vis_info; 208}; 209 210struct socket_client { 211 struct list_head queue_list; 212 unsigned int queue_len; 213 unsigned char index; 214 spinlock_t lock; /* protects queue_list, queue_len, index */ 215 wait_queue_head_t queue_wait; 216 struct bat_priv *bat_priv; 217}; 218 219struct socket_packet { 220 struct list_head list; 221 size_t icmp_len; 222 struct icmp_packet_rr icmp_packet; 223}; 224 225struct tt_local_entry { 226 uint8_t addr[ETH_ALEN]; 227 unsigned long last_seen; 228 char never_purge; 229 struct hlist_node hash_entry; 230}; 231 232struct tt_global_entry { 233 uint8_t addr[ETH_ALEN]; 234 struct orig_node *orig_node; 235 uint8_t ttvn; 236 uint8_t flags; /* only TT_GLOBAL_ROAM is used */ 237 unsigned long roam_at; /* time at which TT_GLOBAL_ROAM was set */ 238 struct hlist_node hash_entry; /* entry in the global table */ 239}; 240 241struct tt_change_node { 242 struct list_head list; 243 struct tt_change change; 244}; 245 246struct tt_req_node { 247 uint8_t addr[ETH_ALEN]; 248 unsigned long issued_at; 249 struct list_head list; 250}; 251 252struct tt_roam_node { 253 uint8_t addr[ETH_ALEN]; 254 atomic_t counter; 255 unsigned long first_time; 256 struct list_head list; 257}; 258 259/** 260 * forw_packet - structure for forw_list maintaining packets to be 261 * send/forwarded 262 */ 263struct forw_packet { 264 struct hlist_node list; 265 unsigned long send_time; 266 uint8_t own; 267 struct sk_buff *skb; 268 uint16_t packet_len; 269 uint32_t direct_link_flags; 270 uint8_t num_packets; 271 struct delayed_work delayed_work; 272 struct hard_iface *if_incoming; 273}; 274 275/* While scanning for vis-entries of a particular vis-originator 276 * this list collects its interfaces to create a subgraph/cluster 277 * out of them later 278 */ 279struct if_list_entry { 280 uint8_t addr[ETH_ALEN]; 281 bool primary; 282 struct hlist_node list; 283}; 284 285struct debug_log { 286 char log_buff[LOG_BUF_LEN]; 287 unsigned long log_start; 288 unsigned long log_end; 289 spinlock_t lock; /* protects log_buff, log_start and log_end */ 290 wait_queue_head_t queue_wait; 291}; 292 293struct frag_packet_list_entry { 294 struct list_head list; 295 uint16_t seqno; 296 struct sk_buff *skb; 297}; 298 299struct vis_info { 300 unsigned long first_seen; 301 /* list of server-neighbors we received a vis-packet 302 * from. we should not reply to them. */ 303 struct list_head recv_list; 304 struct list_head send_list; 305 struct kref refcount; 306 struct hlist_node hash_entry; 307 struct bat_priv *bat_priv; 308 /* this packet might be part of the vis send queue. */ 309 struct sk_buff *skb_packet; 310 /* vis_info may follow here*/ 311} __packed; 312 313struct vis_info_entry { 314 uint8_t src[ETH_ALEN]; 315 uint8_t dest[ETH_ALEN]; 316 uint8_t quality; /* quality = 0 client */ 317} __packed; 318 319struct recvlist_node { 320 struct list_head list; 321 uint8_t mac[ETH_ALEN]; 322}; 323 324struct softif_neigh_vid { 325 struct hlist_node list; 326 struct bat_priv *bat_priv; 327 short vid; 328 atomic_t refcount; 329 struct softif_neigh __rcu *softif_neigh; 330 struct rcu_head rcu; 331 struct hlist_head softif_neigh_list; 332}; 333 334struct softif_neigh { 335 struct hlist_node list; 336 uint8_t addr[ETH_ALEN]; 337 unsigned long last_seen; 338 atomic_t refcount; 339 struct rcu_head rcu; 340}; 341 342#endif /* _NET_BATMAN_ADV_TYPES_H_ */ 343