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 /**
  32  * struct batadv_hard_iface_bat_iv - per hard interface B.A.T.M.A.N. IV data
  33  * @ogm_buff: buffer holding the OGM packet
  34  * @ogm_buff_len: length of the OGM packet buffer
  35  * @ogm_seqno: OGM sequence number - used to identify each OGM
  36  */
  37 struct batadv_hard_iface_bat_iv {
  38         unsigned char *ogm_buff;
  39         int ogm_buff_len;
  40         atomic_t ogm_seqno;
  41 };
  42
  43 struct batadv_hard_iface {
  44         struct list_head list;
  45         int16_t if_num;
  46         char if_status;
  47         struct net_device *net_dev;
  48         atomic_t frag_seqno;
  49         struct kobject *hardif_obj;
  50         atomic_t refcount;
  51         struct packet_type batman_adv_ptype;
  52         struct net_device *soft_iface;
  53         struct rcu_head rcu;
  54         struct batadv_hard_iface_bat_iv bat_iv;
  55 };
  56
  57 /**
  58  *      struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
  59  *      @primary_addr: hosts primary interface address
  60  *      @last_seen: when last packet from this node was received
  61  *      @bcast_seqno_reset: time when the broadcast seqno window was reset
  62  *      @batman_seqno_reset: time when the batman seqno window was reset
  63  *      @gw_flags: flags related to gateway class
  64  *      @flags: for now only VIS_SERVER flag
  65  *      @last_real_seqno: last and best known sequence number
  66  *      @last_ttl: ttl of last received packet
  67  *      @last_bcast_seqno: last broadcast sequence number received by this host
  68  *
  69  *      @candidates: how many candidates are available
  70  *      @selected: next bonding candidate
  71  */
  72 struct batadv_orig_node {
  73         uint8_t orig[ETH_ALEN];
  74         uint8_t primary_addr[ETH_ALEN];
  75         struct batadv_neigh_node __rcu *router; /* rcu protected pointer */
  76         unsigned long *bcast_own;
  77         uint8_t *bcast_own_sum;
  78         unsigned long last_seen;
  79         unsigned long bcast_seqno_reset;
  80         unsigned long batman_seqno_reset;
  81         uint8_t gw_flags;
  82         uint8_t flags;
  83         atomic_t last_ttvn; /* last seen translation table version number */
  84         uint16_t tt_crc;
  85         unsigned char *tt_buff;
  86         int16_t tt_buff_len;
  87         spinlock_t tt_buff_lock; /* protects tt_buff */
  88         atomic_t tt_size;
  89         bool tt_initialised;
  90         /* The tt_poss_change flag is used to detect an ongoing roaming phase.
  91          * If true, then I sent a Roaming_adv to this orig_node and I have to
  92          * inspect every packet directed to it to check whether it is still
  93          * the true destination or not. This flag will be reset to false as
  94          * soon as I receive a new TTVN from this orig_node
  95          */
  96         bool tt_poss_change;
  97         uint32_t last_real_seqno;
  98         uint8_t last_ttl;
  99         DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
 100         uint32_t last_bcast_seqno;
 101         struct hlist_head neigh_list;
 102         struct list_head frag_list;
 103         spinlock_t neigh_list_lock; /* protects neigh_list and router */
 104         atomic_t refcount;
 105         struct rcu_head rcu;
 106         struct hlist_node hash_entry;
 107         struct batadv_priv *bat_priv;
 108         unsigned long last_frag_packet;
 109         /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
 110          * neigh_node->real_bits, neigh_node->real_packet_count
 111          */
 112         spinlock_t ogm_cnt_lock;
 113         /* bcast_seqno_lock protects bcast_bits, last_bcast_seqno */
 114         spinlock_t bcast_seqno_lock;
 115         spinlock_t tt_list_lock; /* protects tt_list */
 116         atomic_t bond_candidates;
 117         struct list_head bond_list;
 118 };
 119
 120 struct batadv_gw_node {
 121         struct hlist_node list;
 122         struct batadv_orig_node *orig_node;
 123         unsigned long deleted;
 124         atomic_t refcount;
 125         struct rcu_head rcu;
 126 };
 127
 128 /*      batadv_neigh_node
 129  *      @last_seen: when last packet via this neighbor was received
 130  */
 131 struct batadv_neigh_node {
 132         struct hlist_node list;
 133         uint8_t addr[ETH_ALEN];
 134         uint8_t real_packet_count;
 135         uint8_t tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
 136         uint8_t tq_index;
 137         uint8_t tq_avg;
 138         uint8_t last_ttl;
 139         struct list_head bonding_list;
 140         unsigned long last_seen;
 141         DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
 142         atomic_t refcount;
 143         struct rcu_head rcu;
 144         struct batadv_orig_node *orig_node;
 145         struct batadv_hard_iface *if_incoming;
 146         spinlock_t lq_update_lock;      /* protects: tq_recv, tq_index */
 147 };
 148
 149 #ifdef CONFIG_BATMAN_ADV_BLA
 150 struct batadv_bcast_duplist_entry {
 151         uint8_t orig[ETH_ALEN];
 152         uint16_t crc;
 153         unsigned long entrytime;
 154 };
 155 #endif
 156
 157 enum batadv_counters {
 158         BATADV_CNT_TX,
 159         BATADV_CNT_TX_BYTES,
 160         BATADV_CNT_TX_DROPPED,
 161         BATADV_CNT_RX,
 162         BATADV_CNT_RX_BYTES,
 163         BATADV_CNT_FORWARD,
 164         BATADV_CNT_FORWARD_BYTES,
 165         BATADV_CNT_MGMT_TX,
 166         BATADV_CNT_MGMT_TX_BYTES,
 167         BATADV_CNT_MGMT_RX,
 168         BATADV_CNT_MGMT_RX_BYTES,
 169         BATADV_CNT_TT_REQUEST_TX,
 170         BATADV_CNT_TT_REQUEST_RX,
 171         BATADV_CNT_TT_RESPONSE_TX,
 172         BATADV_CNT_TT_RESPONSE_RX,
 173         BATADV_CNT_TT_ROAM_ADV_TX,
 174         BATADV_CNT_TT_ROAM_ADV_RX,
 175         BATADV_CNT_NUM,
 176 };
 177
 178 /**
 179  * struct batadv_priv_tt - per mesh interface translation table data
 180  * @vn: translation table version number
 181  * @local_changes: changes registered in an originator interval
 182  * @poss_change: Detect an ongoing roaming phase. If true, then this node
 183  *  received a roaming_adv and has to inspect every packet directed to it to
 184  *  check whether it still is the true destination or not. This flag will be
 185  *  reset to false as soon as the this node's ttvn is increased
 186  * @changes_list: tracks tt local changes within an originator interval
 187  * @req_list: list of pending tt_requests
 188  * @local_crc: Checksum of the local table, recomputed before sending a new OGM
 189  */
 190 struct batadv_priv_tt {
 191         atomic_t vn;
 192         atomic_t ogm_append_cnt;
 193         atomic_t local_changes;
 194         bool poss_change;
 195         struct list_head changes_list;
 196         struct batadv_hashtable *local_hash;
 197         struct batadv_hashtable *global_hash;
 198         struct list_head req_list;
 199         struct list_head roam_list;
 200         spinlock_t changes_list_lock; /* protects changes */
 201         spinlock_t req_list_lock; /* protects req_list */
 202         spinlock_t roam_list_lock; /* protects roam_list */
 203         atomic_t local_entry_num;
 204         uint16_t local_crc;
 205         unsigned char *last_changeset;
 206         int16_t last_changeset_len;
 207         spinlock_t last_changeset_lock; /* protects last_changeset */
 208         struct delayed_work work;
 209 };
 210
 211 #ifdef CONFIG_BATMAN_ADV_BLA
 212 struct batadv_priv_bla {
 213         atomic_t num_requests; /* number of bla requests in flight */
 214         struct batadv_hashtable *claim_hash;
 215         struct batadv_hashtable *backbone_hash;
 216         struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
 217         int bcast_duplist_curr;
 218         /* protects bcast_duplist and bcast_duplist_curr */
 219         spinlock_t bcast_duplist_lock;
 220         struct batadv_bla_claim_dst claim_dest;
 221         struct delayed_work work;
 222 };
 223 #endif
 224
 225 struct batadv_priv_gw {
 226         struct hlist_head list;
 227         spinlock_t list_lock; /* protects gw_list and curr_gw */
 228         struct batadv_gw_node __rcu *curr_gw;  /* rcu protected pointer */
 229         atomic_t reselect;
 230 };
 231
 232 struct batadv_priv_vis {
 233         struct list_head send_list;
 234         struct batadv_hashtable *hash;
 235         spinlock_t hash_lock; /* protects hash */
 236         spinlock_t list_lock; /* protects info::recv_list */
 237         struct delayed_work work;
 238         struct batadv_vis_info *my_info;
 239 };
 240
 241 struct batadv_priv {
 242         atomic_t mesh_state;
 243         struct net_device_stats stats;
 244         uint64_t __percpu *bat_counters; /* Per cpu counters */
 245         atomic_t aggregated_ogms;       /* boolean */
 246         atomic_t bonding;               /* boolean */
 247         atomic_t fragmentation;         /* boolean */
 248         atomic_t ap_isolation;          /* boolean */
 249         atomic_t bridge_loop_avoidance; /* boolean */
 250         atomic_t vis_mode;              /* VIS_TYPE_* */
 251         atomic_t gw_mode;               /* GW_MODE_* */
 252         atomic_t gw_sel_class;          /* uint */
 253         atomic_t gw_bandwidth;          /* gw bandwidth */
 254         atomic_t orig_interval;         /* uint */
 255         atomic_t hop_penalty;           /* uint */
 256         atomic_t log_level;             /* uint */
 257         atomic_t bcast_seqno;
 258         atomic_t bcast_queue_left;
 259         atomic_t batman_queue_left;
 260         char num_ifaces;
 261         struct batadv_debug_log *debug_log;
 262         struct kobject *mesh_obj;
 263         struct dentry *debug_dir;
 264         struct hlist_head forw_bat_list;
 265         struct hlist_head forw_bcast_list;
 266         struct batadv_hashtable *orig_hash;
 267         spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
 268         spinlock_t forw_bcast_list_lock; /* protects  */
 269         struct delayed_work orig_work;
 270         struct batadv_hard_iface __rcu *primary_if;  /* rcu protected pointer */
 271         struct batadv_algo_ops *bat_algo_ops;
 272 #ifdef CONFIG_BATMAN_ADV_BLA
 273         struct batadv_priv_bla bla;
 274 #endif
 275         struct batadv_priv_gw gw;
 276         struct batadv_priv_tt tt;
 277         struct batadv_priv_vis vis;
 278 };
 279
 280 struct batadv_socket_client {
 281         struct list_head queue_list;
 282         unsigned int queue_len;
 283         unsigned char index;
 284         spinlock_t lock; /* protects queue_list, queue_len, index */
 285         wait_queue_head_t queue_wait;
 286         struct batadv_priv *bat_priv;
 287 };
 288
 289 struct batadv_socket_packet {
 290         struct list_head list;
 291         size_t icmp_len;
 292         struct batadv_icmp_packet_rr icmp_packet;
 293 };
 294
 295 struct batadv_tt_common_entry {
 296         uint8_t addr[ETH_ALEN];
 297         struct hlist_node hash_entry;
 298         uint16_t flags;
 299         unsigned long added_at;
 300         atomic_t refcount;
 301         struct rcu_head rcu;
 302 };
 303
 304 struct batadv_tt_local_entry {
 305         struct batadv_tt_common_entry common;
 306         unsigned long last_seen;
 307 };
 308
 309 struct batadv_tt_global_entry {
 310         struct batadv_tt_common_entry common;
 311         struct hlist_head orig_list;
 312         spinlock_t list_lock;   /* protects the list */
 313         unsigned long roam_at; /* time at which TT_GLOBAL_ROAM was set */
 314 };
 315
 316 struct batadv_tt_orig_list_entry {
 317         struct batadv_orig_node *orig_node;
 318         uint8_t ttvn;
 319         atomic_t refcount;
 320         struct rcu_head rcu;
 321         struct hlist_node list;
 322 };
 323
 324 #ifdef CONFIG_BATMAN_ADV_BLA
 325 struct batadv_backbone_gw {
 326         uint8_t orig[ETH_ALEN];
 327         short vid;              /* used VLAN ID */
 328         struct hlist_node hash_entry;
 329         struct batadv_priv *bat_priv;
 330         unsigned long lasttime; /* last time we heard of this backbone gw */
 331         atomic_t request_sent;
 332         atomic_t refcount;
 333         struct rcu_head rcu;
 334         uint16_t crc;           /* crc checksum over all claims */
 335 };
 336
 337 struct batadv_claim {
 338         uint8_t addr[ETH_ALEN];
 339         short vid;
 340         struct batadv_backbone_gw *backbone_gw;
 341         unsigned long lasttime; /* last time we heard of claim (locals only) */
 342         struct rcu_head rcu;
 343         atomic_t refcount;
 344         struct hlist_node hash_entry;
 345 };
 346 #endif
 347
 348 struct batadv_tt_change_node {
 349         struct list_head list;
 350         struct batadv_tt_change change;
 351 };
 352
 353 struct batadv_tt_req_node {
 354         uint8_t addr[ETH_ALEN];
 355         unsigned long issued_at;
 356         struct list_head list;
 357 };
 358
 359 struct batadv_tt_roam_node {
 360         uint8_t addr[ETH_ALEN];
 361         atomic_t counter;
 362         unsigned long first_time;
 363         struct list_head list;
 364 };
 365
 366 /*      forw_packet - structure for forw_list maintaining packets to be
 367  *                    send/forwarded
 368  */
 369 struct batadv_forw_packet {
 370         struct hlist_node list;
 371         unsigned long send_time;
 372         uint8_t own;
 373         struct sk_buff *skb;
 374         uint16_t packet_len;
 375         uint32_t direct_link_flags;
 376         uint8_t num_packets;
 377         struct delayed_work delayed_work;
 378         struct batadv_hard_iface *if_incoming;
 379 };
 380
 381 /* While scanning for vis-entries of a particular vis-originator
 382  * this list collects its interfaces to create a subgraph/cluster
 383  * out of them later
 384  */
 385 struct batadv_if_list_entry {
 386         uint8_t addr[ETH_ALEN];
 387         bool primary;
 388         struct hlist_node list;
 389 };
 390
 391 struct batadv_debug_log {
 392         char log_buff[BATADV_LOG_BUF_LEN];
 393         unsigned long log_start;
 394         unsigned long log_end;
 395         spinlock_t lock; /* protects log_buff, log_start and log_end */
 396         wait_queue_head_t queue_wait;
 397 };
 398
 399 struct batadv_frag_packet_list_entry {
 400         struct list_head list;
 401         uint16_t seqno;
 402         struct sk_buff *skb;
 403 };
 404
 405 struct batadv_vis_info {
 406         unsigned long first_seen;
 407         /* list of server-neighbors we received a vis-packet
 408          * from.  we should not reply to them.
 409          */
 410         struct list_head recv_list;
 411         struct list_head send_list;
 412         struct kref refcount;
 413         struct hlist_node hash_entry;
 414         struct batadv_priv *bat_priv;
 415         /* this packet might be part of the vis send queue. */
 416         struct sk_buff *skb_packet;
 417         /* vis_info may follow here */
 418 } __packed;
 419
 420 struct batadv_vis_info_entry {
 421         uint8_t  src[ETH_ALEN];
 422         uint8_t  dest[ETH_ALEN];
 423         uint8_t  quality;       /* quality = 0 client */
 424 } __packed;
 425
 426 struct batadv_recvlist_node {
 427         struct list_head list;
 428         uint8_t mac[ETH_ALEN];
 429 };
 430
 431 struct batadv_algo_ops {
 432         struct hlist_node list;
 433         char *name;
 434         /* init routing info when hard-interface is enabled */
 435         int (*bat_iface_enable)(struct batadv_hard_iface *hard_iface);
 436         /* de-init routing info when hard-interface is disabled */
 437         void (*bat_iface_disable)(struct batadv_hard_iface *hard_iface);
 438         /* (re-)init mac addresses of the protocol information
 439          * belonging to this hard-interface
 440          */
 441         void (*bat_iface_update_mac)(struct batadv_hard_iface *hard_iface);
 442         /* called when primary interface is selected / changed */
 443         void (*bat_primary_iface_set)(struct batadv_hard_iface *hard_iface);
 444         /* prepare a new outgoing OGM for the send queue */
 445         void (*bat_ogm_schedule)(struct batadv_hard_iface *hard_iface);
 446         /* send scheduled OGM */
 447         void (*bat_ogm_emit)(struct batadv_forw_packet *forw_packet);
 448 };
 449
 450 #endif /* _NET_BATMAN_ADV_TYPES_H_ */