tracehook: add linux/tracehook.h
This patch series introduces the "tracehook" interface layer of inlines in
<linux/tracehook.h>. There are more details in the log entry for patch
01/23 and in the header file comments inside that patch. Most of these
changes move code around with little or no change, and they should not
break anything or change any behavior.
This sets a new standard for uniform arch support to enable clean
arch-independent implementations of new debugging and tracing stuff,
denoted by CONFIG_HAVE_ARCH_TRACEHOOK. Patch 20/23 adds that symbol to
arch/Kconfig, with comments listing everything an arch has to do before
setting "select HAVE_ARCH_TRACEHOOK". These are elaborted a bit at:
http://sourceware.org/systemtap/wiki/utrace/arch/HowTo
The new inlines that arch code must define or call have detailed kerneldoc
comments in the generic header files that say what is required.
No arch is obligated to do any work, and no arch's build should be broken
by these changes. There are several steps that each arch should take so
it can set HAVE_ARCH_TRACEHOOK. Most of these are simple. Providing this
support will let new things people add for doing debugging and tracing of
user-level threads "just work" for your arch in the future. For an arch
that does not provide HAVE_ARCH_TRACEHOOK, some new options for such
features will not be available for config.
I have done some arch work and will submit this to the arch maintainers
after the generic tracehook series settles in. For now, that work is
available in my GIT repositories, and in patch and mbox-of-patches form at
http://people.redhat.com/roland/utrace/2.6-current/
This paves the way for my "utrace" work, to be submitted later. But it is
not innately tied to that. I hope that the tracehook series can go in
soon regardless of what eventually does or doesn't go on top of it. For
anyone implementing any kind of new tracing/debugging plan, or just
understanding all the context of the existing ptrace implementation,
having tracehook.h makes things much easier to find and understand.
This patch:
This adds the new kernel-internal header file <linux/tracehook.h>. This
is not yet used at all. The comments in the header introduce what the
following series of patches is about.
The aim is to formalize and consolidate all the places that the core
kernel code and the arch code now ties into the ptrace implementation.
These patches mostly don't cause any functional change. They just move
the details of ptrace logic out of core code into tracehook.h inlines,
where they are mostly compiled away to the same as before. All that
changes is that everything is thoroughly documented and any future
reworking of ptrace, or addition of something new, would not have to touch
core code all over, just change the tracehook.h inlines.
The new linux/ptrace.h inlines are used by the following patches in the
new tracehook_*() inlines. Using these helpers for the ptrace event stops
makes it simple to change or disable the old ptrace implementation of
these stops conditionally later.
Signed-off-by: Roland McGrath <roland@redhat.com>
Cc: Oleg Nesterov <oleg@tv-sign.ru>
Reviewed-by: Ingo Molnar <mingo@elte.hu>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2008-07-26 02:45:43 +00:00
|
|
|
/*
|
|
|
|
* Tracing hooks
|
|
|
|
*
|
2009-09-23 22:56:53 +00:00
|
|
|
* Copyright (C) 2008-2009 Red Hat, Inc. All rights reserved.
|
tracehook: add linux/tracehook.h
This patch series introduces the "tracehook" interface layer of inlines in
<linux/tracehook.h>. There are more details in the log entry for patch
01/23 and in the header file comments inside that patch. Most of these
changes move code around with little or no change, and they should not
break anything or change any behavior.
This sets a new standard for uniform arch support to enable clean
arch-independent implementations of new debugging and tracing stuff,
denoted by CONFIG_HAVE_ARCH_TRACEHOOK. Patch 20/23 adds that symbol to
arch/Kconfig, with comments listing everything an arch has to do before
setting "select HAVE_ARCH_TRACEHOOK". These are elaborted a bit at:
http://sourceware.org/systemtap/wiki/utrace/arch/HowTo
The new inlines that arch code must define or call have detailed kerneldoc
comments in the generic header files that say what is required.
No arch is obligated to do any work, and no arch's build should be broken
by these changes. There are several steps that each arch should take so
it can set HAVE_ARCH_TRACEHOOK. Most of these are simple. Providing this
support will let new things people add for doing debugging and tracing of
user-level threads "just work" for your arch in the future. For an arch
that does not provide HAVE_ARCH_TRACEHOOK, some new options for such
features will not be available for config.
I have done some arch work and will submit this to the arch maintainers
after the generic tracehook series settles in. For now, that work is
available in my GIT repositories, and in patch and mbox-of-patches form at
http://people.redhat.com/roland/utrace/2.6-current/
This paves the way for my "utrace" work, to be submitted later. But it is
not innately tied to that. I hope that the tracehook series can go in
soon regardless of what eventually does or doesn't go on top of it. For
anyone implementing any kind of new tracing/debugging plan, or just
understanding all the context of the existing ptrace implementation,
having tracehook.h makes things much easier to find and understand.
This patch:
This adds the new kernel-internal header file <linux/tracehook.h>. This
is not yet used at all. The comments in the header introduce what the
following series of patches is about.
The aim is to formalize and consolidate all the places that the core
kernel code and the arch code now ties into the ptrace implementation.
These patches mostly don't cause any functional change. They just move
the details of ptrace logic out of core code into tracehook.h inlines,
where they are mostly compiled away to the same as before. All that
changes is that everything is thoroughly documented and any future
reworking of ptrace, or addition of something new, would not have to touch
core code all over, just change the tracehook.h inlines.
The new linux/ptrace.h inlines are used by the following patches in the
new tracehook_*() inlines. Using these helpers for the ptrace event stops
makes it simple to change or disable the old ptrace implementation of
these stops conditionally later.
Signed-off-by: Roland McGrath <roland@redhat.com>
Cc: Oleg Nesterov <oleg@tv-sign.ru>
Reviewed-by: Ingo Molnar <mingo@elte.hu>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2008-07-26 02:45:43 +00:00
|
|
|
*
|
|
|
|
* This copyrighted material is made available to anyone wishing to use,
|
|
|
|
* modify, copy, or redistribute it subject to the terms and conditions
|
|
|
|
* of the GNU General Public License v.2.
|
|
|
|
*
|
|
|
|
* This file defines hook entry points called by core code where
|
|
|
|
* user tracing/debugging support might need to do something. These
|
|
|
|
* entry points are called tracehook_*(). Each hook declared below
|
|
|
|
* has a detailed kerneldoc comment giving the context (locking et
|
|
|
|
* al) from which it is called, and the meaning of its return value.
|
|
|
|
*
|
|
|
|
* Each function here typically has only one call site, so it is ok
|
|
|
|
* to have some nontrivial tracehook_*() inlines. In all cases, the
|
|
|
|
* fast path when no tracing is enabled should be very short.
|
|
|
|
*
|
|
|
|
* The purpose of this file and the tracehook_* layer is to consolidate
|
|
|
|
* the interface that the kernel core and arch code uses to enable any
|
|
|
|
* user debugging or tracing facility (such as ptrace). The interfaces
|
|
|
|
* here are carefully documented so that maintainers of core and arch
|
|
|
|
* code do not need to think about the implementation details of the
|
|
|
|
* tracing facilities. Likewise, maintainers of the tracing code do not
|
|
|
|
* need to understand all the calling core or arch code in detail, just
|
|
|
|
* documented circumstances of each call, such as locking conditions.
|
|
|
|
*
|
|
|
|
* If the calling core code changes so that locking is different, then
|
|
|
|
* it is ok to change the interface documented here. The maintainer of
|
|
|
|
* core code changing should notify the maintainers of the tracing code
|
|
|
|
* that they need to work out the change.
|
|
|
|
*
|
|
|
|
* Some tracehook_*() inlines take arguments that the current tracing
|
|
|
|
* implementations might not necessarily use. These function signatures
|
|
|
|
* are chosen to pass in all the information that is on hand in the
|
|
|
|
* caller and might conceivably be relevant to a tracer, so that the
|
|
|
|
* core code won't have to be updated when tracing adds more features.
|
|
|
|
* If a call site changes so that some of those parameters are no longer
|
|
|
|
* already on hand without extra work, then the tracehook_* interface
|
|
|
|
* can change so there is no make-work burden on the core code. The
|
|
|
|
* maintainer of core code changing should notify the maintainers of the
|
|
|
|
* tracing code that they need to work out the change.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _LINUX_TRACEHOOK_H
|
|
|
|
#define _LINUX_TRACEHOOK_H 1
|
|
|
|
|
|
|
|
#include <linux/sched.h>
|
|
|
|
#include <linux/ptrace.h>
|
2008-07-26 02:45:44 +00:00
|
|
|
#include <linux/security.h>
|
2012-05-11 00:59:07 +00:00
|
|
|
#include <linux/task_work.h>
|
2008-07-26 02:45:44 +00:00
|
|
|
struct linux_binprm;
|
|
|
|
|
2008-07-26 02:45:52 +00:00
|
|
|
/*
|
|
|
|
* ptrace report for syscall entry and exit looks identical.
|
|
|
|
*/
|
2012-03-23 22:02:39 +00:00
|
|
|
static inline int ptrace_report_syscall(struct pt_regs *regs)
|
2008-07-26 02:45:52 +00:00
|
|
|
{
|
2011-06-17 14:50:34 +00:00
|
|
|
int ptrace = current->ptrace;
|
2008-07-26 02:45:52 +00:00
|
|
|
|
|
|
|
if (!(ptrace & PT_PTRACED))
|
2012-03-23 22:02:39 +00:00
|
|
|
return 0;
|
2008-07-26 02:45:52 +00:00
|
|
|
|
|
|
|
ptrace_notify(SIGTRAP | ((ptrace & PT_TRACESYSGOOD) ? 0x80 : 0));
|
|
|
|
|
|
|
|
/*
|
|
|
|
* this isn't the same as continuing with a signal, but it will do
|
|
|
|
* for normal use. strace only continues with a signal if the
|
|
|
|
* stopping signal is not SIGTRAP. -brl
|
|
|
|
*/
|
|
|
|
if (current->exit_code) {
|
|
|
|
send_sig(current->exit_code, current, 1);
|
|
|
|
current->exit_code = 0;
|
|
|
|
}
|
2012-03-23 22:02:39 +00:00
|
|
|
|
|
|
|
return fatal_signal_pending(current);
|
2008-07-26 02:45:52 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* tracehook_report_syscall_entry - task is about to attempt a system call
|
|
|
|
* @regs: user register state of current task
|
|
|
|
*
|
|
|
|
* This will be called if %TIF_SYSCALL_TRACE has been set, when the
|
|
|
|
* current task has just entered the kernel for a system call.
|
|
|
|
* Full user register state is available here. Changing the values
|
|
|
|
* in @regs can affect the system call number and arguments to be tried.
|
|
|
|
* It is safe to block here, preventing the system call from beginning.
|
|
|
|
*
|
|
|
|
* Returns zero normally, or nonzero if the calling arch code should abort
|
|
|
|
* the system call. That must prevent normal entry so no system call is
|
|
|
|
* made. If @task ever returns to user mode after this, its register state
|
|
|
|
* is unspecified, but should be something harmless like an %ENOSYS error
|
2008-07-26 02:45:57 +00:00
|
|
|
* return. It should preserve enough information so that syscall_rollback()
|
|
|
|
* can work (see asm-generic/syscall.h).
|
2008-07-26 02:45:52 +00:00
|
|
|
*
|
|
|
|
* Called without locks, just after entering kernel mode.
|
|
|
|
*/
|
|
|
|
static inline __must_check int tracehook_report_syscall_entry(
|
|
|
|
struct pt_regs *regs)
|
|
|
|
{
|
2012-03-23 22:02:39 +00:00
|
|
|
return ptrace_report_syscall(regs);
|
2008-07-26 02:45:52 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* tracehook_report_syscall_exit - task has just finished a system call
|
|
|
|
* @regs: user register state of current task
|
|
|
|
* @step: nonzero if simulating single-step or block-step
|
|
|
|
*
|
|
|
|
* This will be called if %TIF_SYSCALL_TRACE has been set, when the
|
|
|
|
* current task has just finished an attempted system call. Full
|
|
|
|
* user register state is available here. It is safe to block here,
|
|
|
|
* preventing signals from being processed.
|
|
|
|
*
|
|
|
|
* If @step is nonzero, this report is also in lieu of the normal
|
|
|
|
* trap that would follow the system call instruction because
|
|
|
|
* user_enable_block_step() or user_enable_single_step() was used.
|
|
|
|
* In this case, %TIF_SYSCALL_TRACE might not be set.
|
|
|
|
*
|
|
|
|
* Called without locks, just before checking for pending signals.
|
|
|
|
*/
|
|
|
|
static inline void tracehook_report_syscall_exit(struct pt_regs *regs, int step)
|
|
|
|
{
|
ptrace: change tracehook_report_syscall_exit() to handle stepping
Suggested by Roland.
Change tracehook_report_syscall_exit() to look at step flag and send the
trap signal if needed.
This change affects ia64, microblaze, parisc, powerpc, sh. They pass
nonzero "step" argument to tracehook but since it was ignored the tracee
reports via ptrace_notify(), this is not right and not consistent.
- PTRACE_SETSIGINFO doesn't work
- if the tracer resumes the tracee with signr != 0 the new signal
is generated rather than delivering it
- If PT_TRACESYSGOOD is set the tracee reports the wrong exit_code
I don't have a powerpc machine, but I think this test-case should see the
difference:
#include <unistd.h>
#include <sys/ptrace.h>
#include <sys/wait.h>
#include <assert.h>
#include <stdio.h>
int main(void)
{
int pid, status;
if (!(pid = fork())) {
assert(ptrace(PTRACE_TRACEME) == 0);
kill(getpid(), SIGSTOP);
getppid();
return 0;
}
assert(pid == wait(&status));
assert(ptrace(PTRACE_SETOPTIONS, pid, 0, PTRACE_O_TRACESYSGOOD) == 0);
assert(ptrace(PTRACE_SYSCALL, pid, 0,0) == 0);
assert(pid == wait(&status));
assert(ptrace(PTRACE_SINGLESTEP, pid, 0,0) == 0);
assert(pid == wait(&status));
if (status == 0x57F)
return 0;
printf("kernel bug: status=%X shouldn't have 0x80\n", status);
return 1;
}
Signed-off-by: Oleg Nesterov <oleg@redhat.com>
Acked-by: Roland McGrath <roland@redhat.com>
Cc: <linux-arch@vger.kernel.org>
Cc: Ingo Molnar <mingo@elte.hu>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: "H. Peter Anvin" <hpa@zytor.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2009-12-16 00:47:19 +00:00
|
|
|
if (step) {
|
|
|
|
siginfo_t info;
|
|
|
|
user_single_step_siginfo(current, regs, &info);
|
|
|
|
force_sig_info(SIGTRAP, &info, current);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2008-07-26 02:45:52 +00:00
|
|
|
ptrace_report_syscall(regs);
|
|
|
|
}
|
|
|
|
|
2008-07-26 02:45:50 +00:00
|
|
|
/**
|
|
|
|
* tracehook_signal_handler - signal handler setup is complete
|
|
|
|
* @sig: number of signal being delivered
|
|
|
|
* @info: siginfo_t of signal being delivered
|
|
|
|
* @ka: sigaction setting that chose the handler
|
|
|
|
* @regs: user register state
|
|
|
|
* @stepping: nonzero if debugger single-step or block-step in use
|
|
|
|
*
|
|
|
|
* Called by the arch code after a signal handler has been set up.
|
|
|
|
* Register and stack state reflects the user handler about to run.
|
|
|
|
* Signal mask changes have already been made.
|
|
|
|
*
|
|
|
|
* Called without locks, shortly before returning to user mode
|
|
|
|
* (or handling more signals).
|
|
|
|
*/
|
|
|
|
static inline void tracehook_signal_handler(int sig, siginfo_t *info,
|
|
|
|
const struct k_sigaction *ka,
|
|
|
|
struct pt_regs *regs, int stepping)
|
|
|
|
{
|
|
|
|
if (stepping)
|
|
|
|
ptrace_notify(SIGTRAP);
|
|
|
|
}
|
|
|
|
|
2008-07-26 02:45:56 +00:00
|
|
|
/**
|
|
|
|
* set_notify_resume - cause tracehook_notify_resume() to be called
|
|
|
|
* @task: task that will call tracehook_notify_resume()
|
|
|
|
*
|
|
|
|
* Calling this arranges that @task will call tracehook_notify_resume()
|
|
|
|
* before returning to user mode. If it's already running in user mode,
|
|
|
|
* it will enter the kernel and call tracehook_notify_resume() soon.
|
|
|
|
* If it's blocked, it will not be woken.
|
|
|
|
*/
|
|
|
|
static inline void set_notify_resume(struct task_struct *task)
|
|
|
|
{
|
2012-05-11 00:59:07 +00:00
|
|
|
#ifdef TIF_NOTIFY_RESUME
|
2008-07-26 02:45:56 +00:00
|
|
|
if (!test_and_set_tsk_thread_flag(task, TIF_NOTIFY_RESUME))
|
|
|
|
kick_process(task);
|
2012-05-11 00:59:07 +00:00
|
|
|
#endif
|
2008-07-26 02:45:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* tracehook_notify_resume - report when about to return to user mode
|
|
|
|
* @regs: user-mode registers of @current task
|
|
|
|
*
|
|
|
|
* This is called when %TIF_NOTIFY_RESUME has been set. Now we are
|
|
|
|
* about to return to user mode, and the user state in @regs can be
|
|
|
|
* inspected or adjusted. The caller in arch code has cleared
|
|
|
|
* %TIF_NOTIFY_RESUME before the call. If the flag gets set again
|
|
|
|
* asynchronously, this will be called again before we return to
|
|
|
|
* user mode.
|
|
|
|
*
|
|
|
|
* Called without locks.
|
|
|
|
*/
|
|
|
|
static inline void tracehook_notify_resume(struct pt_regs *regs)
|
|
|
|
{
|
2012-05-11 00:59:07 +00:00
|
|
|
/*
|
|
|
|
* The caller just cleared TIF_NOTIFY_RESUME. This barrier
|
|
|
|
* pairs with task_work_add()->set_notify_resume() after
|
|
|
|
* hlist_add_head(task->task_works);
|
|
|
|
*/
|
|
|
|
smp_mb__after_clear_bit();
|
2012-06-27 05:24:13 +00:00
|
|
|
if (unlikely(current->task_works))
|
2012-05-11 00:59:07 +00:00
|
|
|
task_work_run();
|
2008-07-26 02:45:56 +00:00
|
|
|
}
|
|
|
|
|
tracehook: add linux/tracehook.h
This patch series introduces the "tracehook" interface layer of inlines in
<linux/tracehook.h>. There are more details in the log entry for patch
01/23 and in the header file comments inside that patch. Most of these
changes move code around with little or no change, and they should not
break anything or change any behavior.
This sets a new standard for uniform arch support to enable clean
arch-independent implementations of new debugging and tracing stuff,
denoted by CONFIG_HAVE_ARCH_TRACEHOOK. Patch 20/23 adds that symbol to
arch/Kconfig, with comments listing everything an arch has to do before
setting "select HAVE_ARCH_TRACEHOOK". These are elaborted a bit at:
http://sourceware.org/systemtap/wiki/utrace/arch/HowTo
The new inlines that arch code must define or call have detailed kerneldoc
comments in the generic header files that say what is required.
No arch is obligated to do any work, and no arch's build should be broken
by these changes. There are several steps that each arch should take so
it can set HAVE_ARCH_TRACEHOOK. Most of these are simple. Providing this
support will let new things people add for doing debugging and tracing of
user-level threads "just work" for your arch in the future. For an arch
that does not provide HAVE_ARCH_TRACEHOOK, some new options for such
features will not be available for config.
I have done some arch work and will submit this to the arch maintainers
after the generic tracehook series settles in. For now, that work is
available in my GIT repositories, and in patch and mbox-of-patches form at
http://people.redhat.com/roland/utrace/2.6-current/
This paves the way for my "utrace" work, to be submitted later. But it is
not innately tied to that. I hope that the tracehook series can go in
soon regardless of what eventually does or doesn't go on top of it. For
anyone implementing any kind of new tracing/debugging plan, or just
understanding all the context of the existing ptrace implementation,
having tracehook.h makes things much easier to find and understand.
This patch:
This adds the new kernel-internal header file <linux/tracehook.h>. This
is not yet used at all. The comments in the header introduce what the
following series of patches is about.
The aim is to formalize and consolidate all the places that the core
kernel code and the arch code now ties into the ptrace implementation.
These patches mostly don't cause any functional change. They just move
the details of ptrace logic out of core code into tracehook.h inlines,
where they are mostly compiled away to the same as before. All that
changes is that everything is thoroughly documented and any future
reworking of ptrace, or addition of something new, would not have to touch
core code all over, just change the tracehook.h inlines.
The new linux/ptrace.h inlines are used by the following patches in the
new tracehook_*() inlines. Using these helpers for the ptrace event stops
makes it simple to change or disable the old ptrace implementation of
these stops conditionally later.
Signed-off-by: Roland McGrath <roland@redhat.com>
Cc: Oleg Nesterov <oleg@tv-sign.ru>
Reviewed-by: Ingo Molnar <mingo@elte.hu>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2008-07-26 02:45:43 +00:00
|
|
|
#endif /* <linux/tracehook.h> */
|