blob: b3cd09beb62f0ba45cc5e788fa3249bbc17c233b [file] [log] [blame]
Thomas Gleixner2025cf92019-05-29 07:18:02 -07001/* SPDX-License-Identifier: GPL-2.0-only */
Adrian Hunter00447cc2014-10-30 16:09:42 +02002/*
3 * thread-stack.h: Synthesize a thread's stack using call / return events
4 * Copyright (c) 2014, Intel Corporation.
Adrian Hunter00447cc2014-10-30 16:09:42 +02005 */
6
7#ifndef __PERF_THREAD_STACK_H
8#define __PERF_THREAD_STACK_H
9
10#include <sys/types.h>
11
12#include <linux/types.h>
13
14struct thread;
Adrian Hunter92a9e4f2014-10-30 16:09:45 +020015struct comm;
Adrian Hunter00447cc2014-10-30 16:09:42 +020016struct ip_callchain;
Adrian Hunter92a9e4f2014-10-30 16:09:45 +020017struct symbol;
18struct dso;
Adrian Hunter92a9e4f2014-10-30 16:09:45 +020019struct perf_sample;
20struct addr_location;
Chris Phlipot451db122016-04-28 01:19:07 -070021struct call_path;
Adrian Hunter92a9e4f2014-10-30 16:09:45 +020022
23/*
24 * Call/Return flags.
25 *
26 * CALL_RETURN_NO_CALL: 'return' but no matching 'call'
27 * CALL_RETURN_NO_RETURN: 'call' but no matching 'return'
Adrian Hunterf08046c2019-01-09 11:18:33 +020028 * CALL_RETURN_NON_CALL: a branch but not a 'call' to the start of a different
29 * symbol
Adrian Hunter92a9e4f2014-10-30 16:09:45 +020030 */
31enum {
32 CALL_RETURN_NO_CALL = 1 << 0,
33 CALL_RETURN_NO_RETURN = 1 << 1,
Adrian Hunterf08046c2019-01-09 11:18:33 +020034 CALL_RETURN_NON_CALL = 1 << 2,
Adrian Hunter92a9e4f2014-10-30 16:09:45 +020035};
36
37/**
38 * struct call_return - paired call/return information.
39 * @thread: thread in which call/return occurred
40 * @comm: comm in which call/return occurred
41 * @cp: call path
42 * @call_time: timestamp of call (if known)
43 * @return_time: timestamp of return (if known)
44 * @branch_count: number of branches seen between call and return
Adrian Hunter003ccdc2019-05-20 14:37:19 +030045 * @insn_count: approx. number of instructions between call and return
46 * @cyc_count: approx. number of cycles between call and return
Adrian Hunter92a9e4f2014-10-30 16:09:45 +020047 * @call_ref: external reference to 'call' sample (e.g. db_id)
48 * @return_ref: external reference to 'return' sample (e.g. db_id)
49 * @db_id: id used for db-export
Adrian Hunterf4358872019-02-28 15:00:24 +020050 * @parent_db_id: id of parent call used for db-export
Adrian Hunter92a9e4f2014-10-30 16:09:45 +020051 * @flags: Call/Return flags
52 */
53struct call_return {
54 struct thread *thread;
55 struct comm *comm;
56 struct call_path *cp;
57 u64 call_time;
58 u64 return_time;
59 u64 branch_count;
Adrian Hunter003ccdc2019-05-20 14:37:19 +030060 u64 insn_count;
61 u64 cyc_count;
Adrian Hunter92a9e4f2014-10-30 16:09:45 +020062 u64 call_ref;
63 u64 return_ref;
64 u64 db_id;
Adrian Hunterf4358872019-02-28 15:00:24 +020065 u64 parent_db_id;
Adrian Hunter92a9e4f2014-10-30 16:09:45 +020066 u32 flags;
67};
68
Chris Phlipot2c15f5e2016-04-28 01:19:10 -070069/**
70 * struct call_return_processor - provides a call-back to consume call-return
71 * information.
72 * @cpr: call path root
73 * @process: call-back that accepts call/return information
74 * @data: anonymous data for call-back
75 */
76struct call_return_processor {
77 struct call_path_root *cpr;
Adrian Hunterf4358872019-02-28 15:00:24 +020078 int (*process)(struct call_return *cr, u64 *parent_db_id, void *data);
Chris Phlipot2c15f5e2016-04-28 01:19:10 -070079 void *data;
80};
81
Adrian Hunter256d92b2018-12-21 14:06:19 +020082int thread_stack__event(struct thread *thread, int cpu, u32 flags, u64 from_ip,
Adrian Hunter86d67182020-04-29 18:07:43 +030083 u64 to_ip, u16 insn_len, u64 trace_nr, bool callstack,
84 unsigned int br_stack_sz, bool mispred_all);
Adrian Hunter256d92b2018-12-21 14:06:19 +020085void thread_stack__set_trace_nr(struct thread *thread, int cpu, u64 trace_nr);
86void thread_stack__sample(struct thread *thread, int cpu, struct ip_callchain *chain,
Adrian Hunter24248302018-10-31 11:10:42 +020087 size_t sz, u64 ip, u64 kernel_start);
Adrian Hunter4fef41b2020-04-01 13:16:06 +030088void thread_stack__sample_late(struct thread *thread, int cpu,
89 struct ip_callchain *chain, size_t sz, u64 ip,
90 u64 kernel_start);
Adrian Hunter86d67182020-04-29 18:07:43 +030091void thread_stack__br_sample(struct thread *thread, int cpu,
92 struct branch_stack *dst, unsigned int sz);
Adrian Hunter3749e0b2020-04-29 18:07:48 +030093void thread_stack__br_sample_late(struct thread *thread, int cpu,
94 struct branch_stack *dst, unsigned int sz,
95 u64 sample_ip, u64 kernel_start);
Adrian Huntera5499b32015-05-29 16:33:30 +030096int thread_stack__flush(struct thread *thread);
Adrian Hunter00447cc2014-10-30 16:09:42 +020097void thread_stack__free(struct thread *thread);
Adrian Hunter256d92b2018-12-21 14:06:19 +020098size_t thread_stack__depth(struct thread *thread, int cpu);
Adrian Hunter00447cc2014-10-30 16:09:42 +020099
Adrian Hunter92a9e4f2014-10-30 16:09:45 +0200100struct call_return_processor *
Adrian Hunterf4358872019-02-28 15:00:24 +0200101call_return_processor__new(int (*process)(struct call_return *cr, u64 *parent_db_id, void *data),
Adrian Hunter92a9e4f2014-10-30 16:09:45 +0200102 void *data);
103void call_return_processor__free(struct call_return_processor *crp);
104int thread_stack__process(struct thread *thread, struct comm *comm,
105 struct perf_sample *sample,
106 struct addr_location *from_al,
107 struct addr_location *to_al, u64 ref,
108 struct call_return_processor *crp);
109
Adrian Hunter00447cc2014-10-30 16:09:42 +0200110#endif