HHH-18976 Forbid any future new uses of Arrays#copyOf(Object[], int)

yrodiere · yrodiere · commit 0af4a21fb5ef · 2025-01-08T16:58:49.000+01:00
Because it uses Array#newInstance under the hood, and we forbid the use
of *that*.
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/model/process/spi/MetadataBuildingProcess.java b/hibernate-core/src/main/java/org/hibernate/boot/model/process/spi/MetadataBuildingProcess.java
@@ -12,7 +12,6 @@
 import java.time.OffsetTime;
 import java.time.ZonedDateTime;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashSet;
 import java.util.List;
@@ -69,6 +68,7 @@
 import org.hibernate.engine.config.spi.ConfigurationService;
 import org.hibernate.engine.config.spi.StandardConverters;
 import org.hibernate.engine.jdbc.spi.JdbcServices;
+import org.hibernate.internal.util.collections.ArrayHelper;
 import org.hibernate.mapping.Table;
 import org.hibernate.models.internal.MutableClassDetailsRegistry;
 import org.hibernate.models.spi.ClassDetails;
@@ -876,7 +876,7 @@ private static void adaptToPreferredSqlTypeCode(
 				jdbcTypeRegistry.getDescriptor( preferredSqlTypeCode ),
 				name
 		);
-		final String[] keys = Arrays.copyOf( additionalKeys, additionalKeys.length + 2 );
+		final String[] keys = ArrayHelper.copyOf( additionalKeys, additionalKeys.length + 2 );
 		keys[additionalKeys.length] = javaType.getSimpleName();
 		keys[additionalKeys.length + 1] = javaType.getName();
 		basicTypeRegistry.register( basicType, keys );
diff --git a/hibernate-core/src/main/java/org/hibernate/bytecode/enhance/internal/tracker/CompositeOwnerTracker.java b/hibernate-core/src/main/java/org/hibernate/bytecode/enhance/internal/tracker/CompositeOwnerTracker.java
@@ -7,6 +7,8 @@
 import java.util.Arrays;
 
 import org.hibernate.engine.spi.CompositeOwner;
+import org.hibernate.internal.build.AllowReflection;
+import org.hibernate.internal.util.collections.ArrayHelper;
 
 /**
  * small low memory class to keep references to composite owners
@@ -23,14 +25,15 @@ public CompositeOwnerTracker() {
 		owners = new CompositeOwner[0];
 	}
 
+	@AllowReflection // Possible array types are registered in org.hibernate.graalvm.internal.StaticClassLists.typesNeedingArrayCopy
 	public void add(String name, CompositeOwner owner) {
 		for ( int i = 0; i < names.length; i++ ) {
 			if ( names[i].equals( name ) ) {
 				owners[i] = owner;
 				return;
 			}
 		}
-		names = Arrays.copyOf( names, names.length + 1 );
+		names = ArrayHelper.copyOf( names, names.length + 1 );
 		names[names.length - 1] = name;
 		owners = Arrays.copyOf( owners, owners.length + 1 );
 		owners[owners.length - 1] = owner;
@@ -44,11 +47,12 @@ public void callOwner(String fieldName) {
 		}
 	}
 
+	@AllowReflection
 	public void removeOwner(String name) {
 		for ( int i = 0; i < names.length; i++ ) {
 			if ( name.equals( names[i] ) ) {
 
-				final String[] newNames = Arrays.copyOf( names, names.length - 1 );
+				final String[] newNames = ArrayHelper.copyOf( names, names.length - 1 );
 				System.arraycopy( names, i + 1, newNames, i, newNames.length - i);
 				names = newNames;
 
diff --git a/hibernate-core/src/main/java/org/hibernate/bytecode/enhance/internal/tracker/SimpleFieldTracker.java b/hibernate-core/src/main/java/org/hibernate/bytecode/enhance/internal/tracker/SimpleFieldTracker.java
@@ -4,8 +4,6 @@
  */
 package org.hibernate.bytecode.enhance.internal.tracker;
 
