Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 1 | // |
| 2 | // Copyright © 2020 Arm Ltd. All rights reserved. |
| 3 | // SPDX-License-Identifier: MIT |
| 4 | // |
| 5 | #pragma once |
| 6 | |
Jim Flynn | 2776183 | 2022-03-20 21:52:17 +0000 | [diff] [blame^] | 7 | #include <client/include/ISendTimelinePacket.hpp> |
Nikhil Raj | 5b1bcc9 | 2021-06-08 12:31:50 +0100 | [diff] [blame] | 8 | |
| 9 | #include <common/include/IProfilingGuidGenerator.hpp> |
Jim Flynn | decd08b | 2022-03-13 22:35:46 +0000 | [diff] [blame] | 10 | #include <common/include/Optional.hpp> |
Nikhil Raj | 5b1bcc9 | 2021-06-08 12:31:50 +0100 | [diff] [blame] | 11 | |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 12 | #include <memory> |
| 13 | #include <vector> |
| 14 | |
Cathal Corbett | 5aa9fd7 | 2022-02-25 15:33:28 +0000 | [diff] [blame] | 15 | namespace arm |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 16 | { |
| 17 | |
Cathal Corbett | 5aa9fd7 | 2022-02-25 15:33:28 +0000 | [diff] [blame] | 18 | namespace pipe |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 19 | { |
| 20 | |
| 21 | struct CounterValue |
| 22 | { |
Sadik Armagan | cab588a | 2020-02-17 11:33:31 +0000 | [diff] [blame] | 23 | CounterValue(uint16_t id, uint32_t value) : |
| 24 | counterId(id), counterValue(value) {} |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 25 | uint16_t counterId; |
| 26 | uint32_t counterValue; |
| 27 | }; |
| 28 | |
| 29 | struct Timestamp |
| 30 | { |
| 31 | uint64_t timestamp; |
| 32 | std::vector<CounterValue> counterValues; |
| 33 | }; |
| 34 | |
| 35 | struct CounterStatus |
| 36 | { |
James Conroy | 2dcd3fe | 2020-02-06 18:34:52 +0000 | [diff] [blame] | 37 | CounterStatus(uint16_t backendCounterId, |
| 38 | uint16_t globalCounterId, |
| 39 | bool enabled, |
| 40 | uint32_t samplingRateInMicroseconds) |
| 41 | : m_BackendCounterId(backendCounterId), |
| 42 | m_GlobalCounterId(globalCounterId), |
| 43 | m_Enabled(enabled), |
| 44 | m_SamplingRateInMicroseconds(samplingRateInMicroseconds) {} |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 45 | uint16_t m_BackendCounterId; |
| 46 | uint16_t m_GlobalCounterId; |
| 47 | bool m_Enabled; |
| 48 | uint32_t m_SamplingRateInMicroseconds; |
| 49 | }; |
| 50 | |
| 51 | class IRegisterBackendCounters |
| 52 | { |
| 53 | public: |
Sadik Armagan | 4c99899 | 2020-02-25 12:44:44 +0000 | [diff] [blame] | 54 | virtual void RegisterCategory(const std::string& categoryName) = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 55 | |
Jim Flynn | 9789702 | 2020-02-02 12:52:59 +0000 | [diff] [blame] | 56 | virtual uint16_t RegisterDevice(const std::string& deviceName, |
| 57 | uint16_t cores = 0, |
Jim Flynn | decd08b | 2022-03-13 22:35:46 +0000 | [diff] [blame] | 58 | const arm::pipe::Optional<std::string>& parentCategoryName |
| 59 | = arm::pipe::EmptyOptional()) = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 60 | |
Jim Flynn | 9789702 | 2020-02-02 12:52:59 +0000 | [diff] [blame] | 61 | virtual uint16_t RegisterCounterSet(const std::string& counterSetName, |
| 62 | uint16_t count = 0, |
Jim Flynn | decd08b | 2022-03-13 22:35:46 +0000 | [diff] [blame] | 63 | const arm::pipe::Optional<std::string>& parentCategoryName |
| 64 | = arm::pipe::EmptyOptional()) = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 65 | |
Jim Flynn | 9789702 | 2020-02-02 12:52:59 +0000 | [diff] [blame] | 66 | virtual uint16_t RegisterCounter(const uint16_t uid, |
Jim Flynn | decd08b | 2022-03-13 22:35:46 +0000 | [diff] [blame] | 67 | const std::string& parentCategoryName, |
| 68 | uint16_t counterClass, |
| 69 | uint16_t interpolation, |
| 70 | double multiplier, |
| 71 | const std::string& name, |
| 72 | const std::string& description, |
| 73 | const arm::pipe::Optional<std::string>& units = arm::pipe::EmptyOptional(), |
| 74 | const arm::pipe::Optional<uint16_t>& numberOfCores = arm::pipe::EmptyOptional(), |
| 75 | const arm::pipe::Optional<uint16_t>& deviceUid = arm::pipe::EmptyOptional(), |
| 76 | const arm::pipe::Optional<uint16_t>& counterSetUid = arm::pipe::EmptyOptional()) = 0; |
Jim Flynn | 9789702 | 2020-02-02 12:52:59 +0000 | [diff] [blame] | 77 | |
| 78 | virtual ~IRegisterBackendCounters() {} |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 79 | }; |
| 80 | |
| 81 | class IBackendProfiling |
| 82 | { |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 83 | public: |
| 84 | virtual ~IBackendProfiling() |
| 85 | {} |
| 86 | |
Colm Donelan | 1aff393 | 2020-02-05 17:48:59 +0000 | [diff] [blame] | 87 | virtual std::unique_ptr<IRegisterBackendCounters> |
James Conroy | 2dcd3fe | 2020-02-06 18:34:52 +0000 | [diff] [blame] | 88 | GetCounterRegistrationInterface(uint16_t currentMaxGlobalCounterID) = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 89 | |
Colm Donelan | 1aff393 | 2020-02-05 17:48:59 +0000 | [diff] [blame] | 90 | virtual std::unique_ptr<ISendTimelinePacket> GetSendTimelinePacket() = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 91 | |
Colm Donelan | 1aff393 | 2020-02-05 17:48:59 +0000 | [diff] [blame] | 92 | virtual IProfilingGuidGenerator& GetProfilingGuidGenerator() = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 93 | |
Colm Donelan | 1aff393 | 2020-02-05 17:48:59 +0000 | [diff] [blame] | 94 | virtual void ReportCounters(const std::vector<Timestamp>& counterValues) = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 95 | |
Colm Donelan | 1aff393 | 2020-02-05 17:48:59 +0000 | [diff] [blame] | 96 | virtual CounterStatus GetCounterStatus(uint16_t backendCounterId) = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 97 | |
Colm Donelan | 1aff393 | 2020-02-05 17:48:59 +0000 | [diff] [blame] | 98 | virtual std::vector<CounterStatus> GetActiveCounters() = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 99 | |
Colm Donelan | 1aff393 | 2020-02-05 17:48:59 +0000 | [diff] [blame] | 100 | virtual bool IsProfilingEnabled() const = 0; |
| 101 | |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 102 | }; |
James Conroy | 2dcd3fe | 2020-02-06 18:34:52 +0000 | [diff] [blame] | 103 | |
Cathal Corbett | 5aa9fd7 | 2022-02-25 15:33:28 +0000 | [diff] [blame] | 104 | } // namespace pipe |
James Conroy | 2dcd3fe | 2020-02-06 18:34:52 +0000 | [diff] [blame] | 105 | |
Jim Flynn | 8de9d44 | 2022-03-07 14:14:28 +0000 | [diff] [blame] | 106 | } // namespace arm |