#include <StorageAccountProxy.h>

Inheritance diagram for StorageAccountProxy:

Public Member Functions
void	close (void) override

void	flush (void) override

IOOffset	position (IOOffset offset, Relative whence=SET) override

bool	prefetch (const IOPosBuffer *what, IOSize n) override

IOSize	read (IOBuffer into)

IOSize	read (IOBuffer into, IOOffset pos)

IOSize	read (void *into, IOSize n) override

virtual IOSize	read (void *into, IOSize n)=0

virtual IOSize	read (void *into, IOSize n, IOOffset pos)

IOSize	read (void *into, IOSize n, IOOffset pos) override

int	read (void)

IOSize	readv (IOBuffer *into, IOSize n) override

IOSize	readv (IOPosBuffer *into, IOSize n) override

void	resize (IOOffset size) override

	StorageAccountProxy (const std::string &storageClass, std::unique_ptr< Storage > baseStorage)

IOSize	write (const void *from, IOSize n) override

virtual IOSize	write (const void *from, IOSize n)=0

virtual IOSize	write (const void *from, IOSize n, IOOffset pos)

IOSize	write (const void *from, IOSize n, IOOffset pos) override

IOSize	write (IOBuffer from)

IOSize	write (IOBuffer from, IOOffset pos)

IOSize	write (unsigned char byte)

IOSize	writev (const IOBuffer *from, IOSize n) override

IOSize	writev (const IOPosBuffer *from, IOSize n) override

	~StorageAccountProxy (void) override

Public Member Functions inherited from Storage
virtual bool	eof (void) const

virtual IOOffset	position (void) const

IOSize	read (IOBuffer into)

IOSize	read (IOBuffer into, IOOffset pos)

virtual IOSize	read (void *into, IOSize n)=0

int	read (void)

virtual IOSize	readv (IOBuffer *into, IOSize buffers)

virtual void	rewind (void)

virtual IOOffset	size (void) const

	Storage (void)

virtual IOSize	write (const void *from, IOSize n)=0

IOSize	write (IOBuffer from)

IOSize	write (IOBuffer from, IOOffset pos)

IOSize	write (unsigned char byte)

virtual IOSize	writev (const IOBuffer *from, IOSize buffers)

	~Storage (void) override

Public Member Functions inherited from IOInput
IOSize	read (IOBuffer into)

int	read (void)

IOSize	xread (IOBuffer into)

IOSize	xread (void *into, IOSize n)

IOSize	xreadv (IOBuffer *into, IOSize buffers)

virtual	~IOInput (void)
	Destruct the stream. A no-op. More...

Public Member Functions inherited from IOOutput
IOSize	write (IOBuffer from)

IOSize	write (unsigned char byte)

IOSize	xwrite (const void *from, IOSize n)

IOSize	xwrite (IOBuffer from)

IOSize	xwritev (const IOBuffer *from, IOSize buffers)

virtual	~IOOutput (void)
	Destruct the stream. A no-op. More...

Protected Member Functions
void	releaseStorage ()

Protected Attributes
edm::propagate_const< std::unique_ptr< Storage > >	m_baseStorage

StorageAccount::Counter &	m_statsPosition

StorageAccount::Counter &	m_statsPrefetch

StorageAccount::Counter &	m_statsRead

StorageAccount::Counter &	m_statsReadV

StorageAccount::Counter &	m_statsWrite

StorageAccount::Counter &	m_statsWriteV

StorageAccount::StorageClassToken	m_token

Additional Inherited Members
Public Types inherited from Storage
enum	Relative { SET, CURRENT, END }

Detailed Description

Proxy class that wraps SEAL's Storage class with one that ticks StorageAccount counters for significant operations. The returned Storage objects from StorageMaker are automatically wrapped with this class.

Future improvement would be to implement more methods so that the wrapper itself doesn't cause peroformance degradation if the base storage does actually implement "sophisticated" features.

Definition at line 18 of file StorageAccountProxy.h.

Constructor & Destructor Documentation

◆ StorageAccountProxy()

StorageAccountProxy::StorageAccountProxy	(	const std::string &	storageClass,
		std::unique_ptr< Storage >	baseStorage
	)

