Index: net/base/network_change_notifier_win.cc |
diff --git a/net/base/network_change_notifier_win.cc b/net/base/network_change_notifier_win.cc |
deleted file mode 100644 |
index 03cc4c0f43c5a36fc0da39ca91643a3187b2665b..0000000000000000000000000000000000000000 |
--- a/net/base/network_change_notifier_win.cc |
+++ /dev/null |
@@ -1,338 +0,0 @@ |
-// Copyright (c) 2012 The Chromium Authors. All rights reserved. |
-// Use of this source code is governed by a BSD-style license that can be |
-// found in the LICENSE file. |
- |
-#include "net/base/network_change_notifier_win.h" |
- |
-#include <iphlpapi.h> |
-#include <winsock2.h> |
- |
-#include "base/bind.h" |
-#include "base/logging.h" |
-#include "base/metrics/histogram.h" |
-#include "base/profiler/scoped_tracker.h" |
-#include "base/threading/thread.h" |
-#include "base/time/time.h" |
-#include "net/base/winsock_init.h" |
-#include "net/dns/dns_config_service.h" |
- |
-#pragma comment(lib, "iphlpapi.lib") |
- |
-namespace net { |
- |
-namespace { |
- |
-// Time between NotifyAddrChange retries, on failure. |
-const int kWatchForAddressChangeRetryIntervalMs = 500; |
- |
-} // namespace |
- |
-// Thread on which we can run DnsConfigService, which requires AssertIOAllowed |
-// to open registry keys and to handle FilePathWatcher updates. |
-class NetworkChangeNotifierWin::DnsConfigServiceThread : public base::Thread { |
- public: |
- DnsConfigServiceThread() : base::Thread("DnsConfigService") {} |
- |
- virtual ~DnsConfigServiceThread() { |
- Stop(); |
- } |
- |
- virtual void Init() override { |
- service_ = DnsConfigService::CreateSystemService(); |
- service_->WatchConfig(base::Bind(&NetworkChangeNotifier::SetDnsConfig)); |
- } |
- |
- virtual void CleanUp() override { |
- service_.reset(); |
- } |
- |
- private: |
- scoped_ptr<DnsConfigService> service_; |
- |
- DISALLOW_COPY_AND_ASSIGN(DnsConfigServiceThread); |
-}; |
- |
-NetworkChangeNotifierWin::NetworkChangeNotifierWin() |
- : NetworkChangeNotifier(NetworkChangeCalculatorParamsWin()), |
- is_watching_(false), |
- sequential_failures_(0), |
- weak_factory_(this), |
- dns_config_service_thread_(new DnsConfigServiceThread()), |
- last_computed_connection_type_(RecomputeCurrentConnectionType()), |
- last_announced_offline_( |
- last_computed_connection_type_ == CONNECTION_NONE) { |
- memset(&addr_overlapped_, 0, sizeof addr_overlapped_); |
- addr_overlapped_.hEvent = WSACreateEvent(); |
-} |
- |
-NetworkChangeNotifierWin::~NetworkChangeNotifierWin() { |
- if (is_watching_) { |
- CancelIPChangeNotify(&addr_overlapped_); |
- addr_watcher_.StopWatching(); |
- } |
- WSACloseEvent(addr_overlapped_.hEvent); |
-} |
- |
-// static |
-NetworkChangeNotifier::NetworkChangeCalculatorParams |
-NetworkChangeNotifierWin::NetworkChangeCalculatorParamsWin() { |
- NetworkChangeCalculatorParams params; |
- // Delay values arrived at by simple experimentation and adjusted so as to |
- // produce a single signal when switching between network connections. |
- params.ip_address_offline_delay_ = base::TimeDelta::FromMilliseconds(1500); |
- params.ip_address_online_delay_ = base::TimeDelta::FromMilliseconds(1500); |
- params.connection_type_offline_delay_ = |
- base::TimeDelta::FromMilliseconds(1500); |
- params.connection_type_online_delay_ = base::TimeDelta::FromMilliseconds(500); |
- return params; |
-} |
- |
-// This implementation does not return the actual connection type but merely |
-// determines if the user is "online" (in which case it returns |
-// CONNECTION_UNKNOWN) or "offline" (and then it returns CONNECTION_NONE). |
-// This is challenging since the only thing we can test with certainty is |
-// whether a *particular* host is reachable. |
-// |
-// While we can't conclusively determine when a user is "online", we can at |
-// least reliably recognize some of the situtations when they are clearly |
-// "offline". For example, if the user's laptop is not plugged into an ethernet |
-// network and is not connected to any wireless networks, it must be offline. |
-// |
-// There are a number of different ways to implement this on Windows, each with |
-// their pros and cons. Here is a comparison of various techniques considered: |
-// |
-// (1) Use InternetGetConnectedState (wininet.dll). This function is really easy |
-// to use (literally a one-liner), and runs quickly. The drawback is it adds a |
-// dependency on the wininet DLL. |
-// |
-// (2) Enumerate all of the network interfaces using GetAdaptersAddresses |
-// (iphlpapi.dll), and assume we are "online" if there is at least one interface |
-// that is connected, and that interface is not a loopback or tunnel. |
-// |
-// Safari on Windows has a fairly simple implementation that does this: |
-// http://trac.webkit.org/browser/trunk/WebCore/platform/network/win/NetworkStateNotifierWin.cpp. |
-// |
-// Mozilla similarly uses this approach: |
-// http://mxr.mozilla.org/mozilla1.9.2/source/netwerk/system/win32/nsNotifyAddrListener.cpp |
-// |
-// The biggest drawback to this approach is it is quite complicated. |
-// WebKit's implementation for example doesn't seem to test for ICS gateways |
-// (internet connection sharing), whereas Mozilla's implementation has extra |
-// code to guess that. |
-// |
-// (3) The method used in this file comes from google talk, and is similar to |
-// method (2). The main difference is it enumerates the winsock namespace |
-// providers rather than the actual adapters. |
-// |
-// I ran some benchmarks comparing the performance of each on my Windows 7 |
-// workstation. Here is what I found: |
-// * Approach (1) was pretty much zero-cost after the initial call. |
-// * Approach (2) took an average of 3.25 milliseconds to enumerate the |
-// adapters. |
-// * Approach (3) took an average of 0.8 ms to enumerate the providers. |
-// |
-// In terms of correctness, all three approaches were comparable for the simple |
-// experiments I ran... However none of them correctly returned "offline" when |
-// executing 'ipconfig /release'. |
-// |
-NetworkChangeNotifier::ConnectionType |
-NetworkChangeNotifierWin::RecomputeCurrentConnectionType() const { |
- DCHECK(CalledOnValidThread()); |
- |
- EnsureWinsockInit(); |
- |
- // The following code was adapted from: |
- // http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/net/notifier/base/win/async_network_alive_win32.cc?view=markup&pathrev=47343 |
- // The main difference is we only call WSALookupServiceNext once, whereas |
- // the earlier code would traverse the entire list and pass LUP_FLUSHPREVIOUS |
- // to skip past the large results. |
- |
- HANDLE ws_handle; |
- WSAQUERYSET query_set = {0}; |
- query_set.dwSize = sizeof(WSAQUERYSET); |
- query_set.dwNameSpace = NS_NLA; |
- // Initiate a client query to iterate through the |
- // currently connected networks. |
- if (0 != WSALookupServiceBegin(&query_set, LUP_RETURN_ALL, |
- &ws_handle)) { |
- LOG(ERROR) << "WSALookupServiceBegin failed with: " << WSAGetLastError(); |
- return NetworkChangeNotifier::CONNECTION_UNKNOWN; |
- } |
- |
- bool found_connection = false; |
- |
- // Retrieve the first available network. In this function, we only |
- // need to know whether or not there is network connection. |
- // Allocate 256 bytes for name, it should be enough for most cases. |
- // If the name is longer, it is OK as we will check the code returned and |
- // set correct network status. |
- char result_buffer[sizeof(WSAQUERYSET) + 256] = {0}; |
- DWORD length = sizeof(result_buffer); |
- reinterpret_cast<WSAQUERYSET*>(&result_buffer[0])->dwSize = |
- sizeof(WSAQUERYSET); |
- int result = WSALookupServiceNext( |
- ws_handle, |
- LUP_RETURN_NAME, |
- &length, |
- reinterpret_cast<WSAQUERYSET*>(&result_buffer[0])); |
- |
- if (result == 0) { |
- // Found a connection! |
- found_connection = true; |
- } else { |
- DCHECK_EQ(SOCKET_ERROR, result); |
- result = WSAGetLastError(); |
- |
- // Error code WSAEFAULT means there is a network connection but the |
- // result_buffer size is too small to contain the results. The |
- // variable "length" returned from WSALookupServiceNext is the minimum |
- // number of bytes required. We do not need to retrieve detail info, |
- // it is enough knowing there was a connection. |
- if (result == WSAEFAULT) { |
- found_connection = true; |
- } else if (result == WSA_E_NO_MORE || result == WSAENOMORE) { |
- // There was nothing to iterate over! |
- } else { |
- LOG(WARNING) << "WSALookupServiceNext() failed with:" << result; |
- } |
- } |
- |
- result = WSALookupServiceEnd(ws_handle); |
- LOG_IF(ERROR, result != 0) |
- << "WSALookupServiceEnd() failed with: " << result; |
- |
- // TODO(droger): Return something more detailed than CONNECTION_UNKNOWN. |
- return found_connection ? NetworkChangeNotifier::CONNECTION_UNKNOWN : |
- NetworkChangeNotifier::CONNECTION_NONE; |
-} |
- |
-NetworkChangeNotifier::ConnectionType |
-NetworkChangeNotifierWin::GetCurrentConnectionType() const { |
- // TODO(vadimt): Remove ScopedTracker below once crbug.com/422516 is fixed. |
- tracked_objects::ScopedTracker tracking_profile( |
- FROM_HERE_WITH_EXPLICIT_FUNCTION( |
- "422516 NetworkChangeNotifierWin::GetCurrentConnectionType")); |
- |
- base::AutoLock auto_lock(last_computed_connection_type_lock_); |
- return last_computed_connection_type_; |
-} |
- |
-void NetworkChangeNotifierWin::SetCurrentConnectionType( |
- ConnectionType connection_type) { |
- base::AutoLock auto_lock(last_computed_connection_type_lock_); |
- last_computed_connection_type_ = connection_type; |
-} |
- |
-void NetworkChangeNotifierWin::OnObjectSignaled(HANDLE object) { |
- // TODO(vadimt): Remove ScopedTracker below once crbug.com/418183 is fixed. |
- tracked_objects::ScopedTracker tracking_profile( |
- FROM_HERE_WITH_EXPLICIT_FUNCTION( |
- "418183 NetworkChangeNotifierWin::OnObjectSignaled")); |
- |
- DCHECK(CalledOnValidThread()); |
- DCHECK(is_watching_); |
- is_watching_ = false; |
- |
- // Start watching for the next address change. |
- WatchForAddressChange(); |
- |
- NotifyObservers(); |
-} |
- |
-void NetworkChangeNotifierWin::NotifyObservers() { |
- DCHECK(CalledOnValidThread()); |
- SetCurrentConnectionType(RecomputeCurrentConnectionType()); |
- NotifyObserversOfIPAddressChange(); |
- |
- // Calling GetConnectionType() at this very moment is likely to give |
- // the wrong result, so we delay that until a little bit later. |
- // |
- // The one second delay chosen here was determined experimentally |
- // by adamk on Windows 7. |
- // If after one second we determine we are still offline, we will |
- // delay again. |
- offline_polls_ = 0; |
- timer_.Start(FROM_HERE, base::TimeDelta::FromSeconds(1), this, |
- &NetworkChangeNotifierWin::NotifyParentOfConnectionTypeChange); |
-} |
- |
-void NetworkChangeNotifierWin::WatchForAddressChange() { |
- DCHECK(CalledOnValidThread()); |
- DCHECK(!is_watching_); |
- |
- // NotifyAddrChange occasionally fails with ERROR_OPEN_FAILED for unknown |
- // reasons. More rarely, it's also been observed failing with |
- // ERROR_NO_SYSTEM_RESOURCES. When either of these happens, we retry later. |
- if (!WatchForAddressChangeInternal()) { |
- ++sequential_failures_; |
- |
- // TODO(mmenke): If the UMA histograms indicate that this fixes |
- // http://crbug.com/69198, remove this histogram and consider reducing the |
- // retry interval. |
- if (sequential_failures_ == 2000) { |
- UMA_HISTOGRAM_COUNTS_10000("Net.NotifyAddrChangeFailures", |
- sequential_failures_); |
- } |
- |
- base::MessageLoop::current()->PostDelayedTask( |
- FROM_HERE, |
- base::Bind(&NetworkChangeNotifierWin::WatchForAddressChange, |
- weak_factory_.GetWeakPtr()), |
- base::TimeDelta::FromMilliseconds( |
- kWatchForAddressChangeRetryIntervalMs)); |
- return; |
- } |
- |
- // Treat the transition from NotifyAddrChange failing to succeeding as a |
- // network change event, since network changes were not being observed in |
- // that interval. |
- if (sequential_failures_ > 0) |
- NotifyObservers(); |
- |
- if (sequential_failures_ < 2000) { |
- UMA_HISTOGRAM_COUNTS_10000("Net.NotifyAddrChangeFailures", |
- sequential_failures_); |
- } |
- |
- is_watching_ = true; |
- sequential_failures_ = 0; |
-} |
- |
-bool NetworkChangeNotifierWin::WatchForAddressChangeInternal() { |
- DCHECK(CalledOnValidThread()); |
- |
- if (!dns_config_service_thread_->IsRunning()) { |
- dns_config_service_thread_->StartWithOptions( |
- base::Thread::Options(base::MessageLoop::TYPE_IO, 0)); |
- } |
- |
- HANDLE handle = NULL; |
- DWORD ret = NotifyAddrChange(&handle, &addr_overlapped_); |
- if (ret != ERROR_IO_PENDING) |
- return false; |
- |
- addr_watcher_.StartWatching(addr_overlapped_.hEvent, this); |
- return true; |
-} |
- |
-void NetworkChangeNotifierWin::NotifyParentOfConnectionTypeChange() { |
- SetCurrentConnectionType(RecomputeCurrentConnectionType()); |
- bool current_offline = IsOffline(); |
- offline_polls_++; |
- // If we continue to appear offline, delay sending out the notification in |
- // case we appear to go online within 20 seconds. UMA histogram data shows |
- // we may not detect the transition to online state after 1 second but within |
- // 20 seconds we generally do. |
- if (last_announced_offline_ && current_offline && offline_polls_ <= 20) { |
- timer_.Start(FROM_HERE, base::TimeDelta::FromSeconds(1), this, |
- &NetworkChangeNotifierWin::NotifyParentOfConnectionTypeChange); |
- return; |
- } |
- if (last_announced_offline_) |
- UMA_HISTOGRAM_CUSTOM_COUNTS("NCN.OfflinePolls", offline_polls_, 1, 50, 50); |
- last_announced_offline_ = current_offline; |
- |
- NotifyObserversOfConnectionTypeChange(); |
-} |
- |
-} // namespace net |