net/batman-adv/types.h

   1 /* Copyright (C) 2007-2012 B.A.T.M.A.N. contributors:
   2  *
   3  * Marek Lindner, Simon Wunderlich
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of version 2 of the GNU General Public
   7  * License as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17  * 02110-1301, USA
  18  */
  19
  20 #ifndef _NET_BATMAN_ADV_TYPES_H_
  21 #define _NET_BATMAN_ADV_TYPES_H_
  22
  23 #include "packet.h"
  24 #include "bitarray.h"
  25 #include <linux/kernel.h>
  26
  27 #define BATADV_HEADER_LEN \
  28         (ETH_HLEN + max(sizeof(struct batadv_unicast_packet), \
  29                         sizeof(struct batadv_bcast_packet)))
  30
  31 #ifdef CONFIG_BATMAN_ADV_DAT
  32
  33 /* batadv_dat_addr_t is the type used for all DHT addresses. If it is changed,
  34  * BATADV_DAT_ADDR_MAX is changed as well.
  35  *
  36  * *Please be careful: batadv_dat_addr_t must be UNSIGNED*
  37  */
  38 #define batadv_dat_addr_t uint16_t
  39
  40 #endif /* CONFIG_BATMAN_ADV_DAT */
  41
  42 /**
  43  * struct batadv_hard_iface_bat_iv - per hard interface B.A.T.M.A.N. IV data
  44  * @ogm_buff: buffer holding the OGM packet
  45  * @ogm_buff_len: length of the OGM packet buffer
  46  * @ogm_seqno: OGM sequence number - used to identify each OGM
  47  */
  48 struct batadv_hard_iface_bat_iv {
  49         unsigned char *ogm_buff;
  50         int ogm_buff_len;
  51         atomic_t ogm_seqno;
  52 };
  53
  54 struct batadv_hard_iface {
  55         struct list_head list;
  56         int16_t if_num;
  57         char if_status;
  58         struct net_device *net_dev;
  59         atomic_t frag_seqno;
  60         struct kobject *hardif_obj;
  61         atomic_t refcount;
  62         struct packet_type batman_adv_ptype;
  63         struct net_device *soft_iface;
  64         struct rcu_head rcu;
  65         struct batadv_hard_iface_bat_iv bat_iv;
  66 };
  67
  68 /**
  69  *      struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
  70  *      @primary_addr: hosts primary interface address
  71  *      @last_seen: when last packet from this node was received
  72  *      @bcast_seqno_reset: time when the broadcast seqno window was reset
  73  *      @batman_seqno_reset: time when the batman seqno window was reset
  74  *      @gw_flags: flags related to gateway class
  75  *      @flags: for now only VIS_SERVER flag
  76  *      @last_real_seqno: last and best known sequence number
  77  *      @last_ttl: ttl of last received packet
  78  *      @last_bcast_seqno: last broadcast sequence number received by this host
  79  *
  80  *      @candidates: how many candidates are available
  81  *      @selected: next bonding candidate
  82  */
  83 struct batadv_orig_node {
  84         uint8_t orig[ETH_ALEN];
  85         uint8_t primary_addr[ETH_ALEN];
  86         struct batadv_neigh_node __rcu *router; /* rcu protected pointer */
  87 #ifdef CONFIG_BATMAN_ADV_DAT
  88         batadv_dat_addr_t dat_addr;
  89 #endif
  90         unsigned long *bcast_own;
  91         uint8_t *bcast_own_sum;
  92         unsigned long last_seen;
  93         unsigned long bcast_seqno_reset;
  94         unsigned long batman_seqno_reset;
  95         uint8_t gw_flags;
  96         uint8_t flags;
  97         atomic_t last_ttvn; /* last seen translation table version number */
  98         uint16_t tt_crc;
  99         unsigned char *tt_buff;
 100         int16_t tt_buff_len;
 101         spinlock_t tt_buff_lock; /* protects tt_buff */
 102         atomic_t tt_size;
 103         bool tt_initialised;
 104         uint32_t last_real_seqno;
 105         uint8_t last_ttl;
 106         DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
 107         uint32_t last_bcast_seqno;
 108         struct hlist_head neigh_list;
 109         struct list_head frag_list;
 110         spinlock_t neigh_list_lock; /* protects neigh_list and router */
 111         atomic_t refcount;
 112         struct rcu_head rcu;
 113         struct hlist_node hash_entry;
 114         struct batadv_priv *bat_priv;
 115         unsigned long last_frag_packet;
 116         /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
 117          * neigh_node->real_bits, neigh_node->real_packet_count
 118          */
 119         spinlock_t ogm_cnt_lock;
 120         /* bcast_seqno_lock protects bcast_bits, last_bcast_seqno */
 121         spinlock_t bcast_seqno_lock;
 122         spinlock_t tt_list_lock; /* protects tt_list */
 123         atomic_t bond_candidates;
 124         struct list_head bond_list;
 125 };
 126
 127 struct batadv_gw_node {
 128         struct hlist_node list;
 129         struct batadv_orig_node *orig_node;
 130         unsigned long deleted;
 131         atomic_t refcount;
 132         struct rcu_head rcu;
 133 };
 134
 135 /*      batadv_neigh_node
 136  *      @last_seen: when last packet via this neighbor was received
 137  */
 138 struct batadv_neigh_node {
 139         struct hlist_node list;
 140         uint8_t addr[ETH_ALEN];
 141         uint8_t real_packet_count;
 142         uint8_t tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
 143         uint8_t tq_index;
 144         uint8_t tq_avg;
 145         uint8_t last_ttl;
 146         struct list_head bonding_list;
 147         unsigned long last_seen;
 148         DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
 149         atomic_t refcount;
 150         struct rcu_head rcu;
 151         struct batadv_orig_node *orig_node;
 152         struct batadv_hard_iface *if_incoming;
 153         spinlock_t lq_update_lock;      /* protects: tq_recv, tq_index */
 154 };
 155
 156 #ifdef CONFIG_BATMAN_ADV_BLA
 157 struct batadv_bcast_duplist_entry {
 158         uint8_t orig[ETH_ALEN];
 159         __be32 crc;
 160         unsigned long entrytime;
 161 };
 162 #endif
 163
 164 enum batadv_counters {
 165         BATADV_CNT_TX,
 166         BATADV_CNT_TX_BYTES,
 167         BATADV_CNT_TX_DROPPED,
 168         BATADV_CNT_RX,
 169         BATADV_CNT_RX_BYTES,
 170         BATADV_CNT_FORWARD,
 171         BATADV_CNT_FORWARD_BYTES,
 172         BATADV_CNT_MGMT_TX,
 173         BATADV_CNT_MGMT_TX_BYTES,
 174         BATADV_CNT_MGMT_RX,
 175         BATADV_CNT_MGMT_RX_BYTES,
 176         BATADV_CNT_TT_REQUEST_TX,
 177         BATADV_CNT_TT_REQUEST_RX,
 178         BATADV_CNT_TT_RESPONSE_TX,
 179         BATADV_CNT_TT_RESPONSE_RX,
 180         BATADV_CNT_TT_ROAM_ADV_TX,
 181         BATADV_CNT_TT_ROAM_ADV_RX,
 182 #ifdef CONFIG_BATMAN_ADV_DAT
 183         BATADV_CNT_DAT_GET_TX,
 184         BATADV_CNT_DAT_GET_RX,
 185         BATADV_CNT_DAT_PUT_TX,
 186         BATADV_CNT_DAT_PUT_RX,
 187         BATADV_CNT_DAT_CACHED_REPLY_TX,
 188 #endif
 189         BATADV_CNT_NUM,
 190 };
 191
 192 /**
 193  * struct batadv_priv_tt - per mesh interface translation table data
 194  * @vn: translation table version number
 195  * @local_changes: changes registered in an originator interval
 196  * @poss_change: Detect an ongoing roaming phase. If true, then this node
 197  *  received a roaming_adv and has to inspect every packet directed to it to
 198  *  check whether it still is the true destination or not. This flag will be
 199  *  reset to false as soon as the this node's ttvn is increased
 200  * @changes_list: tracks tt local changes within an originator interval
 201  * @req_list: list of pending tt_requests
 202  * @local_crc: Checksum of the local table, recomputed before sending a new OGM
 203  */
 204 struct batadv_priv_tt {
 205         atomic_t vn;
 206         atomic_t ogm_append_cnt;
 207         atomic_t local_changes;
 208         struct list_head changes_list;
 209         struct batadv_hashtable *local_hash;
 210         struct batadv_hashtable *global_hash;
 211         struct list_head req_list;
 212         struct list_head roam_list;
 213         spinlock_t changes_list_lock; /* protects changes */
 214         spinlock_t req_list_lock; /* protects req_list */
 215         spinlock_t roam_list_lock; /* protects roam_list */
 216         atomic_t local_entry_num;
 217         uint16_t local_crc;
 218         unsigned char *last_changeset;
 219         int16_t last_changeset_len;
 220         spinlock_t last_changeset_lock; /* protects last_changeset */
 221         struct delayed_work work;
 222 };
 223
 224 #ifdef CONFIG_BATMAN_ADV_BLA
 225 struct batadv_priv_bla {
 226         atomic_t num_requests; /* number of bla requests in flight */
 227         struct batadv_hashtable *claim_hash;
 228         struct batadv_hashtable *backbone_hash;
 229         struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
 230         int bcast_duplist_curr;
 231         /* protects bcast_duplist and bcast_duplist_curr */
 232         spinlock_t bcast_duplist_lock;
 233         struct batadv_bla_claim_dst claim_dest;
 234         struct delayed_work work;
 235 };
 236 #endif
 237
 238 struct batadv_priv_gw {
 239         struct hlist_head list;
 240         spinlock_t list_lock; /* protects gw_list and curr_gw */
 241         struct batadv_gw_node __rcu *curr_gw;  /* rcu protected pointer */
 242         atomic_t reselect;
 243 };
 244
 245 struct batadv_priv_vis {
 246         struct list_head send_list;
 247         struct batadv_hashtable *hash;
 248         spinlock_t hash_lock; /* protects hash */
 249         spinlock_t list_lock; /* protects info::recv_list */
 250         struct delayed_work work;
 251         struct batadv_vis_info *my_info;
 252 };
 253
 254 /**
 255  * struct batadv_priv_dat - per mesh interface DAT private data
 256  * @addr: node DAT address
 257  * @hash: hashtable representing the local ARP cache
 258  * @work: work queue callback item for cache purging
 259  */
 260 #ifdef CONFIG_BATMAN_ADV_DAT
 261 struct batadv_priv_dat {
 262         batadv_dat_addr_t addr;
 263         struct batadv_hashtable *hash;
 264         struct delayed_work work;
 265 };
 266 #endif
 267
 268 struct batadv_priv {
 269         atomic_t mesh_state;
 270         struct net_device_stats stats;
 271         uint64_t __percpu *bat_counters; /* Per cpu counters */
 272         atomic_t aggregated_ogms;       /* boolean */
 273         atomic_t bonding;               /* boolean */
 274         atomic_t fragmentation;         /* boolean */
 275         atomic_t ap_isolation;          /* boolean */
 276 #ifdef CONFIG_BATMAN_ADV_BLA
 277         atomic_t bridge_loop_avoidance; /* boolean */
 278 #endif
 279 #ifdef CONFIG_BATMAN_ADV_DAT
 280         atomic_t distributed_arp_table; /* boolean */
 281 #endif
 282         atomic_t vis_mode;              /* VIS_TYPE_* */
 283         atomic_t gw_mode;               /* GW_MODE_* */
 284         atomic_t gw_sel_class;          /* uint */
 285         atomic_t gw_bandwidth;          /* gw bandwidth */
 286         atomic_t orig_interval;         /* uint */
 287         atomic_t hop_penalty;           /* uint */
 288         atomic_t log_level;             /* uint */
 289         atomic_t bcast_seqno;
 290         atomic_t bcast_queue_left;
 291         atomic_t batman_queue_left;
 292         char num_ifaces;
 293         struct batadv_debug_log *debug_log;
 294         struct kobject *mesh_obj;
 295         struct dentry *debug_dir;
 296         struct hlist_head forw_bat_list;
 297         struct hlist_head forw_bcast_list;
 298         struct batadv_hashtable *orig_hash;
 299         spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
 300         spinlock_t forw_bcast_list_lock; /* protects forw_bcast_list */
 301         struct delayed_work orig_work;
 302         struct batadv_hard_iface __rcu *primary_if;  /* rcu protected pointer */
 303         struct batadv_algo_ops *bat_algo_ops;
 304 #ifdef CONFIG_BATMAN_ADV_BLA
 305         struct batadv_priv_bla bla;
 306 #endif
 307         struct batadv_priv_gw gw;
 308         struct batadv_priv_tt tt;
 309         struct batadv_priv_vis vis;
 310 #ifdef CONFIG_BATMAN_ADV_DAT
 311         struct batadv_priv_dat dat;
 312 #endif
 313 };
 314
 315 struct batadv_socket_client {
 316         struct list_head queue_list;
 317         unsigned int queue_len;
 318         unsigned char index;
 319         spinlock_t lock; /* protects queue_list, queue_len, index */
 320         wait_queue_head_t queue_wait;
 321         struct batadv_priv *bat_priv;
 322 };
 323
 324 struct batadv_socket_packet {
 325         struct list_head list;
 326         size_t icmp_len;
 327         struct batadv_icmp_packet_rr icmp_packet;
 328 };
 329
 330 struct batadv_tt_common_entry {
 331         uint8_t addr[ETH_ALEN];
 332         struct hlist_node hash_entry;
 333         uint16_t flags;
 334         unsigned long added_at;
 335         atomic_t refcount;
 336         struct rcu_head rcu;
 337 };
 338
 339 struct batadv_tt_local_entry {
 340         struct batadv_tt_common_entry common;
 341         unsigned long last_seen;
 342 };
 343
 344 struct batadv_tt_global_entry {
 345         struct batadv_tt_common_entry common;
 346         struct hlist_head orig_list;
 347         spinlock_t list_lock;   /* protects the list */
 348         unsigned long roam_at; /* time at which TT_GLOBAL_ROAM was set */
 349 };
 350
 351 struct batadv_tt_orig_list_entry {
 352         struct batadv_orig_node *orig_node;
 353         uint8_t ttvn;
 354         atomic_t refcount;
 355         struct rcu_head rcu;
 356         struct hlist_node list;
 357 };
 358
 359 #ifdef CONFIG_BATMAN_ADV_BLA
 360 struct batadv_backbone_gw {
 361         uint8_t orig[ETH_ALEN];
 362         short vid;              /* used VLAN ID */
 363         struct hlist_node hash_entry;
 364         struct batadv_priv *bat_priv;
 365         unsigned long lasttime; /* last time we heard of this backbone gw */
 366         atomic_t wait_periods;
 367         atomic_t request_sent;
 368         atomic_t refcount;
 369         struct rcu_head rcu;
 370         uint16_t crc;           /* crc checksum over all claims */
 371 };
 372
 373 struct batadv_claim {
 374         uint8_t addr[ETH_ALEN];
 375         short vid;
 376         struct batadv_backbone_gw *backbone_gw;
 377         unsigned long lasttime; /* last time we heard of claim (locals only) */
 378         struct rcu_head rcu;
 379         atomic_t refcount;
 380         struct hlist_node hash_entry;
 381 };
 382 #endif
 383
 384 struct batadv_tt_change_node {
 385         struct list_head list;
 386         struct batadv_tt_change change;
 387 };
 388
 389 struct batadv_tt_req_node {
 390         uint8_t addr[ETH_ALEN];
 391         unsigned long issued_at;
 392         struct list_head list;
 393 };
 394
 395 struct batadv_tt_roam_node {
 396         uint8_t addr[ETH_ALEN];
 397         atomic_t counter;
 398         unsigned long first_time;
 399         struct list_head list;
 400 };
 401
 402 /*      forw_packet - structure for forw_list maintaining packets to be
 403  *                    send/forwarded
 404  */
 405 struct batadv_forw_packet {
 406         struct hlist_node list;
 407         unsigned long send_time;
 408         uint8_t own;
 409         struct sk_buff *skb;
 410         uint16_t packet_len;
 411         uint32_t direct_link_flags;
 412         uint8_t num_packets;
 413         struct delayed_work delayed_work;
 414         struct batadv_hard_iface *if_incoming;
 415 };
 416
 417 /* While scanning for vis-entries of a particular vis-originator
 418  * this list collects its interfaces to create a subgraph/cluster
 419  * out of them later
 420  */
 421 struct batadv_if_list_entry {
 422         uint8_t addr[ETH_ALEN];
 423         bool primary;
 424         struct hlist_node list;
 425 };
 426
 427 struct batadv_debug_log {
 428         char log_buff[BATADV_LOG_BUF_LEN];
 429         unsigned long log_start;
 430         unsigned long log_end;
 431         spinlock_t lock; /* protects log_buff, log_start and log_end */
 432         wait_queue_head_t queue_wait;
 433 };
 434
 435 struct batadv_frag_packet_list_entry {
 436         struct list_head list;
 437         uint16_t seqno;
 438         struct sk_buff *skb;
 439 };
 440
 441 struct batadv_vis_info {
 442         unsigned long first_seen;
 443         /* list of server-neighbors we received a vis-packet
 444          * from.  we should not reply to them.
 445          */
 446         struct list_head recv_list;
 447         struct list_head send_list;
 448         struct kref refcount;
 449         struct hlist_node hash_entry;
 450         struct batadv_priv *bat_priv;
 451         /* this packet might be part of the vis send queue. */
 452         struct sk_buff *skb_packet;
 453         /* vis_info may follow here */
 454 } __packed;
 455
 456 struct batadv_vis_info_entry {
 457         uint8_t  src[ETH_ALEN];
 458         uint8_t  dest[ETH_ALEN];
 459         uint8_t  quality;       /* quality = 0 client */
 460 } __packed;
 461
 462 struct batadv_recvlist_node {
 463         struct list_head list;
 464         uint8_t mac[ETH_ALEN];
 465 };
 466
 467 struct batadv_algo_ops {
 468         struct hlist_node list;
 469         char *name;
 470         /* init routing info when hard-interface is enabled */
 471         int (*bat_iface_enable)(struct batadv_hard_iface *hard_iface);
 472         /* de-init routing info when hard-interface is disabled */
 473         void (*bat_iface_disable)(struct batadv_hard_iface *hard_iface);
 474         /* (re-)init mac addresses of the protocol information
 475          * belonging to this hard-interface
 476          */
 477         void (*bat_iface_update_mac)(struct batadv_hard_iface *hard_iface);
 478         /* called when primary interface is selected / changed */
 479         void (*bat_primary_iface_set)(struct batadv_hard_iface *hard_iface);
 480         /* prepare a new outgoing OGM for the send queue */
 481         void (*bat_ogm_schedule)(struct batadv_hard_iface *hard_iface);
 482         /* send scheduled OGM */
 483         void (*bat_ogm_emit)(struct batadv_forw_packet *forw_packet);
 484 };
 485
 486 /**
 487  * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
 488  * is used to stored ARP entries needed for the global DAT cache
 489  * @ip: the IPv4 corresponding to this DAT/ARP entry
 490  * @mac_addr: the MAC address associated to the stored IPv4
 491  * @last_update: time in jiffies when this entry was refreshed last time
 492  * @hash_entry: hlist node for batadv_priv_dat::hash
 493  * @refcount: number of contexts the object is used
 494  * @rcu: struct used for freeing in an RCU-safe manner
 495  */
 496 struct batadv_dat_entry {
 497         __be32 ip;
 498         uint8_t mac_addr[ETH_ALEN];
 499         unsigned long last_update;
 500         struct hlist_node hash_entry;
 501         atomic_t refcount;
 502         struct rcu_head rcu;
 503 };
 504
 505 /**
 506  * struct batadv_dat_candidate - candidate destination for DAT operations
 507  * @type: the type of the selected candidate. It can one of the following:
 508  *        - BATADV_DAT_CANDIDATE_NOT_FOUND
 509  *        - BATADV_DAT_CANDIDATE_ORIG
 510  * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to the
 511  *             corresponding originator node structure
 512  */
 513 struct batadv_dat_candidate {
 514         int type;
 515         struct batadv_orig_node *orig_node;
 516 };
 517
 518 #endif /* _NET_BATMAN_ADV_TYPES_H_ */