2014-10-10 14:22:51 +02:00
|
|
|
/****************************************************************************
|
2018-05-29 21:21:26 +02:00
|
|
|
* libs/libc/wqueue/work_usrthread.c
|
2014-10-10 14:22:51 +02:00
|
|
|
*
|
2021-03-02 15:54:21 +01:00
|
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
|
|
* this work for additional information regarding copyright ownership. The
|
|
|
|
* ASF licenses this file to you under the Apache License, Version 2.0 (the
|
|
|
|
* "License"); you may not use this file except in compliance with the
|
|
|
|
* License. You may obtain a copy of the License at
|
2014-10-10 14:22:51 +02:00
|
|
|
*
|
2021-03-02 15:54:21 +01:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2014-10-10 14:22:51 +02:00
|
|
|
*
|
2021-03-02 15:54:21 +01:00
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
|
|
* License for the specific language governing permissions and limitations
|
|
|
|
* under the License.
|
2014-10-10 14:22:51 +02:00
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Included Files
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
|
2014-10-10 22:52:04 +02:00
|
|
|
#include <stdint.h>
|
|
|
|
#include <unistd.h>
|
|
|
|
#include <pthread.h>
|
|
|
|
#include <sched.h>
|
2014-10-10 20:27:11 +02:00
|
|
|
#include <errno.h>
|
2014-10-10 22:52:04 +02:00
|
|
|
#include <assert.h>
|
2014-10-10 20:27:11 +02:00
|
|
|
#include <queue.h>
|
2014-10-10 17:34:03 +02:00
|
|
|
|
2017-10-08 19:52:32 +02:00
|
|
|
#include <nuttx/semaphore.h>
|
2014-10-10 21:21:37 +02:00
|
|
|
#include <nuttx/clock.h>
|
2017-10-08 19:52:32 +02:00
|
|
|
#include <nuttx/wqueue.h>
|
2014-10-10 14:22:51 +02:00
|
|
|
|
2014-10-10 22:52:04 +02:00
|
|
|
#include "wqueue/wqueue.h"
|
|
|
|
|
2021-08-01 09:27:08 +02:00
|
|
|
#if defined(CONFIG_LIBC_USRWORK) && !defined(__KERNEL__)
|
2014-10-10 14:22:51 +02:00
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Pre-processor Definitions
|
|
|
|
****************************************************************************/
|
|
|
|
|
2018-08-25 22:58:07 +02:00
|
|
|
#ifdef CONFIG_SYSTEM_TIME64
|
|
|
|
# define WORK_DELAY_MAX UINT64_MAX
|
|
|
|
#else
|
|
|
|
# define WORK_DELAY_MAX UINT32_MAX
|
|
|
|
#endif
|
|
|
|
|
2014-10-10 14:22:51 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* Private Type Declarations
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Public Data
|
|
|
|
****************************************************************************/
|
|
|
|
|
2014-10-10 22:52:04 +02:00
|
|
|
/* The state of the user mode work queue. */
|
|
|
|
|
2014-10-11 00:24:50 +02:00
|
|
|
struct usr_wqueue_s g_usrwork;
|
2014-10-10 22:52:04 +02:00
|
|
|
|
2014-10-10 14:22:51 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* Private Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
2014-10-10 22:52:04 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* Name: work_process
|
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* This is the logic that performs actions placed on any work list. This
|
|
|
|
* logic is the common underlying logic to all work queues. This logic is
|
|
|
|
* part of the internal implementation of each work queue; it should not
|
|
|
|
* be called from application level logic.
|
|
|
|
*
|
2018-02-01 17:00:02 +01:00
|
|
|
* Input Parameters:
|
2014-10-10 22:52:04 +02:00
|
|
|
* wqueue - Describes the work queue to be processed
|
|
|
|
*
|
|
|
|
* Returned Value:
|
|
|
|
* None
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
2021-07-26 04:36:13 +02:00
|
|
|
static void work_process(FAR struct usr_wqueue_s *wqueue)
|
2014-10-10 22:52:04 +02:00
|
|
|
{
|
|
|
|
volatile FAR struct work_s *work;
|
2021-07-26 04:36:13 +02:00
|
|
|
worker_t worker;
|
2014-10-10 22:52:04 +02:00
|
|
|
FAR void *arg;
|
2021-07-26 04:36:13 +02:00
|
|
|
sclock_t elapsed;
|
2018-06-16 20:16:13 +02:00
|
|
|
clock_t next;
|
2014-10-10 22:52:04 +02:00
|
|
|
int ret;
|
|
|
|
|
|
|
|
/* Then process queued work. Lock the work queue while we process items
|
|
|
|
* in the work list.
|
|
|
|
*/
|
|
|
|
|
2018-08-25 22:58:07 +02:00
|
|
|
next = WORK_DELAY_MAX;
|
2021-07-12 14:58:03 +02:00
|
|
|
ret = _SEM_WAIT(&wqueue->lock);
|
2014-10-10 22:52:04 +02:00
|
|
|
if (ret < 0)
|
|
|
|
{
|
|
|
|
/* Break out earlier if we were awakened by a signal */
|
|
|
|
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* And check each entry in the work queue. Since we have locked the
|
|
|
|
* work queue we know: (1) we will not be suspended unless we do
|
|
|
|
* so ourselves, and (2) there will be no changes to the work queue
|
|
|
|
*/
|
|
|
|
|
|
|
|
work = (FAR struct work_s *)wqueue->q.head;
|
|
|
|
while (work)
|
|
|
|
{
|
2021-07-26 04:36:13 +02:00
|
|
|
/* Is this work ready? It is ready if there is no delay or if
|
|
|
|
* the delay has elapsed. is the time that the work was added
|
|
|
|
* to the work queue. Therefore a delay of equal or less than
|
|
|
|
* zero will always execute immediately.
|
2014-10-10 22:52:04 +02:00
|
|
|
*/
|
|
|
|
|
2021-07-26 04:36:13 +02:00
|
|
|
elapsed = clock() - work->u.s.qtime;
|
|
|
|
|
|
|
|
/* Is this delay work ready? */
|
|
|
|
|
|
|
|
if (elapsed >= 0)
|
2014-10-10 22:52:04 +02:00
|
|
|
{
|
|
|
|
/* Remove the ready-to-execute work from the list */
|
|
|
|
|
2021-07-26 04:36:13 +02:00
|
|
|
sq_remfirst(&wqueue->q);
|
2014-10-10 22:52:04 +02:00
|
|
|
|
|
|
|
/* Extract the work description from the entry (in case the work
|
|
|
|
* instance by the re-used after it has been de-queued).
|
|
|
|
*/
|
|
|
|
|
|
|
|
worker = work->worker;
|
|
|
|
|
|
|
|
/* Check for a race condition where the work may be nullified
|
|
|
|
* before it is removed from the queue.
|
|
|
|
*/
|
|
|
|
|
|
|
|
if (worker != NULL)
|
|
|
|
{
|
2020-08-13 20:59:16 +02:00
|
|
|
/* Extract the work argument before unlocking the work queue */
|
2014-10-10 22:52:04 +02:00
|
|
|
|
|
|
|
arg = work->arg;
|
|
|
|
|
|
|
|
/* Mark the work as no longer being queued */
|
|
|
|
|
|
|
|
work->worker = NULL;
|
|
|
|
|
2017-05-11 21:35:56 +02:00
|
|
|
/* Do the work. Unlock the work queue while the work is being
|
2014-10-10 22:52:04 +02:00
|
|
|
* performed... we don't have any idea how long this will take!
|
|
|
|
*/
|
|
|
|
|
2021-07-12 14:58:03 +02:00
|
|
|
_SEM_POST(&wqueue->lock);
|
2014-10-10 22:52:04 +02:00
|
|
|
worker(arg);
|
|
|
|
|
2020-08-13 20:59:16 +02:00
|
|
|
/* Now, unfortunately, since we unlocked the work queue we
|
|
|
|
* don't know the state of the work list and we will have to
|
|
|
|
* start back at the head of the list.
|
2014-10-10 22:52:04 +02:00
|
|
|
*/
|
|
|
|
|
2021-07-12 14:58:03 +02:00
|
|
|
ret = _SEM_WAIT(&wqueue->lock);
|
2014-10-10 22:52:04 +02:00
|
|
|
if (ret < 0)
|
|
|
|
{
|
|
|
|
/* Break out earlier if we were awakened by a signal */
|
|
|
|
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-07-26 04:36:13 +02:00
|
|
|
work = (FAR struct work_s *)wqueue->q.head;
|
2014-10-10 22:52:04 +02:00
|
|
|
}
|
2021-07-26 04:36:13 +02:00
|
|
|
else
|
2014-10-10 22:52:04 +02:00
|
|
|
{
|
2021-07-26 04:36:13 +02:00
|
|
|
next = work->u.s.qtime - clock();
|
|
|
|
break;
|
2014-10-10 22:52:04 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-07-26 04:36:13 +02:00
|
|
|
/* Unlock the work queue before waiting. */
|
2018-09-14 15:51:31 +02:00
|
|
|
|
2021-07-12 14:58:03 +02:00
|
|
|
_SEM_POST(&wqueue->lock);
|
2018-09-14 15:51:31 +02:00
|
|
|
|
2018-08-25 22:58:07 +02:00
|
|
|
if (next == WORK_DELAY_MAX)
|
2014-10-10 22:52:04 +02:00
|
|
|
{
|
2021-07-26 04:36:13 +02:00
|
|
|
/* Wait indefinitely until work_queue has new items */
|
2014-10-10 22:52:04 +02:00
|
|
|
|
2021-07-26 04:36:13 +02:00
|
|
|
_SEM_WAIT(&wqueue->wake);
|
2018-08-25 22:58:07 +02:00
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2021-11-03 09:41:01 +01:00
|
|
|
struct timespec now;
|
|
|
|
struct timespec delay;
|
2018-09-14 17:02:03 +02:00
|
|
|
struct timespec rqtp;
|
|
|
|
|
2014-10-12 17:40:26 +02:00
|
|
|
/* Wait awhile to check the work list. We will wait here until
|
2021-07-26 04:36:13 +02:00
|
|
|
* either the time elapses or until we are awakened by a semaphore.
|
2014-10-12 17:40:26 +02:00
|
|
|
* Interrupts will be re-enabled while we wait.
|
|
|
|
*/
|
|
|
|
|
2021-11-03 09:41:01 +01:00
|
|
|
clock_gettime(CLOCK_REALTIME, &now);
|
|
|
|
clock_ticks2time(next, &delay);
|
|
|
|
clock_timespec_add(&now, &delay, &rqtp);
|
2018-09-14 17:02:03 +02:00
|
|
|
|
2021-07-26 04:36:13 +02:00
|
|
|
_SEM_TIMEDWAIT(&wqueue->wake, &rqtp);
|
2014-10-10 22:52:04 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-10-10 14:22:51 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* Name: work_usrthread
|
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* This is the worker thread that performs the actions placed on the user
|
|
|
|
* work queue.
|
|
|
|
*
|
|
|
|
* This is a user mode work queue. It must be used by applications for
|
|
|
|
* miscellaneous operations. The user work thread must be started by
|
|
|
|
* application start-up logic by calling work_usrstart().
|
|
|
|
*
|
2018-02-01 17:00:02 +01:00
|
|
|
* Input Parameters:
|
2014-10-10 14:22:51 +02:00
|
|
|
* argc, argv (not used)
|
|
|
|
*
|
|
|
|
* Returned Value:
|
|
|
|
* Does not return
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
2014-10-10 22:52:04 +02:00
|
|
|
#ifdef CONFIG_BUILD_PROTECTED
|
2014-10-10 17:34:03 +02:00
|
|
|
static int work_usrthread(int argc, char *argv[])
|
2014-10-10 22:52:04 +02:00
|
|
|
#else
|
|
|
|
static pthread_addr_t work_usrthread(pthread_addr_t arg)
|
|
|
|
#endif
|
2014-10-10 14:22:51 +02:00
|
|
|
{
|
|
|
|
/* Loop forever */
|
|
|
|
|
2015-10-12 15:45:02 +02:00
|
|
|
for (; ; )
|
2014-10-10 14:22:51 +02:00
|
|
|
{
|
2014-10-10 22:52:04 +02:00
|
|
|
/* Then process queued work. We need to keep the work queue locked
|
|
|
|
* while we process items in the work list.
|
2014-10-10 14:22:51 +02:00
|
|
|
*/
|
|
|
|
|
2014-10-10 16:35:58 +02:00
|
|
|
work_process(&g_usrwork);
|
2014-10-10 14:22:51 +02:00
|
|
|
}
|
|
|
|
|
2014-10-10 22:52:04 +02:00
|
|
|
#ifdef CONFIG_BUILD_PROTECTED
|
2014-10-10 14:22:51 +02:00
|
|
|
return OK; /* To keep some compilers happy */
|
2014-10-10 22:52:04 +02:00
|
|
|
#else
|
|
|
|
return NULL; /* To keep some compilers happy */
|
|
|
|
#endif
|
2014-10-10 14:22:51 +02:00
|
|
|
}
|
|
|
|
|
2014-10-10 17:34:03 +02:00
|
|
|
/****************************************************************************
|
2014-10-10 22:52:04 +02:00
|
|
|
* Public Functions
|
2014-10-10 17:34:03 +02:00
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Name: work_usrstart
|
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* Start the user mode work queue.
|
|
|
|
*
|
2018-02-01 17:00:02 +01:00
|
|
|
* Input Parameters:
|
2014-10-10 17:34:03 +02:00
|
|
|
* None
|
|
|
|
*
|
|
|
|
* Returned Value:
|
|
|
|
* The task ID of the worker thread is returned on success. A negated
|
|
|
|
* errno value is returned on failure.
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
int work_usrstart(void)
|
|
|
|
{
|
2021-07-26 04:36:13 +02:00
|
|
|
int ret;
|
|
|
|
#ifndef CONFIG_BUILD_PROTECTED
|
|
|
|
pthread_t usrwork;
|
|
|
|
pthread_attr_t attr;
|
|
|
|
struct sched_param param;
|
|
|
|
#endif
|
|
|
|
|
2020-08-13 20:59:16 +02:00
|
|
|
/* Set up the work queue lock */
|
2014-10-10 17:34:03 +02:00
|
|
|
|
2021-07-12 14:58:03 +02:00
|
|
|
_SEM_INIT(&g_usrwork.lock, 0, 1);
|
|
|
|
|
2021-07-26 04:36:13 +02:00
|
|
|
_SEM_INIT(&g_usrwork.wake, 0, 0);
|
|
|
|
_SEM_SETPROTOCOL(&g_usrwork.wake, SEM_PRIO_NONE);
|
|
|
|
|
|
|
|
/* Initialize the work queue */
|
|
|
|
|
|
|
|
sq_init(&g_usrwork.q);
|
|
|
|
|
2021-07-12 14:58:03 +02:00
|
|
|
#ifdef CONFIG_BUILD_PROTECTED
|
2014-10-10 17:34:03 +02:00
|
|
|
|
2020-08-13 20:59:16 +02:00
|
|
|
/* Start a user-mode worker thread for use by applications. */
|
2014-10-10 17:34:03 +02:00
|
|
|
|
2021-07-26 04:36:13 +02:00
|
|
|
ret = task_create("uwork",
|
2021-08-01 09:27:08 +02:00
|
|
|
CONFIG_LIBC_USRWORKPRIORITY,
|
|
|
|
CONFIG_LIBC_USRWORKSTACKSIZE,
|
2021-07-26 04:36:13 +02:00
|
|
|
(main_t)work_usrthread,
|
|
|
|
((FAR char * const *)NULL));
|
|
|
|
if (ret < 0)
|
2020-08-13 20:59:16 +02:00
|
|
|
{
|
|
|
|
int errcode = get_errno();
|
|
|
|
DEBUGASSERT(errcode > 0);
|
|
|
|
return -errcode;
|
|
|
|
}
|
2014-10-10 22:52:04 +02:00
|
|
|
|
2021-07-26 04:36:13 +02:00
|
|
|
return ret;
|
2014-10-10 22:52:04 +02:00
|
|
|
#else
|
2020-08-13 20:59:16 +02:00
|
|
|
/* Start a user-mode worker thread for use by applications. */
|
2014-10-10 22:52:04 +02:00
|
|
|
|
2020-08-13 20:59:16 +02:00
|
|
|
pthread_attr_init(&attr);
|
2021-08-01 09:27:08 +02:00
|
|
|
pthread_attr_setstacksize(&attr, CONFIG_LIBC_USRWORKSTACKSIZE);
|
2014-10-10 22:52:04 +02:00
|
|
|
|
2021-07-26 04:36:13 +02:00
|
|
|
pthread_attr_getschedparam(&attr, ¶m);
|
2021-08-01 09:27:08 +02:00
|
|
|
param.sched_priority = CONFIG_LIBC_USRWORKPRIORITY;
|
2020-08-13 20:59:16 +02:00
|
|
|
pthread_attr_setschedparam(&attr, ¶m);
|
2014-10-10 22:52:04 +02:00
|
|
|
|
2020-08-13 20:59:16 +02:00
|
|
|
ret = pthread_create(&usrwork, &attr, work_usrthread, NULL);
|
|
|
|
if (ret != 0)
|
|
|
|
{
|
|
|
|
return -ret;
|
|
|
|
}
|
2014-10-10 22:52:04 +02:00
|
|
|
|
2020-08-13 20:59:16 +02:00
|
|
|
/* Detach because the return value and completion status will not be
|
|
|
|
* requested.
|
|
|
|
*/
|
2014-10-10 22:52:04 +02:00
|
|
|
|
2020-08-13 20:59:16 +02:00
|
|
|
pthread_detach(usrwork);
|
2014-10-10 17:34:03 +02:00
|
|
|
|
2021-07-26 04:36:13 +02:00
|
|
|
return (pid_t)usrwork;
|
2014-10-10 22:52:04 +02:00
|
|
|
#endif
|
2014-10-10 17:34:03 +02:00
|
|
|
}
|
|
|
|
|
2021-08-01 09:27:08 +02:00
|
|
|
#endif /* CONFIG_LIBC_USRWORK && !__KERNEL__*/
|