diff options
| author | Viacheslav Hletenko <v.gletenko@vyos.io> | 2025-09-10 10:31:19 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-09-10 10:31:19 +0300 |
| commit | 41eae8e050fc9afeec7c645ee33da8fdb342056c (patch) | |
| tree | 59bd65b2200879bbb2b6efcc67cbb4a8af795a24 | |
| parent | 1124d3f9aa0531489bc8f622143afcb6116e8f47 (diff) | |
| parent | b0ae930a9fcb3093d3069bb8296a2f572e6a3d93 (diff) | |
| download | vyos-1x-41eae8e050fc9afeec7c645ee33da8fdb342056c.tar.gz vyos-1x-41eae8e050fc9afeec7c645ee33da8fdb342056c.zip | |
Merge pull request #4690 from natali-rs1985/T7757
T7757: VPP Verify buffers for rx/tx queues
| -rw-r--r-- | interface-definitions/vpp.xml.in | 14 | ||||
| -rw-r--r-- | python/vyos/vpp/config_resource_checks/memory.py | 41 | ||||
| -rw-r--r-- | python/vyos/vpp/config_verify.py | 20 | ||||
| -rwxr-xr-x | src/conf_mode/vpp.py | 58 |
4 files changed, 108 insertions, 25 deletions
diff --git a/interface-definitions/vpp.xml.in b/interface-definitions/vpp.xml.in index f69e05168..e7a21ecf1 100644 --- a/interface-definitions/vpp.xml.in +++ b/interface-definitions/vpp.xml.in @@ -360,13 +360,19 @@ <properties> <help>Number of buffers per numa node</help> <valueHelp> - <format>u32:0-4294967295</format> + <format>u32:16384-4294967295</format> <description>Number of buffers</description> </valueHelp> + <valueHelp> + <format>auto</format> + <description>Auto calculate number of buffers per numa node</description> + </valueHelp> <constraint> - <validator name="numeric" argument="--range 0-4294967295"/> + <validator name="numeric" argument="--range 16384-4294967295"/> + <regex>(auto)</regex> </constraint> </properties> + <defaultValue>auto</defaultValue> </leafNode> <leafNode name="data-size"> <properties> @@ -379,12 +385,14 @@ <validator name="numeric" argument="--range 0-4294967295"/> </constraint> </properties> + <defaultValue>2048</defaultValue> </leafNode> <leafNode name="page-size"> <properties> <help>Set the page-size for buffer allocation</help> #include <include/unformat_log2_page_size.xml.i> </properties> + <defaultValue>default</defaultValue> </leafNode> </children> </node> @@ -501,6 +509,7 @@ <validator name="numeric" argument="--range 256-8192"/> </constraint> </properties> + <defaultValue>1024</defaultValue> </leafNode> <leafNode name="num-tx-desc"> <properties> @@ -513,6 +522,7 @@ <validator name="numeric" argument="--range 256-8192"/> </constraint> </properties> + <defaultValue>1024</defaultValue> </leafNode> <leafNode name="num-rx-queues"> <properties> diff --git a/python/vyos/vpp/config_resource_checks/memory.py b/python/vyos/vpp/config_resource_checks/memory.py index 9391e21e1..ea4697ba2 100644 --- a/python/vyos/vpp/config_resource_checks/memory.py +++ b/python/vyos/vpp/config_resource_checks/memory.py @@ -28,6 +28,10 @@ from vyos.vpp.utils import ( from vyos.vpp.config_resource_checks.resource_defaults import default_resource_map +# VPP buffers default per NUMA node +MIN_BUFFERS = 16_384 + + def classify_page_size(page_size_bytes: int) -> str: """ Returns one of: '4K', '2M', '1G' based on page size. @@ -187,3 +191,40 @@ def total_memory_required(settings: dict) -> dict: memory[classify_page_size(page_size)] += memory_size return memory + + +def buffers_required(settings: dict, workers) -> int: + """ + Calculate total VPP buffer requirements based on interface settings and workers. + """ + buffers_total = 0 + for ifname, iface_config in settings.get('interface', {}).items(): + # Do not include XDP interfaces in buffer calculations. + # Unlike DPDK, XDP does not use VPP-managed mbufs for RX/TX rings, + # so buffer requirements cannot be derived from descriptors here. + # Buffers for XDP are handled internally by the kernel/XDP layer, + # not by VPP’s buffer allocator. + if iface_config.get('driver') == 'xdp': + continue + dpdk_options = iface_config.get('dpdk_options', {}) + rx_queues = int(dpdk_options.get('num_rx_queues', 1)) + rx_desc = int(dpdk_options.get('num_rx_desc')) + # default TX queues is equal to number of worker threads + # plus 1 main thread + tx_queues = int(dpdk_options.get('num_tx_queues', workers + 1)) + tx_desc = int(dpdk_options.get('num_tx_desc')) + + # buffers for RX/TX queues for interface + buffers_total += rx_queues * rx_desc + tx_queues * tx_desc + + # per-thread buffer caches (approx. 256 buffers per worker) + buffers_total += workers * 256 + + # Safety margin for buffer calculations: + # traffic bursts, alignment/metadata overhead etc. + # The factor 2.5 is derived from VPP’s own calculations: + # https://github.com/FDio/vpp/blob/stable/2506/extras/vpp_config/vpplib/AutoConfig.py#L609 + buffers_total = int(buffers_total * 2.5) + + # Enforce minimum required by VPP (16K buffers) + return max(buffers_total, MIN_BUFFERS) diff --git a/python/vyos/vpp/config_verify.py b/python/vyos/vpp/config_verify.py index cf0b923bb..71cf97423 100644 --- a/python/vyos/vpp/config_verify.py +++ b/python/vyos/vpp/config_verify.py @@ -317,7 +317,7 @@ def verify_vpp_cpu_main_core(cpu_settings: dict) -> None: ) -def verify_vpp_settings_cpu_workers(cpu_settings: dict) -> int: +def verify_vpp_settings_cpu_workers(cpu_settings: dict): """ Verify that the system has enough available CPU cores to run a given amount of worker processes (1 worker/core) @@ -331,10 +331,8 @@ def verify_vpp_settings_cpu_workers(cpu_settings: dict) -> int: f'(reduce to {available_cores} or less)' ) - return workers - -def verify_vpp_settings_cpu_corelist_workers(cpu_settings: dict) -> int: +def verify_vpp_settings_cpu_corelist_workers(cpu_settings: dict): """ Verify that the CPU cores provided to the config are free and can be used by VPP """ @@ -366,8 +364,6 @@ def verify_vpp_settings_cpu_corelist_workers(cpu_settings: dict) -> int: if len(all_core_nums) > cpu_checks.available_cores_count(cpu_settings): raise ConfigError(f'{error_msg}: Not enough free CPUs in the system.') - return len(all_core_nums) - def verify_vpp_nat44_workers(workers: int, nat44_workers: list): if workers < 1: @@ -442,3 +438,15 @@ def verify_routes_count(settings: dict, workers: int): 'Extensive use of features like ACLs, NAT and others may reduce the numbers above. ' 'Please read the documentation for details: https://docs.vyos.io/' ) + + +def verify_vpp_buffers(settings: dict, workers: int): + buffers_configured = int(settings['buffers']['buffers_per_numa']) + + buffers_required = mem_checks.buffers_required(settings, workers) + + if buffers_required > buffers_configured: + raise ConfigError( + 'Not enough buffers to initialize RX/TX queues for interfaces. ' + f'Set "vpp settings buffers buffers-per-numa" to {buffers_required} or higher' + ) diff --git a/src/conf_mode/vpp.py b/src/conf_mode/vpp.py index 9517f85f3..518860605 100755 --- a/src/conf_mode/vpp.py +++ b/src/conf_mode/vpp.py @@ -58,7 +58,9 @@ from vyos.vpp.config_verify import ( verify_vpp_interfaces_dpdk_num_queues, verify_routes_count, verify_vpp_main_heap_size, + verify_vpp_buffers, ) +from vyos.vpp.config_resource_checks import memory from vyos.vpp.config_filter import iface_filter_eth from vyos.vpp.utils import EthtoolGDrvinfo from vyos.vpp.configdb import JSONStorage @@ -147,6 +149,28 @@ def _unload_module(module_name: str): raise +def _get_workers_count(cpu_settings: dict) -> int: + if 'corelist_workers' in cpu_settings: + corelist_workers = [] + for worker_range in cpu_settings['corelist_workers']: + core_numbers = worker_range.split('-') + corelist_workers.extend( + range(int(core_numbers[0]), int(core_numbers[-1]) + 1) + ) + + return len(corelist_workers) + + return int(cpu_settings.get('workers', 0)) + + +def _normalize_buffers(config: dict): + """Replace 'auto' buffers_per_numa with calculated value""" + if config['settings']['buffers']['buffers_per_numa'] == 'auto': + workers = _get_workers_count(config['settings'].get('cpu', {})) + buffers = memory.buffers_required(config['settings'], workers) + config['settings']['buffers']['buffers_per_numa'] = str(buffers) + + def get_config(config=None): # use persistent config to store interfaces data between executions # this is required because some interfaces after they are connected @@ -223,10 +247,12 @@ def get_config(config=None): # dictionary retrieved. default_values = conf.get_config_defaults(**config.kwargs, recursive=True) - # delete 'xdp-options' from defaults if driver is DPDK + # delete driver-incompatible defaults for iface, iface_config in config.get('settings', {}).get('interface', {}).items(): if iface_config.get('driver') == 'dpdk': del default_values['settings']['interface'][iface]['xdp_options'] + elif iface_config.get('driver') == 'xdp': + del default_values['settings']['interface'][iface]['dpdk_options'] config = config_dict_merge(default_values, config) @@ -239,9 +265,10 @@ def get_config(config=None): default_values_effective = conf.get_config_defaults( **effective_config.kwargs, recursive=True ) - config['effective'] = config_dict_merge( - default_values_effective, effective_config - ) + effective_config = config_dict_merge(default_values_effective, effective_config) + # Buffer normalization (auto → computed) + _normalize_buffers(effective_config) + config['effective'] = effective_config if 'settings' in config: if 'interface' in config['settings']: @@ -314,6 +341,9 @@ def get_config(config=None): xdp_api_params['flags'] = 'no_syscall_lock' iface_config['xdp_api_params'] = xdp_api_params + # Buffer normalization (auto → computed) + _normalize_buffers(config) + if removed_ifaces: config['removed_ifaces'] = removed_ifaces config['xconn_members'] = xconn_members @@ -342,15 +372,6 @@ def get_config(config=None): eth_ifaces_persist[iface]['bus_id'] = control_host.get_bus_name(iface) eth_ifaces_persist[iface]['dev_id'] = control_host.get_dev_id(iface) - # Get kernel settings for hugepages - kernel_memory_settings = conf.get_config_dict( - ['system', 'option', 'kernel', 'memory'], - key_mangling=('-', '_'), - get_first_key=True, - no_tag_node_value_mangle=True, - ) - config['kernel_memory_settings'] = kernel_memory_settings - # Return to config dictionary config['persist_config'] = eth_ifaces_persist @@ -379,8 +400,6 @@ def verify(config): raise ConfigError(f'Interface {iface} does not exist or is not Ethernet!') # Resource usage checks - workers = 0 - if 'cpu' in config['settings']: cpu_settings = config['settings']['cpu'] @@ -394,14 +413,16 @@ def verify(config): # Check if there are enough CPU cores to add workers if 'workers' in cpu_settings: - workers = verify_vpp_settings_cpu_workers(cpu_settings) + verify_vpp_settings_cpu_workers(cpu_settings) if 'main_core' in cpu_settings: verify_vpp_cpu_main_core(cpu_settings) # Check the CPU main core not falling to the corelist-workers if 'corelist_workers' in cpu_settings: - workers = verify_vpp_settings_cpu_corelist_workers(cpu_settings) + verify_vpp_settings_cpu_corelist_workers(cpu_settings) + + workers = _get_workers_count(config['settings'].get('cpu', {})) if 'workers' in config['settings']['nat44']: verify_vpp_nat44_workers( @@ -411,6 +432,9 @@ def verify(config): verify_vpp_main_heap_size(config['settings']) verify_vpp_statseg_size(config['settings']) + # Check buffers + verify_vpp_buffers(config['settings'], workers) + # Check if available memory is enough for current VPP config verify_vpp_memory(config) |
