2019-06-20 23:51:27 +08:00
|
|
|
/*
|
|
|
|
|
* Copyright (c) 2019 Intel corporation
|
|
|
|
|
*
|
|
|
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
|
|
|
*/
|
|
|
|
|
|
2022-05-06 17:04:23 +08:00
|
|
|
#include <zephyr/kernel.h>
|
|
|
|
|
#include <zephyr/kernel_structs.h>
|
|
|
|
|
#include <zephyr/spinlock.h>
|
2019-06-20 23:51:27 +08:00
|
|
|
#include <kswap.h>
|
2023-09-27 06:46:01 +08:00
|
|
|
#include <zephyr/internal/syscall_handler.h>
|
2022-05-06 17:04:23 +08:00
|
|
|
#include <zephyr/init.h>
|
2019-06-20 23:51:27 +08:00
|
|
|
#include <ksched.h>
|
|
|
|
|
|
|
|
|
|
static struct z_futex_data *k_futex_find_data(struct k_futex *futex)
|
|
|
|
|
{
|
2023-09-27 05:37:25 +08:00
|
|
|
struct k_object *obj;
|
2019-06-20 23:51:27 +08:00
|
|
|
|
2023-09-27 18:49:28 +08:00
|
|
|
obj = k_object_find(futex);
|
2024-04-30 19:26:35 +08:00
|
|
|
if ((obj == NULL) || (obj->type != K_OBJ_FUTEX)) {
|
2019-06-20 23:51:27 +08:00
|
|
|
return NULL;
|
|
|
|
|
}
|
|
|
|
|
|
2020-03-11 21:37:42 +08:00
|
|
|
return obj->data.futex_data;
|
2019-06-20 23:51:27 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
int z_impl_k_futex_wake(struct k_futex *futex, bool wake_all)
|
|
|
|
|
{
|
|
|
|
|
k_spinlock_key_t key;
|
2021-04-03 14:06:00 +08:00
|
|
|
unsigned int woken = 0U;
|
2019-06-20 23:51:27 +08:00
|
|
|
struct k_thread *thread;
|
|
|
|
|
struct z_futex_data *futex_data;
|
|
|
|
|
|
|
|
|
|
futex_data = k_futex_find_data(futex);
|
|
|
|
|
if (futex_data == NULL) {
|
|
|
|
|
return -EINVAL;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
key = k_spin_lock(&futex_data->lock);
|
|
|
|
|
|
|
|
|
|
do {
|
|
|
|
|
thread = z_unpend_first_thread(&futex_data->wait_q);
|
2021-03-30 05:13:47 +08:00
|
|
|
if (thread != NULL) {
|
2019-06-20 23:51:27 +08:00
|
|
|
woken++;
|
2021-03-03 05:22:52 +08:00
|
|
|
arch_thread_return_value_set(thread, 0);
|
|
|
|
|
z_ready_thread(thread);
|
2019-06-20 23:51:27 +08:00
|
|
|
}
|
|
|
|
|
} while (thread && wake_all);
|
|
|
|
|
|
|
|
|
|
z_reschedule(&futex_data->lock, key);
|
|
|
|
|
|
|
|
|
|
return woken;
|
|
|
|
|
}
|
|
|
|
|
|
userspace: Support for split 64 bit arguments
System call arguments, at the arch layer, are single words. So
passing wider values requires splitting them into two registers at
call time. This gets even more complicated for values (e.g
k_timeout_t) that may have different sizes depending on configuration.
This patch adds a feature to gen_syscalls.py to detect functions with
wide arguments and automatically generates code to split/unsplit them.
Unfortunately the current scheme of Z_SYSCALL_DECLARE_* macros won't
work with functions like this, because for N arguments (our current
maximum N is 10) there are 2^N possible configurations of argument
widths. So this generates the complete functions for each handler and
wrapper, effectively doing in python what was originally done in the
preprocessor.
Another complexity is that traditional the z_hdlr_*() function for a
system call has taken the raw list of word arguments, which does not
work when some of those arguments must be 64 bit types. So instead of
using a single Z_SYSCALL_HANDLER macro, this splits the job of
z_hdlr_*() into two steps: An automatically-generated unmarshalling
function, z_mrsh_*(), which then calls a user-supplied verification
function z_vrfy_*(). The verification function is typesafe, and is a
simple C function with exactly the same argument and return signature
as the syscall impl function. It is also not responsible for
validating the pointers to the extra parameter array or a wide return
value, that code gets automatically generated.
This commit includes new vrfy/msrh handling for all syscalls invoked
during CI runs. Future commits will port the less testable code.
Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2019-08-07 04:34:31 +08:00
|
|
|
static inline int z_vrfy_k_futex_wake(struct k_futex *futex, bool wake_all)
|
2019-06-20 23:51:27 +08:00
|
|
|
{
|
2023-09-27 19:09:45 +08:00
|
|
|
if (K_SYSCALL_MEMORY_WRITE(futex, sizeof(struct k_futex)) != 0) {
|
2019-06-20 23:51:27 +08:00
|
|
|
return -EACCES;
|
|
|
|
|
}
|
|
|
|
|
|
userspace: Support for split 64 bit arguments
System call arguments, at the arch layer, are single words. So
passing wider values requires splitting them into two registers at
call time. This gets even more complicated for values (e.g
k_timeout_t) that may have different sizes depending on configuration.
This patch adds a feature to gen_syscalls.py to detect functions with
wide arguments and automatically generates code to split/unsplit them.
Unfortunately the current scheme of Z_SYSCALL_DECLARE_* macros won't
work with functions like this, because for N arguments (our current
maximum N is 10) there are 2^N possible configurations of argument
widths. So this generates the complete functions for each handler and
wrapper, effectively doing in python what was originally done in the
preprocessor.
Another complexity is that traditional the z_hdlr_*() function for a
system call has taken the raw list of word arguments, which does not
work when some of those arguments must be 64 bit types. So instead of
using a single Z_SYSCALL_HANDLER macro, this splits the job of
z_hdlr_*() into two steps: An automatically-generated unmarshalling
function, z_mrsh_*(), which then calls a user-supplied verification
function z_vrfy_*(). The verification function is typesafe, and is a
simple C function with exactly the same argument and return signature
as the syscall impl function. It is also not responsible for
validating the pointers to the extra parameter array or a wide return
value, that code gets automatically generated.
This commit includes new vrfy/msrh handling for all syscalls invoked
during CI runs. Future commits will port the less testable code.
Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2019-08-07 04:34:31 +08:00
|
|
|
return z_impl_k_futex_wake(futex, wake_all);
|
2019-06-20 23:51:27 +08:00
|
|
|
}
|
2024-01-24 17:35:04 +08:00
|
|
|
#include <zephyr/syscalls/k_futex_wake_mrsh.c>
|
2019-06-20 23:51:27 +08:00
|
|
|
|
kernel/timeout: Make timeout arguments an opaque type
Add a k_timeout_t type, and use it everywhere that kernel API
functions were accepting a millisecond timeout argument. Instead of
forcing milliseconds everywhere (which are often not integrally
representable as system ticks), do the conversion to ticks at the
point where the timeout is created. This avoids an extra unit
conversion in some application code, and allows us to express the
timeout in units other than milliseconds to achieve greater precision.
The existing K_MSEC() et. al. macros now return initializers for a
k_timeout_t.
The K_NO_WAIT and K_FOREVER constants have now become k_timeout_t
values, which means they cannot be operated on as integers.
Applications which have their own APIs that need to inspect these
vs. user-provided timeouts can now use a K_TIMEOUT_EQ() predicate to
test for equality.
Timer drivers, which receive an integer tick count in ther
z_clock_set_timeout() functions, now use the integer-valued
K_TICKS_FOREVER constant instead of K_FOREVER.
For the initial release, to preserve source compatibility, a
CONFIG_LEGACY_TIMEOUT_API kconfig is provided. When true, the
k_timeout_t will remain a compatible 32 bit value that will work with
any legacy Zephyr application.
Some subsystems present timeout (or timeout-like) values to their own
users as APIs that would re-use the kernel's own constants and
conventions. These will require some minor design work to adapt to
the new scheme (in most cases just using k_timeout_t directly in their
own API), and they have not been changed in this patch, instead
selecting CONFIG_LEGACY_TIMEOUT_API via kconfig. These subsystems
include: CAN Bus, the Microbit display driver, I2S, LoRa modem
drivers, the UART Async API, Video hardware drivers, the console
subsystem, and the network buffer abstraction.
k_sleep() now takes a k_timeout_t argument, with a k_msleep() variant
provided that works identically to the original API.
Most of the changes here are just type/configuration management and
documentation, but there are logic changes in mempool, where a loop
that used a timeout numerically has been reworked using a new
z_timeout_end_calc() predicate. Also in queue.c, a (when POLL was
enabled) a similar loop was needlessly used to try to retry the
k_poll() call after a spurious failure. But k_poll() does not fail
spuriously, so the loop was removed.
Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-03-06 07:18:14 +08:00
|
|
|
int z_impl_k_futex_wait(struct k_futex *futex, int expected,
|
|
|
|
|
k_timeout_t timeout)
|
2019-06-20 23:51:27 +08:00
|
|
|
{
|
|
|
|
|
int ret;
|
|
|
|
|
k_spinlock_key_t key;
|
|
|
|
|
struct z_futex_data *futex_data;
|
|
|
|
|
|
|
|
|
|
futex_data = k_futex_find_data(futex);
|
|
|
|
|
if (futex_data == NULL) {
|
|
|
|
|
return -EINVAL;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (atomic_get(&futex->val) != (atomic_val_t)expected) {
|
|
|
|
|
return -EAGAIN;
|
|
|
|
|
}
|
|
|
|
|
|
2021-07-09 08:13:29 +08:00
|
|
|
key = k_spin_lock(&futex_data->lock);
|
|
|
|
|
|
2019-06-20 23:51:27 +08:00
|
|
|
ret = z_pend_curr(&futex_data->lock,
|
|
|
|
|
key, &futex_data->wait_q, timeout);
|
|
|
|
|
if (ret == -EAGAIN) {
|
|
|
|
|
ret = -ETIMEDOUT;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return ret;
|
|
|
|
|
}
|
|
|
|
|
|
2019-08-14 03:58:38 +08:00
|
|
|
static inline int z_vrfy_k_futex_wait(struct k_futex *futex, int expected,
|
kernel/timeout: Make timeout arguments an opaque type
Add a k_timeout_t type, and use it everywhere that kernel API
functions were accepting a millisecond timeout argument. Instead of
forcing milliseconds everywhere (which are often not integrally
representable as system ticks), do the conversion to ticks at the
point where the timeout is created. This avoids an extra unit
conversion in some application code, and allows us to express the
timeout in units other than milliseconds to achieve greater precision.
The existing K_MSEC() et. al. macros now return initializers for a
k_timeout_t.
The K_NO_WAIT and K_FOREVER constants have now become k_timeout_t
values, which means they cannot be operated on as integers.
Applications which have their own APIs that need to inspect these
vs. user-provided timeouts can now use a K_TIMEOUT_EQ() predicate to
test for equality.
Timer drivers, which receive an integer tick count in ther
z_clock_set_timeout() functions, now use the integer-valued
K_TICKS_FOREVER constant instead of K_FOREVER.
For the initial release, to preserve source compatibility, a
CONFIG_LEGACY_TIMEOUT_API kconfig is provided. When true, the
k_timeout_t will remain a compatible 32 bit value that will work with
any legacy Zephyr application.
Some subsystems present timeout (or timeout-like) values to their own
users as APIs that would re-use the kernel's own constants and
conventions. These will require some minor design work to adapt to
the new scheme (in most cases just using k_timeout_t directly in their
own API), and they have not been changed in this patch, instead
selecting CONFIG_LEGACY_TIMEOUT_API via kconfig. These subsystems
include: CAN Bus, the Microbit display driver, I2S, LoRa modem
drivers, the UART Async API, Video hardware drivers, the console
subsystem, and the network buffer abstraction.
k_sleep() now takes a k_timeout_t argument, with a k_msleep() variant
provided that works identically to the original API.
Most of the changes here are just type/configuration management and
documentation, but there are logic changes in mempool, where a loop
that used a timeout numerically has been reworked using a new
z_timeout_end_calc() predicate. Also in queue.c, a (when POLL was
enabled) a similar loop was needlessly used to try to retry the
k_poll() call after a spurious failure. But k_poll() does not fail
spuriously, so the loop was removed.
Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-03-06 07:18:14 +08:00
|
|
|
k_timeout_t timeout)
|
2019-06-20 23:51:27 +08:00
|
|
|
{
|
2023-09-27 19:09:45 +08:00
|
|
|
if (K_SYSCALL_MEMORY_WRITE(futex, sizeof(struct k_futex)) != 0) {
|
2019-06-20 23:51:27 +08:00
|
|
|
return -EACCES;
|
|
|
|
|
}
|
|
|
|
|
|
userspace: Support for split 64 bit arguments
System call arguments, at the arch layer, are single words. So
passing wider values requires splitting them into two registers at
call time. This gets even more complicated for values (e.g
k_timeout_t) that may have different sizes depending on configuration.
This patch adds a feature to gen_syscalls.py to detect functions with
wide arguments and automatically generates code to split/unsplit them.
Unfortunately the current scheme of Z_SYSCALL_DECLARE_* macros won't
work with functions like this, because for N arguments (our current
maximum N is 10) there are 2^N possible configurations of argument
widths. So this generates the complete functions for each handler and
wrapper, effectively doing in python what was originally done in the
preprocessor.
Another complexity is that traditional the z_hdlr_*() function for a
system call has taken the raw list of word arguments, which does not
work when some of those arguments must be 64 bit types. So instead of
using a single Z_SYSCALL_HANDLER macro, this splits the job of
z_hdlr_*() into two steps: An automatically-generated unmarshalling
function, z_mrsh_*(), which then calls a user-supplied verification
function z_vrfy_*(). The verification function is typesafe, and is a
simple C function with exactly the same argument and return signature
as the syscall impl function. It is also not responsible for
validating the pointers to the extra parameter array or a wide return
value, that code gets automatically generated.
This commit includes new vrfy/msrh handling for all syscalls invoked
during CI runs. Future commits will port the less testable code.
Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2019-08-07 04:34:31 +08:00
|
|
|
return z_impl_k_futex_wait(futex, expected, timeout);
|
2019-06-20 23:51:27 +08:00
|
|
|
}
|
2024-01-24 17:35:04 +08:00
|
|
|
#include <zephyr/syscalls/k_futex_wait_mrsh.c>
|