starpu_driver.h 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. /* StarPU --- Runtime system for heterogeneous multicore architectures.
  2. *
  3. * Copyright (C) 2010-2013,2015,2017,2019 CNRS
  4. * Copyright (C) 2009-2014 Université de Bordeaux
  5. *
  6. * StarPU is free software; you can redistribute it and/or modify
  7. * it under the terms of the GNU Lesser General Public License as published by
  8. * the Free Software Foundation; either version 2.1 of the License, or (at
  9. * your option) any later version.
  10. *
  11. * StarPU is distributed in the hope that it will be useful, but
  12. * WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  14. *
  15. * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  16. */
  17. #ifndef __STARPU_DRIVER_H__
  18. #define __STARPU_DRIVER_H__
  19. #include <starpu_config.h>
  20. #if defined(STARPU_USE_OPENCL) && !defined(__CUDACC__)
  21. #include <starpu_opencl.h>
  22. #endif
  23. #ifdef __cplusplus
  24. extern "C"
  25. {
  26. #endif
  27. /**
  28. @defgroup API_Running_Drivers Running Drivers
  29. @{
  30. */
  31. /**
  32. structure for a driver
  33. */
  34. struct starpu_driver
  35. {
  36. /**
  37. Type of the driver. Only ::STARPU_CPU_WORKER, ::STARPU_CUDA_WORKER
  38. and ::STARPU_OPENCL_WORKER are currently supported.
  39. */
  40. enum starpu_worker_archtype type;
  41. /**
  42. Identifier of the driver.
  43. */
  44. union
  45. {
  46. unsigned cpu_id;
  47. unsigned cuda_id;
  48. #if defined(STARPU_USE_OPENCL) && !defined(__CUDACC__)
  49. cl_device_id opencl_id;
  50. #elif defined(STARPU_SIMGRID)
  51. unsigned opencl_id;
  52. #endif
  53. } id;
  54. };
  55. /**
  56. Initialize the given driver, run it until it receives a request to
  57. terminate, deinitialize it and return 0 on success. Return
  58. <c>-EINVAL</c> if starpu_driver::type is not a valid StarPU device type
  59. (::STARPU_CPU_WORKER, ::STARPU_CUDA_WORKER or ::STARPU_OPENCL_WORKER).
  60. This is the same as using the following functions: calling
  61. starpu_driver_init(), then calling starpu_driver_run_once() in a loop,
  62. and finally starpu_driver_deinit().
  63. */
  64. int starpu_driver_run(struct starpu_driver *d);
  65. /**
  66. Notify all running drivers that they should terminate.
  67. */
  68. void starpu_drivers_request_termination(void);
  69. /**
  70. Initialize the given driver. Return 0 on success, <c>-EINVAL</c>
  71. if starpu_driver::type is not a valid ::starpu_worker_archtype.
  72. */
  73. int starpu_driver_init(struct starpu_driver *d);
  74. /**
  75. Run the driver once, then return 0 on success, <c>-EINVAL</c> if
  76. starpu_driver::type is not a valid ::starpu_worker_archtype.
  77. */
  78. int starpu_driver_run_once(struct starpu_driver *d);
  79. /**
  80. Deinitialize the given driver. Return 0 on success, <c>-EINVAL</c> if
  81. starpu_driver::type is not a valid ::starpu_worker_archtype.
  82. */
  83. int starpu_driver_deinit(struct starpu_driver *d);
  84. /** @} */
  85. #ifdef __cplusplus
  86. }
  87. #endif
  88. #endif /* __STARPU_DRIVER_H__ */