Definition at line 3 of file StorageAccountProxy.cc.

     : m_baseStorage(std::move(baseStorage)),
       m_token(StorageAccount::tokenForStorageClassName(storageClass)),
       m_statsRead(StorageAccount::counter(m_token, StorageAccount::Operation::read)),
       m_statsReadV(StorageAccount::counter(m_token, StorageAccount::Operation::readv)),
       m_statsWrite(StorageAccount::counter(m_token, StorageAccount::Operation::write)),
       m_statsWriteV(StorageAccount::counter(m_token, StorageAccount::Operation::writev)),
       m_statsPosition(StorageAccount::counter(m_token, StorageAccount::Operation::position)),
       m_statsPrefetch(StorageAccount::counter(m_token, StorageAccount::Operation::prefetch)) {
   StorageAccount::Stamp stats(StorageAccount::counter(m_token, StorageAccount::Operation::construct));
   stats.tick();
 }

References StorageAccount::construct, StorageAccount::counter(), m_token, and dqmMemoryStats::stats.

◆ ~StorageAccountProxy()

StorageAccountProxy::~StorageAccountProxy ( void )

override

Definition at line 16 of file StorageAccountProxy.cc.

                                               {
   StorageAccount::Stamp stats(StorageAccount::counter(m_token, StorageAccount::Operation::destruct));
   releaseStorage();
   stats.tick();
 }

References StorageAccount::counter(), StorageAccount::destruct, m_token, releaseStorage(), and dqmMemoryStats::stats.

Member Function Documentation

◆ close()

void StorageAccountProxy::close ( void )

overridevirtual

Reimplemented from Storage.

Definition at line 97 of file StorageAccountProxy.cc.

                                     {
   StorageAccount::Stamp stats(StorageAccount::counter(m_token, StorageAccount::Operation::close));
   m_baseStorage->close();
   stats.tick();
 }

References StorageAccount::close, StorageAccount::counter(), m_baseStorage, m_token, and dqmMemoryStats::stats.

Referenced by esMonitoring.AsyncLineReaderMixin::handle_close(), and esMonitoring.FDJsonServer::handle_close().

◆ flush()

void StorageAccountProxy::flush ( void )

overridevirtual

Reimplemented from Storage.

Definition at line 91 of file StorageAccountProxy.cc.

                                     {
   StorageAccount::Stamp stats(StorageAccount::counter(m_token, StorageAccount::Operation::flush));
   m_baseStorage->flush();
   stats.tick();
 }

References StorageAccount::counter(), StorageAccount::flush, m_baseStorage, m_token, and dqmMemoryStats::stats.

◆ position()

IOOffset StorageAccountProxy::position	(	IOOffset	offset,
		Relative	whence = `SET`
	)

overridevirtual

Implements Storage.

Definition at line 78 of file StorageAccountProxy.cc.

                                                                        {
   StorageAccount::Stamp stats(m_statsPosition);
   IOOffset result = m_baseStorage->position(offset, whence);
   stats.tick();
   return result;
 }

References m_baseStorage, m_statsPosition, hltrates_dqm_sourceclient-live_cfg::offset, mps_fire::result, and dqmMemoryStats::stats.

◆ prefetch()

bool StorageAccountProxy::prefetch	(	const IOPosBuffer *	what,
		IOSize	n
	)

overridevirtual

Reimplemented from Storage.

Definition at line 103 of file StorageAccountProxy.cc.

                                                                     {
   StorageAccount::Stamp stats(m_statsPrefetch);
   bool value = m_baseStorage->prefetch(what, n);
   if (value) {
     IOSize total = 0;
     for (IOSize i = 0; i < n; ++i)
       total += what[i].size();
     stats.tick(total);
   }
   return value;
 }

References mps_fire::i, m_baseStorage, m_statsPrefetch, dqmiodumpmetadata::n, Storage::size(), dqmMemoryStats::stats, dqmMemoryStats::total, and relativeConstraints::value.

◆ read() [1/7]

IOSize IOInput::read

Read from the input stream into the buffer starting at into and of size n.

