Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 5 | #ifndef SHILL_LINK_MONITOR_H_ |
| 6 | #define SHILL_LINK_MONITOR_H_ |
| 7 | |
| 8 | #include <time.h> |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 9 | |
| 10 | #include <base/callback.h> |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 11 | #include <base/cancelable_callback.h> |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 12 | #include <base/memory/scoped_ptr.h> |
| 13 | |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 14 | #include "shill/byte_string.h" |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 15 | #include "shill/refptr_types.h" |
| 16 | |
| 17 | namespace shill { |
| 18 | |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 19 | class ArpClient; |
| 20 | class DeviceInfo; |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 21 | class EventDispatcher; |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 22 | class IOHandler; |
Paul Stewart | ff845fc | 2012-08-07 07:28:44 -0700 | [diff] [blame] | 23 | class Metrics; |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 24 | class Time; |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 25 | |
| 26 | // LinkMonitor tracks the status of a connection by sending ARP |
| 27 | // messages to the default gateway for a connection. It keeps |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 28 | // track of response times which can be an indicator of link |
| 29 | // quality. It signals to caller that the link has failed if |
| 30 | // too many requests go unanswered. |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 31 | class LinkMonitor { |
| 32 | public: |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 33 | typedef base::Closure FailureCallback; |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 34 | |
Paul Stewart | 0443aa5 | 2012-08-09 10:43:50 -0700 | [diff] [blame] | 35 | // When the sum of consecutive unicast and broadcast failures |
| 36 | // equals this value, the failure callback is called, the counters |
| 37 | // are reset, and the link monitoring quiesces. Needed by Metrics. |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 38 | static const int kFailureThreshold; |
Paul Stewart | 0443aa5 | 2012-08-09 10:43:50 -0700 | [diff] [blame] | 39 | |
Paul Stewart | ff845fc | 2012-08-07 07:28:44 -0700 | [diff] [blame] | 40 | // The number of milliseconds between ARP requests. Needed by Metrics. |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 41 | static const int kTestPeriodMilliseconds; |
Paul Stewart | ff845fc | 2012-08-07 07:28:44 -0700 | [diff] [blame] | 42 | |
Paul Stewart | 036dba0 | 2012-08-07 12:34:41 -0700 | [diff] [blame] | 43 | // The default list of technologies for which link monitoring is enabled. |
| 44 | static const char kDefaultLinkMonitorTechnologies[]; |
| 45 | |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 46 | LinkMonitor(const ConnectionRefPtr &connection, |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 47 | EventDispatcher *dispatcher, // Owned by caller; can't be NULL. |
| 48 | Metrics *metrics, // Owned by caller; must not be NULL. |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 49 | DeviceInfo *device_info, |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 50 | const FailureCallback &failure_callback); |
| 51 | virtual ~LinkMonitor(); |
| 52 | |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 53 | // Starts link-monitoring on the selected connection. Returns |
| 54 | // true if successful, false otherwise. |
| 55 | virtual bool Start(); |
| 56 | virtual void Stop(); |
| 57 | |
| 58 | // Return modified cumulative average of the gateway ARP response |
| 59 | // time. Returns zero if no samples are available. For each |
| 60 | // missed ARP response, the sample is assumed to be the full |
| 61 | // test period. |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 62 | virtual int GetResponseTimeMilliseconds() const; |
Paul Stewart | 9f7823e | 2012-08-09 10:58:26 -0700 | [diff] [blame] | 63 | |
| 64 | // Returns true if the LinkMonitor was ever able to find the default |
| 65 | // gateway via broadcast ARP. |
| 66 | virtual bool IsGatewayFound() const; |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 67 | |
| 68 | private: |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 69 | friend class LinkMonitorForTest; |
| 70 | friend class LinkMonitorTest; |
| 71 | |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 72 | // The number of samples to compute a "strict" average over. When |
| 73 | // more samples than this number arrive, this determines how "slow" |
| 74 | // our simple low-pass filter works. |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 75 | static const int kMaxResponseSampleFilterDepth; |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 76 | |
| 77 | // Add a response time sample to the buffer. |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 78 | void AddResponseTimeSample(int response_time_milliseconds); |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 79 | // Create an ArpClient instance so we can receive and transmit ARP |
| 80 | // packets. This method is virtual so it can be overridden in |
| 81 | // unit tests. |
| 82 | virtual bool CreateClient(); |
| 83 | // Convert a hardware address byte-string to a colon-separated string. |
| 84 | static std::string HardwareAddressToString(const ByteString &address); |
| 85 | // Denote a missed response. Returns true if this loss has caused us |
| 86 | // to exceed the failure threshold. |
| 87 | bool AddMissedResponse(); |
| 88 | // This I/O callback is triggered whenever the ARP reception socket |
| 89 | // has data available to be received. |
| 90 | void ReceiveResponse(int fd); |
| 91 | // Send the next ARP request. Returns true if successful, false |
| 92 | // otherwise. |
| 93 | bool SendRequest(); |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 94 | |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 95 | // The connection on which to perform link monitoring. |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 96 | ConnectionRefPtr connection_; |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 97 | // Dispatcher on which to create delayed tasks. |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 98 | EventDispatcher *dispatcher_; |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 99 | // Metrics instance on which to post performance results. |
Paul Stewart | ff845fc | 2012-08-07 07:28:44 -0700 | [diff] [blame] | 100 | Metrics *metrics_; |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 101 | // DeviceInfo instance for retrieving the MAC address of a device. |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 102 | DeviceInfo *device_info_; |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 103 | // Failure callback method to call if LinkMonitor fails. |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 104 | FailureCallback failure_callback_; |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 105 | // The MAC address of device associated with this connection. |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 106 | ByteString local_mac_address_; |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 107 | // The MAC address of the default gateway. |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 108 | ByteString gateway_mac_address_; |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 109 | // ArpClient instance used for performing link tests. |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 110 | scoped_ptr<ArpClient> arp_client_; |
| 111 | |
| 112 | // The number of consecutive times we have failed in receiving |
| 113 | // responses to broadcast ARP requests. |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 114 | int broadcast_failure_count_; |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 115 | // The number of consecutive times we have failed in receiving |
| 116 | // responses to unicast ARP requests. |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 117 | int unicast_failure_count_; |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 118 | |
| 119 | // Whether this iteration of the test was a unicast request |
| 120 | // to the gateway instead of broadcast. The link monitor |
| 121 | // alternates between unicast and broadcast requests so that |
| 122 | // both types of network traffic is monitored. |
| 123 | bool is_unicast_; |
| 124 | |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 125 | // Number of response samples received in our rolling averge. |
| 126 | int response_sample_count_; |
| 127 | // The sum of response samples in our rolling average. |
| 128 | int response_sample_bucket_; |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 129 | |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 130 | // IOCallback that fires when the socket associated with our ArpClient |
| 131 | // has a packet to be received. Calls ReceiveResponse(). |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 132 | scoped_ptr<IOHandler> receive_response_handler_; |
| 133 | // Callback method used for periodic transmission of ARP requests. |
| 134 | // When the timer expires this will call SendRequest() through the |
| 135 | // void callback function SendRequestTask(). |
| 136 | base::CancelableClosure send_request_callback_; |
| 137 | |
Paul Stewart | 0443aa5 | 2012-08-09 10:43:50 -0700 | [diff] [blame] | 138 | // The time at which the link monitor started. |
| 139 | struct timeval started_monitoring_at_; |
| 140 | |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 141 | // The time at which the last ARP request was sent. |
| 142 | struct timeval sent_request_at_; |
Paul Stewart | f1961f8 | 2012-09-11 20:45:39 -0700 | [diff] [blame] | 143 | // Time instance for performing GetTimeMonotonic(). |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 144 | Time *time_; |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 145 | |
| 146 | DISALLOW_COPY_AND_ASSIGN(LinkMonitor); |
| 147 | }; |
| 148 | |
| 149 | } // namespace shill |
| 150 | |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 151 | #endif // SHILL_LINK_MONITOR_H_ |