remove mutex in natpmp

This commit is contained in:
arvidn 2016-05-01 02:21:30 -04:00
parent accf13d93e
commit 60c119c52d
3 changed files with 75 additions and 77 deletions

View File

@ -101,7 +101,7 @@ namespace libtorrent
struct plugin; struct plugin;
struct upnp; struct upnp;
class natpmp; struct natpmp;
class lsd; class lsd;
class torrent; class torrent;
class alert; class alert;

View File

@ -39,8 +39,7 @@ POSSIBILITY OF SUCH DAMAGE.
#include "libtorrent/error_code.hpp" #include "libtorrent/error_code.hpp"
#include "libtorrent/deadline_timer.hpp" #include "libtorrent/deadline_timer.hpp"
#include "libtorrent/time.hpp" #include "libtorrent/time.hpp"
#include "libtorrent/debug.hpp"
#include <mutex>
#include "libtorrent/aux_/disable_warnings_push.hpp" #include "libtorrent/aux_/disable_warnings_push.hpp"
@ -59,9 +58,10 @@ namespace libtorrent
typedef boost::function<void(int, address, int, int, error_code const&)> portmap_callback_t; typedef boost::function<void(int, address, int, int, error_code const&)> portmap_callback_t;
typedef boost::function<void(char const*)> log_callback_t; typedef boost::function<void(char const*)> log_callback_t;
class natpmp : public boost::enable_shared_from_this<natpmp> struct natpmp
: boost::enable_shared_from_this<natpmp>
, single_threaded
{ {
public:
natpmp(io_service& ios, portmap_callback_t const& cb natpmp(io_service& ios, portmap_callback_t const& cb
, log_callback_t const& lcb); , log_callback_t const& lcb);
@ -80,19 +80,19 @@ private:
boost::shared_ptr<natpmp> self() { return shared_from_this(); } boost::shared_ptr<natpmp> self() { return shared_from_this(); }
void update_mapping(int i, std::unique_lock<std::mutex>& l); void update_mapping(int i);
void send_map_request(int i, std::unique_lock<std::mutex>& l); void send_map_request(int i);
void send_get_ip_address_request(std::unique_lock<std::mutex>& l); void send_get_ip_address_request();
void resend_request(int i, error_code const& e); void resend_request(int i, error_code const& e);
void on_reply(error_code const& e void on_reply(error_code const& e
, std::size_t bytes_transferred); , std::size_t bytes_transferred);
void try_next_mapping(int i, std::unique_lock<std::mutex>& l); void try_next_mapping(int i);
void update_expiration_timer(std::unique_lock<std::mutex>& l); void update_expiration_timer();
void mapping_expired(error_code const& e, int i); void mapping_expired(error_code const& e, int i);
void close_impl(std::unique_lock<std::mutex>& l); void close_impl();
void log(char const* msg, std::unique_lock<std::mutex>& l); void log(char const* msg);
void disable(error_code const& ec, std::unique_lock<std::mutex>& l); void disable(error_code const& ec);
struct mapping_t struct mapping_t
{ {
@ -173,9 +173,6 @@ private:
bool m_disabled; bool m_disabled;
bool m_abort; bool m_abort;
// TODO:3 is this object really acceessed from multiple threads?
mutable std::mutex m_mutex;
}; };
} }

View File

