HAL  v4.5.0-83-g30c8f0afc
The Hardware Analyzer - a comprehensive reverse engineering and manipulation framework for gate-level netlists.
saleae_parser.h
Go to the documentation of this file.
1 // MIT License
2 //
3 // Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
4 // Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
5 // Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
6 // Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
7 //
8 // Permission is hereby granted, free of charge, to any person obtaining a copy
9 // of this software and associated documentation files (the "Software"), to deal
10 // in the Software without restriction, including without limitation the rights
11 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 // copies of the Software, and to permit persons to whom the Software is
13 // furnished to do so, subject to the following conditions:
14 //
15 // The above copyright notice and this permission notice shall be included in all
16 // copies or substantial portions of the Software.
17 //
18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 // SOFTWARE.
25 
26 #pragma once
27 #include <map>
28 #include <unordered_map>
29 #include <functional>
30 #include <string>
31 #ifdef STANDALONE_PARSER
32 #include "saleae_directory.h"
33 #include "saleae_file.h"
34 #else
37 #endif
38 
39 namespace hal
40 {
41  class SaleaeInputFile;
42 
43 #ifdef STANDALONE_PARSER
47  class Net
48  {
49  uint32_t mId;
50  std::string mName;
51  public:
52  Net(const std::string n, uint32_t i=0) : mId(i), mName(n) {;}
53  uint32_t get_id() const { return mId; }
54  std::string get_name() const { return mName; }
55  };
56 #else
57  class Net;
58 #endif
59 
74  {
75  SaleaeDirectory mSaleaeDirectory;
76  static std::string strim(std::string s);
80  struct DataFileHandle {
81  std::function<void(void*obj, uint64_t, int)> callback;
82  SaleaeInputFile* file;
83  int value;
84  void* obj;
85  };
86  std::multimap<uint64_t,DataFileHandle> mNextValueMap;
87 
88  public:
93  SaleaeParser(const std::string& filename);
94 
96  uint64_t get_max_time() const;
97 
106  bool register_callback(const std::string& name, uint32_t id, std::function<void(void*,uint64_t, int)> callback, void* obj);
107 
115  bool register_callback(const Net* net, std::function<void(void*,uint64_t, int)> callback, void* obj);
116 
118  bool next_event();
119 
121  SaleaeDirectory get_directory() const { return mSaleaeDirectory; }
122 
124  static uint64_t sTimeScaleFactor;
125  };
126 }
Definition: net.h:58
u32 get_id() const
Definition: net.cpp:88
const std::string & get_name() const
Definition: net.cpp:98
The SaleaeDirectory class provides the API for the SALEAE directory file. The SALEAE directory file w...
The SaleaeParser class is an engine which allows to parse any number of SALEAE files into a sequence ...
Definition: saleae_parser.h:74
bool next_event()
Call to parser to deliver next event via registered callbacks (see above).
bool register_callback(const std::string &name, uint32_t id, std::function< void(void *, uint64_t, int)> callback, void *obj)
Registers callback which gets executed upon next_event()
uint64_t get_max_time() const
Get last simulated time from SALEAE directory.
SaleaeDirectory get_directory() const
Getter for SALEAE directory instance.
static uint64_t sTimeScaleFactor
conversion factor to be applied when converting double values from original SALEAE file to integer va...
SaleaeParser(const std::string &filename)
Definition: defines.h:45
Net * net
std::string name