This structure contains information about file opened for either reading or writing. More...

#include <evio.h>

Data Fields
FILE *	file
	pointer to file. More...

int	handle
	handle used to access this structure. More...

int	rw
	are we reading, writing, piping? More...

int	magic
	magic number. More...

int	bigEndian
	if big endian = 1 else 0 More...

int	byte_swapped
	bytes need swapping = 1 else 0 More...

int	version
	evio FORMAT version number. More...

int	append
	open buffer or file for writing in append mode = 1, else 0. More...

uint32_t	eventCount
	current number of events in (or written to) file/buffer NOT including dictionary(ies). More...

uint32_t *	buf
	For files, sockets, and reading buffers = pointer to buffer of block-being-read / blocks-being-written. More...

uint32_t *	pBuf
	For reading ver 1-3 files, this points to the beginning of actual buffer in memory. More...

uint32_t *	next
	pointer to next word in buffer to be read/written. More...

uint32_t	left

uint32_t	blksiz
	size of block in 32 bit words - v3 or size of actual data in block (including header) - v4. More...

uint32_t	blknum
	block number of block being read/written. More...

int	blkNumDiff
	When reading, the difference between blknum read in and the expected (sequential) value. More...

uint32_t	blkSizeTarget
	target size of block in 32 bit words (including block header). More...

uint32_t	blkEvCount
	number of events written to block so far (including dictionary). More...

uint32_t	bufSize
	When reading, size of block buffer (buf) in 32 bit words. More...

uint32_t	bufRealSize
	When writing file/sock/pipe, total size of buffer being written to. More...

uint32_t	blkEvMax
	max number of events per block. More...

int	isLastBlock
	1 if buf contains last block of file/sock/buf, else 0. More...

uint32_t	blocksToParse
	reading file verions 1-3, # of blocks yet to be parsed. More...

char *	baseFileName
	base name of file to be written to. More...

char *	fileName
	actual name of file to be written to. More...

char *	runType
	run type used in auto naming of split files. More...

int	specifierCount
	number of C printing int format specifiers in file name (0, 1, 2). More...

int	splitting
	0 if not splitting file, else 1. More...

int	lastEmptyBlockHeaderExists
	1 if internal buffer has the last empty block header written, else 0. More...

uint32_t *	currentHeader
	When writing to file/socket/pipe, this points to current block header of block being written. More...

uint32_t	bytesToBuf

uint32_t	eventsToBuf

uint32_t	eventsToFile

uint64_t	bytesToFile

uint32_t	streamCount
	total # of streams in DAQ used in auto naming of files. More...

uint32_t	streamId
	stream id # used in auto naming of files. More...

uint32_t	runNumber
	run # used in auto naming of split files. More...

uint32_t	splitNumber
	number of next split file (used in auto naming). More...

uint64_t	split

uint64_t	fileSize
	size of file being read from, in bytes. More...

uint64_t	filePosition
	how far into the file have we read, in bytes. More...

char *	rwBuf
	pointer to buffer if reading/writing from/to buffer. More...

uint32_t	rwBufSize
	size of rwBuf buffer in bytes. More...

uint32_t	rwBytesOut
	number of bytes written to rwBuf with evWrite. More...

