starpu_mpi.c 52 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488
  1. /* StarPU --- Runtime system for heterogeneous multicore architectures.
  2. *
  3. * Copyright (C) 2009, 2010-2014 Université de Bordeaux
  4. * Copyright (C) 2010, 2011, 2012, 2013, 2014 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. #include <starpu_mpi_private.h>
  21. #include <starpu_profiling.h>
  22. #include <starpu_mpi_stats.h>
  23. #include <starpu_mpi_task_insert.h>
  24. #include <starpu_mpi_early_data.h>
  25. #include <starpu_mpi_early_request.h>
  26. #include <common/config.h>
  27. #include <common/thread.h>
  28. #include <datawizard/interfaces/data_interface.h>
  29. #include <datawizard/coherency.h>
  30. static void _starpu_mpi_add_sync_point_in_fxt(void);
  31. static void _starpu_mpi_submit_ready_request(void *arg);
  32. static void _starpu_mpi_handle_request_termination(struct _starpu_mpi_req *req);
  33. #ifdef STARPU_VERBOSE
  34. static char *_starpu_mpi_request_type(enum _starpu_mpi_request_type request_type);
  35. #endif
  36. static struct _starpu_mpi_req *_starpu_mpi_isend_common(starpu_data_handle_t data_handle,
  37. int dest, int data_tag, MPI_Comm comm,
  38. unsigned detached, unsigned sync, void (*callback)(void *), void *arg,
  39. int sequential_consistency);
  40. static struct _starpu_mpi_req *_starpu_mpi_irecv_common(starpu_data_handle_t data_handle,
  41. int source, int data_tag, MPI_Comm comm,
  42. unsigned detached, unsigned sync, void (*callback)(void *), void *arg,
  43. int sequential_consistency, int is_internal_req,
  44. starpu_ssize_t count);
  45. static void _starpu_mpi_handle_detached_request(struct _starpu_mpi_req *req);
  46. static void _starpu_mpi_early_data_cb(void* arg);
  47. /* The list of ready requests */
  48. static struct _starpu_mpi_req_list *ready_requests;
  49. /* The list of detached requests that have already been submitted to MPI */
  50. static struct _starpu_mpi_req_list *detached_requests;
  51. static starpu_pthread_mutex_t detached_requests_mutex;
  52. /* Condition to wake up progression thread */
  53. static starpu_pthread_cond_t cond_progression;
  54. /* Condition to wake up waiting for all current MPI requests to finish */
  55. static starpu_pthread_cond_t cond_finished;
  56. static starpu_pthread_mutex_t mutex;
  57. static starpu_pthread_t progress_thread;
  58. static int running = 0;
  59. /* Count requests posted by the application and not yet submitted to MPI */
  60. static starpu_pthread_mutex_t mutex_posted_requests;
  61. static int posted_requests = 0, newer_requests, barrier_running = 0;
  62. #define _STARPU_MPI_INC_POSTED_REQUESTS(value) { STARPU_PTHREAD_MUTEX_LOCK(&mutex_posted_requests); posted_requests += value; STARPU_PTHREAD_MUTEX_UNLOCK(&mutex_posted_requests); }
  63. static void _starpu_mpi_request_init(struct _starpu_mpi_req **req)
  64. {
  65. *req = malloc(sizeof(struct _starpu_mpi_req));
  66. STARPU_ASSERT_MSG(*req, "Invalid request");
  67. /* Initialize the request structure */
  68. (*req)->data_handle = NULL;
  69. (*req)->datatype = 0;
  70. (*req)->ptr = NULL;
  71. (*req)->count = -1;
  72. (*req)->user_datatype = -1;
  73. (*req)->srcdst = -1;
  74. (*req)->data_tag = -1;
  75. (*req)->comm = 0;
  76. (*req)->func = NULL;
  77. (*req)->status = NULL;
  78. (*req)->request = 0;
  79. (*req)->flag = NULL;
  80. (*req)->ret = -1;
  81. STARPU_PTHREAD_MUTEX_INIT(&((*req)->req_mutex), NULL);
  82. STARPU_PTHREAD_COND_INIT(&((*req)->req_cond), NULL);
  83. STARPU_PTHREAD_MUTEX_INIT(&((*req)->posted_mutex), NULL);
  84. STARPU_PTHREAD_COND_INIT(&((*req)->posted_cond), NULL);
  85. (*req)->request_type = UNKNOWN_REQ;
  86. (*req)->submitted = 0;
  87. (*req)->completed = 0;
  88. (*req)->posted = 0;
  89. (*req)->other_request = NULL;
  90. (*req)->sync = 0;
  91. (*req)->detached = -1;
  92. (*req)->callback = NULL;
  93. (*req)->callback_arg = NULL;
  94. (*req)->size_req = 0;
  95. (*req)->internal_req = NULL;
  96. (*req)->is_internal_req = 0;
  97. (*req)->envelope = NULL;
  98. (*req)->sequential_consistency = 1;
  99. }
  100. /********************************************************/
  101. /* */
  102. /* Send/Receive functionalities */
  103. /* */
  104. /********************************************************/
  105. struct _starpu_mpi_early_data_cb_args
  106. {
  107. starpu_data_handle_t data_handle;
  108. starpu_data_handle_t early_handle;
  109. struct _starpu_mpi_req *req;
  110. void *buffer;
  111. };
  112. static void _starpu_mpi_submit_ready_request(void *arg)
  113. {
  114. _STARPU_MPI_LOG_IN();
  115. struct _starpu_mpi_req *req = arg;
  116. _STARPU_MPI_INC_POSTED_REQUESTS(-1);
  117. _STARPU_MPI_DEBUG(3, "new req %p srcdst %d tag %d and type %s\n", req, req->srcdst, req->data_tag, _starpu_mpi_request_type(req->request_type));
  118. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  119. if (req->request_type == RECV_REQ)
  120. {
  121. /* Case : the request is the internal receive request submitted
  122. * by StarPU-MPI to receive incoming data without a matching
  123. * early_request from the application. We immediately allocate the
  124. * pointer associated to the data_handle, and push it into the
  125. * ready_requests list, so as the real MPI request can be submitted
  126. * before the next submission of the envelope-catching request. */
  127. if (req->is_internal_req)
  128. {
  129. _starpu_mpi_handle_allocate_datatype(req->data_handle, &req->datatype, &req->user_datatype);
  130. if (req->user_datatype == 0)
  131. {
  132. req->count = 1;
  133. req->ptr = starpu_data_get_local_ptr(req->data_handle);
  134. }
  135. else
  136. {
  137. STARPU_ASSERT(req->count);
  138. req->ptr = malloc(req->count);
  139. STARPU_ASSERT_MSG(req->ptr, "cannot allocate message of size %ld\n", req->count);
  140. }
  141. _STARPU_MPI_DEBUG(3, "Pushing internal starpu_mpi_irecv request %p type %s tag %d src %d data %p ptr %p datatype '%s' count %d user_datatype %d \n",
  142. req, _starpu_mpi_request_type(req->request_type), req->data_tag, req->srcdst, req->data_handle, req->ptr,
  143. _starpu_mpi_datatype(req->datatype), (int)req->count, req->user_datatype);
  144. _starpu_mpi_req_list_push_front(ready_requests, req);
  145. /* inform the starpu mpi thread that the request has been pushed in the ready_requests list */
  146. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  147. STARPU_PTHREAD_MUTEX_LOCK(&req->posted_mutex);
  148. req->posted = 1;
  149. STARPU_PTHREAD_COND_BROADCAST(&req->posted_cond);
  150. STARPU_PTHREAD_MUTEX_UNLOCK(&req->posted_mutex);
  151. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  152. }
  153. else
  154. {
  155. /* test whether the receive request has already been submitted internally by StarPU-MPI*/
  156. struct _starpu_mpi_early_data_handle *early_data_handle = _starpu_mpi_early_data_find(req->data_tag, req->srcdst);
  157. /* Case: a receive request for a data with the given tag and source has already been
  158. * posted by StarPU. Asynchronously requests a Read permission over the temporary handle ,
  159. * so as when the internal receive is completed, the _starpu_mpi_early_data_cb function
  160. * will be called to bring the data back to the original data handle associated to the request.*/
  161. if (early_data_handle)
  162. {
  163. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  164. STARPU_PTHREAD_MUTEX_LOCK(&(early_data_handle->req_mutex));
  165. while (!(early_data_handle->req_ready))
  166. STARPU_PTHREAD_COND_WAIT(&(early_data_handle->req_cond), &(early_data_handle->req_mutex));
  167. STARPU_PTHREAD_MUTEX_UNLOCK(&(early_data_handle->req_mutex));
  168. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  169. _STARPU_MPI_DEBUG(3, "The RECV request %p with tag %d has already been received, copying previously received data into handle's pointer..\n", req, req->data_tag);
  170. STARPU_ASSERT(req->data_handle != early_data_handle->handle);
  171. req->internal_req = early_data_handle->req;
  172. struct _starpu_mpi_early_data_cb_args *cb_args = malloc(sizeof(struct _starpu_mpi_early_data_cb_args));
  173. cb_args->data_handle = req->data_handle;
  174. cb_args->early_handle = early_data_handle->handle;
  175. cb_args->buffer = early_data_handle->buffer;
  176. cb_args->req = req;
  177. _STARPU_MPI_DEBUG(3, "Calling data_acquire_cb on starpu_mpi_copy_cb..\n");
  178. starpu_data_acquire_cb(early_data_handle->handle,STARPU_R,_starpu_mpi_early_data_cb,(void*) cb_args);
  179. }
  180. /* Case: no matching data has been received. Store the receive request as an early_request. */
  181. else
  182. {
  183. _STARPU_MPI_DEBUG(3, "Adding the pending receive request %p (srcdst %d tag %d) into the request hashmap\n", req, req->srcdst, req->data_tag);
  184. _starpu_mpi_early_request_add(req);
  185. }
  186. }
  187. }
  188. else
  189. {
  190. _starpu_mpi_req_list_push_front(ready_requests, req);
  191. _STARPU_MPI_DEBUG(3, "Pushing new request %p type %s tag %d src %d data %p ptr %p datatype '%s' count %d user_datatype %d \n",
  192. req, _starpu_mpi_request_type(req->request_type), req->data_tag, req->srcdst, req->data_handle, req->ptr, _starpu_mpi_datatype(req->datatype), (int)req->count, req->user_datatype);
  193. }
  194. newer_requests = 1;
  195. STARPU_PTHREAD_COND_BROADCAST(&cond_progression);
  196. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  197. _STARPU_MPI_LOG_OUT();
  198. }
  199. static struct _starpu_mpi_req *_starpu_mpi_isend_irecv_common(starpu_data_handle_t data_handle,
  200. int srcdst, int data_tag, MPI_Comm comm,
  201. unsigned detached, unsigned sync, void (*callback)(void *), void *arg,
  202. enum _starpu_mpi_request_type request_type, void (*func)(struct _starpu_mpi_req *),
  203. enum starpu_data_access_mode mode,
  204. int sequential_consistency,
  205. int is_internal_req,
  206. starpu_ssize_t count)
  207. {
  208. struct _starpu_mpi_req *req;
  209. _STARPU_MPI_LOG_IN();
  210. _STARPU_MPI_INC_POSTED_REQUESTS(1);
  211. /* Initialize the request structure */
  212. _starpu_mpi_request_init(&req);
  213. req->request_type = request_type;
  214. req->data_handle = data_handle;
  215. req->srcdst = srcdst;
  216. req->data_tag = data_tag;
  217. req->comm = comm;
  218. req->detached = detached;
  219. req->sync = sync;
  220. req->callback = callback;
  221. req->callback_arg = arg;
  222. req->func = func;
  223. req->sequential_consistency = sequential_consistency;
  224. req->is_internal_req = is_internal_req;
  225. req->count = count;
  226. /* Asynchronously request StarPU to fetch the data in main memory: when
  227. * it is available in main memory, _starpu_mpi_submit_ready_request(req) is called and
  228. * the request is actually submitted */
  229. starpu_data_acquire_cb_sequential_consistency(data_handle, mode, _starpu_mpi_submit_ready_request, (void *)req, sequential_consistency);
  230. _STARPU_MPI_LOG_OUT();
  231. return req;
  232. }
  233. /********************************************************/
  234. /* */
  235. /* Send functionalities */
  236. /* */
  237. /********************************************************/
  238. static void _starpu_mpi_isend_data_func(struct _starpu_mpi_req *req)
  239. {
  240. _STARPU_MPI_LOG_IN();
  241. _STARPU_MPI_DEBUG(2, "post MPI isend request %p type %s tag %d src %d data %p datasize %ld ptr %p datatype '%s' count %d user_datatype %d \n", req, _starpu_mpi_request_type(req->request_type), req->data_tag, req->srcdst, req->data_handle, starpu_data_get_size(req->data_handle), req->ptr, _starpu_mpi_datatype(req->datatype), (int)req->count, req->user_datatype);
  242. _starpu_mpi_comm_amounts_inc(req->comm, req->srcdst, req->datatype, req->count);
  243. _STARPU_MPI_TRACE_ISEND_SUBMIT_BEGIN(req->srcdst, req->data_tag, 0);
  244. if (req->sync == 0)
  245. {
  246. req->ret = MPI_Isend(req->ptr, req->count, req->datatype, req->srcdst, _starpu_mpi_tag, req->comm, &req->request);
  247. STARPU_ASSERT_MSG(req->ret == MPI_SUCCESS, "MPI_Isend returning %d", req->ret);
  248. }
  249. else
  250. {
  251. req->ret = MPI_Issend(req->ptr, req->count, req->datatype, req->srcdst, _starpu_mpi_tag, req->comm, &req->request);
  252. STARPU_ASSERT_MSG(req->ret == MPI_SUCCESS, "MPI_Issend returning %d", req->ret);
  253. }
  254. _STARPU_MPI_TRACE_ISEND_SUBMIT_END(req->srcdst, req->data_tag, 0);
  255. /* somebody is perhaps waiting for the MPI request to be posted */
  256. STARPU_PTHREAD_MUTEX_LOCK(&req->req_mutex);
  257. req->submitted = 1;
  258. STARPU_PTHREAD_COND_BROADCAST(&req->req_cond);
  259. STARPU_PTHREAD_MUTEX_UNLOCK(&req->req_mutex);
  260. _starpu_mpi_handle_detached_request(req);
  261. _STARPU_MPI_LOG_OUT();
  262. }
  263. static void _starpu_mpi_isend_size_func(struct _starpu_mpi_req *req)
  264. {
  265. _starpu_mpi_handle_allocate_datatype(req->data_handle, &req->datatype, &req->user_datatype);
  266. req->envelope = calloc(1,sizeof(struct _starpu_mpi_envelope));
  267. req->envelope->data_tag = req->data_tag;
  268. if (req->user_datatype == 0)
  269. {
  270. int size;
  271. req->count = 1;
  272. req->ptr = starpu_data_get_local_ptr(req->data_handle);
  273. MPI_Type_size(req->datatype, &size);
  274. req->envelope->size = (starpu_ssize_t)req->count * size;
  275. _STARPU_MPI_DEBUG(1, "Post MPI isend count (%ld) datatype_size %ld request to %d with tag %d\n",req->count,starpu_data_get_size(req->data_handle),req->srcdst, _starpu_mpi_tag);
  276. MPI_Isend(req->envelope, sizeof(struct _starpu_mpi_envelope), MPI_BYTE, req->srcdst, _starpu_mpi_tag, req->comm, &req->size_req);
  277. }
  278. else
  279. {
  280. int ret;
  281. // Do not pack the data, just try to find out the size
  282. starpu_data_pack(req->data_handle, NULL, &(req->envelope->size));
  283. if (req->envelope->size != -1)
  284. {
  285. // We already know the size of the data, let's send it to overlap with the packing of the data
  286. _STARPU_MPI_DEBUG(1, "Sending size %ld (%ld %s) with tag %d to node %d (first call to pack)\n", req->envelope->size, sizeof(req->count), _starpu_mpi_datatype(MPI_BYTE), _starpu_mpi_tag, req->srcdst);
  287. req->count = req->envelope->size;
  288. ret = MPI_Isend(req->envelope, sizeof(struct _starpu_mpi_envelope), MPI_BYTE, req->srcdst, _starpu_mpi_tag, req->comm, &req->size_req);
  289. STARPU_ASSERT_MSG(ret == MPI_SUCCESS, "when sending size, MPI_Isend returning %d", ret);
  290. }
  291. // Pack the data
  292. starpu_data_pack(req->data_handle, &req->ptr, &req->count);
  293. if (req->envelope->size == -1)
  294. {
  295. // We know the size now, let's send it
  296. _STARPU_MPI_DEBUG(1, "Sending size %ld (%ld %s) with tag %d to node %d (second call to pack)\n", req->envelope->size, sizeof(req->count), _starpu_mpi_datatype(MPI_BYTE), _starpu_mpi_tag, req->srcdst);
  297. ret = MPI_Isend(req->envelope, sizeof(struct _starpu_mpi_envelope), MPI_BYTE, req->srcdst, _starpu_mpi_tag, req->comm, &req->size_req);
  298. STARPU_ASSERT_MSG(ret == MPI_SUCCESS, "when sending size, MPI_Isend returning %d", ret);
  299. }
  300. else
  301. {
  302. // We check the size returned with the 2 calls to pack is the same
  303. STARPU_ASSERT_MSG(req->count == req->envelope->size, "Calls to pack_data returned different sizes %ld != %ld", req->count, req->envelope->size);
  304. }
  305. // We can send the data now
  306. }
  307. _starpu_mpi_isend_data_func(req);
  308. }
  309. static struct _starpu_mpi_req *_starpu_mpi_isend_common(starpu_data_handle_t data_handle,
  310. int dest, int data_tag, MPI_Comm comm,
  311. unsigned detached, unsigned sync, void (*callback)(void *), void *arg,
  312. int sequential_consistency)
  313. {
  314. return _starpu_mpi_isend_irecv_common(data_handle, dest, data_tag, comm, detached, sync, callback, arg, SEND_REQ, _starpu_mpi_isend_size_func, STARPU_R, sequential_consistency, 0, 0);
  315. }
  316. int starpu_mpi_isend(starpu_data_handle_t data_handle, starpu_mpi_req *public_req, int dest, int data_tag, MPI_Comm comm)
  317. {
  318. _STARPU_MPI_LOG_IN();
  319. STARPU_ASSERT_MSG(public_req, "starpu_mpi_isend needs a valid starpu_mpi_req");
  320. struct _starpu_mpi_req *req;
  321. _STARPU_MPI_TRACE_ISEND_COMPLETE_BEGIN(dest, data_tag, 0);
  322. req = _starpu_mpi_isend_common(data_handle, dest, data_tag, comm, 0, 0, NULL, NULL, 1);
  323. _STARPU_MPI_TRACE_ISEND_COMPLETE_END(dest, data_tag, 0);
  324. STARPU_ASSERT_MSG(req, "Invalid return for _starpu_mpi_isend_common");
  325. *public_req = req;
  326. _STARPU_MPI_LOG_OUT();
  327. return 0;
  328. }
  329. int starpu_mpi_isend_detached(starpu_data_handle_t data_handle,
  330. int dest, int data_tag, MPI_Comm comm, void (*callback)(void *), void *arg)
  331. {
  332. _STARPU_MPI_LOG_IN();
  333. _starpu_mpi_isend_common(data_handle, dest, data_tag, comm, 1, 0, callback, arg, 1);
  334. _STARPU_MPI_LOG_OUT();
  335. return 0;
  336. }
  337. int starpu_mpi_send(starpu_data_handle_t data_handle, int dest, int data_tag, MPI_Comm comm)
  338. {
  339. starpu_mpi_req req;
  340. MPI_Status status;
  341. _STARPU_MPI_LOG_IN();
  342. memset(&status, 0, sizeof(MPI_Status));
  343. starpu_mpi_isend(data_handle, &req, dest, data_tag, comm);
  344. starpu_mpi_wait(&req, &status);
  345. _STARPU_MPI_LOG_OUT();
  346. return 0;
  347. }
  348. int starpu_mpi_issend(starpu_data_handle_t data_handle, starpu_mpi_req *public_req, int dest, int data_tag, MPI_Comm comm)
  349. {
  350. _STARPU_MPI_LOG_IN();
  351. STARPU_ASSERT_MSG(public_req, "starpu_mpi_issend needs a valid starpu_mpi_req");
  352. struct _starpu_mpi_req *req;
  353. req = _starpu_mpi_isend_common(data_handle, dest, data_tag, comm, 0, 1, NULL, NULL, 1);
  354. STARPU_ASSERT_MSG(req, "Invalid return for _starpu_mpi_isend_common");
  355. *public_req = req;
  356. _STARPU_MPI_LOG_OUT();
  357. return 0;
  358. }
  359. int starpu_mpi_issend_detached(starpu_data_handle_t data_handle, int dest, int data_tag, MPI_Comm comm, void (*callback)(void *), void *arg)
  360. {
  361. _STARPU_MPI_LOG_IN();
  362. _starpu_mpi_isend_common(data_handle, dest, data_tag, comm, 1, 1, callback, arg, 1);
  363. _STARPU_MPI_LOG_OUT();
  364. return 0;
  365. }
  366. /********************************************************/
  367. /* */
  368. /* receive functionalities */
  369. /* */
  370. /********************************************************/
  371. static void _starpu_mpi_irecv_data_func(struct _starpu_mpi_req *req)
  372. {
  373. _STARPU_MPI_LOG_IN();
  374. _STARPU_MPI_DEBUG(20, "post MPI irecv request %p type %s tag %d src %d data %p ptr %p datatype '%s' count %d user_datatype %d \n", req, _starpu_mpi_request_type(req->request_type), req->data_tag, req->srcdst, req->data_handle, req->ptr, _starpu_mpi_datatype(req->datatype), (int)req->count, req->user_datatype);
  375. _STARPU_MPI_TRACE_IRECV_SUBMIT_BEGIN(req->srcdst, req->data_tag);
  376. req->ret = MPI_Irecv(req->ptr, req->count, req->datatype, req->srcdst, _starpu_mpi_tag, req->comm, &req->request);
  377. STARPU_ASSERT_MSG(req->ret == MPI_SUCCESS, "MPI_IRecv returning %d", req->ret);
  378. _STARPU_MPI_TRACE_IRECV_SUBMIT_END(req->srcdst, req->data_tag);
  379. /* somebody is perhaps waiting for the MPI request to be posted */
  380. STARPU_PTHREAD_MUTEX_LOCK(&req->req_mutex);
  381. req->submitted = 1;
  382. STARPU_PTHREAD_COND_BROADCAST(&req->req_cond);
  383. STARPU_PTHREAD_MUTEX_UNLOCK(&req->req_mutex);
  384. _starpu_mpi_handle_detached_request(req);
  385. _STARPU_MPI_LOG_OUT();
  386. }
  387. static struct _starpu_mpi_req *_starpu_mpi_irecv_common(starpu_data_handle_t data_handle, int source, int data_tag, MPI_Comm comm, unsigned detached, unsigned sync, void (*callback)(void *), void *arg, int sequential_consistency, int is_internal_req, starpu_ssize_t count)
  388. {
  389. return _starpu_mpi_isend_irecv_common(data_handle, source, data_tag, comm, detached, sync, callback, arg, RECV_REQ, _starpu_mpi_irecv_data_func, STARPU_W, sequential_consistency, is_internal_req, count);
  390. }
  391. int starpu_mpi_irecv(starpu_data_handle_t data_handle, starpu_mpi_req *public_req, int source, int data_tag, MPI_Comm comm)
  392. {
  393. _STARPU_MPI_LOG_IN();
  394. STARPU_ASSERT_MSG(public_req, "starpu_mpi_irecv needs a valid starpu_mpi_req");
  395. // // We check if a tag is defined for the data handle, if not,
  396. // // we define the one given for the communication.
  397. // // A tag is necessary for the internal mpi engine.
  398. // int tag = starpu_data_get_tag(data_handle);
  399. // if (tag == -1)
  400. // starpu_data_set_tag(data_handle, data_tag);
  401. struct _starpu_mpi_req *req;
  402. _STARPU_MPI_TRACE_IRECV_COMPLETE_BEGIN(source, data_tag);
  403. req = _starpu_mpi_irecv_common(data_handle, source, data_tag, comm, 0, 0, NULL, NULL, 1, 0, 0);
  404. _STARPU_MPI_TRACE_IRECV_COMPLETE_END(source, data_tag);
  405. STARPU_ASSERT_MSG(req, "Invalid return for _starpu_mpi_irecv_common");
  406. *public_req = req;
  407. _STARPU_MPI_LOG_OUT();
  408. return 0;
  409. }
  410. int starpu_mpi_irecv_detached(starpu_data_handle_t data_handle, int source, int data_tag, MPI_Comm comm, void (*callback)(void *), void *arg)
  411. {
  412. _STARPU_MPI_LOG_IN();
  413. // // We check if a tag is defined for the data handle, if not,
  414. // // we define the one given for the communication.
  415. // // A tag is necessary for the internal mpi engine.
  416. // int tag = starpu_data_get_tag(data_handle);
  417. // if (tag == -1)
  418. // starpu_data_set_tag(data_handle, data_tag);
  419. _starpu_mpi_irecv_common(data_handle, source, data_tag, comm, 1, 0, callback, arg, 1, 0, 0);
  420. _STARPU_MPI_LOG_OUT();
  421. return 0;
  422. }
  423. int starpu_mpi_irecv_detached_sequential_consistency(starpu_data_handle_t data_handle, int source, int data_tag, MPI_Comm comm, void (*callback)(void *), void *arg, int sequential_consistency)
  424. {
  425. _STARPU_MPI_LOG_IN();
  426. // // We check if a tag is defined for the data handle, if not,
  427. // // we define the one given for the communication.
  428. // // A tag is necessary for the internal mpi engine.
  429. // int tag = starpu_data_get_tag(data_handle);
  430. // if (tag == -1)
  431. // starpu_data_set_tag(data_handle, data_tag);
  432. _starpu_mpi_irecv_common(data_handle, source, data_tag, comm, 1, 0, callback, arg, sequential_consistency, 0, 0);
  433. _STARPU_MPI_LOG_OUT();
  434. return 0;
  435. }
  436. int starpu_mpi_recv(starpu_data_handle_t data_handle, int source, int data_tag, MPI_Comm comm, MPI_Status *status)
  437. {
  438. starpu_mpi_req req;
  439. _STARPU_MPI_LOG_IN();
  440. // // We check if a tag is defined for the data handle, if not,
  441. // // we define the one given for the communication.
  442. // // A tag is necessary for the internal mpi engine.
  443. // int tag = starpu_data_get_tag(data_handle);
  444. // if (tag == -1)
  445. // starpu_data_set_tag(data_handle, data_tag);
  446. starpu_mpi_irecv(data_handle, &req, source, data_tag, comm);
  447. starpu_mpi_wait(&req, status);
  448. _STARPU_MPI_LOG_OUT();
  449. return 0;
  450. }
  451. /********************************************************/
  452. /* */
  453. /* Wait functionalities */
  454. /* */
  455. /********************************************************/
  456. static void _starpu_mpi_wait_func(struct _starpu_mpi_req *waiting_req)
  457. {
  458. _STARPU_MPI_LOG_IN();
  459. /* Which is the mpi request we are waiting for ? */
  460. struct _starpu_mpi_req *req = waiting_req->other_request;
  461. _STARPU_MPI_TRACE_UWAIT_BEGIN(req->srcdst, req->data_tag);
  462. req->ret = MPI_Wait(&req->request, waiting_req->status);
  463. STARPU_ASSERT_MSG(req->ret == MPI_SUCCESS, "MPI_Wait returning %d", req->ret);
  464. _STARPU_MPI_TRACE_UWAIT_END(req->srcdst, req->data_tag);
  465. _starpu_mpi_handle_request_termination(req);
  466. _STARPU_MPI_LOG_OUT();
  467. }
  468. int starpu_mpi_wait(starpu_mpi_req *public_req, MPI_Status *status)
  469. {
  470. int ret;
  471. struct _starpu_mpi_req *req = *public_req;
  472. struct _starpu_mpi_req *waiting_req;
  473. _STARPU_MPI_LOG_IN();
  474. _STARPU_MPI_INC_POSTED_REQUESTS(1);
  475. /* We cannot try to complete a MPI request that was not actually posted
  476. * to MPI yet. */
  477. STARPU_PTHREAD_MUTEX_LOCK(&(req->req_mutex));
  478. while (!(req->submitted))
  479. STARPU_PTHREAD_COND_WAIT(&(req->req_cond), &(req->req_mutex));
  480. STARPU_PTHREAD_MUTEX_UNLOCK(&(req->req_mutex));
  481. /* Initialize the request structure */
  482. _starpu_mpi_request_init(&waiting_req);
  483. waiting_req->status = status;
  484. waiting_req->other_request = req;
  485. waiting_req->func = _starpu_mpi_wait_func;
  486. waiting_req->request_type = WAIT_REQ;
  487. _starpu_mpi_submit_ready_request(waiting_req);
  488. /* We wait for the MPI request to finish */
  489. STARPU_PTHREAD_MUTEX_LOCK(&req->req_mutex);
  490. while (!req->completed)
  491. STARPU_PTHREAD_COND_WAIT(&req->req_cond, &req->req_mutex);
  492. STARPU_PTHREAD_MUTEX_UNLOCK(&req->req_mutex);
  493. ret = req->ret;
  494. /* The internal request structure was automatically allocated */
  495. *public_req = NULL;
  496. free(req);
  497. free(waiting_req);
  498. _STARPU_MPI_LOG_OUT();
  499. return ret;
  500. }
  501. /********************************************************/
  502. /* */
  503. /* Test functionalities */
  504. /* */
  505. /********************************************************/
  506. static void _starpu_mpi_test_func(struct _starpu_mpi_req *testing_req)
  507. {
  508. _STARPU_MPI_LOG_IN();
  509. /* Which is the mpi request we are testing for ? */
  510. struct _starpu_mpi_req *req = testing_req->other_request;
  511. _STARPU_MPI_DEBUG(2, "Test request %p type %s tag %d src %d data %p ptr %p datatype '%s' count %d user_datatype %d \n",
  512. req, _starpu_mpi_request_type(req->request_type), req->data_tag, req->srcdst, req->data_handle, req->ptr, _starpu_mpi_datatype(req->datatype), (int)req->count, req->user_datatype);
  513. _STARPU_MPI_TRACE_UTESTING_BEGIN(req->srcdst, req->data_tag);
  514. req->ret = MPI_Test(&req->request, testing_req->flag, testing_req->status);
  515. STARPU_ASSERT_MSG(req->ret == MPI_SUCCESS, "MPI_Test returning %d", req->ret);
  516. _STARPU_MPI_TRACE_UTESTING_END(req->srcdst, req->data_tag);
  517. if (*testing_req->flag)
  518. {
  519. testing_req->ret = req->ret;
  520. _starpu_mpi_handle_request_termination(req);
  521. }
  522. STARPU_PTHREAD_MUTEX_LOCK(&testing_req->req_mutex);
  523. testing_req->completed = 1;
  524. STARPU_PTHREAD_COND_SIGNAL(&testing_req->req_cond);
  525. STARPU_PTHREAD_MUTEX_UNLOCK(&testing_req->req_mutex);
  526. _STARPU_MPI_LOG_OUT();
  527. }
  528. int starpu_mpi_test(starpu_mpi_req *public_req, int *flag, MPI_Status *status)
  529. {
  530. _STARPU_MPI_LOG_IN();
  531. int ret = 0;
  532. STARPU_ASSERT_MSG(public_req, "starpu_mpi_test needs a valid starpu_mpi_req");
  533. struct _starpu_mpi_req *req = *public_req;
  534. STARPU_ASSERT_MSG(!req->detached, "MPI_Test cannot be called on a detached request");
  535. STARPU_PTHREAD_MUTEX_LOCK(&req->req_mutex);
  536. unsigned submitted = req->submitted;
  537. STARPU_PTHREAD_MUTEX_UNLOCK(&req->req_mutex);
  538. if (submitted)
  539. {
  540. struct _starpu_mpi_req *testing_req;
  541. _starpu_mpi_request_init(&testing_req);
  542. /* Initialize the request structure */
  543. STARPU_PTHREAD_MUTEX_INIT(&(testing_req->req_mutex), NULL);
  544. STARPU_PTHREAD_COND_INIT(&(testing_req->req_cond), NULL);
  545. testing_req->flag = flag;
  546. testing_req->status = status;
  547. testing_req->other_request = req;
  548. testing_req->func = _starpu_mpi_test_func;
  549. testing_req->completed = 0;
  550. testing_req->request_type = TEST_REQ;
  551. _STARPU_MPI_INC_POSTED_REQUESTS(1);
  552. _starpu_mpi_submit_ready_request(testing_req);
  553. /* We wait for the test request to finish */
  554. STARPU_PTHREAD_MUTEX_LOCK(&(testing_req->req_mutex));
  555. while (!(testing_req->completed))
  556. STARPU_PTHREAD_COND_WAIT(&(testing_req->req_cond), &(testing_req->req_mutex));
  557. STARPU_PTHREAD_MUTEX_UNLOCK(&(testing_req->req_mutex));
  558. ret = testing_req->ret;
  559. if (*(testing_req->flag))
  560. {
  561. /* The request was completed so we free the internal
  562. * request structure which was automatically allocated
  563. * */
  564. *public_req = NULL;
  565. free(req);
  566. }
  567. free(testing_req);
  568. }
  569. else
  570. {
  571. *flag = 0;
  572. }
  573. _STARPU_MPI_LOG_OUT();
  574. return ret;
  575. }
  576. /********************************************************/
  577. /* */
  578. /* Barrier functionalities */
  579. /* */
  580. /********************************************************/
  581. static void _starpu_mpi_barrier_func(struct _starpu_mpi_req *barrier_req)
  582. {
  583. _STARPU_MPI_LOG_IN();
  584. barrier_req->ret = MPI_Barrier(barrier_req->comm);
  585. STARPU_ASSERT_MSG(barrier_req->ret == MPI_SUCCESS, "MPI_Barrier returning %d", barrier_req->ret);
  586. _starpu_mpi_handle_request_termination(barrier_req);
  587. _STARPU_MPI_LOG_OUT();
  588. }
  589. int starpu_mpi_barrier(MPI_Comm comm)
  590. {
  591. int ret;
  592. struct _starpu_mpi_req *barrier_req;
  593. _STARPU_MPI_LOG_IN();
  594. _starpu_mpi_request_init(&barrier_req);
  595. /* First wait for *both* all tasks and MPI requests to finish, in case
  596. * some tasks generate MPI requests, MPI requests generate tasks, etc.
  597. */
  598. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  599. STARPU_ASSERT_MSG(!barrier_running, "Concurrent starpu_mpi_barrier is not implemented, even on different communicators");
  600. barrier_running = 1;
  601. do
  602. {
  603. while (posted_requests)
  604. /* Wait for all current MPI requests to finish */
  605. STARPU_PTHREAD_COND_WAIT(&cond_finished, &mutex);
  606. /* No current request, clear flag */
  607. newer_requests = 0;
  608. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  609. /* Now wait for all tasks */
  610. starpu_task_wait_for_all();
  611. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  612. /* Check newer_requests again, in case some MPI requests
  613. * triggered by tasks completed and triggered tasks between
  614. * wait_for_all finished and we take the lock */
  615. } while (posted_requests || newer_requests);
  616. barrier_running = 0;
  617. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  618. /* Initialize the request structure */
  619. STARPU_PTHREAD_MUTEX_INIT(&(barrier_req->req_mutex), NULL);
  620. STARPU_PTHREAD_COND_INIT(&(barrier_req->req_cond), NULL);
  621. barrier_req->func = _starpu_mpi_barrier_func;
  622. barrier_req->request_type = BARRIER_REQ;
  623. barrier_req->comm = comm;
  624. _STARPU_MPI_INC_POSTED_REQUESTS(1);
  625. _starpu_mpi_submit_ready_request(barrier_req);
  626. /* We wait for the MPI request to finish */
  627. STARPU_PTHREAD_MUTEX_LOCK(&barrier_req->req_mutex);
  628. while (!barrier_req->completed)
  629. STARPU_PTHREAD_COND_WAIT(&barrier_req->req_cond, &barrier_req->req_mutex);
  630. STARPU_PTHREAD_MUTEX_UNLOCK(&barrier_req->req_mutex);
  631. ret = barrier_req->ret;
  632. free(barrier_req);
  633. _STARPU_MPI_LOG_OUT();
  634. return ret;
  635. }
  636. /********************************************************/
  637. /* */
  638. /* Progression */
  639. /* */
  640. /********************************************************/
  641. #ifdef STARPU_VERBOSE
  642. static char *_starpu_mpi_request_type(enum _starpu_mpi_request_type request_type)
  643. {
  644. switch (request_type)
  645. {
  646. case SEND_REQ: return "SEND_REQ";
  647. case RECV_REQ: return "RECV_REQ";
  648. case WAIT_REQ: return "WAIT_REQ";
  649. case TEST_REQ: return "TEST_REQ";
  650. case BARRIER_REQ: return "BARRIER_REQ";
  651. case UNKNOWN_REQ: return "UNSET_REQ";
  652. default: return "unknown request type";
  653. }
  654. }
  655. #endif
  656. static void _starpu_mpi_handle_request_termination(struct _starpu_mpi_req *req)
  657. {
  658. int ret;
  659. _STARPU_MPI_LOG_IN();
  660. _STARPU_MPI_DEBUG(2, "complete MPI request %p type %s tag %d src %d data %p ptr %p datatype '%s' count %d user_datatype %d internal_req %p\n",
  661. req, _starpu_mpi_request_type(req->request_type), req->data_tag, req->srcdst, req->data_handle, req->ptr,
  662. _starpu_mpi_datatype(req->datatype), (int)req->count, req->user_datatype, req->internal_req);
  663. if (req->internal_req)
  664. {
  665. struct _starpu_mpi_early_data_handle *early_data_handle = _starpu_mpi_early_data_find(req->data_tag, req->srcdst);
  666. STARPU_ASSERT_MSG(early_data_handle, "Could not find a copy data handle with the tag %d and the node %d\n", req->data_tag, req->srcdst);
  667. _STARPU_MPI_DEBUG(3, "Handling deleting of early_data structure from the hashmap..\n");
  668. _starpu_mpi_early_data_delete(early_data_handle);
  669. free(early_data_handle);
  670. }
  671. else
  672. {
  673. if (req->request_type == RECV_REQ || req->request_type == SEND_REQ)
  674. {
  675. if (req->user_datatype == 1)
  676. {
  677. if (req->request_type == SEND_REQ)
  678. {
  679. // We need to make sure the communication for sending the size
  680. // has completed, as MPI can re-order messages, let's call
  681. // MPI_Wait to make sure data have been sent
  682. ret = MPI_Wait(&req->size_req, MPI_STATUS_IGNORE);
  683. STARPU_ASSERT_MSG(ret == MPI_SUCCESS, "MPI_Wait returning %d", ret);
  684. free(req->ptr);
  685. }
  686. if (req->request_type == RECV_REQ)
  687. {
  688. // req->ptr is freed by starpu_data_unpack
  689. starpu_data_unpack(req->data_handle, req->ptr, req->count);
  690. }
  691. }
  692. else
  693. {
  694. _starpu_mpi_handle_free_datatype(req->data_handle, &req->datatype);
  695. }
  696. }
  697. }
  698. if (req->data_handle)
  699. starpu_data_release(req->data_handle);
  700. if (req->envelope)
  701. {
  702. free(req->envelope);
  703. req->envelope = NULL;
  704. }
  705. /* Execute the specified callback, if any */
  706. if (req->callback)
  707. req->callback(req->callback_arg);
  708. /* tell anyone potentially waiting on the request that it is
  709. * terminated now */
  710. STARPU_PTHREAD_MUTEX_LOCK(&req->req_mutex);
  711. req->completed = 1;
  712. STARPU_PTHREAD_COND_BROADCAST(&req->req_cond);
  713. STARPU_PTHREAD_MUTEX_UNLOCK(&req->req_mutex);
  714. _STARPU_MPI_LOG_OUT();
  715. }
  716. static void _starpu_mpi_early_data_cb(void* arg)
  717. {
  718. struct _starpu_mpi_early_data_cb_args *args = arg;
  719. // We store in the application request the internal MPI
  720. // request so that it can be used by starpu_mpi_wait
  721. args->req->request = args->req->internal_req->request;
  722. args->req->submitted = 1;
  723. if (args->buffer)
  724. {
  725. /* Data has been received as a raw memory, it has to be unpacked */
  726. struct starpu_data_interface_ops *itf_src = starpu_data_get_interface_ops(args->early_handle);
  727. struct starpu_data_interface_ops *itf_dst = starpu_data_get_interface_ops(args->data_handle);
  728. STARPU_ASSERT_MSG(itf_dst->unpack_data, "The data interface does not define an unpack function\n");
  729. itf_dst->unpack_data(args->data_handle, STARPU_MAIN_RAM, args->buffer, itf_src->get_size(args->early_handle));
  730. free(args->buffer);
  731. }
  732. else
  733. {
  734. struct starpu_data_interface_ops *itf = starpu_data_get_interface_ops(args->early_handle);
  735. void* itf_src = starpu_data_get_interface_on_node(args->early_handle, STARPU_MAIN_RAM);
  736. void* itf_dst = starpu_data_get_interface_on_node(args->data_handle, STARPU_MAIN_RAM);
  737. if (!itf->copy_methods->ram_to_ram)
  738. {
  739. _STARPU_MPI_DEBUG(3, "Initiating any_to_any copy..\n");
  740. itf->copy_methods->any_to_any(itf_src, STARPU_MAIN_RAM, itf_dst, STARPU_MAIN_RAM, NULL);
  741. }
  742. else
  743. {
  744. _STARPU_MPI_DEBUG(3, "Initiating ram_to_ram copy..\n");
  745. itf->copy_methods->ram_to_ram(itf_src, STARPU_MAIN_RAM, itf_dst, STARPU_MAIN_RAM);
  746. }
  747. }
  748. _STARPU_MPI_DEBUG(3, "Done, handling release of early_handle..\n");
  749. starpu_data_release(args->early_handle);
  750. _STARPU_MPI_DEBUG(3, "Done, handling unregister of early_handle..\n");
  751. starpu_data_unregister_submit(args->early_handle);
  752. _STARPU_MPI_DEBUG(3, "Done, handling request %p termination of the already received request\n",args->req);
  753. // If the request is detached, we need to call _starpu_mpi_handle_request_termination
  754. // as it will not be called automatically as the request is not in the list detached_requests
  755. if (args->req->detached)
  756. _starpu_mpi_handle_request_termination(args->req);
  757. // else: If the request is not detached its termination will
  758. // be handled when calling starpu_mpi_wait
  759. free(args);
  760. }
  761. #ifdef STARPU_MPI_ACTIVITY
  762. static unsigned _starpu_mpi_progression_hook_func(void *arg STARPU_ATTRIBUTE_UNUSED)
  763. {
  764. unsigned may_block = 1;
  765. STARPU_PTHREAD_MUTEX_LOCK(&detached_requests_mutex);
  766. if (!_starpu_mpi_req_list_empty(detached_requests))
  767. {
  768. STARPU_PTHREAD_MUTEX_UNLOCK(&detached_requests_mutex);
  769. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  770. STARPU_PTHREAD_COND_SIGNAL(&cond_progression);
  771. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  772. may_block = 0;
  773. }
  774. else
  775. STARPU_PTHREAD_MUTEX_UNLOCK(&detached_requests_mutex);
  776. return may_block;
  777. }
  778. #endif /* STARPU_MPI_ACTIVITY */
  779. static void _starpu_mpi_test_detached_requests(void)
  780. {
  781. _STARPU_MPI_LOG_IN();
  782. int flag;
  783. MPI_Status status;
  784. struct _starpu_mpi_req *req, *next_req;
  785. STARPU_PTHREAD_MUTEX_LOCK(&detached_requests_mutex);
  786. for (req = _starpu_mpi_req_list_begin(detached_requests);
  787. req != _starpu_mpi_req_list_end(detached_requests);
  788. req = next_req)
  789. {
  790. next_req = _starpu_mpi_req_list_next(req);
  791. STARPU_PTHREAD_MUTEX_UNLOCK(&detached_requests_mutex);
  792. //_STARPU_MPI_DEBUG(3, "Test detached request %p - mpitag %d - TYPE %s %d\n", &req->request, req->data_tag, _starpu_mpi_request_type(req->request_type), req->srcdst);
  793. req->ret = MPI_Test(&req->request, &flag, &status);
  794. STARPU_ASSERT_MSG(req->ret == MPI_SUCCESS, "MPI_Test returning %d", req->ret);
  795. if (flag)
  796. {
  797. if (req->request_type == RECV_REQ)
  798. {
  799. _STARPU_MPI_TRACE_IRECV_COMPLETE_BEGIN(req->srcdst, req->data_tag);
  800. }
  801. else if (req->request_type == SEND_REQ)
  802. {
  803. _STARPU_MPI_TRACE_ISEND_COMPLETE_BEGIN(req->srcdst, req->data_tag, 0);
  804. }
  805. _starpu_mpi_handle_request_termination(req);
  806. if (req->request_type == RECV_REQ)
  807. {
  808. _STARPU_MPI_TRACE_IRECV_COMPLETE_END(req->srcdst, req->data_tag);
  809. }
  810. else if (req->request_type == SEND_REQ)
  811. {
  812. _STARPU_MPI_TRACE_ISEND_COMPLETE_END(req->srcdst, req->data_tag, 0);
  813. }
  814. }
  815. STARPU_PTHREAD_MUTEX_LOCK(&detached_requests_mutex);
  816. if (flag)
  817. {
  818. _starpu_mpi_req_list_erase(detached_requests, req);
  819. #ifdef STARPU_DEVEL
  820. #warning FIXME: when do we free internal requests
  821. #endif
  822. if (!req->is_internal_req)
  823. free(req);
  824. }
  825. }
  826. STARPU_PTHREAD_MUTEX_UNLOCK(&detached_requests_mutex);
  827. _STARPU_MPI_LOG_OUT();
  828. }
  829. static void _starpu_mpi_handle_detached_request(struct _starpu_mpi_req *req)
  830. {
  831. if (req->detached)
  832. {
  833. /* put the submitted request into the list of pending requests
  834. * so that it can be handled by the progression mechanisms */
  835. STARPU_PTHREAD_MUTEX_LOCK(&detached_requests_mutex);
  836. _starpu_mpi_req_list_push_front(detached_requests, req);
  837. STARPU_PTHREAD_MUTEX_UNLOCK(&detached_requests_mutex);
  838. starpu_wake_all_blocked_workers();
  839. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  840. STARPU_PTHREAD_COND_SIGNAL(&cond_progression);
  841. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  842. }
  843. }
  844. static void _starpu_mpi_handle_ready_request(struct _starpu_mpi_req *req)
  845. {
  846. _STARPU_MPI_LOG_IN();
  847. STARPU_ASSERT_MSG(req, "Invalid request");
  848. /* submit the request to MPI */
  849. _STARPU_MPI_DEBUG(2, "Handling new request %p type %s tag %d src %d data %p ptr %p datatype '%s' count %d user_datatype %d \n",
  850. req, _starpu_mpi_request_type(req->request_type), req->data_tag, req->srcdst, req->data_handle, req->ptr, _starpu_mpi_datatype(req->datatype), (int)req->count, req->user_datatype);
  851. req->func(req);
  852. _STARPU_MPI_LOG_OUT();
  853. }
  854. struct _starpu_mpi_argc_argv
  855. {
  856. int initialize_mpi;
  857. int *argc;
  858. char ***argv;
  859. };
  860. static void _starpu_mpi_print_thread_level_support(int thread_level, char *msg)
  861. {
  862. switch (thread_level)
  863. {
  864. case MPI_THREAD_SERIALIZED:
  865. {
  866. _STARPU_DISP("MPI%s MPI_THREAD_SERIALIZED; Multiple threads may make MPI calls, but only one at a time.\n", msg);
  867. break;
  868. }
  869. case MPI_THREAD_FUNNELED:
  870. {
  871. _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);
  872. break;
  873. }
  874. case MPI_THREAD_SINGLE:
  875. {
  876. _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);
  877. break;
  878. }
  879. }
  880. }
  881. static void *_starpu_mpi_progress_thread_func(void *arg)
  882. {
  883. struct _starpu_mpi_argc_argv *argc_argv = (struct _starpu_mpi_argc_argv *) arg;
  884. int rank, worldsize;
  885. if (argc_argv->initialize_mpi)
  886. {
  887. int thread_support;
  888. _STARPU_DEBUG("Calling MPI_Init_thread\n");
  889. if (MPI_Init_thread(argc_argv->argc, argc_argv->argv, MPI_THREAD_SERIALIZED, &thread_support) != MPI_SUCCESS)
  890. {
  891. _STARPU_ERROR("MPI_Init_thread failed\n");
  892. }
  893. _starpu_mpi_print_thread_level_support(thread_support, "_Init_thread level =");
  894. }
  895. else
  896. {
  897. int provided;
  898. MPI_Query_thread(&provided);
  899. _starpu_mpi_print_thread_level_support(provided, " has been initialized with");
  900. }
  901. MPI_Comm_rank(MPI_COMM_WORLD, &rank);
  902. MPI_Comm_size(MPI_COMM_WORLD, &worldsize);
  903. MPI_Comm_set_errhandler(MPI_COMM_WORLD, MPI_ERRORS_RETURN);
  904. {
  905. _STARPU_MPI_TRACE_START(rank, worldsize);
  906. #ifdef STARPU_USE_FXT
  907. starpu_profiling_set_id(rank);
  908. #endif //STARPU_USE_FXT
  909. }
  910. _starpu_mpi_add_sync_point_in_fxt();
  911. _starpu_mpi_comm_amounts_init(MPI_COMM_WORLD);
  912. _starpu_mpi_cache_init(MPI_COMM_WORLD);
  913. _starpu_mpi_early_request_init(worldsize);
  914. _starpu_mpi_early_data_init(worldsize);
  915. /* notify the main thread that the progression thread is ready */
  916. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  917. running = 1;
  918. STARPU_PTHREAD_COND_SIGNAL(&cond_progression);
  919. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  920. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  921. struct _starpu_mpi_envelope *envelope = calloc(1,sizeof(struct _starpu_mpi_envelope));
  922. int envelope_request_submitted = 0;
  923. while (running || posted_requests || !(_starpu_mpi_req_list_empty(ready_requests)) || !(_starpu_mpi_req_list_empty(detached_requests)))
  924. {
  925. /* shall we block ? */
  926. unsigned block = _starpu_mpi_req_list_empty(ready_requests) && _starpu_mpi_early_request_count() == 0;
  927. #ifndef STARPU_MPI_ACTIVITY
  928. STARPU_PTHREAD_MUTEX_LOCK(&detached_requests_mutex);
  929. block = block && _starpu_mpi_req_list_empty(detached_requests);
  930. STARPU_PTHREAD_MUTEX_UNLOCK(&detached_requests_mutex);
  931. #endif /* STARPU_MPI_ACTIVITY */
  932. if (block)
  933. {
  934. _STARPU_MPI_DEBUG(3, "NO MORE REQUESTS TO HANDLE\n");
  935. _STARPU_MPI_TRACE_SLEEP_BEGIN();
  936. if (barrier_running)
  937. /* Tell mpi_barrier */
  938. STARPU_PTHREAD_COND_SIGNAL(&cond_finished);
  939. STARPU_PTHREAD_COND_WAIT(&cond_progression, &mutex);
  940. _STARPU_MPI_TRACE_SLEEP_END();
  941. }
  942. /* get one request */
  943. struct _starpu_mpi_req *req;
  944. while (!_starpu_mpi_req_list_empty(ready_requests))
  945. {
  946. req = _starpu_mpi_req_list_pop_back(ready_requests);
  947. /* handling a request is likely to block for a while
  948. * (on a sync_data_with_mem call), we want to let the
  949. * application submit requests in the meantime, so we
  950. * release the lock. */
  951. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  952. _starpu_mpi_handle_ready_request(req);
  953. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  954. }
  955. /* If there is no currently submitted envelope_request submitted to
  956. * catch envelopes from senders, and there is some pending
  957. * receive requests on our side, we resubmit a header request. */
  958. MPI_Request envelope_request;
  959. if ((_starpu_mpi_early_request_count() > 0) && (envelope_request_submitted == 0))// && (HASH_COUNT(_starpu_mpi_early_data_handle_hashmap) == 0))
  960. {
  961. _STARPU_MPI_DEBUG(3, "Posting a receive to get a data envelop\n");
  962. MPI_Irecv(envelope, sizeof(struct _starpu_mpi_envelope), MPI_BYTE, MPI_ANY_SOURCE, _starpu_mpi_tag, MPI_COMM_WORLD, &envelope_request);
  963. envelope_request_submitted = 1;
  964. }
  965. /* test whether there are some terminated "detached request" */
  966. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  967. _starpu_mpi_test_detached_requests();
  968. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  969. if (envelope_request_submitted == 1)
  970. {
  971. int flag,res;
  972. MPI_Status status;
  973. _STARPU_MPI_DEBUG(4, "Test of envelope_request\n");
  974. /* test whether an envelope has arrived. */
  975. res = MPI_Test(&envelope_request, &flag, &status);
  976. STARPU_ASSERT(res == MPI_SUCCESS);
  977. if (flag)
  978. {
  979. _STARPU_MPI_DEBUG(3, "Searching for application request with tag %d and source %d (size %ld)\n", envelope->data_tag, status.MPI_SOURCE, envelope->size);
  980. struct _starpu_mpi_req *early_request = _starpu_mpi_early_request_find(envelope->data_tag, status.MPI_SOURCE);
  981. /* Case: a data will arrive before a matching receive is
  982. * posted by the application. Create a temporary handle to
  983. * store the incoming data, submit a starpu_mpi_irecv_detached
  984. * on this handle, and store it as an early_data
  985. */
  986. if (early_request == NULL)
  987. {
  988. _STARPU_MPI_DEBUG(3, "Request with tag %d and source %d not found, creating a early_handle to receive incoming data..\n", envelope->data_tag, status.MPI_SOURCE);
  989. starpu_data_handle_t data_handle = NULL;
  990. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  991. data_handle = _starpu_data_get_data_handle_from_tag(envelope->data_tag);
  992. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  993. struct _starpu_mpi_early_data_handle* early_data_handle = calloc(1, sizeof(struct _starpu_mpi_early_data_handle));
  994. STARPU_ASSERT(early_data_handle);
  995. STARPU_PTHREAD_MUTEX_INIT(&early_data_handle->req_mutex, NULL);
  996. STARPU_PTHREAD_COND_INIT(&early_data_handle->req_cond, NULL);
  997. early_data_handle->data_tag = envelope->data_tag;
  998. early_data_handle->env = envelope;
  999. early_data_handle->source = status.MPI_SOURCE;
  1000. if (data_handle)
  1001. {
  1002. early_data_handle->buffer = NULL;
  1003. starpu_data_register_same(&early_data_handle->handle, data_handle);
  1004. _starpu_mpi_early_data_add(early_data_handle);
  1005. }
  1006. else
  1007. {
  1008. /* The application has not registered yet a data with the tag,
  1009. * we are going to receive the data as a raw memory, and give it
  1010. * to the application when it post a receive for this tag
  1011. */
  1012. _STARPU_MPI_DEBUG(20, "Posting a receive for a data of size %d which has not yet been registered\n", (int)early_data_handle->env->size);
  1013. early_data_handle->buffer = malloc(early_data_handle->env->size);
  1014. starpu_vector_data_register(&early_data_handle->handle, STARPU_MAIN_RAM, (uintptr_t) early_data_handle->buffer, early_data_handle->env->size, 1);
  1015. _starpu_mpi_early_data_add(early_data_handle);
  1016. }
  1017. _STARPU_MPI_DEBUG(20, "Posting internal detached irecv on early_handle with tag %d from src %d ..\n", early_data_handle->data_tag, status.MPI_SOURCE);
  1018. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  1019. early_data_handle->req = _starpu_mpi_irecv_common(early_data_handle->handle, status.MPI_SOURCE,
  1020. early_data_handle->data_tag, MPI_COMM_WORLD, 1, 0,
  1021. NULL, NULL, 1, 1, envelope->size);
  1022. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  1023. // We wait until the request is pushed in the
  1024. // ready_request list, that ensures that the next loop
  1025. // will call _starpu_mpi_handle_ready_request
  1026. // on the request and post the corresponding mpi_irecv,
  1027. // otherwise, it may lead to read data as envelop
  1028. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  1029. STARPU_PTHREAD_MUTEX_LOCK(&(early_data_handle->req->posted_mutex));
  1030. while (!(early_data_handle->req->posted))
  1031. STARPU_PTHREAD_COND_WAIT(&(early_data_handle->req->posted_cond), &(early_data_handle->req->posted_mutex));
  1032. STARPU_PTHREAD_MUTEX_UNLOCK(&(early_data_handle->req->posted_mutex));
  1033. STARPU_PTHREAD_MUTEX_LOCK(&early_data_handle->req_mutex);
  1034. early_data_handle->req_ready = 1;
  1035. STARPU_PTHREAD_COND_BROADCAST(&early_data_handle->req_cond);
  1036. STARPU_PTHREAD_MUTEX_UNLOCK(&early_data_handle->req_mutex);
  1037. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  1038. }
  1039. /* Case: a matching application request has been found for
  1040. * the incoming data, we handle the correct allocation
  1041. * of the pointer associated to the data handle, then
  1042. * submit the corresponding receive with
  1043. * _starpu_mpi_handle_ready_request. */
  1044. else
  1045. {
  1046. _STARPU_MPI_DEBUG(3, "A matching receive has been found for the incoming data with tag %d\n", envelope->data_tag);
  1047. _starpu_mpi_early_request_delete(early_request);
  1048. _starpu_mpi_handle_allocate_datatype(early_request->data_handle, &early_request->datatype, &early_request->user_datatype);
  1049. if (early_request->user_datatype == 0)
  1050. {
  1051. early_request->count = 1;
  1052. early_request->ptr = starpu_data_get_local_ptr(early_request->data_handle);
  1053. }
  1054. else
  1055. {
  1056. early_request->count = envelope->size;
  1057. early_request->ptr = malloc(early_request->count);
  1058. STARPU_ASSERT_MSG(early_request->ptr, "cannot allocate message of size %ld\n", early_request->count);
  1059. }
  1060. _STARPU_MPI_DEBUG(3, "Handling new request... \n");
  1061. /* handling a request is likely to block for a while
  1062. * (on a sync_data_with_mem call), we want to let the
  1063. * application submit requests in the meantime, so we
  1064. * release the lock. */
  1065. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  1066. _starpu_mpi_handle_ready_request(early_request);
  1067. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  1068. }
  1069. envelope_request_submitted = 0;
  1070. }
  1071. else
  1072. {
  1073. _STARPU_MPI_DEBUG(4, "Nothing received, continue ..\n");
  1074. }
  1075. }
  1076. }
  1077. STARPU_ASSERT_MSG(_starpu_mpi_req_list_empty(detached_requests), "List of detached requests not empty");
  1078. STARPU_ASSERT_MSG(_starpu_mpi_req_list_empty(ready_requests), "List of ready requests not empty");
  1079. STARPU_ASSERT_MSG(posted_requests == 0, "Number of posted request is not zero");
  1080. _starpu_mpi_early_request_check_termination();
  1081. _starpu_mpi_early_data_check_termination();
  1082. if (argc_argv->initialize_mpi)
  1083. {
  1084. _STARPU_MPI_DEBUG(3, "Calling MPI_Finalize()\n");
  1085. MPI_Finalize();
  1086. }
  1087. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  1088. _starpu_mpi_early_data_free(worldsize);
  1089. _starpu_mpi_early_request_free();
  1090. free(argc_argv);
  1091. free(envelope);
  1092. return NULL;
  1093. }
  1094. /********************************************************/
  1095. /* */
  1096. /* (De)Initialization methods */
  1097. /* */
  1098. /********************************************************/
  1099. #ifdef STARPU_MPI_ACTIVITY
  1100. static int hookid = - 1;
  1101. #endif /* STARPU_MPI_ACTIVITY */
  1102. static void _starpu_mpi_add_sync_point_in_fxt(void)
  1103. {
  1104. #ifdef STARPU_USE_FXT
  1105. int rank;
  1106. int worldsize;
  1107. int ret;
  1108. MPI_Comm_rank(MPI_COMM_WORLD, &rank);
  1109. MPI_Comm_size(MPI_COMM_WORLD, &worldsize);
  1110. ret = MPI_Barrier(MPI_COMM_WORLD);
  1111. STARPU_ASSERT_MSG(ret == MPI_SUCCESS, "MPI_Barrier returning %d", ret);
  1112. /* We generate a "unique" key so that we can make sure that different
  1113. * FxT traces come from the same MPI run. */
  1114. int random_number;
  1115. /* XXX perhaps we don't want to generate a new seed if the application
  1116. * specified some reproductible behaviour ? */
  1117. if (rank == 0)
  1118. {
  1119. srand(time(NULL));
  1120. random_number = rand();
  1121. }
  1122. ret = MPI_Bcast(&random_number, 1, MPI_INT, 0, MPI_COMM_WORLD);
  1123. STARPU_ASSERT_MSG(ret == MPI_SUCCESS, "MPI_Bcast returning %d", ret);
  1124. _STARPU_MPI_TRACE_BARRIER(rank, worldsize, random_number);
  1125. _STARPU_MPI_DEBUG(3, "unique key %x\n", random_number);
  1126. #endif
  1127. }
  1128. static
  1129. int _starpu_mpi_initialize(int *argc, char ***argv, int initialize_mpi)
  1130. {
  1131. STARPU_PTHREAD_MUTEX_INIT(&mutex, NULL);
  1132. STARPU_PTHREAD_COND_INIT(&cond_progression, NULL);
  1133. STARPU_PTHREAD_COND_INIT(&cond_finished, NULL);
  1134. ready_requests = _starpu_mpi_req_list_new();
  1135. STARPU_PTHREAD_MUTEX_INIT(&detached_requests_mutex, NULL);
  1136. detached_requests = _starpu_mpi_req_list_new();
  1137. STARPU_PTHREAD_MUTEX_INIT(&mutex_posted_requests, NULL);
  1138. struct _starpu_mpi_argc_argv *argc_argv = malloc(sizeof(struct _starpu_mpi_argc_argv));
  1139. argc_argv->initialize_mpi = initialize_mpi;
  1140. argc_argv->argc = argc;
  1141. argc_argv->argv = argv;
  1142. #ifdef STARPU_MPI_ACTIVITY
  1143. hookid = starpu_progression_hook_register(_starpu_mpi_progression_hook_func, NULL);
  1144. STARPU_ASSERT_MSG(hookid >= 0, "starpu_progression_hook_register failed");
  1145. #endif /* STARPU_MPI_ACTIVITY */
  1146. STARPU_PTHREAD_CREATE(&progress_thread, NULL, _starpu_mpi_progress_thread_func, argc_argv);
  1147. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  1148. while (!running)
  1149. STARPU_PTHREAD_COND_WAIT(&cond_progression, &mutex);
  1150. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  1151. return 0;
  1152. }
  1153. int starpu_mpi_init(int *argc, char ***argv, int initialize_mpi)
  1154. {
  1155. return _starpu_mpi_initialize(argc, argv, initialize_mpi);
  1156. }
  1157. int starpu_mpi_initialize(void)
  1158. {
  1159. return _starpu_mpi_initialize(NULL, NULL, 0);
  1160. }
  1161. int starpu_mpi_initialize_extended(int *rank, int *world_size)
  1162. {
  1163. int ret;
  1164. ret = _starpu_mpi_initialize(NULL, NULL, 1);
  1165. if (ret == 0)
  1166. {
  1167. _STARPU_DEBUG("Calling MPI_Comm_rank\n");
  1168. MPI_Comm_rank(MPI_COMM_WORLD, rank);
  1169. MPI_Comm_size(MPI_COMM_WORLD, world_size);
  1170. }
  1171. return ret;
  1172. }
  1173. int starpu_mpi_shutdown(void)
  1174. {
  1175. void *value;
  1176. int rank, world_size;
  1177. /* We need to get the rank before calling MPI_Finalize to pass to _starpu_mpi_comm_amounts_display() */
  1178. MPI_Comm_rank(MPI_COMM_WORLD, &rank);
  1179. MPI_Comm_size(MPI_COMM_WORLD, &world_size);
  1180. /* kill the progression thread */
  1181. STARPU_PTHREAD_MUTEX_LOCK(&mutex);
  1182. running = 0;
  1183. STARPU_PTHREAD_COND_BROADCAST(&cond_progression);
  1184. STARPU_PTHREAD_MUTEX_UNLOCK(&mutex);
  1185. starpu_pthread_join(progress_thread, &value);
  1186. #ifdef STARPU_MPI_ACTIVITY
  1187. starpu_progression_hook_deregister(hookid);
  1188. #endif /* STARPU_MPI_ACTIVITY */
  1189. _STARPU_MPI_TRACE_STOP(rank, world_size);
  1190. /* free the request queues */
  1191. _starpu_mpi_req_list_delete(detached_requests);
  1192. _starpu_mpi_req_list_delete(ready_requests);
  1193. _starpu_mpi_comm_amounts_display(rank);
  1194. _starpu_mpi_comm_amounts_free();
  1195. _starpu_mpi_cache_free(world_size);
  1196. return 0;
  1197. }
  1198. void _starpu_mpi_clear_cache(starpu_data_handle_t data_handle)
  1199. {
  1200. starpu_mpi_cache_flush(MPI_COMM_WORLD, data_handle);
  1201. }
  1202. void starpu_mpi_data_register(starpu_data_handle_t data_handle, int tag, int rank)
  1203. {
  1204. #ifdef STARPU_DEVEL
  1205. #warning see if the following code is really needed, it deadlocks some applications
  1206. #if 0
  1207. int my;
  1208. MPI_Comm_rank(MPI_COMM_WORLD, &my);
  1209. if (my != rank)
  1210. STARPU_ASSERT_MSG(data_handle->home_node == -1, "Data does not belong to node %d, it should be assigned a home node -1", my);
  1211. #endif
  1212. #endif
  1213. _starpu_data_set_rank(data_handle, rank);
  1214. _starpu_data_set_tag(data_handle, tag);
  1215. _starpu_data_set_unregister_hook(data_handle, _starpu_mpi_clear_cache);
  1216. }
  1217. int starpu_mpi_world_rank(void)
  1218. {
  1219. int rank;
  1220. MPI_Comm_rank(MPI_COMM_WORLD, &rank);
  1221. return rank;
  1222. }