nuttx/nuttx-mirror
1
2
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2025-01-13 08:38:38 +08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Incorporate the work thread

Browse source 
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@2230 42af7a65-404d-4744-a932-0658087f49c3
This commit is contained in:
patacongo 2009-11-05 22:58:36 +00:00
parent 86987e3b02
commit 64e5bef2f6
14 changed files with 455 additions and 60 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
ChangeLog
View file

@ -951,4 +951,9 @@
* arch/arm/src/stm32/stm32_gpio.c - Add support for configure an input GPIO
to generate an EXTI interrupt.
* config/stm3210e-eval/src/up_buttons.c - Add support for on-board buttons.
* include/nuttx/rwbuffer.h -- Add generic support for read-ahead buffering
and write buffering that can be used in any block driver.
* include/nuttx/wqueue.h -- Added a generic worker thread that can used to
defer processing from an interrupt to a task.

4
Documentation/NuttX.html
View file

@ -1599,6 +1599,10 @@ nuttx-0.4.14 2009-xx-xx Gregory Nutt <spudmonkey@racsa.co.cr>
* arch/arm/src/stm32/stm32_gpio.c - Add support for configure an input GPIO
to generate an EXTI interrupt.
* config/stm3210e-eval/src/up_buttons.c - Add support for on-board buttons.
* include/nuttx/rwbuffer.h -- Add generic support for read-ahead buffering
and write buffering that can be used in any block driver.
* include/nuttx/wqueue.h -- Added a generic worker thread that can used to
defer processing from an interrupt to a task.
pascal-0.1.3 2009-xx-xx Gregory Nutt <spudmonkey@racsa.co.cr>

4
drivers/rwbuffer.c
View file

@ -59,6 +59,10 @@
/* Configuration ************************************************************/
#ifndef CONFIG_SCHED_WORKQUEUE
# error "Worker thread support is required (CONFIG_SCHED_WORKQUEUE)"
#endif
#ifndef CONFIG_FS_WRDELAY
# define CONFIG_FS_WRDELAY 350
#endif

2
include/nuttx/rwbuffer.h
View file

@ -53,7 +53,7 @@
#if defined(CONFIG_FS_WRITEBUFFER) || defined(CONFIG_FS_READAHEAD)
/**********************************************************************
* Definitions
* Pre-processor Definitions
**********************************************************************/
/**********************************************************************

17
include/nuttx/wqueue.h
View file

@ -42,6 +42,7 @@
#include <nuttx/config.h>
#include <sys/types.h>
#include <signal.h>
#include <queue.h>
#ifdef CONFIG_SCHED_WORKQUEUE
@ -132,6 +133,22 @@ EXTERN int work_queue(struct work_s *work, worker_t worker, FAR void *arg, uint3
EXTERN int work_cancel(struct work_s *work);
/****************************************************************************
* Name: work_signal
*
* Description:
* Signal the worker thread to process the work queue now.
*
* Input parameters:
* None
*
* Returned Value:
* Zero on success, a negated errno on failure
*
****************************************************************************/
#define work_signal() kill(g_worker, SIGWORK)
#undef EXTERN
#ifdef __cplusplus
}

37
include/signal.h
View file

@ -67,16 +67,45 @@
#define SIGRTMIN 0 /* First real time signal */
#define SIGRTMAX 31 /* Last real time signal */
/* A few of the real time signals are used within the OS. The reset are all
* user signals:
/* A few of the real time signals are used within the OS. They have
* default values that can be overridden from the configuration file. The
* rest are all user signals:
*/
#ifndef CONFIG_SIG_SIGUSR1
#define SIGUSR1 0 /* User signal 1 */
#else
#define SIGUSR1 CONFIG_SIG_SIGUSR1
#endif
#ifndef CONFIG_SIG_SIGUSR2
#define SIGUSR2 1 /* User signal 2 */
#else
#define SIGUSR2 CONFIG_SIG_SIGUSR2
#endif
#ifndef CONFIG_SIG_SIGALARM
#define SIGALRM 2 /* Default signal used with POSIX timers (used only */
/* no other signal is provided) */
#define SIGCONDTIMEDOUT 3 /* Used in the implementation of */
/* pthread_cond_timedwait */
#else
#define SIGALRM CONFIG_SIG_SIGALARM
#endif
#ifndef CONFIG_DISABLE_PTHREAD
#ifndef CONFIG_SIG_SIGCONDTIMEDOUT
#define SIGCONDTIMEDOUT 3 /* Used in the implementation of pthread_cond_timedwait */
#else
#define SIGCONDTIMEDOUT CONFIG_SIG_SIGCONDTIMEDOUT
#endif
#endif
#ifdef CONFIG_SCHED_WORKQUEUE
#ifndef CONFIG_SIG_SIGWORK
#define SIGWORK 4 /* Used to wake up the work queue */
#else
#define SIGWORK CONFIG_SIG_SIGWORK
#endif
#endif
/* sigprocmask() "how" definitions. Only one of the following can be specified: */

