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

// SPDX-License-Identifier: GPL-2.0
/* Copyright (C) 2009-2019  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 <uapi/linux/batadv_packet.h>

#include "gateway_client.h"
#include "log.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;
	}
}

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