anonymous_namespace{ArrowResultSetConverter.cpp} Namespace Reference

Classes
class	null_type
struct	null_type< TYPE, std::enable_if_t< std::is_floating_point< TYPE >::value > >
struct	null_type< TYPE, std::enable_if_t< std::is_integral< TYPE >::value > >

Typedefs
template<typename TYPE >
using	null_type_t = typename null_type< TYPE >::type

Functions
SQLTypes	get_dict_index_type (const SQLTypeInfo &ti)
SQLTypes	get_physical_type (const SQLTypeInfo &ti)
template<typename TYPE , typename VALUE_ARRAY_TYPE >
void	create_or_append_value (const ScalarTargetValue &val_cty, std::shared_ptr< ValueArray > &values, const size_t max_size)
template<typename TYPE >
void	create_or_append_validity (const ScalarTargetValue &value, const SQLTypeInfo &col_type, std::shared_ptr< std::vector< bool >> &null_bitmap, const size_t max_size)
template<typename C_TYPE , typename ARROW_TYPE = typename CTypeTraits<C_TYPE>::ArrowType>
void	convert_column (ResultSetPtr result, size_t col, std::unique_ptr< int8_t[]> &values, std::unique_ptr< uint8_t[]> &is_valid, size_t entry_count, std::shared_ptr< Array > &out)
std::pair< key_t, void * >	get_shm (size_t shmsz)
std::pair< key_t, std::shared_ptr< Buffer > >	get_shm_buffer (size_t size)
std::shared_ptr< arrow::DataType >	get_arrow_type (const SQLTypeInfo &sql_type, const ExecutorDeviceType device_type)
template<typename BUILDER_TYPE , typename VALUE_ARRAY_TYPE >
void	appendToColumnBuilder (ArrowResultSetConverter::ColumnBuilder &column_builder, const ValueArray &values, const std::shared_ptr< std::vector< bool >> &is_valid)
template<>
void	appendToColumnBuilder< arrow::StringDictionary32Builder, int32_t > (ArrowResultSetConverter::ColumnBuilder &column_builder, const ValueArray &values, const std::shared_ptr< std::vector< bool >> &is_valid)

Typedef Documentation

null_type_t

template<typename TYPE >

using anonymous_namespace{ArrowResultSetConverter.cpp}::null_type_t = typedef typename null_type<TYPE>::type

Definition at line 156 of file ArrowResultSetConverter.cpp.

Function Documentation

appendToColumnBuilder()

template<typename BUILDER_TYPE , typename VALUE_ARRAY_TYPE >

void anonymous_namespace{ArrowResultSetConverter.cpp}::appendToColumnBuilder	(	ArrowResultSetConverter::ColumnBuilder &	column_builder,
		const ValueArray &	values,
		const std::shared_ptr< std::vector< bool >> &	is_valid
	)

Definition at line 1031 of file ArrowResultSetConverter.cpp.

References ARROW_THROW_NOT_OK, ArrowResultSetConverter::ColumnBuilder::builder, CHECK, ArrowResultSetConverter::ColumnBuilder::field, DateConverters::get_epoch_days_from_seconds(), and kMilliSecsPerSec.

                                                                           {
  static_assert(!std::is_same<BUILDER_TYPE, arrow::StringDictionary32Builder>::value,
                "Dictionary encoded string builder requires function specialization.");

  std::vector<VALUE_ARRAY_TYPE> vals = boost::get<std::vector<VALUE_ARRAY_TYPE>>(values);

  if (scale_epoch_values<BUILDER_TYPE>()) {
    auto scale_sec_to_millisec = [](auto seconds) { return seconds * kMilliSecsPerSec; };
    auto scale_values = [&](auto epoch) {
      return std::is_same<BUILDER_TYPE, Date32Builder>::value
                 ? DateConverters::get_epoch_days_from_seconds(epoch)
                 : scale_sec_to_millisec(epoch);
    };
    std::transform(vals.begin(), vals.end(), vals.begin(), scale_values);
  }

  auto typed_builder = dynamic_cast<BUILDER_TYPE*>(column_builder.builder.get());
  CHECK(typed_builder);
  if (column_builder.field->nullable()) {
    CHECK(is_valid.get());
    ARROW_THROW_NOT_OK(typed_builder->AppendValues(vals, *is_valid));
  } else {
    ARROW_THROW_NOT_OK(typed_builder->AppendValues(vals));
  }
}

