issue: 4207451 Improve config parameter naming

This patch restructures the XLIO configuration system for organization:

1. Rename 'observability' namespace to 'monitor'
2. Reorganize parameter paths:
   - Move WRE counts from buffers to rings section
   - Rename 'select' polling to 'iomux' to better reflect its purpose
   - Group related parameters more logically
3. Flatten completion queue interrupt moderation params
4. Improve parameter naming for clarity:
   - sendfile_limit → sendfile_cache_limit
   - dup2_support → dup2_close_fd
   - rx_duration_usec → blocking_rx_poll_usec
   - ts_conversion → hw_ts_conversion
5. Move profiles.spec to top-level namespace

All related code, mappings, and documentation are updated.

Signed-off-by: Tomer Cabouly <[email protected]>

Author: tomerdbz

README

@@ -39,7 +39,7 @@ The schema organizes configuration into the following main sections:
 3. **hardware**: Hardware-specific configurations and offloads
 4. **performance**: Settings that affect XLIO performance characteristics
 5. **applications**: Configurations and optimizations for specific applications
-6. **observability**: Settings for logging, statistics, and monitoring
+6. **monitor**: Settings for logging, statistics, and monitoring
 
 ## Configuration Methods
 
@@ -55,7 +55,7 @@ Multiple configuration values can be set in a single environment variable using
 
 ```bash
 # Set multiple configuration values in one line
-export XLIO_INLINE_CONFIG="core.resources.memory_limit=4294967296, observability.log.file_path=/tmp/xlio.log, network.protocols.tcp.nodelay.enable=true"
+export XLIO_INLINE_CONFIG="core.resources.memory_limit=4294967296, monitor.log.file_path=/tmp/xlio.log, network.protocols.tcp.nodelay.enable=true"
 ```
 
 The syntax supports comma-separated key-value pairs where each key uses the dot notation of the configuration hierarchy.
@@ -119,7 +119,7 @@ export XLIO_USE_NEW_CONFIG=1
 The new configuration system maintains compatibility with legacy environment variables through a mapping system. Each configuration parameter in the new system can be associated with a legacy environment variable. This mapping is defined in `src/core/config/mappings.py`.
 
 For example:
-- `observability.log.level` maps to `XLIO_TRACELEVEL`
+- `monitor.log.level` maps to `XLIO_TRACELEVEL`
 - `network.protocols.ip.mtu` maps to `XLIO_MTU`
 - `performance.threading.cpu_affinity` maps to `XLIO_INTERNAL_THREAD_AFFINITY`
 
@@ -133,7 +133,7 @@ network.protocols.tcp.nodelay.enable
 performance.rings.tx.alloc_logic
 performance.buffers.tx.global_array_size
 applications.nginx.distribute_cq
-observability.stats.shmem_dir
+monitor.stats.shmem_dir
 ```
 
 ## Dependencies
@@ -157,7 +157,7 @@ bool enable_hugepages = config->get_value<bool>("core.resources.hugepages.enable
 int64_t memory_limit = config->get_value<int64_t>("core.resources.memory_limit");
 
 // Get a string value
-std::string log_file = config->get_value<std::string>("observability.log.file_path");
+std::string log_file = config->get_value<std::string>("monitor.log.file_path");
 ```
 
 ## Migration Guide

src/core/config/README.md

@@ -20,10 +20,10 @@
     "core.syscall.allow_privileged_sockopt": "XLIO_ALLOW_PRIVILEGED_SOCK_OPT",
     "core.syscall.avoid_ctl_syscalls": "XLIO_AVOID_SYS_CALLS_ON_TCP_FD",
     "core.syscall.deferred_close": "XLIO_DEFERRED_CLOSE",
-    "core.syscall.dup2_support": "XLIO_CLOSE_ON_DUP2",
+    "core.syscall.dup2_close_fd": "XLIO_CLOSE_ON_DUP2",
     "core.syscall.fork_support": "XLIO_FORK",
     "core.syscall.getsockname_dummy_send": "XLIO_TRIGGER_DUMMY_SEND_GETSOCKNAME",
