PacketManager.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* ngscopeclient                                                                                                        *
*                                                                                                                      *
* Copyright (c) 2012-2026 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/
 
#ifndef PacketManager_h
#define PacketManager_h
 
#include "../../lib/scopehal/PacketDecoder.h"
#include "Marker.h"
#include "TextureManager.h"
 
class Session;
 
class RowData
{
public:
    RowData()
    : m_height(0)
    , m_totalHeight(0)
    , m_stamp(0, 0)
    , m_packet(nullptr)
    , m_marker(TimePoint(0,0), 0, "")
    {}
 
    RowData(TimePoint t, Packet* p)
    : m_height(0)
    , m_totalHeight(0)
    , m_stamp(t)
    , m_packet(p)
    , m_marker(t, 0, "")
    {}
 
    RowData(TimePoint t, const Marker& m)
    : m_height(0)
    , m_totalHeight(0)
    , m_stamp(t)
    , m_packet(nullptr)
    , m_marker(m)
    {}
 
    double m_height;
 
    double m_totalHeight;
 
    TimePoint m_stamp;
 
    Packet* m_packet;
 
    Marker m_marker;
 
    std::shared_ptr<Texture> m_texture;
};
 
class ProtocolDisplayFilter;
 
class ProtocolDisplayFilterClause
{
public:
    ProtocolDisplayFilterClause(const std::string& str, size_t& i);
    ProtocolDisplayFilterClause(const ProtocolDisplayFilterClause&) =delete;
    ProtocolDisplayFilterClause& operator=(const ProtocolDisplayFilterClause&) =delete;
 
    virtual ~ProtocolDisplayFilterClause();
 
    bool Validate(const std::vector<std::string>& headers);
 
    std::string Evaluate(const Packet* pack);
 
    static std::string EatSpaces(const std::string& str);
 
    enum
    {
        TYPE_DATA,
        TYPE_IDENTIFIER,
        TYPE_STRING,
        TYPE_REAL,
        TYPE_INT,
        TYPE_EXPRESSION,
        TYPE_ERROR
    } m_type;
 
    std::string m_identifier;
    std::string m_string;
    float m_real;
    long m_long;
    ProtocolDisplayFilter* m_expression;
    bool m_invert;
};
 
class ProtocolDisplayFilter
{
public:
    ProtocolDisplayFilter(const std::string& str, size_t& i);
    ProtocolDisplayFilter(const ProtocolDisplayFilterClause&) =delete;
    ProtocolDisplayFilter& operator=(const ProtocolDisplayFilter&) =delete;
    virtual ~ProtocolDisplayFilter();
 
    static void EatSpaces(const std::string& str, size_t& i);
 
    bool Validate(const std::vector<std::string>& headers, bool nakedLiteralOK = false);
 
    bool Match(const Packet* pack);
    std::string Evaluate(const Packet* pack);
 
protected:
    std::vector<ProtocolDisplayFilterClause*> m_clauses;
    std::vector<std::string> m_operators;
};
 
class PacketManager
{
public:
    PacketManager(PacketDecoder* pd, Session& session);
    virtual ~PacketManager();
 
    void Update();
    void RemoveHistoryFrom(TimePoint timestamp);
 
    std::recursive_mutex& GetMutex()
    { return m_mutex; }
 
    const std::map<TimePoint, std::vector<Packet*> >& GetPackets()
    { return m_packets; }
 
    const std::vector<Packet*>& GetChildPackets(Packet* pack)
    { return m_childPackets[pack]; }
 
    const std::map<TimePoint, std::vector<Packet*> >& GetFilteredPackets()
    {
        if(m_filterExpression == nullptr)
            return m_packets;
        else
            return m_filteredPackets;
    }
 
    const std::map<Packet*, std::vector<Packet*> >& GetFilteredChildPackets()
    {
        if(m_filterExpression == nullptr)
            return m_childPackets;
        else
            return m_filteredChildPackets;
    }
 
    const std::vector<Packet*>& GetFilteredChildPackets(Packet* pack)
    {
        if(m_filterExpression == nullptr)
            return m_childPackets[pack];
        else
            return m_filteredChildPackets[pack];
    }
 
    void SetDisplayFilter(std::shared_ptr<ProtocolDisplayFilter> filter)
    {
        m_filterExpression = filter;
        FilterPackets();
    }
 
    void FilterPackets();
 
    bool IsChildOpen(Packet* pack)
    { return m_lastChildOpen[pack]; }
 
    void SetChildOpen(Packet* pack, bool open)
    { m_lastChildOpen[pack] = open; }
 
    std::vector<RowData>& GetRows()
    {
        RefreshIfPending();
        return m_rows;
    }
 
    void OnMarkerChanged();
 
    void RefreshIfPending()
    {
        std::lock_guard<std::recursive_mutex> lock(m_mutex);
        if(m_refreshPending)
        {
            LogTrace("Refreshing rows for %s due to pending changes\n", m_filter->GetDisplayName().c_str());
            RefreshRows();
        }
    }
 
protected:
    void RemoveChildHistoryFrom(Packet* pack);
 
    Session& m_session;
 
    std::recursive_mutex m_mutex;
 
    PacketDecoder* m_filter;
 
    std::map<TimePoint, std::vector<Packet*> > m_packets;
 
    std::map<Packet*, std::vector<Packet*> > m_childPackets;
 
    std::map<TimePoint, std::vector<Packet*> > m_filteredPackets;
 
    std::map<Packet*, std::vector<Packet*> > m_filteredChildPackets;
 
    WaveformCacheKey m_cachekey;
 
    std::shared_ptr<ProtocolDisplayFilter> m_filterExpression;
 
    void RefreshRows();
 
    std::vector<RowData> m_rows;
 
    std::map<Packet*, bool> m_lastChildOpen;
 
    bool m_refreshPending;
};
 
#endif