saleae_file.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 <fstream>
#include <functional>
#ifdef STANDALONE_PARSER
#include "saleae_directory.h"
#else
#include "netlist_simulator_controller/saleae_directory.h"
#endif
 
namespace hal
{
    class SaleaeStatus
    {
    public:
        enum ErrorCode { ErrorOpenFile = -4,
                         BadIndentifier = -3,
                         UnsupportedType = -2,
                         UnexpectedEof = -1,
                         Ok = 0};
    };
 
    class SaleaeHeader
    {
    public:
        enum StorageFormat { Double = 0,          
                             Uint64 = 0x206c6168,
                             Coded = 0x786c6168 };
        char mIdent[9];
        int32_t mVersion;
        StorageFormat mStorageFormat;
        int32_t mValue;
        uint64_t mBeginTime;
        uint64_t mEndTime;
        uint64_t mNumTransitions;
 
        static const char* sIdent;
    public:
        SaleaeHeader();
 
        SaleaeStatus::ErrorCode read(std::ifstream& ff);
 
        SaleaeStatus::ErrorCode write(std::ofstream& of) const;
 
        StorageFormat storageFormat() const { return mStorageFormat; }
 
        void setStorageFormat(StorageFormat sf) { mStorageFormat = sf; }
 
        int32_t value() const { return mValue; }
 
        void setValue(int32_t v) { mValue = v; }
 
        uint64_t beginTime() const { return mBeginTime; }
 
        void setBeginTime(uint64_t t) { mBeginTime = t; }
 
        uint64_t endTime() const { return mEndTime; }
 
        void setEndTime(uint64_t t) { mEndTime = t; }
 
        uint64_t numTransitions() const { return mNumTransitions; }
 
        void setNumTransitions(uint64_t n) { mNumTransitions = n; }
 
        void incrementTransitions() { ++mNumTransitions; }
    };
 
    class SaleaeDataBuffer
    {
    public:
        SaleaeDataBuffer(uint64_t cnt = 0);
 
        ~SaleaeDataBuffer();
 
        uint64_t mCount;
 
        uint64_t* mTimeArray;
 
        int* mValueArray;
 
        bool isNull() const { return mCount == 0; }
 
        void convertCoded();
 
        void dump() const;
    };
 
    class SaleaeDataTuple
    {
    public:
        SaleaeDataTuple(uint64_t t=0, int val=sReadError) : mTime(t), mValue(val) {;}
 
        static const int sReadError = -99;
 
        uint64_t mTime;
 
        int mValue;
 
        bool readError() const { return mValue == sReadError; }
    };
 
    class SaleaeInputFile : public std::ifstream
    {
        SaleaeHeader mHeader;
        uint64_t mReadPointer;
        SaleaeStatus::ErrorCode mStatus;
 
        std::function<uint64_t(bool*)> mReader;
 
        void seekTransition(uint64_t pos) { seekg(pos*sizeof(uint64_t) + 44); }
    public:
        SaleaeInputFile(const std::string& filename);
 
        SaleaeDataTuple get_next_value();
 
        std::string get_last_error() const;
 
        SaleaeDataBuffer* get_buffered_data(uint64_t nread);
 
 
        int64_t get_file_position(double t, bool successor=false);
 
        void set_file_position(int64_t pos);
 
        void skip_transitions(int64_t delta);
 
        int get_int_value(double t);
 
        const SaleaeHeader* header() const { return &mHeader; }
    };
 
 
    class SaleaeOutputFile : public std::ofstream
    {
        int mIndex;
        std::string mFilename;
        SaleaeHeader mHeader;
        SaleaeStatus::ErrorCode mStatus;
        bool mFirstValue;
        int mLastWrittenValue;
        uint64_t mLastWrittenTime;
 
        void convertToCoded();
    public:
        SaleaeOutputFile(const std::string& filename, int index_);
        ~SaleaeOutputFile();
 
        void writeTimeValue(uint64_t t, int32_t val);
 
        void close();
 
        int index() const { return mIndex; }
 
        void put_data(SaleaeDataBuffer* buf);
 
        SaleaeDirectoryFileIndex fileIndex() const;
    };
}