[mirror_ubuntu-artful-kernel.git] / net / batman-adv / gateway_common.c

/* Copyright (C) 2009-2017  B.A.T.M.A.N. contributors:
 *
 * 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 "gateway_common.h"
#include "main.h"

#include <linux/atomic.h>
#include <linux/byteorder/generic.h>
#include <linux/errno.h>
#include <linux/kernel.h>
#include <linux/math64.h>
#include <linux/netdevice.h>
#include <linux/stddef.h>
#include <linux/string.h>

#include "gateway_client.h"
#include "log.h"
#include "packet.h"
#include "tvlv.h"

/**
 * batadv_parse_throughput - parse supplied string buffer to extract throughput
 *  information
 * @net_dev: the soft interface net device
 * @buff: string buffer to parse
 * @description: text shown when throughput string cannot be parsed
 * @throughput: pointer holding the returned throughput information
 *
 * Return: false on parse error and true otherwise.
 */
bool batadv_parse_throughput(struct net_device *net_dev, char *buff,
			     const char *description, u32 *throughput)
{
	enum batadv_bandwidth_units bw_unit_type = BATADV_BW_UNIT_KBIT;
	u64 lthroughput;
	char *tmp_ptr;
	int ret;

	if (strlen(buff) > 4) {
		tmp_ptr = buff + strlen(buff) - 4;

		if (strncasecmp(tmp_ptr, "mbit", 4) == 0)
			bw_unit_type = BATADV_BW_UNIT_MBIT;

		if ((strncasecmp(tmp_ptr, "kbit", 4) == 0) ||
		    (bw_unit_type == BATADV_BW_UNIT_MBIT))
			*tmp_ptr = '\0';
	}

	ret = kstrtou64(buff, 10, &lthroughput);
	if (ret) {
		batadv_err(net_dev,
			   "Invalid throughput speed for %s: %s\n",
			   description, buff);
		return false;
	}

	switch (bw_unit_type) {
	case BATADV_BW_UNIT_MBIT:
		/* prevent overflow */
		if (U64_MAX / 10 < lthroughput) {
			batadv_err(net_dev,
				   "Throughput speed for %s too large: %s\n",
				   description, buff);
			return false;
		}

		lthroughput *= 10;
		break;
	case BATADV_BW_UNIT_KBIT:
	default:
		lthroughput = div_u64(lthroughput, 100);
		break;
	}

	if (lthroughput > U32_MAX) {
		batadv_err(net_dev,
			   "Throughput speed for %s too large: %s\n",
			   description, buff);
		return false;
	}

	*throughput = lthroughput;

	return true;
}

/**
 * batadv_parse_gw_bandwidth - parse supplied string buffer to extract download
 *  and upload bandwidth information
 * @net_dev: the soft interface net device
 * @buff: string buffer to parse
 * @down: pointer holding the returned download bandwidth information
 * @up: pointer holding the returned upload bandwidth information
 *
 * Return: false on parse error and true otherwise.
 */
static bool batadv_parse_gw_bandwidth(struct net_device *net_dev, char *buff,
				      u32 *down, u32 *up)
{
	char *slash_ptr;
	bool ret;

	slash_ptr = strchr(buff, '/');
	if (slash_ptr)
		*slash_ptr = 0;

	ret = batadv_parse_throughput(net_dev, buff, "download gateway speed",
				      down);
	if (!ret)
		return false;

	/* we also got some upload info */
	if (slash_ptr) {
		ret = batadv_parse_throughput(net_dev, slash_ptr + 1,
					      "upload gateway speed", up);
		if (!ret)
			return false;
	}

	return true;
}

/**
 * batadv_gw_tvlv_container_update - update the gw tvlv container after gateway
 *  setting change
 * @bat_priv: the bat priv with all the soft interface information
 */
void batadv_gw_tvlv_container_update(struct batadv_priv *bat_priv)
{
	struct batadv_tvlv_gateway_data gw;
	u32 down, up;
	char gw_mode;

	gw_mode = atomic_read(&bat_priv->gw.mode);

	switch (gw_mode) {
	case BATADV_GW_MODE_OFF:
	case BATADV_GW_MODE_CLIENT:
		batadv_tvlv_container_unregister(bat_priv, BATADV_TVLV_GW, 1);
		break;
	case BATADV_GW_MODE_SERVER:
		down = atomic_read(&bat_priv->gw.bandwidth_down);
		up = atomic_read(&bat_priv->gw.bandwidth_up);
		gw.bandwidth_down = htonl(down);
		gw.bandwidth_up = htonl(up);
		batadv_tvlv_container_register(bat_priv, BATADV_TVLV_GW, 1,
					       &gw, sizeof(gw));
		break;
	}
}

