5 #include "util/cache.h"
6 #include "util/symbol.h"
7 #include "util/thread.h"
8 #include "util/header.h"
10 #include "util/parse-options.h"
11 #include "util/trace-event.h"
13 #include "util/debug.h"
14 #include "util/session.h"
16 #include <sys/types.h>
17 #include <sys/prctl.h>
18 #include <semaphore.h>
23 #include <linux/list.h>
24 #include <linux/hash.h>
26 static struct perf_session *session;
28 /* based on kernel/lockdep.c */
29 #define LOCKHASH_BITS 12
30 #define LOCKHASH_SIZE (1UL << LOCKHASH_BITS)
32 static struct list_head lockhash_table[LOCKHASH_SIZE];
34 #define __lockhashfn(key) hash_long((unsigned long)key, LOCKHASH_BITS)
35 #define lockhashentry(key) (lockhash_table + __lockhashfn((key)))
38 struct list_head hash_entry;
39 struct rb_node rb; /* used for sorting */
42 * FIXME: raw_field_value() returns unsigned long long,
43 * so address of lockdep_map should be dealed as 64bit.
44 * Is there more better solution?
46 void *addr; /* address of lockdep_map, used as ID */
47 char *name; /* for strcpy(), we cannot use const */
49 unsigned int nr_acquire;
50 unsigned int nr_acquired;
51 unsigned int nr_contended;
52 unsigned int nr_release;
54 unsigned int nr_readlock;
55 unsigned int nr_trylock;
56 /* these times are in nano sec. */
61 int discard; /* flag of blacklist */
65 * States of lock_seq_stat
67 * UNINITIALIZED is required for detecting first event of acquire.
68 * As the nature of lock events, there is no guarantee
69 * that the first event for the locks are acquire,
70 * it can be acquired, contended or release.
72 #define SEQ_STATE_UNINITIALIZED 0 /* initial state */
73 #define SEQ_STATE_RELEASED 1
74 #define SEQ_STATE_ACQUIRING 2
75 #define SEQ_STATE_ACQUIRED 3
76 #define SEQ_STATE_READ_ACQUIRED 4
77 #define SEQ_STATE_CONTENDED 5
81 * Imported from include/linux/sched.h.
82 * Should this be synchronized?
84 #define MAX_LOCK_DEPTH 48
87 * struct lock_seq_stat:
88 * Place to put on state of one lock sequence
89 * 1) acquire -> acquired -> release
90 * 2) acquire -> contended -> acquired -> release
91 * 3) acquire (with read or try) -> release
92 * 4) Are there other patterns?
94 struct lock_seq_stat {
95 struct list_head list;
107 struct list_head seq_list;
110 static struct rb_root thread_stats;
112 static struct thread_stat *thread_stat_find(u32 tid)
114 struct rb_node *node;
115 struct thread_stat *st;
117 node = thread_stats.rb_node;
119 st = container_of(node, struct thread_stat, rb);
122 else if (tid < st->tid)
123 node = node->rb_left;
125 node = node->rb_right;
131 static void thread_stat_insert(struct thread_stat *new)
133 struct rb_node **rb = &thread_stats.rb_node;
134 struct rb_node *parent = NULL;
135 struct thread_stat *p;
138 p = container_of(*rb, struct thread_stat, rb);
141 if (new->tid < p->tid)
142 rb = &(*rb)->rb_left;
143 else if (new->tid > p->tid)
144 rb = &(*rb)->rb_right;
146 BUG_ON("inserting invalid thread_stat\n");
149 rb_link_node(&new->rb, parent, rb);
150 rb_insert_color(&new->rb, &thread_stats);
153 static struct thread_stat *thread_stat_findnew_after_first(u32 tid)
155 struct thread_stat *st;
157 st = thread_stat_find(tid);
161 st = zalloc(sizeof(struct thread_stat));
163 die("memory allocation failed\n");
166 INIT_LIST_HEAD(&st->seq_list);
168 thread_stat_insert(st);
173 static struct thread_stat *thread_stat_findnew_first(u32 tid);
174 static struct thread_stat *(*thread_stat_findnew)(u32 tid) =
175 thread_stat_findnew_first;
177 static struct thread_stat *thread_stat_findnew_first(u32 tid)
179 struct thread_stat *st;
181 st = zalloc(sizeof(struct thread_stat));
183 die("memory allocation failed\n");
185 INIT_LIST_HEAD(&st->seq_list);
187 rb_link_node(&st->rb, NULL, &thread_stats.rb_node);
188 rb_insert_color(&st->rb, &thread_stats);
190 thread_stat_findnew = thread_stat_findnew_after_first;
194 /* build simple key function one is bigger than two */
195 #define SINGLE_KEY(member) \
196 static int lock_stat_key_ ## member(struct lock_stat *one, \
197 struct lock_stat *two) \
199 return one->member > two->member; \
202 SINGLE_KEY(nr_acquired)
203 SINGLE_KEY(nr_contended)
204 SINGLE_KEY(wait_time_total)
205 SINGLE_KEY(wait_time_min)
206 SINGLE_KEY(wait_time_max)
210 * name: the value for specify by user
211 * this should be simpler than raw name of member
212 * e.g. nr_acquired -> acquired, wait_time_total -> wait_total
215 int (*key)(struct lock_stat*, struct lock_stat*);
218 static const char *sort_key = "acquired";
220 static int (*compare)(struct lock_stat *, struct lock_stat *);
222 static struct rb_root result; /* place to store sorted data */
224 #define DEF_KEY_LOCK(name, fn_suffix) \
225 { #name, lock_stat_key_ ## fn_suffix }
226 struct lock_key keys[] = {
227 DEF_KEY_LOCK(acquired, nr_acquired),
228 DEF_KEY_LOCK(contended, nr_contended),
229 DEF_KEY_LOCK(wait_total, wait_time_total),
230 DEF_KEY_LOCK(wait_min, wait_time_min),
231 DEF_KEY_LOCK(wait_max, wait_time_max),
233 /* extra comparisons much complicated should be here */
238 static void select_key(void)
242 for (i = 0; keys[i].name; i++) {
243 if (!strcmp(keys[i].name, sort_key)) {
244 compare = keys[i].key;
249 die("Unknown compare key:%s\n", sort_key);
252 static void insert_to_result(struct lock_stat *st,
253 int (*bigger)(struct lock_stat *, struct lock_stat *))
255 struct rb_node **rb = &result.rb_node;
256 struct rb_node *parent = NULL;
260 p = container_of(*rb, struct lock_stat, rb);
264 rb = &(*rb)->rb_left;
266 rb = &(*rb)->rb_right;
269 rb_link_node(&st->rb, parent, rb);
270 rb_insert_color(&st->rb, &result);
273 /* returns left most element of result, and erase it */
274 static struct lock_stat *pop_from_result(void)
276 struct rb_node *node = result.rb_node;
281 while (node->rb_left)
282 node = node->rb_left;
284 rb_erase(node, &result);
285 return container_of(node, struct lock_stat, rb);
288 static struct lock_stat *lock_stat_findnew(void *addr, const char *name)
290 struct list_head *entry = lockhashentry(addr);
291 struct lock_stat *ret, *new;
293 list_for_each_entry(ret, entry, hash_entry) {
294 if (ret->addr == addr)
298 new = zalloc(sizeof(struct lock_stat));
303 new->name = zalloc(sizeof(char) * strlen(name) + 1);
306 strcpy(new->name, name);
308 new->wait_time_min = ULLONG_MAX;
310 list_add(&new->hash_entry, entry);
314 die("memory allocation failed\n");
317 static char const *input_name = "perf.data";
319 struct raw_event_sample {
324 struct trace_acquire_event {
330 struct trace_acquired_event {
335 struct trace_contended_event {
340 struct trace_release_event {
345 struct trace_lock_handler {
346 void (*acquire_event)(struct trace_acquire_event *,
350 struct thread *thread);
352 void (*acquired_event)(struct trace_acquired_event *,
356 struct thread *thread);
358 void (*contended_event)(struct trace_contended_event *,
362 struct thread *thread);
364 void (*release_event)(struct trace_release_event *,
368 struct thread *thread);
371 static struct lock_seq_stat *get_seq(struct thread_stat *ts, void *addr)
373 struct lock_seq_stat *seq;
375 list_for_each_entry(seq, &ts->seq_list, list) {
376 if (seq->addr == addr)
380 seq = zalloc(sizeof(struct lock_seq_stat));
382 die("Not enough memory\n");
383 seq->state = SEQ_STATE_UNINITIALIZED;
386 list_add(&seq->list, &ts->seq_list);
390 static int bad_hist[4];
393 report_lock_acquire_event(struct trace_acquire_event *acquire_event,
394 struct event *__event __used,
396 u64 timestamp __used,
397 struct thread *thread __used)
399 struct lock_stat *ls;
400 struct thread_stat *ts;
401 struct lock_seq_stat *seq;
403 ls = lock_stat_findnew(acquire_event->addr, acquire_event->name);
407 ts = thread_stat_findnew(thread->pid);
408 seq = get_seq(ts, acquire_event->addr);
410 switch (seq->state) {
411 case SEQ_STATE_UNINITIALIZED:
412 case SEQ_STATE_RELEASED:
413 if (!acquire_event->flag) {
414 seq->state = SEQ_STATE_ACQUIRING;
416 if (acquire_event->flag & 1)
418 if (acquire_event->flag & 2)
420 seq->state = SEQ_STATE_READ_ACQUIRED;
425 case SEQ_STATE_READ_ACQUIRED:
426 if (acquire_event->flag & 2) {
434 case SEQ_STATE_ACQUIRED:
435 case SEQ_STATE_ACQUIRING:
436 case SEQ_STATE_CONTENDED:
438 /* broken lock sequence, discard it */
441 list_del(&seq->list);
446 BUG_ON("Unknown state of lock sequence found!\n");
451 seq->prev_event_time = timestamp;
457 report_lock_acquired_event(struct trace_acquired_event *acquired_event,
458 struct event *__event __used,
460 u64 timestamp __used,
461 struct thread *thread __used)
463 struct lock_stat *ls;
464 struct thread_stat *ts;
465 struct lock_seq_stat *seq;
468 ls = lock_stat_findnew(acquired_event->addr, acquired_event->name);
472 ts = thread_stat_findnew(thread->pid);
473 seq = get_seq(ts, acquired_event->addr);
475 switch (seq->state) {
476 case SEQ_STATE_UNINITIALIZED:
477 /* orphan event, do nothing */
479 case SEQ_STATE_ACQUIRING:
481 case SEQ_STATE_CONTENDED:
482 contended_term = timestamp - seq->prev_event_time;
483 ls->wait_time_total += contended_term;
485 if (contended_term < ls->wait_time_min)
486 ls->wait_time_min = contended_term;
487 else if (ls->wait_time_max < contended_term)
488 ls->wait_time_max = contended_term;
490 case SEQ_STATE_RELEASED:
491 case SEQ_STATE_ACQUIRED:
492 case SEQ_STATE_READ_ACQUIRED:
493 /* broken lock sequence, discard it */
496 list_del(&seq->list);
502 BUG_ON("Unknown state of lock sequence found!\n");
506 seq->state = SEQ_STATE_ACQUIRED;
508 seq->prev_event_time = timestamp;
514 report_lock_contended_event(struct trace_contended_event *contended_event,
515 struct event *__event __used,
517 u64 timestamp __used,
518 struct thread *thread __used)
520 struct lock_stat *ls;
521 struct thread_stat *ts;
522 struct lock_seq_stat *seq;
524 ls = lock_stat_findnew(contended_event->addr, contended_event->name);
528 ts = thread_stat_findnew(thread->pid);
529 seq = get_seq(ts, contended_event->addr);
531 switch (seq->state) {
532 case SEQ_STATE_UNINITIALIZED:
533 /* orphan event, do nothing */
535 case SEQ_STATE_ACQUIRING:
537 case SEQ_STATE_RELEASED:
538 case SEQ_STATE_ACQUIRED:
539 case SEQ_STATE_READ_ACQUIRED:
540 case SEQ_STATE_CONTENDED:
541 /* broken lock sequence, discard it */
544 list_del(&seq->list);
549 BUG_ON("Unknown state of lock sequence found!\n");
553 seq->state = SEQ_STATE_CONTENDED;
555 seq->prev_event_time = timestamp;
561 report_lock_release_event(struct trace_release_event *release_event,
562 struct event *__event __used,
564 u64 timestamp __used,
565 struct thread *thread __used)
567 struct lock_stat *ls;
568 struct thread_stat *ts;
569 struct lock_seq_stat *seq;
571 ls = lock_stat_findnew(release_event->addr, release_event->name);
575 ts = thread_stat_findnew(thread->pid);
576 seq = get_seq(ts, release_event->addr);
578 switch (seq->state) {
579 case SEQ_STATE_UNINITIALIZED:
582 case SEQ_STATE_ACQUIRED:
584 case SEQ_STATE_READ_ACQUIRED:
586 BUG_ON(seq->read_count < 0);
587 if (!seq->read_count) {
592 case SEQ_STATE_ACQUIRING:
593 case SEQ_STATE_CONTENDED:
594 case SEQ_STATE_RELEASED:
595 /* broken lock sequence, discard it */
601 BUG_ON("Unknown state of lock sequence found!\n");
607 list_del(&seq->list);
613 /* lock oriented handlers */
614 /* TODO: handlers for CPU oriented, thread oriented */
615 static struct trace_lock_handler report_lock_ops = {
616 .acquire_event = report_lock_acquire_event,
617 .acquired_event = report_lock_acquired_event,
618 .contended_event = report_lock_contended_event,
619 .release_event = report_lock_release_event,
622 static struct trace_lock_handler *trace_handler;
625 process_lock_acquire_event(void *data,
626 struct event *event __used,
628 u64 timestamp __used,
629 struct thread *thread __used)
631 struct trace_acquire_event acquire_event;
632 u64 tmp; /* this is required for casting... */
634 tmp = raw_field_value(event, "lockdep_addr", data);
635 memcpy(&acquire_event.addr, &tmp, sizeof(void *));
636 acquire_event.name = (char *)raw_field_ptr(event, "name", data);
637 acquire_event.flag = (int)raw_field_value(event, "flag", data);
639 if (trace_handler->acquire_event)
640 trace_handler->acquire_event(&acquire_event, event, cpu, timestamp, thread);
644 process_lock_acquired_event(void *data,
645 struct event *event __used,
647 u64 timestamp __used,
648 struct thread *thread __used)
650 struct trace_acquired_event acquired_event;
651 u64 tmp; /* this is required for casting... */
653 tmp = raw_field_value(event, "lockdep_addr", data);
654 memcpy(&acquired_event.addr, &tmp, sizeof(void *));
655 acquired_event.name = (char *)raw_field_ptr(event, "name", data);
657 if (trace_handler->acquire_event)
658 trace_handler->acquired_event(&acquired_event, event, cpu, timestamp, thread);
662 process_lock_contended_event(void *data,
663 struct event *event __used,
665 u64 timestamp __used,
666 struct thread *thread __used)
668 struct trace_contended_event contended_event;
669 u64 tmp; /* this is required for casting... */
671 tmp = raw_field_value(event, "lockdep_addr", data);
672 memcpy(&contended_event.addr, &tmp, sizeof(void *));
673 contended_event.name = (char *)raw_field_ptr(event, "name", data);
675 if (trace_handler->acquire_event)
676 trace_handler->contended_event(&contended_event, event, cpu, timestamp, thread);
680 process_lock_release_event(void *data,
681 struct event *event __used,
683 u64 timestamp __used,
684 struct thread *thread __used)
686 struct trace_release_event release_event;
687 u64 tmp; /* this is required for casting... */
689 tmp = raw_field_value(event, "lockdep_addr", data);
690 memcpy(&release_event.addr, &tmp, sizeof(void *));
691 release_event.name = (char *)raw_field_ptr(event, "name", data);
693 if (trace_handler->acquire_event)
694 trace_handler->release_event(&release_event, event, cpu, timestamp, thread);
698 process_raw_event(void *data, int cpu, u64 timestamp, struct thread *thread)
703 type = trace_parse_common_type(data);
704 event = trace_find_event(type);
706 if (!strcmp(event->name, "lock_acquire"))
707 process_lock_acquire_event(data, event, cpu, timestamp, thread);
708 if (!strcmp(event->name, "lock_acquired"))
709 process_lock_acquired_event(data, event, cpu, timestamp, thread);
710 if (!strcmp(event->name, "lock_contended"))
711 process_lock_contended_event(data, event, cpu, timestamp, thread);
712 if (!strcmp(event->name, "lock_release"))
713 process_lock_release_event(data, event, cpu, timestamp, thread);
716 /* TODO: various way to print, coloring, nano or milli sec */
717 static void print_result(void)
719 struct lock_stat *st;
723 printf("%20s ", "Name");
724 printf("%10s ", "acquired");
725 printf("%10s ", "contended");
727 printf("%15s ", "total wait (ns)");
728 printf("%15s ", "max wait (ns)");
729 printf("%15s ", "min wait (ns)");
734 while ((st = pop_from_result())) {
742 if (strlen(st->name) < 16) {
743 /* output raw name */
744 printf("%20s ", st->name);
746 strncpy(cut_name, st->name, 16);
751 /* cut off name for saving output style */
752 printf("%20s ", cut_name);
755 printf("%10u ", st->nr_acquired);
756 printf("%10u ", st->nr_contended);
758 printf("%15llu ", st->wait_time_total);
759 printf("%15llu ", st->wait_time_max);
760 printf("%15llu ", st->wait_time_min == ULLONG_MAX ?
761 0 : st->wait_time_min);
766 /* Output for debug, this have to be removed */
768 const char *name[4] =
769 { "acquire", "acquired", "contended", "release" };
771 printf("\n=== output for debug===\n\n");
772 printf("bad:%d, total:%d\n", bad, total);
773 printf("bad rate:%f\n", (double)(bad / total));
775 printf("histogram of events caused bad sequence\n");
776 for (i = 0; i < 4; i++)
777 printf(" %10s: %d\n", name[i], bad_hist[i]);
781 static void dump_map(void)
784 struct lock_stat *st;
786 for (i = 0; i < LOCKHASH_SIZE; i++) {
787 list_for_each_entry(st, &lockhash_table[i], hash_entry) {
788 printf("%p: %s\n", st->addr, st->name);
793 static int process_sample_event(event_t *self, struct perf_session *s)
795 struct sample_data data;
796 struct thread *thread;
798 bzero(&data, sizeof(data));
799 event__parse_sample(self, s->sample_type, &data);
801 thread = perf_session__findnew(s, data.tid);
802 if (thread == NULL) {
803 pr_debug("problem processing %d event, skipping it.\n",
808 process_raw_event(data.raw_data, data.cpu, data.time, thread);
813 static struct perf_event_ops eops = {
814 .sample = process_sample_event,
815 .comm = event__process_comm,
816 .ordered_samples = true,
819 static int read_events(void)
821 session = perf_session__new(input_name, O_RDONLY, 0);
823 die("Initializing perf session failed\n");
825 return perf_session__process_events(session, &eops);
828 static void sort_result(void)
831 struct lock_stat *st;
833 for (i = 0; i < LOCKHASH_SIZE; i++) {
834 list_for_each_entry(st, &lockhash_table[i], hash_entry) {
835 insert_to_result(st, compare);
840 static void __cmd_report(void)
849 static const char * const report_usage[] = {
850 "perf lock report [<options>]",
854 static const struct option report_options[] = {
855 OPT_STRING('k', "key", &sort_key, "acquired",
861 static const char * const lock_usage[] = {
862 "perf lock [<options>] {record|trace|report}",
866 static const struct option lock_options[] = {
867 OPT_STRING('i', "input", &input_name, "file", "input file name"),
868 OPT_INCR('v', "verbose", &verbose, "be more verbose (show symbol address, etc)"),
869 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, "dump raw trace in ASCII"),
873 static const char *record_args[] = {
880 "-e", "lock:lock_acquire:r",
881 "-e", "lock:lock_acquired:r",
882 "-e", "lock:lock_contended:r",
883 "-e", "lock:lock_release:r",
886 static int __cmd_record(int argc, const char **argv)
888 unsigned int rec_argc, i, j;
889 const char **rec_argv;
891 rec_argc = ARRAY_SIZE(record_args) + argc - 1;
892 rec_argv = calloc(rec_argc + 1, sizeof(char *));
894 for (i = 0; i < ARRAY_SIZE(record_args); i++)
895 rec_argv[i] = strdup(record_args[i]);
897 for (j = 1; j < (unsigned int)argc; j++, i++)
898 rec_argv[i] = argv[j];
900 BUG_ON(i != rec_argc);
902 return cmd_record(i, rec_argv, NULL);
905 int cmd_lock(int argc, const char **argv, const char *prefix __used)
910 for (i = 0; i < LOCKHASH_SIZE; i++)
911 INIT_LIST_HEAD(lockhash_table + i);
913 argc = parse_options(argc, argv, lock_options, lock_usage,
914 PARSE_OPT_STOP_AT_NON_OPTION);
916 usage_with_options(lock_usage, lock_options);
918 if (!strncmp(argv[0], "rec", 3)) {
919 return __cmd_record(argc, argv);
920 } else if (!strncmp(argv[0], "report", 6)) {
921 trace_handler = &report_lock_ops;
923 argc = parse_options(argc, argv,
924 report_options, report_usage, 0);
926 usage_with_options(report_usage, report_options);
929 } else if (!strcmp(argv[0], "trace")) {
930 /* Aliased to 'perf trace' */
931 return cmd_trace(argc, argv, prefix);
932 } else if (!strcmp(argv[0], "map")) {
933 /* recycling report_lock_ops */
934 trace_handler = &report_lock_ops;
939 usage_with_options(lock_usage, lock_options);