Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef SHILL_METRICS_ |
| 6 | #define SHILL_METRICS_ |
| 7 | |
| 8 | #include <list> |
| 9 | |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 10 | #include <base/memory/scoped_vector.h> |
| 11 | #include <metrics/metrics_library.h> |
| 12 | #include <metrics/timer.h> |
| 13 | |
Thieu Le | 85e050b | 2012-03-13 15:04:38 -0700 | [diff] [blame] | 14 | #include "shill/portal_detector.h" |
Thieu Le | b84ba34 | 2012-03-02 15:15:19 -0800 | [diff] [blame] | 15 | #include "shill/power_manager.h" |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 16 | #include "shill/refptr_types.h" |
| 17 | #include "shill/service.h" |
| 18 | |
| 19 | namespace shill { |
| 20 | |
| 21 | class WiFiService; |
| 22 | |
| 23 | class Metrics { |
| 24 | public: |
| 25 | enum WiFiChannel { |
| 26 | kWiFiChannelUndef = 0, |
| 27 | kWiFiChannel2412 = 1, |
| 28 | kWiFiChannel2417 = 2, |
| 29 | kWiFiChannel2422 = 3, |
| 30 | kWiFiChannel2427 = 4, |
| 31 | kWiFiChannel2432 = 5, |
| 32 | kWiFiChannel2437 = 6, |
| 33 | kWiFiChannel2442 = 7, |
| 34 | kWiFiChannel2447 = 8, |
| 35 | kWiFiChannel2452 = 9, |
| 36 | kWiFiChannel2457 = 10, |
| 37 | kWiFiChannel2462 = 11, |
| 38 | kWiFiChannel2467 = 12, |
| 39 | kWiFiChannel2472 = 13, |
| 40 | kWiFiChannel2484 = 14, |
| 41 | |
| 42 | kWiFiChannel5180 = 15, |
| 43 | kWiFiChannel5200 = 16, |
| 44 | kWiFiChannel5220 = 17, |
| 45 | kWiFiChannel5240 = 18, |
| 46 | kWiFiChannel5260 = 19, |
| 47 | kWiFiChannel5280 = 20, |
| 48 | kWiFiChannel5300 = 21, |
| 49 | kWiFiChannel5320 = 22, |
| 50 | |
| 51 | kWiFiChannel5500 = 23, |
| 52 | kWiFiChannel5520 = 24, |
| 53 | kWiFiChannel5540 = 25, |
| 54 | kWiFiChannel5560 = 26, |
| 55 | kWiFiChannel5580 = 27, |
| 56 | kWiFiChannel5600 = 28, |
| 57 | kWiFiChannel5620 = 29, |
| 58 | kWiFiChannel5640 = 30, |
| 59 | kWiFiChannel5660 = 31, |
| 60 | kWiFiChannel5680 = 32, |
| 61 | kWiFiChannel5700 = 33, |
| 62 | |
| 63 | kWiFiChannel5745 = 34, |
| 64 | kWiFiChannel5765 = 35, |
| 65 | kWiFiChannel5785 = 36, |
| 66 | kWiFiChannel5805 = 37, |
| 67 | kWiFiChannel5825 = 38, |
| 68 | |
| 69 | kWiFiChannel5170 = 39, |
| 70 | kWiFiChannel5190 = 40, |
| 71 | kWiFiChannel5210 = 41, |
| 72 | kWiFiChannel5230 = 42, |
| 73 | |
| 74 | /* NB: ignore old 11b bands 2312..2372 and 2512..2532 */ |
| 75 | /* NB: ignore regulated bands 4920..4980 and 5020..5160 */ |
| 76 | kWiFiChannelMax |
| 77 | }; |
| 78 | |
Thieu Le | ad1ec2c | 2012-01-05 23:39:48 +0000 | [diff] [blame] | 79 | enum WiFiNetworkPhyMode { |
| 80 | kWiFiNetworkPhyModeUndef = 0, // Unknown/undefined |
| 81 | kWiFiNetworkPhyMode11a = 1, // 802.11a |
| 82 | kWiFiNetworkPhyMode11b = 2, // 802.11b |
| 83 | kWiFiNetworkPhyMode11g = 3, // 802.11g |
| 84 | kWiFiNetworkPhyMode11n = 4, // 802.11n |
| 85 | kWiFiNetworkPhyModeHalf = 5, // PSB Half-width |
| 86 | kWiFiNetworkPhyModeQuarter = 6, // PSB Quarter-width |
| 87 | kWiFiNetworkPhyModeTurbo = 7, // Atheros Turbo mode |
| 88 | |
| 89 | kWiFiNetworkPhyModeMax |
| 90 | }; |
| 91 | |
| 92 | enum WiFiSecurity { |
| 93 | kWiFiSecurityUnknown = 0, |
| 94 | kWiFiSecurityNone = 1, |
| 95 | kWiFiSecurityWep = 2, |
| 96 | kWiFiSecurityWpa = 3, |
| 97 | kWiFiSecurityRsn = 4, |
| 98 | kWiFiSecurity8021x = 5, |
| 99 | kWiFiSecurityPsk = 6, |
| 100 | |
| 101 | kWiFiSecurityMax |
| 102 | }; |
| 103 | |
Thieu Le | 85e050b | 2012-03-13 15:04:38 -0700 | [diff] [blame] | 104 | enum PortalResult { |
| 105 | kPortalResultSuccess = 0, |
| 106 | kPortalResultDNSFailure = 1, |
| 107 | kPortalResultDNSTimeout = 2, |
| 108 | kPortalResultConnectionFailure = 3, |
| 109 | kPortalResultConnectionTimeout = 4, |
| 110 | kPortalResultHTTPFailure = 5, |
| 111 | kPortalResultHTTPTimeout = 6, |
| 112 | kPortalResultContentFailure = 7, |
| 113 | kPortalResultContentTimeout = 8, |
| 114 | kPortalResultUnknown = 9, |
| 115 | |
| 116 | kPortalResultMax |
| 117 | }; |
| 118 | |
Thieu Le | 67370f6 | 2012-02-14 23:01:42 +0000 | [diff] [blame] | 119 | static const char kMetricDisconnect[]; |
| 120 | static const int kMetricDisconnectMax; |
| 121 | static const int kMetricDisconnectMin; |
| 122 | static const int kMetricDisconnectNumBuckets; |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 123 | static const char kMetricNetworkChannel[]; |
| 124 | static const int kMetricNetworkChannelMax; |
Thieu Le | ad1ec2c | 2012-01-05 23:39:48 +0000 | [diff] [blame] | 125 | static const char kMetricNetworkPhyMode[]; |
| 126 | static const int kMetricNetworkPhyModeMax; |
| 127 | static const char kMetricNetworkSecurity[]; |
| 128 | static const int kMetricNetworkSecurityMax; |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 129 | static const char kMetricNetworkServiceErrors[]; |
| 130 | static const int kMetricNetworkServiceErrorsMax; |
Thieu Le | a20cbc2 | 2012-01-09 22:01:43 +0000 | [diff] [blame] | 131 | static const char kMetricTimeOnlineSeconds[]; |
| 132 | static const int kMetricTimeOnlineSecondsMax; |
| 133 | static const int kMetricTimeOnlineSecondsMin; |
| 134 | static const int kMetricTimeOnlineSecondsNumBuckets; |
Thieu Le | b84ba34 | 2012-03-02 15:15:19 -0800 | [diff] [blame] | 135 | static const char kMetricTimeResumeToReadyMilliseconds[]; |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 136 | static const char kMetricTimeToConfigMilliseconds[]; |
Thieu Le | a20cbc2 | 2012-01-09 22:01:43 +0000 | [diff] [blame] | 137 | static const char kMetricTimeToDropSeconds[]; |
| 138 | static const int kMetricTimeToDropSecondsMax; |
| 139 | static const int kMetricTimeToDropSecondsMin; |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 140 | static const char kMetricTimeToJoinMilliseconds[]; |
| 141 | static const char kMetricTimeToOnlineMilliseconds[]; |
| 142 | static const char kMetricTimeToPortalMilliseconds[]; |
Thieu Le | a20cbc2 | 2012-01-09 22:01:43 +0000 | [diff] [blame] | 143 | static const int kTimerHistogramMillisecondsMax; |
| 144 | static const int kTimerHistogramMillisecondsMin; |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 145 | static const int kTimerHistogramNumBuckets; |
| 146 | |
Thieu Le | 85e050b | 2012-03-13 15:04:38 -0700 | [diff] [blame] | 147 | // The number of portal detections attempted for each pass. |
| 148 | // This includes both failure/timeout attempts and successful attempt |
| 149 | // (if any). |
| 150 | static const char kMetricPortalAttempts[]; |
| 151 | static const int kMetricPortalAttemptsMax; |
| 152 | static const int kMetricPortalAttemptsMin; |
| 153 | static const int kMetricPortalAttemptsNumBuckets; |
| 154 | |
| 155 | // The total number of portal detections attempted between the Connected |
| 156 | // state and the Online state. This includes both failure/timeout attempts |
| 157 | // and the final successful attempt. |
| 158 | static const char kMetricPortalAttemptsToOnline[]; |
| 159 | static const int kMetricPortalAttemptsToOnlineMax; |
| 160 | static const int kMetricPortalAttemptsToOnlineMin; |
| 161 | static const int kMetricPortalAttemptsToOnlineNumBuckets; |
| 162 | |
| 163 | // The result of the portal detection. |
| 164 | static const char kMetricPortalResult[]; |
| 165 | |
Thieu Le | b84ba34 | 2012-03-02 15:15:19 -0800 | [diff] [blame] | 166 | static const char kMetricPowerManagerKey[]; |
| 167 | |
Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 168 | Metrics(); |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 169 | virtual ~Metrics(); |
| 170 | |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 171 | // Converts the WiFi frequency into the associated UMA channel enumerator. |
| 172 | static WiFiChannel WiFiFrequencyToChannel(uint16 frequency); |
| 173 | |
Thieu Le | ad1ec2c | 2012-01-05 23:39:48 +0000 | [diff] [blame] | 174 | // Converts a flimflam security string into its UMA security enumerator. |
| 175 | static WiFiSecurity WiFiSecurityStringToEnum(const std::string &security); |
| 176 | |
Thieu Le | 85e050b | 2012-03-13 15:04:38 -0700 | [diff] [blame] | 177 | // Converts portal detection result to UMA portal result enumerator. |
| 178 | static PortalResult PortalDetectionResultToEnum( |
| 179 | const PortalDetector::Result &result); |
| 180 | |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 181 | // Registers a service with this object so it can use the timers to track |
| 182 | // state transition metrics. |
| 183 | void RegisterService(const Service *service); |
| 184 | |
| 185 | // Deregisters the service from this class. All state transition timers |
| 186 | // will be removed. |
| 187 | void DeregisterService(const Service *service); |
| 188 | |
| 189 | // Tracks the time it takes |service| to go from |start_state| to |
| 190 | // |stop_state|. When |stop_state| is reached, the time is sent to UMA. |
| 191 | void AddServiceStateTransitionTimer(const Service *service, |
| 192 | const std::string &histogram_name, |
| 193 | Service::ConnectState start_state, |
| 194 | Service::ConnectState stop_state); |
| 195 | |
| 196 | // Specializes |metric_name| for the specified |technology_id|. |
| 197 | std::string GetFullMetricName(const char *metric_name, |
| 198 | Technology::Identifier technology_id); |
| 199 | |
| 200 | // Notifies this object that the default service has changed. |
| 201 | // |service| is the new default service. |
Thieu Le | a20cbc2 | 2012-01-09 22:01:43 +0000 | [diff] [blame] | 202 | virtual void NotifyDefaultServiceChanged(const Service *service); |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 203 | |
| 204 | // Notifies this object that |service| state has changed. |
| 205 | virtual void NotifyServiceStateChanged(const Service *service, |
| 206 | Service::ConnectState new_state); |
| 207 | |
Thieu Le | 67370f6 | 2012-02-14 23:01:42 +0000 | [diff] [blame] | 208 | // Notifies this object that |service| has been disconnected. |
| 209 | void NotifyServiceDisconnect(const Service *service); |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 210 | |
Thieu Le | b84ba34 | 2012-03-02 15:15:19 -0800 | [diff] [blame] | 211 | // Notifies this object of a power management state change. |
| 212 | void NotifyPowerStateChange(PowerManager::SuspendState new_state); |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 213 | |
| 214 | // Sends linear histogram data to UMA. |
Thieu Le | 85e050b | 2012-03-13 15:04:38 -0700 | [diff] [blame] | 215 | virtual bool SendEnumToUMA(const std::string &name, int sample, int max); |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 216 | |
Thieu Le | a20cbc2 | 2012-01-09 22:01:43 +0000 | [diff] [blame] | 217 | // Send histogram data to UMA. |
Thieu Le | 85e050b | 2012-03-13 15:04:38 -0700 | [diff] [blame] | 218 | virtual bool SendToUMA(const std::string &name, int sample, int min, |
| 219 | int max, int num_buckets); |
Thieu Le | a20cbc2 | 2012-01-09 22:01:43 +0000 | [diff] [blame] | 220 | |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 221 | private: |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 222 | friend class MetricsTest; |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 223 | FRIEND_TEST(MetricsTest, FrequencyToChannel); |
Thieu Le | b84ba34 | 2012-03-02 15:15:19 -0800 | [diff] [blame] | 224 | FRIEND_TEST(MetricsTest, ServiceFailure); |
Thieu Le | a20cbc2 | 2012-01-09 22:01:43 +0000 | [diff] [blame] | 225 | FRIEND_TEST(MetricsTest, TimeOnlineTimeToDrop); |
Thieu Le | b84ba34 | 2012-03-02 15:15:19 -0800 | [diff] [blame] | 226 | FRIEND_TEST(MetricsTest, TimeToConfig); |
| 227 | FRIEND_TEST(MetricsTest, TimeToOnline); |
| 228 | FRIEND_TEST(MetricsTest, TimeToPortal); |
| 229 | FRIEND_TEST(MetricsTest, WiFiServiceChannel); |
| 230 | FRIEND_TEST(MetricsTest, WiFiServicePostReady); |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 231 | |
| 232 | typedef ScopedVector<chromeos_metrics::TimerReporter> TimerReporters; |
| 233 | typedef std::list<chromeos_metrics::TimerReporter *> TimerReportersList; |
| 234 | typedef std::map<Service::ConnectState, TimerReportersList> |
| 235 | TimerReportersByState; |
| 236 | struct ServiceMetrics { |
| 237 | ServiceMetrics() : service(NULL) {} |
| 238 | // The service is registered/deregistered in the Service |
| 239 | // constructor/destructor, therefore there is no need to keep a ref count. |
| 240 | const Service *service; |
| 241 | // All TimerReporter objects are stored in |timers| which owns the objects. |
| 242 | // |start_on_state| and |stop_on_state| contain pointers to the |
| 243 | // TimerReporter objects and control when to start and stop the timers. |
| 244 | TimerReporters timers; |
| 245 | TimerReportersByState start_on_state; |
| 246 | TimerReportersByState stop_on_state; |
| 247 | }; |
| 248 | typedef std::map<const Service *, std::tr1::shared_ptr<ServiceMetrics> > |
| 249 | ServiceMetricsLookupMap; |
| 250 | |
| 251 | static const uint16 kWiFiBandwidth5MHz; |
| 252 | static const uint16 kWiFiBandwidth20MHz; |
| 253 | static const uint16 kWiFiFrequency2412; |
| 254 | static const uint16 kWiFiFrequency2472; |
| 255 | static const uint16 kWiFiFrequency2484; |
| 256 | static const uint16 kWiFiFrequency5170; |
| 257 | static const uint16 kWiFiFrequency5180; |
| 258 | static const uint16 kWiFiFrequency5230; |
| 259 | static const uint16 kWiFiFrequency5240; |
| 260 | static const uint16 kWiFiFrequency5320; |
| 261 | static const uint16 kWiFiFrequency5500; |
| 262 | static const uint16 kWiFiFrequency5700; |
| 263 | static const uint16 kWiFiFrequency5745; |
| 264 | static const uint16 kWiFiFrequency5825; |
| 265 | |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 266 | void InitializeCommonServiceMetrics(const Service *service); |
| 267 | void UpdateServiceStateTransitionMetrics(ServiceMetrics *service_metrics, |
| 268 | Service::ConnectState new_state); |
| 269 | void SendServiceFailure(const Service *service); |
| 270 | |
| 271 | // For unit test purposes. |
| 272 | void set_library(MetricsLibraryInterface *library); |
Thieu Le | a20cbc2 | 2012-01-09 22:01:43 +0000 | [diff] [blame] | 273 | void set_time_online_timer(chromeos_metrics::Timer *timer) { |
| 274 | time_online_timer_.reset(timer); // Passes ownership |
| 275 | } |
| 276 | void set_time_to_drop_timer(chromeos_metrics::Timer *timer) { |
| 277 | time_to_drop_timer_.reset(timer); // Passes ownership |
| 278 | } |
Thieu Le | b84ba34 | 2012-03-02 15:15:19 -0800 | [diff] [blame] | 279 | void set_time_resume_to_ready_timer(chromeos_metrics::Timer *timer) { |
| 280 | time_resume_to_ready_timer_.reset(timer); // Passes ownership |
| 281 | } |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 282 | |
| 283 | // |library_| points to |metrics_library_| when shill runs normally. |
| 284 | // However, in order to allow for unit testing, we point |library_| to a |
| 285 | // MetricsLibraryMock object instead. |
| 286 | MetricsLibrary metrics_library_; |
| 287 | MetricsLibraryInterface *library_; |
| 288 | ServiceMetricsLookupMap services_metrics_; |
Thieu Le | a20cbc2 | 2012-01-09 22:01:43 +0000 | [diff] [blame] | 289 | Technology::Identifier last_default_technology_; |
| 290 | bool was_online_; |
| 291 | scoped_ptr<chromeos_metrics::Timer> time_online_timer_; |
| 292 | scoped_ptr<chromeos_metrics::Timer> time_to_drop_timer_; |
Thieu Le | b84ba34 | 2012-03-02 15:15:19 -0800 | [diff] [blame] | 293 | scoped_ptr<chromeos_metrics::Timer> time_resume_to_ready_timer_; |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 294 | |
| 295 | DISALLOW_COPY_AND_ASSIGN(Metrics); |
| 296 | }; |
| 297 | |
| 298 | } // namespace shill |
| 299 | |
| 300 | #endif // SHILL_METRICS_ |