libeiskaltdcpp-dev 2.2.9-3 / usr / include / eiskaltdcpp / dcpp / HashManager.h

/*
 * Copyright (C) 2001-2012 Jacek Sieka, arnetheduck on gmail point com
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#pragma once

#include "Singleton.h"
#include "MerkleTree.h"
#include "Thread.h"
#include "CriticalSection.h"
#include "Semaphore.h"
#include "TimerManager.h"
#include "Util.h"
#include "FastAlloc.h"
#include "Text.h"
#include "Streams.h"
#include "HashManagerListener.h"

#ifdef USE_XATTR
#include "attr/attributes.h"
#else
#define ATTR_MAX_VALUELEN 128
#endif

namespace dcpp {

STANDARD_EXCEPTION(HashException);
class File;

class HashLoader;
class FileException;

class HashManager : public Singleton<HashManager>, public Speaker<HashManagerListener>,
    private TimerManagerListener
{
public:

    /** We don't keep leaves for blocks smaller than this... */
    static const int64_t MIN_BLOCK_SIZE;

    HashManager() {
        TimerManager::getInstance()->addListener(this);
    }
    virtual ~HashManager() noexcept {
        TimerManager::getInstance()->removeListener(this);
        hasher.join();
    }

    /**
     * Check if the TTH tree associated with the filename is current.
     */
    bool checkTTH(const string& aFileName, int64_t aSize, uint32_t aTimeStamp);

    void stopHashing(const string& baseDir) { hasher.stopHashing(baseDir); }
    void setPriority(Thread::Priority p) { hasher.setThreadPriority(p); }

    /** @return TTH root */
    TTHValue getTTH(const string& aFileName, int64_t aSize);

    /** eiskaltdc++ **/
    const TTHValue* getFileTTHif(const string& aFileName);

    bool getTree(const TTHValue& root, TigerTree& tt);

    /** Return block size of the tree associated with root, or 0 if no such tree is in the store */
    size_t getBlockSize(const TTHValue& root);

    void addTree(const string& aFileName, uint32_t aTimeStamp, const TigerTree& tt) {
        hashDone(aFileName, aTimeStamp, tt, -1, -1);
    }
    void addTree(const TigerTree& tree) { Lock l(cs); store.addTree(tree); }

    void getStats(string& curFile, int64_t& bytesLeft, size_t& filesLeft) {
        hasher.getStats(curFile, bytesLeft, filesLeft);
    }

    /**
     * Rebuild hash data file
     */
    void rebuild() { hasher.scheduleRebuild(); }

    void startup() { hasher.start(); store.load(); }

    void shutdown() {
        hasher.shutdown();
        hasher.join();
        Lock l(cs);
        store.save();
    }

    struct HashPauser {
        HashPauser();
        ~HashPauser();

    private:
        bool resume;
    };

    /// @return whether hashing was already paused
    bool pauseHashing();
    void resumeHashing();
    bool isHashingPaused() const;

