Jackie-Jiang commented on code in PR #15261: URL: https://github.com/apache/pinot/pull/15261#discussion_r2008073447
########## pinot-core/src/main/java/org/apache/pinot/core/data/manager/realtime/SemaphoreAccessCoordinator.java: ########## @@ -0,0 +1,251 @@ +/** + * 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.pinot.core.data.manager.realtime; + +import com.google.common.base.Preconditions; +import java.util.HashSet; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.Semaphore; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.locks.Condition; +import java.util.concurrent.locks.Lock; +import java.util.concurrent.locks.ReentrantLock; +import javax.annotation.Nullable; +import org.apache.pinot.common.metadata.segment.SegmentZKMetadata; +import org.apache.pinot.common.utils.LLCSegmentName; +import org.apache.pinot.common.utils.helix.HelixHelper; +import org.apache.pinot.segment.local.data.manager.SegmentDataManager; +import org.apache.pinot.spi.config.table.ingestion.StreamIngestionConfig; +import org.apache.pinot.spi.utils.CommonConstants; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +public class SemaphoreAccessCoordinator { + + private static final Logger LOGGER = LoggerFactory.getLogger(SemaphoreAccessCoordinator.class); + + private final Semaphore _semaphore; + private final boolean _enforceConsumptionInOrder; + private final Condition _condition; + private final Lock _lock; + @Nullable + private Set<Integer> _segmentSequenceNumSet = null; + private final RealtimeTableDataManager _realtimeTableDataManager; + private final AtomicBoolean _isFirstTransitionProcessed; + + public SemaphoreAccessCoordinator(Semaphore semaphore, boolean enforceConsumptionInOrder, + RealtimeTableDataManager realtimeTableDataManager) { + _semaphore = semaphore; + _lock = new ReentrantLock(); + _condition = _lock.newCondition(); + _enforceConsumptionInOrder = enforceConsumptionInOrder; + _realtimeTableDataManager = realtimeTableDataManager; + StreamIngestionConfig streamIngestionConfig = realtimeTableDataManager.getStreamIngestionConfig(); + boolean trackSegmentSeqNumber = false; + if (streamIngestionConfig != null) { + trackSegmentSeqNumber = streamIngestionConfig.isTrackSegmentSeqNumber(); + } + // if trackSegmentSeqNumber is false, server relies on ideal state to fetch previous segment to a segment. + if (trackSegmentSeqNumber) { + _segmentSequenceNumSet = new HashSet<>(); + } + _isFirstTransitionProcessed = new AtomicBoolean(false); + } + + public void acquire(LLCSegmentName llcSegmentName) + throws InterruptedException { + + String segmentName = llcSegmentName.getSegmentName(); + + if (_enforceConsumptionInOrder) { + waitForPrevSegment(llcSegmentName); + } + + long startTimeMs = System.currentTimeMillis(); + while (!_semaphore.tryAcquire(5, TimeUnit.MINUTES)) { + LOGGER.warn("Failed to acquire partitionGroup consumer semaphore in: {} ms. Retrying.", + System.currentTimeMillis() - startTimeMs); + + // if segment is marked online/offline by any instance, just return the current offline -> consuming + // transition. + if (!_enforceConsumptionInOrder && !isSegmentInProgress(segmentName)) { + throw new SegmentAlreadyConsumedException("segment: " + segmentName + " status must be in progress"); + } + } + } + + public void release() { + _semaphore.release(); + } + + public Semaphore getSemaphore() { + return _semaphore; + } + + public void trackSegment(LLCSegmentName llcSegmentName) { + _lock.lock(); + try { + if (_segmentSequenceNumSet != null) { + _segmentSequenceNumSet.add(llcSegmentName.getSequenceNumber()); + } + // notify all helix threads waiting for their offline -> consuming segment's prev segment to be loaded + _condition.signalAll(); + } finally { + _lock.unlock(); + } + } + + private void waitUntilTableIsReady() + throws InterruptedException { + while (!_realtimeTableDataManager.getIsTableReadyToConsumeData().getAsBoolean()) { + Thread.sleep(RealtimeTableDataManager.READY_TO_CONSUME_DATA_CHECK_INTERVAL_MS); + } + } + + private void waitForPrevSegment(LLCSegmentName currSegment) + throws InterruptedException { + + long startTimeMs = System.currentTimeMillis(); + + if ((_segmentSequenceNumSet == null) || (!_isFirstTransitionProcessed.get())) { + // if _segmentSequenceNumSet is null or no offline -> consuming transition has been processed, it means rely on + // ideal state to fetch previous segment. + String previousSegment = getPreviousSegment(currSegment); + if (previousSegment == null) { + // previous segment can only be null if either all the previous segments are deleted or this is the starting + // sequence segment of the partition Group. + return; + } + + SegmentDataManager segmentDataManager = _realtimeTableDataManager.acquireSegment(previousSegment); + try { + _lock.lock(); + while (segmentDataManager == null) { + // if segmentDataManager == null, it means segment is not loaded in the server. + // wait until it's loaded. + while (!_condition.await(5, TimeUnit.MINUTES)) { + LOGGER.warn("Semaphore access denied to segment: {}. Waiting on previous segment: {} since: {} ms.", + currSegment.getSegmentName(), previousSegment, System.currentTimeMillis() - startTimeMs); + } + segmentDataManager = _realtimeTableDataManager.acquireSegment(previousSegment); + } + } finally { + _lock.unlock(); + if (segmentDataManager != null) { + _realtimeTableDataManager.releaseSegment(segmentDataManager); + } + } + + // the first transition will always be prone to error, consider edge case where segment previous to current + // helix transition's segment was deleted and this server came alive after successful deletion. the prev + // segment will not exist, hence first transition is handled using isFirstTransitionSuccessful. + _isFirstTransitionProcessed.compareAndSet(false, true); + return; + } + + int prevSeqNum = currSegment.getSequenceNumber() - 1; + _lock.lock(); + try { + while (!_segmentSequenceNumSet.contains(prevSeqNum)) { + // if _segmentSequenceNumSet does not contain prev segment's seq num, it means segment is not loaded in the + // server. Wait until it's loaded. + while (!_condition.await(5, TimeUnit.MINUTES)) { + LOGGER.warn("Semaphore access denied to segment: {}." + + " Waiting on previous segment with sequence number: {} since: {} ms.", currSegment.getSegmentName(), + prevSeqNum, System.currentTimeMillis() - startTimeMs); + } + } + } finally { + _lock.unlock(); + } + } + + @Nullable + private String getPreviousSegment(LLCSegmentName currSegment) { + // if seq num of current segment is 102, maxSequenceNumBelowCurrentSegment must be highest seq num of any segment + // created before current segment + int maxSequenceNumBelowCurrentSegment = -1; + String previousSegment = null; + int currPartitionGroupId = currSegment.getPartitionGroupId(); + int currSequenceNum = currSegment.getSequenceNumber(); + + Map<String, Map<String, String>> segmentAssignment = + HelixHelper.getSegmentAssignment(_realtimeTableDataManager.getTableName(), Review Comment: I prefer the previous version of storing previous segment in segment ZK metadata. Reading ideal state per consuming segment could cause overhead for large table. You may also store the sequence_id of the previous segment ########## pinot-spi/src/main/java/org/apache/pinot/spi/config/table/ingestion/StreamIngestionConfig.java: ########## @@ -43,6 +43,12 @@ public class StreamIngestionConfig extends BaseJsonConfig { @JsonPropertyDescription("Whether pauseless consumption is enabled for the table") private boolean _pauselessConsumptionEnabled = false; + @JsonPropertyDescription("Enforce consumption of segments in order of segment creation by the controller") + private boolean _enforceConsumptionInOrder = false; + + @JsonPropertyDescription("If enabled, Server in-memory tracks the sequence number of all loaded segments") + private boolean _trackSegmentSeqNumber = true; Review Comment: We probably don't need to have a config for this. Does it work if we only keep a watermark of highest sequence id of the loaded segment? ########## pinot-spi/src/main/java/org/apache/pinot/spi/config/table/ingestion/StreamIngestionConfig.java: ########## @@ -43,6 +43,12 @@ public class StreamIngestionConfig extends BaseJsonConfig { @JsonPropertyDescription("Whether pauseless consumption is enabled for the table") private boolean _pauselessConsumptionEnabled = false; + @JsonPropertyDescription("Enforce consumption of segments in order of segment creation by the controller") + private boolean _enforceConsumptionInOrder = false; Review Comment: We should always enforce order for dedup and partial upsert to have consistent result. We can consider adding a config to turn it off for dedup and partial upsert, and another config to force it even if it is not dedup or partial upsert. It can also be configured as an enum so that we can use the same key to control the behavior ########## pinot-core/src/main/java/org/apache/pinot/core/data/manager/realtime/SemaphoreAccessCoordinator.java: ########## @@ -0,0 +1,251 @@ +/** + * 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.pinot.core.data.manager.realtime; + +import com.google.common.base.Preconditions; +import java.util.HashSet; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.Semaphore; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.locks.Condition; +import java.util.concurrent.locks.Lock; +import java.util.concurrent.locks.ReentrantLock; +import javax.annotation.Nullable; +import org.apache.pinot.common.metadata.segment.SegmentZKMetadata; +import org.apache.pinot.common.utils.LLCSegmentName; +import org.apache.pinot.common.utils.helix.HelixHelper; +import org.apache.pinot.segment.local.data.manager.SegmentDataManager; +import org.apache.pinot.spi.config.table.ingestion.StreamIngestionConfig; +import org.apache.pinot.spi.utils.CommonConstants; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +public class SemaphoreAccessCoordinator { Review Comment: Since you are extracting this out, consider changing the `Semaphore` to a `Lock`. It is not really used as a `Semaphore` -- 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: commits-unsubscr...@pinot.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For additional commands, e-mail: commits-h...@pinot.apache.org
