[deliverable/linux.git] / net / batman-adv / originator.h

/* Copyright (C) 2007-2015 B.A.T.M.A.N. contributors:
 *
 * Marek Lindner, Simon Wunderlich
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _NET_BATMAN_ADV_ORIGINATOR_H_
#define _NET_BATMAN_ADV_ORIGINATOR_H_

#include "main.h"

#include <linux/atomic.h>
#include <linux/compiler.h>
#include <linux/if_ether.h>
#include <linux/jhash.h>
#include <linux/rculist.h>
#include <linux/rcupdate.h>
#include <linux/stddef.h>
#include <linux/types.h>

#include "hash.h"

struct seq_file;

int batadv_compare_orig(const struct hlist_node *node, const void *data2);
int batadv_originator_init(struct batadv_priv *bat_priv);
void batadv_originator_free(struct batadv_priv *bat_priv);
void batadv_purge_orig_ref(struct batadv_priv *bat_priv);
void batadv_orig_node_free_ref(struct batadv_orig_node *orig_node);
void batadv_orig_node_free_ref_now(struct batadv_orig_node *orig_node);
struct batadv_orig_node *batadv_orig_node_new(struct batadv_priv *bat_priv,
					      const u8 *addr);
struct batadv_hardif_neigh_node *
batadv_hardif_neigh_get(const struct batadv_hard_iface *hard_iface,
			const u8 *neigh_addr);
void
batadv_hardif_neigh_free_ref(struct batadv_hardif_neigh_node *hardif_neigh);
struct batadv_neigh_node *
batadv_neigh_node_new(struct batadv_orig_node *orig_node,
		      struct batadv_hard_iface *hard_iface,
		      const u8 *neigh_addr);
void batadv_neigh_node_free_ref(struct batadv_neigh_node *neigh_node);
struct batadv_neigh_node *
batadv_orig_router_get(struct batadv_orig_node *orig_node,
		       const struct batadv_hard_iface *if_outgoing);
struct batadv_neigh_ifinfo *
batadv_neigh_ifinfo_new(struct batadv_neigh_node *neigh,
			struct batadv_hard_iface *if_outgoing);
struct batadv_neigh_ifinfo *
batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,
			struct batadv_hard_iface *if_outgoing);
void batadv_neigh_ifinfo_free_ref(struct batadv_neigh_ifinfo *neigh_ifinfo);

int batadv_hardif_neigh_seq_print_text(struct seq_file *seq, void *offset);

struct batadv_orig_ifinfo *
batadv_orig_ifinfo_get(struct batadv_orig_node *orig_node,
		       struct batadv_hard_iface *if_outgoing);
struct batadv_orig_ifinfo *
batadv_orig_ifinfo_new(struct batadv_orig_node *orig_node,
		       struct batadv_hard_iface *if_outgoing);
void batadv_orig_ifinfo_free_ref(struct batadv_orig_ifinfo *orig_ifinfo);

int batadv_orig_seq_print_text(struct seq_file *seq, void *offset);
int batadv_orig_hardif_seq_print_text(struct seq_file *seq, void *offset);
int batadv_orig_hash_add_if(struct batadv_hard_iface *hard_iface,
			    int max_if_num);
int batadv_orig_hash_del_if(struct batadv_hard_iface *hard_iface,
			    int max_if_num);
struct batadv_orig_node_vlan *
batadv_orig_node_vlan_new(struct batadv_orig_node *orig_node,
			  unsigned short vid);
struct batadv_orig_node_vlan *
batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node,
			  unsigned short vid);
void batadv_orig_node_vlan_free_ref(struct batadv_orig_node_vlan *orig_vlan);

/* hashfunction to choose an entry in a hash table of given size
 * hash algorithm from http://en.wikipedia.org/wiki/Hash_table
 */
static inline u32 batadv_choose_orig(const void *data, u32 size)
{
	u32 hash = 0;

	hash = jhash(data, ETH_ALEN, hash);
	return hash % size;
}

static inline struct batadv_orig_node *
batadv_orig_hash_find(struct batadv_priv *bat_priv, const void *data)
{
	struct batadv_hashtable *hash = bat_priv->orig_hash;
	struct hlist_head *head;
	struct batadv_orig_node *orig_node, *orig_node_tmp = NULL;
	int index;

	if (!hash)
		return NULL;

	index = batadv_choose_orig(data, hash->size);
	head = &hash->table[index];

	rcu_read_lock();
	hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
		if (!batadv_compare_eth(orig_node, data))
			continue;

		if (!atomic_inc_not_zero(&orig_node->refcount))
			continue;

		orig_node_tmp = orig_node;
		break;
	}
	rcu_read_unlock();

	return orig_node_tmp;
}

#endif /* _NET_BATMAN_ADV_ORIGINATOR_H_ */
Commit	Line	Data
9f6446c7	1	/* Copyright (C) 2007-2015 B.A.T.M.A.N. contributors:
c6c8fea2 SE	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
ebf38fb7	15	* along with this program; if not, see <http://www.gnu.org/licenses/>.
c6c8fea2 SE	16	*/
	17
	18	#ifndef _NET_BATMAN_ADV_ORIGINATOR_H_
	19	#define _NET_BATMAN_ADV_ORIGINATOR_H_
	20
1e2c2a4f SE	21	#include "main.h"
	22
	23	#include <linux/atomic.h>
	24	#include <linux/compiler.h>
	25	#include <linux/if_ether.h>
	26	#include <linux/jhash.h>
	27	#include <linux/rculist.h>
	28	#include <linux/rcupdate.h>
	29	#include <linux/stddef.h>
	30	#include <linux/types.h>
	31
