[svn-upgrade] Integrating new upstream version, cpulimit (1.12~svn10)
[debian/cpulimit.git] / process.h
1 /**
2  *
3  * cpulimit - a cpu limiter for Linux
4  *
5  * Copyright (C) 2005-2008, by:  Angelo Marletta <marlonx80@hotmail.com>
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
20  */
21
22 #ifndef __PROCESS_H
23
24 #define __PROCESS_H
25
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <sys/types.h>
30 #include <signal.h>
31 #include <time.h>
32 #include <sys/time.h>
33 #include <unistd.h>
34
35 //kernel time resolution (inverse of one jiffy interval) in Hertz
36 #define HZ sysconf(_SC_CLK_TCK)
37 //size of the history circular queue
38 #define HISTORY_SIZE 10
39
40 //extracted process statistics
41 struct cpu_usage {
42         float pcpu;
43         float workingrate;
44 };
45
46 //process instant photo
47 struct process_screenshot {
48         //timestamp
49         struct timespec when;
50         //total jiffies used by the process
51         int jiffies;
52         //cpu time used since previous screenshot expressed in microseconds
53         int cputime;
54 };
55
56 //process descriptor
57 struct process_history {
58         //the PID of the process
59         int pid;
60         //name of /proc/PID/stat file
61         char stat_file[20];
62         //read buffer for /proc filesystem
63         char buffer[1024];
64         //recent history of the process (fixed circular queue)
65         struct process_screenshot history[HISTORY_SIZE];
66         //the index of the last screenshot made to the process
67         int front_index;
68         //the index of the oldest screenshot made to the process
69         int tail_index;
70         //how many screenshots we have in the queue (max HISTORY_SIZE)
71         int actual_history_size;
72         //total cputime saved in the history
73         long total_workingtime;
74         //current usage
75         struct cpu_usage usage;
76 };
77
78 int process_init(struct process_history *proc, int pid);
79
80 int process_monitor(struct process_history *proc, int last_working_quantum, struct cpu_usage *usage);
81
82 int process_close(struct process_history *proc);
83
84 #endif