Skip to content

[GR-69100] Automatically check for misplaced @UnknownPrimitiveField and @UnknownObjectField annotations #12066

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 28, 2025
Merged

[GR-69100] Automatically check for misplaced @UnknownPrimitiveField and @UnknownObjectField annotations #12066

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion .../com.oracle.svm.hosted/src/com/oracle/svm/hosted/ameta/FieldValueInterceptionSupport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2023, 2023, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2023, 2025, 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
Expand All @@ -24,6 +24,7 @@
*/
package com.oracle.svm.hosted.ameta;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Arrays;
Expand Down Expand Up @@ -56,6 +57,7 @@
import com.oracle.svm.hosted.substitute.AnnotationSubstitutionProcessor;
import com.oracle.svm.hosted.substitute.AutomaticUnsafeTransformationSupport;
import com.oracle.svm.hosted.substitute.FieldValueTransformation;
import com.oracle.svm.util.ClassUtil;
import com.oracle.svm.util.ReflectionUtil;

import jdk.graal.compiler.nodes.ValueNode;
Expand Down Expand Up @@ -376,13 +378,15 @@ private static JavaConstant interceptWordField(AnalysisField field, JavaConstant
private static FieldValueComputer createFieldValueComputer(AnalysisField field) {
UnknownObjectField unknownObjectField = field.getAnnotation(UnknownObjectField.class);
if (unknownObjectField != null) {
checkMisplacedAnnotation(field.getStorageKind().isObject(), field);
return new FieldValueComputer(
ReflectionUtil.newInstance(unknownObjectField.availability()),
extractAnnotationTypes(field, unknownObjectField.types(), unknownObjectField.fullyQualifiedTypes()),
unknownObjectField.canBeNull());
}
UnknownPrimitiveField unknownPrimitiveField = field.getAnnotation(UnknownPrimitiveField.class);
if (unknownPrimitiveField != null) {
checkMisplacedAnnotation(field.getStorageKind().isPrimitive(), field);
return new FieldValueComputer(
ReflectionUtil.newInstance(unknownPrimitiveField.availability()),
List.of(field.getType().getJavaClass()),
Expand All @@ -391,6 +395,31 @@ private static FieldValueComputer createFieldValueComputer(AnalysisField field)
return null;
}

/**
* For compatibility reasons, we cannot unify {@link UnknownObjectField} and
* {@link UnknownPrimitiveField} into a single annotation, but we can at least notify the
* developers if the annotation is misplaced, e.g. {@link UnknownObjectField} is used on a
* primitive field and vice versa.
*/
private static void checkMisplacedAnnotation(boolean condition, AnalysisField field) {
if (!condition) {
String fieldType;
Class<? extends Annotation> expectedAnnotationType;
Class<? extends Annotation> usedAnnotationType;
if (field.getStorageKind().isObject()) {
fieldType = "object";
expectedAnnotationType = UnknownObjectField.class;
usedAnnotationType = UnknownPrimitiveField.class;
} else {
fieldType = "primitive";
expectedAnnotationType = UnknownPrimitiveField.class;
usedAnnotationType = UnknownObjectField.class;
}
throw UserError.abort("@%s should not be used on %s fields, use @%s on %s instead.", ClassUtil.getUnqualifiedName(usedAnnotationType),
fieldType, ClassUtil.getUnqualifiedName(expectedAnnotationType), field.format("%H.%n"));
}
}

private static List<Class<?>> extractAnnotationTypes(AnalysisField field, Class<?>[] types, String[] fullyQualifiedTypes) {
List<Class<?>> annotationTypes = new ArrayList<>(Arrays.asList(types));
for (String annotationTypeName : fullyQualifiedTypes) {
Expand Down