If this is a blocking stream, the call will block until some data can be read, end of input is reached, or an exception is thrown. For a non-blocking stream the available input is returned. If none is available, an exception is thrown.

The base class implementation simply forwards the call to read(void *, IOSize) method.

Returns: The number of bytes actually read. This is less or equal to the size of the buffer. Zero indicates that the end of the input has been reached: end of file, or remote end closing for a connected channel like a pipe or a socket. Otherwise the value can be less than requested if limited amount of input is currently available for platform or implementation reasons.

Exceptions

In	case of error, a #IOError exception is thrown. This includes the situation where the input stream is in non-blocking mode and no input is currently available (FIXME: make this simpler; clarify which exception).

Definition at line 80 of file IOInput.cc.

80 { return read(into.data(), into.size()); }

◆ read() [2/7]

IOSize Storage::read

Definition at line 10 of file Storage.cc.

10 { return read(into.data(), into.size(), pos); }

◆ read() [3/7]

IOSize StorageAccountProxy::read	(	void *	into,
		IOSize	n
	)

overridevirtual

Read into into at most n number of bytes.

If this is a blocking stream, the call will block until some data can be read, end of input is reached, or an exception is thrown. For a non-blocking stream the available input is returned. If none is available, an exception is thrown.

Returns: The number of bytes actually read. This is less or equal to the size of the buffer. Zero indicates that the end of the input has been reached: end of file, or remote end closing for a connected channel like a pipe or a socket. Otherwise the value can be less than requested if limited amount of input is currently available for platform or implementation reasons.

Exceptions

In	case of error, a #IOError exception is thrown. This includes the situation where the input stream is in non-blocking mode and no input is currently available (FIXME: make this simpler; clarify which exception).

Implements IOInput.

Definition at line 22 of file StorageAccountProxy.cc.

                                                      {
   StorageAccount::Stamp stats(m_statsRead);
   IOSize result = m_baseStorage->read(into, n);
   stats.tick(result);
   return result;
 }

References m_baseStorage, m_statsRead, dqmiodumpmetadata::n, mps_fire::result, and dqmMemoryStats::stats.

◆ read() [4/7]

IOSize IOInput::read

Read into into at most n number of bytes.

If this is a blocking stream, the call will block until some data can be read, end of input is reached, or an exception is thrown. For a non-blocking stream the available input is returned. If none is available, an exception is thrown.

Returns: The number of bytes actually read. This is less or equal to the size of the buffer. Zero indicates that the end of the input has been reached: end of file, or remote end closing for a connected channel like a pipe or a socket. Otherwise the value can be less than requested if limited amount of input is currently available for platform or implementation reasons.

Exceptions

In	case of error, a #IOError exception is thrown. This includes the situation where the input stream is in non-blocking mode and no input is currently available (FIXME: make this simpler; clarify which exception).

◆ read() [5/7]

IOSize Storage::read

Definition at line 12 of file Storage.cc.

                                                        {
   // FIXME: this is not thread safe!  split into separate interface
   // that a particular storage can choose to support or not?  make
   // sure that throw semantics are correct here!
   // FIXME: use saveposition object in case exceptions are thrown?
   IOOffset here = position();
   position(pos);
   n = read(into, n);
   position(here);
   return n;
 }

◆ read() [6/7]

IOSize StorageAccountProxy::read	(	void *	into,
		IOSize	n,
		IOOffset	pos
	)

overridevirtual

Reimplemented from Storage.

Definition at line 29 of file StorageAccountProxy.cc.

                                                                    {
   StorageAccount::Stamp stats(m_statsRead);
   IOSize result = m_baseStorage->read(into, n, pos);
   stats.tick(result);
   return result;
 }

References m_baseStorage, m_statsRead, dqmiodumpmetadata::n, mps_fire::result, and dqmMemoryStats::stats.

◆ read() [7/7]

int IOInput::read

Read the next single byte from the input stream and return it as an unsigned char cast to an int, -1 to indicate end of intput data.

If this is a blocking stream, the call will block until the byte can be read, end of data is reached, or an exception is thrown. For a non-blocking input a character is returned if one is available, otherwise an exception is thrown.

