blob: a4a5551dfd091507a297b319fd9dbff6169e2d3c (
plain) (
tree)
|
|
/* tqdata.h
*
* This include file contains all the constants and structures
* needed to declare a thread queue.
*
* COPYRIGHT (c) 1989, 1990, 1991, 1992, 1993, 1994.
* On-Line Applications Research Corporation (OAR).
* All rights assigned to U.S. Government, 1994.
*
* This material may be reproduced by or for the U.S. Government pursuant
* to the copyright license under the clause at DFARS 252.227-7013. This
* notice must appear in all copies of this file and its derivatives.
*
* $Id$
*/
#ifndef __THREAD_QUEUE_DATA_h
#define __THREAD_QUEUE_DATA_h
#ifdef __cplusplus
extern "C" {
#endif
#include <rtems/score/chain.h>
#include <rtems/score/priority.h>
#include <rtems/score/states.h>
/*
* The following enumerated type details all of the disciplines
* supported by the Thread Queue Handler.
*/
typedef enum {
THREAD_QUEUE_DISCIPLINE_FIFO, /* FIFO queue discipline */
THREAD_QUEUE_DISCIPLINE_PRIORITY /* PRIORITY queue discipline */
} Thread_queue_Disciplines;
/*
* The following enumerated types indicate what happened while the thread
* queue was in the synchronization window.
*/
typedef enum {
THREAD_QUEUE_SYNCHRONIZED,
THREAD_QUEUE_NOTHING_HAPPENED,
THREAD_QUEUE_TIMEOUT,
THREAD_QUEUE_SATISFIED
} Thread_queue_States;
/*
* The following record defines the control block used
* to manage each thread.
*/
#define TASK_QUEUE_DATA_NUMBER_OF_PRIORITY_HEADERS 4 /* # of pri groups */
typedef struct {
union {
Chain_Control Fifo; /* FIFO discipline list */
Chain_Control Priority[TASK_QUEUE_DATA_NUMBER_OF_PRIORITY_HEADERS];
/* priority discipline list */
} Queues;
Thread_queue_States sync_state; /* alloc/dealloc critical section */
Thread_queue_Disciplines discipline; /* queue discipline */
States_Control state; /* state of threads on Thread_q */
unsigned32 timeout_status;
unsigned32 count;
} Thread_queue_Control;
/*
* _Thread_queue_Header_number
*
* DESCRIPTION:
*
* This function returns the index of the priority chain on which
* a thread of the_priority should be placed.
*/
STATIC INLINE unsigned32 _Thread_queue_Header_number (
Priority_Control the_priority
);
/*
* _Thread_queue_Is_reverse_search
*
* DESCRIPTION:
*
* This function returns TRUE if the_priority indicates that the
* enqueue search should start at the front of this priority
* group chain, and FALSE if the search should start at the rear.
*/
STATIC INLINE boolean _Thread_queue_Is_reverse_search (
Priority_Control the_priority
);
/*
* _Thread_queue_Enter_critical_section
*
* DESCRIPTION:
*
* This routine is invoked to indicate that the specified thread queue is
* entering a critical section.
*/
STATIC INLINE void _Thread_queue_Enter_critical_section (
Thread_queue_Control *the_thread_queue
);
#include <rtems/score/tqdata.inl>
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
