starpu_mpi.c 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967
  1. /* StarPU --- Runtime system for heterogeneous multicore architectures.
  2. *
  3. * Copyright (C) 2009, 2010-2012 Université de Bordeaux 1
  4. * Copyright (C) 2010, 2011, 2012 Centre National de la Recherche Scientifique
  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. #include <stdlib.h>
  18. #include <starpu_mpi.h>
  19. #include <starpu_mpi_datatype.h>
  20. //#define STARPU_MPI_VERBOSE 1
  21. #include <starpu_mpi_private.h>
  22. #include <starpu_profiling.h>
  23. #include <starpu_mpi_stats.h>
  24. #include <starpu_mpi_insert_task.h>
  25. #ifdef STARPU_DEVEL
  26. # warning TODO find a better way to select the polling method (perhaps during the configuration)
  27. #endif
  28. //#define USE_STARPU_ACTIVITY 1
  29. static void _starpu_mpi_submit_new_mpi_request(void *arg);
  30. static void _starpu_mpi_handle_request_termination(struct _starpu_mpi_req *req);
  31. #ifdef STARPU_MPI_VERBOSE
  32. static char *_starpu_mpi_request_type(enum _starpu_mpi_request_type request_type);
  33. #endif
  34. static struct _starpu_mpi_req *_starpu_mpi_isend_common(starpu_data_handle_t data_handle,
  35. int dest, int mpi_tag, MPI_Comm comm,
  36. unsigned detached, void (*callback)(void *), void *arg);
  37. static struct _starpu_mpi_req *_starpu_mpi_irecv_common(starpu_data_handle_t data_handle, int source, int mpi_tag, MPI_Comm comm, unsigned detached, void (*callback)(void *), void *arg);
  38. static void _starpu_mpi_handle_detached_request(struct _starpu_mpi_req *req);
  39. /* The list of requests that have been newly submitted by the application */
  40. static struct _starpu_mpi_req_list *new_requests;
  41. /* The list of detached requests that have already been submitted to MPI */
  42. static struct _starpu_mpi_req_list *detached_requests;
  43. static _starpu_pthread_mutex_t detached_requests_mutex;
  44. /* Condition to wake up progression thread */
  45. static _starpu_pthread_cond_t cond_progression;
  46. /* Condition to wake up waiting for all current MPI requests to finish */
  47. static _starpu_pthread_cond_t cond_finished;
  48. static _starpu_pthread_mutex_t mutex;
  49. static pthread_t progress_thread;
  50. static int running = 0;
  51. /* Count requests posted by the application and not yet submitted to MPI, i.e pushed into the new_requests list */
  52. static _starpu_pthread_mutex_t mutex_posted_requests;
  53. static int posted_requests = 0, newer_requests, barrier_running = 0;
  54. #define _STARPU_MPI_INC_POSTED_REQUESTS(value) { _STARPU_PTHREAD_MUTEX_LOCK(&mutex_posted_requests); posted_requests += value; _STARPU_PTHREAD_MUTEX_UNLOCK(&mutex_posted_requests); }
  55. /********************************************************/
  56. /* */
  57. /* Send/Receive functionalities */
  58. /* */
  59. /********************************************************/
  60. static struct _starpu_mpi_req *_starpu_mpi_isend_irecv_common(starpu_data_handle_t data_handle,
  61. int srcdst, int mpi_tag, MPI_Comm comm,
  62. unsigned detached, void (*callback)(void *), void *arg,
  63. enum _starpu_mpi_request_type request_type, void (*func)(struct _starpu_mpi_req *),
  64. enum starpu_access_mode mode)
  65. {
  66. _STARPU_MPI_LOG_IN();
  67. struct _starpu_mpi_req *req = calloc(1, sizeof(struct _starpu_mpi_req));
  68. STARPU_ASSERT(req);
  69. _STARPU_MPI_INC_POSTED_REQUESTS(1);
  70. /* Initialize the request structure */
  71. req->submitted = 0;
  72. req->completed = 0;
  73. _STARPU_PTHREAD_MUTEX_INIT(&req->req_mutex, NULL);
  74. _STARPU_PTHREAD_COND_INIT(&req->req_cond, NULL);
  75. req->request_type = request_type;
  76. req->data_handle = data_handle;
  77. req->srcdst = srcdst;
  78. req->mpi_tag = mpi_tag;
  79. req->comm = comm;
  80. req->detached = detached;
  81. req->callback = callback;
  82. req->callback_arg = arg;
  83. req->func = func;
  84. /* Asynchronously request StarPU to fetch the data in main memory: when
  85. * it is available in main memory, _starpu_mpi_submit_new_mpi_request(req) is called and
  86. * the request is actually submitted */
  87. starpu_data_acquire_cb(data_handle, mode, _starpu_mpi_submit_new_mpi_request, (void *)req);
  88. _STARPU_MPI_LOG_OUT();
  89. return req;
  90. }
  91. /********************************************************/
  92. /* */
  93. /* Send functionalities */
  94. /* */
  95. /********************************************************/
  96. static void _starpu_mpi_isend_data_func(struct _starpu_mpi_req *req)
  97. {
  98. _STARPU_MPI_LOG_IN();
  99. STARPU_ASSERT(req->ptr);
  100. _STARPU_MPI_DEBUG("post MPI isend tag %d dst %d ptr %p datatype %p count %d req %p\n", req->mpi_tag, req->srcdst, req->ptr, req->datatype, (int)req->count, &req->request);
  101. _starpu_mpi_comm_amounts_inc(req->comm, req->srcdst, req->datatype, req->count);
  102. req->ret = MPI_Isend(req->ptr, req->count, req->datatype, req->srcdst, req->mpi_tag, req->comm, &req->request);
  103. STARPU_ASSERT(req->ret == MPI_SUCCESS);
  104. TRACE_MPI_ISEND(req->srcdst, req->mpi_tag, 0);
  105. /* somebody is perhaps waiting for the MPI request to be posted */
  106. _STARPU_PTHREAD_MUTEX_LOCK(&req->req_mutex);
  107. req->submitted = 1;
  108. _STARPU_PTHREAD_COND_BROADCAST(&req->req_cond);
  109. _STARPU_PTHREAD_MUTEX_UNLOCK(&req->req_mutex);
  110. _starpu_mpi_handle_detached_request(req);
  111. _STARPU_MPI_LOG_OUT();
  112. }
  113. static void _starpu_mpi_isend_size_callback(void *arg)
  114. {
  115. struct _starpu_mpi_req *req = (struct _starpu_mpi_req *) arg;
  116. _starpu_mpi_isend_data_func(req);
  117. }
  118. static void _starpu_mpi_isend_size_func(struct _starpu_mpi_req *req)
  119. {
  120. _starpu_mpi_handle_allocate_datatype(req->data_handle, &req->datatype, &req->user_datatype);
  121. if (req->user_datatype == 0)
  122. {
  123. req->count = 1;
  124. req->ptr = starpu_handle_get_local_ptr(req->data_handle);
  125. _starpu_mpi_isend_data_func(req);
  126. }
  127. else
  128. {
  129. starpu_data_handle_t count_handle;
  130. starpu_handle_pack_data(req->data_handle, &req->ptr, &req->count);
  131. starpu_variable_data_register(&count_handle, 0, (uintptr_t)&req->count, sizeof(req->count));
  132. _starpu_mpi_isend_common(count_handle, req->srcdst, req->mpi_tag, req->comm, 1, _starpu_mpi_isend_size_callback, req);
  133. starpu_data_unregister_submit(count_handle);
  134. }
  135. }
  136. static struct _starpu_mpi_req *_starpu_mpi_isend_common(starpu_data_handle_t data_handle,
  137. int dest, int mpi_tag, MPI_Comm comm,
  138. unsigned detached, void (*callback)(void *), void *arg)
  139. {
  140. return _starpu_mpi_isend_irecv_common(data_handle, dest, mpi_tag, comm, detached, callback, arg, SEND_REQ, _starpu_mpi_isend_size_func, STARPU_R);
  141. }
  142. int starpu_mpi_isend(starpu_data_handle_t data_handle, starpu_mpi_req *public_req, int dest, int mpi_tag, MPI_Comm comm)
  143. {
  144. _STARPU_MPI_LOG_IN();
  145. STARPU_ASSERT(public_req);
  146. struct _starpu_mpi_req *req;
  147. req = _starpu_mpi_isend_common(data_handle, dest, mpi_tag, comm, 0, NULL, NULL);
  148. STARPU_ASSERT(req);
  149. *public_req = req;
  150. _STARPU_MPI_LOG_OUT();
  151. return 0;
  152. }
  153. int starpu_mpi_isend_detached(starpu_data_handle_t data_handle,
  154. int dest, int mpi_tag, MPI_Comm comm, void (*callback)(void *), void *arg)
  155. {
  156. _STARPU_MPI_LOG_IN();
  157. _starpu_mpi_isend_common(data_handle, dest, mpi_tag, comm, 1, callback, arg);
  158. _STARPU_MPI_LOG_OUT();
  159. return 0;
  160. }
  161. int starpu_mpi_send(starpu_data_handle_t data_handle, int dest, int mpi_tag, MPI_Comm comm)
  162. {
  163. starpu_mpi_req req;
  164. MPI_Status status;
  165. _STARPU_MPI_LOG_IN();
  166. memset(&status, 0, sizeof(MPI_Status));
  167. starpu_mpi_isend(data_handle, &req, dest, mpi_tag, comm);
  168. starpu_mpi_wait(&req, &status);
  169. _STARPU_MPI_LOG_OUT();
  170. return 0;
  171. }
  172. /********************************************************/
  173. /* */
  174. /* Receive functionalities */
  175. /* */
  176. /********************************************************/
  177. static void _starpu_mpi_irecv_data_func(struct _starpu_mpi_req *req)
  178. {
  179. _STARPU_MPI_LOG_IN();
  180. STARPU_ASSERT(req->ptr);
  181. _STARPU_MPI_DEBUG("post MPI irecv tag %d src %d data %p ptr %p datatype %p count %d req %p \n", req->mpi_tag, req->srcdst, req->data_handle, req->ptr, req->datatype, (int)req->count, &req->request);
  182. req->ret = MPI_Irecv(req->ptr, req->count, req->datatype, req->srcdst, req->mpi_tag, req->comm, &req->request);
  183. STARPU_ASSERT(req->ret == MPI_SUCCESS);
  184. /* somebody is perhaps waiting for the MPI request to be posted */
  185. _STARPU_PTHREAD_MUTEX_LOCK(&req->req_mutex);
  186. req->submitted = 1;
  187. _STARPU_PTHREAD_COND_BROADCAST(&req->req_cond);
  188. _STARPU_PTHREAD_MUTEX_UNLOCK(&req->req_mutex);
  189. _starpu_mpi_handle_detached_request(req);
  190. _STARPU_MPI_LOG_OUT();
  191. }
  192. struct _starpu_mpi_irecv_size_callback
  193. {
  194. starpu_data_handle_t handle;
  195. struct _starpu_mpi_req *req;
  196. };
  197. static void _starpu_mpi_irecv_size_callback(void *arg)
  198. {
  199. struct _starpu_mpi_irecv_size_callback *callback = (struct _starpu_mpi_irecv_size_callback *)arg;
  200. starpu_data_unregister(callback->handle);
  201. callback->req->ptr = malloc(callback->req->count);
  202. #ifdef STARPU_DEVEL
  203. #warning TODO: in some cases, callback->req->count is incorrect, we need to fix that
  204. #endif
  205. STARPU_ASSERT_MSG(callback->req->ptr, "cannot allocate message of size %ld\n", callback->req->count);
  206. _starpu_mpi_irecv_data_func(callback->req);
  207. free(callback);
  208. }
  209. static void _starpu_mpi_irecv_size_func(struct _starpu_mpi_req *req)
  210. {
  211. _STARPU_MPI_LOG_IN();
  212. _starpu_mpi_handle_allocate_datatype(req->data_handle, &req->datatype, &req->user_datatype);
  213. if (req->user_datatype == 0)
  214. {
  215. req->count = 1;
  216. req->ptr = starpu_handle_get_local_ptr(req->data_handle);
  217. _starpu_mpi_irecv_data_func(req);
  218. }
  219. else
  220. {
  221. starpu_data_handle_t count_handle;
  222. struct _starpu_mpi_irecv_size_callback *callback = malloc(sizeof(struct _starpu_mpi_irecv_size_callback));
  223. starpu_variable_data_register(&count_handle, 0, (uintptr_t)&req->count, sizeof(req->count));
  224. callback->handle = count_handle;
  225. callback->req = req;
  226. _starpu_mpi_irecv_common(count_handle, req->srcdst, req->mpi_tag, req->comm, 1, _starpu_mpi_irecv_size_callback, callback);
  227. }
  228. }
  229. static struct _starpu_mpi_req *_starpu_mpi_irecv_common(starpu_data_handle_t data_handle, int source, int mpi_tag, MPI_Comm comm, unsigned detached, void (*callback)(void *), void *arg)
  230. {
  231. return _starpu_mpi_isend_irecv_common(data_handle, source, mpi_tag, comm, detached, callback, arg, RECV_REQ, _starpu_mpi_irecv_size_func, STARPU_W);
  232. }
  233. int starpu_mpi_irecv(starpu_data_handle_t data_handle, starpu_mpi_req *public_req, int source, int mpi_tag, MPI_Comm comm)
  234. {
  235. _STARPU_MPI_LOG_IN();
  236. STARPU_ASSERT(public_req);
  237. struct _starpu_mpi_req *req;
  238. req = _starpu_mpi_irecv_common(data_handle, source, mpi_tag, comm, 0, NULL, NULL);
  239. STARPU_ASSERT(req);
  240. *public_req = req;
  241. _STARPU_MPI_LOG_OUT();
  242. return 0;
  243. }
  244. int starpu_mpi_irecv_detached(starpu_data_handle_t data_handle, int source, int mpi_tag, MPI_Comm comm, void (*callback)(void *), void *arg)
  245. {
  246. _STARPU_MPI_LOG_IN();
  247. _starpu_mpi_irecv_common(data_handle, source, mpi_tag, comm, 1, callback, arg);
  248. _STARPU_MPI_LOG_OUT();
  249. return 0;
  250. }
  251. int starpu_mpi_recv(starpu_data_handle_t data_handle, int source, int mpi_tag, MPI_Comm comm, MPI_Status *status)
  252. {
  253. starpu_mpi_req req;
  254. _STARPU_MPI_LOG_IN();
  255. starpu_mpi_irecv(data_handle, &req, source, mpi_tag, comm);
  256. starpu_mpi_wait(&req, status);
  257. _STARPU_MPI_LOG_OUT();
  258. return 0;
  259. }
  260. /********************************************************/
  261. /* */
  262. /* Wait functionalities */
  263. /* */
  264. /********************************************************/
  265. static void _starpu_mpi_wait_func(struct _starpu_mpi_req *waiting_req)
  266. {
  267. _STARPU_MPI_LOG_IN();
  268. /* Which is the mpi request we are waiting for ? */
  269. struct _starpu_mpi_req *req = waiting_req->other_request;
  270. req->ret = MPI_Wait(&req->request, waiting_req->status);
  271. STARPU_ASSERT(req->ret == MPI_SUCCESS);
  272. _starpu_mpi_handle_request_termination(req);
  273. _STARPU_MPI_LOG_OUT();
  274. }
  275. int starpu_mpi_wait(starpu_mpi_req *public_req, MPI_Status *status)
  276. {
  277. _STARPU_MPI_LOG_IN();
  278. int ret;
  279. struct _starpu_mpi_req *waiting_req = calloc(1, sizeof(struct _starpu_mpi_req));
  280. STARPU_ASSERT(waiting_req);
  281. struct _starpu_mpi_req *req = *public_req;
  282. _STARPU_MPI_INC_POSTED_REQUESTS(1);
  283. /* We cannot try to complete a MPI request that was not actually posted
  284. * to MPI yet. */
  285. _STARPU_PTHREAD_MUTEX_LOCK(&(req->req_mutex));
  286. while (!(req->submitted))
  287. _STARPU_PTHREAD_COND_WAIT(&(req->req_cond), &(req->req_mutex));
  288. _STARPU_PTHREAD_MUTEX_UNLOCK(&(req->req_mutex));
  289. /* Initialize the request structure */
  290. _STARPU_PTHREAD_MUTEX_INIT(&(waiting_req->req_mutex), NULL);
  291. _STARPU_PTHREAD_COND_INIT(&(waiting_req->req_cond), NULL);
  292. waiting_req->status = status;
  293. waiting_req->other_request = req;
  294. waiting_req->func = _starpu_mpi_wait_func;
  295. waiting_req->request_type = WAIT_REQ;
  296. _starpu_mpi_submit_new_mpi_request(waiting_req);
  297. /* We wait for the MPI request to finish */
  298. _STARPU_PTHREAD_MUTEX_LOCK(&req->req_mutex);
  299. while (!req->completed)
  300. _STARPU_PTHREAD_COND_WAIT(&req->req_cond, &req->req_mutex);
  301. _STARPU_PTHREAD_MUTEX_UNLOCK(&req->req_mutex);
  302. ret = req->ret;
  303. /* The internal request structure was automatically allocated */
  304. *public_req = NULL;
  305. free(req);
  306. free(waiting_req);
  307. _STARPU_MPI_LOG_OUT();
  308. return ret;
  309. }
  310. /********************************************************/
  311. /* */
  312. /* Test functionalities */
  313. /* */
  314. /********************************************************/
  315. static void _starpu_mpi_test_func(struct _starpu_mpi_req *testing_req)
  316. {
  317. _STARPU_MPI_LOG_IN();
  318. /* Which is the mpi request we are testing for ? */
  319. struct _starpu_mpi_req *req = testing_req->other_request;
  320. _STARPU_MPI_DEBUG("Test request %p - mpitag %d - TYPE %s %d\n", &req->request, req->mpi_tag, _starpu_mpi_request_type(req->request_type), req->srcdst);
  321. req->ret = MPI_Test(&req->request, testing_req->flag, testing_req->status);
  322. STARPU_ASSERT(req->ret == MPI_SUCCESS);
  323. if (*testing_req->flag)
  324. {
  325. testing_req->ret = req->ret;
  326. _starpu_mpi_handle_request_termination(req);
  327. }
  328. _STARPU_PTHREAD_MUTEX_LOCK(&testing_req->req_mutex);
  329. testing_req->completed = 1;
  330. _STARPU_PTHREAD_COND_SIGNAL(&testing_req->req_cond);
  331. _STARPU_PTHREAD_MUTEX_UNLOCK(&testing_req->req_mutex);
  332. _STARPU_MPI_LOG_OUT();
  333. }
  334. int starpu_mpi_test(starpu_mpi_req *public_req, int *flag, MPI_Status *status)
  335. {
  336. _STARPU_MPI_LOG_IN();
  337. int ret = 0;
  338. STARPU_ASSERT(public_req);
  339. struct _starpu_mpi_req *req = *public_req;
  340. STARPU_ASSERT(!req->detached);
  341. _STARPU_PTHREAD_MUTEX_LOCK(&req->req_mutex);
  342. unsigned submitted = req->submitted;
  343. _STARPU_PTHREAD_MUTEX_UNLOCK(&req->req_mutex);
  344. if (submitted)
  345. {
  346. struct _starpu_mpi_req *testing_req = calloc(1, sizeof(struct _starpu_mpi_req));
  347. STARPU_ASSERT(testing_req);
  348. // memset(testing_req, 0, sizeof(struct _starpu_mpi_req));
  349. /* Initialize the request structure */
  350. _STARPU_PTHREAD_MUTEX_INIT(&(testing_req->req_mutex), NULL);
  351. _STARPU_PTHREAD_COND_INIT(&(testing_req->req_cond), NULL);
  352. testing_req->flag = flag;
  353. testing_req->status = status;
  354. testing_req->other_request = req;
  355. testing_req->func = _starpu_mpi_test_func;
  356. testing_req->completed = 0;
  357. testing_req->request_type = TEST_REQ;
  358. _STARPU_MPI_INC_POSTED_REQUESTS(1);
  359. _starpu_mpi_submit_new_mpi_request(testing_req);
  360. /* We wait for the test request to finish */
  361. _STARPU_PTHREAD_MUTEX_LOCK(&(testing_req->req_mutex));
  362. while (!(testing_req->completed))
  363. _STARPU_PTHREAD_COND_WAIT(&(testing_req->req_cond), &(testing_req->req_mutex));
  364. _STARPU_PTHREAD_MUTEX_UNLOCK(&(testing_req->req_mutex));
  365. ret = testing_req->ret;
  366. if (*(testing_req->flag))
  367. {
  368. /* The request was completed so we free the internal
  369. * request structure which was automatically allocated
  370. * */
  371. *public_req = NULL;
  372. free(req);
  373. }
  374. free(testing_req);
  375. }
  376. else
  377. {
  378. *flag = 0;
  379. }
  380. _STARPU_MPI_LOG_OUT();
  381. return ret;
  382. }
  383. /********************************************************/
  384. /* */
  385. /* Barrier functionalities */
  386. /* */
  387. /********************************************************/
  388. static void _starpu_mpi_barrier_func(struct _starpu_mpi_req *barrier_req)
  389. {
  390. _STARPU_MPI_LOG_IN();
  391. barrier_req->ret = MPI_Barrier(barrier_req->comm);
  392. STARPU_ASSERT(barrier_req->ret == MPI_SUCCESS);
  393. _starpu_mpi_handle_request_termination(barrier_req);
  394. _STARPU_MPI_LOG_OUT();
  395. }
  396. int starpu_mpi_barrier(MPI_Comm comm)
  397. {
  398. _STARPU_MPI_LOG_IN();
  399. int ret;
  400. struct _starpu_mpi_req *barrier_req = calloc(1, sizeof(struct _starpu_mpi_req));
  401. STARPU_ASSERT(barrier_req);
  402. /* First wait for *both* all tasks and MPI requests to finish, in case
  403. * some tasks generate MPI requests, MPI requests generate tasks, etc.
  404. */
  405. _STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  406. STARPU_ASSERT_MSG(!barrier_running, "Concurrent starpu_mpi_barrier is not implemented, even on different communicators");
  407. barrier_running = 1;
  408. do
  409. {
  410. while (posted_requests)
  411. /* Wait for all current MPI requests to finish */
  412. _STARPU_PTHREAD_COND_WAIT(&cond_finished, &mutex);
  413. /* No current request, clear flag */
  414. newer_requests = 0;
  415. _STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  416. /* Now wait for all tasks */
  417. starpu_task_wait_for_all();
  418. _STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  419. /* Check newer_requests again, in case some MPI requests
  420. * triggered by tasks completed and triggered tasks between
  421. * wait_for_all finished and we take the lock */
  422. } while (posted_requests || newer_requests);
  423. barrier_running = 0;
  424. _STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  425. /* Initialize the request structure */
  426. _STARPU_PTHREAD_MUTEX_INIT(&(barrier_req->req_mutex), NULL);
  427. _STARPU_PTHREAD_COND_INIT(&(barrier_req->req_cond), NULL);
  428. barrier_req->func = _starpu_mpi_barrier_func;
  429. barrier_req->request_type = BARRIER_REQ;
  430. barrier_req->comm = comm;
  431. _STARPU_MPI_INC_POSTED_REQUESTS(1);
  432. _starpu_mpi_submit_new_mpi_request(barrier_req);
  433. /* We wait for the MPI request to finish */
  434. _STARPU_PTHREAD_MUTEX_LOCK(&barrier_req->req_mutex);
  435. while (!barrier_req->completed)
  436. _STARPU_PTHREAD_COND_WAIT(&barrier_req->req_cond, &barrier_req->req_mutex);
  437. _STARPU_PTHREAD_MUTEX_UNLOCK(&barrier_req->req_mutex);
  438. ret = barrier_req->ret;
  439. //free(waiting_req);
  440. _STARPU_MPI_LOG_OUT();
  441. return ret;
  442. }
  443. /********************************************************/
  444. /* */
  445. /* Progression */
  446. /* */
  447. /********************************************************/
  448. #ifdef STARPU_MPI_VERBOSE
  449. static char *_starpu_mpi_request_type(enum _starpu_mpi_request_type request_type)
  450. {
  451. switch (request_type)
  452. {
  453. case SEND_REQ: return "SEND_REQ";
  454. case RECV_REQ: return "RECV_REQ";
  455. case WAIT_REQ: return "WAIT_REQ";
  456. case TEST_REQ: return "TEST_REQ";
  457. case BARRIER_REQ: return "BARRIER_REQ";
  458. default: return "unknown request type";
  459. }
  460. }
  461. #endif
  462. static void _starpu_mpi_handle_request_termination(struct _starpu_mpi_req *req)
  463. {
  464. _STARPU_MPI_LOG_IN();
  465. _STARPU_MPI_DEBUG("complete MPI (%s %d) data %p req %p - tag %d\n", _starpu_mpi_request_type(req->request_type), req->srcdst, req->data_handle, &req->request, req->mpi_tag);
  466. if (req->request_type == RECV_REQ || req->request_type == SEND_REQ)
  467. {
  468. if (req->user_datatype == 1)
  469. {
  470. if (req->request_type == RECV_REQ)
  471. // req->ptr is freed by starpu_handle_unpack_data
  472. starpu_handle_unpack_data(req->data_handle, req->ptr, req->count);
  473. else
  474. free(req->ptr);
  475. }
  476. else
  477. {
  478. _starpu_mpi_handle_free_datatype(req->data_handle, &req->datatype);
  479. }
  480. starpu_data_release(req->data_handle);
  481. }
  482. if (req->request_type == RECV_REQ)
  483. {
  484. TRACE_MPI_IRECV_END(req->srcdst, req->mpi_tag);
  485. }
  486. /* Execute the specified callback, if any */
  487. if (req->callback)
  488. req->callback(req->callback_arg);
  489. /* tell anyone potentiallly waiting on the request that it is
  490. * terminated now */
  491. _STARPU_PTHREAD_MUTEX_LOCK(&req->req_mutex);
  492. req->completed = 1;
  493. _STARPU_PTHREAD_COND_BROADCAST(&req->req_cond);
  494. _STARPU_PTHREAD_MUTEX_UNLOCK(&req->req_mutex);
  495. _STARPU_MPI_LOG_OUT();
  496. }
  497. static void _starpu_mpi_submit_new_mpi_request(void *arg)
  498. {
  499. _STARPU_MPI_LOG_IN();
  500. struct _starpu_mpi_req *req = arg;
  501. _STARPU_MPI_INC_POSTED_REQUESTS(-1);
  502. _STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  503. _starpu_mpi_req_list_push_front(new_requests, req);
  504. newer_requests = 1;
  505. _STARPU_MPI_DEBUG("Pushing new request type %s\n", _starpu_mpi_request_type(req->request_type));
  506. _STARPU_PTHREAD_COND_BROADCAST(&cond_progression);
  507. _STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  508. _STARPU_MPI_LOG_OUT();
  509. }
  510. #ifdef USE_STARPU_ACTIVITY
  511. static unsigned _starpu_mpi_progression_hook_func(void *arg __attribute__((unused)))
  512. {
  513. unsigned may_block = 1;
  514. _STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  515. if (!_starpu_mpi_req_list_empty(detached_requests))
  516. {
  517. _STARPU_PTHREAD_COND_SIGNAL(&cond_progression);
  518. may_block = 0;
  519. }
  520. _STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  521. return may_block;
  522. }
  523. #endif
  524. static void _starpu_mpi_test_detached_requests(void)
  525. {
  526. _STARPU_MPI_LOG_IN();
  527. int flag;
  528. MPI_Status status;
  529. struct _starpu_mpi_req *req, *next_req;
  530. _STARPU_PTHREAD_MUTEX_LOCK(&detached_requests_mutex);
  531. for (req = _starpu_mpi_req_list_begin(detached_requests);
  532. req != _starpu_mpi_req_list_end(detached_requests);
  533. req = next_req)
  534. {
  535. next_req = _starpu_mpi_req_list_next(req);
  536. _STARPU_PTHREAD_MUTEX_UNLOCK(&detached_requests_mutex);
  537. //_STARPU_MPI_DEBUG("Test detached request %p - mpitag %d - TYPE %s %d\n", &req->request, req->mpi_tag, _starpu_mpi_request_type(req->request_type), req->srcdst);
  538. req->ret = MPI_Test(&req->request, &flag, &status);
  539. STARPU_ASSERT(req->ret == MPI_SUCCESS);
  540. if (flag)
  541. {
  542. _starpu_mpi_handle_request_termination(req);
  543. }
  544. _STARPU_PTHREAD_MUTEX_LOCK(&detached_requests_mutex);
  545. if (flag)
  546. {
  547. _starpu_mpi_req_list_erase(detached_requests, req);
  548. free(req);
  549. }
  550. }
  551. _STARPU_PTHREAD_MUTEX_UNLOCK(&detached_requests_mutex);
  552. _STARPU_MPI_LOG_OUT();
  553. }
  554. static void _starpu_mpi_handle_detached_request(struct _starpu_mpi_req *req)
  555. {
  556. if (req->detached)
  557. {
  558. _STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  559. _starpu_mpi_req_list_push_front(detached_requests, req);
  560. _STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  561. starpu_wake_all_blocked_workers();
  562. /* put the submitted request into the list of pending requests
  563. * so that it can be handled by the progression mechanisms */
  564. _STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  565. _STARPU_PTHREAD_COND_SIGNAL(&cond_progression);
  566. _STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  567. }
  568. }
  569. static void _starpu_mpi_handle_new_request(struct _starpu_mpi_req *req)
  570. {
  571. _STARPU_MPI_LOG_IN();
  572. STARPU_ASSERT(req);
  573. /* submit the request to MPI */
  574. _STARPU_MPI_DEBUG("Handling new request type %s\n", _starpu_mpi_request_type(req->request_type));
  575. req->func(req);
  576. _STARPU_MPI_LOG_OUT();
  577. }
  578. struct _starpu_mpi_argc_argv
  579. {
  580. int initialize_mpi;
  581. int *argc;
  582. char ***argv;
  583. };
  584. static void _starpu_mpi_print_thread_level_support(int thread_level, char *msg)
  585. {
  586. switch (thread_level)
  587. {
  588. case MPI_THREAD_SERIALIZED:
  589. {
  590. _STARPU_DISP("MPI%s MPI_THREAD_SERIALIZED; Multiple threads may make MPI calls, but only one at a time.\n", msg);
  591. break;
  592. }
  593. case MPI_THREAD_FUNNELED:
  594. {
  595. _STARPU_DISP("MPI%s MPI_THREAD_FUNNELED; The application can safely make calls to StarPU-MPI functions, but should not call directly MPI communication functions.\n", msg);
  596. break;
  597. }
  598. case MPI_THREAD_SINGLE:
  599. {
  600. _STARPU_DISP("MPI%s MPI_THREAD_SINGLE; MPI does not have multi-thread support, this might cause problems. The application can make calls to StarPU-MPI functions, but not call directly MPI Communication functions.\n", msg);
  601. break;
  602. }
  603. }
  604. }
  605. static void *_starpu_mpi_progress_thread_func(void *arg)
  606. {
  607. struct _starpu_mpi_argc_argv *argc_argv = (struct _starpu_mpi_argc_argv *) arg;
  608. if (argc_argv->initialize_mpi)
  609. {
  610. int thread_support;
  611. _STARPU_DEBUG("Calling MPI_Init_thread\n");
  612. if (MPI_Init_thread(argc_argv->argc, argc_argv->argv, MPI_THREAD_SERIALIZED, &thread_support) != MPI_SUCCESS)
  613. {
  614. _STARPU_ERROR("MPI_Init_thread failed\n");
  615. }
  616. _starpu_mpi_print_thread_level_support(thread_support, "_Init_thread level =");
  617. }
  618. else
  619. {
  620. int provided;
  621. MPI_Query_thread(&provided);
  622. _starpu_mpi_print_thread_level_support(provided, " has been initialized with");
  623. }
  624. /* notify the main thread that the progression thread is ready */
  625. _STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  626. running = 1;
  627. _STARPU_PTHREAD_COND_SIGNAL(&cond_progression);
  628. _STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  629. _STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  630. while (running || posted_requests || !(_starpu_mpi_req_list_empty(new_requests)) || !(_starpu_mpi_req_list_empty(detached_requests)))
  631. {
  632. /* shall we block ? */
  633. unsigned block = _starpu_mpi_req_list_empty(new_requests);
  634. #ifndef USE_STARPU_ACTIVITY
  635. block = block && _starpu_mpi_req_list_empty(detached_requests);
  636. #endif
  637. if (block)
  638. {
  639. _STARPU_MPI_DEBUG("NO MORE REQUESTS TO HANDLE\n");
  640. if (barrier_running)
  641. /* Tell mpi_barrier */
  642. _STARPU_PTHREAD_COND_SIGNAL(&cond_finished);
  643. _STARPU_PTHREAD_COND_WAIT(&cond_progression, &mutex);
  644. }
  645. /* test whether there are some terminated "detached request" */
  646. _STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  647. _starpu_mpi_test_detached_requests();
  648. _STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  649. /* get one request */
  650. struct _starpu_mpi_req *req;
  651. while (!_starpu_mpi_req_list_empty(new_requests))
  652. {
  653. req = _starpu_mpi_req_list_pop_back(new_requests);
  654. /* handling a request is likely to block for a while
  655. * (on a sync_data_with_mem call), we want to let the
  656. * application submit requests in the meantime, so we
  657. * release the lock. */
  658. _STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  659. _starpu_mpi_handle_new_request(req);
  660. _STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  661. }
  662. }
  663. STARPU_ASSERT(_starpu_mpi_req_list_empty(detached_requests));
  664. STARPU_ASSERT(_starpu_mpi_req_list_empty(new_requests));
  665. STARPU_ASSERT(posted_requests == 0);
  666. if (argc_argv->initialize_mpi)
  667. {
  668. _STARPU_MPI_DEBUG("Calling MPI_Finalize()\n");
  669. MPI_Finalize();
  670. }
  671. _STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  672. free(argc_argv);
  673. return NULL;
  674. }
  675. /********************************************************/
  676. /* */
  677. /* (De)Initialization methods */
  678. /* */
  679. /********************************************************/
  680. #ifdef USE_STARPU_ACTIVITY
  681. static int hookid = - 1;
  682. #endif
  683. static void _starpu_mpi_add_sync_point_in_fxt(void)
  684. {
  685. #ifdef STARPU_USE_FXT
  686. int rank;
  687. int worldsize;
  688. MPI_Comm_rank(MPI_COMM_WORLD, &rank);
  689. MPI_Comm_size(MPI_COMM_WORLD, &worldsize);
  690. int barrier_ret = MPI_Barrier(MPI_COMM_WORLD);
  691. STARPU_ASSERT(barrier_ret == MPI_SUCCESS);
  692. /* We generate a "unique" key so that we can make sure that different
  693. * FxT traces come from the same MPI run. */
  694. int random_number;
  695. /* XXX perhaps we don't want to generate a new seed if the application
  696. * specified some reproductible behaviour ? */
  697. if (rank == 0)
  698. {
  699. srand(time(NULL));
  700. random_number = rand();
  701. }
  702. MPI_Bcast(&random_number, 1, MPI_INT, 0, MPI_COMM_WORLD);
  703. TRACE_MPI_BARRIER(rank, worldsize, random_number);
  704. _STARPU_MPI_DEBUG("unique key %x\n", random_number);
  705. #endif
  706. }
  707. static
  708. int _starpu_mpi_initialize(int *argc, char ***argv, int initialize_mpi)
  709. {
  710. _STARPU_PTHREAD_MUTEX_INIT(&mutex, NULL);
  711. _STARPU_PTHREAD_COND_INIT(&cond_progression, NULL);
  712. _STARPU_PTHREAD_COND_INIT(&cond_finished, NULL);
  713. new_requests = _starpu_mpi_req_list_new();
  714. _STARPU_PTHREAD_MUTEX_INIT(&detached_requests_mutex, NULL);
  715. detached_requests = _starpu_mpi_req_list_new();
  716. _STARPU_PTHREAD_MUTEX_INIT(&mutex_posted_requests, NULL);
  717. struct _starpu_mpi_argc_argv *argc_argv = malloc(sizeof(struct _starpu_mpi_argc_argv));
  718. argc_argv->initialize_mpi = initialize_mpi;
  719. argc_argv->argc = argc;
  720. argc_argv->argv = argv;
  721. _STARPU_PTHREAD_CREATE("MPI progress", &progress_thread, NULL, _starpu_mpi_progress_thread_func, argc_argv);
  722. _STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  723. while (!running)
  724. _STARPU_PTHREAD_COND_WAIT(&cond_progression, &mutex);
  725. _STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  726. #ifdef STARPU_USE_FXT
  727. int prank;
  728. MPI_Comm_rank(MPI_COMM_WORLD, &prank);
  729. starpu_set_profiling_id(prank);
  730. #endif //STARPU_USE_FXT
  731. #ifdef USE_STARPU_ACTIVITY
  732. hookid = starpu_progression_hook_register(progression_hook_func, NULL);
  733. STARPU_ASSERT(hookid >= 0);
  734. #endif
  735. _starpu_mpi_add_sync_point_in_fxt();
  736. _starpu_mpi_comm_amounts_init(MPI_COMM_WORLD);
  737. _starpu_mpi_cache_init(MPI_COMM_WORLD);
  738. return 0;
  739. }
  740. int starpu_mpi_init(int *argc, char ***argv, int initialize_mpi)
  741. {
  742. return _starpu_mpi_initialize(argc, argv, initialize_mpi);
  743. }
  744. int starpu_mpi_initialize(void)
  745. {
  746. return _starpu_mpi_initialize(NULL, NULL, 0);
  747. }
  748. int starpu_mpi_initialize_extended(int *rank, int *world_size)
  749. {
  750. int ret;
  751. ret = _starpu_mpi_initialize(NULL, NULL, 1);
  752. if (ret == 0)
  753. {
  754. _STARPU_DEBUG("Calling MPI_Comm_rank\n");
  755. MPI_Comm_rank(MPI_COMM_WORLD, rank);
  756. MPI_Comm_size(MPI_COMM_WORLD, world_size);
  757. }
  758. return ret;
  759. }
  760. int starpu_mpi_shutdown(void)
  761. {
  762. void *value;
  763. int rank, world_size;
  764. /* We need to get the rank before calling MPI_Finalize to pass to _starpu_mpi_comm_amounts_display() */
  765. MPI_Comm_rank(MPI_COMM_WORLD, &rank);
  766. MPI_Comm_size(MPI_COMM_WORLD, &world_size);
  767. /* kill the progression thread */
  768. _STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  769. running = 0;
  770. _STARPU_PTHREAD_COND_BROADCAST(&cond_progression);
  771. _STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  772. pthread_join(progress_thread, &value);
  773. #ifdef USE_STARPU_ACTIVITY
  774. starpu_progression_hook_deregister(hookid);
  775. #endif
  776. /* free the request queues */
  777. _starpu_mpi_req_list_delete(detached_requests);
  778. _starpu_mpi_req_list_delete(new_requests);
  779. _starpu_mpi_comm_amounts_display(rank);
  780. _starpu_mpi_comm_amounts_free();
  781. _starpu_mpi_cache_free(world_size);
  782. return 0;
  783. }