@ -79,11 +79,12 @@ natpmp::natpmp(io_service& ios
// for this array not to be reallocated, by passing // for this array not to be reallocated, by passing
// around pointers to its elements. so reserve size for now // around pointers to its elements. so reserve size for now
m_mappings.reserve(10); m_mappings.reserve(10);
TORRENT_ASSERT(is_single_thread());
} }
void natpmp::start() void natpmp::start()
{ {
std::unique_lock<std::mutex> l(m_mutex); TORRENT_ASSERT(is_single_thread());
error_code ec; error_code ec;
address gateway = get_default_gateway(m_socket.get_io_service(), ec); address gateway = get_default_gateway(m_socket.get_io_service(), ec);
@ -92,8 +93,8 @@ void natpmp::start()
char msg[200]; char msg[200];
snprintf(msg, sizeof(msg), "failed to find default route: %s" snprintf(msg, sizeof(msg), "failed to find default route: %s"
, convert_from_native(ec.message()).c_str()); , convert_from_native(ec.message()).c_str());
log(msg, l); log(msg);
disable(ec, l); disable(ec);
return; return;
} }
@ -106,25 +107,25 @@ void natpmp::start()
char msg[200]; char msg[200];
snprintf(msg, sizeof(msg), "found router at: %s" snprintf(msg, sizeof(msg), "found router at: %s"
, print_address(m_nat_endpoint.address()).c_str()); , print_address(m_nat_endpoint.address()).c_str());
log(msg, l); log(msg);
m_socket.open(udp::v4(), ec); m_socket.open(udp::v4(), ec);
if (ec) if (ec)
{ {
disable(ec, l); disable(ec);
return; return;
} }
m_socket.bind(udp::endpoint(address_v4::any(), 0), ec); m_socket.bind(udp::endpoint(address_v4::any(), 0), ec);
if (ec) if (ec)
{ {
disable(ec, l); disable(ec);
return; return;
} }
ADD_OUTSTANDING_ASYNC("natpmp::on_reply"); ADD_OUTSTANDING_ASYNC("natpmp::on_reply");
m_socket.async_receive_from(boost::asio::buffer(&m_response_buffer, 16) m_socket.async_receive_from(boost::asio::buffer(&m_response_buffer, 16)
, m_remote, boost::bind(&natpmp::on_reply, self(), _1, _2)); , m_remote, boost::bind(&natpmp::on_reply, self(), _1, _2));
send_get_ip_address_request(l); send_get_ip_address_request();
for (std::vector<mapping_t>::iterator i = m_mappings.begin() for (std::vector<mapping_t>::iterator i = m_mappings.begin()
, end(m_mappings.end()); i != end; ++i) , end(m_mappings.end()); i != end; ++i)
@ -133,19 +134,20 @@ void natpmp::start()
|| i->action != mapping_t::action_none) || i->action != mapping_t::action_none)
continue; continue;
i->action = mapping_t::action_add; i->action = mapping_t::action_add;
update_mapping(i - m_mappings.begin(), l); update_mapping(i - m_mappings.begin());
} }
} }
void natpmp::send_get_ip_address_request(std::unique_lock<std::mutex>& l) void natpmp::send_get_ip_address_request()
{ {
TORRENT_ASSERT(is_single_thread());
using namespace libtorrent::detail; using namespace libtorrent::detail;
char buf[2]; char buf[2];
char* out = buf; char* out = buf;
write_uint8(0, out); // NAT-PMP version write_uint8(0, out); // NAT-PMP version
write_uint8(0, out); // public IP address request opcode write_uint8(0, out); // public IP address request opcode
log("==> get public IP address", l); log("==> get public IP address");
error_code ec; error_code ec;
m_socket.send_to(boost::asio::buffer(buf, sizeof(buf)), m_nat_endpoint, 0, ec); m_socket.send_to(boost::asio::buffer(buf, sizeof(buf)), m_nat_endpoint, 0, ec);
@ -153,7 +155,7 @@ void natpmp::send_get_ip_address_request(std::unique_lock<std::mutex>& l)
bool natpmp::get_mapping(int index, int& local_port, int& external_port, int& protocol) const bool natpmp::get_mapping(int index, int& local_port, int& external_port, int& protocol) const
{ {
std::unique_lock<std::mutex> l(m_mutex); TORRENT_ASSERT(is_single_thread());
TORRENT_ASSERT(index < int(m_mappings.size()) && index >= 0); TORRENT_ASSERT(index < int(m_mappings.size()) && index >= 0);
if (index >= int(m_mappings.size()) || index < 0) return false; if (index >= int(m_mappings.size()) || index < 0) return false;
@ -165,15 +167,15 @@ bool natpmp::get_mapping(int index, int& local_port, int& external_port, int& pr
return true; return true;
} }
void natpmp::log(char const* msg, std::unique_lock<std::mutex>& l) void natpmp::log(char const* msg)
{ {
l.unlock(); TORRENT_ASSERT(is_single_thread());
m_log_callback(msg); m_log_callback(msg);
l.lock();
} }
void natpmp::disable(error_code const& ec, std::unique_lock<std::mutex>& l) void natpmp::disable(error_code const& ec)
{ {
TORRENT_ASSERT(is_single_thread());
m_disabled = true; m_disabled = true;
for (std::vector<mapping_t>::iterator i = m_mappings.begin() for (std::vector<mapping_t>::iterator i = m_mappings.begin()
@ -183,16 +185,14 @@ void natpmp::disable(error_code const& ec, std::unique_lock<std::mutex>& l)
int const proto = i->protocol; int const proto = i->protocol;
i->protocol = none; i->protocol = none;
int index = i - m_mappings.begin(); int index = i - m_mappings.begin();
l.unlock();
m_callback(index, address(), 0, proto, ec); m_callback(index, address(), 0, proto, ec);
l.lock();
} }
close_impl(l); close_impl();
} }
void natpmp::delete_mapping(int index) void natpmp::delete_mapping(int index)
{ {
std::unique_lock<std::mutex> l(m_mutex); TORRENT_ASSERT(is_single_thread());
TORRENT_ASSERT(index < int(m_mappings.size()) && index >= 0); TORRENT_ASSERT(index < int(m_mappings.size()) && index >= 0);
if (index >= int(m_mappings.size()) || index < 0) return; if (index >= int(m_mappings.size()) || index < 0) return;
@ -207,12 +207,12 @@ void natpmp::delete_mapping(int index)
} }
m.action = mapping_t::action_delete; m.action = mapping_t::action_delete;
update_mapping(index, l); update_mapping(index);
} }
int natpmp::add_mapping(protocol_type p, int external_port, int local_port) int natpmp::add_mapping(protocol_type p, int external_port, int local_port)
{ {
std::unique_lock<std::mutex> l(m_mutex); TORRENT_ASSERT(is_single_thread());
if (m_disabled) return -1; if (m_disabled) return -1;
@ -245,12 +245,13 @@ int natpmp::add_mapping(protocol_type p, int external_port, int local_port)
} }
#endif #endif
update_mapping(mapping_index, l); update_mapping(mapping_index);
return mapping_index; return mapping_index;
} }
void natpmp::try_next_mapping(int i, std::unique_lock<std::mutex>& l) void natpmp::try_next_mapping(int i)
{ {
TORRENT_ASSERT(is_single_thread());
#ifdef NATPMP_LOG #ifdef NATPMP_LOG
time_point now = aux::time_now(); time_point now = aux::time_now();
for (std::vector<mapping_t>::iterator m = m_mappings.begin() for (std::vector<mapping_t>::iterator m = m_mappings.begin()
@ -267,7 +268,7 @@ void natpmp::try_next_mapping(int i, std::unique_lock<std::mutex>& l)
#endif #endif
if (i < int(m_mappings.size()) - 1) if (i < int(m_mappings.size()) - 1)
{ {
update_mapping(i + 1, l); update_mapping(i + 1);
return; return;
} }
@ -293,11 +294,12 @@ void natpmp::try_next_mapping(int i, std::unique_lock<std::mutex>& l)
std::cout << " updating " << (m - m_mappings.begin()) << std::endl; std::cout << " updating " << (m - m_mappings.begin()) << std::endl;
#endif #endif
update_mapping(m - m_mappings.begin(), l); update_mapping(m - m_mappings.begin());
} }
void natpmp::update_mapping(int i, std::unique_lock<std::mutex>& l) void natpmp::update_mapping(int i)
{ {
TORRENT_ASSERT(is_single_thread());
if (i == int(m_mappings.size())) if (i == int(m_mappings.size()))
{ {
if (m_abort) if (m_abort)
@ -316,7 +318,7 @@ void natpmp::update_mapping(int i, std::unique_lock<std::mutex>& l)
if (m.action == mapping_t::action_none if (m.action == mapping_t::action_none
|| m.protocol == none) || m.protocol == none)
{ {
try_next_mapping(i, l); try_next_mapping(i);
return; return;
} }
@ -325,12 +327,13 @@ void natpmp::update_mapping(int i, std::unique_lock<std::mutex>& l)
// the socket is not currently in use // the socket is not currently in use
// send out a mapping request // send out a mapping request
m_retry_count = 0; m_retry_count = 0;
send_map_request(i, l); send_map_request(i);
} }
} }
void natpmp::send_map_request(int i, std::unique_lock<std::mutex>& l) void natpmp::send_map_request(int i)
{ {
TORRENT_ASSERT(is_single_thread());
using namespace libtorrent::detail; using namespace libtorrent::detail;
TORRENT_ASSERT(m_currently_mapping == -1 TORRENT_ASSERT(m_currently_mapping == -1
@ -354,7 +357,7 @@ void natpmp::send_map_request(int i, std::unique_lock<std::mutex>& l)
, i, m.action == mapping_t::action_add ? "add" : "delete" , i, m.action == mapping_t::action_add ? "add" : "delete"
, m.protocol == udp ? "udp" : "tcp" , m.protocol == udp ? "udp" : "tcp"
, m.local_port, m.external_port, ttl); , m.local_port, m.external_port, ttl);
log(msg, l); log(msg);
error_code ec; error_code ec;
m_socket.send_to(boost::asio::buffer(buf, sizeof(buf)), m_nat_endpoint, 0, ec); m_socket.send_to(boost::asio::buffer(buf, sizeof(buf)), m_nat_endpoint, 0, ec);
@ -367,7 +370,7 @@ void natpmp::send_map_request(int i, std::unique_lock<std::mutex>& l)
// immediately // immediately
m_currently_mapping = -1; m_currently_mapping = -1;
m.action = mapping_t::action_none; m.action = mapping_t::action_none;
try_next_mapping(i, l); try_next_mapping(i);
} }
else else
{ {
@ -381,9 +384,9 @@ void natpmp::send_map_request(int i, std::unique_lock<std::mutex>& l)
void natpmp::resend_request(int i, error_code const& e) void natpmp::resend_request(int i, error_code const& e)
{ {
TORRENT_ASSERT(is_single_thread());
COMPLETE_ASYNC("natpmp::resend_request"); COMPLETE_ASYNC("natpmp::resend_request");
if (e) return; if (e) return;
std::unique_lock<std::mutex> l(m_mutex);
if (m_currently_mapping != i) return; if (m_currently_mapping != i) return;
// if we're shutting down, don't retry, just move on // if we're shutting down, don't retry, just move on
@ -394,16 +397,16 @@ void natpmp::resend_request(int i, error_code const& e)
m_mappings[i].action = mapping_t::action_none; m_mappings[i].action = mapping_t::action_none;
// try again in two hours // try again in two hours
m_mappings[i].expires = aux::time_now() + hours(2); m_mappings[i].expires = aux::time_now() + hours(2);
try_next_mapping(i, l); try_next_mapping(i);
return; return;
} }
send_map_request(i, l); send_map_request(i);
} }
void natpmp::on_reply(error_code const& e void natpmp::on_reply(error_code const& e
, std::size_t bytes_transferred) , std::size_t bytes_transferred)
{ {
std::unique_lock<std::mutex> l(m_mutex); TORRENT_ASSERT(is_single_thread());
COMPLETE_ASYNC("natpmp::on_reply"); COMPLETE_ASYNC("natpmp::on_reply");
@ -413,7 +416,7 @@ void natpmp::on_reply(error_code const& e
char msg[200]; char msg[200];
snprintf(msg, sizeof(msg), "error on receiving reply: %s" snprintf(msg, sizeof(msg), "error on receiving reply: %s"
, convert_from_native(e.message()).c_str()); , convert_from_native(e.message()).c_str());
log(msg, l); log(msg);
return; return;
} }
@ -430,7 +433,7 @@ void natpmp::on_reply(error_code const& e
/* /*
if ((random() % 2) == 0) if ((random() % 2) == 0)
{ {
log(" simulating drop", l); log(" simulating drop");
return; return;
} }
*/ */
@ -439,7 +442,7 @@ void natpmp::on_reply(error_code const& e
char msg[200]; char msg[200];
snprintf(msg, sizeof(msg), "received packet from wrong IP: %s" snprintf(msg, sizeof(msg), "received packet from wrong IP: %s"
, print_endpoint(m_remote).c_str()); , print_endpoint(m_remote).c_str());
log(msg, l); log(msg);
return; return;
} }
@ -450,7 +453,7 @@ void natpmp::on_reply(error_code const& e
{ {
char msg[200]; char msg[200];
snprintf(msg, sizeof(msg), "received packet of invalid size: %d", int(bytes_transferred)); snprintf(msg, sizeof(msg), "received packet of invalid size: %d", int(bytes_transferred));
log(msg, l); log(msg);
return; return;
} }
@ -467,7 +470,7 @@ void natpmp::on_reply(error_code const& e
char msg[200]; char msg[200];
snprintf(msg, sizeof(msg), "<== public IP address [ %s ]", print_address(m_external_ip).c_str()); snprintf(msg, sizeof(msg), "<== public IP address [ %s ]", print_address(m_external_ip).c_str());
log(msg, l); log(msg);
return; return;
} }
@ -476,7 +479,7 @@ void natpmp::on_reply(error_code const& e
{ {
char msg[200]; char msg[200];
snprintf(msg, sizeof(msg), "received packet of invalid size: %d", int(bytes_transferred)); snprintf(msg, sizeof(msg), "received packet of invalid size: %d", int(bytes_transferred));
log(msg, l); log(msg);
return; return;
} }
@ -498,7 +501,7 @@ void natpmp::on_reply(error_code const& e
{ {
snprintf(msg + num_chars, sizeof(msg) - num_chars, "unexpected version: %u" snprintf(msg + num_chars, sizeof(msg) - num_chars, "unexpected version: %u"
, version); , version);
log(msg, l); log(msg);
} }
mapping_t* m = 0; mapping_t* m = 0;
@ -518,12 +521,12 @@ void natpmp::on_reply(error_code const& e
if (m == 0) if (m == 0)
{ {
snprintf(msg + num_chars, sizeof(msg) - num_chars, " not found in map table"); snprintf(msg + num_chars, sizeof(msg) - num_chars, " not found in map table");
log(msg, l); log(msg);
return; return;
} }
m->outstanding_request = false; m->outstanding_request = false;
log(msg, l); log(msg);
if (public_port == 0 || lifetime == 0) if (public_port == 0 || lifetime == 0)
{ {
@ -552,18 +555,14 @@ void natpmp::on_reply(error_code const& e
m->expires = aux::time_now() + hours(2); m->expires = aux::time_now() + hours(2);
int const proto = m->protocol; int const proto = m->protocol;
l.unlock();
m_callback(index, address(), 0, proto m_callback(index, address(), 0, proto
, error_code(ev, get_libtorrent_category())); , error_code(ev, get_libtorrent_category()));
l.lock();
} }
else if (m->action == mapping_t::action_add) else if (m->action == mapping_t::action_add)
{ {
int const proto = m->protocol; int const proto = m->protocol;
l.unlock();
m_callback(index, m_external_ip, m->external_port, proto m_callback(index, m_external_ip, m->external_port, proto
, error_code(errors::no_error, get_libtorrent_category())); , error_code(errors::no_error, get_libtorrent_category()));
l.lock();
} }
if (m_abort) return; if (m_abort) return;
@ -571,12 +570,13 @@ void natpmp::on_reply(error_code const& e
m_currently_mapping = -1; m_currently_mapping = -1;
m->action = mapping_t::action_none; m->action = mapping_t::action_none;
m_send_timer.cancel(ec); m_send_timer.cancel(ec);
update_expiration_timer(l); update_expiration_timer();
try_next_mapping(index, l); try_next_mapping(index);
} }
void natpmp::update_expiration_timer(std::unique_lock<std::mutex>& l) void natpmp::update_expiration_timer()
{ {
TORRENT_ASSERT(is_single_thread());
if (m_abort) return; if (m_abort) return;
time_point now = aux::time_now() + milliseconds(100); time_point now = aux::time_now() + milliseconds(100);
@ -606,10 +606,10 @@ void natpmp::update_expiration_timer(std::unique_lock<std::mutex>& l)
{ {
char msg[200]; char msg[200];
snprintf(msg, sizeof(msg), "mapping %u expired", index); snprintf(msg, sizeof(msg), "mapping %u expired", index);
log(msg, l); log(msg);
i->action = mapping_t::action_add; i->action = mapping_t::action_add;
if (m_next_refresh == index) m_next_refresh = -1; if (m_next_refresh == index) m_next_refresh = -1;
update_mapping(index, l); update_mapping(index);
} }
else if (i->expires < min_expire) else if (i->expires < min_expire)
{ {
@ -641,27 +641,28 @@ void natpmp::update_expiration_timer(std::unique_lock<std::mutex>& l)
void natpmp::mapping_expired(error_code const& e, int i) void natpmp::mapping_expired(error_code const& e, int i)
{ {
TORRENT_ASSERT(is_single_thread());
COMPLETE_ASYNC("natpmp::mapping_expired"); COMPLETE_ASYNC("natpmp::mapping_expired");
if (e) return; if (e) return;
std::unique_lock<std::mutex> l(m_mutex);
char msg[200]; char msg[200];
snprintf(msg, sizeof(msg), "mapping %u expired", i); snprintf(msg, sizeof(msg), "mapping %u expired", i);
log(msg, l); log(msg);
m_mappings[i].action = mapping_t::action_add; m_mappings[i].action = mapping_t::action_add;
if (m_next_refresh == i) m_next_refresh = -1; if (m_next_refresh == i) m_next_refresh = -1;
update_mapping(i, l); update_mapping(i);
} }
void natpmp::close() void natpmp::close()
{ {
std::unique_lock<std::mutex> l(m_mutex); TORRENT_ASSERT(is_single_thread());
close_impl(l); close_impl();
} }
void natpmp::close_impl(std::unique_lock<std::mutex>& l) void natpmp::close_impl()
{ {
TORRENT_ASSERT(is_single_thread());
m_abort = true; m_abort = true;
log("closing", l); log("closing");
#ifdef NATPMP_LOG #ifdef NATPMP_LOG
std::cout << time_now_string() << " close" << std::endl; std::cout << time_now_string() << " close" << std::endl;
time_point now = aux::time_now(); time_point now = aux::time_now();
@ -685,6 +686,6 @@ void natpmp::close_impl(std::unique_lock<std::mutex>& l)
error_code ec; error_code ec;
m_refresh_timer.cancel(ec); m_refresh_timer.cancel(ec);
m_currently_mapping = -1; m_currently_mapping = -1;
update_mapping(0, l); update_mapping(0);
} }