Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UCP: add support fixed address for mmap #1329

Merged
merged 3 commits into from
Mar 7, 2017
Merged

UCP: add support fixed address for mmap #1329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1c85205
UCP/MEM: add mmap fixed support
evgeny-leksikov Feb 2, 2017
08964f0
UCP/DOC: doc update for ucp_mem_map
evgeny-leksikov Mar 4, 2017
dd323f3
UCP/DOC: fix description of UCP_MEM_MAP_FIXED flag
evgeny-leksikov Mar 7, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions src/tools/perf/libperf.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -756,6 +756,7 @@ static ucs_status_t ucp_perf_test_alloc_mem(ucx_perf_context_t *perf, ucx_perf_p
{
ucs_status_t status;
ucp_mem_map_params_t mem_map_params;
ucp_mem_attr_t mem_attr;
size_t buffer_size;

if (params->iov_stride) {
Expand All @@ -774,13 +775,21 @@ static ucs_status_t ucp_perf_test_alloc_mem(ucx_perf_context_t *perf, ucx_perf_p
mem_map_params.length = buffer_size * params->thread_count;
mem_map_params.flags = (params->flags & UCX_PERF_TEST_FLAG_MAP_NONBLOCK) ?
UCP_MEM_MAP_NONBLOCK : 0;
mem_map_params.flags |= UCP_MEM_MAP_ALLOCATE;

status = ucp_mem_map(perf->ucp.context, &mem_map_params,
&perf->ucp.send_memh);
if (status != UCS_OK) {
goto err;
}
perf->send_buffer = mem_map_params.address;

mem_attr.field_mask = UCP_MEM_ATTR_FIELD_ADDRESS;
status = ucp_mem_query(perf->ucp.send_memh, &mem_attr);
if (status != UCS_OK) {
goto err;
}

perf->send_buffer = mem_attr.address;

/* Allocate receive buffer memory */
perf->recv_buffer = NULL;
Expand All @@ -790,13 +799,20 @@ static ucs_status_t ucp_perf_test_alloc_mem(ucx_perf_context_t *perf, ucx_perf_p
UCP_MEM_MAP_PARAM_FIELD_FLAGS;
mem_map_params.address = perf->recv_buffer;
mem_map_params.length = buffer_size * params->thread_count;
mem_map_params.flags = 0;
mem_map_params.flags = UCP_MEM_MAP_ALLOCATE;

status = ucp_mem_map(perf->ucp.context, &mem_map_params, &perf->ucp.recv_memh);
if (status != UCS_OK) {
goto err_free_send_buffer;
}
perf->recv_buffer = mem_map_params.address;

mem_attr.field_mask = UCP_MEM_ATTR_FIELD_ADDRESS;
status = ucp_mem_query(perf->ucp.recv_memh, &mem_attr);
if (status != UCS_OK) {
goto err_free_send_buffer;
}

perf->recv_buffer = mem_attr.address;

/* Allocate IOV datatype memory */
perf->params.msg_size_cnt = params->msg_size_cnt;
Expand Down Expand Up @@ -1411,4 +1427,3 @@ static int ucx_perf_thread_spawn(ucx_perf_context_t *perf,
return UCS_ERR_INVALID_PARAM;
}
#endif /* _OPENMP */

89 changes: 75 additions & 14 deletions src/ucp/api/ucp.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,11 +175,15 @@ enum ucp_ep_params_field {
* present. It is used for the enablement of backward compatibility support.
*/
enum ucp_mem_map_params_field {
UCP_MEM_MAP_PARAM_FIELD_ADDRESS = UCS_BIT(0), /**< Address of remote peer */
UCP_MEM_MAP_PARAM_FIELD_ADDRESS = UCS_BIT(0), /**< Address of the memory that
would be used in the
@ref ucp_mem_map routine,
see @ref ucp_mem_map_matrix
for details */
UCP_MEM_MAP_PARAM_FIELD_LENGTH = UCS_BIT(1), /**< The size of memory that
would be allocated or
registered in the
ucp_mem_map routine.*/
@ref ucp_mem_map routine.*/
UCP_MEM_MAP_PARAM_FIELD_FLAGS = UCS_BIT(2) /**< Allocation flags */
};

Expand Down Expand Up @@ -247,11 +251,19 @@ enum ucp_dt_type {
* ucp_mem_map() function.
*/
enum {
UCP_MEM_MAP_NONBLOCK = UCS_BIT(0) /**< Complete the mapping faster, possibly by
not populating the pages in the mapping
up-front, and mapping them later when
they are accessed by communication
routines. */
UCP_MEM_MAP_NONBLOCK = UCS_BIT(0), /**< Complete the mapping faster, possibly by
not populating the pages in the mapping
up-front, and mapping them later when
they are accessed by communication
routines. */
UCP_MEM_MAP_ALLOCATE = UCS_BIT(1), /**< Identify requirement for allocation,
if passed address is not a null-pointer
then it will be used as a hint or direct
address for allocation. */
UCP_MEM_MAP_FIXED = UCS_BIT(2) /**< Don't interpret address as a hint:
place the mapping at exactly that
address. The address must be a multiple
of the page size. */
};


Expand Down Expand Up @@ -667,26 +679,26 @@ typedef struct ucp_mem_map_params {
* segment and returns its address in this argument.
* Therefore, this value is optional.
* If it's not set (along with its corresponding bit in the field_mask -
* UCP_MEM_MAP_PARAM_FIELD_ADDRESS), the ucp_mem_map routine will consider
* @ref UCP_MEM_MAP_PARAM_FIELD_ADDRESS), the ucp_mem_map routine will consider
* address as set to NULL and will allocate memory.
*/
void *address;

/**
* Length (in bytes) to allocate or map (register).
* This field is mandatory for filling (along with its corresponding bit
* in the field_mask - UCP_MEM_MAP_PARAM_FIELD_LENGTH).
* The ucp_mem_map routine will return with an error if the length isn't
* in the field_mask - @ref UCP_MEM_MAP_PARAM_FIELD_LENGTH).
* The @ref ucp_mem_map routine will return with an error if the length isn't
* specified.
*/
size_t length;

/**
* Allocation flags, e.g. @ref UCP_MEM_MAP_NONBLOCK "UCP_MEM_MAP_NONBLOCK".
* Allocation flags, e.g. @ref UCP_MEM_MAP_NONBLOCK.
* This value is optional.
* If it's not set (along with its corresponding bit in the field_mask -
* UCP_MEM_MAP_PARAM_FIELD_FLAGS), the ucp_mem_map routine will consider
* the flags as set to zero.
* @ref UCP_MEM_MAP_PARAM_FIELD_FLAGS), the @ref ucp_mem_map routine will
* consider the flags as set to zero.
*/
unsigned flags;
} ucp_mem_map_params_t;
Expand Down Expand Up @@ -1299,6 +1311,39 @@ ucs_status_t ucp_ep_flush(ucp_ep_h ep);
* by a user, then the user is responsible for segmentation and subsequent
* management.
*
* <table>
* <caption id="ucp_mem_map_matrix">Matrix of behavior</caption>
* <tr><th>parameter/flag <td align="center">@ref UCP_MEM_MAP_NONBLOCK "NONBLOCK"</td>
* <td align="center">@ref UCP_MEM_MAP_ALLOCATE "ALLOCATE"</td>
* <td align="center">@ref UCP_MEM_MAP_FIXED "FIXED"</td>
* <td align="center">@ref ucp_mem_map_params.address "address"</td>
* <td align="center">@b result
* <tr><td rowspan="8" align="center">@b value <td rowspan="8" align="center">0/1 - the value\n only affects the\n register/map\n phase</td>
* <td align="center">0 <td align="center">0 <td align="center">0 <td align="center">@ref anch_err "error"
* <tr> <td align="center">1 <td align="center">0 <td align="center">0 <td align="center">@ref anch_alloc_reg "alloc+register"
* <tr> <td align="center">0 <td align="center">1 <td align="center">0 <td align="center">@ref anch_err "error"</td>
* <tr> <td align="center">0 <td align="center">0 <td align="center">defined <td align="center">@ref anch_reg "register"
* <tr> <td align="center">1 <td align="center">1 <td align="center">0 <td align="center">@ref anch_err "error"</td>
* <tr> <td align="center">1 <td align="center">0 <td align="center">defined <td align="center">@ref anch_alloc_hint_reg "alloc+register,hint"
* <tr> <td align="center">0 <td align="center">1 <td align="center">defined <td align="center">@ref anch_err "error"</td>
* <tr> <td align="center">1 <td align="center">1 <td align="center">defined <td align="center">@ref anch_alloc_fixed_reg "alloc+register,fixed"
* </table>
*
* @note
* @li \anchor anch_reg @b register means that the memory will be registered in
* corresponding transports for RMA/AMO operations. This case intends that
* the memory was allocated by user before.
* @li \anchor anch_alloc_reg @b alloc+register means that the memory will be allocated
* in the memory provided by the system and registered in corresponding
* transports for RMA/AMO operations.
* @li \anchor anch_alloc_hint_reg <b>alloc+register,hint</b> means that
* the memory will be allocated with using @ref ucp_mem_map_params.address
* as a hint and registered in corresponding transports for RMA/AMO operations.
* @li \anchor anch_alloc_fixed_reg <b>alloc+register,fixed</b> means that the memory
* will be allocated and registered in corresponding transports for RMA/AMO
* operations.
* @li \anchor anch_err @b error is an erroneous combination of the parameters.
*
* @param [in] context Application @ref ucp_context_h "context" to map
* (register) and allocate the memory on.
* @param [in] params User defined @ref ucp_mem_map_params_t configurations
Expand All @@ -1308,7 +1353,7 @@ ucs_status_t ucp_ep_flush(ucp_ep_h ep);
*
* @return Error code as defined by @ref ucs_status_t
*/
ucs_status_t ucp_mem_map(ucp_context_h context, ucp_mem_map_params_t *params,
ucs_status_t ucp_mem_map(ucp_context_h context, const ucp_mem_map_params_t *params,
ucp_mem_h *memh_p);


Expand Down Expand Up @@ -1342,6 +1387,22 @@ ucs_status_t ucp_mem_map(ucp_context_h context, ucp_mem_map_params_t *params,
ucs_status_t ucp_mem_unmap(ucp_context_h context, ucp_mem_h memh);


/**
* @ingroup UCP_MEM
* @brief query mapped memory segment
*
* This routine returns address and length of memory segment mapped with
* @ref ucp_mem_map "ucp_mem_map()" routine.
*
* @param [in] memh @ref ucp_mem_h "Handle" to memory region.
* @param [out] attr Filled with attributes of the @ref ucp_mem_h
* "UCP memory handle".
*
* @return Error code as defined by @ref ucs_status_t
*/
ucs_status_t ucp_mem_query(const ucp_mem_h memh, ucp_mem_attr_t *attr);


/**
* @ingroup UCP_MEM
* @brief list of UCP memory use advice.
Expand Down
38 changes: 38 additions & 0 deletions src/ucp/api/ucp_def.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,44 @@ typedef struct ucp_rkey *ucp_rkey_h;
typedef struct ucp_mem *ucp_mem_h;


/**
* @ingroup UCP_MEM
* @brief Attributes of the @ref ucp_mem_h "UCP Memory handle", filled by
* @ref ucp_mem_query function.
*/
typedef struct ucp_mem_attr {
/**
* Mask of valid fields in this structure, using bits from @ref ucp_mem_attr_field.
* Fields not specified in this mask would be ignored.
* Provides ABI compatibility with respect to adding new fields.
*/
uint64_t field_mask;

/**
* Address of the memory segment.
*/
void *address;

/**
* Size of the memory segment.
*/
size_t length;
} ucp_mem_attr_t;


/**
* @ingroup UCP_MEM
* @brief UCP Memory handle attributes field mask.
*
* The enumeration allows specifying which fields in @ref ucp_mem_attr_t are
* present. It is used for the enablement of backward compatibility support.
*/
enum ucp_mem_attr_field {
UCP_MEM_ATTR_FIELD_ADDRESS = UCS_BIT(0), /**< Virtual address */
UCP_MEM_ATTR_FIELD_LENGTH = UCS_BIT(1) /**< The size of memory region */
};


/**
* @ingroup UCP_WORKER
* @brief UCP Worker
Expand Down
Loading