The base class implementation simply forwards the call to read(void *, IOSize) method.

Returns: The byte cast from a unsigned char to an int (in range 0...255, inclusive) if one could be read, or -1 to indicate end of input data.

Exceptions

In	case of error, a #IOError exception is thrown. This includes the situation where the input stream is in non-blocking mode and no input is currently available (FIXME: make this simpler; clarify which exception).

Definition at line 52 of file IOInput.cc.

                       {
   unsigned char byte;
   IOSize n = read(&byte, 1);
   return n == 0 ? -1 : byte;
 }

◆ readv() [1/2]

IOSize StorageAccountProxy::readv	(	IOBuffer *	into,
		IOSize	buffers
	)

overridevirtual

Read from the input stream into multiple scattered buffers. There are buffers to fill in an array starting at into; the memory those buffers occupy does not need to be contiguous. The buffers are filled in the order given, eac buffer is filled fully before the subsequent buffers.

If this is a blocking stream, the call will block until some data can be read, end of input is reached, or an exception is thrown. For a non-blocking stream the available input is returned. If none is available, an exception is thrown.

The base class implementation uses read(void *, IOSize) method, but derived classes may implement a more efficient alternative.

Returns: The number of bytes actually read. This is less or equal to the size of the buffer. Zero indicates that the end of the input has been reached: end of file, or remote end closing for a connected channel like a pipe or a socket. Otherwise the value can be less than requested if limited amount of input is currently available for platform or implementation reasons. Note that the return value indicates the number of bytes read, not the number of buffers; it is the sum total of bytes filled into all the buffers.

Exceptions

In case of error, a #IOError exception is thrown. However if some data has already been read, the error is swallowed and the method returns the data read so far. It is assumed that persistent errors will occur anyway on the next read and sporadic errors like stream becoming unvailable can be ignored. Use xread() if a different policy is desirable.

Reimplemented from IOInput.

Definition at line 36 of file StorageAccountProxy.cc.

                                                           {
   StorageAccount::Stamp stats(m_statsReadV);
   IOSize result = m_baseStorage->readv(into, n);
   stats.tick(result, n);
   return result;
 }

References m_baseStorage, m_statsReadV, dqmiodumpmetadata::n, mps_fire::result, and dqmMemoryStats::stats.

◆ readv() [2/2]

IOSize StorageAccountProxy::readv	(	IOPosBuffer *	into,
		IOSize	n
	)

overridevirtual

Reimplemented from Storage.

Definition at line 43 of file StorageAccountProxy.cc.

                                                              {
   StorageAccount::Stamp stats(m_statsReadV);
   IOSize result = m_baseStorage->readv(into, n);
   stats.tick(result, n);
   return result;
 }

References m_baseStorage, m_statsReadV, dqmiodumpmetadata::n, mps_fire::result, and dqmMemoryStats::stats.

◆ releaseStorage()

void StorageAccountProxy::releaseStorage ( )

inlineprotected

Definition at line 42 of file StorageAccountProxy.h.

42 { get_underlying_safe(m_baseStorage).release(); }

References edm::get_underlying_safe(), and m_baseStorage.

Referenced by ~StorageAccountProxy().

◆ resize()

void StorageAccountProxy::resize ( IOOffset size )

overridevirtual

Implements Storage.

Definition at line 85 of file StorageAccountProxy.cc.

                                               {
   StorageAccount::Stamp stats(StorageAccount::counter(m_token, StorageAccount::Operation::resize));
   m_baseStorage->resize(size);
   stats.tick();
 }

References StorageAccount::counter(), m_baseStorage, m_token, StorageAccount::resize, Storage::size(), and dqmMemoryStats::stats.

◆ write() [1/7]

IOSize StorageAccountProxy::write	(	const void *	from,
		IOSize	n
	)

overridevirtual

Write n bytes of data starting at address from.

Returns: The number of bytes written. Normally this will be n, but can be less, even zero, for example if the stream is non-blocking mode and cannot accept input at this time.

Exceptions