ssize_t batadv_gw_bandwidth_set(struct net_device *net_dev, char *buff,
				size_t count)
{
	struct batadv_priv *bat_priv = netdev_priv(net_dev);
	u32 down_curr;
	u32 up_curr;
	u32 down_new = 0;
	u32 up_new = 0;
	bool ret;

	down_curr = (unsigned int)atomic_read(&bat_priv->gw.bandwidth_down);
	up_curr = (unsigned int)atomic_read(&bat_priv->gw.bandwidth_up);

	ret = batadv_parse_gw_bandwidth(net_dev, buff, &down_new, &up_new);
	if (!ret)
		return -EINVAL;

	if (!down_new)
		down_new = 1;

	if (!up_new)
		up_new = down_new / 5;

	if (!up_new)
		up_new = 1;

	if ((down_curr == down_new) && (up_curr == up_new))
		return count;

	batadv_gw_reselect(bat_priv);
	batadv_info(net_dev,
		    "Changing gateway bandwidth from: '%u.%u/%u.%u MBit' to: '%u.%u/%u.%u MBit'\n",
		    down_curr / 10, down_curr % 10, up_curr / 10, up_curr % 10,
		    down_new / 10, down_new % 10, up_new / 10, up_new % 10);

	atomic_set(&bat_priv->gw.bandwidth_down, down_new);
	atomic_set(&bat_priv->gw.bandwidth_up, up_new);
	batadv_gw_tvlv_container_update(bat_priv);

	return count;
}

/**
 * batadv_gw_tvlv_ogm_handler_v1 - process incoming gateway tvlv container
 * @bat_priv: the bat priv with all the soft interface information
 * @orig: the orig_node of the ogm
 * @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags)
 * @tvlv_value: tvlv buffer containing the gateway data
 * @tvlv_value_len: tvlv buffer length
 */
static void batadv_gw_tvlv_ogm_handler_v1(struct batadv_priv *bat_priv,
					  struct batadv_orig_node *orig,
					  u8 flags,
					  void *tvlv_value, u16 tvlv_value_len)
{
	struct batadv_tvlv_gateway_data gateway, *gateway_ptr;

	/* only fetch the tvlv value if the handler wasn't called via the
	 * CIFNOTFND flag and if there is data to fetch
	 */
	if ((flags & BATADV_TVLV_HANDLER_OGM_CIFNOTFND) ||
	    (tvlv_value_len < sizeof(gateway))) {
		gateway.bandwidth_down = 0;
		gateway.bandwidth_up = 0;
	} else {
		gateway_ptr = tvlv_value;
		gateway.bandwidth_down = gateway_ptr->bandwidth_down;
		gateway.bandwidth_up = gateway_ptr->bandwidth_up;
		if ((gateway.bandwidth_down == 0) ||
		    (gateway.bandwidth_up == 0)) {
			gateway.bandwidth_down = 0;
			gateway.bandwidth_up = 0;
		}
	}

	batadv_gw_node_update(bat_priv, orig, &gateway);

	/* restart gateway selection */
	if ((gateway.bandwidth_down != 0) &&
	    (atomic_read(&bat_priv->gw.mode) == BATADV_GW_MODE_CLIENT))
		batadv_gw_check_election(bat_priv, orig);
}

/**
 * batadv_gw_init - initialise the gateway handling internals
 * @bat_priv: the bat priv with all the soft interface information
 */
void batadv_gw_init(struct batadv_priv *bat_priv)
{
	if (bat_priv->algo_ops->gw.init_sel_class)
		bat_priv->algo_ops->gw.init_sel_class(bat_priv);
	else
		atomic_set(&bat_priv->gw.sel_class, 1);

	batadv_tvlv_handler_register(bat_priv, batadv_gw_tvlv_ogm_handler_v1,
				     NULL, BATADV_TVLV_GW, 1,
				     BATADV_TVLV_HANDLER_OGM_CIFNOTFND);
}

