aboutsummaryrefslogtreecommitdiff
path: root/include/lldb/Core/Broadcaster.h
blob: 8e59a41805ecee2d5c5e5282290e3eacb0aa7a98 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
//===-- Broadcaster.h -------------------------------------------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

#ifndef liblldb_Broadcaster_h_
#define liblldb_Broadcaster_h_

// C Includes
// C++ Includes
#include <map>
#include <string>
#include <vector>

// Other libraries and framework includes
// Project includes
#include "lldb/lldb-private.h"
//#include "lldb/Core/Flags.h"
#include "lldb/Core/ConstString.h"
#include "lldb/Core/Listener.h"

namespace lldb_private {

//----------------------------------------------------------------------
// lldb::BroadcastEventSpec
//
// This class is used to specify a kind of event to register for.  The Debugger
// maintains a list of BroadcastEventSpec's and when it is made
//----------------------------------------------------------------------
class BroadcastEventSpec
{
public:
    BroadcastEventSpec (const ConstString &broadcaster_class, uint32_t event_bits) :
        m_broadcaster_class (broadcaster_class),
        m_event_bits (event_bits)
    {
    }
    
    BroadcastEventSpec (const BroadcastEventSpec &rhs);
    
    ~BroadcastEventSpec() = default;
        
    const ConstString &GetBroadcasterClass() const
    {
        return m_broadcaster_class;
    }
    
    uint32_t GetEventBits () const
    {
        return m_event_bits;
    }
    
    // Tell whether this BroadcastEventSpec is contained in in_spec.
    // That is: 
    // (a) the two spec's share the same broadcaster class
    // (b) the event bits of this spec are wholly contained in those of in_spec.
    bool IsContainedIn (BroadcastEventSpec in_spec) const
    {
        if (m_broadcaster_class != in_spec.GetBroadcasterClass())
            return false;
        uint32_t in_bits = in_spec.GetEventBits();
        if (in_bits == m_event_bits)
            return true;
        else
        {
            if ((m_event_bits & in_bits) != 0
                && (m_event_bits & ~in_bits) == 0)
                    return true;
        }
        return false;
    }
    
    bool operator< (const BroadcastEventSpec &rhs) const;
    const BroadcastEventSpec &operator= (const BroadcastEventSpec &rhs);
    
private:
    ConstString m_broadcaster_class;
    uint32_t m_event_bits;
};

class BroadcasterManager
{
public:
    friend class Listener;

    BroadcasterManager ();

    ~BroadcasterManager() = default;

    uint32_t
    RegisterListenerForEvents (Listener &listener, BroadcastEventSpec event_spec);
    
    bool
    UnregisterListenerForEvents (Listener &listener, BroadcastEventSpec event_spec);
    
    Listener *
    GetListenerForEventSpec (BroadcastEventSpec event_spec) const;
    
    void
    SignUpListenersForBroadcaster (Broadcaster &broadcaster);
    
    void
    RemoveListener (Listener &Listener);

protected:
    void Clear();
    
private:
    typedef std::pair<BroadcastEventSpec, Listener *> event_listener_key;
    typedef std::map<BroadcastEventSpec, Listener *> collection;
    typedef std::set<Listener *> listener_collection;
    collection m_event_map;
    listener_collection m_listeners;
    
    Mutex m_manager_mutex;

    // A couple of comparator classes for find_if:
    
    class BroadcasterClassMatches
    {
    public:
        BroadcasterClassMatches (const ConstString &broadcaster_class) : 
            m_broadcaster_class (broadcaster_class) 
        {
        }
        
        ~BroadcasterClassMatches() = default;
        
        bool operator() (const event_listener_key input) const 
        {
            return (input.first.GetBroadcasterClass() == m_broadcaster_class);
        }
        
    private:
        ConstString m_broadcaster_class;
    };

    class BroadcastEventSpecMatches
    {
    public:
        BroadcastEventSpecMatches (BroadcastEventSpec broadcaster_spec) : 
            m_broadcaster_spec (broadcaster_spec) 
        {
        }
        
        ~BroadcastEventSpecMatches() = default;
        
        bool operator() (const event_listener_key input) const 
        {
            return (input.first.IsContainedIn (m_broadcaster_spec));
        }
        
    private:
        BroadcastEventSpec m_broadcaster_spec;
    };
    
    class ListenerMatchesAndSharedBits
    {
    public:
        ListenerMatchesAndSharedBits (BroadcastEventSpec broadcaster_spec, 
                                                   const Listener &listener) : 
            m_broadcaster_spec (broadcaster_spec),
            m_listener (&listener) 
        {
        }
        
        ~ListenerMatchesAndSharedBits() = default;
        
        bool operator() (const event_listener_key input) const 
        {
            return (input.first.GetBroadcasterClass() == m_broadcaster_spec.GetBroadcasterClass()
                    && (input.first.GetEventBits() & m_broadcaster_spec.GetEventBits()) != 0
                    && input.second == m_listener);
        }
        
