Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d6f94d91 authored by Linus Lüssing's avatar Linus Lüssing Committed by Antonio Quartulli
Browse files

batman-adv: ELP - adding basic infrastructure 



The B.A.T.M.A.N. protocol originally only used a single
message type (called OGM) to determine the link qualities to
the direct neighbors and spreading these link quality
information through the whole mesh. This procedure is
summarized on the BATMAN concept page and explained in
details in the RFC draft published in 2008.

This approach was chosen for its simplicity during the
protocol design phase and the implementation. However, it
also bears some drawbacks:

 *  Wireless interfaces usually come with some packet loss,
    therefore a higher broadcast rate is desirable to allow
    a fast reaction on flaky connections.
    Other interfaces of the same host might be connected to
    Ethernet LANs / VPNs / etc which rarely exhibit packet
    loss would benefit from a lower broadcast rate to reduce
    overhead.
 *  It generally is more desirable to detect local link
    quality changes at a faster rate than propagating all
    these changes through the entire mesh (the far end of
    the mesh does not need to care about local link quality
    changes that much). Other optimizations strategies, like
    reducing overhead, might be possible if OGMs weren't
    used for all tasks in the mesh at the same time.

As a result detecting local link qualities shall be handled
by an independent message type, ELP, whereas the OGM message
type remains responsible for flooding the mesh with these
link quality information and determining the overall path
transmit qualities.

Developed by Linus during a 6 months trainee study period in
Ascom (Switzerland) AG.

Signed-off-by: default avatarLinus Luessing <linus.luessing@web.de>
Signed-off-by: default avatarMarek Lindner <mareklindner@neomailbox.ch>
Signed-off-by: default avatarAntonio Quartulli <antonio@open-mesh.com>
parent 0744ff8f

net/batman-adv/Kconfig

+14 −0
Original line number Diff line number Diff line
@@ -15,6 +15,20 @@ config BATMAN_ADV 
          https://www.open-mesh.org/ for more information and user space

          tools.



config BATMAN_ADV_BATMAN_V

	bool "B.A.T.M.A.N. V protocol (experimental)"

	depends on BATMAN_ADV

	default n

	help

	  This option enables the B.A.T.M.A.N. V protocol, the successor

	  of the currently used B.A.T.M.A.N. IV protocol. The main

	  changes include splitting of the OGM protocol into a neighbor

	  discovery protocol (Echo Location Protocol, ELP) and a new OGM

	  Protocol OGMv2 for flooding protocol information through the

	  network, as well as a throughput based metric.

	  B.A.T.M.A.N. V is currently considered experimental and not

	  compatible to B.A.T.M.A.N. IV networks.



config BATMAN_ADV_BLA

	bool "Bridge Loop Avoidance"

	depends on BATMAN_ADV && INET

net/batman-adv/Makefile

+2 −0
Original line number Diff line number Diff line
@@ -18,6 +18,8 @@ 


obj-$(CONFIG_BATMAN_ADV) += batman-adv.o

batman-adv-y += bat_iv_ogm.o

batman-adv-$(CONFIG_BATMAN_ADV_BATMAN_V) += bat_v.o

batman-adv-$(CONFIG_BATMAN_ADV_BATMAN_V) += bat_v_elp.o

batman-adv-y += bitarray.o

batman-adv-$(CONFIG_BATMAN_ADV_BLA) += bridge_loop_avoidance.o

batman-adv-$(CONFIG_DEBUG_FS) += debugfs.o

net/batman-adv/bat_algo.h

+14 −1
Original line number Diff line number Diff line 
/* Copyright (C) 2011-2016  B.A.T.M.A.N. contributors:

 *

 * Marek Lindner

 * Marek Lindner, Linus Lüssing

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of version 2 of the GNU General Public
@@ -20,4 +20,17 @@ 


int batadv_iv_init(void);



#ifdef CONFIG_BATMAN_ADV_BATMAN_V



int batadv_v_init(void);



#else



static inline int batadv_v_init(void)

{

	return 0;

}



#endif /* CONFIG_BATMAN_ADV_BATMAN_V */



#endif /* _NET_BATMAN_ADV_BAT_ALGO_H_ */

net/batman-adv/bat_v.c

0 → 100644
+74 −0
Original line number Diff line number Diff line 
/* Copyright (C) 2013-2016 B.A.T.M.A.N. contributors:

 *

 * Linus Lüssing, Marek Lindner

 *

 * 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/>.

 */