/**
 * batadv_gw_free - free the gateway handling internals
 * @bat_priv: the bat priv with all the soft interface information
 */
void batadv_gw_free(struct batadv_priv *bat_priv)
{
	batadv_tvlv_container_unregister(bat_priv, BATADV_TVLV_GW, 1);
	batadv_tvlv_handler_unregister(bat_priv, BATADV_TVLV_GW, 1);
}
Commit	Line	Data
ac79cbb9	1	/* Copyright (C) 2009-2017 B.A.T.M.A.N. contributors:
c6c8fea2 SE	2	*
	3	* Marek Lindner
	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	*/
c6c8fea2 SE	17
c6c8fea2	18	#include "gateway_common.h"
1e2c2a4f SE	19	#include "main.h"
	20
	21	#include <linux/atomic.h>
	22	#include <linux/byteorder/generic.h>
fcafa5e7	23	#include <linux/errno.h>
1e2c2a4f	24	#include <linux/kernel.h>
0b8336f5	25	#include <linux/math64.h>
1e2c2a4f SE	26	#include <linux/netdevice.h>
	27	#include <linux/stddef.h>
	28	#include <linux/string.h>
	29
c6c8fea2	30	#include "gateway_client.h"
ba412080	31	#include "log.h"
1e2c2a4f	32	#include "packet.h"
1f8dce49	33	#include "tvlv.h"
c6c8fea2	34
414254e3	35	/**
d737ccbe SE	36	* batadv_parse_throughput - parse supplied string buffer to extract throughput
d737ccbe SE	37	* information
414254e3 ML	38	* @net_dev: the soft interface net device
414254e3 ML	39	* @buff: string buffer to parse
d737ccbe SE	40	* @description: text shown when throughput string cannot be parsed
d737ccbe SE	41	* @throughput: pointer holding the returned throughput information
414254e3	42	*
62fe710f	43	* Return: false on parse error and true otherwise.
414254e3	44	*/
0b5ecc68 AQ	45	bool batadv_parse_throughput(struct net_device net_dev, char buff,
0b5ecc68 AQ	46	const char description, u32 throughput)
c6c8fea2	47	{
414254e3	48	enum batadv_bandwidth_units bw_unit_type = BATADV_BW_UNIT_KBIT;
d737ccbe SE	49	u64 lthroughput;
d737ccbe SE	50	char *tmp_ptr;
414254e3	51	int ret;
c6c8fea2	52
c6c8fea2 SE	53	if (strlen(buff) > 4) {
	54	tmp_ptr = buff + strlen(buff) - 4;
	55
b7a8d756	56	if (strncasecmp(tmp_ptr, "mbit", 4) == 0)
414254e3	57	bw_unit_type = BATADV_BW_UNIT_MBIT;
c6c8fea2	58
b7a8d756	59	if ((strncasecmp(tmp_ptr, "kbit", 4) == 0) \|\|
414254e3	60	(bw_unit_type == BATADV_BW_UNIT_MBIT))
c6c8fea2 SE	61	*tmp_ptr = '\0';
	62	}
	63
d737ccbe	64	ret = kstrtou64(buff, 10, &lthroughput);
c6c8fea2	65	if (ret) {
3e34819e	66	batadv_err(net_dev,
d737ccbe SE	67	"Invalid throughput speed for %s: %s\n",
d737ccbe SE	68	description, buff);
c6c8fea2 SE	69	return false;
	70	}
	71
414254e3 ML	72	switch (bw_unit_type) {
414254e3 ML	73	case BATADV_BW_UNIT_MBIT:
0b8336f5	74	/* prevent overflow */
d737ccbe	75	if (U64_MAX / 10 < lthroughput) {
0b8336f5	76	batadv_err(net_dev,
d737ccbe SE	77	"Throughput speed for %s too large: %s\n",
d737ccbe SE	78	description, buff);
0b8336f5 SE	79	return false;
	80	}
	81
d737ccbe	82	lthroughput *= 10;
414254e3 ML	83	break;
	84	case BATADV_BW_UNIT_KBIT:
	85	default:
d737ccbe	86	lthroughput = div_u64(lthroughput, 100);
414254e3 ML	87	break;
414254e3 ML	88	}
c6c8fea2	89
d737ccbe	90	if (lthroughput > U32_MAX) {
0b8336f5	91	batadv_err(net_dev,
d737ccbe SE	92	"Throughput speed for %s too large: %s\n",
d737ccbe SE	93	description, buff);
0b8336f5 SE	94	return false;
	95	}
	96
d737ccbe	97	*throughput = lthroughput;
0b8336f5	98
d737ccbe SE	99	return true;
d737ccbe SE	100	}
c6c8fea2	101
d737ccbe SE	102	/**
	103	* batadv_parse_gw_bandwidth - parse supplied string buffer to extract download
	104	* and upload bandwidth information
	105	* @net_dev: the soft interface net device
	106	* @buff: string buffer to parse
	107	* @down: pointer holding the returned download bandwidth information
	108	* @up: pointer holding the returned upload bandwidth information
	109	*
	110	* Return: false on parse error and true otherwise.
	111	*/
	112	static bool batadv_parse_gw_bandwidth(struct net_device net_dev, char buff,
	113	u32 down, u32 up)
	114	{
	115	char *slash_ptr;
	116	bool ret;
c6c8fea2	117
d737ccbe SE	118	slash_ptr = strchr(buff, '/');
	119	if (slash_ptr)
	120	*slash_ptr = 0;
c6c8fea2	121
d737ccbe SE	122	ret = batadv_parse_throughput(net_dev, buff, "download gateway speed",
	123	down);
	124	if (!ret)
	125	return false;
0b8336f5	126
d737ccbe SE	127	/* we also got some upload info */
	128	if (slash_ptr) {
	129	ret = batadv_parse_throughput(net_dev, slash_ptr + 1,
	130	"upload gateway speed", up);
	131	if (!ret)
0b8336f5	132	return false;
c6c8fea2 SE	133	}
	134
	135	return true;
	136	}
	137
