saleae_directory.h

Go to the documentation of this file.

// MIT License
// 
// Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
// Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
// Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
#include <string>
#include <vector>
#include <unordered_map>
#include <cstdint>
 
// unfortunately std::filesystem::path is not available for all platforms
#ifdef _WIN32
const char folderSeparator = '\\';
#else
const char folderSeparator = '/';
#endif
 
namespace hal
{
    class SaleaeDirectory;
 
#ifndef STANDALONE_PARSER
    class SaleaeDirectoryStoreRequest
    {
    private:
        SaleaeDirectory* mSaleaeDirectory;
        SaleaeDirectoryStoreRequest(const SaleaeDirectoryStoreRequest&) {;} // disable copy constructor
    public:
        SaleaeDirectoryStoreRequest(SaleaeDirectory* sd);
 
        ~SaleaeDirectoryStoreRequest();
 
        static bool sWriteDisabled;
    };
#endif
 
    class SaleaeDirectoryFileIndex
    {
        int      mIndex;
        uint64_t mBeginTime;
        uint64_t mEndTime;
        uint64_t mNumberValues;
    public:
        SaleaeDirectoryFileIndex(int inx, uint64_t tBeg=0, uint64_t tEnd=0, uint64_t nval=0)
            : mIndex(inx), mBeginTime(tBeg), mEndTime(tEnd), mNumberValues(nval) {;}
 
        int index() const { return mIndex; }
 
        uint64_t beginTime() const { return mBeginTime; }
 
        uint64_t endTime() const { return mEndTime; }
 
        uint64_t numberValues() const { return mNumberValues; }
    };
 
    class SaleaeDirectoryNetEntry
    {
        friend class SaleaeDirectory;
    public:
        enum Type { None, Group, Boolean, Trigger };
    protected:
        uint32_t   mId;
        std::string mName;
        Type mType;
        std::vector<SaleaeDirectoryFileIndex> mFileIndexes;
    public:
        SaleaeDirectoryNetEntry(const std::string nam, uint32_t id_=0, Type tp=None)
            : mId(id_), mName(nam), mType(tp) {;}
 
        virtual ~SaleaeDirectoryNetEntry() {;}
 
        uint32_t id() const { return mId; }
 
        std::string name() const { return mName; }
 
        Type type() const { return mType; }
 
        const std::vector<SaleaeDirectoryFileIndex>& indexes() const { return mFileIndexes; }
 
        void addIndex(const SaleaeDirectoryFileIndex& sdfe) { mFileIndexes.push_back(sdfe); }
 
        void rename(const std::string nam) { mName = nam; }
 
        int dataFileIndex() const; // TODO : time as argument
 
        int uniqueKey() const;
 
        static const int sComposedBaseKey = 1 << 16;
    };
 
    class SaleaeDirectoryComposedEntry : public SaleaeDirectoryNetEntry
    {
        friend class SaleaeDirectory;
    private:
        std::vector<int> mChildKeys;
        std::vector<int> mData;
        int mFilterEntry;
    public:
        SaleaeDirectoryComposedEntry(const std::string nam=std::string(), uint32_t id_=0, Type tp=None)
            : SaleaeDirectoryNetEntry(nam,id_,tp), mFilterEntry(0) {;}
        SaleaeDirectoryComposedEntry(const SaleaeDirectoryComposedEntry& other);
        ~SaleaeDirectoryComposedEntry();
 
        void add_child(int key) { mChildKeys.push_back(key); }
 
        void remove_child(int key);
 
        const std::vector<int>& get_children() const {return mChildKeys; }
 
        const std::vector<int>& get_data() const { return mData; }
 
        void set_data(const std::vector<int>& dat);
 
        int get_filter_entry() const { return mFilterEntry; }
 
        void set_filter_entry(int filt) { mFilterEntry = filt; }
 
        bool isNull() const { return !mId || !mType; }
 
        void dump() const;
    };
 
    class SaleaeDirectory
    {
        friend class SaleaeDirectoryStoreRequest;
    public:
        struct ListEntry
        {
            uint32_t id;
            std::string name;
            int fileIndex;
            uint64_t size;
        };
    private:
        std::string mDirectoryFile;
        std::vector<SaleaeDirectoryNetEntry> mNetEntries;
        std::unordered_map<int,SaleaeDirectoryComposedEntry> mComposedEntryMap;
 
        std::unordered_map<uint32_t,int> mById;
        std::unordered_map<std::string, int> mByName;
 
        int getIndex(const SaleaeDirectoryNetEntry& sdnep) const;
        int mNextAvailableIndex;
        int mStoreRequest;
#ifndef STANDALONE_PARSER
        bool write_json() const;
#endif
    public:
        SaleaeDirectory(const std::string& path, bool create=false);
 
        bool parse_json();
 
        void add_or_replace_net(SaleaeDirectoryNetEntry& sdne);
 
        void clearAll();
 
        std::vector<SaleaeDirectoryNetEntry> dump() const;
 
        void update_file_indexes(std::unordered_map<int, SaleaeDirectoryFileIndex>& fileIndexes);
 
        void rename_net(uint32_t id, const std::string& nam);
 
        std::string get_datafile_name(int index) const;
 
        std::string get_datafile_path(int index) const;
 
        std::string get_datafile_path(const std::string& nam, uint32_t id) const;
 
        int get_datafile_index(const std::string& nam, uint32_t id) const;
 
        int get_next_available_index() const { return mNextAvailableIndex; }
 
        uint64_t get_max_time() const;
 
        std::string get_directory() const;
 
        std::string get_filename() const;
 
        std::vector<ListEntry> get_net_list() const;
 
        void add_or_replace_composed(SaleaeDirectoryComposedEntry sdce);
 
        void remove_composed(uint32_t id, SaleaeDirectoryNetEntry::Type tp);
 
        SaleaeDirectoryComposedEntry get_composed(uint32_t id, SaleaeDirectoryNetEntry::Type tp) const;
 
        std::vector<SaleaeDirectoryComposedEntry> get_composed_list() const;
    };
}