| // Copyright (C) 2017 The Android Open Source Project |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| |
| #pragma once |
| |
| #include <aidl/android/os/BnPullAtomCallback.h> |
| #include <aidl/android/os/IPullAtomCallback.h> |
| #include <aidl/android/os/IPullAtomResultReceiver.h> |
| #include <gtest/gtest.h> |
| |
| #include "frameworks/base/cmds/statsd/src/stats_log.pb.h" |
| #include "frameworks/base/cmds/statsd/src/statsd_config.pb.h" |
| #include "src/StatsLogProcessor.h" |
| #include "src/hash.h" |
| #include "src/logd/LogEvent.h" |
| #include "src/stats_log_util.h" |
| #include "stats_event.h" |
| #include "statslog_statsdtest.h" |
| |
| namespace android { |
| namespace os { |
| namespace statsd { |
| |
| using ::aidl::android::os::BnPullAtomCallback; |
| using ::aidl::android::os::IPullAtomCallback; |
| using ::aidl::android::os::IPullAtomResultReceiver; |
| using android::util::ProtoReader; |
| using google::protobuf::RepeatedPtrField; |
| using Status = ::ndk::ScopedAStatus; |
| |
| const int SCREEN_STATE_ATOM_ID = util::SCREEN_STATE_CHANGED; |
| const int UID_PROCESS_STATE_ATOM_ID = util::UID_PROCESS_STATE_CHANGED; |
| |
| enum BucketSplitEvent { APP_UPGRADE, BOOT_COMPLETE }; |
| |
| // Converts a ProtoOutputStream to a StatsLogReport proto. |
| StatsLogReport outputStreamToProto(ProtoOutputStream* proto); |
| |
| // Create AtomMatcher proto to simply match a specific atom type. |
| AtomMatcher CreateSimpleAtomMatcher(const string& name, int atomId); |
| |
| // Create AtomMatcher proto for temperature atom. |
| AtomMatcher CreateTemperatureAtomMatcher(); |
| |
| // Create AtomMatcher proto for scheduled job state changed. |
| AtomMatcher CreateScheduledJobStateChangedAtomMatcher(); |
| |
| // Create AtomMatcher proto for starting a scheduled job. |
| AtomMatcher CreateStartScheduledJobAtomMatcher(); |
| |
| // Create AtomMatcher proto for a scheduled job is done. |
| AtomMatcher CreateFinishScheduledJobAtomMatcher(); |
| |
| // Create AtomMatcher proto for screen brightness state changed. |
| AtomMatcher CreateScreenBrightnessChangedAtomMatcher(); |
| |
| // Create AtomMatcher proto for starting battery save mode. |
| AtomMatcher CreateBatterySaverModeStartAtomMatcher(); |
| |
| // Create AtomMatcher proto for stopping battery save mode. |
| AtomMatcher CreateBatterySaverModeStopAtomMatcher(); |
| |
| // Create AtomMatcher proto for battery state none mode. |
| AtomMatcher CreateBatteryStateNoneMatcher(); |
| |
| // Create AtomMatcher proto for battery state usb mode. |
| AtomMatcher CreateBatteryStateUsbMatcher(); |
| |
| // Create AtomMatcher proto for process state changed. |
| AtomMatcher CreateUidProcessStateChangedAtomMatcher(); |
| |
| // Create AtomMatcher proto for acquiring wakelock. |
| AtomMatcher CreateAcquireWakelockAtomMatcher(); |
| |
| // Create AtomMatcher proto for releasing wakelock. |
| AtomMatcher CreateReleaseWakelockAtomMatcher() ; |
| |
| // Create AtomMatcher proto for screen turned on. |
| AtomMatcher CreateScreenTurnedOnAtomMatcher(); |
| |
| // Create AtomMatcher proto for screen turned off. |
| AtomMatcher CreateScreenTurnedOffAtomMatcher(); |
| |
| // Create AtomMatcher proto for app sync turned on. |
| AtomMatcher CreateSyncStartAtomMatcher(); |
| |
| // Create AtomMatcher proto for app sync turned off. |
| AtomMatcher CreateSyncEndAtomMatcher(); |
| |
| // Create AtomMatcher proto for app sync moves to background. |
| AtomMatcher CreateMoveToBackgroundAtomMatcher(); |
| |
| // Create AtomMatcher proto for app sync moves to foreground. |
| AtomMatcher CreateMoveToForegroundAtomMatcher(); |
| |
| // Create AtomMatcher proto for process crashes |
| AtomMatcher CreateProcessCrashAtomMatcher() ; |
| |
| // Create Predicate proto for screen is on. |
| Predicate CreateScreenIsOnPredicate(); |
| |
| // Create Predicate proto for screen is off. |
| Predicate CreateScreenIsOffPredicate(); |
| |
| // Create Predicate proto for a running scheduled job. |
| Predicate CreateScheduledJobPredicate(); |
| |
| // Create Predicate proto for battery saver mode. |
| Predicate CreateBatterySaverModePredicate(); |
| |
| // Create Predicate proto for device unplogged mode. |
| Predicate CreateDeviceUnpluggedPredicate(); |
| |
| // Create Predicate proto for holding wakelock. |
| Predicate CreateHoldingWakelockPredicate(); |
| |
| // Create a Predicate proto for app syncing. |
| Predicate CreateIsSyncingPredicate(); |
| |
| // Create a Predicate proto for app is in background. |
| Predicate CreateIsInBackgroundPredicate(); |
| |
| // Create State proto for screen state atom. |
| State CreateScreenState(); |
| |
| // Create State proto for uid process state atom. |
| State CreateUidProcessState(); |
| |
| // Create State proto for overlay state atom. |
| State CreateOverlayState(); |
| |
| State CreateScreenStateWithOnOffMap(int64_t screenOnId, int64_t screenOffId); |
| |
| // Create StateGroup proto for ScreenState ON group |
| StateMap_StateGroup CreateScreenStateOnGroup(int64_t screenOnId); |
| |
| // Create StateGroup proto for ScreenState OFF group |
| StateMap_StateGroup CreateScreenStateOffGroup(int64_t screenOffId); |
| |
| // Create StateMap proto for ScreenState ON/OFF map |
| StateMap CreateScreenStateOnOffMap(int64_t screenOnId, int64_t screenOffId); |
| |
| // Add a predicate to the predicate combination. |
| void addPredicateToPredicateCombination(const Predicate& predicate, Predicate* combination); |
| |
| // Create dimensions from primitive fields. |
| FieldMatcher CreateDimensions(const int atomId, const std::vector<int>& fields); |
| |
| // Create dimensions by attribution uid and tag. |
| FieldMatcher CreateAttributionUidAndTagDimensions(const int atomId, |
| const std::vector<Position>& positions); |
| |
| // Create dimensions by attribution uid only. |
| FieldMatcher CreateAttributionUidDimensions(const int atomId, |
| const std::vector<Position>& positions); |
| |
| FieldMatcher CreateAttributionUidAndOtherDimensions(const int atomId, |
| const std::vector<Position>& positions, |
| const std::vector<int>& fields); |
| |
| // START: get primary key functions |
| // These functions take in atom field information and create FieldValues which are stored in the |
| // given HashableDimensionKey. |
| void getUidProcessKey(int uid, HashableDimensionKey* key); |
| |
| void getOverlayKey(int uid, string packageName, HashableDimensionKey* key); |
| |
| void getPartialWakelockKey(int uid, const std::string& tag, HashableDimensionKey* key); |
| |
| void getPartialWakelockKey(int uid, HashableDimensionKey* key); |
| // END: get primary key functions |
| |
| void writeAttribution(AStatsEvent* statsEvent, const vector<int>& attributionUids, |
| const vector<string>& attributionTags); |
| |
| // Builds statsEvent to get buffer that is parsed into logEvent then releases statsEvent. |
| void parseStatsEventToLogEvent(AStatsEvent* statsEvent, LogEvent* logEvent); |
| |
| shared_ptr<LogEvent> CreateTwoValueLogEvent(int atomId, int64_t eventTimeNs, int32_t value1, |
| int32_t value2); |
| |
| void CreateTwoValueLogEvent(LogEvent* logEvent, int atomId, int64_t eventTimeNs, int32_t value1, |
| int32_t value2); |
| |
| shared_ptr<LogEvent> CreateThreeValueLogEvent(int atomId, int64_t eventTimeNs, int32_t value1, |
| int32_t value2, int32_t value3); |
| |
| void CreateThreeValueLogEvent(LogEvent* logEvent, int atomId, int64_t eventTimeNs, int32_t value1, |
| int32_t value2, int32_t value3); |
| |
| // The repeated value log event helpers create a log event with two int fields, both |
| // set to the same value. This is useful for testing metrics that are only interested |
| // in the value of the second field but still need the first field to be populated. |
| std::shared_ptr<LogEvent> CreateRepeatedValueLogEvent(int atomId, int64_t eventTimeNs, |
| int32_t value); |
| |
| void CreateRepeatedValueLogEvent(LogEvent* logEvent, int atomId, int64_t eventTimeNs, |
| int32_t value); |
| |
| std::shared_ptr<LogEvent> CreateNoValuesLogEvent(int atomId, int64_t eventTimeNs); |
| |
| void CreateNoValuesLogEvent(LogEvent* logEvent, int atomId, int64_t eventTimeNs); |
| |
| // Create log event for screen state changed. |
| std::unique_ptr<LogEvent> CreateScreenStateChangedEvent( |
| uint64_t timestampNs, const android::view::DisplayStateEnum state); |
| |
| // Create log event for screen brightness state changed. |
| std::unique_ptr<LogEvent> CreateScreenBrightnessChangedEvent(uint64_t timestampNs, int level); |
| |
| // Create log event when scheduled job starts. |
| std::unique_ptr<LogEvent> CreateStartScheduledJobEvent(uint64_t timestampNs, |
| const vector<int>& attributionUids, |
| const vector<string>& attributionTags, |
| const string& jobName); |
| |
| // Create log event when scheduled job finishes. |
| std::unique_ptr<LogEvent> CreateFinishScheduledJobEvent(uint64_t timestampNs, |
| const vector<int>& attributionUids, |
| const vector<string>& attributionTags, |
| const string& jobName); |
| |
| // Create log event when battery saver starts. |
| std::unique_ptr<LogEvent> CreateBatterySaverOnEvent(uint64_t timestampNs); |
| // Create log event when battery saver stops. |
| std::unique_ptr<LogEvent> CreateBatterySaverOffEvent(uint64_t timestampNs); |
| |
| // Create log event when battery state changes. |
| std::unique_ptr<LogEvent> CreateBatteryStateChangedEvent(const uint64_t timestampNs, const BatteryPluggedStateEnum state); |
| |
| // Create log event for app moving to background. |
| std::unique_ptr<LogEvent> CreateMoveToBackgroundEvent(uint64_t timestampNs, const int uid); |
| |
| // Create log event for app moving to foreground. |
| std::unique_ptr<LogEvent> CreateMoveToForegroundEvent(uint64_t timestampNs, const int uid); |
| |
| // Create log event when the app sync starts. |
| std::unique_ptr<LogEvent> CreateSyncStartEvent(uint64_t timestampNs, const vector<int>& uids, |
| const vector<string>& tags, const string& name); |
| |
| // Create log event when the app sync ends. |
| std::unique_ptr<LogEvent> CreateSyncEndEvent(uint64_t timestampNs, const vector<int>& uids, |
| const vector<string>& tags, const string& name); |
| |
| // Create log event when the app sync ends. |
| std::unique_ptr<LogEvent> CreateAppCrashEvent(uint64_t timestampNs, const int uid); |
| |
| // Create log event for an app crash. |
| std::unique_ptr<LogEvent> CreateAppCrashOccurredEvent(uint64_t timestampNs, const int uid); |
| |
| // Create log event for acquiring wakelock. |
| std::unique_ptr<LogEvent> CreateAcquireWakelockEvent(uint64_t timestampNs, const vector<int>& uids, |
| const vector<string>& tags, |
| const string& wakelockName); |
| |
| // Create log event for releasing wakelock. |
| std::unique_ptr<LogEvent> CreateReleaseWakelockEvent(uint64_t timestampNs, const vector<int>& uids, |
| const vector<string>& tags, |
| const string& wakelockName); |
| |
| // Create log event for releasing wakelock. |
| std::unique_ptr<LogEvent> CreateIsolatedUidChangedEvent(uint64_t timestampNs, int hostUid, |
| int isolatedUid, bool is_create); |
| |
| // Create log event for uid process state change. |
| std::unique_ptr<LogEvent> CreateUidProcessStateChangedEvent( |
| uint64_t timestampNs, int uid, const android::app::ProcessStateEnum state); |
| |
| std::unique_ptr<LogEvent> CreateBleScanStateChangedEvent(uint64_t timestampNs, |
| const vector<int>& attributionUids, |
| const vector<string>& attributionTags, |
| const BleScanStateChanged::State state, |
| const bool filtered, const bool firstMatch, |
| const bool opportunistic); |
| |
| std::unique_ptr<LogEvent> CreateOverlayStateChangedEvent(int64_t timestampNs, const int32_t uid, |
| const string& packageName, |
| const bool usingAlertWindow, |
| const OverlayStateChanged::State state); |
| |
| // Create a statsd log event processor upon the start time in seconds, config and key. |
| sp<StatsLogProcessor> CreateStatsLogProcessor(const int64_t timeBaseNs, const int64_t currentTimeNs, |
| const StatsdConfig& config, const ConfigKey& key, |
| const shared_ptr<IPullAtomCallback>& puller = nullptr, |
| const int32_t atomTag = 0 /*for puller only*/); |
| |
| // Util function to sort the log events by timestamp. |
| void sortLogEventsByTimestamp(std::vector<std::unique_ptr<LogEvent>> *events); |
| |
| int64_t StringToId(const string& str); |
| |
| void ValidateWakelockAttributionUidAndTagDimension(const DimensionsValue& value, const int atomId, |
| const int uid, const string& tag); |
| void ValidateUidDimension(const DimensionsValue& value, int node_idx, int atomId, int uid); |
| void ValidateAttributionUidDimension(const DimensionsValue& value, int atomId, int uid); |
| void ValidateAttributionUidAndTagDimension( |
| const DimensionsValue& value, int atomId, int uid, const std::string& tag); |
| void ValidateAttributionUidAndTagDimension( |
| const DimensionsValue& value, int node_idx, int atomId, int uid, const std::string& tag); |
| |
| struct DimensionsPair { |
| DimensionsPair(DimensionsValue m1, google::protobuf::RepeatedPtrField<StateValue> m2) |
| : dimInWhat(m1), stateValues(m2){}; |
| |
| DimensionsValue dimInWhat; |
| google::protobuf::RepeatedPtrField<StateValue> stateValues; |
| }; |
| |
| bool LessThan(const StateValue& s1, const StateValue& s2); |
| bool LessThan(const DimensionsValue& s1, const DimensionsValue& s2); |
| bool LessThan(const DimensionsPair& s1, const DimensionsPair& s2); |
| |
| |
| void backfillStartEndTimestamp(ConfigMetricsReport *config_report); |
| void backfillStartEndTimestamp(ConfigMetricsReportList *config_report_list); |
| |
| void backfillStringInReport(ConfigMetricsReportList *config_report_list); |
| void backfillStringInDimension(const std::map<uint64_t, string>& str_map, |
| DimensionsValue* dimension); |
| |
| template <typename T> |
| void backfillStringInDimension(const std::map<uint64_t, string>& str_map, |
| T* metrics) { |
| for (int i = 0; i < metrics->data_size(); ++i) { |
| auto data = metrics->mutable_data(i); |
| if (data->has_dimensions_in_what()) { |
| backfillStringInDimension(str_map, data->mutable_dimensions_in_what()); |
| } |
| if (data->has_dimensions_in_condition()) { |
| backfillStringInDimension(str_map, data->mutable_dimensions_in_condition()); |
| } |
| } |
| } |
| |
| void backfillDimensionPath(ConfigMetricsReportList* config_report_list); |
| |
| bool backfillDimensionPath(const DimensionsValue& path, |
| const google::protobuf::RepeatedPtrField<DimensionsValue>& leafValues, |
| DimensionsValue* dimension); |
| |
| class FakeSubsystemSleepCallback : public BnPullAtomCallback { |
| public: |
| Status onPullAtom(int atomTag, |
| const shared_ptr<IPullAtomResultReceiver>& resultReceiver) override; |
| }; |
| |
| template <typename T> |
| void backfillDimensionPath(const DimensionsValue& whatPath, |
| const DimensionsValue& conditionPath, |
| T* metricData) { |
| for (int i = 0; i < metricData->data_size(); ++i) { |
| auto data = metricData->mutable_data(i); |
| if (data->dimension_leaf_values_in_what_size() > 0) { |
| backfillDimensionPath(whatPath, data->dimension_leaf_values_in_what(), |
| data->mutable_dimensions_in_what()); |
| data->clear_dimension_leaf_values_in_what(); |
| } |
| if (data->dimension_leaf_values_in_condition_size() > 0) { |
| backfillDimensionPath(conditionPath, data->dimension_leaf_values_in_condition(), |
| data->mutable_dimensions_in_condition()); |
| data->clear_dimension_leaf_values_in_condition(); |
| } |
| } |
| } |
| |
| struct DimensionCompare { |
| bool operator()(const DimensionsPair& s1, const DimensionsPair& s2) const { |
| return LessThan(s1, s2); |
| } |
| }; |
| |
| template <typename T> |
| void sortMetricDataByDimensionsValue(const T& metricData, T* sortedMetricData) { |
| std::map<DimensionsPair, int, DimensionCompare> dimensionIndexMap; |
| for (int i = 0; i < metricData.data_size(); ++i) { |
| dimensionIndexMap.insert( |
| std::make_pair(DimensionsPair(metricData.data(i).dimensions_in_what(), |
| metricData.data(i).slice_by_state()), |
| i)); |
| } |
| for (const auto& itr : dimensionIndexMap) { |
| *sortedMetricData->add_data() = metricData.data(itr.second); |
| } |
| } |
| |
| template <typename T> |
| void backfillStartEndTimestampForFullBucket( |
| const int64_t timeBaseNs, const int64_t bucketSizeNs, T* bucket) { |
| bucket->set_start_bucket_elapsed_nanos(timeBaseNs + bucketSizeNs * bucket->bucket_num()); |
| bucket->set_end_bucket_elapsed_nanos( |
| timeBaseNs + bucketSizeNs * bucket->bucket_num() + bucketSizeNs); |
| bucket->clear_bucket_num(); |
| } |
| |
| template <typename T> |
| void backfillStartEndTimestampForPartialBucket(const int64_t timeBaseNs, T* bucket) { |
| if (bucket->has_start_bucket_elapsed_millis()) { |
| bucket->set_start_bucket_elapsed_nanos( |
| MillisToNano(bucket->start_bucket_elapsed_millis())); |
| bucket->clear_start_bucket_elapsed_millis(); |
| } |
| if (bucket->has_end_bucket_elapsed_millis()) { |
| bucket->set_end_bucket_elapsed_nanos( |
| MillisToNano(bucket->end_bucket_elapsed_millis())); |
| bucket->clear_end_bucket_elapsed_millis(); |
| } |
| } |
| |
| template <typename T> |
| void backfillStartEndTimestampForMetrics(const int64_t timeBaseNs, const int64_t bucketSizeNs, |
| T* metrics) { |
| for (int i = 0; i < metrics->data_size(); ++i) { |
| auto data = metrics->mutable_data(i); |
| for (int j = 0; j < data->bucket_info_size(); ++j) { |
| auto bucket = data->mutable_bucket_info(j); |
| if (bucket->has_bucket_num()) { |
| backfillStartEndTimestampForFullBucket(timeBaseNs, bucketSizeNs, bucket); |
| } else { |
| backfillStartEndTimestampForPartialBucket(timeBaseNs, bucket); |
| } |
| } |
| } |
| } |
| |
| template <typename T> |
| void backfillStartEndTimestampForSkippedBuckets(const int64_t timeBaseNs, T* metrics) { |
| for (int i = 0; i < metrics->skipped_size(); ++i) { |
| backfillStartEndTimestampForPartialBucket(timeBaseNs, metrics->mutable_skipped(i)); |
| } |
| } |
| } // namespace statsd |
| } // namespace os |
| } // namespace android |