ExternalSort.h

Go to the documentation of this file.

#ifndef SORT_EXTERNALSORT_H
#define SORT_EXTERNALSORT_H
 
#include "tdb.h"
 
#include <functional>
 
#include "extsort/ItemIterator.h"
#include "storage/VarlenDataPage.h"
#include "storage/FileManager.h"
 
namespace taco {
 
typedef std::function<int(const char *item1, const char *item2)>
        SortCompareFunction;
 
 
class ExternalSort {
public:
    static std::unique_ptr<ExternalSort>
    Create(const SortCompareFunction& comp, size_t merge_ways);
 
    ~ExternalSort();
 
    std::unique_ptr<ItemIterator> Sort(ItemIterator *input_iter);
 
private:
 
    class OutputIterator : public ItemIterator {
    public:
        OutputIterator(const File* tmpfile,
                       PageNumber final_num_pages);
 
        ~OutputIterator() override;
 
        bool Next() override;
 
        const char* GetCurrentItem(FieldOffset& p_reclen) override;
 
        bool SupportsRewind() const override { return true; }
 
        uint64_t SavePosition() const override {
            // TODO implement it
            return 0;
        }
 
        void Rewind(uint64_t pos) override;
 
        /*
         * Clean up state.
         */
        void EndScan() override;
    private:
 
        // You can add your own states for the iterator here.
    };
 
    ExternalSort(const SortCompareFunction& comp, size_t merge_ways);
 
    void SortInitialRuns(ItemIterator* item_iter);
 
    void GenerateNewPass(std::vector<PageNumber>& new_run_boundaries);
 
    PageNumber MergeInternalRuns(size_t low_run, size_t high_run);
 
    // You may add more utility functions if necessary.
 
    uint8_t m_current_pass;
    std::unique_ptr<File> m_file[2];
    size_t m_merge_ways;
    SortCompareFunction m_cmp;
    std::vector<PageNumber> m_run_boundaries;
 
    // You can add your own states here.
};
 
}   // namespace taco
 
#endif      // SORT_EXTERNALSORT_H