Feature/trace master merge

org.emoflon.gips.build/META-INF/MANIFEST.MF

@@ -16,6 +16,8 @@ Require-Bundle: org.emoflon.gips.intermediate;bundle-version="1.5.0",
  org.emoflon.ibex.gt,
  org.moflon.core.plugins,
  org.emoflon.gips.core.dependencies,
+ org.emoflon.gips.debugger.trace,
+ org.emoflon.gips.debugger,
  org.junit,
  junit-jupiter-api
 Bundle-Vendor: Real-Time Systems Lab - TU Darmstadt

org.emoflon.gips.build/src/org/emoflon/gips/build/GipsBuilderUtils.java

@@ -16,6 +16,7 @@
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.resources.IResource;
 import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.NullProgressMonitor;
 import org.eclipse.emf.common.util.URI;
 import org.eclipse.emf.ecore.EObject;
@@ -29,6 +30,13 @@
 import org.eclipse.emf.ecore.xmi.XMLResource;
 import org.eclipse.emf.ecore.xmi.impl.XMIResourceFactoryImpl;
 import org.emoflon.gips.build.generator.GipsImportManager;
+import org.emoflon.gips.build.transformation.GipsToIntermediate;
+import org.emoflon.gips.debugger.api.ITraceContext;
+import org.emoflon.gips.debugger.api.ITraceManager;
+import org.emoflon.gips.debugger.trace.TraceMap;
+import org.emoflon.gips.debugger.trace.TraceModelLink;
+import org.emoflon.gips.debugger.trace.resolver.ResolveEcore2Id;
+import org.emoflon.gips.debugger.utility.HelperEclipse;
 import org.emoflon.gips.intermediate.GipsIntermediate.GipsIntermediateModel;
 import org.emoflon.gips.intermediate.GipsIntermediate.TypeConstraint;
 import org.emoflon.ibex.gt.codegen.EClassifiersManager;
@@ -151,7 +159,7 @@ public static URI saveResource(EObject object, String path) {
 		saveOptions.put(XMLResource.OPTION_SAVE_TYPE_INFORMATION, Boolean.TRUE);
 		saveOptions.put(XMLResource.OPTION_SCHEMA_LOCATION_IMPLEMENTATION, Boolean.TRUE);
 		try {
-			((XMIResource) output).save(saveOptions);
+			output.save(saveOptions);
 		} catch (IOException e) {
 			e.printStackTrace();
 		}
@@ -292,6 +300,49 @@ public static void generateEMoflonAPI(final IProject project, final GipsAPIData
 		});
 	}
 
