Component Viewer initial commit

TPIP.md

@@ -1,9 +1,10 @@
 # TPIP Report for vscode-cmsis-debugger
 
-Report prepared at: 13/01/2026, 08:36:58
+Report prepared at: 20/01/2026, 15:39:57
 
 | *Package* | *Version* | *Repository* | *License* |
 |---|---|---|---|
 | arm-none-eabi-gdb | 14.3.1 | https://artifacts.tools.arm.com/arm-none-eabi-gdb/14.3.1/ | https://developer.arm.com/GetEula?Id=15d9660a-2059-4985-85e9-c01cdd4b1ba0 |
 | pyocd | 0.42.0 | https://github.com/pyocd/pyOCD | https://github.com/pyocd/pyOCD/blob/v0.42.0/LICENSE |
+| xml2js | 0.6.2 | https://github.com/Leonidas-from-XIV/node-xml2js | https://github.com/Leonidas-from-XIV/node-xml2js/blob/master/LICENSE |
 | yaml | 2.8.2 | https://github.com/eemeli/yaml | https://github.com/eemeli/yaml/blob/main/LICENSE |

docs/third-party-licenses.json

@@ -13,6 +13,13 @@
         "url": "https://github.com/pyocd/pyOCD",
         "license": "https://github.com/pyocd/pyOCD/blob/v0.42.0/LICENSE"
     },
+    {
+        "name": "xml2js",
+        "version": "0.6.2",
+        "spdx": "MIT",
+        "url": "https://github.com/Leonidas-from-XIV/node-xml2js",
+        "license": "https://github.com/Leonidas-from-XIV/node-xml2js/blob/master/LICENSE"
+    },
     {
         "name": "yaml",
         "version": "2.8.2",

package.json

@@ -60,6 +60,11 @@
           "id": "cmsis-debugger.liveWatch",
           "name": "Live Watch",
           "icon": "media/trace-and-live-light.svg"
+        },
+        {
+          "id": "cmsis-debugger.componentViewer",
+          "name": "Component Viewer",
+          "icon": "media/trace-and-live-light.svg"
         }
       ]
     },
