net/batman-adv/types.h

   1 /*
   2  * Copyright (C) 2007-2012 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 sequence 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 __rcu *router; /* rcu protected pointer */
  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         atomic_t last_ttvn; /* last seen translation table version number */
  79         uint16_t tt_crc;
  80         unsigned char *tt_buff;
  81         int16_t tt_buff_len;
  82         spinlock_t tt_buff_lock; /* protects tt_buff */
  83         atomic_t tt_size;
  84         bool tt_initialised;
  85         /* The tt_poss_change flag is used to detect an ongoing roaming phase.
  86          * If true, then I sent a Roaming_adv to this orig_node and I have to
  87          * inspect every packet directed to it to check whether it is still
  88          * the true destination or not. This flag will be reset to false as
  89          * soon as I receive a new TTVN from this orig_node */
  90         bool tt_poss_change;
  91         uint32_t last_real_seqno;
  92         uint8_t last_ttl;
  93         unsigned long bcast_bits[NUM_WORDS];
  94         uint32_t last_bcast_seqno;
  95         struct hlist_head neigh_list;
  96         struct list_head frag_list;
  97         spinlock_t neigh_list_lock; /* protects neigh_list and router */
  98         atomic_t refcount;
  99         struct rcu_head rcu;
 100         struct hlist_node hash_entry;
 101         struct bat_priv *bat_priv;
 102         unsigned long last_frag_packet;
 103         /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
 104          * neigh_node->real_bits, neigh_node->real_packet_count */
 105         spinlock_t ogm_cnt_lock;
 106         /* bcast_seqno_lock protects bcast_bits, last_bcast_seqno */
 107         spinlock_t bcast_seqno_lock;
 108         spinlock_t tt_list_lock; /* protects tt_list */
 109         atomic_t bond_candidates;
 110         struct list_head bond_list;
 111 };
 112
 113 struct gw_node {
 114         struct hlist_node list;
 115         struct orig_node *orig_node;
 116         unsigned long deleted;
 117         atomic_t refcount;
 118         struct rcu_head rcu;
 119 };
 120
 121 /**
 122  *      neigh_node
 123  *      @last_valid: when last packet via this neighbor was received
 124  */
 125 struct neigh_node {
 126         struct hlist_node list;
 127         uint8_t addr[ETH_ALEN];
 128         uint8_t real_packet_count;
 129         uint8_t tq_recv[TQ_GLOBAL_WINDOW_SIZE];
 130         uint8_t tq_index;
 131         uint8_t tq_avg;
 132         uint8_t last_ttl;
 133         struct list_head bonding_list;
 134         unsigned long last_valid;
 135         unsigned long real_bits[NUM_WORDS];
 136         atomic_t refcount;
 137         struct rcu_head rcu;
 138         struct orig_node *orig_node;
 139         struct hard_iface *if_incoming;
 140         spinlock_t tq_lock;     /* protects: tq_recv, tq_index */
 141 };
 142
 143
 144 struct bat_priv {
 145         atomic_t mesh_state;
 146         struct net_device_stats stats;
 147         atomic_t aggregated_ogms;       /* boolean */
 148         atomic_t bonding;               /* boolean */
 149         atomic_t fragmentation;         /* boolean */
 150         atomic_t ap_isolation;          /* boolean */
 151         atomic_t vis_mode;              /* VIS_TYPE_* */
 152         atomic_t gw_mode;               /* GW_MODE_* */
 153         atomic_t gw_sel_class;          /* uint */
 154         atomic_t gw_bandwidth;          /* gw bandwidth */
 155         atomic_t orig_interval;         /* uint */
 156         atomic_t hop_penalty;           /* uint */
 157         atomic_t log_level;             /* uint */
 158         atomic_t bcast_seqno;
 159         atomic_t bcast_queue_left;
 160         atomic_t batman_queue_left;
 161         atomic_t ttvn; /* translation table version number */
 162         atomic_t tt_ogm_append_cnt;
 163         atomic_t tt_local_changes; /* changes registered in a OGM interval */
 164         /* The tt_poss_change flag is used to detect an ongoing roaming phase.
 165          * If true, then I received a Roaming_adv and I have to inspect every
 166          * packet directed to me to check whether I am still the true
 167          * destination or not. This flag will be reset to false as soon as I
 168          * increase my TTVN */
 169         bool tt_poss_change;
 170         char num_ifaces;
 171         struct debug_log *debug_log;
 172         struct kobject *mesh_obj;
 173         struct dentry *debug_dir;
 174         struct hlist_head forw_bat_list;
 175         struct hlist_head forw_bcast_list;
 176         struct hlist_head gw_list;
 177         struct hlist_head softif_neigh_vids;
 178         struct list_head tt_changes_list; /* tracks changes in a OGM int */
 179         struct list_head vis_send_list;
 180         struct hashtable_t *orig_hash;
 181         struct hashtable_t *tt_local_hash;
 182         struct hashtable_t *tt_global_hash;
 183         struct list_head tt_req_list; /* list of pending tt_requests */
 184         struct list_head tt_roam_list;
 185         struct hashtable_t *vis_hash;
 186         spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
 187         spinlock_t forw_bcast_list_lock; /* protects  */
 188         spinlock_t tt_changes_list_lock; /* protects tt_changes */
 189         spinlock_t tt_req_list_lock; /* protects tt_req_list */
 190         spinlock_t tt_roam_list_lock; /* protects tt_roam_list */
 191         spinlock_t gw_list_lock; /* protects gw_list and curr_gw */
 192         spinlock_t vis_hash_lock; /* protects vis_hash */
 193         spinlock_t vis_list_lock; /* protects vis_info::recv_list */
 194         spinlock_t softif_neigh_lock; /* protects soft-interface neigh list */
 195         spinlock_t softif_neigh_vid_lock; /* protects soft-interface vid list */
 196         atomic_t num_local_tt;
 197         /* Checksum of the local table, recomputed before sending a new OGM */
 198         atomic_t tt_crc;
 199         unsigned char *tt_buff;
 200         int16_t tt_buff_len;
 201         spinlock_t tt_buff_lock; /* protects tt_buff */
 202         struct delayed_work tt_work;
 203         struct delayed_work orig_work;
 204         struct delayed_work vis_work;
 205         struct gw_node __rcu *curr_gw;  /* rcu protected pointer */
 206         atomic_t gw_reselect;
 207         struct hard_iface __rcu *primary_if;  /* rcu protected pointer */
 208         struct vis_info *my_vis_info;
 209         struct bat_algo_ops *bat_algo_ops;
 210 };
 211
 212 struct socket_client {
 213         struct list_head queue_list;
 214         unsigned int queue_len;
 215         unsigned char index;
 216         spinlock_t lock; /* protects queue_list, queue_len, index */
 217         wait_queue_head_t queue_wait;
 218         struct bat_priv *bat_priv;
 219 };
 220
 221 struct socket_packet {
 222         struct list_head list;
 223         size_t icmp_len;
 224         struct icmp_packet_rr icmp_packet;
 225 };
 226
 227 struct tt_common_entry {
 228         uint8_t addr[ETH_ALEN];
 229         struct hlist_node hash_entry;
 230         uint16_t flags;
 231         atomic_t refcount;
 232         struct rcu_head rcu;
 233 };
 234
 235 struct tt_local_entry {
 236         struct tt_common_entry common;
 237         unsigned long last_seen;
 238 };
 239
 240 struct tt_global_entry {
 241         struct tt_common_entry common;
 242         struct orig_node *orig_node;
 243         uint8_t ttvn;
 244         unsigned long roam_at; /* time at which TT_GLOBAL_ROAM was set */
 245 };
 246
 247 struct tt_change_node {
 248         struct list_head list;
 249         struct tt_change change;
 250 };
 251
 252 struct tt_req_node {
 253         uint8_t addr[ETH_ALEN];
 254         unsigned long issued_at;
 255         struct list_head list;
 256 };
 257
 258 struct tt_roam_node {
 259         uint8_t addr[ETH_ALEN];
 260         atomic_t counter;
 261         unsigned long first_time;
 262         struct list_head list;
 263 };
 264
 265 /**
 266  *      forw_packet - structure for forw_list maintaining packets to be
 267  *                    send/forwarded
 268  */
 269 struct forw_packet {
 270         struct hlist_node list;
 271         unsigned long send_time;
 272         uint8_t own;
 273         struct sk_buff *skb;
 274         uint16_t packet_len;
 275         uint32_t direct_link_flags;
 276         uint8_t num_packets;
 277         struct delayed_work delayed_work;
 278         struct hard_iface *if_incoming;
 279 };
 280
 281 /* While scanning for vis-entries of a particular vis-originator
 282  * this list collects its interfaces to create a subgraph/cluster
 283  * out of them later
 284  */
 285 struct if_list_entry {
 286         uint8_t addr[ETH_ALEN];
 287         bool primary;
 288         struct hlist_node list;
 289 };
 290
 291 struct debug_log {
 292         char log_buff[LOG_BUF_LEN];
 293         unsigned long log_start;
 294         unsigned long log_end;
 295         spinlock_t lock; /* protects log_buff, log_start and log_end */
 296         wait_queue_head_t queue_wait;
 297 };
 298
 299 struct frag_packet_list_entry {
 300         struct list_head list;
 301         uint16_t seqno;
 302         struct sk_buff *skb;
 303 };
 304
 305 struct vis_info {
 306         unsigned long first_seen;
 307         /* list of server-neighbors we received a vis-packet
 308          * from.  we should not reply to them. */
 309         struct list_head recv_list;
 310         struct list_head send_list;
 311         struct kref refcount;
 312         struct hlist_node hash_entry;
 313         struct bat_priv *bat_priv;
 314         /* this packet might be part of the vis send queue. */
 315         struct sk_buff *skb_packet;
 316         /* vis_info may follow here*/
 317 } __packed;
 318
 319 struct vis_info_entry {
 320         uint8_t  src[ETH_ALEN];
 321         uint8_t  dest[ETH_ALEN];
 322         uint8_t  quality;       /* quality = 0 client */
 323 } __packed;
 324
 325 struct recvlist_node {
 326         struct list_head list;
 327         uint8_t mac[ETH_ALEN];
 328 };
 329
 330 struct softif_neigh_vid {
 331         struct hlist_node list;
 332         struct bat_priv *bat_priv;
 333         short vid;
 334         atomic_t refcount;
 335         struct softif_neigh __rcu *softif_neigh;
 336         struct rcu_head rcu;
 337         struct hlist_head softif_neigh_list;
 338 };
 339
 340 struct softif_neigh {
 341         struct hlist_node list;
 342         uint8_t addr[ETH_ALEN];
 343         unsigned long last_seen;
 344         atomic_t refcount;
 345         struct rcu_head rcu;
 346 };
 347
 348 struct bat_algo_ops {
 349         struct hlist_node list;
 350         char *name;
 351         /* init OGM when hard-interface is enabled */
 352         void (*bat_ogm_init)(struct hard_iface *hard_iface);
 353         /* init primary OGM when primary interface is selected */
 354         void (*bat_ogm_init_primary)(struct hard_iface *hard_iface);
 355         /* init mac addresses of the OGM belonging to this hard-interface */
 356         void (*bat_ogm_update_mac)(struct hard_iface *hard_iface);
 357         /* prepare a new outgoing OGM for the send queue */
 358         void (*bat_ogm_schedule)(struct hard_iface *hard_iface,
 359                                  int tt_num_changes);
 360         /* send scheduled OGM */
 361         void (*bat_ogm_emit)(struct forw_packet *forw_packet);
 362         /* receive incoming OGM */
 363         void (*bat_ogm_receive)(struct hard_iface *if_incoming,
 364                                 struct sk_buff *skb);
 365 };
 366
 367 #endif /* _NET_BATMAN_ADV_TYPES_H_ */