Linux Audio

Check our new training course

Loading...
v6.13.7
   1// SPDX-License-Identifier: GPL-2.0
   2/*
   3 * ring buffer based function tracer
   4 *
   5 * Copyright (C) 2007-2008 Steven Rostedt <srostedt@redhat.com>
   6 * Copyright (C) 2008 Ingo Molnar <mingo@redhat.com>
   7 *
   8 * Based on code from the latency_tracer, that is:
   9 *
  10 *  Copyright (C) 2004-2006 Ingo Molnar
  11 *  Copyright (C) 2004 Nadia Yvette Chambers
  12 */
  13#include <linux/ring_buffer.h>
  14#include <linux/debugfs.h>
  15#include <linux/uaccess.h>
  16#include <linux/ftrace.h>
  17#include <linux/slab.h>
  18#include <linux/fs.h>
  19
  20#include "trace.h"
  21
  22static void tracing_start_function_trace(struct trace_array *tr);
  23static void tracing_stop_function_trace(struct trace_array *tr);
  24static void
  25function_trace_call(unsigned long ip, unsigned long parent_ip,
  26		    struct ftrace_ops *op, struct ftrace_regs *fregs);
  27static void
  28function_stack_trace_call(unsigned long ip, unsigned long parent_ip,
  29			  struct ftrace_ops *op, struct ftrace_regs *fregs);
  30static void
  31function_no_repeats_trace_call(unsigned long ip, unsigned long parent_ip,
  32			       struct ftrace_ops *op, struct ftrace_regs *fregs);
  33static void
  34function_stack_no_repeats_trace_call(unsigned long ip, unsigned long parent_ip,
  35				     struct ftrace_ops *op,
  36				     struct ftrace_regs *fregs);
  37static struct tracer_flags func_flags;
  38
  39/* Our option */
  40enum {
  41
  42	TRACE_FUNC_NO_OPTS		= 0x0, /* No flags set. */
  43	TRACE_FUNC_OPT_STACK		= 0x1,
  44	TRACE_FUNC_OPT_NO_REPEATS	= 0x2,
  45
  46	/* Update this to next highest bit. */
  47	TRACE_FUNC_OPT_HIGHEST_BIT	= 0x4
  48};
  49
  50#define TRACE_FUNC_OPT_MASK	(TRACE_FUNC_OPT_HIGHEST_BIT - 1)
  51
  52int ftrace_allocate_ftrace_ops(struct trace_array *tr)
  53{
  54	struct ftrace_ops *ops;
  55
  56	/* The top level array uses the "global_ops" */
  57	if (tr->flags & TRACE_ARRAY_FL_GLOBAL)
  58		return 0;
  59
  60	ops = kzalloc(sizeof(*ops), GFP_KERNEL);
  61	if (!ops)
  62		return -ENOMEM;
  63
  64	/* Currently only the non stack version is supported */
  65	ops->func = function_trace_call;
  66	ops->flags = FTRACE_OPS_FL_PID;
  67
  68	tr->ops = ops;
  69	ops->private = tr;
  70
  71	return 0;
  72}
  73
  74void ftrace_free_ftrace_ops(struct trace_array *tr)
  75{
  76	kfree(tr->ops);
  77	tr->ops = NULL;
  78}
  79
  80int ftrace_create_function_files(struct trace_array *tr,
  81				 struct dentry *parent)
  82{
  83	int ret;
  84	/*
  85	 * The top level array uses the "global_ops", and the files are
  86	 * created on boot up.
  87	 */
  88	if (tr->flags & TRACE_ARRAY_FL_GLOBAL)
  89		return 0;
  90
  91	if (!tr->ops)
  92		return -EINVAL;
  93
  94	ret = allocate_fgraph_ops(tr, tr->ops);
  95	if (ret) {
  96		kfree(tr->ops);
  97		return ret;
  98	}
  99
 100	ftrace_create_filter_files(tr->ops, parent);
 101
 102	return 0;
 103}
 104
 105void ftrace_destroy_function_files(struct trace_array *tr)
 106{
 107	ftrace_destroy_filter_files(tr->ops);
 108	ftrace_free_ftrace_ops(tr);
 109	free_fgraph_ops(tr);
 110}
 111
 112static ftrace_func_t select_trace_function(u32 flags_val)
 113{
 114	switch (flags_val & TRACE_FUNC_OPT_MASK) {
 115	case TRACE_FUNC_NO_OPTS:
 116		return function_trace_call;
 117	case TRACE_FUNC_OPT_STACK:
 118		return function_stack_trace_call;
 119	case TRACE_FUNC_OPT_NO_REPEATS:
 120		return function_no_repeats_trace_call;
 121	case TRACE_FUNC_OPT_STACK | TRACE_FUNC_OPT_NO_REPEATS:
 122		return function_stack_no_repeats_trace_call;
 123	default:
 124		return NULL;
 125	}
 126}
 127
 128static bool handle_func_repeats(struct trace_array *tr, u32 flags_val)
 129{
 130	if (!tr->last_func_repeats &&
 131	    (flags_val & TRACE_FUNC_OPT_NO_REPEATS)) {
 132		tr->last_func_repeats = alloc_percpu(struct trace_func_repeats);
 133		if (!tr->last_func_repeats)
 134			return false;
 135	}
 136
 137	return true;
 138}
 139
 140static int function_trace_init(struct trace_array *tr)
 141{
 142	ftrace_func_t func;
 143	/*
 144	 * Instance trace_arrays get their ops allocated
 145	 * at instance creation. Unless it failed
 146	 * the allocation.
 147	 */
 148	if (!tr->ops)
 149		return -ENOMEM;
 150
 151	func = select_trace_function(func_flags.val);
 152	if (!func)
 153		return -EINVAL;
 154
 155	if (!handle_func_repeats(tr, func_flags.val))
 156		return -ENOMEM;
 157
 158	ftrace_init_array_ops(tr, func);
 159
 160	tr->array_buffer.cpu = raw_smp_processor_id();
 161
 162	tracing_start_cmdline_record();
 163	tracing_start_function_trace(tr);
 164	return 0;
 165}
 166
 167static void function_trace_reset(struct trace_array *tr)
 168{
 169	tracing_stop_function_trace(tr);
 170	tracing_stop_cmdline_record();
 171	ftrace_reset_array_ops(tr);
 172}
 173
 174static void function_trace_start(struct trace_array *tr)
 175{
 176	tracing_reset_online_cpus(&tr->array_buffer);
 177}
 178
 179/* fregs are guaranteed not to be NULL if HAVE_DYNAMIC_FTRACE_WITH_ARGS is set */
 180#if defined(CONFIG_FUNCTION_GRAPH_TRACER) && defined(CONFIG_HAVE_DYNAMIC_FTRACE_WITH_ARGS)
 181static __always_inline unsigned long
 182function_get_true_parent_ip(unsigned long parent_ip, struct ftrace_regs *fregs)
 183{
 184	unsigned long true_parent_ip;
 185	int idx = 0;
 186
 187	true_parent_ip = parent_ip;
 188	if (unlikely(parent_ip == (unsigned long)&return_to_handler) && fregs)
 189		true_parent_ip = ftrace_graph_ret_addr(current, &idx, parent_ip,
 190				(unsigned long *)ftrace_regs_get_stack_pointer(fregs));
 191	return true_parent_ip;
 192}
 193#else
 194static __always_inline unsigned long
 195function_get_true_parent_ip(unsigned long parent_ip, struct ftrace_regs *fregs)
 196{
 197	return parent_ip;
 198}
 199#endif
 200
 201static void
 202function_trace_call(unsigned long ip, unsigned long parent_ip,
 203		    struct ftrace_ops *op, struct ftrace_regs *fregs)
 204{
 205	struct trace_array *tr = op->private;
 206	struct trace_array_cpu *data;
 207	unsigned int trace_ctx;
 208	int bit;
 209
 210	if (unlikely(!tr->function_enabled))
 211		return;
 212
 213	bit = ftrace_test_recursion_trylock(ip, parent_ip);
 214	if (bit < 0)
 215		return;
 216
 217	parent_ip = function_get_true_parent_ip(parent_ip, fregs);
 218
 219	trace_ctx = tracing_gen_ctx_dec();
 
 
 
 220
 221	data = this_cpu_ptr(tr->array_buffer.data);
 222	if (!atomic_read(&data->disabled))
 223		trace_function(tr, ip, parent_ip, trace_ctx);
 224
 225	ftrace_test_recursion_unlock(bit);
 
 226}
 227
 228#ifdef CONFIG_UNWINDER_ORC
 229/*
 230 * Skip 2:
 231 *
 232 *   function_stack_trace_call()
 233 *   ftrace_call()
 234 */
 235#define STACK_SKIP 2
 236#else
 237/*
 238 * Skip 3:
 239 *   __trace_stack()
 240 *   function_stack_trace_call()
 241 *   ftrace_call()
 242 */
 243#define STACK_SKIP 3
 244#endif
 245
 246static void
 247function_stack_trace_call(unsigned long ip, unsigned long parent_ip,
 248			  struct ftrace_ops *op, struct ftrace_regs *fregs)
 249{
 250	struct trace_array *tr = op->private;
 251	struct trace_array_cpu *data;
 252	unsigned long flags;
 253	long disabled;
 254	int cpu;
 255	unsigned int trace_ctx;
 256	int skip = STACK_SKIP;
 257
 258	if (unlikely(!tr->function_enabled))
 259		return;
 260
 261	/*
 262	 * Need to use raw, since this must be called before the
 263	 * recursive protection is performed.
 264	 */
 265	local_irq_save(flags);
 266	parent_ip = function_get_true_parent_ip(parent_ip, fregs);
 267	cpu = raw_smp_processor_id();
 268	data = per_cpu_ptr(tr->array_buffer.data, cpu);
 269	disabled = atomic_inc_return(&data->disabled);
 270
 271	if (likely(disabled == 1)) {
 272		trace_ctx = tracing_gen_ctx_flags(flags);
 273		trace_function(tr, ip, parent_ip, trace_ctx);
 274#ifdef CONFIG_UNWINDER_FRAME_POINTER
 275		if (ftrace_pids_enabled(op))
 276			skip++;
 277#endif
 278		__trace_stack(tr, trace_ctx, skip);
 279	}
 280
 281	atomic_dec(&data->disabled);
 282	local_irq_restore(flags);
 283}
 284
 285static inline bool is_repeat_check(struct trace_array *tr,
 286				   struct trace_func_repeats *last_info,
 287				   unsigned long ip, unsigned long parent_ip)
 288{
 289	if (last_info->ip == ip &&
 290	    last_info->parent_ip == parent_ip &&
 291	    last_info->count < U16_MAX) {
 292		last_info->ts_last_call =
 293			ring_buffer_time_stamp(tr->array_buffer.buffer);
 294		last_info->count++;
 295		return true;
 296	}
 297
 298	return false;
 299}
 300
 301static inline void process_repeats(struct trace_array *tr,
 302				   unsigned long ip, unsigned long parent_ip,
 303				   struct trace_func_repeats *last_info,
 304				   unsigned int trace_ctx)
 305{
 306	if (last_info->count) {
 307		trace_last_func_repeats(tr, last_info, trace_ctx);
 308		last_info->count = 0;
 309	}
 310
 311	last_info->ip = ip;
 312	last_info->parent_ip = parent_ip;
 313}
 314
 315static void
 316function_no_repeats_trace_call(unsigned long ip, unsigned long parent_ip,
 317			       struct ftrace_ops *op,
 318			       struct ftrace_regs *fregs)
 319{
 320	struct trace_func_repeats *last_info;
 321	struct trace_array *tr = op->private;
 322	struct trace_array_cpu *data;
 323	unsigned int trace_ctx;
 324	int bit;
 325
 326	if (unlikely(!tr->function_enabled))
 327		return;
 328
 329	bit = ftrace_test_recursion_trylock(ip, parent_ip);
 330	if (bit < 0)
 331		return;
 332
 333	parent_ip = function_get_true_parent_ip(parent_ip, fregs);
 334	data = this_cpu_ptr(tr->array_buffer.data);
 335	if (atomic_read(&data->disabled))
 336		goto out;
 337
 338	/*
 339	 * An interrupt may happen at any place here. But as far as I can see,
 340	 * the only damage that this can cause is to mess up the repetition
 341	 * counter without valuable data being lost.
 342	 * TODO: think about a solution that is better than just hoping to be
 343	 * lucky.
 344	 */
 345	last_info = this_cpu_ptr(tr->last_func_repeats);
 346	if (is_repeat_check(tr, last_info, ip, parent_ip))
 347		goto out;
 348
 349	trace_ctx = tracing_gen_ctx_dec();
 350	process_repeats(tr, ip, parent_ip, last_info, trace_ctx);
 351
 352	trace_function(tr, ip, parent_ip, trace_ctx);
 353
 354out:
 355	ftrace_test_recursion_unlock(bit);
 356}
 357
 358static void
 359function_stack_no_repeats_trace_call(unsigned long ip, unsigned long parent_ip,
 360				     struct ftrace_ops *op,
 361				     struct ftrace_regs *fregs)
 362{
 363	struct trace_func_repeats *last_info;
 364	struct trace_array *tr = op->private;
 365	struct trace_array_cpu *data;
 366	unsigned long flags;
 367	long disabled;
 368	int cpu;
 369	unsigned int trace_ctx;
 370
 371	if (unlikely(!tr->function_enabled))
 372		return;
 373
 374	/*
 375	 * Need to use raw, since this must be called before the
 376	 * recursive protection is performed.
 377	 */
 378	local_irq_save(flags);
 379	parent_ip = function_get_true_parent_ip(parent_ip, fregs);
 380	cpu = raw_smp_processor_id();
 381	data = per_cpu_ptr(tr->array_buffer.data, cpu);
 382	disabled = atomic_inc_return(&data->disabled);
 383
 384	if (likely(disabled == 1)) {
 385		last_info = per_cpu_ptr(tr->last_func_repeats, cpu);
 386		if (is_repeat_check(tr, last_info, ip, parent_ip))
 387			goto out;
 388
 389		trace_ctx = tracing_gen_ctx_flags(flags);
 390		process_repeats(tr, ip, parent_ip, last_info, trace_ctx);
 391
 392		trace_function(tr, ip, parent_ip, trace_ctx);
 393		__trace_stack(tr, trace_ctx, STACK_SKIP);
 
 
 394	}
 395
 396 out:
 397	atomic_dec(&data->disabled);
 398	local_irq_restore(flags);
 399}
 400
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 401static struct tracer_opt func_opts[] = {
 402#ifdef CONFIG_STACKTRACE
 403	{ TRACER_OPT(func_stack_trace, TRACE_FUNC_OPT_STACK) },
 404#endif
 405	{ TRACER_OPT(func-no-repeats, TRACE_FUNC_OPT_NO_REPEATS) },
 406	{ } /* Always set a last empty entry */
 407};
 408
 409static struct tracer_flags func_flags = {
 410	.val = TRACE_FUNC_NO_OPTS, /* By default: all flags disabled */
 411	.opts = func_opts
 412};
 413
 414static void tracing_start_function_trace(struct trace_array *tr)
 415{
 416	tr->function_enabled = 0;
 417	register_ftrace_function(tr->ops);
 418	tr->function_enabled = 1;
 419}
 420
 421static void tracing_stop_function_trace(struct trace_array *tr)
 422{
 423	tr->function_enabled = 0;
 424	unregister_ftrace_function(tr->ops);
 425}
 426
 427static struct tracer function_trace;
 
 
 
 428
 429static int
 430func_set_flag(struct trace_array *tr, u32 old_flags, u32 bit, int set)
 
 
 431{
 432	ftrace_func_t func;
 433	u32 new_flags;
 434
 435	/* Do nothing if already set. */
 436	if (!!set == !!(func_flags.val & bit))
 437		return 0;
 
 
 438
 439	/* We can change this flag only when not running. */
 440	if (tr->current_trace != &function_trace)
 441		return 0;
 
 
 
 442
 443	new_flags = (func_flags.val & ~bit) | (set ? bit : 0);
 444	func = select_trace_function(new_flags);
 445	if (!func)
 446		return -EINVAL;
 
 
 
 447
 448	/* Check if there's anything to change. */
 449	if (tr->ops->func == func)
 450		return 0;
 
 451
 452	if (!handle_func_repeats(tr, new_flags))
 453		return -ENOMEM;
 454
 455	unregister_ftrace_function(tr->ops);
 456	tr->ops->func = func;
 457	register_ftrace_function(tr->ops);
 458
 459	return 0;
 460}
 461
 462static struct tracer function_trace __tracer_data =
 463{
 464	.name		= "function",
 465	.init		= function_trace_init,
 466	.reset		= function_trace_reset,
 467	.start		= function_trace_start,
 
 468	.flags		= &func_flags,
 469	.set_flag	= func_set_flag,
 470	.allow_instances = true,
 471#ifdef CONFIG_FTRACE_SELFTEST
 472	.selftest	= trace_selftest_startup_function,
 473#endif
 474};
 475
 476#ifdef CONFIG_DYNAMIC_FTRACE
 477static void update_traceon_count(struct ftrace_probe_ops *ops,
 478				 unsigned long ip,
 479				 struct trace_array *tr, bool on,
 480				 void *data)
 481{
 482	struct ftrace_func_mapper *mapper = data;
 483	long *count;
 484	long old_count;
 485
 486	/*
 487	 * Tracing gets disabled (or enabled) once per count.
 488	 * This function can be called at the same time on multiple CPUs.
 489	 * It is fine if both disable (or enable) tracing, as disabling
 490	 * (or enabling) the second time doesn't do anything as the
 491	 * state of the tracer is already disabled (or enabled).
 492	 * What needs to be synchronized in this case is that the count
 493	 * only gets decremented once, even if the tracer is disabled
 494	 * (or enabled) twice, as the second one is really a nop.
 495	 *
 496	 * The memory barriers guarantee that we only decrement the
 497	 * counter once. First the count is read to a local variable
 498	 * and a read barrier is used to make sure that it is loaded
 499	 * before checking if the tracer is in the state we want.
 500	 * If the tracer is not in the state we want, then the count
 501	 * is guaranteed to be the old count.
 502	 *
 503	 * Next the tracer is set to the state we want (disabled or enabled)
 504	 * then a write memory barrier is used to make sure that
 505	 * the new state is visible before changing the counter by
 506	 * one minus the old counter. This guarantees that another CPU
 507	 * executing this code will see the new state before seeing
 508	 * the new counter value, and would not do anything if the new
 509	 * counter is seen.
 510	 *
 511	 * Note, there is no synchronization between this and a user
 512	 * setting the tracing_on file. But we currently don't care
 513	 * about that.
 514	 */
 515	count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
 516	old_count = *count;
 517
 518	if (old_count <= 0)
 519		return;
 520
 521	/* Make sure we see count before checking tracing state */
 522	smp_rmb();
 523
 524	if (on == !!tracer_tracing_is_on(tr))
 525		return;
 526
 527	if (on)
 528		tracer_tracing_on(tr);
 529	else
 530		tracer_tracing_off(tr);
 531
 532	/* Make sure tracing state is visible before updating count */
 533	smp_wmb();
 534
 535	*count = old_count - 1;
 536}
 537
 538static void
 539ftrace_traceon_count(unsigned long ip, unsigned long parent_ip,
 540		     struct trace_array *tr, struct ftrace_probe_ops *ops,
 541		     void *data)
 542{
 543	update_traceon_count(ops, ip, tr, 1, data);
 544}
 545
 546static void
 547ftrace_traceoff_count(unsigned long ip, unsigned long parent_ip,
 548		      struct trace_array *tr, struct ftrace_probe_ops *ops,
 549		      void *data)
 550{
 551	update_traceon_count(ops, ip, tr, 0, data);
 552}
 553
 554static void
 555ftrace_traceon(unsigned long ip, unsigned long parent_ip,
 556	       struct trace_array *tr, struct ftrace_probe_ops *ops,
 557	       void *data)
 558{
 559	if (tracer_tracing_is_on(tr))
 560		return;
 561
 562	tracer_tracing_on(tr);
 563}
 564
 565static void
 566ftrace_traceoff(unsigned long ip, unsigned long parent_ip,
 567		struct trace_array *tr, struct ftrace_probe_ops *ops,
 568		void *data)
 569{
 570	if (!tracer_tracing_is_on(tr))
 571		return;
 572
 573	tracer_tracing_off(tr);
 574}
 575
 576#ifdef CONFIG_UNWINDER_ORC
 577/*
 578 * Skip 3:
 579 *
 580 *   function_trace_probe_call()
 581 *   ftrace_ops_assist_func()
 582 *   ftrace_call()
 583 */
 584#define FTRACE_STACK_SKIP 3
 585#else
 586/*
 587 * Skip 5:
 588 *
 589 *   __trace_stack()
 590 *   ftrace_stacktrace()
 591 *   function_trace_probe_call()
 592 *   ftrace_ops_assist_func()
 593 *   ftrace_call()
 594 */
 595#define FTRACE_STACK_SKIP 5
 596#endif
 597
 598static __always_inline void trace_stack(struct trace_array *tr)
 599{
 600	unsigned int trace_ctx;
 601
 602	trace_ctx = tracing_gen_ctx();
 603
 604	__trace_stack(tr, trace_ctx, FTRACE_STACK_SKIP);
 605}
 606
 607static void
 608ftrace_stacktrace(unsigned long ip, unsigned long parent_ip,
 609		  struct trace_array *tr, struct ftrace_probe_ops *ops,
 610		  void *data)
 611{
 612	trace_stack(tr);
 613}
 614
 615static void
 616ftrace_stacktrace_count(unsigned long ip, unsigned long parent_ip,
 617			struct trace_array *tr, struct ftrace_probe_ops *ops,
 618			void *data)
 619{
 620	struct ftrace_func_mapper *mapper = data;
 621	long *count;
 622	long old_count;
 623	long new_count;
 624
 625	if (!tracing_is_on())
 626		return;
 627
 628	/* unlimited? */
 629	if (!mapper) {
 630		trace_stack(tr);
 631		return;
 632	}
 633
 634	count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
 635
 636	/*
 637	 * Stack traces should only execute the number of times the
 638	 * user specified in the counter.
 639	 */
 640	do {
 641		old_count = *count;
 642
 643		if (!old_count)
 644			return;
 645
 646		new_count = old_count - 1;
 647		new_count = cmpxchg(count, old_count, new_count);
 648		if (new_count == old_count)
 649			trace_stack(tr);
 650
 651		if (!tracing_is_on())
 652			return;
 653
 654	} while (new_count != old_count);
 655}
 656
 657static int update_count(struct ftrace_probe_ops *ops, unsigned long ip,
 658			void *data)
 659{
 660	struct ftrace_func_mapper *mapper = data;
 661	long *count = NULL;
 662
 663	if (mapper)
 664		count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
 665
 666	if (count) {
 667		if (*count <= 0)
 668			return 0;
 669		(*count)--;
 670	}
 671
 672	return 1;
 673}
 674
 675static void
 676ftrace_dump_probe(unsigned long ip, unsigned long parent_ip,
 677		  struct trace_array *tr, struct ftrace_probe_ops *ops,
 678		  void *data)
 679{
 680	if (update_count(ops, ip, data))
 681		ftrace_dump(DUMP_ALL);
 682}
 683
 684/* Only dump the current CPU buffer. */
 685static void
 686ftrace_cpudump_probe(unsigned long ip, unsigned long parent_ip,
 687		     struct trace_array *tr, struct ftrace_probe_ops *ops,
 688		     void *data)
 689{
 690	if (update_count(ops, ip, data))
 691		ftrace_dump(DUMP_ORIG);
 692}
 693
 694static int
 695ftrace_probe_print(const char *name, struct seq_file *m,
 696		   unsigned long ip, struct ftrace_probe_ops *ops,
 697		   void *data)
 698{
 699	struct ftrace_func_mapper *mapper = data;
 700	long *count = NULL;
 701
 702	seq_printf(m, "%ps:%s", (void *)ip, name);
 703
 704	if (mapper)
 705		count = (long *)ftrace_func_mapper_find_ip(mapper, ip);
 
 
 706
 707	if (count)
 708		seq_printf(m, ":count=%ld\n", *count);
 709	else
 710		seq_puts(m, ":unlimited\n");
 711
 712	return 0;
 713}
 714
 715static int
 716ftrace_traceon_print(struct seq_file *m, unsigned long ip,
 717		     struct ftrace_probe_ops *ops,
 718		     void *data)
 719{
 720	return ftrace_probe_print("traceon", m, ip, ops, data);
 721}
 722
 723static int
 724ftrace_traceoff_print(struct seq_file *m, unsigned long ip,
 725			 struct ftrace_probe_ops *ops, void *data)
 726{
 727	return ftrace_probe_print("traceoff", m, ip, ops, data);
 728}
 729
 730static int
 731ftrace_stacktrace_print(struct seq_file *m, unsigned long ip,
 732			struct ftrace_probe_ops *ops, void *data)
 733{
 734	return ftrace_probe_print("stacktrace", m, ip, ops, data);
 735}
 736
 737static int
 738ftrace_dump_print(struct seq_file *m, unsigned long ip,
 739			struct ftrace_probe_ops *ops, void *data)
 740{
 741	return ftrace_probe_print("dump", m, ip, ops, data);
 742}
 743
 744static int
 745ftrace_cpudump_print(struct seq_file *m, unsigned long ip,
 746			struct ftrace_probe_ops *ops, void *data)
 747{
 748	return ftrace_probe_print("cpudump", m, ip, ops, data);
 749}
 750
 751
 752static int
 753ftrace_count_init(struct ftrace_probe_ops *ops, struct trace_array *tr,
 754		  unsigned long ip, void *init_data, void **data)
 755{
 756	struct ftrace_func_mapper *mapper = *data;
 757
 758	if (!mapper) {
 759		mapper = allocate_ftrace_func_mapper();
 760		if (!mapper)
 761			return -ENOMEM;
 762		*data = mapper;
 763	}
 764
 765	return ftrace_func_mapper_add_ip(mapper, ip, init_data);
 766}
 767
 768static void
 769ftrace_count_free(struct ftrace_probe_ops *ops, struct trace_array *tr,
 770		  unsigned long ip, void *data)
 771{
 772	struct ftrace_func_mapper *mapper = data;
 773
 774	if (!ip) {
 775		free_ftrace_func_mapper(mapper, NULL);
 776		return;
 777	}
 778
 779	ftrace_func_mapper_remove_ip(mapper, ip);
 780}
 781
 782static struct ftrace_probe_ops traceon_count_probe_ops = {
 783	.func			= ftrace_traceon_count,
 784	.print			= ftrace_traceon_print,
 785	.init			= ftrace_count_init,
 786	.free			= ftrace_count_free,
 787};
 788
 789static struct ftrace_probe_ops traceoff_count_probe_ops = {
 790	.func			= ftrace_traceoff_count,
 791	.print			= ftrace_traceoff_print,
 792	.init			= ftrace_count_init,
 793	.free			= ftrace_count_free,
 794};
 795
 796static struct ftrace_probe_ops stacktrace_count_probe_ops = {
 797	.func			= ftrace_stacktrace_count,
 798	.print			= ftrace_stacktrace_print,
 799	.init			= ftrace_count_init,
 800	.free			= ftrace_count_free,
 801};
 802
 803static struct ftrace_probe_ops dump_probe_ops = {
 804	.func			= ftrace_dump_probe,
 805	.print			= ftrace_dump_print,
 806	.init			= ftrace_count_init,
 807	.free			= ftrace_count_free,
 808};
 809
 810static struct ftrace_probe_ops cpudump_probe_ops = {
 811	.func			= ftrace_cpudump_probe,
 812	.print			= ftrace_cpudump_print,
 813};
 814
 815static struct ftrace_probe_ops traceon_probe_ops = {
 816	.func			= ftrace_traceon,
 817	.print			= ftrace_traceon_print,
 818};
 819
 820static struct ftrace_probe_ops traceoff_probe_ops = {
 821	.func			= ftrace_traceoff,
 822	.print			= ftrace_traceoff_print,
 823};
 824
 825static struct ftrace_probe_ops stacktrace_probe_ops = {
 826	.func			= ftrace_stacktrace,
 827	.print			= ftrace_stacktrace_print,
 828};
 829
 830static int
 831ftrace_trace_probe_callback(struct trace_array *tr,
 832			    struct ftrace_probe_ops *ops,
 833			    struct ftrace_hash *hash, char *glob,
 834			    char *cmd, char *param, int enable)
 835{
 
 836	void *count = (void *)-1;
 837	char *number;
 838	int ret;
 839
 840	/* hash funcs only work with set_ftrace_filter */
 841	if (!enable)
 842		return -EINVAL;
 843
 844	if (glob[0] == '!')
 845		return unregister_ftrace_function_probe_func(glob+1, tr, ops);
 
 
 
 
 
 
 846
 847	if (!param)
 848		goto out_reg;
 849
 850	number = strsep(&param, ":");
 851
 852	if (!strlen(number))
 853		goto out_reg;
 854
 855	/*
 856	 * We use the callback data field (which is a pointer)
 857	 * as our counter.
 858	 */
 859	ret = kstrtoul(number, 0, (unsigned long *)&count);
 860	if (ret)
 861		return ret;
 862
 863 out_reg:
 864	ret = register_ftrace_function_probe(glob, tr, ops, count);
 865
 866	return ret < 0 ? ret : 0;
 867}
 868
 869static int
 870ftrace_trace_onoff_callback(struct trace_array *tr, struct ftrace_hash *hash,
 871			    char *glob, char *cmd, char *param, int enable)
 872{
 873	struct ftrace_probe_ops *ops;
 874
 875	if (!tr)
 876		return -ENODEV;
 877
 878	/* we register both traceon and traceoff to this callback */
 879	if (strcmp(cmd, "traceon") == 0)
 880		ops = param ? &traceon_count_probe_ops : &traceon_probe_ops;
 881	else
 882		ops = param ? &traceoff_count_probe_ops : &traceoff_probe_ops;
 883
 884	return ftrace_trace_probe_callback(tr, ops, hash, glob, cmd,
 885					   param, enable);
 886}
 887
 888static int
 889ftrace_stacktrace_callback(struct trace_array *tr, struct ftrace_hash *hash,
 890			   char *glob, char *cmd, char *param, int enable)
 891{
 892	struct ftrace_probe_ops *ops;
 893
 894	if (!tr)
 895		return -ENODEV;
 896
 897	ops = param ? &stacktrace_count_probe_ops : &stacktrace_probe_ops;
 898
 899	return ftrace_trace_probe_callback(tr, ops, hash, glob, cmd,
 900					   param, enable);
 901}
 902
 903static int
 904ftrace_dump_callback(struct trace_array *tr, struct ftrace_hash *hash,
 905			   char *glob, char *cmd, char *param, int enable)
 906{
 907	struct ftrace_probe_ops *ops;
 908
 909	if (!tr)
 910		return -ENODEV;
 911
 912	ops = &dump_probe_ops;
 913
 914	/* Only dump once. */
 915	return ftrace_trace_probe_callback(tr, ops, hash, glob, cmd,
 916					   "1", enable);
 917}
 918
 919static int
 920ftrace_cpudump_callback(struct trace_array *tr, struct ftrace_hash *hash,
 921			   char *glob, char *cmd, char *param, int enable)
 922{
 923	struct ftrace_probe_ops *ops;
 924
 925	if (!tr)
 926		return -ENODEV;
 927
 928	ops = &cpudump_probe_ops;
 929
 930	/* Only dump once. */
 931	return ftrace_trace_probe_callback(tr, ops, hash, glob, cmd,
 932					   "1", enable);
 933}
 934
 935static struct ftrace_func_command ftrace_traceon_cmd = {
 936	.name			= "traceon",
 937	.func			= ftrace_trace_onoff_callback,
 938};
 939
 940static struct ftrace_func_command ftrace_traceoff_cmd = {
 941	.name			= "traceoff",
 942	.func			= ftrace_trace_onoff_callback,
 943};
 944
 945static struct ftrace_func_command ftrace_stacktrace_cmd = {
 946	.name			= "stacktrace",
 947	.func			= ftrace_stacktrace_callback,
 948};
 949
 950static struct ftrace_func_command ftrace_dump_cmd = {
 951	.name			= "dump",
 952	.func			= ftrace_dump_callback,
 953};
 954
 955static struct ftrace_func_command ftrace_cpudump_cmd = {
 956	.name			= "cpudump",
 957	.func			= ftrace_cpudump_callback,
 958};
 959
 960static int __init init_func_cmd_traceon(void)
 961{
 962	int ret;
 963
 964	ret = register_ftrace_command(&ftrace_traceoff_cmd);
 965	if (ret)
 966		return ret;
 967
 968	ret = register_ftrace_command(&ftrace_traceon_cmd);
 969	if (ret)
 970		goto out_free_traceoff;
 971
 972	ret = register_ftrace_command(&ftrace_stacktrace_cmd);
 973	if (ret)
 974		goto out_free_traceon;
 975
 976	ret = register_ftrace_command(&ftrace_dump_cmd);
 977	if (ret)
 978		goto out_free_stacktrace;
 979
 980	ret = register_ftrace_command(&ftrace_cpudump_cmd);
 981	if (ret)
 982		goto out_free_dump;
 983
 984	return 0;
 985
 986 out_free_dump:
 987	unregister_ftrace_command(&ftrace_dump_cmd);
 988 out_free_stacktrace:
 989	unregister_ftrace_command(&ftrace_stacktrace_cmd);
 990 out_free_traceon:
 991	unregister_ftrace_command(&ftrace_traceon_cmd);
 992 out_free_traceoff:
 993	unregister_ftrace_command(&ftrace_traceoff_cmd);
 994
 995	return ret;
 996}
 997#else
 998static inline int init_func_cmd_traceon(void)
 999{
1000	return 0;
1001}
1002#endif /* CONFIG_DYNAMIC_FTRACE */
1003
1004__init int init_function_trace(void)
1005{
1006	init_func_cmd_traceon();
1007	return register_tracer(&function_trace);
1008}
v3.1
 
  1/*
  2 * ring buffer based function tracer
  3 *
  4 * Copyright (C) 2007-2008 Steven Rostedt <srostedt@redhat.com>
  5 * Copyright (C) 2008 Ingo Molnar <mingo@redhat.com>
  6 *
  7 * Based on code from the latency_tracer, that is:
  8 *
  9 *  Copyright (C) 2004-2006 Ingo Molnar
 10 *  Copyright (C) 2004 William Lee Irwin III
 11 */
 12#include <linux/ring_buffer.h>
 13#include <linux/debugfs.h>
 14#include <linux/uaccess.h>
 15#include <linux/ftrace.h>
 
 16#include <linux/fs.h>
 17
 18#include "trace.h"
 19
 20/* function tracing enabled */
 21static int			ftrace_function_enabled;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 22
 23static struct trace_array	*func_trace;
 
 
 
 
 
 
 
 24
 25static void tracing_start_function_trace(void);
 26static void tracing_stop_function_trace(void);
 27
 28static int function_trace_init(struct trace_array *tr)
 29{
 30	func_trace = tr;
 31	tr->cpu = get_cpu();
 32	put_cpu();
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 33
 34	tracing_start_cmdline_record();
 35	tracing_start_function_trace();
 36	return 0;
 37}
 38
 39static void function_trace_reset(struct trace_array *tr)
 40{
 41	tracing_stop_function_trace();
 42	tracing_stop_cmdline_record();
 
 43}
 44
 45static void function_trace_start(struct trace_array *tr)
 46{
 47	tracing_reset_online_cpus(tr);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 48}
 
 49
 50static void
 51function_trace_call_preempt_only(unsigned long ip, unsigned long parent_ip)
 
 52{
 53	struct trace_array *tr = func_trace;
 54	struct trace_array_cpu *data;
 55	unsigned long flags;
 56	long disabled;
 57	int cpu;
 58	int pc;
 
 59
 60	if (unlikely(!ftrace_function_enabled))
 
 61		return;
 62
 63	pc = preempt_count();
 64	preempt_disable_notrace();
 65	local_save_flags(flags);
 66	cpu = raw_smp_processor_id();
 67	data = tr->data[cpu];
 68	disabled = atomic_inc_return(&data->disabled);
 69
 70	if (likely(disabled == 1))
 71		trace_function(tr, ip, parent_ip, flags, pc);
 
 72
 73	atomic_dec(&data->disabled);
 74	preempt_enable_notrace();
 75}
 76
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 77static void
 78function_trace_call(unsigned long ip, unsigned long parent_ip)
 
 79{
 80	struct trace_array *tr = func_trace;
 81	struct trace_array_cpu *data;
 82	unsigned long flags;
 83	long disabled;
 84	int cpu;
 85	int pc;
 
 86
 87	if (unlikely(!ftrace_function_enabled))
 88		return;
 89
 90	/*
 91	 * Need to use raw, since this must be called before the
 92	 * recursive protection is performed.
 93	 */
 94	local_irq_save(flags);
 
 95	cpu = raw_smp_processor_id();
 96	data = tr->data[cpu];
 97	disabled = atomic_inc_return(&data->disabled);
 98
 99	if (likely(disabled == 1)) {
100		pc = preempt_count();
101		trace_function(tr, ip, parent_ip, flags, pc);
 
 
 
 
 
102	}
103
104	atomic_dec(&data->disabled);
105	local_irq_restore(flags);
106}
107
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
108static void
109function_stack_trace_call(unsigned long ip, unsigned long parent_ip)
 
 
110{
111	struct trace_array *tr = func_trace;
 
112	struct trace_array_cpu *data;
113	unsigned long flags;
114	long disabled;
115	int cpu;
116	int pc;
117
118	if (unlikely(!ftrace_function_enabled))
119		return;
120
121	/*
122	 * Need to use raw, since this must be called before the
123	 * recursive protection is performed.
124	 */
125	local_irq_save(flags);
 
126	cpu = raw_smp_processor_id();
127	data = tr->data[cpu];
128	disabled = atomic_inc_return(&data->disabled);
129
130	if (likely(disabled == 1)) {
131		pc = preempt_count();
132		trace_function(tr, ip, parent_ip, flags, pc);
133		/*
134		 * skip over 5 funcs:
135		 *    __ftrace_trace_stack,
136		 *    __trace_stack,
137		 *    function_stack_trace_call
138		 *    ftrace_list_func
139		 *    ftrace_call
140		 */
141		__trace_stack(tr, flags, 5, pc);
142	}
143
 
144	atomic_dec(&data->disabled);
145	local_irq_restore(flags);
146}
147
148
149static struct ftrace_ops trace_ops __read_mostly =
150{
151	.func = function_trace_call,
152	.flags = FTRACE_OPS_FL_GLOBAL,
153};
154
155static struct ftrace_ops trace_stack_ops __read_mostly =
156{
157	.func = function_stack_trace_call,
158	.flags = FTRACE_OPS_FL_GLOBAL,
159};
160
161/* Our two options */
162enum {
163	TRACE_FUNC_OPT_STACK = 0x1,
164};
165
166static struct tracer_opt func_opts[] = {
167#ifdef CONFIG_STACKTRACE
168	{ TRACER_OPT(func_stack_trace, TRACE_FUNC_OPT_STACK) },
169#endif
 
170	{ } /* Always set a last empty entry */
171};
172
173static struct tracer_flags func_flags = {
174	.val = 0, /* By default: all flags disabled */
175	.opts = func_opts
176};
177
178static void tracing_start_function_trace(void)
179{
180	ftrace_function_enabled = 0;
 
 
 
181
182	if (trace_flags & TRACE_ITER_PREEMPTONLY)
183		trace_ops.func = function_trace_call_preempt_only;
184	else
185		trace_ops.func = function_trace_call;
 
186
187	if (func_flags.val & TRACE_FUNC_OPT_STACK)
188		register_ftrace_function(&trace_stack_ops);
189	else
190		register_ftrace_function(&trace_ops);
191
192	ftrace_function_enabled = 1;
193}
194
195static void tracing_stop_function_trace(void)
196{
197	ftrace_function_enabled = 0;
 
198
199	if (func_flags.val & TRACE_FUNC_OPT_STACK)
200		unregister_ftrace_function(&trace_stack_ops);
201	else
202		unregister_ftrace_function(&trace_ops);
203}
204
205static int func_set_flag(u32 old_flags, u32 bit, int set)
206{
207	if (bit == TRACE_FUNC_OPT_STACK) {
208		/* do nothing if already set */
209		if (!!set == !!(func_flags.val & TRACE_FUNC_OPT_STACK))
210			return 0;
211
212		if (set) {
213			unregister_ftrace_function(&trace_ops);
214			register_ftrace_function(&trace_stack_ops);
215		} else {
216			unregister_ftrace_function(&trace_stack_ops);
217			register_ftrace_function(&trace_ops);
218		}
219
 
 
220		return 0;
221	}
222
223	return -EINVAL;
 
 
 
 
 
 
 
224}
225
226static struct tracer function_trace __read_mostly =
227{
228	.name		= "function",
229	.init		= function_trace_init,
230	.reset		= function_trace_reset,
231	.start		= function_trace_start,
232	.wait_pipe	= poll_wait_pipe,
233	.flags		= &func_flags,
234	.set_flag	= func_set_flag,
 
235#ifdef CONFIG_FTRACE_SELFTEST
236	.selftest	= trace_selftest_startup_function,
237#endif
238};
239
240#ifdef CONFIG_DYNAMIC_FTRACE
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
241static void
242ftrace_traceon(unsigned long ip, unsigned long parent_ip, void **data)
 
 
243{
244	long *count = (long *)data;
 
 
 
 
 
 
 
 
 
245
246	if (tracing_is_on())
 
 
 
 
 
247		return;
248
249	if (!*count)
 
 
 
 
 
 
 
 
250		return;
251
252	if (*count != -1)
253		(*count)--;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
254
255	tracing_on();
256}
257
258static void
259ftrace_traceoff(unsigned long ip, unsigned long parent_ip, void **data)
 
 
260{
261	long *count = (long *)data;
 
 
 
 
 
 
 
 
 
 
 
262
263	if (!tracing_is_on())
264		return;
265
266	if (!*count)
 
 
267		return;
 
 
 
 
 
 
 
 
 
 
 
 
 
268
269	if (*count != -1)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
270		(*count)--;
 
271
272	tracing_off();
273}
274
275static int
276ftrace_trace_onoff_print(struct seq_file *m, unsigned long ip,
277			 struct ftrace_probe_ops *ops, void *data);
 
 
 
 
 
