OmniSciDB  ba1bac9284
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
NRings.h
Go to the documentation of this file.
1 /*
2  * Copyright 2021 OmniSci, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #pragma once
18 
20 
21 namespace spatial_type {
22 
23 class NRings : public Codegen {
24  public:
25  NRings(const Analyzer::GeoOperator* geo_operator,
26  const Catalog_Namespace::Catalog* catalog)
27  : Codegen(geo_operator, catalog) {}
28 
29  size_t size() const final { return 1; }
30 
32 
34  // we expect this to only be called after codegening the loads
36  return operand_owned_.get();
37  }
38 
39  const Analyzer::Expr* getOperand(const size_t index) final {
40  CHECK_EQ(index, size_t(0));
41  if (operand_owned_) {
42  return operand_owned_.get();
43  }
44 
45  const auto operand = operator_->getOperand(0);
46  auto col_var = dynamic_cast<const Analyzer::ColumnVar*>(operand);
47  CHECK(col_var);
48 
49  const auto& geo_ti = col_var->get_type_info();
50  CHECK(geo_ti.is_geometry());
51  is_nullable_ = !geo_ti.get_notnull();
52 
53  // create a new operand which is just the ring sizes and codegen it
54  const auto ring_sizes_column_id = col_var->get_column_id() + 2; // + 2 for ring sizes
55  auto ring_sizes_cd =
56  get_column_descriptor(ring_sizes_column_id, col_var->get_table_id(), *cat_);
57  CHECK(ring_sizes_cd);
58 
59  operand_owned_ = std::make_unique<Analyzer::ColumnVar>(ring_sizes_cd->columnType,
60  col_var->get_table_id(),
61  ring_sizes_column_id,
62  col_var->get_rte_idx());
63  return operand_owned_.get();
64  }
65 
66  // returns arguments lvs and null lv
67  std::tuple<std::vector<llvm::Value*>, llvm::Value*> codegenLoads(
68  const std::vector<llvm::Value*>& arg_lvs,
69  llvm::Value* pos_lv,
70  CgenState* cgen_state) final {
71  CHECK_EQ(arg_lvs.size(), size_t(1));
72  auto& argument_lv = arg_lvs.front();
73  std::string fn_name("array_size");
74 
75  const auto& elem_ti = getOperand(0)->get_type_info().get_elem_type();
76  std::vector<llvm::Value*> array_size_args{
77  argument_lv, pos_lv, cgen_state->llInt(log2_bytes(elem_ti.get_logical_size()))};
78 
79  const bool is_nullable = isNullable();
80 
81  if (is_nullable) {
82  fn_name += "_nullable";
83  array_size_args.push_back(cgen_state->inlineIntNull(getTypeInfo()));
84  }
85  const auto total_num_rings_lv = cgen_state->emitExternalCall(
86  fn_name, get_int_type(32, cgen_state->context_), array_size_args);
87  return std::make_tuple(std::vector<llvm::Value*>{total_num_rings_lv},
88  total_num_rings_lv);
89  }
90 
91  std::vector<llvm::Value*> codegen(const std::vector<llvm::Value*>& args,
92  CodeGenerator::NullCheckCodegen* nullcheck_codegen,
93  CgenState* cgen_state) final {
94  CHECK_EQ(args.size(), size_t(1));
95  if (isNullable()) {
96  CHECK(nullcheck_codegen);
97  return {nullcheck_codegen->finalize(cgen_state->inlineIntNull(getTypeInfo()),
98  args.front())};
99  }
100  return {args.front()};
101  }
102 
103  protected:
104  std::unique_ptr<Analyzer::ColumnVar> operand_owned_;
105 };
106 
107 } // namespace spatial_type
#define CHECK_EQ(x, y)
Definition: Logger.h:214
const Analyzer::Expr * getPositionOperand() const final
Definition: NRings.h:33
class for a per-database catalog. also includes metadata for the current database and the current use...
Definition: Catalog.h:102
#define const
llvm::Type * get_int_type(const int width, llvm::LLVMContext &context)
auto getTypeInfo() const
Definition: Codegen.h:36
std::vector< llvm::Value * > codegen(const std::vector< llvm::Value * > &args, CodeGenerator::NullCheckCodegen *nullcheck_codegen, CgenState *cgen_state) final
Definition: NRings.h:91
NRings(const Analyzer::GeoOperator *geo_operator, const Catalog_Namespace::Catalog *catalog)
Definition: NRings.h:25
size_t size() const final
Definition: NRings.h:29
const Catalog_Namespace::Catalog * cat_
Definition: Codegen.h:65
auto isNullable() const
Definition: Codegen.h:34
const SQLTypeInfo & get_type_info() const
Definition: Analyzer.h:78
SQLTypeInfo getNullType() const final
Definition: NRings.h:31
std::tuple< std::vector< llvm::Value * >, llvm::Value * > codegenLoads(const std::vector< llvm::Value * > &arg_lvs, llvm::Value *pos_lv, CgenState *cgen_state) final
Definition: NRings.h:67
const Analyzer::GeoOperator * operator_
Definition: Codegen.h:64
#define CHECK(condition)
Definition: Logger.h:206
Analyzer::Expr * getOperand(const size_t index) const
Definition: Analyzer.cpp:3449
const Analyzer::Expr * getOperand(const size_t index) final
Definition: NRings.h:39
uint32_t log2_bytes(const uint32_t bytes)
Definition: Execute.h:177
Definition: sqltypes.h:44
SQLTypeInfo get_elem_type() const
Definition: sqltypes.h:713
const ColumnDescriptor * get_column_descriptor(const int col_id, const int table_id, const Catalog_Namespace::Catalog &cat)
Definition: Execute.h:192
std::unique_ptr< Analyzer::ColumnVar > operand_owned_
Definition: NRings.h:104