faiss 0.1.3 → 0.2.0

data/vendor/faiss/faiss/impl/pq4_fast_scan_search_1.cpp

@@ -0,0 +1,180 @@
+/**
+ * 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/impl/pq4_fast_scan.h>
+
+#include <faiss/impl/FaissAssert.h>
+#include <faiss/impl/simd_result_handlers.h>
+
+
+namespace faiss {
+
+
+using namespace simd_result_handlers;
+
+/***************************************************************
+ * accumulation functions
+ ***************************************************************/
+
+namespace {
+
+/*
+ * The computation kernel
+ * It accumulates results for NQ queries and BB * 32 database elements
+ * writes results in a ResultHandler
+ */
+
+template<int NQ, int BB, class ResultHandler>
+void kernel_accumulate_block(
+        int nsq,
+        const uint8_t *codes,
+        const uint8_t *LUT,
+        ResultHandler & res)
+{
+    // distance accumulators
+    simd16uint16 accu[NQ][BB][4];
+
+    for(int q = 0; q < NQ; q++) {
+        for(int b = 0; b < BB; b++) {
+            accu[q][b][0].clear();
+            accu[q][b][1].clear();
+            accu[q][b][2].clear();
+            accu[q][b][3].clear();
+        }
+    }
+
+    for(int sq = 0; sq < nsq; sq += 2) {
+        simd32uint8 lut_cache[NQ];
+        for(int q = 0; q < NQ; q++) {
+            lut_cache[q] = simd32uint8(LUT);
+            LUT += 32;
+        }
+
+        for (int b = 0; b < BB; b++) {
+            simd32uint8 c = simd32uint8(codes);
+            codes += 32;
+            simd32uint8 mask(15);
+            simd32uint8 chi = simd32uint8(simd16uint16(c) >> 4) & mask;
+            simd32uint8 clo = c & mask;
+
+            for(int q = 0; q < NQ; q++) {
+                simd32uint8 lut = lut_cache[q];
+                simd32uint8 res0 = lut.lookup_2_lanes(clo);
+                simd32uint8 res1 = lut.lookup_2_lanes(chi);
+
+                accu[q][b][0] += simd16uint16(res0);
+                accu[q][b][1] += simd16uint16(res0) >> 8;
+
+                accu[q][b][2] += simd16uint16(res1);
+                accu[q][b][3] += simd16uint16(res1) >> 8;
+            }
+        }
+    }
+
+    for(int q = 0; q < NQ; q++) {
+        for (int b = 0; b < BB; b++) {
+
+            accu[q][b][0] -= accu[q][b][1] << 8;
+            simd16uint16 dis0 = combine2x2(accu[q][b][0], accu[q][b][1]);
+
+            accu[q][b][2] -= accu[q][b][3] << 8;
+            simd16uint16 dis1 = combine2x2(accu[q][b][2], accu[q][b][3]);
+
+            res.handle(q, b, dis0, dis1);
+        }
+    }
+
+
+}
+
+
+template<int NQ, int BB, class ResultHandler>
+void accumulate_fixed_blocks(
+        size_t nb,
+        int nsq,
+        const uint8_t *codes,
+        const uint8_t *LUT,
+        ResultHandler & res)
+{
+    constexpr int bbs = 32 * BB;
+    for (int64_t j0 = 0; j0 < nb; j0 += bbs) {
+        FixedStorageHandler<NQ, 2 * BB> res2;
+        kernel_accumulate_block<NQ, BB>(nsq, codes, LUT, res2);
+        res.set_block_origin(0, j0);
+        res2.to_other_handler(res);
+        codes += bbs * nsq / 2;
+    }
+}
+
+
+} // anonymous namespace
+
+template<class ResultHandler>
+void pq4_accumulate_loop(
+        int nq,
+        size_t nb, int bbs,
+        int nsq,
+        const uint8_t *codes,
+        const uint8_t *LUT,
+        ResultHandler & res)
+{
+    FAISS_THROW_IF_NOT(is_aligned_pointer(codes));
+    FAISS_THROW_IF_NOT(is_aligned_pointer(LUT));
+    FAISS_THROW_IF_NOT(bbs % 32 == 0);
+    FAISS_THROW_IF_NOT(nb % bbs == 0);
+
+#define DISPATCH(NQ, BB) \
+   case NQ * 1000 + BB: \
+    accumulate_fixed_blocks<NQ, BB>(nb, nsq, codes, LUT, res);  \
+    break
+
+    switch(nq * 1000 + bbs / 32) {
+        DISPATCH(1, 1);
+        DISPATCH(1, 2);
+        DISPATCH(1, 3);
+        DISPATCH(1, 4);
+        DISPATCH(1, 5);
+        DISPATCH(2, 1);
+        DISPATCH(2, 2);
+        DISPATCH(3, 1);
+        DISPATCH(4, 1);
+    default:
+        FAISS_THROW_FMT("nq=%d bbs=%d not instantiated", nq, bbs);
+    }
+#undef DISPATCH
+
+}
+
+// explicit template instantiations
+
+
+
+
+#define INSTANTIATE_ACCUMULATE(TH, C, with_id_map) \
+template void pq4_accumulate_loop<TH<C, with_id_map>> \
+    (int, size_t, int, int, const uint8_t *, const uint8_t *, TH<C, with_id_map> &);
+
+#define INSTANTIATE_3(C, with_id_map) \
+INSTANTIATE_ACCUMULATE(SingleResultHandler, C, with_id_map) \
+INSTANTIATE_ACCUMULATE(HeapHandler, C, with_id_map) \
+INSTANTIATE_ACCUMULATE(ReservoirHandler, C, with_id_map) \
+
+using Csi = CMax<uint16_t, int>;
+INSTANTIATE_3(Csi, false);
+using CsiMin = CMin<uint16_t, int>;
+INSTANTIATE_3(CsiMin, false);
+
+using Csl = CMax<uint16_t, int64_t>;
+INSTANTIATE_3(Csl, true);
+using CslMin = CMin<uint16_t, int64_t>;
+INSTANTIATE_3(CslMin, true);
+
+
+
+} // namespace faiss
+

