turbostat.c 25.8 KB
Newer Older
Len Brown's avatar
Len Brown committed
1
2
3
4
/*
 * turbostat -- show CPU frequency and C-state residency
 * on modern Intel turbo-capable processors.
 *
5
 * Copyright (c) 2012 Intel Corporation.
Len Brown's avatar
Len Brown committed
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 * Len Brown <len.brown@intel.com>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 */

22
#define _GNU_SOURCE
Len Brown's avatar
Len Brown committed
23
24
25
26
27
28
29
30
31
32
33
34
35
#include <stdio.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/wait.h>
#include <sys/stat.h>
#include <sys/resource.h>
#include <fcntl.h>
#include <signal.h>
#include <sys/time.h>
#include <stdlib.h>
#include <dirent.h>
#include <string.h>
#include <ctype.h>
36
#include <sched.h>
Len Brown's avatar
Len Brown committed
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

#define MSR_TSC	0x10
#define MSR_NEHALEM_PLATFORM_INFO	0xCE
#define MSR_NEHALEM_TURBO_RATIO_LIMIT	0x1AD
#define MSR_APERF	0xE8
#define MSR_MPERF	0xE7
#define MSR_PKG_C2_RESIDENCY	0x60D	/* SNB only */
#define MSR_PKG_C3_RESIDENCY	0x3F8
#define MSR_PKG_C6_RESIDENCY	0x3F9
#define MSR_PKG_C7_RESIDENCY	0x3FA	/* SNB only */
#define MSR_CORE_C3_RESIDENCY	0x3FC
#define MSR_CORE_C6_RESIDENCY	0x3FD
#define MSR_CORE_C7_RESIDENCY	0x3FE	/* SNB only */

char *proc_stat = "/proc/stat";
unsigned int interval_sec = 5;	/* set with -i interval_sec */
unsigned int verbose;		/* set with -v */
54
unsigned int summary_only;	/* set with -s */
Len Brown's avatar
Len Brown committed
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
unsigned int skip_c0;
unsigned int skip_c1;
unsigned int do_nhm_cstates;
unsigned int do_snb_cstates;
unsigned int has_aperf;
unsigned int units = 1000000000;	/* Ghz etc */
unsigned int genuine_intel;
unsigned int has_invariant_tsc;
unsigned int do_nehalem_platform_info;
unsigned int do_nehalem_turbo_ratio_limit;
unsigned int extra_msr_offset;
double bclk;
unsigned int show_pkg;
unsigned int show_core;
unsigned int show_cpu;

int aperf_mperf_unstable;
int backwards_count;
char *progname;

int num_cpus;
76
77
cpu_set_t *cpu_mask;
size_t cpu_mask_size;
Len Brown's avatar
Len Brown committed
78

Len Brown's avatar
Len Brown committed
79
struct counters {
Len Brown's avatar
Len Brown committed
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
	unsigned long long tsc;		/* per thread */
	unsigned long long aperf;	/* per thread */
	unsigned long long mperf;	/* per thread */
	unsigned long long c1;	/* per thread (calculated) */
	unsigned long long c3;	/* per core */
	unsigned long long c6;	/* per core */
	unsigned long long c7;	/* per core */
	unsigned long long pc2;	/* per package */
	unsigned long long pc3;	/* per package */
	unsigned long long pc6;	/* per package */
	unsigned long long pc7;	/* per package */
	unsigned long long extra_msr;	/* per thread */
	int pkg;
	int core;
	int cpu;
Len Brown's avatar
Len Brown committed
95
96
	struct counters *next;
};
Len Brown's avatar
Len Brown committed
97

Len Brown's avatar
Len Brown committed
98
99
100
101
struct counters *cnt_even;
struct counters *cnt_odd;
struct counters *cnt_delta;
struct counters *cnt_average;
Len Brown's avatar
Len Brown committed
102
103
104
105
struct timeval tv_even;
struct timeval tv_odd;
struct timeval tv_delta;

106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/*
 * cpu_mask_init(ncpus)
 *
 * allocate and clear cpu_mask
 * set cpu_mask_size
 */
void cpu_mask_init(int ncpus)
{
	cpu_mask = CPU_ALLOC(ncpus);
	if (cpu_mask == NULL) {
		perror("CPU_ALLOC");
		exit(3);
	}
	cpu_mask_size = CPU_ALLOC_SIZE(ncpus);
	CPU_ZERO_S(cpu_mask_size, cpu_mask);
}

void cpu_mask_uninit()
{
	CPU_FREE(cpu_mask);
	cpu_mask = NULL;
	cpu_mask_size = 0;
}

int cpu_migrate(int cpu)
{
	CPU_ZERO_S(cpu_mask_size, cpu_mask);
	CPU_SET_S(cpu, cpu_mask_size, cpu_mask);
	if (sched_setaffinity(0, cpu_mask_size, cpu_mask) == -1)
		return -1;
	else
		return 0;
}

140
int get_msr(int cpu, off_t offset, unsigned long long *msr)
Len Brown's avatar
Len Brown committed
141
142
143
144
145
146
147
{
	ssize_t retval;
	char pathname[32];
	int fd;

	sprintf(pathname, "/dev/cpu/%d/msr", cpu);
	fd = open(pathname, O_RDONLY);
148
149
	if (fd < 0)
		return -1;
Len Brown's avatar
Len Brown committed
150

151
	retval = pread(fd, msr, sizeof *msr, offset);
Len Brown's avatar
Len Brown committed
152
	close(fd);
153
154
155
156
157

	if (retval != sizeof *msr)
		return -1;

	return 0;
Len Brown's avatar
Len Brown committed
158
159
}

