Blame view

net/batman-adv/gateway_common.c 7.8 KB
7db7d9f36   Sven Eckelmann   batman-adv: Add S...
1
  // SPDX-License-Identifier: GPL-2.0
7a79d717e   Sven Eckelmann   batman-adv: Updat...
2
  /* Copyright (C) 2009-2019  B.A.T.M.A.N. contributors:
c6c8fea29   Sven Eckelmann   net: Add batman-a...
3
4
5
6
7
8
9
10
11
12
13
14
15
   *
   * 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
ebf38fb7a   Antonio Quartulli   batman-adv: remov...
16
   * along with this program; if not, see <http://www.gnu.org/licenses/>.
c6c8fea29   Sven Eckelmann   net: Add batman-a...
17
   */
c6c8fea29   Sven Eckelmann   net: Add batman-a...
18
  #include "gateway_common.h"
1e2c2a4fe   Sven Eckelmann   batman-adv: Add r...
19
20
21
22
  #include "main.h"
  
  #include <linux/atomic.h>
  #include <linux/byteorder/generic.h>
fcafa5e74   Sven Eckelmann   batman-adv: Keep ...
23
  #include <linux/errno.h>
1e2c2a4fe   Sven Eckelmann   batman-adv: Add r...
24
  #include <linux/kernel.h>
0b8336f5f   Sven Eckelmann   batman-adv: Fix g...
25
  #include <linux/math64.h>
1e2c2a4fe   Sven Eckelmann   batman-adv: Add r...
26
27
28
  #include <linux/netdevice.h>
  #include <linux/stddef.h>
  #include <linux/string.h>
fec149f5d   Sven Eckelmann   batman-adv: Conve...
29
  #include <uapi/linux/batadv_packet.h>
e2d0d35b5   Sven Eckelmann   batman-adv: Add g...
30
  #include <uapi/linux/batman_adv.h>
1e2c2a4fe   Sven Eckelmann   batman-adv: Add r...
31

c6c8fea29   Sven Eckelmann   net: Add batman-a...
32
  #include "gateway_client.h"
ba412080f   Sven Eckelmann   batman-adv: Conso...
33
  #include "log.h"
1f8dce499   Markus Pargmann   batman-adv: split...
34
  #include "tvlv.h"
c6c8fea29   Sven Eckelmann   net: Add batman-a...
35

414254e34   Marek Lindner   batman-adv: tvlv ...
36
  /**
7e9a8c2ce   Sven Eckelmann   batman-adv: Use p...
37
38
   * batadv_parse_throughput() - parse supplied string buffer to extract
   *  throughput information
414254e34   Marek Lindner   batman-adv: tvlv ...
39
40
   * @net_dev: the soft interface net device
   * @buff: string buffer to parse
d737ccbed   Sven Eckelmann   batman-adv: Add f...
41
42
   * @description: text shown when throughput string cannot be parsed
   * @throughput: pointer holding the returned throughput information
414254e34   Marek Lindner   batman-adv: tvlv ...
43
   *
62fe710f6   Sven Eckelmann   batman-adv: Fix k...
44
   * Return: false on parse error and true otherwise.
414254e34   Marek Lindner   batman-adv: tvlv ...
45
   */
0b5ecc681   Antonio Quartulli   batman-adv: add t...
46
47
  bool batadv_parse_throughput(struct net_device *net_dev, char *buff,
  			     const char *description, u32 *throughput)
