Skip to content

Fix poll support for pipes #88743

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

Merged
merged 2 commits into from
Apr 21, 2025
Merged

Fix poll support for pipes #88743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d13afc
tests: poll: add pipe coverage
Apr 17, 2025
d048755
kernel/pipe: fix poll support
Apr 17, 2025
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
7 changes: 4 additions & 3 deletions kernel/pipe.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,11 +186,12 @@ int z_impl_k_pipe_write(struct k_pipe *pipe, const uint8_t *data, size_t len, k_
break;
}
}
}

#ifdef CONFIG_POLL
z_handle_obj_poll_events(&pipe->poll_events,
K_POLL_STATE_PIPE_DATA_AVAILABLE);
need_resched |= z_handle_obj_poll_events(&pipe->poll_events,
K_POLL_STATE_PIPE_DATA_AVAILABLE);
#endif /* CONFIG_POLL */
}

written += ring_buf_put(&pipe->buf, &data[written], len - written);
if (likely(written == len)) {
Expand Down
11 changes: 9 additions & 2 deletions kernel/poll.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,15 @@ static inline bool is_condition_met(struct k_poll_event *event, uint32_t *state)
}
break;
case K_POLL_TYPE_PIPE_DATA_AVAILABLE:
*state = K_POLL_STATE_PIPE_DATA_AVAILABLE;
return true;
#ifdef CONFIG_PIPES
if (event->pipe->bytes_used != 0) {
#else
if (!ring_buf_is_empty(&event->pipe->buf)) {
#endif
*state = K_POLL_STATE_PIPE_DATA_AVAILABLE;
return true;
}
break;
case K_POLL_TYPE_IGNORE:
break;
default:
Expand Down
62 changes: 55 additions & 7 deletions tests/kernel/poll/src/test_poll.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,14 @@ struct fifo_msg {
#define MSGQ_MSG_SIZE 4
#define MSGQ_MAX_MSGS 16
#define MSGQ_MSG_VALUE {'a', 'b', 'c', 'd'}
#define PIPE_DATA "atad_epip"
#define STACK_SIZE (1024 + CONFIG_TEST_EXTRA_STACK_SIZE)

/* verify k_poll() without waiting */
static struct k_sem no_wait_sem;
static struct k_fifo no_wait_fifo;
static struct k_poll_signal no_wait_signal;
K_PIPE_DEFINE(no_wait_pipe, 32, 1);
static struct k_poll_signal test_signal;
#ifndef CONFIG_USERSPACE
static struct k_msgq no_wait_msgq;
Expand Down Expand Up @@ -63,6 +65,7 @@ ZTEST_USER(poll_api_1cpu, test_poll_no_wait)
unsigned int signaled;
char msgq_recv_buf[MSGQ_MSG_SIZE] = {0};
char msgq_msg[MSGQ_MSG_SIZE] = MSGQ_MSG_VALUE;
char pipe_recv_buf[sizeof(PIPE_DATA) + 4];
int result;
struct k_msgq *mq;
#ifdef CONFIG_USERSPACE
Expand All @@ -78,6 +81,8 @@ ZTEST_USER(poll_api_1cpu, test_poll_no_wait)

k_msgq_alloc_init(mq, MSGQ_MSG_SIZE, MSGQ_MAX_MSGS);

k_pipe_write(&no_wait_pipe, PIPE_DATA, sizeof(PIPE_DATA), K_NO_WAIT);

struct k_poll_event events[] = {
K_POLL_EVENT_INITIALIZER(K_POLL_TYPE_SEM_AVAILABLE,
K_POLL_MODE_NOTIFY_ONLY,
Expand All @@ -94,6 +99,9 @@ ZTEST_USER(poll_api_1cpu, test_poll_no_wait)
K_POLL_EVENT_INITIALIZER(K_POLL_TYPE_MSGQ_DATA_AVAILABLE,
K_POLL_MODE_NOTIFY_ONLY,
mq),
K_POLL_EVENT_INITIALIZER(K_POLL_TYPE_PIPE_DATA_AVAILABLE,
K_POLL_MODE_NOTIFY_ONLY,
&no_wait_pipe),
};

#ifdef CONFIG_USERSPACE
Expand Down Expand Up @@ -159,12 +167,18 @@ ZTEST_USER(poll_api_1cpu, test_poll_no_wait)
zassert_false(k_msgq_get(mq, msgq_recv_buf, K_NO_WAIT));
zassert_false(memcmp(msgq_msg, msgq_recv_buf, MSGQ_MSG_SIZE), "");

zassert_equal(events[5].state, K_POLL_STATE_PIPE_DATA_AVAILABLE);
result = k_pipe_read(&no_wait_pipe, pipe_recv_buf, sizeof(pipe_recv_buf), K_NO_WAIT);
zassert_equal(result, sizeof(PIPE_DATA));
zassert_str_equal(pipe_recv_buf, PIPE_DATA);

/* verify events are not ready anymore (user has to clear them first) */
events[0].state = K_POLL_STATE_NOT_READY;
events[1].state = K_POLL_STATE_NOT_READY;
events[2].state = K_POLL_STATE_NOT_READY;
events[3].state = K_POLL_STATE_NOT_READY;
events[4].state = K_POLL_STATE_NOT_READY;
events[5].state = K_POLL_STATE_NOT_READY;
k_poll_signal_reset(&no_wait_signal);

zassert_equal(k_poll(events, ARRAY_SIZE(events), K_NO_WAIT), -EAGAIN,
Expand All @@ -174,11 +188,11 @@ ZTEST_USER(poll_api_1cpu, test_poll_no_wait)
zassert_equal(events[2].state, K_POLL_STATE_NOT_READY, "");
zassert_equal(events[3].state, K_POLL_STATE_NOT_READY, "");
zassert_equal(events[4].state, K_POLL_STATE_NOT_READY, "");
zassert_equal(events[5].state, K_POLL_STATE_NOT_READY, "");

zassert_not_equal(k_sem_take(&no_wait_sem, K_NO_WAIT), 0, "");
zassert_is_null(k_fifo_get(&no_wait_fifo, K_NO_WAIT), "");
zassert_not_equal(k_msgq_get(mq, msgq_recv_buf, K_NO_WAIT), 0,
"");
zassert_not_equal(k_msgq_get(mq, msgq_recv_buf, K_NO_WAIT), 0, "");
}

/* verify k_poll() that has to wait */
Expand All @@ -192,10 +206,13 @@ static struct k_poll_signal wait_signal =

struct fifo_msg wait_msg = { NULL, FIFO_MSG_VALUE };

K_PIPE_DEFINE(wait_pipe, 32, 1);

#define TAG_0 10
#define TAG_1 11
#define TAG_2 12
#define TAG_3 13
#define TAG_4 14

struct k_poll_event wait_events[] = {
K_POLL_EVENT_STATIC_INITIALIZER(K_POLL_TYPE_SEM_AVAILABLE,
Expand All @@ -213,10 +230,14 @@ struct k_poll_event wait_events[] = {
K_POLL_EVENT_STATIC_INITIALIZER(K_POLL_TYPE_MSGQ_DATA_AVAILABLE,
K_POLL_MODE_NOTIFY_ONLY,
&wait_msgq, TAG_3),
K_POLL_EVENT_STATIC_INITIALIZER(K_POLL_TYPE_PIPE_DATA_AVAILABLE,
K_POLL_MODE_NOTIFY_ONLY,
&wait_pipe, TAG_4),
};

#define USE_FIFO (1 << 0)
#define USE_MSGQ (1 << 1)
#define USE_PIPE (1 << 2)

static void poll_wait_helper(void *use_queuelike, void *msgq, void *p3)
{
Expand All @@ -239,6 +260,10 @@ static void poll_wait_helper(void *use_queuelike, void *msgq, void *p3)

k_msgq_put(msgq, &m[0], K_FOREVER);
}

if (flags & USE_PIPE) {
k_pipe_write(&wait_pipe, PIPE_DATA, sizeof(PIPE_DATA), K_NO_WAIT);
}
}

/* check results for multiple events */
Expand All @@ -248,6 +273,8 @@ void check_results(struct k_poll_event *events, uint32_t event_type,
struct fifo_msg *msg_ptr;
char msgq_recv_buf[MSGQ_MSG_SIZE] = {0};
char msg[] = MSGQ_MSG_VALUE;
char pipe_recv_buf[sizeof(PIPE_DATA) + 4];
int result;

switch (event_type) {
case K_POLL_TYPE_SEM_AVAILABLE:
Expand Down Expand Up @@ -317,7 +344,20 @@ void check_results(struct k_poll_event *events, uint32_t event_type,
"");
}
break;

case K_POLL_TYPE_PIPE_DATA_AVAILABLE:
if (is_available) {
zassert_equal(events->state, K_POLL_STATE_PIPE_DATA_AVAILABLE);
result = k_pipe_read(&wait_pipe, pipe_recv_buf,
sizeof(pipe_recv_buf), K_NO_WAIT);
zassert_equal(result, sizeof(PIPE_DATA));
zassert_str_equal(pipe_recv_buf, PIPE_DATA);
zassert_equal(events->tag, TAG_4);
/* reset to not ready */
events->state = K_POLL_STATE_NOT_READY;
} else {
zassert_equal(events->state, K_POLL_STATE_NOT_READY);
}
break;
default:
__ASSERT(false, "invalid event type (0x%x)\n", event_type);
break;
Expand Down Expand Up @@ -403,9 +443,9 @@ ZTEST(poll_api_1cpu, test_poll_wait)

k_tid_t tid1 = k_thread_create(&test_thread, test_stack,
K_THREAD_STACK_SIZEOF(test_stack),
poll_wait_helper, (void *)(USE_FIFO | USE_MSGQ), wait_msgq_ptr, 0,
main_low_prio - 1, K_USER | K_INHERIT_PERMS,
K_NO_WAIT);
poll_wait_helper, (void *)(USE_FIFO | USE_MSGQ | USE_PIPE),
wait_msgq_ptr, 0, main_low_prio - 1,
K_USER | K_INHERIT_PERMS, K_NO_WAIT);

rc = k_poll(wait_events, ARRAY_SIZE(wait_events), K_NO_WAIT);
zassert_equal(rc, -EAGAIN, "should return EAGAIN with K_NO_WAIT");
Expand All @@ -422,6 +462,7 @@ ZTEST(poll_api_1cpu, test_poll_wait)
check_results(&wait_events[2], K_POLL_TYPE_SIGNAL, true);
check_results(&wait_events[3], K_POLL_TYPE_IGNORE, true);
check_results(&wait_events[4], K_POLL_TYPE_MSGQ_DATA_AVAILABLE, true);
check_results(&wait_events[5], K_POLL_TYPE_PIPE_DATA_AVAILABLE, true);

/* verify events are not ready anymore */
zassert_equal(k_poll(wait_events, ARRAY_SIZE(wait_events),
Expand All @@ -433,6 +474,7 @@ ZTEST(poll_api_1cpu, test_poll_wait)
check_results(&wait_events[2], K_POLL_TYPE_SIGNAL, false);
check_results(&wait_events[3], K_POLL_TYPE_IGNORE, false);
check_results(&wait_events[4], K_POLL_TYPE_MSGQ_DATA_AVAILABLE, false);
check_results(&wait_events[5], K_POLL_TYPE_PIPE_DATA_AVAILABLE, false);

/*
* Wait for 2 out of 4 non-ready events to become ready from a higher
Expand All @@ -455,6 +497,7 @@ ZTEST(poll_api_1cpu, test_poll_wait)
check_results(&wait_events[1], K_POLL_TYPE_DATA_AVAILABLE, false);
check_results(&wait_events[2], K_POLL_TYPE_SIGNAL, true);
check_results(&wait_events[4], K_POLL_TYPE_MSGQ_DATA_AVAILABLE, false);
check_results(&wait_events[4], K_POLL_TYPE_PIPE_DATA_AVAILABLE, false);

/*
* Wait for each event to be ready from a lower priority thread, one at
Expand All @@ -473,6 +516,7 @@ ZTEST(poll_api_1cpu, test_poll_wait)
check_results(&wait_events[1], K_POLL_TYPE_DATA_AVAILABLE, false);
check_results(&wait_events[2], K_POLL_TYPE_SIGNAL, false);
check_results(&wait_events[4], K_POLL_TYPE_MSGQ_DATA_AVAILABLE, false);
check_results(&wait_events[5], K_POLL_TYPE_PIPE_DATA_AVAILABLE, false);

/* fifo */
rc = k_poll(wait_events, ARRAY_SIZE(wait_events), K_SECONDS(1));
Expand All @@ -483,6 +527,7 @@ ZTEST(poll_api_1cpu, test_poll_wait)
check_results(&wait_events[1], K_POLL_TYPE_DATA_AVAILABLE, true);
check_results(&wait_events[2], K_POLL_TYPE_SIGNAL, false);
check_results(&wait_events[4], K_POLL_TYPE_MSGQ_DATA_AVAILABLE, false);
check_results(&wait_events[5], K_POLL_TYPE_PIPE_DATA_AVAILABLE, false);

/* poll signal */
rc = k_poll(wait_events, ARRAY_SIZE(wait_events), K_SECONDS(1));
Expand All @@ -493,6 +538,7 @@ ZTEST(poll_api_1cpu, test_poll_wait)
check_results(&wait_events[1], K_POLL_TYPE_DATA_AVAILABLE, false);
check_results(&wait_events[2], K_POLL_TYPE_SIGNAL, true);
check_results(&wait_events[4], K_POLL_TYPE_MSGQ_DATA_AVAILABLE, false);
check_results(&wait_events[5], K_POLL_TYPE_PIPE_DATA_AVAILABLE, false);

/* message queue */
rc = k_poll(wait_events, ARRAY_SIZE(wait_events), K_SECONDS(1));
Expand All @@ -503,6 +549,7 @@ ZTEST(poll_api_1cpu, test_poll_wait)
check_results(&wait_events[1], K_POLL_TYPE_DATA_AVAILABLE, false);
check_results(&wait_events[2], K_POLL_TYPE_SIGNAL, false);
check_results(&wait_events[4], K_POLL_TYPE_MSGQ_DATA_AVAILABLE, true);
check_results(&wait_events[5], K_POLL_TYPE_PIPE_DATA_AVAILABLE, false);

k_thread_abort(tid1);
k_thread_abort(tid2);
Expand Down Expand Up @@ -780,7 +827,8 @@ void poll_test_grant_access(void)
&no_wait_signal, &wait_sem, &wait_fifo,
&cancel_fifo, &non_cancel_fifo,
&wait_signal, &test_thread, &test_signal,
&test_stack, &multi_sem, &multi_reply);
&test_stack, &multi_sem, &multi_reply,
&no_wait_pipe, &wait_pipe);
}


Expand Down