414254e3 ML	138	/**
	139	* batadv_gw_tvlv_container_update - update the gw tvlv container after gateway
	140	* setting change
	141	* @bat_priv: the bat priv with all the soft interface information
	142	*/
	143	void batadv_gw_tvlv_container_update(struct batadv_priv *bat_priv)
	144	{
	145	struct batadv_tvlv_gateway_data gw;
6b5e971a	146	u32 down, up;
414254e3 ML	147	char gw_mode;
414254e3 ML	148
3a24a63e	149	gw_mode = atomic_read(&bat_priv->gw.mode);
414254e3 ML	150
	151	switch (gw_mode) {
	152	case BATADV_GW_MODE_OFF:
	153	case BATADV_GW_MODE_CLIENT:
	154	batadv_tvlv_container_unregister(bat_priv, BATADV_TVLV_GW, 1);
	155	break;
	156	case BATADV_GW_MODE_SERVER:
	157	down = atomic_read(&bat_priv->gw.bandwidth_down);
	158	up = atomic_read(&bat_priv->gw.bandwidth_up);
	159	gw.bandwidth_down = htonl(down);
	160	gw.bandwidth_up = htonl(up);
	161	batadv_tvlv_container_register(bat_priv, BATADV_TVLV_GW, 1,
	162	&gw, sizeof(gw));
	163	break;
	164	}
	165	}
	166
