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 *dev;
  40         char if_status;
  41         char addr_str[ETH_STR_LEN];
  42         struct net_device *net_dev;
  43         atomic_t seqno;
  44         unsigned char *packet_buff;
  45         int packet_len;
  46         struct kobject *hardif_obj;
  47         struct rcu_head rcu;
  48
  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 {
  85                 uint8_t candidates;
  86                 struct neigh_node *selected;
  87         } bond;
  88 };
  89
  90 /**
  91   *     neigh_node
  92   *     @last_valid: when last packet via this neighbor was received
  93  */
  94 struct neigh_node {
  95         struct list_head list;
  96         uint8_t addr[ETH_ALEN];
  97         uint8_t real_packet_count;
  98         uint8_t tq_recv[TQ_GLOBAL_WINDOW_SIZE];
  99         uint8_t tq_index;
 100         uint8_t tq_avg;
 101         uint8_t last_ttl;
 102         struct neigh_node *next_bond_candidate;
 103         unsigned long last_valid;
 104         TYPE_OF_WORD real_bits[NUM_WORDS];
 105         struct orig_node *orig_node;
 106         struct batman_if *if_incoming;
 107 };
 108
 109 struct bat_priv {
 110         struct net_device_stats stats;
 111         atomic_t aggregation_enabled;
 112         atomic_t bonding_enabled;
 113         atomic_t vis_mode;
 114         atomic_t orig_interval;
 115         atomic_t log_level;
 116         char num_ifaces;
 117         struct debug_log *debug_log;
 118         struct batman_if *primary_if;
 119         struct kobject *mesh_obj;
 120         struct dentry *debug_dir;
 121 };
 122
 123 struct socket_client {
 124         struct list_head queue_list;
 125         unsigned int queue_len;
 126         unsigned char index;
 127         spinlock_t lock;
 128         wait_queue_head_t queue_wait;
 129         struct bat_priv *bat_priv;
 130 };
 131
 132 struct socket_packet {
 133         struct list_head list;
 134         size_t icmp_len;
 135         struct icmp_packet_rr icmp_packet;
 136 };
 137
 138 struct hna_local_entry {
 139         uint8_t addr[ETH_ALEN];
 140         unsigned long last_seen;
 141         char never_purge;
 142 };
 143
 144 struct hna_global_entry {
 145         uint8_t addr[ETH_ALEN];
 146         struct orig_node *orig_node;
 147 };
 148
 149 /**
 150   *     forw_packet - structure for forw_list maintaining packets to be
 151   *                   send/forwarded
 152  */
 153 struct forw_packet {
 154         struct hlist_node list;
 155         unsigned long send_time;
 156         uint8_t own;
 157         struct sk_buff *skb;
 158         unsigned char *packet_buff;
 159         uint16_t packet_len;
 160         uint32_t direct_link_flags;
 161         uint8_t num_packets;
 162         struct delayed_work delayed_work;
 163         struct batman_if *if_incoming;
 164 };
 165
 166 /* While scanning for vis-entries of a particular vis-originator
 167  * this list collects its interfaces to create a subgraph/cluster
 168  * out of them later
 169  */
 170 struct if_list_entry {
 171         uint8_t addr[ETH_ALEN];
 172         bool primary;
 173         struct hlist_node list;
 174 };
 175
 176 struct debug_log {
 177         char log_buff[LOG_BUF_LEN];
 178         unsigned long log_start;
 179         unsigned long log_end;
 180         spinlock_t lock;
 181         wait_queue_head_t queue_wait;
 182 };
 183
 184 #endif /* _NET_BATMAN_ADV_TYPES_H_ */