lbug 0.16.1

An in-process property graph database management system built for query speed and scalability
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327

#include "processor/operator/path_property_probe.h"

#include "common/constants.h"
#include "function/hash/hash_functions.h"

using namespace lbug::common;

namespace lbug {
namespace processor {

void PathPropertyProbe::initLocalStateInternal(ResultSet* /*resultSet_*/,
    ExecutionContext* /*context*/) {
    localState = PathPropertyProbeLocalState();
    auto pathVector = resultSet->getValueVector(info.pathPos);
    pathNodesVector = StructVector::getFieldVectorRaw(*pathVector, InternalKeyword::NODES);
    pathRelsVector = StructVector::getFieldVectorRaw(*pathVector, InternalKeyword::RELS);
    auto nodesDataVector = ListVector::getDataVector(pathNodesVector);
    auto relsDataVector = ListVector::getDataVector(pathRelsVector);
    pathNodeIDsDataVector = StructVector::getFieldVectorRaw(*nodesDataVector, InternalKeyword::ID);
    pathNodeLabelsDataVector =
        StructVector::getFieldVectorRaw(*nodesDataVector, InternalKeyword::LABEL);
    pathRelIDsDataVector = StructVector::getFieldVectorRaw(*relsDataVector, InternalKeyword::ID);
    pathRelLabelsDataVector =
        StructVector::getFieldVectorRaw(*relsDataVector, InternalKeyword::LABEL);
    pathSrcNodeIDsDataVector =
        StructVector::getFieldVectorRaw(*relsDataVector, InternalKeyword::SRC);
    pathDstNodeIDsDataVector =
        StructVector::getFieldVectorRaw(*relsDataVector, InternalKeyword::DST);
    for (auto fieldIdx : info.nodeFieldIndices) {
        pathNodesPropertyDataVectors.push_back(
            StructVector::getFieldVector(nodesDataVector, fieldIdx).get());
    }
    for (auto fieldIdx : info.relFieldIndices) {
        pathRelsPropertyDataVectors.push_back(
            StructVector::getFieldVector(relsDataVector, fieldIdx).get());
    }
    if (info.leftNodeIDPos.isValid()) {
        inputLeftNodeIDVector = resultSet->getValueVector(info.leftNodeIDPos).get();
        inputRightNodeIDVector = resultSet->getValueVector(info.rightNodeIDPos).get();
        inputNodeIDsVector = resultSet->getValueVector(info.inputNodeIDsPos).get();
        inputRelIDsVector = resultSet->getValueVector(info.inputEdgeIDsPos).get();
        if (info.directionPos.isValid()) {
            inputDirectionVector = resultSet->getValueVector(info.directionPos).get();
        }
    }
}

static void copyListEntry(const ValueVector& srcVector, ValueVector* dstVector) {
    auto& selVector = srcVector.state->getSelVector();
    for (auto i = 0u; i < selVector.getSelSize(); ++i) {
        auto pos = selVector[i];
        auto entry = srcVector.getValue<list_entry_t>(pos);
        ListVector::addList(dstVector, entry.size);
        dstVector->setValue(pos, entry);
    }
}

static void copyInternalID(ValueVector* srcVector, ValueVector* dstIDVector,
    ValueVector* dstLabelVector,
    const std::unordered_map<common::table_id_t, std::string>& tableIDToName) {
    auto srcDataVector = ListVector::getDataVector(srcVector);
    for (auto i = 0u; i < ListVector::getDataVectorSize(srcVector); ++i) {
        auto id = srcDataVector->getValue<internalID_t>(i);
        dstIDVector->setValue(i, id);
        StringVector::addString(dstLabelVector, i, tableIDToName.at(id.tableID));
    }
}

// TODO(Xiyang): revisit me. Instead of printing in src->dst order. Maybe left->right order make
// more sense.
// Truth table.
// Edge Direction | ExtendFromSource | Result
// FWD            | T                | T
// FWD            | F                | F
// BWD            | T                | F
// BWD            | F                | T
static bool isCorrectOrder(ValueVector* vector, sel_t pos, bool extendFromSource) {
    if (extendFromSource) {
        return vector->getValue<bool>(pos);
    }
    return !vector->getValue<bool>(pos);
}

static void writeSrcDstNodeIDs(nodeID_t fromID, nodeID_t toID, ValueVector* directionDataVector,
    ValueVector* srcNodeIDsDataVector, ValueVector* dstNodeIDsDataVector, sel_t pos, bool flag) {
    if (isCorrectOrder(directionDataVector, pos, flag)) {
        srcNodeIDsDataVector->setValue(pos, fromID);
        dstNodeIDsDataVector->setValue(pos, toID);
    } else {
        srcNodeIDsDataVector->setValue(pos, toID);
        dstNodeIDsDataVector->setValue(pos, fromID);
    }
}

bool PathPropertyProbe::getNextTuplesInternal(ExecutionContext* context) {
    if (!children[0]->getNextTuple(context)) {
        return false;
    }
    auto sizeProbed = 0u;
    // Copy node IDs
    if (inputNodeIDsVector != nullptr) {
        pathNodesVector->resetAuxiliaryBuffer();
        copyListEntry(*inputNodeIDsVector, pathNodesVector);
        copyInternalID(inputNodeIDsVector, pathNodeIDsDataVector, pathNodeLabelsDataVector,
            info.tableIDToName);
    }
    // Scan node properties
    if (sharedState->nodeHashTableState != nullptr) {
        auto nodeHashTable = sharedState->nodeHashTableState->getHashTable();
        auto nodeDataSize = ListVector::getDataVectorSize(pathNodesVector);
        while (sizeProbed < nodeDataSize) {
            auto sizeToProbe =
                std::min<uint64_t>(DEFAULT_VECTOR_CAPACITY, nodeDataSize - sizeProbed);
            probe(nodeHashTable, sizeProbed, sizeToProbe, pathNodeIDsDataVector,
                pathNodesPropertyDataVectors, info.nodeTableColumnIndices);
            sizeProbed += sizeToProbe;
        }
    }
    // Copy rel IDs
    if (inputRelIDsVector != nullptr) {
        pathRelsVector->resetAuxiliaryBuffer();
        copyListEntry(*inputRelIDsVector, pathRelsVector);
        copyInternalID(inputRelIDsVector, pathRelIDsDataVector, pathRelLabelsDataVector,
            info.tableIDToName);
    }
    // Scan rel property
    if (sharedState->relHashTableState != nullptr) {
        auto relHashTable = sharedState->relHashTableState->getHashTable();
        auto relDataSize = ListVector::getDataVectorSize(pathRelsVector);
        sizeProbed = 0u;
        while (sizeProbed < relDataSize) {
            auto sizeToProbe =
                std::min<uint64_t>(DEFAULT_VECTOR_CAPACITY, relDataSize - sizeProbed);
            probe(relHashTable, sizeProbed, sizeToProbe, pathRelIDsDataVector,
                pathRelsPropertyDataVectors, info.relTableColumnIndices);
            sizeProbed += sizeToProbe;
        }
    }
    if (inputNodeIDsVector == nullptr || inputRelIDsVector == nullptr) {
        return true;
    }
    auto& selVector = inputNodeIDsVector->state->getSelVector();
    auto inputNodeIDsDataVector = ListVector::getDataVector(inputNodeIDsVector);
    // Copy rel src&dst IDs

    switch (info.extendDirection) {
    case ExtendDirection::FWD: {
        if (info.extendFromLeft) {
            // Example graph src->1->2->3->dst
            // Input: src, dst, [1, 2, 3]
            // Output:
            // - srcIDs [src, 1, 2, 3]
            // - dstIDs [1, 2, 3, dst]
            for (auto i = 0u; i < selVector.getSelSize(); ++i) {
                auto leftNodeID = inputLeftNodeIDVector->getValue<nodeID_t>(i);
                auto rightNodeID = inputRightNodeIDVector->getValue<nodeID_t>(i);
                auto nodeListEntry = inputNodeIDsVector->getValue<list_entry_t>(i);
                auto relListEntry = inputRelIDsVector->getValue<list_entry_t>(i);
                if (relListEntry.size == 0) {
                    continue;
                }
                for (auto j = 0u; j < nodeListEntry.size; ++j) {
                    auto id = inputNodeIDsDataVector->getValue<nodeID_t>(nodeListEntry.offset + j);
                    pathSrcNodeIDsDataVector->setValue(relListEntry.offset + j + 1, id);
                    pathDstNodeIDsDataVector->setValue(relListEntry.offset + j, id);
                }
                pathSrcNodeIDsDataVector->setValue(relListEntry.offset, leftNodeID);
                pathDstNodeIDsDataVector->setValue(relListEntry.offset + relListEntry.size - 1,
                    rightNodeID);
            }
        } else {
            // Example graph src<-1<-2<-3<-dst
            // Input: src, dst, [1, 2, 3]
            // Output:
            // - srcIDs [1, 2, 3, dst]
            // - dstIDs [src, 1, 2, 3]
            for (auto i = 0u; i < selVector.getSelSize(); ++i) {
                auto leftNodeID = inputLeftNodeIDVector->getValue<nodeID_t>(i);
                auto rightNodeID = inputRightNodeIDVector->getValue<nodeID_t>(i);
                auto nodeListEntry = inputNodeIDsVector->getValue<list_entry_t>(i);
                auto relListEntry = inputRelIDsVector->getValue<list_entry_t>(i);
                if (relListEntry.size == 0) {
                    continue;
                }
                for (auto j = 0u; j < nodeListEntry.size; ++j) {
                    auto id = inputNodeIDsDataVector->getValue<nodeID_t>(nodeListEntry.offset + j);
                    pathSrcNodeIDsDataVector->setValue(relListEntry.offset + j, id);
                    pathDstNodeIDsDataVector->setValue(relListEntry.offset + j + 1, id);
                }
                pathSrcNodeIDsDataVector->setValue(relListEntry.offset + relListEntry.size - 1,
                    rightNodeID);
                pathDstNodeIDsDataVector->setValue(relListEntry.offset, leftNodeID);
            }
        }
    } break;
    case common::ExtendDirection::BWD: {
        if (info.extendFromLeft) {
            // Example graph src<-1<-2<-3<-dst
            // Input: src, dst, [1, 2, 3]
            // Output:
            // - srcIDs [1, 2, 3, dst]
            // - dstIDs [src, 1, 2, 3]
            for (auto i = 0u; i < selVector.getSelSize(); ++i) {
                auto leftNodeID = inputLeftNodeIDVector->getValue<nodeID_t>(i);
                auto rightNodeID = inputRightNodeIDVector->getValue<nodeID_t>(i);
                auto nodeListEntry = inputNodeIDsVector->getValue<list_entry_t>(i);
                auto relListEntry = inputRelIDsVector->getValue<list_entry_t>(i);
                if (relListEntry.size == 0) {
                    continue;
                }
                for (auto j = 0u; j < nodeListEntry.size; ++j) {
                    auto id = inputNodeIDsDataVector->getValue<nodeID_t>(nodeListEntry.offset + j);
                    pathSrcNodeIDsDataVector->setValue(relListEntry.offset + j, id);
                    pathDstNodeIDsDataVector->setValue(relListEntry.offset + j + 1, id);
                }
                pathSrcNodeIDsDataVector->setValue(relListEntry.offset + relListEntry.size - 1,
                    rightNodeID);
                pathDstNodeIDsDataVector->setValue(relListEntry.offset, leftNodeID);
            }
        } else {
            // Example graph src->1->2->3->dst
            // Input: src, dst, [1, 2, 3]
            // Output:
            // - srcIDs [src, 1, 2, 3]
            // - dstIDs [1, 2, 3, dst]
            for (auto i = 0u; i < selVector.getSelSize(); ++i) {
                auto leftNodeID = inputLeftNodeIDVector->getValue<nodeID_t>(i);
                auto rightNodeID = inputRightNodeIDVector->getValue<nodeID_t>(i);
                auto nodeListEntry = inputNodeIDsVector->getValue<list_entry_t>(i);
                auto relListEntry = inputRelIDsVector->getValue<list_entry_t>(i);
                if (relListEntry.size == 0) {
                    continue;
                }
                for (auto j = 0u; j < nodeListEntry.size; ++j) {
                    auto id = inputNodeIDsDataVector->getValue<nodeID_t>(nodeListEntry.offset + j);
                    pathSrcNodeIDsDataVector->setValue(relListEntry.offset + j + 1, id);
                    pathDstNodeIDsDataVector->setValue(relListEntry.offset + j, id);
                }
                pathSrcNodeIDsDataVector->setValue(relListEntry.offset, leftNodeID);
                pathDstNodeIDsDataVector->setValue(relListEntry.offset + relListEntry.size - 1,
                    rightNodeID);
            }
        }
    } break;
    case common::ExtendDirection::BOTH: {
        auto directionDataVector = ListVector::getDataVector(inputDirectionVector);
        for (auto i = 0u; i < selVector.getSelSize(); ++i) {
            auto leftNodeID = inputLeftNodeIDVector->getValue<nodeID_t>(i);
            auto rightNodeID = inputRightNodeIDVector->getValue<nodeID_t>(i);
            auto nodeListEntry = inputNodeIDsVector->getValue<list_entry_t>(i);
            auto relListEntry = inputRelIDsVector->getValue<list_entry_t>(i);
            if (relListEntry.size == 0) {
                continue;
            }
            if (nodeListEntry.size == 0) {
                DASSERT(relListEntry.size == 1);
                if (isCorrectOrder(directionDataVector, relListEntry.offset, info.extendFromLeft)) {
                    pathSrcNodeIDsDataVector->setValue(relListEntry.offset, leftNodeID);
                    pathDstNodeIDsDataVector->setValue(relListEntry.offset, rightNodeID);
                } else {
                    pathSrcNodeIDsDataVector->setValue(relListEntry.offset, rightNodeID);
                    pathDstNodeIDsDataVector->setValue(relListEntry.offset, leftNodeID);
                }
                continue;
            }
            for (auto j = 0u; j < nodeListEntry.size - 1; ++j) {
                auto from = inputNodeIDsDataVector->getValue<nodeID_t>(nodeListEntry.offset + j);
                auto to = inputNodeIDsDataVector->getValue<nodeID_t>(nodeListEntry.offset + j + 1);
                writeSrcDstNodeIDs(from, to, directionDataVector, pathSrcNodeIDsDataVector,
                    pathDstNodeIDsDataVector, relListEntry.offset + j + 1, info.extendFromLeft);
            }
            writeSrcDstNodeIDs(leftNodeID,
                inputNodeIDsDataVector->getValue<nodeID_t>(nodeListEntry.offset),
                directionDataVector, pathSrcNodeIDsDataVector, pathDstNodeIDsDataVector,
                relListEntry.offset, info.extendFromLeft);
            writeSrcDstNodeIDs(inputNodeIDsDataVector->getValue<nodeID_t>(
                                   nodeListEntry.offset + nodeListEntry.size - 1),
                rightNodeID, directionDataVector, pathSrcNodeIDsDataVector,
                pathDstNodeIDsDataVector, relListEntry.offset + relListEntry.size - 1,
                info.extendFromLeft);
        }
    } break;
    default:
        UNREACHABLE_CODE;
    }
    return true;
}

void PathPropertyProbe::probe(lbug::processor::JoinHashTable* hashTable, uint64_t sizeProbed,
    uint64_t sizeToProbe, ValueVector* idVector, const std::vector<ValueVector*>& propertyVectors,
    const std::vector<ft_col_idx_t>& colIndicesToScan) const {
    // Hash
    for (auto i = 0u; i < sizeToProbe; ++i) {
        function::Hash::operation(idVector->getValue<internalID_t>(sizeProbed + i),
            localState.hashes[i]);
    }
    // Probe hash
    for (auto i = 0u; i < sizeToProbe; ++i) {
        localState.probedTuples[i] = hashTable->getTupleForHash(localState.hashes[i]);
    }
    // Match value
    for (auto i = 0u; i < sizeToProbe; ++i) {
        while (localState.probedTuples[i]) {
            auto currentTuple = localState.probedTuples[i];
            if (*(internalID_t*)currentTuple == idVector->getValue<internalID_t>(sizeProbed + i)) {
                localState.matchedTuples[i] = currentTuple;
                break;
            }
            localState.probedTuples[i] = *hashTable->getPrevTuple(currentTuple);
        }
        DASSERT(localState.matchedTuples[i] != nullptr);
    }
    // Scan table
    auto factorizedTable = hashTable->getFactorizedTable();
    for (auto i = 0u; i < sizeToProbe; ++i) {
        auto tuple = localState.matchedTuples[i];
        for (auto j = 0u; j < propertyVectors.size(); ++j) {
            auto propertyVector = propertyVectors[j];
            auto colIdx = colIndicesToScan[j];
            factorizedTable->readFlatColToFlatVector(tuple, colIdx, *propertyVector,
                sizeProbed + i);
        }
    }
}

} // namespace processor
} // namespace lbug