SysInfo.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/config.h>
#include <OpenMS/DATASTRUCTURES/StringUtils.h>
 
#include <vector>
 
namespace OpenMS
{
 
  OPENMS_DLLAPI std::string bytesToHumanReadable(UInt64 bytes);
 
  class OPENMS_DLLAPI SysInfo
  {
    public:
      static bool getProcessMemoryConsumption(size_t& mem_virtual);
  
      static bool getProcessPeakMemoryConsumption(size_t& mem_virtual);
 
      static bool getFreeSystemMemory(size_t& mem_available);
 
      static Int64 getProcessId();
 
      static UInt getAvailablePhysicalCores(const std::vector<int>& cpus = {});
 
      static int ompThreadsOfThisThread();
 
      static void setOmpThreadsOfThisThread(int threads);
 
      static bool ompThreadCountIsGlobal();
      struct OPENMS_DLLAPI MemUsage
      {
        size_t mem_before, mem_before_peak, mem_after, mem_after_peak;
 
        MemUsage();
 
        void reset();
        void before();
        void after();
        std::string delta(const std::string& event = "delta");
 
        std::string usage();
 
      private:
        // convert difference to string
        std::string diff_str_(size_t mem_before, size_t mem_after);
 
      };
  };
}