Len Brown's avatar
Len Brown committed
160
void print_header(void)
Len Brown's avatar
Len Brown committed
161
162
{
	if (show_pkg)
163
		fprintf(stderr, "pk");
164
165
	if (show_pkg)
		fprintf(stderr, " ");
Len Brown's avatar
Len Brown committed
166
	if (show_core)
167
		fprintf(stderr, "cor");
Len Brown's avatar
Len Brown committed
168
169
	if (show_cpu)
		fprintf(stderr, " CPU");
170
171
	if (show_pkg || show_core || show_cpu)
		fprintf(stderr, " ");
Len Brown's avatar
Len Brown committed
172
	if (do_nhm_cstates)
173
		fprintf(stderr, "   %%c0");
Len Brown's avatar
Len Brown committed
174
	if (has_aperf)
175
		fprintf(stderr, "  GHz");
Len Brown's avatar
Len Brown committed
176
177
	fprintf(stderr, "  TSC");
	if (do_nhm_cstates)
178
		fprintf(stderr, "    %%c1");
Len Brown's avatar
Len Brown committed
179
	if (do_nhm_cstates)
180
		fprintf(stderr, "    %%c3");
Len Brown's avatar
Len Brown committed
181
	if (do_nhm_cstates)
182
		fprintf(stderr, "    %%c6");
Len Brown's avatar
Len Brown committed
183
	if (do_snb_cstates)
184
		fprintf(stderr, "    %%c7");
Len Brown's avatar
Len Brown committed
185
	if (do_snb_cstates)
186
		fprintf(stderr, "   %%pc2");
Len Brown's avatar
Len Brown committed
187
	if (do_nhm_cstates)
188
		fprintf(stderr, "   %%pc3");
Len Brown's avatar
Len Brown committed
189
	if (do_nhm_cstates)
190
		fprintf(stderr, "   %%pc6");
Len Brown's avatar
Len Brown committed
191
	if (do_snb_cstates)
192
		fprintf(stderr, "   %%pc7");
Len Brown's avatar
Len Brown committed
193
	if (extra_msr_offset)
194
		fprintf(stderr, "        MSR 0x%x ", extra_msr_offset);
Len Brown's avatar
Len Brown committed
195
196
197
198

	putc('\n', stderr);
}

Len Brown's avatar
Len Brown committed
199
void dump_cnt(struct counters *cnt)
Len Brown's avatar
Len Brown committed
200
{
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
	if (!cnt)
		return;
	if (cnt->pkg) fprintf(stderr, "package: %d ", cnt->pkg);
	if (cnt->core) fprintf(stderr, "core:: %d ", cnt->core);
	if (cnt->cpu) fprintf(stderr, "CPU: %d ", cnt->cpu);
	if (cnt->tsc) fprintf(stderr, "TSC: %016llX\n", cnt->tsc);
	if (cnt->c3) fprintf(stderr, "c3: %016llX\n", cnt->c3);
	if (cnt->c6) fprintf(stderr, "c6: %016llX\n", cnt->c6);
	if (cnt->c7) fprintf(stderr, "c7: %016llX\n", cnt->c7);
	if (cnt->aperf) fprintf(stderr, "aperf: %016llX\n", cnt->aperf);
	if (cnt->pc2) fprintf(stderr, "pc2: %016llX\n", cnt->pc2);
	if (cnt->pc3) fprintf(stderr, "pc3: %016llX\n", cnt->pc3);
	if (cnt->pc6) fprintf(stderr, "pc6: %016llX\n", cnt->pc6);
	if (cnt->pc7) fprintf(stderr, "pc7: %016llX\n", cnt->pc7);
	if (cnt->extra_msr) fprintf(stderr, "msr0x%x: %016llX\n", extra_msr_offset, cnt->extra_msr);
Len Brown's avatar
Len Brown committed
216
217
}

Len Brown's avatar
Len Brown committed
218
void dump_list(struct counters *cnt)
Len Brown's avatar
Len Brown committed
219
{
Len Brown's avatar
Len Brown committed
220
	printf("dump_list 0x%p\n", cnt);
Len Brown's avatar
Len Brown committed
221

Len Brown's avatar
Len Brown committed
222
223
	for (; cnt; cnt = cnt->next)
		dump_cnt(cnt);
Len Brown's avatar
Len Brown committed
224
225
}

226
227
228
229
230
231
232
233
234
/*
 * column formatting convention & formats
 * package: "pk" 2 columns %2d
 * core: "cor" 3 columns %3d
 * CPU: "CPU" 3 columns %3d
 * GHz: "GHz" 3 columns %3.2
 * TSC: "TSC" 3 columns %3.2
 * percentage " %pc3" %6.2
 */