278
279static struct ftrace_probe_ops traceon_probe_ops = {
280	.func			= ftrace_traceon,
281	.print			= ftrace_trace_onoff_print,
282};
283
284static struct ftrace_probe_ops traceoff_probe_ops = {
285	.func			= ftrace_traceoff,
286	.print			= ftrace_trace_onoff_print,
287};
288
289static int
290ftrace_trace_onoff_print(struct seq_file *m, unsigned long ip,
291			 struct ftrace_probe_ops *ops, void *data)
 
292{
293	long count = (long)data;
 
294
295	seq_printf(m, "%ps:", (void *)ip);
296
297	if (ops == &traceon_probe_ops)
298		seq_printf(m, "traceon");
299	else
300		seq_printf(m, "traceoff");
301
302	if (count == -1)
303		seq_printf(m, ":unlimited\n");
304	else
305		seq_printf(m, ":count=%ld\n", count);
306
307	return 0;
308}
309
310static int
311ftrace_trace_onoff_unreg(char *glob, char *cmd, char *param)
 
 
 
 
 
 
 
 
 
312{
313	struct ftrace_probe_ops *ops;
 
314
315	/* we register both traceon and traceoff to this callback */
316	if (strcmp(cmd, "traceon") == 0)
317		ops = &traceon_probe_ops;
318	else
319		ops = &traceoff_probe_ops;
 
320
321	unregister_ftrace_function_probe_func(glob, ops);
 
 
 
 
 
322
323	return 0;
 
 
 
 
324}
325
 
