diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000000000000000000000000000000000000..00a51aff5e5a83d6313f3bd15fadc601a205b66f --- /dev/null +++ b/.gitattributes @@ -0,0 +1,6 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# These are explicitly windows files and should use crlf +*.bat text eol=crlf + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..d7ced3675308a654f35c67f1205f3a050658579b --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +# Ignore Gradle project-specific cache directory +.gradle + +# Ignore Gradle build output directory +build + +# Ignore Eclipse +.classpath +.project +.settings/** + diff --git a/analysis/build.gradle b/analysis/build.gradle new file mode 100644 index 0000000000000000000000000000000000000000..8b5ff86b7dfbfab267a3313ff3257626bb995a4a --- /dev/null +++ b/analysis/build.gradle @@ -0,0 +1,5 @@ +plugins { + id 'java' + id 'java-library' +} + diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000000000000000000000000000000000000..26aceb028171e095884a185251989dc432526ccc --- /dev/null +++ b/build.gradle @@ -0,0 +1,32 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * This is a general purpose Gradle build. + * Learn how to create Gradle builds at https://guides.gradle.org/creating-new-gradle-builds + */ + +plugins { + id 'java' +} + +repositories { + // Use jcenter for resolving dependencies. + // You can declare any Maven/Ivy/file repository here. + jcenter() + mavenCentral() + maven { url "https://oss.sonatype.org/content/repositories/snapshots/" } + maven {url "https://oss.sonatype.org/content/repositories/releases/" } +} + +dependencies { + implementation 'net.kieker-monitoring:kieker:1.15-SNAPSHOT' + implementation 'net.sourceforge.teetime:teetime:3.0' + implementation 'com.beust:jcommander:1.78' + + // Use JUnit test framework + testImplementation 'junit:junit:4.13' +} + +subprojects { + +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000000000000000000000000000000000000..62d4c053550b91381bbd28b1afc82d634bf73a8a Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000000000000000000000000000000000000..622ab64a3cb60378cd29384961554c0b032c9368 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000000000000000000000000000000000000..fbd7c515832dab7b01092e80db76e5e03fe32d29 --- /dev/null +++ b/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# 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 +# +# https://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. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000000000000000000000000000000000000..5093609d512a96947851d39fa2dc05df2af2248e --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,104 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000000000000000000000000000000000000..39b81b8115d9365caaf28bb2e637760a793eb03b --- /dev/null +++ b/settings.gradle @@ -0,0 +1,16 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * The settings file is used to specify which projects to include in your build. + * + * Detailed information about configuring a multi-project build in Gradle can be found + * in the user manual at https://docs.gradle.org/6.5/userguide/multi_project_builds.html + */ + +rootProject.name = 'oceandsl-java-tools' + +include 'analysis' +include 'tools:rewrite-log-entries' +include 'tools:create-architecture-model' + + diff --git a/tools/create-architecture-model/README.md b/tools/create-architecture-model/README.md new file mode 100644 index 0000000000000000000000000000000000000000..bfa14556b6e419e42862f1c8d5736e529069c157 --- /dev/null +++ b/tools/create-architecture-model/README.md @@ -0,0 +1,24 @@ +# Replace Log Entries + +This tool has 4 parameters and can be used to replace function pointer +references by function signatures produced by kieker-lang-pack-c +instrumentations. + +The parameters: +-i input kieker log directory> +-o path where the output kieker log is placed +-a the location of the addr2line executable to resolve the names +-m the executable (model) to be analyzed by addr2line + +## Build + +`./gradlew build` + +The build produces an tar and zip archive in its `build/distributions` directory. + +## Notes + +Currently, the resulting Kieker-log uses textual serialization. This could be +changed in future implementations. + + diff --git a/tools/create-architecture-model/build.gradle b/tools/create-architecture-model/build.gradle new file mode 100644 index 0000000000000000000000000000000000000000..bfab315a33bd618a205b4f5e219d74aa4c23e65b --- /dev/null +++ b/tools/create-architecture-model/build.gradle @@ -0,0 +1,20 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * This generated file contains a sample Java project to get you started. + * For more details take a look at the Java Quickstart chapter in the Gradle + * User Manual available at https://docs.gradle.org/6.5/userguide/tutorial_java_projects.html + */ + +plugins { + id 'java' + id 'application' +} + +dependencies { + implementation project(':analysis') +} + +application { + mainClassName = 'org.oceandsl.architecture.model.ArchitectureModelMain' +} diff --git a/tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/ArchitectureModelMain.java b/tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/ArchitectureModelMain.java new file mode 100644 index 0000000000000000000000000000000000000000..1b538199de7822aa6d26076c2952f75ebecf4fea --- /dev/null +++ b/tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/ArchitectureModelMain.java @@ -0,0 +1,68 @@ +/* + * This Java source file was generated by the Gradle 'init' task. + */ +package org.oceandsl.log.rewriter; + +import java.io.File; +import java.io.IOException; + +import com.beust.jcommander.JCommander; + +import kieker.common.configuration.Configuration; +import kieker.common.exception.ConfigurationException; +import kieker.tools.common.AbstractService; + +public class LogRewriterMain extends AbstractService<TeetimeConfiguration,LogRewriterSettings>{ + + public static void main(String[] args) { + java.lang.System.exit(new LogRewriterMain().run("Kieker Log ELF Rewriter", + "log-rewriter", args, new LogRewriterSettings())); + } + + @Override + protected TeetimeConfiguration createTeetimeConfiguration() throws ConfigurationException { + try { + return new TeetimeConfiguration(this.parameterConfiguration); + } catch (IOException e) { + throw new ConfigurationException(e); + } + } + + @Override + protected File getConfigurationFile() { + // we do not use a configuration file + return null; + } + + @Override + protected boolean checkConfiguration(Configuration configuration, JCommander commander) { + return true; + } + + @Override + protected boolean checkParameters(JCommander commander) throws ConfigurationException { + if (!this.parameterConfiguration.getAddrlineExecutable().canExecute()) { + this.logger.error("Addr2line file {} is not executable", this.parameterConfiguration.getAddrlineExecutable()); + return false; + } + if (!this.parameterConfiguration.getModelExecutable().canExecute()) { + this.logger.error("Model file {} is not executable", this.parameterConfiguration.getModelExecutable()); + return false; + } + if (!this.parameterConfiguration.getInputFile().isDirectory()) { + this.logger.error("Input directory {} is not directory", this.parameterConfiguration.getInputFile()); + return false; + } + if (!this.parameterConfiguration.getOutputFile().isDirectory()) { + this.logger.error("Output directory {} is not directory", this.parameterConfiguration.getOutputFile()); + return false; + } + return true; + } + + @Override + protected void shutdownService() { + // TODO Auto-generated method stub + + } +} diff --git a/tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/LogRewriterSettings.java b/tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/LogRewriterSettings.java new file mode 100644 index 0000000000000000000000000000000000000000..c425cc0578dee1e0857a5d7e8e0276304e68294e --- /dev/null +++ b/tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/LogRewriterSettings.java @@ -0,0 +1,44 @@ +/** + * + */ +package org.oceandsl.log.rewriter; + +import java.io.File; + +import com.beust.jcommander.Parameter; +import com.beust.jcommander.converters.FileConverter; + +/** + * @author reiner + * + */ +public class LogRewriterSettings { + + @Parameter(names = { "-i", "--input" }, required = true, converter = FileConverter.class, description = "Input Kieker log directory") + private File inputFile; + + @Parameter(names = { "-o", "--output" }, required = true, converter = FileConverter.class, description = "Output directory where to put the Kieker log directory") + private File outputFile; + + @Parameter(names = { "-a", "--addrline" }, required = true, converter = FileConverter.class, description = "Location of the addrline tool") + private File addrlineExecutable; + + @Parameter(names = { "-m", "--model" }, required = true, converter = FileConverter.class, description = "Location of the model executable") + private File modelExecutable; + + public File getInputFile() { + return this.inputFile; + } + + public File getOutputFile() { + return this.outputFile; + } + + public File getAddrlineExecutable() { + return this.addrlineExecutable; + } + + public File getModelExecutable() { + return this.modelExecutable; + } +} diff --git a/tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/TeetimeConfiguration.java b/tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/TeetimeConfiguration.java new file mode 100644 index 0000000000000000000000000000000000000000..c086926d10711bdba85e724621fa2d37918fe071 --- /dev/null +++ b/tools/create-architecture-model/src/main/java/org/oceandsl/architecture/model/TeetimeConfiguration.java @@ -0,0 +1,70 @@ +/** + * + */ +package org.oceandsl.log.rewriter; + +import java.io.IOException; + +import kieker.analysis.sink.DataSinkStage; +import kieker.tools.source.LogsReaderCompositeStage; +import teetime.framework.Configuration; + +/** + * @author reiner + * + */ +public class TeetimeConfiguration extends Configuration { + + public TeetimeConfiguration(LogRewriterSettings parameterConfiguration) throws IOException { + + kieker.common.configuration.Configuration configuration = new kieker.common.configuration.Configuration(); + configuration.setProperty(LogsReaderCompositeStage.LOG_DIRECTORIES, + parameterConfiguration.getInputFile().getCanonicalPath()); + configuration.setProperty("kieker.monitoring.name", "KIEKER"); + configuration.setProperty("kieker.monitoring.enabled","true"); + configuration.setProperty("kieker.monitoring.initialExperimentId","transcoded"); + configuration.setProperty("kieker.monitoring.metadata","true"); + configuration.setProperty("kieker.monitoring.setLoggingTimestamp","true"); + configuration.setProperty("kieker.monitoring.useShutdownHook","true"); + configuration.setProperty("kieker.monitoring.jmx","false"); + + configuration.setProperty("kieker.monitoring.timer", + kieker.monitoring.timer.SystemNanoTimer.class.getCanonicalName()); + configuration.setProperty("kieker.monitoring.timer.SystemMilliTimer.unit","0"); + configuration.setProperty("kieker.monitoring.timer.SystemNanoTimer.unit","0"); + configuration.setProperty("kieker.monitoring.writer", + kieker.monitoring.writer.filesystem.FileWriter.class.getCanonicalName()); + configuration.setProperty("kieker.monitoring.core.controller.WriterController.RecordQueueFQN", + org.jctools.queues.MpscArrayQueue.class.getCanonicalName()); + configuration.setProperty("kieker.monitoring.core.controller.WriterController.RecordQueueSize","10000"); + configuration.setProperty("kieker.monitoring.core.controller.WriterController.RecordQueueInsertBehavior","1"); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.customStoragePath",parameterConfiguration.getOutputFile().getCanonicalPath()); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.charsetName","UTF-8"); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.maxEntriesInFile","25000"); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.maxLogSize","-1"); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.maxLogFiles","-1"); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.mapFileHandler", + kieker.monitoring.writer.filesystem.TextMapFileHandler.class.getCanonicalName()); + configuration.setProperty("kieker.monitoring.writer.filesystem.TextMapFileHandler.flush","true"); + configuration.setProperty("kieker.monitoring.writer.filesystem.TextMapFileHandler.compression", + kieker.monitoring.writer.compression.NoneCompressionFilter.class.getCanonicalName()); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.logFilePoolHandler", + kieker.monitoring.writer.filesystem.RotatingLogFilePoolHandler.class.getCanonicalName()); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.logStreamHandler", + kieker.monitoring.writer.filesystem.TextLogStreamHandler.class.getCanonicalName()); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.flush","true"); + configuration.setProperty("kieker.monitoring.writer.filesystem.BinaryFileWriter.bufferSize","8192"); + configuration.setProperty("kieker.monitoring.writer.filesystem.BinaryFileWriter.compression", + kieker.monitoring.writer.compression.NoneCompressionFilter.class.getCanonicalName()); + + LogsReaderCompositeStage reader = new LogsReaderCompositeStage(configuration); + + RewriteBeforeAndAfterEventsStage processor = new RewriteBeforeAndAfterEventsStage(parameterConfiguration.getAddrlineExecutable(), + parameterConfiguration.getModelExecutable()); + + DataSinkStage writer = new DataSinkStage(configuration); + + this.connectPorts(reader.getOutputPort(), processor.getInputPort()); + this.connectPorts(processor.getOutputPort(), writer.getInputPort()); + } +} diff --git a/tools/rewrite-log-entries/README.md b/tools/rewrite-log-entries/README.md new file mode 100644 index 0000000000000000000000000000000000000000..bfa14556b6e419e42862f1c8d5736e529069c157 --- /dev/null +++ b/tools/rewrite-log-entries/README.md @@ -0,0 +1,24 @@ +# Replace Log Entries + +This tool has 4 parameters and can be used to replace function pointer +references by function signatures produced by kieker-lang-pack-c +instrumentations. + +The parameters: +-i input kieker log directory> +-o path where the output kieker log is placed +-a the location of the addr2line executable to resolve the names +-m the executable (model) to be analyzed by addr2line + +## Build + +`./gradlew build` + +The build produces an tar and zip archive in its `build/distributions` directory. + +## Notes + +Currently, the resulting Kieker-log uses textual serialization. This could be +changed in future implementations. + + diff --git a/tools/rewrite-log-entries/build.gradle b/tools/rewrite-log-entries/build.gradle new file mode 100644 index 0000000000000000000000000000000000000000..7449b47bfa47b582dc5c58333b5b5d7eeb5569ca --- /dev/null +++ b/tools/rewrite-log-entries/build.gradle @@ -0,0 +1,20 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * This generated file contains a sample Java project to get you started. + * For more details take a look at the Java Quickstart chapter in the Gradle + * User Manual available at https://docs.gradle.org/6.5/userguide/tutorial_java_projects.html + */ + +plugins { + id 'java' + id 'application' +} + +dependencies { + implementation project(':analysis') +} + +application { + mainClassName = 'org.oceandsl.log.rewriter.LogRewriterMain' +} diff --git a/tools/rewrite-log-entries/src/main/java/org/oceandsl/log/rewriter/LogRewriterMain.java b/tools/rewrite-log-entries/src/main/java/org/oceandsl/log/rewriter/LogRewriterMain.java new file mode 100644 index 0000000000000000000000000000000000000000..1b538199de7822aa6d26076c2952f75ebecf4fea --- /dev/null +++ b/tools/rewrite-log-entries/src/main/java/org/oceandsl/log/rewriter/LogRewriterMain.java @@ -0,0 +1,68 @@ +/* + * This Java source file was generated by the Gradle 'init' task. + */ +package org.oceandsl.log.rewriter; + +import java.io.File; +import java.io.IOException; + +import com.beust.jcommander.JCommander; + +import kieker.common.configuration.Configuration; +import kieker.common.exception.ConfigurationException; +import kieker.tools.common.AbstractService; + +public class LogRewriterMain extends AbstractService<TeetimeConfiguration,LogRewriterSettings>{ + + public static void main(String[] args) { + java.lang.System.exit(new LogRewriterMain().run("Kieker Log ELF Rewriter", + "log-rewriter", args, new LogRewriterSettings())); + } + + @Override + protected TeetimeConfiguration createTeetimeConfiguration() throws ConfigurationException { + try { + return new TeetimeConfiguration(this.parameterConfiguration); + } catch (IOException e) { + throw new ConfigurationException(e); + } + } + + @Override + protected File getConfigurationFile() { + // we do not use a configuration file + return null; + } + + @Override + protected boolean checkConfiguration(Configuration configuration, JCommander commander) { + return true; + } + + @Override + protected boolean checkParameters(JCommander commander) throws ConfigurationException { + if (!this.parameterConfiguration.getAddrlineExecutable().canExecute()) { + this.logger.error("Addr2line file {} is not executable", this.parameterConfiguration.getAddrlineExecutable()); + return false; + } + if (!this.parameterConfiguration.getModelExecutable().canExecute()) { + this.logger.error("Model file {} is not executable", this.parameterConfiguration.getModelExecutable()); + return false; + } + if (!this.parameterConfiguration.getInputFile().isDirectory()) { + this.logger.error("Input directory {} is not directory", this.parameterConfiguration.getInputFile()); + return false; + } + if (!this.parameterConfiguration.getOutputFile().isDirectory()) { + this.logger.error("Output directory {} is not directory", this.parameterConfiguration.getOutputFile()); + return false; + } + return true; + } + + @Override + protected void shutdownService() { + // TODO Auto-generated method stub + + } +} diff --git a/tools/rewrite-log-entries/src/main/java/org/oceandsl/log/rewriter/LogRewriterSettings.java b/tools/rewrite-log-entries/src/main/java/org/oceandsl/log/rewriter/LogRewriterSettings.java new file mode 100644 index 0000000000000000000000000000000000000000..c425cc0578dee1e0857a5d7e8e0276304e68294e --- /dev/null +++ b/tools/rewrite-log-entries/src/main/java/org/oceandsl/log/rewriter/LogRewriterSettings.java @@ -0,0 +1,44 @@ +/** + * + */ +package org.oceandsl.log.rewriter; + +import java.io.File; + +import com.beust.jcommander.Parameter; +import com.beust.jcommander.converters.FileConverter; + +/** + * @author reiner + * + */ +public class LogRewriterSettings { + + @Parameter(names = { "-i", "--input" }, required = true, converter = FileConverter.class, description = "Input Kieker log directory") + private File inputFile; + + @Parameter(names = { "-o", "--output" }, required = true, converter = FileConverter.class, description = "Output directory where to put the Kieker log directory") + private File outputFile; + + @Parameter(names = { "-a", "--addrline" }, required = true, converter = FileConverter.class, description = "Location of the addrline tool") + private File addrlineExecutable; + + @Parameter(names = { "-m", "--model" }, required = true, converter = FileConverter.class, description = "Location of the model executable") + private File modelExecutable; + + public File getInputFile() { + return this.inputFile; + } + + public File getOutputFile() { + return this.outputFile; + } + + public File getAddrlineExecutable() { + return this.addrlineExecutable; + } + + public File getModelExecutable() { + return this.modelExecutable; + } +} diff --git a/tools/rewrite-log-entries/src/main/java/org/oceandsl/log/rewriter/RegTestMain.java b/tools/rewrite-log-entries/src/main/java/org/oceandsl/log/rewriter/RegTestMain.java new file mode 100644 index 0000000000000000000000000000000000000000..3018a1e271b02e69e507374e0b7633533cead94f --- /dev/null +++ b/tools/rewrite-log-entries/src/main/java/org/oceandsl/log/rewriter/RegTestMain.java @@ -0,0 +1,23 @@ +package org.oceandsl.log.rewriter; + +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +public class RegTestMain { + + public static void main(String[] args) { + String string = "MAIN_ at ??:?"; + final Pattern pattern = Pattern.compile("^(\\w+) at ([\\w\\?]+):([\\d\\?]*)$"); + Matcher matcher = pattern.matcher(string); + + boolean result = matcher.find(); + + System.out.println(matcher.groupCount()); + System.out.println(result); + System.out.println(matcher.group(0)); + System.out.println(matcher.group(1)); + System.out.println(matcher.group(2)); + System.out.println(matcher.group(3)); + } + +} diff --git a/tools/rewrite-log-entries/src/main/java/org/oceandsl/log/rewriter/RewriteBeforeAndAfterEventsStage.java b/tools/rewrite-log-entries/src/main/java/org/oceandsl/log/rewriter/RewriteBeforeAndAfterEventsStage.java new file mode 100644 index 0000000000000000000000000000000000000000..a2da28c0d485ff3c008ea2db37225494c92077fb --- /dev/null +++ b/tools/rewrite-log-entries/src/main/java/org/oceandsl/log/rewriter/RewriteBeforeAndAfterEventsStage.java @@ -0,0 +1,117 @@ +/** + * + */ +package org.oceandsl.log.rewriter; + +import java.io.BufferedReader; +import java.io.File; +import java.io.IOException; +import java.io.InputStreamReader; +import java.util.HashMap; +import java.util.Map; +import java.util.function.Consumer; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import kieker.common.record.IMonitoringRecord; +import kieker.common.record.flow.trace.operation.AfterOperationEvent; +import kieker.common.record.flow.trace.operation.BeforeOperationEvent; +import teetime.framework.AbstractConsumerStage; +import teetime.framework.OutputPort; + +/** + * @author reiner + * + */ +public class RewriteBeforeAndAfterEventsStage extends AbstractConsumerStage<IMonitoringRecord> { + + private OutputPort<IMonitoringRecord> outputPort = this.createOutputPort(IMonitoringRecord.class); + + private File addrlineExecutable; + private Map<String,AddrOutput> addressMap = new HashMap<String,AddrOutput>(); + private File modelExecutable; + + public RewriteBeforeAndAfterEventsStage(File addrLineExecutable, File modelExecutable) { + this.addrlineExecutable = addrLineExecutable; + this.modelExecutable = modelExecutable; + } + + @Override + protected void execute(IMonitoringRecord element) throws Exception { + if (element instanceof BeforeOperationEvent) { + BeforeOperationEvent before = (BeforeOperationEvent)element; + AddrOutput rewriteInfo = findRewriteInfo(before.getOperationSignature()); + this.outputPort.send(new BeforeOperationEvent(before.getTimestamp(), before.getTraceId(), before.getOrderIndex(), + rewriteInfo.name,"COMPONENT")); + } else if (element instanceof AfterOperationEvent) { + AfterOperationEvent before = (AfterOperationEvent)element; + AddrOutput rewriteInfo = findRewriteInfo(before.getOperationSignature()); + this.outputPort.send(new AfterOperationEvent(before.getTimestamp(), before.getTraceId(), before.getOrderIndex(), + rewriteInfo.name,"COMPONENT")); + } else + this.outputPort.send(element); + } + + private AddrOutput findRewriteInfo(String address) throws IOException, InterruptedException { + AddrOutput addrOutput = addressMap.get(address); + if (addrOutput == null) { + Process process = Runtime.getRuntime().exec(String.format("%s -e %s -p -C -f %s", + this.addrlineExecutable.getCanonicalPath(), + this.modelExecutable, address)); + process.waitFor(); + new BufferedReader(new InputStreamReader(process.getErrorStream())).lines().forEach(new Consumer<String>() { + @Override + public void accept(String arg0) { + System.err.println(arg0); + } + }); + + new BufferedReader(new InputStreamReader(process.getInputStream())).lines().forEach(new Consumer<String>() { + + final Pattern pattern = Pattern.compile("^(\\w+) at ([\\w\\?/\\.\\-]+):([\\d\\?]*)$"); + + @Override + public void accept(String string) { + Matcher matcher = this.pattern.matcher(string); + if (matcher.find()) { + Integer linenumber = matcher.group(3).equals("?")?null:Integer.parseInt(matcher.group(3)); + addressMap.put(address,new AddrOutput(matcher.group(1), matcher.group(2), linenumber)); + } + } + + }); + return addressMap.get(address); + } else + return addrOutput; + } + + class AddrOutput { + + private final String name; + private final String filename; + private final Integer linenumber; + + public AddrOutput(String name, String filename, Integer linenumber) { + this.name = name; + this.filename = filename; + this.linenumber = linenumber; + } + + public String getName() { + return name; + } + + public String getFilename() { + return filename; + } + + public Integer getLinenumber() { + return linenumber; + } + } + + public OutputPort getOutputPort() { + return this.outputPort; + } + +} diff --git a/tools/rewrite-log-entries/src/main/java/org/oceandsl/log/rewriter/TeetimeConfiguration.java b/tools/rewrite-log-entries/src/main/java/org/oceandsl/log/rewriter/TeetimeConfiguration.java new file mode 100644 index 0000000000000000000000000000000000000000..c086926d10711bdba85e724621fa2d37918fe071 --- /dev/null +++ b/tools/rewrite-log-entries/src/main/java/org/oceandsl/log/rewriter/TeetimeConfiguration.java @@ -0,0 +1,70 @@ +/** + * + */ +package org.oceandsl.log.rewriter; + +import java.io.IOException; + +import kieker.analysis.sink.DataSinkStage; +import kieker.tools.source.LogsReaderCompositeStage; +import teetime.framework.Configuration; + +/** + * @author reiner + * + */ +public class TeetimeConfiguration extends Configuration { + + public TeetimeConfiguration(LogRewriterSettings parameterConfiguration) throws IOException { + + kieker.common.configuration.Configuration configuration = new kieker.common.configuration.Configuration(); + configuration.setProperty(LogsReaderCompositeStage.LOG_DIRECTORIES, + parameterConfiguration.getInputFile().getCanonicalPath()); + configuration.setProperty("kieker.monitoring.name", "KIEKER"); + configuration.setProperty("kieker.monitoring.enabled","true"); + configuration.setProperty("kieker.monitoring.initialExperimentId","transcoded"); + configuration.setProperty("kieker.monitoring.metadata","true"); + configuration.setProperty("kieker.monitoring.setLoggingTimestamp","true"); + configuration.setProperty("kieker.monitoring.useShutdownHook","true"); + configuration.setProperty("kieker.monitoring.jmx","false"); + + configuration.setProperty("kieker.monitoring.timer", + kieker.monitoring.timer.SystemNanoTimer.class.getCanonicalName()); + configuration.setProperty("kieker.monitoring.timer.SystemMilliTimer.unit","0"); + configuration.setProperty("kieker.monitoring.timer.SystemNanoTimer.unit","0"); + configuration.setProperty("kieker.monitoring.writer", + kieker.monitoring.writer.filesystem.FileWriter.class.getCanonicalName()); + configuration.setProperty("kieker.monitoring.core.controller.WriterController.RecordQueueFQN", + org.jctools.queues.MpscArrayQueue.class.getCanonicalName()); + configuration.setProperty("kieker.monitoring.core.controller.WriterController.RecordQueueSize","10000"); + configuration.setProperty("kieker.monitoring.core.controller.WriterController.RecordQueueInsertBehavior","1"); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.customStoragePath",parameterConfiguration.getOutputFile().getCanonicalPath()); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.charsetName","UTF-8"); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.maxEntriesInFile","25000"); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.maxLogSize","-1"); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.maxLogFiles","-1"); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.mapFileHandler", + kieker.monitoring.writer.filesystem.TextMapFileHandler.class.getCanonicalName()); + configuration.setProperty("kieker.monitoring.writer.filesystem.TextMapFileHandler.flush","true"); + configuration.setProperty("kieker.monitoring.writer.filesystem.TextMapFileHandler.compression", + kieker.monitoring.writer.compression.NoneCompressionFilter.class.getCanonicalName()); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.logFilePoolHandler", + kieker.monitoring.writer.filesystem.RotatingLogFilePoolHandler.class.getCanonicalName()); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.logStreamHandler", + kieker.monitoring.writer.filesystem.TextLogStreamHandler.class.getCanonicalName()); + configuration.setProperty("kieker.monitoring.writer.filesystem.FileWriter.flush","true"); + configuration.setProperty("kieker.monitoring.writer.filesystem.BinaryFileWriter.bufferSize","8192"); + configuration.setProperty("kieker.monitoring.writer.filesystem.BinaryFileWriter.compression", + kieker.monitoring.writer.compression.NoneCompressionFilter.class.getCanonicalName()); + + LogsReaderCompositeStage reader = new LogsReaderCompositeStage(configuration); + + RewriteBeforeAndAfterEventsStage processor = new RewriteBeforeAndAfterEventsStage(parameterConfiguration.getAddrlineExecutable(), + parameterConfiguration.getModelExecutable()); + + DataSinkStage writer = new DataSinkStage(configuration); + + this.connectPorts(reader.getOutputPort(), processor.getInputPort()); + this.connectPorts(processor.getOutputPort(), writer.getInputPort()); + } +}