src/hugepages.c

   1 /*-
   2  * collectd - src/hugepages.c
   3  * MIT License
   4  *
   5  * Copyright(c) 2016 Intel Corporation. All rights reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  *
  25  * Authors:
  26  *   Jaroslav Safka <jaroslavx.safka@intel.com>
  27  *   Kim-Marie Jones <kim-marie.jones@intel.com>
  28  */
  29
  30 #include "collectd.h"
  31 #include "common.h" /* auxiliary functions */
  32 #include "plugin.h" /* plugin_register_*, plugin_dispatch_values */
  33
  34 static const char g_plugin_name[] = "hugepages";
  35
  36 static _Bool g_flag_rpt_numa = 1;
  37 static _Bool g_flag_rpt_mm = 1;
  38
  39 static _Bool values_pages = 1;
  40 static _Bool values_bytes = 0;
  41 static _Bool values_percent = 0;
  42
  43 #define HP_HAVE_NR 0x01
  44 #define HP_HAVE_SURPLUS 0x02
  45 #define HP_HAVE_FREE 0x04
  46 #define HP_HAVE_ALL 0x07
  47
  48 struct entry_info {
  49   char *d_name;
  50   const char *node;
  51   size_t page_size_kb;
  52
  53   gauge_t nr;
  54   gauge_t surplus;
  55   gauge_t free;
  56   uint8_t flags;
  57 };
  58
  59 static int hp_config(oconfig_item_t *ci) {
  60   for (int i = 0; i < ci->children_num; i++) {
  61     oconfig_item_t *child = ci->children + i;
  62     if (strcasecmp("ReportPerNodeHP", child->key) == 0)
  63       cf_util_get_boolean(child, &g_flag_rpt_numa);
  64     else if (strcasecmp("ReportRootHP", child->key) == 0)
  65       cf_util_get_boolean(child, &g_flag_rpt_mm);
  66     else if (strcasecmp("ValuesPages", child->key) == 0)
  67       cf_util_get_boolean(child, &values_pages);
  68     else if (strcasecmp("ValuesBytes", child->key) == 0)
  69       cf_util_get_boolean(child, &values_bytes);
  70     else if (strcasecmp("ValuesPercentage", child->key) == 0)
  71       cf_util_get_boolean(child, &values_percent);
  72     else
  73       ERROR("%s: Invalid configuration option: \"%s\".", g_plugin_name,
  74             child->key);
  75   }
  76
  77   return (0);
  78 }
  79
  80 static void submit_hp(const struct entry_info *info) {
  81   value_list_t vl = VALUE_LIST_INIT;
  82
  83   vl.values = &(value_t) { .gauge = NAN };
  84   vl.values_len = 1;
  85
  86   sstrncpy(vl.host, hostname_g, sizeof(vl.host));
  87   sstrncpy(vl.plugin, g_plugin_name, sizeof(vl.plugin));
  88   if (info->node) {
  89     ssnprintf(vl.plugin_instance, sizeof(vl.plugin_instance), "%s-%zuKb",
  90               info->node, info->page_size_kb);
  91   } else {
  92     ssnprintf(vl.plugin_instance, sizeof(vl.plugin_instance), "%zuKb",
  93               info->page_size_kb);
  94   }
  95
  96   /* ensure all metrics have the same timestamp */
  97   vl.time = cdtime();
  98
  99   gauge_t free = info->free;
 100   gauge_t used = (info->nr + info->surplus) - info->free;
 101
 102   if (values_pages) {
 103     sstrncpy(vl.type, "vmpage_number", sizeof(vl.type));
 104     plugin_dispatch_multivalue(&vl, /* store_percentage = */ 0, DS_TYPE_GAUGE,
 105                                "free", free, "used", used, NULL);
 106   }
 107   if (values_bytes) {
 108     gauge_t page_size = (gauge_t)(1024 * info->page_size_kb);
 109     sstrncpy(vl.type, "memory", sizeof(vl.type));
 110     plugin_dispatch_multivalue(&vl, /* store_percentage = */ 0, DS_TYPE_GAUGE,
 111                                "free", free * page_size, "used",
 112                                used * page_size, NULL);
 113   }
 114   if (values_percent) {
 115     sstrncpy(vl.type, "percent", sizeof(vl.type));
 116     plugin_dispatch_multivalue(&vl, /* store_percentage = */ 1, DS_TYPE_GAUGE,
 117                                "free", free, "used", used, NULL);
 118   }
 119 }
 120
 121 static int read_hugepage_entry(const char *path, const char *entry,
 122                                void *e_info) {
 123   char path2[PATH_MAX];
 124   struct entry_info *info = e_info;
 125   double value;
 126
 127   ssnprintf(path2, sizeof(path2), "%s/%s", path, entry);
 128
 129   FILE *fh = fopen(path2, "rt");
 130   if (fh == NULL) {
 131     ERROR("%s: cannot open %s", g_plugin_name, path2);
 132     return -1;
 133   }
 134
 135   if (fscanf(fh, "%lf", &value) != 1) {
 136     ERROR("%s: cannot parse file %s", g_plugin_name, path2);
 137     fclose(fh);
 138     return -1;
 139   }
 140   fclose(fh);
 141
 142   if (strcmp(entry, "nr_hugepages") == 0) {
 143     info->nr = value;
 144     info->flags |= HP_HAVE_NR;
 145   } else if (strcmp(entry, "surplus_hugepages") == 0) {
 146     info->surplus = value;
 147     info->flags |= HP_HAVE_SURPLUS;
 148   } else if (strcmp(entry, "free_hugepages") == 0) {
 149     info->free = value;
 150     info->flags |= HP_HAVE_FREE;
 151   }
 152
 153   if (info->flags != HP_HAVE_ALL) {
 154     return 0;
 155   }
 156
 157   submit_hp(info);
 158
 159   /* Reset flags so subsequent calls don't submit again. */
 160   info->flags = 0;
 161   return 0;
 162 }
 163
 164 static int read_syshugepages(const char *path, const char *node) {
 165   static const char hugepages_dir[] = "hugepages-";
 166   DIR *dir;
 167   struct dirent *result;
 168   char path2[PATH_MAX];
 169
 170   dir = opendir(path);
 171   if (dir == NULL) {
 172     ERROR("%s: cannot open directory %s", g_plugin_name, path);
 173     return -1;
 174   }
 175
 176   /* read "hugepages-XXXXXkB" entries */
 177   while ((result = readdir(dir)) != NULL) {
 178     if (strncmp(result->d_name, hugepages_dir, sizeof(hugepages_dir) - 1)) {
 179       /* not node dir */
 180       errno = 0;
 181       continue;
 182     }
 183
 184     long page_size = strtol(result->d_name + strlen(hugepages_dir),
 185                             /* endptr = */ NULL, /* base = */ 10);
 186     if (errno != 0) {
 187       char errbuf[1024];
 188       ERROR("%s: failed to determine page size from directory name \"%s\": %s",
 189             g_plugin_name, result->d_name,
 190             sstrerror(errno, errbuf, sizeof(errbuf)));
 191       continue;
 192     }
 193
 194     /* /sys/devices/system/node/node?/hugepages/ */
 195     ssnprintf(path2, sizeof(path2), "%s/%s", path, result->d_name);
 196
 197     walk_directory(path2, read_hugepage_entry,
 198                    &(struct entry_info){
 199                        .d_name = result->d_name,
 200                        .node = node,
 201                        .page_size_kb = (size_t)page_size,
 202                    },
 203                    /* hidden = */ 0);
 204     errno = 0;
 205   }
 206
 207   /* Check if NULL return from readdir() was an error */
 208   if (errno != 0) {
 209     ERROR("%s: readdir failed", g_plugin_name);
 210     closedir(dir);
 211     return -1;
 212   }
 213
 214   closedir(dir);
 215   return 0;
 216 }
 217
 218 static int read_nodes(void) {
 219   static const char sys_node[] = "/sys/devices/system/node";
 220   static const char node_string[] = "node";
 221   static const char sys_node_hugepages[] =
 222       "/sys/devices/system/node/%s/hugepages";
 223   DIR *dir;
 224   struct dirent *result;
 225   char path[PATH_MAX];
 226
 227   dir = opendir(sys_node);
 228   if (dir == NULL) {
 229     ERROR("%s: cannot open directory %s", g_plugin_name, sys_node);
 230     return -1;
 231   }
 232
 233   while ((result = readdir(dir)) != NULL) {
 234     if (strncmp(result->d_name, node_string, sizeof(node_string) - 1)) {
 235       /* not node dir */
 236       errno = 0;
 237       continue;
 238     }
 239
 240     ssnprintf(path, sizeof(path), sys_node_hugepages, result->d_name);
 241     read_syshugepages(path, result->d_name);
 242     errno = 0;
 243   }
 244
 245   /* Check if NULL return from readdir() was an error */
 246   if (errno != 0) {
 247     ERROR("%s: readdir failed", g_plugin_name);
 248     closedir(dir);
 249     return -1;
 250   }
 251
 252   closedir(dir);
 253   return 0;
 254 }
 255
 256 static int huge_read(void) {
 257   static const char sys_mm_hugepages[] = "/sys/kernel/mm/hugepages";
 258
 259   if (g_flag_rpt_mm) {
 260     if (read_syshugepages(sys_mm_hugepages, "mm") != 0) {
 261       return -1;
 262     }
 263   }
 264   if (g_flag_rpt_numa) {
 265     if (read_nodes() != 0) {
 266       return -1;
 267     }
 268   }
 269
 270   return 0;
 271 }
 272
 273 void module_register(void) {
 274   plugin_register_complex_config(g_plugin_name, hp_config);
 275   plugin_register_read(g_plugin_name, huge_read);
 276 }