4
sched/Makefile
View file

@ -38,7 +38,7 @@
ASRCS =
AOBJS = $(ASRCS:.S=$(OBJEXT))
MISC_SRCS = os_start.c get_errno_ptr.c \
MISC_SRCS = os_start.c get_errno_ptr.c sched_garbage.c \
sched_setupstreams.c sched_getfiles.c sched_getsockets.c sched_getstreams.c \
sched_setupidlefiles.c sched_setuptaskfiles.c sched_setuppthreadfiles.c \
sched_releasefiles.c
@ -136,7 +136,7 @@ TIMER_SRCS = timer_initialize.c timer_create.c timer_delete.c timer_getoverrun.c
endif
ifeq ($(CONFIG_SCHED_WORKQUEUE),y)
WORK_SRCS = work_queue.c work_cancel.c
WORK_SRCS = work_thread.c work_queue.c work_cancel.c
endif
IRQ_SRCS = irq_initialize.c irq_attach.c irq_dispatch.c irq_unexpectedisr.c

1
sched/os_internal.h
View file

@ -273,5 +273,6 @@ extern int sched_releasefiles(FAR _TCB *tcb);
#endif
extern int sched_releasetcb(FAR _TCB *tcb);
extern void sched_garbagecollection(void);
#endif /* __OS_INTERNAL_H */

51
sched/os_start.c
View file

