Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/java/org/apache/cassandra/db/tries/InMemoryTrie.java
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ final void putShort(int pos, short value)

final void putShortVolatile(int pos, short value)
{
getChunk(pos).putShort(inChunkPointer(pos), value);
getChunk(pos).putShortVolatile(inChunkPointer(pos), value);

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

potentially a copy-paste bug

}

final void putByte(int pos, byte value)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ protected AbstractSSTableIterator(SSTableReader sstable,
}
else
{
Reader reader = null;
Comment thread
iamaleksey marked this conversation as resolved.
boolean shouldCloseFile = file == null;
try
{
Expand All @@ -119,15 +120,18 @@ protected AbstractSSTableIterator(SSTableReader sstable,

// Note that this needs to be called after file != null and after the partitionDeletion has been set, but before readStaticRow
// (since it uses it) so we can't move that up (but we'll be able to simplify as soon as we drop support for the old file format).
this.reader = createReader(indexEntry, file, shouldCloseFile);
reader = createReader(indexEntry, file, shouldCloseFile);
this.staticRow = readStaticRow(sstable, file, helper, columns.fetchedColumns().statics);
}
else
{
this.partitionLevelDeletion = indexEntry.deletionTime();
this.staticRow = Rows.EMPTY_STATIC_ROW;
this.reader = createReader(indexEntry, file, shouldCloseFile);
reader = createReader(indexEntry, file, shouldCloseFile);
}

this.reader = reader;

if (!partitionLevelDeletion.validate())
UnfilteredValidation.handleInvalid(metadata(), key, sstable, "partitionLevelDeletion="+partitionLevelDeletion.toString());

Expand All @@ -137,9 +141,25 @@ protected AbstractSSTableIterator(SSTableReader sstable,
if (reader == null && file != null && shouldCloseFile)
file.close();
}
catch (IOException e)
catch (CorruptSSTableException | IOException e)
Comment thread
iamaleksey marked this conversation as resolved.
{
sstable.markSuspect();

if (reader != null)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when an exception occurs, we have a reader that might not get closed properly

{
try
{
reader.close();
// reader will close the file internally, so there's no
// need to close it in the next block
shouldCloseFile = false;
}
catch (IOException suppressed)
{
e.addSuppressed(suppressed);
}
}

String filePath = file.getPath();
if (shouldCloseFile)
Comment thread
iamaleksey marked this conversation as resolved.
{
Expand All @@ -152,6 +172,8 @@ protected AbstractSSTableIterator(SSTableReader sstable,
e.addSuppressed(suppressed);
}
}
if (e instanceof CorruptSSTableException)
throw (CorruptSSTableException)e;
Comment thread
iamaleksey marked this conversation as resolved.
throw new CorruptSSTableException(e, filePath);
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -330,13 +330,16 @@ protected SequentialWriter openDataWriter()
{
checkState(!dataWriterOpened, "Data writer has been already opened.");

return DataComponent.buildWriter(descriptor,
getTableMetadataRef().getLocal(),
getIOOptions().writerOptions,
getMetadataCollector(),
ensuringInBuildInternalContext(operationType),
getIOOptions().flushCompression,
getCompressionDictionaryManager());
SequentialWriter sequentialWriter = DataComponent.buildWriter(descriptor,
getTableMetadataRef().getLocal(),
getIOOptions().writerOptions,
getMetadataCollector(),
ensuringInBuildInternalContext(operationType),
getIOOptions().flushCompression,
getCompressionDictionaryManager());
dataWriterOpened = true;

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is missing setting dataWriterOpened. This doesn't seem to have any functional issues at the moment, but adding the fix for completeness


return sequentialWriter;
}

@Override
Expand Down
16 changes: 12 additions & 4 deletions src/java/org/apache/cassandra/io/tries/ReverseValueIterator.java

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, both here and for ValueIterator it would probably be better to wrap the entire if-else block in the constructors. So that if e.g. limit.next() call throws, we still clean up. It would also reduce the visual nesting where it matters more.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This minimizes the diff, but it actually makes more sense to handle it at the contractor instead

Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,18 @@ protected ReverseValueIterator(Rebufferer source, long root, ByteComparable star
super(source, root);
limit = start != null ? start.asComparableBytes(BYTE_COMPARABLE_VERSION) : null;

if (end != null)
initializeWithRightBound(root, end.asComparableBytes(BYTE_COMPARABLE_VERSION), admitPrefix, limit != null);
else
initializeNoRightBound(root, limit != null ? limit.next() : NOT_AT_LIMIT, admitPrefix);
try
{
if (end != null)
initializeWithRightBound(root, end.asComparableBytes(BYTE_COMPARABLE_VERSION), admitPrefix, limit != null);
else
initializeNoRightBound(root, limit != null ? limit.next() : NOT_AT_LIMIT, admitPrefix);
}
catch (Throwable t)
{
super.close();
throw t;
}
}

void initializeWithRightBound(long root, ByteSource endStream, boolean admitPrefix, boolean hasLimit)
Expand Down
108 changes: 50 additions & 58 deletions src/java/org/apache/cassandra/io/tries/ValueIterator.java
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,18 @@ protected ValueIterator(Rebufferer source, long root, ByteComparable start, Byte
limit = end != null ? end.asComparableBytes(BYTE_COMPARABLE_VERSION) : null;
collector = collecting ? new TransitionBytesCollector() : null;

if (start != null)
initializeWithLeftBound(root, start.asComparableBytes(BYTE_COMPARABLE_VERSION), admitPrefix, limit != null);
else
initializeNoLeftBound(root, limit != null ? limit.next() : 256);
try
{
if (start != null)
initializeWithLeftBound(root, start.asComparableBytes(BYTE_COMPARABLE_VERSION), admitPrefix, limit != null);
else
initializeNoLeftBound(root, limit != null ? limit.next() : 256);
}
catch (Throwable t)
{
super.close();
throw t;
}
}

private void initializeWithLeftBound(long root, ByteSource startStream, boolean admitPrefix, boolean atLimit)
Expand All @@ -110,76 +118,60 @@ private void initializeWithLeftBound(long root, ByteSource startStream, boolean
int limitByte;
long payloadedNode = -1;

try
// Follow start position while we still have a prefix, stacking path and saving prefixes.
go(root);
while (true)
{
// Follow start position while we still have a prefix, stacking path and saving prefixes.
go(root);
while (true)
{
int s = startStream.next();
childIndex = search(s);
int s = startStream.next();
childIndex = search(s);

// For a separator trie the latest payload met along the prefix is a potential match for start
if (admitPrefix)
// For a separator trie the latest payload met along the prefix is a potential match for start
if (admitPrefix)
{
if (childIndex == 0 || childIndex == -1)
{
if (childIndex == 0 || childIndex == -1)
{
if (hasPayload())
payloadedNode = position;
}
else
{
payloadedNode = -1;
}
if (hasPayload())
payloadedNode = position;
}

limitByte = 256;
if (atLimit)
else
{
limitByte = limit.next();
if (s < limitByte)
atLimit = false;
payloadedNode = -1;
}
if (childIndex < 0)
break;

prev = new IterationPosition(position, childIndex, limitByte, prev);
go(transition(childIndex)); // child index is positive, transition must exist
}

childIndex = -1 - childIndex - 1;
stack = new IterationPosition(position, childIndex, limitByte, prev);
limitByte = 256;
if (atLimit)
{
limitByte = limit.next();
if (s < limitByte)
atLimit = false;
}
if (childIndex < 0)
break;

// Advancing now gives us first match if we didn't find one already.
if (payloadedNode != -1)
next = payloadedNode;
else
next = advanceNode();
}
catch (Throwable t)
{
super.close();
throw t;
prev = new IterationPosition(position, childIndex, limitByte, prev);
go(transition(childIndex)); // child index is positive, transition must exist
}

childIndex = -1 - childIndex - 1;
stack = new IterationPosition(position, childIndex, limitByte, prev);

// Advancing now gives us first match if we didn't find one already.
if (payloadedNode != -1)
next = payloadedNode;
else
next = advanceNode();
}

private void initializeNoLeftBound(long root, int limitByte)
{
stack = new IterationPosition(root, -1, limitByte, null);

try
{
go(root);
if (hasPayload())
next = root;
else
next = advanceNode();
}
catch (Throwable t)
{
super.close();
throw t;
}
go(root);
if (hasPayload())
next = root;
else
next = advanceNode();
}

/**
Expand Down
2 changes: 1 addition & 1 deletion src/java/org/apache/cassandra/io/tries/Walker.java
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
public class Walker<CONCRETE extends Walker<CONCRETE>> implements AutoCloseable
{
/** Value used to indicate a branch (e.g. lesser/greaterBranch) does not exist. */
public static int NONE = TrieNode.NONE;
public static final int NONE = TrieNode.NONE;

private final Rebufferer source;
protected final long root;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
/*
* 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.cassandra.io.tries;

import java.io.IOException;
import java.nio.ByteBuffer;
import java.util.concurrent.atomic.AtomicBoolean;

import org.junit.Test;

import org.apache.cassandra.io.util.DataOutputBuffer;
import org.apache.cassandra.io.util.Rebufferer;
import org.apache.cassandra.utils.bytecomparable.ByteComparable;
import org.apache.cassandra.utils.bytecomparable.ByteSource;

import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

/**
* Reproducer: ReverseValueIterator leaks Rebufferer on constructor exception
*
* <p>If initializeWithRightBound() or initializeNoRightBound() throws after the Walker
* super-constructor acquires a Rebufferer, the Rebufferer is never closed. Compare with
* ValueIterator which wraps initialization in try-catch with super.close().
*
* Expected: Rebufferer.closeReader() is called when initialization throws.
* Actual (buggy): Rebufferer leaks — closeReader() never called.
* Failure criterion: closeReader() not called after constructor exception.
*/
@SuppressWarnings({"unchecked", "RedundantSuppression"})
public class ReverseValueIteratorLeakTest extends AbstractTrieTestBase
{
// ORACLE: Rebufferer.closeReader() must be called if constructor throws
@Test
public void testRebuffererClosedOnInitWithRightBoundFailure() throws IOException
{
// HARNESS: build a valid trie, wrap its Rebufferer with close tracking,
// then trigger a failure during initializeWithRightBound
DataOutputBuffer buf = new DataOutputBufferPaged();
IncrementalTrieWriter<Integer> builder = newTrieWriter(serializer, buf);
builder.add(source("aaa"), 1);
builder.add(source("bbb"), 2);
long root = builder.complete();

AtomicBoolean closeReaderCalled = new AtomicBoolean(false);
Rebufferer trackingSource = new TrackingRebufferer(buf.asNewBuffer(), closeReaderCalled);

// TRIGGER: provide a ByteComparable whose ByteSource throws during iteration,
// causing initializeWithRightBound to fail after Walker acquires the Rebufferer
ByteComparable throwingEnd = v -> new ByteSource()
{
private int calls = 0;

@Override
public int next()
{
if (++calls > 1)
throw new RuntimeException("simulated failure during trie traversal");
return 'b';
}
};

try
{
new ReverseValueIterator<>(trackingSource, root, source("aaa"), throwingEnd, false);
fail("Constructor should have thrown");
}
catch (RuntimeException e)
{
assertTrue("Expected simulated failure", e.getMessage().contains("simulated failure"));
}

// ORACLE: Rebufferer must have been closed despite the constructor failure
assertTrue("Rebufferer.closeReader() must be called when ReverseValueIterator " +
"constructor fails during initializeWithRightBound — without the fix, " +
"the Rebufferer leaks",
closeReaderCalled.get());
}

private static class TrackingRebufferer extends ByteBufRebufferer
{
private final AtomicBoolean closeReaderCalled;

TrackingRebufferer(ByteBuffer buffer, AtomicBoolean closeReaderCalled)
{
super(buffer);
this.closeReaderCalled = closeReaderCalled;
}

@Override
public void closeReader()
{
closeReaderCalled.set(true);
}
}
}