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