blob: 60de1a24cce565f72d8beb70f35fc5bf7fed8d4a [file] [log] [blame]
Yao Chen44cf27c2017-09-14 22:32:50 -07001/*
2 * Copyright (C) 2017 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Yangster-mac754e29e2018-05-02 12:23:17 -070016#define DEBUG false // STOPSHIP if true
Joe Onorato9fc9edf2017-10-15 20:08:52 -070017#include "Log.h"
tsaichristined21aacf2019-10-07 14:47:38 -070018
Yao Chen44cf27c2017-09-14 22:32:50 -070019#include "MetricsManager.h"
tsaichristined21aacf2019-10-07 14:47:38 -070020
tsaichristined21aacf2019-10-07 14:47:38 -070021#include <private/android_filesystem_config.h>
Yao Chen93fe3a32017-11-02 13:52:59 -070022
Yao Chen44cf27c2017-09-14 22:32:50 -070023#include "CountMetricProducer.h"
Yao Chen93fe3a32017-11-02 13:52:59 -070024#include "condition/CombinationConditionTracker.h"
25#include "condition/SimpleConditionTracker.h"
Yao Chenb3561512017-11-21 18:07:17 -080026#include "guardrail/StatsdStats.h"
Yao Chen93fe3a32017-11-02 13:52:59 -070027#include "matchers/CombinationLogMatchingTracker.h"
28#include "matchers/SimpleLogMatchingTracker.h"
Yao Chencaf339d2017-10-06 16:01:10 -070029#include "metrics_manager_util.h"
tsaichristined21aacf2019-10-07 14:47:38 -070030#include "state/StateManager.h"
Yangster-mac330af582018-02-08 15:24:38 -080031#include "stats_log_util.h"
tsaichristined21aacf2019-10-07 14:47:38 -070032#include "stats_util.h"
Jeffrey Huang74fc4352020-03-06 15:18:33 -080033#include "statslog_statsd.h"
Yao Chen288c6002017-12-12 13:43:18 -080034
35using android::util::FIELD_COUNT_REPEATED;
David Chenfaa1af52018-03-30 15:14:04 -070036using android::util::FIELD_TYPE_INT32;
37using android::util::FIELD_TYPE_INT64;
Yao Chen288c6002017-12-12 13:43:18 -080038using android::util::FIELD_TYPE_MESSAGE;
Yangster-mac9def8e32018-04-17 13:55:51 -070039using android::util::FIELD_TYPE_STRING;
Yao Chen288c6002017-12-12 13:43:18 -080040using android::util::ProtoOutputStream;
41
Yao Chen44cf27c2017-09-14 22:32:50 -070042using std::set;
43using std::string;
Yao Chen44cf27c2017-09-14 22:32:50 -070044using std::vector;
45
46namespace android {
47namespace os {
48namespace statsd {
49
Yao Chen288c6002017-12-12 13:43:18 -080050const int FIELD_ID_METRICS = 1;
David Chenfaa1af52018-03-30 15:14:04 -070051const int FIELD_ID_ANNOTATIONS = 7;
52const int FIELD_ID_ANNOTATIONS_INT64 = 1;
53const int FIELD_ID_ANNOTATIONS_INT32 = 2;
Yao Chen288c6002017-12-12 13:43:18 -080054
Muhammad Qureshi844694b2019-04-05 10:10:40 -070055// for ActiveConfig
56const int FIELD_ID_ACTIVE_CONFIG_ID = 1;
57const int FIELD_ID_ACTIVE_CONFIG_UID = 2;
58const int FIELD_ID_ACTIVE_CONFIG_METRIC = 3;
59
Yao Chend10f7b12017-12-18 12:53:50 -080060MetricsManager::MetricsManager(const ConfigKey& key, const StatsdConfig& config,
Yangster-mac15f6bbc2018-04-08 11:52:26 -070061 const int64_t timeBaseNs, const int64_t currentTimeNs,
Chenjie Yue2219202018-06-08 10:07:51 -070062 const sp<UidMap>& uidMap,
63 const sp<StatsPullerManager>& pullerManager,
Yangster-mac932ecec2018-02-01 10:23:52 -080064 const sp<AlarmMonitor>& anomalyAlarmMonitor,
65 const sp<AlarmMonitor>& periodicAlarmMonitor)
Chenjie Yue2219202018-06-08 10:07:51 -070066 : mConfigKey(key),
67 mUidMap(uidMap),
Yangster-macb142cc82018-03-30 15:22:08 -070068 mTtlNs(config.has_ttl_in_seconds() ? config.ttl_in_seconds() * NS_PER_SEC : -1),
69 mTtlEndNs(-1),
David Chen48944902018-05-03 10:29:11 -070070 mLastReportTimeNs(currentTimeNs),
Yao Chen9a43b4f2019-04-10 10:43:20 -070071 mLastReportWallClockNs(getWallClockNs()),
Tej Singh3be093b2020-03-04 20:08:38 -080072 mPullerManager(pullerManager),
Muhammad Qureshif6816462020-05-13 15:13:33 -070073 mWhitelistedAtomIds(config.whitelisted_atom_ids().begin(),
74 config.whitelisted_atom_ids().end()),
Yao Chen9a43b4f2019-04-10 10:43:20 -070075 mShouldPersistHistory(config.persist_locally()) {
Yangster-macb142cc82018-03-30 15:22:08 -070076 // Init the ttl end timestamp.
Yangster-mac15f6bbc2018-04-08 11:52:26 -070077 refreshTtl(timeBaseNs);
Yangster-macb142cc82018-03-30 15:22:08 -070078
Chenjie Yue2219202018-06-08 10:07:51 -070079 mConfigValid = initStatsdConfig(
80 key, config, *uidMap, pullerManager, anomalyAlarmMonitor, periodicAlarmMonitor,
81 timeBaseNs, currentTimeNs, mTagIds, mAllAtomMatchers, mAllConditionTrackers,
82 mAllMetricProducers, mAllAnomalyTrackers, mAllPeriodicAlarmTrackers,
Yangster-mac849dfdc22018-10-12 15:41:45 -070083 mConditionToMetricMap, mTrackerToMetricMap, mTrackerToConditionMap,
Muhammad Qureshi3a5ebf52019-03-28 12:38:21 -070084 mActivationAtomTrackerToMetricMap, mDeactivationAtomTrackerToMetricMap,
Jeffrey Huang38d70262020-03-19 17:28:59 -070085 mAlertTrackerMap, mMetricIndexesWithActivation, mNoReportMetricIds);
Yao Chenb3561512017-11-21 18:07:17 -080086
Yangster-mac1c58f042018-05-17 15:52:51 -070087 mHashStringsInReport = config.hash_strings_in_metric_report();
dwchen730403e2018-10-29 11:41:56 -070088 mVersionStringsInReport = config.version_strings_in_metric_report();
89 mInstallerInReport = config.installer_in_metric_report();
Yangster-mac1c58f042018-05-17 15:52:51 -070090
Tej Singh3be093b2020-03-04 20:08:38 -080091 // Init allowed pushed atom uids.
Yao Chen147ce602017-12-22 14:35:34 -080092 if (config.allowed_log_source_size() == 0) {
David Chen8faaa012018-02-28 15:54:36 -080093 mConfigValid = false;
94 ALOGE("Log source whitelist is empty! This config won't get any data. Suggest adding at "
95 "least AID_SYSTEM and AID_STATSD to the allowed_log_source field.");
Yao Chend10f7b12017-12-18 12:53:50 -080096 } else {
Yao Chen147ce602017-12-22 14:35:34 -080097 for (const auto& source : config.allowed_log_source()) {
98 auto it = UidMap::sAidToUidMapping.find(source);
99 if (it != UidMap::sAidToUidMapping.end()) {
100 mAllowedUid.push_back(it->second);
101 } else {
102 mAllowedPkg.push_back(source);
103 }
104 }
Yao Chend10f7b12017-12-18 12:53:50 -0800105
106 if (mAllowedUid.size() + mAllowedPkg.size() > StatsdStats::kMaxLogSourceCount) {
107 ALOGE("Too many log sources. This is likely to be an error in the config.");
108 mConfigValid = false;
109 } else {
110 initLogSourceWhiteList();
111 }
112 }
113
Tej Singh3be093b2020-03-04 20:08:38 -0800114 // Init default allowed pull atom uids.
115 int numPullPackages = 0;
116 for (const string& pullSource : config.default_pull_packages()) {
117 auto it = UidMap::sAidToUidMapping.find(pullSource);
118 if (it != UidMap::sAidToUidMapping.end()) {
119 numPullPackages++;
120 mDefaultPullUids.insert(it->second);
121 } else {
122 ALOGE("Default pull atom packages must be in sAidToUidMapping");
123 mConfigValid = false;
124 }
125 }
126 // Init per-atom pull atom packages.
127 for (const PullAtomPackages& pullAtomPackages : config.pull_atom_packages()) {
128 int32_t atomId = pullAtomPackages.atom_id();
129 for (const string& pullPackage : pullAtomPackages.packages()) {
130 numPullPackages++;
131 auto it = UidMap::sAidToUidMapping.find(pullPackage);
132 if (it != UidMap::sAidToUidMapping.end()) {
133 mPullAtomUids[atomId].insert(it->second);
134 } else {
135 mPullAtomPackages[atomId].insert(pullPackage);
136 }
137 }
138 }
139 if (numPullPackages > StatsdStats::kMaxPullAtomPackages) {
140 ALOGE("Too many sources in default_pull_packages and pull_atom_packages. This is likely to "
141 "be an error in the config");
142 mConfigValid = false;
143 } else {
144 initPullAtomSources();
145 }
146 mPullerManager->RegisterPullUidProvider(mConfigKey, this);
147
David Chenfaa1af52018-03-30 15:14:04 -0700148 // Store the sub-configs used.
149 for (const auto& annotation : config.annotation()) {
150 mAnnotations.emplace_back(annotation.field_int64(), annotation.field_int32());
151 }
152
Yao Chenb3561512017-11-21 18:07:17 -0800153 // Guardrail. Reject the config if it's too big.
154 if (mAllMetricProducers.size() > StatsdStats::kMaxMetricCountPerConfig ||
155 mAllConditionTrackers.size() > StatsdStats::kMaxConditionCountPerConfig ||
Stefan Lafonb8c9aa82017-12-03 14:27:25 -0800156 mAllAtomMatchers.size() > StatsdStats::kMaxMatcherCountPerConfig) {
Yao Chenb3561512017-11-21 18:07:17 -0800157 ALOGE("This config is too big! Reject!");
158 mConfigValid = false;
159 }
Bookatz1476ef22018-02-13 12:26:01 -0800160 if (mAllAnomalyTrackers.size() > StatsdStats::kMaxAlertCountPerConfig) {
161 ALOGE("This config has too many alerts! Reject!");
162 mConfigValid = false;
163 }
Tej Singh6ede28b2019-01-29 17:06:54 -0800164
165 mIsAlwaysActive = (mMetricIndexesWithActivation.size() != mAllMetricProducers.size()) ||
166 (mAllMetricProducers.size() == 0);
167 bool isActive = mIsAlwaysActive;
168 for (int metric : mMetricIndexesWithActivation) {
169 isActive |= mAllMetricProducers[metric]->isActive();
170 }
171 mIsActive = isActive;
172 VLOG("mIsActive is initialized to %d", mIsActive)
173
Yao Chenf09569f2017-12-13 17:00:51 -0800174 // no matter whether this config is valid, log it in the stats.
David Chenfaa1af52018-03-30 15:14:04 -0700175 StatsdStats::getInstance().noteConfigReceived(
176 key, mAllMetricProducers.size(), mAllConditionTrackers.size(), mAllAtomMatchers.size(),
177 mAllAnomalyTrackers.size(), mAnnotations, mConfigValid);
Chenjie Yuc7939cb2019-02-04 17:25:45 -0800178 // Check active
179 for (const auto& metric : mAllMetricProducers) {
180 if (metric->isActive()) {
181 mIsActive = true;
182 break;
183 }
184 }
Yao Chen44cf27c2017-09-14 22:32:50 -0700185}
186
187MetricsManager::~MetricsManager() {
tsaichristined21aacf2019-10-07 14:47:38 -0700188 for (auto it : mAllMetricProducers) {
189 for (int atomId : it->getSlicedStateAtoms()) {
190 StateManager::getInstance().unregisterListener(atomId, it);
191 }
192 }
Tej Singh3eb9ced2020-04-20 22:04:38 -0700193 mPullerManager->UnregisterPullUidProvider(mConfigKey, this);
tsaichristined21aacf2019-10-07 14:47:38 -0700194
Bookatzd3606c72017-10-19 10:13:49 -0700195 VLOG("~MetricsManager()");
Yao Chen44cf27c2017-09-14 22:32:50 -0700196}
197
Yao Chend10f7b12017-12-18 12:53:50 -0800198void MetricsManager::initLogSourceWhiteList() {
199 std::lock_guard<std::mutex> lock(mAllowedLogSourcesMutex);
200 mAllowedLogSources.clear();
201 mAllowedLogSources.insert(mAllowedUid.begin(), mAllowedUid.end());
202
203 for (const auto& pkg : mAllowedPkg) {
204 auto uids = mUidMap->getAppUid(pkg);
205 mAllowedLogSources.insert(uids.begin(), uids.end());
206 }
207 if (DEBUG) {
208 for (const auto& uid : mAllowedLogSources) {
209 VLOG("Allowed uid %d", uid);
210 }
211 }
212}
213
Tej Singh3be093b2020-03-04 20:08:38 -0800214void MetricsManager::initPullAtomSources() {
215 std::lock_guard<std::mutex> lock(mAllowedLogSourcesMutex);
216 mCombinedPullAtomUids.clear();
217 for (const auto& [atomId, uids] : mPullAtomUids) {
218 mCombinedPullAtomUids[atomId].insert(uids.begin(), uids.end());
219 }
220 for (const auto& [atomId, packages] : mPullAtomPackages) {
221 for (const string& pkg : packages) {
222 set<int32_t> uids = mUidMap->getAppUid(pkg);
223 mCombinedPullAtomUids[atomId].insert(uids.begin(), uids.end());
224 }
225 }
226}
227
Yao Chencaf339d2017-10-06 16:01:10 -0700228bool MetricsManager::isConfigValid() const {
229 return mConfigValid;
230}
231
Yangster-macb142cc82018-03-30 15:22:08 -0700232void MetricsManager::notifyAppUpgrade(const int64_t& eventTimeNs, const string& apk, const int uid,
David Chen27785a82018-01-19 17:06:45 -0800233 const int64_t version) {
Tej Singh9ec159a2019-11-14 11:59:48 -0800234 // Inform all metric producers.
Tej Singhe678cb72020-04-14 16:23:30 -0700235 for (const auto& it : mAllMetricProducers) {
236 it->notifyAppUpgrade(eventTimeNs);
Tej Singh9ec159a2019-11-14 11:59:48 -0800237 }
Yao Chend10f7b12017-12-18 12:53:50 -0800238 // check if we care this package
Tej Singh3be093b2020-03-04 20:08:38 -0800239 if (std::find(mAllowedPkg.begin(), mAllowedPkg.end(), apk) != mAllowedPkg.end()) {
240 // We will re-initialize the whole list because we don't want to keep the multi mapping of
241 // UID<->pkg inside MetricsManager to reduce the memory usage.
242 initLogSourceWhiteList();
Yao Chend10f7b12017-12-18 12:53:50 -0800243 }
Tej Singh3be093b2020-03-04 20:08:38 -0800244
245 for (const auto& it : mPullAtomPackages) {
246 if (it.second.find(apk) != it.second.end()) {
247 initPullAtomSources();
248 return;
249 }
250 }
Yao Chend10f7b12017-12-18 12:53:50 -0800251}
252
Yangster-macb142cc82018-03-30 15:22:08 -0700253void MetricsManager::notifyAppRemoved(const int64_t& eventTimeNs, const string& apk,
David Chen27785a82018-01-19 17:06:45 -0800254 const int uid) {
Tej Singh9ec159a2019-11-14 11:59:48 -0800255 // Inform all metric producers.
Tej Singhe678cb72020-04-14 16:23:30 -0700256 for (const auto& it : mAllMetricProducers) {
257 it->notifyAppRemoved(eventTimeNs);
Tej Singh9ec159a2019-11-14 11:59:48 -0800258 }
Yao Chend10f7b12017-12-18 12:53:50 -0800259 // check if we care this package
Tej Singh3be093b2020-03-04 20:08:38 -0800260 if (std::find(mAllowedPkg.begin(), mAllowedPkg.end(), apk) != mAllowedPkg.end()) {
261 // We will re-initialize the whole list because we don't want to keep the multi mapping of
262 // UID<->pkg inside MetricsManager to reduce the memory usage.
263 initLogSourceWhiteList();
Yao Chend10f7b12017-12-18 12:53:50 -0800264 }
Tej Singh3be093b2020-03-04 20:08:38 -0800265
266 for (const auto& it : mPullAtomPackages) {
267 if (it.second.find(apk) != it.second.end()) {
268 initPullAtomSources();
269 return;
270 }
271 }
Yao Chend10f7b12017-12-18 12:53:50 -0800272}
273
Yangster-macb142cc82018-03-30 15:22:08 -0700274void MetricsManager::onUidMapReceived(const int64_t& eventTimeNs) {
Tej Singh9ec159a2019-11-14 11:59:48 -0800275 // Purposefully don't inform metric producers on a new snapshot
276 // because we don't need to flush partial buckets.
277 // This occurs if a new user is added/removed or statsd crashes.
Tej Singh3be093b2020-03-04 20:08:38 -0800278 initPullAtomSources();
279
Yao Chend10f7b12017-12-18 12:53:50 -0800280 if (mAllowedPkg.size() == 0) {
281 return;
282 }
283 initLogSourceWhiteList();
284}
285
Tej Singhe678cb72020-04-14 16:23:30 -0700286void MetricsManager::onStatsdInitCompleted(const int64_t& eventTimeNs) {
287 // Inform all metric producers.
288 for (const auto& it : mAllMetricProducers) {
289 it->onStatsdInitCompleted(eventTimeNs);
290 }
291}
292
Tej Singh3be093b2020-03-04 20:08:38 -0800293void MetricsManager::init() {
294 for (const auto& producer : mAllMetricProducers) {
295 producer->prepareFirstBucket();
296 }
297}
298
299vector<int32_t> MetricsManager::getPullAtomUids(int32_t atomId) {
300 std::lock_guard<std::mutex> lock(mAllowedLogSourcesMutex);
301 vector<int32_t> uids;
302 const auto& it = mCombinedPullAtomUids.find(atomId);
303 if (it != mCombinedPullAtomUids.end()) {
304 uids.insert(uids.end(), it->second.begin(), it->second.end());
305 }
306 uids.insert(uids.end(), mDefaultPullUids.begin(), mDefaultPullUids.end());
307 return uids;
308}
309
Yao Chen884c8c12018-01-26 10:36:25 -0800310void MetricsManager::dumpStates(FILE* out, bool verbose) {
311 fprintf(out, "ConfigKey %s, allowed source:", mConfigKey.ToString().c_str());
312 {
313 std::lock_guard<std::mutex> lock(mAllowedLogSourcesMutex);
314 for (const auto& source : mAllowedLogSources) {
315 fprintf(out, "%d ", source);
316 }
317 }
318 fprintf(out, "\n");
319 for (const auto& producer : mAllMetricProducers) {
320 producer->dumpStates(out, verbose);
321 }
322}
323
Yangster-macb142cc82018-03-30 15:22:08 -0700324void MetricsManager::dropData(const int64_t dropTimeNs) {
Yao Chen06dba5d2018-01-26 13:38:16 -0800325 for (const auto& producer : mAllMetricProducers) {
326 producer->dropData(dropTimeNs);
327 }
328}
329
Yangster-mace68f3a52018-04-04 00:01:43 -0700330void MetricsManager::onDumpReport(const int64_t dumpTimeStampNs,
331 const bool include_current_partial_bucket,
Bookatzff71cad2018-09-20 17:17:49 -0700332 const bool erase_data,
Olivier Gaillard6c75ecd2019-02-20 09:57:33 +0000333 const DumpLatency dumpLatency,
Yangster-mac9def8e32018-04-17 13:55:51 -0700334 std::set<string> *str_set,
Yangster-mace68f3a52018-04-04 00:01:43 -0700335 ProtoOutputStream* protoOutput) {
Yao Chen729093d2017-10-16 10:33:26 -0700336 VLOG("=========================Metric Reports Start==========================");
337 // one StatsLogReport per MetricProduer
Yangster-mac94e197c2018-01-02 16:03:03 -0800338 for (const auto& producer : mAllMetricProducers) {
339 if (mNoReportMetricIds.find(producer->getMetricId()) == mNoReportMetricIds.end()) {
Yangster-mac9def8e32018-04-17 13:55:51 -0700340 uint64_t token = protoOutput->start(
341 FIELD_TYPE_MESSAGE | FIELD_COUNT_REPEATED | FIELD_ID_METRICS);
Yangster-mac1c58f042018-05-17 15:52:51 -0700342 if (mHashStringsInReport) {
Bookatzff71cad2018-09-20 17:17:49 -0700343 producer->onDumpReport(dumpTimeStampNs, include_current_partial_bucket, erase_data,
Olivier Gaillard6c75ecd2019-02-20 09:57:33 +0000344 dumpLatency, str_set, protoOutput);
Yangster-mac1c58f042018-05-17 15:52:51 -0700345 } else {
Bookatzff71cad2018-09-20 17:17:49 -0700346 producer->onDumpReport(dumpTimeStampNs, include_current_partial_bucket, erase_data,
Olivier Gaillard6c75ecd2019-02-20 09:57:33 +0000347 dumpLatency, nullptr, protoOutput);
Yangster-mac1c58f042018-05-17 15:52:51 -0700348 }
Yangster-mac94e197c2018-01-02 16:03:03 -0800349 protoOutput->end(token);
Yangster-maca802d732018-04-24 07:50:38 -0700350 } else {
351 producer->clearPastBuckets(dumpTimeStampNs);
Yangster-mac94e197c2018-01-02 16:03:03 -0800352 }
Yao Chen729093d2017-10-16 10:33:26 -0700353 }
David Chenfaa1af52018-03-30 15:14:04 -0700354 for (const auto& annotation : mAnnotations) {
355 uint64_t token = protoOutput->start(FIELD_TYPE_MESSAGE | FIELD_COUNT_REPEATED |
356 FIELD_ID_ANNOTATIONS);
357 protoOutput->write(FIELD_TYPE_INT64 | FIELD_ID_ANNOTATIONS_INT64,
358 (long long)annotation.first);
359 protoOutput->write(FIELD_TYPE_INT32 | FIELD_ID_ANNOTATIONS_INT32, annotation.second);
360 protoOutput->end(token);
361 }
Yangster-mac9def8e32018-04-17 13:55:51 -0700362
Jeffrey Huang289eae62020-06-10 16:28:23 -0700363 // Do not update the timestamps when data is not cleared to avoid timestamps from being
364 // misaligned.
365 if (erase_data) {
366 mLastReportTimeNs = dumpTimeStampNs;
367 mLastReportWallClockNs = getWallClockNs();
368 }
Yao Chen729093d2017-10-16 10:33:26 -0700369 VLOG("=========================Metric Reports End==========================");
Yao Chen729093d2017-10-16 10:33:26 -0700370}
371
Yao Chencaf339d2017-10-06 16:01:10 -0700372
Andrei Oneada01ea52019-01-30 15:28:36 +0000373bool MetricsManager::checkLogCredentials(const LogEvent& event) {
Muhammad Qureshif6816462020-05-13 15:13:33 -0700374 if (mWhitelistedAtomIds.find(event.GetTagId()) != mWhitelistedAtomIds.end()) {
375 return true;
376 }
Andrei Oneada01ea52019-01-30 15:28:36 +0000377 std::lock_guard<std::mutex> lock(mAllowedLogSourcesMutex);
378 if (mAllowedLogSources.find(event.GetUid()) == mAllowedLogSources.end()) {
379 VLOG("log source %d not on the whitelist", event.GetUid());
380 return false;
381 }
382 return true;
383}
384
385bool MetricsManager::eventSanityCheck(const LogEvent& event) {
Jeffrey Huang74fc4352020-03-06 15:18:33 -0800386 if (event.GetTagId() == util::APP_BREADCRUMB_REPORTED) {
David Chenb639d142018-02-14 17:29:54 -0800387 // Check that app breadcrumb reported fields are valid.
David Chendaa9f3a2017-12-28 16:52:22 -0800388 status_t err = NO_ERROR;
Bookatzb223c4e2018-02-01 15:35:04 -0800389
390 // Uid is 3rd from last field and must match the caller's uid,
391 // unless that caller is statsd itself (statsd is allowed to spoof uids).
392 long appHookUid = event.GetLong(event.size()-2, &err);
Ruchir Rastogid4cc6932020-04-20 11:51:14 -0700393 if (err != NO_ERROR) {
David Chen77ef6712018-02-23 18:23:42 -0800394 VLOG("APP_BREADCRUMB_REPORTED had error when parsing the uid");
Andrei Oneada01ea52019-01-30 15:28:36 +0000395 return false;
David Chen77ef6712018-02-23 18:23:42 -0800396 }
Ruchir Rastogid4cc6932020-04-20 11:51:14 -0700397
398 // Because the uid within the LogEvent may have been mapped from
399 // isolated to host, map the loggerUid similarly before comparing.
400 int32_t loggerUid = mUidMap->getHostUidOrSelf(event.GetUid());
David Chen77ef6712018-02-23 18:23:42 -0800401 if (loggerUid != appHookUid && loggerUid != AID_STATSD) {
402 VLOG("APP_BREADCRUMB_REPORTED has invalid uid: claimed %ld but caller is %d",
403 appHookUid, loggerUid);
Andrei Oneada01ea52019-01-30 15:28:36 +0000404 return false;
David Chendaa9f3a2017-12-28 16:52:22 -0800405 }
Bookatzb223c4e2018-02-01 15:35:04 -0800406
David Chendaa9f3a2017-12-28 16:52:22 -0800407 // The state must be from 0,3. This part of code must be manually updated.
Bookatzb223c4e2018-02-01 15:35:04 -0800408 long appHookState = event.GetLong(event.size(), &err);
Ruchir Rastogid4cc6932020-04-20 11:51:14 -0700409 if (err != NO_ERROR) {
David Chen77ef6712018-02-23 18:23:42 -0800410 VLOG("APP_BREADCRUMB_REPORTED had error when parsing the state field");
Andrei Oneada01ea52019-01-30 15:28:36 +0000411 return false;
David Chen77ef6712018-02-23 18:23:42 -0800412 } else if (appHookState < 0 || appHookState > 3) {
413 VLOG("APP_BREADCRUMB_REPORTED does not have valid state %ld", appHookState);
Andrei Oneada01ea52019-01-30 15:28:36 +0000414 return false;
David Chendaa9f3a2017-12-28 16:52:22 -0800415 }
Jeffrey Huang74fc4352020-03-06 15:18:33 -0800416 } else if (event.GetTagId() == util::DAVEY_OCCURRED) {
Tej Singhbb8554a2018-01-26 11:59:14 -0800417 // Daveys can be logged from any app since they are logged in libs/hwui/JankTracker.cpp.
418 // Check that the davey duration is reasonable. Max length check is for privacy.
419 status_t err = NO_ERROR;
David Chen77ef6712018-02-23 18:23:42 -0800420
421 // Uid is the first field provided.
422 long jankUid = event.GetLong(1, &err);
Ruchir Rastogid4cc6932020-04-20 11:51:14 -0700423 if (err != NO_ERROR) {
David Chen77ef6712018-02-23 18:23:42 -0800424 VLOG("Davey occurred had error when parsing the uid");
Andrei Oneada01ea52019-01-30 15:28:36 +0000425 return false;
David Chen77ef6712018-02-23 18:23:42 -0800426 }
427 int32_t loggerUid = event.GetUid();
428 if (loggerUid != jankUid && loggerUid != AID_STATSD) {
429 VLOG("DAVEY_OCCURRED has invalid uid: claimed %ld but caller is %d", jankUid,
430 loggerUid);
Andrei Oneada01ea52019-01-30 15:28:36 +0000431 return false;
David Chen77ef6712018-02-23 18:23:42 -0800432 }
433
Tej Singhbb8554a2018-01-26 11:59:14 -0800434 long duration = event.GetLong(event.size(), &err);
Ruchir Rastogid4cc6932020-04-20 11:51:14 -0700435 if (err != NO_ERROR) {
David Chen77ef6712018-02-23 18:23:42 -0800436 VLOG("Davey occurred had error when parsing the duration");
Andrei Oneada01ea52019-01-30 15:28:36 +0000437 return false;
David Chen77ef6712018-02-23 18:23:42 -0800438 } else if (duration > 100000) {
Tej Singhbb8554a2018-01-26 11:59:14 -0800439 VLOG("Davey duration is unreasonably long: %ld", duration);
Andrei Oneada01ea52019-01-30 15:28:36 +0000440 return false;
Tej Singhbb8554a2018-01-26 11:59:14 -0800441 }
Andrei Oneada01ea52019-01-30 15:28:36 +0000442 }
443
444 return true;
445}
446
447// Consume the stats log if it's interesting to this metric.
448void MetricsManager::onLogEvent(const LogEvent& event) {
449 if (!mConfigValid) {
450 return;
451 }
452
453 if (!checkLogCredentials(event)) {
454 return;
455 }
456
457 if (!eventSanityCheck(event)) {
458 return;
Yao Chend10f7b12017-12-18 12:53:50 -0800459 }
460
Joe Onoratoc4dfae52017-10-17 23:38:21 -0700461 int tagId = event.GetTagId();
Yangster-mac849dfdc22018-10-12 15:41:45 -0700462 int64_t eventTimeNs = event.GetElapsedTimestampNs();
463
Tej Singh6ede28b2019-01-29 17:06:54 -0800464 bool isActive = mIsAlwaysActive;
Muhammad Qureshi3a5ebf52019-03-28 12:38:21 -0700465
466 // Set of metrics that are still active after flushing.
467 unordered_set<int> activeMetricsIndices;
468
469 // Update state of all metrics w/ activation conditions as of eventTimeNs.
470 for (int metricIndex : mMetricIndexesWithActivation) {
471 const sp<MetricProducer>& metric = mAllMetricProducers[metricIndex];
472 metric->flushIfExpire(eventTimeNs);
473 if (metric->isActive()) {
474 // If this metric w/ activation condition is still active after
475 // flushing, remember it.
476 activeMetricsIndices.insert(metricIndex);
477 }
Yangster-mac849dfdc22018-10-12 15:41:45 -0700478 }
479
Muhammad Qureshi3a5ebf52019-03-28 12:38:21 -0700480 mIsActive = isActive || !activeMetricsIndices.empty();
Tej Singh6ede28b2019-01-29 17:06:54 -0800481
Yao Chen44cf27c2017-09-14 22:32:50 -0700482 if (mTagIds.find(tagId) == mTagIds.end()) {
Muhammad Qureshi3a5ebf52019-03-28 12:38:21 -0700483 // Not interesting...
Yao Chen44cf27c2017-09-14 22:32:50 -0700484 return;
485 }
Yao Chen44cf27c2017-09-14 22:32:50 -0700486
Stefan Lafonb8c9aa82017-12-03 14:27:25 -0800487 vector<MatchingState> matcherCache(mAllAtomMatchers.size(), MatchingState::kNotComputed);
Yao Chencaf339d2017-10-06 16:01:10 -0700488
Muhammad Qureshi3a5ebf52019-03-28 12:38:21 -0700489 // Evaluate all atom matchers.
Stefan Lafonb8c9aa82017-12-03 14:27:25 -0800490 for (auto& matcher : mAllAtomMatchers) {
491 matcher->onLogEvent(event, mAllAtomMatchers, matcherCache);
Yao Chen44cf27c2017-09-14 22:32:50 -0700492 }
493
Muhammad Qureshi3a5ebf52019-03-28 12:38:21 -0700494 // Set of metrics that received an activation cancellation.
495 unordered_set<int> metricIndicesWithCanceledActivations;
496
497 // Determine which metric activations received a cancellation and cancel them.
498 for (const auto& it : mDeactivationAtomTrackerToMetricMap) {
499 if (matcherCache[it.first] == MatchingState::kMatched) {
500 for (int metricIndex : it.second) {
501 mAllMetricProducers[metricIndex]->cancelEventActivation(it.first);
502 metricIndicesWithCanceledActivations.insert(metricIndex);
503 }
504 }
505 }
506
507 // Determine whether any metrics are no longer active after cancelling metric activations.
508 for (const int metricIndex : metricIndicesWithCanceledActivations) {
509 const sp<MetricProducer>& metric = mAllMetricProducers[metricIndex];
510 metric->flushIfExpire(eventTimeNs);
511 if (!metric->isActive()) {
512 activeMetricsIndices.erase(metricIndex);
513 }
514 }
515
516 isActive |= !activeMetricsIndices.empty();
517
518
519 // Determine which metric activations should be turned on and turn them on
Yangster-mac849dfdc22018-10-12 15:41:45 -0700520 for (const auto& it : mActivationAtomTrackerToMetricMap) {
521 if (matcherCache[it.first] == MatchingState::kMatched) {
522 for (int metricIndex : it.second) {
523 mAllMetricProducers[metricIndex]->activate(it.first, eventTimeNs);
Chenjie Yuc7939cb2019-02-04 17:25:45 -0800524 isActive |= mAllMetricProducers[metricIndex]->isActive();
Yangster-mac849dfdc22018-10-12 15:41:45 -0700525 }
526 }
527 }
528
Chenjie Yuc7939cb2019-02-04 17:25:45 -0800529 mIsActive = isActive;
530
Yao Chencaf339d2017-10-06 16:01:10 -0700531 // A bitmap to see which ConditionTracker needs to be re-evaluated.
532 vector<bool> conditionToBeEvaluated(mAllConditionTrackers.size(), false);
533
534 for (const auto& pair : mTrackerToConditionMap) {
535 if (matcherCache[pair.first] == MatchingState::kMatched) {
536 const auto& conditionList = pair.second;
537 for (const int conditionIndex : conditionList) {
538 conditionToBeEvaluated[conditionIndex] = true;
539 }
540 }
541 }
542
543 vector<ConditionState> conditionCache(mAllConditionTrackers.size(),
544 ConditionState::kNotEvaluated);
545 // A bitmap to track if a condition has changed value.
546 vector<bool> changedCache(mAllConditionTrackers.size(), false);
547 for (size_t i = 0; i < mAllConditionTrackers.size(); i++) {
548 if (conditionToBeEvaluated[i] == false) {
549 continue;
550 }
Yao Chencaf339d2017-10-06 16:01:10 -0700551 sp<ConditionTracker>& condition = mAllConditionTrackers[i];
552 condition->evaluateCondition(event, matcherCache, mAllConditionTrackers, conditionCache,
Yao Chen967b2052017-11-07 16:36:43 -0800553 changedCache);
Yao Chen729093d2017-10-16 10:33:26 -0700554 }
555
556 for (size_t i = 0; i < mAllConditionTrackers.size(); i++) {
Yao Chen967b2052017-11-07 16:36:43 -0800557 if (changedCache[i] == false) {
Yao Chen729093d2017-10-16 10:33:26 -0700558 continue;
559 }
560 auto pair = mConditionToMetricMap.find(i);
561 if (pair != mConditionToMetricMap.end()) {
562 auto& metricList = pair->second;
563 for (auto metricIndex : metricList) {
Muhammad Qureshi3a5ebf52019-03-28 12:38:21 -0700564 // Metric cares about non sliced condition, and it's changed.
Yao Chen729093d2017-10-16 10:33:26 -0700565 // Push the new condition to it directly.
Yao Chen967b2052017-11-07 16:36:43 -0800566 if (!mAllMetricProducers[metricIndex]->isConditionSliced()) {
Yao Chen5154a372017-10-30 22:57:06 -0700567 mAllMetricProducers[metricIndex]->onConditionChanged(conditionCache[i],
Yangster-mac849dfdc22018-10-12 15:41:45 -0700568 eventTimeNs);
Muhammad Qureshi3a5ebf52019-03-28 12:38:21 -0700569 // Metric cares about sliced conditions, and it may have changed. Send
Yao Chen729093d2017-10-16 10:33:26 -0700570 // notification, and the metric can query the sliced conditions that are
571 // interesting to it.
Yangsterf2bee6f2017-11-29 12:01:05 -0800572 } else {
Yao Chen427d3722018-03-22 15:21:52 -0700573 mAllMetricProducers[metricIndex]->onSlicedConditionMayChange(conditionCache[i],
Yangster-mac849dfdc22018-10-12 15:41:45 -0700574 eventTimeNs);
Yao Chen44cf27c2017-09-14 22:32:50 -0700575 }
Yao Chencaf339d2017-10-06 16:01:10 -0700576 }
577 }
578 }
579
Stefan Lafonb8c9aa82017-12-03 14:27:25 -0800580 // For matched AtomMatchers, tell relevant metrics that a matched event has come.
581 for (size_t i = 0; i < mAllAtomMatchers.size(); i++) {
Yao Chencaf339d2017-10-06 16:01:10 -0700582 if (matcherCache[i] == MatchingState::kMatched) {
Yao Chenb3561512017-11-21 18:07:17 -0800583 StatsdStats::getInstance().noteMatcherMatched(mConfigKey,
Yangster-mac94e197c2018-01-02 16:03:03 -0800584 mAllAtomMatchers[i]->getId());
Yao Chencaf339d2017-10-06 16:01:10 -0700585 auto pair = mTrackerToMetricMap.find(i);
586 if (pair != mTrackerToMetricMap.end()) {
587 auto& metricList = pair->second;
588 for (const int metricIndex : metricList) {
Chenjie Yub3dda412017-10-24 13:41:59 -0700589 // pushed metrics are never scheduled pulls
Chenjie Yua7259ab2017-12-10 08:31:05 -0800590 mAllMetricProducers[metricIndex]->onMatchedLogEvent(i, event);
Yao Chencaf339d2017-10-06 16:01:10 -0700591 }
Yao Chen44cf27c2017-09-14 22:32:50 -0700592 }
593 }
594 }
595}
596
Yangster-mac932ecec2018-02-01 10:23:52 -0800597void MetricsManager::onAnomalyAlarmFired(
Yangster-macb142cc82018-03-30 15:22:08 -0700598 const int64_t& timestampNs,
Yangster-mac932ecec2018-02-01 10:23:52 -0800599 unordered_set<sp<const InternalAlarm>, SpHash<InternalAlarm>>& alarmSet) {
Yangster-mace2cd6d52017-11-09 20:38:30 -0800600 for (const auto& itr : mAllAnomalyTrackers) {
Yangster-mac932ecec2018-02-01 10:23:52 -0800601 itr->informAlarmsFired(timestampNs, alarmSet);
Yangster-mace2cd6d52017-11-09 20:38:30 -0800602 }
603}
604
Yangster-mac932ecec2018-02-01 10:23:52 -0800605void MetricsManager::onPeriodicAlarmFired(
Yangster-macb142cc82018-03-30 15:22:08 -0700606 const int64_t& timestampNs,
Yangster-mac932ecec2018-02-01 10:23:52 -0800607 unordered_set<sp<const InternalAlarm>, SpHash<InternalAlarm>>& alarmSet) {
608 for (const auto& itr : mAllPeriodicAlarmTrackers) {
609 itr->informAlarmsFired(timestampNs, alarmSet);
Yangster-mace2cd6d52017-11-09 20:38:30 -0800610 }
611}
612
yro69007c82017-10-26 20:42:57 -0700613// Returns the total byte size of all metrics managed by a single config source.
614size_t MetricsManager::byteSize() {
615 size_t totalSize = 0;
Chih-Hung Hsieha1b644e2018-12-11 11:09:20 -0800616 for (const auto& metricProducer : mAllMetricProducers) {
yro69007c82017-10-26 20:42:57 -0700617 totalSize += metricProducer->byteSize();
618 }
619 return totalSize;
620}
621
Muhammad Qureshi844694b2019-04-05 10:10:40 -0700622void MetricsManager::loadActiveConfig(const ActiveConfig& config, int64_t currentTimeNs) {
623 if (config.metric_size() == 0) {
Chenjie Yuc7939cb2019-02-04 17:25:45 -0800624 ALOGW("No active metric for config %s", mConfigKey.ToString().c_str());
625 return;
626 }
627
Muhammad Qureshi844694b2019-04-05 10:10:40 -0700628 for (int i = 0; i < config.metric_size(); i++) {
629 const auto& activeMetric = config.metric(i);
630 for (int metricIndex : mMetricIndexesWithActivation) {
631 const auto& metric = mAllMetricProducers[metricIndex];
632 if (metric->getMetricId() == activeMetric.id()) {
633 VLOG("Setting active metric: %lld", (long long)metric->getMetricId());
634 metric->loadActiveMetric(activeMetric, currentTimeNs);
Tej Singh16ca28f2019-06-24 11:58:23 -0700635 if (!mIsActive && metric->isActive()) {
636 StatsdStats::getInstance().noteActiveStatusChanged(mConfigKey,
637 /*activate=*/ true);
638 }
Muhammad Qureshi844694b2019-04-05 10:10:40 -0700639 mIsActive |= metric->isActive();
Chenjie Yuc7939cb2019-02-04 17:25:45 -0800640 }
641 }
642 }
643}
644
Muhammad Qureshi844694b2019-04-05 10:10:40 -0700645void MetricsManager::writeActiveConfigToProtoOutputStream(
Tej Singhf53d4452019-05-09 18:17:59 -0700646 int64_t currentTimeNs, const DumpReportReason reason, ProtoOutputStream* proto) {
Muhammad Qureshi844694b2019-04-05 10:10:40 -0700647 proto->write(FIELD_TYPE_INT64 | FIELD_ID_ACTIVE_CONFIG_ID, (long long)mConfigKey.GetId());
648 proto->write(FIELD_TYPE_INT32 | FIELD_ID_ACTIVE_CONFIG_UID, mConfigKey.GetUid());
649 for (int metricIndex : mMetricIndexesWithActivation) {
650 const auto& metric = mAllMetricProducers[metricIndex];
651 const uint64_t metricToken = proto->start(FIELD_TYPE_MESSAGE | FIELD_COUNT_REPEATED |
652 FIELD_ID_ACTIVE_CONFIG_METRIC);
Tej Singhf53d4452019-05-09 18:17:59 -0700653 metric->writeActiveMetricToProtoOutputStream(currentTimeNs, reason, proto);
Muhammad Qureshi844694b2019-04-05 10:10:40 -0700654 proto->end(metricToken);
655 }
656}
657
Jeffrey Huangb8f54032020-03-23 13:42:42 -0700658bool MetricsManager::writeMetadataToProto(int64_t currentWallClockTimeNs,
659 int64_t systemElapsedTimeNs,
660 metadata::StatsMetadata* statsMetadata) {
661 bool metadataWritten = false;
662 metadata::ConfigKey* configKey = statsMetadata->mutable_config_key();
663 configKey->set_config_id(mConfigKey.GetId());
664 configKey->set_uid(mConfigKey.GetUid());
665 for (const auto& anomalyTracker : mAllAnomalyTrackers) {
666 metadata::AlertMetadata* alertMetadata = statsMetadata->add_alert_metadata();
667 bool alertWritten = anomalyTracker->writeAlertMetadataToProto(currentWallClockTimeNs,
668 systemElapsedTimeNs, alertMetadata);
669 if (!alertWritten) {
670 statsMetadata->mutable_alert_metadata()->RemoveLast();
671 }
672 metadataWritten |= alertWritten;
673 }
674 return metadataWritten;
675}
Muhammad Qureshi844694b2019-04-05 10:10:40 -0700676
Jeffrey Huang475677e2020-03-30 19:52:07 -0700677void MetricsManager::loadMetadata(const metadata::StatsMetadata& metadata,
678 int64_t currentWallClockTimeNs,
679 int64_t systemElapsedTimeNs) {
680 for (const metadata::AlertMetadata& alertMetadata : metadata.alert_metadata()) {
681 int64_t alertId = alertMetadata.alert_id();
682 auto it = mAlertTrackerMap.find(alertId);
683 if (it == mAlertTrackerMap.end()) {
684 ALOGE("No anomalyTracker found for alertId %lld", (long long) alertId);
685 continue;
686 }
687 mAllAnomalyTrackers[it->second]->loadAlertMetadata(alertMetadata,
688 currentWallClockTimeNs,
689 systemElapsedTimeNs);
690 }
691}
Muhammad Qureshi844694b2019-04-05 10:10:40 -0700692
Yao Chen44cf27c2017-09-14 22:32:50 -0700693} // namespace statsd
694} // namespace os
695} // namespace android