Support for field annotations in local records and tuples

bvm/ballerina-runtime/src/main/java/io/ballerina/runtime/internal/ValueUtils.java

@@ -241,4 +241,19 @@ public static BTypedesc getTypedescValue(Type type, BValue value) {
         return new TypedescValueImpl(type);
     }
 
+    /**
+     * Provide the Typedesc Value depending on the immutability of a value.
+     * @param readOnly Indicates that the type is a subtype of readonly
+     * @param value Ballerina value
+     * @param inherentType Inherent type of the value
+     * @return     typedesc with the suitable type
+     */
+    public static BTypedesc getTypedescValue(Boolean readOnly, BValue value, TypedescValueImpl inherentType) {
+        if (readOnly) {
+            TypedescValueImpl typedesc = (TypedescValueImpl) createSingletonTypedesc(value);
+            typedesc.annotations = inherentType.annotations;
+            return typedesc;
+        }
+        return inherentType;
+    }
 }

bvm/ballerina-runtime/src/main/java/io/ballerina/runtime/internal/values/TupleValueImpl.java

@@ -200,6 +200,11 @@ public TupleValueImpl(Type type, BListInitialValueEntry[] initialValues) {
         this.typedesc = getTypedescValue(type, this);
     }
 
+    public TupleValueImpl(Type type, BListInitialValueEntry[] initialValues, TypedescValueImpl inherentType) {
+        this(type, initialValues);
+        this.typedesc = getTypedescValue(type.isReadOnly(), this, inherentType);
+    }
+
     @Override
     public BTypedesc getTypedesc() {
         return typedesc;

bvm/ballerina-runtime/src/main/java/io/ballerina/runtime/internal/values/TypedescValue.java

@@ -26,5 +26,4 @@
  * @since 1.3.0
  */
 public interface TypedescValue extends RefValue, BTypedesc {
-
 }

bvm/ballerina-runtime/src/main/java/io/ballerina/runtime/internal/values/TypedescValueImpl.java

@@ -25,6 +25,7 @@
 import io.ballerina.runtime.api.values.BMapInitialValueEntry;
 import io.ballerina.runtime.api.values.BTypedesc;
 import io.ballerina.runtime.internal.scheduling.Strand;
+import io.ballerina.runtime.internal.types.BAnnotatableType;
 import io.ballerina.runtime.internal.types.BTypedescType;
 import io.ballerina.runtime.internal.util.exceptions.BallerinaException;
 
@@ -52,6 +53,7 @@ public class TypedescValueImpl implements  TypedescValue {
     final Type type;
     final Type describingType; // Type of the value describe by this typedesc.
     public MapValue[] closures;
+    public MapValue annotations;
 
     @Deprecated
     public TypedescValueImpl(Type describingType) {
@@ -66,6 +68,11 @@ public TypedescValueImpl(Type describingType, MapValue[] closures) {
         this.closures = closures;
     }
 
+    public TypedescValueImpl(Type describingType, MapValue[] closures, MapValue annotations) {
+        this(describingType, closures);
+        this.annotations = annotations;
+        ((BAnnotatableType) describingType).setAnnotations(annotations);
+    }
 
     /**
      * Returns the {@code BType} of the value describe by this type descriptor.
@@ -84,13 +91,17 @@ public Object instantiate(Strand s) {
         return instantiate(s, new BInitialValueEntry[0]);
     }
 
+    public MapValue getAnnotations() {
+        return annotations;
+    }
+
     @Override
     public Object instantiate(Strand s, BInitialValueEntry[] initialValues) {
         Type referredType = getReferredType(this.describingType);
         if (referredType.getTag() == TypeTags.MAP_TAG) {
             return new MapValueImpl(this.describingType, (BMapInitialValueEntry[]) initialValues);
         } else if (referredType.getTag() == TypeTags.TUPLE_TAG) {
-            return new TupleValueImpl(this.describingType, (BListInitialValueEntry[]) initialValues);
+            return new TupleValueImpl(this.describingType, (BListInitialValueEntry[]) initialValues, this);
         }
         // This method will be overridden for user-defined types, therefor this line shouldn't be reached.
         throw new BallerinaException("Given type can't be instantiated at runtime : " + this.describingType);

compiler/ballerina-lang/src/main/java/org/wso2/ballerinalang/compiler/BIRPackageSymbolEnter.java

@@ -1236,7 +1236,6 @@ public BType readType(int cpI) throws IOException {
 
             // Read the type flags to identify if type reference types are nullable.
             int typeFlags = inputStream.readInt();
-
             switch (tag) {
                 case TypeTags.INT:
                     return typeParamAnalyzer.getNominalType(symTable.intType, name, flags);

compiler/ballerina-lang/src/main/java/org/wso2/ballerinalang/compiler/bir/BIRGen.java

@@ -1608,7 +1608,8 @@ public void visit(BLangTypeConversionExpr astTypeConversionExpr) {
     @Override
     public void visit(BLangStructLiteral astStructLiteralExpr) {
         List<BIROperand> varDcls = mapToVarDcls(astStructLiteralExpr.enclMapSymbols);
-        visitTypedesc(astStructLiteralExpr.pos, astStructLiteralExpr.getBType(), varDcls);
+        BType type = astStructLiteralExpr.getBType();
+        visitTypedesc(astStructLiteralExpr.pos, type, varDcls, getAnnotations(type.tsymbol, this.env));
 
         BIRVariableDcl tempVarDcl = new BIRVariableDcl(astStructLiteralExpr.getBType(),
                                                        this.env.nextLocalVarId(names), VarScope.FUNCTION, VarKind.TEMP);
@@ -1671,17 +1672,33 @@ public void visit(BLangSimpleVarRef.BLangFieldVarRef fieldVarRef) {
     public void visit(BLangArrayLiteral astArrayLiteralExpr) {
         BType bType = astArrayLiteralExpr.getBType();
         if (bType.tag == TypeTags.TUPLE) {
-            visitTypedesc(astArrayLiteralExpr.pos, bType, Collections.emptyList());
+            visitTypedesc(astArrayLiteralExpr.pos, bType, Collections.emptyList(),
+                          getAnnotations(bType.tsymbol, this.env));
         }
         generateListConstructorExpr(astArrayLiteralExpr);
     }
 
     @Override
     public void visit(BLangTupleLiteral tupleLiteral) {
-        visitTypedesc(tupleLiteral.pos, tupleLiteral.getBType(), Collections.emptyList());
+        BType type = tupleLiteral.getBType();
+        visitTypedesc(tupleLiteral.pos, type, Collections.emptyList(), getAnnotations(type.tsymbol, this.env));
         generateListConstructorExpr(tupleLiteral);
     }
 
+    private BIROperand getAnnotations(BTypeSymbol typeSymbol, BIRGenEnv env) {
+        if (typeSymbol == null || typeSymbol.annotations == null) {
+            return null;
+        }
+        return new BIROperand(getAnnotations(typeSymbol.annotations, env));
+    }
+
+    private BIRVariableDcl getAnnotations(BVarSymbol annotations, BIRGenEnv env) {
+        if (env.symbolVarMap.containsKey(annotations)) {
+            return env.symbolVarMap.get(annotations);
+        }
+        return globalVarMap.get(annotations);
+    }
+
     @Override
     public void visit(BLangGroupExpr groupExpr) {
         groupExpr.expression.accept(this);
@@ -1691,7 +1708,8 @@ public void visit(BLangGroupExpr groupExpr) {
     public void visit(BLangJSONArrayLiteral jsonArrayLiteralExpr) {
         BType bType = jsonArrayLiteralExpr.getBType();
         if (bType.tag == TypeTags.TUPLE) {
-            visitTypedesc(jsonArrayLiteralExpr.pos, bType, Collections.emptyList());
+            visitTypedesc(jsonArrayLiteralExpr.pos, bType, Collections.emptyList(),
+                          getAnnotations(bType.tsymbol, this.env));
         }
         generateListConstructorExpr(jsonArrayLiteralExpr);
     }
@@ -2195,7 +2213,7 @@ public void visit(BLangTypedescExpr accessExpr) {
         this.env.enclFunc.localVars.add(tempVarDcl);
         BIROperand toVarRef = new BIROperand(tempVarDcl);
         setScopeAndEmit(new BIRNonTerminator.NewTypeDesc(accessExpr.pos, toVarRef, accessExpr.resolvedType,
-                                              Collections.emptyList()));
+                                                         Collections.emptyList()));
         this.env.targetOperand = toVarRef;
     }
 
@@ -2249,11 +2267,19 @@ public void visit(BLangSimpleVarRef.BLangTypeLoad typeLoad) {
     }
 
     private void visitTypedesc(Location pos, BType type, List<BIROperand> varDcls) {
-        BIRVariableDcl tempVarDcl =
-                new BIRVariableDcl(symTable.typeDesc, this.env.nextLocalVarId(names), VarScope.FUNCTION, VarKind
-                        .TEMP);
+        visitTypedesc(pos, type, varDcls, null);
+    }
+
+    private void visitTypedesc(Location pos, BType type, List<BIROperand> varDcls, BIROperand annotations) {
+        BIRVariableDcl tempVarDcl = new BIRVariableDcl(symTable.typeDesc, this.env.nextLocalVarId(names),
+                                                       VarScope.FUNCTION, VarKind.TEMP);
         this.env.enclFunc.localVars.add(tempVarDcl);
         BIROperand toVarRef = new BIROperand(tempVarDcl);
+        if (annotations != null) {
+            setScopeAndEmit(new BIRNonTerminator.NewTypeDesc(pos, toVarRef, type, varDcls, annotations));
+            this.env.targetOperand = toVarRef;
+            return;
+        }
         setScopeAndEmit(new BIRNonTerminator.NewTypeDesc(pos, toVarRef, type, varDcls));
         this.env.targetOperand = toVarRef;
     }

compiler/ballerina-lang/src/main/java/org/wso2/ballerinalang/compiler/bir/codegen/JvmConstants.java

@@ -252,6 +252,7 @@ public class JvmConstants {
     // service objects, annotation processing related classes
     public static final String ANNOTATION_UTILS = "io/ballerina/runtime/internal/AnnotationUtils";
     public static final String ANNOTATION_MAP_NAME = "$annotation_data";
+    public static final String ANNOTATIONS_FIELD = "$annotations";
     public static final String DEFAULTABLE_ARGS_ANOT_NAME = "DefaultableArgs";
     public static final String DEFAULTABLE_ARGS_ANOT_FIELD = "args";
 

compiler/ballerina-lang/src/main/java/org/wso2/ballerinalang/compiler/bir/codegen/JvmInstructionGen.java

@@ -235,6 +235,7 @@
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.SET_ON_INIT;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.TWO_OBJECTS_ARGS;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.TYPE_DESC_CONSTRUCTOR;
+import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.TYPE_DESC_CONSTRUCTOR_WITH_ANNOTATIONS;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.XML_ADD_CHILDREN;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.XML_CHILDREN;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.XML_CHILDREN_FROM_STRING;
@@ -2094,7 +2095,7 @@ void generateNewTypedescIns(BIRNonTerminator.NewTypeDesc newTypeDesc) {
             String fieldName = jvmTypeGen.getTypedescFieldName(toNameString(type));
             mv.visitFieldInsn(GETSTATIC, typeOwner, fieldName, GET_TYPEDESC);
         } else {
-            generateNewTypedescCreate(newTypeDesc.type, closureVars);
+            generateNewTypedescCreate(newTypeDesc.type, closureVars, newTypeDesc.annotations);
         }
         this.storeToVar(newTypeDesc.lhsOp.variableDcl);
     }
@@ -2108,7 +2109,7 @@ private boolean isNonReferredRecord(BType type) {
                 type.getQualifiedTypeName().equals(referredType.getQualifiedTypeName());
     }
 
-    private void generateNewTypedescCreate(BType btype, List<BIROperand> closureVars) {
+    private void generateNewTypedescCreate(BType btype, List<BIROperand> closureVars, BIROperand annotations) {
         BType type = JvmCodeGenUtil.getReferredType(btype);
         String className = TYPEDESC_VALUE_IMPL;
         if (type.tag == TypeTags.RECORD) {
@@ -2127,8 +2128,13 @@ private void generateNewTypedescCreate(BType btype, List<BIROperand> closureVars
             this.loadVar(closureVar.variableDcl);
             mv.visitInsn(AASTORE);
         }
-
-        this.mv.visitMethodInsn(INVOKESPECIAL, className, JVM_INIT_METHOD, TYPE_DESC_CONSTRUCTOR, false);
+        if (annotations != null) {
+            this.loadVar(annotations.variableDcl);
+            this.mv.visitMethodInsn(INVOKESPECIAL, className, JVM_INIT_METHOD, TYPE_DESC_CONSTRUCTOR_WITH_ANNOTATIONS,
+                                    false);
+        } else {
+            this.mv.visitMethodInsn(INVOKESPECIAL, className, JVM_INIT_METHOD, TYPE_DESC_CONSTRUCTOR, false);
+        }
     }
 
     void loadVar(BIRNode.BIRVariableDcl varDcl) {

compiler/ballerina-lang/src/main/java/org/wso2/ballerinalang/compiler/bir/codegen/JvmSignatures.java

@@ -443,6 +443,8 @@ public class JvmSignatures {
     public static final String TUPLE_SET_MEMBERS_METHOD = "(L" + LIST + ";L" + TYPE + ";)V";
     public static final String TWO_OBJECTS_ARGS = "(L" + OBJECT + ";L" + OBJECT + ";)V";
     public static final String TYPE_DESC_CONSTRUCTOR = "(L" + TYPE + ";[L" + MAP_VALUE + ";)V";
+    public static final String TYPE_DESC_CONSTRUCTOR_WITH_ANNOTATIONS =
+                                                             "(L" + TYPE + ";[L" + MAP_VALUE + ";L" + MAP_VALUE + ";)V";
     public static final String TYPE_PARAMETER = "(L" + TYPE + ";)V";
     public static final String UPDATE_CHANNEL_DETAILS = "([L" + CHANNEL_DETAILS + ";)V";
     public static final String VALUE_CLASS_INIT = "(L" + STRAND_CLASS + ";L" + MAP_VALUE + ";)L" + OBJECT + ";";

compiler/ballerina-lang/src/main/java/org/wso2/ballerinalang/compiler/bir/codegen/JvmValueGen.java

@@ -86,6 +86,7 @@
 import static org.objectweb.asm.Opcodes.V1_8;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmCodeGenUtil.toNameString;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmConstants.ABSTRACT_OBJECT_VALUE;
+import static org.wso2.ballerinalang.compiler.bir.codegen.JvmConstants.ANNOTATIONS_FIELD;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmConstants.BAL_OPTIONAL;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmConstants.B_OBJECT;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmConstants.JVM_INIT_METHOD;
@@ -108,13 +109,15 @@
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmPackageGen.computeLockNameFromString;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.CAST_B_MAPPING_INITIAL_VALUE_ENTRY;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.GET_MAP_ARRAY;
+import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.GET_MAP_VALUE;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.INIT_TYPEDESC;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.INSTANTIATE;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.OBJECT_TYPE_IMPL_INIT;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.POPULATE_INITIAL_VALUES;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.RECORD_INIT_WRAPPER;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.RECORD_VALUE_CLASS;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.TYPE_DESC_CONSTRUCTOR;
+import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.TYPE_DESC_CONSTRUCTOR_WITH_ANNOTATIONS;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.TYPE_PARAMETER;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmSignatures.VALUE_CLASS_INIT;
 import static org.wso2.ballerinalang.compiler.bir.codegen.JvmTypeGen.getTypeDesc;
@@ -249,7 +252,11 @@ private byte[] createRecordTypeDescClass(BRecordType recordType, String classNam
         }
         cw.visit(V1_8, ACC_PUBLIC + ACC_SUPER, className, null, TYPEDESC_VALUE_IMPL, new String[]{TYPEDESC_VALUE});
 
+        FieldVisitor fv = cw.visitField(0, ANNOTATIONS_FIELD, GET_MAP_VALUE, null, null);
+        fv.visitEnd();
+
         this.createTypeDescConstructor(cw);
+        this.createTypeDescConstructorWithAnnotations(cw, className);
         this.createInstantiateMethod(cw, recordType, typeDef);
 
         cw.visitEnd();
@@ -429,6 +436,32 @@ private void createTypeDescConstructor(ClassWriter cw) {
         mv.visitEnd();
     }
 
+    private void createTypeDescConstructorWithAnnotations(ClassWriter cw, String name) {
+
+        String descriptor = TYPE_DESC_CONSTRUCTOR_WITH_ANNOTATIONS;
+        MethodVisitor mv = cw.visitMethod(ACC_PUBLIC, JVM_INIT_METHOD, descriptor, null, null);
+        mv.visitCode();
+
+        mv.visitVarInsn(ALOAD, 0);
+        mv.visitVarInsn(ALOAD, 3);
+        mv.visitFieldInsn(PUTFIELD, name, ANNOTATIONS_FIELD, GET_MAP_VALUE);
+        // load super
+        mv.visitVarInsn(ALOAD, 0);
+        // load type
+        mv.visitVarInsn(ALOAD, 1);
+        // load closures
+        mv.visitVarInsn(ALOAD, 2);
+        // load annotations
+        mv.visitVarInsn(ALOAD, 3);
+        // invoke `super(type)`;
+        mv.visitMethodInsn(INVOKESPECIAL, TYPEDESC_VALUE_IMPL, JVM_INIT_METHOD, TYPE_DESC_CONSTRUCTOR_WITH_ANNOTATIONS,
+                           false);
+
+        mv.visitInsn(RETURN);
+        mv.visitMaxs(0, 0);
+        mv.visitEnd();
+    }
+
     private void createRecordConstructor(ClassWriter cw, String argumentClass) {
         MethodVisitor mv = cw.visitMethod(ACC_PUBLIC, JVM_INIT_METHOD, argumentClass, null, null);
         mv.visitCode();

compiler/ballerina-lang/src/main/java/org/wso2/ballerinalang/compiler/bir/model/BIRNonTerminator.java

@@ -824,6 +824,7 @@ public BIROperand[] getRhsOperands() {
     public static class NewTypeDesc extends BIRNonTerminator {
         public final List<BIROperand> closureVars;
         public BType type;
+        public BIROperand annotations;
 
         public NewTypeDesc(Location pos, BIROperand lhsOp, BType type, List<BIROperand> closureVars) {
             super(pos, InstructionKind.NEW_TYPEDESC);
@@ -832,6 +833,12 @@ public NewTypeDesc(Location pos, BIROperand lhsOp, BType type, List<BIROperand>
             this.type = type;
         }
 
+        public NewTypeDesc(Location pos, BIROperand lhsOp, BType type, List<BIROperand> closureVars,
+                           BIROperand annotations) {
+            this(pos, lhsOp, type, closureVars);
+            this.annotations = annotations;
+        }
+
         @Override
         public void accept(BIRVisitor visitor) {
             visitor.visit(this);