@@ -362,7 +367,8 @@
     "baseContentUrl": "https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/blob/main/README.md"
   },
   "dependencies": {
-    "yaml": "^2.8.2"
+    "yaml": "^2.8.2",
+    "xml2js": "^0.6.2"
   },
   "devDependencies": {
     "@open-cmsis-pack/vsce-helper": "^0.2.2",
@@ -373,6 +379,7 @@
     "@types/node": "^20.19.25",
     "@types/node-fetch": "^2.6.13",
     "@types/vscode": "^1.106.1",
+    "@types/xml2js": "^0.4.14",
     "@types/yargs": "^17.0.35",
     "@types/yarnpkg__lockfile": "^1.1.9",
     "@typescript-eslint/eslint-plugin": "8.53.0",

src/cbuild-run/cbuild-run-reader.ts

@@ -44,23 +44,33 @@ export class CbuildRunReader {
     }
 
     public getSvdFilePaths(cmsisPackRoot?: string, pname?: string): string[] {
+        const svdFilePaths = this.getFilePathsByType('svd', cmsisPackRoot, pname);
+        return svdFilePaths;
+    }
+
+    public getScvdFilePaths(cmsisPackRoot?: string, pname?: string): string[] {
+        const scvdFilePaths = this.getFilePathsByType('scvd', cmsisPackRoot, pname);
+        return scvdFilePaths;
+    }
+
+    private getFilePathsByType(type: 'svd' | 'scvd', cmsisPackRoot?: string, pname?: string): string[] {
         if (!this.cbuildRun) {
             return [];
         }
-        // Get SVD file descriptors
+        // Get file descriptors
         const systemDescriptions = this.cbuildRun['system-descriptions'];
-        const svdFileDescriptors = systemDescriptions?.filter(descriptor => descriptor.type === 'svd') ?? [];
-        if (svdFileDescriptors.length === 0) {
+        const fileDescriptors = systemDescriptions?.filter(descriptor => descriptor.type === type) ?? [];
+        if (fileDescriptors.length === 0) {
             return [];
         }
         // Replace potential ${CMSIS_PACK_ROOT} placeholder
         const effectiveCmsisPackRoot = cmsisPackRoot ?? getCmsisPackRootPath();
         // Map to copies, leave originals untouched
-        const filteredSvdDescriptors = pname ? svdFileDescriptors.filter(descriptor => descriptor.pname === pname): svdFileDescriptors;
-        const svdFilePaths = filteredSvdDescriptors.map(descriptor => `${effectiveCmsisPackRoot
+        const filteredDescriptors = pname ? fileDescriptors.filter(descriptor => descriptor.pname === pname): fileDescriptors;
+        const filePaths = filteredDescriptors.map(descriptor => `${effectiveCmsisPackRoot
             ? descriptor.file.replaceAll(CMSIS_PACK_ROOT_ENVVAR, effectiveCmsisPackRoot)
             : descriptor.file}`);
-        return svdFilePaths;
+        return filePaths;
     }
 
     public getPnames(): string[] {

src/debug-session/gdbtarget-debug-session.ts

@@ -106,7 +106,7 @@ export class GDBTargetDebugSession {
         return this.session.configuration.request === 'launch' && this.capabilities?.supportsTerminateRequest === true;
     }
 
-    /** Function returns string only in case of failure */
+    // Function returns string only in case of failure
     public async evaluateGlobalExpression(expression: string, context = 'hover'): Promise<DebugProtocol.EvaluateResponse['body'] | string> {
         try {
             const frameId = (vscode.debug.activeStackItem as vscode.DebugStackFrame)?.frameId ?? 0;

src/desktop/extension.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2025 Arm Limited
+ * Copyright 2025-2026 Arm Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,6 +24,7 @@ import { CpuStates } from '../features/cpu-states/cpu-states';
 import { CpuStatesCommands } from '../features/cpu-states/cpu-states-commands';
 import { LiveWatchTreeDataProvider } from '../views/live-watch/live-watch';
 import { GenericCommands } from '../features/generic-commands';
+import { ComponentViewer } from '../views/component-viewer/component-viewer-main';
 
 const BUILTIN_TOOLS_PATHS = [
     'tools/pyocd/pyocd',
@@ -39,6 +40,7 @@ export const activate = async (context: vscode.ExtensionContext): Promise<void>
     const cpuStates = new CpuStates();
     const cpuStatesCommands = new CpuStatesCommands();
     const cpuStatesStatusBarItem = new CpuStatesStatusBarItem();
+    const componentViewer = new ComponentViewer(context);
     // Register the Tree View under the id from package.json
     liveWatchTreeDataProvider = new LiveWatchTreeDataProvider(context);
 
@@ -54,6 +56,8 @@ export const activate = async (context: vscode.ExtensionContext): Promise<void>
     cpuStatesStatusBarItem.activate(context, cpuStates);
     // Live Watch view
     liveWatchTreeDataProvider.activate(gdbtargetDebugTracker);
+    // Component Viewer
+    componentViewer.activate(gdbtargetDebugTracker);
 
     logger.debug('Extension Pack activated');
 };

src/manifest.ts

@@ -18,3 +18,5 @@ export const PUBLISHER_NAME = 'arm';
 export const EXTENSION_NAME = 'vscode-cmsis-debugger';
 export const EXTENSION_ID = `${PUBLISHER_NAME}.${EXTENSION_NAME}`;
 export const DISPLAY_NAME = 'Arm CMSIS Debugger';
+
+export const COMPONENT_VIEWER_DISPLAY_NAME = 'Arm CMSIS Component Viewer';

src/views/component-viewer/component-viewer-instance.ts

@@ -0,0 +1,199 @@
+/**
+ * Copyright 2026 Arm Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as vscode from 'vscode';
+import { URI } from 'vscode-uri';
+import { parseStringPromise, ParserOptions } from 'xml2js';
+import { Json } from './model/scvd-base';
+import { Resolver } from './resolver';
+import { ScvdComponentViewer } from './model/scvd-component-viewer';
+import { ScvdBase } from './model/scvd-base';
+import { StatementEngine } from './statement-engine/statement-engine';
+import { ScvdEvalContext } from './scvd-eval-context';
+import { GDBTargetDebugSession, GDBTargetDebugTracker } from '../../debug-session';
+import { ScvdGuiTree } from './scvd-gui-tree';
+
+
+const xmlOpts: ParserOptions = {
+    explicitArray: false,
+    mergeAttrs: true,
+    explicitRoot: true,
+    trim: true,
+    // Add child objects that carry their original tag name via '#name'
+    explicitChildren: true,
+    preserveChildrenOrder: true
+};
+
+export class ComponentViewerInstance {
+    private _model: ScvdComponentViewer | undefined;
+    private _memUsageStart: number = 0;
+    private _memUsageLast: number = 0;
+    private _timeUsageLast: number = 0;
+    private _statementEngine: StatementEngine | undefined;
+    private _guiTree: ScvdGuiTree | undefined;
+
+    public constructor(
+    ) {
+    }
+
+    private injectLineNumbers(xml: string): string {
+        const lines = xml.split(/\r?\n/);
+        const result: string[] = [];
+        for (const [idx, line] of lines.entries()) {
+            result.push(line.replace(
+                /<((?!\/|!|\?)([A-Za-z_][A-Za-z0-9._:-]*))/g,
+                `<$1 __line="${idx + 1}"`
+            ));
+        }
+        return result.join('\n');
+    }
+
+    public getGuiTree(): ScvdGuiTree[] | undefined {
+        return this._guiTree?.children;
+    }
+
+    public getStats(text: string): string {
+        const mem = process.memoryUsage();
+        const memCurrent = Math.round(mem.heapUsed / 1024 / 1024);
+        const timeCurrent = Date.now();
+
+        if (this._timeUsageLast === 0) {
+            this._timeUsageLast = timeCurrent;
+        }
+        if (this._memUsageStart === 0) {
+            this._memUsageStart = memCurrent;
+            this._memUsageLast = memCurrent;
+        }
+
+        const memUsage = memCurrent - this._memUsageLast;
+        const timeUsage = timeCurrent - this._timeUsageLast;
+        const memIncrease = memCurrent - this._memUsageStart;
+
+        this._memUsageLast = memCurrent;
+        this._timeUsageLast = timeCurrent;
+
+        return `${text}, Time: ${timeUsage} ms, Mem: ${memUsage}, Mem Increase: ${memIncrease} MB, (Total: ${memCurrent} MB)`;
+    }
+
+    public async readModel(filename: URI, debugSession: GDBTargetDebugSession, debugTracker: GDBTargetDebugTracker): Promise<void> {
+        const stats: string[] = [];
+
+        stats.push(this.getStats(`  Start reading SCVD file ${filename}`));
+        const buf = (await this.readFileToBuffer(filename)).toString('utf-8');
+        stats.push(this.getStats('  read'));
+        const bufLineNo = this.injectLineNumbers(buf);
+        stats.push(this.getStats('  inject'));
+        const xml: Json = await this.parseXml(bufLineNo);
+        stats.push(this.getStats('  parse'));
+
+        if (xml === undefined) {
+            console.error('Failed to parse SCVD XML');
+            return;
+        }
+
+        ScvdBase.resetIds();
+        this.model = new ScvdComponentViewer(undefined);
+        if (!this.model) {
+            console.error('Failed to create SCVD model');
+            return;
+        }
+
+        this.model.readXml(xml);
+        stats.push(this.getStats('  model.readXml'));
+
+        const scvdEvalContext = new ScvdEvalContext(this.model);
+        scvdEvalContext.init(debugSession, debugTracker);
+        stats.push(this.getStats('  evalContext.init'));
+
+        const executionContext = scvdEvalContext.getExecutionContext();
+        this.model.setExecutionContextAll(executionContext);
+        stats.push(this.getStats('  model.setExecutionContextAll'));
+
+        this.model.configureAll();
+        stats.push(this.getStats('  model.configureAll'));
+        this.model.validateAll(true);
+        stats.push(this.getStats('  model.validateAll'));
+
+        const resolver = new Resolver(this.model);
+        resolver.resolve();
+        stats.push(this.getStats('  resolver.resolve'));
+
+        await this.model.calculateTypedefs();
+        stats.push(this.getStats('  model.calculateTypedefs'));
+
+        this.statementEngine = new StatementEngine(this.model, executionContext);
+        this.statementEngine.initialize();
+        stats.push(this.getStats('  statementEngine.initialize'));
+        this._guiTree = new ScvdGuiTree(undefined, 'component-viewer-root');
+
+        console.log('ComponentViewerInstance readModel stats:\n' + stats.join('\n  '));
+    }
+
+    public async update(): Promise<void> {
+        const stats: string[] = [];
+        stats.push(this.getStats('  start'));
+        if (this._statementEngine === undefined || this._guiTree === undefined) {
+            return;
+        }
+        const epoch = this._guiTree.beginUpdate();
+        await this._statementEngine.executeAll(this._guiTree);
+        this._guiTree.finalizeUpdate(epoch);
+        stats.push(this.getStats('end'));
+        console.log('ComponentViewerInstance update stats:\n' + stats.join('\n  '));
+    }
+
+    private async readFileToBuffer(filePath: URI): Promise<Buffer> {
+        try {
+            const buffer = await vscode.workspace.fs.readFile(filePath);
+            return Buffer.from(buffer);
+        } catch (error) {
+            console.error('Error reading file:', error);
+            throw error;
+        }
+    }
+
+    private async parseXml(text: string) {
+        try {
+            const json = await parseStringPromise(text, xmlOpts);
+            //console.log(JSON.stringify(json, null, 2));
+            return json;
+        } catch (err) {
+            console.error('Error parsing XML:', err);
+        }
+    }
+
+    public get model(): ScvdComponentViewer | undefined {
+        return this._model;
+    }
+
+    private set model(value: ScvdComponentViewer | undefined) {
+        this._model = value;
+    }
+
+    public get statementEngine(): StatementEngine | undefined {
+        return this._statementEngine;
+    }
+
+    private set statementEngine(value: StatementEngine | undefined) {
+        this._statementEngine = value;
+    }
+
+    public async executeStatements(guiTree: ScvdGuiTree): Promise<void> {
+        if (this._statementEngine !== undefined) {
+            await this._statementEngine.executeAll(guiTree);
+        }
+    }
+}

src/views/component-viewer/component-viewer-logger.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2025-2026 Arm Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as vscode from 'vscode';
+import * as manifest from '../../manifest';
+
+export const componentViewerLogger = vscode.window.createOutputChannel(manifest.COMPONENT_VIEWER_DISPLAY_NAME, { log: true });