function.hpp

Go to the documentation of this file.

 
#pragma once
 
#include "datum.hpp"
#include "guard.hpp"
#include "imports.h"
#include "record.hpp"
#include "set.hpp"
#include "syscache.hpp"
#include "types.hpp"
#include "utils/function_traits.hpp"
#include "utils/utils.hpp"
#include "value.hpp"
 
#include <array>
#include <complex>
#include <iostream>
#include <stack>
#include <tuple>
#include <typeinfo>
 
namespace cppgres {
 
template <typename T>
concept convertible_into_nullable_datum_or_set_iterator_or_void =
    convertible_into_nullable_datum<T> || datumable_iterator<T> || std::same_as<T, void>;
 
template <typename Func>
concept datumable_function =
    requires { typename utils::function_traits::function_traits<Func>::argument_types; } &&
    all_from_nullable_datum<
        typename utils::function_traits::function_traits<Func>::argument_types>::value &&
    requires(Func f, utils::function_traits::function_traits<Func>::argument_types &&args) {
      { std::apply(f, args) } -> convertible_into_nullable_datum_or_set_iterator_or_void;
    };
 
struct function_call_info {
  function_call_info(::FunctionCallInfo info) : info_(info) {}
 
  operator FunctionCallInfo() const { return info_; }
 
  short nargs() const { return info_->nargs; }
 
  auto args() const {
    return std::views::iota(0, nargs()) | std::views::transform([this](int i) -> nullable_datum {
             return nullable_datum(info_->args[i]);
           });
  }
 
  auto arg_types() const {
    return std::views::iota(0, nargs()) | std::views::transform([this](int i) -> type {
             return {.oid = ffi_guard{::get_fn_expr_argtype}(info_->flinfo, i)};
           });
  }
 
  auto arg_values() const {
    return std::views::iota(0, nargs()) | std::views::transform([this](int i) -> value {
             return value(nullable_datum(info_->args[i]),
                          {.oid = ffi_guard{::get_fn_expr_argtype}(info_->flinfo, i)});
           });
  }
 
  oid called_function_oid() const { return info_->flinfo->fn_oid; }
 
  type return_type() const { return {.oid = ffi_guard{::get_fn_expr_rettype}(info_->flinfo)}; }
 
  oid collation() const { return info_->fncollation; }
 
private:
  ::FunctionCallInfo info_;
};
 
struct current_postgres_function {
 
  static std::optional<bool> atomic() {
    if (!calls.empty()) {
      auto ctx = calls.top()->context;
      if (ctx != nullptr && IsA(ctx, CallContext)) {
        return reinterpret_cast<::CallContext *>(ctx)->atomic;
      }
    }
 
    return std::nullopt;
  }
 
  static std::optional<function_call_info> call_info() {
    if (!calls.empty()) {
      return calls.top();
    }
 
    return std::nullopt;
  }
 
  template <datumable_function Func> friend struct postgres_function;
 
private:
  struct handle {
    ~handle() { calls.pop(); }
 
    friend struct current_postgres_function;
 
  private:
    handle() {}
  };
 
  static handle push(::FunctionCallInfo fcinfo) {
    calls.push(fcinfo);
    return handle{};
  }
  static void pop() { calls.pop(); }
 
