File: utilities.h

package info (click to toggle)
ergo 3.8.2-1.1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 17,568 kB
  • sloc: cpp: 94,763; ansic: 17,785; sh: 10,701; makefile: 1,403; yacc: 127; lex: 116; awk: 23
file content (127 lines) | stat: -rw-r--r-- 4,101 bytes parent folder | download
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/* Ergo, version 3.8.2, a program for linear scaling electronic structure
 * calculations.
 * Copyright (C) 2023 Elias Rudberg, Emanuel H. Rubensson, Pawel Salek,
 * and Anastasia Kruchinina.
 * 
 * This program 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.
 * 
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * Primary academic reference:
 * Ergo: An open-source program for linear-scaling electronic structure
 * calculations,
 * Elias Rudberg, Emanuel H. Rubensson, Pawel Salek, and Anastasia
 * Kruchinina,
 * SoftwareX 7, 107 (2018),
 * <http://dx.doi.org/10.1016/j.softx.2018.03.005>
 * 
 * For further information about Ergo, see <http://www.ergoscf.org>.
 */

/** @file utilities.h

    @brief Basic OS access utilities.

    @author: Elias Rudberg <em>responsible</em>
*/

#ifndef UTILITIES_HEADER
#define UTILITIES_HEADER


#include <time.h>
#include <sys/time.h>
#include <sys/resource.h>


#define MAX_HOST_NAME_LEN 100

typedef struct
{
  char s[MAX_HOST_NAME_LEN];
} host_name_struct;

#define MAX_WORKING_DIRECTORY_LEN 800

typedef struct
{
  char s[MAX_WORKING_DIRECTORY_LEN];
} working_directory_struct;

void get_host_name(host_name_struct* result);

void get_working_directory(working_directory_struct* result);

int get_memory_usage_by_ps(double* virtualMemoryGigaBytes, double* residentMemoryGigaBytes);

int get_memory_usage_by_procfile(double* virtualMemGigaBytes,
					  double* residentMemGigaBytes,
					  double* virtualMemPeakGigaBytes);

int generate_unique_random_filename(char* result, unsigned n);

long int get_file_size(const char* fileName);

#include <stdexcept>
#include "output.h"
#include "realtype.h"
namespace Util {
  /** Time-measuring class. Measures the time between the
      construction of the object and the call of the print method. */
  class TimeMeter {
  private:
    double startTimeCPU_sys;
    double startTimeCPU_usr;
    double startTimeWall;
  public:
    double get_start_time_wall_seconds() const {
      return startTimeWall;
    }
    static double get_wall_seconds() {
      struct timeval tv;
      if(gettimeofday(&tv, NULL) != 0)
        throw std::runtime_error("Error in get_wall_seconds(), in gettimeofday().");
      double seconds = tv.tv_sec + (double)tv.tv_usec / 1000000;
      return seconds;
    }
    static void get_current_cpu_times(double & seconds_usr, double & seconds_sys) {
      struct rusage usage;
      if(getrusage (RUSAGE_SELF, &usage) != 0)
	throw std::runtime_error("Error in get_current_cpu_times(), in getrusage().");
      seconds_usr = usage.ru_utime.tv_sec + (double)usage.ru_utime.tv_usec / 1000000;
      seconds_sys = usage.ru_stime.tv_sec + (double)usage.ru_stime.tv_usec / 1000000;
    }
    TimeMeter() {
      startTimeWall = get_wall_seconds();
      get_current_cpu_times(startTimeCPU_usr, startTimeCPU_sys);
    }
    double get_elapsed_wall_seconds() {
      double endTimeWall = get_wall_seconds();
      return endTimeWall - startTimeWall;
    }
    void print(int area, const char *routine) {
      double endTimeWall = get_wall_seconds();
      double secondsTakenWall = endTimeWall - startTimeWall;
      double seconds_usr, seconds_sys;
      get_current_cpu_times(seconds_usr, seconds_sys);
      double secondsTakenCPU_usr = seconds_usr - startTimeCPU_usr;
      double secondsTakenCPU_sys = seconds_sys - startTimeCPU_sys;
      do_output(LOG_CAT_TIMINGS, area, "%s took %9.2f usr cpu s  %9.2f sys cpu s  %9.2f wall s", 
		routine, secondsTakenCPU_usr, secondsTakenCPU_sys, secondsTakenWall);
    }
    

  };
}


#endif /* UTILITIES_HEADER */