| /* |
| * 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 "condition/condition_util.h" |
| #include "frameworks/base/cmds/statsd/src/statsd_config.pb.h" |
| #include "matchers/LogMatchingTracker.h" |
| #include "matchers/matcher_util.h" |
| |
| #include <log/logprint.h> |
| #include <utils/RefBase.h> |
| |
| #include <unordered_map> |
| |
| namespace android { |
| namespace os { |
| namespace statsd { |
| |
| class ConditionTracker : public virtual RefBase { |
| public: |
| ConditionTracker(const std::string& name, const int index) |
| : mName(name), |
| mIndex(index), |
| mInitialized(false), |
| mTrackerIndex(), |
| mNonSlicedConditionState(ConditionState::kUnknown), |
| mSliced(false){}; |
| |
| virtual ~ConditionTracker(){}; |
| |
| // Initialize this ConditionTracker. This initialization is done recursively (DFS). It can also |
| // be done in the constructor, but we do it separately because (1) easy to return a bool to |
| // indicate whether the initialization is successful. (2) makes unit test easier. |
| // allConditionConfig: the list of all Condition config from statsd_config. |
| // allConditionTrackers: the list of all ConditionTrackers (this is needed because we may also |
| // need to call init() on children conditions) |
| // conditionNameIndexMap: the mapping from condition name to its index. |
| // stack: a bit map to keep track which nodes have been visited on the stack in the recursion. |
| virtual bool init(const std::vector<Condition>& allConditionConfig, |
| const std::vector<sp<ConditionTracker>>& allConditionTrackers, |
| const std::unordered_map<std::string, int>& conditionNameIndexMap, |
| std::vector<bool>& stack) = 0; |
| |
| // evaluate current condition given the new event. |
| // return true if the condition state changed, false if the condition state is not changed. |
| // event: the new log event |
| // eventMatcherValues: the results of the LogMatcherTrackers. LogMatcherTrackers always process |
| // event before ConditionTrackers, because ConditionTracker depends on |
| // LogMatchingTrackers. |
| // mAllConditions: the list of all ConditionTracker |
| // conditionCache: the cached non-sliced condition of the ConditionTrackers for this new event. |
| // nonSlicedConditionChanged: the bit map to record whether non-sliced condition has changed. |
| // slicedConditionMayChanged: the bit map to record whether sliced condition may have changed. |
| // Because sliced condition needs parameters to determine the value. So the sliced |
| // condition is not pushed to metrics. We only inform the relevant metrics that the sliced |
| // condition may have changed, and metrics should pull the conditions that they are |
| // interested in. |
| virtual bool evaluateCondition(const LogEvent& event, |
| const std::vector<MatchingState>& eventMatcherValues, |
| const std::vector<sp<ConditionTracker>>& mAllConditions, |
| std::vector<ConditionState>& conditionCache, |
| std::vector<bool>& nonSlicedConditionChanged, |
| std::vector<bool>& slicedConditionMayChanged) = 0; |
| |
| // Return the current condition state. |
| virtual ConditionState isConditionMet() { |
| return mNonSlicedConditionState; |
| }; |
| |
| // Query the condition with parameters. |
| // [conditionParameters]: a map from condition name to the HashableDimensionKey to query the |
| // condition. |
| // [allConditions]: all condition trackers. This is needed because the condition evaluation is |
| // done recursively |
| // [conditionCache]: the cache holding the condition evaluation values. |
| virtual void isConditionMet( |
| const std::map<std::string, HashableDimensionKey>& conditionParameters, |
| const std::vector<sp<ConditionTracker>>& allConditions, |
| std::vector<ConditionState>& conditionCache) = 0; |
| |
| // return the list of LogMatchingTracker index that this ConditionTracker uses. |
| virtual const std::set<int>& getLogTrackerIndex() const { |
| return mTrackerIndex; |
| } |
| |
| virtual void setSliced(bool sliced) { |
| mSliced = mSliced | sliced; |
| } |
| |
| protected: |
| // We don't really need the string name, but having a name here makes log messages |
| // easy to debug. |
| const std::string mName; |
| |
| // the index of this condition in the manager's condition list. |
| const int mIndex; |
| |
| // if it's properly initialized. |
| bool mInitialized; |
| |
| // the list of LogMatchingTracker index that this ConditionTracker uses. |
| std::set<int> mTrackerIndex; |
| |
| ConditionState mNonSlicedConditionState; |
| |
| bool mSliced; |
| }; |
| |
| } // namespace statsd |
| } // namespace os |
| } // namespace android |
| |