private:
    class Hasher : public Thread {
    public:
        Hasher() : stop(false), running(false), paused(0), rebuild(false), currentSize(0) { }

        void hashFile(const string& fileName, int64_t size);

        /// @return whether hashing was already paused
        bool pause();
        void resume();
        bool isPaused() const;

        void stopHashing(const string& baseDir);
        virtual int run();
        bool fastHash(const string& fname, uint8_t* buf, TigerTree& tth, int64_t size, CRC32Filter* xcrc32);
        void getStats(string& curFile, int64_t& bytesLeft, size_t& filesLeft);
        void shutdown() { stop = true; if(paused){ s.signal(); resume();} s.signal(); }
        void scheduleRebuild() { rebuild = true; if(paused) s.signal(); s.signal(); }

    private:
        // Case-sensitive (faster), it is rather unlikely that case changes, and if it does it's harmless.
        // map because it's sorted (to avoid random hash order that would create quite strange shares while hashing)
        typedef map<string, int64_t> WorkMap;
        typedef WorkMap::iterator WorkIter;

        WorkMap w;
        mutable CriticalSection cs;
        Semaphore s;

        bool stop;
        bool running;
        unsigned paused;
        bool rebuild;
        string currentFile;
        int64_t currentSize;

        void instantPause();
    };

    friend class Hasher;

    class HashStore {
    public:
        HashStore();
        void addFile(const string& aFileName, uint32_t aTimeStamp, const TigerTree& tth, bool aUsed);

        void load();
        void save();

        void rebuild();

        bool checkTTH(const string& aFileName, int64_t aSize, uint32_t aTimeStamp);

        void addTree(const TigerTree& tt) noexcept;
        const TTHValue* getTTH(const string& aFileName);
        bool getTree(const TTHValue& root, TigerTree& tth);
        size_t getBlockSize(const TTHValue& root) const;
        bool isDirty() { return dirty; }
    private:
        /** Root -> tree mapping info, we assume there's only one tree for each root (a collision would mean we've broken tiger...) */
        struct TreeInfo {
            TreeInfo() : size(0), index(0), blockSize(0) { }
            TreeInfo(int64_t aSize, int64_t aIndex, int64_t aBlockSize) : size(aSize), index(aIndex), blockSize(aBlockSize) { }
            TreeInfo(const TreeInfo& rhs) : size(rhs.size), index(rhs.index), blockSize(rhs.blockSize) { }
            TreeInfo& operator=(const TreeInfo& rhs) { size = rhs.size; index = rhs.index; blockSize = rhs.blockSize; return *this; }

            GETSET(int64_t, size, Size);
            GETSET(int64_t, index, Index);
            GETSET(int64_t, blockSize, BlockSize);
        };

        /** File -> root mapping info */
        struct FileInfo {
        public:
            FileInfo(const string& aFileName, const TTHValue& aRoot, uint32_t aTimeStamp, bool aUsed) :
                fileName(aFileName), root(aRoot), timeStamp(aTimeStamp), used(aUsed) { }

            bool operator==(const string& name) { return name == fileName; }

            GETSET(string, fileName, FileName);
            GETSET(TTHValue, root, Root);
            GETSET(uint32_t, timeStamp, TimeStamp);
            GETSET(bool, used, Used);
        };

        typedef vector<FileInfo> FileInfoList;
        typedef FileInfoList::iterator FileInfoIter;

        typedef unordered_map<string, FileInfoList> DirMap;
        typedef DirMap::iterator DirIter;

        typedef unordered_map<TTHValue, TreeInfo> TreeMap;
        typedef TreeMap::iterator TreeIter;

        friend class HashLoader;

        DirMap fileIndex;
        TreeMap treeIndex;

        bool dirty;

        void createDataFile(const string& name);

        bool loadTree(File& dataFile, const TreeInfo& ti, const TTHValue& root, TigerTree& tt);
        int64_t saveTree(File& dataFile, const TigerTree& tt);

        string getIndexFile() { return Util::getPath(Util::PATH_USER_CONFIG) + "HashIndex.xml"; }
        string getDataFile() { return Util::getPath(Util::PATH_USER_CONFIG) + "HashData.dat"; }
    };

    friend class HashLoader;

    Hasher hasher;
    HashStore store;

    class StreamStore
    {
    public:
        struct TTHStreamHeader
        {
            uint32_t magic;
            uint32_t checksum;
            uint64_t fileSize;
            uint64_t timeStamp;
            uint64_t blockSize;
            TTHValue root;
        };

        bool loadTree(const string& p_filePath, TigerTree &tree, int64_t p_aFileSize = -1);
        bool saveTree(const string& p_filePath, const TigerTree& p_Tree);
        void deleteStream(const string& p_filePath);

    private:
        static const uint32_t g_MAGIC = 0x2b2b6c67;
        static const string g_streamName;

        void setCheckSum(TTHStreamHeader& p_header);
        bool validateCheckSum(const TTHStreamHeader& p_header);
    };
    StreamStore m_streamstore;

    mutable CriticalSection cs;

    /** Single node tree where node = root, no storage in HashData.dat */
    static const int64_t SMALL_TREE = -1;

    void hashDone(const string& aFileName, uint32_t aTimeStamp, const TigerTree& tth, int64_t speed, int64_t size);

    void doRebuild() {
        Lock l(cs);
        store.rebuild();
    }

    virtual void on(TimerManagerListener::Minute, uint64_t) noexcept {
        Lock l(cs);
        store.save();
    }
    void on(TimerManagerListener::Second, uint64_t) noexcept;
};

} // namespace dcpp