cpupower: Better detect offlined CPUs
[linux-2.6.git] / tools / power / cpupower / utils / idle_monitor / cpupower-monitor.c
1 /*
2  *  (C) 2010,2011       Thomas Renninger <trenn@suse.de>, Novell Inc.
3  *
4  *  Licensed under the terms of the GNU GPL License version 2.
5  *
6  *  Output format inspired by Len Brown's <lenb@kernel.org> turbostat tool.
7  *
8  */
9
10
11 #include <stdio.h>
12 #include <unistd.h>
13 #include <stdlib.h>
14 #include <string.h>
15 #include <time.h>
16 #include <signal.h>
17 #include <sys/types.h>
18 #include <sys/wait.h>
19 #include <libgen.h>
20
21 #include "idle_monitor/cpupower-monitor.h"
22 #include "idle_monitor/idle_monitors.h"
23 #include "helpers/helpers.h"
24
25 /* Define pointers to all monitors.  */
26 #define DEF(x) & x ## _monitor ,
27 struct cpuidle_monitor *all_monitors[] = {
28 #include "idle_monitors.def"
29 0
30 };
31
32 static struct cpuidle_monitor *monitors[MONITORS_MAX];
33 static unsigned int avail_monitors;
34
35 static char *progname;
36
37 enum operation_mode_e { list = 1, show, show_all };
38 static int mode;
39 static int interval = 1;
40 static char *show_monitors_param;
41 static struct cpupower_topology cpu_top;
42
43 /* ToDo: Document this in the manpage */
44 static char range_abbr[RANGE_MAX] = { 'T', 'C', 'P', 'M', };
45
46 long long timespec_diff_us(struct timespec start, struct timespec end)
47 {
48         struct timespec temp;
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;
52         } else {
53                 temp.tv_sec = end.tv_sec - start.tv_sec;
54                 temp.tv_nsec = end.tv_nsec - start.tv_nsec;
55         }
56         return (temp.tv_sec * 1000000) + (temp.tv_nsec / 1000);
57 }
58
59 void monitor_help(void)
60 {
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"));
69         printf("\n");
70         printf(_("only one of: -l, -m are allowed\nIf none of them is passed,"));
71         printf(_(" all supported monitors are shown\n"));
72 }
73
74 void print_n_spaces(int n)
75 {
76         int x;
77         for (x = 0; x < n; x++)
78                 printf(" ");
79 }
80
81 /* size of s must be at least n + 1 */
82 int fill_string_with_spaces(char *s, int n)
83 {
84         int len = strlen(s);
85         if (len > n)
86                 return -1;
87         for (; len < n; len++)
88                 s[len] = ' ';
89         s[len] = '\0';
90         return 0;
91 }
92
93 void print_header(int topology_depth)
94 {
95         int unsigned mon;
96         int state, need_len, pr_mon_len;
97         cstate_t s;
98         char buf[128] = "";
99         int percent_width = 4;
100
101         fill_string_with_spaces(buf, topology_depth * 5 - 1);
102         printf("%s|", buf);
103
104         for (mon = 0; mon < avail_monitors; mon++) {
105                 pr_mon_len = 0;
106                 need_len = monitors[mon]->hw_states_num * (percent_width + 3)
107                         - 1;
108                 if (mon != 0) {
109                         printf("|| ");
110                         need_len--;
111                 }
112                 sprintf(buf, "%s", monitors[mon]->name);
113                 fill_string_with_spaces(buf, need_len);
114                 printf("%s", buf);
115         }
116         printf("\n");
117
118         if (topology_depth > 2)
119                 printf("PKG |");
120         if (topology_depth > 1)
121                 printf("CORE|");
122         if (topology_depth > 0)
123                 printf("CPU |");
124
125         for (mon = 0; mon < avail_monitors; mon++) {
126                 if (mon != 0)
127                         printf("|| ");
128                 else
129                         printf(" ");
130                 for (state = 0; state < monitors[mon]->hw_states_num; state++) {
131                         if (state != 0)
132                                 printf(" | ");
133                         s = monitors[mon]->hw_states[state];
134                         sprintf(buf, "%s", s.name);
135                         fill_string_with_spaces(buf, percent_width);
136                         printf("%s", buf);
137                 }
138                 printf(" ");
139         }
140         printf("\n");
141 }
142
143
144 void print_results(int topology_depth, int cpu)
145 {
146         unsigned int mon;
147         int state, ret;
148         double percent;
149         unsigned long long result;
150         cstate_t s;
151
152         if (topology_depth > 2)
153                 printf("%4d|", cpu_top.core_info[cpu].pkg);
154         if (topology_depth > 1)
155                 printf("%4d|", cpu_top.core_info[cpu].core);
156         if (topology_depth > 0)
157                 printf("%4d|", cpu_top.core_info[cpu].cpu);
158
159         for (mon = 0; mon < avail_monitors; mon++) {
160                 if (mon != 0)
161                         printf("||");
162
163                 for (state = 0; state < monitors[mon]->hw_states_num; state++) {
164                         if (state != 0)
165                                 printf("|");
166
167                         s = monitors[mon]->hw_states[state];
168
169                         if (s.get_count_percent) {
170                                 ret = s.get_count_percent(s.id, &percent,
171                                                   cpu_top.core_info[cpu].cpu);
172                                 if (ret)
173                                         printf("******");
174                                 else if (percent >= 100.0)
175                                         printf("%6.1f", percent);
176                                 else
177                                         printf("%6.2f", percent);
178                         } else if (s.get_count) {
179                                 ret = s.get_count(s.id, &result,
180                                                   cpu_top.core_info[cpu].cpu);
181                                 if (ret)
182                                         printf("******");
183                                 else
184                                         printf("%6llu", result);
185                         } else {
186                                 printf(_("Monitor %s, Counter %s has no count "
187                                          "function. Implementation error\n"),
188                                        monitors[mon]->name, s.name);
189                                 exit(EXIT_FAILURE);
190                         }
191                 }
192         }
193         /*
194          * The monitor could still provide useful data, for example
195          * AMD HW counters partly sit in PCI config space.
196          * It's up to the monitor plug-in to check .is_online, this one
197          * is just for additional info.
198          */
199         if (!cpu_top.core_info[cpu].is_online) {
200                 printf(_(" *is offline\n"));
201                 return;
202         } else
203                 printf("\n");
204 }
205
206
207 /* param: string passed by -m param (The list of monitors to show)
208  *
209  * Monitors must have been registered already, matching monitors
210  * are picked out and available monitors array is overridden
211  * with matching ones
212  *
213  * Monitors get sorted in the same order the user passes them
214 */
215
216 static void parse_monitor_param(char *param)
217 {
218         unsigned int num;
219         int mon, hits = 0;
220         char *tmp = param, *token;
221         struct cpuidle_monitor *tmp_mons[MONITORS_MAX];
222
223
224         for (mon = 0; mon < MONITORS_MAX; mon++, tmp = NULL) {
225                 token = strtok(tmp, ",");
226                 if (token == NULL)
227                         break;
228                 if (strlen(token) >= MONITOR_NAME_LEN) {
229                         printf(_("%s: max monitor name length"
230                                  " (%d) exceeded\n"), token, MONITOR_NAME_LEN);
231                         continue;
232                 }
233
234                 for (num = 0; num < avail_monitors; num++) {
235                         if (!strcmp(monitors[num]->name, token)) {
236                                 dprint("Found requested monitor: %s\n", token);
237                                 tmp_mons[hits] = monitors[num];
238                                 hits++;
239                         }
240                 }
241         }
242         if (hits == 0) {
243                 printf(_("No matching monitor found in %s, "
244                          "try -l option\n"), param);
245                 monitor_help();
246                 exit(EXIT_FAILURE);
247         }
248         /* Override detected/registerd monitors array with requested one */
249         memcpy(monitors, tmp_mons,
250                 sizeof(struct cpuidle_monitor *) * MONITORS_MAX);
251         avail_monitors = hits;
252 }
253
254 void list_monitors(void)
255 {
256         unsigned int mon;
257         int state;
258         cstate_t s;
259
260         for (mon = 0; mon < avail_monitors; mon++) {
261                 printf(_("Monitor \"%s\" (%d states) - Might overflow after %u "
262                          "s\n"),
263                         monitors[mon]->name, monitors[mon]->hw_states_num,
264                         monitors[mon]->overflow_s);
265
266                 for (state = 0; state < monitors[mon]->hw_states_num; state++) {
267                         s = monitors[mon]->hw_states[state];
268                         /*
269                          * ToDo show more state capabilities:
270                          * percent, time (granlarity)
271                          */
272                         printf("%s\t[%c] -> %s\n", s.name, range_abbr[s.range],
273                                gettext(s.desc));
274                 }
275         }
276 }
277
278 int fork_it(char **argv)
279 {
280         int status;
281         unsigned int num;
282         unsigned long long timediff;
283         pid_t child_pid;
284         struct timespec start, end;
285
286         child_pid = fork();
287         clock_gettime(CLOCK_REALTIME, &start);
288
289         for (num = 0; num < avail_monitors; num++)
290                 monitors[num]->start();
291
292         if (!child_pid) {
293                 /* child */
294                 execvp(argv[0], argv);
295         } else {
296                 /* parent */
297                 if (child_pid == -1) {
298                         perror("fork");
299                         exit(1);
300                 }
301
302                 signal(SIGINT, SIG_IGN);
303                 signal(SIGQUIT, SIG_IGN);
304                 if (waitpid(child_pid, &status, 0) == -1) {
305                         perror("wait");
306                         exit(1);
307                 }
308         }
309         clock_gettime(CLOCK_REALTIME, &end);
310         for (num = 0; num < avail_monitors; num++)
311                 monitors[num]->stop();
312
313         timediff = timespec_diff_us(start, end);
314         if (WIFEXITED(status))
315                 printf(_("%s took %.5f seconds and exited with status %d\n"),
316                         argv[0], timediff / (1000.0 * 1000),
317                         WEXITSTATUS(status));
318         return 0;
319 }
320
321 int do_interval_measure(int i)
322 {
323         unsigned int num;
324
325         for (num = 0; num < avail_monitors; num++) {
326                 dprint("HW C-state residency monitor: %s - States: %d\n",
327                        monitors[num]->name, monitors[num]->hw_states_num);
328                 monitors[num]->start();
329         }
330         sleep(i);
331         for (num = 0; num < avail_monitors; num++)
332                 monitors[num]->stop();
333
334         return 0;
335 }
336
337 static void cmdline(int argc, char *argv[])
338 {
339         int opt;
340         progname = basename(argv[0]);
341
342         while ((opt = getopt(argc, argv, "+hli:m:")) != -1) {
343                 switch (opt) {
344                 case 'h':
345                         monitor_help();
346                         exit(EXIT_SUCCESS);
347                 case 'l':
348                         if (mode) {
349                                 monitor_help();
350                                 exit(EXIT_FAILURE);
351                         }
352                         mode = list;
353                         break;
354                 case 'i':
355                         /* only allow -i with -m or no option */
356                         if (mode && mode != show) {
357                                 monitor_help();
358                                 exit(EXIT_FAILURE);
359                         }
360                         interval = atoi(optarg);
361                         break;
362                 case 'm':
363                         if (mode) {
364                                 monitor_help();
365                                 exit(EXIT_FAILURE);
366                         }
367                         mode = show;
368                         show_monitors_param = optarg;
369                         break;
370                 default:
371                         monitor_help();
372                         exit(EXIT_FAILURE);
373                 }
374         }
375         if (!mode)
376                 mode = show_all;
377 }
378
379 int cmd_monitor(int argc, char **argv)
380 {
381         unsigned int num;
382         struct cpuidle_monitor *test_mon;
383         int cpu;
384
385         cmdline(argc, argv);
386         cpu_count = get_cpu_topology(&cpu_top);
387         if (cpu_count < 0) {
388                 printf(_("Cannot read number of available processors\n"));
389                 return EXIT_FAILURE;
390         }
391
392         dprint("System has up to %d CPU cores\n", cpu_count);
393
394         for (num = 0; all_monitors[num]; num++) {
395                 dprint("Try to register: %s\n", all_monitors[num]->name);
396                 test_mon = all_monitors[num]->do_register();
397                 if (test_mon) {
398                         if (test_mon->needs_root && !run_as_root) {
399                                 fprintf(stderr, _("Available monitor %s needs "
400                                           "root access\n"), test_mon->name);
401                                 continue;
402                         }
403                         monitors[avail_monitors] = test_mon;
404                         dprint("%s registered\n", all_monitors[num]->name);
405                         avail_monitors++;
406                 }
407         }
408
409         if (avail_monitors == 0) {
410                 printf(_("No HW Cstate monitors found\n"));
411                 return 1;
412         }
413
414         if (mode == list) {
415                 list_monitors();
416                 exit(EXIT_SUCCESS);
417         }
418
419         if (mode == show)
420                 parse_monitor_param(show_monitors_param);
421
422         dprint("Packages: %d - Cores: %d - CPUs: %d\n",
423                cpu_top.pkgs, cpu_top.cores, cpu_count);
424
425         /*
426          * if any params left, it must be a command to fork
427          */
428         if (argc - optind)
429                 fork_it(argv + optind);
430         else
431                 do_interval_measure(interval);
432
433         /* ToDo: Topology parsing needs fixing first to do
434            this more generically */
435         if (cpu_top.pkgs > 1)
436                 print_header(3);
437         else
438                 print_header(1);
439
440         for (cpu = 0; cpu < cpu_count; cpu++) {
441                 if (cpu_top.pkgs > 1)
442                         print_results(3, cpu);
443                 else
444                         print_results(1, cpu);
445         }
446
447         for (num = 0; num < avail_monitors; num++)
448                 monitors[num]->unregister();
449
450         cpu_topology_release(cpu_top);
451         return 0;
452 }