Here is the call graph for this function:

appendToColumnBuilder< arrow::StringDictionary32Builder, int32_t >()

template<>

void anonymous_namespace{ArrowResultSetConverter.cpp}::appendToColumnBuilder< arrow::StringDictionary32Builder, int32_t >	(	ArrowResultSetConverter::ColumnBuilder &	column_builder,
		const ValueArray &	values,
		const std::shared_ptr< std::vector< bool >> &	is_valid
	)

Definition at line 1060 of file ArrowResultSetConverter.cpp.

References ARROW_THROW_NOT_OK, and CHECK.

                                                    {
  auto typed_builder =
      dynamic_cast<arrow::StringDictionary32Builder*>(column_builder.builder.get());
  CHECK(typed_builder);

  std::vector<int32_t> vals = boost::get<std::vector<int32_t>>(values);

  if (column_builder.field->nullable()) {
    CHECK(is_valid.get());
    // TODO(adb): Generate this instead of the boolean bitmap
    std::vector<uint8_t> transformed_bitmap;
    transformed_bitmap.reserve(is_valid->size());
    std::for_each(
        is_valid->begin(), is_valid->end(), [&transformed_bitmap](const bool is_valid) {
          transformed_bitmap.push_back(is_valid ? 1 : 0);
        });

    ARROW_THROW_NOT_OK(typed_builder->AppendIndices(
        vals.data(), static_cast<int64_t>(vals.size()), transformed_bitmap.data()));
  } else {
    ARROW_THROW_NOT_OK(
        typed_builder->AppendIndices(vals.data(), static_cast<int64_t>(vals.size())));
  }
}

convert_column()

template<typename C_TYPE , typename ARROW_TYPE = typename CTypeTraits<C_TYPE>::ArrowType>

void anonymous_namespace{ArrowResultSetConverter.cpp}::convert_column	(	ResultSetPtr	result,
		size_t	col,
		std::unique_ptr< int8_t[]> &	values,
		std::unique_ptr< uint8_t[]> &	is_valid,
		size_t	entry_count,
		std::shared_ptr< Array > &	out
	)

Definition at line 159 of file ArrowResultSetConverter.cpp.

