ThreadList.h revision d9919d3f46c5069eef065a27f96abc021330d5f3 
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 (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);
55
56    bool
57    SetSelectedThreadByIndexID (uint32_t index_id);
58
59    void
60    Clear();
61
62    // Note that "idx" is not the same as the "thread_index". It is a zero
63    // based index to accessing the current threads, whereas "thread_index"
64    // is a unique index assigned
65    lldb::ThreadSP
66    GetThreadAtIndex (uint32_t idx, bool can_update = true);
67
68    lldb::ThreadSP
69    FindThreadByID (lldb::tid_t tid, bool can_update = true);
70
71    lldb::ThreadSP
72    FindThreadByIndexID (uint32_t index_id, bool can_update = true);
73
74    lldb::ThreadSP
75    GetThreadSPForThreadPtr (Thread *thread_ptr);
76
77    bool
78    ShouldStop (Event *event_ptr);
79
80    Vote
81    ShouldReportStop (Event *event_ptr);
82
83    Vote
84    ShouldReportRun (Event *event_ptr);
85
86    void
87    RefreshStateAfterStop ();
88
89    bool
90    WillResume ();
91
92    void
93    DidResume ();
94
95    void
96    DiscardThreadPlans();
97
98    uint32_t
99    GetStopID () const;
100
101    void
102    SetStopID (uint32_t stop_id);
103
104    Mutex &
105    GetMutex ()
106    {
107        return m_threads_mutex;
108    }
109
110    void
111    Update (ThreadList &rhs);
112
113protected:
114
115    typedef std::vector<lldb::ThreadSP> collection;
116    //------------------------------------------------------------------
117    // Classes that inherit from Process can see and modify these
118    //------------------------------------------------------------------
119    Process *m_process; ///< The process that manages this thread list.
120    uint32_t m_stop_id; ///< The process stop ID that this thread list is valid for.
121    collection m_threads; ///< The threads for this process.
122    mutable Mutex m_threads_mutex;
123    lldb::tid_t m_selected_tid;  ///< For targets that need the notion of a current thread.
124
125private:
126    ThreadList ();
127};
128
129} // namespace lldb_private
130
131#endif  // liblldb_ThreadList_h_
132