Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8273018: [lworld] Property annotation propagation to <init> lacks in primitive records #541

Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -1015,7 +1015,9 @@ void writeMethod(MethodSymbol m) {
endAttr(alenIdx);
acount++;
}
if (target.hasMethodParameters() && (options.isSet(PARAMETERS) || m.isConstructor() && (m.flags_field & RECORD) != 0)) {
if (target.hasMethodParameters() && (
options.isSet(PARAMETERS)
|| ((m.flags_field & RECORD) != 0 && (m.isConstructor() || m.isPrimitiveObjectFactory())))) {
if (!m.isLambdaMethod()) // Per JDK-8138729, do not emit parameters table for lambda bodies.
This conversation was marked as resolved by jespersm

This comment has been minimized.

@sadayapalam

sadayapalam Sep 15, 2021
Collaborator

Can you fold the two checks for (m.flags_field & RECORD) != 0 into one here ??

acount += writeMethodParametersAttr(m);
}
@@ -389,14 +389,20 @@ private MethodSymbol getPrimitiveObjectFactory(MethodSymbol init) {
if (factory != null)
return factory;

MethodType factoryType = new MethodType(init.erasure(types).getParameterTypes(),
MethodType factoryType = new MethodType(init.type.getParameterTypes(),
init.owner.type.asValueType(),
init.type.getThrownTypes(),
This conversation was marked as resolved by jespersm

This comment has been minimized.

@sadayapalam

sadayapalam Sep 15, 2021
Collaborator

I am lost and need a bit of help here. What exactly is the change and why is it needed ?

This comment has been minimized.

@jespersm

jespersm Sep 16, 2021
Author Contributor

This method makes a primitive object factory from the parsed constructor. In the current version, the parameter types are erased and their annotations, and original method signature, are erased from the original. This line preserves this information, so the generated classfile is correct.

See next comment.

init.owner.type.tsym);
factory = new MethodSymbol(init.flags_field | STATIC,
names.init,
factoryType,
init.owner);
factory.params = init.params;
// Re-patch the return type on the erased method type, or code generation will fail
factory.erasure_field = new MethodType(init.erasure(types).getParameterTypes(),
init.owner.type.asValueType(),
init.type.getThrownTypes(),
init.owner.type.tsym);
factory.setAttributes(init);
This conversation was marked as resolved by jespersm

This comment has been minimized.

@sadayapalam

sadayapalam Sep 15, 2021
Collaborator

Again, I need some help with this change. I understand the part of parameters being carried over, but the dance around recomputation of erasure field - what exactly is the material change there ?? I can see the RecordReading test failing if I backout the changes here (except for factory.params = init.params) but need some explanation - TIA

This comment has been minimized.

@jespersm

jespersm Sep 16, 2021
Author Contributor

Related to comment above: Since we're now preserving the full type information for factoryType and thus factory, instead of propagating the erased info, information from the other (preceding) lowerings would get lost. To avoid that, the erasure is explicitly reconstructed, but with a fixed return type (instead of void).

There is a different test which blows up if this isn't reconstructed, it might be InnerValueNew.java (I'll check later).

init2factory.put(init, factory);
return factory;
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2020, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -25,6 +25,7 @@
* @test
* @summary test the records can be read by javac properly
* @library /tools/lib
* @bug 8273018
* @modules jdk.compiler/com.sun.tools.javac.api
* jdk.compiler/com.sun.tools.javac.main
* @build toolbox.ToolBox toolbox.JavacTask
@@ -126,4 +127,67 @@ public R(int i,
}
}

@Test
public void testPrimitiveRecordClassFileReading(Path base) throws Exception {
Path src = base.resolve("src");
This conversation was marked as resolved by jespersm

This comment has been minimized.

@sadayapalam

sadayapalam Sep 15, 2021
Collaborator

Could you please update the copyright to 2021 and also add a @bug id line to the test spec ? Thanks


tb.writeJavaFiles(src,
"""
public primitive record R(int i, @A long j, java.util.List<String> l) {}
""",
"""
public @interface A {}
""");

Path out = base.resolve("out");
Files.createDirectories(out);

new JavacTask(tb)
.outdir(out)
.files(findJavaFiles(src))
.run();

//read the class file back, to verify javac's ClassReader
//reads the Record attribute properly:
String output = new JavacTask(tb)
.options("-Xprint")
.classpath(out.toString())
.classes("R")
.run()
.writeAll()
.getOutput(Task.OutputKind.STDOUT)
.replaceAll("\\R", "\n");

String expected =
"""
\n\
public primitive record R(int i, @A long j, java.util.List<java.lang.String> l) {
private final int i;
@A
private final long j;
private final java.util.List<java.lang.String> l;
\n\
public final java.lang.String toString();
\n\
public final int hashCode();
\n\
public final boolean equals(java.lang.Object arg0);
\n\
public int i();
\n\
@A
public long j();
\n\
public java.util.List<java.lang.String> l();
\n\
public R(int i,
@A long j,
java.util.List<java.lang.String> l);
}
""";
if (!Objects.equals(expected, output)) {
throw new AssertionError("Unexpected output: " + output);
}
}

}
@@ -0,0 +1,84 @@
/*
* Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/

/*
* @test
* @summary [lworld] test for equal treatment of annotations on primitive records (copy of ApplicableAnnotationsOnRecords)
* @bug 8273018
* @library /tools/lib
* @modules jdk.compiler/com.sun.tools.javac.util
* jdk.jdeps/com.sun.tools.classfile
* @run main ApplicableAnnotationsOnPrimitiveRecords
*/
import com.sun.tools.classfile.*;
import com.sun.tools.javac.util.Assert;
import java.lang.annotation.*;
import java.io.InputStream;

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
@interface FieldAnnotation {
}

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@interface MethodAnnotation {
}

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER})
@interface ParameterAnnotation {
}

