This class holds the complete scratch space. More...

#include <scratch.h>

Collaboration diagram for Scratch:

Public Member Functions
	Scratch (MFloat size, MInt Cells)
	Constructor. More...

	~Scratch ()
	Destructor. More...

Static Public Member Functions
static char *	getEndPointer ()
	Returns a pointer to the end of the scratch. More...

static size_t	getAvailableMemory ()
	Returns the amount of available memory in scratch. More...

static size_t	getTotalMemory ()
	Returns the amount of total available memory in scratch. More...

static MString	printSelfScratch ()
	Returns a string summing up the scratch state information. More...

static MString	printSelf ()
	Returns a string summing up the scratch state information and all scratch space elements information. More...

static MString	printSelfReport ()
	Returns a shortened string summing up the scratch space state information. More...

static MFloat	getAvailableMemory ()

Static Public Attributes
static size_t	m_number_of_cells

static size_t	m_number_of_elements

static MInt	m_object_id = 0

static char *	m_totalScratch

static size_t	m_usedmemsize

static char *	m_nextfree

static ScratchList	m_scratchSpaces

static char *	m_maxused

static MString	m_report

Static Private Attributes
static const uintptr_t	ALIGNMENT_BOUNDARY = MAIA_SCRATCH_ALIGNMENT_BOUNDARY

Friends
class	ScratchSpaceBase

Detailed Description

Authors: Andreas Lintermann, Stephan Schlimpert, Christoph Siewert

Date: 10.05.2011, 10.06.2011, 21.10.2011

This class defines the overall size of the scratch space and tracks the sizes and allocation of newly requested Scratch space arrays.

Definition at line 91 of file scratch.h.

Constructor & Destructor Documentation

◆ Scratch()

Scratch::Scratch	(	MFloat	size,
		MInt	Cells
	)

Authors: Andreas Lintermann, Stephan Schlimpert, Christoph Siewert

Date: 10.05.2011, 10.06.2011, 21.10.2011

Note: Base memory now points to an aligned memory address, Lennart Schneiders, 12.12.2012

Allocates space of "size * sizeof(MFloat) * Cells" bytes, that is "size" MFloat for every cell.

Parameters

[in]	size	number of MFloat for every cell.
[in]	Cells	number of cells.

Definition at line 27 of file scratch.cpp.

                                        {
  m_number_of_cells = Cells;
  m_number_of_elements = floor(size * sizeof(MFloat) * m_number_of_cells) + ALIGNMENT_BOUNDARY;
  m_totalScratch = new char[m_number_of_elements];
  m_nextfree = m_totalScratch;
  m_maxused = m_totalScratch;
 
  m_nextfree += ((ALIGNMENT_BOUNDARY - (((uintptr_t)m_nextfree) % ALIGNMENT_BOUNDARY)) % ALIGNMENT_BOUNDARY);
  ASSERT((((uintptr_t)m_nextfree) % ALIGNMENT_BOUNDARY == 0), "Scratch memory is not aligned");
 
  m_report = printSelfScratch();
}

◆ ~Scratch()

Scratch::~Scratch ( )

inline

Author: Andreas Lintermann, Christoph Siewert

Date: 10.05.2011, 21.10.2011

Definition at line 117 of file scratch.h.

             {
    m_number_of_cells = 0;
    m_number_of_elements = 0;
    m_object_id = 0;
    m_usedmemsize = 0;
    m_nextfree = nullptr;
    m_scratchSpaces.clear();
    m_maxused = nullptr;
    m_report = "n/a";
    delete[] m_totalScratch;
    m_totalScratch = nullptr;
  };

Member Function Documentation

◆ getAvailableMemory() [1/2]

static size_t Scratch::getAvailableMemory ( )

inlinestatic

Author: Andreas Lintermann, Christoph Siewert

Date: 10.05.2011, 21.10.2011

Returns: the amount of available memory

Definition at line 148 of file scratch.h.

148{ return (&m_totalScratch[m_number_of_elements - 1] - m_nextfree); }

◆ getAvailableMemory() [2/2]

static MFloat Scratch::getAvailableMemory ( )

inlinestatic

Definition at line 837 of file scratch.h.

837{ return 100; }

◆ getEndPointer()

static char * Scratch::getEndPointer ( )

inlinestatic

Authors: Andreas Lintermann, Stephan Schlimpert, Christoph Siewert

Date: 10.05.2011, 10.06.2011, 21.01.2011

Returns: a pointer to the end of the scratch

Definition at line 137 of file scratch.h.

137{ return (char*)(size_t)(m_totalScratch + m_number_of_elements - 1); }

◆ getTotalMemory()

static size_t Scratch::getTotalMemory ( )

inlinestatic

Author: Andreas Lintermann. Christoph Siewert

Date: 10.05.2011, 21.10.2011

Returns: the amount of total available memory

Definition at line 157 of file scratch.h.

157{ return (getEndPointer() + 1 - m_totalScratch); }

Scratch::getEndPointer

static char * getEndPointer()

Returns a pointer to the end of the scratch.

Definition: scratch.h:137

◆ printSelf()

string Scratch::printSelf ( )

static

Author: Andreas Lintermann, Christoph Siewert

Date: 10.05.2011, 21.10.2011

