aria2/src/DefaultPieceStorage.h

314 lines
8.8 KiB
C++

/* <!-- copyright */
/*
* aria2 - The high speed download utility
*
* Copyright (C) 2006 Tatsuhiro Tsujikawa
*
* 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
*
* In addition, 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 two.
* You must obey the GNU General Public License in all respects
* for all of the code used other than OpenSSL. 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 here.
*/
/* copyright --> */
#ifndef D_DEFAULT_PIECE_STORAGE_H
#define D_DEFAULT_PIECE_STORAGE_H
#include "PieceStorage.h"
#include <deque>
#include <set>
#include "a2functional.h"
namespace aria2 {
class DownloadContext;
class BitfieldMan;
class Option;
class DiskWriterFactory;
class FileEntry;
class PieceStatMan;
class PieceSelector;
class StreamPieceSelector;
#define END_GAME_PIECE_NUM 20
class HaveEntry {
private:
cuid_t cuid_;
size_t index_;
Timer registeredTime_;
public:
HaveEntry(cuid_t cuid, size_t index, const Timer& registeredTime):
cuid_(cuid),
index_(index),
registeredTime_(registeredTime) {}
cuid_t getCuid() const { return cuid_; }
size_t getIndex() const { return index_; }
const Timer& getRegisteredTime() const { return registeredTime_; }
};
class DefaultPieceStorage : public PieceStorage {
private:
SharedHandle<DownloadContext> downloadContext_;
BitfieldMan* bitfieldMan_;
SharedHandle<DiskAdaptor> diskAdaptor_;
SharedHandle<DiskWriterFactory> diskWriterFactory_;
typedef std::set<SharedHandle<Piece>,
DerefLess<SharedHandle<Piece> > > UsedPieceSet;
UsedPieceSet usedPieces_;
bool endGame_;
size_t endGamePieceNum_;
const Option* option_;
std::deque<HaveEntry> haves_;
SharedHandle<PieceStatMan> pieceStatMan_;
SharedHandle<PieceSelector> pieceSelector_;
SharedHandle<StreamPieceSelector> streamPieceSelector_;
#ifdef ENABLE_BITTORRENT
void getMissingPiece
(std::vector<SharedHandle<Piece> >& pieces,
size_t minMissingBlocks,
const unsigned char* bitfield,
size_t length,
cuid_t cuid);
void createFastIndexBitfield(BitfieldMan& bitfield,
const SharedHandle<Peer>& peer);
#endif // ENABLE_BITTORRENT
SharedHandle<Piece> checkOutPiece(size_t index, cuid_t cuid);
// size_t deleteUsedPiecesByFillRate(int fillRate, size_t toDelete);
// void reduceUsedPieces(size_t upperBound);
void deleteUsedPiece(const SharedHandle<Piece>& piece);
SharedHandle<Piece> findUsedPiece(size_t index) const;
// Returns the sum of completed length of in-flight pieces
int64_t getInFlightPieceCompletedLength() const;
// Returns the sum of completed length of in-flight pieces
// intersecting filter ranges.
int64_t getInFlightPieceFilteredCompletedLength() const;
public:
// Setting randomPieceStatsOrdering to true means a piece is chosen in
// random when more than 2 pieces has the same rarity.
// If it is set to false, a piece whose index is smallest has the highest
// priority.
DefaultPieceStorage(const SharedHandle<DownloadContext>& downloadContext,
const Option* option);
virtual ~DefaultPieceStorage();
#ifdef ENABLE_BITTORRENT
virtual bool hasMissingPiece(const SharedHandle<Peer>& peer);
virtual void getMissingPiece
(std::vector<SharedHandle<Piece> >& pieces,
size_t minMissingBlocks,
const SharedHandle<Peer>& peer,
cuid_t cuid);
virtual void getMissingPiece
(std::vector<SharedHandle<Piece> >& pieces,
size_t minMissingBlocks,
const SharedHandle<Peer>& peer,
const std::vector<size_t>& excludedIndexes,
cuid_t cuid);
virtual void getMissingFastPiece
(std::vector<SharedHandle<Piece> >& pieces,
size_t minMissingBlocks,
const SharedHandle<Peer>& peer,
cuid_t cuid);
virtual void getMissingFastPiece
(std::vector<SharedHandle<Piece> >& pieces,
size_t minMissingBlocks,
const SharedHandle<Peer>& peer,
const std::vector<size_t>& excludedIndexes,
cuid_t cuid);
virtual SharedHandle<Piece> getMissingPiece
(const SharedHandle<Peer>& peer,
cuid_t cuid);
virtual SharedHandle<Piece> getMissingPiece
(const SharedHandle<Peer>& peer,
const std::vector<size_t>& excludedIndexes,
cuid_t cuid);
SharedHandle<Piece> getMissingFastPiece
(const SharedHandle<Peer>& peer,
cuid_t cuid);
SharedHandle<Piece> getMissingFastPiece
(const SharedHandle<Peer>& peer,
const std::vector<size_t>& excludedIndexes,
cuid_t cuid);
#endif // ENABLE_BITTORRENT
virtual bool hasMissingUnusedPiece();
virtual SharedHandle<Piece> getMissingPiece
(size_t minSplitSize,
const unsigned char* ignoreBitfield,
size_t length,
cuid_t cuid);
virtual SharedHandle<Piece> getMissingPiece(size_t index, cuid_t cuid);
virtual SharedHandle<Piece> getPiece(size_t index);
virtual void completePiece(const SharedHandle<Piece>& piece);
virtual void cancelPiece(const SharedHandle<Piece>& piece, cuid_t cuid);
virtual bool hasPiece(size_t index);
virtual bool isPieceUsed(size_t index);
virtual int64_t getTotalLength();
virtual int64_t getFilteredTotalLength();
virtual int64_t getCompletedLength();
virtual int64_t getFilteredCompletedLength();
virtual void initStorage();
virtual void setupFileFilter();
virtual void clearFileFilter();
virtual bool downloadFinished();
virtual bool allDownloadFinished();
virtual void setBitfield(const unsigned char* bitfield,
size_t bitfieldLength);
virtual size_t getBitfieldLength();
virtual const unsigned char* getBitfield();
virtual void setEndGamePieceNum(size_t num) {
endGamePieceNum_ = num;
}
size_t getEndGamePieceNum() const {
return endGamePieceNum_;
}
virtual bool isSelectiveDownloadingMode();
virtual bool isEndGame()
{
return endGame_;
}
virtual void enterEndGame()
{
endGame_ = true;
}
virtual SharedHandle<DiskAdaptor> getDiskAdaptor();
virtual int32_t getPieceLength(size_t index);
virtual void advertisePiece(cuid_t cuid, size_t index);
virtual void
getAdvertisedPieceIndexes(std::vector<size_t>& indexes,
cuid_t myCuid, const Timer& lastCheckTime);
virtual void removeAdvertisedPiece(time_t elapsed);
virtual void markAllPiecesDone();
virtual void markPiecesDone(int64_t length);
virtual void markPieceMissing(size_t index);
virtual void addInFlightPiece
(const std::vector<SharedHandle<Piece> >& pieces);
virtual size_t countInFlightPiece();
virtual void getInFlightPieces
(std::vector<SharedHandle<Piece> >& pieces);
virtual void addPieceStats(size_t index);
virtual void addPieceStats(const unsigned char* bitfield,
size_t bitfieldLength);
virtual void subtractPieceStats(const unsigned char* bitfield,
size_t bitfieldLength);
virtual void updatePieceStats(const unsigned char* newBitfield,
size_t newBitfieldLength,
const unsigned char* oldBitfield);
virtual size_t getNextUsedIndex(size_t index);
virtual void onDownloadIncomplete();
/**
* This method is made private for test purpose only.
*/
void addUsedPiece(const SharedHandle<Piece>& piece);
void setDiskWriterFactory
(const SharedHandle<DiskWriterFactory>& diskWriterFactory);
const SharedHandle<PieceStatMan>& getPieceStatMan() const
{
return pieceStatMan_;
}
void setPieceSelector(const SharedHandle<PieceSelector>& pieceSelector)
{
pieceSelector_ = pieceSelector;
}
const SharedHandle<PieceSelector>& getPieceSelector() const
{
return pieceSelector_;
}
};
typedef SharedHandle<DefaultPieceStorage> DefaultPieceStorageHandle;
} // namespace aria2
#endif // D_DEFAULT_PIECE_STORAGE_H