Skip to content

HHH-19483 EntityEntries #10217

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 2 commits into from
May 24, 2025
Merged

HHH-19483 EntityEntries #10217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad84955
use || operator
gavinking May 24, 2025
66ba5ce
HHH-19483 kill off completely unnecessary split into two kinds of Ent…
gavinking May 24, 2025
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
14 changes: 6 additions & 8 deletions hibernate-core/src/main/java/org/hibernate/engine/internal/EntityEntryContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,11 @@ public void addEntityEntry(Object entity, EntityEntry entityEntry) {
// any addition (even the double one described above) should invalidate the cross-ref array
dirty = true;

assert entityEntry instanceof AbstractEntityEntry;

// We only need to check a mutable EntityEntry is associated with the same PersistenceContext.
// Immutable EntityEntry can be associated with multiple PersistenceContexts, so no need to check.
// ImmutableEntityEntry#getPersistenceContext() throws an exception (HHH-10251).
assert !entityEntry.getPersister().isMutable()
|| ( (AbstractEntityEntry) entityEntry ).getPersistenceContext() == persistenceContext;
|| ( (EntityEntryImpl) entityEntry ).getPersistenceContext() == persistenceContext;

// Determine the appropriate ManagedEntity instance to use based on whether the entity is enhanced or not.
// Throw an exception if entity is a mutable ManagedEntity that is associated with a different
Expand Down Expand Up @@ -171,8 +169,8 @@ private ManagedEntity getAssociatedManagedEntity(Object entity) {
// it is not associated
return null;
}
final AbstractEntityEntry entityEntry =
(AbstractEntityEntry) managedEntity.$$_hibernate_getEntityEntry();
final EntityEntryImpl entityEntry =
(EntityEntryImpl) managedEntity.$$_hibernate_getEntityEntry();

if ( entityEntry.getPersister().isMutable() ) {
return entityEntry.getPersistenceContext() == persistenceContext
Expand Down Expand Up @@ -212,7 +210,7 @@ private void putImmutableManagedEntity(ManagedEntity managed, int instanceId, Im

private void checkNotAssociatedWithOtherPersistenceContextIfMutable(ManagedEntity managedEntity) {
// we only have to check mutable managedEntity
final AbstractEntityEntry entityEntry = (AbstractEntityEntry) managedEntity.$$_hibernate_getEntityEntry();
final EntityEntryImpl entityEntry = (EntityEntryImpl) managedEntity.$$_hibernate_getEntityEntry();
if ( entityEntry == null ||
!entityEntry.getPersister().isMutable() ||
entityEntry.getPersistenceContext() == null ||
Expand Down Expand Up @@ -729,8 +727,8 @@ public ImmutableManagedEntityHolder(ManagedEntity immutableManagedEntity) {
// Check instance type of EntityEntry and if type is ImmutableEntityEntry,
// check to see if entity is referenced cached in the second level cache
private static boolean canClearEntityEntryReference(EntityEntry entityEntry) {
return !(entityEntry instanceof ImmutableEntityEntry)
|| !isReferenceCachingEnabled( entityEntry.getPersister() );
final EntityPersister persister = entityEntry.getPersister();
return persister.isMutable() || !isReferenceCachingEnabled( persister );
}

@Override
Expand Down
148 changes: 99 additions & 49 deletions .../engine/internal/AbstractEntityEntry.java → ...nate/engine/internal/EntityEntryImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@
package org.hibernate.engine.internal;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;

import org.hibernate.AssertionFailure;
import org.hibernate.CustomEntityDirtinessStrategy;
import org.hibernate.HibernateException;
import org.hibernate.LockMode;
import org.hibernate.UnsupportedLockAttemptException;
import org.hibernate.bytecode.enhance.spi.interceptor.EnhancementAsProxyLazinessInterceptor;
import org.hibernate.collection.spi.PersistentCollection;
import org.hibernate.engine.spi.EntityEntry;
Expand All @@ -33,11 +35,11 @@
import org.checkerframework.checker.nullness.qual.Nullable;

import static org.hibernate.LockMode.PESSIMISTIC_FORCE_INCREMENT;
import static org.hibernate.engine.internal.AbstractEntityEntry.BooleanState.EXISTS_IN_DATABASE;
import static org.hibernate.engine.internal.AbstractEntityEntry.BooleanState.IS_BEING_REPLICATED;
import static org.hibernate.engine.internal.AbstractEntityEntry.EnumState.LOCK_MODE;
import static org.hibernate.engine.internal.AbstractEntityEntry.EnumState.PREVIOUS_STATUS;
import static org.hibernate.engine.internal.AbstractEntityEntry.EnumState.STATUS;
import static org.hibernate.engine.internal.EntityEntryImpl.BooleanState.EXISTS_IN_DATABASE;
import static org.hibernate.engine.internal.EntityEntryImpl.BooleanState.IS_BEING_REPLICATED;
import static org.hibernate.engine.internal.EntityEntryImpl.EnumState.LOCK_MODE;
import static org.hibernate.engine.internal.EntityEntryImpl.EnumState.PREVIOUS_STATUS;
import static org.hibernate.engine.internal.EntityEntryImpl.EnumState.STATUS;
import static org.hibernate.engine.internal.ManagedTypeHelper.asManagedEntity;
import static org.hibernate.engine.internal.ManagedTypeHelper.asPersistentAttributeInterceptable;
import static org.hibernate.engine.internal.ManagedTypeHelper.asSelfDirtinessTracker;
Expand All @@ -52,6 +54,7 @@
import static org.hibernate.engine.spi.Status.MANAGED;
import static org.hibernate.engine.spi.Status.READ_ONLY;
import static org.hibernate.engine.spi.Status.SAVING;
import static org.hibernate.internal.util.StringHelper.nullIfEmpty;
import static org.hibernate.pretty.MessageHelper.infoString;
import static org.hibernate.proxy.HibernateProxy.extractLazyInitializer;

Expand All @@ -63,17 +66,17 @@
* @author Gunnar Morling
* @author Sanne Grinovero
*/
public abstract class AbstractEntityEntry implements Serializable, EntityEntry {

protected final Object id;
protected Object[] loadedState;
protected Object version;
protected final EntityPersister persister; // permanent but we only need the entityName state in a non transient way
protected transient EntityKey cachedEntityKey; // cached EntityKey (lazy-initialized)
protected final transient Object rowId;
protected final transient PersistenceContext persistenceContext;
protected transient @Nullable ImmutableBitSet maybeLazySet;
protected EntityEntryExtraState next;
public final class EntityEntryImpl implements Serializable, EntityEntry {

private final Object id;
private Object[] loadedState;
private Object version;
private final EntityPersister persister; // permanent but we only need the entityName state in a non transient way
private transient EntityKey cachedEntityKey; // cached EntityKey (lazy-initialized)
private final transient Object rowId;
private final transient PersistenceContext persistenceContext;
private transient @Nullable ImmutableBitSet maybeLazySet;
private EntityEntryExtraState next;

/**
* Holds several boolean and enum typed attributes in a very compact manner. Enum values are stored in 4 bits
Expand Down Expand Up @@ -102,7 +105,7 @@ public abstract class AbstractEntityEntry implements Serializable, EntityEntry {
*/
private transient int compressedState;

public AbstractEntityEntry(
public EntityEntryImpl(
final Status status,
final Object[] loadedState,
final Object rowId,
Expand All @@ -127,14 +130,17 @@ public AbstractEntityEntry(
setCompressedValue( LOCK_MODE, lockMode );
setCompressedValue( IS_BEING_REPLICATED, disableVersionIncrement );
this.persister = persister;
this.persistenceContext = persistenceContext;
// don't store PersistenceContext for immutable entity, see HHH-10251
this.persistenceContext =
persister == null || persister.isMutable()
? persistenceContext
: null;
}

/**
* This for is used during custom deserialization handling
* Overloaded form used during custom deserialization
*/
protected AbstractEntityEntry(
final SessionFactoryImplementor factory,
private EntityEntryImpl(
final String entityName,
final Object id,
final Status status,
Expand All @@ -145,10 +151,14 @@ protected AbstractEntityEntry(
final LockMode lockMode,
final boolean existsInDatabase,
final boolean isBeingReplicated,
final boolean mutable,
final PersistenceContext persistenceContext) {
this.persister = factory == null
? null
: factory.getMappingMetamodel().getEntityDescriptor( entityName );
final SessionFactoryImplementor factory =
persistenceContext.getSession().getFactory();
this.persister =
factory == null
? null
: factory.getMappingMetamodel().getEntityDescriptor( entityName );
this.id = id;
setCompressedValue( STATUS, status );
setCompressedValue( PREVIOUS_STATUS, previousStatus );
Expand All @@ -159,7 +169,8 @@ protected AbstractEntityEntry(
setCompressedValue( EXISTS_IN_DATABASE, existsInDatabase );
setCompressedValue( IS_BEING_REPLICATED, isBeingReplicated );
this.rowId = null; // this is equivalent to the old behavior...
this.persistenceContext = persistenceContext;
// don't store PersistenceContext for immutable entity, see HHH-10251
this.persistenceContext = mutable ? persistenceContext : null;
}

@Override
Expand All @@ -169,10 +180,14 @@ public LockMode getLockMode() {

@Override
public void setLockMode(LockMode lockMode) {
if ( lockMode.greaterThan( LockMode.READ )
&& persister!=null && !persister.isMutable() ) {
throw new UnsupportedLockAttemptException( "Lock mode " + lockMode
+ " not supported for read-only entity" );
}
setCompressedValue( LOCK_MODE, lockMode );
}


@Override
public Status getStatus() {
return getCompressedValue( STATUS );
Expand All @@ -197,12 +212,12 @@ public void setStatus(Status status) {
}

@Override
public final Object getId() {
public Object getId() {
return id;
}

@Override
public final Object[] getLoadedState() {
public Object[] getLoadedState() {
return loadedState;
}

Expand Down Expand Up @@ -232,7 +247,7 @@ public boolean isExistsInDatabase() {
}

@Override
public final Object getVersion() {
public Object getVersion() {
return version;
}

Expand All @@ -242,7 +257,7 @@ public void postInsert(Object version) {
}

@Override
public final EntityPersister getPersister() {
public EntityPersister getPersister() {
return persister;
}

Expand Down Expand Up @@ -283,8 +298,8 @@ public void postUpdate(Object entity, Object[] updatedState, Object nextVersion)
persister.setValue( entity, persister.getVersionProperty(), nextVersion );
}

processIfSelfDirtinessTracker( entity, AbstractEntityEntry::clearDirtyAttributes );
processIfManagedEntity( entity, AbstractEntityEntry::useTracker );
processIfSelfDirtinessTracker( entity, EntityEntryImpl::clearDirtyAttributes );
processIfManagedEntity( entity, EntityEntryImpl::useTracker );

final SharedSessionContractImplementor session = getPersistenceContext().getSession();
session.getFactory().getCustomEntityDirtinessStrategy()
Expand Down Expand Up @@ -437,11 +452,11 @@ public void setReadOnly(boolean readOnly, Object entity) {
setStatus( READ_ONLY );
loadedState = null;
}
else if ( !persister.isMutable() ) {
throw new IllegalStateException( "Cannot make an entity of immutable type '"
+ persister.getEntityName() + "' modifiable" );
}
else {
if ( ! persister.isMutable() ) {
throw new IllegalStateException( "Cannot make an entity of immutable type '"
+ persister.getEntityName() + "' modifiable" );
}
setStatus( MANAGED );
loadedState = persister.getValues( entity );
TypeHelper.deepCopy(
Expand Down Expand Up @@ -483,19 +498,51 @@ public String toString() {
@Override
public void serialize(ObjectOutputStream oos) throws IOException {
final Status previousStatus = getPreviousStatus();
oos.writeObject( getEntityName() );
final String entityName = getEntityName();
oos.writeUTF( entityName == null ? "" : entityName );
oos.writeObject( id );
oos.writeObject( getStatus().name() );
oos.writeObject( (previousStatus == null ? "" : previousStatus.name()) );
oos.writeInt( getStatus().ordinal() );
oos.writeInt( previousStatus == null ? -1 : previousStatus.ordinal() );
// todo : potentially look at optimizing these two arrays
oos.writeObject( loadedState );
oos.writeObject( getDeletedState() );
oos.writeObject( version );
oos.writeObject( getLockMode().toString() );
oos.writeInt( getLockMode().ordinal() );
oos.writeBoolean( isExistsInDatabase() );
oos.writeBoolean( isBeingReplicated() );
oos.writeBoolean( persister == null || persister.isMutable() );
}

/**
* Custom deserialization routine used during deserialization
* of a {@link PersistenceContext} for increased performance.
*
* @param ois The stream from which to read the entry
* @param persistenceContext The context being deserialized
*
* @return The deserialized {@code EntityEntry}
*
* @throws IOException If a stream error occurs
* @throws ClassNotFoundException If any of the classes declared
* in the stream cannot be found
*/
public static EntityEntry deserialize(ObjectInputStream ois, PersistenceContext persistenceContext)
throws IOException, ClassNotFoundException {
return new EntityEntryImpl(
nullIfEmpty( ois.readUTF() ),
ois.readObject(),
Status.fromOrdinal( ois.readInt() ),
Status.fromOrdinal( ois.readInt() ),
(Object[]) ois.readObject(),
(Object[]) ois.readObject(),
ois.readObject(),
LockMode.values()[ ois.readInt() ],
ois.readBoolean(),
ois.readBoolean(),
ois.readBoolean(),
persistenceContext
);
}

@Override
public void addExtraState(EntityEntryExtraState extraState) {
Expand All @@ -520,7 +567,10 @@ public <T extends EntityEntryExtraState> T getExtraState(Class<T> extraStateType
}
}

public PersistenceContext getPersistenceContext(){
public PersistenceContext getPersistenceContext() {
if ( persistenceContext == null ) {
throw new UnsupportedOperationException( "PersistenceContext not available for immutable entity" );
}
return persistenceContext;
}

Expand All @@ -533,7 +583,7 @@ public PersistenceContext getPersistenceContext(){
* the value to store; The caller must make sure that it matches
* the given identifier
*/
protected <E extends Enum<E>> void setCompressedValue(EnumState<E> state, E value) {
<E extends Enum<E>> void setCompressedValue(EnumState<E> state, E value) {
// reset the bits for the given property to 0
compressedState &= state.getUnsetMask();
// store the numeric representation of the enum value at the right offset
Expand All @@ -547,7 +597,7 @@ protected <E extends Enum<E>> void setCompressedValue(EnumState<E> state, E valu
* identifies the value to store
* @return the current value of the specified property
*/
protected <E extends Enum<E>> E getCompressedValue(EnumState<E> state) {
<E extends Enum<E>> E getCompressedValue(EnumState<E> state) {
// restore the numeric value from the bits at the right offset and return the corresponding enum constant
final int index = ( ( compressedState & state.getMask() ) >> state.getOffset() ) - 1;
return index == - 1 ? null : state.getEnumConstants()[index];
Expand All @@ -561,7 +611,7 @@ protected <E extends Enum<E>> E getCompressedValue(EnumState<E> state) {
* @param value
* the value to store
*/
protected void setCompressedValue(BooleanState state, boolean value) {
void setCompressedValue(BooleanState state, boolean value) {
compressedState &= state.getUnsetMask();
compressedState |= ( state.getValue( value ) << state.getOffset() );
}
Expand All @@ -573,7 +623,7 @@ protected void setCompressedValue(BooleanState state, boolean value) {
* identifies the value to store
* @return the current value of the specified flag
*/
protected boolean getCompressedValue(BooleanState state) {
boolean getCompressedValue(BooleanState state) {
return ( ( compressedState & state.getMask() ) >> state.getOffset() ) == 1;
}

Expand All @@ -582,7 +632,7 @@ protected boolean getCompressedValue(BooleanState state) {
*
* @author Gunnar Morling
*/
protected static class EnumState<E extends Enum<E>> {
static class EnumState<E extends Enum<E>> {

protected static final EnumState<LockMode> LOCK_MODE = new EnumState<>( 0, LockMode.class );
protected static final EnumState<Status> STATUS = new EnumState<>( 4, Status.class );
Expand All @@ -593,11 +643,11 @@ protected static class EnumState<E extends Enum<E>> {
protected final int mask;
protected final int unsetMask;

private EnumState(int offset, Class<E> enumType) {
EnumState(int offset, Class<E> enumType) {
final E[] enumConstants = enumType.getEnumConstants();

// In case any of the enums cannot be stored in 4 bits anymore,
// we'd have to re-structure the compressed state int
// we'd have to restructure the compressed state int
if ( enumConstants.length > 15 ) {
throw new AssertionFailure( "Cannot store enum type " + enumType.getName()
+ " in compressed state as it has too many values." );
Expand Down Expand Up @@ -654,7 +704,7 @@ private E[] getEnumConstants() {
*
* @author Gunnar Morling
*/
protected enum BooleanState {
enum BooleanState {

EXISTS_IN_DATABASE(13),
IS_BEING_REPLICATED(14);
Expand Down
Loading