issue: 4633470 fix generate_docs.py +update README

Fix bug in generate_docs.py where non-dict properties caused processing
failures. Add proper type checking and error handling to prevent crashes
when encountering unexpected property types in the JSON schema.

Changes in generate_docs.py:
- Add type check to skip non-dict properties
- Wrap property processing in try-catch block
- Add error reporting with property path context

Regenerate README documentation with the fixed script:
- Document memory size suffix support (B, KB, MB, GB) for memory params
- Add missing threading behavior options (with_wakeup/no_wakeup)
- Simplify worker threads documentation for better clarity
- Fix inconsistent default value formatting

This ensures robust documentation generation and provides users with
complete information about memory size formatting and threading options.

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

Author: tomerdbz

README

@@ -238,11 +238,11 @@ Avoid expensive extra checks to reduce the initialization time. Maps to **XLIO_Q
 Default value is 0 (Disabled)
 
 core.resources.external_memory_limit
-Memory limit for external user allocator. Maps to **XLIO_MEMORY_LIMIT_USER** environment variable. The user allocator can optionally be provided with XLIO extra API. Default value 0 makes XLIO use the core.resources.memory_limit value for user allocations.
+Memory limit for external user allocator. Maps to **XLIO_MEMORY_LIMIT_USER** environment variable. The user allocator can optionally be provided with XLIO extra API. Default value 0 makes XLIO use the core.resources.memory_limit value for user allocations. Supports suffixes: B, KB, MB, GB.
 Default value is 0
 
 core.resources.heap_metadata_block_size
-Size of metadata block added to every heap allocation. Maps to **XLIO_HEAP_METADATA_BLOCK** environment variable.
+Size of metadata block added to every heap allocation. Maps to **XLIO_HEAP_METADATA_BLOCK** environment variable. Supports suffixes: B, KB, MB, GB.
 Default value is 32 MB
 
 core.resources.hugepages.enable
@@ -254,7 +254,7 @@ Force specific hugepage size for XLIO internal memory allocations. Value 0 allow
 Default value is 0
 
 core.resources.memory_limit
-Pre-allocated memory limit for buffers. Maps to **XLIO_MEMORY_LIMIT** environment variable. Note that the limit does not include dynamic memory allocation and XLIO memory consumption can exceed the limit. A value of 0 means unlimited memory allocation.
+Pre-allocated memory limit for buffers. Maps to **XLIO_MEMORY_LIMIT** environment variable. Note that the limit does not include dynamic memory allocation and XLIO memory consumption can exceed the limit. A value of 0 means unlimited memory allocation. Supports suffixes: B, KB, MB, GB.
 Default value is 2048 MB
 
 core.signals.sigint.exit
@@ -289,7 +289,7 @@ Control whether XLIO should support fork. Maps to **XLIO_FORK** environment vari
 Default value is 1 (Enabled)
 
 core.syscall.sendfile_cache_limit
-Memory limit for the mapping cache which is used by sendfile(). Maps to **XLIO_ZC_CACHE_THRESHOLD** environment variable.
+Memory limit for the mapping cache which is used by sendfile(). Maps to **XLIO_ZC_CACHE_THRESHOLD** environment variable. Supports suffixes: B, KB, MB, GB.
 Default value is 10240 MB
 
 
@@ -830,7 +830,9 @@ performance.threading.internal_handler.behavior
 Select which TCP control flows are done in the internal thread. Maps to **XLIO_TCP_CTL_THREAD** environment variable. This feature should be kept disabled if using blocking poll/select (epoll is OK).
 Use value of 'disable'/0 to disable.
 Use value of 'delegate'/1 to handle TCP timers in application context threads. In this mode the socket must be handled by the same thread from the time of its creation to the time of its destruction. Otherwise, it may lead to an unexpected behaviour.
-Default value is disabled
+Use value of 'with_wakeup'/2 for waking up the thread when there is work to do.
+Use value of 'no_wakeup'/3 for waiting for thread timer to expire.
+Default value is 0
 
 performance.threading.internal_handler.timer_msec
 Control XLIO internal thread wakeup timer resolution (in milliseconds). Maps to **XLIO_TIMER_RESOLUTION_MSEC** environment variable.
@@ -844,17 +846,9 @@ Default: 0 (Spin)
 Default value is 0 (Disabled)
 
 performance.threading.worker_threads
-Controls which mode is used to handle networking and progress sockets.
-Applicable only to POSIX API.
-There are two available modes: Run to completion mode and Worker Threads mode. 
-Run to completion mode:
-Only application execution contexts progress networking as part of socket related syscalls.
-In this mode, XLIO depends on the application to provide execution context to XLIO.
-Worker Threads Mode:
-XLIO spawns worker threads. Worker threads progress networking without dependency on the application to provide execution context to XLIO.
-0 - Run to completion mode
-Number greater than 0 - Worker Threads mode with number of XLIO worker threads specified by the value.
-Default: 0
+Controls which execution model and number of worker threads to be used to handle networking and progress sockets.
+Default value is 0
+
 
 ================================================================================
 

generate_docs.py

@@ -115,13 +115,20 @@ def _process_properties(
             # Skip if we've already processed this property
             if current_path in self.processed_props:
                 continue
-            
+
+            if not isinstance(prop_data, dict):
+                continue
+
             self.processed_props.add(current_path)
-            
+
             # Extract property information
-            description = prop_data.get("description", "")
-            default = prop_data.get("default", None)
-            env_var = ConfigPropertyParser.extract_env_var(description)
+            try:
+                description = prop_data.get("description", "")
+                default = prop_data.get("default", None)
+                env_var = ConfigPropertyParser.extract_env_var(description)
+            except Exception as e:
+                print(f"Error processing property {current_path}: {e}")
+                sys.exit(1)
 
             # If this is an object with properties, process its children
             if prop_data.get("type") == "object":

src/core/config/descriptor_providers/xlio_config_schema.json

@@ -918,7 +918,7 @@
                                         }
                                     ],
                                     "title": "TCP control flow behavior",
-                                    "description": "Select which TCP control flows are done in the internal thread. Maps to XLIO_TCP_CTL_THREAD environment variable. This feature should be kept disabled if using blocking poll/select (epoll is OK).\nUse value of 'disable'/0 to disable.\nUse value of 'delegate'/1 to handle TCP timers in application context threads. In this mode the socket must be handled by the same thread from the time of its creation to the time of its destruction. Otherwise, it may lead to an unexpected behaviour.\nUse value of 'with_wakeup'/2 for waking up the thread when there is work to do.\nUse value of 'no_wakeup'/3 for waiting for thread timer to expire.\nDefault value is disabled"
+                                    "description": "Select which TCP control flows are done in the internal thread. Maps to XLIO_TCP_CTL_THREAD environment variable. This feature should be kept disabled if using blocking poll/select (epoll is OK).\nUse value of 'disable'/0 to disable.\nUse value of 'delegate'/1 to handle TCP timers in application context threads. In this mode the socket must be handled by the same thread from the time of its creation to the time of its destruction. Otherwise, it may lead to an unexpected behaviour.\nUse value of 'with_wakeup'/2 for waking up the thread when there is work to do.\nUse value of 'no_wakeup'/3 for waiting for thread timer to expire."
                                 }
                             },
                             "additionalProperties": false