drivers/staging/batman-adv/types.h

   1 /*
   2  * Copyright (C) 2007-2010 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         atomic_t refcnt;
  47         struct packet_type batman_adv_ptype;
  48         struct net_device *soft_iface;
  49 };
  50
  51 /**
  52  *      orig_node - structure for orig_list maintaining nodes of mesh
  53  *      @primary_addr: hosts primary interface address
  54  *      @last_valid: when last packet from this node was received
  55  *      @bcast_seqno_reset: time when the broadcast seqno window was reset
  56  *      @batman_seqno_reset: time when the batman seqno window was reset
  57  *      @flags: for now only VIS_SERVER flag
  58  *      @last_real_seqno: last and best known squence number
  59  *      @last_ttl: ttl of last received packet
  60  *      @last_bcast_seqno: last broadcast sequence number received by this host
  61  *
  62  *      @candidates: how many candidates are available
  63  *      @selected: next bonding candidate
  64  */
  65 struct orig_node {
  66         uint8_t orig[ETH_ALEN];
  67         uint8_t primary_addr[ETH_ALEN];
  68         struct neigh_node *router;
  69         TYPE_OF_WORD *bcast_own;
  70         uint8_t *bcast_own_sum;
  71         uint8_t tq_own;
  72         int tq_asym_penalty;
  73         unsigned long last_valid;
  74         unsigned long bcast_seqno_reset;
  75         unsigned long batman_seqno_reset;
  76         uint8_t  flags;
  77         unsigned char *hna_buff;
  78         int16_t hna_buff_len;
  79         uint32_t last_real_seqno;
  80         uint8_t last_ttl;
  81         TYPE_OF_WORD bcast_bits[NUM_WORDS];
  82         uint32_t last_bcast_seqno;
  83         struct list_head neigh_list;
  84         struct list_head frag_list;
  85         unsigned long last_frag_packet;
  86         struct {
  87                 uint8_t candidates;
  88                 struct neigh_node *selected;
  89         } bond;
  90 };
  91
  92 /**
  93  *      neigh_node
  94  *      @last_valid: when last packet via this neighbor was received
  95  */
  96 struct neigh_node {
  97         struct list_head list;
  98         uint8_t addr[ETH_ALEN];
  99         uint8_t real_packet_count;
 100         uint8_t tq_recv[TQ_GLOBAL_WINDOW_SIZE];
 101         uint8_t tq_index;
 102         uint8_t tq_avg;
 103         uint8_t last_ttl;
 104         struct neigh_node *next_bond_candidate;
 105         unsigned long last_valid;
 106         TYPE_OF_WORD real_bits[NUM_WORDS];
 107         struct orig_node *orig_node;
 108         struct batman_if *if_incoming;
 109 };
 110
 111
 112 struct bat_priv {
 113         atomic_t mesh_state;
 114         struct net_device_stats stats;
 115         atomic_t aggregation_enabled;
 116         atomic_t bonding_enabled;
 117         atomic_t frag_enabled;
 118         atomic_t vis_mode;
 119         atomic_t orig_interval;
 120         atomic_t log_level;
 121         atomic_t bcast_seqno;
 122         atomic_t bcast_queue_left;
 123         atomic_t batman_queue_left;
 124         char num_ifaces;
 125         struct debug_log *debug_log;
 126         struct batman_if *primary_if;
 127         struct kobject *mesh_obj;
 128         struct dentry *debug_dir;
 129         struct hlist_head forw_bat_list;
 130         struct hlist_head forw_bcast_list;
 131         struct list_head vis_send_list;
 132         struct hashtable_t *orig_hash;
 133         struct hashtable_t *hna_local_hash;
 134         struct hashtable_t *hna_global_hash;
 135         struct hashtable_t *vis_hash;
 136         spinlock_t orig_hash_lock; /* protects orig_hash */
 137         spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
 138         spinlock_t forw_bcast_list_lock; /* protects  */
 139         spinlock_t hna_lhash_lock; /* protects hna_local_hash */
 140         spinlock_t hna_ghash_lock; /* protects hna_global_hash */
 141         spinlock_t vis_hash_lock; /* protects vis_hash */
 142         spinlock_t vis_list_lock; /* protects vis_info::recv_list */
 143         int16_t num_local_hna;
 144         atomic_t hna_local_changed;
 145         struct delayed_work hna_work;
 146         struct delayed_work orig_work;
 147         struct delayed_work vis_work;
 148         struct vis_info *my_vis_info;
 149 };
 150
 151 struct socket_client {
 152         struct list_head queue_list;
 153         unsigned int queue_len;
 154         unsigned char index;
 155         spinlock_t lock; /* protects queue_list, queue_len, index */
 156         wait_queue_head_t queue_wait;
 157         struct bat_priv *bat_priv;
 158 };
 159
 160 struct socket_packet {
 161         struct list_head list;
 162         size_t icmp_len;
 163         struct icmp_packet_rr icmp_packet;
 164 };
 165
 166 struct hna_local_entry {
 167         uint8_t addr[ETH_ALEN];
 168         unsigned long last_seen;
 169         char never_purge;
 170 };
 171
 172 struct hna_global_entry {
 173         uint8_t addr[ETH_ALEN];
 174         struct orig_node *orig_node;
 175 };
 176
 177 /**
 178  *      forw_packet - structure for forw_list maintaining packets to be
 179  *                    send/forwarded
 180  */
 181 struct forw_packet {
 182         struct hlist_node list;
 183         unsigned long send_time;
 184         uint8_t own;
 185         struct sk_buff *skb;
 186         uint16_t packet_len;
 187         uint32_t direct_link_flags;
 188         uint8_t num_packets;
 189         struct delayed_work delayed_work;
 190         struct batman_if *if_incoming;
 191 };
 192
 193 /* While scanning for vis-entries of a particular vis-originator
 194  * this list collects its interfaces to create a subgraph/cluster
 195  * out of them later
 196  */
 197 struct if_list_entry {
 198         uint8_t addr[ETH_ALEN];
 199         bool primary;
 200         struct hlist_node list;
 201 };
 202
 203 struct debug_log {
 204         char log_buff[LOG_BUF_LEN];
 205         unsigned long log_start;
 206         unsigned long log_end;
 207         spinlock_t lock; /* protects log_buff, log_start and log_end */
 208         wait_queue_head_t queue_wait;
 209 };
 210
 211 struct frag_packet_list_entry {
 212         struct list_head list;
 213         uint16_t seqno;
 214         struct sk_buff *skb;
 215 };
 216
 217 struct vis_info {
 218         unsigned long       first_seen;
 219         struct list_head    recv_list;
 220                             /* list of server-neighbors we received a vis-packet
 221                              * from.  we should not reply to them. */
 222         struct list_head send_list;
 223         struct kref refcount;
 224         struct bat_priv *bat_priv;
 225         /* this packet might be part of the vis send queue. */
 226         struct sk_buff *skb_packet;
 227         /* vis_info may follow here*/
 228 } __attribute__((packed));
 229
 230 struct vis_info_entry {
 231         uint8_t  src[ETH_ALEN];
 232         uint8_t  dest[ETH_ALEN];
 233         uint8_t  quality;       /* quality = 0 means HNA */
 234 } __attribute__((packed));
 235
 236 struct recvlist_node {
 237         struct list_head list;
 238         uint8_t mac[ETH_ALEN];
 239 };
 240
 241 #endif /* _NET_BATMAN_ADV_TYPES_H_ */