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 | // |
Jim Flynn | 3e9bc19 | 2022-03-23 23:01:26 +0000 | [diff] [blame] | 5 | |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 6 | #pragma once |
| 7 | |
Jim Flynn | 3e9bc19 | 2022-03-23 23:01:26 +0000 | [diff] [blame] | 8 | #include <client/include/CounterStatus.hpp> |
| 9 | #include <client/include/CounterValue.hpp> |
| 10 | #include <client/include/IProfilingService.hpp> |
| 11 | #include <client/include/ISendCounterPacket.hpp> |
Jim Flynn | 2776183 | 2022-03-20 21:52:17 +0000 | [diff] [blame] | 12 | #include <client/include/ISendTimelinePacket.hpp> |
Jim Flynn | 3e9bc19 | 2022-03-23 23:01:26 +0000 | [diff] [blame] | 13 | #include <client/include/ProfilingOptions.hpp> |
| 14 | #include <client/include/Timestamp.hpp> |
Nikhil Raj | 5b1bcc9 | 2021-06-08 12:31:50 +0100 | [diff] [blame] | 15 | |
| 16 | #include <common/include/IProfilingGuidGenerator.hpp> |
Jim Flynn | decd08b | 2022-03-13 22:35:46 +0000 | [diff] [blame] | 17 | #include <common/include/Optional.hpp> |
Nikhil Raj | 5b1bcc9 | 2021-06-08 12:31:50 +0100 | [diff] [blame] | 18 | |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 19 | #include <memory> |
| 20 | #include <vector> |
| 21 | |
Cathal Corbett | 5aa9fd7 | 2022-02-25 15:33:28 +0000 | [diff] [blame] | 22 | namespace arm |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 23 | { |
| 24 | |
Cathal Corbett | 5aa9fd7 | 2022-02-25 15:33:28 +0000 | [diff] [blame] | 25 | namespace pipe |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 26 | { |
| 27 | |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 28 | class IRegisterBackendCounters |
| 29 | { |
| 30 | public: |
Sadik Armagan | 4c99899 | 2020-02-25 12:44:44 +0000 | [diff] [blame] | 31 | virtual void RegisterCategory(const std::string& categoryName) = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 32 | |
Jim Flynn | 9789702 | 2020-02-02 12:52:59 +0000 | [diff] [blame] | 33 | virtual uint16_t RegisterDevice(const std::string& deviceName, |
| 34 | uint16_t cores = 0, |
Jim Flynn | decd08b | 2022-03-13 22:35:46 +0000 | [diff] [blame] | 35 | const arm::pipe::Optional<std::string>& parentCategoryName |
| 36 | = arm::pipe::EmptyOptional()) = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 37 | |
Jim Flynn | 9789702 | 2020-02-02 12:52:59 +0000 | [diff] [blame] | 38 | virtual uint16_t RegisterCounterSet(const std::string& counterSetName, |
| 39 | uint16_t count = 0, |
Jim Flynn | decd08b | 2022-03-13 22:35:46 +0000 | [diff] [blame] | 40 | const arm::pipe::Optional<std::string>& parentCategoryName |
| 41 | = arm::pipe::EmptyOptional()) = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 42 | |
Jim Flynn | 9789702 | 2020-02-02 12:52:59 +0000 | [diff] [blame] | 43 | virtual uint16_t RegisterCounter(const uint16_t uid, |
Jim Flynn | decd08b | 2022-03-13 22:35:46 +0000 | [diff] [blame] | 44 | const std::string& parentCategoryName, |
| 45 | uint16_t counterClass, |
| 46 | uint16_t interpolation, |
| 47 | double multiplier, |
| 48 | const std::string& name, |
| 49 | const std::string& description, |
| 50 | const arm::pipe::Optional<std::string>& units = arm::pipe::EmptyOptional(), |
| 51 | const arm::pipe::Optional<uint16_t>& numberOfCores = arm::pipe::EmptyOptional(), |
| 52 | const arm::pipe::Optional<uint16_t>& deviceUid = arm::pipe::EmptyOptional(), |
| 53 | const arm::pipe::Optional<uint16_t>& counterSetUid = arm::pipe::EmptyOptional()) = 0; |
Jim Flynn | 9789702 | 2020-02-02 12:52:59 +0000 | [diff] [blame] | 54 | |
| 55 | virtual ~IRegisterBackendCounters() {} |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 56 | }; |
| 57 | |
| 58 | class IBackendProfiling |
| 59 | { |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 60 | public: |
Jim Flynn | 3e9bc19 | 2022-03-23 23:01:26 +0000 | [diff] [blame] | 61 | static std::unique_ptr<IBackendProfiling> CreateBackendProfiling(const ProfilingOptions& options, |
| 62 | IProfilingService& profilingService, |
| 63 | const std::string& backendId); |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 64 | virtual ~IBackendProfiling() |
| 65 | {} |
| 66 | |
Colm Donelan | 1aff393 | 2020-02-05 17:48:59 +0000 | [diff] [blame] | 67 | virtual std::unique_ptr<IRegisterBackendCounters> |
James Conroy | 2dcd3fe | 2020-02-06 18:34:52 +0000 | [diff] [blame] | 68 | GetCounterRegistrationInterface(uint16_t currentMaxGlobalCounterID) = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 69 | |
Colm Donelan | 1aff393 | 2020-02-05 17:48:59 +0000 | [diff] [blame] | 70 | virtual std::unique_ptr<ISendTimelinePacket> GetSendTimelinePacket() = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 71 | |
Colm Donelan | 1aff393 | 2020-02-05 17:48:59 +0000 | [diff] [blame] | 72 | virtual IProfilingGuidGenerator& GetProfilingGuidGenerator() = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 73 | |
Colm Donelan | 1aff393 | 2020-02-05 17:48:59 +0000 | [diff] [blame] | 74 | virtual void ReportCounters(const std::vector<Timestamp>& counterValues) = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 75 | |
Colm Donelan | 1aff393 | 2020-02-05 17:48:59 +0000 | [diff] [blame] | 76 | virtual CounterStatus GetCounterStatus(uint16_t backendCounterId) = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 77 | |
Colm Donelan | 1aff393 | 2020-02-05 17:48:59 +0000 | [diff] [blame] | 78 | virtual std::vector<CounterStatus> GetActiveCounters() = 0; |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 79 | |
Colm Donelan | 1aff393 | 2020-02-05 17:48:59 +0000 | [diff] [blame] | 80 | virtual bool IsProfilingEnabled() const = 0; |
| 81 | |
Colm Donelan | e49755b | 2020-01-29 15:22:43 +0000 | [diff] [blame] | 82 | }; |
James Conroy | 2dcd3fe | 2020-02-06 18:34:52 +0000 | [diff] [blame] | 83 | |
Cathal Corbett | 5aa9fd7 | 2022-02-25 15:33:28 +0000 | [diff] [blame] | 84 | } // namespace pipe |
James Conroy | 2dcd3fe | 2020-02-06 18:34:52 +0000 | [diff] [blame] | 85 | |
Jim Flynn | 8de9d44 | 2022-03-07 14:14:28 +0000 | [diff] [blame] | 86 | } // namespace arm |