liboffloadmic/runtime/liboffload_msg.h

   1 /*
   2     Copyright (c) 2014 Intel Corporation.  All Rights Reserved.
   3
   4     Redistribution and use in source and binary forms, with or without
   5     modification, are permitted provided that the following conditions
   6     are met:
   7
   8       * Redistributions of source code must retain the above copyright
   9         notice, this list of conditions and the following disclaimer.
  10       * Redistributions in binary form must reproduce the above copyright
  11         notice, this list of conditions and the following disclaimer in the
  12         documentation and/or other materials provided with the distribution.
  13       * Neither the name of Intel Corporation nor the names of its
  14         contributors may be used to endorse or promote products derived
  15         from this software without specific prior written permission.
  16
  17     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21     HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 */
  29
  30 // file: liboffload_msg.h
  31 enum {
  32         __dummy__ = 0,
  33         msg_c_device_is_not_available,
  34         msg_c_invalid_device_number,
  35         msg_c_send_func_ptr,
  36         msg_c_receive_func_ptr,
  37         msg_c_malloc,
  38         msg_c_offload_malloc,
  39         msg_c_offload1,
  40         msg_c_unknown_var_type,
  41         msg_c_invalid_env_var_value,
  42         msg_c_invalid_env_var_int_value,
  43         msg_c_invalid_env_report_value,
  44         msg_c_offload_signaled1,
  45         msg_c_offload_signaled2,
  46         msg_c_myowrapper_checkresult,
  47         msg_c_myotarget_checkresult,
  48         msg_c_offload_descriptor_offload,
  49         msg_c_merge_var_descs1,
  50         msg_c_merge_var_descs2,
  51         msg_c_mic_parse_env_var_list1,
  52         msg_c_mic_parse_env_var_list2,
  53         msg_c_mic_process_exit_ret,
  54         msg_c_mic_process_exit_sig,
  55         msg_c_mic_process_exit,
  56         msg_c_mic_init3,
  57         msg_c_mic_init4,
  58         msg_c_mic_init5,
  59         msg_c_mic_init6,
  60         msg_c_no_static_var_data,
  61         msg_c_no_ptr_data,
  62         msg_c_get_engine_handle,
  63         msg_c_get_engine_index,
  64         msg_c_process_create,
  65         msg_c_process_get_func_handles,
  66         msg_c_process_wait_shutdown,
  67         msg_c_process_proxy_flush,
  68         msg_c_load_library,
  69         msg_c_pipeline_create,
  70         msg_c_pipeline_run_func,
  71         msg_c_pipeline_start_run_funcs,
  72         msg_c_buf_create,
  73         msg_c_buf_create_out_of_mem,
  74         msg_c_buf_create_from_mem,
  75         msg_c_buf_destroy,
  76         msg_c_buf_map,
  77         msg_c_buf_unmap,
  78         msg_c_buf_read,
  79         msg_c_buf_write,
  80         msg_c_buf_copy,
  81         msg_c_buf_get_address,
  82         msg_c_buf_add_ref,
  83         msg_c_buf_release_ref,
  84         msg_c_buf_set_state,
  85         msg_c_event_wait,
  86         msg_c_zero_or_neg_ptr_len,
  87         msg_c_zero_or_neg_transfer_size,
  88         msg_c_bad_ptr_mem_range,
  89         msg_c_different_src_and_dstn_sizes,
  90         msg_c_non_contiguous_dope_vector,
  91         msg_c_omp_invalid_device_num_env,
  92         msg_c_omp_invalid_device_num,
  93         msg_c_unknown_binary_type,
  94         msg_c_multiple_target_exes,
  95         msg_c_no_target_exe,
  96         msg_c_report_unknown_timer_node,
  97         msg_c_report_unknown_trace_node,
  98         msg_c_report_host,
  99         msg_c_report_mic,
 100         msg_c_report_title,
 101         msg_c_report_seconds,
 102         msg_c_report_bytes,
 103         msg_c_report_cpu_time,
 104         msg_c_report_mic_time,
 105         msg_c_report_tag,
 106         msg_c_report_from_file,
 107         msg_c_report_file,
 108         msg_c_report_line,
 109         msg_c_report_cpu_to_mic_data,
 110         msg_c_report_mic_to_cpu_data,
 111         msg_c_report_offload,
 112         msg_c_report_w_tag,
 113         msg_c_report_state,
 114         msg_c_report_start,
 115         msg_c_report_init,
 116         msg_c_report_logical_card,
 117         msg_c_report_physical_card,
 118         msg_c_report_register,
 119         msg_c_report_init_func,
 120         msg_c_report_create_buf_host,
 121         msg_c_report_create_buf_mic,
 122         msg_c_report_send_pointer_data,
 123         msg_c_report_sent_pointer_data,
 124         msg_c_report_gather_copyin_data,
 125         msg_c_report_copyin_data,
 126         msg_c_report_state_signal,
 127         msg_c_report_signal,
 128         msg_c_report_wait,
 129         msg_c_report_compute,
 130         msg_c_report_receive_pointer_data,
 131         msg_c_report_received_pointer_data,
 132         msg_c_report_start_target_func,
 133         msg_c_report_var,
 134         msg_c_report_scatter_copyin_data,
 135         msg_c_report_gather_copyout_data,
 136         msg_c_report_scatter_copyout_data,
 137         msg_c_report_copyout_data,
 138         msg_c_report_unregister,
 139         msg_c_report_destroy,
 140         msg_c_report_myoinit,
 141         msg_c_report_myoregister,
 142         msg_c_report_myofini,
 143         msg_c_report_mic_myo_shared,
 144         msg_c_report_mic_myo_fptr,
 145         msg_c_report_myosharedmalloc,
 146         msg_c_report_myosharedfree,
 147         msg_c_report_myosharedalignedmalloc,
 148         msg_c_report_myosharedalignedfree,
 149         msg_c_report_myoacquire,
 150         msg_c_report_myorelease,
 151         msg_c_report_host_total_offload_time,
 152         msg_c_report_host_initialize,
 153         msg_c_report_host_target_acquire,
 154         msg_c_report_host_wait_deps,
 155         msg_c_report_host_setup_buffers,
 156         msg_c_report_host_alloc_buffers,
 157         msg_c_report_host_setup_misc_data,
 158         msg_c_report_host_alloc_data_buffer,
 159         msg_c_report_host_send_pointers,
 160         msg_c_report_host_gather_inputs,
 161         msg_c_report_host_map_in_data_buffer,
 162         msg_c_report_host_unmap_in_data_buffer,
 163         msg_c_report_host_start_compute,
 164         msg_c_report_host_wait_compute,
 165         msg_c_report_host_start_buffers_reads,
 166         msg_c_report_host_scatter_outputs,
 167         msg_c_report_host_map_out_data_buffer,
 168         msg_c_report_host_unmap_out_data_buffer,
 169         msg_c_report_host_wait_buffers_reads,
 170         msg_c_report_host_destroy_buffers,
 171         msg_c_report_target_total_time,
 172         msg_c_report_target_descriptor_setup,
 173         msg_c_report_target_func_lookup,
 174         msg_c_report_target_func_time,
 175         msg_c_report_target_scatter_inputs,
 176         msg_c_report_target_add_buffer_refs,
 177         msg_c_report_target_compute,
 178         msg_c_report_target_gather_outputs,
 179         msg_c_report_target_release_buffer_refs,
 180         msg_c_coi_pipeline_max_number,
 181         msg_c_ranges_dont_match,
 182         msg_c_destination_is_over,
 183         msg_c_slice_of_noncont_array,
 184         msg_c_pointer_array_mismatch,
 185         lastMsg = 153,
 186         firstMsg = 1
 187 };
 188
 189
 190 #if !defined(MESSAGE_TABLE_NAME)
 191 #    define MESSAGE_TABLE_NAME __liboffload_message_table
 192 #endif
 193
 194 static char const * MESSAGE_TABLE_NAME[] = {
 195         /*   0 __dummy__                               */ "Un-used message",
 196         /*   1 msg_c_device_is_not_available           */ "offload error: cannot offload to MIC - device is not available",
 197         /*   2 msg_c_invalid_device_number             */ "offload error: expected a number greater than or equal to -1",
 198         /*   3 msg_c_send_func_ptr                     */ "offload error: cannot find function name for address %p",
 199         /*   4 msg_c_receive_func_ptr                  */ "offload error: cannot find address of function %s",
 200         /*   5 msg_c_malloc                            */ "offload error: memory allocation failed",
 201         /*   6 msg_c_offload_malloc                    */ "offload error: memory allocation failed (requested=%lld bytes, align %lld)",
 202         /*   7 msg_c_offload1                          */ "offload error: device %d does not have a pending signal for wait(%p)",
 203         /*   8 msg_c_unknown_var_type                  */ "offload error: unknown variable type %d",
 204         /*   9 msg_c_invalid_env_var_value             */ "offload warning: ignoring invalid value specified for %s",
 205         /*  10 msg_c_invalid_env_var_int_value         */ "offload warning: specify an integer value for %s",
 206         /*  11 msg_c_invalid_env_report_value          */ "offload warning: ignoring %s setting; use a value in range 1-3",
 207         /*  12 msg_c_offload_signaled1                 */ "offload error: invalid device number %d specified in _Offload_signaled",
 208         /*  13 msg_c_offload_signaled2                 */ "offload error: invalid signal %p specified for _Offload_signaled",
 209         /*  14 msg_c_myowrapper_checkresult            */ "offload error: %s failed with error %d",
 210         /*  15 msg_c_myotarget_checkresult             */ "offload error: %s failed with error %d",
 211         /*  16 msg_c_offload_descriptor_offload        */ "offload error: cannot find offload entry %s",
 212         /*  17 msg_c_merge_var_descs1                  */ "offload error: unexpected number of variable descriptors",
 213         /*  18 msg_c_merge_var_descs2                  */ "offload error: unexpected variable type",
 214         /*  19 msg_c_mic_parse_env_var_list1           */ "offload_error: MIC environment variable must begin with an alpabetic character",
 215         /*  20 msg_c_mic_parse_env_var_list2           */ "offload_error: MIC environment variable value must be specified with \'=\'",
 216         /*  21 msg_c_mic_process_exit_ret              */ "offload error: process on the device %d unexpectedly exited with code %d",
 217         /*  22 msg_c_mic_process_exit_sig              */ "offload error: process on the device %d was terminated by signal %d (%s)",
 218         /*  23 msg_c_mic_process_exit                  */ "offload error: process on the device %d was unexpectedly terminated",
 219         /*  24 msg_c_mic_init3                         */ "offload warning: ignoring MIC_STACKSIZE setting; use a value >= 16K and a multiple of 4K",
 220         /*  25 msg_c_mic_init4                         */ "offload error: thread key create failed with error %d",
 221         /*  26 msg_c_mic_init5                         */ "offload warning: specify OFFLOAD_DEVICES as comma-separated physical device numbers or 'none'",
 222         /*  27 msg_c_mic_init6                         */ "offload warning: OFFLOAD_DEVICES device number %d does not correspond to a physical device",
 223         /*  28 msg_c_no_static_var_data                */ "offload error: cannot find data associated with statically allocated variable %p",
 224         /*  29 msg_c_no_ptr_data                       */ "offload error: cannot find data associated with pointer variable %p",
 225         /*  30 msg_c_get_engine_handle                 */ "offload error: cannot get device %d handle (error code %d)",
 226         /*  31 msg_c_get_engine_index                  */ "offload error: cannot get physical index for logical device %d (error code %d)",
 227         /*  32 msg_c_process_create                    */ "offload error: cannot start process on the device %d (error code %d)",
 228         /*  33 msg_c_process_get_func_handles          */ "offload error: cannot get function handles on the device %d (error code %d)",
 229         /*  34 msg_c_process_wait_shutdown             */ "offload error: wait for process shutdown failed on device %d (error code %d)",
 230         /*  35 msg_c_process_proxy_flush               */ "offload error: cannot flush process output on device %d (error code %d)",
 231         /*  36 msg_c_load_library                      */ "offload error: cannot load library to the device %d (error code %d)",
 232         /*  37 msg_c_pipeline_create                   */ "offload error: cannot create pipeline on the device %d (error code %d)",
 233         /*  38 msg_c_pipeline_run_func                 */ "offload error: cannot execute function on the device %d (error code %d)",
 234         /*  39 msg_c_pipeline_start_run_funcs          */ "offload error: cannot start executing pipeline function on the device %d (error code %d)",
 235         /*  40 msg_c_buf_create                        */ "offload error: cannot create buffer on device %d (error code %d)",
 236         /*  41 msg_c_buf_create_out_of_mem             */ "offload error: cannot create buffer on device %d, out of memory",
 237         /*  42 msg_c_buf_create_from_mem               */ "offload error: cannot create buffer from memory on device %d (error code %d)",
 238         /*  43 msg_c_buf_destroy                       */ "offload error: buffer destroy failed (error code %d)",
 239         /*  44 msg_c_buf_map                           */ "offload error: buffer map failed (error code %d)",
 240         /*  45 msg_c_buf_unmap                         */ "offload error: buffer unmap failed (error code %d)",
 241         /*  46 msg_c_buf_read                          */ "offload error: buffer read failed (error code %d)",
 242         /*  47 msg_c_buf_write                         */ "offload error: buffer write failed (error code %d)",
 243         /*  48 msg_c_buf_copy                          */ "offload error: buffer copy failed (error code %d)",
 244         /*  49 msg_c_buf_get_address                   */ "offload error: cannot get buffer address on device %d (error code %d)",
 245         /*  50 msg_c_buf_add_ref                       */ "offload error: cannot reuse buffer memory on device %d (error code %d)",
 246         /*  51 msg_c_buf_release_ref                   */ "offload error: cannot release buffer memory on device %d (error code %d)",
 247         /*  52 msg_c_buf_set_state                     */ "offload error: buffer set state failed (error code %d)",
 248         /*  53 msg_c_event_wait                        */ "offload error: wait for event to become signaled failed (error code %d)",
 249         /*  54 msg_c_zero_or_neg_ptr_len               */ "offload error: memory allocation of negative length is not supported",
 250         /*  55 msg_c_zero_or_neg_transfer_size         */ "offload error: data transfer of zero or negative size is not supported",
 251         /*  56 msg_c_bad_ptr_mem_range                 */ "offload error: address range partially overlaps with existing allocation",
 252         /*  57 msg_c_different_src_and_dstn_sizes      */ "offload error: size of the source %d differs from size of the destination %d",
 253         /*  58 msg_c_non_contiguous_dope_vector        */ "offload error: offload data transfer supports only a single contiguous memory range per variable",
 254         /*  59 msg_c_omp_invalid_device_num_env        */ "offload warning: ignoring %s setting; use a non-negative integer value",
 255         /*  60 msg_c_omp_invalid_device_num            */ "offload error: device number should be a non-negative integer value",
 256         /*  61 msg_c_unknown_binary_type               */ "offload error: unexpected embedded target binary type, expected either an executable or shared library",
 257         /*  62 msg_c_multiple_target_exes              */ "offload error: more that one target executable found",
 258         /*  63 msg_c_no_target_exe                     */ "offload error: target executable is not available",
 259         /*  64 msg_c_report_unknown_timer_node         */ "offload error: unknown timer node",
 260         /*  65 msg_c_report_unknown_trace_node         */ "offload error: unknown trace node",
 261         /*  66 msg_c_report_host                       */ "HOST",
 262         /*  67 msg_c_report_mic                        */ "MIC",
 263         /*  68 msg_c_report_title                      */ "timer data       (sec)",
 264         /*  69 msg_c_report_seconds                    */ "(seconds)",
 265         /*  70 msg_c_report_bytes                      */ "(bytes)",
 266         /*  71 msg_c_report_cpu_time                   */ "CPU Time",
 267         /*  72 msg_c_report_mic_time                   */ "MIC Time",
 268         /*  73 msg_c_report_tag                        */ "Tag",
 269         /*  74 msg_c_report_from_file                  */ "Offload from file",
 270         /*  75 msg_c_report_file                       */ "File",
 271         /*  76 msg_c_report_line                       */ "Line",
 272         /*  77 msg_c_report_cpu_to_mic_data            */ "CPU->MIC Data",
 273         /*  78 msg_c_report_mic_to_cpu_data            */ "MIC->CPU Data",
 274         /*  79 msg_c_report_offload                    */ "Offload",
 275         /*  80 msg_c_report_w_tag                      */ "Tag %d",
 276         /*  81 msg_c_report_state                      */ "State",
 277         /*  82 msg_c_report_start                      */ "Start target",
 278         /*  83 msg_c_report_init                       */ "Initialize",
 279         /*  84 msg_c_report_logical_card               */ "logical card",
 280         /*  85 msg_c_report_physical_card              */ "physical card",
 281         /*  86 msg_c_report_register                   */ "Register static data tables",
 282         /*  87 msg_c_report_init_func                  */ "Setup target entry",
 283         /*  88 msg_c_report_create_buf_host            */ "Create host buffer",
 284         /*  89 msg_c_report_create_buf_mic             */ "Create target buffer",
 285         /*  90 msg_c_report_send_pointer_data          */ "Send pointer data",
 286         /*  91 msg_c_report_sent_pointer_data          */ "Host->target pointer data",
 287         /*  92 msg_c_report_gather_copyin_data         */ "Gather copyin data",
 288         /*  93 msg_c_report_copyin_data                */ "Host->target copyin data",
 289         /*  94 msg_c_report_state_signal               */ "Signal",
 290         /*  95 msg_c_report_signal                     */ "signal :",
 291         /*  96 msg_c_report_wait                       */ "waits  :",
 292         /*  97 msg_c_report_compute                    */ "Execute task on target",
 293         /*  98 msg_c_report_receive_pointer_data       */ "Receive pointer data",
 294         /*  99 msg_c_report_received_pointer_data      */ "Target->host pointer data",
 295         /* 100 msg_c_report_start_target_func          */ "Start target entry",
 296         /* 101 msg_c_report_var                        */ "Var",
 297         /* 102 msg_c_report_scatter_copyin_data        */ "Scatter copyin data",
 298         /* 103 msg_c_report_gather_copyout_data        */ "Gather copyout data",
 299         /* 104 msg_c_report_scatter_copyout_data       */ "Scatter copyout data",
 300         /* 105 msg_c_report_copyout_data               */ "Target->host copyout data",
 301         /* 106 msg_c_report_unregister                 */ "Unregister data tables",
 302         /* 107 msg_c_report_destroy                    */ "Destroy",
 303         /* 108 msg_c_report_myoinit                    */ "Initialize MYO",
 304         /* 109 msg_c_report_myoregister                */ "Register MYO tables",
 305         /* 110 msg_c_report_myofini                    */ "Finalize MYO",
 306         /* 111 msg_c_report_mic_myo_shared             */ "MIC MYO shared table register",
 307         /* 112 msg_c_report_mic_myo_fptr               */ "MIC MYO fptr table register",
 308         /* 113 msg_c_report_myosharedmalloc            */ "MYO shared malloc",
 309         /* 114 msg_c_report_myosharedfree              */ "MYO shared free",
 310         /* 115 msg_c_report_myosharedalignedmalloc     */ "MYO shared aligned malloc",
 311         /* 116 msg_c_report_myosharedalignedfree       */ "MYO shared aligned free",
 312         /* 117 msg_c_report_myoacquire                 */ "MYO acquire",
 313         /* 118 msg_c_report_myorelease                 */ "MYO release",
 314         /* 119 msg_c_report_host_total_offload_time    */ "host: total offload time",
 315         /* 120 msg_c_report_host_initialize            */ "host: initialize target",
 316         /* 121 msg_c_report_host_target_acquire        */ "host: acquire target",
 317         /* 122 msg_c_report_host_wait_deps             */ "host: wait dependencies",
 318         /* 123 msg_c_report_host_setup_buffers         */ "host: setup buffers",
 319         /* 124 msg_c_report_host_alloc_buffers         */ "host: allocate buffers",
 320         /* 125 msg_c_report_host_setup_misc_data       */ "host: setup misc_data",
 321         /* 126 msg_c_report_host_alloc_data_buffer     */ "host: allocate buffer",
 322         /* 127 msg_c_report_host_send_pointers         */ "host: send pointers",
 323         /* 128 msg_c_report_host_gather_inputs         */ "host: gather inputs",
 324         /* 129 msg_c_report_host_map_in_data_buffer    */ "host: map IN data buffer",
 325         /* 130 msg_c_report_host_unmap_in_data_buffer  */ "host: unmap IN data buffer",
 326         /* 131 msg_c_report_host_start_compute         */ "host: initiate compute",
 327         /* 132 msg_c_report_host_wait_compute          */ "host: wait compute",
 328         /* 133 msg_c_report_host_start_buffers_reads   */ "host: initiate pointer reads",
 329         /* 134 msg_c_report_host_scatter_outputs       */ "host: scatter outputs",
 330         /* 135 msg_c_report_host_map_out_data_buffer   */ "host: map OUT data buffer",
 331         /* 136 msg_c_report_host_unmap_out_data_buffer */ "host: unmap OUT data buffer",
 332         /* 137 msg_c_report_host_wait_buffers_reads    */ "host: wait pointer reads",
 333         /* 138 msg_c_report_host_destroy_buffers       */ "host: destroy buffers",
 334         /* 139 msg_c_report_target_total_time          */ "target: total time",
 335         /* 140 msg_c_report_target_descriptor_setup    */ "target: setup offload descriptor",
 336         /* 141 msg_c_report_target_func_lookup         */ "target: entry lookup",
 337         /* 142 msg_c_report_target_func_time           */ "target: entry time",
 338         /* 143 msg_c_report_target_scatter_inputs      */ "target: scatter inputs",
 339         /* 144 msg_c_report_target_add_buffer_refs     */ "target: add buffer reference",
 340         /* 145 msg_c_report_target_compute             */ "target: compute",
 341         /* 146 msg_c_report_target_gather_outputs      */ "target: gather outputs",
 342         /* 147 msg_c_report_target_release_buffer_refs */ "target: remove buffer reference",
 343         /* 148 msg_c_coi_pipeline_max_number           */ "number of host threads doing offload exceeds maximum of %d",
 344         /* 149 msg_c_ranges_dont_match                 */ "ranges of source and destination don't match together",
 345         /* 150 msg_c_destination_is_over               */ "insufficient destination memory to transfer source",
 346         /* 151 msg_c_slice_of_noncont_array            */ "a non-contiguous slice may be taken of contiguous arrays only",
 347         /* 152 msg_c_pointer_array_mismatch            */ "number of %s elements is less than described by the source",
 348 };