-    "core.syscall.sendfile_limit": "XLIO_ZC_CACHE_THRESHOLD",
+    "core.syscall.sendfile_cache_limit": "XLIO_ZC_CACHE_THRESHOLD",
 
     # network section
     "network.multicast.mc_disable_flowtag": "XLIO_DISABLE_FLOW_TAG",
@@ -46,8 +46,8 @@
     "network.protocols.tcp.timer_msec": "XLIO_TCP_TIMER_RESOLUTION_MSEC",
     "network.protocols.tcp.timestamps": "XLIO_TCP_TIMESTAMP_OPTION",
     "network.protocols.tcp.wmem": "XLIO_TCP_SEND_BUFFER_SIZE",
-    "network.protocols.udp.batch_size": "TX_BUFS_BATCH_UDP",
-    "network.timing.ts_conversion": "XLIO_HW_TS_CONVERSION",
+    "network.protocols.udp.buffer_batch": "TX_BUFS_BATCH_UDP",
+    "network.timing.hw_ts_conversion": "XLIO_HW_TS_CONVERSION",
 
     # hardware_features section
     "hardware_features.striding_rq.enable": "XLIO_STRQ",
@@ -73,55 +73,55 @@
     "performance.buffers.tcp_segments.socket_batch_size": "XLIO_TX_SEGS_BATCH_TCP",
     "performance.buffers.tx.buf_size": "XLIO_TX_BUF_SIZE",
     "performance.buffers.tx.global_array_size": "XLIO_TX_BUFS",
-    "performance.buffers.tx.nonblocking_eagain": "XLIO_TX_NONBLOCKED_EAGAINS",
     "performance.buffers.tx.prefetch_size": "XLIO_TX_PREFETCH_BYTES",
-    "performance.buffers.tx.tcp_batch_size": "XLIO_TX_BUFS_BATCH_TCP",
-    "performance.buffers.work_request_elements.rx_batch_size": "XLIO_RX_WRE_BATCHING",
-    "performance.buffers.work_request_elements.rx_global_array_size": "XLIO_RX_WRE",
+    "performance.buffers.tx.tcp_buffer_batch": "XLIO_TX_BUFS_BATCH_TCP",
+    "performance.buffers.work_request_elements.rx_post_batch_size": "XLIO_RX_WRE_BATCHING",
     "performance.buffers.work_request_elements.tx_completion_batch_size": "XLIO_TX_WRE_BATCHING",
-    "performance.buffers.work_request_elements.tx_global_array_size": "XLIO_TX_WRE",
     "performance.buffers.work_request_elements.tx_max_inline_size": "XLIO_TX_MAX_INLINE",