data/vendor/faiss/faiss/impl/pq4_fast_scan_search_qbs.cpp

@@ -0,0 +1,354 @@
+/**
+ * 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/impl/pq4_fast_scan.h>
+
+#include <faiss/impl/FaissAssert.h>
+#include <faiss/utils/simdlib.h>
+#include <faiss/impl/simd_result_handlers.h>
+
+
+namespace faiss {
+
+
+using namespace simd_result_handlers;
+
+/************************************************************
+ * Accumulation functions
+ ************************************************************/
+
+namespace {
+
+/*
+ * The computation kernel
+ * It accumulates results for NQ queries and 2 * 16 database elements
+ * writes results in a ResultHandler
+ */
+
+template<int NQ, class ResultHandler>
+void kernel_accumulate_block(
+        int nsq,
+        const uint8_t *codes,
+        const uint8_t *LUT,
+        ResultHandler & res)
+{
+    // dummy alloc to keep the windows compiler happy
+    constexpr int NQA = NQ > 0 ? NQ : 1;
+    // distance accumulators
+    simd16uint16 accu[NQA][4];
+
+    for(int q = 0; q < NQ; q++) {
+        for(int b = 0; b < 4; b++) {
+            accu[q][b].clear();
+        }
+    }
+
+    // _mm_prefetch(codes + 768, 0);
+    for(int sq = 0; sq < nsq; sq += 2) {
+
+        // prefetch
+        simd32uint8 c(codes);
+        codes += 32;
+
+        simd32uint8 mask(0xf);
+        // shift op does not exist for int8...
+        simd32uint8 chi = simd32uint8(simd16uint16(c) >> 4) & mask;
+        simd32uint8 clo = c & mask;
+
+        for(int q = 0; q < NQ; q++) {
+            // load LUTs for 2 quantizers
+            simd32uint8 lut(LUT);
+            LUT += 32;
+
+            simd32uint8 res0 = lut.lookup_2_lanes(clo);
+            simd32uint8 res1 = lut.lookup_2_lanes(chi);
+
+            accu[q][0] += simd16uint16(res0);
+            accu[q][1] += simd16uint16(res0) >> 8;
+
+            accu[q][2] += simd16uint16(res1);
+            accu[q][3] += simd16uint16(res1) >> 8;
+        }
+    }
+
+    for(int q = 0; q < NQ; q++) {
+        accu[q][0] -= accu[q][1] << 8;
+        simd16uint16 dis0 = combine2x2(accu[q][0], accu[q][1]);
+        accu[q][2] -= accu[q][3] << 8;
+        simd16uint16 dis1 = combine2x2(accu[q][2], accu[q][3]);
+        res.handle(q, 0, dis0, dis1);
+    }
+
+}
+
+// handle at most 4 blocks of queries
+template<int QBS, class ResultHandler>
+void accumulate_q_4step(
+        size_t ntotal2,
+        int nsq,
+        const uint8_t *codes,
+        const uint8_t *LUT0,
+        ResultHandler & res)
+{
+
+    constexpr int Q1 = QBS & 15;
+    constexpr int Q2 = (QBS >> 4) & 15;
+    constexpr int Q3 = (QBS >> 8) & 15;
+    constexpr int Q4 = (QBS >> 12) & 15;
+    constexpr int SQ = Q1 + Q2 + Q3 + Q4;
+
+    for (int64_t j0 = 0; j0 < ntotal2; j0 += 32) {
+        FixedStorageHandler<SQ, 2> res2;
+        const uint8_t *LUT = LUT0;
+        kernel_accumulate_block<Q1>(nsq, codes, LUT, res2);
+        LUT += Q1 * nsq * 16;
+        if (Q2 > 0) {
+            res2.set_block_origin(Q1, 0);
+            kernel_accumulate_block<Q2>(nsq, codes, LUT, res2);
+            LUT += Q2 * nsq * 16;
+        }
+        if (Q3 > 0) {
+            res2.set_block_origin(Q1 + Q2, 0);
+            kernel_accumulate_block<Q3>(nsq, codes, LUT, res2);
+            LUT += Q3 * nsq * 16;
+        }
+        if (Q4 > 0) {
+            res2.set_block_origin(Q1 + Q2 + Q3, 0);
+            kernel_accumulate_block<Q4>(nsq, codes, LUT, res2);
+        }
+        res.set_block_origin(0, j0);
+        res2.to_other_handler(res);
+        codes += 32 * nsq / 2;
+    }
+}
+
+
+
+
+template<int NQ, class ResultHandler>
+void kernel_accumulate_block_loop(
+        size_t ntotal2,
+        int nsq,
+        const uint8_t *codes,
+        const uint8_t *LUT,
+        ResultHandler & res)
+{
+
+    for (int64_t j0 = 0; j0 < ntotal2; j0 += 32) {
+        res.set_block_origin(0, j0);
+        kernel_accumulate_block<NQ, ResultHandler>
+            (nsq, codes + j0 * nsq / 2, LUT, res);
+    }
+
+}
+
+// non-template version of accumulate kernel -- dispatches dynamically
+template<class ResultHandler>
+void accumulate(
+        int nq,
+        size_t ntotal2,
+        int nsq,
+        const uint8_t *codes,
+        const uint8_t *LUT,
+        ResultHandler & res)
+{
+
+    assert(nsq % 2 == 0);
+    assert(is_aligned_pointer(codes));
+    assert(is_aligned_pointer(LUT));
+
+#define DISPATCH(NQ)                                       \
+    case NQ:                                                    \
+        kernel_accumulate_block_loop<NQ, ResultHandler>    \
+                (ntotal2, nsq, codes, LUT, res);                \
+    return
+
+    switch(nq) {
+        DISPATCH(1);
+        DISPATCH(2);
+        DISPATCH(3);
+        DISPATCH(4);
+    }
+    FAISS_THROW_FMT("accumulate nq=%d not instanciated",
+                    nq);
+
+#undef DISPATCH
+}
+
+
+} // anonumous namespace
+
+
+
+template<class ResultHandler>
+void pq4_accumulate_loop_qbs(
+        int qbs,
+        size_t ntotal2,
+        int nsq,
+        const uint8_t *codes,
+        const uint8_t *LUT0,
+        ResultHandler & res)
+{
+
+    assert(nsq % 2 == 0);
+    assert(is_aligned_pointer(codes));
+    assert(is_aligned_pointer(LUT0));
+
+    // try out optimized versions
+    switch(qbs) {
+#define DISPATCH(QBS) \
+        case QBS: accumulate_q_4step<QBS>  \
+            (ntotal2, nsq, codes, LUT0, res);  \
+        return;
+            DISPATCH(0x3333);  // 12
+            DISPATCH(0x2333);  // 11
+            DISPATCH(0x2233);  // 10
+            DISPATCH(0x333);   // 9
+            DISPATCH(0x2223);  // 9
+            DISPATCH(0x233);   // 8
+            DISPATCH(0x1223);  // 8
+            DISPATCH(0x223);   // 7
+            DISPATCH(0x34);    // 7
+            DISPATCH(0x133);   // 7
+            DISPATCH(0x6);     // 6
+            DISPATCH(0x33);    // 6
+            DISPATCH(0x123);   // 6
+            DISPATCH(0x222);   // 6
+            DISPATCH(0x23);    // 5
+            DISPATCH(0x5);     // 5
+            DISPATCH(0x13);    // 4
+            DISPATCH(0x22);    // 4
+            DISPATCH(0x4);     // 4
+            DISPATCH(0x3);     // 3
+            DISPATCH(0x21);    // 3
+            DISPATCH(0x2);     // 2
+            DISPATCH(0x1);     // 1
+#undef DISPATCH
+    }
+
+    // default implementation where qbs is not known at compile time
+
+    for (int64_t j0 = 0; j0 < ntotal2; j0 += 32) {
+        const uint8_t *LUT = LUT0;
+        int qi = qbs;
+        int i0 = 0;
+        while(qi) {
+            int nq = qi & 15;
+            qi >>= 4;
+            res.set_block_origin(i0, j0);
+#define DISPATCH(NQ)                                     \
+    case NQ:                                             \
+        kernel_accumulate_block<NQ, ResultHandler> \
+           (nsq, codes, LUT, res);                       \
+        break
+            switch(nq) {
+                DISPATCH(1);
+                DISPATCH(2);
+                DISPATCH(3);
+                DISPATCH(4);
+#undef DISPATCH
+            default:
+                FAISS_THROW_FMT("accumulate nq=%d not instanciated",
+                                nq);
+            }
+            i0 += nq;
+            LUT += nq * nsq * 16;
+        }
+        codes += 32 * nsq / 2;
+    }
+}
+
+
+
+// explicit template instantiations
+
+
+#define INSTANTIATE_ACCUMULATE_Q(RH) \
+template void pq4_accumulate_loop_qbs<RH> \
+    (int, size_t, int, const uint8_t *, const uint8_t *, RH &);
+
+using Csi = CMax<uint16_t, int>;
+INSTANTIATE_ACCUMULATE_Q(SingleResultHandler<Csi>)
+INSTANTIATE_ACCUMULATE_Q(HeapHandler<Csi>)
+INSTANTIATE_ACCUMULATE_Q(ReservoirHandler<Csi>)
+using Csi2 = CMin<uint16_t, int>;
+INSTANTIATE_ACCUMULATE_Q(SingleResultHandler<Csi2>)
+INSTANTIATE_ACCUMULATE_Q(HeapHandler<Csi2>)
+INSTANTIATE_ACCUMULATE_Q(ReservoirHandler<Csi2>)
+
+using Cfl = CMax<uint16_t, int64_t>;
+using HHCsl = HeapHandler<Cfl, true>;
+using RHCsl = ReservoirHandler<Cfl, true>;
+using SHCsl = SingleResultHandler<Cfl, true>;
+INSTANTIATE_ACCUMULATE_Q(HHCsl)
+INSTANTIATE_ACCUMULATE_Q(RHCsl)
+INSTANTIATE_ACCUMULATE_Q(SHCsl)
+using Cfl2 = CMin<uint16_t, int64_t>;
+using HHCsl2 = HeapHandler<Cfl2, true>;
+using RHCsl2 = ReservoirHandler<Cfl2, true>;
+using SHCsl2 = SingleResultHandler<Cfl2, true>;
+INSTANTIATE_ACCUMULATE_Q(HHCsl2)
+INSTANTIATE_ACCUMULATE_Q(RHCsl2)
+INSTANTIATE_ACCUMULATE_Q(SHCsl2)
+
+
+/***************************************************************
+ * Packing functions
+ ***************************************************************/
+
+int pq4_qbs_to_nq(int qbs) {
+    int i0 = 0;
+    int qi = qbs;
+    while(qi) {
+        int nq = qi & 15;
+        qi >>= 4;
+        i0 += nq;
+    }
+    return i0;
+}
+
+
+
+void accumulate_to_mem(
+        int nq,
+        size_t ntotal2,
+        int nsq,
+        const uint8_t *codes,
+        const uint8_t *LUT,
+        uint16_t* accu)
+{
+    FAISS_THROW_IF_NOT(ntotal2 % 32 == 0);
+    StoreResultHandler handler(accu, ntotal2);
+    accumulate(nq, ntotal2, nsq, codes, LUT, handler);
+}
+
+
+int pq4_preferred_qbs(int n) {
+    // from timmings in P141901742, P141902828
+    static int map[12] = {
+        0, 1, 2, 3, 0x13,
+        0x23, 0x33, 0x223, 0x233, 0x333,
+        0x2233, 0x2333
+    };
+    if (n <= 11) {
+        return map[n];
+    } else if (n <= 24) {
+        // override qbs: all first stages with 3 steps
+        // then 1 stage with the rest
+        int nbit = 4 * (n / 3); // nbits with only 3s
+        int qbs = 0x33333333 & ((1 << nbit) - 1);
+        qbs |= (n % 3) << nbit;
+        return qbs;
+    } else {
+        FAISS_THROW_FMT("number of queries %d too large", n);
+    }
+}
+
+
+
+} // namespace faiss
+