summaryrefslogtreecommitdiff
path: root/src/mongo/db/exec/shard_filter.cpp
blob: 72b4bb6887bde50338f3d05919cd1ea88e35227b (plain)
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
/**
 *    Copyright (C) 2013 10gen Inc.
 *
 *    This program is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    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
 *    GNU Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *    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 GNU Affero General 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.
 */

#include "mongo/db/exec/shard_filter.h"

#include "mongo/db/keypattern.h"

namespace mongo {

    ShardFilterStage::ShardFilterStage(const CollectionMetadataPtr& metadata,
                                       WorkingSet* ws,
                                       PlanStage* child)
        : _ws(ws), _child(child), _metadata(metadata) { }

    ShardFilterStage::~ShardFilterStage() { }

    bool ShardFilterStage::isEOF() { return _child->isEOF(); }

    PlanStage::StageState ShardFilterStage::work(WorkingSetID* out) {
        ++_commonStats.works;

        // If we've returned as many results as we're limited to, isEOF will be true.
        if (isEOF()) { return PlanStage::IS_EOF; }

        StageState status = _child->work(out);

        if (PlanStage::ADVANCED == status) {
            // If we're sharded make sure that we don't return any data that hasn't been migrated
            // off of our shared yet.
            if (_metadata) {
                KeyPattern kp(_metadata->getKeyPattern());

                WorkingSetMember* member = _ws->get(*out);

                // This performs excessive BSONObj creation but that's OK for now.
                if (!_metadata->keyBelongsToMe(kp.extractSingleKey(member->obj))) {
                    _ws->free(*out);
                    ++_specificStats.chunkSkips;
                    return PlanStage::NEED_TIME;
                }
            }

            // If we're here either we have shard state and our doc passed, or we have no shard
            // state.  Either way, we advance.
            ++_commonStats.advanced;
            return status;
        }
        else {
            if (PlanStage::NEED_TIME == status) {
                ++_commonStats.needTime;
            }
            return status;
        }
    }

    void ShardFilterStage::prepareToYield() {
        ++_commonStats.yields;
        _child->prepareToYield();
    }

    void ShardFilterStage::recoverFromYield() {
        ++_commonStats.unyields;
        _child->recoverFromYield();
    }

    void ShardFilterStage::invalidate(const DiskLoc& dl, InvalidationType type) {
        ++_commonStats.invalidates;
        _child->invalidate(dl, type);
    }

    PlanStageStats* ShardFilterStage::getStats() {
        _commonStats.isEOF = isEOF();
        auto_ptr<PlanStageStats> ret(new PlanStageStats(_commonStats, STAGE_SHARDING_FILTER));
        ret->children.push_back(_child->getStats());
        ret->specific.reset(new ShardingFilterStats(_specificStats));
        return ret.release();
    }

}  // namespace mongo