summaryrefslogtreecommitdiff
path: root/src/components/utils/include/utils/resource_usage.h
blob: ff90b2c22f8951a417361fe6a4880eb4886f99c7 (plain)
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/*
 * Copyright (c) 2014, Ford Motor Company
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the Ford Motor Company nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef SRC_COMPONENTS_UTILS_INCLUDE_UTILS_RESOURCE_USAGE_H_
#define SRC_COMPONENTS_UTILS_INCLUDE_UTILS_RESOURCE_USAGE_H_

#include <sys/resource.h>
#if defined(__QNXNTO__)
#include <sys/procfs.h>
#endif

#include "utils/macro.h"
#include <string>
#include <iostream>

#include "utils/logger.h"

#define MAX_COMM_LEN	128
#define MAX_CMDLINE_LEN	128

namespace utils {

struct ResourseUsage {
  long long int utime;
  long long int stime;
  long long int memory;
};

class Resources {
  public:
  typedef uint32_t MemInfo;
#if defined(__QNXNTO__)
  typedef procfs_info PidStats;

#elif defined(OS_LINUX)

  struct PidStats {
    int pid;
    char comm[MAX_COMM_LEN];
    char state;
    int ppid;
    int pgrp;
    int session;
    int tty_nr;
    int tpgid;
    unsigned int flags;
    unsigned long minflt;
    unsigned long cminflt;
    unsigned long majflt;
    unsigned long cmajflt;
    unsigned long utime;
    long stime;
    long cutime;
    long cstime;
    long priority;
    long nice;
    long num_threads;
    long itrealvalue;
    unsigned long long starttime;
    unsigned long vsize;
    long rss;
    unsigned long rsslim;
    unsigned long startcode;
    unsigned long endcode;
    unsigned long startstack;
    unsigned long kstkesp;
    unsigned long kstkeip;
    unsigned long signal;
    unsigned long blocked;
    unsigned long sigignore;
    unsigned long sigcatch;
    unsigned long wchan;
    unsigned long nswap;
    unsigned long cnswap;
    int exit_signal;
    int processor;
    unsigned int rt_priority;
    unsigned int policy;
    unsigned long long delayacct_blkio_ticks;
    unsigned long guest_time;
    long int cguest_time;
    };
#else

#endif
  public:
    /*
     * @brief Returns current resource usage of process
     * @return Raw pointer on  ResourseUsage if success, otherwise return NULL
     */
  static ResourseUsage* getCurrentResourseUsage();

private:

#ifdef BUILD_TESTS
  friend class ResourceUsagePrivateTest;
  FRIEND_TEST(ResourceUsagePrivateTest, ReadStatFileTest);
  FRIEND_TEST(ResourceUsagePrivateTest, GetProcInfoTest);
  FRIEND_TEST(ResourceUsagePrivateTest, GetMemInfoTest);
  FRIEND_TEST(ResourceUsagePrivateTest, GetStatPathTest_FileExists);
  FRIEND_TEST(ResourceUsagePrivateTest, GetStatPathTest_ReadFile);
  FRIEND_TEST(ResourceUsagePrivateTest, GetProcPathTest);
#endif

  /*
   * @brief reads /proc/PID/stat file on linux
   *        do not work on QNX ( return false, output wan't be changed )
   * @param output - storage for result string ( there will be separated content of /proc/PID/stat )
   * @return true on succes false onb fail
   */
  static bool ReadStatFile(std::string& output);

  /*
   * @brief Grab information about curent process
   * @param output - storage for result struct
   * @return true on succes false onb fail
   */
  static bool GetProcInfo(PidStats& output);

  /*
   * @brief Grab process memory information
   * @param output - storage for result struct
   * @return true on succes false onb fail
   */
  static bool GetMemInfo(MemInfo& output);

  /*
   * @brief return path to /proc/PID/stat file on linux
   *        return path to /proc/PID/as file on linux
   * @return path to file
   */
  static std::string GetStatPath();

  /*
   * @brief return path to /proc/PID directry
   * @return path to dir
   */
  static std::string GetProcPath();

  /*
   * path to /proc/ directory
   */
  static const char* proc;
};

}



#endif /* SRC_COMPONENTS_UTILS_INCLUDE_UTILS_RESOURCE_USAGE_H_ */