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