baseSerDes.h

Go to the documentation of this file.

//=== SerDes/baseSerDes.h - Base for serialization and deserialization C++ ===//
//
// Part of the MLCompilerBridge Project, under the Apache License v2.0 with LLVM
// Exceptions. See the LICENSE file for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//===----------------------------------------------------------------------===//
 
#ifndef BASE_SERDES_H
#define BASE_SERDES_H
 
#include "MLModelRunner/Utils/Debug.h"
#include "google/protobuf/extension_set.h"
#include "google/protobuf/message.h"
#include "llvm/Support/raw_ostream.h"
 
#include <cassert>
#include <map>
#include <string>
#include <vector>
 
// TYPE, NAME
#define SUPPORTED_TYPES(M)                                                     \
  M(int, int)                                                                  \
  M(long, long)                                                                \
  M(float, float)                                                              \
  M(double, double)                                                            \
  M(std::string, string)                                                       \
  M(bool, bool)
 
namespace MLBridge {
enum class SerDesKind : int { Unknown, Json, Bitstream, Protobuf, Tensorflow };
class BaseSerDes {
public:
  SerDesKind getKind() const { return Type; }
 
#define SET_FEATURE(TYPE, _)                                                   \
  virtual void setFeature(const std::string &, const TYPE) = 0;                \
  virtual void setFeature(const std::string &, const std::vector<TYPE> &){};
  SUPPORTED_TYPES(SET_FEATURE)
#undef SET_FEATURE
 
  virtual void setFeature(const std::string &name,
                          const google::protobuf::Message *value){};
  virtual void
  setFeature(const std::string &name,
             const std::vector<google::protobuf::Message *> &value){};
 
  // a hack to set the request and response structures in protobuf serializer
  virtual void setRequest(void *Request) {
    MLBRIDGE_DEBUG(std::cout << "In BaseSerializer setRequest...\n");
  };
  virtual void setResponse(void *Response){};
  virtual void *getSerializedData() = 0;
  virtual void *deserializeUntyped(void *data) = 0;
  size_t getMessageLength() { return MessageLength; }
  virtual void *getRequest() { return nullptr; };
  virtual void *getResponse() { return nullptr; };
 
protected:
  BaseSerDes(SerDesKind Type) : Type(Type) {
    assert(Type != SerDesKind::Unknown);
  }
  virtual void cleanDataStructures() = 0;
  const SerDesKind Type;
  void *RequestVoid;
  void *ResponseVoid;
  size_t MessageLength;
};
} // namespace MLBridge
 
#endif