-
Notifications
You must be signed in to change notification settings - Fork 15
/
cli.py
379 lines (341 loc) · 13.8 KB
/
cli.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
import argparse
import atexit
import collections
import enum
import time
from typing import Dict, DefaultDict, Set
from loguru import logger
from ruamel.yaml import YAML
from .exceptions import DependencyOutputError, MissingDependencyError
from .net import ProcessFilterPredicate, filter_net_connections
from .speedtest import test_speed
from .tc import (
MAX_RATE,
INGRESS_QDISC_PARENT_ID,
tc_add_htb_class,
tc_add_u32_filter,
tc_remove_qdisc,
tc_remove_u32_filter,
tc_setup,
)
CONFIG_ENCODING = "UTF-8"
GLOBAL_MINIMUM_DOWNLOAD_RATE = "100kbps"
GLOBAL_MINIMUM_UPLOAD_RATE = "10kbps"
MINIMUM_DOWNLOAD_RATE = "10kbps"
MINIMUM_UPLOAD_RATE = "1kbps"
class _TrafficType(enum.Enum):
Ingress = enum.auto()
Egress = enum.auto()
def get_argument_parser() -> argparse.ArgumentParser:
# noinspection PyTypeChecker
argument_parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter
)
argument_parser.add_argument(
"device", help="The network device to be traffic shaped"
)
argument_parser.add_argument("config", help="The configuration file")
argument_parser.add_argument(
"--delay",
"-d",
type=float,
default=1,
help="The delay in seconds between checks for changed connections in monitored "
"processes",
)
argument_parser.add_argument(
"--logging-level",
"-l",
choices={"TRACE", "DEBUG", "INFO", "SUCCESS", "WARNING", "ERROR", "CRITICAL"},
default="INFO",
help="The logging level",
)
argument_parser.add_argument(
"--speed-test",
"-s",
action="store_true",
help="Automatically determine upload and download speed before start. Make sure"
' to run "speedtest --accept-license" as root beforehand if you are using the '
'official "Ookla Speedtest CLI".',
)
return argument_parser
def _clean_up(ingress_device: str, egress_device: str) -> None:
logger.info("Cleaning up QDiscs")
tc_remove_qdisc(ingress_device)
tc_remove_qdisc(egress_device)
tc_remove_qdisc(egress_device, INGRESS_QDISC_PARENT_ID)
# TODO: Check configuration and raise ConfigError
def main(arguments: argparse.Namespace) -> None:
with open(arguments.config, "r", encoding=CONFIG_ENCODING) as file:
config = YAML().load(file)
config_global_download_rate = config.get("download")
config_global_upload_rate = config.get("upload")
if arguments.speed_test:
logger.info("Running speed test...")
try:
result = test_speed()
except MissingDependencyError as error:
logger.error("Missing dependency: {}", error)
result = None
except DependencyOutputError as error:
logger.error("Dependency output error: {}", error)
result = None
if result:
logger.info(
"Determined download speed: {}bps, upload speed: {}bps", *result
)
config_global_download_rate, config_global_upload_rate = result
else:
logger.error(
"Failed to automatically determine download and upload speed, falling "
"back to configuration values"
)
if config_global_download_rate is None:
logger.info(
"No global download rate specified, download traffic prioritization won't "
"work"
)
global_download_rate = MAX_RATE
else:
global_download_rate = config_global_download_rate
if config_global_upload_rate is None:
logger.info(
"No global upload rate specified, upload traffic prioritization won't work"
)
global_upload_rate = MAX_RATE
else:
global_upload_rate = config_global_upload_rate
# Determine the priority we want the global default classes to have: this is n+1
# where n is the lowest defined (=highest integer) priority for any processes in the
# configuration file. Processes that do not explicitly specify a priority will use
# this default priority and therefore have the same priority as the global default
# classes
lowest_priority = -1
for name, process in (config.get("processes", {}) or {}).items():
lowest_priority = max(process.get("upload-priority", -1), lowest_priority)
lowest_priority = max(process.get("download-priority", -1), lowest_priority)
lowest_priority += 1
global_download_priority = config.get("download-priority", lowest_priority)
global_upload_priority = config.get("upload-priority", lowest_priority)
config_global_download_minimum_rate = config.get("download-minimum")
global_download_minimum_rate = (
GLOBAL_MINIMUM_DOWNLOAD_RATE
if config_global_download_minimum_rate is None
else config_global_download_minimum_rate
)
if config_global_download_rate is not None:
logger.info(
"Setting up global class with max download rate: {} (minimum: {}) and "
"priority: {}",
global_download_rate,
global_download_minimum_rate,
global_download_priority,
)
else:
logger.info(
"Setting up global class with unlimited download rate (minimum: {}) and "
"priority: {}",
global_download_minimum_rate,
global_download_priority,
)
config_global_upload_minimum_rate = config.get("upload-minimum")
global_upload_minimum_rate = (
GLOBAL_MINIMUM_UPLOAD_RATE
if config_global_upload_minimum_rate is None
else config_global_upload_minimum_rate
)
if config_global_upload_rate is not None:
logger.info(
"Setting up global class with max upload rate: {} (minimum: {}) and "
"priority: {}",
global_upload_rate,
global_upload_minimum_rate,
global_upload_priority,
)
else:
logger.info(
"Setting up global class with unlimited upload rate (minimum: {}) and "
"priority: {}",
global_upload_minimum_rate,
global_upload_priority,
)
ingress_qdisc, egress_qdisc = tc_setup(
arguments.device,
global_download_rate,
global_download_minimum_rate,
global_upload_rate,
global_upload_minimum_rate,
global_download_priority,
global_upload_priority,
)
atexit.register(_clean_up, ingress_qdisc.device, egress_qdisc.device)
process_filter_predicates = []
class_ids: Dict[_TrafficType, Dict[str, int]] = {
_TrafficType.Ingress: {},
_TrafficType.Egress: {},
}
for name, process in (config.get("processes", {}) or {}).items():
# Prepare process filter predicates to match network connections
conditions = [list(match.items())[0] for match in process.get("match", [])]
if not conditions:
logger.warning(
"No conditions for: {!r} specified, it will never be matched", name
)
continue
predicate = ProcessFilterPredicate(
name, conditions, process.get("recursive", False)
)
process_filter_predicates.append(predicate)
# Set up classes for download/upload limiting
config_download_rate = process.get("download")
config_download_minimum_rate = process.get("download-minimum")
config_download_priority = process.get("download-priority")
download_rate = (
global_download_rate
if config_download_rate is None
else config_download_rate
)
download_minimum_rate = (
MINIMUM_DOWNLOAD_RATE
if config_download_minimum_rate is None
else config_download_minimum_rate
)
download_priority = (
lowest_priority
if config_download_priority is None
else config_download_priority
)
config_upload_rate = process.get("upload")
config_upload_minimum_rate = process.get("upload-minimum")
config_upload_priority = process.get("upload-priority")
upload_rate = (
global_upload_rate if config_upload_rate is None else config_upload_rate
)
upload_minimum_rate = (
MINIMUM_UPLOAD_RATE
if config_upload_minimum_rate is None
else config_upload_minimum_rate
)
upload_priority = (
lowest_priority
if config_upload_priority is None
else config_upload_priority
)
if config_download_rate is not None:
logger.info(
"Setting up class for: {!r} with max download rate: {} (minimum: {}) "
"and priority: {}",
name,
download_rate,
download_minimum_rate,
download_priority,
)
ingress_class_id = tc_add_htb_class(
ingress_qdisc, download_rate, download_minimum_rate, download_priority,
)
class_ids[_TrafficType.Ingress][name] = ingress_class_id
elif config_download_priority is not None:
logger.info(
"Setting up class for: {!r} with unlimited download rate (minimum: {}) "
"and priority: {}",
name,
download_minimum_rate,
download_priority,
)
ingress_class_id = tc_add_htb_class(
ingress_qdisc, download_rate, download_minimum_rate, download_priority,
)
class_ids[_TrafficType.Ingress][name] = ingress_class_id
if config_upload_rate is not None:
logger.info(
"Setting up class for: {!r} with max upload rate: {} (minimum: {}) and "
"priority: {}",
name,
upload_rate,
upload_minimum_rate,
upload_priority,
)
egress_class_id = tc_add_htb_class(
egress_qdisc, upload_rate, upload_minimum_rate, upload_priority,
)
class_ids[_TrafficType.Egress][name] = egress_class_id
elif config_upload_priority is not None:
logger.info(
"Setting up class for: {!r} with unlimited upload rate (minimum: {}) "
"and priority: {}",
name,
upload_minimum_rate,
upload_priority,
)
egress_class_id = tc_add_htb_class(
egress_qdisc, upload_rate, upload_minimum_rate, upload_priority,
)
class_ids[_TrafficType.Egress][name] = egress_class_id
port_to_filter_id: Dict[_TrafficType, Dict[int, str]] = {
_TrafficType.Ingress: {},
_TrafficType.Egress: {},
}
def add_ingress_filter(port: int, class_id: int) -> None:
filter_id = tc_add_u32_filter(
ingress_qdisc, f"match ip dport {port} 0xffff", class_id,
)
port_to_filter_id[_TrafficType.Ingress][port] = filter_id
def add_egress_filter(port: int, class_id: int) -> None:
filter_id = tc_add_u32_filter(
egress_qdisc, f"match ip sport {port} 0xffff", class_id,
)
port_to_filter_id[_TrafficType.Egress][port] = filter_id
def remove_filters(port: int) -> None:
ingress_filter_id = port_to_filter_id[_TrafficType.Ingress].get(port)
if ingress_filter_id:
tc_remove_u32_filter(ingress_qdisc, ingress_filter_id)
del port_to_filter_id[_TrafficType.Ingress][port]
egress_filter_id = port_to_filter_id[_TrafficType.Egress].get(port)
if egress_filter_id:
tc_remove_u32_filter(egress_qdisc, egress_filter_id)
del port_to_filter_id[_TrafficType.Egress][port]
filtered_ports: DefaultDict[str, Set[int]] = collections.defaultdict(set)
while True:
filtered_connections = filter_net_connections(process_filter_predicates)
for name, connections in filtered_connections.items():
ports = set(connection.laddr.port for connection in connections)
active_ingress_class_id = class_ids[_TrafficType.Ingress].get(name)
active_egress_class_id = class_ids[_TrafficType.Egress].get(name)
# Add new port filters
new_ports = sorted(ports.difference(filtered_ports[name]))
if new_ports:
logger.info(
"Shaping traffic for {!r} on local ports {}",
name,
", ".join(map(str, new_ports)),
)
for port in new_ports:
if active_ingress_class_id:
add_ingress_filter(port, active_ingress_class_id)
if active_egress_class_id:
add_egress_filter(port, active_egress_class_id)
# Remove old port filters
freed_ports = sorted(filtered_ports[name].difference(ports))
if freed_ports:
logger.info(
"Removing filters for {!r} on local ports {}",
name,
", ".join(map(str, freed_ports)),
)
for port in freed_ports:
remove_filters(port)
filtered_ports[name] = ports
# Remove freed ports for unmatched processes (process died or predicate
# conditions stopped matching)
for name in set(filtered_ports).difference(filtered_connections):
freed_ports = sorted(filtered_ports[name])
if freed_ports:
logger.info(
"Removing filters for {!r} on local ports {}",
name,
", ".join(map(str, freed_ports)),
)
for port in freed_ports:
remove_filters(port)
del filtered_ports[name]
time.sleep(arguments.delay)