Len Brown's avatar
Len Brown committed
235
void print_cnt(struct counters *p)
Len Brown's avatar
Len Brown committed
236
237
238
239
240
241
{
	double interval_float;

	interval_float = tv_delta.tv_sec + tv_delta.tv_usec/1000000.0;

	/* topology columns, print blanks on 1st (average) line */
Len Brown's avatar
Len Brown committed
242
	if (p == cnt_average) {
Len Brown's avatar
Len Brown committed
243
		if (show_pkg)
244
245
			fprintf(stderr, "  ");
		if (show_pkg && show_core)
246
			fprintf(stderr, " ");
Len Brown's avatar
Len Brown committed
247
		if (show_core)
248
			fprintf(stderr, "   ");
Len Brown's avatar
Len Brown committed
249
		if (show_cpu)
250
			fprintf(stderr, " " "   ");
Len Brown's avatar
Len Brown committed
251
252
	} else {
		if (show_pkg)
253
254
255
			fprintf(stderr, "%2d", p->pkg);
		if (show_pkg && show_core)
			fprintf(stderr, " ");
Len Brown's avatar
Len Brown committed
256
		if (show_core)
257
			fprintf(stderr, "%3d", p->core);
Len Brown's avatar
Len Brown committed
258
		if (show_cpu)
259
			fprintf(stderr, " %3d", p->cpu);
Len Brown's avatar
Len Brown committed
260
261
262
263
	}

	/* %c0 */
	if (do_nhm_cstates) {
264
265
		if (show_pkg || show_core || show_cpu)
			fprintf(stderr, " ");
Len Brown's avatar
Len Brown committed
266
		if (!skip_c0)
267
			fprintf(stderr, "%6.2f", 100.0 * p->mperf/p->tsc);
Len Brown's avatar
Len Brown committed
268
		else
269
			fprintf(stderr, "  ****");
Len Brown's avatar
Len Brown committed
270
271
272
273
274
	}

	/* GHz */
	if (has_aperf) {
		if (!aperf_mperf_unstable) {
275
			fprintf(stderr, " %3.2f",
Len Brown's avatar
Len Brown committed
276
277
278
279
				1.0 * p->tsc / units * p->aperf /
				p->mperf / interval_float);
		} else {
			if (p->aperf > p->tsc || p->mperf > p->tsc) {
280
				fprintf(stderr, " ***");
Len Brown's avatar
Len Brown committed
281
			} else {
282
				fprintf(stderr, "%3.1f*",
Len Brown's avatar
Len Brown committed
283
284
285
286
287
288
289
290
291
292
293
294
					1.0 * p->tsc /
					units * p->aperf /
					p->mperf / interval_float);
			}
		}
	}

	/* TSC */
	fprintf(stderr, "%5.2f", 1.0 * p->tsc/units/interval_float);

	if (do_nhm_cstates) {
		if (!skip_c1)
295
			fprintf(stderr, " %6.2f", 100.0 * p->c1/p->tsc);
Len Brown's avatar
Len Brown committed
296
		else
297
			fprintf(stderr, "  ****");
Len Brown's avatar
Len Brown committed
298
299
	}
	if (do_nhm_cstates)
300
		fprintf(stderr, " %6.2f", 100.0 * p->c3/p->tsc);
Len Brown's avatar
Len Brown committed
301
	if (do_nhm_cstates)
302
		fprintf(stderr, " %6.2f", 100.0 * p->c6/p->tsc);
Len Brown's avatar
Len Brown committed
303
	if (do_snb_cstates)
304
		fprintf(stderr, " %6.2f", 100.0 * p->c7/p->tsc);
Len Brown's avatar
Len Brown committed
305
	if (do_snb_cstates)
306
		fprintf(stderr, " %6.2f", 100.0 * p->pc2/p->tsc);
Len Brown's avatar
Len Brown committed
307
	if (do_nhm_cstates)
308
		fprintf(stderr, " %6.2f", 100.0 * p->pc3/p->tsc);
Len Brown's avatar
Len Brown committed
309
	if (do_nhm_cstates)
310
		fprintf(stderr, " %6.2f", 100.0 * p->pc6/p->tsc);
Len Brown's avatar
Len Brown committed
311
	if (do_snb_cstates)
312
		fprintf(stderr, " %6.2f", 100.0 * p->pc7/p->tsc);
Len Brown's avatar
Len Brown committed
313
314
315
316
317
	if (extra_msr_offset)
		fprintf(stderr, "  0x%016llx", p->extra_msr);
	putc('\n', stderr);
}

Len Brown's avatar
Len Brown committed
318
void print_counters(struct counters *counters)
Len Brown's avatar
Len Brown committed
319
{
Len Brown's avatar
Len Brown committed
320
	struct counters *cnt;
321
	static int printed;
Len Brown's avatar
Len Brown committed
322

323
324
325

	if (!printed || !summary_only)
		print_header();
Len Brown's avatar
Len Brown committed
326
327

	if (num_cpus > 1)
Len Brown's avatar
Len Brown committed
328
		print_cnt(cnt_average);
Len Brown's avatar
Len Brown committed
329

330
331
332
333
334
	printed = 1;

	if (summary_only)
		return;

Len Brown's avatar
Len Brown committed
335
336
	for (cnt = counters; cnt != NULL; cnt = cnt->next)
		print_cnt(cnt);
Len Brown's avatar
Len Brown committed
337
338
339
340
341

}

#define SUBTRACT_COUNTER(after, before, delta) (delta = (after - before), (before > after))

Len Brown's avatar
Len Brown committed
342
343
int compute_delta(struct counters *after,
	struct counters *before, struct counters *delta)