-import java.util.Arrays;
-
 import org.hibernate.internal.util.collections.ArrayHelper;
 
 /**
@@ -31,7 +29,7 @@ public void add(String name) {
 			return;
 		}
 		if ( !contains( name ) ) {
-			names = Arrays.copyOf( names, names.length + 1 );
+			names = ArrayHelper.copyOf( names, names.length + 1 );
 			names[names.length - 1] = name;
 		}
 	}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/JsonHelper.java b/hibernate-core/src/main/java/org/hibernate/dialect/JsonHelper.java
@@ -1546,6 +1546,7 @@ private static class CustomArrayList extends AbstractCollection<Object> implemen
 		Object[] array = ArrayHelper.EMPTY_OBJECT_ARRAY;
 		int size;
 
+		@AllowReflection
 		public void ensureCapacity(int minCapacity) {
 			int oldCapacity = array.length;
 			if ( minCapacity > oldCapacity ) {
@@ -1608,6 +1609,7 @@ public Object next() {
 		}
 
 		@Override
+		@AllowReflection
 		public Object[] toArray() {
 			return Arrays.copyOf( array, size );
 		}
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/internal/SessionEventListenerManagerImpl.java b/hibernate-core/src/main/java/org/hibernate/engine/internal/SessionEventListenerManagerImpl.java
@@ -11,6 +11,7 @@
 
 import org.hibernate.SessionEventListener;
 import org.hibernate.engine.spi.SessionEventListenerManager;
+import org.hibernate.internal.build.AllowReflection;
 
 /**
  * @author Steve Ebersole
@@ -30,6 +31,7 @@ public SessionEventListenerManagerImpl(List<SessionEventListener> initialListene
 	}
 
 	@Override
+	@AllowReflection
 	public void addListener(final SessionEventListener... additionalListeners) {
 		Objects.requireNonNull( additionalListeners );
 		final SessionEventListener[] existing = this.listeners;
diff --git a/hibernate-core/src/main/java/org/hibernate/internal/util/collections/StandardStack.java b/hibernate-core/src/main/java/org/hibernate/internal/util/collections/StandardStack.java
@@ -4,6 +4,8 @@
  */
 package org.hibernate.internal.util.collections;
 
+import org.hibernate.internal.build.AllowReflection;
+
 import java.util.Arrays;
 import java.util.NoSuchElementException;
 import java.util.function.BiFunction;
@@ -142,6 +144,7 @@ public <X, Y> X findCurrentFirstWithParameter(Y parameter, BiFunction<T, Y, X> b
 		return null;
 	}
 
