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
|
/**
* Copyright (C) 2019-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include "mongo/db/exec/sbe/stages/stages.h"
namespace mongo {
template <typename Key, typename Value>
class SortIteratorInterface;
template <typename Key, typename Value>
class Sorter;
} // namespace mongo
namespace mongo::sbe {
/**
* Sorts the incoming data from the 'input' tree. The keys on which we are sorting are given by the
* order-by slots, 'obs'. The ascending/descending sort direction associated with each of these
* order-by slots is given by 'dirs'. The 'obs' and 'dirs' vectors must be the same length. The
* 'vals' slot vector indicates the values that should associated with the sort keys.
*
* Together, a set of values for 'obs' and 'vals' consistute one of the rows being sorted. These
* rows are materialized at runtime. The given 'memoryLimit' contrains the amount of materialized
* data that can be held in memory. If this limit is exceeded, and 'allowDiskUse' is false, then
* this stage throws a query-fatal exception. If 'allowDiskUse' is true, then this stage will spill
* materialized rows to disk.
*
* If 'limit' is not std::numeric_limits<size_t>::max(), then this is a top-k sort that should only
* return the number of rows given by the limit.
*
* This stage is a binding reflector, meaning that only the 'obs' and 'vals' slots are visible to
* nodes higher in the tree.
*
* Debug string representation:
*
* sort [<order-by slots>] [asc/desc, ...] [<value slots>] limit? childStage
*/
class SortStage final : public PlanStage {
public:
SortStage(std::unique_ptr<PlanStage> input,
value::SlotVector obs,
std::vector<value::SortDirection> dirs,
value::SlotVector vals,
size_t limit,
size_t memoryLimit,
bool allowDiskUse,
PlanNodeId planNodeId);
~SortStage();
std::unique_ptr<PlanStage> clone() const final;
void prepare(CompileCtx& ctx) final;
value::SlotAccessor* getAccessor(CompileCtx& ctx, value::SlotId slot) final;
void open(bool reOpen) final;
PlanState getNext() final;
void close() final;
std::unique_ptr<PlanStageStats> getStats(bool includeDebugInfo) const final;
const SpecificStats* getSpecificStats() const final;
std::vector<DebugPrinter::Block> debugPrint() const final;
size_t estimateCompileTimeSize() const final;
protected:
void doDetachFromTrialRunTracker() override;
TrialRunTrackerAttachResultMask doAttachToTrialRunTracker(
TrialRunTracker* tracker, TrialRunTrackerAttachResultMask childrenAttachResult) override;
private:
void makeSorter();
using SorterIterator = SortIteratorInterface<value::MaterializedRow, value::MaterializedRow>;
using SorterData = std::pair<value::MaterializedRow, value::MaterializedRow>;
const value::SlotVector _obs;
const std::vector<value::SortDirection> _dirs;
const value::SlotVector _vals;
const bool _allowDiskUse;
SortStats _specificStats;
std::vector<value::SlotAccessor*> _inKeyAccessors;
std::vector<value::SlotAccessor*> _inValueAccessors;
value::SlotMap<std::unique_ptr<value::SlotAccessor>> _outAccessors;
std::unique_ptr<SorterIterator> _mergeIt;
SorterData _mergeData;
SorterData* _mergeDataIt{&_mergeData};
std::unique_ptr<Sorter<value::MaterializedRow, value::MaterializedRow>> _sorter;
// If provided, used during a trial run to accumulate certain execution stats. Once the trial
// run is complete, this pointer is reset to nullptr.
TrialRunTracker* _tracker{nullptr};
};
} // namespace mongo::sbe
|