References CHECK.

                                               {
  CHECK(sizeof(C_TYPE) == result->getColType(col).get_size());
  CHECK(!values);
  CHECK(!is_valid);

  const int8_t* data_ptr;
  if (result->isZeroCopyColumnarConversionPossible(col)) {
    data_ptr = result->getColumnarBuffer(col);
  } else {
    values.reset(new int8_t[entry_count * sizeof(C_TYPE)]);
    result->copyColumnIntoBuffer(col, values.get(), entry_count * sizeof(C_TYPE));
    data_ptr = values.get();
  }

  int64_t null_count = 0;
  is_valid.reset(new uint8_t[(entry_count + 7) / 8]);

  const null_type_t<C_TYPE>* vals =
      reinterpret_cast<const null_type_t<C_TYPE>*>(data_ptr);
  null_type_t<C_TYPE> null_val = null_type<C_TYPE>::value;

  size_t unroll_count = entry_count & 0xFFFFFFFFFFFFFFF8ULL;
  for (size_t i = 0; i < unroll_count; i += 8) {
    uint8_t valid_byte = 0;
    uint8_t valid;
    valid = vals[i + 0] != null_val;
    valid_byte |= valid << 0;
    null_count += !valid;
    valid = vals[i + 1] != null_val;
    valid_byte |= valid << 1;
    null_count += !valid;
    valid = vals[i + 2] != null_val;
    valid_byte |= valid << 2;
    null_count += !valid;
    valid = vals[i + 3] != null_val;
    valid_byte |= valid << 3;
    null_count += !valid;
    valid = vals[i + 4] != null_val;
    valid_byte |= valid << 4;
    null_count += !valid;
    valid = vals[i + 5] != null_val;
    valid_byte |= valid << 5;
    null_count += !valid;
    valid = vals[i + 6] != null_val;
    valid_byte |= valid << 6;
    null_count += !valid;
    valid = vals[i + 7] != null_val;
    valid_byte |= valid << 7;
    null_count += !valid;
    is_valid[i >> 3] = valid_byte;
  }
  if (unroll_count != entry_count) {
    uint8_t valid_byte = 0;
    for (size_t i = unroll_count; i < entry_count; ++i) {
      bool valid = vals[i] != null_val;
      valid_byte |= valid << (i & 7);
      null_count += !valid;
    }
    is_valid[unroll_count >> 3] = valid_byte;
  }

  if (!null_count) {
    is_valid.reset();
  }

  // TODO: support date/time + scaling
  // TODO: support booleans
  std::shared_ptr<Buffer> data(new Buffer(reinterpret_cast<const uint8_t*>(data_ptr),
                                          entry_count * sizeof(C_TYPE)));
  if (null_count) {
    std::shared_ptr<Buffer> null_bitmap(
        new Buffer(is_valid.get(), (entry_count + 7) / 8));
    out.reset(new NumericArray<ARROW_TYPE>(entry_count, data, null_bitmap, null_count));
  } else {
    out.reset(new NumericArray<ARROW_TYPE>(entry_count, data));
  }
}

create_or_append_validity()

template<typename TYPE >

void anonymous_namespace{ArrowResultSetConverter.cpp}::create_or_append_validity	(	const ScalarTargetValue &	value,
		const SQLTypeInfo &	col_type,
		std::shared_ptr< std::vector< bool >> &	null_bitmap,
		const size_t	max_size
	)

Definition at line 109 of file ArrowResultSetConverter.cpp.

References CHECK, SQLTypeInfo::get_notnull(), inline_fp_null_val(), inline_int_null_val(), SQLTypeInfo::is_boolean(), SQLTypeInfo::is_dict_encoded_string(), SQLTypeInfo::is_fp(), SQLTypeInfo::is_integer(), SQLTypeInfo::is_time(), and UNREACHABLE.

                                                      {
  if (col_type.get_notnull()) {
    CHECK(!null_bitmap);
    return;
  }
  auto pvalue = boost::get<TYPE>(&value);
  CHECK(pvalue);
  bool is_valid = false;
  if (col_type.is_boolean()) {
    is_valid = inline_int_null_val(col_type) != static_cast<int8_t>(*pvalue);
  } else if (col_type.is_dict_encoded_string()) {
    is_valid = inline_int_null_val(col_type) != static_cast<int32_t>(*pvalue);
  } else if (col_type.is_integer() || col_type.is_time()) {
    is_valid = inline_int_null_val(col_type) != static_cast<int64_t>(*pvalue);
  } else if (col_type.is_fp()) {
    is_valid = inline_fp_null_val(col_type) != static_cast<double>(*pvalue);
  } else {
    UNREACHABLE();
  }

  if (!null_bitmap) {
    null_bitmap = std::make_shared<std::vector<bool>>();
    null_bitmap->reserve(max_size);
  }
  CHECK(null_bitmap);
  null_bitmap->push_back(is_valid);
}

Here is the call graph for this function:

create_or_append_value()

template<typename TYPE , typename VALUE_ARRAY_TYPE >

void anonymous_namespace{ArrowResultSetConverter.cpp}::create_or_append_value	(	const ScalarTargetValue &	val_cty,
		std::shared_ptr< ValueArray > &	values,
		const size_t	max_size
	)

Definition at line 92 of file ArrowResultSetConverter.cpp.

