ThreadList.h revision 2e2812388b75d3c62c9518cc1a6550ce29325aa6 
1//===-- ThreadList.h --------------------------------------------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#ifndef liblldb_ThreadList_h_
11#define liblldb_ThreadList_h_
12
13#include <vector>
14
15#include "lldb/lldb-private.h"
16#include "lldb/Host/Mutex.h"
17#include "lldb/Core/UserID.h"
18
19
20// FIXME: Currently this is a thread list with lots of functionality for use only by
21// the process for which this is the thread list.  If we ever want a container class
22// to hand out that is just a random subset of threads, with iterator functionality,
23// then we should make that part a base class, and make a ProcessThreadList for the
24// process.
25namespace lldb_private {
26
27class ThreadList
28{
29friend class Process;
30
31public:
32
33    ThreadList (Process *process);
34
35    ThreadList (const ThreadList &rhs);
36
37    ~ThreadList ();
38
39    const ThreadList&
40    operator = (const ThreadList& rhs);
41
42    uint32_t
43    GetSize(bool can_update = true);
44
45    void
46    AddThread (const lldb::ThreadSP &thread_sp);
47
48    // Return the selected thread if there is one.  Otherwise, return the thread
49    // selected at index 0.
50    lldb::ThreadSP
51    GetSelectedThread ();
52
53    bool
54    SetSelectedThreadByID (lldb::tid_t tid, bool notify = false);
55
56    bool
57    SetSelectedThreadByIndexID (uint32_t index_id, bool notify = false);
58
59    void
60    Clear();
61
62    void
63    Flush();
64
65    void
66    Destroy();
67
68    // Note that "idx" is not the same as the "thread_index". It is a zero
69    // based index to accessing the current threads, whereas "thread_index"
70    // is a unique index assigned
71    lldb::ThreadSP
72    GetThreadAtIndex (uint32_t idx, bool can_update = true);
73
74    lldb::ThreadSP
75    FindThreadByID (lldb::tid_t tid, bool can_update = true);
76
77    lldb::ThreadSP
78    FindThreadByIndexID (uint32_t index_id, bool can_update = true);
79
80    lldb::ThreadSP
81    GetThreadSPForThreadPtr (Thread *thread_ptr);
82
83    bool
84    ShouldStop (Event *event_ptr);
85
86    Vote
87    ShouldReportStop (Event *event_ptr);
88
89    Vote
90    ShouldReportRun (Event *event_ptr);
91
92    void
93    RefreshStateAfterStop ();
94
95    //------------------------------------------------------------------
96    /// The thread list asks tells all the threads it is about to resume.
97    /// If a thread can "resume" without having to resume the target, it
98    /// will return false for WillResume, and then the process will not be
99    /// restarted.
100    ///
101    /// @return
102    ///    \b true instructs the process to resume normally,
103    ///    \b false means start & stopped events will be generated, but
104    ///    the process will not actually run.  The thread must then return
105    ///    the correct StopInfo when asked.
106    ///
107    //------------------------------------------------------------------
108    bool
109    WillResume ();
110
111    void
112    DidResume ();
113
114    void
115    DiscardThreadPlans();
116
117    uint32_t
118    GetStopID () const;
119
120    void
121    SetStopID (uint32_t stop_id);
122
123    Mutex &
124    GetMutex ()
125    {
126        return m_threads_mutex;
127    }
128
129    void
130    Update (ThreadList &rhs);
131
132protected:
133
134    void
135    NotifySelectedThreadChanged (lldb::tid_t tid);
136
137    typedef std::vector<lldb::ThreadSP> collection;
138    //------------------------------------------------------------------
139    // Classes that inherit from Process can see and modify these
140    //------------------------------------------------------------------
141    Process *m_process; ///< The process that manages this thread list.
142    uint32_t m_stop_id; ///< The process stop ID that this thread list is valid for.
143    collection m_threads; ///< The threads for this process.
144    mutable Mutex m_threads_mutex;
145    lldb::tid_t m_selected_tid;  ///< For targets that need the notion of a current thread.
146
147private:
148    ThreadList ();
149};
150
151} // namespace lldb_private
152
153#endif  // liblldb_ThreadList_h_
154