Len Brown's avatar
Len Brown committed
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
{
	int errors = 0;
	int perf_err = 0;

	skip_c0 = skip_c1 = 0;

	for ( ; after && before && delta;
		after = after->next, before = before->next, delta = delta->next) {
		if (before->cpu != after->cpu) {
			printf("cpu configuration changed: %d != %d\n",
				before->cpu, after->cpu);
			return -1;
		}

		if (SUBTRACT_COUNTER(after->tsc, before->tsc, delta->tsc)) {
			fprintf(stderr, "cpu%d TSC went backwards %llX to %llX\n",
				before->cpu, before->tsc, after->tsc);
			errors++;
		}
		/* check for TSC < 1 Mcycles over interval */
		if (delta->tsc < (1000 * 1000)) {
			fprintf(stderr, "Insanely slow TSC rate,"
				" TSC stops in idle?\n");
			fprintf(stderr, "You can disable all c-states"
				" by booting with \"idle=poll\"\n");
			fprintf(stderr, "or just the deep ones with"
				" \"processor.max_cstate=1\"\n");
			exit(-3);
		}
		if (SUBTRACT_COUNTER(after->c3, before->c3, delta->c3)) {
			fprintf(stderr, "cpu%d c3 counter went backwards %llX to %llX\n",
				before->cpu, before->c3, after->c3);
			errors++;
		}
		if (SUBTRACT_COUNTER(after->c6, before->c6, delta->c6)) {
			fprintf(stderr, "cpu%d c6 counter went backwards %llX to %llX\n",
				before->cpu, before->c6, after->c6);
			errors++;
		}
		if (SUBTRACT_COUNTER(after->c7, before->c7, delta->c7)) {
			fprintf(stderr, "cpu%d c7 counter went backwards %llX to %llX\n",
				before->cpu, before->c7, after->c7);
			errors++;
		}
		if (SUBTRACT_COUNTER(after->pc2, before->pc2, delta->pc2)) {
			fprintf(stderr, "cpu%d pc2 counter went backwards %llX to %llX\n",
				before->cpu, before->pc2, after->pc2);
			errors++;
		}
		if (SUBTRACT_COUNTER(after->pc3, before->pc3, delta->pc3)) {
			fprintf(stderr, "cpu%d pc3 counter went backwards %llX to %llX\n",
				before->cpu, before->pc3, after->pc3);
			errors++;
		}
		if (SUBTRACT_COUNTER(after->pc6, before->pc6, delta->pc6)) {
			fprintf(stderr, "cpu%d pc6 counter went backwards %llX to %llX\n",
				before->cpu, before->pc6, after->pc6);
			errors++;
		}
		if (SUBTRACT_COUNTER(after->pc7, before->pc7, delta->pc7)) {
			fprintf(stderr, "cpu%d pc7 counter went backwards %llX to %llX\n",
				before->cpu, before->pc7, after->pc7);
			errors++;
		}

		perf_err = SUBTRACT_COUNTER(after->aperf, before->aperf, delta->aperf);
		if (perf_err) {
			fprintf(stderr, "cpu%d aperf counter went backwards %llX to %llX\n",
				before->cpu, before->aperf, after->aperf);
		}
		perf_err |= SUBTRACT_COUNTER(after->mperf, before->mperf, delta->mperf);
		if (perf_err) {
			fprintf(stderr, "cpu%d mperf counter went backwards %llX to %llX\n",
				before->cpu, before->mperf, after->mperf);
		}
		if (perf_err) {
			if (!aperf_mperf_unstable) {
				fprintf(stderr, "%s: APERF or MPERF went backwards *\n", progname);
				fprintf(stderr, "* Frequency results do not cover entire interval *\n");
				fprintf(stderr, "* fix this by running Linux-2.6.30 or later *\n");

				aperf_mperf_unstable = 1;
			}
			/*
			 * mperf delta is likely a huge "positive" number
			 * can not use it for calculating c0 time
			 */
			skip_c0 = 1;
			skip_c1 = 1;
		}

		/*
		 * As mperf and tsc collection are not atomic,
		 * it is possible for mperf's non-halted cycles
		 * to exceed TSC's all cycles: show c1 = 0% in that case.
		 */
		if (delta->mperf > delta->tsc)
			delta->c1 = 0;
		else /* normal case, derive c1 */
			delta->c1 = delta->tsc - delta->mperf
				- delta->c3 - delta->c6 - delta->c7;

		if (delta->mperf == 0)
			delta->mperf = 1;	/* divide by 0 protection */

		/*
		 * for "extra msr", just copy the latest w/o subtracting
		 */
		delta->extra_msr = after->extra_msr;
		if (errors) {
			fprintf(stderr, "ERROR cpu%d before:\n", before->cpu);
Len Brown's avatar
Len Brown committed
455
			dump_cnt(before);
Len Brown's avatar
Len Brown committed
456
			fprintf(stderr, "ERROR cpu%d after:\n", before->cpu);
Len Brown's avatar
Len Brown committed
457
			dump_cnt(after);
Len Brown's avatar
Len Brown committed
458
459
460
461
462
463
			errors = 0;
		}
	}
	return 0;
}

Len Brown's avatar
Len Brown committed
464
void compute_average(struct counters *delta, struct counters *avg)
Len Brown's avatar
Len Brown committed
465
{
Len Brown's avatar
Len Brown committed
466
	struct counters *sum;
Len Brown's avatar
Len Brown committed
467

Len Brown's avatar
Len Brown committed
468
	sum = calloc(1, sizeof(struct counters));
Len Brown's avatar
Len Brown committed
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
	if (sum == NULL) {
		perror("calloc sum");
		exit(1);
	}

	for (; delta; delta = delta->next) {
		sum->tsc += delta->tsc;
		sum->c1 += delta->c1;
		sum->c3 += delta->c3;
		sum->c6 += delta->c6;
		sum->c7 += delta->c7;
		sum->aperf += delta->aperf;
		sum->mperf += delta->mperf;
		sum->pc2 += delta->pc2;
		sum->pc3 += delta->pc3;
		sum->pc6 += delta->pc6;
		sum->pc7 += delta->pc7;
	}
	avg->tsc = sum->tsc/num_cpus;
	avg->c1 = sum->c1/num_cpus;
	avg->c3 = sum->c3/num_cpus;
	avg->c6 = sum->c6/num_cpus;
	avg->c7 = sum->c7/num_cpus;
	avg->aperf = sum->aperf/num_cpus;
	avg->mperf = sum->mperf/num_cpus;
	avg->pc2 = sum->pc2/num_cpus;
	avg->pc3 = sum->pc3/num_cpus;
	avg->pc6 = sum->pc6/num_cpus;
	avg->pc7 = sum->pc7/num_cpus;

	free(sum);
}

