faiss/gpu/GpuDistance.cu

/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */


#include <faiss/gpu/GpuDistance.h>
#include <faiss/impl/FaissAssert.h>
#include <faiss/gpu/GpuResources.h>
#include <faiss/gpu/impl/Distance.cuh>
#include <faiss/gpu/utils/ConversionOperators.cuh>
#include <faiss/gpu/utils/CopyUtils.cuh>
#include <faiss/gpu/utils/DeviceUtils.h>
#include <faiss/gpu/utils/DeviceTensor.cuh>

namespace faiss { namespace gpu {

template <typename T>
void bfKnnConvert(GpuResources* resources, const GpuDistanceParams& args) {
  auto device = getCurrentDevice();
  auto stream = resources->getDefaultStreamCurrentDevice();
  auto& mem = resources->getMemoryManagerCurrentDevice();

  auto tVectors =
    toDevice<T, 2>(resources,
                   device,
                   const_cast<T*>(reinterpret_cast<const T*>(args.vectors)),
                   stream,
                   {args.vectorsRowMajor ? args.numVectors : args.dims,
                    args.vectorsRowMajor ? args.dims : args.numVectors});
  auto tQueries =
    toDevice<T, 2>(resources,
                   device,
                   const_cast<T*>(reinterpret_cast<const T*>(args.queries)),
                   stream,
                   {args.queriesRowMajor ? args.numQueries : args.dims,
                    args.queriesRowMajor ? args.dims : args.numQueries});

  DeviceTensor<float, 1, true> tVectorNorms;
  if (args.vectorNorms) {
    tVectorNorms = toDevice<float, 1>(resources,
                                      device,
                                      const_cast<float*>(args.vectorNorms),
                                      stream,
                                      {args.numVectors});
  }

  auto tOutDistances =
    toDevice<float, 2>(resources,
                       device,
                       args.outDistances,
                       stream,
                       {args.numQueries, args.k});

  // The brute-force API only supports an interface for integer indices
  DeviceTensor<int, 2, true>
    tOutIntIndices(mem, {args.numQueries, args.k}, stream);

  // Since we've guaranteed that all arguments are on device, call the
  // implementation
  bfKnnOnDevice<T>(resources,
                   device,
                   stream,
                   tVectors,
                   args.vectorsRowMajor,
                   args.vectorNorms ? &tVectorNorms : nullptr,
                   tQueries,
                   args.queriesRowMajor,
                   args.k,
                   args.metric,
                   args.metricArg,
                   tOutDistances,
                   tOutIntIndices,
                   args.ignoreOutDistances);

  // Convert and copy int indices out
  auto tOutIndices =
    toDevice<faiss::Index::idx_t, 2>(resources,
                                     device,
                                     args.outIndices,
                                     stream,
                                     {args.numQueries, args.k});

  // Convert int to idx_t
  convertTensor<int, faiss::Index::idx_t, 2>(stream,
                                             tOutIntIndices,
                                             tOutIndices);

  // Copy back if necessary
  fromDevice<float, 2>(tOutDistances, args.outDistances, stream);
  fromDevice<faiss::Index::idx_t, 2>(tOutIndices, args.outIndices, stream);
}

void
bfKnn(GpuResources* resources, const GpuDistanceParams& args) {
  // For now, both vectors and queries must be of the same data type
  FAISS_THROW_IF_NOT_MSG(
    args.vectorType == args.queryType,
    "limitation: both vectorType and queryType must currently "
    "be the same (F32 or F16");

  if (args.vectorType == DistanceDataType::F32) {
    bfKnnConvert<float>(resources, args);
  } else if (args.vectorType == DistanceDataType::F16) {
    bfKnnConvert<half>(resources, args);
  } else {
    FAISS_THROW_MSG("unknown vectorType");
  }
}

// legacy version
void
bruteForceKnn(GpuResources* resources,
              faiss::MetricType metric,
              // A region of memory size numVectors x dims, with dims
              // innermost
              const float* vectors,
              bool vectorsRowMajor,
              int numVectors,
              // A region of memory size numQueries x dims, with dims
              // innermost
              const float* queries,
              bool queriesRowMajor,
              int numQueries,
              int dims,
              int k,
              // A region of memory size numQueries x k, with k
              // innermost
              float* outDistances,
              // A region of memory size numQueries x k, with k
              // innermost
              faiss::Index::idx_t* outIndices) {
  std::cerr << "bruteForceKnn is deprecated; call bfKnn instead" << std::endl;

  GpuDistanceParams args;
  args.metric = metric;
  args.k = k;
  args.dims = dims;
  args.vectors = vectors;
  args.vectorsRowMajor = vectorsRowMajor;
  args.numVectors = numVectors;
  args.queries = queries;
  args.queriesRowMajor = queriesRowMajor;
  args.numQueries = numQueries;
  args.outDistances = outDistances;
  args.outIndices = outIndices;

  bfKnn(resources, args);
}

} } // namespace