Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <AK/CircularDeque.h>
30#include <AK/NonnullOwnPtr.h>
31#include <AK/Optional.h>
32#include <AK/RefCounted.h>
33#include <Kernel/Arch/i386/CPU.h>
34#include <Kernel/UnixTypes.h>
35#include <LibC/sys/arch/i386/regs.h>
36
37namespace Kernel {
38
39class ThreadTracer {
40public:
41 static NonnullOwnPtr<ThreadTracer> create(pid_t tracer) { return make<ThreadTracer>(tracer); }
42
43 pid_t tracer_pid() const { return m_tracer_pid; }
44 bool has_pending_signal(u32 signal) const { return m_pending_signals & (1 << (signal - 1)); }
45 void set_signal(u32 signal) { m_pending_signals |= (1 << (signal - 1)); }
46 void unset_signal(u32 signal) { m_pending_signals &= ~(1 << (signal - 1)); }
47
48 bool is_tracing_syscalls() const { return m_trace_syscalls; }
49 void set_trace_syscalls(bool val) { m_trace_syscalls = val; }
50
51 void set_regs(const RegisterState& regs);
52 bool has_regs() const { return m_regs.has_value(); }
53 const PtraceRegisters& regs() const
54 {
55 ASSERT(m_regs.has_value());
56 return m_regs.value();
57 }
58
59 explicit ThreadTracer(pid_t);
60
61private:
62 pid_t m_tracer_pid { -1 };
63
64 // This is a bitmap for signals that are sent from the tracer to the tracee
65 // TODO: Since we do not currently support sending signals
66 // to the tracee via PT_CONTINUE, this bitmap is always zeroed
67 u32 m_pending_signals { 0 };
68
69 bool m_trace_syscalls { false };
70 Optional<PtraceRegisters> m_regs;
71};
72
73}