+	@AllowReflection
 	private void grow() {
 		final int oldCapacity = elements.length;
 		final int jump = ( oldCapacity < 64 ) ? ( oldCapacity + 2 ) : ( oldCapacity >> 1 );
diff --git a/hibernate-core/src/main/java/org/hibernate/loader/ast/internal/MultiIdEntityLoaderArrayParam.java b/hibernate-core/src/main/java/org/hibernate/loader/ast/internal/MultiIdEntityLoaderArrayParam.java
@@ -200,6 +200,7 @@ protected Object[] toIdArray(List<Object> ids) {
 		return ids.toArray( idArray );
 	}
 
+	@AllowReflection
 	protected Object[] toIdArray(Object[] ids) {
 		if ( ids.getClass().equals( idArray.getClass() ) ) {
 			return ids;
diff --git a/hibernate-core/src/main/java/org/hibernate/loader/ast/internal/MultiKeyLoadHelper.java b/hibernate-core/src/main/java/org/hibernate/loader/ast/internal/MultiKeyLoadHelper.java
@@ -6,6 +6,7 @@
 
 import org.hibernate.dialect.Dialect;
 import org.hibernate.engine.spi.SessionFactoryImplementor;
+import org.hibernate.internal.build.AllowReflection;
 import org.hibernate.metamodel.mapping.JdbcMapping;
 import org.hibernate.type.BasicType;
 import org.hibernate.type.descriptor.java.BasicPluralJavaType;
@@ -74,6 +75,7 @@ static boolean hasSingleId(Object[] ids) {
 		return true;
 	}
 
+	@AllowReflection
 	static Object[] trimIdBatch(int length, Object[] keysToInitialize) {
 		int newLength = length;
 		while ( newLength>1 && keysToInitialize[newLength-1] == null ) {
diff --git a/hibernate-core/src/main/java/org/hibernate/persister/entity/mutation/TableSet.java b/hibernate-core/src/main/java/org/hibernate/persister/entity/mutation/TableSet.java
@@ -7,6 +7,7 @@
 import java.util.Arrays;
 import java.util.BitSet;
 
+import org.hibernate.internal.build.AllowReflection;
 import org.hibernate.sql.model.TableMapping;
 
 /**
@@ -68,6 +69,7 @@ private boolean addForChecks(final TableMapping tableMapping) {
 	}
 
 	//Meant for assertions only
+	@AllowReflection
 	private void ensureCapacity(final int position) {
 		final int increments = 3; //Needs to be at least 1.
 		if ( checks == null ) {
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/results/jdbc/internal/JdbcValuesResultSetImpl.java b/hibernate-core/src/main/java/org/hibernate/sql/results/jdbc/internal/JdbcValuesResultSetImpl.java
@@ -17,6 +17,7 @@
 import org.hibernate.engine.spi.SharedSessionContractImplementor;
 import org.hibernate.exception.DataException;
 import org.hibernate.exception.LockTimeoutException;
+import org.hibernate.internal.build.AllowReflection;
 import org.hibernate.query.spi.Limit;
 import org.hibernate.query.spi.QueryOptions;
 import org.hibernate.sql.ast.spi.SqlSelection;
@@ -346,6 +347,7 @@ public boolean usesFollowOnLocking() {
 	}
 
 	@Override
+	@AllowReflection
 	public void finishRowProcessing(RowProcessingState rowProcessingState, boolean wasAdded) {
 		if ( queryCachePutManager != null ) {
 			if ( wasAdded ) {
diff --git a/hibernate-testing/src/main/java/org/hibernate/testing/junit4/CustomParameterized.java b/hibernate-testing/src/main/java/org/hibernate/testing/junit4/CustomParameterized.java
@@ -18,6 +18,7 @@
 import java.util.SortedMap;
 import java.util.TreeMap;
 
+import org.hibernate.internal.build.AllowReflection;
 import org.junit.runner.Runner;
 import org.junit.runner.manipulation.NoTestsRemainException;
 import org.junit.runner.notification.RunNotifier;
@@ -84,6 +85,7 @@ protected List<Runner> getChildren() {
 		return runners;
 	}
 
+	@AllowReflection
 	private Iterable<Object[]> allParameters(List<FrameworkMethod> parametersMethods) throws Throwable {
 		ArrayList<Iterable<Object[]>> returnedParameters = new ArrayList<Iterable<Object[]>>();
 		ArrayList<Object[]> allParameters = new ArrayList<Object[]>();
diff --git a/rules/forbidden-apis.txt b/rules/forbidden-apis.txt
@@ -15,6 +15,11 @@ org.hibernate.internal.util.collections.ArrayHelper#newInstance(java.lang.Class,
 org.hibernate.internal.util.collections.ArrayHelper#filledArray(java.lang.Object, java.lang.Class, int)
 org.hibernate.internal.util.collections.ArrayHelper#join(java.lang.Object[], java.lang.Object[])
 
+@defaultMessage This forbidden method requires reflection and may not work in natively compiled applications. If you really must use this forbidden method, annotate the calling method with @AllowReflection.
+
+java.util.Arrays#copyOf(java.lang.Object[], int)
+java.util.Arrays#copyOf(java.lang.Object[], int, java.lang.Class)
+
 ################################################################################################################
 # Misc -- put things here as a last resort, but if possible prefer adding a category above with an actionable message.
 @defaultMessage Should not be used.

Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,6 @@`
`4`	`4`	`*/`
`5`	`5`	`package org.hibernate.bytecode.enhance.internal.tracker;`
`6`	`6`
`7`		`-import java.util.Arrays;`
`8`		`-`
`9`	`7`	`import org.hibernate.internal.util.collections.ArrayHelper;`
`10`	`8`
`11`	`9`	`/**`
`@@ -31,7 +29,7 @@ public void add(String name) {`
`31`	`29`	`return;`
`32`	`30`	`}`
`33`	`31`	`if ( !contains( name ) ) {`
`34`		`- names = Arrays.copyOf( names, names.length + 1 );`
	`32`	`+ names = ArrayHelper.copyOf( names, names.length + 1 );`
`35`	`33`	`names[names.length - 1] = name;`
`36`	`34`	`}`
`37`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1546,6 +1546,7 @@ private static class CustomArrayList extends AbstractCollection<Object> implemen`
`1546`	`1546`	`Object[] array = ArrayHelper.EMPTY_OBJECT_ARRAY;`
`1547`	`1547`	`int size;`
`1548`	`1548`
	`1549`	`+ @AllowReflection`
`1549`	`1550`	`public void ensureCapacity(int minCapacity) {`
`1550`	`1551`	`int oldCapacity = array.length;`
`1551`	`1552`	`if ( minCapacity > oldCapacity ) {`
`@@ -1608,6 +1609,7 @@ public Object next() {`
`1608`	`1609`	`}`
`1609`	`1610`
`1610`	`1611`	`@Override`
	`1612`	`+ @AllowReflection`
`1611`	`1613`	`public Object[] toArray() {`
`1612`	`1614`	`return Arrays.copyOf( array, size );`
`1613`	`1615`	`}`
Original file line number	Diff line number	Diff line change
`@@ -200,6 +200,7 @@ protected Object[] toIdArray(List<Object> ids) {`
`200`	`200`	`return ids.toArray( idArray );`
`201`	`201`	`}`
`202`	`202`
	`203`	`+ @AllowReflection`
`203`	`204`	`protected Object[] toIdArray(Object[] ids) {`
`204`	`205`	`if ( ids.getClass().equals( idArray.getClass() ) ) {`
`205`	`206`	`return ids;`