1 package org.simantics.scl.compiler.elaboration.chr;
3 import java.util.ArrayList;
5 import org.cojen.classfile.TypeDesc;
6 import org.simantics.scl.compiler.compilation.CompilationContext;
7 import org.simantics.scl.compiler.constants.BooleanConstant;
8 import org.simantics.scl.compiler.constants.Constant;
9 import org.simantics.scl.compiler.constants.IntegerConstant;
10 import org.simantics.scl.compiler.constants.JavaConstructor;
11 import org.simantics.scl.compiler.constants.JavaMethod;
12 import org.simantics.scl.compiler.constants.NoRepConstant;
13 import org.simantics.scl.compiler.constants.generic.CallJava;
14 import org.simantics.scl.compiler.constants.generic.MethodRef.FieldRef;
15 import org.simantics.scl.compiler.constants.generic.MethodRef.ObjectMethodRef;
16 import org.simantics.scl.compiler.constants.generic.MethodRef.SetFieldRef;
17 import org.simantics.scl.compiler.elaboration.chr.analysis.CHRConstraintGGInfo;
18 import org.simantics.scl.compiler.elaboration.chr.analysis.UsageAnalysis;
19 import org.simantics.scl.compiler.elaboration.chr.plan.CHRSearchPlan;
20 import org.simantics.scl.compiler.elaboration.chr.plan.PlanRealizer;
21 import org.simantics.scl.compiler.elaboration.chr.relations.CHRConstraint;
22 import org.simantics.scl.compiler.elaboration.contexts.SimplificationContext;
23 import org.simantics.scl.compiler.elaboration.contexts.TranslationContext;
24 import org.simantics.scl.compiler.elaboration.contexts.TypingContext;
25 import org.simantics.scl.compiler.elaboration.expressions.Variable;
26 import org.simantics.scl.compiler.elaboration.expressions.block.IncludeStatement;
27 import org.simantics.scl.compiler.environment.AmbiguousNameException;
28 import org.simantics.scl.compiler.errors.Locations;
29 import org.simantics.scl.compiler.internal.codegen.chr.CHRCodeGenerationConstants;
30 import org.simantics.scl.compiler.internal.codegen.chr.CHRRuntimeRulesetCodeGenerator;
31 import org.simantics.scl.compiler.internal.codegen.references.BoundVar;
32 import org.simantics.scl.compiler.internal.codegen.references.IVal;
33 import org.simantics.scl.compiler.internal.codegen.ssa.SSAFunction;
34 import org.simantics.scl.compiler.internal.codegen.types.StandardTypeConstructor;
35 import org.simantics.scl.compiler.internal.codegen.utils.Constants;
36 import org.simantics.scl.compiler.internal.codegen.writer.CodeWriter;
37 import org.simantics.scl.compiler.internal.parsing.Symbol;
38 import org.simantics.scl.compiler.types.TCon;
39 import org.simantics.scl.compiler.types.TVar;
40 import org.simantics.scl.compiler.types.Type;
41 import org.simantics.scl.compiler.types.Types;
43 import gnu.trove.map.hash.THashMap;
44 import gnu.trove.map.hash.TObjectIntHashMap;
45 import gnu.trove.set.hash.THashSet;
46 import gnu.trove.set.hash.TIntHashSet;
48 public class CHRRuleset extends Symbol {
50 public static final String INIT_CONSTRAINT = "__INIT__";
52 public ArrayList<CHRConstraint> constraints = new ArrayList<CHRConstraint>();
53 public ArrayList<CHRRule> rules = new ArrayList<CHRRule>();
54 public ArrayList<IncludeStatement> includes = new ArrayList<IncludeStatement>();
55 public THashMap<CHRConstraint, IncludeStatement> constraintSourceMap = new THashMap<CHRConstraint, IncludeStatement>();
56 public THashMap<CHRConstraint, CHRConstraintGGInfo> activeConstraintGGInfo = new THashMap<CHRConstraint, CHRConstraintGGInfo>(); // contains also imported constraints
57 public THashMap<IncludeStatement, ArrayList<CHRConstraint>> inverseActiveConstraintSourceMap = new THashMap<IncludeStatement, ArrayList<CHRConstraint>>();
59 public boolean extensible;
61 public CHRConstraint initConstraint;
62 public int priorityCount;
64 public int initialPriorityNumber = 0;
66 public String runtimeRulesetClassName;
67 public TCon runtimeRulesetType;
68 public BoundVar runtimeRulesetVariable;
69 public TypeDesc runtimeRulesetTypeDesc;
71 public static final Constant READ_CURRENT_ID = new CallJava(TVar.EMPTY_ARRAY, Types.PROC, Types.INTEGER, new Type[] {Types.CHRContext},
72 null, new FieldRef(CHRCodeGenerationConstants.CHRContext_name, "currentId", CHRRuntimeRulesetCodeGenerator.FACT_ID_TYPE), null);
73 public static final Constant WRITE_CURRENT_ID = new CallJava(TVar.EMPTY_ARRAY, Types.PROC, Types.UNIT, new Type[] {Types.CHRContext, Types.INTEGER},
74 null, new SetFieldRef(CHRCodeGenerationConstants.CHRContext_name, "currentId", CHRRuntimeRulesetCodeGenerator.FACT_ID_TYPE), null);
75 public static final Constant GENERATE_ID = new CallJava(TVar.EMPTY_ARRAY, Types.PROC, Types.INTEGER, new Type[] {Types.CHRContext},
76 null, new ObjectMethodRef(false, CHRCodeGenerationConstants.CHRContext_name, "generateId", CHRRuntimeRulesetCodeGenerator.FACT_ID_TYPE, Constants.EMPTY_TYPEDESC_ARRAY), null);
78 // FIXME remove and change the parameter of Expression.toVal
79 private CompilationContext cachedContext;
81 // For code generation
82 public CHRRulesetObject rulesetObject;
83 public SSAFunction initializer;
84 public SSAFunction deinitializer;
87 initConstraint = new CHRConstraint(Locations.NO_LOCATION, INIT_CONSTRAINT, Type.EMPTY_ARRAY);
88 constraints.add(initConstraint);
91 public void resolve(TranslationContext context) {
92 boolean failedIncludes = false;
93 for(IncludeStatement include : includes) {
95 include.ruleset = context.resolveRuleset(include.name.text);
96 if(include.ruleset == null) {
97 failedIncludes = true;
98 context.getErrorLog().log(include.name.location, "Couldn't resolve ruleset " + include.name + ".");
101 include.value = include.value.resolve(context);
102 for(CHRConstraint constraint : include.ruleset.constraints) {
103 context.newCHRConstraint(constraint.name, constraint);
104 constraintSourceMap.put(constraint, include);
106 } catch (AmbiguousNameException e) {
107 failedIncludes = true;
108 context.getErrorLog().log(include.name.location, e.getMessage());
113 for(CHRConstraint constraint : constraints)
114 context.newCHRConstraint(constraint.name, constraint);
116 for(CHRRule rule : rules) {
117 rule.resolve(context);
118 rule.priority = priorityCount++;
120 /*for(CHRConstraint constraint : constraints) {
121 Variable newVariable = context.newVariable("claim" + constraint.factClassName);
125 public void checkType(TypingContext context) {
126 for(IncludeStatement include : includes)
127 include.value = include.value.checkType(context, include.ruleset.runtimeRulesetType);
128 for(CHRRule rule : rules)
129 rule.checkType(context);
132 public void collectVars(TObjectIntHashMap<Variable> allVars, TIntHashSet vars) {
133 for(IncludeStatement include : includes)
134 include.value.collectVars(allVars, vars);
135 for(CHRRule rule : rules)
136 rule.collectVars(allVars, vars);
139 public void setLocationDeep(long loc) {
140 if(location == Locations.NO_LOCATION) {
142 for(CHRRule rule : rules)
143 rule.setLocationDeep(loc);
147 public int getMinimumPriority(CHRConstraint constraint) {
148 CHRConstraintGGInfo info = activeConstraintGGInfo.get(constraint);
150 return Integer.MAX_VALUE;
152 return info.minimumPriority;
155 public int getAndUpdateNextPriority(CHRConstraint constraint, int nextPriority) {
156 CHRConstraintGGInfo info = activeConstraintGGInfo.get(constraint);
158 return Integer.MAX_VALUE;
160 int result = info.nextPriority;
161 info.nextPriority = nextPriority;
166 public void compile(SimplificationContext context) {
167 initializeCodeGeneration(context.getCompilationContext());
169 applyExtensibleDefaults();
170 UsageAnalysis.analyzeUsage(this);
171 for(CHRRule rule : rules) {
172 rule.compile(context.getCompilationContext(), initConstraint);
173 for(CHRSearchPlan plan : rule.plans) {
174 CHRConstraint constraint = plan.constraint;
175 if(!activeConstraintGGInfo.containsKey(constraint)) {
176 activeConstraintGGInfo.put(constraint, new CHRConstraintGGInfo(rule.priority));
177 IncludeStatement include = constraintSourceMap.get(constraint);
178 if(include != null) {
179 ArrayList<CHRConstraint> list = inverseActiveConstraintSourceMap.get(include);
181 list = new ArrayList<CHRConstraint>(4);
182 inverseActiveConstraintSourceMap.put(include, list);
184 list.add(constraint);
189 // remove init constraint if it is not useful
190 if(getMinimumPriority(initConstraint) == Integer.MAX_VALUE) {
191 constraints.remove(0);
192 initConstraint = null;
196 private void applyExtensibleDefaults() {
197 for(CHRConstraint constraint : constraints) {
198 // FIXME Too much indexing!!!
199 int max = 1 << constraint.parameterTypes.length;
200 for(int i=0;i<max;++i)
201 constraint.getOrCreateIndex(cachedContext, i);
202 constraint.setMayBeRemoved();
204 constraint.getOrCreateIndex(cachedContext, 0);
205 if(constraint.parameterTypes.length > 0)
206 constraint.getOrCreateIndex(cachedContext, 1);*/
210 public void simplify(SimplificationContext context) {
211 for(IncludeStatement include : includes)
212 include.value = include.value.simplify(context);
213 for(CHRRule rule : rules)
214 rule.simplify(context);
217 public void setRulesetType(TCon type, String className) {
218 this.runtimeRulesetType = type;
219 this.runtimeRulesetClassName = className;
222 public void initializeCodeGeneration(CompilationContext context) {
223 cachedContext = context; // FIXME remove
225 boolean createTypeDesc = false;
226 if(runtimeRulesetType == null) {
227 String suffix = context.namingPolicy.getFreshClosureClassNameSuffix();
228 setRulesetType(Types.con(context.namingPolicy.getModuleName(), "CHR" + suffix), context.namingPolicy.getModuleClassName() + suffix);
229 createTypeDesc = true;
231 runtimeRulesetTypeDesc = TypeDesc.forClass(runtimeRulesetClassName);
232 runtimeRulesetVariable = new BoundVar(runtimeRulesetType);
233 for(CHRConstraint constraint : constraints)
234 constraint.initializeCodeGeneration(context, this);
235 if(createTypeDesc && context.module != null) // for unit testing
236 context.module.addTypeDescriptor(runtimeRulesetType.name, new StandardTypeConstructor(runtimeRulesetType, TVar.EMPTY_ARRAY, runtimeRulesetTypeDesc));
239 public static final Constant ACTIVATE = new JavaMethod(true, CHRCodeGenerationConstants.CHRContext_name, "activate", Types.PROC, Types.UNIT, Types.CHRContext, Types.INTEGER);
240 private static final Constant CREATE_CHR_CONTEXT = new JavaConstructor("org/simantics/scl/runtime/chr/CHRContext", Types.PROC, Types.CHRContext);
242 public IVal generateCode(CodeWriter w) {
243 for(IncludeStatement include : includes) {
244 include.storeVar = include.value.toVal(cachedContext, w);
245 initialPriorityNumber = Math.max(initialPriorityNumber, include.ruleset.initialPriorityNumber + include.ruleset.priorityCount);
247 CHRRulesetObject object = new CHRRulesetObject(runtimeRulesetVariable, this);
248 w.defineObject(object);
249 for(CHRRule rule : rules) {
250 for(CHRSearchPlan plan : rule.plans) {
251 /*System.out.println(" plan " + plan.priority);
252 for(PlanOp planOp : plan.ops)
253 System.out.println(" " + planOp);*/
254 CodeWriter methodWriter = object.createMethod(w.getModuleWriter(), TVar.EMPTY_ARRAY, Types.PROC, Types.BOOLEAN, new Type[] {Types.CHRContext, plan.constraint.factType});
255 plan.implementation = methodWriter.getFunction();
256 IVal[] implementationParameters = methodWriter.getParameters();
257 plan.activeFact.setVal(implementationParameters[1]);
258 PlanRealizer realizer = new PlanRealizer(cachedContext, this, runtimeRulesetVariable, implementationParameters[0], plan.ops);
259 realizer.nextOp(methodWriter);
260 if(methodWriter.isUnfinished())
261 methodWriter.return_(BooleanConstant.TRUE);
264 if(!includes.isEmpty() || extensible) {
266 CodeWriter methodWriter = object.createMethod(w.getModuleWriter(), TVar.EMPTY_ARRAY, Types.PROC, Types.UNIT, new Type[] {Types.CHRContext});
267 initializer = methodWriter.getFunction();
268 for(IncludeStatement include : includes) {
269 methodWriter.apply(include.location,
270 new JavaMethod(true, runtimeRulesetClassName, "register", Types.PROC, Types.UNIT, new Type[] {runtimeRulesetType, Types.CHRContext, include.ruleset.runtimeRulesetType}),
271 object.getTarget(), methodWriter.getParameters()[0], include.storeVar);
274 methodWriter.apply(Locations.NO_LOCATION,
275 new JavaMethod(true, runtimeRulesetClassName, "register", Types.PROC, Types.UNIT, new Type[] {runtimeRulesetType, Types.CHRContext}),
276 object.getTarget(), methodWriter.getParameters()[0]);
277 methodWriter.return_(NoRepConstant.UNIT);
280 CodeWriter methodWriter = object.createMethod(w.getModuleWriter(), TVar.EMPTY_ARRAY, Types.PROC, Types.UNIT, new Type[] {Types.CHRContext});
281 deinitializer = methodWriter.getFunction();
282 for(IncludeStatement include : includes) {
283 methodWriter.apply(include.location,
284 new JavaMethod(true, runtimeRulesetClassName, "unregister", Types.PROC, Types.UNIT, new Type[] {runtimeRulesetType, Types.CHRContext, include.ruleset.runtimeRulesetType}),
285 object.getTarget(), methodWriter.getParameters()[0], include.storeVar);
288 methodWriter.apply(Locations.NO_LOCATION,
289 new JavaMethod(true, runtimeRulesetClassName, "unregister", Types.PROC, Types.UNIT, new Type[] {runtimeRulesetType, Types.CHRContext}),
290 object.getTarget(), methodWriter.getParameters()[0]);
291 methodWriter.return_(NoRepConstant.UNIT);
294 if(initConstraint != null) {
295 IVal chrContext = w.apply(location, CREATE_CHR_CONTEXT);
296 if(initializer != null) {
298 new JavaMethod(true, runtimeRulesetClassName, "initialize", Types.PROC, Types.UNIT, new Type[] {runtimeRulesetType, Types.CHRContext}),
299 object.getTarget(), chrContext);
301 IVal initFact = w.apply(location, initConstraint.constructor, w.apply(location, GENERATE_ID, chrContext));
302 w.apply(location, initConstraint.addProcedure, runtimeRulesetVariable, chrContext, initFact);
303 w.apply(location, ACTIVATE, chrContext, new IntegerConstant(Integer.MAX_VALUE));
304 if(deinitializer != null) {
306 new JavaMethod(true, runtimeRulesetClassName, "deinitialize", Types.PROC, Types.UNIT, new Type[] {runtimeRulesetType, Types.CHRContext}),
307 object.getTarget(), chrContext);
310 return runtimeRulesetVariable;
313 public void collectEffects(THashSet<Type> effects) {
314 for(CHRRule rule : rules) {
315 for(CHRLiteral literal : rule.head.literals)
316 literal.collectQueryEffects(effects);
317 for(CHRLiteral literal : rule.head.literals)
318 literal.collectEnforceEffects(effects);
322 public void addRule(CHRRule rule) {
324 rule.parentRuleset = this;