File: dis_memory_usage.h

package info (click to toggle)
rheolef 7.2-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 88,200 kB
  • sloc: cpp: 110,259; sh: 16,733; makefile: 5,406; python: 1,391; yacc: 218; javascript: 203; xml: 191; awk: 61; sed: 5
file content (77 lines) | stat: -rw-r--r-- 2,301 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
#ifndef _RHEO_DIS_MEMORY_USAGE_H
#define _RHEO_DIS_MEMORY_USAGE_H
//
// This file is part of Rheolef.
//
// Copyright (C) 2000-2009 Pierre Saramito <Pierre.Saramito@imag.fr>
//
// Rheolef 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 2 of the License, or
// (at your option) any later version.
//
// Rheolef is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Rheolef; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
// 
// =========================================================================
// AUTHOR: Pierre.Saramito@imag.fr
// DATE:   4 january 2018

namespace rheolef {
/**
@utilclassfile dis_memory_usage memory used in distributed environment

Synopsis
========
@snippet dis_memory_usage.h verbatim_dis_memory_usage

Description
===========
`seq_memory_usage`
>	Returns the current resident set size 
>	(physical memory use) measured in bytes, 
>	or zero if the value cannot be determined on this OS.

`dis_memory_usage`
>	Returns the accumulated memory usage
>	for all processed linked together via the default communicator.

`seq_peak_memory_usage`
>	Returns the peak (maximum so far)
>	resident set size (physical memory use) measured in bytes,
>	or zero if the value cannot be determined on this OS.

`dis_peak_memory_usage`
>	Returns the accumulated peak memory usage
>	for all processed linked together via the default communicator.

`memory_size`
>	Returns the size of physical memory (RAM) in bytes
>	associated to the given process.

Implementation
==============
@showfromfile
*/
} // namespace rheolef

#include "rheolef/communicator.h"

namespace rheolef {

// [verbatim_dis_memory_usage]
size_t seq_memory_usage();
size_t dis_memory_usage();
size_t seq_peak_memory_usage();
size_t dis_peak_memory_usage();
size_t memory_size();
// [verbatim_dis_memory_usage]

} // namespace rheolef
#endif // _RHEO_DIS_MEMORY_USAGE_H