org.corfudb.infrastructure.log

Class StreamLogFiles

java.lang.Object

org.corfudb.infrastructure.log.StreamLogFiles

All Implemented Interfaces:

StreamLog, StreamLogWithRankedAddressSpace

public class StreamLogFiles
extends Object
implements StreamLog, StreamLogWithRankedAddressSpace

This class implements the StreamLog by persisting the stream log as records in multiple files. This StreamLog implementation can detect log file corruption, if checksum is enabled, otherwise the checksum field will be ignored.

Created by maithem on 10/28/16.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamLogFiles.Checksum

Field Summary

Fields

Modifier and Type	Field and Description
static int	METADATA_SIZE
static int	RECORDS_PER_LOG_FILE
static int	VERSION

Constructor Summary

Constructors

Constructor and Description
StreamLogFiles(ServerContext serverContext, boolean noVerify) Returns a file-based stream log object.

Method Summary

Modifier and Type	Method and Description
void	append(List<LogData> range) Append a range of consecutive entries ordered by their addresses.
void	append(long address, LogData entry) Append an entry to the stream log.
void	close() Close the stream log.
void	compact() Remove all trimmed addresses from the StreamLog.
TailsResponse	getAllTails() Get global and all stream tails.
long	getLogTail() Get the global log tail.
StreamsAddressResponse	getStreamsAddressSpace() Get the address space for every stream.
TailsResponse	getTails(List<UUID> streams) Get the global tail and stream tails.
long	getTrimMark() Get the first untrimmed address in the address space.
void	prefixTrim(long address) Prefix trim the global log.
LogData	read(long address) Given an address, read the corresponding stream entry.
void	reset() TODO(Maithem) remove this method.
void	sync(boolean force) Sync the stream log file to secondary storage.
static void	writeHeader(FileChannel fileChannel, int version, boolean verify) Write the header for a Corfu log file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.corfudb.infrastructure.log.StreamLogWithRankedAddressSpace

assertAppendPermittedUnsafe

Methods inherited from interface org.corfudb.infrastructure.log.StreamLog

getOverwriteCauseForAddress

Field Detail

METADATA_SIZE

public static final int METADATA_SIZE

VERSION

public static final int VERSION

See Also:

Constant Field Values

RECORDS_PER_LOG_FILE

public static final int RECORDS_PER_LOG_FILE

See Also:

Constant Field Values

Constructor Detail

StreamLogFiles

public StreamLogFiles(ServerContext serverContext,
                      boolean noVerify)

Returns a file-based stream log object.

Parameters:

serverContext - Context object that provides server state such as epoch, segment and start address

noVerify - Disable checksum if true

Method Detail

writeHeader

public static void writeHeader(FileChannel fileChannel,
                               int version,
                               boolean verify)
                        throws IOException

Write the header for a Corfu log file.

Parameters:

fileChannel - The file channel to use.

version - The version number to append to the header.

verify - Checksum verify flag

Throws:

IOException - I/O exception

getLogTail

public long getLogTail()

Description copied from interface: StreamLog

Get the global log tail.

Specified by:

getLogTail in interface StreamLog

getTails

public TailsResponse getTails(List<UUID> streams)

Description copied from interface: StreamLog

Get the global tail and stream tails.

Specified by:

getTails in interface StreamLog

getStreamsAddressSpace

public StreamsAddressResponse getStreamsAddressSpace()

Description copied from interface: StreamLog

Get the address space for every stream.

Specified by:

getStreamsAddressSpace in interface StreamLog

getAllTails

public TailsResponse getAllTails()

Description copied from interface: StreamLog

Get global and all stream tails.

Specified by:

getAllTails in interface StreamLog

prefixTrim

public void prefixTrim(long address)

Description copied from interface: StreamLog

Prefix trim the global log.

Specified by:

prefixTrim in interface StreamLog

Parameters:

address - address to trim the log up to

sync

public void sync(boolean force)
          throws IOException

Description copied from interface: StreamLog

Sync the stream log file to secondary storage.

Specified by:

sync in interface StreamLog

Parameters:

force - force data to secondary storage if true

Throws:

IOException

compact

public void compact()

Description copied from interface: StreamLog

Remove all trimmed addresses from the StreamLog.

Specified by:

compact in interface StreamLog

getTrimMark

public long getTrimMark()

Description copied from interface: StreamLog

Get the first untrimmed address in the address space.

Specified by:

getTrimMark in interface StreamLog

append

public void append(List<LogData> range)

Description copied from interface: StreamLog

Append a range of consecutive entries ordered by their addresses. Entries that are trimmed, or overwrites other addresses are ignored (i.e. they are not written) and an OverwriteException is not thrown.

Specified by:

append in interface StreamLog

append

public void append(long address,
                   LogData entry)

Description copied from interface: StreamLog

Append an entry to the stream log.

Specified by:

append in interface StreamLog

Parameters:

address - address of append entry

entry - entry to append to the log

read

public LogData read(long address)

Description copied from interface: StreamLog

Given an address, read the corresponding stream entry.

Specified by:

read in interface StreamLog

Parameters:

address - address to read from the log

Returns:

Stream entry if it exists, otherwise return null

close

public void close()

Description copied from interface: StreamLog

Close the stream log.

Specified by:

close in interface StreamLog

reset

public void reset()

TODO(Maithem) remove this method. Obtaining a new instance should happen through instantiation not by clearing this class' state

Resets the Stream log. Clears all data and resets the handlers. Usage: To heal a recovering node, we require to wipe off existing data.

Specified by:

reset in interface StreamLog