326static int
327ftrace_trace_onoff_callback(struct ftrace_hash *hash,
328			    char *glob, char *cmd, char *param, int enable)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
329{
330	struct ftrace_probe_ops *ops;
331	void *count = (void *)-1;
332	char *number;
333	int ret;
334
335	/* hash funcs only work with set_ftrace_filter */
336	if (!enable)
337		return -EINVAL;
338
339	if (glob[0] == '!')
340		return ftrace_trace_onoff_unreg(glob+1, cmd, param);
341
342	/* we register both traceon and traceoff to this callback */
343	if (strcmp(cmd, "traceon") == 0)
344		ops = &traceon_probe_ops;
345	else
346		ops = &traceoff_probe_ops;
347
348	if (!param)
349		goto out_reg;
350
351	number = strsep(&param, ":");
352
353	if (!strlen(number))
354		goto out_reg;
355
356	/*
357	 * We use the callback data field (which is a pointer)
358	 * as our counter.
359	 */
360	ret = strict_strtoul(number, 0, (unsigned long *)&count);
361	if (ret)
362		return ret;
363
364 out_reg:
365	ret = register_ftrace_function_probe(glob, ops, count);
366
367	return ret < 0 ? ret : 0;
368}
369
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
370static struct ftrace_func_command ftrace_traceon_cmd = {
371	.name			= "traceon",
372	.func			= ftrace_trace_onoff_callback,
373};
374
375static struct ftrace_func_command ftrace_traceoff_cmd = {
376	.name			= "traceoff",
377	.func			= ftrace_trace_onoff_callback,
378};
379
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
380static int __init init_func_cmd_traceon(void)
381{
382	int ret;
383
384	ret = register_ftrace_command(&ftrace_traceoff_cmd);
385	if (ret)
386		return ret;
387
388	ret = register_ftrace_command(&ftrace_traceon_cmd);
389	if (ret)
390		unregister_ftrace_command(&ftrace_traceoff_cmd);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
391	return ret;
392}
393#else
394static inline int init_func_cmd_traceon(void)
395{
396	return 0;
397}
398#endif /* CONFIG_DYNAMIC_FTRACE */
399
400static __init int init_function_trace(void)
401{
402	init_func_cmd_traceon();
403	return register_tracer(&function_trace);
404}
405device_initcall(init_function_trace);
406