MemoryProfiler.cpp

Go to the documentation of this file.

//
// Class MemoryProfiler
//   This class writes a SDDS file with virtual memory usage information (Linux only).
//
// Copyright (c) 2019, Matthias Frey, Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved
//
// Implemented as part of the PhD thesis
// "Precise Simulations of Multibunches in High Intensity Cyclotrons"
//
// This file is part of OPAL.
//
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// You should have received a copy of the GNU General Public License
// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
//
#include "Structure/MemoryProfiler.h"

#include "AbstractObjects/OpalData.h"
#include "Algorithms/PartBunchBase.h"
#include "Physics/Units.h"
#include "Utilities/Timer.h"
#include "Utilities/OpalException.h"

#include "Ippl.h"

#ifdef __linux__
#include <sys/types.h>
#include <unistd.h>
#endif
#include <sstream>

MemoryProfiler::MemoryProfiler(const std::string& fname, bool restart)
    : SDDSWriter(fname, restart)
{
    procinfo_m = {
        {"VmPeak:", VirtualMemory::VMPEAK},
        {"VmSize:", VirtualMemory::VMSIZE},
        {"VmHWM:",  VirtualMemory::VMHWM},
        {"VmRSS:",  VirtualMemory::VMRSS},
        {"VmStk:",  VirtualMemory::VMSTK},
        {"VmData:", VirtualMemory::VMDATA},
        {"VmExe:",  VirtualMemory::VMEXE},
        {"VmLck:",  VirtualMemory::VMLCK},
        {"VmPin:",  VirtualMemory::VMPIN},
        {"VmLib:",  VirtualMemory::VMLIB},
        {"VmPTE:",  VirtualMemory::VMPTE},
        {"VmPMD:",  VirtualMemory::VMPMD},
        {"VmSwap:", VirtualMemory::VMSWAP}
    };

    vmem_m.resize(procinfo_m.size());
    unit_m.resize(procinfo_m.size());
}


void MemoryProfiler::header() {

    if (this->hasColumns()) {
        return;
    }

    columns_m.addColumn("t", "double", "ns", "Time");

    columns_m.addColumn("s", "double", "m", "Path length");

    // peak virtual memory size
    columns_m.addColumn("VmPeak-Min", "double", unit_m[VirtualMemory::VMPEAK],
                        "Minimum peak virtual memory size");

    columns_m.addColumn("VmPeak-Max", "double", unit_m[VirtualMemory::VMPEAK],
                        "Maximum peak virtual memory size");

    columns_m.addColumn("VmPeak-Avg", "double", unit_m[VirtualMemory::VMPEAK],
                        "Average peak virtual memory size");

    // virtual memory size
    columns_m.addColumn("VmSize-Min", "double", unit_m[VirtualMemory::VMSIZE],
                        "Minimum virtual memory size");

    columns_m.addColumn("VmSize-Max", "double", unit_m[VirtualMemory::VMSIZE],
                        "Maximum virtual memory size");

    columns_m.addColumn("VmSize-Avg", "double", unit_m[VirtualMemory::VMSIZE],
                        "Average virtual memory size");

    // peak resident set size ("high water mark")
    columns_m.addColumn("VmHWM-Min", "double", unit_m[VirtualMemory::VMHWM],
                        "Minimum peak resident set size");

    columns_m.addColumn("VmHWM-Max", "double", unit_m[VirtualMemory::VMHWM],
                        "Maximum peak resident set size");

    columns_m.addColumn("VmHWM-Avg", "double", unit_m[VirtualMemory::VMHWM],
                        "Average peak resident set size");

    // resident set size
    columns_m.addColumn("VmRSS-Min", "double", unit_m[VirtualMemory::VMRSS],
                        "Minimum resident set size");

    columns_m.addColumn("VmRSS-Max", "double", unit_m[VirtualMemory::VMRSS],
                        "Maximum resident set size");

    columns_m.addColumn("VmRSS-Avg", "double", unit_m[VirtualMemory::VMRSS],
                        "Average resident set size");

    // stack size
    columns_m.addColumn("VmStk-Min", "double", unit_m[VirtualMemory::VMSTK],
                        "Minimum stack size");

    columns_m.addColumn("VmStk-Max", "double", unit_m[VirtualMemory::VMSTK],
                        "Maximum stack size");

    columns_m.addColumn("VmStk-Avg", "double", unit_m[VirtualMemory::VMSTK],
                        "Average stack size");

    if ( mode_m == std::ios::app )
        return;

    OPALTimer::Timer simtimer;

    std::string dateStr(simtimer.date());
    std::string timeStr(simtimer.time());

    std::stringstream ss;
    ss << "Memory statistics '"
       << OpalData::getInstance()->getInputFn() << "' "
       << dateStr << "" << timeStr;

    this->addDescription(ss.str(), "memory info");

    this->addDefaultParameters();

    this->addInfo("ascii", 1);
}