In	case of error, an exception is thrown. However if the stream is in non-blocking mode and cannot accept output, it will not throw an exception – the return value will be less than requested.

Implements IOOutput.

Definition at line 50 of file StorageAccountProxy.cc.

                                                             {
   StorageAccount::Stamp stats(m_statsWrite);
   IOSize result = m_baseStorage->write(from, n);
   stats.tick(result);
   return result;
 }

References m_baseStorage, m_statsWrite, dqmiodumpmetadata::n, mps_fire::result, and dqmMemoryStats::stats.

◆ write() [2/7]

IOSize IOOutput::write

Write n bytes of data starting at address from.

Returns: The number of bytes written. Normally this will be n, but can be less, even zero, for example if the stream is non-blocking mode and cannot accept input at this time.

Exceptions

In	case of error, an exception is thrown. However if the stream is in non-blocking mode and cannot accept output, it will not throw an exception – the return value will be less than requested.

◆ write() [3/7]

IOSize Storage::write

Definition at line 44 of file Storage.cc.

                                                               {
   // FIXME: this is not thread safe!  split into separate interface
   // that a particular storage can choose to support or not?  make
   // sure that throw semantics are correct here!
  
   // FIXME: use saveposition object in case exceptions are thrown?
   IOOffset here = position();
   position(pos);
   n = write(from, n);
   position(here);
   return n;
 }

◆ write() [4/7]

IOSize StorageAccountProxy::write	(	const void *	from,
		IOSize	n,
		IOOffset	pos
	)

overridevirtual

Reimplemented from Storage.

Definition at line 57 of file StorageAccountProxy.cc.

                                                                           {
   StorageAccount::Stamp stats(m_statsWrite);
   IOSize result = m_baseStorage->write(from, n, pos);
   stats.tick(result);
   return result;
 }

References m_baseStorage, m_statsWrite, dqmiodumpmetadata::n, mps_fire::result, and dqmMemoryStats::stats.

◆ write() [5/7]

IOSize IOOutput::write

Write to the output stream the buffer from. This method is simply redirected to write(const void *, IOSize).

Note that derived classes should not normally call this method, as it simply routes the call back to derived class through the other virtual functions. Use this method only at the "outside edge" when transferring calls from one object to another, not in up/down calls in the inheritance tree.

Returns: The number of bytes actually written. This is less or equal to the size of the buffer. The value can be less than requested if the stream is unable to accept all the output for platform or implementation reasons.

Exceptions

In	case of error, an exception is thrown. However if the stream is in non-blocking mode and cannot accept output, it will not throw an exception – the return value will be less than requested.

Definition at line 59 of file IOOutput.cc.

59 { return write(from.data(), from.size()); }

◆ write() [6/7]

IOSize Storage::write

Definition at line 42 of file Storage.cc.

42 { return write(from.data(), from.size(), pos); }

◆ write() [7/7]

IOSize IOOutput::write

Write a single byte to the output stream. This method is simply redirected to write(const void *, IOSize).

Note that derived classes should not normally call this method, as it simply routes the call back to derived class through the other virtual functions. Use this method only at the "outside edge" when transferring calls from one object to another, not in up/down calls in the inheritance tree.

Returns: The number of bytes written. Normally this will be one, but can be zero if the stream is in non-blocking mode and cannot accept output at this time.

Exceptions

In	case of error, an exception is thrown. However if the stream is in non-blocking mode and cannot accept output, it will not throw an exception – zero will be returned.

Definition at line 39 of file IOOutput.cc.

39 { return write(&byte, 1); }

◆ writev() [1/2]

IOSize StorageAccountProxy::writev	(	const IOBuffer *	from,
		IOSize	buffers
	)

overridevirtual

Write to the output stream from multiple buffers. There are buffers to fill in an array starting at from. The buffers are filled in the order given, each buffer fully before the subsequent buffers. The method uses write(const void *, IOSize), but may be implemented more efficiently in derived classes.

Note that derived classes should not normally call this method, as it simply routes the call back to derived class through the other virtual functions. Use this method only at the "outside edge" when transferring calls from one object to another, not in up/down calls in the inheritance tree.

