xref: /aosp_15_r20/frameworks/base/cmds/incidentd/src/Throttler.h (revision d57664e9bc4670b3ecf6748a746a57c557b6bc9e)
1*d57664e9SAndroid Build Coastguard Worker /*
2*d57664e9SAndroid Build Coastguard Worker  * Copyright (C) 2018 The Android Open Source Project
3*d57664e9SAndroid Build Coastguard Worker  *
4*d57664e9SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*d57664e9SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*d57664e9SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*d57664e9SAndroid Build Coastguard Worker  *
8*d57664e9SAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*d57664e9SAndroid Build Coastguard Worker  *
10*d57664e9SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*d57664e9SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*d57664e9SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*d57664e9SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*d57664e9SAndroid Build Coastguard Worker  * limitations under the License.
15*d57664e9SAndroid Build Coastguard Worker  */
16*d57664e9SAndroid Build Coastguard Worker 
17*d57664e9SAndroid Build Coastguard Worker #pragma once
18*d57664e9SAndroid Build Coastguard Worker 
19*d57664e9SAndroid Build Coastguard Worker #include "Reporter.h"
20*d57664e9SAndroid Build Coastguard Worker 
21*d57664e9SAndroid Build Coastguard Worker #include <utils/RefBase.h>
22*d57664e9SAndroid Build Coastguard Worker 
23*d57664e9SAndroid Build Coastguard Worker #include <vector>
24*d57664e9SAndroid Build Coastguard Worker #include <unistd.h>
25*d57664e9SAndroid Build Coastguard Worker 
26*d57664e9SAndroid Build Coastguard Worker namespace android {
27*d57664e9SAndroid Build Coastguard Worker namespace os {
28*d57664e9SAndroid Build Coastguard Worker namespace incidentd {
29*d57664e9SAndroid Build Coastguard Worker 
30*d57664e9SAndroid Build Coastguard Worker /**
31*d57664e9SAndroid Build Coastguard Worker  * This is a size-based throttler which prevents incidentd to take more data.
32*d57664e9SAndroid Build Coastguard Worker  */
33*d57664e9SAndroid Build Coastguard Worker class Throttler : public virtual android::RefBase {
34*d57664e9SAndroid Build Coastguard Worker public:
35*d57664e9SAndroid Build Coastguard Worker     Throttler(size_t limit, int64_t refractoryPeriodMs);
36*d57664e9SAndroid Build Coastguard Worker     ~Throttler();
37*d57664e9SAndroid Build Coastguard Worker 
38*d57664e9SAndroid Build Coastguard Worker     /**
39*d57664e9SAndroid Build Coastguard Worker      * Return a batch containing reports, if any that should be executed.
40*d57664e9SAndroid Build Coastguard Worker      * Those will be removed from 'queued'.
41*d57664e9SAndroid Build Coastguard Worker      */
42*d57664e9SAndroid Build Coastguard Worker     sp<ReportBatch> filterBatch(const sp<ReportBatch>& queued);
43*d57664e9SAndroid Build Coastguard Worker 
44*d57664e9SAndroid Build Coastguard Worker     bool shouldThrottle();
45*d57664e9SAndroid Build Coastguard Worker 
46*d57664e9SAndroid Build Coastguard Worker     void addReportSize(size_t reportByteSize);
47*d57664e9SAndroid Build Coastguard Worker 
48*d57664e9SAndroid Build Coastguard Worker     void dump(FILE* out);
49*d57664e9SAndroid Build Coastguard Worker 
50*d57664e9SAndroid Build Coastguard Worker private:
51*d57664e9SAndroid Build Coastguard Worker     const size_t mSizeLimit;
52*d57664e9SAndroid Build Coastguard Worker     const int64_t mRefractoryPeriodMs;
53*d57664e9SAndroid Build Coastguard Worker 
54*d57664e9SAndroid Build Coastguard Worker     size_t mAccumulatedSize;
55*d57664e9SAndroid Build Coastguard Worker     int64_t mLastRefractoryMs;
56*d57664e9SAndroid Build Coastguard Worker };
57*d57664e9SAndroid Build Coastguard Worker 
58*d57664e9SAndroid Build Coastguard Worker }  // namespace incidentd
59*d57664e9SAndroid Build Coastguard Worker }  // namespace os
60*d57664e9SAndroid Build Coastguard Worker }  // namespace android
61