  static inline std::stack<::FunctionCallInfo> calls;
};
 
template <datumable_function Func> struct postgres_function {
  Func func;
 
  explicit postgres_function(Func f) : func(f) {}
 
  // Use the function_traits to extract argument types.
  using traits = utils::function_traits::function_traits<Func>;
  using argument_types = typename traits::argument_types;
  using return_type = utils::function_traits::invoke_result_from_tuple_t<Func, argument_types>;
  static constexpr std::size_t arity = traits::arity;
 
  auto operator()(FunctionCallInfo fc) -> ::Datum {
 
    return exception_guard([&] {
      // return type
      auto rettype = type{.oid = ffi_guard{::get_fn_expr_rettype}(fc->flinfo)};
      auto retset = fc->flinfo->fn_retset;
 
      if constexpr (datumable_iterator<return_type>) {
        // Check this before checking the type of `retset`
        auto rsinfo = reinterpret_cast<::ReturnSetInfo *>(fc->resultinfo);
        if (rsinfo == nullptr) {
          report(ERROR, "caller is not expecting a set");
        }
      }
 
      if (!OidIsValid(rettype.oid)) {
        // TODO: not very efficient to look it up every time
        syscache<Form_pg_proc, oid> cache(fc->flinfo->fn_oid);
        rettype = type{.oid = (*cache).prorettype};
        retset = (*cache).proretset;
      }
 
      if (retset) {
        if constexpr (datumable_iterator<return_type>) {
          using set_value_type = set_iterator_traits<return_type>::value_type;
          if (!type_traits<set_value_type>().is(rettype)) {
            report(ERROR, "unexpected set's return type, can't convert `%s` into `%.*s`",
                   rettype.name().data(), utils::type_name<set_value_type>().length(),
                   utils::type_name<set_value_type>().data());
          }
        } else {
          report(ERROR,
                 "unexpected return type, set is expected, but `%.*s` does not conform to "
                 "`cppgres::datumable_iterator`",
                 utils::type_name<return_type>().length(), utils::type_name<return_type>().data());
        }
      } else if (!type_traits<return_type>().is(rettype)) {
        report(ERROR, "unexpected return type, can't convert `%s` into `%.*s`",
               rettype.name().data(), utils::type_name<return_type>().length(),
               utils::type_name<return_type>().data());
      }
 
      // arguments
      short accounted_for_args = 0;
      auto t = [&]<std::size_t... Is>(std::index_sequence<Is...>) {
        return argument_types{([&]() -> utils::tuple_element_t<Is, argument_types> {
          using ptyp = utils::tuple_element_t<Is, argument_types>;
          auto typ = type{.oid = ffi_guard{::get_fn_expr_argtype}(fc->flinfo, Is)};
          if (!OidIsValid(typ.oid)) {
            // TODO: not very efficient to look it up every time
            syscache<Form_pg_proc, oid> cache(fc->flinfo->fn_oid);
            if ((*cache).proargtypes.dim1 > Is) {
              typ = type{.oid = (*cache).proargtypes.values[Is]};
            }
          }
          if (!type_traits<ptyp>().is(typ)) {
            report(ERROR, "unexpected type in position %d, can't convert `%s` into `%.*s`", Is,
                   typ.name().data(), utils::type_name<ptyp>().length(),
                   utils::type_name<ptyp>().data());
          }
          accounted_for_args++;
          return from_nullable_datum<ptyp>(nullable_datum(fc->args[Is]), typ.oid);
        }())...};
      }(std::make_index_sequence<utils::tuple_size_v<argument_types>>{});
 
      if (arity != accounted_for_args) {
        report(ERROR, "expected %d arguments, got %d instead", arity, accounted_for_args);
      }
 
      auto call_handle = current_postgres_function::push(fc);
 
      if constexpr (datumable_iterator<return_type>) {
        auto rsinfo = reinterpret_cast<::ReturnSetInfo *>(fc->resultinfo);
        // TODO: For now, let's assume materialized model
        using set_value_type = set_iterator_traits<return_type>::value_type;
        if constexpr (std::same_as<set_value_type, record>) {
 
          auto natts = rsinfo->expectedDesc == nullptr ? -1 : rsinfo->expectedDesc->natts;
 
          rsinfo->returnMode = SFRM_Materialize;
 
          memory_context_scope scope(memory_context(rsinfo->econtext->ecxt_per_query_memory));
 
          ::Tuplestorestate *tupstore = ffi_guard{::tuplestore_begin_heap}(
              (rsinfo->allowedModes & SFRM_Materialize_Random) == SFRM_Materialize_Random, false,
              work_mem);
          rsinfo->setResult = tupstore;
 
          auto res = std::apply(func, t);
 
          bool checked = false;
          for (auto r : res) {
            auto nargs = r.attributes();
            if (!checked) {
              if (rsinfo->expectedDesc != nullptr && nargs != natts) {
                throw std::runtime_error(
                    cppgres::fmt::format("expected record with {} value{}, got {} instead", nargs,
                                nargs == 1 ? "" : "s", natts));
              }
              if (rsinfo->expectedDesc != nullptr &&
                  !r.get_tuple_descriptor().equal_types(
                      cppgres::tuple_descriptor(rsinfo->expectedDesc))) {
                throw std::runtime_error("expected and returned records do not match");
              }
              checked = true;
            }
 
            ffi_guard{::tuplestore_puttuple}(tupstore, r);
          }
          fc->isnull = true;
          return ::Datum(0);
        } else {
          constexpr auto nargs = utils::tuple_size_v<set_value_type>;
 
          auto natts = rsinfo->expectedDesc->natts;
 
          if (nargs != natts) {
            throw std::runtime_error(cppgres::fmt::format("expected set with {} value{}, got {} instead",
                                                 nargs, nargs == 1 ? "" : "s", natts));
          }
 
          [&]<std::size_t... Is>(std::index_sequence<Is...>) {
            (([&] {
               auto oid = ffi_guard{::SPI_gettypeid}(rsinfo->expectedDesc, Is + 1);
               auto t = type{.oid = oid};
               using typ = utils::tuple_element_t<Is, set_value_type>;
               if (!type_traits<typ>().is(t)) {
                 throw std::invalid_argument(
                     cppgres::fmt::format("invalid type in record's position {} ({}), got OID {}", Is,
                                 utils::type_name<typ>(), oid));
               }
             }()),
             ...);
          }(std::make_index_sequence<nargs>{});
 
          rsinfo->returnMode = SFRM_Materialize;
 
          memory_context_scope scope(memory_context(rsinfo->econtext->ecxt_per_query_memory));
 
          ::Tuplestorestate *tupstore = ffi_guard{::tuplestore_begin_heap}(
              (rsinfo->allowedModes & SFRM_Materialize_Random) == SFRM_Materialize_Random, false,
              work_mem);
          rsinfo->setResult = tupstore;
 
          auto result = std::apply(func, t);
 
          for (auto it : result) {
            CHECK_FOR_INTERRUPTS();
            std::array<::Datum, nargs> values = std::apply(
                [](auto &&...elems) -> std::array<::Datum, sizeof...(elems)> {
                  return {into_nullable_datum(elems)...};
                },
                utils::tie(it));
            std::array<bool, nargs> isnull = std::apply(
                [](auto &&...elems) -> std::array<bool, sizeof...(elems)> {
                  return {into_nullable_datum(elems).is_null()...};
                },
                utils::tie(it));
            ffi_guard{::tuplestore_putvalues}(tupstore, rsinfo->expectedDesc, values.data(),
                                              isnull.data());
          }
 
          fc->isnull = true;
          return ::Datum(0);
        }
      } else {
        if constexpr (std::same_as<return_type, void>) {
          std::apply(func, t);
          return ::Datum(0);
        } else {
          auto result = std::apply(func, t);
          nullable_datum nd = into_nullable_datum(result);
          if (nd.is_null()) {
            fc->isnull = true;
            return ::Datum(0);
          }
          return nd.operator const ::Datum &();
        }
      }
    })();
    __builtin_unreachable();
  }
};
 
template <has_type_traits ret_type, has_type_traits... arg_types> struct function {
 
  function() = delete;
 
  function(const char *schema, const char *name)
      : function([schema, name]() -> oid {
          return alloc_set_memory_context()([&schema, &name]() {
            ::List *fname = list_make2(::makeString(const_cast<char *>(schema)),
                                       ::makeString(const_cast<char *>(name)));
            std::array<::Oid, sizeof...(arg_types)> argtypes = {
                type_traits<arg_types>().type_for().oid...};
            return ffi_guard{::LookupFuncName}(fname, static_cast<int>(sizeof...(arg_types)),
                                               argtypes.data(), false);
          });
        }()) {}
  function(std::string &schema, std::string &name) : function(schema.c_str(), name.c_str()) {}
  explicit function(const char *name)
      : function([name]() -> oid {
          return alloc_set_memory_context()([&name]() {
            ::List *fname = list_make1(::makeString(const_cast<char *>(name)));
            std::array<::Oid, sizeof...(arg_types)> argtypes = {
                type_traits<arg_types>().type_for().oid...};
            return ffi_guard{::LookupFuncName}(fname, static_cast<int>(sizeof...(arg_types)),
                                               argtypes.data(), false);
          });
        }()) {}
  function(std::string &name) : function(name.c_str()) {}
  function(oid oid) : oid_(oid) {
    syscache<Form_pg_proc, decltype(oid)> p(oid_);
    // Check arguments
    auto &argtypes = (*p).proargtypes;
    std::array<type, sizeof...(arg_types)> types = {type_traits<arg_types>().type_for()...};
    for (int i = 0; i < argtypes.dim1; i++) {
      cppgres::oid arg(argtypes.values[i]);
      if (types[i] != type{UNKNOWNOID} /* FIXME: figure out how to avoid this special case */ &&
          arg != types[i].oid) {
        throw std::runtime_error(cppgres::fmt::format("expected type {} for argument {}, got {}",
                                                      types[i].name(), i, type{.oid = arg}.name()));
      }
    }
    // Check return type
    rettype_ = (*p).prorettype;
    if (type_traits<ret_type>().type_for().oid !=
            UNKNOWNOID /* FIXME: figure out how to avoid this special case */
        && rettype_ != type_traits<ret_type>().type_for().oid) {
      throw std::runtime_error(cppgres::fmt::format("expected return type {}, got {}",
                                                    type_traits<ret_type>().type_for().name(),
                                                    type{.oid = rettype_}.name()));
    }
    strict_ = (*p).proisstrict;
  }
 
  using self = function<ret_type, arg_types...>;
  template <typename... Args> static constexpr bool convertible_args() {
    if constexpr (sizeof...(Args) != sizeof...(arg_types)) {
      return false;
    } else {
      return []<std::size_t... I>(std::index_sequence<I...>) {
        return (std::convertible_to<std::decay_t<Args>,
                                    std::tuple_element_t<I, std::tuple<arg_types...>>> &&
                ...);
      }(std::make_index_sequence<sizeof...(Args)>{});
    }
  }
  ret_type operator()(auto... args) requires(self::convertible_args<decltype(args)...>())
  {
    bool any_nulls = false;
    auto optval = []<std::size_t I>(auto arg) -> ::Datum {
      using nth_type = std::tuple_element_t<I, std::tuple<arg_types...>>;
      if constexpr (std::same_as<std::nullopt_t, decltype(arg)>) {
        return datum(0);
      } else if constexpr (!utils::is_optional<decltype(arg)>) {
        return datum_conversion<nth_type>().into_datum(arg);
      } else {
        return arg.has_value() ? datum_conversion<nth_type>().into_datum(arg.value()) : datum(0);
      }
      return datum(0);
    };
    auto isnull = [&any_nulls](auto arg) {
      if constexpr (std::same_as<std::nullopt_t, decltype(arg)>) {
        any_nulls = true;
        return true;
      } else if constexpr (!utils::is_optional<decltype(arg)>) {
        return false;
      } else {
        any_nulls = !arg.has_value();
        return !arg.has_value();
      }
      return false;
    };
    return [&]<std::size_t... I>(std::index_sequence<I...>) -> ret_type {
      LOCAL_FCINFO(fcinfo, sizeof...(args));
      ::FmgrInfo flinfo;
 
      ffi_guard{::fmgr_info}(oid_, &flinfo);
 
      InitFunctionCallInfoData(*fcinfo, &flinfo, sizeof...(args), InvalidOid, nullptr, nullptr);
 
      ((fcinfo->args[I].value = optval.template operator()<I>(args)), ...);
      ((fcinfo->args[I].isnull = isnull(args)), ...);
 
      if (any_nulls && strict_) {
        if constexpr (utils::is_optional<ret_type>) {
          return std::nullopt;
        } else {
          throw null_datum_exception();
        }
      }
 
      nullable_datum result(ffi_guard{[&fcinfo]() { return FunctionCallInvoke(fcinfo); }}());
      if (fcinfo->isnull) {
        result = nullable_datum();
      }
 
      return datum_conversion<ret_type>().from_nullable_datum(result, rettype_);
    }(std::make_index_sequence<sizeof...(args)>{});
  }
 
  const oid &function_oid() const { return oid_; }
 
private:
  oid oid_;
  oid rettype_;
  bool strict_;
};
 
template <has_type_traits ret, has_type_traits... Args>
struct datum_conversion<function<ret, Args...>> : default_datum_conversion<function<ret, Args...>> {
  static function<ret, Args...> from_datum(const datum &d, oid, std::optional<memory_context> ctx) {
    return {oid(d)};
  }
 
