2009-11-05 22:44:33 +01:00
|
|
|
/****************************************************************************
|
2018-05-29 21:21:26 +02:00
|
|
|
* libs/libc/wqueue/work_queue.c
|
2009-11-05 22:44:33 +01: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
|
2009-11-05 22:44:33 +01:00
|
|
|
*
|
2021-03-02 15:54:21 +01:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2009-11-05 22:44:33 +01: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.
|
2009-11-05 22:44:33 +01:00
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Included Files
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
|
2009-12-14 19:39:29 +01:00
|
|
|
#include <stdint.h>
|
2014-10-10 22:52:04 +02:00
|
|
|
#include <signal.h>
|
2009-11-05 22:44:33 +01:00
|
|
|
#include <assert.h>
|
2014-10-10 22:52:04 +02:00
|
|
|
#include <queue.h>
|
2009-11-05 22:44:33 +01:00
|
|
|
#include <errno.h>
|
|
|
|
|
|
|
|
#include <nuttx/clock.h>
|
|
|
|
#include <nuttx/wqueue.h>
|
|
|
|
|
2014-10-10 16:35:58 +02:00
|
|
|
#include "wqueue/wqueue.h"
|
|
|
|
|
2014-10-11 23:59:40 +02:00
|
|
|
#if defined(CONFIG_LIB_USRWORK) && !defined(__KERNEL__)
|
2009-11-05 22:44:33 +01:00
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Private Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
2014-10-10 16:35:58 +02:00
|
|
|
* Name: work_qqueue
|
2009-11-05 22:44:33 +01:00
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* Queue work to be performed at a later time. All queued work will be
|
2020-03-16 20:42:34 +01:00
|
|
|
* performed on the worker thread of execution (not the caller's).
|
2009-11-05 22:44:33 +01:00
|
|
|
*
|
2009-11-06 14:42:49 +01:00
|
|
|
* The work structure is allocated by caller, but completely managed by
|
|
|
|
* the work queue logic. The caller should never modify the contents of
|
2017-08-28 15:46:48 +02:00
|
|
|
* the work queue structure; the caller should not call work_qqueue()
|
2009-11-06 14:42:49 +01:00
|
|
|
* again until either (1) the previous work has been performed and removed
|
|
|
|
* from the queue, or (2) work_cancel() has been called to cancel the work
|
|
|
|
* and remove it from the work queue.
|
|
|
|
*
|
2018-02-01 17:00:02 +01:00
|
|
|
* Input Parameters:
|
2012-09-04 02:54:09 +02:00
|
|
|
* qid - The work queue ID (index)
|
2009-11-05 22:44:33 +01:00
|
|
|
* work - The work structure to queue
|
2021-07-05 23:19:30 +02:00
|
|
|
* worker - The worker callback to be invoked. The callback will be
|
|
|
|
* invoked on the worker thread of execution.
|
|
|
|
* arg - The argument that will be passed to the worker callback when
|
2009-11-05 22:44:33 +01:00
|
|
|
* int is invoked.
|
|
|
|
* delay - Delay (in clock ticks) from the time queue until the worker
|
|
|
|
* is invoked. Zero means to perform the work immediately.
|
|
|
|
*
|
|
|
|
* Returned Value:
|
|
|
|
* Zero on success, a negated errno on failure
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
2014-10-11 00:24:50 +02:00
|
|
|
static int work_qqueue(FAR struct usr_wqueue_s *wqueue,
|
|
|
|
FAR struct work_s *work, worker_t worker,
|
2018-06-16 20:16:13 +02:00
|
|
|
FAR void *arg, clock_t delay)
|
2009-11-05 22:44:33 +01:00
|
|
|
{
|
2014-10-10 16:35:58 +02:00
|
|
|
DEBUGASSERT(work != NULL);
|
2009-11-05 22:44:33 +01:00
|
|
|
|
2014-10-10 22:52:04 +02:00
|
|
|
/* Get exclusive access to the work queue */
|
|
|
|
|
|
|
|
while (work_lock() < 0);
|
|
|
|
|
2017-08-31 15:43:47 +02:00
|
|
|
/* Is there already pending work? */
|
|
|
|
|
|
|
|
if (work->worker != NULL)
|
|
|
|
{
|
2021-07-05 23:19:30 +02:00
|
|
|
/* Remove the entry from the work queue. It will be requeued at the
|
2017-08-31 15:43:47 +02:00
|
|
|
* end of the work queue.
|
|
|
|
*/
|
|
|
|
|
|
|
|
dq_rem((FAR dq_entry_t *)work, &wqueue->q);
|
|
|
|
}
|
|
|
|
|
2015-09-30 19:04:29 +02:00
|
|
|
/* Initialize the work structure */
|
|
|
|
|
|
|
|
work->worker = worker; /* Work callback. non-NULL means queued */
|
|
|
|
work->arg = arg; /* Callback argument */
|
|
|
|
work->delay = delay; /* Delay until work performed */
|
|
|
|
|
2014-10-10 22:52:04 +02:00
|
|
|
/* Now, time-tag that entry and put it in the work queue. */
|
2009-11-05 22:44:33 +01:00
|
|
|
|
2018-06-16 20:50:28 +02:00
|
|
|
work->qtime = clock(); /* Time work queued */
|
2012-09-04 02:54:09 +02:00
|
|
|
|
|
|
|
dq_addlast((FAR dq_entry_t *)work, &wqueue->q);
|
2014-10-11 00:24:50 +02:00
|
|
|
kill(wqueue->pid, SIGWORK); /* Wake up the worker thread */
|
2012-09-04 02:54:09 +02:00
|
|
|
|
2014-10-10 22:52:04 +02:00
|
|
|
work_unlock();
|
2009-11-05 22:44:33 +01:00
|
|
|
return OK;
|
|
|
|
}
|
2012-07-14 21:30:31 +02:00
|
|
|
|
2014-10-10 22:52:04 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* Public Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
2014-10-10 16:35:58 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* Name: work_queue
|
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* Queue user-mode work to be performed at a later time. All queued work
|
2020-03-16 20:42:34 +01:00
|
|
|
* will be performed on the worker thread of execution (not the caller's).
|
2014-10-10 16:35:58 +02:00
|
|
|
*
|
2017-08-28 15:46:48 +02:00
|
|
|
* The work structure is allocated and must be initialized to all zero by
|
|
|
|
* the caller. Otherwise, the work structure is completely managed by the
|
|
|
|
* work queue logic. The caller should never modify the contents of the
|
|
|
|
* work queue structure directly. If work_queue() is called before the
|
2021-07-05 23:19:30 +02:00
|
|
|
* previous work has been performed and removed from the queue, then any
|
2017-08-28 15:46:48 +02:00
|
|
|
* pending work will be canceled and lost.
|
2014-10-10 16:35:58 +02:00
|
|
|
*
|
2018-02-01 17:00:02 +01:00
|
|
|
* Input Parameters:
|
2014-10-10 16:35:58 +02:00
|
|
|
* qid - The work queue ID (index)
|
|
|
|
* work - The work structure to queue
|
2021-07-05 23:19:30 +02:00
|
|
|
* worker - The worker callback to be invoked. The callback will be
|
|
|
|
* invoked on the worker thread of execution.
|
|
|
|
* arg - The argument that will be passed to the worker callback when
|
2014-10-10 16:35:58 +02:00
|
|
|
* int is invoked.
|
|
|
|
* delay - Delay (in clock ticks) from the time queue until the worker
|
|
|
|
* is invoked. Zero means to perform the work immediately.
|
|
|
|
*
|
|
|
|
* Returned Value:
|
|
|
|
* Zero on success, a negated errno on failure
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
int work_queue(int qid, FAR struct work_s *work, worker_t worker,
|
2018-06-16 20:16:13 +02:00
|
|
|
FAR void *arg, clock_t delay)
|
2014-10-10 16:35:58 +02:00
|
|
|
{
|
|
|
|
if (qid == USRWORK)
|
|
|
|
{
|
|
|
|
return work_qqueue(&g_usrwork, work, worker, arg, delay);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
return -EINVAL;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-10-11 23:59:40 +02:00
|
|
|
#endif /* CONFIG_LIB_USRWORK && !__KERNEL__ */
|