-    "performance.completion_queue.interrupt_moderation.interrupt_per_packet": "XLIO_INTERNAL_THREAD_ARM_CQ",
-    "performance.completion_queue.interrupt_moderation.manual_moderation.adaptive_change_frequency_msec": "XLIO_CQ_AIM_INTERVAL_MSEC",
-    "performance.completion_queue.interrupt_moderation.manual_moderation.adaptive_count": "XLIO_CQ_AIM_MAX_COUNT",
-    "performance.completion_queue.interrupt_moderation.manual_moderation.adaptive_period_usec": "XLIO_CQ_AIM_MAX_PERIOD_USEC",
-    "performance.completion_queue.interrupt_moderation.manual_moderation.enable": "XLIO_CQ_MODERATION_ENABLE",
-    "performance.completion_queue.interrupt_moderation.manual_moderation.interrupt_per_sec": "XLIO_CQ_AIM_INTERRUPTS_RATE_PER_SEC",
-    "performance.completion_queue.interrupt_moderation.manual_moderation.packet_count": "XLIO_CQ_MODERATION_COUNT",
-    "performance.completion_queue.interrupt_moderation.manual_moderation.period_usec": "XLIO_CQ_MODERATION_PERIOD_USEC",
+    "performance.completion_queue.interrupt_moderation.adaptive_change_frequency_msec": "XLIO_CQ_AIM_INTERVAL_MSEC",
+    "performance.completion_queue.interrupt_moderation.adaptive_count": "XLIO_CQ_AIM_MAX_COUNT",
+    "performance.completion_queue.interrupt_moderation.adaptive_interrupt_per_sec": "XLIO_CQ_AIM_INTERRUPTS_RATE_PER_SEC",
+    "performance.completion_queue.interrupt_moderation.adaptive_period_usec": "XLIO_CQ_AIM_MAX_PERIOD_USEC",
+    "performance.completion_queue.interrupt_moderation.enable": "XLIO_CQ_MODERATION_ENABLE",
+    "performance.completion_queue.interrupt_moderation.packet_count": "XLIO_CQ_MODERATION_COUNT",
+    "performance.completion_queue.interrupt_moderation.period_usec": "XLIO_CQ_MODERATION_PERIOD_USEC",
     "performance.completion_queue.keep_full": "XLIO_CQ_KEEP_QP_FULL",
     "performance.completion_queue.periodic_drain_max_cqes": "XLIO_PROGRESS_ENGINE_WCE_MAX",
     "performance.completion_queue.periodic_drain_msec": "XLIO_PROGRESS_ENGINE_INTERVAL",
     "performance.completion_queue.rx_drain_rate_nsec": "XLIO_RX_CQ_DRAIN_RATE_NSEC",
     "performance.completion_queue.rx_spare_buffers": "XLIO_QP_COMPENSATION_LEVEL",
     "performance.max_gro_streams": "XLIO_GRO_STREAMS_MAX",
+    "performance.polling.blocking_rx_poll_usec": "XLIO_RX_POLL",
+    "performance.polling.iomux.poll_os_force": "XLIO_SELECT_POLL_OS_FORCE",
+    "performance.polling.iomux.poll_os_ratio": "XLIO_SELECT_POLL_OS_RATIO",
+    "performance.polling.iomux.poll_usec": "XLIO_SELECT_POLL",
+    "performance.polling.iomux.skip_os": "XLIO_SELECT_SKIP_OS",
     "performance.polling.kernel_fd_attention_level": "XLIO_RING_KERNEL_FD_ATTENTION_LEVEL",
+    "performance.polling.max_rx_poll_batch": "XLIO_CQ_POLL_BATCH_MAX",
+    "performance.polling.nonblocking_eagain": "XLIO_TX_NONBLOCKED_EAGAINS",
     "performance.polling.offload_transition_poll_count": "XLIO_RX_POLL_INIT",
-    "performance.polling.rx_buffer_max_count": "XLIO_CQ_POLL_BATCH_MAX",
     "performance.polling.rx_cq_wait_ctrl": "XLIO_RX_CQ_WAIT_CTRL",
-    "performance.polling.rx_duration_usec": "XLIO_RX_POLL",
     "performance.polling.rx_kernel_fd_attention_level": "XLIO_RX_UDP_POLL_OS_RATIO",
-    "performance.polling.rx_poll_on_tx": "XLIO_RX_POLL_ON_TX_TCP",
-    "performance.polling.select.poll_os_force": "XLIO_SELECT_POLL_OS_FORCE",
-    "performance.polling.select.poll_os_ratio": "XLIO_SELECT_POLL_OS_RATIO",
-    "performance.polling.select.poll_usec": "XLIO_SELECT_POLL",
-    "performance.polling.select.skip_os": "XLIO_SELECT_SKIP_OS",
+    "performance.polling.rx_poll_on_tx_tcp": "XLIO_RX_POLL_ON_TX_TCP",
     "performance.polling.skip_cq_on_rx": "XLIO_SKIP_POLL_IN_RX",
     "performance.polling.yield_on_poll": "XLIO_RX_POLL_YIELD",
     "performance.rings.max_per_interface": "XLIO_RING_LIMIT_PER_INTERFACE",
     "performance.rings.rx.allocation_logic": "XLIO_RING_ALLOCATION_LOGIC_RX",
     "performance.rings.rx.migration_ratio": "XLIO_RING_MIGRATION_RATIO_RX",
