OmniSciDB  a575cb28ea
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ExtensionFunctionsWhitelist.h
Go to the documentation of this file.
1 /*
2  * Copyright 2017 MapD Technologies, 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 /*
18  * @file ExtensionFunctionsWhitelist.h
19  * @author Alex Suhan <alex@mapd.com>
20  * @brief Supported runtime functions management and retrieval.
21  *
22  * Copyright (c) 2016 MapD Technologies, Inc. All rights reserved.
23  */
24 
25 #ifndef QUERYENGINE_EXTENSIONFUNCTIONSWHITELIST_H
26 #define QUERYENGINE_EXTENSIONFUNCTIONSWHITELIST_H
27 
28 #include <string>
29 #include <unordered_map>
30 #include <unordered_set>
31 #include <vector>
32 
33 #include "Shared/sqltypes.h"
34 #include "Shared/toString.h"
35 
36 enum class ExtArgumentType {
37  Int8,
38  Int16,
39  Int32,
40  Int64,
41  Float,
42  Double,
43  Void,
44  PInt8,
45  PInt16,
46  PInt32,
47  PInt64,
48  PFloat,
49  PDouble,
50  PBool,
51  Bool,
52  ArrayInt8,
53  ArrayInt16,
54  ArrayInt32,
55  ArrayInt64,
56  ArrayFloat,
58  ArrayBool,
59  GeoPoint,
61  Cursor,
62  GeoPolygon,
64  ColumnInt8,
70  ColumnBool,
75 };
76 
78 
80  public:
81  ExtensionFunction(const std::string& name,
82  const std::vector<ExtArgumentType>& args,
83  const ExtArgumentType ret)
84  : name_(name), args_(args), ret_(ret) {}
85 
86  const std::string getName(bool keep_suffix = true) const;
87 
88  const std::vector<ExtArgumentType>& getArgs() const { return args_; }
89  const std::vector<ExtArgumentType>& getInputArgs() const { return args_; }
90 
91  const ExtArgumentType getRet() const { return ret_; }
92  std::string toString() const;
93  std::string toStringSQL() const;
94 
95  inline bool isGPU() const {
96  return (name_.find("_cpu_", name_.find("__")) == std::string::npos);
97  }
98  inline bool isCPU() const {
99  return (name_.find("_gpu_", name_.find("__")) == std::string::npos);
100  }
101 
102  private:
103  const std::string name_;
104  const std::vector<ExtArgumentType> args_;
106 };
107 
109  public:
110  static void add(const std::string& json_func_sigs);
111 
112  static void addUdfs(const std::string& json_func_sigs);
113 
114  static void clearRTUdfs();
115  static void addRTUdfs(const std::string& json_func_sigs);
116 
117  static std::vector<ExtensionFunction>* get(const std::string& name);
118 
119  static std::vector<ExtensionFunction>* get_udf(const std::string& name);
120 
121  static std::vector<ExtensionFunction> get_ext_funcs(const std::string& name,
122  const bool is_gpu);
123 
124  static std::vector<ExtensionFunction> get_ext_funcs(const std::string& name,
125  size_t arity);
126 
127  static std::vector<ExtensionFunction> get_ext_funcs(const std::string& name,
128  size_t arity,
129  const SQLTypeInfo& rtype);
130 
131  static std::string toString(const std::vector<ExtensionFunction>& ext_funcs,
132  std::string tab = "");
133  static std::string toString(const std::vector<SQLTypeInfo>& arg_types);
134  static std::string toString(const std::vector<ExtArgumentType>& sig_types);
135  static std::string toStringSQL(const std::vector<ExtArgumentType>& sig_types);
136  static std::string toString(const ExtArgumentType& sig_type);
137  static std::string toStringSQL(const ExtArgumentType& sig_type);
138 
139  static std::vector<std::string> getLLVMDeclarations(
140  const std::unordered_set<std::string>& udf_decls);
141 
142  private:
143  static void addCommon(
144  std::unordered_map<std::string, std::vector<ExtensionFunction>>& sigs,
145  const std::string& json_func_sigs);
146 
147  private:
148  // Compiletime UDFs defined in ExtensionFunctions.hpp
149  static std::unordered_map<std::string, std::vector<ExtensionFunction>> functions_;
150  // Loadtime UDFs defined via omnisci server --udf argument
151  static std::unordered_map<std::string, std::vector<ExtensionFunction>> udf_functions_;
152  // Runtime UDFs defined via thrift interface.
153  static std::unordered_map<std::string, std::vector<ExtensionFunction>>
155 };
156 
157 std::string toString(const ExtArgumentType& sig_type);
158 
159 #endif // QUERYENGINE_EXTENSIONFUNCTIONSWHITELIST_H
static std::vector< ExtensionFunction > get_ext_funcs(const std::string &name, const bool is_gpu)
static void addUdfs(const std::string &json_func_sigs)
const std::vector< ExtArgumentType > & getArgs() const
std::string toString(const ExtArgumentType &sig_type)
static std::unordered_map< std::string, std::vector< ExtensionFunction > > udf_functions_
const ExtArgumentType getRet() const
static std::unordered_map< std::string, std::vector< ExtensionFunction > > rt_udf_functions_
const std::vector< ExtArgumentType > args_
static void add(const std::string &json_func_sigs)
Constants for Builtin SQL Types supported by OmniSci.
const std::string getName(bool keep_suffix=true) const
std::string toStringSQL() const
static std::unordered_map< std::string, std::vector< ExtensionFunction > > functions_
static std::vector< ExtensionFunction > * get_udf(const std::string &name)
ExtensionFunction(const std::string &name, const std::vector< ExtArgumentType > &args, const ExtArgumentType ret)
static void addCommon(std::unordered_map< std::string, std::vector< ExtensionFunction >> &sigs, const std::string &json_func_sigs)
const std::vector< ExtArgumentType > & getInputArgs() const
const ExtArgumentType ret_
static std::string toString(const std::vector< ExtensionFunction > &ext_funcs, std::string tab="")
static std::vector< std::string > getLLVMDeclarations(const std::unordered_set< std::string > &udf_decls)
string name
Definition: setup.py:44
SQLTypeInfo ext_arg_type_to_type_info(const ExtArgumentType ext_arg_type)
static std::string toStringSQL(const std::vector< ExtArgumentType > &sig_types)
static void addRTUdfs(const std::string &json_func_sigs)