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 at 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 = 0;
  37 static HANDLE mic_handle = NULL;
  38
  39 static int const therm_ids[] = {
  40         eMicThermalDie, eMicThermalDevMem, eMicThermalFin, eMicThermalFout,
  41         eMicThermalVccp, eMicThermalVddg, eMicThermalVddq };
  42 static char const * const therm_names[] = {
  43         "die", "devmem", "fin", "fout",
  44         "vccp", "vddg", "vddq" };
  45
  46 static const char *config_keys[] =
  47 {
  48         "ShowTotalCPU",
  49         "ShowPerCPU",
  50         "ShowTemps",
  51         "ShowMemory",
  52         "TempSensor",
  53         "IgnoreTempSelected",
  54 };
  55 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  56
  57 static _Bool show_total_cpu = 1;
  58 static _Bool show_per_cpu = 1;
  59 static _Bool show_temps = 1;
  60 static _Bool show_memory = 1;
  61 static ignorelist_t *temp_ignore = NULL;
  62
  63
  64 static int mic_init (void)
  65 {
  66         U32 ret;
  67         U32 mic_count;
  68
  69         if (mic_handle)
  70                 return (0);
  71
  72         mic_count = (U32) STATIC_ARRAY_SIZE(mics);
  73         ret = MicInitAPI(&mic_handle,  eTARGET_SCIF_DRIVER, mics, &mic_count);
  74         if (ret != MIC_ACCESS_API_SUCCESS) {
  75                 ERROR("mic plugin: Problem initializing MicAccessAPI: %s",
  76                                 MicGetErrorString(ret));
  77         }
  78         DEBUG("mic plugin: found: %"PRIu32" MIC(s)",mic_count);
  79
  80         if (mic_count<0 || mic_count>=MAX_MICS) {
  81                 ERROR("mic plugin: No Intel MICs in system");
  82                 return (1);
  83         }
  84         else {
  85                 num_mics = mic_count;
  86                 return (0);
  87         }
  88 }
  89
  90 static int mic_config (const char *key, const char *value) {
  91         if (temp_ignore == NULL)
  92                 temp_ignore = ignorelist_create(1);
  93         if (temp_ignore == NULL)
  94                 return (1);
  95
  96         if (strcasecmp("ShowTotalCPU",key) == 0)
  97         {
  98                 show_total_cpu = IS_TRUE(value);
  99         }
 100         else if (strcasecmp("ShowPerCPU",key) == 0)
 101         {
 102                 show_per_cpu = IS_TRUE(value);
 103         }
 104         else if (strcasecmp("ShowTemps",key) == 0)
 105         {
 106                 show_temps = IS_TRUE(value);
 107         }
 108         else if (strcasecmp("ShowMemory",key) == 0)
 109         {
 110                 show_memory = IS_TRUE(value);
 111         }
 112         else if (strcasecmp("TempSensor",key) == 0)
 113         {
 114                 ignorelist_add(temp_ignore,value);
 115         }
 116         else if (strcasecmp("IgnoreTempSelected",key) == 0)
 117         {
 118                 int invert = 1;
 119                 if (IS_TRUE(value))
 120                         invert = 0;
 121                 ignorelist_set_invert(temp_ignore,invert);
 122         }
 123         else
 124         {
 125                 return (-1);
 126         }
 127         return (0);
 128 }
 129
 130 static void mic_submit_memory_use(int micnumber, const char *type_instance, U32 val)
 131 {
 132         value_t values[1];
 133         value_list_t vl = VALUE_LIST_INIT;
 134
 135         /* MicAccessAPI reports KB's of memory, adjust for this */
 136         DEBUG("mic plugin: Memory Value Report; %u %lf",val,((gauge_t)val)*1024.0);
 137         values[0].gauge = ((gauge_t)val)*1024.0;
 138
 139         vl.values=values;
 140         vl.values_len=1;
 141
 142         strncpy (vl.host, hostname_g, sizeof (vl.host));
 143         strncpy (vl.plugin, "mic", sizeof (vl.plugin));
 144         ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance), "%i", micnumber);
 145         strncpy (vl.type, "memory", sizeof (vl.type));
 146         strncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 147
 148         plugin_dispatch_values (&vl);
 149 }
 150
 151 /* Gather memory Utilization */
 152 static int mic_read_memory(int mic)
 153 {
 154         U32 ret;
 155         U32 mem_total,mem_free,mem_bufs;
 156
 157         ret = MicGetMemoryUtilization(mic_handle,&mem_total,&mem_free,&mem_bufs);
 158         if (ret != MIC_ACCESS_API_SUCCESS) {
 159                 ERROR("mic plugin: Problem getting Memory Utilization: %s",
 160                                 MicGetErrorString(ret));
 161                 return (1);
 162         }
 163         mic_submit_memory_use(mic,"free",mem_free);
 164         mic_submit_memory_use(mic,"used",mem_total-mem_free-mem_bufs);
 165         mic_submit_memory_use(mic,"buffered",mem_bufs);
 166         DEBUG("mic plugin: Memory Read: %u %u %u",mem_total,mem_free,mem_bufs);
 167         return (0);
 168 }
 169
 170 static void mic_submit_temp(int micnumber, const char *type, gauge_t val)
 171 {
 172         value_t values[1];
 173         value_list_t vl = VALUE_LIST_INIT;
 174
 175         values[0].gauge = val;
 176
 177         vl.values=values;
 178         vl.values_len=1;
 179
 180         strncpy (vl.host, hostname_g, sizeof (vl.host));
 181         strncpy (vl.plugin, "mic", sizeof (vl.plugin));
 182         ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
 183                         "%i", micnumber);
 184         strncpy (vl.type, "temperature", sizeof (vl.type));
 185         strncpy (vl.type_instance, type, sizeof (vl.type_instance));
 186
 187         plugin_dispatch_values (&vl);
 188 }
 189
 190 /* Gather Temperature Information */
 191 static int mic_read_temps(int mic)
 192 {
 193         size_t num_therms = STATIC_ARRAY_SIZE(therm_ids);
 194         size_t j;
 195
 196         for (j = 0; j < num_therms; j++) {
 197                 U32 status;
 198                 U32 temp_buffer;
 199                 U32 buffer_size = (U32)sizeof(temp_buffer);
 200                 char const *name = therm_names[j];
 201
 202                 if (ignorelist_match(temp_ignore, name) != 0)
 203                         continue;
 204
 205                 status = MicGetTemperature(mic_handle, therm_ids[j],
 206                                 &temp_buffer, &buffer_size);
 207                 if (status != MIC_ACCESS_API_SUCCESS) {
 208                         ERROR("mic plugin: Error reading temperature \"%s\": "
 209                                         "%s", name, MicGetErrorString(status));
 210                         return (1);
 211                 }
 212                 mic_submit_temp(mic, name, temp_buffer);
 213         }
 214         return (0);
 215 }
 216
 217 static void mic_submit_cpu(int micnumber, const char *type_instance, int core, derive_t val)
 218 {
 219         value_t values[1];
 220         value_list_t vl = VALUE_LIST_INIT;
 221
 222         values[0].derive = val;
 223
 224         vl.values=values;
 225         vl.values_len=1;
 226
 227         strncpy (vl.host, hostname_g, sizeof (vl.host));
 228         strncpy (vl.plugin, "mic", sizeof (vl.plugin));
 229         ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance), "%i", micnumber);
 230         strncpy (vl.type, "cpu", sizeof (vl.type));
 231         if (core < 0)
 232                 strncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 233         else
 234                 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
 235                                 "%i-%s", core, type_instance);
 236
 237         plugin_dispatch_values (&vl);
 238 }
 239
 240 /*Gather CPU Utilization Information */
 241 static int mic_read_cpu(int mic)
 242 {
 243         MicCoreUtil core_util;
 244         MicCoreJiff core_jiffs[MAX_CORES];
 245         U32 core_jiffs_size;
 246         U32 status;
 247
 248         core_jiffs_size = MAX_CORES * sizeof(MicCoreJiff);
 249         status = MicGetCoreUtilization(mic_handle, &core_util,
 250                         core_jiffs, &core_jiffs_size);
 251         if (status != MIC_ACCESS_API_SUCCESS) {
 252                 ERROR("mic plugin: Problem getting CPU utilization: %s",
 253                                 MicGetErrorString(status));
 254                 return(-1);
 255         }
 256
 257         if (show_total_cpu) {
 258                 mic_submit_cpu(mic, "user", -1, core_util.sum.user);
 259                 mic_submit_cpu(mic, "sys", -1, core_util.sum.sys);
 260                 mic_submit_cpu(mic, "nice", -1, core_util.sum.nice);
 261                 mic_submit_cpu(mic, "idle", -1, core_util.sum.idle);
 262         }
 263
 264         if (show_per_cpu) {
 265                 int j;
 266                 for (j = 0; j < core_util.core; j++) {
 267                         mic_submit_cpu(mic, "user", j, core_jiffs[j].user);
 268                         mic_submit_cpu(mic, "sys", j, core_jiffs[j].sys);
 269                         mic_submit_cpu(mic, "nice", j, core_jiffs[j].nice);
 270                         mic_submit_cpu(mic, "idle", j, core_jiffs[j].idle);
 271                 }
 272         }
 273         return (0);
 274 }
 275
 276 static int mic_read (void)
 277 {
 278         int i;
 279         U32 ret;
 280         int error;
 281
 282         error=0;
 283         for (i=0;i<num_mics;i++) {
 284                 ret = MicInitAdapter(&mic_handle,&mics[i]);
 285                 if (ret != MIC_ACCESS_API_SUCCESS) {
 286                         ERROR("mic plugin: Problem initializing MicAdapter: %s",
 287                                         MicGetErrorString(ret));
 288                         error=1;
 289                 }
 290
 291                 if (error == 0 && show_memory)
 292                         error = mic_read_memory(i);
 293
 294                 if (error == 0 && show_temps)
 295                         error = mic_read_temps(i);
 296
 297                 if (error == 0 && (show_total_cpu || show_per_cpu))
 298                         error = mic_read_cpu(i);
 299
 300                 ret = MicCloseAdapter(mic_handle);
 301                 if (ret != MIC_ACCESS_API_SUCCESS) {
 302                         ERROR("mic plugin: Problem closing MicAdapter: %s",
 303                                         MicGetErrorString(ret));
 304                         error=2;
 305                         break;
 306                 }
 307         }
 308         if (num_mics==0)
 309                 error=3;
 310         return error;
 311 }
 312
 313
 314 static int mic_shutdown (void)
 315 {
 316         if (mic_handle)
 317         MicCloseAPI(&mic_handle);
 318         return (0);
 319 }
 320
 321 void module_register (void)
 322 {
 323         plugin_register_init ("mic", mic_init);
 324         plugin_register_shutdown ("mic", mic_shutdown);
 325         plugin_register_read ("mic", mic_read);
 326         plugin_register_config ("mic",mic_config, config_keys, config_keys_num);
 327 } /* void module_register */
 328
 329 /*
 330  * vim: set shiftwidth=8 softtabstop=8 noet textwidth=78 :
 331  */