DefaultPieceStorage.h 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  1. /* <!-- copyright */
  2. /*
  3. * aria2 - The high speed download utility
  4. *
  5. * Copyright (C) 2006 Tatsuhiro Tsujikawa
  6. *
  7. * This program is free software; you can redistribute it and/or modify
  8. * it under the terms of the GNU General Public License as published by
  9. * the Free Software Foundation; either version 2 of the License, or
  10. * (at your option) any later version.
  11. *
  12. * This program is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. * GNU General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU General Public License
  18. * along with this program; if not, write to the Free Software
  19. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20. *
  21. * In addition, as a special exception, the copyright holders give
  22. * permission to link the code of portions of this program with the
  23. * OpenSSL library under certain conditions as described in each
  24. * individual source file, and distribute linked combinations
  25. * including the two.
  26. * You must obey the GNU General Public License in all respects
  27. * for all of the code used other than OpenSSL. If you modify
  28. * file(s) with this exception, you may extend this exception to your
  29. * version of the file(s), but you are not obligated to do so. If you
  30. * do not wish to do so, delete this exception statement from your
  31. * version. If you delete this exception statement from all source
  32. * files in the program, then also delete it here.
  33. */
  34. /* copyright --> */
  35. #ifndef _D_DEFAULT_PIECE_STORAGE_H_
  36. #define _D_DEFAULT_PIECE_STORAGE_H_
  37. #include "PieceStorage.h"
  38. #include <deque>
  39. namespace aria2 {
  40. class DownloadContext;
  41. class BitfieldMan;
  42. class Logger;
  43. class Option;
  44. class DiskWriterFactory;
  45. class FileEntry;
  46. class PieceStatMan;
  47. class PieceSelector;
  48. #define END_GAME_PIECE_NUM 20
  49. class HaveEntry {
  50. private:
  51. cuid_t _cuid;
  52. size_t _index;
  53. Timer _registeredTime;
  54. public:
  55. HaveEntry(cuid_t cuid, size_t index, const Timer& registeredTime):
  56. _cuid(cuid),
  57. _index(index),
  58. _registeredTime(registeredTime) {}
  59. cuid_t getCuid() const { return _cuid; }
  60. size_t getIndex() const { return _index; }
  61. const Timer& getRegisteredTime() const { return _registeredTime; }
  62. };
  63. class DefaultPieceStorage : public PieceStorage {
  64. private:
  65. SharedHandle<DownloadContext> _downloadContext;
  66. BitfieldMan* _bitfieldMan;
  67. SharedHandle<DiskAdaptor> _diskAdaptor;
  68. SharedHandle<DiskWriterFactory> _diskWriterFactory;
  69. std::deque<SharedHandle<Piece> > _usedPieces;
  70. size_t _endGamePieceNum;
  71. Logger* _logger;
  72. const Option* _option;
  73. std::deque<HaveEntry> _haves;
  74. SharedHandle<PieceStatMan> _pieceStatMan;
  75. SharedHandle<PieceSelector> _pieceSelector;
  76. bool getMissingPieceIndex(size_t& index,
  77. const unsigned char* bitfield, size_t length);
  78. SharedHandle<Piece> getMissingPiece(const unsigned char* bitfield,
  79. size_t length);
  80. SharedHandle<Piece> getMissingPiece(const BitfieldMan& bitfield);
  81. #ifdef ENABLE_BITTORRENT
  82. void createFastIndexBitfield(BitfieldMan& bitfield,
  83. const SharedHandle<Peer>& peer);
  84. #endif // ENABLE_BITTORRENT
  85. SharedHandle<Piece> checkOutPiece(size_t index);
  86. // size_t deleteUsedPiecesByFillRate(int fillRate, size_t toDelete);
  87. // void reduceUsedPieces(size_t upperBound);
  88. void deleteUsedPiece(const SharedHandle<Piece>& piece);
  89. SharedHandle<Piece> findUsedPiece(size_t index) const;
  90. size_t getInFlightPieceCompletedLength() const;
  91. public:
  92. // Setting randomPieceStatsOrdering to true means a piece is chosen in
  93. // random when more than 2 pieces has the same rarity.
  94. // If it is set to false, a piece whose index is smallest has the highest
  95. // priority.
  96. DefaultPieceStorage(const SharedHandle<DownloadContext>& downloadContext,
  97. const Option* option);
  98. virtual ~DefaultPieceStorage();
  99. #ifdef ENABLE_BITTORRENT
  100. virtual bool hasMissingPiece(const SharedHandle<Peer>& peer);
  101. virtual SharedHandle<Piece> getMissingPiece(const SharedHandle<Peer>& peer);
  102. virtual SharedHandle<Piece> getMissingFastPiece
  103. (const SharedHandle<Peer>& peer);
  104. virtual SharedHandle<Piece> getMissingPiece
  105. (const SharedHandle<Peer>& peer, const std::vector<size_t>& excludedIndexes);
  106. virtual SharedHandle<Piece> getMissingFastPiece
  107. (const SharedHandle<Peer>& peer, const std::vector<size_t>& excludedIndexes);
  108. #endif // ENABLE_BITTORRENT
  109. virtual bool hasMissingUnusedPiece();
  110. virtual SharedHandle<Piece> getSparseMissingUnusedPiece
  111. (const unsigned char* ignoreBitfield, size_t length);
  112. virtual SharedHandle<Piece> getMissingPiece(size_t index);
  113. virtual SharedHandle<Piece> getPiece(size_t index);
  114. virtual void completePiece(const SharedHandle<Piece>& piece);
  115. virtual void cancelPiece(const SharedHandle<Piece>& piece);
  116. virtual bool hasPiece(size_t index);
  117. virtual bool isPieceUsed(size_t index);
  118. virtual uint64_t getTotalLength();
  119. virtual uint64_t getFilteredTotalLength();
  120. virtual uint64_t getCompletedLength();
  121. virtual uint64_t getFilteredCompletedLength();
  122. virtual void initStorage();
  123. virtual void setupFileFilter();
  124. virtual void clearFileFilter();
  125. virtual bool downloadFinished();
  126. virtual bool allDownloadFinished();
  127. virtual void setBitfield(const unsigned char* bitfield,
  128. size_t bitfieldLength);
  129. virtual size_t getBitfieldLength();
  130. virtual const unsigned char* getBitfield();
  131. virtual void setEndGamePieceNum(size_t num) {
  132. _endGamePieceNum = num;
  133. }
  134. size_t getEndGamePieceNum() const {
  135. return _endGamePieceNum;
  136. }
  137. virtual bool isSelectiveDownloadingMode();
  138. virtual bool isEndGame();
  139. virtual SharedHandle<DiskAdaptor> getDiskAdaptor();
  140. virtual size_t getPieceLength(size_t index);
  141. virtual void advertisePiece(cuid_t cuid, size_t index);
  142. virtual void
  143. getAdvertisedPieceIndexes(std::vector<size_t>& indexes,
  144. cuid_t myCuid, const Timer& lastCheckTime);
  145. virtual void removeAdvertisedPiece(time_t elapsed);
  146. virtual void markAllPiecesDone();
  147. virtual void markPiecesDone(uint64_t length);
  148. virtual void markPieceMissing(size_t index);
  149. virtual void addInFlightPiece
  150. (const std::vector<SharedHandle<Piece> >& pieces);
  151. virtual size_t countInFlightPiece();
  152. virtual void getInFlightPieces
  153. (std::vector<SharedHandle<Piece> >& pieces);
  154. virtual void addPieceStats(size_t index);
  155. virtual void addPieceStats(const unsigned char* bitfield,
  156. size_t bitfieldLength);
  157. virtual void subtractPieceStats(const unsigned char* bitfield,
  158. size_t bitfieldLength);
  159. virtual void updatePieceStats(const unsigned char* newBitfield,
  160. size_t newBitfieldLength,
  161. const unsigned char* oldBitfield);
  162. /**
  163. * This method is made private for test purpose only.
  164. */
  165. void addUsedPiece(const SharedHandle<Piece>& piece);
  166. void setDiskWriterFactory
  167. (const SharedHandle<DiskWriterFactory>& diskWriterFactory);
  168. const SharedHandle<PieceStatMan>& getPieceStatMan() const
  169. {
  170. return _pieceStatMan;
  171. }
  172. void setPieceSelector(const SharedHandle<PieceSelector>& pieceSelector)
  173. {
  174. _pieceSelector = pieceSelector;
  175. }
  176. const SharedHandle<PieceSelector>& getPieceSelector() const
  177. {
  178. return _pieceSelector;
  179. }
  180. };
  181. typedef SharedHandle<DefaultPieceStorage> DefaultPieceStorageHandle;
  182. } // namespace aria2
  183. #endif // _D_DEFAULT_PIECE_STORAGE_H_