StarPU Handbook
starpu.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2009-2020 Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria
4  *
5  * StarPU is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU Lesser General Public License as published by
7  * the Free Software Foundation; either version 2.1 of the License, or (at
8  * your option) any later version.
9  *
10  * StarPU is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13  *
14  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
15  */
16 
17 #ifndef __STARPU_H__
18 #define __STARPU_H__
19 
20 #include <stdlib.h>
21 
22 #ifndef _MSC_VER
23 #include <stdint.h>
24 #else
25 #include <windows.h>
26 typedef unsigned char uint8_t;
27 typedef unsigned short uint16_t;
28 typedef unsigned int uint32_t;
29 typedef unsigned long long uint64_t;
30 typedef UINT_PTR uintptr_t;
31 typedef char int8_t;
32 typedef short int16_t;
33 typedef int int32_t;
34 typedef long long int64_t;
35 typedef INT_PTR intptr_t;
36 #endif
37 
38 #include <starpu_config.h>
39 
40 #ifdef STARPU_HAVE_WINDOWS
41 #include <windows.h>
42 #endif
43 
44 #if defined(STARPU_USE_OPENCL) && !defined(__CUDACC__)
45 #include <starpu_opencl.h>
46 #endif
47 
48 #include <starpu_thread.h>
49 #include <starpu_thread_util.h>
50 #include <starpu_util.h>
51 #include <starpu_data.h>
52 #include <starpu_helper.h>
53 #include <starpu_disk.h>
54 #include <starpu_data_interfaces.h>
55 #include <starpu_data_filters.h>
56 #include <starpu_stdlib.h>
57 #include <starpu_task_bundle.h>
58 #include <starpu_task_dep.h>
59 #include <starpu_task.h>
60 #include <starpu_worker.h>
61 #include <starpu_perfmodel.h>
62 #include <starpu_worker.h>
63 #ifndef BUILDING_STARPU
64 #include <starpu_task_list.h>
65 #endif
66 #include <starpu_task_util.h>
67 #include <starpu_scheduler.h>
68 #include <starpu_sched_ctx.h>
69 #include <starpu_expert.h>
70 #include <starpu_rand.h>
71 #include <starpu_cuda.h>
72 #include <starpu_cublas.h>
73 #include <starpu_cusparse.h>
74 #include <starpu_bound.h>
75 #include <starpu_hash.h>
76 #include <starpu_profiling.h>
77 #include <starpu_fxt.h>
78 #include <starpu_driver.h>
79 #include <starpu_tree.h>
80 #include <starpu_openmp.h>
81 #include <starpu_simgrid_wrap.h>
82 #include <starpu_bitmap.h>
83 #include <starpu_clusters.h>
84 
85 #ifdef __cplusplus
86 extern "C"
87 {
88 #endif
89 
103 {
109  int magic;
110 
116  const char *sched_policy_name;
117 
124  void (*sched_policy_init)(unsigned);
125 
136 
142  int ncpus;
143 
150 
157  int ncuda;
158 
165  int nopencl;
166 
172  int nmic;
173 
180  int nmpi_ms;
181 
201 
218 
235 
252 
269 
289 
304 
312 
380 
394 
408 
417  int global_sched_ctx_min_priority;
418  int global_sched_ctx_max_priority;
419 
420 #ifdef STARPU_WORKER_CALLBACKS
421  void (*callback_worker_going_to_sleep)(unsigned workerid);
422  void (*callback_worker_waking_up)(unsigned workerid);
423 #endif
424 
436 };
437 
448 int starpu_conf_init(struct starpu_conf *conf);
449 
459 int starpu_init(struct starpu_conf *conf) STARPU_WARN_UNUSED_RESULT;
460 
467 int starpu_initialize(struct starpu_conf *user_conf, int *argc, char ***argv);
468 
472 int starpu_is_initialized(void);
473 
477 void starpu_wait_initialized(void);
478 
485 void starpu_shutdown(void);
486 
494 void starpu_pause(void);
499 void starpu_resume(void);
500 
507 #define STARPU_THREAD_ACTIVE (1 << 0)
508 
517 unsigned starpu_get_next_bindid(unsigned flags, unsigned *preferred, unsigned npreferred);
518 
530 int starpu_bind_thread_on(int cpuid, unsigned flags, const char *name);
531 
535 void starpu_topology_print(FILE *f);
536 
542 
548 
554 
560 
566 
567 void starpu_display_stats(void);
568 
569 void starpu_get_version(int *major, int *minor, int *release);
570 
573 #ifdef __cplusplus
574 }
575 #endif
576 
577 #include "starpu_deprecated_api.h"
578 
579 #endif /* __STARPU_H__ */
starpu_conf::disable_asynchronous_copy
int disable_asynchronous_copy
Definition: starpu.h:327
starpu_sched_policy
Definition: starpu_scheduler.h:82
starpu_conf::workers_mpi_ms_deviceid
unsigned workers_mpi_ms_deviceid[STARPU_NMAXWORKERS]
Definition: starpu.h:268
starpu_conf::calibrate
int calibrate
Definition: starpu.h:288
starpu_conf::disable_asynchronous_mic_copy
int disable_asynchronous_mic_copy
Definition: starpu.h:367
starpu_asynchronous_mpi_ms_copy_disabled
int starpu_asynchronous_mpi_ms_copy_disabled(void)
starpu_asynchronous_copy_disabled
int starpu_asynchronous_copy_disabled(void)
starpu_conf::n_cuda_opengl_interoperability
unsigned n_cuda_opengl_interoperability
Definition: starpu.h:393
starpu_conf
Definition: starpu.h:102
starpu_opencl.h
starpu_conf::mic_sink_program_path
char * mic_sink_program_path
Definition: starpu.h:311
starpu_openmp.h
starpu_clusters.h
starpu_get_next_bindid
unsigned starpu_get_next_bindid(unsigned flags, unsigned *preferred, unsigned npreferred)
starpu_tree.h
starpu_conf_init
int starpu_conf_init(struct starpu_conf *conf)
starpu_asynchronous_opencl_copy_disabled
int starpu_asynchronous_opencl_copy_disabled(void)
starpu_task_dep.h
starpu_hash.h
starpu_resume
void starpu_resume(void)
starpu_pause
void starpu_pause(void)
starpu_conf::ncuda
int ncuda
Definition: starpu.h:157
starpu_stdlib.h
starpu_conf::disable_asynchronous_mpi_ms_copy
int disable_asynchronous_mpi_ms_copy
Definition: starpu.h:379
STARPU_NMAXWORKERS
#define STARPU_NMAXWORKERS
Definition: starpu_config.h:226
starpu_driver.h
starpu_data.h
starpu_shutdown
void starpu_shutdown(void)
starpu_conf::sched_policy_name
const char * sched_policy_name
Definition: starpu.h:116
starpu_perfmodel.h
starpu_bind_thread_on
int starpu_bind_thread_on(int cpuid, unsigned flags, const char *name)
starpu_conf::use_explicit_workers_mic_deviceid
unsigned use_explicit_workers_mic_deviceid
Definition: starpu.h:245
starpu_conf::nmic
int nmic
Definition: starpu.h:172
starpu_conf::reserve_ncpus
int reserve_ncpus
Definition: starpu.h:149
starpu_wait_initialized
void starpu_wait_initialized(void)
starpu_profiling.h
starpu_driver
Definition: starpu_driver.h:38
starpu_conf::sched_policy
struct starpu_sched_policy * sched_policy
Definition: starpu.h:123
starpu_conf::nmpi_ms
int nmpi_ms
Definition: starpu.h:180
starpu_conf::use_explicit_workers_mpi_ms_deviceid
unsigned use_explicit_workers_mpi_ms_deviceid
Definition: starpu.h:261
starpu_conf::workers_bindid
unsigned workers_bindid[STARPU_NMAXWORKERS]
Definition: starpu.h:200
starpu_asynchronous_mic_copy_disabled
int starpu_asynchronous_mic_copy_disabled(void)
starpu_cublas.h
starpu_conf::use_explicit_workers_cuda_gpuid
unsigned use_explicit_workers_cuda_gpuid
Definition: starpu.h:211
starpu_init
int starpu_init(struct starpu_conf *conf) STARPU_WARN_UNUSED_RESULT
starpu_conf::precedence_over_environment_variables
int precedence_over_environment_variables
Definition: starpu.h:135
starpu_bitmap.h
starpu_initialize
int starpu_initialize(struct starpu_conf *user_conf, int *argc, char ***argv)
starpu_util.h
starpu_thread_util.h
starpu_conf::trace_buffer_size
unsigned trace_buffer_size
Definition: starpu.h:416
starpu_expert.h
starpu_conf::workers_opencl_gpuid
unsigned workers_opencl_gpuid[STARPU_NMAXWORKERS]
Definition: starpu.h:234
starpu_simgrid_wrap.h
starpu_topology_print
void starpu_topology_print(FILE *f)
starpu_get_version
void starpu_get_version(int *major, int *minor, int *release)
starpu_conf::use_explicit_workers_bindid
unsigned use_explicit_workers_bindid
Definition: starpu.h:190
starpu_task_util.h
starpu_task_list.h
starpu_thread.h
starpu_deprecated_api.h
starpu_conf::use_explicit_workers_opencl_gpuid
unsigned use_explicit_workers_opencl_gpuid
Definition: starpu.h:228
starpu_fxt.h
starpu_helper.h
starpu_task.h
starpu_conf::disable_asynchronous_cuda_copy
int disable_asynchronous_cuda_copy
Definition: starpu.h:339
starpu_config.h
starpu_rand.h
starpu_conf::magic
int magic
Definition: starpu.h:109
starpu_sched_ctx.h
starpu_disk.h
starpu_worker.h
starpu_asynchronous_cuda_copy_disabled
int starpu_asynchronous_cuda_copy_disabled(void)
starpu_conf::bus_calibrate
int bus_calibrate
Definition: starpu.h:277
starpu_conf::catch_signals
int catch_signals
Definition: starpu.h:435
starpu_data_interfaces.h
starpu_conf::not_launched_drivers
struct starpu_driver * not_launched_drivers
Definition: starpu.h:400
starpu_conf::cuda_opengl_interoperability
unsigned * cuda_opengl_interoperability
Definition: starpu.h:389
starpu_task_bundle.h
starpu_scheduler.h
starpu_conf::workers_mic_deviceid
unsigned workers_mic_deviceid[STARPU_NMAXWORKERS]
Definition: starpu.h:251
starpu_cusparse.h
starpu_conf::n_not_launched_drivers
unsigned n_not_launched_drivers
Definition: starpu.h:407
starpu_conf::nopencl
int nopencl
Definition: starpu.h:165
starpu_conf::workers_cuda_gpuid
unsigned workers_cuda_gpuid[STARPU_NMAXWORKERS]
Definition: starpu.h:217
starpu_data_filters.h
starpu_conf::disable_asynchronous_opencl_copy
int disable_asynchronous_opencl_copy
Definition: starpu.h:355
starpu_bound.h
starpu_conf::ncpus
int ncpus
Definition: starpu.h:142
starpu_cuda.h
starpu_conf::single_combined_worker
int single_combined_worker
Definition: starpu.h:303
starpu_is_initialized
int starpu_is_initialized(void)