summaryrefslogtreecommitdiff
path: root/src/mongo/db/exec/simple_plan_runner.h
blob: 490d9ba4996c185210afe5c86dd4281a0ee8ce10 (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
/**
 *    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/>.
 */

#include "mongo/db/exec/plan_stage.h"
#include "mongo/db/exec/working_set.h"
#include "mongo/db/exec/working_set_common.h"

namespace mongo {

    /**
     * A placeholder for a full-featured plan runner.  Calls work() on a plan until a result is
     * produced.  Stops when the plan is EOF or if the plan errors.
     *
     * TODO: Yielding policy
     * TODO: Graceful error handling
     * TODO: Fetch
     * TODO: Stats, diagnostics, instrumentation, etc.
     */
    class SimplePlanRunner {
    public:
        SimplePlanRunner() { }

        WorkingSet* getWorkingSet() { return &_workingSet; }

        /**
         * Takes ownership of root.
         */
        void setRoot(PlanStage* root) {
            verify(root);
            _root.reset(root);
        }

        bool getNext(BSONObj* objOut) {
            for (;;) {
                WorkingSetID id;
                PlanStage::StageState code = _root->work(&id);

                if (PlanStage::ADVANCED == code) {
                    WorkingSetMember* member = _workingSet.get(id);
                    uassert(16912, "Couldn't fetch obj from query plan",
                            WorkingSetCommon::fetch(member));
                    *objOut = member->obj;
                    _workingSet.free(id);
                    return true;
                }
                else if (code == PlanStage::NEED_TIME) {
                    // TODO: Occasionally yield.  For now, we run until we get another result.
                }
                else {
                    // IS_EOF, ERROR, NEED_YIELD.  We just stop here.
                    return false;
                }
            }
        }

    private:
        WorkingSet _workingSet;
        scoped_ptr<PlanStage> _root;
    };

}  // namespace mongo