oneapi-src / oneapi-src/unified-memory-framework

Should umfPutIPCHandle and umfOpenIPCHandle take const handle data pointers?

Open
#1,536 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C
Stars
98
Forks
48
Avg merge
3d 20h
Merged PRs (30d)
6

Description

Rationale

umfPutIPCHandle and umfOpenIPCHandle currently take an umf_ipc_handle_t, but since the handles are replicable across processes I would not expect these functions to change the data contained in the handles. Could these be changed to take const handles?

API Changes

Change from

umf_result_t umfPutIPCHandle(umf_ipc_handle_t ipcHandle);
umf_result_t umfOpenIPCHandle(umf_ipc_handler_handle_t hIPCHandler, umf_ipc_handle_t ipcHandle, void **ptr)

to

typedef const struct umf_ipc_data_t *umf_const_ipc_handle_t;

umf_result_t umfPutIPCHandle(umf_const_ipc_handle_t ipcHandle);
umf_result_t umfOpenIPCHandle(umf_ipc_handler_handle_t hIPCHandler, umf_const_ipc_handle_t ipcHandle, void **ptr)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the declarations, implementations, and call sites for umfPutIPCHandle and umfOpenIPCHandle, then inspect the existing umf_ipc_handle_t definition and related tests. Done means the requested const handle type is applied consistently without breaking the API build or its tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.