1 package org.simantics.scl.compiler.compilation;
3 import java.util.ArrayList;
4 import java.util.Collection;
7 import org.cojen.classfile.TypeDesc;
8 import org.objectweb.asm.Opcodes;
9 import org.simantics.scl.compiler.common.datatypes.Constructor;
10 import org.simantics.scl.compiler.common.exceptions.InternalCompilerError;
11 import org.simantics.scl.compiler.common.names.Name;
12 import org.simantics.scl.compiler.constants.LocalFieldConstant;
13 import org.simantics.scl.compiler.constants.LocalVariableConstant;
14 import org.simantics.scl.compiler.constants.NoRepConstant;
15 import org.simantics.scl.compiler.constants.SCLConstant;
16 import org.simantics.scl.compiler.constants.ThisConstant;
17 import org.simantics.scl.compiler.elaboration.contexts.SimplificationContext;
18 import org.simantics.scl.compiler.elaboration.expressions.Expression;
19 import org.simantics.scl.compiler.elaboration.macros.StandardMacroRule;
20 import org.simantics.scl.compiler.elaboration.modules.InlineProperty;
21 import org.simantics.scl.compiler.elaboration.modules.MethodImplementation;
22 import org.simantics.scl.compiler.elaboration.modules.PrivateProperty;
23 import org.simantics.scl.compiler.elaboration.modules.SCLValue;
24 import org.simantics.scl.compiler.elaboration.modules.SCLValueProperty;
25 import org.simantics.scl.compiler.elaboration.modules.TypeClass;
26 import org.simantics.scl.compiler.elaboration.modules.TypeClassInstance;
27 import org.simantics.scl.compiler.elaboration.modules.TypeClassMethod;
28 import org.simantics.scl.compiler.environment.Environment;
29 import org.simantics.scl.compiler.errors.ErrorLog;
30 import org.simantics.scl.compiler.internal.codegen.references.IVal;
31 import org.simantics.scl.compiler.internal.codegen.references.Val;
32 import org.simantics.scl.compiler.internal.codegen.ssa.SSAModule;
33 import org.simantics.scl.compiler.internal.codegen.types.JavaReferenceValidator;
34 import org.simantics.scl.compiler.internal.codegen.types.JavaTypeTranslator;
35 import org.simantics.scl.compiler.internal.codegen.types.StandardTypeConstructor;
36 import org.simantics.scl.compiler.internal.codegen.utils.ClassBuilder;
37 import org.simantics.scl.compiler.internal.codegen.utils.CodeBuilderUtils;
38 import org.simantics.scl.compiler.internal.codegen.utils.CodeBuildingException;
39 import org.simantics.scl.compiler.internal.codegen.utils.Constants;
40 import org.simantics.scl.compiler.internal.codegen.utils.JavaNamingPolicy;
41 import org.simantics.scl.compiler.internal.codegen.utils.MethodBuilder;
42 import org.simantics.scl.compiler.internal.codegen.utils.MethodBuilderBase;
43 import org.simantics.scl.compiler.internal.codegen.utils.ModuleBuilder;
44 import org.simantics.scl.compiler.internal.codegen.writer.CodeWriter;
45 import org.simantics.scl.compiler.internal.codegen.writer.ExternalConstant;
46 import org.simantics.scl.compiler.internal.codegen.writer.ModuleWriter;
47 import org.simantics.scl.compiler.internal.elaboration.decomposed.DecomposedExpression;
48 import org.simantics.scl.compiler.module.ConcreteModule;
49 import org.simantics.scl.compiler.top.SCLCompilerConfiguration;
50 import org.simantics.scl.compiler.types.TCon;
51 import org.simantics.scl.compiler.types.TPred;
52 import org.simantics.scl.compiler.types.Type;
53 import org.simantics.scl.compiler.types.Types;
54 import org.simantics.scl.compiler.types.exceptions.MatchException;
55 import org.simantics.scl.compiler.types.util.MultiFunction;
57 import gnu.trove.procedure.TObjectObjectProcedure;
58 import gnu.trove.procedure.TObjectProcedure;
60 public class CodeGeneration {
62 public static final int OPTIMIZATION_PHASES = 2;
65 Environment environment;
66 JavaNamingPolicy namingPolicy;
67 JavaTypeTranslator javaTypeTranslator;
68 JavaReferenceValidator<Object, Object, Object, Object> validator;
69 ConcreteModule module;
70 ModuleBuilder moduleBuilder;
74 ExternalConstant[] externalConstants;
75 Map<String, byte[]> classes;
77 @SuppressWarnings("unchecked")
78 public CodeGeneration(ErrorLog errorLog,
79 Environment environment,
80 JavaNamingPolicy namingPolicy, JavaTypeTranslator javaTypeTranslator,
81 JavaReferenceValidator<?, ?, ?, ?> javaReferenceValidator,
82 ConcreteModule module) {
83 this.errorLog = errorLog;
84 this.environment = environment;
85 this.namingPolicy = namingPolicy;
86 this.javaTypeTranslator = javaTypeTranslator;
88 this.validator = (JavaReferenceValidator<Object, Object, Object, Object>) javaReferenceValidator;
90 moduleBuilder = new ModuleBuilder(namingPolicy, javaTypeTranslator);
93 public void simplifyValues() {
94 //System.out.println("===== Simplify values =====");
96 Collection<SCLValue> values = module.getValues();
97 SimplificationContext simplificationContext =
98 new SimplificationContext(environment, errorLog,
99 javaTypeTranslator, validator);
100 //System.out.println("-----------------------------------------------");
101 SCLValue[] valueArray = values.toArray(new SCLValue[values.size()]);
103 for(SCLValue value : valueArray) {
104 if(value.getMacroRule() instanceof StandardMacroRule) {
105 StandardMacroRule rule = (StandardMacroRule)value.getMacroRule();
106 rule.setBaseExpression(value.getExpression().copy());
111 for(SCLValue value : valueArray) {
112 //System.out.println("BEFORE " + value.getName() + " = " + value.getExpression());
113 value.getSimplifiedExpression(simplificationContext);
114 //System.out.println("AFTER " + value.getName() + " = " + value.getExpression());
118 public void convertToSSA() {
119 ModuleWriter mw = new ModuleWriter(namingPolicy.getModuleClassName());
120 for(SCLValue value : module.getValues()) {
121 //System.out.println(value.getName().name + " :: " + value.getType());
122 Expression expression = value.getExpression();
123 if(expression == null)
126 Name name = value.getName();
127 DecomposedExpression decomposed =
128 DecomposedExpression.decompose(expression);
130 SCLConstant constant = new SCLConstant(name, value.getType());
131 value.setValue(constant);
132 /*constant.setBase(new JavaStaticMethod(
133 namingPolicy.getModuleClassName(), namingPolicy.getMethodName(name.name),
135 decomposed.typeParameters,
136 decomposed.returnType,
137 decomposed.parameterTypes));*/
138 for(SCLValueProperty prop : value.getProperties()) {
139 if(prop instanceof InlineProperty) {
140 InlineProperty inlineProperty = (InlineProperty)prop;
141 constant.setInlineArity(inlineProperty.arity, inlineProperty.phaseMask);
143 else if(prop == PrivateProperty.INSTANCE)
144 constant.setPrivate(true);
147 // This is quite hackish optimization that can be possibly removed when
148 // better optimizations exist
149 /*for(SCLValue value : module.getValues()) {
150 Expression expression = value.getExpression();
151 if(!(expression instanceof EConstant))
153 EConstant constant = (EConstant)expression;
154 if(constant.getTypeParameters().length > 0)
157 //System.out.println(value.getName() + " <- " + constant.getValue().getName());
158 value.setValue(constant.getValue().getValue());
159 value.setExpression(null); // HMM??
161 for(SCLValue value : module.getValues()) {
163 Expression expression = value.getExpression();
164 if(expression == null)
167 DecomposedExpression decomposed =
168 DecomposedExpression.decompose(expression);
170 CodeWriter w = mw.createFunction((SCLConstant)value.getValue(),
171 decomposed.typeParameters,
173 decomposed.returnType,
174 decomposed.parameterTypes);
175 if(value.getValue() instanceof SCLConstant) // FIXME should be redundant test, if expression is nulled above
176 ((SCLConstant)value.getValue()).setDefinition(w.getFunction());
177 IVal[] parameterVals = w.getParameters();
178 for(int i=0;i<decomposed.parameters.length;++i)
179 decomposed.parameters[i].setVal(parameterVals[i]);
180 w.return_(decomposed.body.toVal(environment, w));
181 } catch(RuntimeException e) {
182 errorLog.setExceptionPosition(value.getExpression().location);
186 ssaModule = mw.getModule();
187 if(SCLCompilerConfiguration.DEBUG)
188 ssaModule.validate();
190 this.externalConstants = mw.getExternalConstants();
193 public void optimizeSSA() {
194 if(SCLCompilerConfiguration.SHOW_SSA_BEFORE_OPTIMIZATION) {
195 System.out.println("=== SSA before optimization ====================================");
196 System.out.println(ssaModule);
198 if(SCLCompilerConfiguration.DEBUG)
199 ssaModule.validate();
201 for(int phase=0;phase<OPTIMIZATION_PHASES;++phase) {
202 while(optCount++ < 100 && ssaModule.simplify(environment, phase)) {
203 //System.out.println("simplify " + optCount);
204 //System.out.println("================================================================");
205 //System.out.println(ssaModule);
208 ssaModule.saveInlinableDefinitions();
210 if(SCLCompilerConfiguration.SHOW_SSA_BEFORE_LAMBDA_LIFTING) {
211 System.out.println("=== SSA before lambda lifting ==================================");
212 System.out.println(ssaModule);
214 ssaModule.lambdaLift(errorLog);
215 //ssaModule.validate();
216 // TODO prevent creating more lambdas here
217 //ssaModule.simplify(environment);
218 ssaModule.markGenerateOnFly();
221 public void generateCode() {
222 if(SCLCompilerConfiguration.SHOW_FINAL_SSA) {
223 System.out.println("=== Final SSA ==================================================");
224 System.out.println(ssaModule);
227 ssaModule.generateCode(moduleBuilder);
228 } catch (CodeBuildingException e) {
229 errorLog.log(e.getMessage());
231 if(SCLCompilerConfiguration.TRACE_MAX_METHOD_SIZE && moduleBuilder.getMethodSizeCounter() != null)
232 System.out.println("[Max method size] " + module.getName() + ": " + moduleBuilder.getMethodSizeCounter());
233 classes = moduleBuilder.getClasses();
236 public void generateDataTypes(ArrayList<StandardTypeConstructor> dataTypes) {
237 for(StandardTypeConstructor dataType : dataTypes) {
238 if(dataType.external)
240 if(dataType.constructors.length == 1) {
241 Constructor constructor = dataType.constructors[0];
242 if(constructor.parameterTypes.length != 1) {
243 String javaName = MethodBuilderBase.getClassName(dataType.getTypeDesc());
244 if(SCLCompilerConfiguration.TRACE_METHOD_CREATION)
245 System.out.println("Create class " + javaName);
246 ClassBuilder cf = new ClassBuilder(moduleBuilder, Opcodes.ACC_PUBLIC, javaName, "java/lang/Object");
247 cf.setSourceFile("_SCL_DataType");
248 CodeBuilderUtils.makeRecord(cf, constructor.name.name,
249 Opcodes.ACC_PUBLIC | Opcodes.ACC_FINAL, "c",
250 javaTypeTranslator.toTypeDescs(constructor.parameterTypes),
252 moduleBuilder.addClass(cf);
256 String javaName = MethodBuilderBase.getClassName(dataType.getTypeDesc());
259 if(SCLCompilerConfiguration.TRACE_METHOD_CREATION)
260 System.out.println("Create class " + javaName);
261 ClassBuilder cf = new ClassBuilder(moduleBuilder,
262 Opcodes.ACC_ABSTRACT | Opcodes.ACC_PUBLIC,
263 javaName, "java/lang/Object");
264 cf.setSourceFile("_SCL_DataType");
265 cf.addDefaultConstructor();
266 moduleBuilder.addClass(cf);
269 // Create constructors
270 for(Constructor constructor : dataType.constructors) {
271 if(SCLCompilerConfiguration.TRACE_METHOD_CREATION)
272 System.out.println("Create class " + constructor.javaName);
273 ClassBuilder cf = new ClassBuilder(moduleBuilder, Opcodes.ACC_PUBLIC, constructor.javaName, javaName);
274 cf.setSourceFile("_SCL_DataType");
275 CodeBuilderUtils.makeRecord(cf, constructor.name.name,
276 Opcodes.ACC_PUBLIC | Opcodes.ACC_FINAL, "c",
277 javaTypeTranslator.toTypeDescs(constructor.parameterTypes),
279 moduleBuilder.addClass(cf);
285 public void generateTypeClasses() {
286 for(TypeClass typeClass : module.getTypeClasses()) {
287 final JavaTypeTranslator javaTypeTranslator = moduleBuilder.getJavaTypeTranslator();
289 if(SCLCompilerConfiguration.TRACE_METHOD_CREATION)
290 System.out.println("Create class " + typeClass.javaName);
291 final ClassBuilder cf = new ClassBuilder(moduleBuilder,
292 Opcodes.ACC_INTERFACE | Opcodes.ACC_PUBLIC,
293 typeClass.javaName, "java/lang/Object");
295 for(int i=0;i<typeClass.context.length;++i) {
296 TPred sup = typeClass.context[i];
297 /*if(Types.equals(sup.parameters, typeClass.parameters))
298 cf.addInterface(javaTypeTranslator.toTypeDesc(sup).getDescriptor());
300 cf.addAbstractMethod(Opcodes.ACC_PUBLIC | Opcodes.ACC_ABSTRACT, "super" + i,
301 javaTypeTranslator.toTypeDesc(sup),
302 Constants.EMPTY_TYPEDESC_ARRAY);
305 typeClass.methods.forEachValue(new TObjectProcedure<TypeClassMethod>() {
307 public boolean execute(TypeClassMethod method) {
310 mfun = Types.matchFunction(method.getBaseType(), method.getArity());
311 } catch (MatchException e) {
312 throw new InternalCompilerError("Method " + method.getName() + " has too high arity.");
314 cf.addAbstractMethod(Opcodes.ACC_PUBLIC | Opcodes.ACC_ABSTRACT, method.getJavaName(),
315 javaTypeTranslator.toTypeDesc(mfun.returnType),
316 JavaTypeTranslator.filterVoid(javaTypeTranslator.toTypeDescs(mfun.parameterTypes)));
321 moduleBuilder.addClass(cf);
325 public void generateTypeClassInstances() {
326 module.getTypeInstances().forEachEntry(new TObjectObjectProcedure<TCon, ArrayList<TypeClassInstance>>() {
329 public boolean execute(TCon typeClass, ArrayList<TypeClassInstance> instances) {
330 for(TypeClassInstance instance : instances)
331 generateTypeClassInstance(instance);
337 private void generateTypeClassInstance(final TypeClassInstance instance) {
338 final JavaTypeTranslator javaTypeTranslator = moduleBuilder.getJavaTypeTranslator();
340 if(SCLCompilerConfiguration.TRACE_METHOD_CREATION)
341 System.out.println("Create class " + instance.javaName);
342 final ClassBuilder cb = new ClassBuilder(moduleBuilder, Opcodes.ACC_PUBLIC, instance.javaName, "java/lang/Object",
343 instance.typeClass.javaName);
344 cb.setSourceFile("_SCL_TypeClassInstance");
346 CodeBuilderUtils.makeRecord(cb, instance.javaName, Opcodes.ACC_PRIVATE, "cx",
347 javaTypeTranslator.toTypeDescs(instance.context), false);
349 for(int i=0;i<instance.superExpressions.length;++i) {
350 TypeDesc returnTypeDesc = javaTypeTranslator.toTypeDesc(instance.typeClass.context[i]);
351 MethodBuilder mb = cb.addMethod(Opcodes.ACC_PUBLIC, "super" + i,
353 Constants.EMPTY_TYPEDESC_ARRAY);
354 Val[] parameters = new Val[instance.context.length];
355 for(int j=0;j<instance.context.length;++j)
356 parameters[j] = new LocalFieldConstant(instance.context[j], "cx"+j);
357 instance.superExpressions[i].getValue().apply(mb, Type.EMPTY_ARRAY, parameters);
358 mb.returnValue(returnTypeDesc);
362 instance.typeClass.methods.forEachValue(new TObjectProcedure<TypeClassMethod>() {
364 public boolean execute(TypeClassMethod method) {
366 Type baseType = method.getBaseType();
368 mfun = Types.matchFunction(baseType, method.getArity());
369 } catch (MatchException e) {
370 throw new InternalCompilerError("Method " + method.getName() + " has too high arity.");
372 //System.out.println("Interface types: " + Arrays.toString(types));
373 TypeDesc[] parameterTypeDescs = javaTypeTranslator.toTypeDescs(mfun.parameterTypes);
374 TypeDesc returnTypeDesc = javaTypeTranslator.toTypeDesc(mfun.returnType);
375 MethodBuilder mb = cb.addMethod(Opcodes.ACC_PUBLIC, method.getJavaName(),
377 JavaTypeTranslator.filterVoid(parameterTypeDescs));
379 MethodImplementation implementation =
380 instance.methodImplementations.get(method.getName());
381 if(implementation.isDefault) {
382 IVal function = environment.getValue(implementation.name).getValue();
384 Val[] parameters = new Val[method.getArity() + 1];
387 mfun2 = Types.matchFunction(Types.removeForAll(function.getType()), parameters.length);
388 } catch (MatchException e) {
389 throw new InternalCompilerError(e);
391 parameters[0] = new ThisConstant(instance.instance);
392 for(int i=0,j=0;i<method.getArity();++i)
393 if(javaTypeTranslator.toTypeDesc(mfun2.parameterTypes[1 + i]).equals(TypeDesc.VOID))
394 parameters[1+i] = new NoRepConstant(mfun2.parameterTypes[1 + i]);
396 parameters[1+i] = new LocalVariableConstant(mfun2.parameterTypes[1 + i], mb.getParameter(j++));
397 Type returnType = function.apply(mb, Type.EMPTY_ARRAY, parameters);
398 if(returnTypeDesc == TypeDesc.OBJECT)
400 mb.returnValue(returnTypeDesc);
403 IVal function = module.getValue(implementation.name.name).getValue();
405 Val[] parameters = new Val[method.getArity() + instance.context.length];
408 mfun2 = Types.matchFunction(Types.removeForAll(function.getType()), parameters.length);
409 //System.out.println("Implementation types: " + Arrays.toString(functionTypes));
410 } catch (MatchException e) {
411 throw new InternalCompilerError(e);
413 for(int i=0;i<instance.context.length;++i)
414 parameters[i] = new LocalFieldConstant(instance.context[i], "cx"+i);
415 for(int i=0,j=0;i<method.getArity();++i)
416 if(javaTypeTranslator.toTypeDesc(mfun2.parameterTypes[instance.context.length + i]).equals(TypeDesc.VOID))
417 parameters[instance.context.length+i] = new NoRepConstant(mfun2.parameterTypes[instance.context.length + i]);
419 parameters[instance.context.length+i] = new LocalVariableConstant(mfun2.parameterTypes[instance.context.length + i], mb.getParameter(j++));
420 Type returnType = function.apply(mb, Type.EMPTY_ARRAY, parameters);
421 if(returnTypeDesc == TypeDesc.OBJECT)
423 mb.returnValue(returnTypeDesc);
430 moduleBuilder.addClass(cb);