Returns: The number of bytes actually written. This is less or equal to the size of the buffers. The value can be less than requested if the stream is unable to accept all the output for platform or implementation reasons. Note that the return value indicates the number of bytes written, not the number of buffers; it is the sum total of bytes written from all the buffers.

Exceptions

In	case of error, an exception is thrown. However if the stream is in non-blocking mode and cannot accept output, it will not throw an exception – the return value will be less than requested.

Reimplemented from IOOutput.

Definition at line 64 of file StorageAccountProxy.cc.

                                                                  {
   StorageAccount::Stamp stats(m_statsWriteV);
   IOSize result = m_baseStorage->writev(from, n);
   stats.tick(result, n);
   return result;
 }

References m_baseStorage, m_statsWriteV, dqmiodumpmetadata::n, mps_fire::result, and dqmMemoryStats::stats.

◆ writev() [2/2]

IOSize StorageAccountProxy::writev	(	const IOPosBuffer *	from,
		IOSize	n
	)

overridevirtual

Reimplemented from Storage.

Definition at line 71 of file StorageAccountProxy.cc.

                                                                     {
   StorageAccount::Stamp stats(m_statsWriteV);
   IOSize result = m_baseStorage->writev(from, n);
   stats.tick(result, n);
   return result;
 }

References m_baseStorage, m_statsWriteV, dqmiodumpmetadata::n, mps_fire::result, and dqmMemoryStats::stats.

Member Data Documentation

◆ m_baseStorage

edm::propagate_const<std::unique_ptr<Storage> > StorageAccountProxy::m_baseStorage

protected

Definition at line 44 of file StorageAccountProxy.h.

Referenced by close(), flush(), position(), prefetch(), read(), readv(), releaseStorage(), resize(), write(), and writev().

◆ m_statsPosition

StorageAccount::Counter& StorageAccountProxy::m_statsPosition

protected

Definition at line 51 of file StorageAccountProxy.h.

Referenced by position().

◆ m_statsPrefetch

StorageAccount::Counter& StorageAccountProxy::m_statsPrefetch

protected

Definition at line 52 of file StorageAccountProxy.h.

Referenced by prefetch().

◆ m_statsRead

StorageAccount::Counter& StorageAccountProxy::m_statsRead

protected

Definition at line 47 of file StorageAccountProxy.h.

Referenced by read().

◆ m_statsReadV

StorageAccount::Counter& StorageAccountProxy::m_statsReadV

protected

Definition at line 48 of file StorageAccountProxy.h.

Referenced by readv().

◆ m_statsWrite

StorageAccount::Counter& StorageAccountProxy::m_statsWrite

protected

Definition at line 49 of file StorageAccountProxy.h.

Referenced by write().

◆ m_statsWriteV

StorageAccount::Counter& StorageAccountProxy::m_statsWriteV

protected

Definition at line 50 of file StorageAccountProxy.h.

Referenced by writev().

◆ m_token

StorageAccount::StorageClassToken StorageAccountProxy::m_token

protected

Definition at line 46 of file StorageAccountProxy.h.

Referenced by close(), flush(), resize(), StorageAccountProxy(), and ~StorageAccountProxy().

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StorageAccountProxy()

◆ ~StorageAccountProxy()

Member Function Documentation

◆ close()

◆ flush()

◆ position()

◆ prefetch()

◆ read() [1/7]

◆ read() [2/7]

◆ read() [3/7]

◆ read() [4/7]

◆ read() [5/7]

◆ read() [6/7]

◆ read() [7/7]

◆ readv() [1/2]

◆ readv() [2/2]

◆ releaseStorage()

◆ resize()

◆ write() [1/7]

◆ write() [2/7]

◆ write() [3/7]

◆ write() [4/7]

◆ write() [5/7]

◆ write() [6/7]

◆ write() [7/7]

◆ writev() [1/2]

◆ writev() [2/2]

Member Data Documentation

◆ m_baseStorage

◆ m_statsPosition

◆ m_statsPrefetch

◆ m_statsRead

◆ m_statsReadV

◆ m_statsWrite

◆ m_statsWriteV

◆ m_token