Codec.h

Go to the documentation of this file.

/*
 * Copyright 2022 HEAVY.AI, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef QUERYENGINE_CODEC_H
#define QUERYENGINE_CODEC_H

#include <llvm/IR/IRBuilder.h>
#include <llvm/IR/Module.h>
#include <llvm/IR/Value.h>

#include "../Shared/sqltypes.h"

class Decoder {
 public:
  virtual llvm::Instruction* codegenDecode(llvm::Value* byte_stream,
                                           llvm::Value* pos,
                                           llvm::Module* llvm_module) const = 0;
  virtual ~Decoder() {}
};

class FixedWidthInt : public Decoder {
 public:
  FixedWidthInt(const size_t byte_width);
  llvm::Instruction* codegenDecode(llvm::Value* byte_stream,
                                   llvm::Value* pos,
                                   llvm::Module* llvm_module) const override;

 private:
  const size_t byte_width_;
};

class FixedWidthUnsigned : public Decoder {
 public:
  FixedWidthUnsigned(const size_t byte_width);
  llvm::Instruction* codegenDecode(llvm::Value* byte_stream,
                                   llvm::Value* pos,
                                   llvm::Module* llvm_module) const override;

 private:
  const size_t byte_width_;
};

class DiffFixedWidthInt : public Decoder {
 public:
  DiffFixedWidthInt(const size_t byte_width, const int64_t baseline);
  llvm::Instruction* codegenDecode(llvm::Value* byte_stream,
                                   llvm::Value* pos,
                                   llvm::Module* llvm_module) const override;

 private:
  const size_t byte_width_;
  const int64_t baseline_;
};

class FixedWidthReal : public Decoder {
 public:
  FixedWidthReal(const bool is_double);
  llvm::Instruction* codegenDecode(llvm::Value* byte_stream,
                                   llvm::Value* pos,
                                   llvm::Module* llvm_module) const override;

 private:
  const bool is_double_;
};

class FixedWidthSmallDate : public Decoder {
 public:
  FixedWidthSmallDate(const size_t byte_width);
  llvm::Instruction* codegenDecode(llvm::Value* byte_stream,
                                   llvm::Value* pos,
                                   llvm::Module* llvm_module) const override;

 private:
  const size_t byte_width_;
  const int32_t null_val_;
  static constexpr int64_t ret_null_val_ = NULL_BIGINT;
};

#endif  // QUERYENGINE_CODEC_H