Ben Chan | bc49ac7 | 2012-04-10 19:59: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 | |
| 5 | #include "shill/scope_logger.h" |
| 6 | |
| 7 | #include <vector> |
| 8 | |
Paul Stewart | 5ad1606 | 2013-02-21 18:10:48 -0800 | [diff] [blame] | 9 | #include <base/strings/string_tokenizer.h> |
Ben Chan | a0ddf46 | 2014-02-06 11:32:42 -0800 | [diff] [blame] | 10 | #include <base/strings/string_util.h> |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 11 | |
Paul Stewart | 5ad1606 | 2013-02-21 18:10:48 -0800 | [diff] [blame] | 12 | using base::StringTokenizer; |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 13 | using std::string; |
| 14 | using std::vector; |
| 15 | |
| 16 | namespace shill { |
| 17 | |
| 18 | namespace { |
| 19 | |
| 20 | const int kDefaultVerboseLevel = 0; |
| 21 | |
| 22 | // Scope names corresponding to the scope defined by ScopeLogger::Scope. |
Paul Stewart | 1a212a6 | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 23 | const char* const kScopeNames[] = { |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 24 | "cellular", |
| 25 | "connection", |
| 26 | "crypto", |
Ben Chan | fad4a0b | 2012-04-18 15:49:59 -0700 | [diff] [blame] | 27 | "daemon", |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 28 | "dbus", |
| 29 | "device", |
Ben Chan | fad4a0b | 2012-04-18 15:49:59 -0700 | [diff] [blame] | 30 | "dhcp", |
| 31 | "dns", |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 32 | "ethernet", |
Ben Chan | fad4a0b | 2012-04-18 15:49:59 -0700 | [diff] [blame] | 33 | "http", |
| 34 | "httpproxy", |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 35 | "inet", |
Paul Stewart | 6c72c97 | 2012-07-27 11:29:20 -0700 | [diff] [blame] | 36 | "link", |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 37 | "manager", |
| 38 | "metrics", |
| 39 | "modem", |
| 40 | "portal", |
Ben Chan | fad4a0b | 2012-04-18 15:49:59 -0700 | [diff] [blame] | 41 | "power", |
mukesh agrawal | 9da0777 | 2013-05-15 14:15:17 -0700 | [diff] [blame] | 42 | "ppp", |
Garret Kelly | 2dc218e | 2015-01-30 11:16:34 -0500 | [diff] [blame] | 43 | "pppoe", |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 44 | "profile", |
Ben Chan | fad4a0b | 2012-04-18 15:49:59 -0700 | [diff] [blame] | 45 | "property", |
| 46 | "resolver", |
| 47 | "route", |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 48 | "rtnl", |
| 49 | "service", |
| 50 | "storage", |
| 51 | "task", |
| 52 | "vpn", |
| 53 | "wifi", |
Darin Petkov | 096b347 | 2012-05-15 10:26:22 +0200 | [diff] [blame] | 54 | "wimax", |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 55 | }; |
| 56 | |
| 57 | COMPILE_ASSERT(arraysize(kScopeNames) == ScopeLogger::kNumScopes, |
| 58 | scope_tags_does_not_have_expected_number_of_strings); |
| 59 | |
Ben Chan | fdfdc87 | 2012-04-24 08:31:36 -0700 | [diff] [blame] | 60 | // ScopeLogger needs to be a 'leaky' singleton as it needs to survive to |
| 61 | // handle logging till the very end of the shill process. Making ScopeLogger |
| 62 | // leaky is fine as it does not need to clean up or release any resource at |
| 63 | // destruction. |
| 64 | base::LazyInstance<ScopeLogger>::Leaky g_scope_logger = |
| 65 | LAZY_INSTANCE_INITIALIZER; |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 66 | |
| 67 | } // namespace |
| 68 | |
| 69 | // static |
| 70 | ScopeLogger* ScopeLogger::GetInstance() { |
| 71 | return g_scope_logger.Pointer(); |
| 72 | } |
| 73 | |
| 74 | ScopeLogger::ScopeLogger() |
| 75 | : verbose_level_(kDefaultVerboseLevel) { |
| 76 | } |
| 77 | |
| 78 | ScopeLogger::~ScopeLogger() { |
| 79 | } |
| 80 | |
| 81 | bool ScopeLogger::IsLogEnabled(Scope scope, int verbose_level) const { |
Paul Stewart | 5581d07 | 2012-12-17 17:30:20 -0800 | [diff] [blame] | 82 | return IsScopeEnabled(scope) && verbose_level <= verbose_level_; |
| 83 | } |
| 84 | |
| 85 | bool ScopeLogger::IsScopeEnabled(Scope scope) const { |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 86 | CHECK_GE(scope, 0); |
| 87 | CHECK_LT(scope, kNumScopes); |
| 88 | |
Paul Stewart | 5581d07 | 2012-12-17 17:30:20 -0800 | [diff] [blame] | 89 | return scope_enabled_[scope]; |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 90 | } |
| 91 | |
| 92 | string ScopeLogger::GetAllScopeNames() const { |
| 93 | vector<string> names(kScopeNames, kScopeNames + arraysize(kScopeNames)); |
Ben Chan | 1c72260 | 2012-04-17 17:37:35 -0700 | [diff] [blame] | 94 | return JoinString(names, '+'); |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 95 | } |
| 96 | |
| 97 | string ScopeLogger::GetEnabledScopeNames() const { |
| 98 | vector<string> names; |
| 99 | for (size_t i = 0; i < arraysize(kScopeNames); ++i) { |
| 100 | if (scope_enabled_[i]) |
| 101 | names.push_back(kScopeNames[i]); |
| 102 | } |
| 103 | return JoinString(names, '+'); |
| 104 | } |
| 105 | |
Paul Stewart | 1a212a6 | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 106 | void ScopeLogger::EnableScopesByName(const string& expression) { |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 107 | if (expression.empty()) { |
| 108 | DisableAllScopes(); |
| 109 | return; |
| 110 | } |
| 111 | |
| 112 | // As described in the header file, if the first scope name in the |
| 113 | // sequence specified by |expression| is not prefixed by a plus or |
| 114 | // minus sign, it indicates that all scopes are first disabled before |
| 115 | // enabled by |expression|. |
| 116 | if (expression[0] != '+' && expression[0] != '-') |
| 117 | DisableAllScopes(); |
| 118 | |
| 119 | bool enable_scope = true; |
| 120 | StringTokenizer tokenizer(expression, "+-"); |
| 121 | tokenizer.set_options(StringTokenizer::RETURN_DELIMS); |
| 122 | while (tokenizer.GetNext()) { |
| 123 | if (tokenizer.token_is_delim()) { |
| 124 | enable_scope = (tokenizer.token() == "+"); |
| 125 | continue; |
| 126 | } |
| 127 | |
| 128 | if (tokenizer.token().empty()) |
| 129 | continue; |
| 130 | |
| 131 | size_t i; |
| 132 | for (i = 0; i < arraysize(kScopeNames); ++i) { |
| 133 | if (tokenizer.token() == kScopeNames[i]) { |
| 134 | SetScopeEnabled(static_cast<Scope>(i), enable_scope); |
| 135 | break; |
| 136 | } |
| 137 | } |
| 138 | LOG_IF(WARNING, i == arraysize(kScopeNames)) |
| 139 | << "Unknown scope '" << tokenizer.token() << "'"; |
| 140 | } |
| 141 | } |
| 142 | |
Paul Stewart | 5581d07 | 2012-12-17 17:30:20 -0800 | [diff] [blame] | 143 | void ScopeLogger::RegisterScopeEnableChangedCallback( |
| 144 | Scope scope, ScopeEnableChangedCallback callback) { |
| 145 | CHECK_GE(scope, 0); |
| 146 | CHECK_LT(scope, kNumScopes); |
| 147 | log_scope_callbacks_[scope].push_back(callback); |
| 148 | } |
| 149 | |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 150 | void ScopeLogger::DisableAllScopes() { |
Paul Stewart | 5581d07 | 2012-12-17 17:30:20 -0800 | [diff] [blame] | 151 | // Iterate over all scopes so the notification side-effect occurs. |
| 152 | for (size_t i = 0; i < arraysize(kScopeNames); ++i) { |
| 153 | SetScopeEnabled(static_cast<Scope>(i), false); |
| 154 | } |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 155 | } |
| 156 | |
| 157 | void ScopeLogger::SetScopeEnabled(Scope scope, bool enabled) { |
| 158 | CHECK_GE(scope, 0); |
| 159 | CHECK_LT(scope, kNumScopes); |
| 160 | |
Paul Stewart | 5581d07 | 2012-12-17 17:30:20 -0800 | [diff] [blame] | 161 | if (scope_enabled_[scope] != enabled) { |
Paul Stewart | 1a212a6 | 2015-06-16 13:13:10 -0700 | [diff] [blame] | 162 | for (const auto& callback : log_scope_callbacks_[scope]) { |
Paul Stewart | 6db7b24 | 2014-05-02 15:34:21 -0700 | [diff] [blame] | 163 | callback.Run(enabled); |
Paul Stewart | 5581d07 | 2012-12-17 17:30:20 -0800 | [diff] [blame] | 164 | } |
| 165 | } |
| 166 | |
Ben Chan | bc49ac7 | 2012-04-10 19:59:45 -0700 | [diff] [blame] | 167 | scope_enabled_[scope] = enabled; |
| 168 | } |
| 169 | |
| 170 | } // namespace shill |