/* Copyright (c) 2003, Arvid Norberg All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef TORRENT_STORAGE_HPP_INCLUDE #define TORRENT_STORAGE_HPP_INCLUDE #include #ifdef _MSC_VER #pragma warning(push, 1) #endif #include #include #include #include #include #include #ifdef _MSC_VER #pragma warning(pop) #endif #include "libtorrent/torrent_info.hpp" #include "libtorrent/piece_picker.hpp" #include "libtorrent/intrusive_ptr_base.hpp" #include "libtorrent/peer_request.hpp" #include "libtorrent/hasher.hpp" #include "libtorrent/config.hpp" #include "libtorrent/file.hpp" #include "libtorrent/disk_buffer_holder.hpp" namespace libtorrent { namespace aux { struct piece_checker_data; } namespace fs = boost::filesystem; class session; struct file_pool; struct disk_io_job; struct disk_buffer_pool; enum storage_mode_t { storage_mode_allocate = 0, storage_mode_sparse, storage_mode_compact }; TORRENT_EXPORT std::vector > get_filesizes( file_storage const& t , fs::path p); TORRENT_EXPORT bool match_filesizes( file_storage const& t , fs::path p , std::vector > const& sizes , bool compact_mode , std::string* error = 0); struct TORRENT_EXPORT file_allocation_failed: std::exception { file_allocation_failed(const char* error_msg): m_msg(error_msg) {} virtual const char* what() const throw() { return m_msg.c_str(); } virtual ~file_allocation_failed() throw() {} std::string m_msg; }; struct TORRENT_EXPORT partial_hash { partial_hash(): offset(0) {} // the number of bytes in the piece that has been hashed int offset; // the sha-1 context hasher h; }; struct TORRENT_EXPORT storage_interface { storage_interface(): m_disk_pool(0), m_settings(0) {} // create directories and set file sizes // if allocate_files is true. // allocate_files is true if allocation mode // is set to full and sparse files are supported // false return value indicates an error virtual bool initialize(bool allocate_files) = 0; virtual bool has_any_file() = 0; virtual int readv(file::iovec_t const* bufs, int slot, int offset, int num_bufs); virtual int writev(file::iovec_t const* bufs, int slot, int offset, int num_bufs); // negative return value indicates an error virtual int read(char* buf, int slot, int offset, int size) = 0; // negative return value indicates an error virtual int write(const char* buf, int slot, int offset, int size) = 0; virtual size_type physical_offset(int slot, int offset) = 0; // returns the end of the sparse region the slot 'start' // resides in i.e. the next slot with content. If start // is not in a sparse region, start itself is returned virtual int sparse_end(int start) const { return start; } // non-zero return value indicates an error virtual bool move_storage(fs::path save_path) = 0; // verify storage dependent fast resume entries virtual bool verify_resume_data(lazy_entry const& rd, error_code& error) = 0; // write storage dependent fast resume entries virtual bool write_resume_data(entry& rd) const = 0; // moves (or copies) the content in src_slot to dst_slot virtual bool move_slot(int src_slot, int dst_slot) = 0; // swaps the data in slot1 and slot2 virtual bool swap_slots(int slot1, int slot2) = 0; // swaps the puts the data in slot1 in slot2, the data in slot2 // in slot3 and the data in slot3 in slot1 virtual bool swap_slots3(int slot1, int slot2, int slot3) = 0; // this will close all open files that are opened for // writing. This is called when a torrent has finished // downloading. // non-zero return value indicates an error virtual bool release_files() = 0; // this will rename the file specified by index. virtual bool rename_file(int index, std::string const& new_filename) = 0; // this will close all open files and delete them // non-zero return value indicates an error virtual bool delete_files() = 0; disk_buffer_pool* disk_pool() { return m_disk_pool; } session_settings const& settings() const { return *m_settings; } void set_error(boost::filesystem::path const& file, error_code const& ec) const { m_error_file = file.string(); m_error = ec; } error_code const& error() const { return m_error; } std::string const& error_file() const { return m_error_file; } void clear_error() { m_error = error_code(); m_error_file.clear(); } mutable error_code m_error; mutable std::string m_error_file; virtual ~storage_interface() {} disk_buffer_pool* m_disk_pool; session_settings* m_settings; }; typedef storage_interface* (*storage_constructor_type)( file_storage const&, file_storage const*, fs::path const&, file_pool&); TORRENT_EXPORT storage_interface* default_storage_constructor( file_storage const&, file_storage const* mapped, fs::path const&, file_pool&); TORRENT_EXPORT storage_interface* disabled_storage_constructor( file_storage const&, file_storage const* mapped, fs::path const&, file_pool&); struct disk_io_thread; class TORRENT_EXPORT piece_manager : public intrusive_ptr_base , boost::noncopyable { friend class invariant_access; friend struct disk_io_thread; public: piece_manager( boost::shared_ptr const& torrent , boost::intrusive_ptr info , fs::path const& path , file_pool& fp , disk_io_thread& io , storage_constructor_type sc , storage_mode_t sm); ~piece_manager(); boost::intrusive_ptr info() const { return m_info; } void write_resume_data(entry& rd) const; void async_check_fastresume(lazy_entry const* resume_data , boost::function const& handler); void async_check_files(boost::function const& handler); int queued_bytes() const; void async_rename_file(int index, std::string const& name , boost::function const& handler); void async_read( peer_request const& r , boost::function const& handler , int priority = 0); void async_read_and_hash( peer_request const& r , boost::function const& handler , int priority = 0); void async_write( peer_request const& r , disk_buffer_holder& buffer , boost::function const& f); void async_hash(int piece, boost::function const& f); void async_release_files( boost::function const& handler = boost::function()); void abort_disk_io(); void async_clear_read_cache( boost::function const& handler = boost::function()); void async_delete_files( boost::function const& handler = boost::function()); void async_move_storage(fs::path const& p , boost::function const& handler); void async_save_resume_data( boost::function const& handler); enum return_t { // return values from check_fastresume and check_files no_error = 0, need_full_check = -1, fatal_disk_error = -2, disk_check_aborted = -3 }; storage_interface* get_storage_impl() { return m_storage.get(); } private: fs::path save_path() const; bool verify_resume_data(lazy_entry const& rd, error_code& error) { return m_storage->verify_resume_data(rd, error); } bool is_allocating() const { return m_state == state_expand_pieces; } void mark_failed(int index); error_code const& error() const { return m_storage->error(); } std::string const& error_file() const { return m_storage->error_file(); } int last_piece() const { return m_last_piece; } int last_operation() const { return m_last_op; } void clear_error() { m_storage->clear_error(); } int slot_for(int piece) const; int piece_for(int slot) const; // helper functions for check_dastresume int check_no_fastresume(error_code& error); int check_init_storage(error_code& error); // if error is set and return value is 'no_error' or 'need_full_check' // the error message indicates that the fast resume data was rejected // if 'fatal_disk_error' is returned, the error message indicates what // when wrong in the disk access int check_fastresume(lazy_entry const& rd, error_code& error); // this function returns true if the checking is complete int check_files(int& current_slot, int& have_piece, error_code& error); bool compact_allocation() const { return m_storage_mode == storage_mode_compact; } #ifdef TORRENT_DEBUG std::string name() const { return m_info->name(); } #endif bool allocate_slots(int num_slots, bool abort_on_disk = false); // updates the ph.h hasher object with the data at the given slot // and optionally a 'small hash' as well, the hash for // the partial slot. Returns the number of bytes read int hash_for_slot(int slot, partial_hash& h, int piece_size , int small_piece_size = 0, sha1_hash* small_hash = 0); int read_impl( file::iovec_t* bufs , int piece_index , int offset , int num_bufs); int write_impl( file::iovec_t* bufs , int piece_index , int offset , int num_bufs); size_type physical_offset(int piece_index, int offset); // returns the number of pieces left in the // file currently being checked int skip_file() const; // -1=error 0=ok >0=skip this many pieces int check_one_piece(int& have_piece); int identify_data( sha1_hash const& large_hash , sha1_hash const& small_hash , int current_slot); void switch_to_full_mode(); sha1_hash hash_for_piece_impl(int piece); int release_files_impl() { return m_storage->release_files(); } int delete_files_impl() { return m_storage->delete_files(); } int rename_file_impl(int index, std::string const& new_filename) { return m_storage->rename_file(index, new_filename); } int move_storage_impl(fs::path const& save_path); int allocate_slot_for_piece(int piece_index); #ifdef TORRENT_DEBUG void check_invariant() const; #ifdef TORRENT_STORAGE_DEBUG void debug_log() const; #endif #endif boost::intrusive_ptr m_info; file_storage const& m_files; boost::scoped_ptr m_storage; storage_mode_t m_storage_mode; // slots that haven't had any file storage allocated std::vector m_unallocated_slots; // slots that have file storage, but isn't assigned to a piece std::vector m_free_slots; enum { has_no_slot = -3 // the piece has no storage }; // maps piece indices to slots. If a piece doesn't // have any storage, it is set to 'has_no_slot' std::vector m_piece_to_slot; enum { unallocated = -1, // the slot is unallocated unassigned = -2 // the slot is allocated but not assigned to a piece }; // maps slots to piece indices, if a slot doesn't have a piece // it can either be 'unassigned' or 'unallocated' std::vector m_slot_to_piece; fs::path m_save_path; mutable boost::recursive_mutex m_mutex; enum { // the default initial state state_none, // the file checking is complete state_finished, // checking the files state_full_check, // move pieces to their final position state_expand_pieces } m_state; int m_current_slot; // used during check. If any piece is found // that is not in its final position, this // is set to true bool m_out_of_place; // used to move pieces while expanding // the storage from compact allocation // to full allocation disk_buffer_holder m_scratch_buffer; disk_buffer_holder m_scratch_buffer2; // the piece that is in the scratch buffer int m_scratch_piece; // the last piece we wrote to or read from int m_last_piece; // the last operation we did (read or write) int m_last_op; // this is saved in case we need to instantiate a new // storage (osed when remapping files) storage_constructor_type m_storage_constructor; // this maps a piece hash to piece index. It will be // build the first time it is used (to save time if it // isn't needed) std::multimap m_hash_to_piece; // this map contains partial hashes for downloading // pieces. This is only accessed from within the // disk-io thread. std::map m_piece_hasher; disk_io_thread& m_io_thread; // the reason for this to be a void pointer // is to avoid creating a dependency on the // torrent. This shared_ptr is here only // to keep the torrent object alive until // the piece_manager destructs. This is because // the torrent_info object is owned by the torrent. boost::shared_ptr m_torrent; }; } #endif // TORRENT_STORAGE_HPP_INCLUDED