Skip to content

README.md

Latest commit

 

History

History
105 lines (80 loc) · 5.05 KB

README.md

File metadata and controls

105 lines (80 loc) · 5.05 KB
Raw

Legacy Plugins and Shared Plugin Helpers

1. High-Level Purpose & Architecture

The plugins/ tree contains legacy Dobby plugins and shared helpers that predate or complement the RDK plugin launcher. These components extend bundle/container behavior through older plugin configuration paths when legacy support is enabled.

They do not define the modern IDobbyRdkPlugin ABI and should not be assumed interchangeable with rdkPlugins/.

2. Architectural Overview

Legacy spec/config
      |
Dobby legacy plugin manager
      |
plugins/Common PluginBase and ServiceMonitor
      |
EthanLog, OpenCDM, MulticastSockets, Perfetto

3. Code Organization (Folder & File-Level)

  • plugins/Common/include/PluginBase.h: shared legacy plugin base.
  • plugins/Common/include/ServiceMonitor.h, source/ServiceMonitor.cpp: service monitoring helper.
  • plugins/EthanLog/source/EthanLogPlugin.*: EthanLog integration.
  • plugins/EthanLog/source/EthanLogClient.*, EthanLogLoop.*: client and event loop helpers.
  • plugins/EthanLog/client/lib/include/ethanlog.h, source/ethanlog.c: C client API.
  • plugins/EthanLog/client/cat/ethanlog-cat.cpp: log inspection tool.
  • plugins/OpenCDM/source/OpenCDMPlugin.*: OpenCDM integration.
  • plugins/MulticastSockets/source/MulticastSocketsPlugin.*: multicast socket integration.
  • plugins/Perfetto/source/PerfettoPlugin.*: legacy Perfetto integration.

Some build/runtime interactions are conditional on LEGACY_COMPONENTS; exact plugin-specific configuration keys must be read from each plugin source and schema.

4. Class & Interface Documentation

PluginBase and concrete plugin classes provide the legacy extension point. ServiceMonitor observes an external service and is used by components that need service availability. EthanLogClient and EthanLogLoop isolate the EthanLog transport/event behavior.

The legacy hook defaults are defined in PluginBase.h, and the hook contract and hints are declared in IDobbyPlugin.h. The service monitor API and implementation are in ServiceMonitor.h and ServiceMonitor.cpp. EthanLog client and event-loop interfaces are in EthanLogClient.h and EthanLogLoop.h.

5. Configuration & Build Integration

LEGACY_COMPONENTS enables legacy plugins and related template/spec support. The legacy Perfetto plugin bind-mounts the host producer socket; separate in-process tracing requires a debug build, ENABLE_PERFETTO_TRACING, and the Perfetto SDK.

6. Internal Workflows & Execution Flow

A legacy-enabled build loads plugin libraries through DobbyLegacyPluginManager.cpp, which dispatches the lifecycle hooks declared in DobbyLegacyPluginManager.h. During container lifecycle operations, DobbyManager.cpp calls executePostConstructionHooks, executePreStartHooks, executePostStartHooks, executePostStopHooks, and executePreDestructionHooks. These legacy hooks are distinct from the modern RDK hooks documented in rdkPlugins/README.md.

7. Diagrams & Visual Aids

flowchart LR
    Spec[Legacy plugin config] --> Manager[Legacy plugin manager]
    Manager --> Base[PluginBase]
    Base --> Ethan[EthanLog]
    Base --> CDM[OpenCDM]
    Base --> Multi[Multicast sockets]
    Base --> Perf[Perfetto]
Loading 
classDiagram
    class PluginBase
    class ServiceMonitor
    class EthanLogPlugin
    class OpenCDMPlugin
    class MulticastSocketsPlugin
    PluginBase <|-- EthanLogPlugin
    PluginBase <|-- OpenCDMPlugin
    PluginBase <|-- MulticastSocketsPlugin
    %% ServiceMonitor is a standalone helper; no direct relationship is defined here.
Loading 
sequenceDiagram
    participant Config
    participant Manager
    participant Plugin
    participant Service
    Config->>Manager: legacy plugin settings
    Manager->>Plugin: construct/setup
    Plugin->>Service: monitor or configure
    Service-->>Plugin: event/status
    Plugin-->>Manager: result
Loading 
stateDiagram-v2
    [*] --> Disabled
    Disabled --> Enabled: LEGACY_COMPONENTS
    Enabled --> Initialized
    Initialized --> Active
    Active --> Stopped
    Stopped --> [*]
Loading

8. Testing & Quality Analysis

The file inventory shows broad daemon and configuration tests but no clearly named test suite for every legacy plugin. Add plugin-specific tests for service disappearance, malformed settings, duplicate cleanup, socket ownership, and builds with LEGACY_COMPONENTS both enabled and disabled. Platform services require integration tests.

9. Beginner-to-Expert Teaching Mode

Must know first: legacy plugins are an older extension path and are compile-time optional.

Advanced path: compare legacy plugin ownership and hook timing with IDobbyRdkPlugin, then trace configuration compatibility and migration risks.