#include "bat_algo.h"

#include "main.h"



#include <linux/cache.h>

#include <linux/init.h>



#include "bat_v_elp.h"



static int batadv_v_iface_enable(struct batadv_hard_iface *hard_iface)

{

	return batadv_v_elp_iface_enable(hard_iface);

}



static void batadv_v_iface_disable(struct batadv_hard_iface *hard_iface)

{

	batadv_v_elp_iface_disable(hard_iface);

}



static void batadv_v_iface_update_mac(struct batadv_hard_iface *hard_iface)

{

}



static void batadv_v_primary_iface_set(struct batadv_hard_iface *hard_iface)

{

	batadv_v_elp_primary_iface_set(hard_iface);

}



static void batadv_v_ogm_schedule(struct batadv_hard_iface *hard_iface)

{

}



static void batadv_v_ogm_emit(struct batadv_forw_packet *forw_packet)

{

}



static struct batadv_algo_ops batadv_batman_v __read_mostly = {

	.name = "BATMAN_V",

	.bat_iface_enable = batadv_v_iface_enable,

	.bat_iface_disable = batadv_v_iface_disable,

	.bat_iface_update_mac = batadv_v_iface_update_mac,

	.bat_primary_iface_set = batadv_v_primary_iface_set,

	.bat_ogm_emit = batadv_v_ogm_emit,

	.bat_ogm_schedule = batadv_v_ogm_schedule,

};



/**

 * batadv_v_init - B.A.T.M.A.N. V initialization function

 *

 * Description: Takes care of initializing all the subcomponents.

 * It is invoked upon module load only.

 *

 * Return: 0 on success or a negative error code otherwise

 */

int __init batadv_v_init(void)

{

	return batadv_algo_register(&batadv_batman_v);

}

net/batman-adv/bat_v_elp.c

0 → 100644
+193 −0
Original line number Diff line number Diff line 
/* Copyright (C) 2011-2016 B.A.T.M.A.N. contributors:

 *

 * Linus Lüssing, Marek Lindner

 *

 * 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/>.

 */



#include "bat_v_elp.h"

#include "main.h"



#include <linux/atomic.h>

#include <linux/byteorder/generic.h>

#include <linux/errno.h>

#include <linux/etherdevice.h>

#include <linux/fs.h>

#include <linux/if_ether.h>

#include <linux/jiffies.h>

#include <linux/kernel.h>

#include <linux/netdevice.h>

#include <linux/random.h>

#include <linux/rculist.h>

#include <linux/rcupdate.h>

#include <linux/skbuff.h>

#include <linux/stddef.h>

#include <linux/string.h>

#include <linux/types.h>

#include <linux/workqueue.h>



#include "bat_algo.h"

#include "hard-interface.h"

#include "packet.h"

#include "send.h"



/**

 * batadv_v_elp_start_timer - restart timer for ELP periodic work

 * @hard_iface: the interface for which the timer has to be reset

 */

static void batadv_v_elp_start_timer(struct batadv_hard_iface *hard_iface)

{

	unsigned int msecs;



	msecs = atomic_read(&hard_iface->bat_v.elp_interval) - BATADV_JITTER;

	msecs += prandom_u32() % (2 * BATADV_JITTER);



	queue_delayed_work(batadv_event_workqueue, &hard_iface->bat_v.elp_wq,

			   msecs_to_jiffies(msecs));

}



/**

 * batadv_v_elp_periodic_work - ELP periodic task per interface

 * @work: work queue item

 *

 * Emits broadcast ELP message in regular intervals.

 */

static void batadv_v_elp_periodic_work(struct work_struct *work)

