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 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  */
  67 struct 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
 112 struct 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  */
 124 struct 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
 143 struct 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_req_list_lock; /* protects tt_req_list */
 188         spinlock_t tt_roam_list_lock; /* protects tt_roam_list */
 189         spinlock_t gw_list_lock; /* protects gw_list and curr_gw */
 190         spinlock_t vis_hash_lock; /* protects vis_hash */
 191         spinlock_t vis_list_lock; /* protects vis_info::recv_list */
 192         spinlock_t softif_neigh_lock; /* protects soft-interface neigh list */
 193         spinlock_t softif_neigh_vid_lock; /* protects soft-interface vid list */
 194         atomic_t num_local_tt;
 195         /* Checksum of the local table, recomputed before sending a new OGM */
 196         atomic_t tt_crc;
 197         unsigned char *tt_buff;
 198         int16_t tt_buff_len;
 199         spinlock_t tt_buff_lock; /* protects tt_buff */
 200         struct delayed_work tt_work;
 201         struct delayed_work orig_work;
 202         struct delayed_work vis_work;
 203         struct gw_node __rcu *curr_gw;  /* rcu protected pointer */
 204         atomic_t gw_reselect;
 205         struct hard_iface __rcu *primary_if;  /* rcu protected pointer */
 206         struct vis_info *my_vis_info;
 207 };
 208
 209 struct socket_client {
 210         struct list_head queue_list;
 211         unsigned int queue_len;
 212         unsigned char index;
 213         spinlock_t lock; /* protects queue_list, queue_len, index */
 214         wait_queue_head_t queue_wait;
 215         struct bat_priv *bat_priv;
 216 };
 217
 218 struct socket_packet {
 219         struct list_head list;
 220         size_t icmp_len;
 221         struct icmp_packet_rr icmp_packet;
 222 };
 223
 224 struct tt_local_entry {
 225         uint8_t addr[ETH_ALEN];
 226         unsigned long last_seen;
 227         uint16_t flags;
 228         atomic_t refcount;
 229         struct rcu_head rcu;
 230         struct hlist_node hash_entry;
 231 };
 232
 233 struct tt_global_entry {
 234         uint8_t addr[ETH_ALEN];
 235         struct orig_node *orig_node;
 236         uint8_t ttvn;
 237         uint16_t flags; /* only TT_GLOBAL_ROAM is used */
 238         unsigned long roam_at; /* time at which TT_GLOBAL_ROAM was set */
 239         atomic_t refcount;
 240         struct rcu_head rcu;
 241         struct hlist_node hash_entry; /* entry in the global table */
 242 };
 243
 244 struct tt_change_node {
 245         struct list_head list;
 246         struct tt_change change;
 247 };
 248
 249 struct tt_req_node {
 250         uint8_t addr[ETH_ALEN];
 251         unsigned long issued_at;
 252         struct list_head list;
 253 };
 254
 255 struct tt_roam_node {
 256         uint8_t addr[ETH_ALEN];
 257         atomic_t counter;
 258         unsigned long first_time;
 259         struct list_head list;
 260 };
 261
 262 /**
 263  *      forw_packet - structure for forw_list maintaining packets to be
 264  *                    send/forwarded
 265  */
 266 struct forw_packet {
 267         struct hlist_node list;
 268         unsigned long send_time;
 269         uint8_t own;
 270         struct sk_buff *skb;
 271         uint16_t packet_len;
 272         uint32_t direct_link_flags;
 273         uint8_t num_packets;
 274         struct delayed_work delayed_work;
 275         struct hard_iface *if_incoming;
 276 };
 277
 278 /* While scanning for vis-entries of a particular vis-originator
 279  * this list collects its interfaces to create a subgraph/cluster
 280  * out of them later
 281  */
 282 struct if_list_entry {
 283         uint8_t addr[ETH_ALEN];
 284         bool primary;
 285         struct hlist_node list;
 286 };
 287
 288 struct debug_log {
 289         char log_buff[LOG_BUF_LEN];
 290         unsigned long log_start;
 291         unsigned long log_end;
 292         spinlock_t lock; /* protects log_buff, log_start and log_end */
 293         wait_queue_head_t queue_wait;
 294 };
 295
 296 struct frag_packet_list_entry {
 297         struct list_head list;
 298         uint16_t seqno;
 299         struct sk_buff *skb;
 300 };
 301
 302 struct vis_info {
 303         unsigned long first_seen;
 304         /* list of server-neighbors we received a vis-packet
 305          * from.  we should not reply to them. */
 306         struct list_head recv_list;
 307         struct list_head send_list;
 308         struct kref refcount;
 309         struct hlist_node hash_entry;
 310         struct bat_priv *bat_priv;
 311         /* this packet might be part of the vis send queue. */
 312         struct sk_buff *skb_packet;
 313         /* vis_info may follow here*/
 314 } __packed;
 315
 316 struct vis_info_entry {
 317         uint8_t  src[ETH_ALEN];
 318         uint8_t  dest[ETH_ALEN];
 319         uint8_t  quality;       /* quality = 0 client */
 320 } __packed;
 321
 322 struct recvlist_node {
 323         struct list_head list;
 324         uint8_t mac[ETH_ALEN];
 325 };
 326
 327 struct softif_neigh_vid {
 328         struct hlist_node list;
 329         struct bat_priv *bat_priv;
 330         short vid;
 331         atomic_t refcount;
 332         struct softif_neigh __rcu *softif_neigh;
 333         struct rcu_head rcu;
 334         struct hlist_head softif_neigh_list;
 335 };
 336
 337 struct softif_neigh {
 338         struct hlist_node list;
 339         uint8_t addr[ETH_ALEN];
 340         unsigned long last_seen;
 341         atomic_t refcount;
 342         struct rcu_head rcu;
 343 };
 344
 345 #endif /* _NET_BATMAN_ADV_TYPES_H_ */