  static datum into_datum(const function<ret, Args...> &t) {
    return datum_conversion<oid>::into_datum(t.function_oid());
  }
};
 
template <has_type_traits ret, has_type_traits... Args> struct type_traits<function<ret, Args...>> {
  static bool is(const type &t) {
    return t.oid == REGPROCEDUREOID || t.oid == OIDOID || t.oid == REGPROCOID;
  }
  static constexpr type type_for() { return type{.oid = REGPROCEDUREOID}; }
};
 
template <has_type_traits T> function<const char *, T> output_function() {
  ::Oid foutoid;
  bool typisvarlena;
  ffi_guard{::getTypeOutputInfo}(type_traits<T>().type_for().oid, &foutoid, &typisvarlena);
  return function<const char *, T>(foutoid);
}
 
template <has_type_traits T> function<const char *, T> output_function(T &&v) {
  ::Oid foutoid;
  bool typisvarlena;
  ffi_guard{::getTypeOutputInfo}(type_traits<T>(v).type_for().oid, &foutoid, &typisvarlena);
  return function<const char *, T>(foutoid);
}
 
template <has_type_traits T> function<const char *, T> output_function(T &v) {
  ::Oid foutoid;
  bool typisvarlena;
  ffi_guard{::getTypeOutputInfo}(type_traits<T>(v).type_for().oid, &foutoid, &typisvarlena);
  return function<const char *, T>(foutoid);
}
 
static function<const char *, cppgres::value> output_function(const type &t) {
  ::Oid foutoid;
  bool typisvarlena;
  ffi_guard{::getTypeOutputInfo}(t.oid, &foutoid, &typisvarlena);
  return function<const char *, cppgres::value>(foutoid);
}
 
} // namespace cppgres