/* StarPU --- Runtime system for heterogeneous multicore architectures. * * Copyright (C) 2011, 2012, 2013, 2014, 2015 Centre National de la Recherche Scientifique * Copyright (C) 2011-2015 Université de Bordeaux * Copyright (C) 2014 INRIA * * StarPU is free software; you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation; either version 2.1 of the License, or (at * your option) any later version. * * StarPU is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. * * See the GNU Lesser General Public License in COPYING.LGPL for more details. */ #include #include #include #include #include #include #include #include #include #include #include #define _SEND_DATA(data, mode, dest, data_tag, comm, callback, arg) \ if (mode & STARPU_SSEND) \ starpu_mpi_issend_detached(data, dest, data_tag, comm, callback, arg); \ else \ starpu_mpi_isend_detached(data, dest, data_tag, comm, callback, arg); static int _starpu_mpi_find_executee_node(starpu_data_handle_t data, enum starpu_data_access_mode mode, int me, int *do_execute, int *inconsistent_execute, int *xrank) { if (mode & STARPU_W) { if (!data) { /* We don't have anything allocated for this. * The application knows we won't do anything * about this task */ /* Yes, the app could actually not call * task_insert at all itself, this is just a * safeguard. */ _STARPU_MPI_DEBUG(3, "oh oh\n"); _STARPU_MPI_LOG_OUT(); return -EINVAL; } int mpi_rank = starpu_data_get_rank(data); if (mpi_rank == -1) { _STARPU_ERROR("Data %p with mode STARPU_W needs to have a valid rank", data); } if (mpi_rank == me) { // This node owns the data if (*do_execute == 0) { _STARPU_MPI_DEBUG(100, "Another node has already been selected to execute the codelet\n"); *inconsistent_execute = 1; } else { _STARPU_MPI_DEBUG(100, "This node is going to execute the codelet\n"); *xrank = me; *do_execute = 1; } } else { // Another node owns the data if (*do_execute == 1) { _STARPU_MPI_DEBUG(100, "Another node owns the data but this node has already been selected to execute the codelet\n"); *inconsistent_execute = 1; } else { _STARPU_MPI_DEBUG(100, "This node will not execute the codelet\n"); *do_execute = 0; *xrank = mpi_rank; } } } _STARPU_MPI_DEBUG(100, "Executing: inconsistent=%d, do_execute=%d, xrank=%d\n", *inconsistent_execute, *do_execute, *xrank); return 0; } static void _starpu_mpi_exchange_data_before_execution(starpu_data_handle_t data, enum starpu_data_access_mode mode, int me, int xrank, int do_execute, MPI_Comm comm) { if (data && mode & STARPU_R) { int mpi_rank = starpu_data_get_rank(data); int data_tag = starpu_data_get_tag(data); if (mpi_rank == -1) { fprintf(stderr,"StarPU needs to be told the MPI rank of this data, using starpu_data_set_rank\n"); STARPU_ABORT(); } if (data_tag == -1) { fprintf(stderr,"StarPU needs to be told the MPI tag of this data, using starpu_data_set_tag\n"); STARPU_ABORT(); } if (do_execute && mpi_rank != me) { /* The node is going to execute the codelet, but it does not own the data, it needs to receive the data from the owner node */ void *already_received = _starpu_mpi_cache_received_data_set(data, mpi_rank); if (already_received == NULL) { _STARPU_MPI_DEBUG(1, "Receiving data %p from %d\n", data, mpi_rank); starpu_mpi_irecv_detached(data, mpi_rank, data_tag, comm, NULL, NULL); } // else the node has already received the data } if (!do_execute && mpi_rank == me) { /* The node owns the data, but another node is going to execute the codelet, the node needs to send the data to the executee node. */ void *already_sent = _starpu_mpi_cache_sent_data_set(data, xrank); if (already_sent == NULL) { _STARPU_MPI_DEBUG(1, "Sending data %p to %d\n", data, xrank); _SEND_DATA(data, mode, xrank, data_tag, comm, NULL, NULL); } // Else the data has already been sent } } } static void _starpu_mpi_exchange_data_after_execution(starpu_data_handle_t data, enum starpu_data_access_mode mode, int me, int xrank, int do_execute, MPI_Comm comm) { if (mode & STARPU_W) { int mpi_rank = starpu_data_get_rank(data); int data_tag = starpu_data_get_tag(data); if(mpi_rank == -1) { fprintf(stderr,"StarPU needs to be told the MPI rank of this data, using starpu_data_set_rank\n"); STARPU_ABORT(); } if(data_tag == -1) { fprintf(stderr,"StarPU needs to be told the MPI tag of this data, using starpu_data_set_tag\n"); STARPU_ABORT(); } if (mpi_rank == me) { if (xrank != -1 && me != xrank) { _STARPU_MPI_DEBUG(1, "Receive data %p back from the task %d which executed the codelet ...\n", data, xrank); starpu_mpi_irecv_detached(data, xrank, data_tag, comm, NULL, NULL); } } else if (do_execute) { _STARPU_MPI_DEBUG(1, "Send data %p back to its owner %d...\n", data, mpi_rank); _SEND_DATA(data, mode, mpi_rank, data_tag, comm, NULL, NULL); } } } static void _starpu_mpi_clear_data_after_execution(starpu_data_handle_t data, enum starpu_data_access_mode mode, int me, int do_execute, MPI_Comm comm) { if (_starpu_cache_enabled) { if (mode & STARPU_W || mode & STARPU_REDUX) { /* The data has been modified, it MUST be removed from the cache */ _starpu_mpi_cache_sent_data_clear(comm, data); _starpu_mpi_cache_received_data_clear(data); } } else { /* We allocated a temporary buffer for the received data, now drop it */ if ((mode & STARPU_R) && do_execute) { int mpi_rank = starpu_data_get_rank(data); if (mpi_rank != me && mpi_rank != -1) { starpu_data_invalidate_submit(data); } } } } static int _starpu_mpi_task_decode_v(struct starpu_codelet *codelet, int me, int nb_nodes, int *xrank, int *do_execute, struct starpu_data_descr **descrs_p, int *nb_data_p, va_list varg_list) { va_list varg_list_copy; int inconsistent_execute = 0; int arg_type, arg_type_nocommute; int node_selected = 0; int nb_allocated_data = 16; struct starpu_data_descr *descrs; int nb_data; int select_node_policy = STARPU_MPI_NODE_SELECTION_CURRENT_POLICY; descrs = (struct starpu_data_descr *)malloc(nb_allocated_data * sizeof(struct starpu_data_descr)); nb_data = 0; *do_execute = -1; *xrank = -1; va_copy(varg_list_copy, varg_list); while ((arg_type = va_arg(varg_list_copy, int)) != 0) { arg_type_nocommute = arg_type & ~STARPU_COMMUTE; if (arg_type==STARPU_EXECUTE_ON_NODE) { *xrank = va_arg(varg_list_copy, int); if (node_selected == 0) { _STARPU_MPI_DEBUG(100, "Executing on node %d\n", *xrank); *do_execute = 1; node_selected = 1; inconsistent_execute = 0; } } else if (arg_type==STARPU_EXECUTE_ON_DATA) { starpu_data_handle_t data = va_arg(varg_list_copy, starpu_data_handle_t); if (node_selected == 0) { *xrank = starpu_data_get_rank(data); STARPU_ASSERT_MSG(*xrank != -1, "Rank of the data must be set using starpu_mpi_data_register() or starpu_data_set_rank()"); _STARPU_MPI_DEBUG(100, "Executing on data node %d\n", *xrank); STARPU_ASSERT_MSG(*xrank <= nb_nodes, "Node %d to execute codelet is not a valid node (%d)", *xrank, nb_nodes); *do_execute = 1; node_selected = 1; inconsistent_execute = 0; } } else if (arg_type_nocommute & STARPU_R || arg_type_nocommute & STARPU_W || arg_type_nocommute & STARPU_RW || arg_type & STARPU_SCRATCH || arg_type & STARPU_REDUX) { starpu_data_handle_t data = va_arg(varg_list_copy, starpu_data_handle_t); enum starpu_data_access_mode mode = (enum starpu_data_access_mode) arg_type; if (node_selected == 0) { int ret = _starpu_mpi_find_executee_node(data, mode, me, do_execute, &inconsistent_execute, xrank); if (ret == -EINVAL) { return ret; } } if (nb_data >= nb_allocated_data) { nb_allocated_data *= 2; descrs = (struct starpu_data_descr *)realloc(descrs, nb_allocated_data * sizeof(struct starpu_data_descr)); } descrs[nb_data].handle = data; descrs[nb_data].mode = mode; nb_data ++; } else if (arg_type == STARPU_DATA_ARRAY) { starpu_data_handle_t *datas = va_arg(varg_list_copy, starpu_data_handle_t *); int nb_handles = va_arg(varg_list_copy, int); int i; for(i=0 ; i= nb_allocated_data) { nb_allocated_data *= 2; descrs = (struct starpu_data_descr *)realloc(descrs, nb_allocated_data * sizeof(struct starpu_data_descr)); } descrs[nb_data].handle = datas[i]; descrs[nb_data].mode = mode; nb_data ++; } } else if (arg_type == STARPU_DATA_MODE_ARRAY) { struct starpu_data_descr *_descrs = va_arg(varg_list_copy, struct starpu_data_descr*); int nb_handles = va_arg(varg_list_copy, int); int i; for(i=0 ; i= nb_allocated_data) { nb_allocated_data *= 2; descrs = (struct starpu_data_descr *)realloc(descrs, nb_allocated_data * sizeof(struct starpu_data_descr)); } descrs[nb_data].handle = _descrs[i].handle; descrs[nb_data].mode = mode; nb_data ++; } } else if (arg_type==STARPU_VALUE) { (void)va_arg(varg_list_copy, void *); (void)va_arg(varg_list_copy, size_t); } else if (arg_type==STARPU_CALLBACK) { (void)va_arg(varg_list_copy, _starpu_callback_func_t); } else if (arg_type==STARPU_CALLBACK_WITH_ARG) { (void)va_arg(varg_list_copy, _starpu_callback_func_t); (void)va_arg(varg_list_copy, void *); } else if (arg_type==STARPU_CALLBACK_ARG) { (void)va_arg(varg_list_copy, void *); } else if (arg_type==STARPU_PRIORITY) { (void)va_arg(varg_list_copy, int); } /* STARPU_EXECUTE_ON_NODE handled above */ /* STARPU_EXECUTE_ON_DATA handled above */ /* STARPU_DATA_ARRAY handled above */ /* STARPU_DATA_MODE_ARRAY handled above */ else if (arg_type==STARPU_TAG) { (void)va_arg(varg_list_copy, starpu_tag_t); } else if (arg_type==STARPU_HYPERVISOR_TAG) { (void)va_arg(varg_list_copy, int); } else if (arg_type==STARPU_FLOPS) { (void)va_arg(varg_list_copy, double); } else if (arg_type==STARPU_SCHED_CTX) { (void)va_arg(varg_list_copy, unsigned); } else if (arg_type==STARPU_PROLOGUE_CALLBACK) { (void)va_arg(varg_list_copy, _starpu_callback_func_t); } else if (arg_type==STARPU_PROLOGUE_CALLBACK_ARG) { (void)va_arg(varg_list_copy, void *); } else if (arg_type==STARPU_PROLOGUE_CALLBACK_POP) { (void)va_arg(varg_list_copy, _starpu_callback_func_t); } else if (arg_type==STARPU_PROLOGUE_CALLBACK_POP_ARG) { (void)va_arg(varg_list_copy, void *); } else if (arg_type==STARPU_EXECUTE_ON_WORKER) { // the flag is decoded and set later when // calling function _starpu_task_insert_create() (void)va_arg(varg_list_copy, int); } else if (arg_type==STARPU_TAG_ONLY) { (void)va_arg(varg_list_copy, starpu_tag_t); } else if (arg_type==STARPU_POSSIBLY_PARALLEL) { (void)va_arg(varg_list_copy, unsigned); } else if (arg_type==STARPU_WORKER_ORDER) { // the flag is decoded and set later when // calling function _starpu_task_insert_create() (void)va_arg(varg_list_copy, unsigned); } else if (arg_type==STARPU_NODE_SELECTION_POLICY) { select_node_policy = va_arg(varg_list_copy, int); } else { STARPU_ABORT_MSG("Unrecognized argument %d\n", arg_type); } } va_end(varg_list_copy); if (inconsistent_execute == 1 || *xrank == -1) { // We need to find out which node is going to execute the codelet. _STARPU_MPI_DISP("Different nodes are owning W data. Need to specify which node is going to execute the codelet, using STARPU_EXECUTE_ON_NODE or STARPU_EXECUTE_ON_DATA\n"); *xrank = _starpu_mpi_select_node(me, nb_nodes, descrs, nb_data, select_node_policy); *do_execute = (me == *xrank); } else { _STARPU_MPI_DEBUG(100, "Inconsistent=%d - xrank=%d\n", inconsistent_execute, *xrank); *do_execute = (me == *xrank); } _STARPU_MPI_DEBUG(100, "do_execute=%d\n", *do_execute); *descrs_p = descrs; *nb_data_p = nb_data; return 0; } static int _starpu_mpi_task_build_v(MPI_Comm comm, struct starpu_codelet *codelet, struct starpu_task **task, int *xrank_p, struct starpu_data_descr **descrs_p, int *nb_data_p, va_list varg_list) { va_list varg_list_copy; int me, do_execute, xrank, nb_nodes; int ret; int i; struct starpu_data_descr *descrs; int nb_data; _STARPU_MPI_LOG_IN(); starpu_mpi_comm_rank(comm, &me); starpu_mpi_comm_size(comm, &nb_nodes); /* Find out whether we are to execute the data because we own the data to be written to. */ ret = _starpu_mpi_task_decode_v(codelet, me, nb_nodes, &xrank, &do_execute, &descrs, &nb_data, varg_list); if (ret < 0) return ret; /* Send and receive data as requested */ for(i=0 ; iname:NULL); *task = starpu_task_create(); (*task)->cl_arg_free = 1; va_copy(varg_list_copy, varg_list); _starpu_task_insert_create(codelet, task, varg_list_copy); va_end(varg_list_copy); return 0; } } static int _starpu_mpi_task_postbuild_v(MPI_Comm comm, int xrank, int do_execute, struct starpu_data_descr *descrs, int nb_data) { int me, i; starpu_mpi_comm_rank(comm, &me); for(i=0 ; icl, (codelet == NULL) ? "none" : task->cl->name ? task->cl->name : (task->cl->model && task->cl->model->symbol)?task->cl->model->symbol:"none"); task->destroy = 0; starpu_task_destroy(task); } } return _starpu_mpi_task_postbuild_v(comm, xrank, do_execute, descrs, nb_data); } int starpu_mpi_task_insert(MPI_Comm comm, struct starpu_codelet *codelet, ...) { va_list varg_list; int ret; va_start(varg_list, codelet); ret = _starpu_mpi_task_insert_v(comm, codelet, varg_list); va_end(varg_list); return ret; } int starpu_mpi_insert_task(MPI_Comm comm, struct starpu_codelet *codelet, ...) { va_list varg_list; int ret; va_start(varg_list, codelet); ret = _starpu_mpi_task_insert_v(comm, codelet, varg_list); va_end(varg_list); return ret; } struct starpu_task *starpu_mpi_task_build(MPI_Comm comm, struct starpu_codelet *codelet, ...) { va_list varg_list; struct starpu_task *task; int ret; va_start(varg_list, codelet); ret = _starpu_mpi_task_build_v(comm, codelet, &task, NULL, NULL, NULL, varg_list); va_end(varg_list); STARPU_ASSERT(ret >= 0); if (ret > 0) return NULL; else return task; } int starpu_mpi_task_post_build(MPI_Comm comm, struct starpu_codelet *codelet, ...) { int xrank, do_execute; int ret, me, nb_nodes; va_list varg_list; struct starpu_data_descr *descrs; int nb_data; starpu_mpi_comm_rank(comm, &me); starpu_mpi_comm_size(comm, &nb_nodes); va_start(varg_list, codelet); /* Find out whether we are to execute the data because we own the data to be written to. */ ret = _starpu_mpi_task_decode_v(codelet, me, nb_nodes, &xrank, &do_execute, &descrs, &nb_data, varg_list); va_end(varg_list); if (ret < 0) return ret; return _starpu_mpi_task_postbuild_v(comm, xrank, do_execute, descrs, nb_data); } void starpu_mpi_get_data_on_node_detached(MPI_Comm comm, starpu_data_handle_t data_handle, int node, void (*callback)(void*), void *arg) { int me, rank, tag; rank = starpu_data_get_rank(data_handle); tag = starpu_data_get_tag(data_handle); if (rank == -1) { _STARPU_ERROR("StarPU needs to be told the MPI rank of this data, using starpu_mpi_data_register() or starpu_data_set_rank()\n"); } if (tag == -1) { _STARPU_ERROR("StarPU needs to be told the MPI tag of this data, using starpu_mpi_data_register() or starpu_data_set_tag()\n"); } starpu_mpi_comm_rank(comm, &me); if (node == rank) return; if (me == node) { starpu_mpi_irecv_detached(data_handle, rank, tag, comm, callback, arg); } else if (me == rank) { starpu_mpi_isend_detached(data_handle, node, tag, comm, NULL, NULL); } } void starpu_mpi_get_data_on_node(MPI_Comm comm, starpu_data_handle_t data_handle, int node) { int me, rank, tag; rank = starpu_data_get_rank(data_handle); tag = starpu_data_get_tag(data_handle); if (rank == -1) { fprintf(stderr,"StarPU needs to be told the MPI rank of this data, using starpu_data_set_rank\n"); STARPU_ABORT(); } if (tag == -1) { fprintf(stderr,"StarPU needs to be told the MPI tag of this data, using starpu_data_set_tag\n"); STARPU_ABORT(); } starpu_mpi_comm_rank(comm, &me); if (node == rank) return; if (me == node) { MPI_Status status; starpu_mpi_recv(data_handle, rank, tag, comm, &status); } else if (me == rank) { starpu_mpi_send(data_handle, node, tag, comm); } } struct _starpu_mpi_redux_data_args { starpu_data_handle_t data_handle; starpu_data_handle_t new_handle; int tag; int node; MPI_Comm comm; struct starpu_task *taskB; }; void _starpu_mpi_redux_data_dummy_func(STARPU_ATTRIBUTE_UNUSED void *buffers[], STARPU_ATTRIBUTE_UNUSED void *cl_arg) { } static struct starpu_codelet _starpu_mpi_redux_data_read_cl = { .cpu_funcs = {_starpu_mpi_redux_data_dummy_func}, .cuda_funcs = {_starpu_mpi_redux_data_dummy_func}, .opencl_funcs = {_starpu_mpi_redux_data_dummy_func}, .nbuffers = 1, .modes = {STARPU_R}, .name = "_starpu_mpi_redux_data_read_cl" }; struct starpu_codelet _starpu_mpi_redux_data_readwrite_cl = { .cpu_funcs = {_starpu_mpi_redux_data_dummy_func}, .cuda_funcs = {_starpu_mpi_redux_data_dummy_func}, .opencl_funcs = {_starpu_mpi_redux_data_dummy_func}, .nbuffers = 1, .modes = {STARPU_RW}, .name = "_starpu_mpi_redux_data_write_cl" }; static void _starpu_mpi_redux_data_detached_callback(void *arg) { struct _starpu_mpi_redux_data_args *args = (struct _starpu_mpi_redux_data_args *) arg; STARPU_TASK_SET_HANDLE(args->taskB, args->new_handle, 1); int ret = starpu_task_submit(args->taskB); STARPU_ASSERT(ret == 0); starpu_data_unregister_submit(args->new_handle); free(args); } static void _starpu_mpi_redux_data_recv_callback(void *callback_arg) { struct _starpu_mpi_redux_data_args *args = (struct _starpu_mpi_redux_data_args *) callback_arg; starpu_data_register_same(&args->new_handle, args->data_handle); starpu_mpi_irecv_detached_sequential_consistency(args->new_handle, args->node, args->tag, args->comm, _starpu_mpi_redux_data_detached_callback, args, 0); } /* TODO: this should rather be implicitly called by starpu_mpi_task_insert when * a data previously accessed in REDUX mode gets accessed in R mode. */ void starpu_mpi_redux_data(MPI_Comm comm, starpu_data_handle_t data_handle) { int me, rank, tag, nb_nodes; rank = starpu_data_get_rank(data_handle); tag = starpu_data_get_tag(data_handle); if (rank == -1) { fprintf(stderr,"StarPU needs to be told the MPI rank of this data, using starpu_data_set_rank\n"); STARPU_ABORT(); } if (tag == -1) { fprintf(stderr,"StarPU needs to be told the MPI tag of this data, using starpu_data_set_tag\n"); STARPU_ABORT(); } starpu_mpi_comm_rank(comm, &me); starpu_mpi_comm_size(comm, &nb_nodes); _STARPU_MPI_DEBUG(1, "Doing reduction for data %p on node %d with %d nodes ...\n", data_handle, rank, nb_nodes); // need to count how many nodes have the data in redux mode if (me == rank) { int i, j=0; struct starpu_task *taskBs[nb_nodes]; for(i=0 ; idata_handle = data_handle; args->tag = tag; args->node = i; args->comm = comm; // We need to create taskB early as // taskC declares a dependancy on it args->taskB = starpu_task_create(); args->taskB->cl = args->data_handle->redux_cl; args->taskB->sequential_consistency = 0; STARPU_TASK_SET_HANDLE(args->taskB, args->data_handle, 0); taskBs[j] = args->taskB; j++; // Submit taskA starpu_task_insert(&_starpu_mpi_redux_data_read_cl, STARPU_R, data_handle, STARPU_CALLBACK_WITH_ARG, _starpu_mpi_redux_data_recv_callback, args, 0); } } // Submit taskC which depends on all taskBs created struct starpu_task *taskC = starpu_task_create(); taskC->cl = &_starpu_mpi_redux_data_readwrite_cl; STARPU_TASK_SET_HANDLE(taskC, data_handle, 0); starpu_task_declare_deps_array(taskC, j, taskBs); int ret = starpu_task_submit(taskC); STARPU_ASSERT(ret == 0); } else { _STARPU_MPI_DEBUG(1, "Sending redux handle to %d ...\n", rank); starpu_mpi_isend_detached(data_handle, rank, tag, comm, NULL, NULL); starpu_task_insert(data_handle->init_cl, STARPU_W, data_handle, 0); } /* FIXME: In order to prevent simultaneous receive submissions * on the same handle, we need to wait that all the starpu_mpi * tasks are done before submitting next tasks. The current * version of the implementation does not support multiple * simultaneous receive requests on the same handle.*/ starpu_task_wait_for_all(); }