VILLASnode/fpga/include/villas/fpga/utils.hpp

/* Helper function for directly using VILLASfpga outside of VILLASnode
 * Author: Niklas Eiling <niklas.eiling@rwth-aachen.de>
 * SPDX-FileCopyrightText: 2022-2023 Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
 * SPDX-License-Identifier: Apache-2.0
 */

#pragma once

#include <string>
#include <villas/fpga/ips/aurora_xilinx.hpp>
#include <villas/fpga/ips/dma.hpp>
#include <villas/fpga/pcie_card.hpp>

namespace villas {
namespace fpga {

std::shared_ptr<fpga::Card> setupFpgaCard(const std::string &configFile,
                                          const std::string &fpgaName);

std::shared_ptr<fpga::Card>
createCard(json_t *config, const std::filesystem::path &searchPath,
           std::shared_ptr<kernel::vfio::Container> vfioContainer,
           std::string card_name = "anonymous Card");

int createCards(
    json_t *config, std::list<std::shared_ptr<fpga::Card>> &cards,
    const std::filesystem::path &searchPath,
    std::shared_ptr<kernel::vfio::Container> vfioContainer = nullptr);
int createCards(
    json_t *config, std::list<std::shared_ptr<fpga::Card>> &cards,
    const std::string &searchPath,
    std::shared_ptr<kernel::vfio::Container> vfioContainer = nullptr);

std::shared_ptr<std::vector<std::shared_ptr<fpga::ip::Node>>>
getAuroraChannels(std::shared_ptr<fpga::Card> card);

void setupColorHandling();

class ConnectString {
public:
  enum class ConnectType { AURORA, DMA, DINO, LOOPBACK };
  ConnectString(std::string &connectString, int maxPortNum = 7);
  void parseString(std::string &connectString);
  int portStringToInt(std::string &str) const;
  void configCrossBar(std::shared_ptr<villas::fpga::Card> card) const;
  bool isBidirectional() const { return bidirectional; };
  bool isDmaLoopback() const { return srcType == ConnectType::LOOPBACK; };
  bool isSrcStdin() const { return srcType == ConnectType::DMA; };
  bool isDstStdout() const { return dstType == ConnectType::DMA; };
  int getSrcAsInt() const { return srcAsInt; };
  int getDstAsInt() const { return dstAsInt; };
  static std::string connectTypeToString(ConnectType type) {
    static const std::string connectTypeStrings[] = {"aurora", "dma", "dino",
                                                     "loopback"};
    return connectTypeStrings[(int)type];
  }

protected:
  villas::Logger log;
  int maxPortNum;
  bool bidirectional;
  bool invert;
  ConnectType srcType;
  ConnectType dstType;
  int srcAsInt;
  int dstAsInt;
};

class BufferedSampleFormatter {
public:
  virtual void format(float value) = 0;
  virtual void output(std::ostream &out) {
    out << buf.data() << std::flush;
    clearBuf();
  }
  virtual void clearBuf() {
    for (size_t i = 0; i < bufSamples && buf[i * bufSampleSize] != '\0'; i++) {
      buf[i * bufSampleSize] = '\0';
    }
    currentBufLoc = 0;
  }

protected:
  std::vector<char> buf;
  const size_t bufSamples;
  const size_t bufSampleSize;
  size_t currentBufLoc;

  BufferedSampleFormatter(const size_t bufSamples, const size_t bufSampleSize)
      : buf(bufSamples * bufSampleSize + 1), // Leave room for a final `\0'
        bufSamples(bufSamples), bufSampleSize(bufSampleSize),
        currentBufLoc(0) {};
  BufferedSampleFormatter() = delete;
  BufferedSampleFormatter(const BufferedSampleFormatter &) = delete;
  virtual char *nextBufPos() { return &buf[(currentBufLoc++) * bufSampleSize]; }
};

class BufferedSampleFormatterShort : public BufferedSampleFormatter {
public:
  BufferedSampleFormatterShort(size_t bufSizeInSamples)
      : BufferedSampleFormatter(bufSizeInSamples, formatStringSize) {};

  virtual void format(float value) override {
    size_t chars;
    if ((chars = std::snprintf(nextBufPos(), formatStringSize + 1, formatString,
                               value)) > (int)formatStringSize) {
      throw RuntimeError("Output buffer too small. Expected " +
                         std::to_string(formatStringSize) +
                         " characters, got " + std::to_string(chars));
    }
  }

protected:
  static constexpr char formatString[] = "%013.6f\n";
  static constexpr size_t formatStringSize = 14;
};

class BufferedSampleFormatterLong : public BufferedSampleFormatter {
public:
  BufferedSampleFormatterLong(size_t bufSizeInSamples)
      : BufferedSampleFormatter(bufSizeInSamples, formatStringSize),
        sampleCnt(0) {};

  virtual void format(float value) override {
    if (std::snprintf(nextBufPos(), formatStringSize + 1, formatString,
                      sampleCnt, value) > (int)formatStringSize) {
      throw RuntimeError("Output buffer too small");
    }
    sampleCnt = (sampleCnt + 1) % 100000;
  }

protected:
  static constexpr char formatString[] = "%05zd: %013.6f\n";
  static constexpr size_t formatStringSize = 22;
  size_t sampleCnt;
};

std::unique_ptr<BufferedSampleFormatter>
getBufferedSampleFormatter(const std::string &format, size_t bufSizeInSamples);

} // namespace fpga
} // namespace villas