Memory.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2019 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
//====================================================================
//  Memory.h
//--------------------------------------------------------------------
//
//  Package    : System (The LHCb System service)
//
//  Description: Information of memory usage from a given process
//
//  Author     : M.Frank
//  Created    : 13/11/00
//  Changes    :
//
//====================================================================
#ifndef GAUDIKERNEL_MEMORY_H
#define GAUDIKERNEL_MEMORY_H

// Framework include files
#include "GaudiKernel/Kernel.h"
#include "GaudiKernel/SystemBase.h"

namespace System {
  enum MemoryUnit { Byte, kByte, MByte, GByte, TByte, PByte, EByte };
  GAUDI_API long adjustMemory( MemoryUnit typ, long value );
  GAUDI_API long procID();
  GAUDI_API long parentID( InfoType fetch = ProcessBasics, long pid = -1 );
  GAUDI_API long affinityMask( InfoType fetch = ProcessBasics, long pid = -1 );
  GAUDI_API long exitStatus( InfoType fetch = ProcessBasics, long pid = -1 );
  GAUDI_API long basePriority( InfoType fetch = ProcessBasics, long pid = -1 );
  GAUDI_API long priorityBoost( InfoType fetch = PriorityBoost, long pid = -1 );

  GAUDI_API long numPageFault( InfoType fetch = Memory, long pid = -1 );
  GAUDI_API long pagefileUsage( MemoryUnit unit = kByte, InfoType fetch = Memory, long pid = -1 );
  GAUDI_API long pagefileUsagePeak( MemoryUnit unit = kByte, InfoType fetch = Memory, long pid = -1 );
  GAUDI_API long pagefileUsageLimit( MemoryUnit unit = kByte, InfoType fetch = Quota, long pid = -1 );

  GAUDI_API long nonPagedMemory( MemoryUnit unit = kByte, InfoType fetch = Memory, long pid = -1 );
  GAUDI_API long nonPagedMemoryPeak( MemoryUnit unit = kByte, InfoType fetch = Memory, long pid = -1 );
  GAUDI_API long nonPagedMemoryLimit( MemoryUnit unit = kByte, InfoType fetch = Quota, long pid = -1 );

  GAUDI_API long pagedMemory( MemoryUnit unit = kByte, InfoType fetch = Memory, long pid = -1 );
  GAUDI_API long pagedMemoryPeak( MemoryUnit unit = kByte, InfoType fetch = Memory, long pid = -1 );
  GAUDI_API long pagedMemoryLimit( MemoryUnit unit = kByte, InfoType fetch = Quota, long pid = -1 );

  GAUDI_API long minMemoryLimit( MemoryUnit unit = kByte, InfoType fetch = Quota, long pid = -1 );
  GAUDI_API long maxMemoryLimit( MemoryUnit unit = kByte, InfoType fetch = Quota, long pid = -1 );
  GAUDI_API long mappedMemory( MemoryUnit unit = kByte, InfoType fetch = Memory, long pid = -1 );
  GAUDI_API long mappedMemoryPeak( MemoryUnit unit = kByte, InfoType fetch = Memory, long pid = -1 );
  GAUDI_API long virtualMemory( MemoryUnit unit = kByte, InfoType fetch = Memory, long pid = -1 );
  GAUDI_API long virtualMemoryPeak( MemoryUnit unit = kByte, InfoType fetch = Memory, long pid = -1 );
  GAUDI_API long virtualMemoryLimit( MemoryUnit unit = kByte, InfoType fetch = Quota, long pid = -1 );
} // namespace System
#endif // GAUDIKERNEL_MEMORY_H