502
int get_counters(struct counters *cnt)
Len Brown's avatar
Len Brown committed
503
{
Len Brown's avatar
Len Brown committed
504
	for ( ; cnt; cnt = cnt->next) {
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523

		if (cpu_migrate(cnt->cpu))
			return -1;

		if (get_msr(cnt->cpu, MSR_TSC, &cnt->tsc))
			return -1;

		if (has_aperf) {
			if (get_msr(cnt->cpu, MSR_APERF, &cnt->aperf))
				return -1;
			if (get_msr(cnt->cpu, MSR_MPERF, &cnt->mperf))
				return -1;
		}

		if (do_nhm_cstates) {
			if (get_msr(cnt->cpu, MSR_CORE_C3_RESIDENCY, &cnt->c3))
				return -1;
			if (get_msr(cnt->cpu, MSR_CORE_C6_RESIDENCY, &cnt->c6))
				return -1;
524
525
		}

Len Brown's avatar
Len Brown committed
526
		if (do_snb_cstates)
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
			if (get_msr(cnt->cpu, MSR_CORE_C7_RESIDENCY, &cnt->c7))
				return -1;

		if (do_nhm_cstates) {
			if (get_msr(cnt->cpu, MSR_PKG_C3_RESIDENCY, &cnt->pc3))
				return -1;
			if (get_msr(cnt->cpu, MSR_PKG_C6_RESIDENCY, &cnt->pc6))
				return -1;
		}
		if (do_snb_cstates) {
			if (get_msr(cnt->cpu, MSR_PKG_C2_RESIDENCY, &cnt->pc2))
				return -1;
			if (get_msr(cnt->cpu, MSR_PKG_C7_RESIDENCY, &cnt->pc7))
				return -1;
		}
Len Brown's avatar
Len Brown committed
542
		if (extra_msr_offset)
543
544
			if (get_msr(cnt->cpu, extra_msr_offset, &cnt->extra_msr))
				return -1;
Len Brown's avatar
Len Brown committed
545
	}
546
	return 0;
Len Brown's avatar
Len Brown committed
547
548
}

Len Brown's avatar
Len Brown committed
549
void print_nehalem_info(void)
Len Brown's avatar
Len Brown committed
550
551
552
553
554
555
556
{
	unsigned long long msr;
	unsigned int ratio;

	if (!do_nehalem_platform_info)
		return;

557
	get_msr(0, MSR_NEHALEM_PLATFORM_INFO, &msr);
Len Brown's avatar
Len Brown committed
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572

	ratio = (msr >> 40) & 0xFF;
	fprintf(stderr, "%d * %.0f = %.0f MHz max efficiency\n",
		ratio, bclk, ratio * bclk);

	ratio = (msr >> 8) & 0xFF;
	fprintf(stderr, "%d * %.0f = %.0f MHz TSC frequency\n",
		ratio, bclk, ratio * bclk);

	if (verbose > 1)
		fprintf(stderr, "MSR_NEHALEM_PLATFORM_INFO: 0x%llx\n", msr);

	if (!do_nehalem_turbo_ratio_limit)
		return;

573
	get_msr(0, MSR_NEHALEM_TURBO_RATIO_LIMIT, &msr);
Len Brown's avatar
Len Brown committed
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596

	ratio = (msr >> 24) & 0xFF;
	if (ratio)
		fprintf(stderr, "%d * %.0f = %.0f MHz max turbo 4 active cores\n",
			ratio, bclk, ratio * bclk);

	ratio = (msr >> 16) & 0xFF;
	if (ratio)
		fprintf(stderr, "%d * %.0f = %.0f MHz max turbo 3 active cores\n",
			ratio, bclk, ratio * bclk);

	ratio = (msr >> 8) & 0xFF;
	if (ratio)
		fprintf(stderr, "%d * %.0f = %.0f MHz max turbo 2 active cores\n",
			ratio, bclk, ratio * bclk);

	ratio = (msr >> 0) & 0xFF;
	if (ratio)
		fprintf(stderr, "%d * %.0f = %.0f MHz max turbo 1 active cores\n",
			ratio, bclk, ratio * bclk);

}

Len Brown's avatar
Len Brown committed
597
void free_counter_list(struct counters *list)
Len Brown's avatar
Len Brown committed
598
{
Len Brown's avatar
Len Brown committed
599
	struct counters *p;
Len Brown's avatar
Len Brown committed
600
601

	for (p = list; p; ) {
Len Brown's avatar
Len Brown committed
602
		struct counters *free_me;
Len Brown's avatar
Len Brown committed
603
604
605
606
607
608
609
610
611

		free_me = p;
		p = p->next;
		free(free_me);
	}
}

void free_all_counters(void)
{
Len Brown's avatar
Len Brown committed
612
613
	free_counter_list(cnt_even);
	cnt_even = NULL;
Len Brown's avatar
Len Brown committed
614

Len Brown's avatar
Len Brown committed
615
616
	free_counter_list(cnt_odd);
	cnt_odd = NULL;
Len Brown's avatar
Len Brown committed
617

Len Brown's avatar
Len Brown committed
618
619
	free_counter_list(cnt_delta);
	cnt_delta = NULL;
Len Brown's avatar
Len Brown committed
620

Len Brown's avatar
Len Brown committed
621
622
	free_counter_list(cnt_average);
	cnt_average = NULL;
Len Brown's avatar
Len Brown committed
623
624
}

Len Brown's avatar
Len Brown committed
625
626
void insert_counters(struct counters **list,
	struct counters *new)
