LLDB mainline
ThreadPlanBase.h
Go to the documentation of this file.
1//===-- ThreadPlanBase.h ----------------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLDB_TARGET_THREADPLANBASE_H
10#define LLDB_TARGET_THREADPLANBASE_H
11
12#include "lldb/Target/Process.h"
13#include "lldb/Target/Thread.h"
15
16namespace lldb_private {
17
18// Base thread plans:
19// This is the generic version of the bottom most plan on the plan stack. It
20// should
21// be able to handle generic breakpoint hitting, and signals and exceptions.
22
23class ThreadPlanBase : public ThreadPlan {
24 friend class Process; // RunThreadPlan manages "stopper" base plans.
25public:
26 ~ThreadPlanBase() override;
27
28 void GetDescription(Stream *s, lldb::DescriptionLevel level) override;
29 bool ValidatePlan(Stream *error) override;
30 bool ShouldStop(Event *event_ptr) override;
31 Vote ShouldReportStop(Event *event_ptr) override;
32 bool StopOthers() override;
34 bool WillStop() override;
35 bool MischiefManaged() override;
36
37 bool OkayToDiscard() override { return false; }
38
39 bool IsBasePlan() override { return true; }
40
41protected:
42 bool DoWillResume(lldb::StateType resume_state, bool current_plan) override;
43 bool DoPlanExplainsStop(Event *event_ptr) override;
44 ThreadPlanBase(Thread &thread);
45
46private:
47 friend lldb::ThreadPlanSP Thread::QueueBasePlan(bool abort_other_plans);
48
49 ThreadPlanBase(const ThreadPlanBase &) = delete;
50 const ThreadPlanBase &operator=(const ThreadPlanBase &) = delete;
51};
52
53} // namespace lldb_private
54
55#endif // LLDB_TARGET_THREADPLANBASE_H
static llvm::raw_ostream & error(Stream &strm)
A plug-in interface definition class for debugging a process.
Definition: Process.h:342
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
bool DoWillResume(lldb::StateType resume_state, bool current_plan) override
bool ValidatePlan(Stream *error) override
Returns whether this plan could be successfully created.
const ThreadPlanBase & operator=(const ThreadPlanBase &)=delete
ThreadPlanBase(const ThreadPlanBase &)=delete
bool ShouldStop(Event *event_ptr) override
bool DoPlanExplainsStop(Event *event_ptr) override
lldb::StateType GetPlanRunState() override
Vote ShouldReportStop(Event *event_ptr) override
void GetDescription(Stream *s, lldb::DescriptionLevel level) override
Print a description of this thread to the stream s.
lldb::ThreadPlanSP QueueBasePlan(bool abort_other_plans)
Queues the base plan for a thread.
Definition: Thread.cpp:1254
A class that represents a running process on the host machine.
DescriptionLevel
Description levels for "void GetDescription(Stream *, DescriptionLevel)" calls.
StateType
Process and Thread States.