Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/*
2 * thread-stack.h: Synthesize a thread's stack using call / return events
3 * Copyright (c) 2014, Intel Corporation.
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
13 *
14 */
15
16#ifndef __PERF_THREAD_STACK_H
17#define __PERF_THREAD_STACK_H
18
19#include <sys/types.h>
20
21#include <linux/types.h>
22
23struct thread;
24struct comm;
25struct ip_callchain;
26struct symbol;
27struct dso;
28struct comm;
29struct perf_sample;
30struct addr_location;
31struct call_path;
32
33/*
34 * Call/Return flags.
35 *
36 * CALL_RETURN_NO_CALL: 'return' but no matching 'call'
37 * CALL_RETURN_NO_RETURN: 'call' but no matching 'return'
38 * CALL_RETURN_NON_CALL: a branch but not a 'call' to the start of a different
39 * symbol
40 */
41enum {
42 CALL_RETURN_NO_CALL = 1 << 0,
43 CALL_RETURN_NO_RETURN = 1 << 1,
44 CALL_RETURN_NON_CALL = 1 << 2,
45};
46
47/**
48 * struct call_return - paired call/return information.
49 * @thread: thread in which call/return occurred
50 * @comm: comm in which call/return occurred
51 * @cp: call path
52 * @call_time: timestamp of call (if known)
53 * @return_time: timestamp of return (if known)
54 * @branch_count: number of branches seen between call and return
55 * @call_ref: external reference to 'call' sample (e.g. db_id)
56 * @return_ref: external reference to 'return' sample (e.g. db_id)
57 * @db_id: id used for db-export
58 * @parent_db_id: id of parent call used for db-export
59 * @flags: Call/Return flags
60 */
61struct call_return {
62 struct thread *thread;
63 struct comm *comm;
64 struct call_path *cp;
65 u64 call_time;
66 u64 return_time;
67 u64 branch_count;
68 u64 call_ref;
69 u64 return_ref;
70 u64 db_id;
71 u64 parent_db_id;
72 u32 flags;
73};
74
75/**
76 * struct call_return_processor - provides a call-back to consume call-return
77 * information.
78 * @cpr: call path root
79 * @process: call-back that accepts call/return information
80 * @data: anonymous data for call-back
81 */
82struct call_return_processor {
83 struct call_path_root *cpr;
84 int (*process)(struct call_return *cr, u64 *parent_db_id, void *data);
85 void *data;
86};
87
88int thread_stack__event(struct thread *thread, int cpu, u32 flags, u64 from_ip,
89 u64 to_ip, u16 insn_len, u64 trace_nr);
90void thread_stack__set_trace_nr(struct thread *thread, int cpu, u64 trace_nr);
91void thread_stack__sample(struct thread *thread, int cpu, struct ip_callchain *chain,
92 size_t sz, u64 ip, u64 kernel_start);
93int thread_stack__flush(struct thread *thread);
94void thread_stack__free(struct thread *thread);
95size_t thread_stack__depth(struct thread *thread, int cpu);
96
97struct call_return_processor *
98call_return_processor__new(int (*process)(struct call_return *cr, u64 *parent_db_id, void *data),
99 void *data);
100void call_return_processor__free(struct call_return_processor *crp);
101int thread_stack__process(struct thread *thread, struct comm *comm,
102 struct perf_sample *sample,
103 struct addr_location *from_al,
104 struct addr_location *to_al, u64 ref,
105 struct call_return_processor *crp);
106
107#endif