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

/* Copyright (C) 2007-2016  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/compiler.h>
#include <linux/if_ether.h>
#include <linux/jhash.h>
#include <linux/kref.h>
#include <linux/rculist.h>
#include <linux/rcupdate.h>
#include <linux/stddef.h>
#include <linux/types.h>

#include "hash.h"

struct seq_file;

bool 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_put(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_put(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_put(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_put(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_put(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_put(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 (!kref_get_unless_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
0046b040	1	/* Copyright (C) 2007-2016 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"
1e2c2a4f SE	22
1e2c2a4f SE	23	#include <linux/compiler.h>
	24	#include <linux/if_ether.h>
	25	#include <linux/jhash.h>
7c124391	26	#include <linux/kref.h>
1e2c2a4f SE	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
4b426b10	36	bool 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);
5d967310	40	void batadv_orig_node_put(struct batadv_orig_node *orig_node);
bbad0a5e	41	struct batadv_orig_node batadv_orig_node_new(struct batadv_priv bat_priv,
6b5e971a	42	const u8 *addr);
cef63419 ML	43	struct batadv_hardif_neigh_node *
	44	batadv_hardif_neigh_get(const struct batadv_hard_iface *hard_iface,
	45	const u8 *neigh_addr);
	46	void
accadc35	47	batadv_hardif_neigh_put(struct batadv_hardif_neigh_node *hardif_neigh);
56303d34	48	struct batadv_neigh_node *
3f32f8a6 ML	49	batadv_neigh_node_new(struct batadv_orig_node *orig_node,
	50	struct batadv_hard_iface *hard_iface,
	51	const u8 *neigh_addr);
25bb2509	52	void batadv_neigh_node_put(struct batadv_neigh_node *neigh_node);
56303d34	53	struct batadv_neigh_node *
7351a482 SW	54	batadv_orig_router_get(struct batadv_orig_node *orig_node,
7351a482 SW	55	const struct batadv_hard_iface *if_outgoing);
89652331 SW	56	struct batadv_neigh_ifinfo *
	57	batadv_neigh_ifinfo_new(struct batadv_neigh_node *neigh,
	58	struct batadv_hard_iface *if_outgoing);
	59	struct batadv_neigh_ifinfo *
	60	batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,
	61	struct batadv_hard_iface *if_outgoing);
044fa3ae	62	void batadv_neigh_ifinfo_put(struct batadv_neigh_ifinfo *neigh_ifinfo);
7351a482	63
7587405a ML	64	int batadv_hardif_neigh_seq_print_text(struct seq_file seq, void offset);
7587405a ML	65
7351a482 SW	66	struct batadv_orig_ifinfo *
	67	batadv_orig_ifinfo_get(struct batadv_orig_node *orig_node,
	68	struct batadv_hard_iface *if_outgoing);
	69	struct batadv_orig_ifinfo *
	70	batadv_orig_ifinfo_new(struct batadv_orig_node *orig_node,
	71	struct batadv_hard_iface *if_outgoing);
35f94779	72	void batadv_orig_ifinfo_put(struct batadv_orig_ifinfo *orig_ifinfo);
7351a482	73
7d211efc	74	int batadv_orig_seq_print_text(struct seq_file seq, void offset);
cb1c92ec	75	int batadv_orig_hardif_seq_print_text(struct seq_file seq, void offset);
56303d34 SE	76	int batadv_orig_hash_add_if(struct batadv_hard_iface *hard_iface,
	77	int max_if_num);
	78	int batadv_orig_hash_del_if(struct batadv_hard_iface *hard_iface,
	79	int max_if_num);
7ea7b4a1 AQ	80	struct batadv_orig_node_vlan *
	81	batadv_orig_node_vlan_new(struct batadv_orig_node *orig_node,
	82	unsigned short vid);
	83	struct batadv_orig_node_vlan *
	84	batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node,
	85	unsigned short vid);
21754e25	86	void batadv_orig_node_vlan_put(struct batadv_orig_node_vlan *orig_vlan);
c6c8fea2	87
9cfc7bd6 SE	88	/* hashfunction to choose an entry in a hash table of given size
	89	* hash algorithm from http://en.wikipedia.org/wiki/Hash_table
	90	*/
6b5e971a	91	static inline u32 batadv_choose_orig(const void *data, u32 size)
c6c8fea2	92	{
6b5e971a	93	u32 hash = 0;
c6c8fea2	94
36fd61cb	95	hash = jhash(data, ETH_ALEN, hash);
c6c8fea2 SE	96	return hash % size;
	97	}
	98
56303d34 SE	99	static inline struct batadv_orig_node *
56303d34 SE	100	batadv_orig_hash_find(struct batadv_priv bat_priv, const void data)
7aadf889	101	{
5bf74e9c	102	struct batadv_hashtable *hash = bat_priv->orig_hash;
7aadf889	103	struct hlist_head *head;
56303d34	104	struct batadv_orig_node orig_node, orig_node_tmp = NULL;
7aadf889 ML	105	int index;
	106
	107	if (!hash)
	108	return NULL;
	109
da641193	110	index = batadv_choose_orig(data, hash->size);
7aadf889 ML	111	head = &hash->table[index];
	112
	113	rcu_read_lock();
b67bfe0d	114	hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
1eda58bf	115	if (!batadv_compare_eth(orig_node, data))
7aadf889 ML	116	continue;
7aadf889 ML	117
7c124391	118	if (!kref_get_unless_zero(&orig_node->refcount))
7b36e8ee ML	119	continue;
7b36e8ee ML	120
7aadf889	121	orig_node_tmp = orig_node;
7aadf889 ML	122	break;
	123	}
	124	rcu_read_unlock();
	125
	126	return orig_node_tmp;
	127	}
	128
c6c8fea2	129	#endif /* _NET_BATMAN_ADV_ORIGINATOR_H_ */