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