public primitive record ApplicableAnnotationsOnPrimitiveRecords(@FieldAnnotation @MethodAnnotation @ParameterAnnotation String s, @FieldAnnotation @MethodAnnotation @ParameterAnnotation int i) {

public static void main(String... args) throws Exception {
try ( InputStream in = ApplicableAnnotationsOnPrimitiveRecords.class.getResourceAsStream("ApplicableAnnotationsOnPrimitiveRecords.class")) {
ClassFile cf = ClassFile.read(in);
Assert.check(cf.methods.length > 5);
for (Method m : cf.methods) {
String methodName = m.getName(cf.constant_pool);
if (methodName.equals("toString") || methodName.equals("hashCode") || methodName.equals("equals") || methodName.equals("main")) {
// ignore
} else if (methodName.equals("<init>")) {
var paAnnos = ((RuntimeVisibleParameterAnnotations_attribute) m.attributes.get(Attribute.RuntimeVisibleParameterAnnotations)).parameter_annotations;
Assert.check(paAnnos != null && paAnnos.length > 0);
for (var pa : paAnnos) {
Assert.check(pa.length == 1);
Assert.check(cf.constant_pool.getUTF8Value(pa[0].type_index).equals("LParameterAnnotation;"));
}
} else {
var annos = ((RuntimeAnnotations_attribute) m.attributes.get(Attribute.RuntimeVisibleAnnotations)).annotations;
Assert.check(annos.length == 1);
Assert.check(cf.constant_pool.getUTF8Value(annos[0].type_index).equals("LMethodAnnotation;"));
}
}
Assert.check(cf.fields.length > 0);
for (Field field : cf.fields) {
var annos = ((RuntimeAnnotations_attribute) field.attributes.get(Attribute.RuntimeVisibleAnnotations)).annotations;
Assert.check(annos.length == 1);
Assert.check(cf.constant_pool.getUTF8Value(annos[0].type_index).equals("LFieldAnnotation;"));
}
}
}
}