Commit 93eb677d authored by Steven Rostedt's avatar Steven Rostedt Committed by Ingo Molnar
Browse files

ftrace: use module notifier for function tracer 



The hooks in the module code for the function tracer must be called
before any of that module code runs. The function tracer hooks
modify the module (replacing calls to mcount to nops). If the code
is executed while the change occurs, then the CPU can take a GPF.

To handle the above with a bit of paranoia, I originally implemented
the hooks as calls directly from the module code.

After examining the notifier calls, it looks as though the start up
notify is called before any of the module's code is executed. This makes
the use of the notify safe with ftrace.

Only the startup notify is required to be "safe". The shutdown simply
removes the entries from the ftrace function list, and does not modify
any code.

This change has another benefit. It removes a issue with a reverse dependency
in the mutexes of ftrace_lock and module_mutex.

[ Impact: fix lock dependency bug, cleanup ]

Cc: Rusty Russell <rusty@rustcorp.com.au>
Signed-off-by: default avatarSteven Rostedt <rostedt@goodmis.org>
parent f3948f88

include/linux/ftrace.h

+0 −7
Original line number Diff line number Diff line
@@ -233,8 +233,6 @@ extern int ftrace_arch_read_dyn_info(char *buf, int size); 


extern int skip_trace(unsigned long ip);



extern void ftrace_release(void *start, unsigned long size);



extern void ftrace_disable_daemon(void);

extern void ftrace_enable_daemon(void);

#else
@@ -325,13 +323,8 @@ static inline void __ftrace_enabled_restore(int enabled) 


#ifdef CONFIG_FTRACE_MCOUNT_RECORD

extern void ftrace_init(void);

extern void ftrace_init_module(struct module *mod,

			       unsigned long *start, unsigned long *end);

#else

static inline void ftrace_init(void) { }

static inline void

ftrace_init_module(struct module *mod,

		   unsigned long *start, unsigned long *end) { }

#endif



/*

include/linux/module.h

+4 −0
Original line number Diff line number Diff line
@@ -341,6 +341,10 @@ struct module 
	struct ftrace_event_call *trace_events;

	unsigned int num_trace_events;

#endif

#ifdef CONFIG_FTRACE_MCOUNT_RECORD

	unsigned long *ftrace_callsites;

	unsigned int num_ftrace_callsites;

#endif



#ifdef CONFIG_MODULE_UNLOAD

	/* What modules depend on me? */

kernel/module.c

+7 −12
Original line number Diff line number Diff line
@@ -1490,9 +1490,6 @@ static void free_module(struct module *mod) 
	/* Free any allocated parameters. */

	destroy_params(mod->kp, mod->num_kp);



	/* release any pointers to mcount in this module */

	ftrace_release(mod->module_core, mod->core_size);



	/* This may be NULL, but that's OK */

	module_free(mod, mod->module_init);

	kfree(mod->args);
