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