xiiregexbuilder

FPGA-Accelerated Regular Expression Matching Engine
git clone https://github.com/maydayv7/xiiregexbuilder

emitter.h (2324B)

 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
#ifndef EMITTER_H
#define EMITTER_H

#include <vector>
#include <string>
#include <memory>
#include "nfa.h"

#include <filesystem>
#include <system_error>

class Emitter
{
public:
    Emitter() = delete; // Static class, no instances

    /**
     * @brief Emits all Verilog files to the specified directory.
     * @param nfas           The vector of NFAs to be emitted.
     * @param outputDir      Directory where files will be written.
     * @param testStrings    Optional test strings for the testbench.
     * @param expectedMatches Optional expected match masks for the testbench.
     */
    static void emit(const std::vector<std::unique_ptr<NFA>> &nfas,
                     const std::string &outputDir,
                     const std::vector<std::string> &testStrings = {},
                     const std::vector<std::string> &expectedMatches = {},
                     bool isPII = false);

private:
    static void emitNFAModule(const NFA &nfa, const std::filesystem::path &outputDir, bool isPII);
    static void emitTopModule(const std::vector<std::unique_ptr<NFA>> &nfas, const std::filesystem::path &outputDir);
    static void emitTestbench(const std::vector<std::unique_ptr<NFA>> &nfas,
                              const std::filesystem::path &outputDir,
                              const std::vector<std::string> &testStrings,
                              const std::vector<std::string> &expectedMatches);

    // UART RX receiver
    static void emitUARTRX(const std::filesystem::path &outputDir);

    // UART TX transmitter
    static void emitUARTTX(const std::filesystem::path &outputDir);

    // Circular FIFO buffer between uart_rx and the NFA engine
    static void emitFIFO(const std::filesystem::path &outputDir);

    // Top FPGA module
    static void emitTopFPGA(const std::vector<std::unique_ptr<NFA>> &nfas, const std::filesystem::path &outputDir);

    // PII Guard specifics
    static void emitPIIUART(const std::filesystem::path &outputDir);
    static void emitPIIUARTTx(const std::filesystem::path &outputDir);
    static void emitPIITopFPGA(const std::vector<std::unique_ptr<NFA>> &nfas, const std::filesystem::path &outputDir);

    static void emitConstraints(const std::vector<std::unique_ptr<NFA>> &nfas, const std::filesystem::path &outputDir);
};

#endif // EMITTER_H