/*
* 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.jena.tdb.transaction;
import java.nio.ByteBuffer ;
import java.util.HashMap ;
import java.util.HashSet ;
import java.util.Iterator ;
import java.util.Map ;
import java.util.Set ;
import org.apache.jena.atlas.logging.Log ;
import org.apache.jena.query.ReadWrite ;
import org.apache.jena.sparql.util.Context ;
import org.apache.jena.tdb.TDB ;
import org.apache.jena.tdb.base.block.Block ;
import org.apache.jena.tdb.base.block.BlockException ;
import org.apache.jena.tdb.base.block.BlockMgr ;
import org.apache.jena.tdb.base.file.BufferAllocator ;
import org.apache.jena.tdb.base.file.BufferAllocatorDirect ;
import org.apache.jena.tdb.base.file.BufferAllocatorMapped ;
import org.apache.jena.tdb.base.file.BufferAllocatorMem ;
import org.apache.jena.tdb.sys.FileRef ;
import org.apache.jena.tdb.sys.SystemTDB ;
import org.slf4j.Logger ;
import org.slf4j.LoggerFactory ;
public class BlockMgrJournal implements BlockMgr, TransactionLifecycle
{
private static Logger log = LoggerFactory.getLogger(BlockMgrJournal.class) ;
private BlockMgr blockMgr ; // read-only except during journal checkpoint.
private Transaction transaction ;
private FileRef fileRef ;
private final BufferAllocator writeBlockBufferAllocator ;
private final Set<Long> readBlocks = new HashSet<>() ;
private final Set<Long> iteratorBlocks = new HashSet<>() ;
private final Map<Long, Block> writeBlocks = new HashMap<>() ;
private final Map<Long, Block> freedBlocks = new HashMap<>() ;
private boolean closed = false ;
private boolean active = false ; // In a transaction, or preparing.
public BlockMgrJournal(Transaction txn, FileRef fileRef, BlockMgr underlyingBlockMgr)
{
Context context = txn.getBaseDataset().getContext() ;
String mode = (null != context) ? (String) context.get(TDB.transactionJournalWriteBlockMode, "") : "" ;
if ("direct".equalsIgnoreCase(mode))
{
writeBlockBufferAllocator = new BufferAllocatorDirect() ;
}
else if ("mapped".equalsIgnoreCase(mode))
{
writeBlockBufferAllocator = new BufferAllocatorMapped(SystemTDB.BlockSize) ;
}
else
{
writeBlockBufferAllocator = new BufferAllocatorMem() ;
}
reset(txn, fileRef, underlyingBlockMgr) ;
if ( txn.getMode() == ReadWrite.READ && underlyingBlockMgr instanceof BlockMgrJournal )
System.err.println("Two level BlockMgrJournal") ;
}
@Override
public void begin(Transaction txn)
{
reset(txn, fileRef, blockMgr) ;
}
@Override
public void commitPrepare(Transaction txn)
{
checkActive() ;
for ( Block blk : writeBlocks.values() )
writeJournalEntry(blk) ;
this.active = false ;
}
@Override
public void commitEnact(Transaction txn)
{
// No-op : this is done by playing the master journal.
}
@Override
public void abort(Transaction txn)
{
checkActive() ;
this.active = false ;
// Do clearup of in-memory structures in clearup().
}
@Override
public void commitClearup(Transaction txn)
{
// Persistent state is in the system journal.
clear(txn) ;
}
/** Set, or reset, this BlockMgr.
*/
private void reset(Transaction txn, FileRef fileRef, BlockMgr underlyingBlockMgr)
{
this.fileRef = fileRef ;
this.blockMgr = underlyingBlockMgr ;
this.active = true ;
clear(txn) ;
}
private void clear(Transaction txn)
{
this.transaction = txn ;
this.readBlocks.clear() ;
this.iteratorBlocks.clear() ;
this.writeBlocks.clear() ;
this.freedBlocks.clear() ;
this.writeBlockBufferAllocator.clear() ;
}
@Override
public Block allocate(int blockSize)
{
checkIfClosed() ;
// Might as well allocate now.
// This allocates the id.
Block block = blockMgr.allocate(blockSize) ;
// [TxTDB:TODO]
// But we "copy" it by allocating ByteBuffer space.
if ( active )
{
block = replicate(block) ;
writeBlocks.put(block.getId(), block) ;
}
return block ;
}
@Override
public Block getRead(long id)
{
checkIfClosed() ;
Block block = localBlock(id) ;
if ( block != null )
return block ;
block = blockMgr.getRead(id) ;
if ( active )
readBlocks.add(block.getId()) ;
return block ;
}
@Override
public Block getReadIterator(long id)
{
//logState() ;
checkIfClosed() ;
Block block = localBlock(id) ;
if ( block == null )
block = blockMgr.getReadIterator(id) ;
if ( block == null )
throw new BlockException("No such block: "+getLabel()+" "+id) ;
if ( active )
iteratorBlocks.add(block.getId()) ;
return block ;
}
@Override
public Block getWrite(long id)
{
// NB: If we are in a stack of BlockMgrs, after a transaction has committed,
// we would be called via getRead and the upper Blockgr does the promotion.
checkActive() ;
checkIfClosed() ;
Block block = localBlock(id) ;
if ( block != null )
return block ;
// Get-as-read.
block = blockMgr.getRead(id) ;
// If most blocks get modified, then a copy is needed
// anyway so now is as good a time as any.
block = _promote(block) ;
return block ;
}
private Block localBlock(long id)
{
checkIfClosed() ;
return writeBlocks.get(id) ;
}
@Override
public Block promote(Block block)
{
checkIfClosed() ;
if ( writeBlocks.containsKey(block.getId()) )
return block ;
return _promote(block) ;
}
private Block _promote(Block block)
{
checkActive() ;
block = replicate(block) ;
writeBlocks.put(block.getId(), block) ;
return block ;
}
@Override
public void release(Block block)
{
checkIfClosed() ;
Long id = block.getId() ;
// Only release unchanged blocks.
if ( ! writeBlocks.containsKey(id))
blockMgr.release(block) ;
}
@Override
public void write(Block block)
{
checkIfClosed() ;
if ( ! block.isModified() )
Log.warn(this, "Page for block "+fileRef+"/"+block.getId()+" not modified") ;
if ( ! writeBlocks.containsKey(block.getId()) )
{
Log.warn(this, "Block not recognized: "+block.getId()) ;
// Probably corruption by writing in-place.
// but at least when this transaction commits,
// the update data is written,
writeBlocks.put(block.getId(), block) ;
}
}
@Override
public void overwrite(Block block)
{
// We are in a chain of BlockMgrs - pass down to the base.
blockMgr.overwrite(block) ;
}
@Override
public void free(Block block)
{
checkIfClosed() ;
freedBlocks.put(block.getId(), block) ;
}
@Override
public boolean isEmpty()
{
checkIfClosed() ;
return writeBlocks.isEmpty() && blockMgr.isEmpty() ;
}
@Override
public boolean valid(int id)
{
checkIfClosed() ;
if ( writeBlocks.containsKey(id) ) return true ;
return blockMgr.valid(id) ;
}
@Override
public void close()
{
writeBlockBufferAllocator.close() ;
closed = true ;
}
@Override
public boolean isClosed()
{
return closed ;
}
private void checkIfClosed()
{
if ( closed )
Log.fatal(this, "Already closed: "+transaction.getTxnId()) ;
}
private void checkActive()
{
if ( ! active )
Log.fatal(this, "Not active: "+transaction.getTxnId()) ;
TxnState state = transaction.getState() ;
if ( state != TxnState.ACTIVE && state != TxnState.PREPARING )
Log.fatal(this, "**** Not active: "+transaction.getTxnId()) ;
}
@Override
public void sync()
{
checkIfClosed() ;
}
@Override
public void syncForce()
{
blockMgr.syncForce() ;
}
// we only use the underlying blockMgr in read-mode - we don't write back blocks.
@Override
public void beginUpdate() { checkIfClosed() ; blockMgr.beginRead() ; }
@Override
public void endUpdate()
{
checkIfClosed() ;
blockMgr.endRead() ;
}
private void writeJournalEntry(Block blk)
{
blk.getByteBuffer().rewind() ;
transaction.getJournal().write(JournalEntryType.Block, fileRef, blk) ;
}
private void logState()
{
Log.info(this, "state: "+getLabel()) ;
Log.info(this, " readBlocks: "+readBlocks) ;
Log.info(this, " writeBlocks: "+writeBlocks) ;
Log.info(this, " iteratorBlocks: "+iteratorBlocks) ;
Log.info(this, " freedBlocks: "+freedBlocks) ;
}
@Override
public void beginRead() { checkIfClosed() ; blockMgr.beginRead() ; }
@Override
public void endRead() { checkIfClosed() ; blockMgr.endRead() ; }
@Override
public void beginIterator(Iterator<?> iterator)
{
checkIfClosed() ;
transaction.addIterator(iterator) ;
// Don't pass down the beginIterator call - we track and manage here, not lower down.
//blockMgr.beginIterator(iterator) ;
}
@Override
public void endIterator(Iterator<?> iterator)
{
checkIfClosed() ;
transaction.removeIterator(iterator) ;
// Don't pass down the beginIterator call - we track and manage here, not lower down.
//blockMgr.endIterator(iterator) ;
}
@Override
public String toString() { return "Journal:"+fileRef.getFilename()+" ("+blockMgr.getClass().getSimpleName()+")" ; }
@Override
public String getLabel() { return fileRef.getFilename() ; }
// Our own replicate method that gets the destination ByteBuffer from our allocator instead of always the heap
private Block replicate(Block srcBlock)
{
ByteBuffer dstBuffer = writeBlockBufferAllocator.allocate(srcBlock.getByteBuffer().capacity()) ;
return srcBlock.replicate(dstBuffer) ;
}
}