added value of the sensor in the notification body
[psensor.git] / src / lib / psensor.c
1 /*
2  * Copyright (C) 2010-2012 jeanfi@gmail.com
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  * 02110-1301 USA
18  */
19 #include <stdlib.h>
20 #include <string.h>
21
22 #include <locale.h>
23 #include <libintl.h>
24 #define _(str) gettext(str)
25
26 #include "hdd.h"
27 #include "psensor.h"
28 #include "lmsensor.h"
29
30 #ifdef HAVE_GTOP
31 #include "cpu.h"
32 #endif
33
34
35 struct psensor *psensor_create(char *id, char *name,
36                                unsigned int type, int values_max_length)
37 {
38         struct psensor *psensor
39             = (struct psensor *)malloc(sizeof(struct psensor));
40
41         psensor->id = id;
42         psensor->name = name;
43         psensor->enabled = 1;
44         psensor->min = UNKNOWN_DBL_VALUE;
45         psensor->max = UNKNOWN_DBL_VALUE;
46
47         psensor->type = type;
48
49         psensor->values_max_length = values_max_length;
50         psensor->measures = measures_dbl_create(values_max_length);
51
52         psensor->alarm_limit = 0;
53
54         psensor->cb_alarm_raised = NULL;
55         psensor->cb_alarm_raised_data = NULL;
56         psensor->alarm_raised = 0;
57
58         psensor->alarm_enabled = 0;
59
60         psensor->url = NULL;
61
62         psensor->color = NULL;
63
64         return psensor;
65 }
66
67 void psensor_values_resize(struct psensor *s, int new_size)
68 {
69         struct measure *new_ms, *cur_ms;
70         int cur_size;
71
72         cur_size = s->values_max_length;
73         cur_ms = s->measures;
74         new_ms = measures_dbl_create(new_size);
75
76         if (cur_ms) {
77                 int i;
78                 for (i = 0; i < new_size - 1 && i < cur_size - 1; i++)
79                         measure_copy(&cur_ms[cur_size - i - 1],
80                                      &new_ms[new_size - i - 1]);
81
82                 measures_free(s->measures);
83         }
84
85         s->values_max_length = new_size;
86         s->measures = new_ms;
87 }
88
89 void psensor_free(struct psensor *sensor)
90 {
91         if (sensor) {
92                 log_debug("Cleanup %s", sensor->id);
93
94                 free(sensor->name);
95                 free(sensor->id);
96
97                 if (sensor->color)
98                         free(sensor->color);
99
100                 measures_free(sensor->measures);
101
102                 free(sensor->url);
103
104                 free(sensor);
105         }
106 }
107
108 void psensor_list_free(struct psensor **sensors)
109 {
110         struct psensor **sensor_cur;
111
112         if (sensors) {
113                 sensor_cur = sensors;
114
115                 while (*sensor_cur) {
116                         psensor_free(*sensor_cur);
117
118                         sensor_cur++;
119                 }
120
121                 free(sensors);
122
123                 sensors = NULL;
124         }
125 }
126
127 int psensor_list_size(struct psensor **sensors)
128 {
129         int size;
130         struct psensor **sensor_cur;
131
132         if (!sensors)
133                 return 0;
134
135         size = 0;
136         sensor_cur = sensors;
137
138         while (*sensor_cur) {
139                 size++;
140                 sensor_cur++;
141         }
142         return size;
143 }
144
145 int psensor_list_contains_type(struct psensor **sensors, unsigned int type)
146 {
147         struct psensor **s;
148
149         if (!sensors)
150                 return 0;
151
152         s = sensors;
153         while (*s) {
154                 if ((*s)->type == type)
155                         return 1;
156                 s++;
157         }
158
159         return 0;
160 }
161
162 struct psensor **psensor_list_add(struct psensor **sensors,
163                                   struct psensor *sensor)
164 {
165         int size = psensor_list_size(sensors);
166
167         struct psensor **result
168             = malloc((size + 1 + 1) * sizeof(struct psensor *));
169
170         if (sensors)
171                 memcpy(result, sensors, size * sizeof(struct psensor *));
172
173         result[size] = sensor;
174         result[size + 1] = NULL;
175
176         return result;
177 }
178
179 struct psensor *psensor_list_get_by_id(struct psensor **sensors, const char *id)
180 {
181         struct psensor **sensors_cur = sensors;
182
183         while (*sensors_cur) {
184                 if (!strcmp((*sensors_cur)->id, id))
185                         return *sensors_cur;
186
187                 sensors_cur++;
188         }
189
190         return NULL;
191 }
192
193 int is_temp_type(unsigned int type)
194 {
195         return type & SENSOR_TYPE_TEMP;
196 }
197
198 int is_fan_type(unsigned int type)
199 {
200         return type & SENSOR_TYPE_FAN;
201 }
202
203 double celcius_to_fahrenheit(double c)
204 {
205         return c * (9.0/5.0) + 32;
206 }
207
208 double fahrenheit_to_celcius(double f)
209 {
210         return (f - 32) * (5.0/9.0);
211 }
212
213 char *
214 psensor_value_to_str(unsigned int type, double value, int use_celcius)
215 {
216         /* should not be possible to exceed 20 characters with temp or
217            rpm values the .x part is never displayed */
218         char *str = malloc(20);
219
220         char *unit;
221
222         if (is_temp_type(type))
223                 if (use_celcius) {
224                         unit = "°C";
225                 } else {
226                         unit = "°F";
227                         value = celcius_to_fahrenheit(value);
228                 }
229         else if (type & SENSOR_TYPE_CPU_USAGE)
230                 unit = "%";
231         else
232                 unit = "";
233
234         sprintf(str, "%.0f%s", value, unit);
235
236         return str;
237 }
238
239 char *
240 psensor_measure_to_str(const struct measure *m,
241                        unsigned int type,
242                        unsigned int use_celcius)
243 {
244         return psensor_value_to_str(type, m->value, use_celcius);
245 }
246
247 void psensor_set_current_value(struct psensor *sensor, double value)
248 {
249         struct timeval tv;
250
251         if (gettimeofday(&tv, NULL) != 0)
252                 timerclear(&tv);
253
254         psensor_set_current_measure(sensor, value, tv);
255 }
256
257 void
258 psensor_set_current_measure(struct psensor *s,
259                             double v, struct timeval tv)
260 {
261         memmove(s->measures,
262                 &s->measures[1],
263                 (s->values_max_length - 1) * sizeof(struct measure));
264
265         s->measures[s->values_max_length - 1].value = v;
266         s->measures[s->values_max_length - 1].time = tv;
267
268         if (s->min == UNKNOWN_DBL_VALUE || v < s->min)
269                 s->min = v;
270
271         if (s->max == UNKNOWN_DBL_VALUE || v > s->max)
272                 s->max = v;
273
274         if (s->alarm_limit && s->alarm_enabled) {
275                 if (v > s->alarm_limit) {
276                         if (!s->alarm_raised && s->cb_alarm_raised)
277                                 s->cb_alarm_raised(s,
278                                                    s->cb_alarm_raised_data);
279
280                         s->alarm_raised = 1;
281                 } else {
282                         s->alarm_raised = 0;
283                 }
284         }
285 }
286
287 double psensor_get_current_value(struct psensor *sensor)
288 {
289         return sensor->measures[sensor->values_max_length - 1].value;
290 }
291
292 struct measure *psensor_get_current_measure(struct psensor *sensor)
293 {
294         return &sensor->measures[sensor->values_max_length - 1];
295 }
296
297 /*
298   Returns the minimal value of a given 'type' (SENSOR_TYPE_TEMP or
299   SENSOR_TYPE_FAN)
300  */
301 double get_min_value(struct psensor **sensors, int type)
302 {
303         double m = UNKNOWN_DBL_VALUE;
304         struct psensor **s = sensors;
305
306         while (*s) {
307                 struct psensor *sensor = *s;
308
309                 if (sensor->enabled && (sensor->type & type)) {
310                         int i;
311                         double t;
312
313                         for (i = 0; i < sensor->values_max_length; i++) {
314                                 t = sensor->measures[i].value;
315
316                                 if (t == UNKNOWN_DBL_VALUE)
317                                         continue;
318
319                                 if (m == UNKNOWN_DBL_VALUE || t < m)
320                                         m = t;
321                         }
322                 }
323                 s++;
324         }
325
326         return m;
327 }
328
329 /*
330   Returns the maximal value of a given 'type' (SENSOR_TYPE_TEMP or
331   SENSOR_TYPE_FAN)
332  */
333 double get_max_value(struct psensor **sensors, int type)
334 {
335         double m = UNKNOWN_DBL_VALUE;
336         struct psensor **s = sensors;
337
338         while (*s) {
339                 struct psensor *sensor = *s;
340
341                 if (sensor->enabled && (sensor->type & type)) {
342                         int i;
343                         double t;
344                         for (i = 0; i < sensor->values_max_length; i++) {
345                                 t = sensor->measures[i].value;
346
347                                 if (t == UNKNOWN_DBL_VALUE)
348                                         continue;
349
350                                 if (m == UNKNOWN_DBL_VALUE || t > m)
351                                         m = t;
352                         }
353                 }
354                 s++;
355         }
356
357         return m;
358 }
359
360 double
361 psensor_get_max_current_value(struct psensor **sensors, unsigned int type)
362 {
363         double m = UNKNOWN_DBL_VALUE;
364         struct psensor **s_cur = sensors;
365
366         while (*s_cur) {
367                 struct psensor *s = *s_cur;
368
369                 if (s->enabled && (s->type & type)) {
370                         double v = psensor_get_current_value(s);
371
372                         if (m == UNKNOWN_DBL_VALUE || v > m)
373                                 m = v;
374                 }
375
376                 s_cur++;
377         }
378
379         return m;
380 }
381
382 double get_min_temp(struct psensor **sensors)
383 {
384         return get_min_value(sensors, SENSOR_TYPE_TEMP);
385 }
386
387 double get_min_rpm(struct psensor **sensors)
388 {
389         return get_min_value(sensors, SENSOR_TYPE_FAN);
390 }
391
392 double get_max_rpm(struct psensor **sensors)
393 {
394         return get_max_value(sensors, SENSOR_TYPE_FAN);
395 }
396
397 double get_max_temp(struct psensor **sensors)
398 {
399         return get_max_value(sensors, SENSOR_TYPE_TEMP);
400 }
401
402 struct psensor **get_all_sensors(int use_libatasmart, int values_max_length)
403 {
404         struct psensor **psensors = NULL;
405         struct psensor **tmp_psensors;
406
407         psensors = lmsensor_psensor_list_add(NULL, values_max_length);
408
409         if (!use_libatasmart) {
410                 tmp_psensors = hddtemp_psensor_list_add(psensors,
411                                                         values_max_length);
412                 if (tmp_psensors != psensors) {
413                         free(psensors);
414                         psensors = tmp_psensors;
415                 }
416         }
417 #ifdef HAVE_ATASMART
418                 else {
419                         tmp_psensors = hdd_psensor_list_add(psensors,
420                                                             values_max_length);
421                         if (tmp_psensors != psensors) {
422                                 free(psensors);
423                                 psensors = tmp_psensors;
424                         }
425                 }
426 #endif
427
428         if (!psensors) {        /* there is no detected sensors */
429                 psensors = malloc(sizeof(struct psensor *));
430                 *psensors = NULL;
431         }
432
433         return psensors;
434 }
435
436 const char *psensor_type_to_str(unsigned int type)
437 {
438         if ((type & SENSOR_TYPE_NVIDIA_TEMP) == SENSOR_TYPE_NVIDIA_TEMP)
439                 return "NVidia GPU Temperature";
440
441         if ((type & SENSOR_TYPE_AMD_TEMP) == SENSOR_TYPE_AMD_TEMP)
442                 return "AMD GPU Temperature";
443
444         if ((type & SENSOR_TYPE_AMD_FAN) == SENSOR_TYPE_AMD_FAN)
445                 return "AMD GPU Fan Speed";
446
447         if ((type & SENSOR_TYPE_HDD_TEMP) == SENSOR_TYPE_HDD_TEMP)
448                 return "HDD Temperature";
449
450         if (type & SENSOR_TYPE_CPU_USAGE)
451                 return "CPU Usage";
452
453         if (type & SENSOR_TYPE_TEMP)
454                 return "Temperature";
455
456         if (type & SENSOR_TYPE_FAN)
457                 return "Fan";
458
459         if (type & SENSOR_TYPE_REMOTE)
460                 return "Remote";
461
462         return "N/A";           /* should not be possible */
463 }
464
465
466 const char *psensor_type_to_unit_str(unsigned int type, int use_celcius)
467 {
468         if (type & SENSOR_TYPE_TEMP) {
469                 if (use_celcius)
470                         return _("°C");
471                 else
472                         return _("°F");
473         }
474
475         if (type & SENSOR_TYPE_FAN)
476                 return _("RPM");
477
478         if (type & SENSOR_TYPE_CPU_USAGE)
479                 return _("%");
480
481         return "N/A";
482 }
483
484 void psensor_list_update_measures(struct psensor **sensors)
485 {
486         lmsensor_psensor_list_update(sensors);
487
488 #ifdef HAVE_GTOP
489         cpu_psensor_list_update(sensors);
490 #endif
491
492         if (psensor_list_contains_type(sensors, SENSOR_TYPE_HDD_TEMP_HDDTEMP))
493                 hddtemp_psensor_list_update(sensors);
494
495 #ifdef HAVE_ATASMART
496         if (psensor_list_contains_type(sensors,
497                                        SENSOR_TYPE_HDD_TEMP_ATASMART))
498                 hdd_psensor_list_update(sensors);
499 #endif
500 }
501
502 void psensor_log_measures(struct psensor **sensors)
503 {
504         if (log_level == LOG_DEBUG)
505                 while (*sensors) {
506                         log_debug("Measure: %s %.2f",
507                                    (*sensors)->name,
508                                    psensor_get_current_value(*sensors));
509
510                         sensors++;
511                 }
512 }
513
514 void psensor_init()
515 {
516         lmsensor_init();
517 }
518
519 void psensor_cleanup()
520 {
521         lmsensor_cleanup();
522 }