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 | ff845fc | 2012-08-07 07:28:44 -0700 | [diff] [blame^] | 35 | // The number of milliseconds between ARP requests. Needed by Metrics. |
| 36 | static const unsigned int kTestPeriodMilliseconds; |
| 37 | |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 38 | LinkMonitor(const ConnectionRefPtr &connection, |
| 39 | EventDispatcher *dispatcher, |
Paul Stewart | ff845fc | 2012-08-07 07:28:44 -0700 | [diff] [blame^] | 40 | Metrics *metrics, |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 41 | DeviceInfo *device_info, |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 42 | const FailureCallback &failure_callback); |
| 43 | virtual ~LinkMonitor(); |
| 44 | |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 45 | // Starts link-monitoring on the selected connection. Returns |
| 46 | // true if successful, false otherwise. |
| 47 | virtual bool Start(); |
| 48 | virtual void Stop(); |
| 49 | |
| 50 | // Return modified cumulative average of the gateway ARP response |
| 51 | // time. Returns zero if no samples are available. For each |
| 52 | // missed ARP response, the sample is assumed to be the full |
| 53 | // test period. |
| 54 | virtual unsigned int GetResponseTimeMilliseconds(); |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 55 | |
| 56 | private: |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 57 | friend class LinkMonitorForTest; |
| 58 | friend class LinkMonitorTest; |
| 59 | |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 60 | // When the sum of consecutive unicast and broadcast failures |
| 61 | // equals this value, the failure callback is called, the counters |
| 62 | // are reset, and the link monitoring quiesces. |
| 63 | static const unsigned int kFailureThreshold; |
| 64 | |
| 65 | // The number of samples to compute a "strict" average over. When |
| 66 | // more samples than this number arrive, this determines how "slow" |
| 67 | // our simple low-pass filter works. |
| 68 | static const unsigned int kMaxResponseSampleFilterDepth; |
| 69 | |
| 70 | // Add a response time sample to the buffer. |
| 71 | void AddResponseTimeSample(unsigned int response_time_milliseconds); |
| 72 | // Create an ArpClient instance so we can receive and transmit ARP |
| 73 | // packets. This method is virtual so it can be overridden in |
| 74 | // unit tests. |
| 75 | virtual bool CreateClient(); |
| 76 | // Convert a hardware address byte-string to a colon-separated string. |
| 77 | static std::string HardwareAddressToString(const ByteString &address); |
| 78 | // Denote a missed response. Returns true if this loss has caused us |
| 79 | // to exceed the failure threshold. |
| 80 | bool AddMissedResponse(); |
| 81 | // This I/O callback is triggered whenever the ARP reception socket |
| 82 | // has data available to be received. |
| 83 | void ReceiveResponse(int fd); |
| 84 | // Send the next ARP request. Returns true if successful, false |
| 85 | // otherwise. |
| 86 | bool SendRequest(); |
| 87 | // Timer callback which calls SendRequest(). |
| 88 | void SendRequestTask(); |
| 89 | |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 90 | ConnectionRefPtr connection_; |
| 91 | EventDispatcher *dispatcher_; |
Paul Stewart | ff845fc | 2012-08-07 07:28:44 -0700 | [diff] [blame^] | 92 | Metrics *metrics_; |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 93 | DeviceInfo *device_info_; |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 94 | FailureCallback failure_callback_; |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 95 | ByteString local_mac_address_; |
| 96 | ByteString gateway_mac_address_; |
| 97 | scoped_ptr<ArpClient> arp_client_; |
| 98 | |
| 99 | // The number of consecutive times we have failed in receiving |
| 100 | // responses to broadcast ARP requests. |
| 101 | unsigned int broadcast_failure_count_; |
| 102 | // The number of consecutive times we have failed in receiving |
| 103 | // responses to unicast ARP requests. |
| 104 | unsigned int unicast_failure_count_; |
| 105 | |
| 106 | // Whether this iteration of the test was a unicast request |
| 107 | // to the gateway instead of broadcast. The link monitor |
| 108 | // alternates between unicast and broadcast requests so that |
| 109 | // both types of network traffic is monitored. |
| 110 | bool is_unicast_; |
| 111 | |
| 112 | // Maintain a pseudo-average of response time. |
| 113 | unsigned int response_sample_count_; |
| 114 | unsigned int response_sample_bucket_; |
| 115 | |
| 116 | scoped_ptr<IOHandler> receive_response_handler_; |
| 117 | // Callback method used for periodic transmission of ARP requests. |
| 118 | // When the timer expires this will call SendRequest() through the |
| 119 | // void callback function SendRequestTask(). |
| 120 | base::CancelableClosure send_request_callback_; |
| 121 | |
| 122 | // The time at which the last ARP request was sent. |
| 123 | struct timeval sent_request_at_; |
| 124 | Time *time_; |
Paul Stewart | 3f43f43 | 2012-07-16 12:12:45 -0700 | [diff] [blame] | 125 | |
| 126 | DISALLOW_COPY_AND_ASSIGN(LinkMonitor); |
| 127 | }; |
| 128 | |
| 129 | } // namespace shill |
| 130 | |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 131 | #endif // SHILL_LINK_MONITOR_H_ |