Commit | Line | Data |
---|---|---|
9f36eaed MJ |
1 | /* SPDX-License-Identifier: (GPL-2.0 or LGPL-2.1) |
2 | * | |
2fa2d39a FG |
3 | * lttng-context-callstack.c |
4 | * | |
5 | * LTTng callstack event context. | |
6 | * | |
7 | * Copyright (C) 2014 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
8 | * Copyright (C) 2014 Francis Giraldeau <francis.giraldeau@gmail.com> | |
9 | * | |
0bb47c89 MD |
10 | * The callstack context can be added to any kernel event. It records |
11 | * either the kernel or the userspace callstack, up to a max depth. The | |
12 | * context is a CTF sequence, such that it uses only the space required | |
13 | * for the number of callstack entries. | |
2fa2d39a | 14 | * |
0bb47c89 MD |
15 | * It allocates callstack buffers per-CPU up to 4 interrupt nesting. |
16 | * This nesting limit is the same as defined in the ring buffer. It | |
17 | * therefore uses a fixed amount of memory, proportional to the number | |
18 | * of CPUs: | |
2fa2d39a FG |
19 | * |
20 | * size = cpus * nest * depth * sizeof(unsigned long) | |
21 | * | |
3685cc80 | 22 | * Which is 4096 bytes per CPU on 64-bit host and a depth of 128. |
0bb47c89 MD |
23 | * The allocation is done at the initialization to avoid memory |
24 | * allocation overhead while tracing, using a shallow stack. | |
2fa2d39a FG |
25 | * |
26 | * The kernel callstack is recovered using save_stack_trace(), and the | |
27 | * userspace callstack uses save_stack_trace_user(). They rely on frame | |
0bb47c89 MD |
28 | * pointers. These are usually available for the kernel, but the |
29 | * compiler option -fomit-frame-pointer frequently used in popular Linux | |
30 | * distributions may cause the userspace callstack to be unreliable, and | |
31 | * is a known limitation of this approach. If frame pointers are not | |
32 | * available, it produces no error, but the callstack will be empty. We | |
33 | * still provide the feature, because it works well for runtime | |
34 | * environments having frame pointers. In the future, unwind support | |
35 | * and/or last branch record may provide a solution to this problem. | |
2fa2d39a FG |
36 | * |
37 | * The symbol name resolution is left to the trace reader. | |
38 | */ | |
39 | ||
40 | #include <linux/module.h> | |
41 | #include <linux/slab.h> | |
42 | #include <linux/sched.h> | |
43 | #include <linux/utsname.h> | |
44 | #include <linux/stacktrace.h> | |
45 | #include <linux/spinlock.h> | |
46 | #include "lttng-events.h" | |
47 | #include "wrapper/ringbuffer/backend.h" | |
48 | #include "wrapper/ringbuffer/frontend.h" | |
49 | #include "wrapper/vmalloc.h" | |
50 | #include "lttng-tracer.h" | |
51 | ||
7bc5af6c | 52 | #include "lttng-context-callstack-legacy-impl.h" |
2fa2d39a FG |
53 | |
54 | static | |
55 | void field_data_free(struct field_data *fdata) | |
56 | { | |
2fa2d39a FG |
57 | if (!fdata) |
58 | return; | |
2fa2d39a FG |
59 | free_percpu(fdata->cs_percpu); |
60 | kfree(fdata); | |
61 | } | |
62 | ||
63 | static | |
0bb47c89 | 64 | struct field_data __percpu *field_data_create(enum lttng_cs_ctx_modes mode) |
2fa2d39a | 65 | { |
2fa2d39a | 66 | struct lttng_cs __percpu *cs_set; |
64cc198b | 67 | struct field_data *fdata; |
2fa2d39a | 68 | |
64cc198b | 69 | fdata = kzalloc(sizeof(*fdata), GFP_KERNEL); |
2fa2d39a FG |
70 | if (!fdata) |
71 | return NULL; | |
72 | cs_set = alloc_percpu(struct lttng_cs); | |
73 | if (!cs_set) | |
74 | goto error_alloc; | |
36b21795 | 75 | lttng_cs_set_init(cs_set); |
2fa2d39a | 76 | fdata->cs_percpu = cs_set; |
0bb47c89 | 77 | fdata->mode = mode; |
2fa2d39a FG |
78 | return fdata; |
79 | ||
80 | error_alloc: | |
81 | field_data_free(fdata); | |
82 | return NULL; | |
83 | } | |
84 | ||
85 | static | |
86 | void lttng_callstack_destroy(struct lttng_ctx_field *field) | |
87 | { | |
3c1a57e8 | 88 | struct field_data *fdata = field->priv; |
2fa2d39a FG |
89 | |
90 | field_data_free(fdata); | |
91 | } | |
92 | ||
93 | static | |
0bb47c89 MD |
94 | int __lttng_add_callstack_generic(struct lttng_ctx **ctx, |
95 | enum lttng_cs_ctx_modes mode) | |
2fa2d39a | 96 | { |
36b21795 | 97 | const char *ctx_name = lttng_cs_ctx_mode_name(mode); |
2fa2d39a FG |
98 | struct lttng_ctx_field *field; |
99 | struct field_data *fdata; | |
100 | int ret; | |
101 | ||
102 | ret = init_type(mode); | |
103 | if (ret) | |
104 | return ret; | |
105 | field = lttng_append_context(ctx); | |
106 | if (!field) | |
107 | return -ENOMEM; | |
108 | if (lttng_find_context(*ctx, ctx_name)) { | |
2fa2d39a FG |
109 | ret = -EEXIST; |
110 | goto error_find; | |
111 | } | |
64cc198b | 112 | fdata = field_data_create(mode); |
2fa2d39a FG |
113 | if (!fdata) { |
114 | ret = -ENOMEM; | |
115 | goto error_create; | |
116 | } | |
117 | ||
118 | field->event_field.name = ctx_name; | |
119 | field->event_field.type.atype = atype_sequence; | |
120 | field->event_field.type.u.sequence.elem_type.atype = atype_integer; | |
121 | field->event_field.type.u.sequence.elem_type.u.basic.integer.size = sizeof(unsigned long) * CHAR_BIT; | |
122 | field->event_field.type.u.sequence.elem_type.u.basic.integer.alignment = lttng_alignof(long) * CHAR_BIT; | |
123 | field->event_field.type.u.sequence.elem_type.u.basic.integer.signedness = lttng_is_signed_type(unsigned long); | |
124 | field->event_field.type.u.sequence.elem_type.u.basic.integer.reverse_byte_order = 0; | |
125 | field->event_field.type.u.sequence.elem_type.u.basic.integer.base = 16; | |
126 | field->event_field.type.u.sequence.elem_type.u.basic.integer.encoding = lttng_encode_none; | |
127 | ||
128 | field->event_field.type.u.sequence.length_type.atype = atype_integer; | |
129 | field->event_field.type.u.sequence.length_type.u.basic.integer.size = sizeof(unsigned int) * CHAR_BIT; | |
130 | field->event_field.type.u.sequence.length_type.u.basic.integer.alignment = lttng_alignof(unsigned int) * CHAR_BIT; | |
131 | field->event_field.type.u.sequence.length_type.u.basic.integer.signedness = lttng_is_signed_type(unsigned int); | |
132 | field->event_field.type.u.sequence.length_type.u.basic.integer.reverse_byte_order = 0; | |
133 | field->event_field.type.u.sequence.length_type.u.basic.integer.base = 10; | |
134 | field->event_field.type.u.sequence.length_type.u.basic.integer.encoding = lttng_encode_none; | |
135 | ||
136 | field->get_size_arg = lttng_callstack_get_size; | |
137 | field->record = lttng_callstack_record; | |
3c1a57e8 | 138 | field->priv = fdata; |
2fa2d39a FG |
139 | field->destroy = lttng_callstack_destroy; |
140 | wrapper_vmalloc_sync_all(); | |
2fa2d39a FG |
141 | return 0; |
142 | ||
143 | error_create: | |
144 | field_data_free(fdata); | |
145 | error_find: | |
146 | lttng_remove_context_field(ctx, field); | |
147 | return ret; | |
148 | } | |
149 | ||
150 | /** | |
151 | * lttng_add_callstack_to_ctx - add callstack event context | |
152 | * | |
153 | * @ctx: the lttng_ctx pointer to initialize | |
154 | * @type: the context type | |
155 | * | |
156 | * Supported callstack type supported: | |
157 | * LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL | |
158 | * Records the callstack of the kernel | |
159 | * LTTNG_KERNEL_CONTEXT_CALLSTACK_USER | |
160 | * Records the callstack of the userspace program (from the kernel) | |
161 | * | |
162 | * Return 0 for success, or error code. | |
163 | */ | |
164 | int lttng_add_callstack_to_ctx(struct lttng_ctx **ctx, int type) | |
165 | { | |
166 | switch (type) { | |
167 | case LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL: | |
168 | return __lttng_add_callstack_generic(ctx, CALLSTACK_KERNEL); | |
b874d3f3 | 169 | #ifdef CONFIG_X86 |
2fa2d39a FG |
170 | case LTTNG_KERNEL_CONTEXT_CALLSTACK_USER: |
171 | return __lttng_add_callstack_generic(ctx, CALLSTACK_USER); | |
b874d3f3 | 172 | #endif |
2fa2d39a FG |
173 | default: |
174 | return -EINVAL; | |
175 | } | |
176 | } | |
177 | EXPORT_SYMBOL_GPL(lttng_add_callstack_to_ctx); |