84d5e5e0 SE	167	ssize_t batadv_gw_bandwidth_set(struct net_device net_dev, char buff,
84d5e5e0 SE	168	size_t count)
c6c8fea2	169	{
56303d34	170	struct batadv_priv *bat_priv = netdev_priv(net_dev);
4f248cff SE	171	u32 down_curr;
	172	u32 up_curr;
	173	u32 down_new = 0;
	174	u32 up_new = 0;
c6c8fea2 SE	175	bool ret;
c6c8fea2 SE	176
414254e3 ML	177	down_curr = (unsigned int)atomic_read(&bat_priv->gw.bandwidth_down);
	178	up_curr = (unsigned int)atomic_read(&bat_priv->gw.bandwidth_up);
	179
	180	ret = batadv_parse_gw_bandwidth(net_dev, buff, &down_new, &up_new);
c6c8fea2	181	if (!ret)
77927b7d	182	return -EINVAL;
c6c8fea2	183
414254e3 ML	184	if (!down_new)
414254e3 ML	185	down_new = 1;
c6c8fea2	186
414254e3 ML	187	if (!up_new)
414254e3 ML	188	up_new = down_new / 5;
c6c8fea2	189
414254e3 ML	190	if (!up_new)
414254e3 ML	191	up_new = 1;
c6c8fea2	192
414254e3	193	if ((down_curr == down_new) && (up_curr == up_new))
dafe94b2 ML	194	return count;
dafe94b2 ML	195
4e820e72	196	batadv_gw_reselect(bat_priv);
3e34819e	197	batadv_info(net_dev,
414254e3 ML	198	"Changing gateway bandwidth from: '%u.%u/%u.%u MBit' to: '%u.%u/%u.%u MBit'\n",
	199	down_curr / 10, down_curr % 10, up_curr / 10, up_curr % 10,
	200	down_new / 10, down_new % 10, up_new / 10, up_new % 10);
c6c8fea2	201
414254e3 ML	202	atomic_set(&bat_priv->gw.bandwidth_down, down_new);
	203	atomic_set(&bat_priv->gw.bandwidth_up, up_new);
	204	batadv_gw_tvlv_container_update(bat_priv);
c6c8fea2	205
c6c8fea2 SE	206	return count;
c6c8fea2 SE	207	}
414254e3 ML	208
	209	/**
	210	* batadv_gw_tvlv_ogm_handler_v1 - process incoming gateway tvlv container
	211	* @bat_priv: the bat priv with all the soft interface information
	212	* @orig: the orig_node of the ogm
	213	* @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags)
	214	* @tvlv_value: tvlv buffer containing the gateway data
	215	* @tvlv_value_len: tvlv buffer length
	216	*/
	217	static void batadv_gw_tvlv_ogm_handler_v1(struct batadv_priv *bat_priv,
	218	struct batadv_orig_node *orig,
6b5e971a SE	219	u8 flags,
6b5e971a SE	220	void *tvlv_value, u16 tvlv_value_len)
414254e3 ML	221	{
	222	struct batadv_tvlv_gateway_data gateway, *gateway_ptr;
	223
	224	/* only fetch the tvlv value if the handler wasn't called via the
	225	* CIFNOTFND flag and if there is data to fetch
	226	*/
	227	if ((flags & BATADV_TVLV_HANDLER_OGM_CIFNOTFND) \|\|
	228	(tvlv_value_len < sizeof(gateway))) {
	229	gateway.bandwidth_down = 0;
	230	gateway.bandwidth_up = 0;
	231	} else {
	232	gateway_ptr = tvlv_value;
	233	gateway.bandwidth_down = gateway_ptr->bandwidth_down;
	234	gateway.bandwidth_up = gateway_ptr->bandwidth_up;
	235	if ((gateway.bandwidth_down == 0) \|\|
	236	(gateway.bandwidth_up == 0)) {
	237	gateway.bandwidth_down = 0;
	238	gateway.bandwidth_up = 0;
	239	}
	240	}
	241
	242	batadv_gw_node_update(bat_priv, orig, &gateway);
	243
34d99cfe	244	/* restart gateway selection */
414254e3	245	if ((gateway.bandwidth_down != 0) &&
34d99cfe	246	(atomic_read(&bat_priv->gw.mode) == BATADV_GW_MODE_CLIENT))
414254e3 ML	247	batadv_gw_check_election(bat_priv, orig);
	248	}
	249
	250	/**
	251	* batadv_gw_init - initialise the gateway handling internals
	252	* @bat_priv: the bat priv with all the soft interface information
	253	*/
	254	void batadv_gw_init(struct batadv_priv *bat_priv)
	255	{
1a9070ec SE	256	if (bat_priv->algo_ops->gw.init_sel_class)
	257	bat_priv->algo_ops->gw.init_sel_class(bat_priv);
	258	else
	259	atomic_set(&bat_priv->gw.sel_class, 1);
	260
414254e3 ML	261	batadv_tvlv_handler_register(bat_priv, batadv_gw_tvlv_ogm_handler_v1,
	262	NULL, BATADV_TVLV_GW, 1,
	263	BATADV_TVLV_HANDLER_OGM_CIFNOTFND);
	264	}
	265
	266	/**
	267	* batadv_gw_free - free the gateway handling internals
	268	* @bat_priv: the bat priv with all the soft interface information
	269	*/
	270	void batadv_gw_free(struct batadv_priv *bat_priv)
	271	{
	272	batadv_tvlv_container_unregister(bat_priv, BATADV_TVLV_GW, 1);
	273	batadv_tvlv_handler_unregister(bat_priv, BATADV_TVLV_GW, 1);
	274	}