1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2012 The Chromium OS Authors.
10 #include <asm/global_data.h>
12 #include <asm/sections.h>
14 DECLARE_GLOBAL_DATA_PTR;
16 static char trace_enabled __section(".data");
17 static char trace_inited __section(".data");
19 /* The header block at the start of the trace memory area */
21 int func_count; /* Total number of function call sites */
22 u64 call_count; /* Total number of tracked function calls */
23 u64 untracked_count; /* Total number of untracked function calls */
24 int funcs_used; /* Total number of functions used */
27 * Call count for each function. This is indexed by the word offset
28 * of the function from gd->relocaddr
30 uintptr_t *call_accum;
32 /* Function trace list */
33 struct trace_call *ftrace; /* The function call records */
34 ulong ftrace_size; /* Num. of ftrace records we have space for */
35 ulong ftrace_count; /* Num. of ftrace records written */
36 ulong ftrace_too_deep_count; /* Functions that were too deep */
43 /* Pointer to start of trace buffer */
44 static struct trace_hdr *hdr __section(".data");
46 static inline uintptr_t __attribute__((no_instrument_function))
47 func_ptr_to_num(void *func_ptr)
49 uintptr_t offset = (uintptr_t)func_ptr;
52 offset -= (uintptr_t)&_init;
54 if (gd->flags & GD_FLG_RELOC)
55 offset -= gd->relocaddr;
57 offset -= CONFIG_TEXT_BASE;
59 return offset / FUNC_SITE_SIZE;
62 #if defined(CONFIG_EFI_LOADER) && (defined(CONFIG_ARM) || defined(CONFIG_RISCV))
65 * trace_gd - the value of the gd register
67 static volatile gd_t *trace_gd;
70 * trace_save_gd() - save the value of the gd register
72 static void notrace trace_save_gd(void)
78 * trace_swap_gd() - swap between U-Boot and application gd register value
80 * An UEFI application may change the value of the register that gd lives in.
81 * But some of our functions like get_ticks() access this register. So we
82 * have to set the gd register to the U-Boot value when entering a trace
83 * point and set it back to the application value when exiting the trace point.
85 static void notrace trace_swap_gd(void)
87 volatile gd_t *temp_gd = trace_gd;
95 static void notrace trace_save_gd(void)
99 static void notrace trace_swap_gd(void)
105 static void notrace add_ftrace(void *func_ptr, void *caller, ulong flags)
107 if (hdr->depth > hdr->depth_limit) {
108 hdr->ftrace_too_deep_count++;
111 if (hdr->ftrace_count < hdr->ftrace_size) {
112 struct trace_call *rec = &hdr->ftrace[hdr->ftrace_count];
114 rec->func = func_ptr_to_num(func_ptr);
115 rec->caller = func_ptr_to_num(caller);
116 rec->flags = flags | (timer_get_us() & FUNCF_TIMESTAMP_MASK);
121 static void notrace add_textbase(void)
123 if (hdr->ftrace_count < hdr->ftrace_size) {
124 struct trace_call *rec = &hdr->ftrace[hdr->ftrace_count];
126 rec->func = CONFIG_TEXT_BASE;
128 rec->flags = FUNCF_TEXTBASE;
134 * __cyg_profile_func_enter() - record function entry
136 * We add to our tally for this function and add to the list of called
139 * @func_ptr: pointer to function being entered
140 * @caller: pointer to function which called this function
142 void notrace __cyg_profile_func_enter(void *func_ptr, void *caller)
148 add_ftrace(func_ptr, caller, FUNCF_ENTRY);
149 func = func_ptr_to_num(func_ptr);
150 if (func < hdr->func_count) {
151 hdr->call_accum[func]++;
154 hdr->untracked_count++;
157 if (hdr->depth > hdr->depth_limit)
158 hdr->max_depth = hdr->depth;
164 * __cyg_profile_func_exit() - record function exit
166 * @func_ptr: pointer to function being entered
167 * @caller: pointer to function which called this function
169 void notrace __cyg_profile_func_exit(void *func_ptr, void *caller)
173 add_ftrace(func_ptr, caller, FUNCF_EXIT);
180 * trace_list_functions() - produce a list of called functions
182 * The information is written into the supplied buffer - a header followed
183 * by a list of function records.
185 * @buff: buffer to place list into
186 * @buff_size: size of buffer
187 * @needed: returns size of buffer needed, which may be
188 * greater than buff_size if we ran out of space.
189 * Return: 0 if ok, -ENOSPC if space was exhausted
191 int trace_list_functions(void *buff, size_t buff_size, size_t *needed)
193 struct trace_output_hdr *output_hdr = NULL;
194 void *end, *ptr = buff;
198 end = buff ? buff + buff_size : NULL;
200 /* Place some header information */
201 if (ptr + sizeof(struct trace_output_hdr) < end)
203 ptr += sizeof(struct trace_output_hdr);
205 /* Add information about each function */
206 for (func = upto = 0; func < hdr->func_count; func++) {
207 size_t calls = hdr->call_accum[func];
212 if (ptr + sizeof(struct trace_output_func) < end) {
213 struct trace_output_func *stats = ptr;
215 stats->offset = func * FUNC_SITE_SIZE;
216 stats->call_count = calls;
219 ptr += sizeof(struct trace_output_func);
222 /* Update the header */
224 output_hdr->rec_count = upto;
225 output_hdr->type = TRACE_CHUNK_FUNCS;
228 /* Work out how must of the buffer we used */
229 *needed = ptr - buff;
237 * trace_list_functions() - produce a list of function calls
239 * The information is written into the supplied buffer - a header followed
240 * by a list of function records.
242 * @buff: buffer to place list into
243 * @buff_size: size of buffer
244 * @needed: returns size of buffer needed, which may be
245 * greater than buff_size if we ran out of space.
246 * Return: 0 if ok, -ENOSPC if space was exhausted
248 int trace_list_calls(void *buff, size_t buff_size, size_t *needed)
250 struct trace_output_hdr *output_hdr = NULL;
251 void *end, *ptr = buff;
255 end = buff ? buff + buff_size : NULL;
257 /* Place some header information */
258 if (ptr + sizeof(struct trace_output_hdr) < end)
260 ptr += sizeof(struct trace_output_hdr);
262 /* Add information about each call */
263 count = hdr->ftrace_count;
264 if (count > hdr->ftrace_size)
265 count = hdr->ftrace_size;
266 for (rec = upto = 0; rec < count; rec++) {
267 if (ptr + sizeof(struct trace_call) < end) {
268 struct trace_call *call = &hdr->ftrace[rec];
269 struct trace_call *out = ptr;
271 out->func = call->func * FUNC_SITE_SIZE;
272 out->caller = call->caller * FUNC_SITE_SIZE;
273 out->flags = call->flags;
276 ptr += sizeof(struct trace_call);
279 /* Update the header */
281 output_hdr->rec_count = upto;
282 output_hdr->type = TRACE_CHUNK_CALLS;
285 /* Work out how must of the buffer we used */
286 *needed = ptr - buff;
294 * trace_print_stats() - print basic information about tracing
296 void trace_print_stats(void)
301 puts("Warning: make U-Boot with FTRACE to enable function instrumenting.\n");
302 puts("You will likely get zeroed data here\n");
305 printf("Trace is disabled\n");
308 print_grouped_ull(hdr->func_count, 10);
309 puts(" function sites\n");
310 print_grouped_ull(hdr->call_count, 10);
311 puts(" function calls\n");
312 print_grouped_ull(hdr->untracked_count, 10);
313 puts(" untracked function calls\n");
314 count = min(hdr->ftrace_count, hdr->ftrace_size);
315 print_grouped_ull(count, 10);
316 puts(" traced function calls");
317 if (hdr->ftrace_count > hdr->ftrace_size) {
318 printf(" (%lu dropped due to overflow)",
319 hdr->ftrace_count - hdr->ftrace_size);
322 printf("%15d maximum observed call depth\n", hdr->max_depth);
323 printf("%15d call depth limit\n", hdr->depth_limit);
324 print_grouped_ull(hdr->ftrace_too_deep_count, 10);
325 puts(" calls not traced due to depth\n");
328 void notrace trace_set_enabled(int enabled)
330 trace_enabled = enabled != 0;
334 * trace_init() - initialize the tracing system and enable it
336 * @buff: Pointer to trace buffer
337 * @buff_size: Size of trace buffer
340 int notrace trace_init(void *buff, size_t buff_size)
342 ulong func_count = gd->mon_len / FUNC_SITE_SIZE;
344 int was_disabled = !trace_enabled;
349 #ifdef CONFIG_TRACE_EARLY
354 * Copy over the early trace data if we have it. Disable
355 * tracing while we are doing this.
358 hdr = map_sysmem(CONFIG_TRACE_EARLY_ADDR,
359 CONFIG_TRACE_EARLY_SIZE);
360 end = (char *)&hdr->ftrace[min(hdr->ftrace_count,
362 used = end - (char *)hdr;
363 printf("trace: copying %08lx bytes of early data from %x to %08lx\n",
364 used, CONFIG_TRACE_EARLY_ADDR,
365 (ulong)map_to_sysmem(buff));
366 memcpy(buff, hdr, used);
368 puts("trace: already enabled\n");
372 hdr = (struct trace_hdr *)buff;
373 needed = sizeof(*hdr) + func_count * sizeof(uintptr_t);
374 if (needed > buff_size) {
375 printf("trace: buffer size %zd bytes: at least %zd needed\n",
381 memset(hdr, '\0', needed);
382 hdr->func_count = func_count;
383 hdr->call_accum = (uintptr_t *)(hdr + 1);
385 /* Use any remaining space for the timed function trace */
386 hdr->ftrace = (struct trace_call *)(buff + needed);
387 hdr->ftrace_size = (buff_size - needed) / sizeof(*hdr->ftrace);
390 puts("trace: enabled\n");
391 hdr->depth_limit = CONFIG_TRACE_CALL_DEPTH_LIMIT;
398 #ifdef CONFIG_TRACE_EARLY
400 * trace_early_init() - initialize the tracing system for early tracing
402 * Return: 0 if ok, -ENOSPC if not enough memory is available
404 int notrace trace_early_init(void)
406 ulong func_count = gd->mon_len / FUNC_SITE_SIZE;
407 size_t buff_size = CONFIG_TRACE_EARLY_SIZE;
410 /* We can ignore additional calls to this function */
414 hdr = map_sysmem(CONFIG_TRACE_EARLY_ADDR, CONFIG_TRACE_EARLY_SIZE);
415 needed = sizeof(*hdr) + func_count * sizeof(uintptr_t);
416 if (needed > buff_size) {
417 printf("trace: buffer size is %zd bytes, at least %zd needed\n",
422 memset(hdr, '\0', needed);
423 hdr->call_accum = (uintptr_t *)(hdr + 1);
424 hdr->func_count = func_count;
426 /* Use any remaining space for the timed function trace */
427 hdr->ftrace = (struct trace_call *)((char *)hdr + needed);
428 hdr->ftrace_size = (buff_size - needed) / sizeof(*hdr->ftrace);
430 hdr->depth_limit = CONFIG_TRACE_EARLY_CALL_DEPTH_LIMIT;
431 printf("trace: early enable at %08x\n", CONFIG_TRACE_EARLY_ADDR);