{"id":9743,"date":"2022-06-21T13:53:06","date_gmt":"2022-06-21T13:53:06","guid":{"rendered":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/documentation\/rdk_broadband_documentation\/components\/utopia\/"},"modified":"2026-02-17T10:07:09","modified_gmt":"2026-02-17T10:07:09","slug":"utopia","status":"publish","type":"page","link":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/utopia\/","title":{"rendered":"Utopia"},"content":{"rendered":"\n<p>Utopia serves as the foundational system infrastructure component for RDK-B middleware, providing comprehensive system initialization, configuration management, event bus services, and network service orchestration. This component acts as the backbone that enables inter-process communication, persistent configuration storage, and coordinated startup\/shutdown sequences across all RDK-B middleware components.<\/p>\n\n\n\n<p>Utopia provides three critical service layers to the RDK-B stack:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>System Infrastructure Services<\/strong>\u00a0that handle system initialization, configuration persistence (syscfg), and inter-component messaging (sysevent);<\/li>\n\n\n\n<li><strong>Network Service Management<\/strong>\u00a0that orchestrates networking services including DHCP, firewall, routing, and WAN connectivity; and<\/li>\n\n\n\n<li><strong>API Layer Services<\/strong>\u00a0that expose standardized interfaces (UTAPI) for configuration management and system control to other RDK-B components and external management systems.<\/li>\n<\/ul>\n\n\n\n<p>The component integrates deeply with the Linux system layer through direct HAL interactions, manages persistent data through filesystem-based storage mechanisms, and coordinates with other RDK-B components via RBus messaging protocol. Utopia&#8217;s modular architecture supports platform-specific customizations while maintaining consistent service interfaces across different RDK-B device implementations.<\/p>\n\n\n\n<div class=\"wp-block-merpress-mermaidjs diagram-source-mermaid\"><pre class=\"mermaid\">graph LR\n\n    subgraph \"External Systems\"\n        RemoteMgmt[\"Remote Management\"]\n        LocalUI[\"Local Web UI\"]\n    end\n\n    \n    subgraph \"RDK-B Platform\"\n        subgraph \"Remote Management Agents\"\n            ProtocolAgents[\"Protocol Agents&lt;br>( TR-069, WebPA, USP etc.)\"]\n        end\n        rdkbComponent[\"Other RDK-B Components\"]\n        subgraph \"Utopia\"\n            subgraph \"Utopia Core Services\"\n                SysEvent[SysEvent Bus]\n                SysCfg[SysCfg Storage] \n                ServiceMgr[Service Manager]\n                UtAPI[UTAPI Library]\n            end\n    \n            subgraph \"Utopia Network Services\"\n                DHCP[DHCP Service]\n                Firewall[Firewall Service]\n                Routing[Routing Service]\n                MultiNet[Multi-Network Service]\n                WAN[WAN Service]\n                IPv6[IPv6 Service]\n                IGD[UPnP IGD]\n            end\n        end\n        subgraph \"Platform Layer\"\n            HAL[\"Platform HAL\"]\n            Linux[\"Linux\"]\n            NetFilter[NetFilter\/IPTables]\n        end\n    end\n\n    RemoteMgmt --> ProtocolAgents\n    LocalUI --> UtAPI\n    ProtocolAgents --> SysEvent\n    rdkbComponent --> SysCfg\n    \n    UtAPI --> SysCfg\n    UtAPI --> SysEvent\n    ServiceMgr --> SysEvent\n    \n    SysEvent --> DHCP\n    SysEvent --> Firewall\n    SysEvent --> Routing\n    SysEvent --> MultiNet\n    SysEvent --> WAN\n    SysEvent --> IPv6\n    SysEvent --> IDG\n    \n    SysCfg --> DHCP\n    SysCfg --> Firewall\n    SysCfg --> WAN\n    \n    Routing --> Linux\n    Firewall --> NetFilter\n    DHCP --> HAL\n    WAN --> HAL\n    HAL --> Linux\n\n    classDef external fill:#fff3e0,stroke:#ef6c00,stroke-width:2px;\n    classDef utopia fill:#e3f2fd,stroke:#1976d2,stroke-width:3px;\n    classDef rdkbComponent fill:#e8f5e8,stroke:#2e7d32,stroke-width:2px;\n    classDef system fill:#fce4ec,stroke:#c2185b,stroke-width:2px;\n\n    class RemoteMgmt,LocalUI external;\n    class SysEvent,SysCfg,ServiceMgr,UtAPI,DHCP,Firewall,Routing,MultiNet,WAN,IPv6,IGD utopia;\n    class ProtocolAgents,rdkbComponent, rdkbComponent;\n    class HAL,Linux,NetFilter system;<\/pre><\/div>\n\n\n\n<p><strong>Key Features &amp; Responsibilities<\/strong>:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>System Infrastructure Management<\/strong>: Provides core system initialization services including process startup coordination, dependency management, and system-wide configuration bootstrapping essential for RDK-B middleware operation<\/li>\n\n\n\n<li><strong>Configuration Persistence (syscfg)<\/strong>: Implements a high-performance shared memory-based configuration database with filesystem backing that enables atomic configuration updates and fast parameter retrieval across all system components<\/li>\n\n\n\n<li><strong>Inter-Process Event Bus (sysevent)<\/strong>: Operates a publish-subscribe event messaging system using Unix domain sockets that facilitates real-time communication and state synchronization between RDK-B middleware components<\/li>\n\n\n\n<li><strong>Network Service Orchestration<\/strong>: Manages and coordinates networking services including DHCP server\/client operations, firewall rule management, routing table updates, and WAN interface configuration through integrated service handlers<\/li>\n\n\n\n<li><strong>Unified API Layer (UTAPI)<\/strong>: Exposes standardized C APIs and command-line interfaces for system configuration, network management, and status monitoring that abstract platform-specific implementations from higher-level components<\/li>\n\n\n\n<li><strong>Multi-Network Management<\/strong>: Provides advanced networking capabilities including VLAN management, bridge configuration, multi-WAN support, and service-specific network isolation through the service_multinet framework<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"design\"><a href=\"https:\/\/wiki.rdkcentral.com\/spaces\/RDK\/pages\/460988741\/Utopia#design\">Design<\/a><\/h2>\n\n\n\n<p>Utopia&#8217;s architectural design follows a layered service-oriented approach that separates system infrastructure from application-specific networking logic. The core design principle centers around three foundational services: syscfg for configuration persistence, sysevent for inter-process communication, and UTAPI for external interface abstraction. These services operate as independent but coordinated daemons that provide reliable, high-performance infrastructure for the entire RDK-B middleware stack.<\/p>\n\n\n\n<p>The design emphasizes scalability and maintainability through modular service decomposition, where each networking function (DHCP, firewall, routing) operates as an independent service process that communicates through standardized IPC mechanisms. Configuration changes propagate through the sysevent bus, triggering coordinated updates across dependent services without requiring direct inter-service dependencies. The shared memory-based syscfg implementation ensures configuration consistency while providing sub-millisecond access times critical for real-time networking operations.<\/p>\n\n\n\n<p>Integration with external systems occurs through well-defined interface boundaries: northbound interactions with CCSP components use RBus messaging protcol, while southbound interactions with HAL and kernel services use direct API calls and system interfaces. The UTAPI layer provides configuration abstraction that enables platform-specific implementations while maintaining API compatibility across different hardware platforms. Event-driven service activation ensures efficient resource utilization and rapid response to network state changes.<\/p>\n\n\n\n<p>Data persistence operates through a hybrid approach combining in-memory performance with filesystem reliability, where syscfg maintains active configuration in shared memory while asynchronously committing changes to persistent storage. The sysevent system supports both persistent and transient event states, enabling appropriate handling of both configuration changes and runtime status updates. Service startup orchestration follows dependency chains defined through sysevent triggers, ensuring proper initialization ordering without hard-coded dependencies.<\/p>\n\n\n\n<div class=\"wp-block-merpress-mermaidjs diagram-source-mermaid\"><pre class=\"mermaid\">%%{init:{\n  \"themeVariables\": { \"fontSize\": \"60px\", \"lineHeight\": 1.7 }, {\"flowchart\": {\"curve\": \"basis\", \"rankSpacing\": 50, \"nodeSpacing\": 40}}}%%\nflowchart LR\n\n    subgraph UtopiaCore[\"Utopia Core\"]\n        %% --- UTAPI Layer ---\n        subgraph UTAPI_Layer[\"UTAPI Layer\"]\n            direction TB\n            UTAPI[UTAPI Library]\n            UTCtx[UT Context Manager]\n        end\n\n        %% --- Core Infrastructure ---\n        subgraph Core_Infra[\"Core Infrastructure\"]\n            direction TB\n            SysCfg[SysCfg Service]\n            SysEvent[SysEvent Daemon]\n            SrvMgr[Service Manager]\n        end\n\n        %% --- Network Services ---\n        subgraph Net_Services[\"Network Services\"]\n            direction TB\n            DHCP[service_dhcp]\n            FW[Firewall Service]\n            WAN[service_wan]\n            MNet[service_multinet]\n            Route[service_routed]\n            IPv6[service_ipv6]\n            IGD[UPnP IGD]\n        end\n\n        %% --- Utility Services ---\n        subgraph Util_Services[\"Utility Services\"]\n            direction TB\n            DevMode[service_deviceMode]\n            DDNS[service_ddns]\n            DSLite[service_dslite]\n            UDHCPc[service_udhcpc]\n        end\n    end\n    %% --- Storage &amp; IPC ---\n    subgraph Storage_IPC[\"Storage &amp; IPC\"]\n        direction LR\n        SharedMem[(Shared Memory)]\n        EventBus[(Event Bus)]\n        ConfigFiles[(Config Files)]\n    end\n\n    %% --- Main Flows ---\n    UTAPI --> UTCtx\n    UTCtx --> SysCfg\n    UTCtx --> SysEvent\n    SrvMgr --> SysEvent\n\n    SysCfg --> SharedMem\n    SysCfg --> ConfigFiles\n    SysEvent --> EventBus\n\n    %% --- Network Services Connections ---\n    Net_Services --> SysCfg\n    Net_Services --> SysEvent\n\n    %% --- Utility Services Connections ---\n    Util_Services --> SysEvent<\/pre><\/div>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"prerequisites-and-dependencies\"><a href=\"https:\/\/wiki.rdkcentral.com\/spaces\/RDK\/pages\/460988741\/Utopia#prerequisites-and-dependencies\">Prerequisites and Dependencies<\/a><\/h3>\n\n\n\n<p><strong>Build-Time Flags and Configuration:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><tbody><tr><td><code>--enable-dslite_feature_support<\/code><\/td><td><code>dslite<\/code><\/td><td><code>DSLITE_FEATURE_SUPPORT<\/code><\/td><td>Enable DS-Lite dual-stack lite tunneling support<\/td><td>Enabled<\/td><\/tr><tr><td><code>--enable-core_net_lib_feature_support<\/code><\/td><td><code>core-net-lib<\/code><\/td><td><code>CORE_NET_LIB_FEATURE_SUPPORT<\/code><\/td><td>Enable advanced core networking library support<\/td><td>Disabled<\/td><\/tr><tr><td><code>--enable-extender<\/code><\/td><td><code>extender<\/code><\/td><td><code>FEATURE_RDKB_EXTENDER<\/code><\/td><td>Enable WiFi extender\/mesh device support<\/td><td>Disabled<\/td><\/tr><tr><td><code>--enable-hotspot<\/code><\/td><td>N\/A<\/td><td><code>ENABLE_HOTSPOT_SERVICE<\/code><\/td><td>Enable HotSpot captive portal functionality<\/td><td>Enabled<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>RDK-B Platform and Integration Requirements:<\/strong><\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>RDK-B Components<\/strong>: CcspCommonLibrary, RBus messaging , persistent storage manager<\/li>\n\n\n\n<li><strong>HAL Dependencies<\/strong>: Network HAL interfaces (WiFi, Ethernet, MoCA, DOCSIS)<\/li>\n\n\n\n<li><strong>Systemd Services<\/strong>: Basic Linux systemd environment, Unix domain socket support, cron service integration<\/li>\n\n\n\n<li><strong>Message Bus<\/strong>: RBus infrastructure for enhanced IPC performance (optional, falls back to direct calls)<\/li>\n\n\n\n<li><strong>Configuration Files<\/strong>:\u00a0<code>\/etc\/utopia\/system_defaults<\/code>,\u00a0<code>\/nvram\/syscfg.db<\/code>,\u00a0<code>\/etc\/utopia\/service.d\/<\/code>\u00a0service scripts<\/li>\n\n\n\n<li><strong>Startup Order<\/strong>: Must initialize before CCSP components (PAM, PSM, TR-069 PA) that depend on configuration services<\/li>\n<\/ul>\n\n\n\n<p><strong>Threading Model:<\/strong><\/p>\n\n\n\n<p>Utopia employs a hybrid threading architecture that combines single-threaded event processing with multi-threaded I\/O operations to ensure data consistency while maintaining responsiveness. The core sysevent daemon operates as a single-threaded event loop that processes all IPC messages sequentially, preventing race conditions in event ordering and state management. Network service handlers typically run as separate single-threaded processes that respond to sysevent triggers, enabling isolated failure domains and simplified debugging.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Threading Architecture<\/strong>: Hybrid &#8211; Single-threaded for event processing, Multi-threaded for I\/O operations<\/li>\n\n\n\n<li><strong>Main Thread<\/strong>: Sysevent daemon main thread handles Unix domain socket connections, event routing, and client management using select()-based I\/O multiplexing<\/li>\n\n\n\n<li><strong>Main worker Threads<\/strong>:\n<ul class=\"wp-block-list\">\n<li><strong>I\/O Worker Threads<\/strong>: Handle file system operations for syscfg persistence, preventing blocking on main event processing thread<\/li>\n\n\n\n<li><strong>Network Service Threads<\/strong>: Separate processes for DHCP, firewall, and routing services, each with dedicated single-threaded event handlers<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li><strong>Synchronization<\/strong>: Shared memory access uses POSIX semaphores and memory barriers, sysevent uses Unix domain socket message queuing for thread-safe communication<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"component-state-flow\"><a href=\"https:\/\/wiki.rdkcentral.com\/spaces\/RDK\/pages\/460988741\/Utopia#component-state-flow\">Component State Flow<\/a><\/h3>\n\n\n\n<p><strong>Initialization to Active State<\/strong><\/p>\n\n\n\n<p>Utopia follows a carefully orchestrated multi-phase initialization sequence that establishes core infrastructure services before activating network-specific services. The initialization process ensures dependency satisfaction and proper resource allocation while providing failure recovery mechanisms at each phase.<\/p>\n\n\n\n<div class=\"wp-block-merpress-mermaidjs diagram-source-mermaid\"><pre class=\"mermaid\">%%{init: { \"config\": { \"useMaxWidth\": false } }}%%\nsequenceDiagram\n    autonumber\n    participant System\n    participant Syscfg\n    participant Sysevent  \n    participant UTAPI\n    participant Services\n    participant Monitor\n\n    System->>System: Start [*] \u2192 SystemInit\n    Note right of System: Load system defaults&lt;br>Initialize logging&lt;br>Create shared memory&lt;br>Set up IPC sockets\n\n    System->>Syscfg: Boot\/Service Start \u2192 SyscfgInit\n    Note right of Syscfg: Initialize shared memory&lt;br>Load persistent config&lt;br>Setup syscfg database\n\n    Syscfg->>Sysevent: Initialize Configuration Storage \u2192 SyseventInit\n    Note right of Sysevent: Create Unix domain socket&lt;br>Initialize event routing&lt;br>Setup trigger manager\n\n    Sysevent->>UTAPI: Start Event Bus \u2192 UtapiInit\n    UTAPI->>Services: Initialize API Layer \u2192 ServiceRegistration\n    Services->>System: Register Network Services \u2192 DependencyCheck\n\n    System->>System: Validate Dependencies \u2192 Active\n    Note right of System: Process events&lt;br>Handle configuration&lt;br>Monitor services&lt;br>Respond to requests\n\n    System->>System: Configuration Update \u2192 ConfigChange\n    System->>Services: Affected Service Restart \u2192 ServiceRestart\n    Services->>System: Service Synchronized \u2192 Active\n\n    System->>System: Interface State Change \u2192 NetworkEvent\n    System->>Monitor: Service Health Check Failed \u2192 FailureDetected\n    Monitor->>System: Restart Failed Service \u2192 ServiceRecovery\n    System->>System: Service Restored \u2192 Active\n\n    System->>System: Stop Request \u2192 Shutdown \u2192 [*]<\/pre><\/div>\n\n\n\n<p><strong>Runtime State Changes and Context Switching<\/strong><\/p>\n\n\n\n<p>Utopia dynamically adapts to runtime conditions through event-driven state transitions that handle network topology changes, service failures, and configuration updates. The system maintains consistency through atomic state transitions and rollback mechanisms.<\/p>\n\n\n\n<p><strong>State Change Triggers:<\/strong><\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Network interface up\/down events trigger service reconfiguration and routing table updates<\/li>\n\n\n\n<li>Configuration parameter changes propagate through sysevent bus causing coordinated service updates<\/li>\n\n\n\n<li>HAL device status changes trigger hardware-specific service adaptations<\/li>\n\n\n\n<li>External management requests (TR-069, WebUI) initiate controlled configuration transactions<\/li>\n<\/ul>\n\n\n\n<p><strong>Context Switching Scenarios:<\/strong><\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>WAN failover scenarios where primary connection failure triggers automatic secondary interface activation<\/li>\n\n\n\n<li>DHCP lease renewal cycles that may require firewall rule updates and routing changes<\/li>\n\n\n\n<li>IPv6 address assignment changes that trigger neighbor discovery and routing protocol updates<\/li>\n\n\n\n<li>Bridge\/VLAN reconfiguration events that require coordinated interface state management<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"call-flow\"><a href=\"https:\/\/wiki.rdkcentral.com\/spaces\/RDK\/pages\/460988741\/Utopia#call-flow\">Call Flow<\/a><\/h3>\n\n\n\n<p><strong>Initialization Call Flow:<\/strong><\/p>\n\n\n\n<div class=\"wp-block-merpress-mermaidjs diagram-source-mermaid\"><pre class=\"mermaid\">sequenceDiagram\n    participant Init as System Init\n    participant Syscfg as Syscfg Service\n    participant Sysevent as Sysevent Daemon\n    participant Services as Network Services\n    participant HAL as HAL Layer\n\n    Init->>Syscfg: Start syscfg service\n    Syscfg->>Syscfg: Load configuration from persistent storage\n    Syscfg->>Syscfg: Initialize shared memory database\n    Syscfg-->>Init: Syscfg ready\n\n    Init->>Sysevent: Start sysevent daemon\n    Sysevent->>Sysevent: Create Unix domain socket\n    Sysevent->>Sysevent: Initialize event routing tables\n    Sysevent-->>Init: Event bus ready\n\n    Init->>Services: Initialize network services\n    Services->>Syscfg: Read service configuration\n    Services->>Sysevent: Register for events\n    Services->>HAL: Initialize hardware interfaces\n    HAL-->>Services: Interface status\n    Services-->>Init: Services initialized\n\n    Init->>Init: System fully active<\/pre><\/div>\n\n\n\n<p><strong>Configuration Change Request Processing Call Flow:<\/strong><\/p>\n\n\n\n<div class=\"wp-block-merpress-mermaidjs diagram-source-mermaid\"><pre class=\"mermaid\">sequenceDiagram\n    participant Client as External Client\n    participant UTAPI as UTAPI Layer\n    participant Syscfg as Syscfg Service\n    participant Sysevent as Sysevent Daemon\n    participant Service as Network Service\n    participant HAL as HAL Layer\n\n    Client->>UTAPI: Configuration change request\n    UTAPI->>UTAPI: Validate parameters\n    UTAPI->>Syscfg: Update configuration parameter\n    Syscfg->>Syscfg: Atomic database update\n    Syscfg->>Sysevent: Broadcast config change event\n    Sysevent->>Service: Event notification\n    Service->>Syscfg: Read updated configuration\n    Service->>HAL: Apply hardware changes\n    HAL-->>Service: Status confirmation\n    Service->>Sysevent: Service update complete\n    Sysevent-->>UTAPI: Change propagated\n    UTAPI-->>Client: Configuration updated successfully<\/pre><\/div>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"internal-modules\"><a href=\"https:\/\/wiki.rdkcentral.com\/spaces\/RDK\/pages\/460988741\/Utopia#internal-modules\">Internal Modules<\/a><\/h2>\n\n\n\n<p>Utopia is organized into distinct functional modules that provide specific infrastructure and networking services. Each module operates with clear responsibilities and well-defined interfaces, enabling modular development and platform-specific customization while maintaining system-wide coordination through the core event bus and configuration management systems.<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><tbody><tr><td><strong>Sysevent System<\/strong><\/td><td>Core inter-process communication daemon providing publish-subscribe event messaging using Unix domain sockets with support for persistent and transient event states<\/td><td><code>syseventd_main.c<\/code>,&nbsp;<code>clientsMgr.c<\/code>,&nbsp;<code>triggerMgr.c<\/code>,&nbsp;<code>dataMgr.c<\/code><\/td><\/tr><tr><td><strong>Syscfg Database<\/strong><\/td><td>High-performance configuration persistence service using shared memory with filesystem backing, supporting atomic updates and namespace-based parameter organization<\/td><td><code>syscfg_lib.c<\/code>,&nbsp;<code><strong>syscfg<\/strong>.h<\/code>,&nbsp;<code>syscfg\/<strong>cmd<\/strong>\/syscfg.c<\/code><\/td><\/tr><tr><td><strong>UTAPI Interface<\/strong><\/td><td>Unified API layer providing standardized C interfaces and command-line tools for system configuration, network management, and status monitoring<\/td><td><code>utapi.c<\/code>,&nbsp;<code><strong>utapi<\/strong>.h<\/code>,&nbsp;<code><strong>utapi_util<\/strong>.h<\/code>,&nbsp;<code><strong>utapi_wlan<\/strong>.h<\/code><\/td><\/tr><tr><td><strong>DHCP Services<\/strong><\/td><td>Comprehensive DHCP server and client management including lease database management, option configuration, and multi-interface support<\/td><td><code>service_dhcp.c<\/code>,&nbsp;<code>dhcp_server_functions.c<\/code>,&nbsp;<code>lan_handler.c<\/code>,&nbsp;<code>service_udhcpc.c<\/code><\/td><\/tr><tr><td><strong>Firewall Management<\/strong><\/td><td>Advanced iptables-based firewall service with rule generation, NAT configuration, port triggering, and QoS integration<\/td><td><code>firewall.c<\/code>,&nbsp;<code>firewall_interface.c<\/code>,&nbsp;<code>nfq_handler.c<\/code><\/td><\/tr><tr><td><strong>WAN Service Handler<\/strong><\/td><td>WAN interface management supporting multiple connection types (DHCP, PPPoE, static), connection monitoring, and failover capabilities<\/td><td><code>service_wan\/<\/code>,&nbsp;<code>service_routed.c<\/code><\/td><\/tr><tr><td><strong>IPv6 Services<\/strong><\/td><td>IPv6 address management, routing, and neighbor discovery with support for stateless autoconfiguration and DHCPv6<\/td><td><code>service_ipv6.c<\/code>,&nbsp;<code>service_dhcpv6_client.c<\/code><\/td><\/tr><tr><td><strong>Multi-Network Management<\/strong><\/td><td>VLAN and bridge management service enabling network isolation, service-specific networking, and complex topology support<\/td><td><code>service_multinet\/<\/code>,&nbsp;<code>service_multinet_swfab.c<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"component-interactions\"><a href=\"https:\/\/wiki.rdkcentral.com\/spaces\/RDK\/pages\/460988741\/Utopia#component-interactions\">Component Interactions<\/a><\/h2>\n\n\n\n<p>Utopia maintains extensive integration points across the RDK-B middleware stack, providing foundational services that enable coordinated operation of networking, management, and platform services. The component serves as both a service provider and orchestration layer, managing complex interactions between system components while maintaining clean separation of concerns through well-defined interface boundaries.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"interaction-matrix\"><a href=\"https:\/\/wiki.rdkcentral.com\/spaces\/RDK\/pages\/460988741\/Utopia#interaction-matrix\">Interaction Matrix<\/a><\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><tbody><tr><td><strong>RDK-B CCSP Components<\/strong><\/td><td><\/td><td><\/td><\/tr><tr><td>CcspPandM<\/td><td>Configuration parameter management<\/td><td><code>GetParameterValues()<\/code>,&nbsp;<code>SetParameterValues()<\/code>,&nbsp;<code>AddObject()<\/code><\/td><\/tr><tr><td>CcspPsm<\/td><td>Persistent storage manager integration for cross-component data sharing<\/td><td><code>PsmSet()<\/code>,&nbsp;<code>PsmGet()<\/code>,&nbsp;<code>PsmGetRecordKeys()<\/code><\/td><\/tr><tr><td>Component Registrar<\/td><td>Service discovery and component lifecycle management<\/td><td><code>RegisterComponent()<\/code>,&nbsp;<code>UnregisterComponent()<\/code><\/td><\/tr><tr><td><strong>Network Management Components<\/strong><\/td><td><\/td><td><\/td><\/tr><tr><td>OneWifi<\/td><td>WiFi interface configuration, status monitoring, and event coordination<\/td><td><code>wifi-status<\/code>,&nbsp;<code>wifi-<strong>restart<\/strong><\/code>,&nbsp;<code>wlan-<strong>configuration<\/strong><\/code><\/td><\/tr><tr><td>WAN Manager<\/td><td>WAN connection management, failover coordination, and interface binding<\/td><td><code>wan-status<\/code>,&nbsp;<code>wan-<strong>restart<\/strong><\/code>,&nbsp;<code>UTAPI_WanConnect()<\/code><\/td><\/tr><tr><td>Ethernet Agent<\/td><td>Ethernet interface management and link status monitoring<\/td><td><code>ethernet-status<\/code>,&nbsp;<code><strong>link<\/strong>-up<\/code>,&nbsp;<code><strong>link<\/strong>-down<\/code><\/td><\/tr><tr><td><strong>System &amp; HAL Layers<\/strong><\/td><td><\/td><td><\/td><\/tr><tr><td>Network HAL<\/td><td>Hardware network interface control and status monitoring<\/td><td><code><strong>wifi_hal_init<\/strong>()<\/code>,&nbsp;<code><strong>ethernet_hal_getConfig<\/strong>()<\/code>,&nbsp;<code>docsis_hal_*<\/code><\/td><\/tr><tr><td>Linux Network Stack<\/td><td>Network interface configuration, routing, and firewall rule management<\/td><td><code><strong>ioctl<\/strong>()<\/code>,&nbsp;<code><strong>netlink_socket<\/strong>()<\/code>,&nbsp;<code>\/proc\/net\/*<\/code>,&nbsp;<code>\/sys\/<strong>class<\/strong>\/net\/*<\/code><\/td><\/tr><tr><td>Persistent Storage<\/td><td>Configuration data persistence and system defaults management<\/td><td><code>\/nvram\/syscfg.db<\/code>,&nbsp;<code>\/etc\/utopia\/system_defaults<\/code><\/td><\/tr><tr><td>SystemD Services<\/td><td>Process lifecycle management and service coordination<\/td><td><code>systemctl&nbsp;<strong>start<\/strong>\/<strong>stop<\/strong>\/restart<\/code>, service dependency management<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>Main events Published by Utopia:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><tbody><tr><td><code><strong>system<\/strong>-ready<\/code><\/td><td><code>\/<strong>system<\/strong>\/ready<\/code><\/td><td>Complete system initialization finished<\/td><td>All CCSP components, Network Agents<\/td><\/tr><tr><td><code>config-changed<\/code><\/td><td><code>\/config\/changed\/{parameter}<\/code><\/td><td>Configuration parameter modified via syscfg<\/td><td>Affected service handlers<\/td><\/tr><tr><td><code>network-<strong>restart<\/strong><\/code><\/td><td><code>\/network\/restart\/{service}<\/code><\/td><td>Network service restart required<\/td><td>Network management components<\/td><\/tr><tr><td><code>wan-status<\/code><\/td><td><code>\/wan\/status<\/code><\/td><td>WAN connection state change detected<\/td><td>WAN Manager, Routing services, CCSP components<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"ipc-flow-patterns\"><a href=\"https:\/\/wiki.rdkcentral.com\/spaces\/RDK\/pages\/460988741\/Utopia#ipc-flow-patterns\">IPC Flow Patterns<\/a><\/h3>\n\n\n\n<p><strong>Primary IPC Flow &#8211; Configuration Management:<\/strong><\/p>\n\n\n\n<div class=\"wp-block-merpress-mermaidjs diagram-source-mermaid\"><pre class=\"mermaid\">sequenceDiagram\n    participant Client as CCSP Component\n    participant UTAPI as UTAPI Layer  \n    participant Syscfg as Syscfg Database\n    participant Sysevent as Sysevent Bus\n    participant Service as Network Service\n    participant HAL as HAL Interface\n\n    Client->>UTAPI: SetParameterValue (RBus call)\n    UTAPI->>UTAPI: Validate parameter and permissions\n    UTAPI->>Syscfg: syscfg_set (shared memory update)\n    Syscfg->>Syscfg: Atomic database commit\n    Syscfg->>Sysevent: Post config-change event\n    Sysevent->>Service: Event notification (Unix socket)\n    Service->>Syscfg: syscfg_get (read new configuration)\n    Service->>HAL: Apply configuration (HAL API call)\n    HAL-->>Service: Status response\n    Service->>Sysevent: Post service-ready event\n    Sysevent-->>UTAPI: Configuration applied successfully\n    UTAPI-->>Client: RBus response (success\/failure)<\/pre><\/div>\n\n\n\n<p><strong>Event Notification Flow:<\/strong><\/p>\n\n\n\n<div class=\"wp-block-merpress-mermaidjs diagram-source-mermaid\"><pre class=\"mermaid\">sequenceDiagram\n    participant HAL as Hardware Layer\n    participant Service as Network Service\n    participant Sysevent as Sysevent Bus\n    participant Subscriber1 as OneWifi\n    participant Subscriber2 as WAN Manager\n    participant CCSP as CCSP Component\n\n    HAL->>Service: Interface state change interrupt\n    Service->>Service: Process hardware event\n    Service->>Sysevent: Publish network-status event\n    \n    Note over Sysevent: Event routing to subscribers\n    \n    Sysevent->>Subscriber1: Event delivery (Unix socket)\n    Sysevent->>Subscriber2: Event delivery (Unix socket)  \n    Sysevent->>CCSP: Event notification (RBus signal)\n    \n    Subscriber1-->>Sysevent: Acknowledgment (if required)\n    Subscriber2-->>Sysevent: Acknowledgment (if required)\n    CCSP-->>Sysevent: Event processed confirmation<\/pre><\/div>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"implementation-details\"><a href=\"https:\/\/wiki.rdkcentral.com\/spaces\/RDK\/pages\/460988741\/Utopia#implementation-details\">Implementation Details<\/a><\/h2>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"major-hal-apis-integration\"><a href=\"https:\/\/wiki.rdkcentral.com\/spaces\/RDK\/pages\/460988741\/Utopia#major-hal-apis-integration\">Major HAL APIs Integration<\/a><\/h3>\n\n\n\n<p>Utopia integrates with multiple HAL interface categories to provide comprehensive network device management and monitoring capabilities. The HAL integration layer abstracts platform-specific hardware differences while providing consistent interfaces to upper-layer network services.<\/p>\n\n\n\n<p><strong>Core HAL APIs:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><tbody><tr><td><code><strong>wifi_hal_init<\/strong>()<\/code><\/td><td>Initialize WiFi hardware subsystem and establish device communication<\/td><td><code>service_dhcp.c<\/code>, WiFi service handlers<\/td><\/tr><tr><td><code><strong>wifi_hal_getSSIDName<\/strong>()<\/code><\/td><td>Retrieve current SSID configuration for specified radio index<\/td><td><code>utapi_wlan.c<\/code>, wireless configuration modules<\/td><\/tr><tr><td><code><strong>ethernet_hal_getEthWanLinkStatus<\/strong>()<\/code><\/td><td>Check physical link status of WAN ethernet interface<\/td><td><code>service_wan\/wan_service.c<\/code><\/td><\/tr><tr><td><code><strong>docsis_hal_GetDhcpInfo<\/strong>()<\/code><\/td><td>Retrieve DHCP lease information from DOCSIS cable modem<\/td><td><code>service_dhcp_server.c<\/code><\/td><\/tr><tr><td><code><strong>platform_hal_GetDeviceConfigStatus<\/strong>()<\/code><\/td><td>Query overall device configuration and operational status<\/td><td><code>utapi.c<\/code>, system status functions<\/td><\/tr><tr><td><code><strong>firewall_hal_setFirewallRule<\/strong>()<\/code><\/td><td>Configure hardware firewall rules when hardware acceleration available<\/td><td><code>firewall.c<\/code>,&nbsp;<code>firewall_interface.c<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"key-implementation-logic\"><a href=\"https:\/\/wiki.rdkcentral.com\/spaces\/RDK\/pages\/460988741\/Utopia#key-implementation-logic\">Key Implementation Logic<\/a><\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Event Bus Architecture<\/strong>: The sysevent system implements a high-performance Unix domain socket server with multi-client support, event queuing, and trigger-based action execution located in\u00a0<code>syseventd_main.c<\/code>\u00a0with client management logic in\u00a0<code>clientsMgr.c<\/code>\u00a0and event routing in\u00a0<code>triggerMgr.c<\/code>. Main implementation in\u00a0<code>syseventd_main.c<\/code>\u00a0handles socket server, connection management, and event processing loop. Event routing and subscription management in\u00a0<code>triggerMgr.c<\/code>\u00a0provides publish-subscribe functionality with wildcard support. Client connection lifecycle managed in\u00a0<code>clientsMgr.c<\/code>\u00a0with authentication and resource tracking.<\/li>\n\n\n\n<li><strong>Configuration Database Engine<\/strong>: Syscfg implements a shared memory-based configuration database optimized for frequent reads and atomic writes, with automatic persistence and namespace support. Primary database engine in\u00a0<code>syscfg_lib.c<\/code>\u00a0providing thread-safe shared memory operations. Atomic transaction support with rollback capability for configuration consistency. Namespace isolation enabling multi-tenant configuration management<\/li>\n\n\n\n<li><strong>Network Service Orchestration<\/strong>: Service handlers coordinate complex networking operations through event-driven state machines that respond to configuration changes and hardware events. DHCP service coordination between server\/client modes with lease management. Firewall rule generation from high-level policies to iptables implementation. WAN service state machines for connection establishment and failover management.<\/li>\n\n\n\n<li><strong>Error Handling Strategy<\/strong>: Comprehensive error detection includes HAL error code mapping, service health monitoring, and automatic recovery mechanisms for transient failures. HAL error code standardization and logging with detailed context information. Service watchdog functionality with automatic restart for failed network services. Configuration validation and rollback on invalid parameter detection.<\/li>\n\n\n\n<li><strong>Logging &amp; Debugging<\/strong>: Multi-level logging system with category-based filtering, performance metrics, and debugging interfaces for troubleshooting complex network configurations. Structured logging with configurable verbosity levels and category filtering. Performance instrumentation for syscfg operations and event processing latency. Debug hooks enabling runtime inspection of configuration state and event flow.<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"key-configuration-files\"><a href=\"https:\/\/wiki.rdkcentral.com\/spaces\/RDK\/pages\/460988741\/Utopia#key-configuration-files\">Key Configuration Files<\/a><\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><tbody><tr><td><code>\/etc\/utopia\/system_defaults<\/code><\/td><td>System-wide default configuration template loaded during initialization<\/td><td>Product-specific files, factory reset procedures<\/td><\/tr><tr><td><code>\/etc\/utopia\/service.d\/service_*\/<\/code><\/td><td>Service-specific configuration and script directories<\/td><td>Yocto recipe customization, platform overlays<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"<p>Utopia serves as the foundational system infrastructure component for RDK-B middleware, providing comprehensive system initialization, [&hellip;]<\/p>\n","protected":false},"author":28,"featured_media":0,"parent":9575,"menu_order":30,"comment_status":"open","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-9743","page","type-page","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.9 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Utopia - RDK Documentation Portal | Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/utopia\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Utopia - RDK Documentation Portal | Documentation\" \/>\n<meta property=\"og:description\" content=\"Utopia serves as the foundational system infrastructure component for RDK-B middleware, providing comprehensive system initialization, [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/utopia\/\" \/>\n<meta property=\"og:site_name\" content=\"RDK Documentation Portal | Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2026-02-17T10:07:09+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"8 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/utopia\/\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/utopia\/\",\"name\":\"Utopia - RDK Documentation Portal | Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\"},\"datePublished\":\"2022-06-21T13:53:06+00:00\",\"dateModified\":\"2026-02-17T10:07:09+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/utopia\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/utopia\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/utopia\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"RDK Broadband\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Components\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Utopia\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/\",\"name\":\"RDK Documentation Portal | Documentation\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Utopia - RDK Documentation Portal | Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/utopia\/","og_locale":"en_US","og_type":"article","og_title":"Utopia - RDK Documentation Portal | Documentation","og_description":"Utopia serves as the foundational system infrastructure component for RDK-B middleware, providing comprehensive system initialization, [&hellip;]","og_url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/utopia\/","og_site_name":"RDK Documentation Portal | Documentation","article_modified_time":"2026-02-17T10:07:09+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"8 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/utopia\/","url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/utopia\/","name":"Utopia - RDK Documentation Portal | Documentation","isPartOf":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website"},"datePublished":"2022-06-21T13:53:06+00:00","dateModified":"2026-02-17T10:07:09+00:00","breadcrumb":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/utopia\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/utopia\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/utopia\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":2,"name":"Documentation","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":3,"name":"RDK Broadband","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/"},{"@type":"ListItem","position":4,"name":"Components","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/"},{"@type":"ListItem","position":5,"name":"Utopia"}]},{"@type":"WebSite","@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website","url":"https:\/\/developer.rdkcentral.com\/documentation\/","name":"RDK Documentation Portal | Documentation","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9743","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/users\/28"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/comments?post=9743"}],"version-history":[{"count":7,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9743\/revisions"}],"predecessor-version":[{"id":12719,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9743\/revisions\/12719"}],"up":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9575"}],"wp:attachment":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/media?parent=9743"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}