Viet-Hoa Do | 3389f53 | 2023-07-05 17:36:40 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2023 Arm Limited. |
| 3 | * |
| 4 | * SPDX-License-Identifier: MIT |
| 5 | * |
| 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | * of this software and associated documentation files (the "Software"), to |
| 8 | * deal in the Software without restriction, including without limitation the |
| 9 | * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
| 10 | * sell copies of the Software, and to permit persons to whom the Software is |
| 11 | * furnished to do so, subject to the following conditions: |
| 12 | * |
| 13 | * The above copyright notice and this permission notice shall be included in all |
| 14 | * copies or substantial portions of the Software. |
| 15 | * |
| 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 22 | * SOFTWARE. |
| 23 | */ |
| 24 | |
| 25 | #ifndef CKW_INCLUDE_CKW_KERNEL_H |
| 26 | #define CKW_INCLUDE_CKW_KERNEL_H |
| 27 | |
Viet-Hoa Do | 1df9f6e | 2023-07-24 17:57:12 +0100 | [diff] [blame] | 28 | #include "ckw/KernelArgument.h" |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame] | 29 | |
Viet-Hoa Do | 3389f53 | 2023-07-05 17:36:40 +0100 | [diff] [blame] | 30 | #include <string> |
Viet-Hoa Do | 1df9f6e | 2023-07-24 17:57:12 +0100 | [diff] [blame] | 31 | #include <vector> |
Viet-Hoa Do | 3389f53 | 2023-07-05 17:36:40 +0100 | [diff] [blame] | 32 | |
| 33 | namespace ckw |
| 34 | { |
| 35 | |
Gunes Bayir | ab0b750 | 2023-07-11 14:57:36 +0100 | [diff] [blame] | 36 | // Forward Declerations |
| 37 | class TileInfo; |
Gunes Bayir | 3c77606 | 2023-07-12 14:50:56 +0100 | [diff] [blame] | 38 | class TileOperand; |
Gunes Bayir | ab0b750 | 2023-07-11 14:57:36 +0100 | [diff] [blame] | 39 | |
| 40 | enum class TargetLanguage; |
| 41 | |
Viet-Hoa Do | 3389f53 | 2023-07-05 17:36:40 +0100 | [diff] [blame] | 42 | /** The kernel that has been emitted by the kernel writer. |
| 43 | * |
| 44 | * It contains all the necessary information to compile and execute the kernel. |
| 45 | */ |
| 46 | class Kernel |
| 47 | { |
| 48 | public: |
Gunes Bayir | ab0b750 | 2023-07-11 14:57:36 +0100 | [diff] [blame] | 49 | virtual ~Kernel(); |
| 50 | |
Viet-Hoa Do | 3389f53 | 2023-07-05 17:36:40 +0100 | [diff] [blame] | 51 | /** Initialize a new instance of @ref Kernel class with all emitted kernel information. |
| 52 | * |
| 53 | * @param[in] language The target language of the kernel. |
Viet-Hoa Do | 1df9f6e | 2023-07-24 17:57:12 +0100 | [diff] [blame] | 54 | * @param[in] arguments The list of kernel arguments. |
Viet-Hoa Do | 3389f53 | 2023-07-05 17:36:40 +0100 | [diff] [blame] | 55 | * @param[in] source_code The source code of the kernel. |
| 56 | */ |
Viet-Hoa Do | 1df9f6e | 2023-07-24 17:57:12 +0100 | [diff] [blame] | 57 | Kernel(TargetLanguage language, const std::vector<KernelArgument> &arguments, const std::string &source_code); |
Viet-Hoa Do | 3389f53 | 2023-07-05 17:36:40 +0100 | [diff] [blame] | 58 | |
| 59 | /** Get the target language. */ |
| 60 | TargetLanguage target_language() const; |
| 61 | |
Viet-Hoa Do | 1df9f6e | 2023-07-24 17:57:12 +0100 | [diff] [blame] | 62 | /** Get the list of arguments. */ |
| 63 | const std::vector<KernelArgument> &arguments() const; |
| 64 | |
Viet-Hoa Do | 3389f53 | 2023-07-05 17:36:40 +0100 | [diff] [blame] | 65 | /** Get the source code. */ |
| 66 | const std::string &source_code() const; |
| 67 | |
Viet-Hoa Do | 3389f53 | 2023-07-05 17:36:40 +0100 | [diff] [blame] | 68 | private: |
Viet-Hoa Do | 1df9f6e | 2023-07-24 17:57:12 +0100 | [diff] [blame] | 69 | TargetLanguage _language; |
| 70 | std::vector<KernelArgument> _arguments; |
| 71 | std::string _source_code; |
Viet-Hoa Do | 3389f53 | 2023-07-05 17:36:40 +0100 | [diff] [blame] | 72 | }; |
| 73 | |
| 74 | } // namespace ckw |
| 75 | |
| 76 | #endif // CKW_INCLUDE_CKW_KERNEL_H |