annotate liboffloadmic/runtime/liboffload_error_codes.h @ 158:494b0b89df80 default tip

...
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 18:13:55 +0900
parents 04ced10e8804
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
111
kono
parents:
diff changeset
1 /*
kono
parents:
diff changeset
2 Copyright (c) 2014-2016 Intel Corporation. All Rights Reserved.
kono
parents:
diff changeset
3
kono
parents:
diff changeset
4 Redistribution and use in source and binary forms, with or without
kono
parents:
diff changeset
5 modification, are permitted provided that the following conditions
kono
parents:
diff changeset
6 are met:
kono
parents:
diff changeset
7
kono
parents:
diff changeset
8 * Redistributions of source code must retain the above copyright
kono
parents:
diff changeset
9 notice, this list of conditions and the following disclaimer.
kono
parents:
diff changeset
10 * Redistributions in binary form must reproduce the above copyright
kono
parents:
diff changeset
11 notice, this list of conditions and the following disclaimer in the
kono
parents:
diff changeset
12 documentation and/or other materials provided with the distribution.
kono
parents:
diff changeset
13 * Neither the name of Intel Corporation nor the names of its
kono
parents:
diff changeset
14 contributors may be used to endorse or promote products derived
kono
parents:
diff changeset
15 from this software without specific prior written permission.
kono
parents:
diff changeset
16
kono
parents:
diff changeset
17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
kono
parents:
diff changeset
18 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
kono
parents:
diff changeset
19 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
kono
parents:
diff changeset
20 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
kono
parents:
diff changeset
21 HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
kono
parents:
diff changeset
22 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
kono
parents:
diff changeset
23 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
kono
parents:
diff changeset
24 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
kono
parents:
diff changeset
25 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
kono
parents:
diff changeset
26 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
kono
parents:
diff changeset
27 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
kono
parents:
diff changeset
28 */
kono
parents:
diff changeset
29
kono
parents:
diff changeset
30
kono
parents:
diff changeset
31 #if !defined(LIBOFFLOAD_ERROR_CODES_H)
kono
parents:
diff changeset
32 #define LIBOFFLOAD_ERROR_CODES_H
kono
parents:
diff changeset
33 #include <stdarg.h>
kono
parents:
diff changeset
34 #include <stdlib.h>
kono
parents:
diff changeset
35 #include <stdio.h>
kono
parents:
diff changeset
36
kono
parents:
diff changeset
37 typedef enum
kono
parents:
diff changeset
38 {
kono
parents:
diff changeset
39 c_device_is_not_available = 0,
kono
parents:
diff changeset
40 c_invalid_device_number,
kono
parents:
diff changeset
41 c_offload1,
kono
parents:
diff changeset
42 c_unknown_var_type,
kono
parents:
diff changeset
43 c_send_func_ptr,
kono
parents:
diff changeset
44 c_receive_func_ptr,
kono
parents:
diff changeset
45 c_malloc,
kono
parents:
diff changeset
46 c_unknown_mic_device_type,
kono
parents:
diff changeset
47 c_offload_malloc,
kono
parents:
diff changeset
48 c_invalid_env_var_value,
kono
parents:
diff changeset
49 c_invalid_env_var_int_value,
kono
parents:
diff changeset
50 c_invalid_env_report_value,
kono
parents:
diff changeset
51 c_offload_signaled1,
kono
parents:
diff changeset
52 c_offload_signaled2,
kono
parents:
diff changeset
53 c_myotarget_checkresult,
kono
parents:
diff changeset
54 c_myowrapper_checkresult,
kono
parents:
diff changeset
55 c_offload_descriptor_offload,
kono
parents:
diff changeset
56 c_merge_var_descs1,
kono
parents:
diff changeset
57 c_merge_var_descs2,
kono
parents:
diff changeset
58 c_mic_parse_env_var_list1,
kono
parents:
diff changeset
59 c_mic_parse_env_var_list2,
kono
parents:
diff changeset
60 c_mic_process_exit_ret,
kono
parents:
diff changeset
61 c_mic_process_exit_sig,
kono
parents:
diff changeset
62 c_mic_process_exit,
kono
parents:
diff changeset
63 c_mic_init3,
kono
parents:
diff changeset
64 c_mic_init4,
kono
parents:
diff changeset
65 c_mic_init5,
kono
parents:
diff changeset
66 c_mic_init6,
kono
parents:
diff changeset
67 c_mic_init7,
kono
parents:
diff changeset
68 c_mic_init8,
kono
parents:
diff changeset
69 c_mic_init9,
kono
parents:
diff changeset
70 c_mic_init10,
kono
parents:
diff changeset
71 c_mic_init11,
kono
parents:
diff changeset
72 c_no_static_var_data,
kono
parents:
diff changeset
73 c_no_ptr_data,
kono
parents:
diff changeset
74 c_get_engine_handle,
kono
parents:
diff changeset
75 c_get_engine_index,
kono
parents:
diff changeset
76 c_process_create,
kono
parents:
diff changeset
77 c_process_set_cache_size,
kono
parents:
diff changeset
78 c_process_get_func_handles,
kono
parents:
diff changeset
79 c_process_wait_shutdown,
kono
parents:
diff changeset
80 c_process_proxy_flush,
kono
parents:
diff changeset
81 c_load_library,
kono
parents:
diff changeset
82 c_pipeline_create,
kono
parents:
diff changeset
83 c_pipeline_run_func,
kono
parents:
diff changeset
84 c_pipeline_start_run_funcs,
kono
parents:
diff changeset
85 c_buf_create,
kono
parents:
diff changeset
86 c_buf_create_out_of_mem,
kono
parents:
diff changeset
87 c_buf_create_from_mem,
kono
parents:
diff changeset
88 c_buf_destroy,
kono
parents:
diff changeset
89 c_buf_map,
kono
parents:
diff changeset
90 c_buf_unmap,
kono
parents:
diff changeset
91 c_buf_read,
kono
parents:
diff changeset
92 c_buf_write,
kono
parents:
diff changeset
93 c_buf_copy,
kono
parents:
diff changeset
94 c_buf_get_address,
kono
parents:
diff changeset
95 c_buf_add_ref,
kono
parents:
diff changeset
96 c_buf_release_ref,
kono
parents:
diff changeset
97 c_buf_set_state,
kono
parents:
diff changeset
98 c_event_wait,
kono
parents:
diff changeset
99 c_zero_or_neg_ptr_len,
kono
parents:
diff changeset
100 c_zero_or_neg_transfer_size,
kono
parents:
diff changeset
101 c_bad_ptr_mem_alloc,
kono
parents:
diff changeset
102 c_bad_ptr_mem_range,
kono
parents:
diff changeset
103 c_different_src_and_dstn_sizes,
kono
parents:
diff changeset
104 c_ranges_dont_match,
kono
parents:
diff changeset
105 c_destination_is_over,
kono
parents:
diff changeset
106 c_slice_of_noncont_array,
kono
parents:
diff changeset
107 c_non_contiguous_dope_vector,
kono
parents:
diff changeset
108 c_pointer_array_mismatch,
kono
parents:
diff changeset
109 c_omp_invalid_device_num_env,
kono
parents:
diff changeset
110 c_omp_invalid_device_num,
kono
parents:
diff changeset
111 c_unknown_binary_type,
kono
parents:
diff changeset
112 c_multiple_target_exes,
kono
parents:
diff changeset
113 c_no_target_exe,
kono
parents:
diff changeset
114 c_incorrect_affinity,
kono
parents:
diff changeset
115 c_cannot_set_affinity,
kono
parents:
diff changeset
116 c_mixed_versions,
kono
parents:
diff changeset
117 c_report_host,
kono
parents:
diff changeset
118 c_report_target,
kono
parents:
diff changeset
119 c_report_title,
kono
parents:
diff changeset
120 c_report_from_file,
kono
parents:
diff changeset
121 c_report_file,
kono
parents:
diff changeset
122 c_report_line,
kono
parents:
diff changeset
123 c_report_tag,
kono
parents:
diff changeset
124 c_report_seconds,
kono
parents:
diff changeset
125 c_report_bytes,
kono
parents:
diff changeset
126 c_report_mic,
kono
parents:
diff changeset
127 c_report_cpu_time,
kono
parents:
diff changeset
128 c_report_cpu_to_mic_data,
kono
parents:
diff changeset
129 c_report_mic_time,
kono
parents:
diff changeset
130 c_report_mic_to_cpu_data,
kono
parents:
diff changeset
131 c_report_unknown_timer_node,
kono
parents:
diff changeset
132 c_report_unknown_trace_node,
kono
parents:
diff changeset
133 c_report_offload,
kono
parents:
diff changeset
134 c_report_w_tag,
kono
parents:
diff changeset
135 c_report_state,
kono
parents:
diff changeset
136 c_report_start,
kono
parents:
diff changeset
137 c_report_init,
kono
parents:
diff changeset
138 c_report_logical_card,
kono
parents:
diff changeset
139 c_report_physical_card,
kono
parents:
diff changeset
140 c_report_register,
kono
parents:
diff changeset
141 c_report_init_func,
kono
parents:
diff changeset
142 c_report_create_buf_host,
kono
parents:
diff changeset
143 c_report_create_buf_mic,
kono
parents:
diff changeset
144 c_report_send_pointer_data,
kono
parents:
diff changeset
145 c_report_sent_pointer_data,
kono
parents:
diff changeset
146 c_report_gather_copyin_data,
kono
parents:
diff changeset
147 c_report_copyin_data,
kono
parents:
diff changeset
148 c_report_state_signal,
kono
parents:
diff changeset
149 c_report_signal,
kono
parents:
diff changeset
150 c_report_wait,
kono
parents:
diff changeset
151 c_report_compute,
kono
parents:
diff changeset
152 c_report_receive_pointer_data,
kono
parents:
diff changeset
153 c_report_received_pointer_data,
kono
parents:
diff changeset
154 c_report_start_target_func,
kono
parents:
diff changeset
155 c_report_var,
kono
parents:
diff changeset
156 c_report_scatter_copyin_data,
kono
parents:
diff changeset
157 c_report_gather_copyout_data,
kono
parents:
diff changeset
158 c_report_scatter_copyout_data,
kono
parents:
diff changeset
159 c_report_copyout_data,
kono
parents:
diff changeset
160 c_report_unregister,
kono
parents:
diff changeset
161 c_report_destroy,
kono
parents:
diff changeset
162 c_report_myoinit,
kono
parents:
diff changeset
163 c_report_myoregister,
kono
parents:
diff changeset
164 c_report_myofini,
kono
parents:
diff changeset
165 c_report_mic_myo_shared,
kono
parents:
diff changeset
166 c_report_mic_myo_fptr,
kono
parents:
diff changeset
167 c_report_myosharedmalloc,
kono
parents:
diff changeset
168 c_report_myosharedfree,
kono
parents:
diff changeset
169 c_report_myosharedalignedmalloc,
kono
parents:
diff changeset
170 c_report_myosharedalignedfree,
kono
parents:
diff changeset
171 c_report_myoacquire,
kono
parents:
diff changeset
172 c_report_myorelease,
kono
parents:
diff changeset
173 c_report_myosupportsfeature,
kono
parents:
diff changeset
174 c_report_myosharedarenacreate,
kono
parents:
diff changeset
175 c_report_myosharedalignedarenamalloc,
kono
parents:
diff changeset
176 c_report_myosharedalignedarenafree,
kono
parents:
diff changeset
177 c_report_myoarenaacquire,
kono
parents:
diff changeset
178 c_report_myoarenarelease,
kono
parents:
diff changeset
179 c_coipipe_max_number,
kono
parents:
diff changeset
180 c_in_with_preallocated,
kono
parents:
diff changeset
181 c_report_no_host_exe,
kono
parents:
diff changeset
182 c_report_no_target_exe,
kono
parents:
diff changeset
183 c_report_path_buff_overflow,
kono
parents:
diff changeset
184 c_create_pipeline_for_stream,
kono
parents:
diff changeset
185 c_offload_no_stream,
kono
parents:
diff changeset
186 c_offload_device_doesnt_match_to_stream,
kono
parents:
diff changeset
187 c_offload_streams_are_absent,
kono
parents:
diff changeset
188 c_get_engine_info,
kono
parents:
diff changeset
189 c_clear_cpu_mask,
kono
parents:
diff changeset
190 c_set_cpu_mask,
kono
parents:
diff changeset
191 c_report_state_stream,
kono
parents:
diff changeset
192 c_report_stream,
kono
parents:
diff changeset
193 c_unload_library,
kono
parents:
diff changeset
194 c_target_myo_library,
kono
parents:
diff changeset
195 c_myo_dl_sym,
kono
parents:
diff changeset
196 c_bad_myo_free
kono
parents:
diff changeset
197 } error_types;
kono
parents:
diff changeset
198
kono
parents:
diff changeset
199 enum OffloadHostPhase {
kono
parents:
diff changeset
200 // Total time on host for entire offload
kono
parents:
diff changeset
201 c_offload_host_total_offload = 0,
kono
parents:
diff changeset
202
kono
parents:
diff changeset
203 // Time to load target binary
kono
parents:
diff changeset
204 c_offload_host_initialize,
kono
parents:
diff changeset
205
kono
parents:
diff changeset
206 // Time to acquire lrb availability dynamically
kono
parents:
diff changeset
207 c_offload_host_target_acquire,
kono
parents:
diff changeset
208
kono
parents:
diff changeset
209 // Time to wait for dependencies
kono
parents:
diff changeset
210 c_offload_host_wait_deps,
kono
parents:
diff changeset
211
kono
parents:
diff changeset
212 // Time to allocate pointer buffers, initiate writes for pointers
kono
parents:
diff changeset
213 // and calculate size of copyin/copyout buffer
kono
parents:
diff changeset
214 c_offload_host_setup_buffers,
kono
parents:
diff changeset
215
kono
parents:
diff changeset
216 // Time to allocate pointer buffers
kono
parents:
diff changeset
217 c_offload_host_alloc_buffers,
kono
parents:
diff changeset
218
kono
parents:
diff changeset
219 // Time to initialize misc data
kono
parents:
diff changeset
220 c_offload_host_setup_misc_data,
kono
parents:
diff changeset
221
kono
parents:
diff changeset
222 // Time to allocate copyin/copyout buffer
kono
parents:
diff changeset
223 c_offload_host_alloc_data_buffer,
kono
parents:
diff changeset
224
kono
parents:
diff changeset
225 // Time to initiate writes from host pointers to buffers
kono
parents:
diff changeset
226 c_offload_host_send_pointers,
kono
parents:
diff changeset
227
kono
parents:
diff changeset
228 // Time to Gather IN data of offload into buffer
kono
parents:
diff changeset
229 c_offload_host_gather_inputs,
kono
parents:
diff changeset
230
kono
parents:
diff changeset
231 // Time to map buffer
kono
parents:
diff changeset
232 c_offload_host_map_in_data_buffer,
kono
parents:
diff changeset
233
kono
parents:
diff changeset
234 // Time to unmap buffer
kono
parents:
diff changeset
235 c_offload_host_unmap_in_data_buffer,
kono
parents:
diff changeset
236
kono
parents:
diff changeset
237 // Time to start remote function call that does computation on lrb
kono
parents:
diff changeset
238 c_offload_host_start_compute,
kono
parents:
diff changeset
239
kono
parents:
diff changeset
240 // Time to wait for compute to finish
kono
parents:
diff changeset
241 c_offload_host_wait_compute,
kono
parents:
diff changeset
242
kono
parents:
diff changeset
243 // Time to initiate reads from pointer buffers
kono
parents:
diff changeset
244 c_offload_host_start_buffers_reads,
kono
parents:
diff changeset
245
kono
parents:
diff changeset
246 // Time to update host variabels with OUT data from buffer
kono
parents:
diff changeset
247 c_offload_host_scatter_outputs,
kono
parents:
diff changeset
248
kono
parents:
diff changeset
249 // Time to map buffer
kono
parents:
diff changeset
250 c_offload_host_map_out_data_buffer,
kono
parents:
diff changeset
251
kono
parents:
diff changeset
252 // Time to unmap buffer
kono
parents:
diff changeset
253 c_offload_host_unmap_out_data_buffer,
kono
parents:
diff changeset
254
kono
parents:
diff changeset
255 // Time to wait reads from buffers to finish
kono
parents:
diff changeset
256 c_offload_host_wait_buffers_reads,
kono
parents:
diff changeset
257
kono
parents:
diff changeset
258 // Time to destroy buffers that are no longer needed
kono
parents:
diff changeset
259 c_offload_host_destroy_buffers,
kono
parents:
diff changeset
260
kono
parents:
diff changeset
261 // LAST TIME MONITOR
kono
parents:
diff changeset
262 c_offload_host_max_phase
kono
parents:
diff changeset
263 };
kono
parents:
diff changeset
264
kono
parents:
diff changeset
265 enum OffloadTargetPhase {
kono
parents:
diff changeset
266 // Total time spent on the target
kono
parents:
diff changeset
267 c_offload_target_total_time = 0,
kono
parents:
diff changeset
268
kono
parents:
diff changeset
269 // Time to initialize offload descriptor
kono
parents:
diff changeset
270 c_offload_target_descriptor_setup,
kono
parents:
diff changeset
271
kono
parents:
diff changeset
272 // Time to find target entry point in lookup table
kono
parents:
diff changeset
273 c_offload_target_func_lookup,
kono
parents:
diff changeset
274
kono
parents:
diff changeset
275 // Total time spend executing offload entry
kono
parents:
diff changeset
276 c_offload_target_func_time,
kono
parents:
diff changeset
277
kono
parents:
diff changeset
278 // Time to initialize target variables with IN values from buffer
kono
parents:
diff changeset
279 c_offload_target_scatter_inputs,
kono
parents:
diff changeset
280
kono
parents:
diff changeset
281 // Time to add buffer reference for pointer buffers
kono
parents:
diff changeset
282 c_offload_target_add_buffer_refs,
kono
parents:
diff changeset
283
kono
parents:
diff changeset
284 // Total time on lrb for computation
kono
parents:
diff changeset
285 c_offload_target_compute,
kono
parents:
diff changeset
286
kono
parents:
diff changeset
287 // On lrb, time to copy OUT into buffer
kono
parents:
diff changeset
288 c_offload_target_gather_outputs,
kono
parents:
diff changeset
289
kono
parents:
diff changeset
290 // Time to release buffer references
kono
parents:
diff changeset
291 c_offload_target_release_buffer_refs,
kono
parents:
diff changeset
292
kono
parents:
diff changeset
293 // LAST TIME MONITOR
kono
parents:
diff changeset
294 c_offload_target_max_phase
kono
parents:
diff changeset
295 };
kono
parents:
diff changeset
296
kono
parents:
diff changeset
297 #ifdef TARGET_WINNT
kono
parents:
diff changeset
298 #define DLL_LOCAL
kono
parents:
diff changeset
299 #else
kono
parents:
diff changeset
300 #define DLL_LOCAL __attribute__((visibility("hidden")))
kono
parents:
diff changeset
301 #endif
kono
parents:
diff changeset
302
kono
parents:
diff changeset
303 #ifdef __cplusplus
kono
parents:
diff changeset
304 extern "C" {
kono
parents:
diff changeset
305 #endif
kono
parents:
diff changeset
306 DLL_LOCAL void __liboffload_error_support(error_types input_tag, ...);
kono
parents:
diff changeset
307 DLL_LOCAL void __liboffload_report_support(error_types input_tag, ...);
kono
parents:
diff changeset
308 DLL_LOCAL char const *offload_get_message_str(int msgCode);
kono
parents:
diff changeset
309 DLL_LOCAL char const * report_get_message_str(error_types input_tag);
kono
parents:
diff changeset
310 DLL_LOCAL char const * report_get_host_stage_str(int i);
kono
parents:
diff changeset
311 DLL_LOCAL char const * report_get_target_stage_str(int i);
kono
parents:
diff changeset
312 #ifdef __cplusplus
kono
parents:
diff changeset
313 }
kono
parents:
diff changeset
314 #endif
kono
parents:
diff changeset
315
kono
parents:
diff changeset
316 #define test_msg_cat(nm, msg) \
kono
parents:
diff changeset
317 fprintf(stderr, "\t TEST for %s \n \t", nm); \
kono
parents:
diff changeset
318 __liboffload_error_support(msg);
kono
parents:
diff changeset
319
kono
parents:
diff changeset
320 #define test_msg_cat1(nm, msg, ...) \
kono
parents:
diff changeset
321 fprintf(stderr, "\t TEST for %s \n \t", nm); \
kono
parents:
diff changeset
322 __liboffload_error_support(msg, __VA_ARGS__);
kono
parents:
diff changeset
323
kono
parents:
diff changeset
324 DLL_LOCAL void write_message(FILE * file, int msgCode, va_list args_p);
kono
parents:
diff changeset
325
kono
parents:
diff changeset
326 #define LIBOFFLOAD_ERROR __liboffload_error_support
kono
parents:
diff changeset
327
kono
parents:
diff changeset
328 #ifdef TARGET_WINNT
kono
parents:
diff changeset
329 #define LIBOFFLOAD_ABORT \
kono
parents:
diff changeset
330 _set_abort_behavior(0, _WRITE_ABORT_MSG); \
kono
parents:
diff changeset
331 abort()
kono
parents:
diff changeset
332 #else
kono
parents:
diff changeset
333 #define LIBOFFLOAD_ABORT \
kono
parents:
diff changeset
334 abort()
kono
parents:
diff changeset
335 #endif
kono
parents:
diff changeset
336
kono
parents:
diff changeset
337 #endif // !defined(LIBOFFLOAD_ERROR_CODES_H)