Returns: a string summing up the scratch state information and all scratch space elements information

Definition at line 106 of file scratch.cpp.

                          {
  string message = printSelfScratch();
  ScratchList::iterator iter;
 
  for(iter = Scratch::m_scratchSpaces.begin(); iter != Scratch::m_scratchSpaces.end(); iter++) {
    message += (*iter)->printSelf();
    message += "\n";
  }
 
  message += "\n\n";
  return message;
}

◆ printSelfReport()

string Scratch::printSelfReport ( )

static

Author: Andreas Lintermann

Date: 10.05.2011

This function is used in the report process for tracking the occasion of maximal memory usage during program execution.

Returns: a shortened string summing up the scratch space state information

Definition at line 129 of file scratch.cpp.

                                {
  string message = m_report;
  message += "\n\n";
  return message;
}

◆ printSelfScratch()

string Scratch::printSelfScratch ( )

static

Authors: Andreas Lintermann, Stephan Schlimpert, Christoph Siewert

Date: 10.05.2011, 10.06.2011, 21.10.2011

Returns: a string summing up the scratch state information

Definition at line 48 of file scratch.cpp.

                                 {
  stringstream begin, end, nextfree, number, total, totalmb, used, usedmb, available, availablemb, maxmem, maxmemmb;
  const MFloat bytesInAMegaByte = 1048576.0;
  begin << (MInt*)m_totalScratch;
  end << (MInt*)getEndPointer();
  nextfree << (MInt*)m_nextfree;
  number << m_number_of_elements;
  total << getTotalMemory();
  totalmb << (MFloat)getTotalMemory() / bytesInAMegaByte;
  used << m_usedmemsize;
  usedmb << (MFloat)m_usedmemsize / bytesInAMegaByte;
  available << getAvailableMemory();
  availablemb << (MFloat)getAvailableMemory() / bytesInAMegaByte;
  maxmem << (m_maxused - m_totalScratch);
  maxmemmb << (MFloat)(m_maxused - m_totalScratch) / bytesInAMegaByte;
 
  string message = "\n\nScratch:";
  message += "\n-----------------------------\n";
  message += "Bytes allocated:\t\t";
  message += number.str();
  message += "\nTotal memory:\t\t\t";
  message += total.str();
  message += "\t(";
  message += totalmb.str();
  message += "MB)";
  message += "\nUsed memory:\t\t\t";
  message += used.str();
  message += "\t(";
  message += usedmb.str();
  message += "MB)";
  message += "\nFree memory:\t\t\t";
  message += available.str();
  message += "\t(";
  message += availablemb.str();
  message += "MB)";
  message += "\nMax memory:\t\t\t";
  message += maxmem.str();
  message += "\t(";
  message += maxmemmb.str();
  message += "MB)";
  message += "\nScratch start pointer:\t\t";
  message += begin.str();
  message += "\nScratch end pointer:\t\t";
  message += end.str();
  message += "\nNext free pointer:\t\t";
  message += nextfree.str();
  message += "\n\n";
 
  return message;
}

Friends And Related Function Documentation

◆ ScratchSpaceBase

friend class ScratchSpaceBase

friend

Definition at line 92 of file scratch.h.

Member Data Documentation

◆ ALIGNMENT_BOUNDARY

const uintptr_t Scratch::ALIGNMENT_BOUNDARY = MAIA_SCRATCH_ALIGNMENT_BOUNDARY

staticprivate

Definition at line 94 of file scratch.h.

◆ m_maxused

char * Scratch::m_maxused

static

Definition at line 170 of file scratch.h.

◆ m_nextfree

char * Scratch::m_nextfree

static

Definition at line 168 of file scratch.h.

◆ m_number_of_cells

size_t Scratch::m_number_of_cells

static

Definition at line 163 of file scratch.h.

◆ m_number_of_elements

size_t Scratch::m_number_of_elements

static

Definition at line 164 of file scratch.h.

◆ m_object_id

MInt Scratch::m_object_id = 0

static

Definition at line 165 of file scratch.h.

◆ m_report

string Scratch::m_report

static

Definition at line 171 of file scratch.h.

◆ m_scratchSpaces

ScratchList Scratch::m_scratchSpaces

static

Definition at line 169 of file scratch.h.

◆ m_totalScratch

char * Scratch::m_totalScratch

static

Definition at line 166 of file scratch.h.

◆ m_usedmemsize

size_t Scratch::m_usedmemsize

static

Definition at line 167 of file scratch.h.

The documentation for this class was generated from the following files:

/home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/MEMORY/scratch.h
/home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/MEMORY/scratch.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Scratch()

◆ ~Scratch()

Member Function Documentation

◆ getAvailableMemory() [1/2]

◆ getAvailableMemory() [2/2]

◆ getEndPointer()

◆ getTotalMemory()

◆ printSelf()

◆ printSelfReport()

◆ printSelfScratch()

Friends And Related Function Documentation

◆ ScratchSpaceBase

Member Data Documentation

◆ ALIGNMENT_BOUNDARY

◆ m_maxused

◆ m_nextfree

◆ m_number_of_cells

◆ m_number_of_elements

◆ m_object_id

◆ m_report

◆ m_scratchSpaces

◆ m_totalScratch

◆ m_usedmemsize