7260: Create a new serializers bundle

Reviewed-by: jbachorik, hdafgard, aptmac
openjdk · Jun 2, 2021 · 8c28f1b · 8c28f1b
1 parent 103245e
commit 8c28f1b
Show file tree

Hide file tree

Showing 33 changed files with 632 additions and 133 deletions.
diff --git a/application/org.openjdk.jmc.feature.flightrecorder/feature.xml b/application/org.openjdk.jmc.feature.flightrecorder/feature.xml
@@ -114,6 +114,13 @@
          install-size="0"
          version="0.0.0"
          unpack="false"/>
+
+   <plugin
+         id="org.openjdk.jmc.flightrecorder.serializers"
+         download-size="0"
+         install-size="0"
+         version="0.0.0"
+         unpack="false"/>
 
    <plugin
          id="org.openjdk.jmc.rjmx.services.jfr"

diff --git a/application/org.openjdk.jmc.flightrecorder.flameview/META-INF/MANIFEST.MF b/application/org.openjdk.jmc.flightrecorder.flameview/META-INF/MANIFEST.MF
@@ -5,6 +5,7 @@ Bundle-Name: FlameView
 Bundle-SymbolicName: org.openjdk.jmc.flightrecorder.flameview;singleton:=true
 Bundle-Version: 8.1.0.qualifier
 Require-Bundle: org.openjdk.jmc.flightrecorder,
+ org.openjdk.jmc.flightrecorder.serializers,
  org.openjdk.jmc.flightrecorder.ui,
  org.openjdk.jmc.flightrecorder.rules,
  org.openjdk.jmc.common

diff --git a/...lameview/src/main/java/org/openjdk/jmc/flightrecorder/flameview/views/FlameGraphView.java b/...lameview/src/main/java/org/openjdk/jmc/flightrecorder/flameview/views/FlameGraphView.java
@@ -97,8 +97,8 @@
 import org.openjdk.jmc.common.item.IItemCollection;
 import org.openjdk.jmc.common.item.ItemCollectionToolkit;
 import org.openjdk.jmc.common.util.StringToolkit;
-import org.openjdk.jmc.flightrecorder.flameview.FlameGraphJsonMarshaller;
 import org.openjdk.jmc.flightrecorder.flameview.FlameviewImages;
+import org.openjdk.jmc.flightrecorder.serializers.json.FlameGraphJsonSerializer;
 import org.openjdk.jmc.flightrecorder.stacktrace.FrameSeparator;
 import org.openjdk.jmc.flightrecorder.stacktrace.FrameSeparator.FrameCategorization;
 import org.openjdk.jmc.flightrecorder.stacktrace.tree.StacktraceTreeModel;
