1 //===-- QueueList.h --------------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef liblldb_QueueList_h_
11 #define liblldb_QueueList_h_
15 #include "lldb/lldb-private.h"
16 #include "lldb/Core/UserID.h"
17 #include "lldb/Utility/Iterable.h"
20 namespace lldb_private {
22 //------------------------------------------------------------------
24 // This is the container for libdispatch aka Grand Central Dispatch
27 // Each Process will have a QueueList. When the process execution is
28 // paused, the QueueList may be populated with Queues by the
30 //------------------------------------------------------------------
38 QueueList (Process *process);
42 //------------------------------------------------------------------
43 /// Get the number of libdispatch queues that are available
46 /// The number of queues that are stored in the QueueList.
47 //------------------------------------------------------------------
51 //------------------------------------------------------------------
52 /// Get the Queue at a given index number
55 /// The index number (0-based) of the queue.
57 /// The Queue at that index number.
58 //------------------------------------------------------------------
60 GetQueueAtIndex (uint32_t idx);
62 typedef std::vector<lldb::QueueSP> collection;
63 typedef LockingAdaptedIterable<collection, lldb::QueueSP, vector_adapter> QueueIterable;
65 //------------------------------------------------------------------
66 /// Iterate over the list of queues
69 /// An Iterable object which can be used to loop over the queues
71 //------------------------------------------------------------------
75 return QueueIterable(m_queues, m_mutex);
78 //------------------------------------------------------------------
79 /// Clear out the list of queues from the QueueList
80 //------------------------------------------------------------------
84 //------------------------------------------------------------------
85 /// Add a Queue to the QueueList
88 /// Used by the SystemRuntime to populate the QueueList
89 //------------------------------------------------------------------
91 AddQueue (lldb::QueueSP queue);
93 //------------------------------------------------------------------
94 /// Find a queue in the QueueList by QueueID
97 /// The QueueID (same as returned by Thread::GetQueueID()) to find.
100 /// A QueueSP to the queue requested, if it is present in the QueueList.
101 /// An empty QueueSP willbe returned if this queue was not found.
102 //------------------------------------------------------------------
104 FindQueueByID (lldb::queue_id_t qid);
106 //------------------------------------------------------------------
107 /// Find a queue in the QueueList by IndexID
109 /// @param [in] index_id
110 /// Find a queue by IndexID. This is an integer associated with each
111 /// unique queue seen during a debug session and will not be reused
112 /// for a different queue. Unlike the QueueID, a 64-bit value, this
113 /// will tend to be an integral value like 1 or 7.
116 /// A QueueSP to the queue requested, if it is present in the QueueList.
117 /// An empty QueueSP willbe returned if this queue was not found.
118 //------------------------------------------------------------------
120 FindQueueByIndexID (uint32_t index_id);
122 lldb_private::Mutex &
127 //------------------------------------------------------------------
128 // Classes that inherit from Process can see and modify these
129 //------------------------------------------------------------------
130 Process *m_process; ///< The process that manages this queue list.
131 uint32_t m_stop_id; ///< The process stop ID that this queue list is valid for.
132 collection m_queues; ///< The queues for this process.
139 } // namespace lldb_private
141 #endif // liblldb_QueueList_h_