c6c8fea29   Sven Eckelmann   net: Add batman-a...
48
  {
414254e34   Marek Lindner   batman-adv: tvlv ...
49
  	enum batadv_bandwidth_units bw_unit_type = BATADV_BW_UNIT_KBIT;
d737ccbed   Sven Eckelmann   batman-adv: Add f...
50
51
  	u64 lthroughput;
  	char *tmp_ptr;
414254e34   Marek Lindner   batman-adv: tvlv ...
52
  	int ret;
c6c8fea29   Sven Eckelmann   net: Add batman-a...
53

c6c8fea29   Sven Eckelmann   net: Add batman-a...
54
55
  	if (strlen(buff) > 4) {
  		tmp_ptr = buff + strlen(buff) - 4;
b7a8d756f   Rasmus Villemoes   batman-adv: repla...
56
  		if (strncasecmp(tmp_ptr, "mbit", 4) == 0)
414254e34   Marek Lindner   batman-adv: tvlv ...
57
  			bw_unit_type = BATADV_BW_UNIT_MBIT;
c6c8fea29   Sven Eckelmann   net: Add batman-a...
58

825ffe1f7   Sven Eckelmann   batman-adv: Remov...
59
60
  		if (strncasecmp(tmp_ptr, "kbit", 4) == 0 ||
  		    bw_unit_type == BATADV_BW_UNIT_MBIT)
c6c8fea29   Sven Eckelmann   net: Add batman-a...
61
62
  			*tmp_ptr = '\0';
  	}
d737ccbed   Sven Eckelmann   batman-adv: Add f...
63
  	ret = kstrtou64(buff, 10, &lthroughput);
c6c8fea29   Sven Eckelmann   net: Add batman-a...
64
  	if (ret) {
3e34819e0   Sven Eckelmann   batman-adv: Prefi...
65
  		batadv_err(net_dev,
d737ccbed   Sven Eckelmann   batman-adv: Add f...
66
67
68
  			   "Invalid throughput speed for %s: %s
  ",
  			   description, buff);
c6c8fea29   Sven Eckelmann   net: Add batman-a...
69
70
  		return false;
  	}
414254e34   Marek Lindner   batman-adv: tvlv ...
71
72
  	switch (bw_unit_type) {
  	case BATADV_BW_UNIT_MBIT:
0b8336f5f   Sven Eckelmann   batman-adv: Fix g...
73
  		/* prevent overflow */
d737ccbed   Sven Eckelmann   batman-adv: Add f...
74
  		if (U64_MAX / 10 < lthroughput) {
0b8336f5f   Sven Eckelmann   batman-adv: Fix g...
75
  			batadv_err(net_dev,
d737ccbed   Sven Eckelmann   batman-adv: Add f...
76
77
78
  				   "Throughput speed for %s too large: %s
  ",
  				   description, buff);
0b8336f5f   Sven Eckelmann   batman-adv: Fix g...
79
80
  			return false;
  		}
d737ccbed   Sven Eckelmann   batman-adv: Add f...
81
  		lthroughput *= 10;
414254e34   Marek Lindner   batman-adv: tvlv ...
82
83
84
  		break;
  	case BATADV_BW_UNIT_KBIT:
  	default:
d737ccbed   Sven Eckelmann   batman-adv: Add f...
85
  		lthroughput = div_u64(lthroughput, 100);
414254e34   Marek Lindner   batman-adv: tvlv ...
86
87
  		break;
  	}
c6c8fea29   Sven Eckelmann   net: Add batman-a...
88

d737ccbed   Sven Eckelmann   batman-adv: Add f...
89
  	if (lthroughput > U32_MAX) {
0b8336f5f   Sven Eckelmann   batman-adv: Fix g...
90
  		batadv_err(net_dev,
d737ccbed   Sven Eckelmann   batman-adv: Add f...
91
92
93
  			   "Throughput speed for %s too large: %s
  ",
  			   description, buff);
0b8336f5f   Sven Eckelmann   batman-adv: Fix g...
94
95
  		return false;
  	}
d737ccbed   Sven Eckelmann   batman-adv: Add f...
96
  	*throughput = lthroughput;
0b8336f5f   Sven Eckelmann   batman-adv: Fix g...
97

d737ccbed   Sven Eckelmann   batman-adv: Add f...
98
99
  	return true;
  }
c6c8fea29   Sven Eckelmann   net: Add batman-a...
100

