MemoryUtils Namespace Reference

Classes
struct	Stats

Enumerations
enum	MemUnits {   MemUnits::Bytes, MemUnits::Kibibytes, MemUnits::Mebibytes, MemUnits::Gibibytes = 3,   MemUnits::Kilobytes, MemUnits::Megabytes, MemUnits::Gigabytes = 6 }

Functions
std::string	getMPIProcessorName ()
	get the MPI hostname More...
MooseEnum	getMemUnitsEnum ()
	get the moose enum for the mem_unit_prefix parameter More...
std::size_t	getTotalRAM ()
	get the total amount of physical RAM available More...
bool	getMemoryStats (Stats &stats)
	get all memory stats for the current process stats The Stats object to fill with the data More...
std::size_t	convertBytes (std::size_t bytes, MemUnits unit)
	convert bytes to selected unit prefix More...

Enumeration Type Documentation

MemUnits

enum MemoryUtils::MemUnits

strong

Enumerator
Bytes
Kibibytes
Mebibytes
Gibibytes
Kilobytes
Megabytes
Gigabytes

Definition at line 28 of file MemoryUtils.h.

{
  Bytes,
  Kibibytes,
  Mebibytes,
  Gibibytes = 3,
  Kilobytes,
  Megabytes,
  Gigabytes = 6,
};

Function Documentation

convertBytes()

std::size_t MemoryUtils::convertBytes	(	std::size_t	bytes,
		MemUnits	unit
	)

convert bytes to selected unit prefix

Definition at line 174 of file MemoryUtils.C.

Referenced by MemoryUsage::execute(), ActionWarehouse::executeActionsWithAction(), ActionWarehouse::executeAllActions(), VectorMemoryUsage::finalize(), PerfGraph::pop(), PerfGraph::push(), PerfGraph::update(), and VectorMemoryUsage::VectorMemoryUsage().

{
  if (unit == MemUnits::Bytes)
    return bytes;

  unsigned int nunit = static_cast<unsigned int>(unit);

  // kibi, mebi, gibi
  if (nunit <= 3)
    return bytes >> (nunit * 10);

  // kilo, mega, giga
  if (nunit <= 6)
  {
    while (nunit-- > 3)
      bytes /= 1000;
    return bytes;
  }

  mooseError("Unknown memory unit");
}

getMemoryStats()

bool MemoryUtils::getMemoryStats

(

Stats &

stats

)

get all memory stats for the current process stats The Stats object to fill with the data

Returns

true for success, false for failure

Definition at line 79 of file MemoryUtils.C.

Referenced by MemoryUsage::execute(), VectorMemoryUsage::execute(), ActionWarehouse::executeActionsWithAction(), ActionWarehouse::executeAllActions(), PerfGraph::pop(), PerfGraph::push(), and PerfGraph::update().

{
  bool retval = false;

  enum StatItem
  {
    index_page_faults = 8,
    index_virtual_size = 19,
    index_resident_size = 20,
    num = 21 // total number of entries read
  };

  // inspect /proc
  std::ifstream stat_stream("/proc/self/stat", std::ios_base::in);
  std::array<std::size_t, 21> val;
  val.fill(0);

  if (stat_stream)
  {
    // if the proc filesystem file is found (Linux) read its contents
    std::string pid, comm, state;
    stat_stream >> pid >> comm >> state;

    unsigned int i = 0;

    while (!stat_stream.eof() && i < val.size())
    {
      stat_stream >> val[i];
      i++;
    }

    // Handle the case where we didn't get enough values by just zeroing everything
    // since we probably got junk
    if (i != val.size())
      val.fill(0);
    else
      retval = true;

      // resident size is reported as number of pages in /proc
#ifndef __WIN32__
    val[index_resident_size] *= sysconf(_SC_PAGE_SIZE);
#endif
  }
  else
  {
#ifdef __WIN32__
    auto pid = GetCurrentProcessId();
    auto hProcess = OpenProcess(PROCESS_QUERY_INFORMATION | PROCESS_VM_READ, FALSE, pid);

    PROCESS_MEMORY_COUNTERS pmc;
    if (NULL == hProcess || !GetProcessMemoryInfo(hProcess, &pmc, sizeof(pmc)))
      val.fill(0);
    else
    {
      retval = true;
      val[index_page_faults] = pmc.PageFaultCount;
      val[index_virtual_size] = pmc.WorkingSetSize + pmc.PagefileUsage;
      val[index_resident_size] = pmc.WorkingSetSize;
    }
#else
    // set all data entries to zero (if all else should fail)
    val.fill(0);
#endif

// obtain mach task info on mac OS
#if defined(__APPLE__)
    struct task_basic_info t_info;
    mach_msg_type_number_t t_info_count = TASK_BASIC_INFO_COUNT;
    if (KERN_SUCCESS == task_info(mach_task_self(),
                                  TASK_BASIC_INFO,
                                  reinterpret_cast<task_info_t>(&t_info),
                                  &t_info_count))
    {
      retval = true;
      val[index_virtual_size] = t_info.virtual_size;   // in bytes
      val[index_resident_size] = t_info.resident_size; // in bytes
    }
    else
      mooseDoOnce(::mooseWarning("task_info call failed, memory usage numbers will be incorrect"));
#endif
  }

  // physical mem
  stats._physical_memory = val[index_resident_size];

  // virtual mem
  stats._virtual_memory = val[index_virtual_size];

  // page faults
  stats._page_faults = val[index_page_faults];

  return retval;
}

getMemUnitsEnum()

MooseEnum MemoryUtils::getMemUnitsEnum

(

)

get the moose enum for the mem_unit_prefix parameter

Definition at line 52 of file MemoryUtils.C.

Referenced by MemoryUsage::validParams(), and VectorMemoryUsage::validParams().

{
  return MooseEnum("bytes kibibytes mebibytes gibibytes kilobytes megabytes gigabytes",
                   "mebibytes");
}

getMPIProcessorName()

std::string MemoryUtils::getMPIProcessorName

(

)

get the MPI hostname

Definition at line 39 of file MemoryUtils.C.

{
#ifdef LIBMESH_HAVE_MPI
  int mpi_namelen;
  char mpi_name[MPI_MAX_PROCESSOR_NAME];
  MPI_Get_processor_name(mpi_name, &mpi_namelen);
  return mpi_name;
#else
  return "serial";
#endif
}

getTotalRAM()

std::size_t MemoryUtils::getTotalRAM

(

)

get the total amount of physical RAM available

Definition at line 59 of file MemoryUtils.C.

Referenced by MemoryUsageReporter::MemoryUsageReporter().

{
#if defined(__APPLE__)
  uint64_t hwmem_size;
  size_t length = sizeof(hwmem_size);
  if (0 <= sysctlbyname("hw.memsize", &hwmem_size, &length, NULL, 0))
    return hwmem_size;
#elif defined(__WIN32__)
  ULONGLONG mem_kb;
  if (GetPhysicallyInstalledSystemMemory(&mem_kb))
    return mem_kb * 1024;
#else
  struct sysinfo si_data;
  if (!sysinfo(&si_data))
    return si_data.totalram * si_data.mem_unit;
#endif
  return 0;
}