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 (ETH_HLEN + \
  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_seen: 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_seen;
  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         DECLARE_BITMAP(bcast_bits, TQ_LOCAL_WINDOW_SIZE);
  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_seen: 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_seen;
 135         DECLARE_BITMAP(real_bits, TQ_LOCAL_WINDOW_SIZE);
 136         atomic_t refcount;
 137         struct rcu_head rcu;
 138         struct orig_node *orig_node;
 139         struct hard_iface *if_incoming;
 140         spinlock_t lq_update_lock;      /* protects: tq_recv, tq_index */
 141 };
 142
 143 #ifdef CONFIG_BATMAN_ADV_BLA
 144 struct bcast_duplist_entry {
 145         uint8_t orig[ETH_ALEN];
 146         uint16_t crc;
 147         unsigned long entrytime;
 148 };
 149 #endif
 150
 151 enum bat_counters {
 152         BAT_CNT_FORWARD,
 153         BAT_CNT_FORWARD_BYTES,
 154         BAT_CNT_MGMT_TX,
 155         BAT_CNT_MGMT_TX_BYTES,
 156         BAT_CNT_MGMT_RX,
 157         BAT_CNT_MGMT_RX_BYTES,
 158         BAT_CNT_TT_REQUEST_TX,
 159         BAT_CNT_TT_REQUEST_RX,
 160         BAT_CNT_TT_RESPONSE_TX,
 161         BAT_CNT_TT_RESPONSE_RX,
 162         BAT_CNT_TT_ROAM_ADV_TX,
 163         BAT_CNT_TT_ROAM_ADV_RX,
 164         BAT_CNT_NUM,
 165 };
 166
 167 struct bat_priv {
 168         atomic_t mesh_state;
 169         struct net_device_stats stats;
 170         uint64_t __percpu *bat_counters; /* Per cpu counters */
 171         atomic_t aggregated_ogms;       /* boolean */
 172         atomic_t bonding;               /* boolean */
 173         atomic_t fragmentation;         /* boolean */
 174         atomic_t ap_isolation;          /* boolean */
 175         atomic_t bridge_loop_avoidance; /* boolean */
 176         atomic_t vis_mode;              /* VIS_TYPE_* */
 177         atomic_t gw_mode;               /* GW_MODE_* */
 178         atomic_t gw_sel_class;          /* uint */
 179         atomic_t gw_bandwidth;          /* gw bandwidth */
 180         atomic_t orig_interval;         /* uint */
 181         atomic_t hop_penalty;           /* uint */
 182         atomic_t log_level;             /* uint */
 183         atomic_t bcast_seqno;
 184         atomic_t bcast_queue_left;
 185         atomic_t batman_queue_left;
 186         atomic_t ttvn; /* translation table version number */
 187         atomic_t tt_ogm_append_cnt;
 188         atomic_t tt_local_changes; /* changes registered in a OGM interval */
 189         atomic_t bla_num_requests; /* number of bla requests in flight */
 190         /* The tt_poss_change flag is used to detect an ongoing roaming phase.
 191          * If true, then I received a Roaming_adv and I have to inspect every
 192          * packet directed to me to check whether I am still the true
 193          * destination or not. This flag will be reset to false as soon as I
 194          * increase my TTVN */
 195         bool tt_poss_change;
 196         char num_ifaces;
 197         struct debug_log *debug_log;
 198         struct kobject *mesh_obj;
 199         struct dentry *debug_dir;
 200         struct hlist_head forw_bat_list;
 201         struct hlist_head forw_bcast_list;
 202         struct hlist_head gw_list;
 203         struct list_head tt_changes_list; /* tracks changes in a OGM int */
 204         struct list_head vis_send_list;
 205         struct hashtable_t *orig_hash;
 206         struct hashtable_t *tt_local_hash;
 207         struct hashtable_t *tt_global_hash;
 208 #ifdef CONFIG_BATMAN_ADV_BLA
 209         struct hashtable_t *claim_hash;
 210         struct hashtable_t *backbone_hash;
 211 #endif
 212         struct list_head tt_req_list; /* list of pending tt_requests */
 213         struct list_head tt_roam_list;
 214         struct hashtable_t *vis_hash;
 215 #ifdef CONFIG_BATMAN_ADV_BLA
 216         struct bcast_duplist_entry bcast_duplist[DUPLIST_SIZE];
 217         int bcast_duplist_curr;
 218         struct bla_claim_dst claim_dest;
 219 #endif
 220         spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
 221         spinlock_t forw_bcast_list_lock; /* protects  */
 222         spinlock_t tt_changes_list_lock; /* protects tt_changes */
 223         spinlock_t tt_req_list_lock; /* protects tt_req_list */
 224         spinlock_t tt_roam_list_lock; /* protects tt_roam_list */
 225         spinlock_t gw_list_lock; /* protects gw_list and curr_gw */
 226         spinlock_t vis_hash_lock; /* protects vis_hash */
 227         spinlock_t vis_list_lock; /* protects vis_info::recv_list */
 228         atomic_t num_local_tt;
 229         /* Checksum of the local table, recomputed before sending a new OGM */
 230         uint16_t tt_crc;
 231         unsigned char *tt_buff;
 232         int16_t tt_buff_len;
 233         spinlock_t tt_buff_lock; /* protects tt_buff */
 234         struct delayed_work tt_work;
 235         struct delayed_work orig_work;
 236         struct delayed_work vis_work;
 237         struct delayed_work bla_work;
 238         struct gw_node __rcu *curr_gw;  /* rcu protected pointer */
 239         atomic_t gw_reselect;
 240         struct hard_iface __rcu *primary_if;  /* rcu protected pointer */
 241         struct vis_info *my_vis_info;
 242         struct bat_algo_ops *bat_algo_ops;
 243 };
 244
 245 struct socket_client {
 246         struct list_head queue_list;
 247         unsigned int queue_len;
 248         unsigned char index;
 249         spinlock_t lock; /* protects queue_list, queue_len, index */
 250         wait_queue_head_t queue_wait;
 251         struct bat_priv *bat_priv;
 252 };
 253
 254 struct socket_packet {
 255         struct list_head list;
 256         size_t icmp_len;
 257         struct icmp_packet_rr icmp_packet;
 258 };
 259
 260 struct tt_common_entry {
 261         uint8_t addr[ETH_ALEN];
 262         struct hlist_node hash_entry;
 263         uint16_t flags;
 264         atomic_t refcount;
 265         struct rcu_head rcu;
 266 };
 267
 268 struct tt_local_entry {
 269         struct tt_common_entry common;
 270         unsigned long last_seen;
 271 };
 272
 273 struct tt_global_entry {
 274         struct tt_common_entry common;
 275         struct hlist_head orig_list;
 276         spinlock_t list_lock;   /* protects the list */
 277         unsigned long roam_at; /* time at which TT_GLOBAL_ROAM was set */
 278 };
 279
 280 struct tt_orig_list_entry {
 281         struct orig_node *orig_node;
 282         uint8_t ttvn;
 283         struct rcu_head rcu;
 284         struct hlist_node list;
 285 };
 286
 287 #ifdef CONFIG_BATMAN_ADV_BLA
 288 struct backbone_gw {
 289         uint8_t orig[ETH_ALEN];
 290         short vid;              /* used VLAN ID */
 291         struct hlist_node hash_entry;
 292         struct bat_priv *bat_priv;
 293         unsigned long lasttime; /* last time we heard of this backbone gw */
 294         atomic_t request_sent;
 295         atomic_t refcount;
 296         struct rcu_head rcu;
 297         uint16_t crc;           /* crc checksum over all claims */
 298 };
 299
 300 struct claim {
 301         uint8_t addr[ETH_ALEN];
 302         short vid;
 303         struct backbone_gw *backbone_gw;
 304         unsigned long lasttime; /* last time we heard of claim (locals only) */
 305         struct rcu_head rcu;
 306         atomic_t refcount;
 307         struct hlist_node hash_entry;
 308 };
 309 #endif
 310
 311 struct tt_change_node {
 312         struct list_head list;
 313         struct tt_change change;
 314 };
 315
 316 struct tt_req_node {
 317         uint8_t addr[ETH_ALEN];
 318         unsigned long issued_at;
 319         struct list_head list;
 320 };
 321
 322 struct tt_roam_node {
 323         uint8_t addr[ETH_ALEN];
 324         atomic_t counter;
 325         unsigned long first_time;
 326         struct list_head list;
 327 };
 328
 329 /**
 330  *      forw_packet - structure for forw_list maintaining packets to be
 331  *                    send/forwarded
 332  */
 333 struct forw_packet {
 334         struct hlist_node list;
 335         unsigned long send_time;
 336         uint8_t own;
 337         struct sk_buff *skb;
 338         uint16_t packet_len;
 339         uint32_t direct_link_flags;
 340         uint8_t num_packets;
 341         struct delayed_work delayed_work;
 342         struct hard_iface *if_incoming;
 343 };
 344
 345 /* While scanning for vis-entries of a particular vis-originator
 346  * this list collects its interfaces to create a subgraph/cluster
 347  * out of them later
 348  */
 349 struct if_list_entry {
 350         uint8_t addr[ETH_ALEN];
 351         bool primary;
 352         struct hlist_node list;
 353 };
 354
 355 struct debug_log {
 356         char log_buff[LOG_BUF_LEN];
 357         unsigned long log_start;
 358         unsigned long log_end;
 359         spinlock_t lock; /* protects log_buff, log_start and log_end */
 360         wait_queue_head_t queue_wait;
 361 };
 362
 363 struct frag_packet_list_entry {
 364         struct list_head list;
 365         uint16_t seqno;
 366         struct sk_buff *skb;
 367 };
 368
 369 struct vis_info {
 370         unsigned long first_seen;
 371         /* list of server-neighbors we received a vis-packet
 372          * from.  we should not reply to them. */
 373         struct list_head recv_list;
 374         struct list_head send_list;
 375         struct kref refcount;
 376         struct hlist_node hash_entry;
 377         struct bat_priv *bat_priv;
 378         /* this packet might be part of the vis send queue. */
 379         struct sk_buff *skb_packet;
 380         /* vis_info may follow here*/
 381 } __packed;
 382
 383 struct vis_info_entry {
 384         uint8_t  src[ETH_ALEN];
 385         uint8_t  dest[ETH_ALEN];
 386         uint8_t  quality;       /* quality = 0 client */
 387 } __packed;
 388
 389 struct recvlist_node {
 390         struct list_head list;
 391         uint8_t mac[ETH_ALEN];
 392 };
 393
 394 struct bat_algo_ops {
 395         struct hlist_node list;
 396         char *name;
 397         /* init routing info when hard-interface is enabled */
 398         int (*bat_iface_enable)(struct hard_iface *hard_iface);
 399         /* de-init routing info when hard-interface is disabled */
 400         void (*bat_iface_disable)(struct hard_iface *hard_iface);
 401         /* (re-)init mac addresses of the protocol information
 402          * belonging to this hard-interface
 403          */
 404         void (*bat_iface_update_mac)(struct hard_iface *hard_iface);
 405         /* called when primary interface is selected / changed */
 406         void (*bat_primary_iface_set)(struct hard_iface *hard_iface);
 407         /* prepare a new outgoing OGM for the send queue */
 408         void (*bat_ogm_schedule)(struct hard_iface *hard_iface,
 409                                  int tt_num_changes);
 410         /* send scheduled OGM */
 411         void (*bat_ogm_emit)(struct forw_packet *forw_packet);
 412 };
 413
 414 #endif /* _NET_BATMAN_ADV_TYPES_H_ */