void MemoryProfiler::update() {
#ifdef __linux__
    static pid_t pid = getpid();
    std::string fname = "/proc/" + std::to_string(pid) + "/status";

    if ( !std::filesystem::exists(fname) ) {
        throw OpalException("MemoryProfiler::update()",
                            "File '" + fname + "' doesn't exist.");
    }

    std::ifstream ifs(fname.c_str());

    if ( !ifs.is_open() ) {
        throw OpalException("MemoryProfiler::update()",
                            "Failed to open '" + fname + "'.");
    }

    std::string token;
    while (ifs >> token) {
        if ( !procinfo_m.count(token) ) {
            continue;
        }
        int idx = procinfo_m[token];
        ifs >> vmem_m[idx]
            >> unit_m[idx];
    }

    ifs.close();
#endif
}


void MemoryProfiler::compute(vm_t& vmMin,
                             vm_t& vmMax,
                             vm_t& vmAvg)
{
    if ( Ippl::getNodes() == 1 ) {
        for (unsigned int i = 0; i < vmem_m.size(); ++i) {
            vmMin[i] = vmMax[i] = vmAvg[i] = vmem_m[i];
        }
        return;
    }

    new_reduce(vmem_m.data(), vmAvg.data(), vmem_m.size(), std::plus<double>());

    double inodes = 1.0 / double(Ippl::getNodes());
    for (auto& vm : vmAvg) {
        vm *= inodes;
    }

    new_reduce(vmem_m.data(), vmMin.data(), vmem_m.size(), std::less<double>());
    new_reduce(vmem_m.data(), vmMax.data(), vmem_m.size(), std::greater<double>());
}


void MemoryProfiler::write(PartBunchBase<double, 3>* beam) {

    this->update();

    vm_t vmMin(vmem_m.size());
    vm_t vmMax(vmem_m.size());
    vm_t vmAvg(vmem_m.size());

    this->compute(vmMin, vmMax, vmAvg);

    if ( Ippl::myNode() != 0 ) {
        return;
    }

    double  pathLength = beam->get_sPos();

    header();

    this->open();

    this->writeHeader();

    columns_m.addColumnValue("t", beam->getT() * Units::s2ns); // 1
    columns_m.addColumnValue("s", pathLength);                   // 2

    // boost::variant can't overload double and long double. By using a
    // string this shortcoming can be bypassed.
    columns_m.addColumnValue("VmPeak-Min", toString(vmMin[VMPEAK]));
    columns_m.addColumnValue("VmPeak-Max", toString(vmMax[VMPEAK]));
    columns_m.addColumnValue("VmPeak-Avg", toString(vmAvg[VMPEAK]));

    columns_m.addColumnValue("VmSize-Min", toString(vmMin[VMSIZE]));
    columns_m.addColumnValue("VmSize-Max", toString(vmMax[VMSIZE]));
    columns_m.addColumnValue("VmSize-Avg", toString(vmAvg[VMSIZE]));

    columns_m.addColumnValue("VmHWM-Min", toString(vmMin[VMHWM]));
    columns_m.addColumnValue("VmHWM-Max", toString(vmMax[VMHWM]));
    columns_m.addColumnValue("VmHWM-Avg", toString(vmAvg[VMHWM]));

    columns_m.addColumnValue("VmRSS-Min", toString(vmMin[VMRSS]));
    columns_m.addColumnValue("VmRSS-Max", toString(vmMax[VMRSS]));
    columns_m.addColumnValue("VmRSS-Avg", toString(vmAvg[VMRSS]));

    columns_m.addColumnValue("VmStk-Min", toString(vmMin[VMSTK]));
    columns_m.addColumnValue("VmStk-Max", toString(vmMax[VMSTK]));
    columns_m.addColumnValue("VmStk-Avg", toString(vmAvg[VMSTK]));

    this->writeRow();

    this->close();
}