1 /*
2  * Copyright (c) 2023 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 #ifdef HAS_HIPERF
16 #ifndef INTERFACES_INNER_API_UNIFIED_COLLECTION_UTILITY_PERF_COLLECTOR_H
17 #define INTERFACES_INNER_API_UNIFIED_COLLECTION_UTILITY_PERF_COLLECTOR_H
18 #include <string>
19 #include <vector>
20 
21 #include "collect_result.h"
22 
23 namespace OHOS {
24 namespace HiviewDFX {
25 namespace UCollectUtil {
26 class PerfCollector {
27 public:
28     PerfCollector() = default;
29     virtual ~PerfCollector() = default;
30     virtual CollectResult<bool> StartPerf(const std::string &logDir) = 0;
31     virtual void SetSelectPids(const std::vector<pid_t> &selectPids) = 0;
32     virtual void SetTargetSystemWide(bool enable) = 0;
33     virtual void SetTimeStopSec(int timeStopSec) = 0;
34     virtual void SetFrequency(int frequency) = 0;
35     virtual void SetOffCPU(bool offCPU) = 0;
36     virtual void SetOutputFilename(const std::string &outputFilename) = 0;
37     virtual void SetCallGraph(const std::string &sampleTypes) = 0;
38     virtual void SetSelectEvents(const std::vector<std::string> &selectEvents) = 0;
39     virtual void SetCpuPercent(int cpuPercent) = 0;
40     virtual void SetReport(bool enable) = 0;
41     // for prepare recod mode
42     virtual CollectResult<bool> Prepare(const std::string &logDir) = 0;
43     virtual CollectResult<bool> StartRun() = 0;
44     virtual CollectResult<bool> Pause() = 0;
45     virtual CollectResult<bool> Resume() = 0;
46     virtual CollectResult<bool> Stop() = 0;
47     static std::shared_ptr<PerfCollector> Create();
48 };
49 } // UCollectUtil
50 } // HivewDFX
51 } // OHOS
52 #endif // INTERFACES_INNER_API_UNIFIED_COLLECTION_UTILITY_PERF_COLLECTOR_H
53 #endif // HAS_HIPERF
54