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 *router;
  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         unsigned char *hna_buff;
  79         int16_t hna_buff_len;
  80         uint32_t last_real_seqno;
  81         uint8_t last_ttl;
  82         unsigned long bcast_bits[NUM_WORDS];
  83         uint32_t last_bcast_seqno;
  84         struct hlist_head neigh_list;
  85         struct list_head frag_list;
  86         spinlock_t neigh_list_lock; /* protects neighbor list */
  87         atomic_t refcount;
  88         struct rcu_head rcu;
  89         struct hlist_node hash_entry;
  90         struct bat_priv *bat_priv;
  91         unsigned long last_frag_packet;
  92         spinlock_t ogm_cnt_lock; /* protects: bcast_own, bcast_own_sum,
  93                                   * neigh_node->real_bits,
  94                                   * neigh_node->real_packet_count */
  95         spinlock_t bcast_seqno_lock; /* protects bcast_bits,
  96                                       *  last_bcast_seqno */
  97         atomic_t bond_candidates;
  98         struct list_head bond_list;
  99 };
 100
 101 struct gw_node {
 102         struct hlist_node list;
 103         struct orig_node *orig_node;
 104         unsigned long deleted;
 105         atomic_t refcount;
 106         struct rcu_head rcu;
 107 };
 108
 109 /**
 110  *      neigh_node
 111  *      @last_valid: when last packet via this neighbor was received
 112  */
 113 struct neigh_node {
 114         struct hlist_node list;
 115         uint8_t addr[ETH_ALEN];
 116         uint8_t real_packet_count;
 117         uint8_t tq_recv[TQ_GLOBAL_WINDOW_SIZE];
 118         uint8_t tq_index;
 119         uint8_t tq_avg;
 120         uint8_t last_ttl;
 121         struct list_head bonding_list;
 122         unsigned long last_valid;
 123         unsigned long real_bits[NUM_WORDS];
 124         atomic_t refcount;
 125         struct rcu_head rcu;
 126         struct orig_node *orig_node;
 127         struct hard_iface *if_incoming;
 128 };
 129
 130
 131 struct bat_priv {
 132         atomic_t mesh_state;
 133         struct net_device_stats stats;
 134         atomic_t aggregated_ogms;       /* boolean */
 135         atomic_t bonding;               /* boolean */
 136         atomic_t fragmentation;         /* boolean */
 137         atomic_t vis_mode;              /* VIS_TYPE_* */
 138         atomic_t gw_mode;               /* GW_MODE_* */
 139         atomic_t gw_sel_class;          /* uint */
 140         atomic_t gw_bandwidth;          /* gw bandwidth */
 141         atomic_t orig_interval;         /* uint */
 142         atomic_t hop_penalty;           /* uint */
 143         atomic_t log_level;             /* uint */
 144         atomic_t bcast_seqno;
 145         atomic_t bcast_queue_left;
 146         atomic_t batman_queue_left;
 147         char num_ifaces;
 148         struct hlist_head softif_neigh_list;
 149         struct softif_neigh *softif_neigh;
 150         struct debug_log *debug_log;
 151         struct hard_iface *primary_if;
 152         struct kobject *mesh_obj;
 153         struct dentry *debug_dir;
 154         struct hlist_head forw_bat_list;
 155         struct hlist_head forw_bcast_list;
 156         struct hlist_head gw_list;
 157         struct list_head vis_send_list;
 158         struct hashtable_t *orig_hash;
 159         struct hashtable_t *hna_local_hash;
 160         struct hashtable_t *hna_global_hash;
 161         struct hashtable_t *vis_hash;
 162         spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
 163         spinlock_t forw_bcast_list_lock; /* protects  */
 164         spinlock_t hna_lhash_lock; /* protects hna_local_hash */
 165         spinlock_t hna_ghash_lock; /* protects hna_global_hash */
 166         spinlock_t gw_list_lock; /* protects gw_list and curr_gw */
 167         spinlock_t vis_hash_lock; /* protects vis_hash */
 168         spinlock_t vis_list_lock; /* protects vis_info::recv_list */
 169         spinlock_t softif_neigh_lock; /* protects soft-interface neigh list */
 170         int16_t num_local_hna;
 171         atomic_t hna_local_changed;
 172         struct delayed_work hna_work;
 173         struct delayed_work orig_work;
 174         struct delayed_work vis_work;
 175         struct gw_node __rcu *curr_gw;  /* rcu protected pointer */
 176         struct vis_info *my_vis_info;
 177 };
 178
 179 struct socket_client {
 180         struct list_head queue_list;
 181         unsigned int queue_len;
 182         unsigned char index;
 183         spinlock_t lock; /* protects queue_list, queue_len, index */
 184         wait_queue_head_t queue_wait;
 185         struct bat_priv *bat_priv;
 186 };
 187
 188 struct socket_packet {
 189         struct list_head list;
 190         size_t icmp_len;
 191         struct icmp_packet_rr icmp_packet;
 192 };
 193
 194 struct hna_local_entry {
 195         uint8_t addr[ETH_ALEN];
 196         unsigned long last_seen;
 197         char never_purge;
 198         struct hlist_node hash_entry;
 199 };
 200
 201 struct hna_global_entry {
 202         uint8_t addr[ETH_ALEN];
 203         struct orig_node *orig_node;
 204         struct hlist_node hash_entry;
 205 };
 206
 207 /**
 208  *      forw_packet - structure for forw_list maintaining packets to be
 209  *                    send/forwarded
 210  */
 211 struct forw_packet {
 212         struct hlist_node list;
 213         unsigned long send_time;
 214         uint8_t own;
 215         struct sk_buff *skb;
 216         uint16_t packet_len;
 217         uint32_t direct_link_flags;
 218         uint8_t num_packets;
 219         struct delayed_work delayed_work;
 220         struct hard_iface *if_incoming;
 221 };
 222
 223 /* While scanning for vis-entries of a particular vis-originator
 224  * this list collects its interfaces to create a subgraph/cluster
 225  * out of them later
 226  */
 227 struct if_list_entry {
 228         uint8_t addr[ETH_ALEN];
 229         bool primary;
 230         struct hlist_node list;
 231 };
 232
 233 struct debug_log {
 234         char log_buff[LOG_BUF_LEN];
 235         unsigned long log_start;
 236         unsigned long log_end;
 237         spinlock_t lock; /* protects log_buff, log_start and log_end */
 238         wait_queue_head_t queue_wait;
 239 };
 240
 241 struct frag_packet_list_entry {
 242         struct list_head list;
 243         uint16_t seqno;
 244         struct sk_buff *skb;
 245 };
 246
 247 struct vis_info {
 248         unsigned long       first_seen;
 249         struct list_head    recv_list;
 250                             /* list of server-neighbors we received a vis-packet
 251                              * from.  we should not reply to them. */
 252         struct list_head send_list;
 253         struct kref refcount;
 254         struct hlist_node hash_entry;
 255         struct bat_priv *bat_priv;
 256         /* this packet might be part of the vis send queue. */
 257         struct sk_buff *skb_packet;
 258         /* vis_info may follow here*/
 259 } __packed;
 260
 261 struct vis_info_entry {
 262         uint8_t  src[ETH_ALEN];
 263         uint8_t  dest[ETH_ALEN];
 264         uint8_t  quality;       /* quality = 0 means HNA */
 265 } __packed;
 266
 267 struct recvlist_node {
 268         struct list_head list;
 269         uint8_t mac[ETH_ALEN];
 270 };
 271
 272 struct softif_neigh {
 273         struct hlist_node list;
 274         uint8_t addr[ETH_ALEN];
 275         unsigned long last_seen;
 276         short vid;
 277         atomic_t refcount;
 278         struct rcu_head rcu;
 279 };
 280
 281 #endif /* _NET_BATMAN_ADV_TYPES_H_ */