Debian Codegraph @

visa/iga/IGALibrary/api/igad.h

raw
1 /*========================== begin_copyright_notice ============================
2
3 Copyright (C) 2017-2021 Intel Corporation
4
5 SPDX-License-Identifier: MIT
6
7 ============================= end_copyright_notice ===========================*/
8
9 #ifndef _IGAD_H_
10 #define _IGAD_H_
11
12 #include "iga.h"
13 #include "kv.h"
14
15 #if defined(_WIN32)
16 #define CDECLATTRIBUTE __cdecl
17 #elif __GNUC__
18 #ifdef __x86_64__
19 #define CDECLATTRIBUTE
20 #elif defined(__ARM_ARCH)
21 #define CDECLATTRIBUTE
22 #else
23 #define CDECLATTRIBUTE __attribute__((__cdecl__))
24 #endif
25 #endif
26
27 #ifdef __cplusplus
28 extern "C" {
29
30 #define IGA_VERSION_STRING_STR "iga_version_string"
31 typedef const char *(CDECLATTRIBUTE *pIGAVersionString)();
32
33 #define IGA_STATUS_TO_STRING_STR "iga_status_to_string"
34 typedef const char *(CDECLATTRIBUTE *pIGAStatusToString)(const iga_status_t st);
35
36 #define IGA_CONTEXT_CREATE_STR "iga_context_create"
37 typedef iga_status_t(CDECLATTRIBUTE *pIGAContextCreate)(
38 const iga_context_options_t *opts, iga_context_t *ctx);
39 /* deprecated name */
40 #define IGA_CREATE_CONTEXT_STR "iga_create_context"
41 typedef iga_status_t(CDECLATTRIBUTE *pIGACreateContext)(
42 const iga_context_options_t *opts, iga_context_t *ctx);
43
44 #define IGA_CONTEXT_RELEASE_STR "iga_context_release"
45 typedef iga_status_t(CDECLATTRIBUTE *pIGAContextRelease)(iga_context_t ctx);
46 /* deprecated name */
47 #define IGA_RELEASE_CONTEXT_STR "iga_release_context"
48 typedef iga_status_t(CDECLATTRIBUTE *pIGAReleaseContext)(iga_context_t ctx);
49
50 #define IGA_CONTEXT_ASSEMBLE_STR "iga_context_assemble"
51 typedef iga_status_t(CDECLATTRIBUTE *pIGAContextAssemble)(
52 iga_context_t ctx, const iga_assemble_options_t *opts,
53 const char *kernel_text, void **output, uint32_t *output_size);
54 /* deprecated name */
55 #define IGA_ASSEMBLE_STR "iga_assemble"
56 typedef iga_status_t(CDECLATTRIBUTE *pIGAAssemble)(
57 iga_context_t ctx, const iga_assemble_options_t *opts,
58 const char *kernel_text, void **output, uint32_t *output_size);
59
60 #define IGA_CONTEXT_DISASSEMBLE_STR "iga_context_disassemble"
61 typedef iga_status_t(CDECLATTRIBUTE *pIGAContextDisassemble)(
62 iga_context_t ctx, const iga_disassemble_options_t *opts, const void *input,
63 uint32_t input_size, const char *(*fmt_label_name)(int32_t, void *),
64 void *fmt_label_ctx, char **kernel_text);
65 /* deprecated name */
66 #define IGA_DISASSEMBLE_STR "iga_disassemble"
67 typedef iga_status_t(CDECLATTRIBUTE *pIGADisassemble)(
68 iga_context_t ctx, const iga_disassemble_options_t *opts, const void *input,
69 uint32_t input_size, const char *(*fmt_label_name)(int32_t, void *),
70 void *fmt_label_ctx, char **kernel_text);
71
72 #define IGA_CONTEXT_DISASSEMBLE_INSTRUCTION_STR \
73 "iga_context_disassemble_instruction"
74 typedef iga_status_t(CDECLATTRIBUTE *pIGAContextDisassembleInstruction)(
75 iga_context_t ctx, const iga_disassemble_options_t *dopts,
76 const void *input, const char *(*fmt_label_name)(int32_t, void *),
77 void *fmt_label_ctx, char **kernel_text);
78 /* deprecated name */
79 #define IGA_DISASSEMBLE_INSTRUCTION_STR "iga_disassemble_instruction"
80 typedef iga_status_t(CDECLATTRIBUTE *pIGADisassembleInstruction)(
81 iga_context_t ctx, const iga_disassemble_options_t *dopts,
82 const void *input, const char *(*fmt_label_name)(int32_t, void *),
83 void *fmt_label_ctx, char **kernel_text);
84
85 #define IGA_CONTEXT_GET_ERRORS_STR "iga_context_get_errors"
86 typedef iga_status_t(CDECLATTRIBUTE *pIGAContextGetErrors)(
87 iga_context_t ctx, const iga_diagnostic_t **ds, uint32_t *ds_len);
88 /* deprecated name */
89 #define IGA_GET_ERRORS_STR "iga_get_errors"
90 typedef iga_status_t(CDECLATTRIBUTE *pIGAGetErrors)(iga_context_t ctx,
91 const iga_diagnostic_t **ds,
92 uint32_t *ds_len);
93
94 #define IGA_CONTEXT_GET_WARNINGS_STR "iga_context_get_warnings"
95 typedef iga_status_t(CDECLATTRIBUTE *pIGAContextGetWarnings)(
96 iga_context_t ctx, const iga_diagnostic_t **ds, uint32_t *ds_len);
97 /* deprecated name */
98 #define IGA_GET_WARNINGS_STR "iga_get_warnings"
99 typedef iga_status_t(CDECLATTRIBUTE *pIGAGetWarnings)(
100 iga_context_t ctx, const iga_diagnostic_t **ds, uint32_t *ds_len);
101
102 #define IGA_DIAGNOSTIC_GET_MESSAGE_STR "iga_diagnostic_get_message"
103 typedef iga_status_t(CDECLATTRIBUTE *pIGADiagnosticGetMessage)(
104 const iga_diagnostic_t *d, const char **message);
105 #define IGA_GIAGNOSTIC_GET_OFFSET "iga_diagnostic_get_offset"
106 typedef iga_status_t(CDECLATTRIBUTE *pIGADiagnosticGetOffset)(
107 const iga_diagnostic_t *d, uint32_t *offset);
108 #define IGA_DIAGNOSITC_GET_TYPE_STR "iga_diagnostic_get_type"
109 typedef iga_status_t(CDECLATTRIBUTE *pIGADiagnosticGetType)(
110 const iga_diagnostic_t *d, iga_diagnostic_type_t *dt);
111 #define IGA_DIAGNOSTIC_GET_TEXT_LINE_STR "iga_diagnostic_get_text_line"
112 typedef iga_status_t(CDECLATTRIBUTE *pIGADiagnosticGetTextLine)(
113 const iga_diagnostic_t *d, uint32_t *line);
114 #define IGA_DIAGNOSTIC_GET_TEXT_COLUMN_STR "iga_diagnostic_get_text_column"
115 typedef iga_status_t(CDECLATTRIBUTE *pIGADiagnosticGetTextColumn)(
116 const iga_diagnostic_t *d, uint32_t *col);
117 #define IGA_DIAGNOSTIC_GET_TEXT_EXTENT_STR "iga_diagnostic_get_text_extent"
118 typedef iga_status_t(CDECLATTRIBUTE *pIGADiagnosticGetTextExtent)(
119 const iga_diagnostic_t *d, uint32_t *extent);
120
121 #define IGA_OPSEC_ENUMERATE_STR "iga_opspec_enumerate"
122 typedef iga_status_t(CDECLATTRIBUTE *pIGAOpspecEnumerate)(iga_gen_t gen,
123 iga_opspec_t *ops_arr,
124 size_t *ops_arr_len);
125 #define IGA_OPSPEC_MNEMONIC_STR "iga_opspec_mnemonic"
126 typedef iga_status_t(CDECLATTRIBUTE *pIGAOpspecMnemonic)(iga_opspec_t op,
127 char *mnemonic,
128 size_t *mnemonic_len);
129 #define IGA_OPSPEC_NAME_STR "iga_opspec_name"
130 typedef iga_status_t(CDECLATTRIBUTE *pIGAOpspecName)(iga_opspec_t op,
131 char *name,
132 size_t *name_len);
133 #define IGA_OPSPEC_DESCRIPTION_STR "iga_opspec_description"
134 typedef iga_status_t(CDECLATTRIBUTE *pIGAOpspecDescription)(iga_opspec_t op,
135 char *desc,
136 size_t *desc_len);
137 #define IGA_OPSPEC_OP_STR "iga_opspec_op"
138 typedef iga_status_t(CDECLATTRIBUTE *pIGAOpspecOp)(iga_opspec_t op,
139 uint32_t *opcode);
140
141 /*************************************************************************
142 * *
143 * The KernelView C interface *
144 * *
145 *************************************************************************/
146
147 #define IGA_KV_CREATE_STR "kv_create"
148 typedef kv_t *(CDECLATTRIBUTE *pIGAKVCreate)(
149 iga_gen_t plat, const void *bytes, size_t bytes_len, iga_status_t *status,
150 char *errbuf, size_t errbuf_cap,
151 /* iga::SWSB_ENCODE_MODE */ uint32_t swsb_mode
152 );
153 #define IGA_KV_DELETE_STR "kv_delete"
154 typedef void(CDECLATTRIBUTE *pIGAKVDelete)(kv_t *);
155
156 #define IGA_KV_GET_INST_SIZE_STR "kv_get_inst_size"
157 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetInstSize)(const kv_t *kv, int32_t pc);
158 #define IGA_KV_GET_INST_MSG_INFO_STR "kv_get_inst_msg_info"
159 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetInstMsgInfo)(const kv_t *kv,
160 int32_t pc,
161 bool *isAtomic,
162 bool *isSlm,
163 bool *isScratch);
164 #define IGA_KV_GET_INST_TARGETS_STR "kv_get_inst_targets"
165 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetInstTargets)(const kv_t *kv,
166 int32_t pc,
167 int32_t *pcs);
168 #define IGA_KV_IS_INST_TARGET_STR "kv_is_inst_target"
169 typedef uint32_t(CDECLATTRIBUTE *pIGAKVIsInstTarget)(const kv_t *kv,
170 int32_t pc);
171 #define IGA_KV_GET_DEFAULT_LABEL_NAME_STR "kv_get_default_label_name"
172 typedef size_t(CDECLATTRIBUTE *pIGAKVGetDefaultLabelName)(int32_t pc,
173 char *sbuf,
174 size_t sbuf_cap);
175 #define IGA_KV_GET_INST_SYNTAX_STR "kv_get_inst_syntax"
176 typedef size_t(CDECLATTRIBUTE *pIGAKVGetInstSyntax)(
177 const kv_t *kv, int32_t pc, char *sbuf, size_t sbuf_cap, uint32_t fmt_opts,
178 const char *(*get_label_name)(int32_t, void *), void *env);
179 #define IGA_KV_GET_OPGROUP_STR "kv_get_opgroup"
180 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetOpgroup)(const kv_t *kv, int32_t pc);
181 #define IGA_KV_GET_SEND_DESCS_STR "kv_get_send_descs"
182 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetSendDescs)(const kv_t *kv, int32_t pc,
183 uint32_t *ex_desc,
184 uint32_t *desc);
185 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetSendExDescImmOff)(
186 const kv_t *kv, int32_t pc, uint32_t *ex_desc_immoff);
187 #define IGA_KV_GET_SEND_INDIRECT_DESCS_STR "kv_get_send_indirect_descs"
188 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetSendIndirectDescs)(
189 const kv_t *kv, int32_t pc, uint8_t *ex_desc_reg, uint8_t *ex_desc_subreg,
190 uint8_t *desc_reg, uint8_t *desc_subreg);
191 typedef kv_status_t(CDECLATTRIBUTE *pIGAKVGetSendgDesc)(const kv_t *kv,
192 int32_t pc,
193 uint64_t *desc);
194 typedef kv_status_t(CDECLATTRIBUTE *pIGAKVGetSendgIndDesc)(
195 const kv_t *kv, int32_t pc, uint32_t *subregPresent, uint32_t *subreg);
196
197 /************************* KV Analysis APIS **********************************/
198
199 #define IGA_KV_HAS_INST_OPT_STR "kv_has_inst_opt"
200 typedef bool(CDECLATTRIBUTE *pIGAKVHasInstOpt)(const kv_t *kv, int32_t pc,
201 uint32_t opt);
202
203 #define IGA_KV_GET_EXECUTION_SIZE "kv_get_execution_size"
204 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetExecutionSize)(const kv_t *kv,
205 int32_t pc);
206
207 #define IGA_KV_GET_SWSB_INFO "kv_get_swsb_info"
208 typedef bool(CDECLATTRIBUTE *pIGAKVGetSWSBInfo)(
209 const kv_t *kv, int32_t pc, iga::SWSB_ENCODE_MODE encdoe_mode,
210 iga::SWSB &swsb);
211
212 #define IGA_KV_GET_NUMBER_SOURCES_STR "kv_get_number_sources"
213 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetNumberSources)(const kv_t *kv,
214 int32_t pc);
215 #define IGA_KV_GET_OPCODE_STR "kv_get_opcode"
216 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetOpcode)(const kv_t *kv, int32_t pc);
217 #define IGA_KV_GET_SUBFUNCTION_STR "kv_get_subfunction"
218 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetSubfunction)(const kv_t *kv,
219 int32_t pc,
220 uint32_t *subfunc);
221 #define IGA_KV_GET_HAS_DESTINATION_STR "kv_get_has_destination"
222 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetHasDestination)(const kv_t *kv,
223 int32_t pc);
224 #define IGA_KV_GET_DESTINATION_REGISTER_STR "kv_get_destination_register"
225 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetDstRegister)(const kv_t *kv,
226 int32_t pc);
227 #define IGA_KV_GET_DESTINATION_SUB_REGISTER_STR \
228 "kv_get_destination_sub_register"
229 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetDstSubRegister)(const kv_t *kv,
230 int32_t pc);
231 #define IGA_KV_GET_DESTINATION_DATA_TYPE_STR "kv_get_destination_data_type"
232 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetDstDataType)(const kv_t *kv,
233 int32_t pc);
234 #define IGA_KV_GET_DESTINATION_REGISTER_TYPE_STR \
235 "kv_get_destination_register_type"
236 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetDstRegisterType)(const kv_t *kv,
237 int32_t pc);
238 #define IGA_KV_GET_DESTINATION_REGISTER_KIND_STR \
239 "kv_get_destination_register_kind"
240 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetDstRegisterKind)(const kv_t *kv,
241 int32_t pc);
242 #define IGA_KV_GET_SOURCE_REGISTER_STR "kv_get_source_register"
243 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetSrcRegister)(const kv_t *kv,
244 int32_t pc,
245 uint32_t sourceNumber);
246 #define IGA_KV_GET_SOURCE_SUB_REGISTER_STR "kv_get_source_sub_register"
247 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetSrcSubRegister)(const kv_t *kv,
248 int32_t pc,
249 uint32_t sourceNumber);
250 #define IGA_KV_GET_SOURCE_DATA_TYPE_STR "kv_get_source_data_type"
251 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetSrcDataType)(const kv_t *kv,
252 int32_t pc,
253 uint32_t sourceNumber);
254 #define IGA_KV_GET_SOURCE_REGISTER_TYPE_STR "kv_get_source_register_type"
255 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetSrcRegisterType)(
256 const kv_t *kv, int32_t pc, uint32_t sourceNumber);
257 #define IGA_KV_GET_SOURCE_REGISTER_KIND_STR "kv_get_source_register_kind"
258 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetSrcRegisterKind)(
259 const kv_t *kv, int32_t pc, uint32_t sourceNumber);
260 #define IGA_KV_GET_IS_SOURCE_VECTOR_STR "kv_is_source_vector"
261 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetIsSrcVector)(const kv_t *kv,
262 int32_t pc,
263 uint32_t sourceNumber);
264 #define IGA_KV_GET_CHANNEL_OFFSET_STR "kv_get_channel_offset"
265 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetChannelOffset)(const kv_t *kv,
266 int32_t pc);
267 #define IGA_KV_GET_MASK_CONTROL_STR "kv_get_mask_control"
268 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetMaskControl)(const kv_t *kv,
269 int32_t pc);
270 #define IGA_KV_GET_SEND_EXBSO_STR "kv_get_send_exbso"
271 typedef kv_status_t(CDECLATTRIBUTE *pIGAKVGetSendExBso)(const kv_t *kv,
272 int32_t pc,
273 int32_t *exbso);
274 #define IGA_KV_GET_MESSAGE_TYPE_STR "kv_get_message_type"
275 typedef kv_status_t(CDECLATTRIBUTE *pIGAKVGetMessageType)(
276 const kv_t *kv, int32_t pc, int32_t *message_type_enum);
277 #define IGA_KV_GET_MESSAGE_SFID_STR "kv_get_message_sfid"
278 typedef kv_status_t(CDECLATTRIBUTE *pIGAKVGetMessageSFID)(const kv_t *kv,
279 int32_t pc,
280 int32_t *sfid_enum);
281 #define IGA_KV_GET_MESSAGE_LEN_STR "kv_get_message_len"
282 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetMessageLen)(const kv_t *kv,
283 int32_t pc,
284 uint32_t *mLen,
285 uint32_t *emLen,
286 uint32_t *rLen);
287 #define IGA_KV_GET_IS_DESTINATION_REGION_STR "kv_get_destination_region"
288 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetDstRegion)(const kv_t *kv, int32_t pc,
289 uint32_t *hz);
290 #define IGA_KV_GET_IS_SOURCE_REGION_STR "kv_get_source_region"
291 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetSrcRegion)(const kv_t *kv, int32_t pc,
292 uint32_t src_op,
293 uint32_t *vt, uint32_t *wi,
294 uint32_t *hz);
295 #define IGA_KV_GET_SOURCE_IMMEDIATE_STR "kv_get_source_immediate"
296 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetSrcImmediate)(const kv_t *kv,
297 int32_t pc,
298 uint32_t src_op,
299 uint64_t *imm);
300 #define IGA_KV_GET_FLAG_MODIFIER_STR "kv_get_flag_modifier"
301 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetFlagModifier)(const kv_t *kv,
302 int32_t pc);
303 #define IGA_KV_GET_SOURCE_MODIFIER_STR "kv_get_source_modifier"
304 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetSrcModifier)(const kv_t *kv,
305 int32_t pc,
306 uint32_t src_op);
307 #define IGA_KV_GET_DESTINATION_MODIFIER_STR "kv_get_destination_modifier"
308 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetDstModifier)(const kv_t *kv,
309 int32_t pc);
310 #define IGA_KV_GET_FLAG_REGISTER_STR "kv_get_flag_register"
311 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetFlagReg)(const kv_t *kv, int32_t pc);
312 #define IGA_KV_GET_FLAG_SUB_REGISTER_STR "kv_get_flag_sub_register"
313 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetFlagSubReg)(const kv_t *kv,
314 int32_t pc);
315 #define IGA_KV_GET_PREDICATE "kv_get_predicate"
316 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetPredicate)(const kv_t *kv,
317 int32_t pc);
318 #define IGA_KV_GET_IS_INVERSE_PREDICATE "kv_get_is_inverse_predicate"
319 typedef uint32_t(CDECLATTRIBUTE *pIGAKVGetIsInversePred)(const kv_t *kv,
320 int32_t pc);
321 #define IGA_KV_GET_SOURCE_INDIRECT_IMM_OFF_STR "kv_get_source_indirect_imm_off"
322 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetSrcIndirectImmOff)(const kv_t *kv,
323 int32_t pc,
324 uint32_t src_op,
325 int16_t *immoff);
326 #define IGA_KV_GET_DESTINATION_INDIRECT_IMM_OFF_STR \
327 "kv_get_destination_indirect_imm_off"
328 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetDstIndirectImmOff)(const kv_t *kv,
329 int32_t pc,
330 int16_t *immoff);
331 #define IGA_KV_GET_SOURCE_MME_NUMBER "kv_get_source_mme_number"
332 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetSrcMMENumber)(const kv_t *kv,
333 int32_t pc,
334 uint32_t src_op,
335 int16_t *mme);
336 #define IGA_KV_GET_DESTINATION_MME_NUMBER "kv_get_destination_mme_number"
337 typedef int32_t(CDECLATTRIBUTE *pIGAKVGetDstMMENumber)(const kv_t *kv,
338 int32_t pc,
339 int16_t *mme);
340 #define IGA_KV_GET_CACHE_OPT "kv_get_cache_opt"
341 typedef kv_status_t(CDECLATTRIBUTE *pIGAKVGetCacheOpt)(const kv_t *kv,
342 int32_t pc,
343 int32_t cache_level,
344 int32_t *cacheopt_enum);
345 /*
346 * A table of IGA functions
347 */
348 typedef struct {
349 /* miscellaneous API functions */
350 pIGAVersionString iga_version_string;
351 pIGAStatusToString iga_status_to_string;
352 /* context functions */
353 pIGAContextCreate iga_context_create;
354 pIGAContextRelease iga_context_release;
355 pIGAContextAssemble iga_context_assemble;
356 pIGAContextDisassemble iga_context_disassemble;
357 pIGAContextDisassembleInstruction iga_context_disassemble_instruction;
358 pIGAContextGetErrors iga_context_get_errors;
359 pIGAContextGetWarnings iga_context_get_warnings;
360 /* diagnostic query functions */
361 pIGADiagnosticGetMessage iga_diagnostic_get_message;
362 pIGADiagnosticGetOffset iga_diagnostic_get_offset;
363 pIGADiagnosticGetType iga_diagnostic_get_type;
364 pIGADiagnosticGetTextLine iga_diagnostic_get_text_line;
365 pIGADiagnosticGetTextColumn iga_diagnostic_get_text_column;
366 pIGADiagnosticGetTextExtent iga_diagnostic_get_text_extent;
367 /* opspec functions */
368 pIGAOpspecEnumerate iga_opspec_enumerate;
369 pIGAOpspecMnemonic iga_opspec_mnemonic;
370 pIGAOpspecName iga_opspec_name;
371 pIGAOpspecDescription iga_opspec_description;
372 pIGAOpspecOp iga_opspec_op;
373 } iga_functions_t;
374
375 /*
376 * gets a table of the IGA functions
377 *
378 * RETURNS:
379 * IGA_SUCCESS on success
380 * IGA_INVALID if the parameter is nullptr
381 */
382 #endif
383 IGA_API iga_status_t iga_get_interface(iga_functions_t *);
384
385 #ifdef __cplusplus
386 }
387 #endif
388
389 /* A table of all kernel viewer functions */
390 typedef struct {
391 pIGAKVCreate kv_create;
392 pIGAKVDelete kv_delete;
393 pIGAKVGetInstSize kv_get_inst_size;
394 pIGAKVGetInstMsgInfo kv_get_inst_msg_info;
395 pIGAKVGetInstTargets kv_get_inst_targets;
396 pIGAKVIsInstTarget kv_is_inst_target;
397 pIGAKVGetDefaultLabelName kv_get_default_label_name;
398 pIGAKVGetInstSyntax kv_get_inst_syntax;
399 pIGAKVGetOpgroup kv_get_opgroup;
400 pIGAKVGetSendDescs kv_get_send_descs;
401 pIGAKVGetSendExDescImmOff kv_get_send_exdesc_immoff;
402 pIGAKVGetSendgDesc kv_get_sendg_desc;
403 pIGAKVGetSendgIndDesc kv_get_sendg_ind_desc0;
404 pIGAKVGetSendgIndDesc kv_get_sendg_ind_desc1;
405 pIGAKVGetSendIndirectDescs kv_get_send_indirect_descs;
406 pIGAKVGetSendExBso kv_get_send_exbso;
407 pIGAKVGetExecutionSize kv_get_execution_size;
408 pIGAKVGetNumberSources kv_get_number_sources;
409 pIGAKVGetOpcode kv_get_opcode;
410 pIGAKVGetSubfunction kv_get_subfunction;
411 pIGAKVGetHasDestination kv_get_has_destination;
412 pIGAKVGetDstRegister kv_get_destination_register;
413 pIGAKVGetDstSubRegister kv_get_destination_sub_register;
414 pIGAKVGetDstDataType kv_get_destination_data_type;
415 pIGAKVGetDstRegisterType kv_get_destination_register_type;
416 pIGAKVGetDstRegisterKind kv_get_destination_register_kind;
417 pIGAKVGetSrcRegister kv_get_source_register;
418 pIGAKVGetSrcSubRegister kv_get_source_sub_register;
419 pIGAKVGetSrcDataType kv_get_source_data_type;
420 pIGAKVGetSrcRegisterType kv_get_source_register_type;
421 pIGAKVGetSrcRegisterKind kv_get_source_register_kind;
422 pIGAKVGetIsSrcVector kv_is_source_vector;
423 pIGAKVGetChannelOffset kv_get_channel_offset;
424 pIGAKVGetMaskControl kv_get_mask_control;
425 pIGAKVGetMessageType kv_get_message_type;
426 pIGAKVGetMessageSFID kv_get_message_sfid;
427 pIGAKVGetMessageLen kv_get_message_len;
428 pIGAKVGetDstRegion kv_get_destination_region;
429 pIGAKVGetSrcRegion kv_get_source_region;
430 pIGAKVGetSrcImmediate kv_get_source_immediate;
431 pIGAKVGetFlagModifier kv_get_flag_modifier;
432 pIGAKVGetSrcModifier kv_get_source_modifier;
433 pIGAKVGetDstModifier kv_get_destination_modifier;
434 pIGAKVGetFlagReg kv_get_flag_reg;
435 pIGAKVGetFlagSubReg kv_get_flag_subreg;
436 pIGAKVGetPredicate kv_get_predicate;
437 pIGAKVGetIsInversePred kv_get_inverse_predicate;
438 pIGAKVGetSWSBInfo kv_get_swsb_info;
439 pIGAKVHasInstOpt kv_has_inst_opt;
440 pIGAKVGetSrcIndirectImmOff kv_get_source_indirect_imm_off;
441 pIGAKVGetDstIndirectImmOff kv_get_destination_indirect_imm_off;
442 pIGAKVGetSrcMMENumber kv_get_source_mme_number;
443 pIGAKVGetDstMMENumber kv_get_destination_mme_number;
444 pIGAKVGetCacheOpt kv_get_cache_opt;
445 } kv_functions_t;
446
447 #endif // _IGAD_H_