    private:
        BroadcastEventSpec m_broadcaster_spec;
        const Listener *m_listener;
    };
    
    class ListenerMatches
    {
    public:
        ListenerMatches (const Listener &in_listener) :
            m_listener (&in_listener)
        {
        }
        
        ~ListenerMatches() = default;
        
        bool operator () (const event_listener_key input) const
        {
            if (input.second == m_listener)
                return true;
            else
                return false;
        }
        
    private:
        const Listener *m_listener;
    
    };
};

//----------------------------------------------------------------------
/// @class Broadcaster Broadcaster.h "lldb/Core/Broadcaster.h"
/// @brief An event broadcasting class.
///
/// The Broadcaster class is designed to be subclassed by objects that
/// wish to vend events in a multi-threaded environment. Broadcaster
/// objects can each vend 32 events. Each event is represented by a bit
/// in a 32 bit value and these bits can be set:
///     @see Broadcaster::SetEventBits(uint32_t)
/// or cleared:
///     @see Broadcaster::ResetEventBits(uint32_t)
/// When an event gets set the Broadcaster object will notify the
/// Listener object that is listening for the event (if there is one).
///
/// Subclasses should provide broadcast bit definitions for any events
/// they vend, typically using an enumeration:
///     \code
///         class Foo : public Broadcaster
///         {
///         public:
///         //----------------------------------------------------------
///         // Broadcaster event bits definitions.
///         //----------------------------------------------------------
///         enum
///         {
///             eBroadcastBitStateChanged   = (1 << 0),
///             eBroadcastBitInterrupt      = (1 << 1),
///             eBroadcastBitSTDOUT         = (1 << 2),
///             eBroadcastBitSTDERR         = (1 << 3),
///             eBroadcastBitProfileData    = (1 << 4)
///         };
///     \endcode
//----------------------------------------------------------------------
class Broadcaster
{
public:
    //------------------------------------------------------------------
    /// Construct with a broadcaster with a name.
    ///
    /// @param[in] name
    ///     A NULL terminated C string that contains the name of the
    ///     broadcaster object.
    //------------------------------------------------------------------
    Broadcaster (BroadcasterManager *manager, const char *name);

    //------------------------------------------------------------------
    /// Destructor.
    ///
    /// The destructor is virtual since this class gets subclassed.
    //------------------------------------------------------------------
    virtual
    ~Broadcaster();

    void
    CheckInWithManager ();
    
    //------------------------------------------------------------------
    /// Broadcast an event which has no associated data.
    ///
    /// @param[in] event_type
    ///     The element from the enum defining this broadcaster's events
    ///     that is being broadcast.
    ///
    /// @param[in] event_data
    ///     User event data that will be owned by the lldb::Event that
    ///     is created internally.
    ///
    /// @param[in] unique
    ///     If true, then only add an event of this type if there isn't
    ///     one already in the queue.
    ///
    //------------------------------------------------------------------
    void
    BroadcastEvent (lldb::EventSP &event_sp);

    void
    BroadcastEventIfUnique (lldb::EventSP &event_sp);

    void
    BroadcastEvent(uint32_t event_type, EventData *event_data = nullptr);

    void
    BroadcastEventIfUnique(uint32_t event_type, EventData *event_data = nullptr);

    void
    Clear();

    virtual void
    AddInitialEventsToListener (Listener *listener, uint32_t requested_events);

    //------------------------------------------------------------------
    /// Listen for any events specified by \a event_mask.
    ///
    /// Only one listener can listen to each event bit in a given
    /// Broadcaster. Once a listener has acquired an event bit, no
    /// other broadcaster will have access to it until it is
    /// relinquished by the first listener that gets it. The actual
    /// event bits that get acquired by \a listener may be different
    /// from what is requested in \a event_mask, and to track this the
    /// actual event bits that are acquired get returned.
    ///
    /// @param[in] listener
    ///     The Listener object that wants to monitor the events that
    ///     get broadcast by this object.
    ///
    /// @param[in] event_mask
    ///     A bit mask that indicates which events the listener is
    ///     asking to monitor.
    ///
    /// @return
    ///     The actual event bits that were acquired by \a listener.
    //------------------------------------------------------------------
    uint32_t
    AddListener (Listener* listener, uint32_t event_mask);

    //------------------------------------------------------------------
    /// Get the NULL terminated C string name of this Broadcaster
    /// object.
    ///
    /// @return
    ///     The NULL terminated C string name of this Broadcaster.
    //------------------------------------------------------------------
    const ConstString &
    GetBroadcasterName ();