Len Brown's avatar
Len Brown committed
627
{
Len Brown's avatar
Len Brown committed
628
	struct counters *prev;
Len Brown's avatar
Len Brown committed
629
630
631
632
633
634
635
636
637
638

	/*
	 * list was empty
	 */
	if (*list == NULL) {
		new->next = *list;
		*list = new;
		return;
	}

639
640
	if (!summary_only)
		show_cpu = 1;	/* there is more than one CPU */
Len Brown's avatar
Len Brown committed
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657

	/*
	 * insert on front of list.
	 * It is sorted by ascending package#, core#, cpu#
	 */
	if (((*list)->pkg > new->pkg) ||
	    (((*list)->pkg == new->pkg) && ((*list)->core > new->core)) ||
	    (((*list)->pkg == new->pkg) && ((*list)->core == new->core) && ((*list)->cpu > new->cpu))) {
		new->next = *list;
		*list = new;
		return;
	}

	prev = *list;

	while (prev->next && (prev->next->pkg < new->pkg)) {
		prev = prev->next;
658
659
		if (!summary_only)
			show_pkg = 1;	/* there is more than 1 package */
Len Brown's avatar
Len Brown committed
660
661
662
663
664
	}

	while (prev->next && (prev->next->pkg == new->pkg)
		&& (prev->next->core < new->core)) {
		prev = prev->next;
665
666
		if (!summary_only)
			show_core = 1;	/* there is more than 1 core */
Len Brown's avatar
Len Brown committed
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
	}

	while (prev->next && (prev->next->pkg == new->pkg)
		&& (prev->next->core == new->core)
		&& (prev->next->cpu < new->cpu)) {
		prev = prev->next;
	}

	/*
	 * insert after "prev"
	 */
	new->next = prev->next;
	prev->next = new;
}

Len Brown's avatar
Len Brown committed
682
void alloc_new_counters(int pkg, int core, int cpu)
Len Brown's avatar
Len Brown committed
683
{
Len Brown's avatar
Len Brown committed
684
	struct counters *new;
Len Brown's avatar
Len Brown committed
685
686
687
688

	if (verbose > 1)
		printf("pkg%d core%d, cpu%d\n", pkg, core, cpu);

Len Brown's avatar
Len Brown committed
689
	new = (struct counters *)calloc(1, sizeof(struct counters));
Len Brown's avatar
Len Brown committed
690
691
692
693
694
695
696
	if (new == NULL) {
		perror("calloc");
		exit(1);
	}
	new->pkg = pkg;
	new->core = core;
	new->cpu = cpu;
Len Brown's avatar
Len Brown committed
697
	insert_counters(&cnt_odd, new);
Len Brown's avatar
Len Brown committed
698

Len Brown's avatar
Len Brown committed
699
700
	new = (struct counters *)calloc(1,
		sizeof(struct counters));
Len Brown's avatar
Len Brown committed
701
702
703
704
705
706
707
	if (new == NULL) {
		perror("calloc");
		exit(1);
	}
	new->pkg = pkg;
	new->core = core;
	new->cpu = cpu;
Len Brown's avatar
Len Brown committed
708
	insert_counters(&cnt_even, new);
Len Brown's avatar
Len Brown committed
709

Len Brown's avatar
Len Brown committed
710
	new = (struct counters *)calloc(1, sizeof(struct counters));
Len Brown's avatar
Len Brown committed
711
712
713
714
715
716
717
	if (new == NULL) {
		perror("calloc");
		exit(1);
	}
	new->pkg = pkg;
	new->core = core;
	new->cpu = cpu;
Len Brown's avatar
Len Brown committed
718
	insert_counters(&cnt_delta, new);
Len Brown's avatar
Len Brown committed
719

Len Brown's avatar
Len Brown committed
720
	new = (struct counters *)calloc(1, sizeof(struct counters));
Len Brown's avatar
Len Brown committed
721
722
723
724
725
726
727
	if (new == NULL) {
		perror("calloc");
		exit(1);
	}
	new->pkg = pkg;
	new->core = core;
	new->cpu = cpu;
Len Brown's avatar
Len Brown committed
728
	cnt_average = new;
Len Brown's avatar
Len Brown committed
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
}

int get_physical_package_id(int cpu)
{
	char path[64];
	FILE *filep;
	int pkg;

	sprintf(path, "/sys/devices/system/cpu/cpu%d/topology/physical_package_id", cpu);
	filep = fopen(path, "r");
	if (filep == NULL) {
		perror(path);
		exit(1);
	}
	fscanf(filep, "%d", &pkg);
	fclose(filep);
	return pkg;
}

int get_core_id(int cpu)
{
	char path[64];
	FILE *filep;
	int core;

	sprintf(path, "/sys/devices/system/cpu/cpu%d/topology/core_id", cpu);
	filep = fopen(path, "r");
	if (filep == NULL) {
		perror(path);
		exit(1);
	}
	fscanf(filep, "%d", &core);
	fclose(filep);
	return core;
}

/*
766
 * run func(pkg, core, cpu) on every cpu in /proc/stat
Len Brown's avatar
Len Brown committed
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 */

int for_all_cpus(void (func)(int, int, int))
{
	FILE *fp;
	int cpu_count;
	int retval;

	fp = fopen(proc_stat, "r");
	if (fp == NULL) {
		perror(proc_stat);
		exit(1);
	}

	retval = fscanf(fp, "cpu %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d\n");
	if (retval != 0) {
		perror("/proc/stat format");
		exit(1);
	}

	for (cpu_count = 0; ; cpu_count++) {
		int cpu;

		retval = fscanf(fp, "cpu%u %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d\n", &cpu);
		if (retval != 1)
			break;

		func(get_physical_package_id(cpu), get_core_id(cpu), cpu);
	}
	fclose(fp);
	return cpu_count;
}

void re_initialize(void)
{
	free_all_counters();
Len Brown's avatar
Len Brown committed
803
	num_cpus = for_all_cpus(alloc_new_counters);
804
805
	cpu_mask_uninit();
	cpu_mask_init(num_cpus);
806
	printf("turbostat: re-initialized with num_cpus %d\n", num_cpus);
Len Brown's avatar
Len Brown committed
807
808
809
810
811
812
}