References CHECK.

                                                   {
  auto pval_cty = boost::get<VALUE_ARRAY_TYPE>(&val_cty);
  CHECK(pval_cty);
  auto val_ty = static_cast<TYPE>(*pval_cty);
  if (!values) {
    values = std::make_shared<ValueArray>(std::vector<TYPE>());
    boost::get<std::vector<TYPE>>(*values).reserve(max_size);
  }
  CHECK(values);
  auto values_ty = boost::get<std::vector<TYPE>>(values.get());
  CHECK(values_ty);
  values_ty->push_back(val_ty);
}

get_arrow_type()

std::shared_ptr<arrow::DataType> anonymous_namespace{ArrowResultSetConverter.cpp}::get_arrow_type	(	const SQLTypeInfo &	sql_type,
		const ExecutorDeviceType	device_type
	)

Definition at line 879 of file ArrowResultSetConverter.cpp.

References get_physical_type(), SQLTypeInfo::get_precision(), SQLTypeInfo::get_scale(), SQLTypeInfo::get_type_name(), GPU, SQLTypeInfo::is_dict_encoded_string(), kARRAY, kBIGINT, kBOOLEAN, kCHAR, kDATE, kDECIMAL, kDOUBLE, kFLOAT, kINT, kINTERVAL_DAY_TIME, kINTERVAL_YEAR_MONTH, kNUMERIC, kSMALLINT, kTEXT, kTIME, kTIMESTAMP, kTINYINT, kVARCHAR, and to_string().