d737ccbed   Sven Eckelmann   batman-adv: Add f...
101
  /**
7e9a8c2ce   Sven Eckelmann   batman-adv: Use p...
102
103
   * batadv_parse_gw_bandwidth() - parse supplied string buffer to extract
   *  download and upload bandwidth information
d737ccbed   Sven Eckelmann   batman-adv: Add f...
104
105
106
107
108
109
110
111
112
113
114
115
   * @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;
c6c8fea29   Sven Eckelmann   net: Add batman-a...
116

d737ccbed   Sven Eckelmann   batman-adv: Add f...
117
118
119
  	slash_ptr = strchr(buff, '/');
  	if (slash_ptr)
  		*slash_ptr = 0;
c6c8fea29   Sven Eckelmann   net: Add batman-a...
120

d737ccbed   Sven Eckelmann   batman-adv: Add f...
121
122
123
124
  	ret = batadv_parse_throughput(net_dev, buff, "download gateway speed",
  				      down);
  	if (!ret)
  		return false;
0b8336f5f   Sven Eckelmann   batman-adv: Fix g...
125

d737ccbed   Sven Eckelmann   batman-adv: Add f...
126
127
128
129
130
  	/* we also got some upload info */
  	if (slash_ptr) {
  		ret = batadv_parse_throughput(net_dev, slash_ptr + 1,
  					      "upload gateway speed", up);
  		if (!ret)
0b8336f5f   Sven Eckelmann   batman-adv: Fix g...
131
  			return false;
c6c8fea29   Sven Eckelmann   net: Add batman-a...
132
133
134
135
  	}
  
  	return true;
  }
414254e34   Marek Lindner   batman-adv: tvlv ...
136
  /**
7e9a8c2ce   Sven Eckelmann   batman-adv: Use p...
137
138
   * batadv_gw_tvlv_container_update() - update the gw tvlv container after
   *  gateway setting change
414254e34   Marek Lindner   batman-adv: tvlv ...
139
140
141
142
143
   * @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;
6b5e971a2   Sven Eckelmann   batman-adv: Repla...
144
  	u32 down, up;
414254e34   Marek Lindner   batman-adv: tvlv ...
145
  	char gw_mode;
3a24a63e7   Antonio Quartulli   batman-adv: move ...
146
  	gw_mode = atomic_read(&bat_priv->gw.mode);
414254e34   Marek Lindner   batman-adv: tvlv ...
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
  
  	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;
  	}
  }
ff15c27c9   Sven Eckelmann   batman-adv: Add k...
163
164
165
166
167
168
169
170
171
  /**
   * 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
   */
84d5e5e00   Sven Eckelmann   batman-adv: Prefi...
172
173
  ssize_t batadv_gw_bandwidth_set(struct net_device *net_dev, char *buff,
  				size_t count)
c6c8fea29   Sven Eckelmann   net: Add batman-a...
174
  {
56303d34a   Sven Eckelmann   batman-adv: Prefi...
175
  	struct batadv_priv *bat_priv = netdev_priv(net_dev);
4f248cff9   Sven Eckelmann   batman-adv: Remov...
176
177
178
179
  	u32 down_curr;
  	u32 up_curr;
  	u32 down_new = 0;
  	u32 up_new = 0;
c6c8fea29   Sven Eckelmann   net: Add batman-a...
180
  	bool ret;
414254e34   Marek Lindner   batman-adv: tvlv ...
181
182
183
184
  	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);
c6c8fea29   Sven Eckelmann   net: Add batman-a...
185
  	if (!ret)
77927b7d9   Sven Eckelmann   batman-adv: Retur...
186
  		return -EINVAL;
c6c8fea29   Sven Eckelmann   net: Add batman-a...
187

414254e34   Marek Lindner   batman-adv: tvlv ...
188
189
  	if (!down_new)
  		down_new = 1;
c6c8fea29   Sven Eckelmann   net: Add batman-a...
190

414254e34   Marek Lindner   batman-adv: tvlv ...
191
192
  	if (!up_new)
  		up_new = down_new / 5;
c6c8fea29   Sven Eckelmann   net: Add batman-a...
193

414254e34   Marek Lindner   batman-adv: tvlv ...
194
195
  	if (!up_new)
  		up_new = 1;
c6c8fea29   Sven Eckelmann   net: Add batman-a...
196

825ffe1f7   Sven Eckelmann   batman-adv: Remov...
197
  	if (down_curr == down_new && up_curr == up_new)
dafe94b27   Marek Lindner   batman-adv: only ...
198
  		return count;
4e820e72d   Antonio Quartulli   batman-adv: renam...
199
  	batadv_gw_reselect(bat_priv);
3e34819e0   Sven Eckelmann   batman-adv: Prefi...
200
  	batadv_info(net_dev,
414254e34   Marek Lindner   batman-adv: tvlv ...
201
202
203
204
  		    "Changing gateway bandwidth from: '%u.%u/%u.%u MBit' to: '%u.%u/%u.%u MBit'
  ",
  		    down_curr / 10, down_curr % 10, up_curr / 10, up_curr % 10,
  		    down_new / 10, down_new % 10, up_new / 10, up_new % 10);
c6c8fea29   Sven Eckelmann   net: Add batman-a...
205

414254e34   Marek Lindner   batman-adv: tvlv ...
206
207
208
  	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);
c6c8fea29   Sven Eckelmann   net: Add batman-a...
209

c6c8fea29   Sven Eckelmann   net: Add batman-a...
210
211
  	return count;
  }
414254e34   Marek Lindner   batman-adv: tvlv ...
212
213
  
  /**
7e9a8c2ce   Sven Eckelmann   batman-adv: Use p...
214
   * batadv_gw_tvlv_ogm_handler_v1() - process incoming gateway tvlv container
414254e34   Marek Lindner   batman-adv: tvlv ...
215
216
217
218
219
220
221
222
   * @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,
6b5e971a2   Sven Eckelmann   batman-adv: Repla...
223
224
  					  u8 flags,
  					  void *tvlv_value, u16 tvlv_value_len)
414254e34   Marek Lindner   batman-adv: tvlv ...
225
226
227
228
229
230
  {
  	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
  	 */
825ffe1f7   Sven Eckelmann   batman-adv: Remov...
231
232
  	if (flags & BATADV_TVLV_HANDLER_OGM_CIFNOTFND ||
  	    tvlv_value_len < sizeof(gateway)) {
414254e34   Marek Lindner   batman-adv: tvlv ...
233
234
235
236
237
238
  		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;
825ffe1f7   Sven Eckelmann   batman-adv: Remov...
239
240
  		if (gateway.bandwidth_down == 0 ||
  		    gateway.bandwidth_up == 0) {
414254e34   Marek Lindner   batman-adv: tvlv ...
241
242
243
244
245
246
  			gateway.bandwidth_down = 0;
  			gateway.bandwidth_up = 0;
  		}
  	}
  
  	batadv_gw_node_update(bat_priv, orig, &gateway);
34d99cfef   Antonio Quartulli   batman-adv: make ...
247
  	/* restart gateway selection */
825ffe1f7   Sven Eckelmann   batman-adv: Remov...
248
249
  	if (gateway.bandwidth_down != 0 &&
  	    atomic_read(&bat_priv->gw.mode) == BATADV_GW_MODE_CLIENT)
414254e34   Marek Lindner   batman-adv: tvlv ...
250
251
252
253
  		batadv_gw_check_election(bat_priv, orig);
  }
  
  /**
7e9a8c2ce   Sven Eckelmann   batman-adv: Use p...
254
   * batadv_gw_init() - initialise the gateway handling internals
414254e34   Marek Lindner   batman-adv: tvlv ...
255
256
257
258
   * @bat_priv: the bat priv with all the soft interface information
   */
  void batadv_gw_init(struct batadv_priv *bat_priv)
  {
1a9070ec9   Sven Eckelmann   batman-adv: Initi...
259
260
261
262
  	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);
414254e34   Marek Lindner   batman-adv: tvlv ...
263
264
265
266
267
268
  	batadv_tvlv_handler_register(bat_priv, batadv_gw_tvlv_ogm_handler_v1,
  				     NULL, BATADV_TVLV_GW, 1,
  				     BATADV_TVLV_HANDLER_OGM_CIFNOTFND);
  }
  
  /**
7e9a8c2ce   Sven Eckelmann   batman-adv: Use p...
269
   * batadv_gw_free() - free the gateway handling internals
414254e34   Marek Lindner   batman-adv: tvlv ...
270
271
272
273
274
275
276
   * @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);
  }