2 * (C) 2010,2011 Thomas Renninger <trenn@suse.de>, Novell Inc.
4 * Licensed under the terms of the GNU GPL License version 2.
6 * Output format inspired by Len Brown's <lenb@kernel.org> turbostat tool.
17 #include <sys/types.h>
21 #include "idle_monitor/cpupower-monitor.h"
22 #include "idle_monitor/idle_monitors.h"
23 #include "helpers/helpers.h"
25 /* Define pointers to all monitors. */
26 #define DEF(x) & x ## _monitor ,
27 struct cpuidle_monitor *all_monitors[] = {
28 #include "idle_monitors.def"
32 static struct cpuidle_monitor *monitors[MONITORS_MAX];
33 static unsigned int avail_monitors;
35 static char *progname;
37 enum operation_mode_e { list = 1, show, show_all };
39 static int interval = 1;
40 static char *show_monitors_param;
41 static struct cpupower_topology cpu_top;
43 /* ToDo: Document this in the manpage */
44 static char range_abbr[RANGE_MAX] = { 'T', 'C', 'P', 'M', };
46 long long timespec_diff_us(struct timespec start, struct timespec end)
49 if ((end.tv_nsec - start.tv_nsec) < 0) {
50 temp.tv_sec = end.tv_sec - start.tv_sec - 1;
51 temp.tv_nsec = 1000000000 + end.tv_nsec - start.tv_nsec;
53 temp.tv_sec = end.tv_sec - start.tv_sec;
54 temp.tv_nsec = end.tv_nsec - start.tv_nsec;
56 return (temp.tv_sec * 1000000) + (temp.tv_nsec / 1000);
59 void monitor_help(void)
61 printf(_("cpupower monitor: [-m <mon1>,[<mon2>],.. ] command\n"));
62 printf(_("cpupower monitor: [-m <mon1>,[<mon2>],.. ] [ -i interval_sec ]\n"));
63 printf(_("cpupower monitor: -l\n"));
64 printf(_("\t command: pass an arbitrary command to measure specific workload\n"));
65 printf(_("\t -i: time intervall to measure for in seconds (default 1)\n"));
66 printf(_("\t -l: list available CPU sleep monitors (for use with -m)\n"));
67 printf(_("\t -m: show specific CPU sleep monitors only (in same order)\n"));
68 printf(_("\t -h: print this help\n"));
70 printf(_("only one of: -l, -m are allowed\nIf none of them is passed,"));
71 printf(_(" all supported monitors are shown\n"));
74 void print_n_spaces(int n)
77 for (x = 0; x < n; x++)
81 /* size of s must be at least n + 1 */
82 int fill_string_with_spaces(char *s, int n)
87 for (; len < n; len++)
93 void print_header(int topology_depth)
96 int state, need_len, pr_mon_len;
99 int percent_width = 4;
101 fill_string_with_spaces(buf, topology_depth * 5 - 1);
104 for (mon = 0; mon < avail_monitors; mon++) {
106 need_len = monitors[mon]->hw_states_num * (percent_width + 3)
112 sprintf(buf, "%s", monitors[mon]->name);
113 fill_string_with_spaces(buf, need_len);
118 if (topology_depth > 2)
120 if (topology_depth > 1)
122 if (topology_depth > 0)
125 for (mon = 0; mon < avail_monitors; mon++) {
130 for (state = 0; state < monitors[mon]->hw_states_num; state++) {
133 s = monitors[mon]->hw_states[state];
134 sprintf(buf, "%s", s.name);
135 fill_string_with_spaces(buf, percent_width);
144 void print_results(int topology_depth, int cpu)
149 unsigned long long result;
152 /* Be careful CPUs may got resorted for pkg value do not just use cpu */
153 if (!bitmask_isbitset(cpus_chosen, cpu_top.core_info[cpu].cpu))
156 if (topology_depth > 2)
157 printf("%4d|", cpu_top.core_info[cpu].pkg);
158 if (topology_depth > 1)
159 printf("%4d|", cpu_top.core_info[cpu].core);
160 if (topology_depth > 0)
161 printf("%4d|", cpu_top.core_info[cpu].cpu);
163 for (mon = 0; mon < avail_monitors; mon++) {
167 for (state = 0; state < monitors[mon]->hw_states_num; state++) {
171 s = monitors[mon]->hw_states[state];
173 if (s.get_count_percent) {
174 ret = s.get_count_percent(s.id, &percent,
175 cpu_top.core_info[cpu].cpu);
178 else if (percent >= 100.0)
179 printf("%6.1f", percent);
181 printf("%6.2f", percent);
182 } else if (s.get_count) {
183 ret = s.get_count(s.id, &result,
184 cpu_top.core_info[cpu].cpu);
188 printf("%6llu", result);
190 printf(_("Monitor %s, Counter %s has no count "
191 "function. Implementation error\n"),
192 monitors[mon]->name, s.name);
198 * The monitor could still provide useful data, for example
199 * AMD HW counters partly sit in PCI config space.
200 * It's up to the monitor plug-in to check .is_online, this one
201 * is just for additional info.
203 if (!cpu_top.core_info[cpu].is_online) {
204 printf(_(" *is offline\n"));
211 /* param: string passed by -m param (The list of monitors to show)
213 * Monitors must have been registered already, matching monitors
214 * are picked out and available monitors array is overridden
217 * Monitors get sorted in the same order the user passes them
220 static void parse_monitor_param(char *param)
224 char *tmp = param, *token;
225 struct cpuidle_monitor *tmp_mons[MONITORS_MAX];
228 for (mon = 0; mon < MONITORS_MAX; mon++, tmp = NULL) {
229 token = strtok(tmp, ",");
232 if (strlen(token) >= MONITOR_NAME_LEN) {
233 printf(_("%s: max monitor name length"
234 " (%d) exceeded\n"), token, MONITOR_NAME_LEN);
238 for (num = 0; num < avail_monitors; num++) {
239 if (!strcmp(monitors[num]->name, token)) {
240 dprint("Found requested monitor: %s\n", token);
241 tmp_mons[hits] = monitors[num];
247 printf(_("No matching monitor found in %s, "
248 "try -l option\n"), param);
252 /* Override detected/registerd monitors array with requested one */
253 memcpy(monitors, tmp_mons,
254 sizeof(struct cpuidle_monitor *) * MONITORS_MAX);
255 avail_monitors = hits;
258 void list_monitors(void)
264 for (mon = 0; mon < avail_monitors; mon++) {
265 printf(_("Monitor \"%s\" (%d states) - Might overflow after %u "
267 monitors[mon]->name, monitors[mon]->hw_states_num,
268 monitors[mon]->overflow_s);
270 for (state = 0; state < monitors[mon]->hw_states_num; state++) {
271 s = monitors[mon]->hw_states[state];
273 * ToDo show more state capabilities:
274 * percent, time (granlarity)
276 printf("%s\t[%c] -> %s\n", s.name, range_abbr[s.range],
282 int fork_it(char **argv)
286 unsigned long long timediff;
288 struct timespec start, end;
291 clock_gettime(CLOCK_REALTIME, &start);
293 for (num = 0; num < avail_monitors; num++)
294 monitors[num]->start();
298 execvp(argv[0], argv);
301 if (child_pid == -1) {
306 signal(SIGINT, SIG_IGN);
307 signal(SIGQUIT, SIG_IGN);
308 if (waitpid(child_pid, &status, 0) == -1) {
313 clock_gettime(CLOCK_REALTIME, &end);
314 for (num = 0; num < avail_monitors; num++)
315 monitors[num]->stop();
317 timediff = timespec_diff_us(start, end);
318 if (WIFEXITED(status))
319 printf(_("%s took %.5f seconds and exited with status %d\n"),
320 argv[0], timediff / (1000.0 * 1000),
321 WEXITSTATUS(status));
325 int do_interval_measure(int i)
329 for (num = 0; num < avail_monitors; num++) {
330 dprint("HW C-state residency monitor: %s - States: %d\n",
331 monitors[num]->name, monitors[num]->hw_states_num);
332 monitors[num]->start();
335 for (num = 0; num < avail_monitors; num++)
336 monitors[num]->stop();
341 static void cmdline(int argc, char *argv[])
344 progname = basename(argv[0]);
346 while ((opt = getopt(argc, argv, "+hli:m:")) != -1) {
359 /* only allow -i with -m or no option */
360 if (mode && mode != show) {
364 interval = atoi(optarg);
372 show_monitors_param = optarg;
383 int cmd_monitor(int argc, char **argv)
386 struct cpuidle_monitor *test_mon;
390 cpu_count = get_cpu_topology(&cpu_top);
392 printf(_("Cannot read number of available processors\n"));
396 /* Default is: monitor all CPUs */
397 if (bitmask_isallclear(cpus_chosen))
398 bitmask_setall(cpus_chosen);
400 dprint("System has up to %d CPU cores\n", cpu_count);
402 for (num = 0; all_monitors[num]; num++) {
403 dprint("Try to register: %s\n", all_monitors[num]->name);
404 test_mon = all_monitors[num]->do_register();
406 if (test_mon->needs_root && !run_as_root) {
407 fprintf(stderr, _("Available monitor %s needs "
408 "root access\n"), test_mon->name);
411 monitors[avail_monitors] = test_mon;
412 dprint("%s registered\n", all_monitors[num]->name);
417 if (avail_monitors == 0) {
418 printf(_("No HW Cstate monitors found\n"));
428 parse_monitor_param(show_monitors_param);
430 dprint("Packages: %d - Cores: %d - CPUs: %d\n",
431 cpu_top.pkgs, cpu_top.cores, cpu_count);
434 * if any params left, it must be a command to fork
437 fork_it(argv + optind);
439 do_interval_measure(interval);
441 /* ToDo: Topology parsing needs fixing first to do
442 this more generically */
443 if (cpu_top.pkgs > 1)
448 for (cpu = 0; cpu < cpu_count; cpu++) {
449 if (cpu_top.pkgs > 1)
450 print_results(3, cpu);
452 print_results(1, cpu);
455 for (num = 0; num < avail_monitors; num++)
456 monitors[num]->unregister();
458 cpu_topology_release(cpu_top);