Skip to content

Commit

Permalink
Enable adversarial reads in RecordFormatTest
Browse files Browse the repository at this point in the history
  • Loading branch information
@lutovich
lutovich committed Feb 25, 2016
1 parent cafb75f commit d958e42
Show file tree
Hide file tree
Showing 5 changed files with 76 additions and 49 deletions.
5 changes: 5 additions & 0 deletions community/kernel/src/main/java/org/neo4j/kernel/impl/util/Bits.java
View file
Expand Up @@ -177,6 +177,11 @@ public String toString()
return builder.toString();
}

public static String numberToString( long value, int numberOfBytes )
{
return numberToString( new StringBuilder(), value, numberOfBytes ).toString();
}

public static StringBuilder numberToString( StringBuilder builder, long value, int numberOfBytes )
{
builder.append( "[" );
Expand Down
3 changes: 0 additions & 3 deletions ...ity/kernel/src/test/java/org/neo4j/kernel/impl/store/format/LowLimitRecordFormatTest.java
View file
Expand Up @@ -19,9 +19,6 @@
*/
package org.neo4j.kernel.impl.store.format;

import org.neo4j.kernel.impl.store.format.LimitedRecordGenerators;
import org.neo4j.kernel.impl.store.format.RecordFormatTest;
import org.neo4j.kernel.impl.store.format.RecordGenerators;
import org.neo4j.kernel.impl.store.format.lowlimit.LowLimit;

public class LowLimitRecordFormatTest extends RecordFormatTest
Expand Down
92 changes: 56 additions & 36 deletions community/kernel/src/test/java/org/neo4j/kernel/impl/store/format/RecordFormatTest.java
View file
Expand Up @@ -64,7 +64,7 @@ public abstract class RecordFormatTest
public static final RandomRule random = new RandomRule();

private final EphemeralFileSystemRule fsRule = new EphemeralFileSystemRule();
private final PageCacheRule pageCacheRule = new PageCacheRule( false /*true here later*/ );
private final PageCacheRule pageCacheRule = new PageCacheRule();
@Rule
public final RuleChain ruleChain = RuleChain.outerRule( pageCacheRule ).around( fsRule );

Expand Down Expand Up @@ -160,46 +160,13 @@ private <R extends AbstractBaseRecord> void verifyWriteAndRead(
R written = generator.get( recordSize, format );
try
{
// write
try ( PageCursor cursor = storeFile.io( 0, PagedFile.PF_SHARED_WRITE_LOCK ) )
{
assertedNext( cursor );
if ( written.inUse() )
{
format.prepare( written, recordSize, idSequence );
}
writeRecord( written, format, storeFile, recordSize, idSequence );

int offset = Math.toIntExact( written.getId() * recordSize );
cursor.setOffset( offset );
format.write( written, cursor, recordSize, storeFile );
}
long recordsUsedForWriting = storeFile.nextCalls();
long unusedBytes = storeFile.unusedBytes();
storeFile.resetMeasurements();

// read
try ( PageCursor cursor = storeFile.io( 0, PagedFile.PF_SHARED_READ_LOCK ) )
{
assertedNext( cursor );
int offset = Math.toIntExact( written.getId() * recordSize );
cursor.setOffset( offset );
@SuppressWarnings( "unchecked" )
R read = (R) written.clone(); // just to get a new instance
format.read( read, cursor, NORMAL, recordSize, storeFile );

// THEN
if ( written.inUse() )
{
assertEquals( written.inUse(), read.inUse() );
assertEquals( written.getId(), read.getId() );
assertEquals( written.getSecondaryUnitId(), read.getSecondaryUnitId() );
key.assertRecordsEquals( written, read );
}
else
{
assertEquals( written.inUse(), read.inUse() );
}
}
readAndVerifyRecord( written, format, key, storeFile, recordSize );

if ( written.inUse() )
{
Expand Down Expand Up @@ -248,6 +215,59 @@ private <R extends AbstractBaseRecord> void verifyWriteAndRead(
}
}

private <R extends AbstractBaseRecord> void readAndVerifyRecord( R written, RecordFormat<R> format,
RecordKey<R> key, PagedFile storeFile, int recordSize ) throws IOException
{
try ( PageCursor cursor = storeFile.io( 0, PagedFile.PF_SHARED_READ_LOCK ) )
{
assertedNext( cursor );
R read = format.newRecord();
read.setId( written.getId() );

/**
Retry loop is needed here because format does not handle retries on the primary cursor.
Same retry is done on the store level in {@link org.neo4j.kernel.impl.store.CommonAbstractStore}
*/
int offset = Math.toIntExact( written.getId() * recordSize );
do
{
cursor.setOffset( offset );
format.read( read, cursor, NORMAL, recordSize, storeFile );
}
while ( cursor.shouldRetry() );

// THEN
if ( written.inUse() )
{
assertEquals( written.inUse(), read.inUse() );
assertEquals( written.getId(), read.getId() );
assertEquals( written.getSecondaryUnitId(), read.getSecondaryUnitId() );
key.assertRecordsEquals( written, read );
}
else
{
assertEquals( written.inUse(), read.inUse() );
}
}
}

private <R extends AbstractBaseRecord> void writeRecord( R record, RecordFormat<R> format, PagedFile storeFile,
int recordSize, BatchingIdSequence idSequence ) throws IOException
{
try ( PageCursor cursor = storeFile.io( 0, PagedFile.PF_SHARED_WRITE_LOCK ) )
{
assertedNext( cursor );
if ( record.inUse() )
{
format.prepare( record, recordSize, idSequence );
}

int offset = Math.toIntExact( record.getId() * recordSize );
cursor.setOffset( offset );
format.write( record, cursor, recordSize, storeFile );
}
}

private double percent( long part, long total )
{
return 100.0D * part / total;
Expand Down
20 changes: 13 additions & 7 deletions ...java/org/neo4j/kernel/impl/store/format/highlimit/SecondaryPageCursorReadDataAdapter.java
View file
Expand Up @@ -23,8 +23,8 @@

import org.neo4j.io.pagecache.PageCursor;
import org.neo4j.io.pagecache.PagedFile;
import org.neo4j.kernel.impl.store.format.highlimit.BaseHighLimitRecordFormat;
import org.neo4j.kernel.impl.store.format.highlimit.Reference.DataAdapter;
import org.neo4j.kernel.impl.util.Bits;

/**
* {@link DataAdapter} able to acquire a secondary {@link PageCursor} on potentially a different page
Expand All @@ -38,6 +38,7 @@ class SecondaryPageCursorReadDataAdapter implements DataAdapter<PageCursor>, Sec
private final PageCursor secondaryCursor;
private final int secondaryOffset;
private boolean switched;
private byte secondaryHeaderByte;

SecondaryPageCursorReadDataAdapter( PageCursor cursor, PagedFile storeFile,
long secondaryPageId, int secondaryOffset, int primaryEndOffset, int pfFlags ) throws IOException
Expand All @@ -58,12 +59,9 @@ public byte get( PageCursor primaryCursor /*same as the one we have*/ )
// We've come to the end of the primary cursor, use the secondary cursor instead
if ( !switched )
{
// Just read out the header, get it out of the way and verify that this secondary record
// is in fact a secondary record.
// TODO can we do this in BaseHighLimitRecordFormat (the place where this adapter is created) instead?
byte secondaryHeaderByte = secondaryCursor.getByte();
assert (secondaryHeaderByte & BaseHighLimitRecordFormat.HEADER_BIT_RECORD_UNIT) != 0;
assert (secondaryHeaderByte & BaseHighLimitRecordFormat.HEADER_BIT_FIRST_RECORD_UNIT) == 0;
// Just read out the header, get it out of the way. Verification of the header byte happens in #close()
// because it is the only place where we surely read the consistent value
secondaryHeaderByte = secondaryCursor.getByte();
switched = true;
}
return secondaryCursor.getByte();
Expand Down Expand Up @@ -99,5 +97,13 @@ public boolean shouldRetry() throws IOException
public void close()
{
secondaryCursor.close();

assert (secondaryHeaderByte & BaseHighLimitRecordFormat.HEADER_BIT_RECORD_UNIT) != 0 : illegalHeader();
assert (secondaryHeaderByte & BaseHighLimitRecordFormat.HEADER_BIT_FIRST_RECORD_UNIT) == 0 : illegalHeader();
}

private String illegalHeader()
{
return "Read illegal secondary record unit header: " + Bits.numberToString( secondaryHeaderByte, Byte.BYTES );
}
}
5 changes: 2 additions & 3 deletions ...src/test/java/org/neo4j/kernel/impl/store/format/highlimit/HighLimitRecordFormatTest.java
View file
Expand Up @@ -22,14 +22,13 @@
import org.neo4j.kernel.impl.store.format.LimitedRecordGenerators;
import org.neo4j.kernel.impl.store.format.RecordFormatTest;
import org.neo4j.kernel.impl.store.format.RecordGenerators;
import org.neo4j.kernel.impl.store.format.highlimit.HighLimit;

public class HighLimitRecordFormatTest extends RecordFormatTest
{
protected static final RecordGenerators _50_BIT_LIMITS = new LimitedRecordGenerators( random, 50, 50, 50, 16, NULL );
private static final RecordGenerators HIGH_LIMITS = new LimitedRecordGenerators( random, 50, 50, 50, 16, NULL );

public HighLimitRecordFormatTest()
{
super( HighLimit.RECORD_FORMATS, _50_BIT_LIMITS );
super( HighLimit.RECORD_FORMATS, HIGH_LIMITS );
}
}

0 comments on commit d958e42

Please sign in to comment.