Referenced by ArrowResultSetConverter::makeField().

                                                                                      {
  switch (get_physical_type(sql_type)) {
    case kBOOLEAN:
      return arrow::boolean();
    case kTINYINT:
      return arrow::int8();
    case kSMALLINT:
      return arrow::int16();
    case kINT:
      return arrow::int32();
    case kBIGINT:
      return arrow::int64();
    case kFLOAT:
      return arrow::float32();
    case kDOUBLE:
      return arrow::float64();
    case kCHAR:
    case kVARCHAR:
    case kTEXT:
      if (sql_type.is_dict_encoded_string()) {
        auto value_type = std::make_shared<StringType>();
        return dictionary(int32(), value_type, false);
      }
      return utf8();
    case kDECIMAL:
    case kNUMERIC:
      return decimal(sql_type.get_precision(), sql_type.get_scale());
    case kTIME:
      return time32(TimeUnit::SECOND);
    case kDATE:
      // TODO(wamsi) : Remove date64() once date32() support is added in cuDF. date32()
      // Currently support for date32() is missing in cuDF.Hence, if client requests for
      // date on GPU, return date64() for the time being, till support is added.
      return device_type == ExecutorDeviceType::GPU ? date64() : date32();
    case kTIMESTAMP:
      switch (sql_type.get_precision()) {
        case 0:
          return timestamp(TimeUnit::SECOND);
        case 3:
          return timestamp(TimeUnit::MILLI);
        case 6:
          return timestamp(TimeUnit::MICRO);
        case 9:
          return timestamp(TimeUnit::NANO);
        default:
          throw std::runtime_error(
              "Unsupported timestamp precision for Arrow result sets: " +
              std::to_string(sql_type.get_precision()));
      }
    case kARRAY:
    case kINTERVAL_DAY_TIME:
    case kINTERVAL_YEAR_MONTH:
    default:
      throw std::runtime_error(sql_type.get_type_name() +
                               " is not supported in Arrow result sets.");
  }
  return nullptr;
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_dict_index_type()

SQLTypes anonymous_namespace{ArrowResultSetConverter.cpp}::get_dict_index_type ( const SQLTypeInfo &  ti )

inline

Definition at line 55 of file ArrowResultSetConverter.cpp.

References CHECK, SQLTypeInfo::get_size(), SQLTypeInfo::get_type(), SQLTypeInfo::is_dict_encoded_string(), kBIGINT, kINT, kSMALLINT, and kTINYINT.

Referenced by ArrowResultSetConverter::initializeColumnBuilder().

                                                           {
  CHECK(ti.is_dict_encoded_string());
  switch (ti.get_size()) {
    case 1:
      return kTINYINT;
    case 2:
      return kSMALLINT;
    case 4:
      return kINT;
    case 8:
      return kBIGINT;
    default:
      CHECK(false);
  }
  return ti.get_type();
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_physical_type()

SQLTypes anonymous_namespace{ArrowResultSetConverter.cpp}::get_physical_type ( const SQLTypeInfo &  ti )

inline

Definition at line 72 of file ArrowResultSetConverter.cpp.

References CHECK, SQLTypeInfo::get_size(), SQLTypeInfo::get_type(), IS_INTEGER, kBIGINT, kINT, kSMALLINT, and kTINYINT.

Referenced by get_arrow_type(), and ArrowResultSetConverter::initializeColumnBuilder().

                                                         {
  auto logical_type = ti.get_type();
  if (IS_INTEGER(logical_type)) {
    switch (ti.get_size()) {
      case 1:
        return kTINYINT;
      case 2:
        return kSMALLINT;
      case 4:
        return kINT;
      case 8:
        return kBIGINT;
      default:
        CHECK(false);
    }
  }
  return logical_type;
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_shm()

std::pair<key_t, void*> anonymous_namespace{ArrowResultSetConverter.cpp}::get_shm

(

size_t

shmsz

)

Definition at line 243 of file ArrowResultSetConverter.cpp.

Referenced by arrow::get_and_copy_to_shm(), and get_shm_buffer().

                                            {
  if (!shmsz) {
    return std::make_pair(IPC_PRIVATE, nullptr);
  }
  // Generate a new key for a shared memory segment. Keys to shared memory segments
  // are OS global, so we need to try a new key if we encounter a collision. It seems
  // incremental keygen would be deterministically worst-case. If we use a hash
  // (like djb2) + nonce, we could still get collisions if multiple clients specify
  // the same nonce, so using rand() in lieu of a better approach
  // TODO(ptaylor): Is this common? Are these assumptions true?
  auto key = static_cast<key_t>(rand());
  int shmid = -1;
  // IPC_CREAT - indicates we want to create a new segment for this key if it doesn't
  // exist IPC_EXCL - ensures failure if a segment already exists for this key
  while ((shmid = shmget(key, shmsz, IPC_CREAT | IPC_EXCL | 0666)) < 0) {
    // If shmget fails and errno is one of these four values, try a new key.
    // TODO(ptaylor): is checking for the last three values really necessary? Checking
    // them by default to be safe. EEXIST - a shared memory segment is already associated
    // with this key EACCES - a shared memory segment is already associated with this key,
    // but we don't have permission to access it EINVAL - a shared memory segment is
    // already associated with this key, but the size is less than shmsz ENOENT -
    // IPC_CREAT was not set in shmflg and no shared memory segment associated with key
    // was found
    if (!(errno & (EEXIST | EACCES | EINVAL | ENOENT))) {
      throw std::runtime_error("failed to create a shared memory");
    }
    key = static_cast<key_t>(rand());
  }
  // get a pointer to the shared memory segment
  auto ipc_ptr = shmat(shmid, NULL, 0);
  if (reinterpret_cast<int64_t>(ipc_ptr) == -1) {
    throw std::runtime_error("failed to attach a shared memory");
  }

  return std::make_pair(key, ipc_ptr);
}

Here is the caller graph for this function:

get_shm_buffer()

std::pair<key_t, std::shared_ptr<Buffer> > anonymous_namespace{ArrowResultSetConverter.cpp}::get_shm_buffer

(

size_t

size

)

Definition at line 281 of file ArrowResultSetConverter.cpp.

References get_shm().

Referenced by ArrowResultSetConverter::getArrowResult().

                                                                  {
#ifdef _MSC_VER
  throw std::runtime_error("Arrow IPC not yet supported on Windows.");
  return std::make_pair(0, nullptr);
#else
  auto [key, ipc_ptr] = get_shm(size);
  std::shared_ptr<Buffer> buffer(new MutableBuffer(static_cast<uint8_t*>(ipc_ptr), size));
  return std::make_pair<key_t, std::shared_ptr<Buffer>>(std::move(key),
                                                        std::move(buffer));
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function: