summaryrefslogtreecommitdiff
path: root/src/mongo/db/extsort.h
blob: 5b1b322fd5524ef15d65844a24f25c7dcd2e97b8 (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
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
// extsort.h

/**
*    Copyright (C) 2008 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.
*/

#pragma once

#include "mongo/pch.h"

#include "mongo/db/index.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/curop-inl.h"
#include "mongo/util/array.h"

#define MONGO_USE_NEW_SORTER 1

#if MONGO_USE_NEW_SORTER
#   include "mongo/db/sorter/sorter.h"
#endif

namespace mongo {

    typedef pair<BSONObj, DiskLoc> ExternalSortDatum;

    /**
     * To external sort, you provide a pointer to an implementation of this class.
     * The compare function follows the usual -1, 0, 1 semantics.
     */
    class ExternalSortComparison {
    public:
        virtual ~ExternalSortComparison() { }
        virtual int compare(const ExternalSortDatum& l, const ExternalSortDatum& r) const = 0;
    };

#if MONGO_USE_NEW_SORTER
    // TODO This class will probably disappear in the future or be replaced with a typedef
    class BSONObjExternalSorter : boost::noncopyable {
    public:
        typedef pair<BSONObj, DiskLoc> Data;
        typedef SortIteratorInterface<BSONObj, DiskLoc> Iterator;

        BSONObjExternalSorter(const ExternalSortComparison* comp, long maxFileSize=100*1024*1024);

        void add( const BSONObj& o, const DiskLoc& loc, bool mayInterrupt ) {
            *_mayInterrupt = mayInterrupt;
            _sorter->add(o.getOwned(), loc);
        }

        auto_ptr<Iterator> iterator() { return auto_ptr<Iterator>(_sorter->done()); }

        void sort( bool mayInterrupt ) { *_mayInterrupt = mayInterrupt; }
        int numFiles() { return _sorter->numFiles(); }
        long getCurSizeSoFar() { return _sorter->memUsed(); }
        void hintNumObjects(long long) {} // unused

    private:
        shared_ptr<bool> _mayInterrupt;
        scoped_ptr<Sorter<BSONObj, DiskLoc> > _sorter;
    };
#else
    /**
       for external (disk) sorting by BSONObj and attaching a value
     */
    class BSONObjExternalSorter : boost::noncopyable {
    public:
        BSONObjExternalSorter(const ExternalSortComparison* cmp,
                              long maxFileSize = 1024 * 1024 * 100 );
        ~BSONObjExternalSorter();
 
    private:
        static HLMutex _extSortMutex;

        static int _compare(const ExternalSortComparison* cmp, const ExternalSortDatum& l,
                            const ExternalSortDatum& r);

        class MyCmp {
        public:
            MyCmp(const ExternalSortComparison* cmp) : _cmp(cmp) { }
            bool operator()( const ExternalSortDatum &l, const ExternalSortDatum &r ) const {
                return _cmp->compare(l, r) < 0;
            };
        private:
            const ExternalSortComparison* _cmp;
        };

        static bool extSortMayInterrupt;
        static int extSortComp( const void *lv, const void *rv );
        static const ExternalSortComparison* staticExtSortCmp;

        class FileIterator : boost::noncopyable {
        public:
            FileIterator( const std::string& file );
            ~FileIterator();
            bool more();
            ExternalSortDatum next();
        private:
            bool _read( char* buf, long long count );

            int _file;
            unsigned long long _length;
            unsigned long long _readSoFar;
        };

    public:

        typedef FastArray<ExternalSortDatum> InMemory;

        class Iterator : boost::noncopyable {
        public:

            Iterator( BSONObjExternalSorter * sorter );
            ~Iterator();
            bool more();
            ExternalSortDatum next();

        private:
            MyCmp _cmp;
            vector<FileIterator*> _files;
            vector< pair<ExternalSortDatum,bool> > _stash;

            InMemory * _in;
            InMemory::iterator _it;

        };

        void add( const BSONObj& o, const DiskLoc& loc, bool mayInterrupt );

        /* call after adding values, and before fetching the iterator */
        void sort( bool mayInterrupt );

        auto_ptr<Iterator> iterator() {
            uassert( 10052 ,  "not sorted" , _sorted );
            return auto_ptr<Iterator>( new Iterator( this ) );
        }

        int numFiles() {
            return _files.size();
        }

        long getCurSizeSoFar() { return _curSizeSoFar; }

        void hintNumObjects( long long numObjects ) {
            if ( numObjects < _arraySize )
                _arraySize = (int)(numObjects + 100);
        }

    private:

        void _sortInMem( bool mayInterrupt );

        void sort( const std::string& file );
        void finishMap( bool mayInterrupt );

        const ExternalSortComparison* _cmp;
        long _maxFilesize;
        boost::filesystem::path _root;

        int _arraySize;
        InMemory * _cur;
        long _curSizeSoFar;

        list<string> _files;
        bool _sorted;

        static unsigned long long _compares;
        static unsigned long long _uniqueNumber;
    };
#endif
}