@ -61,6 +61,9 @@
#include "clock_internal.h"
#include "timer_internal.h"
#include "irq_internal.h"
#ifdef CONFIG_SCHED_WORKQUEUE
# include "work_internal.h"
#endif
/****************************************************************************
* Definitions
@ -156,6 +159,12 @@ volatile pid_t g_lastpid;
pidhash_t g_pidhash[CONFIG_MAX_TASKS];
/* The task ID of the worker thread */
#ifdef CONFIG_SCHED_WORKQUEUE
pid_t g_worker;
#endif
/* This is a table of task lists. This table is indexed by
* the task state enumeration type (tstate_t) and provides
* a pointer to the associated static task list (if there
@ -423,6 +432,15 @@ void os_start(void)
(void)sched_setupidlefiles(&g_idletcb);
/* Start the worker thread that will perform misc garbage clean-up */
#ifdef CONFIG_SCHED_WORKQUEUE
g_worker = task_create("work", CONFIG_SCHED_WORKPRIORITY,
CONFIG_SCHED_WORKSTACKSIZE,
(main_t)work_thread, (const char **)NULL);
#endif
ASSERT(g_worker != ERROR);
/* Once the operating system has been initialized, the system must be
* started by spawning the user init thread of execution.
*/
@ -443,33 +461,14 @@ void os_start(void)
sdbg("Beginning Idle Loop\n");
for (;;)
{
/* Check if there is anything in the delayed deallocation list.
* If there is deallocate it now. We must have exclusive access
* to the memory manager to do this BUT the idle task cannot
* wait on a semaphore. So we only do the cleanup now if we
* can get the semaphore -- and this should be possible because
* since we are running, no other task is!
/* Peform garbage collection (if it is not being done by the worker
* thread. This cleans-up memory de-allocations that was queued
* because it could not be freed in that execution context (for
* example, if the memory was freed from an interrupt handler).
*/
if (mm_trysemaphore() == 0)
{
while (g_delayeddeallocations.head)
{
/* Remove the first delayed deallocation. */
irqstate_t saved_state = irqsave();
void *address = (void*)sq_remfirst((FAR sq_queue_t*)&g_delayeddeallocations);
irqrestore(saved_state);
/* Then deallocate it */
if (address)
{
free(address);
}
}
mm_givesemaphore();
}
#ifndef CONFIG_SCHED_WORKQEUE
sched_garbagecollection();
#endif
/* Perform any processor-specific idle state operations */

64
sched/sched_free.c
View file

@ -1,7 +1,7 @@
/************************************************************
* sched_free.c
/************************************************************************
* sched/sched_free.c
*
* Copyright (C) 2007 Gregory Nutt. All rights reserved.
* Copyright (C) 2007, 2009 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
*
* Redistribution and use in source and binary forms, with or without
@ -14,7 +14,7 @@
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name Gregory Nutt nor the names of its contributors may be
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
@ -31,55 +31,59 @@
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
************************************************************/
************************************************************************/
/************************************************************
/************************************************************************
* Included Files
************************************************************/
************************************************************************/
#include <nuttx/config.h>
#include <sys/types.h>
#include <nuttx/kmalloc.h>
#include <queue.h>
#include <assert.h>
#include <nuttx/kmalloc.h>
#include <nuttx/arch.h>
#include <nuttx/wqueue.h>
#include <nuttx/mm.h>
#include "os_internal.h"
/************************************************************
/************************************************************************
* Definitions
************************************************************/
************************************************************************/
/************************************************************
/************************************************************************
* Private Type Declarations
************************************************************/
************************************************************************/
/************************************************************
/************************************************************************
* Global Variables
************************************************************/
************************************************************************/
/************************************************************
/************************************************************************
* Private Variables
************************************************************/
************************************************************************/
/************************************************************
/************************************************************************
* Private Function Prototypes
************************************************************/
************************************************************************/
/************************************************************
/************************************************************************
* Public Functions
************************************************************/
************************************************************************/
/************************************************************
/************************************************************************
* Name: sched_free
*
* Description:
* This function performs deallocations that
* the operating system may need to make. This special
* interface to free is used to handling corner cases
* where the operating system may have to perform deallocations
* from within an interrupt handler.
* This function performs deallocations that the operating system may
* need to make. This special interface to free is used to handling
* corner cases where the operating system may have to perform
* deallocations from within an interrupt handler.
*
************************************************************/
************************************************************************/
void sched_free(FAR void *address)
{
@ -95,6 +99,12 @@ void sched_free(FAR void *address)
irqstate_t saved_state = irqsave();
sq_addlast((FAR sq_entry_t*)address, (sq_queue_t*)&g_delayeddeallocations);
/* Signal the worker thread that is has some clean up to do */
#ifdef CONFIG_SCHED_WORKQUEUE
work_signal();
#endif
irqrestore(saved_state);
}
else

127
sched/sched_garbage.c Executable file
View file

@ -0,0 +1,127 @@
/****************************************************************************
* sched/work_garbage.c
*
* Copyright (C) 2009 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <sys/types.h>
#include <stdlib.h>
#include <nuttx/mm.h>
#include "os_internal.h"
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/****************************************************************************
* Private Type Declarations
****************************************************************************/
/****************************************************************************
* Public Variables
****************************************************************************/
/****************************************************************************
* Private Variables
****************************************************************************/
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: sched_garbagecollection
*
* Description:
* Clean-up memory de-allocations that we queued because they could not
* be freed in that execution context (for example, if the memory was freed
* from an interrupt handler).
*
* This logic may be called from the worker thread (see work_thread.c).
* If, however, CONFIG_SCHED_WORKQUEUE is not defined, then this logic will
* be called from the IDLE thread. It is less optimal for the garbage
* collection to be called from the IDLE thread because it runs at a very
* low priority and could cause false memory out conditions.
*
* Input parameters:
* None
*
* Returned Value:
* None
*
****************************************************************************/
void sched_garbagecollection(void)
{
/* Check if there is anything in the delayed deallocation list. If there
* is deallocate it now. We must have exclusive access to the memory manager
* to do this BUT the idle task cannot wait on a semaphore. So we only do
* the cleanup now if we can get the semaphore -- and this should be possible
* because if the IDLE thread is running, no other task is!
*/
#ifdef CONFIG_SCHED_WORKQUEUE
mm_takesemaphore();
#else
if (mm_trysemaphore() == 0)
#endif
{
while (g_delayeddeallocations.head)
{
/* Remove the first delayed deallocation. */
irqstate_t saved_state = irqsave();
void *address = (void*)sq_remfirst((FAR sq_queue_t*)&g_delayeddeallocations);
irqrestore(saved_state);
/* Then deallocate it */
if (address)
{
free(address);
}
}
mm_givesemaphore();
}
}

32
sched/work_internal.h
View file

@ -50,6 +50,20 @@
* Pre-Processor Definitions
****************************************************************************/
/* Configuration ************************************************************/
#ifndef CONFIG_SCHED_WORKPRIORITY
# define CONFIG_SCHED_WORKPRIORITY 50
#endif
#ifndef CONFIG_SCHED_WORKPERIODUS
# define CONFIG_SCHED_WORKPERIOD (50*1000) /* 50 milliseconds */
#endif
#ifndef CONFIG_SCHED_WORKSTACKSIZE
# define CONFIG_SCHED_WORKSTACKSIZE CONFIG_IDLETHREAD_STACKSIZE
#endif
/****************************************************************************
* Public Types
****************************************************************************/
@ -68,6 +82,24 @@ extern struct dq_queue_s g_work;
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: work_thread
*
* Description:
* This is the main worker thread that performs actions placed on the work
* queue. It also performs periodic garbage collection (that is performed
* by the idle thread if CONFIG_SCHED_WORKQUEUE is not defined).
*
* Input parameters:
* argc, argv (not used)
*
* Returned Value:
* Does not return
*
****************************************************************************/
extern int work_thread(int argc, char *argv[]);
#endif /* __ASSEMBLY__ */
#endif /* CONFIG_SCHED_WORKQUEUE */
#endif /* __SCHED_WORK_INTERNAL_H */

1
sched/work_queue.c
View file

@ -117,6 +117,7 @@ int work_queue(struct work_s *work, worker_t worker, FAR void *arg, uint32 delay
flags = irqsave();
work->qtime = g_system_timer; /* Time work queued */
dq_addlast((FAR dq_entry_t *)work, &g_work);
work_signal(); /* Wake up the worker thread */
irqrestore(flags);
return OK;
}

166
sched/work_thread.c Executable file
View file

@ -0,0 +1,166 @@
/****************************************************************************
* sched/work_thread.c
*
* Copyright (C) 2009 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <sys/types.h>
#include <unistd.h>
#include <queue.h>
#include <assert.h>
#include <errno.h>
#include <debug.h>
#include <nuttx/arch.h>
#include <nuttx/wqueue.h>
#include <nuttx/clock.h>
#include "os_internal.h"
#include "work_internal.h"
#ifdef CONFIG_SCHED_WORKQUEUE
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/****************************************************************************
* Private Type Declarations
****************************************************************************/
/****************************************************************************
* Public Variables
****************************************************************************/
/* The queue of pending work */
struct dq_queue_s g_work;
/****************************************************************************
* Private Variables
****************************************************************************/
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: work_thread
*
* Description:
* This is the main worker thread that performs actions placed on the work
* list. It also performs periodic garbage collection (that is performed
* by the idle thread if CONFIG_SCHED_WORKQUEUE is not defined).
*
* Input parameters:
* argc, argv (not used)
*
* Returned Value:
* Does not return
*
****************************************************************************/
int work_thread(int argc, char *argv[])
{
volatile FAR struct work_s *work;
irqstate_t flags;
/* Loop forever */
for (;;)
{
/* Wait awhile to check the work list. We will wait here until either
* the time elapses or until we are awakened by a signal.
*/
usleep(CONFIG_SCHED_WORKPERIOD);
/* First, clean-up any delayed memory deallocations */
sched_garbagecollection();
/* Then process queued work. We need to keep interrupts disabled while
* we process items in the work list.
*/
flags = irqsave();
work = (FAR struct work_s *)g_work.head;
while (work)
{
/* Is this work ready? It is ready if there is no delay or if
* the delay has elapsed.
*/
if (work->delay == 0 || g_system_timer - work->qtime > work->delay)
{
/* Remove the work at the head of the list. And re-enable
* interrupts while the work is performed.
*/
(void)dq_remfirst(&g_work);
/* Do the work. Re-enable interrupts while the work is being
* performed... we don't have any idea how long that will take
*/
irqrestore(flags);
work->worker(work->arg);
/* Now, unfortunately, since we re-enabled interrupts we have
* to start back at the head of the list.
*/
flags = irqsave();
work = (FAR struct work_s *)g_work.head;
}
else
{
/* This one is not ready, try the next in the list. */
work = (FAR struct work_s *)work->dq.flink;
}
}
irqrestore(flags);
}
return OK; /* To keep some compilers happy */
}
#endif /* CONFIG_SCHED_WORKQUEUE */