IEP-374: GCOV Reports view and creation

README.md

@@ -54,6 +54,7 @@ To get a quick understanding about ESP-IDF and Eclipse plugin features check our
 * [ Device Firmware Upgrade (DFU) through USB ](#deviceFirmwareUpgrade)<br>
 * [ GDBStub Debugging ](#gdbStubDebugging)<br>
 * [ Core Dump Debugging ](#coreDumpDebugging)<br>
+* [ GCOV Code Coverage and Dump Generation ](#gcovCodeCoverage)<br>
 * [ Application Level Tracing ](#appLvlTracing)<br>
 * [ ESP-IDF master update](#updateEspIdfMaster)<br>
 * [ Partition Table Editor UI for ESP-IDF](#partitionTableEditor)<br>
@@ -581,6 +582,38 @@ This will enable the core dump debugging and whenever you connect a serial monit
 
 You can view the registers stack trace and even view the value of variables in stack frame. To exit the debug session simply press stop button.
 
+<a name="gcovCodeCoverage"></a>
+
+# GCOV Code Coverage and Dump Generation
+
+The idf eclipse plugin allows you to generate and view the gcov code coverage reports.
+
+For the purpose of the this documentation please use the example project [gcov](https://github.com/espressif/esp-idf/blob/master/examples/system/gcov/).
+You can read about the project more in the project [README.MD](https://github.com/espressif/esp-idf/blob/master/examples/system/gcov/README.md) to learn more about the flags required to enable this.
+
+After building and flashing the project you can start a normal debug session using the OpenOCD Launch Configuration. Once the debug session starts and the eclipse switches to the debug prespective you will notice two buttons on the IDF Process Console.
+![](docs/images/GcovCodeCoverage/gcov-1.png)
+
+The first button is to generate the instant runtime dump and the second button is to generate the hard coded dump. Based on where your program is you can create a dump. As per the example project the program halts twice for you to generate the hard-coded dump which you can do by pressing the second button.
+The instant runtime dump can be generated by pressing the first button after the hard-coded dump is complete.
+
+After your dumps are generated you can right click on the project and select the following option.
+`ESP-IDF: View GCOV Files`
+
+![](docs/images/GcovCodeCoverage/gcov-2.png)
+
+This will open a view for you that will show you the dumps that are available for the eclipse to be analyzed.
+![](docs/images/GcovCodeCoverage/gcov-3.png)
+
+You can press the refresh button to update the view to show the latest files and use the select project button to select a different project.
+Only one name is shown for both gcno and gcda files and only files that have a matching partner file with gcno or gcda are shown here.
+
+You can double click on any shown file and you will receive the following dialog. ![](docs/images/GcovCodeCoverage/gcov-4.png).
+You can either select to view the coverage for the selected file only or view the whole coverage 
+Depending upon what you selected you will either be shown the file and also a view that will contain the whole summary for the coverage.
+![Summary View](docs/images/GcovCodeCoverage/gcov-5.png)
+![File View](docs/images/GcovCodeCoverage/gcov-6.png)
+
 <a name="deviceFirmwareUpgrade"></a>
 
 # Device Firmware Upgrade (DFU) through USB

bundles/com.espressif.idf.core/META-INF/MANIFEST.MF

@@ -25,8 +25,9 @@ Require-Bundle: org.eclipse.core.runtime,
  org.eclipse.core.commands,
  org.eclipse.jface,
  org.apache.commons.logging;bundle-version="1.2.0",
- org.eclipse.core.variables,
- org.eclipse.embedcdt.core;visibility:=reexport
+ org.eclipse.embedcdt.core;visibility:=reexport,
+ org.eclipse.linuxtools.gcov.core,
+ org.eclipse.core.variables
 Bundle-RequiredExecutionEnvironment: JavaSE-11
 Automatic-Module-Name: com.espressif.idf.core
 Bundle-ActivationPolicy: lazy

bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/GcovUtility.java

@@ -0,0 +1,65 @@
+/*******************************************************************************
+ * Copyright 2023 Espressif Systems (Shanghai) PTE LTD. All rights reserved.
+ * Use is subject to license terms.
+ *******************************************************************************/
+package com.espressif.idf.core.util;
+
+import org.eclipse.core.internal.registry.osgi.OSGIUtils;
+import org.eclipse.core.resources.IFile;
+import org.eclipse.core.resources.IProject;
+import org.eclipse.jface.dialogs.IDialogSettings;
+import org.eclipse.ui.PlatformUI;
+import org.osgi.framework.Bundle;
+import org.osgi.framework.FrameworkUtil;
+
+import com.espressif.idf.core.logging.Logger;
+
+/**
+ * Gcov utility to handle and manage the selected project for view and also used to setup the dialog settings
+ * 
+ * @author Ali Azam Rana
+ *
+ */
+@SuppressWarnings("restriction")
+public class GcovUtility
+{
+	private static IProject selectedProject;
+
+	public static void setSelectedProject(IProject project)
+	{
+		selectedProject = project;
+	}
+
+	public static IProject getSelectedProject()
+	{
+		return selectedProject;
+	}
+
+	public static void clearSelectedProject()
+	{
+		selectedProject = null;
+	}
+
+	public static void setUpDialog(IFile gcFile, String elfFile)
+	{
+		try
+		{
+			Bundle bundle = OSGIUtils.getDefault().getBundle("org.eclipse.linuxtools.gcov.core"); //$NON-NLS-1$
+			Class<?> openGcAction = bundle.loadClass("org.eclipse.linuxtools.internal.gcov.action.OpenGCAction"); //$NON-NLS-1$
+			Class<?> openGcDialog = bundle.loadClass("org.eclipse.linuxtools.internal.gcov.dialog.OpenGCDialog"); //$NON-NLS-1$
+			IDialogSettings ds = PlatformUI.getDialogSettingsProvider(FrameworkUtil.getBundle(openGcAction))
+					.getDialogSettings();
+			IDialogSettings defaultMapping = ds.getSection(openGcDialog.getName());
+			if (defaultMapping == null)
+			{
+				defaultMapping = ds.addNewSection(openGcDialog.getName());
+			}
+
+			ds.put(gcFile.getRawLocation().toOSString(), elfFile);
+		}
+		catch (Exception e)
+		{
+			Logger.log(e);
+		}
+	}
+}

bundles/com.espressif.idf.debug.gdbjtag.openocd/plugin.xml

@@ -132,6 +132,17 @@
           id="com.espressif.idf.ui.appLvlTracing"
           name="%command.name">
       </command>
+      <command
+            defaultHandler="com.espressif.idf.debug.gdbjtag.openocd.gcov.GcovDumpHandler"
+            id="com.espressif.idf.gcov.instant"
+            name="GCOV Instant">
+      </command>
+      <command
+            defaultHandler="com.espressif.idf.debug.gdbjtag.openocd.gcov.GcovDumpHandler"
+            id="com.espressif.idf.gcov.hardcoded"
+            name="GCOV Hard-coded">
+      </command>
+
  </extension>
  <extension
        point="org.eclipse.ui.startup">

bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/Launch.java

@@ -1,4 +1,4 @@
 /*******************************************************************************
  * Copyright (c) 2013 Liviu Ionescu.
  *
  * This program and the accompanying materials
@@ -22,6 +22,7 @@
 
 import org.eclipse.cdt.debug.gdbjtag.core.IGDBJtagConstants;
 import org.eclipse.cdt.dsf.concurrent.DefaultDsfExecutor;
+import org.eclipse.cdt.dsf.concurrent.DsfExecutor;
 import org.eclipse.cdt.dsf.concurrent.DsfRunnable;
 import org.eclipse.cdt.dsf.concurrent.IDsfStatusConstants;
 import org.eclipse.cdt.dsf.gdb.IGDBLaunchConfigurationConstants;
@@ -37,7 +38,6 @@
 import org.eclipse.debug.core.ILaunchConfigurationWorkingCopy;
 import org.eclipse.debug.core.model.IProcess;
 import org.eclipse.debug.core.model.ISourceLocator;
-import org.eclipse.debug.internal.core.LaunchConfigurationWorkingCopy;
 import org.eclipse.embedcdt.debug.gdbjtag.core.dsf.GnuMcuLaunch;
 
 import com.espressif.idf.core.util.PortChecker;
@@ -70,11 +70,25 @@
 			System.out.println("openocd.Launch.launch(" + launchConfiguration.getName() + "," + mode + ") " + this);
 		}
 
 		fConfig = launchConfiguration;
 		fExecutor = (DefaultDsfExecutor) getDsfExecutor();
 		fSession = getSession();
 	}
-
+
+	public DsfSession getSession()
+	{
+		return super.getSession();
+	}
+
+	public DsfServicesTracker getDsfServicesTracker()
+	{
+		return fTracker;
+	}
+
+	public DsfExecutor getDsfExecutor()
+	{
+		return super.getDsfExecutor();
+	}
 	// ------------------------------------------------------------------------
 
 	@Override

bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/gcov/GcovDumpHandler.java

@@ -0,0 +1,157 @@
+/*******************************************************************************
+ * Copyright 2023 Espressif Systems (Shanghai) PTE LTD. All rights reserved.
+ * Use is subject to license terms.
+ *******************************************************************************/
+package com.espressif.idf.debug.gdbjtag.openocd.gcov;
+
+import org.eclipse.cdt.debug.core.ICDTLaunchConfigurationConstants;
+import org.eclipse.cdt.dsf.concurrent.DataRequestMonitor;
+import org.eclipse.cdt.dsf.concurrent.DsfExecutor;
+import org.eclipse.cdt.dsf.concurrent.ImmediateDataRequestMonitor;
+import org.eclipse.cdt.dsf.concurrent.RequestMonitor;
+import org.eclipse.cdt.dsf.datamodel.DMContexts;
+import org.eclipse.cdt.dsf.datamodel.IDMContext;
+import org.eclipse.cdt.dsf.debug.service.IProcesses;
+import org.eclipse.cdt.dsf.debug.service.IRunControl;
+import org.eclipse.cdt.dsf.debug.service.IRunControl.IExecutionDMContext;
+import org.eclipse.cdt.dsf.debug.service.command.ICommandControlService;
+import org.eclipse.cdt.dsf.debug.service.command.ICommandControlService.ICommandControlDMContext;
+import org.eclipse.cdt.dsf.mi.service.command.commands.CLICommand;
+import org.eclipse.cdt.dsf.service.DsfServicesTracker;
+import org.eclipse.core.commands.AbstractHandler;
+import org.eclipse.core.commands.ExecutionEvent;
+import org.eclipse.core.commands.ExecutionException;
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.resources.ResourcesPlugin;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.debug.core.DebugPlugin;
+import org.eclipse.debug.core.ILaunch;
+import org.eclipse.debug.core.ILaunchConfiguration;
+import org.eclipse.debug.core.ILaunchManager;
+import org.eclipse.swt.widgets.Display;
+import org.eclipse.ui.IWorkbenchPage;
+import org.eclipse.ui.IWorkbenchWindow;
+import org.eclipse.ui.PartInitException;
+import org.eclipse.ui.PlatformUI;
+
+import com.espressif.idf.core.logging.Logger;
+import com.espressif.idf.core.util.GcovUtility;
+import com.espressif.idf.core.util.StringUtil;
+import com.espressif.idf.debug.gdbjtag.openocd.dsf.Launch;
+import com.espressif.idf.ui.gcov.GcovFileView;
+
+/**
+ * The gcov dump handler simply runs and suspends the debug session momentarily to send the dump commands based on which
+ * button was pressed
+ * 
+ * @author Ali Azam Rana
+ *
+ */
+public class GcovDumpHandler extends AbstractHandler
+{
+	private static final String INSTANT_ID = "com.espressif.idf.gcov.instant";
+	private static final String HARD_CODED_ID = "com.espressif.idf.gcov.hardcoded";
+
+	private IExecutionDMContext executionDMContext;
+	private boolean isInstant = false;
+
+	@Override
+	public Object execute(ExecutionEvent event) throws ExecutionException
+	{
+		isInstant = event.getCommand().getId().equals(INSTANT_ID);
+		ILaunchManager launchManager = DebugPlugin.getDefault().getLaunchManager();
+		ILaunch[] launches = launchManager.getLaunches();
+		ILaunch launchActive = null;
+		for (ILaunch launch : launches)
+		{
+			if (!launch.isTerminated())
+			{
+				launchActive = launch;
+				break;
+			}
+		}
+
+		DsfServicesTracker dsfServicesTracker = ((Launch) launchActive).getDsfServicesTracker();
+		ICommandControlService commandControlService = dsfServicesTracker.getService(ICommandControlService.class);
+		DsfExecutor dsfExecutor = ((Launch) launchActive).getDsfExecutor();
+		IRunControl runControl = dsfServicesTracker.getService(IRunControl.class);
+		ICommandControlDMContext controlDmc = DMContexts.getAncestorOfType(commandControlService.getContext(),
+				ICommandControlDMContext.class);
+		IProcesses processControl = dsfServicesTracker.getService(IProcesses.class);
+		processControl.getProcessesBeingDebugged(controlDmc, new DataRequestMonitor<IDMContext[]>(dsfExecutor, null)
+		{
+			@Override
+			protected void handleSuccess()
+			{
+				executionDMContext = (IExecutionDMContext) (getData()[0]);
+			}
+		});
+		final ILaunch finalActiveLaunch = launchActive;
+		runControl.suspend(executionDMContext, new RequestMonitor(dsfExecutor, null)
+		{
+			@Override
+			protected void handleSuccess()
+			{
+				commandControlService.queueCommand(new CLICommand<>(commandControlService.getContext(),
+						isInstant ? "mon esp gcov dump" : "mon esp gcov"), new ImmediateDataRequestMonitor<>()
+						{
+							@Override
+							protected void handleSuccess()
+							{
+								runControl.resume(executionDMContext, new RequestMonitor(dsfExecutor, null));
+								ILaunchConfiguration launchConfig = finalActiveLaunch.getLaunchConfiguration();
+								Display.getDefault().asyncExec(() -> {
+									String projectName;
+									try
+									{
+										projectName = launchConfig.getAttribute(
+												ICDTLaunchConfigurationConstants.ATTR_PROJECT_NAME, StringUtil.EMPTY);
+
+										if (!projectName.isEmpty())
+										{
+											IProject project = ResourcesPlugin.getWorkspace().getRoot()
+													.getProject(projectName);
+											if (project != null && project.exists())
+											{
+												GcovUtility.setSelectedProject(project);
+												IWorkbenchWindow window = PlatformUI.getWorkbench()
+														.getActiveWorkbenchWindow();
+												if (window != null)
+												{
+													IWorkbenchPage page = window.getActivePage();
+													if (page != null)
+													{
+														try
+														{
+															GcovFileView gcovFileView = (GcovFileView) page
+																	.showView(GcovFileView.ID);
+															page.activate(gcovFileView);
+
+														}
+														catch (PartInitException e)
+														{
+															Logger.log(e);
+														}
+													}
+												}
+											}
+										}
+									}
+									catch (CoreException e)
+									{
+										Logger.log(e);
+									}
+								});
+							}
+
+							@Override
+							protected void handleError()
+							{
+								runControl.resume(executionDMContext, new RequestMonitor(dsfExecutor, null));
+							}
+						});
+			}
+		});
+		return null;
+	}
+}

bundles/com.espressif.idf.serial.monitor/src/com/espressif/idf/serial/monitor/core/IDFMonitor.java

@@ -43,7 +43,7 @@
 
 	public IDFMonitor(IProject project, String port, String filterOptions, String pythonBinPath, int serverPort)
 	{
 		this.project = project;
 		this.port = port;
 		this.pythonBinPath = pythonBinPath;
 		this.filterOptions = filterOptions;
@@ -143,54 +143,54 @@
 
 	public Process start() throws Exception
 	{
 		if (!dependenciesAreInstalled())
 		{
 			throw new Exception("The WebSocket dependency is missing and cannot be installed automatically"); //$NON-NLS-1$
 		}
 		List<String> arguments = commandArgsWithSocketServer();
 
 		// command to execute
 		Logger.log(arguments.toString());
 
 		// CDT Build environment variables
 		Map<String, String> idfEnvMap = new IDFEnvironmentVariables().getSystemEnvMap();
 
 		// Disable buffering of output
 		idfEnvMap.put("PYTHONUNBUFFERED", "1"); //$NON-NLS-1$ //$NON-NLS-2$
 
 		// Update with the CDT build environment variables
 		Map<String, String> environment = new HashMap<>(System.getenv());
 		environment.putAll(idfEnvMap);
 
 		Logger.log(environment.toString());
 
 		// Update PATH and Path
 		String idfPath = environment.get("PATH"); //$NON-NLS-1$
 		String processPath = environment.get("Path"); //$NON-NLS-1$
 		if (!StringUtil.isEmpty(idfPath) && !StringUtil.isEmpty(processPath)) // if both exist!
 		{
 			idfPath = idfPath.concat(";").concat(processPath); //$NON-NLS-1$
 			environment.put("PATH", idfPath); //$NON-NLS-1$
 			environment.remove("Path");//$NON-NLS-1$
 		}
 
 		// Add ptyprocess terminal argument
 		environment.remove("TERM_PROGRAM"); // for OS X //$NON-NLS-1$
 		environment.put("TERM", "vt102"); //$NON-NLS-1$ //$NON-NLS-2$
 
 		Logger.log(environment.toString());
 
 		// working dir
 		IPath workingDir = project.getLocation();
 
 		LocalTerminal localTerminal = new LocalTerminal(arguments, workingDir.toFile(), environment);
 		return localTerminal.connect();
 	}
 
 	public boolean dependenciesAreInstalled()
 	{
 		InstallToolsHandler installToolsHandler = new InstallToolsHandler();
-		IStatus status = installToolsHandler.handleWebSocketClientInstall();
+		IStatus status = installToolsHandler.handlePythonDependenciesInstall();
 		if (status == null || status.getSeverity() == IStatus.ERROR)
 		{
 			Logger.log(IDFCorePlugin.getPlugin(), IDFCorePlugin.errorStatus("Unable to get the process status.", null)); //$NON-NLS-1$

bundles/com.espressif.idf.ui/META-INF/MANIFEST.MF

@@ -41,12 +41,14 @@ Require-Bundle: org.eclipse.core.runtime,
  org.eclipse.embedcdt.ui,
  org.eclipse.ltk.ui.refactoring,
  org.eclipse.ltk.core.refactoring,
- org.eclipse.epp.mpc.ui
+ org.eclipse.epp.mpc.ui,
+ org.eclipse.core.variables;bundle-version="3.5.100"
 Automatic-Module-Name: com.espressif.idf.ui
 Bundle-ActivationPolicy: lazy
 Bundle-RequiredExecutionEnvironment: JavaSE-11
 Export-Package: com.espressif.idf.ui,
  com.espressif.idf.ui.dialogs,
+ com.espressif.idf.ui.gcov,
  com.espressif.idf.ui.handlers,
  com.espressif.idf.ui.preferences,
  com.espressif.idf.ui.tracing,