Fix input parameter
[collectd.git] / src / mic.c
1 /**
2  * collectd - src/mic.c
3  * Copyright (C) 2013 Battelle Memorial Institute
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License as published by the
7  * Free Software Foundation; only version 2 of the License is applicable.
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 along
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
17  *
18  * Authors:
19  *   Evan Felix <evan.felix@pnnl.gov>
20  **/
21
22 #include "collectd.h"
23 #include "plugin.h"
24 #include "common.h"
25 #include "utils_ignorelist.h"
26
27 #include <MicAccessTypes.h>
28 #include <MicAccessErrorTypes.h>
29 #include <MicAccessApi.h>
30 #include <MicThermalAPI.h>
31
32 #define MAX_MICS 32
33 #define MAX_CORES 256
34
35 static MicDeviceOnSystem mics[MAX_MICS];
36 static U32 num_mics = MAX_MICS;
37 static HANDLE mic_handle = NULL;
38 #define NUM_THERMS 7
39 static const int therms[NUM_THERMS] = {eMicThermalDie,eMicThermalDevMem,eMicThermalFin,eMicThermalFout,eMicThermalVccp,eMicThermalVddg,eMicThermalVddq};
40 static const char *therm_names[NUM_THERMS] = {"die","devmem","fin","fout","vccp","vddg","vddq"};
41
42 static const char *config_keys[] =
43 {
44         "ShowTotalCPU",
45         "ShowPerCPU",
46         "ShowTemps",
47         "ShowMemory",
48         "TempSensor",
49         "IgnoreTempSelected",
50 };
51 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
52
53 static _Bool show_total_cpu = 1;
54 static _Bool show_per_cpu = 1;
55 static _Bool show_temps = 1;
56 static _Bool show_memory = 1;
57 static ignorelist_t *temp_ignore = NULL;
58
59
60 static int mic_init (void)
61 {
62         U32 ret;
63
64         if (mic_handle)
65                 return (0);
66
67         ret = MicInitAPI(&mic_handle,  eTARGET_SCIF_DRIVER, mics, &num_mics);
68         if (ret != MIC_ACCESS_API_SUCCESS) {
69                 ERROR("Problem initializing MicAccessAPI: %s",MicGetErrorString(ret));
70         }
71         DEBUG("MICs found: %d",num_mics);
72         
73         if (num_mics<0 || num_mics>=MAX_MICS) {
74                 ERROR("No Intel MICs in system");
75                 return (1);
76         }
77         else
78                 return (0);
79 }
80
81 static int mic_config (const char *key, const char *value) {
82         if (temp_ignore == NULL)
83                 temp_ignore = ignorelist_create(1);
84         if (temp_ignore == NULL)
85                 return (1);
86
87         if (strcasecmp("ShowTotalCPU",key) == 0)
88         {
89                 show_total_cpu = IS_TRUE(value);
90         }
91         else if (strcasecmp("ShowPerCPU",key) == 0)
92         {
93                 show_per_cpu = IS_TRUE(value);
94         }
95         else if (strcasecmp("ShowTemps",key) == 0)
96         {
97                 show_temps = IS_TRUE(value);
98         }
99         else if (strcasecmp("ShowMemory",key) == 0)
100         {
101                 show_memory = IS_TRUE(value);
102         }
103         else if (strcasecmp("TempSensor",key) == 0)
104         {
105                 ignorelist_add(temp_ignore,value);
106         }
107         else if (strcasecmp("IgnoreTempSelected",key) == 0)
108         {
109                 int invert = 1;
110                 if (IS_TRUE(value))
111                         invert = 0;
112                 ignorelist_set_invert(temp_ignore,invert);
113         }
114         else
115         {
116                 return (-1);
117         }
118         return (0);
119 }
120
121 static void mic_submit_memory_use(int micnumber, const char *type_instance, gauge_t val)
122 {
123         value_t values[1];
124         value_list_t vl = VALUE_LIST_INIT;
125
126         values[0].gauge = val;
127
128         vl.values=values;
129         vl.values_len=1;
130
131         strncpy (vl.host, hostname_g, sizeof (vl.host));
132         strncpy (vl.plugin, "mic", sizeof (vl.plugin));
133         ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance), "%i", micnumber);
134         strncpy (vl.type, "memory", sizeof (vl.type));
135         strncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
136
137         plugin_dispatch_values (&vl);
138
139
140 /* Gather memory Utilization */
141 static int mic_read_memory(int mic)
142 {
143         U32 ret;
144         U32 mem_total,mem_used,mem_bufs;
145         
146         ret = MicGetMemoryUtilization(mic_handle,&mem_total,&mem_used,&mem_bufs);
147         if (ret != MIC_ACCESS_API_SUCCESS) {
148                 ERROR("Problem getting Memory Utilization: %s",MicGetErrorString(ret));
149                 return (1);
150         }
151         /* API reprots KB's of memory, adjust for this */ 
152         mic_submit_memory_use(mic,"free",(mem_total-mem_used-mem_bufs)*1024);
153         mic_submit_memory_use(mic,"used",mem_used*1024);
154         mic_submit_memory_use(mic,"buffered",mem_bufs*1024);
155         /*INFO("Memory Read: %u %u %u",mem_total,mem_used,mem_bufs);*/
156         return (0);
157 }
158
159 static void mic_submit_temp(int micnumber, const char *type, gauge_t val)
160 {
161         value_t values[1];
162         value_list_t vl = VALUE_LIST_INIT;
163
164         values[0].gauge = val;
165
166         vl.values=values;
167         vl.values_len=1;
168
169         strncpy (vl.host, hostname_g, sizeof (vl.host));
170         strncpy (vl.plugin, "mic", sizeof (vl.plugin));
171         ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance), "%i", micnumber);
172         strncpy (vl.type, "temperature", sizeof (vl.type));
173         strncpy (vl.type_instance, type, sizeof (vl.type_instance));
174
175         plugin_dispatch_values (&vl);
176
177
178 /* Gather Temperature Information */
179 static int mic_read_temps(int mic)
180 {
181         int j;
182         U32 ret;
183         U32 temp_buffer;
184         U32 buffer_size = (U32)sizeof(temp_buffer);
185         
186         for (j=0;j<NUM_THERMS;j++) {
187                 if (ignorelist_match(temp_ignore,therm_names[j])!=0)
188                         continue;
189                 ret = MicGetTemperature(mic_handle,therms[j],&temp_buffer,&buffer_size);
190                 if (ret != MIC_ACCESS_API_SUCCESS) {
191                         ERROR("Problem getting Temperature(%d) %s",j,MicGetErrorString(ret));
192                         return (1);
193                 }
194                 mic_submit_temp(mic,therm_names[j],temp_buffer);
195         }
196         return (0);
197 }
198
199 static void mic_submit_cpu(int micnumber, const char *type_instance, int core, derive_t val)
200 {
201         value_t values[1];
202         value_list_t vl = VALUE_LIST_INIT;
203
204         values[0].derive = val;
205
206         vl.values=values;
207         vl.values_len=1;
208
209         strncpy (vl.host, hostname_g, sizeof (vl.host));
210         strncpy (vl.plugin, "mic", sizeof (vl.plugin));
211         ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance), "%i", micnumber);
212         strncpy (vl.type, "cpu", sizeof (vl.type));
213         if (core < 0)
214                 strncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
215         else
216                 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%i-%s", core, type_instance);
217
218         plugin_dispatch_values (&vl);
219
220
221 /*Gather CPU Utilization Information */
222 static int mic_read_cpu(int mic)
223 {
224         U32 ret;
225         U32 buffer_size;
226         int j;
227         MicCoreUtil core_util;
228         MicCoreJiff core_jiffs[MAX_CORES];
229
230         buffer_size=MAX_CORES*sizeof(MicCoreJiff);
231         ret = MicGetCoreUtilization(mic_handle,&core_util,core_jiffs,&buffer_size);
232         if (ret != MIC_ACCESS_API_SUCCESS) {
233                 ERROR("Problem getting CPU utilization: %s",MicGetErrorString(ret));
234                 return(0);
235         }
236         if (show_total_cpu) {
237                 mic_submit_cpu(mic,"user",-1,core_util.sum.user);
238                 mic_submit_cpu(mic,"sys",-1,core_util.sum.sys);
239                 mic_submit_cpu(mic,"nice",-1,core_util.sum.nice);
240                 mic_submit_cpu(mic,"idle",-1,core_util.sum.idle);
241         }
242         if (show_per_cpu) {
243                 for (j=0;j<core_util.core;j++) {
244                         mic_submit_cpu(mic,"user",j,core_jiffs[j].user);
245                         mic_submit_cpu(mic,"sys",j,core_jiffs[j].sys);
246                         mic_submit_cpu(mic,"nice",j,core_jiffs[j].nice);
247                         mic_submit_cpu(mic,"idle",j,core_jiffs[j].idle);
248                 }
249         }
250         return (0);
251 }
252
253 static int mic_read (void)
254 {
255         int i;
256         U32 ret;
257         int error;
258
259         error=0;
260         for (i=0;i<num_mics;i++) {
261                 ret = MicInitAdapter(&mic_handle,&mics[i]);
262                 if (ret != MIC_ACCESS_API_SUCCESS) {
263                         ERROR("Problem initializing MicAdapter: %s",MicGetErrorString(ret));
264                         error=1;
265                 }
266
267                 if (error == 0 && show_memory)
268                         error = mic_read_memory(i);
269
270                 if (error == 0 && show_temps)
271                         error = mic_read_temps(i);
272
273                 if (error == 0 && (show_total_cpu || show_per_cpu))
274                         error = mic_read_cpu(i);
275
276                 ret = MicCloseAdapter(mic_handle);
277                 if (ret != MIC_ACCESS_API_SUCCESS) {
278                         ERROR("Problem closing MicAdapter: %s",MicGetErrorString(ret));
279                         error=2;
280                         break;
281                 }
282         }
283         if (num_mics==0)
284                 error=3;
285         return error;
286 }
287
288
289 static int mic_shutdown (void)
290 {
291         if (mic_handle)
292         MicCloseAPI(&mic_handle);
293         return (0);
294 }
295
296 void module_register (void)
297 {
298         plugin_register_init ("mic", mic_init);
299         plugin_register_shutdown ("mic", mic_shutdown);
300         plugin_register_read ("mic", mic_read);
301         plugin_register_config ("mic",mic_config, config_keys, config_keys_num);
302 } /* void module_register */
303
304 /*
305  * vim: shiftwidth=2:softtabstop=2:textwidth=78
306  */