GpuSharedMemoryUtils.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.
 */

#pragma once

#include <string>
#include <vector>

#include <llvm/IR/Function.h>
#include <llvm/IR/IRBuilder.h>
#include <llvm/IR/InstIterator.h>
#include <llvm/IR/Module.h>
#include <llvm/IR/Value.h>
#include <llvm/Linker/Linker.h>
#include <llvm/Transforms/Utils/BasicBlockUtils.h>

#include "Descriptors/QueryMemoryDescriptor.h"
#include "IRCodegenUtils.h"
#include "Logger/Logger.h"
#include "ResultSet.h"
#include "Shared/TargetInfo.h"

class GpuSharedMemCodeBuilder {
 public:
  GpuSharedMemCodeBuilder(llvm::Module* module,
                          llvm::LLVMContext& context,
                          const QueryMemoryDescriptor& qmd,
                          const std::vector<TargetInfo>& targets,
                          const std::vector<int64_t>& init_agg_values,
                          const size_t executor_id);
  void codegen();

  void injectFunctionsInto(llvm::Function* query_func);

  llvm::Function* getReductionFunction() const { return reduction_func_; }
  llvm::Function* getInitFunction() const { return init_func_; }
  std::string toString() const;

 protected:
  void codegenReduction();
  void codegenInitialization();
  llvm::Function* createReductionFunction() const;
  llvm::Function* createInitFunction() const;
  llvm::Function* getFunction(const std::string& func_name) const;

  size_t executor_id_;
  llvm::Module* module_;
  llvm::LLVMContext& context_;
  llvm::Function* reduction_func_;
  llvm::Function* init_func_;
  const QueryMemoryDescriptor query_mem_desc_;
  const std::vector<TargetInfo> targets_;
  const std::vector<int64_t> init_agg_values_;
};