Google Git
Sign in
eclipse/tracecompass/org.eclipse.tracecompass/37f9cf25d068b999eee67782bfbbbfe853bf0faa
commit
37f9cf25d068b999eee67782bfbbbfe853bf0faa
[log] [tgz]
author
Hoang Thuan Pham <hoang.pham@calian.ca>
Thu Aug 03 10:53:46 2023 -0400
committer
Marco Miller <marco.miller@ericsson.com>
Tue Aug 15 11:56:27 2023 -0400
tree
26c8d2456f8f5b2ac13fdcd0a5f56c8e97e0b5e4
parent
121f90ee65157ce00aa45c616ea15fe55b11940e [diff]
linux: Move SWSLatency analysis to Trace Compass core

The SWSLatency computes the latency between the sched_wakeup event and
the sched_switch event for each thread. It is a subclass of
AbstractSegmentStoreAnalysisEventBasedModule.

This commit moves the SWSLatency analysis from the incubator to Trace
Compass core by copying the necessary files from
org.eclipse.tracecompass.incubator.internal.kernel.core.swslatency to
org.eclipse.tracecompass.analysis.os.linux.core.swslatency and making
necessary changes to existing configuration files. It also moves unit
tests for the analysis to Trace Compass core.

To test the analysis:

[1] Run the unit tests in
org.eclipse.tracecompass.analysis.os.linux.core.tests.swslatency
as J-unit plug-in tests. Confirm that they all pass. The goal is to test
that the analysis runs and provides expected output.
[2] Run the unit tests in
org.eclipse.tracecompass.integration.core.tests.dataproviders
as J-unit plug-in tests. Confirm that they all pass. Adding the new
analysis generates new DataProviderDescriptor(s). This is to make sure
that the existing test in this package is updated.
[3] Open Trace Compass. Open a kernel trace. Make sure that the
Scheduler Wakeup to Scheduler Switch Latency analysis is visible and not
crossed out under Views in the Project Explorer. It is normal to have no
output under the analysis because they are not yet included in this
commit. This is required to make sure that the analysis is exposed to
users in the UI of the Trace Compass application.

To be done in subsequent patches:

[1] Migrate outputs of the SWSLatency analysis
[2] Renaming the SWSLatency analysis to
SchedulerWakeupToSchedulerSwitchLatency to make the name of the analysis
easier to understand
[3] Add documentation
[4] Deprecate the SWSLatency analysis in the incubator

[Added] SWSLatency (SchedulerWakeupToSchedulerSwitchLatency) analysis

Change-Id: I7e105c4bae2042fd230d43eee9e97972113b8529
Signed-off-by: Hoang Thuan Pham <hoang.pham@calian.ca>
Reviewed-on: https://git.eclipse.org/r/c/tracecompass/org.eclipse.tracecompass/+/203530
Tested-by: Marco Miller <marco.miller@ericsson.com>
Tested-by: Trace Compass Bot <tracecompass-bot@eclipse.org>
Reviewed-by: Marco Miller <marco.miller@ericsson.com>
12 files changed
tree: 26c8d2456f8f5b2ac13fdcd0a5f56c8e97e0b5e4
  1. .mvn/
  2. analysis/
  3. btf/
  4. common/
  5. ctf/
  6. doc/
  7. gdbtrace/
  8. jsontrace/
  9. lttng/
  10. pcap/
  11. rcp/
  12. releng/
  13. statesystem/
  14. tmf/
  15. .dockerignore
  16. .gitattributes
  17. .gitignore
  18. .gitreview
  19. CODE_OF_CONDUCT.md
  20. components.dia
  21. components.svg
  22. CONTRIBUTING.md
  23. jsonify.sh
  24. LICENSE
  25. logging.properties
  26. NOTICE.md
  27. pom.xml
  28. README.md
  29. sync_settings.sh
  30. TraceCompass.setup
README.md

Eclipse Trace Compass

This source tree contains the source code for the Trace Compass plugins for Eclipse.

The plugins are categorized as follows:

analysis/    | Generic extensions to the base framework
btf/         | Best Trace Format (BTF) integration
common/      | Generic utilities that can be used by other plugins
ctf/         | Common Trace Format (CTF) reader library
doc/         | Documentation and code examples
gdbtrace/    | Support for reading and viewing GDB traces
lttng/       | LTTng integration
pcap/        | libpcap integration
rcp/         | Code specific to the RCP version
releng/      | Releng-related plugins
statesystem/ | State System library
tmf/         | Core framework

See the components.svg file for a diagram showing the dependencies between the different components.

Setting up the development environment

