]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - tools/perf/builtin-lock.c
perf tools: Update copy of libbpf's hashmap.c
[mirror_ubuntu-hirsute-kernel.git] / tools / perf / builtin-lock.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
a43783ae 2#include <errno.h>
fd20e811 3#include <inttypes.h>
9b5e350c
HM
4#include "builtin.h"
5#include "perf.h"
6
7ae811b1 7#include "util/evlist.h" // for struct evsel_str_handler
fcf65bf1 8#include "util/evsel.h"
9b5e350c
HM
9#include "util/symbol.h"
10#include "util/thread.h"
11#include "util/header.h"
12
fa0d9846 13#include <subcmd/pager.h>
4b6ab94e 14#include <subcmd/parse-options.h>
9b5e350c
HM
15#include "util/trace-event.h"
16
17#include "util/debug.h"
18#include "util/session.h"
45694aa7 19#include "util/tool.h"
f5fc1412 20#include "util/data.h"
9b5e350c
HM
21
22#include <sys/types.h>
23#include <sys/prctl.h>
24#include <semaphore.h>
25#include <pthread.h>
26#include <math.h>
27#include <limits.h>
28
29#include <linux/list.h>
30#include <linux/hash.h>
877a7a11 31#include <linux/kernel.h>
7f7c536f 32#include <linux/zalloc.h>
6ef81c55 33#include <linux/err.h>
9b5e350c 34
e4cef1f6
HM
35static struct perf_session *session;
36
9b5e350c
HM
37/* based on kernel/lockdep.c */
38#define LOCKHASH_BITS 12
39#define LOCKHASH_SIZE (1UL << LOCKHASH_BITS)
40
41static struct list_head lockhash_table[LOCKHASH_SIZE];
42
43#define __lockhashfn(key) hash_long((unsigned long)key, LOCKHASH_BITS)
44#define lockhashentry(key) (lockhash_table + __lockhashfn((key)))
45
9b5e350c 46struct lock_stat {
59f411b6
IM
47 struct list_head hash_entry;
48 struct rb_node rb; /* used for sorting */
9b5e350c 49
59f411b6 50 /*
efc0cdc9 51 * FIXME: evsel__intval() returns u64,
9b5e350c 52 * so address of lockdep_map should be dealed as 64bit.
59f411b6
IM
53 * Is there more better solution?
54 */
55 void *addr; /* address of lockdep_map, used as ID */
56 char *name; /* for strcpy(), we cannot use const */
9b5e350c 57
59f411b6 58 unsigned int nr_acquire;
e4cef1f6 59 unsigned int nr_acquired;
59f411b6
IM
60 unsigned int nr_contended;
61 unsigned int nr_release;
9b5e350c 62
e4cef1f6
HM
63 unsigned int nr_readlock;
64 unsigned int nr_trylock;
f37376cd 65
9b5e350c 66 /* these times are in nano sec. */
f37376cd 67 u64 avg_wait_time;
59f411b6
IM
68 u64 wait_time_total;
69 u64 wait_time_min;
70 u64 wait_time_max;
e4cef1f6
HM
71
72 int discard; /* flag of blacklist */
73};
74
75/*
76 * States of lock_seq_stat
77 *
78 * UNINITIALIZED is required for detecting first event of acquire.
79 * As the nature of lock events, there is no guarantee
80 * that the first event for the locks are acquire,
81 * it can be acquired, contended or release.
82 */
83#define SEQ_STATE_UNINITIALIZED 0 /* initial state */
84#define SEQ_STATE_RELEASED 1
85#define SEQ_STATE_ACQUIRING 2
86#define SEQ_STATE_ACQUIRED 3
87#define SEQ_STATE_READ_ACQUIRED 4
88#define SEQ_STATE_CONTENDED 5
89
90/*
91 * MAX_LOCK_DEPTH
92 * Imported from include/linux/sched.h.
93 * Should this be synchronized?
94 */
95#define MAX_LOCK_DEPTH 48
96
97/*
98 * struct lock_seq_stat:
99 * Place to put on state of one lock sequence
100 * 1) acquire -> acquired -> release
101 * 2) acquire -> contended -> acquired -> release
102 * 3) acquire (with read or try) -> release
103 * 4) Are there other patterns?
104 */
105struct lock_seq_stat {
106 struct list_head list;
107 int state;
108 u64 prev_event_time;
109 void *addr;
110
111 int read_count;
9b5e350c
HM
112};
113
e4cef1f6
HM
114struct thread_stat {
115 struct rb_node rb;
116
117 u32 tid;
118 struct list_head seq_list;
119};
120
121static struct rb_root thread_stats;
122
123static struct thread_stat *thread_stat_find(u32 tid)
124{
125 struct rb_node *node;
126 struct thread_stat *st;
127
128 node = thread_stats.rb_node;
129 while (node) {
130 st = container_of(node, struct thread_stat, rb);
131 if (st->tid == tid)
132 return st;
133 else if (tid < st->tid)
134 node = node->rb_left;
135 else
136 node = node->rb_right;
137 }
138
139 return NULL;
140}
141
142static void thread_stat_insert(struct thread_stat *new)
143{
144 struct rb_node **rb = &thread_stats.rb_node;
145 struct rb_node *parent = NULL;
146 struct thread_stat *p;
147
148 while (*rb) {
149 p = container_of(*rb, struct thread_stat, rb);
150 parent = *rb;
151
152 if (new->tid < p->tid)
153 rb = &(*rb)->rb_left;
154 else if (new->tid > p->tid)
155 rb = &(*rb)->rb_right;
156 else
157 BUG_ON("inserting invalid thread_stat\n");
158 }
159
160 rb_link_node(&new->rb, parent, rb);
161 rb_insert_color(&new->rb, &thread_stats);
162}
163
164static struct thread_stat *thread_stat_findnew_after_first(u32 tid)
165{
166 struct thread_stat *st;
167
168 st = thread_stat_find(tid);
169 if (st)
170 return st;
171
172 st = zalloc(sizeof(struct thread_stat));
33d6aef5
DA
173 if (!st) {
174 pr_err("memory allocation failed\n");
175 return NULL;
176 }
e4cef1f6
HM
177
178 st->tid = tid;
179 INIT_LIST_HEAD(&st->seq_list);
180
181 thread_stat_insert(st);
182
183 return st;
184}
185
186static struct thread_stat *thread_stat_findnew_first(u32 tid);
187static struct thread_stat *(*thread_stat_findnew)(u32 tid) =
188 thread_stat_findnew_first;
189
190static struct thread_stat *thread_stat_findnew_first(u32 tid)
191{
192 struct thread_stat *st;
193
194 st = zalloc(sizeof(struct thread_stat));
33d6aef5
DA
195 if (!st) {
196 pr_err("memory allocation failed\n");
197 return NULL;
198 }
e4cef1f6
HM
199 st->tid = tid;
200 INIT_LIST_HEAD(&st->seq_list);
201
202 rb_link_node(&st->rb, NULL, &thread_stats.rb_node);
203 rb_insert_color(&st->rb, &thread_stats);
204
205 thread_stat_findnew = thread_stat_findnew_after_first;
206 return st;
207}
208
9b5e350c 209/* build simple key function one is bigger than two */
59f411b6 210#define SINGLE_KEY(member) \
9b5e350c
HM
211 static int lock_stat_key_ ## member(struct lock_stat *one, \
212 struct lock_stat *two) \
213 { \
214 return one->member > two->member; \
215 }
216
217SINGLE_KEY(nr_acquired)
218SINGLE_KEY(nr_contended)
f37376cd 219SINGLE_KEY(avg_wait_time)
9b5e350c 220SINGLE_KEY(wait_time_total)
9b5e350c
HM
221SINGLE_KEY(wait_time_max)
222
9df03abe
MS
223static int lock_stat_key_wait_time_min(struct lock_stat *one,
224 struct lock_stat *two)
225{
226 u64 s1 = one->wait_time_min;
227 u64 s2 = two->wait_time_min;
228 if (s1 == ULLONG_MAX)
229 s1 = 0;
230 if (s2 == ULLONG_MAX)
231 s2 = 0;
232 return s1 > s2;
233}
234
9b5e350c
HM
235struct lock_key {
236 /*
237 * name: the value for specify by user
238 * this should be simpler than raw name of member
239 * e.g. nr_acquired -> acquired, wait_time_total -> wait_total
240 */
59f411b6
IM
241 const char *name;
242 int (*key)(struct lock_stat*, struct lock_stat*);
9b5e350c
HM
243};
244
59f411b6
IM
245static const char *sort_key = "acquired";
246
247static int (*compare)(struct lock_stat *, struct lock_stat *);
248
249static struct rb_root result; /* place to store sorted data */
9b5e350c
HM
250
251#define DEF_KEY_LOCK(name, fn_suffix) \
252 { #name, lock_stat_key_ ## fn_suffix }
253struct lock_key keys[] = {
254 DEF_KEY_LOCK(acquired, nr_acquired),
255 DEF_KEY_LOCK(contended, nr_contended),
f37376cd 256 DEF_KEY_LOCK(avg_wait, avg_wait_time),
9b5e350c
HM
257 DEF_KEY_LOCK(wait_total, wait_time_total),
258 DEF_KEY_LOCK(wait_min, wait_time_min),
259 DEF_KEY_LOCK(wait_max, wait_time_max),
260
261 /* extra comparisons much complicated should be here */
262
263 { NULL, NULL }
264};
265
33d6aef5 266static int select_key(void)
9b5e350c
HM
267{
268 int i;
269
270 for (i = 0; keys[i].name; i++) {
271 if (!strcmp(keys[i].name, sort_key)) {
272 compare = keys[i].key;
33d6aef5 273 return 0;
9b5e350c
HM
274 }
275 }
276
33d6aef5
DA
277 pr_err("Unknown compare key: %s\n", sort_key);
278
279 return -1;
9b5e350c
HM
280}
281
9b5e350c 282static void insert_to_result(struct lock_stat *st,
59f411b6 283 int (*bigger)(struct lock_stat *, struct lock_stat *))
9b5e350c
HM
284{
285 struct rb_node **rb = &result.rb_node;
286 struct rb_node *parent = NULL;
287 struct lock_stat *p;
288
289 while (*rb) {
290 p = container_of(*rb, struct lock_stat, rb);
291 parent = *rb;
292
293 if (bigger(st, p))
294 rb = &(*rb)->rb_left;
295 else
296 rb = &(*rb)->rb_right;
297 }
298
299 rb_link_node(&st->rb, parent, rb);
300 rb_insert_color(&st->rb, &result);
301}
302
303/* returns left most element of result, and erase it */
304static struct lock_stat *pop_from_result(void)
305{
306 struct rb_node *node = result.rb_node;
307
308 if (!node)
309 return NULL;
310
311 while (node->rb_left)
312 node = node->rb_left;
313
314 rb_erase(node, &result);
315 return container_of(node, struct lock_stat, rb);
316}
317
59f411b6 318static struct lock_stat *lock_stat_findnew(void *addr, const char *name)
9b5e350c
HM
319{
320 struct list_head *entry = lockhashentry(addr);
321 struct lock_stat *ret, *new;
322
323 list_for_each_entry(ret, entry, hash_entry) {
324 if (ret->addr == addr)
325 return ret;
326 }
327
328 new = zalloc(sizeof(struct lock_stat));
329 if (!new)
330 goto alloc_failed;
331
332 new->addr = addr;
333 new->name = zalloc(sizeof(char) * strlen(name) + 1);
0a98c7fe
DB
334 if (!new->name) {
335 free(new);
9b5e350c 336 goto alloc_failed;
0a98c7fe 337 }
9b5e350c 338
0a98c7fe 339 strcpy(new->name, name);
9b5e350c
HM
340 new->wait_time_min = ULLONG_MAX;
341
342 list_add(&new->hash_entry, entry);
343 return new;
344
345alloc_failed:
33d6aef5
DA
346 pr_err("memory allocation failed\n");
347 return NULL;
9b5e350c
HM
348}
349
9b5e350c 350struct trace_lock_handler {
32dcd021 351 int (*acquire_event)(struct evsel *evsel,
746f16ec 352 struct perf_sample *sample);
9b5e350c 353
32dcd021 354 int (*acquired_event)(struct evsel *evsel,
746f16ec 355 struct perf_sample *sample);
9b5e350c 356
32dcd021 357 int (*contended_event)(struct evsel *evsel,
746f16ec 358 struct perf_sample *sample);
9b5e350c 359
32dcd021 360 int (*release_event)(struct evsel *evsel,
746f16ec 361 struct perf_sample *sample);
9b5e350c
HM
362};
363
e4cef1f6
HM
364static struct lock_seq_stat *get_seq(struct thread_stat *ts, void *addr)
365{
366 struct lock_seq_stat *seq;
367
368 list_for_each_entry(seq, &ts->seq_list, list) {
369 if (seq->addr == addr)
370 return seq;
371 }
372
373 seq = zalloc(sizeof(struct lock_seq_stat));
33d6aef5
DA
374 if (!seq) {
375 pr_err("memory allocation failed\n");
376 return NULL;
377 }
e4cef1f6
HM
378 seq->state = SEQ_STATE_UNINITIALIZED;
379 seq->addr = addr;
380
381 list_add(&seq->list, &ts->seq_list);
382 return seq;
383}
384
10350ec3
FW
385enum broken_state {
386 BROKEN_ACQUIRE,
387 BROKEN_ACQUIRED,
388 BROKEN_CONTENDED,
389 BROKEN_RELEASE,
390 BROKEN_MAX,
391};
392
393static int bad_hist[BROKEN_MAX];
e4cef1f6 394
84c7a217
FW
395enum acquire_flags {
396 TRY_LOCK = 1,
397 READ_LOCK = 2,
398};
399
32dcd021 400static int report_lock_acquire_event(struct evsel *evsel,
746f16ec 401 struct perf_sample *sample)
9b5e350c 402{
746f16ec 403 void *addr;
e4cef1f6
HM
404 struct lock_stat *ls;
405 struct thread_stat *ts;
406 struct lock_seq_stat *seq;
efc0cdc9
ACM
407 const char *name = evsel__strval(evsel, sample, "name");
408 u64 tmp = evsel__intval(evsel, sample, "lockdep_addr");
e24a87b5 409 int flag = evsel__intval(evsel, sample, "flags");
e4cef1f6 410
746f16ec
ACM
411 memcpy(&addr, &tmp, sizeof(void *));
412
413 ls = lock_stat_findnew(addr, name);
33d6aef5 414 if (!ls)
b33492ad 415 return -ENOMEM;
e4cef1f6 416 if (ls->discard)
33d6aef5 417 return 0;
9b5e350c 418
01d95524 419 ts = thread_stat_findnew(sample->tid);
33d6aef5 420 if (!ts)
b33492ad 421 return -ENOMEM;
33d6aef5 422
746f16ec 423 seq = get_seq(ts, addr);
33d6aef5 424 if (!seq)
b33492ad 425 return -ENOMEM;
9b5e350c 426
e4cef1f6
HM
427 switch (seq->state) {
428 case SEQ_STATE_UNINITIALIZED:
429 case SEQ_STATE_RELEASED:
746f16ec 430 if (!flag) {
e4cef1f6
HM
431 seq->state = SEQ_STATE_ACQUIRING;
432 } else {
746f16ec 433 if (flag & TRY_LOCK)
e4cef1f6 434 ls->nr_trylock++;
746f16ec 435 if (flag & READ_LOCK)
e4cef1f6
HM
436 ls->nr_readlock++;
437 seq->state = SEQ_STATE_READ_ACQUIRED;
438 seq->read_count = 1;
439 ls->nr_acquired++;
440 }
441 break;
442 case SEQ_STATE_READ_ACQUIRED:
746f16ec 443 if (flag & READ_LOCK) {
e4cef1f6
HM
444 seq->read_count++;
445 ls->nr_acquired++;
446 goto end;
447 } else {
448 goto broken;
449 }
9b5e350c 450 break;
e4cef1f6
HM
451 case SEQ_STATE_ACQUIRED:
452 case SEQ_STATE_ACQUIRING:
453 case SEQ_STATE_CONTENDED:
454broken:
455 /* broken lock sequence, discard it */
456 ls->discard = 1;
10350ec3 457 bad_hist[BROKEN_ACQUIRE]++;
e56fbc9d 458 list_del_init(&seq->list);
e4cef1f6
HM
459 free(seq);
460 goto end;
9b5e350c 461 default:
e4cef1f6 462 BUG_ON("Unknown state of lock sequence found!\n");
9b5e350c
HM
463 break;
464 }
465
e4cef1f6 466 ls->nr_acquire++;
01d95524 467 seq->prev_event_time = sample->time;
e4cef1f6 468end:
33d6aef5 469 return 0;
9b5e350c
HM
470}
471
32dcd021 472static int report_lock_acquired_event(struct evsel *evsel,
746f16ec 473 struct perf_sample *sample)
9b5e350c 474{
746f16ec 475 void *addr;
e4cef1f6
HM
476 struct lock_stat *ls;
477 struct thread_stat *ts;
478 struct lock_seq_stat *seq;
479 u64 contended_term;
efc0cdc9
ACM
480 const char *name = evsel__strval(evsel, sample, "name");
481 u64 tmp = evsel__intval(evsel, sample, "lockdep_addr");
746f16ec
ACM
482
483 memcpy(&addr, &tmp, sizeof(void *));
9b5e350c 484
746f16ec 485 ls = lock_stat_findnew(addr, name);
33d6aef5 486 if (!ls)
b33492ad 487 return -ENOMEM;
e4cef1f6 488 if (ls->discard)
33d6aef5 489 return 0;
e4cef1f6 490
01d95524 491 ts = thread_stat_findnew(sample->tid);
33d6aef5 492 if (!ts)
b33492ad 493 return -ENOMEM;
33d6aef5 494
746f16ec 495 seq = get_seq(ts, addr);
33d6aef5 496 if (!seq)
b33492ad 497 return -ENOMEM;
9b5e350c 498
e4cef1f6
HM
499 switch (seq->state) {
500 case SEQ_STATE_UNINITIALIZED:
501 /* orphan event, do nothing */
33d6aef5 502 return 0;
e4cef1f6 503 case SEQ_STATE_ACQUIRING:
9b5e350c 504 break;
e4cef1f6 505 case SEQ_STATE_CONTENDED:
746f16ec 506 contended_term = sample->time - seq->prev_event_time;
e4cef1f6 507 ls->wait_time_total += contended_term;
e4cef1f6
HM
508 if (contended_term < ls->wait_time_min)
509 ls->wait_time_min = contended_term;
90c0e5fc 510 if (ls->wait_time_max < contended_term)
e4cef1f6 511 ls->wait_time_max = contended_term;
9b5e350c 512 break;
e4cef1f6
HM
513 case SEQ_STATE_RELEASED:
514 case SEQ_STATE_ACQUIRED:
515 case SEQ_STATE_READ_ACQUIRED:
516 /* broken lock sequence, discard it */
517 ls->discard = 1;
10350ec3 518 bad_hist[BROKEN_ACQUIRED]++;
e56fbc9d 519 list_del_init(&seq->list);
e4cef1f6
HM
520 free(seq);
521 goto end;
9b5e350c 522 default:
e4cef1f6 523 BUG_ON("Unknown state of lock sequence found!\n");
9b5e350c
HM
524 break;
525 }
526
e4cef1f6
HM
527 seq->state = SEQ_STATE_ACQUIRED;
528 ls->nr_acquired++;
f37376cd 529 ls->avg_wait_time = ls->nr_contended ? ls->wait_time_total/ls->nr_contended : 0;
746f16ec 530 seq->prev_event_time = sample->time;
e4cef1f6 531end:
33d6aef5 532 return 0;
9b5e350c
HM
533}
534
32dcd021 535static int report_lock_contended_event(struct evsel *evsel,
746f16ec 536 struct perf_sample *sample)
9b5e350c 537{
746f16ec 538 void *addr;
e4cef1f6
HM
539 struct lock_stat *ls;
540 struct thread_stat *ts;
541 struct lock_seq_stat *seq;
efc0cdc9
ACM
542 const char *name = evsel__strval(evsel, sample, "name");
543 u64 tmp = evsel__intval(evsel, sample, "lockdep_addr");
746f16ec
ACM
544
545 memcpy(&addr, &tmp, sizeof(void *));
e4cef1f6 546
746f16ec 547 ls = lock_stat_findnew(addr, name);
33d6aef5 548 if (!ls)
b33492ad 549 return -ENOMEM;
e4cef1f6 550 if (ls->discard)
33d6aef5 551 return 0;
9b5e350c 552
01d95524 553 ts = thread_stat_findnew(sample->tid);
33d6aef5 554 if (!ts)
b33492ad 555 return -ENOMEM;
33d6aef5 556
746f16ec 557 seq = get_seq(ts, addr);
33d6aef5 558 if (!seq)
b33492ad 559 return -ENOMEM;
9b5e350c 560
e4cef1f6
HM
561 switch (seq->state) {
562 case SEQ_STATE_UNINITIALIZED:
563 /* orphan event, do nothing */
33d6aef5 564 return 0;
e4cef1f6 565 case SEQ_STATE_ACQUIRING:
9b5e350c 566 break;
e4cef1f6
HM
567 case SEQ_STATE_RELEASED:
568 case SEQ_STATE_ACQUIRED:
569 case SEQ_STATE_READ_ACQUIRED:
570 case SEQ_STATE_CONTENDED:
571 /* broken lock sequence, discard it */
572 ls->discard = 1;
10350ec3 573 bad_hist[BROKEN_CONTENDED]++;
e56fbc9d 574 list_del_init(&seq->list);
e4cef1f6
HM
575 free(seq);
576 goto end;
9b5e350c 577 default:
e4cef1f6 578 BUG_ON("Unknown state of lock sequence found!\n");
9b5e350c
HM
579 break;
580 }
581
e4cef1f6
HM
582 seq->state = SEQ_STATE_CONTENDED;
583 ls->nr_contended++;
f37376cd 584 ls->avg_wait_time = ls->wait_time_total/ls->nr_contended;
01d95524 585 seq->prev_event_time = sample->time;
e4cef1f6 586end:
33d6aef5 587 return 0;
9b5e350c
HM
588}
589
32dcd021 590static int report_lock_release_event(struct evsel *evsel,
746f16ec 591 struct perf_sample *sample)
9b5e350c 592{
746f16ec 593 void *addr;
e4cef1f6
HM
594 struct lock_stat *ls;
595 struct thread_stat *ts;
596 struct lock_seq_stat *seq;
efc0cdc9
ACM
597 const char *name = evsel__strval(evsel, sample, "name");
598 u64 tmp = evsel__intval(evsel, sample, "lockdep_addr");
9b5e350c 599
746f16ec
ACM
600 memcpy(&addr, &tmp, sizeof(void *));
601
602 ls = lock_stat_findnew(addr, name);
33d6aef5 603 if (!ls)
b33492ad 604 return -ENOMEM;
e4cef1f6 605 if (ls->discard)
33d6aef5 606 return 0;
9b5e350c 607
01d95524 608 ts = thread_stat_findnew(sample->tid);
33d6aef5 609 if (!ts)
b33492ad 610 return -ENOMEM;
33d6aef5 611
746f16ec 612 seq = get_seq(ts, addr);
33d6aef5 613 if (!seq)
b33492ad 614 return -ENOMEM;
9b5e350c 615
e4cef1f6
HM
616 switch (seq->state) {
617 case SEQ_STATE_UNINITIALIZED:
618 goto end;
e4cef1f6
HM
619 case SEQ_STATE_ACQUIRED:
620 break;
621 case SEQ_STATE_READ_ACQUIRED:
622 seq->read_count--;
623 BUG_ON(seq->read_count < 0);
b0e5a05c 624 if (seq->read_count) {
e4cef1f6 625 ls->nr_release++;
9b5e350c
HM
626 goto end;
627 }
e4cef1f6
HM
628 break;
629 case SEQ_STATE_ACQUIRING:
630 case SEQ_STATE_CONTENDED:
631 case SEQ_STATE_RELEASED:
632 /* broken lock sequence, discard it */
633 ls->discard = 1;
10350ec3 634 bad_hist[BROKEN_RELEASE]++;
e4cef1f6 635 goto free_seq;
9b5e350c 636 default:
e4cef1f6 637 BUG_ON("Unknown state of lock sequence found!\n");
9b5e350c
HM
638 break;
639 }
640
e4cef1f6
HM
641 ls->nr_release++;
642free_seq:
e56fbc9d 643 list_del_init(&seq->list);
e4cef1f6 644 free(seq);
9b5e350c 645end:
33d6aef5 646 return 0;
9b5e350c
HM
647}
648
649/* lock oriented handlers */
650/* TODO: handlers for CPU oriented, thread oriented */
59f411b6
IM
651static struct trace_lock_handler report_lock_ops = {
652 .acquire_event = report_lock_acquire_event,
653 .acquired_event = report_lock_acquired_event,
654 .contended_event = report_lock_contended_event,
655 .release_event = report_lock_release_event,
9b5e350c
HM
656};
657
658static struct trace_lock_handler *trace_handler;
659
3d655813 660static int evsel__process_lock_acquire(struct evsel *evsel, struct perf_sample *sample)
9b5e350c 661{
59f411b6 662 if (trace_handler->acquire_event)
746f16ec
ACM
663 return trace_handler->acquire_event(evsel, sample);
664 return 0;
9b5e350c
HM
665}
666
3d655813 667static int evsel__process_lock_acquired(struct evsel *evsel, struct perf_sample *sample)
9b5e350c 668{
33d6aef5 669 if (trace_handler->acquired_event)
746f16ec
ACM
670 return trace_handler->acquired_event(evsel, sample);
671 return 0;
9b5e350c
HM
672}
673
3d655813 674static int evsel__process_lock_contended(struct evsel *evsel, struct perf_sample *sample)
9b5e350c 675{
33d6aef5 676 if (trace_handler->contended_event)
746f16ec
ACM
677 return trace_handler->contended_event(evsel, sample);
678 return 0;
9b5e350c
HM
679}
680
3d655813 681static int evsel__process_lock_release(struct evsel *evsel, struct perf_sample *sample)
9b5e350c 682{
33d6aef5 683 if (trace_handler->release_event)
746f16ec
ACM
684 return trace_handler->release_event(evsel, sample);
685 return 0;
9b5e350c
HM
686}
687
10350ec3
FW
688static void print_bad_events(int bad, int total)
689{
690 /* Output for debug, this have to be removed */
691 int i;
692 const char *name[4] =
693 { "acquire", "acquired", "contended", "release" };
694
695 pr_info("\n=== output for debug===\n\n");
5efe08cf 696 pr_info("bad: %d, total: %d\n", bad, total);
60a25cbc 697 pr_info("bad rate: %.2f %%\n", (double)bad / (double)total * 100);
10350ec3
FW
698 pr_info("histogram of events caused bad sequence\n");
699 for (i = 0; i < BROKEN_MAX; i++)
700 pr_info(" %10s: %d\n", name[i], bad_hist[i]);
701}
702
9b5e350c
HM
703/* TODO: various way to print, coloring, nano or milli sec */
704static void print_result(void)
705{
706 struct lock_stat *st;
707 char cut_name[20];
e4cef1f6 708 int bad, total;
9b5e350c 709
26242d85
HM
710 pr_info("%20s ", "Name");
711 pr_info("%10s ", "acquired");
712 pr_info("%10s ", "contended");
9b5e350c 713
f37376cd 714 pr_info("%15s ", "avg wait (ns)");
26242d85
HM
715 pr_info("%15s ", "total wait (ns)");
716 pr_info("%15s ", "max wait (ns)");
717 pr_info("%15s ", "min wait (ns)");
9b5e350c 718
26242d85 719 pr_info("\n\n");
9b5e350c 720
e4cef1f6 721 bad = total = 0;
9b5e350c 722 while ((st = pop_from_result())) {
e4cef1f6
HM
723 total++;
724 if (st->discard) {
725 bad++;
726 continue;
727 }
9b5e350c
HM
728 bzero(cut_name, 20);
729
9b5e350c
HM
730 if (strlen(st->name) < 16) {
731 /* output raw name */
26242d85 732 pr_info("%20s ", st->name);
9b5e350c
HM
733 } else {
734 strncpy(cut_name, st->name, 16);
735 cut_name[16] = '.';
736 cut_name[17] = '.';
737 cut_name[18] = '.';
738 cut_name[19] = '\0';
739 /* cut off name for saving output style */
26242d85 740 pr_info("%20s ", cut_name);
9b5e350c
HM
741 }
742
26242d85
HM
743 pr_info("%10u ", st->nr_acquired);
744 pr_info("%10u ", st->nr_contended);
9b5e350c 745
f37376cd 746 pr_info("%15" PRIu64 " ", st->avg_wait_time);
9486aa38
ACM
747 pr_info("%15" PRIu64 " ", st->wait_time_total);
748 pr_info("%15" PRIu64 " ", st->wait_time_max);
749 pr_info("%15" PRIu64 " ", st->wait_time_min == ULLONG_MAX ?
9b5e350c 750 0 : st->wait_time_min);
26242d85 751 pr_info("\n");
9b5e350c 752 }
e4cef1f6 753
10350ec3 754 print_bad_events(bad, total);
9b5e350c
HM
755}
756
8035458f 757static bool info_threads, info_map;
26242d85
HM
758
759static void dump_threads(void)
760{
761 struct thread_stat *st;
762 struct rb_node *node;
763 struct thread *t;
764
765 pr_info("%10s: comm\n", "Thread ID");
766
767 node = rb_first(&thread_stats);
768 while (node) {
769 st = container_of(node, struct thread_stat, rb);
770 t = perf_session__findnew(session, st->tid);
b9c5143a 771 pr_info("%10d: %s\n", st->tid, thread__comm_str(t));
26242d85 772 node = rb_next(node);
b91fc39f 773 thread__put(t);
8284bbea 774 }
26242d85
HM
775}
776
9b5e350c
HM
777static void dump_map(void)
778{
779 unsigned int i;
780 struct lock_stat *st;
781
26242d85 782 pr_info("Address of instance: name of class\n");
9b5e350c
HM
783 for (i = 0; i < LOCKHASH_SIZE; i++) {
784 list_for_each_entry(st, &lockhash_table[i], hash_entry) {
26242d85 785 pr_info(" %p: %s\n", st->addr, st->name);
9b5e350c
HM
786 }
787 }
788}
789
33d6aef5 790static int dump_info(void)
26242d85 791{
33d6aef5
DA
792 int rc = 0;
793
26242d85
HM
794 if (info_threads)
795 dump_threads();
796 else if (info_map)
797 dump_map();
33d6aef5
DA
798 else {
799 rc = -1;
800 pr_err("Unknown type of information\n");
801 }
802
803 return rc;
26242d85
HM
804}
805
32dcd021 806typedef int (*tracepoint_handler)(struct evsel *evsel,
746f16ec
ACM
807 struct perf_sample *sample);
808
1d037ca1 809static int process_sample_event(struct perf_tool *tool __maybe_unused,
d20deb64 810 union perf_event *event,
9e69c210 811 struct perf_sample *sample,
32dcd021 812 struct evsel *evsel,
743eb868 813 struct machine *machine)
c61e52ee 814{
b91fc39f 815 int err = 0;
314add6b
AH
816 struct thread *thread = machine__findnew_thread(machine, sample->pid,
817 sample->tid);
c61e52ee 818
c61e52ee
FW
819 if (thread == NULL) {
820 pr_debug("problem processing %d event, skipping it.\n",
8115d60c 821 event->header.type);
c61e52ee
FW
822 return -1;
823 }
824
744a9719
ACM
825 if (evsel->handler != NULL) {
826 tracepoint_handler f = evsel->handler;
b91fc39f 827 err = f(evsel, sample);
746f16ec
ACM
828 }
829
b91fc39f
ACM
830 thread__put(thread);
831
832 return err;
c61e52ee
FW
833}
834
375eb2be
DB
835static void sort_result(void)
836{
837 unsigned int i;
838 struct lock_stat *st;
839
840 for (i = 0; i < LOCKHASH_SIZE; i++) {
841 list_for_each_entry(st, &lockhash_table[i], hash_entry) {
842 insert_to_result(st, compare);
843 }
844 }
845}
846
32dcd021 847static const struct evsel_str_handler lock_tracepoints[] = {
3d655813
ACM
848 { "lock:lock_acquire", evsel__process_lock_acquire, }, /* CONFIG_LOCKDEP */
849 { "lock:lock_acquired", evsel__process_lock_acquired, }, /* CONFIG_LOCKDEP, CONFIG_LOCK_STAT */
850 { "lock:lock_contended", evsel__process_lock_contended, }, /* CONFIG_LOCKDEP, CONFIG_LOCK_STAT */
851 { "lock:lock_release", evsel__process_lock_release, }, /* CONFIG_LOCKDEP */
746f16ec
ACM
852};
853
c4ac732a
YS
854static bool force;
855
375eb2be 856static int __cmd_report(bool display_info)
9b5e350c 857{
375eb2be 858 int err = -EINVAL;
c75d98af
ACM
859 struct perf_tool eops = {
860 .sample = process_sample_event,
861 .comm = perf_event__process_comm,
f3b3614a 862 .namespaces = perf_event__process_namespaces,
0a8cb85c 863 .ordered_events = true,
c75d98af 864 };
8ceb41d7 865 struct perf_data data = {
2d4f2799
JO
866 .path = input_name,
867 .mode = PERF_DATA_MODE_READ,
868 .force = force,
f5fc1412 869 };
375eb2be 870
8ceb41d7 871 session = perf_session__new(&data, false, &eops);
6ef81c55 872 if (IS_ERR(session)) {
33d6aef5 873 pr_err("Initializing perf session failed\n");
6ef81c55 874 return PTR_ERR(session);
33d6aef5 875 }
9b5e350c 876
0a7e6d1b 877 symbol__init(&session->header.env);
6fd6c6b4 878
375eb2be
DB
879 if (!perf_session__has_traces(session, "lock record"))
880 goto out_delete;
881
746f16ec
ACM
882 if (perf_session__set_tracepoints_handlers(session, lock_tracepoints)) {
883 pr_err("Initializing perf session tracepoint handlers failed\n");
375eb2be 884 goto out_delete;
746f16ec
ACM
885 }
886
375eb2be
DB
887 if (select_key())
888 goto out_delete;
9b5e350c 889
b7b61cbe 890 err = perf_session__process_events(session);
375eb2be
DB
891 if (err)
892 goto out_delete;
9b5e350c 893
9b5e350c 894 setup_pager();
375eb2be
DB
895 if (display_info) /* used for info subcommand */
896 err = dump_info();
897 else {
898 sort_result();
899 print_result();
900 }
33d6aef5 901
375eb2be
DB
902out_delete:
903 perf_session__delete(session);
904 return err;
9b5e350c
HM
905}
906
9b5e350c
HM
907static int __cmd_record(int argc, const char **argv)
908{
c75d98af 909 const char *record_args[] = {
4a4d371a 910 "record", "-R", "-m", "1024", "-c", "1",
c75d98af 911 };
0a98c7fe 912 unsigned int rec_argc, i, j, ret;
9b5e350c
HM
913 const char **rec_argv;
914
d25dcba8 915 for (i = 0; i < ARRAY_SIZE(lock_tracepoints); i++) {
746f16ec 916 if (!is_valid_tracepoint(lock_tracepoints[i].name)) {
d25dcba8
DA
917 pr_err("tracepoint %s is not enabled. "
918 "Are CONFIG_LOCKDEP and CONFIG_LOCK_STAT enabled?\n",
746f16ec 919 lock_tracepoints[i].name);
d25dcba8
DA
920 return 1;
921 }
922 }
923
9b5e350c 924 rec_argc = ARRAY_SIZE(record_args) + argc - 1;
d25dcba8
DA
925 /* factor of 2 is for -e in front of each tracepoint */
926 rec_argc += 2 * ARRAY_SIZE(lock_tracepoints);
9b5e350c 927
d25dcba8 928 rec_argv = calloc(rec_argc + 1, sizeof(char *));
0a98c7fe 929 if (!rec_argv)
ce47dc56
CS
930 return -ENOMEM;
931
9b5e350c
HM
932 for (i = 0; i < ARRAY_SIZE(record_args); i++)
933 rec_argv[i] = strdup(record_args[i]);
934
d25dcba8
DA
935 for (j = 0; j < ARRAY_SIZE(lock_tracepoints); j++) {
936 rec_argv[i++] = "-e";
746f16ec 937 rec_argv[i++] = strdup(lock_tracepoints[j].name);
d25dcba8
DA
938 }
939
9b5e350c
HM
940 for (j = 1; j < (unsigned int)argc; j++, i++)
941 rec_argv[i] = argv[j];
942
943 BUG_ON(i != rec_argc);
944
b0ad8ea6 945 ret = cmd_record(i, rec_argv);
0a98c7fe
DB
946 free(rec_argv);
947 return ret;
9b5e350c
HM
948}
949
b0ad8ea6 950int cmd_lock(int argc, const char **argv)
9b5e350c 951{
249eed53
CD
952 const struct option lock_options[] = {
953 OPT_STRING('i', "input", &input_name, "file", "input file name"),
954 OPT_INCR('v', "verbose", &verbose, "be more verbose (show symbol address, etc)"),
955 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, "dump raw trace in ASCII"),
b40e3612 956 OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
249eed53
CD
957 OPT_END()
958 };
959
c75d98af
ACM
960 const struct option info_options[] = {
961 OPT_BOOLEAN('t', "threads", &info_threads,
962 "dump thread list in perf.data"),
963 OPT_BOOLEAN('m', "map", &info_map,
964 "map of lock instances (address:name table)"),
249eed53 965 OPT_PARENT(lock_options)
c75d98af 966 };
249eed53 967
c75d98af
ACM
968 const struct option report_options[] = {
969 OPT_STRING('k', "key", &sort_key, "acquired",
f37376cd 970 "key for sorting (acquired / contended / avg_wait / wait_total / wait_max / wait_min)"),
c75d98af 971 /* TODO: type */
249eed53 972 OPT_PARENT(lock_options)
c75d98af 973 };
249eed53 974
c75d98af
ACM
975 const char * const info_usage[] = {
976 "perf lock info [<options>]",
977 NULL
978 };
a2368c31
RR
979 const char *const lock_subcommands[] = { "record", "report", "script",
980 "info", NULL };
981 const char *lock_usage[] = {
982 NULL,
c75d98af
ACM
983 NULL
984 };
985 const char * const report_usage[] = {
986 "perf lock report [<options>]",
987 NULL
988 };
9b5e350c 989 unsigned int i;
33d6aef5 990 int rc = 0;
9b5e350c 991
9b5e350c
HM
992 for (i = 0; i < LOCKHASH_SIZE; i++)
993 INIT_LIST_HEAD(lockhash_table + i);
994
a2368c31
RR
995 argc = parse_options_subcommand(argc, argv, lock_options, lock_subcommands,
996 lock_usage, PARSE_OPT_STOP_AT_NON_OPTION);
9b5e350c
HM
997 if (!argc)
998 usage_with_options(lock_usage, lock_options);
999
1000 if (!strncmp(argv[0], "rec", 3)) {
1001 return __cmd_record(argc, argv);
59f411b6
IM
1002 } else if (!strncmp(argv[0], "report", 6)) {
1003 trace_handler = &report_lock_ops;
9b5e350c
HM
1004 if (argc) {
1005 argc = parse_options(argc, argv,
59f411b6 1006 report_options, report_usage, 0);
9b5e350c 1007 if (argc)
59f411b6 1008 usage_with_options(report_usage, report_options);
9b5e350c 1009 }
375eb2be 1010 rc = __cmd_report(false);
133dc4c3
IM
1011 } else if (!strcmp(argv[0], "script")) {
1012 /* Aliased to 'perf script' */
b0ad8ea6 1013 return cmd_script(argc, argv);
26242d85
HM
1014 } else if (!strcmp(argv[0], "info")) {
1015 if (argc) {
1016 argc = parse_options(argc, argv,
1017 info_options, info_usage, 0);
1018 if (argc)
1019 usage_with_options(info_usage, info_options);
1020 }
59f411b6
IM
1021 /* recycling report_lock_ops */
1022 trace_handler = &report_lock_ops;
375eb2be 1023 rc = __cmd_report(true);
9b5e350c
HM
1024 } else {
1025 usage_with_options(lock_usage, lock_options);
1026 }
1027
33d6aef5 1028 return rc;
9b5e350c 1029}