yihua commented on code in PR #13103: URL: https://github.com/apache/hudi/pull/13103#discussion_r2034094939
########## hudi-client/hudi-client-common/src/main/java/org/apache/hudi/client/transaction/lock/ConditionalWriteLockProvider.java: ########## @@ -0,0 +1,581 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hudi.client.transaction.lock; + +import org.apache.hudi.client.transaction.lock.models.StorageLockData; +import org.apache.hudi.client.transaction.lock.models.StorageLockFile; +import org.apache.hudi.client.transaction.lock.models.HeartbeatManager; +import org.apache.hudi.client.transaction.lock.models.LockGetResult; +import org.apache.hudi.client.transaction.lock.models.LockProviderHeartbeatManager; +import org.apache.hudi.client.transaction.lock.models.LockUpdateResult; +import org.apache.hudi.common.config.LockConfiguration; +import org.apache.hudi.common.lock.LockProvider; +import org.apache.hudi.common.lock.LockState; +import org.apache.hudi.common.util.CollectionUtils; +import org.apache.hudi.common.util.ReflectionUtils; +import org.apache.hudi.common.util.StringUtils; +import org.apache.hudi.common.util.VisibleForTesting; +import org.apache.hudi.common.util.collection.Pair; +import org.apache.hudi.common.util.hash.HashID; +import org.apache.hudi.exception.HoodieLockException; +import org.apache.hudi.exception.HoodieNotSupportedException; +import org.apache.hudi.storage.StorageConfiguration; +import org.apache.hudi.storage.StoragePath; +import org.apache.hudi.storage.StorageSchemes; + +import org.jetbrains.annotations.NotNull; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.annotation.concurrent.GuardedBy; +import javax.annotation.concurrent.ThreadSafe; + +import java.net.URI; +import java.net.URISyntaxException; +import java.util.Map; +import java.util.Objects; +import java.util.Properties; +import java.util.UUID; +import java.util.concurrent.TimeUnit; + +import static org.apache.hudi.common.lock.LockState.ACQUIRED; +import static org.apache.hudi.common.lock.LockState.ACQUIRING; +import static org.apache.hudi.common.lock.LockState.FAILED_TO_ACQUIRE; +import static org.apache.hudi.common.lock.LockState.FAILED_TO_RELEASE; +import static org.apache.hudi.common.lock.LockState.RELEASED; +import static org.apache.hudi.common.lock.LockState.RELEASING; +import static org.apache.hudi.common.table.HoodieTableMetaClient.LOCKS_FOLDER_NAME; + +@ThreadSafe +public class ConditionalWriteLockProvider implements LockProvider<StorageLockFile> { + + public static final String DEFAULT_TABLE_LOCK_FILE_NAME = "table_lock"; + // How long to wait before retrying lock acquisition in blocking calls. + private static final long DEFAULT_LOCK_ACQUISITION_BUFFER = 1000; + // Maximum expected clock drift between two nodes. + // This is similar idea as SkewAdjustingTimeGenerator. + // In reality, within a single cloud provider all nodes share the same ntp + // server + // therefore we do not expect drift more than a few ms. + // However, since our lock leases are pretty long, we can use a high buffer. + private static final long CLOCK_DRIFT_BUFFER_MS = 500; + + // When we retry lock upserts, do so 5 times + private static final long LOCK_UPSERT_RETRY_COUNT = 5; + + private static final String GCS_LOCK_SERVICE_CLASS_NAME = "org.apache.hudi.gcp.transaction.lock.GCSStorageLock"; + private static final String S3_LOCK_SERVICE_CLASS_NAME = "org.apache.hudi.aws.transaction.lock.S3StorageLock"; + + // The static logger to be shared across contexts + private static final Logger DEFAULT_LOGGER = LoggerFactory.getLogger(ConditionalWriteLockProvider.class); + private static final String LOCK_STATE_LOGGER_MSG = "Owner {}: Lock file path {}, Thread {}, Conditional Write lock state {}"; + private static final String LOCK_STATE_LOGGER_MSG_WITH_INFO = "Owner {}: Lock file path {}, Thread {}, Conditional Write lock state {}, {}"; + + private static final Map<String, String> SUPPORTED_LOCK_SERVICE_IMPLEMENTATIONS = CollectionUtils.createImmutableMap( + Pair.of(StorageSchemes.GCS.getScheme(), GCS_LOCK_SERVICE_CLASS_NAME), + Pair.of(StorageSchemes.S3A.getScheme(), S3_LOCK_SERVICE_CLASS_NAME), + Pair.of(StorageSchemes.S3.getScheme(), S3_LOCK_SERVICE_CLASS_NAME)); + + @VisibleForTesting + Logger logger; + + // The lock service implementation which interacts with cloud storage. + private final StorageLock lockService; + + // Local variables + private final long heartbeatIntervalMs; + private final long lockValidityMs; + private final String ownerId; + private final String lockFilePath; + private final String bucketName; + private final HeartbeatManager heartbeatManager; + + // Provide a place to store the "current lock object". + @GuardedBy("this") + private StorageLockFile currentLockObj = null; + // Ensures we do not try to lock after being closed. + @GuardedBy("this") + private boolean isClosed = false; + + private synchronized void setLock(StorageLockFile lockObj) { + if (lockObj != null && !Objects.equals(lockObj.getOwner(), this.ownerId)) { + throw new HoodieLockException("Owners do not match! Current LP owner: " + this.ownerId + " lock path: " + + this.lockFilePath + " owner: " + lockObj.getOwner()); + } + this.currentLockObj = lockObj; + } + + /** + * Default constructor for ConditionalWriteLockProvider, required by LockManager + * to instantiate it using reflection. + * + * @param lockConfiguration The lock configuration, should be transformable into + * ConditionalWriteLockConfig + * @param conf Storage config, ignored. + */ + public ConditionalWriteLockProvider(final LockConfiguration lockConfiguration, final StorageConfiguration<?> conf) { + ConditionalWriteLockConfig config = new ConditionalWriteLockConfig.Builder() + .fromProperties(lockConfiguration.getConfig()).build(); + heartbeatIntervalMs = config.getHeartbeatPollMs(); + lockValidityMs = config.getLockValidityTimeoutMs(); + + // Determine if the provided locks location is relative. + String configuredLocksLocation = config.getLocksLocation(); + + // If using base path, recalculate the locks location as .hoodie/.locks + String locksLocation = StringUtils.isNullOrEmpty(configuredLocksLocation) + ? String.format("%s%s%s", config.getHudiTableBasePath(), StoragePath.SEPARATOR, LOCKS_FOLDER_NAME) + : configuredLocksLocation; + + URI uri = parseURI(locksLocation); + bucketName = uri.getHost(); // For most schemes, the bucket/container is the host. + String folderName = uri.getPath(); // Path after the bucket/container. + + String fileName = StringUtils.isNullOrEmpty(configuredLocksLocation) + ? DEFAULT_TABLE_LOCK_FILE_NAME + : slugifyLockFolderFromBasePath(config.getHudiTableBasePath()); + + lockFilePath = buildLockObjectPath(folderName, fileName); + ownerId = UUID.randomUUID().toString(); + this.logger = DEFAULT_LOGGER; + this.heartbeatManager = new LockProviderHeartbeatManager( + ownerId, + heartbeatIntervalMs, + this::renewLock); + + try { + this.lockService = (StorageLock) ReflectionUtils.loadClass( + getLockServiceClassName(uri.getScheme()), + new Class<?>[] { String.class, String.class, String.class, Properties.class }, + new Object[] { ownerId, bucketName, lockFilePath, lockConfiguration.getConfig() }); + } catch (Throwable e) { + throw new HoodieLockException("Failed to load and initialize StorageLock", e); + } + + logger.info("Instantiated new Conditional Write LP, owner: {}, lockfilePath: {}", ownerId, lockFilePath); + } + + private URI parseURI(String location) { + try { + return new URI(location); + } catch (URISyntaxException e) { + throw new HoodieLockException("Unable to parse locks location as a URI: " + location, e); + } + } + + private static @NotNull String getLockServiceClassName(String scheme) { + if (SUPPORTED_LOCK_SERVICE_IMPLEMENTATIONS.containsKey(scheme) + && StorageSchemes.isConditionalWriteSupported(scheme)) { + return SUPPORTED_LOCK_SERVICE_IMPLEMENTATIONS.get(scheme); + } else { + throw new HoodieNotSupportedException("No implementation of StorageLock supports this scheme: " + scheme); + } + } + + @VisibleForTesting + ConditionalWriteLockProvider( + int heartbeatIntervalMs, + int lockValidityMs, + String bucketName, + String lockFilePath, + String ownerId, + HeartbeatManager heartbeatManager, + StorageLock lockService, + Logger logger) { + this.heartbeatIntervalMs = heartbeatIntervalMs; + this.lockValidityMs = lockValidityMs; + this.bucketName = bucketName; + this.lockFilePath = lockFilePath; + this.heartbeatManager = heartbeatManager; + this.lockService = lockService; + this.ownerId = ownerId; + this.logger = logger; + logger.debug("Instantiating new Conditional Write LP, owner: {}", ownerId); + } + + // ----------------------------------------- + // BASE METHODS + // ----------------------------------------- + + @Override + public synchronized StorageLockFile getLock() { + return currentLockObj; + } + + /** + * Attempts to acquire the lock within the given timeout. + */ + @Override + public boolean tryLock(long time, TimeUnit unit) { + long deadlineNanos = System.nanoTime() + unit.toNanos(time); + + while (System.nanoTime() < deadlineNanos) { + try { + if (tryLock()) { + return true; + } + logger.debug( + LOCK_STATE_LOGGER_MSG, + ownerId, + lockFilePath, + Thread.currentThread(), + ACQUIRING); + Thread.sleep(DEFAULT_LOCK_ACQUISITION_BUFFER); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new HoodieLockException(generateLockStateMessage(LockState.FAILED_TO_ACQUIRE), e); + } + } + + return false; + } + + @Override + public synchronized void close() { + try { + this.unlock(); + } catch (Exception e) { + logger.error("Owner {}: Failed to unlock current lock.", ownerId, e); + } + try { + this.lockService.close(); + } catch (Exception e) { + logger.error("Owner {}: Lock service failed to close.", ownerId, e); + } + try { + this.heartbeatManager.close(); + } catch (Exception e) { + logger.error("Owner {}: Heartbeat manager failed to close.", ownerId, e); + } + + this.isClosed = true; + } + + private synchronized boolean isLockStillValid(StorageLockFile lock) { + return !lock.isExpired() && !isCurrentTimeCertainlyOlderThanDistributedTime(lock.getValidUntil()); + } + + /** + * Attempts a single pass to acquire the lock (non-blocking). + * + * @return true if lock acquired, false otherwise + */ + @Override + public synchronized boolean tryLock() { + assertHeartBeatManagerExists(); + assertUnclosed(); + logger.debug(LOCK_STATE_LOGGER_MSG, ownerId, lockFilePath, Thread.currentThread(), ACQUIRING); + if (actuallyHoldsLock()) { + // Supports reentrant locks + return true; + } + + if (this.heartbeatManager.hasActiveHeartbeat()) { + logger.error("Detected broken invariant: there is an active heartbeat without a lock being held."); + // Breach of object invariant - we should never have an active heartbeat without + // holding a lock. + throw new HoodieLockException(generateLockStateMessage(FAILED_TO_ACQUIRE)); + } + + Pair<LockGetResult, StorageLockFile> latestLock = this.lockService.readCurrentLockFile(); + if (latestLock.getLeft() == LockGetResult.UNKNOWN_ERROR) { + logger.info( + LOCK_STATE_LOGGER_MSG_WITH_INFO, + ownerId, + lockFilePath, + Thread.currentThread(), + FAILED_TO_ACQUIRE, + "Failed to get the latest lock status"); Review Comment: Similar on all such logger calls. ########## hudi-client/hudi-client-common/src/main/java/org/apache/hudi/client/transaction/lock/ConditionalWriteLockProvider.java: ########## @@ -0,0 +1,581 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hudi.client.transaction.lock; + +import org.apache.hudi.client.transaction.lock.models.StorageLockData; +import org.apache.hudi.client.transaction.lock.models.StorageLockFile; +import org.apache.hudi.client.transaction.lock.models.HeartbeatManager; +import org.apache.hudi.client.transaction.lock.models.LockGetResult; +import org.apache.hudi.client.transaction.lock.models.LockProviderHeartbeatManager; +import org.apache.hudi.client.transaction.lock.models.LockUpdateResult; +import org.apache.hudi.common.config.LockConfiguration; +import org.apache.hudi.common.lock.LockProvider; +import org.apache.hudi.common.lock.LockState; +import org.apache.hudi.common.util.CollectionUtils; +import org.apache.hudi.common.util.ReflectionUtils; +import org.apache.hudi.common.util.StringUtils; +import org.apache.hudi.common.util.VisibleForTesting; +import org.apache.hudi.common.util.collection.Pair; +import org.apache.hudi.common.util.hash.HashID; +import org.apache.hudi.exception.HoodieLockException; +import org.apache.hudi.exception.HoodieNotSupportedException; +import org.apache.hudi.storage.StorageConfiguration; +import org.apache.hudi.storage.StoragePath; +import org.apache.hudi.storage.StorageSchemes; + +import org.jetbrains.annotations.NotNull; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.annotation.concurrent.GuardedBy; +import javax.annotation.concurrent.ThreadSafe; + +import java.net.URI; +import java.net.URISyntaxException; +import java.util.Map; +import java.util.Objects; +import java.util.Properties; +import java.util.UUID; +import java.util.concurrent.TimeUnit; + +import static org.apache.hudi.common.lock.LockState.ACQUIRED; +import static org.apache.hudi.common.lock.LockState.ACQUIRING; +import static org.apache.hudi.common.lock.LockState.FAILED_TO_ACQUIRE; +import static org.apache.hudi.common.lock.LockState.FAILED_TO_RELEASE; +import static org.apache.hudi.common.lock.LockState.RELEASED; +import static org.apache.hudi.common.lock.LockState.RELEASING; +import static org.apache.hudi.common.table.HoodieTableMetaClient.LOCKS_FOLDER_NAME; + +@ThreadSafe +public class ConditionalWriteLockProvider implements LockProvider<StorageLockFile> { + + public static final String DEFAULT_TABLE_LOCK_FILE_NAME = "table_lock"; + // How long to wait before retrying lock acquisition in blocking calls. + private static final long DEFAULT_LOCK_ACQUISITION_BUFFER = 1000; + // Maximum expected clock drift between two nodes. + // This is similar idea as SkewAdjustingTimeGenerator. + // In reality, within a single cloud provider all nodes share the same ntp + // server + // therefore we do not expect drift more than a few ms. + // However, since our lock leases are pretty long, we can use a high buffer. + private static final long CLOCK_DRIFT_BUFFER_MS = 500; + + // When we retry lock upserts, do so 5 times + private static final long LOCK_UPSERT_RETRY_COUNT = 5; + + private static final String GCS_LOCK_SERVICE_CLASS_NAME = "org.apache.hudi.gcp.transaction.lock.GCSStorageLock"; + private static final String S3_LOCK_SERVICE_CLASS_NAME = "org.apache.hudi.aws.transaction.lock.S3StorageLock"; + + // The static logger to be shared across contexts + private static final Logger DEFAULT_LOGGER = LoggerFactory.getLogger(ConditionalWriteLockProvider.class); + private static final String LOCK_STATE_LOGGER_MSG = "Owner {}: Lock file path {}, Thread {}, Conditional Write lock state {}"; + private static final String LOCK_STATE_LOGGER_MSG_WITH_INFO = "Owner {}: Lock file path {}, Thread {}, Conditional Write lock state {}, {}"; + + private static final Map<String, String> SUPPORTED_LOCK_SERVICE_IMPLEMENTATIONS = CollectionUtils.createImmutableMap( + Pair.of(StorageSchemes.GCS.getScheme(), GCS_LOCK_SERVICE_CLASS_NAME), + Pair.of(StorageSchemes.S3A.getScheme(), S3_LOCK_SERVICE_CLASS_NAME), + Pair.of(StorageSchemes.S3.getScheme(), S3_LOCK_SERVICE_CLASS_NAME)); + + @VisibleForTesting + Logger logger; + + // The lock service implementation which interacts with cloud storage. + private final StorageLock lockService; + + // Local variables + private final long heartbeatIntervalMs; + private final long lockValidityMs; + private final String ownerId; + private final String lockFilePath; + private final String bucketName; + private final HeartbeatManager heartbeatManager; + + // Provide a place to store the "current lock object". + @GuardedBy("this") + private StorageLockFile currentLockObj = null; + // Ensures we do not try to lock after being closed. + @GuardedBy("this") + private boolean isClosed = false; + + private synchronized void setLock(StorageLockFile lockObj) { + if (lockObj != null && !Objects.equals(lockObj.getOwner(), this.ownerId)) { + throw new HoodieLockException("Owners do not match! Current LP owner: " + this.ownerId + " lock path: " + + this.lockFilePath + " owner: " + lockObj.getOwner()); + } + this.currentLockObj = lockObj; + } + + /** + * Default constructor for ConditionalWriteLockProvider, required by LockManager + * to instantiate it using reflection. + * + * @param lockConfiguration The lock configuration, should be transformable into + * ConditionalWriteLockConfig + * @param conf Storage config, ignored. + */ + public ConditionalWriteLockProvider(final LockConfiguration lockConfiguration, final StorageConfiguration<?> conf) { + ConditionalWriteLockConfig config = new ConditionalWriteLockConfig.Builder() + .fromProperties(lockConfiguration.getConfig()).build(); + heartbeatIntervalMs = config.getHeartbeatPollMs(); + lockValidityMs = config.getLockValidityTimeoutMs(); + + // Determine if the provided locks location is relative. + String configuredLocksLocation = config.getLocksLocation(); + + // If using base path, recalculate the locks location as .hoodie/.locks + String locksLocation = StringUtils.isNullOrEmpty(configuredLocksLocation) + ? String.format("%s%s%s", config.getHudiTableBasePath(), StoragePath.SEPARATOR, LOCKS_FOLDER_NAME) + : configuredLocksLocation; + + URI uri = parseURI(locksLocation); + bucketName = uri.getHost(); // For most schemes, the bucket/container is the host. + String folderName = uri.getPath(); // Path after the bucket/container. + + String fileName = StringUtils.isNullOrEmpty(configuredLocksLocation) + ? DEFAULT_TABLE_LOCK_FILE_NAME + : slugifyLockFolderFromBasePath(config.getHudiTableBasePath()); + + lockFilePath = buildLockObjectPath(folderName, fileName); + ownerId = UUID.randomUUID().toString(); + this.logger = DEFAULT_LOGGER; + this.heartbeatManager = new LockProviderHeartbeatManager( + ownerId, + heartbeatIntervalMs, + this::renewLock); + + try { + this.lockService = (StorageLock) ReflectionUtils.loadClass( + getLockServiceClassName(uri.getScheme()), + new Class<?>[] { String.class, String.class, String.class, Properties.class }, + new Object[] { ownerId, bucketName, lockFilePath, lockConfiguration.getConfig() }); + } catch (Throwable e) { + throw new HoodieLockException("Failed to load and initialize StorageLock", e); + } + + logger.info("Instantiated new Conditional Write LP, owner: {}, lockfilePath: {}", ownerId, lockFilePath); + } + + private URI parseURI(String location) { + try { + return new URI(location); + } catch (URISyntaxException e) { + throw new HoodieLockException("Unable to parse locks location as a URI: " + location, e); + } + } + + private static @NotNull String getLockServiceClassName(String scheme) { + if (SUPPORTED_LOCK_SERVICE_IMPLEMENTATIONS.containsKey(scheme) + && StorageSchemes.isConditionalWriteSupported(scheme)) { + return SUPPORTED_LOCK_SERVICE_IMPLEMENTATIONS.get(scheme); + } else { + throw new HoodieNotSupportedException("No implementation of StorageLock supports this scheme: " + scheme); + } + } + + @VisibleForTesting + ConditionalWriteLockProvider( + int heartbeatIntervalMs, + int lockValidityMs, + String bucketName, + String lockFilePath, + String ownerId, + HeartbeatManager heartbeatManager, + StorageLock lockService, + Logger logger) { + this.heartbeatIntervalMs = heartbeatIntervalMs; + this.lockValidityMs = lockValidityMs; + this.bucketName = bucketName; + this.lockFilePath = lockFilePath; + this.heartbeatManager = heartbeatManager; + this.lockService = lockService; + this.ownerId = ownerId; + this.logger = logger; + logger.debug("Instantiating new Conditional Write LP, owner: {}", ownerId); + } + + // ----------------------------------------- + // BASE METHODS + // ----------------------------------------- + + @Override + public synchronized StorageLockFile getLock() { + return currentLockObj; + } + + /** + * Attempts to acquire the lock within the given timeout. + */ + @Override + public boolean tryLock(long time, TimeUnit unit) { + long deadlineNanos = System.nanoTime() + unit.toNanos(time); + + while (System.nanoTime() < deadlineNanos) { + try { + if (tryLock()) { + return true; + } + logger.debug( + LOCK_STATE_LOGGER_MSG, + ownerId, + lockFilePath, + Thread.currentThread(), + ACQUIRING); + Thread.sleep(DEFAULT_LOCK_ACQUISITION_BUFFER); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new HoodieLockException(generateLockStateMessage(LockState.FAILED_TO_ACQUIRE), e); + } + } + + return false; + } + + @Override + public synchronized void close() { + try { + this.unlock(); + } catch (Exception e) { + logger.error("Owner {}: Failed to unlock current lock.", ownerId, e); + } + try { + this.lockService.close(); + } catch (Exception e) { + logger.error("Owner {}: Lock service failed to close.", ownerId, e); + } + try { + this.heartbeatManager.close(); + } catch (Exception e) { + logger.error("Owner {}: Heartbeat manager failed to close.", ownerId, e); + } + + this.isClosed = true; + } + + private synchronized boolean isLockStillValid(StorageLockFile lock) { + return !lock.isExpired() && !isCurrentTimeCertainlyOlderThanDistributedTime(lock.getValidUntil()); + } + + /** + * Attempts a single pass to acquire the lock (non-blocking). + * + * @return true if lock acquired, false otherwise + */ + @Override + public synchronized boolean tryLock() { + assertHeartBeatManagerExists(); + assertUnclosed(); + logger.debug(LOCK_STATE_LOGGER_MSG, ownerId, lockFilePath, Thread.currentThread(), ACQUIRING); + if (actuallyHoldsLock()) { + // Supports reentrant locks + return true; + } + + if (this.heartbeatManager.hasActiveHeartbeat()) { + logger.error("Detected broken invariant: there is an active heartbeat without a lock being held."); + // Breach of object invariant - we should never have an active heartbeat without + // holding a lock. + throw new HoodieLockException(generateLockStateMessage(FAILED_TO_ACQUIRE)); + } + + Pair<LockGetResult, StorageLockFile> latestLock = this.lockService.readCurrentLockFile(); + if (latestLock.getLeft() == LockGetResult.UNKNOWN_ERROR) { + logger.info( + LOCK_STATE_LOGGER_MSG_WITH_INFO, + ownerId, + lockFilePath, + Thread.currentThread(), + FAILED_TO_ACQUIRE, + "Failed to get the latest lock status"); + // We were not able to determine whether a lock was present. + return false; + } + + if (latestLock.getLeft() == LockGetResult.SUCCESS && isLockStillValid(latestLock.getRight())) { + String msg = String.format("Lock already held by %s", latestLock.getRight().getOwner()); + // Lock held by others. + logger.info( + LOCK_STATE_LOGGER_MSG_WITH_INFO, + ownerId, + lockFilePath, + Thread.currentThread(), + FAILED_TO_ACQUIRE, + msg); + return false; + } + + // Try to acquire the lock + StorageLockData newLockData = new StorageLockData(false, System.currentTimeMillis() + lockValidityMs, ownerId); + Pair<LockUpdateResult, StorageLockFile> lockUpdateStatus = this.lockService.tryCreateOrUpdateLockFile( + newLockData, latestLock.getLeft() == LockGetResult.NOT_EXISTS ? null : latestLock.getRight()); + if (lockUpdateStatus.getLeft() != LockUpdateResult.SUCCESS) { + // failed to acquire the lock, indicates concurrent contention + logger.info( + LOCK_STATE_LOGGER_MSG, + ownerId, + lockFilePath, + Thread.currentThread(), + FAILED_TO_ACQUIRE); + return false; + } + this.setLock(lockUpdateStatus.getRight()); + + // There is a remote chance that + // - after lock is acquired but before heartbeat starts the lock is expired. + // - lock is acquired and heartbeat is up yet it does not run timely before the + // lock is expired + // It is mitigated by setting the lock validity period to a reasonably long + // period to survive until heartbeat comes, plus + // set the heartbeat interval relatively small enough. + if (!this.heartbeatManager.startHeartbeatForThread(Thread.currentThread())) { + // Precondition "no active heartbeat" is checked previously, so when + // startHeartbeatForThread returns false, + // we are confident no heartbeat thread is running. + logger.error( + LOCK_STATE_LOGGER_MSG_WITH_INFO, + ownerId, + lockFilePath, + Thread.currentThread(), + RELEASING, + "We were unable to start the heartbeat!"); + tryExpireCurrentLock(); + return false; + } + + logger.info( + LOCK_STATE_LOGGER_MSG, + ownerId, + lockFilePath, + Thread.currentThread(), + ACQUIRED); + return true; + } + + /** + * Determines whether this provider currently holds a valid lock. + * + * <p> + * This method checks both the existence of a lock object and its validity. A + * lock is considered + * valid only if it exists and has not expired according to its timestamp. + * + * @return {@code true} if this provider holds a valid lock, {@code false} + * otherwise + */ + private boolean actuallyHoldsLock() { + return believesLockMightBeHeld() && isLockStillValid(getLock()); + } + + /** + * Checks if this provider has a non-null lock object reference. + * + * <p> + * A non-null lock object indicates that this provider has previously + * **successfully** acquired a lock via + * ConditionalWriteLockProvider##lock and has not yet **successfully** released + * it via ConditionalWriteLockProvider#unlock(). + * It is merely an indicator that the lock might be held by this provider. To + * truly certify we are the owner of the lock, + * ConditionalWriteLockProvider#actuallyHoldsLock should be used. + * + * @return {@code true} if this provider has a non-null lock object, + * {@code false} otherwise + * @see ConditionalWriteLockProvider#actuallyHoldsLock() + */ + private boolean believesLockMightBeHeld() { + return this.getLock() != null; + } + + /** + * Unlock by marking our current lock file "expired": true. + */ + @Override + public synchronized void unlock() { + assertHeartBeatManagerExists(); + if (!believesLockMightBeHeld()) { + return; + } + boolean believesNoLongerHoldsLock = true; + + // Try to stop the heartbeat first + if (heartbeatManager.hasActiveHeartbeat()) { + logger.debug("Owner {}: Gracefully shutting down heartbeat.", ownerId); + believesNoLongerHoldsLock &= heartbeatManager.stopHeartbeat(true); + } + + // Then expire the current lock. + believesNoLongerHoldsLock &= tryExpireCurrentLock(); + if (!believesNoLongerHoldsLock) { + throw new HoodieLockException(generateLockStateMessage(FAILED_TO_RELEASE)); + } + } + + private void assertHeartBeatManagerExists() { Review Comment: ```suggestion private void assertHeartbeatManagerExists() { ``` ########## hudi-client/hudi-client-common/src/main/java/org/apache/hudi/client/transaction/lock/ConditionalWriteLockProvider.java: ########## @@ -0,0 +1,581 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hudi.client.transaction.lock; + +import org.apache.hudi.client.transaction.lock.models.StorageLockData; +import org.apache.hudi.client.transaction.lock.models.StorageLockFile; +import org.apache.hudi.client.transaction.lock.models.HeartbeatManager; +import org.apache.hudi.client.transaction.lock.models.LockGetResult; +import org.apache.hudi.client.transaction.lock.models.LockProviderHeartbeatManager; +import org.apache.hudi.client.transaction.lock.models.LockUpdateResult; +import org.apache.hudi.common.config.LockConfiguration; +import org.apache.hudi.common.lock.LockProvider; +import org.apache.hudi.common.lock.LockState; +import org.apache.hudi.common.util.CollectionUtils; +import org.apache.hudi.common.util.ReflectionUtils; +import org.apache.hudi.common.util.StringUtils; +import org.apache.hudi.common.util.VisibleForTesting; +import org.apache.hudi.common.util.collection.Pair; +import org.apache.hudi.common.util.hash.HashID; +import org.apache.hudi.exception.HoodieLockException; +import org.apache.hudi.exception.HoodieNotSupportedException; +import org.apache.hudi.storage.StorageConfiguration; +import org.apache.hudi.storage.StoragePath; +import org.apache.hudi.storage.StorageSchemes; + +import org.jetbrains.annotations.NotNull; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.annotation.concurrent.GuardedBy; +import javax.annotation.concurrent.ThreadSafe; + +import java.net.URI; +import java.net.URISyntaxException; +import java.util.Map; +import java.util.Objects; +import java.util.Properties; +import java.util.UUID; +import java.util.concurrent.TimeUnit; + +import static org.apache.hudi.common.lock.LockState.ACQUIRED; +import static org.apache.hudi.common.lock.LockState.ACQUIRING; +import static org.apache.hudi.common.lock.LockState.FAILED_TO_ACQUIRE; +import static org.apache.hudi.common.lock.LockState.FAILED_TO_RELEASE; +import static org.apache.hudi.common.lock.LockState.RELEASED; +import static org.apache.hudi.common.lock.LockState.RELEASING; +import static org.apache.hudi.common.table.HoodieTableMetaClient.LOCKS_FOLDER_NAME; + +@ThreadSafe +public class ConditionalWriteLockProvider implements LockProvider<StorageLockFile> { + + public static final String DEFAULT_TABLE_LOCK_FILE_NAME = "table_lock"; + // How long to wait before retrying lock acquisition in blocking calls. + private static final long DEFAULT_LOCK_ACQUISITION_BUFFER = 1000; + // Maximum expected clock drift between two nodes. + // This is similar idea as SkewAdjustingTimeGenerator. + // In reality, within a single cloud provider all nodes share the same ntp + // server + // therefore we do not expect drift more than a few ms. + // However, since our lock leases are pretty long, we can use a high buffer. + private static final long CLOCK_DRIFT_BUFFER_MS = 500; + + // When we retry lock upserts, do so 5 times + private static final long LOCK_UPSERT_RETRY_COUNT = 5; + + private static final String GCS_LOCK_SERVICE_CLASS_NAME = "org.apache.hudi.gcp.transaction.lock.GCSStorageLock"; + private static final String S3_LOCK_SERVICE_CLASS_NAME = "org.apache.hudi.aws.transaction.lock.S3StorageLock"; + + // The static logger to be shared across contexts + private static final Logger DEFAULT_LOGGER = LoggerFactory.getLogger(ConditionalWriteLockProvider.class); + private static final String LOCK_STATE_LOGGER_MSG = "Owner {}: Lock file path {}, Thread {}, Conditional Write lock state {}"; + private static final String LOCK_STATE_LOGGER_MSG_WITH_INFO = "Owner {}: Lock file path {}, Thread {}, Conditional Write lock state {}, {}"; + + private static final Map<String, String> SUPPORTED_LOCK_SERVICE_IMPLEMENTATIONS = CollectionUtils.createImmutableMap( + Pair.of(StorageSchemes.GCS.getScheme(), GCS_LOCK_SERVICE_CLASS_NAME), + Pair.of(StorageSchemes.S3A.getScheme(), S3_LOCK_SERVICE_CLASS_NAME), + Pair.of(StorageSchemes.S3.getScheme(), S3_LOCK_SERVICE_CLASS_NAME)); + + @VisibleForTesting + Logger logger; + + // The lock service implementation which interacts with cloud storage. + private final StorageLock lockService; + + // Local variables + private final long heartbeatIntervalMs; + private final long lockValidityMs; + private final String ownerId; + private final String lockFilePath; + private final String bucketName; + private final HeartbeatManager heartbeatManager; + + // Provide a place to store the "current lock object". + @GuardedBy("this") + private StorageLockFile currentLockObj = null; + // Ensures we do not try to lock after being closed. + @GuardedBy("this") + private boolean isClosed = false; + + private synchronized void setLock(StorageLockFile lockObj) { + if (lockObj != null && !Objects.equals(lockObj.getOwner(), this.ownerId)) { + throw new HoodieLockException("Owners do not match! Current LP owner: " + this.ownerId + " lock path: " + + this.lockFilePath + " owner: " + lockObj.getOwner()); + } + this.currentLockObj = lockObj; + } + + /** + * Default constructor for ConditionalWriteLockProvider, required by LockManager + * to instantiate it using reflection. + * + * @param lockConfiguration The lock configuration, should be transformable into + * ConditionalWriteLockConfig + * @param conf Storage config, ignored. + */ + public ConditionalWriteLockProvider(final LockConfiguration lockConfiguration, final StorageConfiguration<?> conf) { + ConditionalWriteLockConfig config = new ConditionalWriteLockConfig.Builder() + .fromProperties(lockConfiguration.getConfig()).build(); + heartbeatIntervalMs = config.getHeartbeatPollMs(); + lockValidityMs = config.getLockValidityTimeoutMs(); + + // Determine if the provided locks location is relative. + String configuredLocksLocation = config.getLocksLocation(); + + // If using base path, recalculate the locks location as .hoodie/.locks + String locksLocation = StringUtils.isNullOrEmpty(configuredLocksLocation) + ? String.format("%s%s%s", config.getHudiTableBasePath(), StoragePath.SEPARATOR, LOCKS_FOLDER_NAME) + : configuredLocksLocation; + + URI uri = parseURI(locksLocation); + bucketName = uri.getHost(); // For most schemes, the bucket/container is the host. + String folderName = uri.getPath(); // Path after the bucket/container. + + String fileName = StringUtils.isNullOrEmpty(configuredLocksLocation) + ? DEFAULT_TABLE_LOCK_FILE_NAME + : slugifyLockFolderFromBasePath(config.getHudiTableBasePath()); + + lockFilePath = buildLockObjectPath(folderName, fileName); + ownerId = UUID.randomUUID().toString(); + this.logger = DEFAULT_LOGGER; + this.heartbeatManager = new LockProviderHeartbeatManager( + ownerId, + heartbeatIntervalMs, + this::renewLock); + + try { + this.lockService = (StorageLock) ReflectionUtils.loadClass( + getLockServiceClassName(uri.getScheme()), + new Class<?>[] { String.class, String.class, String.class, Properties.class }, + new Object[] { ownerId, bucketName, lockFilePath, lockConfiguration.getConfig() }); + } catch (Throwable e) { + throw new HoodieLockException("Failed to load and initialize StorageLock", e); + } + + logger.info("Instantiated new Conditional Write LP, owner: {}, lockfilePath: {}", ownerId, lockFilePath); + } + + private URI parseURI(String location) { + try { + return new URI(location); + } catch (URISyntaxException e) { + throw new HoodieLockException("Unable to parse locks location as a URI: " + location, e); + } + } + + private static @NotNull String getLockServiceClassName(String scheme) { + if (SUPPORTED_LOCK_SERVICE_IMPLEMENTATIONS.containsKey(scheme) + && StorageSchemes.isConditionalWriteSupported(scheme)) { + return SUPPORTED_LOCK_SERVICE_IMPLEMENTATIONS.get(scheme); + } else { + throw new HoodieNotSupportedException("No implementation of StorageLock supports this scheme: " + scheme); + } + } + + @VisibleForTesting + ConditionalWriteLockProvider( + int heartbeatIntervalMs, + int lockValidityMs, + String bucketName, + String lockFilePath, + String ownerId, + HeartbeatManager heartbeatManager, + StorageLock lockService, + Logger logger) { + this.heartbeatIntervalMs = heartbeatIntervalMs; + this.lockValidityMs = lockValidityMs; + this.bucketName = bucketName; + this.lockFilePath = lockFilePath; + this.heartbeatManager = heartbeatManager; + this.lockService = lockService; + this.ownerId = ownerId; + this.logger = logger; + logger.debug("Instantiating new Conditional Write LP, owner: {}", ownerId); + } + + // ----------------------------------------- + // BASE METHODS + // ----------------------------------------- + + @Override + public synchronized StorageLockFile getLock() { + return currentLockObj; + } + + /** + * Attempts to acquire the lock within the given timeout. + */ + @Override + public boolean tryLock(long time, TimeUnit unit) { + long deadlineNanos = System.nanoTime() + unit.toNanos(time); + + while (System.nanoTime() < deadlineNanos) { + try { + if (tryLock()) { + return true; + } + logger.debug( + LOCK_STATE_LOGGER_MSG, + ownerId, + lockFilePath, + Thread.currentThread(), + ACQUIRING); + Thread.sleep(DEFAULT_LOCK_ACQUISITION_BUFFER); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new HoodieLockException(generateLockStateMessage(LockState.FAILED_TO_ACQUIRE), e); + } + } + + return false; + } + + @Override + public synchronized void close() { + try { + this.unlock(); + } catch (Exception e) { + logger.error("Owner {}: Failed to unlock current lock.", ownerId, e); + } + try { + this.lockService.close(); + } catch (Exception e) { + logger.error("Owner {}: Lock service failed to close.", ownerId, e); + } + try { + this.heartbeatManager.close(); + } catch (Exception e) { + logger.error("Owner {}: Heartbeat manager failed to close.", ownerId, e); + } + + this.isClosed = true; + } + + private synchronized boolean isLockStillValid(StorageLockFile lock) { + return !lock.isExpired() && !isCurrentTimeCertainlyOlderThanDistributedTime(lock.getValidUntil()); + } + + /** + * Attempts a single pass to acquire the lock (non-blocking). + * + * @return true if lock acquired, false otherwise + */ + @Override + public synchronized boolean tryLock() { + assertHeartBeatManagerExists(); + assertUnclosed(); + logger.debug(LOCK_STATE_LOGGER_MSG, ownerId, lockFilePath, Thread.currentThread(), ACQUIRING); + if (actuallyHoldsLock()) { + // Supports reentrant locks + return true; + } + + if (this.heartbeatManager.hasActiveHeartbeat()) { + logger.error("Detected broken invariant: there is an active heartbeat without a lock being held."); + // Breach of object invariant - we should never have an active heartbeat without + // holding a lock. + throw new HoodieLockException(generateLockStateMessage(FAILED_TO_ACQUIRE)); + } + + Pair<LockGetResult, StorageLockFile> latestLock = this.lockService.readCurrentLockFile(); + if (latestLock.getLeft() == LockGetResult.UNKNOWN_ERROR) { + logger.info( + LOCK_STATE_LOGGER_MSG_WITH_INFO, + ownerId, + lockFilePath, + Thread.currentThread(), + FAILED_TO_ACQUIRE, + "Failed to get the latest lock status"); + // We were not able to determine whether a lock was present. + return false; + } + + if (latestLock.getLeft() == LockGetResult.SUCCESS && isLockStillValid(latestLock.getRight())) { + String msg = String.format("Lock already held by %s", latestLock.getRight().getOwner()); + // Lock held by others. + logger.info( + LOCK_STATE_LOGGER_MSG_WITH_INFO, + ownerId, + lockFilePath, + Thread.currentThread(), + FAILED_TO_ACQUIRE, + msg); + return false; + } + + // Try to acquire the lock + StorageLockData newLockData = new StorageLockData(false, System.currentTimeMillis() + lockValidityMs, ownerId); + Pair<LockUpdateResult, StorageLockFile> lockUpdateStatus = this.lockService.tryCreateOrUpdateLockFile( + newLockData, latestLock.getLeft() == LockGetResult.NOT_EXISTS ? null : latestLock.getRight()); + if (lockUpdateStatus.getLeft() != LockUpdateResult.SUCCESS) { + // failed to acquire the lock, indicates concurrent contention + logger.info( + LOCK_STATE_LOGGER_MSG, + ownerId, + lockFilePath, + Thread.currentThread(), + FAILED_TO_ACQUIRE); + return false; + } + this.setLock(lockUpdateStatus.getRight()); + + // There is a remote chance that + // - after lock is acquired but before heartbeat starts the lock is expired. + // - lock is acquired and heartbeat is up yet it does not run timely before the + // lock is expired + // It is mitigated by setting the lock validity period to a reasonably long + // period to survive until heartbeat comes, plus + // set the heartbeat interval relatively small enough. + if (!this.heartbeatManager.startHeartbeatForThread(Thread.currentThread())) { + // Precondition "no active heartbeat" is checked previously, so when + // startHeartbeatForThread returns false, + // we are confident no heartbeat thread is running. + logger.error( + LOCK_STATE_LOGGER_MSG_WITH_INFO, + ownerId, + lockFilePath, + Thread.currentThread(), + RELEASING, + "We were unable to start the heartbeat!"); + tryExpireCurrentLock(); + return false; + } + + logger.info( + LOCK_STATE_LOGGER_MSG, + ownerId, + lockFilePath, + Thread.currentThread(), + ACQUIRED); + return true; + } + + /** + * Determines whether this provider currently holds a valid lock. + * + * <p> + * This method checks both the existence of a lock object and its validity. A + * lock is considered + * valid only if it exists and has not expired according to its timestamp. + * + * @return {@code true} if this provider holds a valid lock, {@code false} + * otherwise + */ + private boolean actuallyHoldsLock() { + return believesLockMightBeHeld() && isLockStillValid(getLock()); + } + + /** + * Checks if this provider has a non-null lock object reference. + * + * <p> + * A non-null lock object indicates that this provider has previously + * **successfully** acquired a lock via + * ConditionalWriteLockProvider##lock and has not yet **successfully** released + * it via ConditionalWriteLockProvider#unlock(). + * It is merely an indicator that the lock might be held by this provider. To + * truly certify we are the owner of the lock, + * ConditionalWriteLockProvider#actuallyHoldsLock should be used. + * + * @return {@code true} if this provider has a non-null lock object, + * {@code false} otherwise + * @see ConditionalWriteLockProvider#actuallyHoldsLock() + */ + private boolean believesLockMightBeHeld() { + return this.getLock() != null; + } + + /** + * Unlock by marking our current lock file "expired": true. + */ + @Override + public synchronized void unlock() { + assertHeartBeatManagerExists(); + if (!believesLockMightBeHeld()) { + return; + } + boolean believesNoLongerHoldsLock = true; + + // Try to stop the heartbeat first + if (heartbeatManager.hasActiveHeartbeat()) { + logger.debug("Owner {}: Gracefully shutting down heartbeat.", ownerId); + believesNoLongerHoldsLock &= heartbeatManager.stopHeartbeat(true); + } + + // Then expire the current lock. + believesNoLongerHoldsLock &= tryExpireCurrentLock(); + if (!believesNoLongerHoldsLock) { + throw new HoodieLockException(generateLockStateMessage(FAILED_TO_RELEASE)); + } + } + + private void assertHeartBeatManagerExists() { + if (heartbeatManager == null) { + // broken function precondition. + throw new HoodieLockException("Unexpected null heartbeatManager"); + } + } + + private void assertUnclosed() { + if (this.isClosed) { + throw new HoodieLockException("Lock provider already closed"); + } + } + + /** + * Tries to expire the currently held lock. + * + * @return True if we were successfully able to upload an expired lock. + */ + private synchronized boolean tryExpireCurrentLock() { + // It does not make sense to have heartbeat alive extending the lock lease while + // here we are trying + // to expire the lock. + if (heartbeatManager.hasActiveHeartbeat()) { + // broken function precondition. + throw new HoodieLockException("Must stop heartbeat before expire lock file"); + } + logger.debug(LOCK_STATE_LOGGER_MSG, ownerId, lockFilePath, Thread.currentThread(), RELEASING); + // Upload metadata that will unlock this lock. + Pair<LockUpdateResult, StorageLockFile> result = this.lockService.tryCreateOrUpdateLockFileWithRetry( + () -> new StorageLockData(true, this.getLock().getValidUntil(), ownerId), + this.getLock(), + // Keep retrying for the normal validity time. + LOCK_UPSERT_RETRY_COUNT); + switch (result.getLeft()) { + case UNKNOWN_ERROR: + // Here we do not know the state of the lock. + logger.error(LOCK_STATE_LOGGER_MSG, ownerId, lockFilePath, Thread.currentThread(), FAILED_TO_RELEASE); + return false; + case SUCCESS: + logger.info(LOCK_STATE_LOGGER_MSG, ownerId, lockFilePath, Thread.currentThread(), RELEASED); + setLock(null); + return true; + case ACQUIRED_BY_OTHERS: + // As we are confident no lock is held by itself, clean up the cached lock + // object. + logger.warn(LOCK_STATE_LOGGER_MSG, ownerId, lockFilePath, Thread.currentThread(), RELEASED); + setLock(null); + return true; + default: + throw new HoodieLockException("Unexpected lock update result: " + result.getLeft()); + } + } + + /** + * Renews (heartbeats) the current lock if we are the holder, it forcefully set + * the expiration flag + * to false and the lock expiration time to a later time in the future. + */ Review Comment: Add javadocs on the return value, i.e., what `true` or `false` indicates. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