+    "performance.rings.rx.ring_elements_count": "XLIO_RX_WRE",
     "performance.rings.tx.allocation_logic": "XLIO_RING_ALLOCATION_LOGIC_TX",
     "performance.rings.tx.max_on_device_memory": "XLIO_RING_DEV_MEM_TX",
     "performance.rings.tx.migration_ratio": "XLIO_RING_MIGRATION_RATIO_TX",
+    "performance.rings.tx.ring_elements_count": "XLIO_TX_WRE",
     "performance.steering_rules.tcp.2t_rules": "XLIO_TCP_2T_RULES",
     "performance.steering_rules.tcp.3t_rules": "XLIO_TCP_3T_RULES",
     "performance.steering_rules.udp.3t_rules": "XLIO_UDP_3T_RULES",
     "performance.steering_rules.udp.only_mc_l2_rules": "XLIO_ETH_MC_L2_ONLY_RULES",
     "performance.threading.cpu_affinity": "XLIO_INTERNAL_THREAD_AFFINITY",
     "performance.threading.cpuset": "XLIO_INTERNAL_THREAD_CPUSET",
-    "performance.threading.handlers.behavior": "XLIO_TCP_CTL_THREAD",
-    "performance.threading.handlers.timer_msec": "XLIO_TIMER_RESOLUTION_MSEC",
+    "performance.threading.internal_handler.behavior": "XLIO_TCP_CTL_THREAD",
+    "performance.threading.internal_handler.timer_msec": "XLIO_TIMER_RESOLUTION_MSEC",
+    "performance.threading.internal_handler.wakeup_per_packet": "XLIO_INTERNAL_THREAD_ARM_CQ",
     "performance.threading.mutex_over_spinlock": "XLIO_MULTILOCK",
 
     # applications section
@@ -130,26 +130,28 @@
     "applications.nginx.udp_pool_size": "XLIO_NGINX_UDP_POOL_SIZE",
     "applications.nginx.udp_socket_pool_reuse": "XLIO_NGINX_UDP_POOL_RX_NUM_BUFFS_REUSE",
     "applications.nginx.workers_num": "XLIO_NGINX_WORKERS_NUM",
-    "applications.profiles.spec": "XLIO_SPEC",
 
     # acceleration_control section
     "acceleration_control.app_id": "XLIO_APPLICATION_ID",
     "acceleration_control.default_acceleration": "XLIO_OFFLOADED_SOCKETS",
 
-    # observability section
-    "observability.exit_report": "XLIO_PRINT_REPORT",
-    "observability.log.colors": "XLIO_LOG_COLORS",
-    "observability.log.details": "XLIO_LOG_DETAILS",
-    "observability.log.file_path": "XLIO_LOG_FILE",
-    "observability.log.level": "XLIO_TRACELEVEL",
-    "observability.stats.cpu_usage": "XLIO_CPU_USAGE_STATS",
-    "observability.stats.fd_num": "XLIO_STATS_FD_NUM",
-    "observability.stats.file_path": "XLIO_STATS_FILE",
-    "observability.stats.shmem_dir": "XLIO_STATS_SHMEM_DIR",
+    # monitor section
+    "monitor.exit_report": "XLIO_PRINT_REPORT",
+    "monitor.log.colors": "XLIO_LOG_COLORS",
+    "monitor.log.details": "XLIO_LOG_DETAILS",
+    "monitor.log.file_path": "XLIO_LOG_FILE",
+    "monitor.log.level": "XLIO_TRACELEVEL",
+    "monitor.stats.cpu_usage": "XLIO_CPU_USAGE_STATS",
+    "monitor.stats.fd_num": "XLIO_STATS_FD_NUM",
+    "monitor.stats.file_path": "XLIO_STATS_FILE",
+    "monitor.stats.shmem_dir": "XLIO_STATS_SHMEM_DIR",
 
     # extra_api section
     "extra_api.hugepage_size": "XLIO_USER_HUGE_PAGE_SIZE",
     "extra_api.socketextreme": "XLIO_SOCKETEXTREME",
+    
+    # profiles section
+    "profiles.spec": "XLIO_SPEC",
 
 }