void dummy(int pkg, int core, int cpu) { return; }
/*
 * check to see if a cpu came on-line
 */
813
int verify_num_cpus(void)
Len Brown's avatar
Len Brown committed
814
815
816
817
818
819
820
821
822
{
	int new_num_cpus;

	new_num_cpus = for_all_cpus(dummy);

	if (new_num_cpus != num_cpus) {
		if (verbose)
			printf("num_cpus was %d, is now  %d\n",
				num_cpus, new_num_cpus);
823
		return -1;
Len Brown's avatar
Len Brown committed
824
	}
825
	return 0;
Len Brown's avatar
Len Brown committed
826
827
828
829
830
}

void turbostat_loop()
{
restart:
Len Brown's avatar
Len Brown committed
831
	get_counters(cnt_even);
Len Brown's avatar
Len Brown committed
832
833
834
	gettimeofday(&tv_even, (struct timezone *)NULL);

	while (1) {
835
		if (verify_num_cpus()) {
Len Brown's avatar
Len Brown committed
836
837
838
839
			re_initialize();
			goto restart;
		}
		sleep(interval_sec);
840
841
842
843
		if (get_counters(cnt_odd)) {
			re_initialize();
			goto restart;
		}
Len Brown's avatar
Len Brown committed
844
		gettimeofday(&tv_odd, (struct timezone *)NULL);
Len Brown's avatar
Len Brown committed
845
		compute_delta(cnt_odd, cnt_even, cnt_delta);
Len Brown's avatar
Len Brown committed
846
		timersub(&tv_odd, &tv_even, &tv_delta);
Len Brown's avatar
Len Brown committed
847
848
		compute_average(cnt_delta, cnt_average);
		print_counters(cnt_delta);
849
850
		sleep(interval_sec);
		if (get_counters(cnt_even)) {
Len Brown's avatar
Len Brown committed
851
852
853
854
			re_initialize();
			goto restart;
		}
		gettimeofday(&tv_even, (struct timezone *)NULL);
Len Brown's avatar
Len Brown committed
855
		compute_delta(cnt_even, cnt_odd, cnt_delta);
Len Brown's avatar
Len Brown committed
856
		timersub(&tv_even, &tv_odd, &tv_delta);
Len Brown's avatar
Len Brown committed
857
858
		compute_average(cnt_delta, cnt_average);
		print_counters(cnt_delta);
Len Brown's avatar
Len Brown committed
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
	}
}

void check_dev_msr()
{
	struct stat sb;

	if (stat("/dev/cpu/0/msr", &sb)) {
		fprintf(stderr, "no /dev/cpu/0/msr\n");
		fprintf(stderr, "Try \"# modprobe msr\"\n");
		exit(-5);
	}
}

void check_super_user()
{
	if (getuid() != 0) {
		fprintf(stderr, "must be root\n");
		exit(-6);
	}
}

int has_nehalem_turbo_ratio_limit(unsigned int family, unsigned int model)
{
	if (!genuine_intel)
		return 0;

	if (family != 6)
		return 0;

	switch (model) {
	case 0x1A:	/* Core i7, Xeon 5500 series - Bloomfield, Gainstown NHM-EP */
	case 0x1E:	/* Core i7 and i5 Processor - Clarksfield, Lynnfield, Jasper Forest */
	case 0x1F:	/* Core i7 and i5 Processor - Nehalem */
	case 0x25:	/* Westmere Client - Clarkdale, Arrandale */
	case 0x2C:	/* Westmere EP - Gulftown */
	case 0x2A:	/* SNB */
	case 0x2D:	/* SNB Xeon */
897
898
	case 0x3A:	/* IVB */
	case 0x3D:	/* IVB Xeon */
Len Brown's avatar
Len Brown committed
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
		return 1;
	case 0x2E:	/* Nehalem-EX Xeon - Beckton */
	case 0x2F:	/* Westmere-EX Xeon - Eagleton */
	default:
		return 0;
	}
}

int is_snb(unsigned int family, unsigned int model)
{
	if (!genuine_intel)
		return 0;

	switch (model) {
	case 0x2A:
	case 0x2D:
		return 1;
	}
	return 0;
}

double discover_bclk(unsigned int family, unsigned int model)
{
	if (is_snb(family, model))
		return 100.00;
	else
		return 133.33;
}

