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 | 3389f53 | 2023-07-05 17:36:40 +0100 | [diff] [blame] | 28 | #include <string> |
| 29 | |
| 30 | namespace ckw |
| 31 | { |
| 32 | |
Gunes Bayir | ab0b750 | 2023-07-11 14:57:36 +0100 | [diff] [blame] | 33 | // Forward Declerations |
| 34 | class TileInfo; |
Gunes Bayir | 3c77606 | 2023-07-12 14:50:56 +0100 | [diff] [blame] | 35 | class TileOperand; |
Gunes Bayir | ab0b750 | 2023-07-11 14:57:36 +0100 | [diff] [blame] | 36 | |
| 37 | enum class TargetLanguage; |
| 38 | |
Viet-Hoa Do | 3389f53 | 2023-07-05 17:36:40 +0100 | [diff] [blame] | 39 | /** The kernel that has been emitted by the kernel writer. |
| 40 | * |
| 41 | * It contains all the necessary information to compile and execute the kernel. |
| 42 | */ |
| 43 | class Kernel |
| 44 | { |
| 45 | public: |
Gunes Bayir | ab0b750 | 2023-07-11 14:57:36 +0100 | [diff] [blame] | 46 | virtual ~Kernel(); |
| 47 | |
Viet-Hoa Do | 3389f53 | 2023-07-05 17:36:40 +0100 | [diff] [blame] | 48 | /** Initialize a new instance of @ref Kernel class with all emitted kernel information. |
| 49 | * |
| 50 | * @param[in] language The target language of the kernel. |
| 51 | * @param[in] source_code The source code of the kernel. |
| 52 | */ |
| 53 | Kernel(TargetLanguage language, const std::string &source_code); |
| 54 | |
| 55 | /** Get the target language. */ |
| 56 | TargetLanguage target_language() const; |
| 57 | |
| 58 | /** Get the source code. */ |
| 59 | const std::string &source_code() const; |
| 60 | |
Gunes Bayir | ab0b750 | 2023-07-11 14:57:36 +0100 | [diff] [blame] | 61 | /** Add a tile operand */ |
Gunes Bayir | 3c77606 | 2023-07-12 14:50:56 +0100 | [diff] [blame] | 62 | virtual TileOperand &add_operand(const std::string &name, const TileInfo &tile_info) = 0; |
Gunes Bayir | ab0b750 | 2023-07-11 14:57:36 +0100 | [diff] [blame] | 63 | |
Viet-Hoa Do | 3389f53 | 2023-07-05 17:36:40 +0100 | [diff] [blame] | 64 | private: |
| 65 | TargetLanguage _language; |
| 66 | std::string _source_code; |
| 67 | }; |
| 68 | |
| 69 | } // namespace ckw |
| 70 | |
| 71 | #endif // CKW_INCLUDE_CKW_KERNEL_H |