7aadf889 ML	32	#include "hash.h"
7aadf889 ML	33
1e2c2a4f SE	34	struct seq_file;
1e2c2a4f SE	35
bbad0a5e	36	int batadv_compare_orig(const struct hlist_node node, const void data2);
56303d34 SE	37	int batadv_originator_init(struct batadv_priv *bat_priv);
	38	void batadv_originator_free(struct batadv_priv *bat_priv);
	39	void batadv_purge_orig_ref(struct batadv_priv *bat_priv);
	40	void batadv_orig_node_free_ref(struct batadv_orig_node *orig_node);
72822225	41	void batadv_orig_node_free_ref_now(struct batadv_orig_node *orig_node);
bbad0a5e	42	struct batadv_orig_node batadv_orig_node_new(struct batadv_priv bat_priv,
6b5e971a	43	const u8 *addr);
cef63419 ML	44	struct batadv_hardif_neigh_node *
	45	batadv_hardif_neigh_get(const struct batadv_hard_iface *hard_iface,
	46	const u8 *neigh_addr);
	47	void
	48	batadv_hardif_neigh_free_ref(struct batadv_hardif_neigh_node *hardif_neigh);
56303d34	49	struct batadv_neigh_node *
3f32f8a6 ML	50	batadv_neigh_node_new(struct batadv_orig_node *orig_node,
	51	struct batadv_hard_iface *hard_iface,
	52	const u8 *neigh_addr);
56303d34 SE	53	void batadv_neigh_node_free_ref(struct batadv_neigh_node *neigh_node);
56303d34 SE	54	struct batadv_neigh_node *
7351a482 SW	55	batadv_orig_router_get(struct batadv_orig_node *orig_node,
7351a482 SW	56	const struct batadv_hard_iface *if_outgoing);
89652331 SW	57	struct batadv_neigh_ifinfo *
	58	batadv_neigh_ifinfo_new(struct batadv_neigh_node *neigh,
	59	struct batadv_hard_iface *if_outgoing);
	60	struct batadv_neigh_ifinfo *
	61	batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,
	62	struct batadv_hard_iface *if_outgoing);
	63	void batadv_neigh_ifinfo_free_ref(struct batadv_neigh_ifinfo *neigh_ifinfo);
7351a482	64
7587405a ML	65	int batadv_hardif_neigh_seq_print_text(struct seq_file seq, void offset);
7587405a ML	66
7351a482 SW	67	struct batadv_orig_ifinfo *
	68	batadv_orig_ifinfo_get(struct batadv_orig_node *orig_node,
	69	struct batadv_hard_iface *if_outgoing);
	70	struct batadv_orig_ifinfo *
	71	batadv_orig_ifinfo_new(struct batadv_orig_node *orig_node,
	72	struct batadv_hard_iface *if_outgoing);
	73	void batadv_orig_ifinfo_free_ref(struct batadv_orig_ifinfo *orig_ifinfo);
	74
7d211efc	75	int batadv_orig_seq_print_text(struct seq_file seq, void offset);
cb1c92ec	76	int batadv_orig_hardif_seq_print_text(struct seq_file seq, void offset);
56303d34 SE	77	int batadv_orig_hash_add_if(struct batadv_hard_iface *hard_iface,
	78	int max_if_num);
	79	int batadv_orig_hash_del_if(struct batadv_hard_iface *hard_iface,
	80	int max_if_num);
7ea7b4a1 AQ	81	struct batadv_orig_node_vlan *
	82	batadv_orig_node_vlan_new(struct batadv_orig_node *orig_node,
	83	unsigned short vid);
	84	struct batadv_orig_node_vlan *
	85	batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node,
	86	unsigned short vid);
	87	void batadv_orig_node_vlan_free_ref(struct batadv_orig_node_vlan *orig_vlan);
c6c8fea2	88
9cfc7bd6 SE	89	/* hashfunction to choose an entry in a hash table of given size
	90	* hash algorithm from http://en.wikipedia.org/wiki/Hash_table
	91	*/
6b5e971a	92	static inline u32 batadv_choose_orig(const void *data, u32 size)
c6c8fea2	93	{
6b5e971a	94	u32 hash = 0;
c6c8fea2	95
36fd61cb	96	hash = jhash(data, ETH_ALEN, hash);
c6c8fea2 SE	97	return hash % size;
	98	}
	99
56303d34 SE	100	static inline struct batadv_orig_node *
56303d34 SE	101	batadv_orig_hash_find(struct batadv_priv bat_priv, const void data)
7aadf889	102	{
5bf74e9c	103	struct batadv_hashtable *hash = bat_priv->orig_hash;
7aadf889	104	struct hlist_head *head;
56303d34	105	struct batadv_orig_node orig_node, orig_node_tmp = NULL;
7aadf889 ML	106	int index;
	107
	108	if (!hash)
	109	return NULL;
	110
da641193	111	index = batadv_choose_orig(data, hash->size);
7aadf889 ML	112	head = &hash->table[index];
	113
	114	rcu_read_lock();
b67bfe0d	115	hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
1eda58bf	116	if (!batadv_compare_eth(orig_node, data))
7aadf889 ML	117	continue;
7aadf889 ML	118
7b36e8ee ML	119	if (!atomic_inc_not_zero(&orig_node->refcount))
	120	continue;
	121
7aadf889	122	orig_node_tmp = orig_node;
7aadf889 ML	123	break;
	124	}
	125	rcu_read_unlock();
	126
	127	return orig_node_tmp;
	128	}
	129
c6c8fea2	130	#endif /* _NET_BATMAN_ADV_ORIGINATOR_H_ */