+	/**
+	 * Updates the project specific model transformation trace
+	 * 
+	 * @param project              used to determine the project to be update
+	 * @param gipslModelURI        used to generate an id for the gipsl model
+	 * @param intermediateModelURI used to generate an id the intermediate model
+	 * @param transformer          Provides the gipsl-intermediate trace
+	 */
+	public static void updateTrace(final IProject project, final URI gipslModelURI, final URI intermediateModelURI,
+			final GipsToIntermediate transformer) {
+
+		// each project has it's own trace.
+		ITraceContext traceContext = ITraceManager.getInstance().getContext(project.getName());
+
+		try {
+			// adjust file extension from xmi to gipsl
+			URI gipslURI = HelperEclipse.toPlatformURI(gipslModelURI.trimFileExtension().appendFileExtension("gipsl"));
+			// first segment of an URI is the project name, by removing it we get a
+			// project relative path
+			IPath gipslPath = IPath.fromOSString(gipslURI.toPlatformString(true)).makeRelative().removeFirstSegments(1);
+
+			URI intermediateURI = HelperEclipse.toPlatformURI(intermediateModelURI);
+			// FIXME: the intermediate URI isn't a valid URI. The first segment is not the
+			// project name.
+			IPath intermediatePath = IPath.fromOSString(intermediateURI.toPlatformString(true)).makeRelative();
+
+			String gipslModelId = gipslPath.toString(); // gipslModelURI.trimFileExtension().lastSegment();
+			String intermediateModelId = intermediatePath.toString(); // intermediateModelURI.trimFileExtension().lastSegment();
+
+			if (gipslModelId.equalsIgnoreCase(intermediateModelId))
+				throw new IllegalArgumentException(
+						"GIPSL and Intermediate model id should not be equal: '" + gipslModelId + "'");
+
+			TraceMap<String, String> gipsl2intermediateMppings = TraceMap.normalize(transformer.getTrace(),
+					ResolveEcore2Id.INSTANCE, ResolveEcore2Id.INSTANCE);
+
+			traceContext
+					.updateTraceModel(new TraceModelLink(gipslModelId, intermediateModelId, gipsl2intermediateMppings));
+		} catch (Exception e) {
+			e.printStackTrace();
+		}
+	}
+
 	/**
 	 * Gets the class name prefix for a given project
 	 *

org.emoflon.gips.build/src/org/emoflon/gips/build/GipsProjectBuilder.java

@@ -73,6 +73,10 @@ public void build(IProject project, Resource resource) {
 		GipsBuilderUtils.saveResource(model, gipsApiData.apiPackageFolder.getLocation() + "/gips/gips-model.xmi");
 		gipsApiData.intermediateModelURI = URI.createPlatformResourceURI(
 				gipsApiData.apiPackageFolder.getProjectRelativePath() + "/gips/gips-model.xmi", true);
+		// FIXME; createPlatformResourceURI requires a path of the form
+		// "/project-name/path", but getProjectRelativePath() does not include
+		// "project-name"
+		// TODO: See if this can be easily fixed.
 
 		// build HiPE engine code
 		if (ibexModel != null && !ibexModel.getPatternSet().getContextPatterns().isEmpty()) {
@@ -99,6 +103,12 @@ public void build(IProject project, Resource resource) {
 		// generate files
 		GipsCodeGenerator gipsGen = new GipsCodeGenerator(model, gipsApiData, manager);
 		gipsGen.generate();
+
+		// update gipsl->intermediate tracing
+		LogUtils.info(logger, "GipsProjectBuilder: update trace...");
+		GipsBuilderUtils.updateTrace(project, gipsSlangFile.eResource().getURI(), gipsApiData.intermediateModelURI,
+				transformer);
+
 		LogUtils.info(logger, "GipsProjectBuilder: Done!");
 
 		try {
@@ -108,5 +118,4 @@ public void build(IProject project, Resource resource) {
 			e.printStackTrace();
 		}
 	}
-
 }

org.emoflon.gips.build/src/org/emoflon/gips/build/transformation/GipsToIntermediate.java

@@ -17,6 +17,7 @@
 import org.emoflon.gips.build.transformation.transformer.ArithmeticExpressionTransformer;
 import org.emoflon.gips.build.transformation.transformer.BooleanExpressionTransformer;
 import org.emoflon.gips.build.transformation.transformer.TransformerFactory;
+import org.emoflon.gips.debugger.trace.TraceMap;
 import org.emoflon.gips.gipsl.gipsl.EditorGTFile;
 import org.emoflon.gips.gipsl.gipsl.GipsArithmeticExpression;
 import org.emoflon.gips.gipsl.gipsl.GipsBooleanExpression;
@@ -76,6 +77,7 @@ public class GipsToIntermediate {
 	protected GipsIntermediateFactory factory = GipsIntermediateFactory.eINSTANCE;
 	final protected GipsTransformationData data;
 	final protected TransformerFactory transformationFactory;
+	final private TraceMap<EObject, EObject> gipsl2gipsTrace = new TraceMap<>();
 	protected int constraintCounter = 0;
 
 	public GipsToIntermediate(final EditorGTFile gipslFile) {
@@ -131,6 +133,10 @@ public GipsIntermediateModel transform() throws Exception {
 		return data.model();
 	}
 
+	public TraceMap<EObject, EObject> getTrace() {
+		return gipsl2gipsTrace;
+	}
+
 	protected void preprocessGipslFile() {
 		EditorToIBeXPatternTransformation ibexTransformer = new EditorToIBeXPatternTransformation();
 		data.model().setIbexModel(ibexTransformer.transform(data.gipslFile()));
@@ -218,6 +224,7 @@ protected void transformConfig() {
 		}
 
 		data.model().setConfig(config);
+		gipsl2gipsTrace.map(eConfig, config);
 	}
 
 	protected void transformMappings() {
@@ -254,6 +261,7 @@ protected void transformMappings() {
 
 			data.model().getMappings().add(mapping);
 			data.eMapping2Mapping().put(eMapping, mapping);
+			gipsl2gipsTrace.map(eMapping, mapping);
 		});
 	}
 
@@ -286,6 +294,7 @@ protected void transformMappingVariables(GipsMapping mapping, RuleMapping ruleMa
 				ruleMapping.getBoundVariables().add(var);
 				data.model().getVariables().add(var);
 				data.eVariable2Variable().put(gipsVar, var);
+				gipsl2gipsTrace.map(gipsVar, var);
 			} else {
 				Variable var = factory.createVariable();
 				var.setType(GipsTransformationUtils.typeToVariableType(gipsVar.getType()));
@@ -295,6 +304,7 @@ protected void transformMappingVariables(GipsMapping mapping, RuleMapping ruleMa
 				ruleMapping.getFreeVariables().add(var);
 				data.model().getVariables().add(var);
 				data.eVariable2Variable().put(gipsVar, var);
+				gipsl2gipsTrace.map(gipsVar, var);
 			}
 		}
 	}
@@ -312,6 +322,7 @@ protected void transformMappingVariables(GipsMapping mapping, PatternMapping pat
 			patternMapping.getFreeVariables().add(var);
 			data.model().getVariables().add(var);
 			data.eVariable2Variable().put(gipsVar, var);
+			gipsl2gipsTrace.map(gipsVar, var);
 		}
 	}
 
@@ -350,6 +361,7 @@ protected void transformConstraints() throws Exception {
 				case DISJUNCTION_OF_LITERALS -> {
 					Constraint disjunction = createDisjunctConstraint(eSubConstraint, constraintCounter);
 					data.model().getConstraints().add(disjunction);
+					gipsl2gipsTrace.map(eConstraint, disjunction);
 					constraintCounter++;
 
 					Map<GipsConstraint, Collection<Constraint>> transformed = new HashMap<>();
@@ -363,6 +375,7 @@ protected void transformConstraints() throws Exception {
 								symbolicVariable);
 						constraints.forEach(c -> c.setSymbolicVariable(symbolicVariable));
 						transformed.put(subConstraint, constraints);
+						gipsl2gipsTrace.mapOneToMany(eConstraint, constraints);
 						disjunction.getDependencies().addAll(constraints);
 					}
 
@@ -442,12 +455,17 @@ protected void transformConstraints() throws Exception {
 
 					substituteRelation.setLhs(substituteSum);
 					disjunction.setExpression(substituteRelation);
+					gipsl2gipsTrace.map(eConstraint.getExpression(), disjunction.getExpression());
 				}
 				case LITERAL -> {
-					transformConstraint(eSubConstraint.result().values().iterator().next(), false, null);
+					Collection<Constraint> constraints = transformConstraint(
+							eSubConstraint.result().values().iterator().next(), false, null);
+					gipsl2gipsTrace.mapOneToMany(eConstraint, constraints);
 				}
 				case NEGATED_LITERAL -> {
-					transformConstraint(eSubConstraint.result().values().iterator().next(), true, null);
+					Collection<Constraint> constraints = transformConstraint(
+							eSubConstraint.result().values().iterator().next(), true, null);
+					gipsl2gipsTrace.mapOneToMany(eConstraint, constraints);
 				}
 				default -> {
 					throw new IllegalArgumentException("Unknown constraint annotation type.");
@@ -519,6 +537,7 @@ protected void transformLinearFunctions() throws Exception {
 			LinearFunction linearFunction = createLinearFunction(eLinearFunction);
 			data.model().getFunctions().add(linearFunction);
 			data.eFunction2Function().put(eLinearFunction, linearFunction);
+			gipsl2gipsTrace.map(eLinearFunction, linearFunction);
 
 			// Create all constants
 			if (eLinearFunction.getConstants() != null && !eLinearFunction.getConstants().isEmpty()) {
@@ -543,6 +562,7 @@ protected void transformLinearFunctions() throws Exception {
 			// of products.
 			linearFunction.setExpression(
 					new GipsArithmeticTransformer(factory).normalizeAndExpand(linearFunction.getExpression()));
+					gipsl2gipsTrace.map(eLinearFunction.getExpression(), linearFunction.getExpression());
 		}
 	}
 
@@ -554,6 +574,7 @@ protected void transformObjective() throws Exception {
 
 		Objective objective = factory.createObjective();
 		data.model().setObjective(objective);
+		gipsl2gipsTrace.map(eObjective, objective);
 
 		// Create all constants
 		if (eObjective.getConstants() != null && !eObjective.getConstants().isEmpty()) {
@@ -588,6 +609,7 @@ protected void transformObjective() throws Exception {
 		// Rewrite the expression, which will be translated into ILP-Terms, into a sum
 		// of products.
 		objective.setExpression(new GipsArithmeticTransformer(factory).normalizeAndExpand(objective.getExpression()));
+		gipsl2gipsTrace.map(eObjective.getExpression(), objective.getExpression());
 	}
 
 	protected Constraint createConstraint(final GipsConstraint eConstraint, int counter) {
@@ -782,6 +804,7 @@ protected void mapGT2IBeXElements() {
 			for (IBeXRule rule : data.model().getIbexModel().getRuleSet().getRules()) {
 				if (rule.getName().equals(ePattern.getName())) {
 					data.addRule(ePattern, rule);
+					gipsl2gipsTrace.map(ePattern, rule);
 				}
 			}
 		}
@@ -795,10 +818,12 @@ protected void mapGT2IBeXElements() {
 			for (IBeXContext pattern : data.model().getIbexModel().getPatternSet().getContextPatterns()) {
 				if (pattern.getName().equals(ePattern.getName())) {
 					data.addPattern(ePattern, pattern);
+					gipsl2gipsTrace.map(ePattern, pattern);
 					for (EditorNode eNode : ePattern.getNodes()) {
 						for (IBeXNode node : toContextPattern(pattern).getSignatureNodes()) {
 							if (eNode.getName().equals(node.getName())) {
 								data.eNode2Node().putIfAbsent(eNode, node);
+								gipsl2gipsTrace.map(eNode, node);
 							}
 						}
 					}

org.emoflon.gips.core/META-INF/MANIFEST.MF

@@ -7,8 +7,9 @@ Automatic-Module-Name: org.emoflon.gips.core
 Bundle-RequiredExecutionEnvironment: JavaSE-21
 Require-Bundle: org.emoflon.ibex.gt;visibility:=reexport,
  org.emoflon.gips.intermediate;visibility:=reexport,
- org.emoflon.gips.core.dependencies;visibility:=reexport,
- org.emoflon.gips.build
+ org.emoflon.gips.core.dependencies;bundle-version="1.0.0";visibility:=reexport,
+ org.emoflon.gips.build,
+ org.emoflon.gips.debugger;bundle-version="[1.0.0,2.0.0)";visibility:=reexport
 Export-Package: org.emoflon.gips.core,
  org.emoflon.gips.core.api,
  org.emoflon.gips.core.gt,

org.emoflon.gips.core/src/org/emoflon/gips/core/GipsEngine.java

@@ -8,9 +8,13 @@
 import org.emoflon.gips.core.milp.Solver;
 import org.emoflon.gips.core.milp.SolverOutput;
 import org.emoflon.gips.core.milp.SolverStatus;
+import org.emoflon.gips.core.milp.model.Constraint;
+import org.emoflon.gips.core.milp.model.Term;
 import org.emoflon.gips.core.milp.model.Variable;
 import org.emoflon.gips.core.util.Observer;
 import org.emoflon.gips.core.validation.GipsConstraintValidationLog;
+import org.emoflon.gips.debugger.api.ILPTraceKeywords;
+import org.emoflon.gips.debugger.api.Intermediate2IlpTracer;
 
 public abstract class GipsEngine {
 
@@ -24,6 +28,7 @@ public abstract class GipsEngine {
 	final protected Map<String, GipsLinearFunction<?, ?, ?>> functions = Collections.synchronizedMap(new HashMap<>());
 	protected GipsObjective objective;
 	protected Solver solver;
+	final protected Intermediate2IlpTracer tracer = new Intermediate2IlpTracer();
 
 	public abstract void update();
 
@@ -108,6 +113,52 @@ public void buildProblem(boolean doUpdate) {
 			objective.buildObjectiveFunction();
 
 		solver.buildILPProblem();
+		buildTracingTree();
+	}
+
+	protected void buildTracingTree() {
+		Intermediate2IlpTracer tracer = getTracer();
+		if (!tracer.isTracingEnabled())
+			return;
+
+		// try to build a bridge between ILP model and ILP text file
+
+		for (GipsMapper<?> mapper : this.mappers.values()) {
+			tracer.map(mapper.mapping,
+					ILPTraceKeywords.buildElementId(ILPTraceKeywords.TYPE_MAPPING, mapper.getName()));
+//			final var fragmentPath = EcoreUtil.getURI(mapper.mapping);
+		}
+
+		for (GipsConstraint<?, ?, ?> constraint : this.constraints.values()) {
+			tracer.map(constraint.constraint,
+					ILPTraceKeywords.buildElementId(ILPTraceKeywords.TYPE_CONSTRAINT, constraint.getName()));
+			for (Constraint ilpConstraint : constraint.getConstraints()) {
+				for (Term ilpTerm : ilpConstraint.lhsTerms()) {
+					tracer.map(constraint.constraint.getExpression(), ILPTraceKeywords
+							.buildElementId(ILPTraceKeywords.TYPE_CONSTRAINT_VAR, ilpTerm.variable().getName()));
+				}
+			}
+
+			for (Variable<?> variables : constraint.getAdditionalVariables()) {
+				tracer.map(constraint.constraint.getExpression(),
+						ILPTraceKeywords.buildElementId(ILPTraceKeywords.TYPE_CONSTRAINT_VAR, variables.getName()));
+			}
+		}
+
+		for (GipsLinearFunction<?, ?, ?> function : this.functions.values()) {
+			tracer.map(function.linearFunction,
+					ILPTraceKeywords.buildElementId(ILPTraceKeywords.TYPE_FUNCTION, function.getName()));
+			for (Term term : function.terms) {
+				tracer.map(function.linearFunction,
+						ILPTraceKeywords.buildElementId(ILPTraceKeywords.TYPE_FUNCTION_VAR, term.variable().getName()));
+			}
+		}
+
+		if (objective != null) {
+			tracer.map(objective.objective, ILPTraceKeywords.buildElementId(ILPTraceKeywords.TYPE_OBJECTIVE, ""));
+		}
+
+		tracer.postTraceToRMIService();
 	}
 
 	public SolverOutput solveProblemTimed() {
@@ -233,4 +284,8 @@ protected void setObjective(final GipsObjective objective) {
 	public void setSolver(final Solver solver) {
 		this.solver = solver;
 	}
+
+	public Intermediate2IlpTracer getTracer() {
+		return this.tracer;
+	}
 }

org.emoflon.gips.core/src/org/emoflon/gips/core/api/GipsEngineAPI.java

@@ -167,6 +167,7 @@ public ResourceSet getResourceSet() {
 	 * Terminates the GipsEngine (super class) and the eMoflon::IBeX engine
 	 * (including the pattern matcher).
 	 */
+	@Override
 	public void terminate() {
 		// Terminate the GipsEngine
 		super.terminate();
@@ -292,6 +293,7 @@ private void initInternalCommon(final URI gipsModelURI) {
 		initTypeIndexer();
 		validationLog = new GipsConstraintValidationLog();
 		setSolverConfig(gipsModel.getConfig());
+		initTracer();
 		initMapperFactory();
 		createMappers();
 		initConstraintFactory();
@@ -327,6 +329,11 @@ protected void loadIntermediateModel(final URI gipsModelURI) {
 		gipsModel.getMappings().forEach(mapping -> name2Mapping.put(mapping.getName(), mapping));
 	}
 
+	protected void initTracer() {
+		tracer.computeGipsModelId(gipsModel.eResource().getURI());
+		tracer.computeLpModelId(gipsModel.getConfig().getLpPath());
+	}
+
 	protected abstract void createMappers();
 
 	protected void createConstraints() {