    //------------------------------------------------------------------
    /// Get the event name(s) for one or more event bits.
    ///
    /// @param[in] event_mask
    ///     A bit mask that indicates which events to get names for.
    ///
    /// @return
    ///     The NULL terminated C string name of this Broadcaster.
    //------------------------------------------------------------------
    bool
    GetEventNames (Stream &s, const uint32_t event_mask, bool prefix_with_broadcaster_name) const;

    //------------------------------------------------------------------
    /// Set the name for an event bit.
    ///
    /// @param[in] event_mask
    ///     A bit mask that indicates which events the listener is
    ///     asking to monitor.
    ///
    /// @return
    ///     The NULL terminated C string name of this Broadcaster.
    //------------------------------------------------------------------
    void
    SetEventName (uint32_t event_mask, const char *name)
    {
        m_event_names[event_mask] = name;
    }
    
    const char *
    GetEventName (uint32_t event_mask) const
    {
        const auto pos = m_event_names.find (event_mask);
        if (pos != m_event_names.end())
            return pos->second.c_str();
        return nullptr;
    }

    bool
    EventTypeHasListeners (uint32_t event_type);

    //------------------------------------------------------------------
    /// Removes a Listener from this broadcasters list and frees the
    /// event bits specified by \a event_mask that were previously
    /// acquired by \a listener (assuming \a listener was listening to
    /// this object) for other listener objects to use.
    ///
    /// @param[in] listener
    ///     A Listener object that previously called AddListener.
    ///
    /// @param[in] event_mask
    ///     The event bits \a listener wishes to relinquish.
    ///
    /// @return
    ///     \b True if the listener was listening to this broadcaster
    ///     and was removed, \b false otherwise.
    ///
    /// @see uint32_t Broadcaster::AddListener (Listener*, uint32_t)
    //------------------------------------------------------------------
    bool
    RemoveListener (Listener* listener, uint32_t event_mask = UINT32_MAX);
    
    //------------------------------------------------------------------
    /// Provides a simple mechanism to temporarily redirect events from 
    /// broadcaster.  When you call this function passing in a listener and
    /// event type mask, all events from the broadcaster matching the mask
    /// will now go to the hijacking listener.
    /// Only one hijack can occur at a time.  If we need more than this we
    /// will have to implement a Listener stack.
    ///
    /// @param[in] listener
    ///     A Listener object.  You do not need to call StartListeningForEvents
    ///     for this broadcaster (that would fail anyway since the event bits
    ///     would most likely be taken by the listener(s) you are usurping.
    ///
    /// @param[in] event_mask
    ///     The event bits \a listener wishes to hijack.
    ///
    /// @return
    ///     \b True if the event mask could be hijacked, \b false otherwise.
    ///
    /// @see uint32_t Broadcaster::AddListener (Listener*, uint32_t)
    //------------------------------------------------------------------
    bool
    HijackBroadcaster (Listener *listener, uint32_t event_mask = UINT32_MAX);
    
    bool
    IsHijackedForEvent (uint32_t event_mask);

    //------------------------------------------------------------------
    /// Restore the state of the Broadcaster from a previous hijack attempt.
    ///
    //------------------------------------------------------------------
    void
    RestoreBroadcaster ();
    
    // This needs to be filled in if you are going to register the broadcaster with the broadcaster
    // manager and do broadcaster class matching.
    // FIXME: Probably should make a ManagedBroadcaster subclass with all the bits needed to work
    // with the BroadcasterManager, so that it is clearer how to add one.
    virtual ConstString &GetBroadcasterClass() const;
    
    BroadcasterManager *GetManager();

protected:
    void
    PrivateBroadcastEvent (lldb::EventSP &event_sp, bool unique);

    //------------------------------------------------------------------
    // Classes that inherit from Broadcaster can see and modify these
    //------------------------------------------------------------------
    typedef std::vector< std::pair<Listener*,uint32_t> > collection;
    typedef std::map<uint32_t, std::string> event_names_map;
    // Prefix the name of our member variables with "m_broadcaster_"
    // since this is a class that gets subclassed.
    const ConstString m_broadcaster_name;   ///< The name of this broadcaster object.
    event_names_map m_event_names;  ///< Optionally define event names for readability and logging for each event bit
    collection m_listeners;     ///< A list of Listener / event_mask pairs that are listening to this broadcaster.
    Mutex m_listeners_mutex;    ///< A mutex that protects \a m_listeners.
    std::vector<Listener *> m_hijacking_listeners;  // A simple mechanism to intercept events from a broadcaster 
    std::vector<uint32_t> m_hijacking_masks;        // At some point we may want to have a stack or Listener
                                                    // collections, but for now this is just for private hijacking.
    BroadcasterManager *m_manager;
    
private:
    //------------------------------------------------------------------
    // For Broadcaster only
    //------------------------------------------------------------------
    DISALLOW_COPY_AND_ASSIGN (Broadcaster);
};

} // namespace lldb_private

#endif  // liblldb_Broadcaster_h_