To set up the environment to build Trace Compass from within Eclipse, see this wiki page: http://wiki.eclipse.org/Trace_Compass/Development_Environment_Setup

Compiling manually

The Maven project build requires version 3.3 or later. It can be downloaded from http://maven.apache.org or from the package management system of your distro.

To build the project manually using Maven, simply run the following command from the top-level directory:

mvn clean install

The default command will compile and run the unit tests. Running the tests can take some time, to skip them you can append -Dmaven.test.skip=true to the mvn command:

mvn clean install -Dmaven.test.skip=true

Stand-alone application (RCP) packages will be placed in rcp/org.eclipse.tracecompass.rcp.product/target/products.

The p2 update site, used for installation as plugins inside Eclipse, will be placed in releng/org.eclipse.tracecompass.releng-site/target/repository.

To generate the javadoc from the Trace Compass source code, run the following command from the top-level directory:

mvn clean package javadoc:aggregate

The javadoc html files will be under target/site/apidocs.

Tracing Trace Compass

Trace Compass can be traced by doing the following in the launch configuration:

  • (java 8 only) -vmargs
  • -Djava.util.logging.config.file=%gitroot%/logging.properties (where %gitroot% is the directory tracecompass is checked out to)
  • -Dorg.eclipse.tracecompass.logging=true

Additionally the folder the trace is being written to (default is home/.tracecompass/logs) needs to be created in advance. After running Trace Compass, a trace_n.json will be created in the tracing folder. It needs to be converted to true json, so use the jsonify.sh script in the root directory to convert it. Then it can be loaded into Trace Compass, if the Trace Event format is installed from the incubator, or from a web browser such as Chromium.

The performance impact is low enough as long as the log level is greater than “FINEST”.

NOTE: thread 1 is always the UI thread for Trace Compass. Also, the thread numbers are the JVM threads and do not correspond necessarily to Process IDs.

Maven profiles and properties

NOTE: if you want to build the RCP with older platforms than 4.12 you need to copy the legacy tracing.product: cp rcp/org.eclipse.tracecompass.rcp.product/legacy/tracing.product rcp/org.eclipse.tracecompass.rcp.product/

The following Maven profiles and properties are defined in the build system. You can set them by using -P[profile name] and -D[property name]=[value] in mvn commands.

  • -Dtarget-platform=[target]

    Defines which target to use. This is used to build against various versions of the Eclipse platform. Available ones are in releng/org.eclipse.tracecompass.target. The default is usually the latest stable platform. To use the staging target for example, use -Dtarget-platform=tracecompass-eStaging.

  • -Dskip-tc-core-tests

    Skips the automated core tests. Not required when using -Dmaven.test.skip=true or -DskipTests=true , which already skips all the tests.

  • -Dskip-short-tc-ui-tests

    Skips the short UI integration tests. Not required when using -Dmaven.test.skip=true or -DskipTests=true, which already skips all the tests.

  • -Dskip-long-tc-ui-tests

    Skips the long UI integration tests. Not required when using -Dmaven.test.skip=true or -DskipTests=true, which already skips all the tests.

  • -Dskip-rcp

    Skips building the RCP archives and related deployment targets. Only works in conjunction with -Dskip-tc-long-ui-tests, due to a limitation in Maven.

  • -Pctf-grammar

    Re-compiles the CTF grammar files. This should be enabled if you modify the .g files in the ctf.parser plugin.

  • -Prun-custom-test-suite

    Runs a test suite present in releng/org.eclipse.tracecompass.alltests. The test suite to run has to be defined by -DcustomTestSuite=[name], for example -DcustomTestSuite=RunAllPerfTests.

  • -Pdeploy-rcp

    Mainly for use on build servers. Copies the generated RCP archives, as well as the RCP-specific update site, to the paths specified by -DrcpDestination=/absolute/path/to/destination and -DrcpSiteDestination=/absolute/path/to/destination, respectively.

  • -Pdeploy-update-site

    Mainly for use on build servers. Copies the standard update site (for the Eclipse plugin installation) to the destination specified by -DsiteDestination=/absolute/path/to/destination.

  • -Psign-update-site

    Mainly for use on build servers. Signs all the generated update sites using the Eclipse signing server.

  • -Pdeploy-doc

    Mainly for use on build servers. Copies the generated HTML documentation to the destination specified by -DdocDestination=/absolute/path/to/destination. Some directories may need to already exist at the destination (or Maven will throw related errors).

Build Trace Compass image with Docker

To compile the image of Trace Compass with Docker, run the following command from the top level directory:

docker build -f releng/dockerfiles/Dockerfile -t tracecompass .

The image will be tagged tracecompass.