src/lpar.c

   1 /**
   2  * collectd - src/lpar.c
   3  * Copyright (C) 2010  Aurélien Reynaud
   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  *   Aurélien Reynaud <collectd at wattapower.net>
  20  **/
  21
  22 #include "collectd.h"
  23
  24 #include "common.h"
  25 #include "plugin.h"
  26
  27 #include <libperfstat.h>
  28 #include <sys/protosw.h>
  29 #include <sys/utsname.h>
  30
  31 /* XINTFRAC was defined in libperfstat.h somewhere between AIX 5.3 and 6.1 */
  32 #ifndef XINTFRAC
  33 #include <sys/systemcfg.h>
  34 #define XINTFRAC                                                               \
  35   ((double)(_system_configuration.Xint) / (double)(_system_configuration.Xfrac))
  36 #endif
  37
  38 #define CLOCKTICKS_TO_TICKS(cticks) ((cticks) / XINTFRAC)
  39
  40 static const char *config_keys[] = {"CpuPoolStats", "ReportBySerial"};
  41 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
  42
  43 static _Bool pool_stats = 0;
  44 static _Bool report_by_serial = 0;
  45 #if PERFSTAT_SUPPORTS_DONATION
  46 static _Bool donate_flag = 0;
  47 #endif
  48 static char serial[SYS_NMLN];
  49
  50 static perfstat_partition_total_t lparstats_old;
  51
  52 static int lpar_config(const char *key, const char *value) {
  53   if (strcasecmp("CpuPoolStats", key) == 0) {
  54     if (IS_TRUE(value))
  55       pool_stats = 1;
  56     else
  57       pool_stats = 0;
  58   } else if (strcasecmp("ReportBySerial", key) == 0) {
  59     if (IS_TRUE(value))
  60       report_by_serial = 1;
  61     else
  62       report_by_serial = 0;
  63   } else {
  64     return -1;
  65   }
  66
  67   return 0;
  68 } /* int lpar_config */
  69
  70 static int lpar_init(void) {
  71   int status;
  72
  73   /* Retrieve the initial metrics. Returns the number of structures filled. */
  74   status = perfstat_partition_total(/* name = */ NULL, /* (must be NULL) */
  75                                     &lparstats_old,
  76                                     sizeof(perfstat_partition_total_t),
  77                                     /* number = */ 1 /* (must be 1) */);
  78   if (status != 1) {
  79     char errbuf[1024];
  80     ERROR("lpar plugin: perfstat_partition_total failed: %s (%i)",
  81           sstrerror(errno, errbuf, sizeof(errbuf)), status);
  82     return -1;
  83   }
  84
  85 #if PERFSTAT_SUPPORTS_DONATION
  86   if (!lparstats_old.type.b.shared_enabled &&
  87       lparstats_old.type.b.donate_enabled) {
  88     donate_flag = 1;
  89   }
  90 #endif
  91
  92   if (pool_stats && !lparstats_old.type.b.pool_util_authority) {
  93     WARNING("lpar plugin: This partition does not have pool authority. "
  94             "Disabling CPU pool statistics collection.");
  95     pool_stats = 0;
  96   }
  97
  98   return 0;
  99 } /* int lpar_init */
 100
 101 static void lpar_submit(const char *type_instance, double value) {
 102   value_list_t vl = VALUE_LIST_INIT;
 103
 104   vl.values = &(value_t){.gauge = value};
 105   vl.values_len = 1;
 106   if (report_by_serial) {
 107     sstrncpy(vl.host, serial, sizeof(vl.host));
 108     sstrncpy(vl.plugin_instance, hostname_g, sizeof(vl.plugin));
 109   }
 110   sstrncpy(vl.plugin, "lpar", sizeof(vl.plugin));
 111   sstrncpy(vl.type, "vcpu", sizeof(vl.type));
 112   sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
 113
 114   plugin_dispatch_values(&vl);
 115 } /* void lpar_submit */
 116
 117 static int lpar_read(void) {
 118   perfstat_partition_total_t lparstats;
 119   int status;
 120   struct utsname name;
 121   u_longlong_t ticks;
 122   u_longlong_t user_ticks, syst_ticks, wait_ticks, idle_ticks;
 123   u_longlong_t consumed_ticks;
 124   double entitled_proc_capacity;
 125
 126   /* An LPAR has the same serial number as the physical system it is currently
 127      running on. It is a convenient way of tracking LPARs as they are moved
 128      from chassis to chassis through Live Partition Mobility (LPM). */
 129   if (uname(&name) != 0) {
 130     ERROR("lpar plugin: uname failed.");
 131     return -1;
 132   }
 133   sstrncpy(serial, name.machine, sizeof(serial));
 134
 135   /* Retrieve the current metrics. Returns the number of structures filled. */
 136   status =
 137       perfstat_partition_total(/* name = */ NULL, /* (must be NULL) */
 138                                &lparstats, sizeof(perfstat_partition_total_t),
 139                                /* number = */ 1 /* (must be 1) */);
 140   if (status != 1) {
 141     char errbuf[1024];
 142     ERROR("lpar plugin: perfstat_partition_total failed: %s (%i)",
 143           sstrerror(errno, errbuf, sizeof(errbuf)), status);
 144     return -1;
 145   }
 146
 147   /* Number of ticks since we last run. */
 148   ticks = lparstats.timebase_last - lparstats_old.timebase_last;
 149   if (ticks == 0) {
 150     /* The stats have not been updated. Return now to avoid
 151      * dividing by zero */
 152     return 0;
 153   }
 154
 155   /*
 156    * On a shared partition, we're "entitled" to a certain amount of
 157    * processing power, for example 250/100 of a physical CPU. Processing
 158    * capacity not used by the partition may be assigned to a different
 159    * partition by the hypervisor, so "idle" is hopefully a very small
 160    * number.
 161    *
 162    * A dedicated partition may donate its CPUs to another partition and
 163    * may steal ticks from somewhere else (another partition or maybe the
 164    * shared pool, I don't know --octo).
 165    */
 166
 167   /* entitled_proc_capacity is in 1/100th of a CPU */
 168   entitled_proc_capacity = 0.01 * ((double)lparstats.entitled_proc_capacity);
 169   lpar_submit("entitled", entitled_proc_capacity);
 170
 171   /* The number of ticks actually spent in the various states */
 172   user_ticks = lparstats.puser - lparstats_old.puser;
 173   syst_ticks = lparstats.psys - lparstats_old.psys;
 174   wait_ticks = lparstats.pwait - lparstats_old.pwait;
 175   idle_ticks = lparstats.pidle - lparstats_old.pidle;
 176   consumed_ticks = user_ticks + syst_ticks + wait_ticks + idle_ticks;
 177
 178   lpar_submit("user", (double)user_ticks / (double)ticks);
 179   lpar_submit("system", (double)syst_ticks / (double)ticks);
 180   lpar_submit("wait", (double)wait_ticks / (double)ticks);
 181   lpar_submit("idle", (double)idle_ticks / (double)ticks);
 182
 183 #if PERFSTAT_SUPPORTS_DONATION
 184   if (donate_flag) {
 185     /* donated => ticks given to another partition
 186      * stolen  => ticks received from another partition */
 187     u_longlong_t idle_donated_ticks, busy_donated_ticks;
 188     u_longlong_t idle_stolen_ticks, busy_stolen_ticks;
 189
 190     /* FYI:  PURR == Processor Utilization of Resources Register
 191      *      SPURR == Scaled PURR */
 192     idle_donated_ticks =
 193         lparstats.idle_donated_purr - lparstats_old.idle_donated_purr;
 194     busy_donated_ticks =
 195         lparstats.busy_donated_purr - lparstats_old.busy_donated_purr;
 196     idle_stolen_ticks =
 197         lparstats.idle_stolen_purr - lparstats_old.idle_stolen_purr;
 198     busy_stolen_ticks =
 199         lparstats.busy_stolen_purr - lparstats_old.busy_stolen_purr;
 200
 201     lpar_submit("idle_donated", (double)idle_donated_ticks / (double)ticks);
 202     lpar_submit("busy_donated", (double)busy_donated_ticks / (double)ticks);
 203     lpar_submit("idle_stolen", (double)idle_stolen_ticks / (double)ticks);
 204     lpar_submit("busy_stolen", (double)busy_stolen_ticks / (double)ticks);
 205
 206     /* Donated ticks will be accounted for as stolen ticks in other LPARs */
 207     consumed_ticks += idle_stolen_ticks + busy_stolen_ticks;
 208   }
 209 #endif
 210
 211   lpar_submit("consumed", (double)consumed_ticks / (double)ticks);
 212
 213   if (pool_stats) {
 214     char typinst[DATA_MAX_NAME_LEN];
 215     u_longlong_t pool_idle_cticks;
 216     double pool_idle_cpus;
 217     double pool_busy_cpus;
 218
 219     /* We're calculating "busy" from "idle" and the total number of
 220      * CPUs, because the "busy" member didn't exist in early versions
 221      * of libperfstat. It was added somewhere between AIX 5.3 ML5 and ML9. */
 222     pool_idle_cticks = lparstats.pool_idle_time - lparstats_old.pool_idle_time;
 223     pool_idle_cpus =
 224         CLOCKTICKS_TO_TICKS((double)pool_idle_cticks) / (double)ticks;
 225     pool_busy_cpus = ((double)lparstats.phys_cpus_pool) - pool_idle_cpus;
 226     if (pool_busy_cpus < 0.0)
 227       pool_busy_cpus = 0.0;
 228
 229     snprintf(typinst, sizeof(typinst), "pool-%X-busy", lparstats.pool_id);
 230     lpar_submit(typinst, pool_busy_cpus);
 231
 232     snprintf(typinst, sizeof(typinst), "pool-%X-idle", lparstats.pool_id);
 233     lpar_submit(typinst, pool_idle_cpus);
 234   }
 235
 236   memcpy(&lparstats_old, &lparstats, sizeof(lparstats_old));
 237
 238   return 0;
 239 } /* int lpar_read */
 240
 241 void module_register(void) {
 242   plugin_register_config("lpar", lpar_config, config_keys, config_keys_num);
 243   plugin_register_init("lpar", lpar_init);
 244   plugin_register_read("lpar", lpar_read);
 245 } /* void module_register */