void check_cpuid()
{
	unsigned int eax, ebx, ecx, edx, max_level;
	unsigned int fms, family, model, stepping;

	eax = ebx = ecx = edx = 0;

	asm("cpuid" : "=a" (max_level), "=b" (ebx), "=c" (ecx), "=d" (edx) : "a" (0));

	if (ebx == 0x756e6547 && edx == 0x49656e69 && ecx == 0x6c65746e)
		genuine_intel = 1;

	if (verbose)
		fprintf(stderr, "%.4s%.4s%.4s ",
			(char *)&ebx, (char *)&edx, (char *)&ecx);

	asm("cpuid" : "=a" (fms), "=c" (ecx), "=d" (edx) : "a" (1) : "ebx");
	family = (fms >> 8) & 0xf;
	model = (fms >> 4) & 0xf;
	stepping = fms & 0xf;
	if (family == 6 || family == 0xf)
		model += ((fms >> 16) & 0xf) << 4;

	if (verbose)
		fprintf(stderr, "%d CPUID levels; family:model:stepping 0x%x:%x:%x (%d:%d:%d)\n",
			max_level, family, model, stepping, family, model, stepping);

	if (!(edx & (1 << 5))) {
		fprintf(stderr, "CPUID: no MSR\n");
		exit(1);
	}

	/*
	 * check max extended function levels of CPUID.
	 * This is needed to check for invariant TSC.
	 * This check is valid for both Intel and AMD.
	 */
	ebx = ecx = edx = 0;
	asm("cpuid" : "=a" (max_level), "=b" (ebx), "=c" (ecx), "=d" (edx) : "a" (0x80000000));

	if (max_level < 0x80000007) {
		fprintf(stderr, "CPUID: no invariant TSC (max_level 0x%x)\n", max_level);
		exit(1);
	}

	/*
	 * Non-Stop TSC is advertised by CPUID.EAX=0x80000007: EDX.bit8
	 * this check is valid for both Intel and AMD
	 */
	asm("cpuid" : "=a" (eax), "=b" (ebx), "=c" (ecx), "=d" (edx) : "a" (0x80000007));
978
	has_invariant_tsc = edx & (1 << 8);
Len Brown's avatar
Len Brown committed
979
980
981
982
983
984
985
986
987
988
989
990

	if (!has_invariant_tsc) {
		fprintf(stderr, "No invariant TSC\n");
		exit(1);
	}

	/*
	 * APERF/MPERF is advertised by CPUID.EAX=0x6: ECX.bit0
	 * this check is valid for both Intel and AMD
	 */

	asm("cpuid" : "=a" (eax), "=b" (ebx), "=c" (ecx), "=d" (edx) : "a" (0x6));
991
	has_aperf = ecx & (1 << 0);
Len Brown's avatar
Len Brown committed
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
	if (!has_aperf) {
		fprintf(stderr, "No APERF MSR\n");
		exit(1);
	}

	do_nehalem_platform_info = genuine_intel && has_invariant_tsc;
	do_nhm_cstates = genuine_intel;	/* all Intel w/ non-stop TSC have NHM counters */
	do_snb_cstates = is_snb(family, model);
	bclk = discover_bclk(family, model);

	do_nehalem_turbo_ratio_limit = has_nehalem_turbo_ratio_limit(family, model);
}


void usage()
{
	fprintf(stderr, "%s: [-v] [-M MSR#] [-i interval_sec | command ...]\n",
		progname);
	exit(1);
}


/*
 * in /dev/cpu/ return success for names that are numbers
 * ie. filter out ".", "..", "microcode".
 */
int dir_filter(const struct dirent *dirp)
{
	if (isdigit(dirp->d_name[0]))
		return 1;
	else
		return 0;
}

int open_dev_cpu_msr(int dummy1)
{
	return 0;
}

void turbostat_init()
{
	check_cpuid();

	check_dev_msr();
	check_super_user();

Len Brown's avatar
Len Brown committed
1038
	num_cpus = for_all_cpus(alloc_new_counters);
1039
	cpu_mask_init(num_cpus);
Len Brown's avatar
Len Brown committed
1040
1041
1042
1043
1044
1045
1046
1047
1048

	if (verbose)
		print_nehalem_info();
}

int fork_it(char **argv)
{
	int retval;
	pid_t child_pid;
Len Brown's avatar
Len Brown committed
1049
	get_counters(cnt_even);
Len Brown's avatar
Len Brown committed
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
	gettimeofday(&tv_even, (struct timezone *)NULL);

	child_pid = fork();
	if (!child_pid) {
		/* child */
		execvp(argv[0], argv);
	} else {
		int status;

		/* parent */
		if (child_pid == -1) {
			perror("fork");
			exit(1);
		}

		signal(SIGINT, SIG_IGN);
		signal(SIGQUIT, SIG_IGN);
		if (waitpid(child_pid, &status, 0) == -1) {
			perror("wait");
			exit(1);
		}
	}
Len Brown's avatar
Len Brown committed
1072
	get_counters(cnt_odd);
Len Brown's avatar
Len Brown committed
1073
	gettimeofday(&tv_odd, (struct timezone *)NULL);
Len Brown's avatar
Len Brown committed
1074
	retval = compute_delta(cnt_odd, cnt_even, cnt_delta);
Len Brown's avatar
Len Brown committed
1075
1076

	timersub(&tv_odd, &tv_even, &tv_delta);
Len Brown's avatar
Len Brown committed
1077
	compute_average(cnt_delta, cnt_average);
Len Brown's avatar
Len Brown committed
1078
	if (!retval)
Len Brown's avatar
Len Brown committed
1079
		print_counters(cnt_delta);
Len Brown's avatar
Len Brown committed
1080

1081
	fprintf(stderr, "%.6f sec\n", tv_delta.tv_sec + tv_delta.tv_usec/1000000.0);
Len Brown's avatar
Len Brown committed
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091

	return 0;
}

void cmdline(int argc, char **argv)
{
	int opt;

	progname = argv[0];

1092
	while ((opt = getopt(argc, argv, "+svi:M:")) != -1) {
Len Brown's avatar
Len Brown committed
1093
		switch (opt) {
1094
1095
1096
		case 's':
			summary_only++;
			break;
Len Brown's avatar
Len Brown committed
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
		case 'v':
			verbose++;
			break;
		case 'i':
			interval_sec = atoi(optarg);
			break;
		case 'M':
			sscanf(optarg, "%x", &extra_msr_offset);
			if (verbose > 1)
				fprintf(stderr, "MSR 0x%X\n", extra_msr_offset);
			break;
		default:
			usage();
		}
	}
}

int main(int argc, char **argv)
{
	cmdline(argc, argv);

	if (verbose > 1)
		fprintf(stderr, "turbostat Dec 6, 2010"
			" - Len Brown <lenb@kernel.org>\n");
	if (verbose > 1)
		fprintf(stderr, "http://userweb.kernel.org/~lenb/acpi/utils/pmtools/turbostat/\n");

	turbostat_init();

	/*
	 * if any params left, it must be a command to fork
	 */
	if (argc - optind)
		return fork_it(argv + optind);
	else
		turbostat_loop();

	return 0;
}