@@ -302,7 +302,7 @@ public void run() {
 			if (isInvalid) {
 				return;
 			}
-			String flameGraphJson = FlameGraphJsonMarshaller.toJson(treeModel);
+			String flameGraphJson = FlameGraphJsonSerializer.toJson(treeModel);
 			if (isInvalid) {
 				return;
 			} else {

diff --git a/application/org.openjdk.jmc.flightrecorder.graphview/META-INF/MANIFEST.MF b/application/org.openjdk.jmc.flightrecorder.graphview/META-INF/MANIFEST.MF
@@ -3,8 +3,9 @@ Bundle-ManifestVersion: 2
 Bundle-Name: GraphView
 Bundle-SymbolicName: org.openjdk.jmc.flightrecorder.graphview;singleton:=true
 Bundle-Version: 8.1.0.qualifier
-Require-Bundle: org.openjdk.jmc.flightrecorder;bundle-version="8.1.0",
- org.openjdk.jmc.flightrecorder.ui;bundle-version="8.1.0",
+Require-Bundle: org.openjdk.jmc.flightrecorder,
+ org.openjdk.jmc.flightrecorder.ui,
+ org.openjdk.jmc.flightrecorder.serializers,
  org.junit,
  org.junit.jupiter.api,
  org.junit.jupiter.engine,

diff --git a/...der.graphview/src/main/java/org/openjdk/jmc/flightrecorder/graphview/views/GraphView.java b/...der.graphview/src/main/java/org/openjdk/jmc/flightrecorder/graphview/views/GraphView.java
@@ -75,7 +75,7 @@
 import org.openjdk.jmc.common.item.ItemCollectionToolkit;
 import org.openjdk.jmc.common.util.Pair;
 import org.openjdk.jmc.common.util.StringToolkit;
-import org.openjdk.jmc.flightrecorder.ext.graphview.graph.DotGenerator;
+import org.openjdk.jmc.flightrecorder.serializers.dot.DotSerializer;
 import org.openjdk.jmc.flightrecorder.stacktrace.FrameSeparator;
 import org.openjdk.jmc.flightrecorder.stacktrace.FrameSeparator.FrameCategorization;
 import org.openjdk.jmc.flightrecorder.stacktrace.graph.StacktraceGraphModel;
@@ -327,7 +327,7 @@ private static String toDot(StacktraceGraphModel model, int maxNodesRendered) {
 	}
 
 	private static String render(StacktraceGraphModel model, int maxNodesRendered) {
-		return DotGenerator.toDot(model, maxNodesRendered, DotGenerator.getDefaultConfiguration());
+		return DotSerializer.toDot(model, maxNodesRendered, DotSerializer.getDefaultConfiguration());
 	}
 
 	private static String loadLibraries(String ... libs) {

diff --git a/application/pom.xml b/application/pom.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--   
-   Copyright (c) 2018, 2020, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved.
    
    DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
    
@@ -166,6 +166,11 @@
 			<artifactId>flightrecorder.rules.jdk</artifactId>
 			<version>${revision}${changelist}</version>
 		</dependency>
+		<dependency>
+			<groupId>org.openjdk.jmc</groupId>
+			<artifactId>flightrecorder.serializers</artifactId>
+			<version>${revision}${changelist}</version>
+		</dependency>
 		<dependency>
 			<groupId>org.openjdk.jmc</groupId>
 			<artifactId>jdp</artifactId>

diff --git a/application/tests/org.openjdk.jmc.flightrecorder.flameview.test/.project b/application/tests/org.openjdk.jmc.flightrecorder.flameview.test/.project
diff --git a/application/tests/org.openjdk.jmc.flightrecorder.flameview.test/META-INF/MANIFEST.MF b/application/tests/org.openjdk.jmc.flightrecorder.flameview.test/META-INF/MANIFEST.MF
diff --git a/application/tests/pom.xml b/application/tests/pom.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--   
-   Copyright (c) 2018, 2020, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved.
    
    DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
    
@@ -45,7 +45,6 @@
 		<module>org.openjdk.jmc.flightrecorder.controlpanel.ui.configuration.test</module>
 		<module>org.openjdk.jmc.flightrecorder.controlpanel.ui.test</module>
 		<module>org.openjdk.jmc.flightrecorder.ext.jfx.test</module>
-		<module>org.openjdk.jmc.flightrecorder.flameview.test</module>
 		<module>org.openjdk.jmc.flightrecorder.ui.test</module>
 		<module>org.openjdk.jmc.greychart.test</module>
 		<module>org.openjdk.jmc.ide.launch.test</module>

diff --git a/configuration/ide/eclipse/dictionary/dictionary.txt b/configuration/ide/eclipse/dictionary/dictionary.txt
@@ -1,3 +1,4 @@
+
 accessor
 accessors
 affine
@@ -10,6 +11,7 @@ combinable
 commensurability
 conformance
 darkens
+datadog
 decompressed
 deserialization
 enablement
@@ -27,6 +29,7 @@ introspected
 introspecting
 iterable
 javascript
+jfr
 jigsaw
 kibibytes
 kleene
@@ -48,6 +51,7 @@ refactored
 reimplemented
 rethink
 serializable
+serializers
 servlet
 stacktrace
 stacktraces
@@ -65,10 +69,9 @@ unparsable
 unpersistable
 username
 versioning
+xml
 whitelisted
 wildcard
 wildcards
 zip
 zipped
-datadog
-xml
diff --git a/core/org.openjdk.jmc.flightrecorder.serializers/.classpath b/core/org.openjdk.jmc.flightrecorder.serializers/.classpath
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="src" output="target/classes" path="src/main/java">
+		<attributes>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
+	<classpathentry kind="src" output="target/test-classes" path="src/test/java">
+		<attributes>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="test" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="src" output="target/classes" path="${rootDir}/license">
+		<attributes>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="output" path="target/classes"/>
+</classpath>
diff --git a/core/org.openjdk.jmc.flightrecorder.serializers/META-INF/MANIFEST.MF b/core/org.openjdk.jmc.flightrecorder.serializers/META-INF/MANIFEST.MF
@@ -0,0 +1,12 @@
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-RequiredExecutionEnvironment: JavaSE-1.8
+Bundle-Name: Common Plug-in
+Bundle-SymbolicName: org.openjdk.jmc.flightrecorder.serializers;singleton:=true
+Bundle-Version: 8.1.0.qualifier
+Bundle-Vendor: Oracle Corporation
+Export-Package: org.openjdk.jmc.flightrecorder.serializers,
+ org.openjdk.jmc.flightrecorder.serializers.json,
+ org.openjdk.jmc.flightrecorder.serializers.dot
+Automatic-Module-Name: org.openjdk.jmc.flightrecorder.serializers
+Require-Bundle: org.lz4.lz4-java, org.openjdk.jmc.flightrecorder
diff --git a/core/org.openjdk.jmc.flightrecorder.serializers/build.properties b/core/org.openjdk.jmc.flightrecorder.serializers/build.properties
@@ -0,0 +1,39 @@
+#
+#  Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
+#  Copyright (c) 2021, Datadog, Inc. All rights reserved.
+#
+#  DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+#
+#  The contents of this file are subject to the terms of either the Universal Permissive License 
+#  v 1.0 as shown at http://oss.oracle.com/licenses/upl
+#   
+#  or the following license:
+#   
+#  Redistribution and use in source and binary forms, with or without modification, are permitted
+#  provided that the following conditions are met:
+#   
+#  1. Redistributions of source code must retain the above copyright notice, this list of conditions
+#  and the following disclaimer.
+#   
+#  2. Redistributions in binary form must reproduce the above copyright notice, this list of
+#  conditions and the following disclaimer in the documentation and/or other materials provided with
+#  the distribution.
+#   
+#  3. Neither the name of the copyright holder nor the names of its contributors may be used to
+#  endorse or promote products derived from this software without specific prior written permission.
+#
+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
+#  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+#  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+#  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+#  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+#  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+#  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
+#  WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+source.. = src/main/java/,\
+           src/main/resources/
+output.. = target/classes/
+bin.includes = META-INF/,\
+               .
+pde.match.rule.bundle=compatible
diff --git a/...jmc.flightrecorder.flameview.test/pom.xml → ...dk.jmc.flightrecorder.serializers/pom.xml b/...jmc.flightrecorder.flameview.test/pom.xml → ...dk.jmc.flightrecorder.serializers/pom.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!--
-   Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
-   Copyright (c) 2020, Datadog, Inc. All rights reserved.
+<!--   
+   Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2021, Datadog, Inc. All rights reserved.
    
    DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
    
@@ -36,13 +36,28 @@
 	<modelVersion>4.0.0</modelVersion>
 	<parent>
 		<groupId>org.openjdk.jmc</groupId>
-		<artifactId>missioncontrol.application.tests</artifactId>
+		<artifactId>missioncontrol.core</artifactId>
 		<version>${revision}${changelist}</version>
 	</parent>
-	<artifactId>org.openjdk.jmc.flightrecorder.flameview.test</artifactId>
-	<packaging>eclipse-test-plugin</packaging>
-
+	<artifactId>flightrecorder.serializers</artifactId>
 	<properties>
-		<spotless.config.path>${basedir}/../../../configuration/ide/eclipse/formatting/formatting.xml</spotless.config.path>
+		<spotless.config.path>${basedir}/../../configuration/ide/eclipse/formatting/formatting.xml</spotless.config.path>
 	</properties>
+	<dependencies>
+		<dependency>
+			<groupId>org.openjdk.jmc</groupId>
+			<artifactId>common</artifactId>
+			<version>${project.version}</version>
+		</dependency>
+		<dependency>
+			<groupId>org.openjdk.jmc</groupId>
+			<artifactId>flightrecorder</artifactId>
+			<version>${project.version}</version>
+		</dependency>
+		<dependency>
+			<groupId>org.lz4</groupId>
+			<artifactId>lz4-java</artifactId>
+			<version>1.7.1</version>
+		</dependency>
+	</dependencies>
 </project>
diff --git a/...der/ext/graphview/graph/DotGenerator.java → ...corder/serializers/dot/DotSerializer.java b/...der/ext/graphview/graph/DotGenerator.java → ...corder/serializers/dot/DotSerializer.java
@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2019, 2020, Oracle and/or its affiliates. All rights reserved.
- * Copyright (c) 2019, 2020, Datadog, Inc. All rights reserved.
+ * Copyright (c) 2019, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 2021, Datadog, Inc. All rights reserved.
  *
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
@@ -31,7 +31,7 @@
  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
  * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-package org.openjdk.jmc.flightrecorder.ext.graphview.graph;
+package org.openjdk.jmc.flightrecorder.serializers.dot;
 
 import java.io.File;
 import java.io.IOException;
@@ -53,7 +53,7 @@
  * Converts a {@link StacktraceGraphModel} to DOT format text. This format can, for example, be used
  * by d3-graphviz, to visualize the graphs.
  */
-public final class DotGenerator {
+public final class DotSerializer {
 	private static final String DEFAULT_NAME = "Unnamed";
 	private static final String DEFAULT_SHAPE = "box";
 	private static final String DEFAULT_STYLE = "filled";
@@ -442,13 +442,24 @@ private static String getConf(
 	}
 
 	/**
-	 * Generates a dot file for the CPU profiling events available in the recording.
+	 * Generates a DOT file for the execution sample (CPU profiling) events available in the
+	 * recording.
+	 * <p>
+	 * TODO: This could easily be made highly configurable to allow the user to configure which
+	 * event type to filter for, what attribute to use for weight, and what frame separator to use.
 	 * 
 	 * @param args
+	 *            takes one argument - the file name of the JFR file to serialize into DOT.
 	 * @throws IOException
 	 * @throws CouldNotLoadRecordingException
 	 */
 	public static void main(String[] args) throws IOException, CouldNotLoadRecordingException {
+		if (args.length != 1) {
+			System.out.println("Usage: DotSerializer <filename>\n");
+			System.out.println(
+					"Serializes the execution sample events in a JFR file into a DOT file, suitable for visualizing with GraphViz.");
+			System.exit(2);
+		}
 		File jfrFile = new File(args[0]);
 		IItemCollection items = JfrLoaderToolkit.loadEvents(jfrFile);
 		IItemCollection filteredItems = items.apply(JdkFilters.EXECUTION_SAMPLE);