added degree sign before C/F
[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 char *psensor_value_to_string(unsigned int type,
209                               double value,
210                               int use_celcius)
211 {
212         /* should not be possible to exceed 20 characters with temp or
213            rpm values the .x part is never displayed */
214         char *str = malloc(20);
215
216         char *unit;
217
218         if (is_temp_type(type))
219                 if (use_celcius) {
220                         unit = "°C";
221                 } else {
222                         unit = "°F";
223                         value = celcius_to_fahrenheit(value);
224                 }
225         else if (type & SENSOR_TYPE_CPU_USAGE)
226                 unit = "%";
227         else
228                 unit = "";
229
230         sprintf(str, "%.0f%s", value, unit);
231
232         return str;
233 }
234
235 void psensor_set_current_value(struct psensor *sensor, double value)
236 {
237         struct timeval tv;
238
239         if (gettimeofday(&tv, NULL) != 0)
240                 timerclear(&tv);
241
242         psensor_set_current_measure(sensor, value, tv);
243 }
244
245 void
246 psensor_set_current_measure(struct psensor *s,
247                             double v, struct timeval tv)
248 {
249         memmove(s->measures,
250                 &s->measures[1],
251                 (s->values_max_length - 1) * sizeof(struct measure));
252
253         s->measures[s->values_max_length - 1].value.d_num = v;
254         s->measures[s->values_max_length - 1].time = tv;
255
256         if (s->min == UNKNOWN_DBL_VALUE || v < s->min)
257                 s->min = v;
258
259         if (s->max == UNKNOWN_DBL_VALUE || v > s->max)
260                 s->max = v;
261
262         if (s->alarm_limit && s->alarm_enabled) {
263                 if (v > s->alarm_limit) {
264                         if (!s->alarm_raised && s->cb_alarm_raised)
265                                 s->cb_alarm_raised(s,
266                                                    s->cb_alarm_raised_data);
267
268                         s->alarm_raised = 1;
269                 } else {
270                         s->alarm_raised = 0;
271                 }
272         }
273 }
274
275 double psensor_get_current_value(struct psensor *sensor)
276 {
277         return sensor->measures[sensor->values_max_length - 1].value.d_num;
278 }
279
280 struct measure *psensor_get_current_measure(struct psensor *sensor)
281 {
282         return &sensor->measures[sensor->values_max_length - 1];
283 }
284
285 /*
286   Returns the minimal value of a given 'type' (SENSOR_TYPE_TEMP or
287   SENSOR_TYPE_FAN)
288  */
289 double get_min_value(struct psensor **sensors, int type)
290 {
291         double m = UNKNOWN_DBL_VALUE;
292         struct psensor **s = sensors;
293
294         while (*s) {
295                 struct psensor *sensor = *s;
296
297                 if (sensor->enabled && (sensor->type & type)) {
298                         int i;
299                         double t;
300
301                         for (i = 0; i < sensor->values_max_length; i++) {
302                                 t = sensor->measures[i].value.d_num;
303
304                                 if (t == UNKNOWN_DBL_VALUE)
305                                         continue;
306
307                                 if (m == UNKNOWN_DBL_VALUE || t < m)
308                                         m = t;
309                         }
310                 }
311                 s++;
312         }
313
314         return m;
315 }
316
317 /*
318   Returns the maximal value of a given 'type' (SENSOR_TYPE_TEMP or
319   SENSOR_TYPE_FAN)
320  */
321 double get_max_value(struct psensor **sensors, int type)
322 {
323         double m = UNKNOWN_DBL_VALUE;
324         struct psensor **s = sensors;
325
326         while (*s) {
327                 struct psensor *sensor = *s;
328
329                 if (sensor->enabled && (sensor->type & type)) {
330                         int i;
331                         double t;
332                         for (i = 0; i < sensor->values_max_length; i++) {
333                                 t = sensor->measures[i].value.d_num;
334
335                                 if (t == UNKNOWN_DBL_VALUE)
336                                         continue;
337
338                                 if (m == UNKNOWN_DBL_VALUE || t > m)
339                                         m = t;
340                         }
341                 }
342                 s++;
343         }
344
345         return m;
346 }
347
348 double
349 psensor_get_max_current_value(struct psensor **sensors, unsigned int type)
350 {
351         double m = UNKNOWN_DBL_VALUE;
352         struct psensor **s_cur = sensors;
353
354         while (*s_cur) {
355                 struct psensor *s = *s_cur;
356
357                 if (s->enabled && (s->type & type)) {
358                         double v = psensor_get_current_value(s);
359
360                         if (m == UNKNOWN_DBL_VALUE || v > m)
361                                 m = v;
362                 }
363
364                 s_cur++;
365         }
366
367         return m;
368 }
369
370 double get_min_temp(struct psensor **sensors)
371 {
372         return get_min_value(sensors, SENSOR_TYPE_TEMP);
373 }
374
375 double get_min_rpm(struct psensor **sensors)
376 {
377         return get_min_value(sensors, SENSOR_TYPE_FAN);
378 }
379
380 double get_max_rpm(struct psensor **sensors)
381 {
382         return get_max_value(sensors, SENSOR_TYPE_FAN);
383 }
384
385 double get_max_temp(struct psensor **sensors)
386 {
387         return get_max_value(sensors, SENSOR_TYPE_TEMP);
388 }
389
390 struct psensor **get_all_sensors(int use_libatasmart, int values_max_length)
391 {
392         struct psensor **psensors = NULL;
393         struct psensor **tmp_psensors;
394
395         psensors = lmsensor_psensor_list_add(NULL, values_max_length);
396
397         if (!use_libatasmart) {
398                 tmp_psensors = hddtemp_psensor_list_add(psensors,
399                                                         values_max_length);
400                 if (tmp_psensors != psensors) {
401                         free(psensors);
402                         psensors = tmp_psensors;
403                 }
404         }
405 #ifdef HAVE_ATASMART
406                 else {
407                         tmp_psensors = hdd_psensor_list_add(psensors,
408                                                             values_max_length);
409                         if (tmp_psensors != psensors) {
410                                 free(psensors);
411                                 psensors = tmp_psensors;
412                         }
413                 }
414 #endif
415
416         if (!psensors) {        /* there is no detected sensors */
417                 psensors = malloc(sizeof(struct psensor *));
418                 *psensors = NULL;
419         }
420
421         return psensors;
422 }
423
424 const char *psensor_type_to_str(unsigned int type)
425 {
426         if ((type & SENSOR_TYPE_NVIDIA_TEMP) == SENSOR_TYPE_NVIDIA_TEMP)
427                 return "NVidia GPU Temperature";
428
429         if ((type & SENSOR_TYPE_AMD_TEMP) == SENSOR_TYPE_AMD_TEMP)
430                 return "AMD GPU Temperature";
431
432         if ((type & SENSOR_TYPE_AMD_FAN) == SENSOR_TYPE_AMD_FAN)
433                 return "AMD GPU Fan Speed";
434
435         if ((type & SENSOR_TYPE_HDD_TEMP) == SENSOR_TYPE_HDD_TEMP)
436                 return "HDD Temperature";
437
438         if (type & SENSOR_TYPE_CPU_USAGE)
439                 return "CPU Usage";
440
441         if (type & SENSOR_TYPE_TEMP)
442                 return "Temperature";
443
444         if (type & SENSOR_TYPE_FAN)
445                 return "Fan";
446
447         if (type & SENSOR_TYPE_REMOTE)
448                 return "Remote";
449
450         return "N/A";           /* should not be possible */
451 }
452
453
454 const char *psensor_type_to_unit_str(unsigned int type, int use_celcius)
455 {
456         if (type & SENSOR_TYPE_TEMP) {
457                 if (use_celcius)
458                         return _("°C");
459                 else
460                         return _("°F");
461         }
462
463         if (type & SENSOR_TYPE_FAN)
464                 return _("RPM");
465
466         if (type & SENSOR_TYPE_CPU_USAGE)
467                 return _("%");
468
469         return "N/A";
470 }
471
472 void psensor_list_update_measures(struct psensor **sensors)
473 {
474         lmsensor_psensor_list_update(sensors);
475
476 #ifdef HAVE_GTOP
477         cpu_psensor_list_update(sensors);
478 #endif
479
480         if (psensor_list_contains_type(sensors, SENSOR_TYPE_HDD_TEMP_HDDTEMP))
481                 hddtemp_psensor_list_update(sensors);
482
483 #ifdef HAVE_ATASMART
484         if (psensor_list_contains_type(sensors,
485                                        SENSOR_TYPE_HDD_TEMP_ATASMART))
486                 hdd_psensor_list_update(sensors);
487 #endif
488 }
489
490 void psensor_log_measures(struct psensor **sensors)
491 {
492         if (log_level == LOG_DEBUG)
493                 while (*sensors) {
494                         log_debug("Measure: %s %.2f",
495                                    (*sensors)->name,
496                                    psensor_get_current_value(*sensors));
497
498                         sensors++;
499                 }
500 }
501
502 void psensor_init()
503 {
504         lmsensor_init();
505 }
506
507 void psensor_cleanup()
508 {
509         lmsensor_cleanup();
510 }