1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
|
#include "opal_config.h"
#include "common_ucx.h"
#include "common_ucx_wpool.h"
#include "common_ucx_wpool_int.h"
#include "opal/mca/base/mca_base_framework.h"
#include "opal/mca/base/mca_base_var.h"
#include "opal/mca/pmix/pmix-internal.h"
#include "opal/memoryhooks/memory.h"
#include "opal/util/proc.h"
#include "opal/util/sys_limits.h"
#include "opal/util/sys_limits.h"
#include <ucm/api/ucm.h>
/*******************************************************************************
*******************************************************************************
*
* Worker Pool (wpool) framework
* Used to manage multi-threaded implementation of UCX for ompi/OSC & OSHMEM
*
*******************************************************************************
******************************************************************************/
OBJ_CLASS_INSTANCE(opal_common_ucx_winfo_t, opal_list_item_t, NULL, _winfo_destructor);
OBJ_CLASS_INSTANCE(_ctx_record_t, opal_list_item_t, NULL, NULL);
OBJ_CLASS_INSTANCE(_mem_record_t, opal_list_item_t, NULL, NULL);
// TODO: Remove once debug is completed
#ifdef OPAL_COMMON_UCX_WPOOL_DBG
__thread FILE *tls_pf = NULL;
__thread int initialized = 0;
#endif
bool opal_common_ucx_thread_enabled = false;
opal_atomic_int64_t opal_common_ucx_ep_counts = 0;
opal_atomic_int64_t opal_common_ucx_unpacked_rkey_counts = 0;
static _ctx_record_t *_tlocal_add_ctx_rec(opal_common_ucx_ctx_t *ctx);
static inline _ctx_record_t *_tlocal_get_ctx_rec(opal_tsd_tracked_key_t tls_key);
static void _tlocal_ctx_rec_cleanup(_ctx_record_t *ctx_rec);
static void _tlocal_mem_rec_cleanup(_mem_record_t *mem_rec);
static void _ctx_rec_destructor(void *arg);
static void _mem_rec_destructor(void *arg);
/* -----------------------------------------------------------------------------
* Worker information (winfo) management functionality
*----------------------------------------------------------------------------*/
static opal_common_ucx_winfo_t *_winfo_create(opal_common_ucx_wpool_t *wpool)
{
ucp_worker_params_t worker_params;
ucp_worker_h worker;
ucs_status_t status;
opal_common_ucx_winfo_t *winfo = NULL;
if (opal_common_ucx_thread_enabled || wpool->dflt_winfo == NULL) {
memset(&worker_params, 0, sizeof(worker_params));
worker_params.field_mask = UCP_WORKER_PARAM_FIELD_THREAD_MODE;
worker_params.thread_mode = UCS_THREAD_MODE_SINGLE;
status = ucp_worker_create(wpool->ucp_ctx, &worker_params, &worker);
if (UCS_OK != status) {
MCA_COMMON_UCX_ERROR("ucp_worker_create failed: %d", status);
goto exit;
}
} else {
/* Single threaded application can reuse the default worker */
worker = wpool->dflt_winfo->worker;
}
winfo = OBJ_NEW(opal_common_ucx_winfo_t);
if (NULL == winfo) {
MCA_COMMON_UCX_ERROR("Cannot allocate memory for worker info");
goto release_worker;
}
OBJ_CONSTRUCT(&winfo->mutex, opal_recursive_mutex_t);
winfo->worker = worker;
winfo->endpoints = NULL;
winfo->comm_size = 0;
winfo->inflight_ops = NULL;
winfo->global_inflight_ops = 0;
winfo->inflight_req = UCS_OK;
winfo->is_dflt_winfo = false;
return winfo;
release_worker:
ucp_worker_destroy(worker);
exit:
return winfo;
}
static void _winfo_destructor(opal_common_ucx_winfo_t *winfo)
{
if (winfo->inflight_req != UCS_OK) {
opal_common_ucx_wait_request_mt(winfo->inflight_req, "opal_common_ucx_flush");
winfo->inflight_req = UCS_OK;
}
assert(winfo->global_inflight_ops == 0);
if (winfo->comm_size != 0) {
size_t i;
if (opal_common_ucx_thread_enabled) {
for (i = 0; i < winfo->comm_size; i++) {
if (NULL != winfo->endpoints[i]) {
ucp_ep_destroy(winfo->endpoints[i]);
OPAL_COMMON_UCX_DEBUG_ATOMIC_ADD(opal_common_ucx_ep_counts, -1);
}
assert(winfo->inflight_ops[i] == 0);
}
}
free(winfo->endpoints);
free(winfo->inflight_ops);
}
winfo->endpoints = NULL;
winfo->comm_size = 0;
OBJ_DESTRUCT(&winfo->mutex);
if (opal_common_ucx_thread_enabled || winfo->is_dflt_winfo) {
ucp_worker_destroy(winfo->worker);
}
}
/* -----------------------------------------------------------------------------
* Worker Pool management functionality
*----------------------------------------------------------------------------*/
OPAL_DECLSPEC opal_common_ucx_wpool_t *opal_common_ucx_wpool_allocate(void)
{
opal_common_ucx_wpool_t *ptr = calloc(1, sizeof(opal_common_ucx_wpool_t));
ptr->refcnt = 0;
return ptr;
}
OPAL_DECLSPEC void opal_common_ucx_wpool_free(opal_common_ucx_wpool_t *wpool)
{
assert(wpool->refcnt == 0);
free(wpool);
}
static int _wpool_list_put(opal_common_ucx_wpool_t *wpool, opal_list_t *list,
opal_common_ucx_winfo_t *winfo);
OPAL_DECLSPEC int opal_common_ucx_wpool_init(opal_common_ucx_wpool_t *wpool)
{
opal_common_ucx_winfo_t *winfo;
ucs_status_t status;
int rc = OPAL_SUCCESS;
wpool->refcnt++;
if (1 < wpool->refcnt) {
return rc;
}
OBJ_CONSTRUCT(&wpool->mutex, opal_mutex_t);
/* create recv worker and add to idle pool */
OBJ_CONSTRUCT(&wpool->idle_workers, opal_list_t);
OBJ_CONSTRUCT(&wpool->active_workers, opal_list_t);
wpool->dflt_winfo = NULL;
winfo = _winfo_create(wpool);
if (NULL == winfo) {
MCA_COMMON_UCX_ERROR("Failed to create receive worker");
rc = OPAL_ERROR;
goto err_worker_create;
}
winfo->is_dflt_winfo = true;
wpool->dflt_winfo = winfo;
OBJ_RETAIN(wpool->dflt_winfo);
status = ucp_worker_get_address(wpool->dflt_winfo->worker, &wpool->recv_waddr,
&wpool->recv_waddr_len);
if (status != UCS_OK) {
MCA_COMMON_UCX_VERBOSE(1, "ucp_worker_get_address failed: %d", status);
rc = OPAL_ERROR;
goto err_get_addr;
}
rc = _wpool_list_put(wpool, &wpool->idle_workers, winfo);
if (rc) {
goto err_wpool_add;
}
return rc;
err_wpool_add:
free(wpool->recv_waddr);
err_get_addr:
OBJ_RELEASE(winfo);
wpool->dflt_winfo = NULL;
err_worker_create:
OBJ_DESTRUCT(&wpool->idle_workers);
OBJ_DESTRUCT(&wpool->active_workers);
ucp_cleanup(wpool->ucp_ctx);
err_ucp_init:
return rc;
}
OPAL_DECLSPEC
void opal_common_ucx_wpool_finalize(opal_common_ucx_wpool_t *wpool)
{
wpool->refcnt--;
if (wpool->refcnt > 0) {
return;
}
/* Release the address here. recv worker will be released
* below along with other idle workers */
ucp_worker_release_address(wpool->dflt_winfo->worker, wpool->recv_waddr);
/* Go over the list, free idle list items */
if (!opal_list_is_empty(&wpool->idle_workers)) {
opal_common_ucx_winfo_t *winfo, *next;
OPAL_LIST_FOREACH_SAFE (winfo, next, &wpool->idle_workers, opal_common_ucx_winfo_t) {
opal_list_remove_item(&wpool->idle_workers, &winfo->super);
OBJ_RELEASE(winfo);
}
}
OBJ_DESTRUCT(&wpool->idle_workers);
/* Release active workers. They are no longer active actually
* because opal_common_ucx_wpool_finalize is being called. */
if (!opal_list_is_empty(&wpool->active_workers)) {
opal_common_ucx_winfo_t *winfo, *next;
OPAL_LIST_FOREACH_SAFE (winfo, next, &wpool->active_workers, opal_common_ucx_winfo_t) {
opal_list_remove_item(&wpool->active_workers, &winfo->super);
OBJ_RELEASE(winfo);
}
}
OBJ_DESTRUCT(&wpool->active_workers);
OBJ_RELEASE(wpool->dflt_winfo);
wpool->dflt_winfo = NULL;
OBJ_DESTRUCT(&wpool->mutex);
if (NULL != wpool->ucp_ctx) {
ucp_cleanup(wpool->ucp_ctx);
wpool->ucp_ctx = NULL;
}
return;
}
OPAL_DECLSPEC int opal_common_ucx_wpool_progress(opal_common_ucx_wpool_t *wpool)
{
opal_common_ucx_winfo_t *winfo = NULL, *next = NULL;
int completed = 0, progressed = 0;
/* Go over all active workers and progress them
* TODO: may want to have some partitioning to progress only part of
* workers */
if (0 != opal_mutex_trylock(&wpool->mutex)) {
return completed;
}
bool progress_dflt_worker = true;
OPAL_LIST_FOREACH_SAFE (winfo, next, &wpool->active_workers, opal_common_ucx_winfo_t) {
if (0 != opal_mutex_trylock(&winfo->mutex)) {
continue;
}
do {
if (winfo == wpool->dflt_winfo) {
progress_dflt_worker = false;
}
progressed = ucp_worker_progress(winfo->worker);
completed += progressed;
} while (progressed);
opal_mutex_unlock(&winfo->mutex);
}
opal_mutex_unlock(&wpool->mutex);
if (progress_dflt_worker) {
/* make sure to progress at least some */
opal_mutex_lock(&wpool->dflt_winfo->mutex);
completed += ucp_worker_progress(wpool->dflt_winfo->worker);
opal_mutex_unlock(&wpool->dflt_winfo->mutex);
}
return completed;
}
static int _wpool_list_put(opal_common_ucx_wpool_t *wpool, opal_list_t *list,
opal_common_ucx_winfo_t *winfo)
{
opal_list_append(list, &winfo->super);
return OPAL_SUCCESS;
}
static opal_common_ucx_winfo_t *_wpool_list_get(opal_common_ucx_wpool_t *wpool, opal_list_t *list)
{
opal_common_ucx_winfo_t *winfo = NULL;
if (!opal_list_is_empty(list)) {
winfo = (opal_common_ucx_winfo_t *) opal_list_get_first(list);
opal_list_remove_item(list, &winfo->super);
}
return winfo;
}
static opal_common_ucx_winfo_t *_wpool_get_winfo(opal_common_ucx_wpool_t *wpool, size_t comm_size)
{
opal_common_ucx_winfo_t *winfo;
opal_mutex_lock(&wpool->mutex);
winfo = _wpool_list_get(wpool, &wpool->idle_workers);
if (!winfo) {
winfo = _winfo_create(wpool);
if (!winfo) {
MCA_COMMON_UCX_ERROR("Failed to allocate worker info structure");
opal_mutex_unlock(&wpool->mutex);
return NULL;
}
}
winfo->endpoints = calloc(comm_size, sizeof(ucp_ep_h));
winfo->inflight_ops = calloc(comm_size, sizeof(short));
winfo->comm_size = comm_size;
/* Put the worker on the active list */
_wpool_list_put(wpool, &wpool->active_workers, winfo);
opal_mutex_unlock(&wpool->mutex);
return winfo;
}
/* Remove the winfo from active workers and add it to idle workers */
static void _wpool_put_winfo(opal_common_ucx_wpool_t *wpool, opal_common_ucx_winfo_t *winfo)
{
opal_mutex_lock(&wpool->mutex);
if (winfo->comm_size != 0) {
size_t i;
if (opal_common_ucx_thread_enabled) {
for (i = 0; i < winfo->comm_size; i++) {
if (NULL != winfo->endpoints[i]) {
ucp_ep_destroy(winfo->endpoints[i]);
OPAL_COMMON_UCX_DEBUG_ATOMIC_ADD(opal_common_ucx_ep_counts, -1);
}
assert(winfo->inflight_ops[i] == 0);
}
}
free(winfo->endpoints);
free(winfo->inflight_ops);
}
winfo->endpoints = NULL;
winfo->comm_size = 0;
opal_list_remove_item(&wpool->active_workers, &winfo->super);
opal_list_prepend(&wpool->idle_workers, &winfo->super);
opal_mutex_unlock(&wpool->mutex);
return;
}
/* -----------------------------------------------------------------------------
* Worker Pool Communication context management functionality
*----------------------------------------------------------------------------*/
OPAL_DECLSPEC int opal_common_ucx_wpctx_create(opal_common_ucx_wpool_t *wpool, int comm_size,
opal_common_ucx_exchange_func_t exchange_func,
void *exchange_metadata,
opal_common_ucx_ctx_t **ctx_ptr)
{
opal_common_ucx_ctx_t *ctx = calloc(1, sizeof(*ctx));
int ret = OPAL_SUCCESS;
OBJ_CONSTRUCT(&ctx->mutex, opal_recursive_mutex_t);
OBJ_CONSTRUCT(&ctx->ctx_records, opal_list_t);
ctx->wpool = wpool;
ctx->comm_size = comm_size;
ctx->recv_worker_addrs = NULL;
ctx->recv_worker_displs = NULL;
ctx->num_incomplete_req_ops = 0;
ret = exchange_func(wpool->recv_waddr, wpool->recv_waddr_len, &ctx->recv_worker_addrs,
&ctx->recv_worker_displs, exchange_metadata);
if (ret != OPAL_SUCCESS) {
goto error;
}
OBJ_CONSTRUCT(&ctx->tls_key, opal_tsd_tracked_key_t);
opal_tsd_tracked_key_set_destructor(&ctx->tls_key, _ctx_rec_destructor);
(*ctx_ptr) = ctx;
return ret;
error:
OBJ_DESTRUCT(&ctx->mutex);
OBJ_DESTRUCT(&ctx->ctx_records);
free(ctx);
(*ctx_ptr) = NULL;
return ret;
}
OPAL_DECLSPEC void opal_common_ucx_wpctx_release(opal_common_ucx_ctx_t *ctx)
{
_ctx_record_t *ctx_rec = NULL, *next;
/* Application is expected to guarantee that no operation
* is performed on the context that is being released */
/* destroy key so that other threads don't invoke destructors */
OBJ_DESTRUCT(&ctx->tls_key);
/* loop through list of records */
OPAL_LIST_FOREACH_SAFE (ctx_rec, next, &ctx->ctx_records, _ctx_record_t) {
_tlocal_ctx_rec_cleanup(ctx_rec);
}
free(ctx->recv_worker_addrs);
free(ctx->recv_worker_displs);
OBJ_DESTRUCT(&ctx->mutex);
OBJ_DESTRUCT(&ctx->ctx_records);
free(ctx);
}
/* -----------------------------------------------------------------------------
* Worker Pool Memory management functionality
*----------------------------------------------------------------------------*/
OPAL_DECLSPEC
int opal_common_ucx_wpmem_create(opal_common_ucx_ctx_t *ctx, void **mem_base, size_t mem_size,
opal_common_ucx_mem_type_t mem_type,
opal_common_ucx_exchange_func_t exchange_func,
opal_common_ucx_exchange_mode_t exchange_mode,
void *exchange_metadata, char **my_mem_addr, int *my_mem_addr_size,
opal_common_ucx_wpmem_t **mem_ptr)
{
opal_common_ucx_wpmem_t *mem = calloc(1, sizeof(*mem));
void *rkey_addr = NULL;
size_t rkey_addr_len;
ucs_status_t status;
int ret = OPAL_SUCCESS;
mem->ctx = ctx;
mem->mem_addrs = NULL;
mem->mem_displs = NULL;
mem->skip_periodic_flush = false;
OBJ_CONSTRUCT(&mem->mutex, opal_mutex_t);
ret = _comm_ucx_wpmem_map(ctx->wpool, mem_base, mem_size, &mem->memh, mem_type);
if (ret != OPAL_SUCCESS) {
MCA_COMMON_UCX_VERBOSE(1, "_comm_ucx_mem_map failed: %d", ret);
goto error_mem_map;
}
status = ucp_rkey_pack(ctx->wpool->ucp_ctx, mem->memh, &rkey_addr, &rkey_addr_len);
if (status != UCS_OK) {
MCA_COMMON_UCX_VERBOSE(1, "ucp_rkey_pack failed: %d", status);
ret = OPAL_ERROR;
goto error_rkey_pack;
}
if (exchange_mode == OPAL_COMMON_UCX_WPMEM_ADDR_EXCHANGE_FULL) {
ret = exchange_func(rkey_addr, rkey_addr_len, &mem->mem_addrs, &mem->mem_displs,
exchange_metadata);
if (ret != OPAL_SUCCESS) {
goto error_rkey_pack;
}
}
OBJ_CONSTRUCT(&mem->tls_key, opal_tsd_tracked_key_t);
opal_tsd_tracked_key_set_destructor(&mem->tls_key, _mem_rec_destructor);
(*mem_ptr) = mem;
(*my_mem_addr) = rkey_addr;
(*my_mem_addr_size) = rkey_addr_len;
return ret;
error_rkey_pack:
ucp_mem_unmap(ctx->wpool->ucp_ctx, mem->memh);
error_mem_map:
free(mem);
(*mem_ptr) = NULL;
return ret;
}
static int _comm_ucx_wpmem_map(opal_common_ucx_wpool_t *wpool, void **base, size_t size,
ucp_mem_h *memh_ptr, opal_common_ucx_mem_type_t mem_type)
{
ucp_mem_map_params_t mem_params;
ucp_mem_attr_t mem_attrs;
ucs_status_t status;
int ret = OPAL_SUCCESS;
memset(&mem_params, 0, sizeof(ucp_mem_map_params_t));
mem_params.field_mask = UCP_MEM_MAP_PARAM_FIELD_ADDRESS | UCP_MEM_MAP_PARAM_FIELD_LENGTH
| UCP_MEM_MAP_PARAM_FIELD_FLAGS;
mem_params.length = size;
if (mem_type == OPAL_COMMON_UCX_MEM_ALLOCATE_MAP) {
mem_params.address = NULL;
mem_params.flags = UCP_MEM_MAP_ALLOCATE;
} else {
mem_params.address = (*base);
}
status = ucp_mem_map(wpool->ucp_ctx, &mem_params, memh_ptr);
if (status != UCS_OK) {
MCA_COMMON_UCX_VERBOSE(1, "ucp_mem_map failed: %d", status);
ret = OPAL_ERROR;
return ret;
}
mem_attrs.field_mask = UCP_MEM_ATTR_FIELD_ADDRESS | UCP_MEM_ATTR_FIELD_LENGTH;
status = ucp_mem_query((*memh_ptr), &mem_attrs);
if (status != UCS_OK) {
MCA_COMMON_UCX_VERBOSE(1, "ucp_mem_query failed: %d", status);
ret = OPAL_ERROR;
goto error;
}
assert(mem_attrs.length >= size);
if (mem_type != OPAL_COMMON_UCX_MEM_ALLOCATE_MAP) {
/* Returned mapped address is aligned to ucs rcache->params.alignment.
* Alignment is less than page size */
assert(((mem_attrs.address <= (*base)) && ((*base) - opal_getpagesize()
< mem_attrs.address)) || (size == 0 && mem_attrs.address == NULL));
} else {
(*base) = mem_attrs.address;
}
return ret;
error:
ucp_mem_unmap(wpool->ucp_ctx, (*memh_ptr));
return ret;
}
void opal_common_ucx_wpmem_free(opal_common_ucx_wpmem_t *mem)
{
if (NULL == mem) {
return;
}
OBJ_DESTRUCT(&mem->tls_key);
free(mem->mem_addrs);
free(mem->mem_displs);
ucp_mem_unmap(mem->ctx->wpool->ucp_ctx, mem->memh);
free(mem);
}
static inline _ctx_record_t *_tlocal_get_ctx_rec(opal_tsd_tracked_key_t tls_key)
{
_ctx_record_t *ctx_rec = NULL;
int rc = opal_tsd_tracked_key_get(&tls_key, (void **) &ctx_rec);
if (OPAL_SUCCESS != rc) {
return NULL;
}
return ctx_rec;
}
static void _ctx_rec_destructor(void *arg)
{
_tlocal_ctx_rec_cleanup((_ctx_record_t *) arg);
return;
}
/* Thread local storage destructor, also called from wpool_ctx release */
static void _tlocal_ctx_rec_cleanup(_ctx_record_t *ctx_rec)
{
if (NULL == ctx_rec) {
return;
}
opal_common_ucx_winfo_t *winfo = ctx_rec->winfo;
opal_common_ucx_wpool_t *wpool = ctx_rec->gctx->wpool;
opal_mutex_lock(&winfo->mutex);
int rc = opal_common_ucx_winfo_flush(winfo, 0, OPAL_COMMON_UCX_FLUSH_B, OPAL_COMMON_UCX_SCOPE_WORKER, NULL);
winfo->global_inflight_ops = 0;
memset(winfo->inflight_ops, 0, winfo->comm_size * sizeof(short));
opal_mutex_unlock(&winfo->mutex);
if (rc != OPAL_SUCCESS) {
MCA_COMMON_UCX_ERROR("opal_common_ucx_flush failed: %d", rc);
return;
}
/* Remove worker from active and return to idle list. */
_wpool_put_winfo(wpool, winfo);
/* Remove the context record from the ctx list. */
opal_mutex_lock(&ctx_rec->gctx->mutex);
opal_list_remove_item(&ctx_rec->gctx->ctx_records, &ctx_rec->super);
opal_mutex_unlock(&ctx_rec->gctx->mutex);
OBJ_RELEASE(ctx_rec);
return;
}
static _ctx_record_t *_tlocal_add_ctx_rec(opal_common_ucx_ctx_t *ctx)
{
int rc;
_ctx_record_t *ctx_rec = OBJ_NEW(_ctx_record_t);
if (!ctx_rec) {
MCA_COMMON_UCX_ERROR("Failed to allocate new ctx_rec");
goto error1;
}
ctx_rec->gctx = ctx;
ctx_rec->winfo = _wpool_get_winfo(ctx->wpool, ctx->comm_size);
if (NULL == ctx_rec->winfo) {
MCA_COMMON_UCX_ERROR("Failed to allocate new worker");
goto error2;
}
/* Add ctx_rec to list */
opal_mutex_lock(&ctx->mutex);
opal_list_append(&ctx->ctx_records, &ctx_rec->super);
opal_mutex_unlock(&ctx->mutex);
/* Add tls reference to record */
rc = opal_tsd_tracked_key_set(&ctx->tls_key, ctx_rec);
if (OPAL_SUCCESS != rc) {
MCA_COMMON_UCX_ERROR("Failed to set ctx_rec tls key");
goto error3;
}
/* All good - return the record */
return ctx_rec;
error3:
opal_mutex_lock(&ctx->mutex);
opal_list_remove_item(&ctx->ctx_records, &ctx_rec->super);
opal_mutex_unlock(&ctx->mutex);
_wpool_put_winfo(ctx->wpool, ctx_rec->winfo);
error2:
OBJ_RELEASE(ctx_rec);
error1:
return NULL;
}
static int _tlocal_ctx_connect(_ctx_record_t *ctx_rec, int target)
{
ucp_ep_params_t ep_params;
opal_common_ucx_winfo_t *winfo = ctx_rec->winfo;
opal_common_ucx_ctx_t *gctx = ctx_rec->gctx;
ucs_status_t status;
int displ;
memset(&ep_params, 0, sizeof(ucp_ep_params_t));
ep_params.field_mask = UCP_EP_PARAM_FIELD_REMOTE_ADDRESS;
assert(winfo->endpoints[target] == NULL);
opal_mutex_lock(&winfo->mutex);
displ = gctx->recv_worker_displs[target];
ep_params.address = (ucp_address_t *) &(gctx->recv_worker_addrs[displ]);
status = ucp_ep_create(winfo->worker, &ep_params, &winfo->endpoints[target]);
if (status != UCS_OK) {
MCA_COMMON_UCX_VERBOSE(1, "ucp_ep_create failed: %d", status);
opal_mutex_unlock(&winfo->mutex);
return OPAL_ERROR;
}
OPAL_COMMON_UCX_DEBUG_ATOMIC_ADD(opal_common_ucx_ep_counts, 1);
opal_mutex_unlock(&winfo->mutex);
assert(winfo->endpoints[target] != NULL);
return OPAL_SUCCESS;
}
static void _mem_rec_destructor(void *arg)
{
_tlocal_mem_rec_cleanup((_mem_record_t *) arg);
return;
}
static void _tlocal_mem_rec_cleanup(_mem_record_t *mem_rec)
{
size_t i;
if (NULL == mem_rec) {
return;
}
opal_mutex_lock(&mem_rec->winfo->mutex);
for (i = 0; i < mem_rec->gmem->ctx->comm_size; i++) {
if (mem_rec->rkeys[i]) {
ucp_rkey_destroy(mem_rec->rkeys[i]);
OPAL_COMMON_UCX_DEBUG_ATOMIC_ADD(opal_common_ucx_unpacked_rkey_counts, -1);
}
}
opal_mutex_unlock(&mem_rec->winfo->mutex);
free(mem_rec->rkeys);
OBJ_RELEASE(mem_rec);
return;
}
static _mem_record_t *_tlocal_add_mem_rec(opal_common_ucx_wpmem_t *mem, _ctx_record_t *ctx_rec)
{
int rc = OPAL_SUCCESS;
_mem_record_t *mem_rec = OBJ_NEW(_mem_record_t);
if (NULL == mem_rec) {
return NULL;
}
mem_rec->gmem = mem;
mem_rec->ctx_rec = ctx_rec;
mem_rec->winfo = ctx_rec->winfo;
mem_rec->rkeys = calloc(mem->ctx->comm_size, sizeof(*mem_rec->rkeys));
rc = opal_tsd_tracked_key_set(&mem->tls_key, mem_rec);
if (OPAL_SUCCESS != rc) {
return NULL;
}
return mem_rec;
}
static int _tlocal_mem_create_rkey(_mem_record_t *mem_rec, ucp_ep_h ep, int target)
{
opal_common_ucx_wpmem_t *gmem = mem_rec->gmem;
int displ = gmem->mem_displs[target];
ucs_status_t status;
opal_mutex_lock(&mem_rec->winfo->mutex);
status = ucp_ep_rkey_unpack(ep, &gmem->mem_addrs[displ], &mem_rec->rkeys[target]);
OPAL_COMMON_UCX_DEBUG_ATOMIC_ADD(opal_common_ucx_unpacked_rkey_counts, 1);
opal_mutex_unlock(&mem_rec->winfo->mutex);
if (status != UCS_OK) {
MCA_COMMON_UCX_VERBOSE(1, "ucp_ep_rkey_unpack failed: %d", status);
return OPAL_ERROR;
}
return OPAL_SUCCESS;
}
/* Get the TLS in case of slow path (not everything has been yet initialized */
OPAL_DECLSPEC int opal_common_ucx_tlocal_fetch_spath(opal_common_ucx_wpmem_t *mem, int target, ucp_ep_h *dflt_ep)
{
_ctx_record_t *ctx_rec = NULL;
_mem_record_t *mem_rec = NULL;
opal_common_ucx_winfo_t *winfo = NULL;
ucp_ep_h ep;
int rc = OPAL_SUCCESS;
ctx_rec = _tlocal_get_ctx_rec(mem->ctx->tls_key);
if (OPAL_UNLIKELY(!ctx_rec)) {
ctx_rec = _tlocal_add_ctx_rec(mem->ctx);
if (NULL == ctx_rec) {
return OPAL_ERR_OUT_OF_RESOURCE;
}
}
winfo = ctx_rec->winfo;
/* Obtain the endpoint */
if (OPAL_UNLIKELY(NULL == winfo->endpoints[target])) {
if (opal_common_ucx_thread_enabled || (dflt_ep == NULL) ||
(*dflt_ep == NULL)) {
rc = _tlocal_ctx_connect(ctx_rec, target);
if (rc != OPAL_SUCCESS) {
return rc;
}
if (!opal_common_ucx_thread_enabled && (dflt_ep != NULL) &&
(*dflt_ep == NULL)) {
/* set the proc ep */
*dflt_ep = winfo->endpoints[target];
}
} else {
/* reuse the previously created ep */
winfo->endpoints[target] = *dflt_ep;
}
}
ep = winfo->endpoints[target];
rc = opal_tsd_tracked_key_get(&mem->tls_key, (void **) &mem_rec);
if (OPAL_SUCCESS != rc) {
return rc;
}
if (NULL == mem_rec) {
/* Allocate a memory region info */
mem_rec = _tlocal_add_mem_rec(mem, ctx_rec);
}
/* Obtain the rkey */
if (NULL == mem_rec->rkeys[target]) {
/* Create the rkey */
rc = _tlocal_mem_create_rkey(mem_rec, ep, target);
if (rc) {
return rc;
}
}
return OPAL_SUCCESS;
}
OPAL_DECLSPEC int opal_common_ucx_winfo_flush(opal_common_ucx_winfo_t *winfo, int target,
opal_common_ucx_flush_type_t type,
opal_common_ucx_flush_scope_t scope,
ucs_status_ptr_t *req_ptr)
{
ucs_status_ptr_t req;
ucs_status_t status = UCS_OK;
int rc = OPAL_SUCCESS;
#if HAVE_DECL_UCP_EP_FLUSH_NB
if (scope == OPAL_COMMON_UCX_SCOPE_EP) {
req = ucp_ep_flush_nb(winfo->endpoints[target], 0, opal_common_ucx_empty_complete_cb);
} else {
req = ucp_worker_flush_nb(winfo->worker, 0, opal_common_ucx_empty_complete_cb);
}
if (UCS_PTR_IS_PTR(req)) {
((opal_common_ucx_request_t *) req)->winfo = winfo;
}
if (OPAL_COMMON_UCX_FLUSH_B == type) {
rc = opal_common_ucx_wait_request_mt(req, "ucp_ep_flush_nb");
} else {
*req_ptr = req;
}
return rc;
#endif
switch (type) {
case OPAL_COMMON_UCX_FLUSH_NB_PREFERRED:
case OPAL_COMMON_UCX_FLUSH_B:
if (scope == OPAL_COMMON_UCX_SCOPE_EP) {
status = ucp_ep_flush(winfo->endpoints[target]);
} else {
status = ucp_worker_flush(winfo->worker);
}
rc = (status == UCS_OK) ? OPAL_SUCCESS : OPAL_ERROR;
case OPAL_COMMON_UCX_FLUSH_NB:
default:
rc = OPAL_ERROR;
}
return rc;
}
static inline int ctx_flush(opal_common_ucx_ctx_t *ctx,
opal_common_ucx_flush_scope_t scope, int target)
{
_ctx_record_t *ctx_rec;
int rc = OPAL_SUCCESS;
if (NULL == ctx) {
return OPAL_SUCCESS;
}
opal_mutex_lock(&ctx->mutex);
OPAL_LIST_FOREACH (ctx_rec, &ctx->ctx_records, _ctx_record_t) {
opal_common_ucx_winfo_t *winfo = ctx_rec->winfo;
if ((scope == OPAL_COMMON_UCX_SCOPE_EP) && (NULL == winfo->endpoints[target])) {
continue;
}
opal_mutex_lock(&winfo->mutex);
rc = opal_common_ucx_winfo_flush(winfo, target, OPAL_COMMON_UCX_FLUSH_B, scope, NULL);
switch (scope) {
case OPAL_COMMON_UCX_SCOPE_WORKER:
winfo->global_inflight_ops = 0;
memset(winfo->inflight_ops, 0, winfo->comm_size * sizeof(short));
break;
case OPAL_COMMON_UCX_SCOPE_EP:
winfo->global_inflight_ops -= winfo->inflight_ops[target];
winfo->inflight_ops[target] = 0;
break;
}
opal_mutex_unlock(&winfo->mutex);
if (rc != OPAL_SUCCESS) {
MCA_COMMON_UCX_ERROR("opal_common_ucx_flush failed: %d", rc);
rc = OPAL_ERROR;
break;
}
}
opal_mutex_unlock(&ctx->mutex);
return rc;
}
OPAL_DECLSPEC int opal_common_ucx_ctx_flush(opal_common_ucx_ctx_t *ctx,
opal_common_ucx_flush_scope_t scope, int target)
{
int rc = OPAL_SUCCESS;
int spin = 0;
if (NULL == ctx) {
return OPAL_SUCCESS;
}
rc = ctx_flush(ctx, scope, target);
if (rc != OPAL_SUCCESS) {
return rc;
}
/* progress the nonblocking operations */
while (ctx->num_incomplete_req_ops > 0) {
spin++;
rc = ctx_flush(ctx, OPAL_COMMON_UCX_SCOPE_WORKER, 0);
if (rc != OPAL_SUCCESS) {
return rc;
}
if (spin == opal_common_ucx.progress_iterations) {
opal_progress();
spin = 0;
}
}
return rc;
}
OPAL_DECLSPEC int opal_common_ucx_wpmem_flush_ep_nb(opal_common_ucx_wpmem_t *mem,
int target,
opal_common_ucx_user_req_handler_t user_req_cb,
void *user_req_ptr, ucp_ep_h *dflt_ep)
{
#if HAVE_DECL_UCP_EP_FLUSH_NB
int rc = OPAL_SUCCESS;
ucp_ep_h ep = NULL;
ucp_rkey_h rkey = NULL;
opal_common_ucx_winfo_t *winfo = NULL;
if (NULL == mem) {
return OPAL_SUCCESS;
}
rc = opal_common_ucx_tlocal_fetch(mem, target, &ep, &rkey, &winfo, dflt_ep);
if (OPAL_UNLIKELY(OPAL_SUCCESS != rc)) {
MCA_COMMON_UCX_ERROR("tlocal_fetch failed: %d", rc);
return rc;
}
opal_mutex_lock(&winfo->mutex);
opal_common_ucx_request_t *req;
req = ucp_worker_flush_nb(winfo->worker, 0, opal_common_ucx_req_completion);
if (UCS_PTR_IS_PTR(req)) {
req->ext_req = user_req_ptr;
req->ext_cb = user_req_cb;
req->winfo = winfo;
} else {
if (user_req_cb != NULL) {
(*user_req_cb)(user_req_ptr);
}
}
opal_mutex_unlock(&winfo->mutex);
return rc;
#else
return OPAL_ERR_NOT_SUPPORTED;
#endif // HAVE_DECL_UCP_EP_FLUSH_NB
}
/* TODO Replace the input with opal_common_ucx_ctx_t */
OPAL_DECLSPEC int opal_common_ucx_wpmem_fence(opal_common_ucx_wpmem_t *mem)
{
ucs_status_t status = UCS_OK;
_ctx_record_t *ctx_rec;
opal_common_ucx_winfo_t *winfo;
opal_common_ucx_ctx_t *ctx;
int rc = OPAL_SUCCESS;
if (NULL == mem) {
return OPAL_SUCCESS;
}
ctx = mem->ctx;
opal_mutex_lock(&ctx->mutex);
OPAL_LIST_FOREACH (ctx_rec, &ctx->ctx_records, _ctx_record_t) {
winfo = ctx_rec->winfo;
opal_mutex_lock(&winfo->mutex);
status = ucp_worker_fence(winfo->worker);
opal_mutex_unlock(&winfo->mutex);
if (status != UCS_OK) {
MCA_COMMON_UCX_ERROR("opal_common_ucx_fence failed: %d", rc);
rc = OPAL_ERROR;
break;
}
}
opal_mutex_unlock(&ctx->mutex);
return rc;
}
OPAL_DECLSPEC void opal_common_ucx_req_init(void *request)
{
opal_common_ucx_request_t *req = (opal_common_ucx_request_t *) request;
req->ext_req = NULL;
req->ext_cb = NULL;
req->winfo = NULL;
}
OPAL_DECLSPEC void opal_common_ucx_req_completion(void *request, ucs_status_t status)
{
opal_common_ucx_request_t *req = (opal_common_ucx_request_t *) request;
if (req->ext_cb != NULL) {
(*req->ext_cb)(req->ext_req);
}
ucp_request_release(req);
}
|