@@ -1893,11 +1890,9 @@ static noinline struct module *load_module(void __user *umod, 
	unsigned int symindex = 0;

	unsigned int strindex = 0;

	unsigned int modindex, versindex, infoindex, pcpuindex;

	unsigned int num_mcount;

	struct module *mod;

	long err = 0;

	void *percpu = NULL, *ptr = NULL; /* Stops spurious gcc warning */

	unsigned long *mseg;

	mm_segment_t old_fs;



	DEBUGP("load_module: umod=%p, len=%lu, uargs=%p\n",
@@ -2179,7 +2174,13 @@ static noinline struct module *load_module(void __user *umod, 
					 sizeof(*mod->trace_events),

					 &mod->num_trace_events);

#endif



#ifdef CONFIG_FTRACE_MCOUNT_RECORD

	/* sechdrs[0].sh_size is always zero */

	mod->ftrace_callsites = section_objs(hdr, sechdrs, secstrings,

					     "__mcount_loc",

					     sizeof(*mod->ftrace_callsites),

					     &mod->num_ftrace_callsites);

#endif

#ifdef CONFIG_MODVERSIONS

	if ((mod->num_syms && !mod->crcs)

	    || (mod->num_gpl_syms && !mod->gpl_crcs)
@@ -2244,11 +2245,6 @@ static noinline struct module *load_module(void __user *umod, 
			dynamic_debug_setup(debug, num_debug);

	}



	/* sechdrs[0].sh_size is always zero */

	mseg = section_objs(hdr, sechdrs, secstrings, "__mcount_loc",

			    sizeof(*mseg), &num_mcount);

	ftrace_init_module(mod, mseg, mseg + num_mcount);



	err = module_finalize(hdr, sechdrs, mod);

	if (err < 0)

		goto cleanup;
@@ -2309,7 +2305,6 @@ static noinline struct module *load_module(void __user *umod, 
 cleanup:

	kobject_del(&mod->mkobj.kobj);

	kobject_put(&mod->mkobj.kobj);

	ftrace_release(mod->module_core, mod->core_size);

 free_unload:

	module_unload_free(mod);

#if defined(CONFIG_MODULE_UNLOAD) && defined(CONFIG_SMP)

kernel/trace/ftrace.c

+64 −26
Original line number Diff line number Diff line
@@ -916,30 +916,6 @@ static void ftrace_free_rec(struct dyn_ftrace *rec) 
	rec->flags |= FTRACE_FL_FREE;

}



void ftrace_release(void *start, unsigned long size)

{

	struct dyn_ftrace *rec;

	struct ftrace_page *pg;

	unsigned long s = (unsigned long)start;

	unsigned long e = s + size;



	if (ftrace_disabled || !start)

		return;



	mutex_lock(&ftrace_lock);

	do_for_each_ftrace_rec(pg, rec) {

		if ((rec->ip >= s) && (rec->ip < e)) {

			/*

			 * rec->ip is changed in ftrace_free_rec()

			 * It should not between s and e if record was freed.

			 */

			FTRACE_WARN_ON(rec->flags & FTRACE_FL_FREE);

			ftrace_free_rec(rec);

		}

	} while_for_each_ftrace_rec();

	mutex_unlock(&ftrace_lock);

}



static struct dyn_ftrace *ftrace_alloc_dyn_node(unsigned long ip)

{

	struct dyn_ftrace *rec;
@@ -2752,7 +2728,32 @@ static int ftrace_convert_nops(struct module *mod, 
	return 0;

}



void ftrace_init_module(struct module *mod,

#ifdef CONFIG_MODULES

void ftrace_release(void *start, void *end)

{

	struct dyn_ftrace *rec;

	struct ftrace_page *pg;

	unsigned long s = (unsigned long)start;

	unsigned long e = (unsigned long)end;



	if (ftrace_disabled || !start || start == end)

		return;



	mutex_lock(&ftrace_lock);

	do_for_each_ftrace_rec(pg, rec) {

		if ((rec->ip >= s) && (rec->ip < e)) {

			/*

			 * rec->ip is changed in ftrace_free_rec()

			 * It should not between s and e if record was freed.

			 */

			FTRACE_WARN_ON(rec->flags & FTRACE_FL_FREE);

			ftrace_free_rec(rec);

		}

	} while_for_each_ftrace_rec();

	mutex_unlock(&ftrace_lock);

}



static void ftrace_init_module(struct module *mod,

			       unsigned long *start, unsigned long *end)

{

	if (ftrace_disabled || start == end)
@@ -2760,6 +2761,39 @@ void ftrace_init_module(struct module *mod, 
	ftrace_convert_nops(mod, start, end);

}



static int ftrace_module_notify(struct notifier_block *self,

				unsigned long val, void *data)

{

	struct module *mod = data;



	switch (val) {

	case MODULE_STATE_COMING:

		ftrace_init_module(mod, mod->ftrace_callsites,

				   mod->ftrace_callsites +

				   mod->num_ftrace_callsites);

		break;

	case MODULE_STATE_GOING:

		ftrace_release(mod->ftrace_callsites,

			       mod->ftrace_callsites +

			       mod->num_ftrace_callsites);

		break;

	}



	return 0;

}

#else

static int ftrace_module_notify(struct notifier_block *self,

				unsigned long val, void *data)

{

	return 0;

}

#endif /* CONFIG_MODULES */



struct notifier_block ftrace_module_nb = {

	.notifier_call = ftrace_module_notify,

	.priority = 0,

};



extern unsigned long __start_mcount_loc[];

extern unsigned long __stop_mcount_loc[];
@@ -2791,6 +2825,10 @@ void __init ftrace_init(void) 
				  __start_mcount_loc,

				  __stop_mcount_loc);



	ret = register_module_notifier(&ftrace_module_nb);

	if (!ret)

		pr_warning("Failed to register trace ftrace module notifier\n");



	return;

 failed:

	ftrace_disabled = 1;

CRA Git | Maintained and supported by SUSTech CRA and CCSE