uint32_t	rwBytesIn
	number of bytes read from rwBuf so far (i.e. More...

int	rwFirstWrite
	1 if this evWrite is the first for this rwBuf, else 0. More...

int	sockFd
	socket file descriptor if reading/writing from/to socket. More...

int	randomAccess
	if true, use random access file/buffer reading. More...

size_t	mmapFileSize
	size of mapped file in bytes. More...

uint32_t *	mmapFile
	pointer to memory mapped file. More...

uint32_t **	pTable
	array of pointers to events in memory mapped file or buffer. More...

int	hasAppendDictionary
	if appending, true if first header says there is a dictionary. More...

int	wroteDictionary
	dictionary already written out to a single (split fragment) file? More...

uint32_t	dictLength
	length of dictionary bank in bytes (including entire header). More...

uint32_t *	dictBuf
	buffer containing dictionary bank. More...

char *	dictionary
	xml format dictionary to either read or write. More...

uint32_t	firstEventLength
	length of first event bank in bytes (including entire header). More...

uint32_t *	firstEventBuf
	buffer containing firstEvent bank. More...

uint32_t	commonBlkCount
	Number of events written into common block. More...

int	lockingOn
	if = 1 (default), turn on the use of a mutex for thread safety. More...

uint32_t	fileIndexArrayLen
	file header's index array len in bytes. More...

uint32_t	fileUserHeaderLen
	file header's user header len in bytes. More...

uint32_t	curRecordIndexArrayLen
	current record header's index array len in bytes. More...

uint32_t	curRecordUserHeaderLen
	current record header's user header len in bytes. More...

uint64_t	trailerPosition
	trailer's position from start of file in bytes (0 if unknown). More...

uint64_t	firstRecordPosition
	first record's position from start of file in bytes (0 if unknown). More...

uint32_t *	eventLengths
	For current record, an array containing the event lengths. More...

uint32_t	eventLengthsLen
	Size of eventLengths array in words, convenience variable when reading. More...

uint32_t *	dataBuf
	For writing, pointer to buffer of events (data) to be written. More...

uint32_t *	dataNext
	pointer to next word in dataBuf to be written. More...

uint32_t	dataLeft

uint32_t	bytesToDataBuf

Detailed Description

This structure contains information about file opened for either reading or writing.

Field Documentation

◆ append

int evfilestruct::append

open buffer or file for writing in append mode = 1, else 0.

If append = 2, then an event was already been appended.

Referenced by evFileStructInit().

◆ baseFileName

char* evfilestruct::baseFileName

base name of file to be written to.

Referenced by evFileStructInit(), and evGenerateFileNameOld().

◆ bigEndian

int evfilestruct::bigEndian

if big endian = 1 else 0

Referenced by evFileStructInit().

◆ blkEvCount

uint32_t evfilestruct::blkEvCount

number of events written to block so far (including dictionary).

Referenced by evFileStructInit().

◆ blkEvMax

uint32_t evfilestruct::blkEvMax

max number of events per block.

Referenced by evFileStructInit().

◆ blknum

uint32_t evfilestruct::blknum

block number of block being read/written.

Next to be used, starting at 1.

Referenced by evFileStructInit().

◆ blkNumDiff

int evfilestruct::blkNumDiff

When reading, the difference between blknum read in and the expected (sequential) value.

Used in debug message.

Referenced by evFileStructInit().

◆ blksiz

uint32_t evfilestruct::blksiz

size of block in 32 bit words - v3 or size of actual data in block (including header) - v4.

Referenced by evFileStructInit().

◆ blkSizeTarget

uint32_t evfilestruct::blkSizeTarget

target size of block in 32 bit words (including block header).

Referenced by evFileStructInit().

◆ blocksToParse

uint32_t evfilestruct::blocksToParse

reading file verions 1-3, # of blocks yet to be parsed.

Referenced by evFileStructInit().

◆ buf

uint32_t* evfilestruct::buf

For files, sockets, and reading buffers = pointer to buffer of block-being-read / blocks-being-written.

When writing to file/socket/pipe, this buffer may contain multiple blocks. When writing to buffer, this points to block header in block currently being written to (no separate block buffer exists). For reading ver 1-3 files, this points to block being parsed (multiple block are read in at once) and pBuf points to the beginning of actual buffer in memory.

Referenced by evFileStructInit().

◆ bufRealSize

uint32_t evfilestruct::bufRealSize

When writing file/sock/pipe, total size of buffer being written to.

Amount of memory actually allocated in 32 bit words (not all may be used).

Referenced by evFileStructInit().

◆ bufSize

uint32_t evfilestruct::bufSize

When reading, size of block buffer (buf) in 32 bit words.

When writing file/sock/pipe, size of buffer being written to that is actually being used (must be <= bufRealSize).

Referenced by evFileStructInit().

◆ byte_swapped

int evfilestruct::byte_swapped

bytes need swapping = 1 else 0

Referenced by evFileStructInit().

◆ bytesToBuf

uint32_t evfilestruct::bytesToBuf

bytes written to internal buffer including dict.

Referenced by evFileStructInit().

◆ bytesToDataBuf

uint32_t evfilestruct::bytesToDataBuf

data bytes written to dataBuf.

Referenced by evFileStructInit().

◆ bytesToFile

uint64_t evfilestruct::bytesToFile

bytes flushed to the current file (including ending

empty block & dictionary), not the total in all split files.

Referenced by evFileStructInit().

◆ commonBlkCount

uint32_t evfilestruct::commonBlkCount

Number of events written into common block.

This can be 2 at the most, dictionary + first event.

Referenced by evFileStructInit().

◆ curRecordIndexArrayLen

uint32_t evfilestruct::curRecordIndexArrayLen

current record header's index array len in bytes.

Referenced by evFileStructInit().

◆ curRecordUserHeaderLen

uint32_t evfilestruct::curRecordUserHeaderLen

current record header's user header len in bytes.

Referenced by evFileStructInit().

◆ currentHeader

uint32_t* evfilestruct::currentHeader

When writing to file/socket/pipe, this points to current block header of block being written.

Referenced by evFileStructInit().

◆ dataBuf

uint32_t* evfilestruct::dataBuf

For writing, pointer to buffer of events (data) to be written.

Due to evio version 6 having an array of event lengths after the record header and before the record data, we must store the data separately in order to facilitate writing the record with fewest number of data copies. Stores data for a single record. For convenience, it'll be same size as "buf".

Referenced by evFileStructInit().

◆ dataLeft

uint32_t evfilestruct::dataLeft

of valid 32 bit unwritten words in dataBuf.

Referenced by evFileStructInit().

◆ dataNext

uint32_t* evfilestruct::dataNext

pointer to next word in dataBuf to be written.

Referenced by evFileStructInit().

◆ dictBuf

uint32_t* evfilestruct::dictBuf

buffer containing dictionary bank.

Referenced by evFileStructInit().

◆ dictionary

char* evfilestruct::dictionary

xml format dictionary to either read or write.

Referenced by evFileStructInit().

◆ dictLength

uint32_t evfilestruct::dictLength

length of dictionary bank in bytes (including entire header).

Referenced by evFileStructInit().

◆ eventCount

uint32_t evfilestruct::eventCount

current number of events in (or written to) file/buffer NOT including dictionary(ies).

If the file being written to is split, this value refers to all split files taken together.

Referenced by evFileStructInit().

◆ eventLengths

uint32_t* evfilestruct::eventLengths

For current record, an array containing the event lengths.

blkEvCount tracks how many events and therefore entries in this array.

Referenced by evFileStructInit().

◆ eventLengthsLen

uint32_t evfilestruct::eventLengthsLen

Size of eventLengths array in words, convenience variable when reading.

Referenced by evFileStructInit().

◆ eventsToBuf

uint32_t evfilestruct::eventsToBuf

events written to internal buffer including dictionary.

Referenced by evFileStructInit().

◆ eventsToFile

uint32_t evfilestruct::eventsToFile

of events written to file including dictionary.

If the file is being split, this value refers to the file currently being written to.

Referenced by evFileStructInit().

◆ file

FILE* evfilestruct::file

pointer to file.

Referenced by evFileStructInit().

◆ fileIndexArrayLen

uint32_t evfilestruct::fileIndexArrayLen

file header's index array len in bytes.

Referenced by evFileStructInit().

◆ fileName

char* evfilestruct::fileName

actual name of file to be written to.

Referenced by evFileStructInit().

◆ filePosition

uint64_t evfilestruct::filePosition

how far into the file have we read, in bytes.

Referenced by evFileStructInit().

◆ fileSize

uint64_t evfilestruct::fileSize

size of file being read from, in bytes.

Referenced by evFileStructInit().

◆ fileUserHeaderLen

uint32_t evfilestruct::fileUserHeaderLen

file header's user header len in bytes.

Referenced by evFileStructInit().

◆ firstEventBuf

uint32_t* evfilestruct::firstEventBuf

buffer containing firstEvent bank.

Referenced by evFileStructInit().

◆ firstEventLength

uint32_t evfilestruct::firstEventLength

length of first event bank in bytes (including entire header).

Referenced by evFileStructInit().

◆ firstRecordPosition

uint64_t evfilestruct::firstRecordPosition

first record's position from start of file in bytes (0 if unknown).

◆ handle

int evfilestruct::handle

handle used to access this structure.

Referenced by evFileStructInit().

◆ hasAppendDictionary

int evfilestruct::hasAppendDictionary

if appending, true if first header says there is a dictionary.

Referenced by evFileStructInit().

◆ isLastBlock

int evfilestruct::isLastBlock

1 if buf contains last block of file/sock/buf, else 0.

Referenced by evFileStructInit().

◆ lastEmptyBlockHeaderExists

int evfilestruct::lastEmptyBlockHeaderExists

1 if internal buffer has the last empty block header written, else 0.

Referenced by evFileStructInit().

◆ left

uint32_t evfilestruct::left

of valid 32 bit unread/unwritten words in buffer.

Referenced by evFileStructInit().

◆ lockingOn

int evfilestruct::lockingOn

if = 1 (default), turn on the use of a mutex for thread safety.

Referenced by evFileStructInit().

◆ magic

int evfilestruct::magic

magic number.

Referenced by evFileStructInit().

◆ mmapFile

uint32_t* evfilestruct::mmapFile

pointer to memory mapped file.

Referenced by evFileStructInit().

◆ mmapFileSize

size_t evfilestruct::mmapFileSize

size of mapped file in bytes.

Referenced by evFileStructInit().

◆ next

uint32_t* evfilestruct::next

pointer to next word in buffer to be read/written.

Referenced by evFileStructInit().

◆ pBuf

uint32_t* evfilestruct::pBuf

For reading ver 1-3 files, this points to the beginning of actual buffer in memory.

Referenced by evFileStructInit().

◆ pTable

uint32_t** evfilestruct::pTable

array of pointers to events in memory mapped file or buffer.

Referenced by evFileStructInit().

◆ randomAccess

int evfilestruct::randomAccess

if true, use random access file/buffer reading.

Referenced by evFileStructInit().

◆ runNumber

uint32_t evfilestruct::runNumber

run # used in auto naming of split files.

Referenced by evFileStructInit().

◆ runType

char* evfilestruct::runType

run type used in auto naming of split files.

Referenced by evFileStructInit().

◆ rw

int evfilestruct::rw

are we reading, writing, piping?

Referenced by evFileStructInit(), and evGenerateFileNameOld().

◆ rwBuf

char* evfilestruct::rwBuf

pointer to buffer if reading/writing from/to buffer.

Referenced by evFileStructInit().

◆ rwBufSize

uint32_t evfilestruct::rwBufSize

size of rwBuf buffer in bytes.

Referenced by evFileStructInit().

◆ rwBytesIn

uint32_t evfilestruct::rwBytesIn

number of bytes read from rwBuf so far (i.e.

# bytes in buffer already used).

Referenced by evFileStructInit().

◆ rwBytesOut

uint32_t evfilestruct::rwBytesOut

number of bytes written to rwBuf with evWrite.

Referenced by evFileStructInit().

◆ rwFirstWrite

int evfilestruct::rwFirstWrite

1 if this evWrite is the first for this rwBuf, else 0.

Needed for calculating accurate value for rwBytesOut.

Referenced by evFileStructInit().

◆ sockFd

int evfilestruct::sockFd

socket file descriptor if reading/writing from/to socket.

Referenced by evFileStructInit().

◆ specifierCount

int evfilestruct::specifierCount

number of C printing int format specifiers in file name (0, 1, 2).

Referenced by evFileStructInit().

◆ split

uint64_t evfilestruct::split

of bytes at which to split file when writing

(defaults to EV_SPLIT_SIZE, 1GB).

Referenced by evFileStructInit().

◆ splitNumber

uint32_t evfilestruct::splitNumber

number of next split file (used in auto naming).

Referenced by evFileStructInit().

◆ splitting

int evfilestruct::splitting

0 if not splitting file, else 1.

Referenced by evFileStructInit().

◆ streamCount

uint32_t evfilestruct::streamCount

total # of streams in DAQ used in auto naming of files.

Referenced by evFileStructInit().

◆ streamId

uint32_t evfilestruct::streamId

stream id # used in auto naming of files.

Referenced by evFileStructInit().

◆ trailerPosition

uint64_t evfilestruct::trailerPosition

trailer's position from start of file in bytes (0 if unknown).

Referenced by evFileStructInit().

◆ version

int evfilestruct::version

evio FORMAT version number.

Referenced by evFileStructInit().

◆ wroteDictionary

int evfilestruct::wroteDictionary

dictionary already written out to a single (split fragment) file?

Referenced by evFileStructInit().

The documentation for this struct was generated from the following file:

evio.h

Data Fields

Detailed Description

Field Documentation

◆ append

◆ baseFileName

◆ bigEndian

◆ blkEvCount

◆ blkEvMax

◆ blknum

◆ blkNumDiff

◆ blksiz

◆ blkSizeTarget

◆ blocksToParse

◆ buf

◆ bufRealSize

◆ bufSize

◆ byte_swapped

◆ bytesToBuf

bytes written to internal buffer including dict.

◆ bytesToDataBuf

data bytes written to dataBuf.

◆ bytesToFile

bytes flushed to the current file (including ending

◆ commonBlkCount

◆ curRecordIndexArrayLen

◆ curRecordUserHeaderLen

◆ currentHeader

◆ dataBuf

◆ dataLeft

of valid 32 bit unwritten words in dataBuf.

◆ dataNext

◆ dictBuf

◆ dictionary

◆ dictLength

◆ eventCount

◆ eventLengths

◆ eventLengthsLen

◆ eventsToBuf

events written to internal buffer including dictionary.

◆ eventsToFile

of events written to file including dictionary.

◆ file

◆ fileIndexArrayLen

◆ fileName

◆ filePosition

◆ fileSize

◆ fileUserHeaderLen

◆ firstEventBuf

◆ firstEventLength

◆ firstRecordPosition

◆ handle

◆ hasAppendDictionary

◆ isLastBlock

◆ lastEmptyBlockHeaderExists

◆ left

of valid 32 bit unread/unwritten words in buffer.

◆ lockingOn

◆ magic

◆ mmapFile

◆ mmapFileSize

◆ next

◆ pBuf

◆ pTable

◆ randomAccess

◆ runNumber

◆ runType

◆ rw

◆ rwBuf

◆ rwBufSize

◆ rwBytesIn

◆ rwBytesOut

◆ rwFirstWrite

◆ sockFd

◆ specifierCount

◆ split

of bytes at which to split file when writing

◆ splitNumber

◆ splitting

◆ streamCount

◆ streamId