You add torrents through the add_torrent() function where you give an @@ -418,9 +422,15 @@ structure in the torrent-file.
If the torrent you are trying to add already exists in the session (is either queued for checking, being checked or downloading) add_torrent() will throw duplicate_torrent which derives from std::exception.
-The optional last parameter, resume_data can be given if up to date fast-resume data +
The optional parameter, resume_data can be given if up to date fast-resume data is available. The fast-resume data can be acquired from a running torrent by calling torrent_handle::write_resume_data(). See fast resume.
+The compact_mode paramater refers to the layout of the storage for this torrent. If +set to true (default), the storage will grow as more pieces are downloaded, and pieces +are rearranged to finally be in their correct places once the entire torrent has been +downloaded. If it is false, the entire storage is allocated before download begins. I.e. +the files contained in the torrent are filled with zeroes, and each downloaded piece +is put in its final place directly when downloaded.
The torrent_handle returned by add_torrent() can be used to retrieve information about the torrent's progress, its peers etc. It is also used to abort a torrent.
The second overload that takes a tracker url and an info-hash instead of metadata (entry) @@ -742,6 +752,8 @@ reverse_file_iterator rend_files() const; in the torrent, you can use begin_files(), end_files(), rbegin_files() and rend_files(). These will give you standard vector iterators with the type file_entry.
+The path is the full (relative) path of each file. i.e. if it is a multi-file +torrent, all the files starts with a directory with the same name as torrent_info::name().
struct file_entry
{
diff --git a/docs/manual.rst b/docs/manual.rst
index cf98b2a48..fd0dc6fe6 100755
--- a/docs/manual.rst
+++ b/docs/manual.rst
@@ -217,13 +217,15 @@ The ``session`` class has the following synopsis::
torrent_handle add_torrent(
entry const& e
, boost::filesystem::path const& save_path
- , entry const& resume_data = entry());
+ , entry const& resume_data = entry()
+ , bool compact_mode = true);
torrent_handle add_torrent(
char const* tracker_url
, sha1_hash const& info_hash
, boost::filesystem::path const& save_path
- , entry const& resume_data = entry());
+ , entry const& resume_data = entry()
+ , bool compact_mode = true);
void remove_torrent(torrent_handle const& h);
@@ -291,12 +293,14 @@ add_torrent()
torrent_handle add_torrent(
entry const& e
, boost::filesystem::path const& save_path
- , entry const& resume_data = entry());
+ , entry const& resume_data = entry()
+ , bool compact_mode = true);
torrent_handle add_torrent(
char const* tracker_url
, sha1_hash const& info_hash
, boost::filesystem::path const& save_path
- , entry const& resume_data = entry());
+ , entry const& resume_data = entry()
+ , bool compact_mode = true);
You add torrents through the ``add_torrent()`` function where you give an
object representing the information found in the torrent file and the path where you
@@ -307,10 +311,17 @@ If the torrent you are trying to add already exists in the session (is either qu
for checking, being checked or downloading) ``add_torrent()`` will throw
duplicate_torrent_ which derives from ``std::exception``.
-The optional last parameter, ``resume_data`` can be given if up to date fast-resume data
+The optional parameter, ``resume_data`` can be given if up to date fast-resume data
is available. The fast-resume data can be acquired from a running torrent by calling
``torrent_handle::write_resume_data()``. See `fast resume`_.
+The ``compact_mode`` paramater refers to the layout of the storage for this torrent. If
+set to true (default), the storage will grow as more pieces are downloaded, and pieces
+are rearranged to finally be in their correct places once the entire torrent has been
+downloaded. If it is false, the entire storage is allocated before download begins. I.e.
+the files contained in the torrent are filled with zeroes, and each downloaded piece
+is put in its final place directly when downloaded.
+
The torrent_handle_ returned by ``add_torrent()`` can be used to retrieve information
about the torrent's progress, its peers etc. It is also used to abort a torrent.
diff --git a/include/libtorrent/session.hpp b/include/libtorrent/session.hpp
index 675bfc3f5..8370d7ad8 100755
--- a/include/libtorrent/session.hpp
+++ b/include/libtorrent/session.hpp
@@ -311,13 +311,15 @@ namespace libtorrent
torrent_handle add_torrent(
entry const& metadata
, boost::filesystem::path const& save_path
- , entry const& resume_data = entry());
+ , entry const& resume_data = entry()
+ , bool compact_mode = true);
torrent_handle add_torrent(
char const* tracker_url
, sha1_hash const& info_hash
, boost::filesystem::path const& save_path
- , entry const& resume_data = entry());
+ , entry const& resume_data = entry()
+ , bool compact_mode = true);
session_status status() const;
diff --git a/include/libtorrent/storage.hpp b/include/libtorrent/storage.hpp
index f06accb5a..5b6f9e2a6 100755
--- a/include/libtorrent/storage.hpp
+++ b/include/libtorrent/storage.hpp
@@ -117,14 +117,15 @@ namespace libtorrent
piece_manager(
const torrent_info& info
- , const boost::filesystem::path& path);
+ , const boost::filesystem::path& path);
~piece_manager();
void check_pieces(
boost::mutex& mutex
- , detail::piece_checker_data& data
- , std::vector& pieces);
+ , detail::piece_checker_data& data
+ , std::vector& pieces
+ , bool compact_mode);
void release_files();
diff --git a/include/libtorrent/torrent.hpp b/include/libtorrent/torrent.hpp
index fc220e0ff..f106c3914 100755
--- a/include/libtorrent/torrent.hpp
+++ b/include/libtorrent/torrent.hpp
@@ -94,7 +94,8 @@ namespace libtorrent
detail::session_impl& ses
, entry const& metadata
, boost::filesystem::path const& save_path
- , address const& net_interface);
+ , address const& net_interface
+ , bool compact_mode);
// used with metadata-less torrents
// (the metadata is downloaded from the peers)
@@ -103,7 +104,8 @@ namespace libtorrent
, char const* tracker_url
, sha1_hash const& info_hash
, boost::filesystem::path const& save_path
- , address const& net_interface);
+ , address const& net_interface
+ , bool compact_mode);
~torrent();
@@ -493,6 +495,9 @@ namespace libtorrent
std::vector m_requested_metadata;
boost::filesystem::path m_save_path;
+
+ // determines the storage state for this torrent.
+ const bool m_compact_mode;
};
inline boost::posix_time::ptime torrent::next_announce() const
diff --git a/src/piece_picker.cpp b/src/piece_picker.cpp
index e58fd5ddd..07c171f5f 100755
--- a/src/piece_picker.cpp
+++ b/src/piece_picker.cpp
@@ -90,8 +90,7 @@ namespace libtorrent
- std::accumulate(pieces.begin(), pieces.end(), 0));
for (std::vector::const_iterator i = pieces.begin();
- i != pieces.end();
- ++i)
+ i != pieces.end(); ++i)
{
if (*i) continue;
int index = static_cast(i - pieces.begin());
@@ -103,8 +102,7 @@ namespace libtorrent
// add the pieces to the piece_picker
for (std::vector::iterator i = piece_list.begin();
- i != piece_list.end();
- ++i)
+ i != piece_list.end(); ++i)
{
int index = *i;
assert(index >= 0);
@@ -124,9 +122,7 @@ namespace libtorrent
if (!unfinished.empty())
{
for (std::vector::const_iterator i
- = unfinished.begin();
- i != unfinished.end();
- ++i)
+ = unfinished.begin(); i != unfinished.end(); ++i)
{
address peer;
for (int j = 0; j < m_blocks_per_piece; ++j)
@@ -151,8 +147,7 @@ namespace libtorrent
assert((int)m_piece_map.size() == t->torrent_file().num_pieces());
for (std::vector::const_iterator i = m_piece_map.begin();
- i != m_piece_map.end();
- ++i)
+ i != m_piece_map.end(); ++i)
{
int index = static_cast(i - m_piece_map.begin());
@@ -160,8 +155,7 @@ namespace libtorrent
{
int actual_peer_count = 0;
for (torrent::const_peer_iterator peer = t->begin();
- peer != t->end();
- ++peer)
+ peer != t->end(); ++peer)
{
if (peer->second->has_piece(index)) actual_peer_count++;
}
@@ -199,12 +193,10 @@ namespace libtorrent
// with this index. (there shouldn't
// be since the piece_map is 0xfffff)
for (std::vector >::const_iterator i = m_piece_info.begin();
- i != m_piece_info.end();
- ++i)
+ i != m_piece_info.end(); ++i)
{
for (std::vector::const_iterator j= i->begin();
- j != i->end();
- ++j)
+ j != i->end(); ++j)
{
assert(*j != index);
}
@@ -215,8 +207,7 @@ namespace libtorrent
++i)
{
for (std::vector::const_iterator j = i->begin();
- j != i->end();
- ++j)
+ j != i->end(); ++j)
{
assert(*j != index);
}
@@ -489,8 +480,7 @@ namespace libtorrent
assert(num_blocks > 0);
for (std::vector::const_iterator i = piece_list.begin();
- i != piece_list.end();
- ++i)
+ i != piece_list.end(); ++i)
{
assert(*i >= 0);
assert(*i < (int)m_piece_map.size());
@@ -771,8 +761,7 @@ namespace libtorrent
{
int counter = 0;
for (std::vector::const_iterator i = m_downloads.begin();
- i != m_downloads.end();
- ++i)
+ i != m_downloads.end(); ++i)
{
counter += (int)i->finished_blocks.count();
}
@@ -780,3 +769,4 @@ namespace libtorrent
}
}
+
diff --git a/src/session.cpp b/src/session.cpp
index a382b55aa..751e498b2 100755
--- a/src/session.cpp
+++ b/src/session.cpp
@@ -934,7 +934,8 @@ namespace libtorrent
torrent_handle session::add_torrent(
entry const& metadata
, boost::filesystem::path const& save_path
- , entry const& resume_data)
+ , entry const& resume_data
+ , bool compact_mode)
{
assert(!save_path.empty());
torrent_info ti(metadata);
@@ -962,7 +963,8 @@ namespace libtorrent
// the checker thread and store it before starting
// the thread
boost::shared_ptr torrent_ptr(
- new torrent(m_impl, metadata, save_path, m_impl.m_listen_interface));
+ new torrent(m_impl, metadata, save_path, m_impl.m_listen_interface
+ , compact_mode));
detail::piece_checker_data d;
d.torrent_ptr = torrent_ptr;
@@ -983,7 +985,8 @@ namespace libtorrent
char const* tracker_url
, sha1_hash const& info_hash
, boost::filesystem::path const& save_path
- , entry const&)
+ , entry const&
+ , bool compact_mode)
{
// TODO: support resume data in this case
assert(!save_path.empty());
@@ -1012,7 +1015,7 @@ namespace libtorrent
// the thread
boost::shared_ptr torrent_ptr(
new torrent(m_impl, tracker_url, info_hash, save_path
- , m_impl.m_listen_interface));
+ , m_impl.m_listen_interface, compact_mode));
m_impl.m_torrents.insert(
std::make_pair(info_hash, torrent_ptr)).first;
diff --git a/src/storage.cpp b/src/storage.cpp
index 9d30674e4..24d4d5206 100755
--- a/src/storage.cpp
+++ b/src/storage.cpp
@@ -557,12 +557,13 @@ namespace libtorrent
impl(
const torrent_info& info
- , const path& path);
+ , const path& path);
void check_pieces(
boost::mutex& mutex
- , detail::piece_checker_data& data
- , std::vector& pieces);
+ , detail::piece_checker_data& data
+ , std::vector& pieces
+ , bool compact_mode);
void release_files();
@@ -603,9 +604,13 @@ namespace libtorrent
void export_piece_map(std::vector& p) const;
private:
+
+ void post_check(boost::mutex& mutex
+ , detail::piece_checker_data& data);
+
// returns the slot currently associated with the given
// piece or assigns the given piece_index to a free slot
-
+
int identify_data(
const std::vector& piece_data
, int current_slot
@@ -621,6 +626,17 @@ namespace libtorrent
#endif
storage m_storage;
+ // if this is true, pieces are always allocated at the
+ // lowest possible slot index. If it is false, pieces
+ // are always written to their final place immediately
+ bool m_compact_mode;
+
+ // if this is true, pieces that haven't been downloaded
+ // will be filled with zeroes. Not filling with zeroes
+ // will not work in some cases (where a seek cannot pass
+ // the end of the file).
+ bool m_fill_mode;
+
// a bitmask representing the pieces we have
std::vector m_have_piece;
@@ -663,6 +679,8 @@ namespace libtorrent
const torrent_info& info
, const path& save_path)
: m_storage(info, save_path)
+ , m_compact_mode(false)
+ , m_fill_mode(true)
, m_info(info)
, m_save_path(complete(save_path))
, m_allocating(false)
@@ -703,16 +721,14 @@ namespace libtorrent
p.clear();
std::vector::const_reverse_iterator last;
for (last = m_slot_to_piece.rbegin();
- last != m_slot_to_piece.rend();
- ++last)
+ last != m_slot_to_piece.rend(); ++last)
{
if (*last != unallocated) break;
}
for (std::vector::const_iterator i =
m_slot_to_piece.begin();
- i != last.base();
- ++i)
+ i != last.base(); ++i)
{
p.push_back(*i);
}
@@ -970,8 +986,7 @@ namespace libtorrent
// already been assigned
int free_piece = unassigned;
for (std::vector::iterator i = matching_pieces.begin();
- i != matching_pieces.end();
- ++i)
+ i != matching_pieces.end(); ++i)
{
if (have_pieces[*i]) continue;
free_piece = *i;
@@ -993,10 +1008,33 @@ namespace libtorrent
}
}
+ void piece_manager::impl::post_check(boost::mutex& mutex
+ , detail::piece_checker_data& data)
+ {
+ if (!m_compact_mode)
+ {
+ // if we're not in compact mode, make sure the
+ // pieces are spread out and placed at their
+ // final position.
+ int num_slots = (int)m_unallocated_slots.size();
+
+ for (int i = 0; i < num_slots; ++i)
+ {
+ allocate_slots(1);
+
+ boost::mutex::scoped_lock lock(mutex);
+ data.progress = (float)i / num_slots;
+ if (data.abort || (data.torrent_ptr && data.torrent_ptr->is_aborted()))
+ return;
+ }
+ }
+ }
+
void piece_manager::impl::check_pieces(
boost::mutex& mutex
- , detail::piece_checker_data& data
- , std::vector& pieces)
+ , detail::piece_checker_data& data
+ , std::vector& pieces
+ , bool compact_mode)
{
assert(m_info.piece_length() > 0);
// synchronization ------------------------------------------------------
@@ -1005,6 +1043,8 @@ namespace libtorrent
INVARIANT_CHECK;
+ m_compact_mode = compact_mode;
+
// This will corrupt the storage
// use while debugging to find
// states that cannot be scanned
@@ -1058,6 +1098,9 @@ namespace libtorrent
{
m_unallocated_slots.push_back(i);
}
+
+ post_check(mutex, data);
+
return;
}
@@ -1309,15 +1352,19 @@ namespace libtorrent
return;
}
}
+
+ post_check(mutex, data);
+
// TODO: sort m_free_slots and m_unallocated_slots?
}
void piece_manager::check_pieces(
boost::mutex& mutex
- , detail::piece_checker_data& data
- , std::vector& pieces)
+ , detail::piece_checker_data& data
+ , std::vector& pieces
+ , bool compact_mode)
{
- m_pimpl->check_pieces(mutex, data, pieces);
+ m_pimpl->check_pieces(mutex, data, pieces, compact_mode);
}
int piece_manager::impl::allocate_slot_for_piece(int piece_index)
@@ -1491,29 +1538,30 @@ namespace libtorrent
const int piece_size = static_cast(m_info.piece_length());
- std::vector zeros(piece_size, 0);
+ std::vector buffer(piece_size, 0);
- for (int i = 0;
- i < num_slots && !m_unallocated_slots.empty();
- ++i)
+ for (int i = 0; i < num_slots && !m_unallocated_slots.empty(); ++i)
{
int pos = m_unallocated_slots.front();
// int piece_pos = pos;
+ bool write_back = false;
int new_free_slot = pos;
if (m_piece_to_slot[pos] != has_no_slot)
{
assert(m_piece_to_slot[pos] >= 0);
- m_storage.read(&zeros[0], m_piece_to_slot[pos], 0, static_cast(m_info.piece_size(pos)));
+ m_storage.read(&buffer[0], m_piece_to_slot[pos], 0, static_cast(m_info.piece_size(pos)));
new_free_slot = m_piece_to_slot[pos];
m_slot_to_piece[pos] = pos;
m_piece_to_slot[pos] = pos;
+ write_back = true;
}
m_unallocated_slots.erase(m_unallocated_slots.begin());
m_slot_to_piece[new_free_slot] = unassigned;
m_free_slots.push_back(new_free_slot);
- m_storage.write(&zeros[0], pos, 0, static_cast(m_info.piece_size(pos)));
+ if (write_back || m_fill_mode)
+ m_storage.write(&buffer[0], pos, 0, static_cast(m_info.piece_size(pos)));
}
assert(m_free_slots.size() > 0);
@@ -1546,8 +1594,7 @@ namespace libtorrent
assert((int)m_slot_to_piece.size() == m_info.num_pieces());
for (std::vector::const_iterator i = m_free_slots.begin();
- i != m_free_slots.end();
- ++i)
+ i != m_free_slots.end(); ++i)
{
assert(*i < (int)m_slot_to_piece.size());
assert(*i >= 0);
@@ -1555,8 +1602,7 @@ namespace libtorrent
}
for (std::vector::const_iterator i = m_unallocated_slots.begin();
- i != m_unallocated_slots.end();
- ++i)
+ i != m_unallocated_slots.end(); ++i)
{
assert(*i < (int)m_slot_to_piece.size());
assert(*i >= 0);
diff --git a/src/torrent.cpp b/src/torrent.cpp
index 3865d9d6a..53548f765 100755
--- a/src/torrent.cpp
+++ b/src/torrent.cpp
@@ -150,7 +150,8 @@ namespace libtorrent
detail::session_impl& ses
, entry const& metadata
, boost::filesystem::path const& save_path
- , address const& net_interface)
+ , address const& net_interface
+ , bool compact_mode)
: m_torrent_file(metadata)
, m_abort(false)
, m_paused(false)
@@ -179,6 +180,7 @@ namespace libtorrent
, m_upload_bandwidth_limit(std::numeric_limits::max())
, m_download_bandwidth_limit(std::numeric_limits::max())
, m_save_path(complete(save_path))
+ , m_compact_mode(compact_mode)
{
m_uploads_quota.min = 2;
m_connections_quota.min = 2;
@@ -198,7 +200,8 @@ namespace libtorrent
, char const* tracker_url
, sha1_hash const& info_hash
, boost::filesystem::path const& save_path
- , address const& net_interface)
+ , address const& net_interface
+ , bool compact_mode)
: m_torrent_file(info_hash)
, m_abort(false)
, m_paused(false)
@@ -226,6 +229,7 @@ namespace libtorrent
, m_upload_bandwidth_limit(std::numeric_limits::max())
, m_download_bandwidth_limit(std::numeric_limits::max())
, m_save_path(complete(save_path))
+ , m_compact_mode(compact_mode)
{
m_uploads_quota.min = 2;
m_connections_quota.min = 2;
@@ -760,7 +764,7 @@ namespace libtorrent
boost::mutex& mutex)
{
assert(m_storage.get());
- m_storage->check_pieces(mutex, data, m_have_pieces);
+ m_storage->check_pieces(mutex, data, m_have_pieces, m_compact_mode);
m_num_pieces = std::accumulate(
m_have_pieces.begin()
, m_have_pieces.end()