Page MenuHomeVyOS Platform
Files F35451006

trafficshaper.py
No OneTemporary
Actions

Size
8 KB
Referenced Files
None
Subscribers
None

trafficshaper.py
View Options

# Copyright VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see <http://www.gnu.org/licenses/>.
from math import ceil
from vyos.qos.base import QoSBase
# Kernel limits on quantum (bytes)
MAXQUANTUM = 200000
MINQUANTUM = 1000
class TrafficShaper(QoSBase):
_parent = 1
qostype = 'shaper'
# https://man7.org/linux/man-pages/man8/tc-htb.8.html
def update(self, config, direction):
class_id_max = 0
if 'class' in config:
tmp = list(config['class'])
# Convert strings to integers
tmp = [int(x) for x in tmp]
class_id_max = max(tmp)
r2q = 10
# bandwidth is a mandatory CLI node
speed = self._rate_convert(config['bandwidth'])
speed_bps = int(speed) // 8
# need a bigger r2q if going fast than 16 mbits/sec
if (speed_bps // r2q) >= MAXQUANTUM: # integer division
r2q = ceil(speed_bps / MAXQUANTUM)
else:
# if there is a slow class then may need smaller value
if 'class' in config:
min_speed = speed_bps
for cls, cls_options in config['class'].items():
# find class with the lowest bandwidth used
if 'bandwidth' in cls_options:
bw_bps = int(self._rate_convert(cls_options['bandwidth'])) // 8 # bandwidth in bytes per second
if bw_bps < min_speed:
min_speed = bw_bps
while (r2q > 1) and (min_speed // r2q) < MINQUANTUM:
tmp = r2q -1
if (speed_bps // tmp) >= MAXQUANTUM:
break
r2q = tmp
default_minor_id = int(class_id_max) +1
tmp = f'tc qdisc replace dev {self._interface} root handle {self._parent:x}: htb r2q {r2q} default {default_minor_id:x}' # default is in hex
self._cmd(tmp)
tmp = f'tc class replace dev {self._interface} parent {self._parent:x}: classid {self._parent:x}:1 htb rate {speed}'
self._cmd(tmp)
if 'class' in config:
for cls, cls_config in config['class'].items():
# class id is used later on and passed as hex, thus this needs to be an int
cls = int(cls)
# bandwidth is a mandatory CLI node
# T5296 if bandwidth 'auto' or 'xx%' get value from config shaper total "bandwidth"
# i.e from set shaper test bandwidth '300mbit'
# without it, it tries to get value from qos.base /sys/class/net/{self._interface}/speed
if cls_config['bandwidth'] == 'auto':
rate = self._rate_convert(config['bandwidth'])
elif cls_config['bandwidth'].endswith('%'):
percent = cls_config['bandwidth'].rstrip('%')
rate = self._rate_convert(config['bandwidth']) * int(percent) // 100
else:
rate = self._rate_convert(cls_config['bandwidth'])
burst = cls_config['burst']
quantum = cls_config['codel_quantum']
tmp = f'tc class replace dev {self._interface} parent {self._parent:x}:1 classid {self._parent:x}:{cls:x} htb rate {rate} burst {burst} quantum {quantum}'
if 'priority' in cls_config:
priority = cls_config['priority']
tmp += f' prio {priority}'
if 'ceiling' in cls_config:
f_ceil = self._rate_convert(cls_config['ceiling'])
tmp += f' ceil {f_ceil}'
self._cmd(tmp)
tmp = f'tc qdisc replace dev {self._interface} parent {self._parent:x}:{cls:x} sfq'
self._cmd(tmp)
if 'default' in config:
if config['default']['bandwidth'].endswith('%'):
percent = config['default']['bandwidth'].rstrip('%')
rate = self._rate_convert(config['bandwidth']) * int(percent) // 100
else:
rate = self._rate_convert(config['default']['bandwidth'])
burst = config['default']['burst']
quantum = config['default']['codel_quantum']
tmp = f'tc class replace dev {self._interface} parent {self._parent:x}:1 classid {self._parent:x}:{default_minor_id:x} htb rate {rate} burst {burst} quantum {quantum}'
if 'priority' in config['default']:
priority = config['default']['priority']
tmp += f' prio {priority}'
if 'ceiling' in config['default']:
if config['default']['ceiling'].endswith('%'):
percent = config['default']['ceiling'].rstrip('%')
f_ceil = self._rate_convert(config['bandwidth']) * int(percent) // 100
else:
f_ceil = self._rate_convert(config['default']['ceiling'])
tmp += f' ceil {f_ceil}'
self._cmd(tmp)
tmp = f'tc qdisc replace dev {self._interface} parent {self._parent:x}:{default_minor_id:x} sfq'
self._cmd(tmp)
# call base class
super().update(config, direction)
class TrafficShaperHFSC(QoSBase):
"""
Traffic shaper using Hierarchical Fair Service Curve (HFSC).
Documentation: https://man7.org/linux/man-pages/man8/tc-hfsc.8.html
"""
_parent = 1
qostype = 'shaper_hfsc'
criteria = ['linkshare', 'realtime', 'upperlimit']
short_criterion = {
'linkshare': 'ls',
'realtime': 'rt',
'upperlimit': 'ul',
}
def _gen_class(self, cls: int, cls_config: dict):
"""
Generate HFSC class and add Stochastic Fair Queueing (SFQ) qdisc.
Args:
cls (int): Class ID
cls_config (dict): Configuration for the class
"""
tmp = f'tc class replace dev {self._interface} parent {self._parent:x}:1 classid {self._parent:x}:{cls:x} hfsc'
for crit in self.criteria:
param = cls_config.get(crit)
if param:
tmp += (
f' {self.short_criterion[crit]}'
f' m1 {self._rate_convert(param["m1"]) if param.get("m1") else 0}'
f' d {param.get("d", 0)}ms'
f' m2 {self._rate_convert(param["m2"])}'
)
self._cmd(tmp)
tmp = f'tc qdisc replace dev {self._interface} parent {self._parent:x}:{cls:x} sfq perturb 10'
self._cmd(tmp)
def update(self, config, direction):
class_id_max = self._get_class_max_id(config)
default_cls_id = int(class_id_max) + 1 if class_id_max else 2
speed = self._rate_convert(config['bandwidth'])
tmp = f'tc qdisc replace dev {self._interface} root handle {self._parent:x}: hfsc default {default_cls_id:x}' # default is in hex
self._cmd(tmp)
tmp = f'tc class replace dev {self._interface} parent {self._parent:x}: classid {self._parent:x}:1 hfsc sc rate {speed} ul rate {speed}'
self._cmd(tmp)
# tmp = f'tc qdisc add dev {self._interface} parent {self._parent:x}:1 handle f1: sfq perturb 10'
# self._cmd(tmp)
if 'class' in config:
for cls, cls_config in config['class'].items():
self._gen_class(cls=int(cls), cls_config=cls_config)
if 'default' in config:
self._gen_class(
cls=int(default_cls_id), cls_config=config.get('default', {})
)
# call base class
super().update(config, direction)

File Metadata

Mime Type
text/x-script.python
Expires
Tue, Dec 9, 10:52 PM (1 d, 1 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3068806
Default Alt Text
trafficshaper.py (8 KB)

Event Timeline