{

	struct batadv_hard_iface *hard_iface;

	struct batadv_hard_iface_bat_v *bat_v;

	struct batadv_elp_packet *elp_packet;

	struct batadv_priv *bat_priv;

	struct sk_buff *skb;

	u32 elp_interval;



	bat_v = container_of(work, struct batadv_hard_iface_bat_v, elp_wq.work);

	hard_iface = container_of(bat_v, struct batadv_hard_iface, bat_v);

	bat_priv = netdev_priv(hard_iface->soft_iface);



	if (atomic_read(&bat_priv->mesh_state) == BATADV_MESH_DEACTIVATING)

		goto out;



	/* we are in the process of shutting this interface down */

	if ((hard_iface->if_status == BATADV_IF_NOT_IN_USE) ||

	    (hard_iface->if_status == BATADV_IF_TO_BE_REMOVED))

		goto out;



	/* the interface was enabled but may not be ready yet */

	if (hard_iface->if_status != BATADV_IF_ACTIVE)

		goto restart_timer;



	skb = skb_copy(hard_iface->bat_v.elp_skb, GFP_ATOMIC);

	if (!skb)

		goto restart_timer;



	elp_packet = (struct batadv_elp_packet *)skb->data;

	elp_packet->seqno = htonl(atomic_read(&hard_iface->bat_v.elp_seqno));

	elp_interval = atomic_read(&hard_iface->bat_v.elp_interval);

	elp_packet->elp_interval = htonl(elp_interval);



	batadv_dbg(BATADV_DBG_BATMAN, bat_priv,

		   "Sending broadcast ELP packet on interface %s, seqno %u\n",

		   hard_iface->net_dev->name,

		   atomic_read(&hard_iface->bat_v.elp_seqno));



	batadv_send_skb_packet(skb, hard_iface, batadv_broadcast_addr);



	atomic_inc(&hard_iface->bat_v.elp_seqno);



restart_timer:

	batadv_v_elp_start_timer(hard_iface);

out:

	return;

}



/**

 * batadv_v_elp_iface_enable - setup the ELP interface private resources

 * @hard_iface: interface for which the data has to be prepared

 *

 * Return: 0 on success or a -ENOMEM in case of failure.

 */

int batadv_v_elp_iface_enable(struct batadv_hard_iface *hard_iface)

{

	struct batadv_elp_packet *elp_packet;

	unsigned char *elp_buff;

	u32 random_seqno;

	size_t size;

	int res = -ENOMEM;



	size = ETH_HLEN + NET_IP_ALIGN + BATADV_ELP_HLEN;

	hard_iface->bat_v.elp_skb = dev_alloc_skb(size);

	if (!hard_iface->bat_v.elp_skb)

		goto out;



	skb_reserve(hard_iface->bat_v.elp_skb, ETH_HLEN + NET_IP_ALIGN);

	elp_buff = skb_push(hard_iface->bat_v.elp_skb, BATADV_ELP_HLEN);

	elp_packet = (struct batadv_elp_packet *)elp_buff;

	memset(elp_packet, 0, BATADV_ELP_HLEN);



	elp_packet->packet_type = BATADV_ELP;

	elp_packet->version = BATADV_COMPAT_VERSION;



	/* randomize initial seqno to avoid collision */

	get_random_bytes(&random_seqno, sizeof(random_seqno));

	atomic_set(&hard_iface->bat_v.elp_seqno, random_seqno);

	atomic_set(&hard_iface->bat_v.elp_interval, 500);



	INIT_DELAYED_WORK(&hard_iface->bat_v.elp_wq,

			  batadv_v_elp_periodic_work);

	batadv_v_elp_start_timer(hard_iface);

	res = 0;



out:

	return res;

}



/**

 * batadv_v_elp_iface_disable - release ELP interface private resources

 * @hard_iface: interface for which the resources have to be released

 */

void batadv_v_elp_iface_disable(struct batadv_hard_iface *hard_iface)

{

	cancel_delayed_work_sync(&hard_iface->bat_v.elp_wq);



	dev_kfree_skb(hard_iface->bat_v.elp_skb);

	hard_iface->bat_v.elp_skb = NULL;

}



/**

 * batadv_v_elp_primary_iface_set - change internal data to reflect the new

 *  primary interface

 * @primary_iface: the new primary interface

 */

void batadv_v_elp_primary_iface_set(struct batadv_hard_iface *primary_iface)

{

	struct batadv_hard_iface *hard_iface;

	struct batadv_elp_packet *elp_packet;

	struct sk_buff *skb;



	/* update orig field of every elp iface belonging to this mesh */

	rcu_read_lock();

	list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {

		if (primary_iface->soft_iface != hard_iface->soft_iface)

			continue;



		if (!hard_iface->bat_v.elp_skb)

			continue;



		skb = hard_iface->bat_v.elp_skb;

		elp_packet = (struct batadv_elp_packet *)skb->data;

		ether_addr_copy(elp_packet->orig,

				primary_iface->net_dev->dev_addr);

	}

	rcu_read_unlock();

}