threadq.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */

 
/*
 *  COPYRIGHT (c) 1989-2014.
 *  On-Line Applications Research Corporation (OAR).
 *
 * 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.
 *
 * 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.
 */
 
#ifndef _RTEMS_SCORE_THREADQ_H
#define _RTEMS_SCORE_THREADQ_H
 
#include <rtems/score/chain.h>
#include <rtems/score/isrlock.h>
#include <rtems/score/object.h>
#include <rtems/score/priority.h>
#include <rtems/score/rbtree.h>
#include <rtems/score/states.h>
#include <rtems/score/watchdogticks.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct Per_CPU_Control;
 
struct Scheduler_Node;

 
typedef struct _Thread_Control Thread_Control;
 
typedef struct Thread_queue_Context Thread_queue_Context;
 
typedef struct Thread_queue_Queue Thread_queue_Queue;
 
typedef struct Thread_queue_Operations Thread_queue_Operations;

typedef void ( *Thread_queue_Enqueue_callout )(
  Thread_queue_Queue     *queue,
  Thread_Control         *the_thread,
  struct Per_CPU_Control *cpu_self,
  Thread_queue_Context   *queue_context
);

typedef void ( *Thread_queue_Deadlock_callout )(
  Thread_Control *the_thread
);
 
#if defined(RTEMS_MULTIPROCESSING)
typedef void ( *Thread_queue_MP_callout )(
  Thread_Control *the_proxy,
  Objects_Id      mp_id
);
#endif
 
#if defined(RTEMS_SMP)
typedef struct {
  Chain_Node Node;
 
  Atomic_Uint go_ahead;
} Thread_queue_Gate;
#endif
 
typedef struct {
  ISR_lock_Context Lock_context;
 
#if defined(RTEMS_SMP)
  struct {
    Thread_queue_Gate Gate;

    Thread_queue_Queue *queue;
  } Wait;
#endif
} Thread_queue_Lock_context;
 
#if defined(RTEMS_SMP)
typedef struct {
  RBTree_Node Registry_node;

  Thread_queue_Queue *source;

  Thread_queue_Queue *target;

  Chain_Node Path_node;

  Thread_Control *owner;

  Thread_queue_Lock_context Lock_context;
} Thread_queue_Link;
#endif

struct Thread_queue_Context {
  Thread_queue_Lock_context Lock_context;

  States_Control thread_state;

  Thread_queue_Enqueue_callout enqueue_callout;

  union {
    Watchdog_Interval ticks;

    const void *arg;
  } Timeout;

  bool timeout_absolute;
 
#if defined(RTEMS_SMP)
  struct {
    Chain_Control Links;

    Thread_queue_Link Start;

    Thread_queue_Link Deadlock;
  } Path;
#endif

  struct {
    Priority_Actions Actions;

    size_t update_count;

    Thread_Control *update[ 2 ];
  } Priority;

  Thread_queue_Deadlock_callout deadlock_callout;
 
#if defined(RTEMS_MULTIPROCESSING)
  Thread_queue_MP_callout mp_callout;
#endif
};

typedef struct {
#if defined(RTEMS_SMP)
  Chain_Node Node;
#endif

  Priority_Aggregation Queue;

  struct Scheduler_Node *scheduler_node;
} Thread_queue_Priority_queue;

typedef struct _Thread_queue_Heads {
  union {
    Chain_Control Fifo;
 
#if !defined(RTEMS_SMP)
    Thread_queue_Priority_queue Priority;
#endif
  } Heads;

  Chain_Control Free_chain;

  Chain_Node Free_node;
 
#if defined(RTEMS_SMP)
  Thread_queue_Priority_queue Priority[ RTEMS_ZERO_LENGTH_ARRAY ];
#endif
} Thread_queue_Heads;
 
struct Thread_queue_Queue {
#if defined(RTEMS_SMP)
  SMP_ticket_lock_Control Lock;
#endif

  Thread_queue_Heads *heads;

  Thread_Control *owner;

  const char *name;
};

typedef void ( *Thread_queue_Priority_actions_operation )(
  Thread_queue_Queue   *queue,
  Priority_Actions     *priority_actions
);

typedef void ( *Thread_queue_Enqueue_operation )(
  Thread_queue_Queue   *queue,
  Thread_Control       *the_thread,
  Thread_queue_Context *queue_context
);

typedef void ( *Thread_queue_Extract_operation )(
  Thread_queue_Queue   *queue,
  Thread_Control       *the_thread,
  Thread_queue_Context *queue_context
);

typedef Thread_Control *( *Thread_queue_Surrender_operation )(
  Thread_queue_Queue   *queue,
  Thread_queue_Heads   *heads,
  Thread_Control       *previous_owner,
  Thread_queue_Context *queue_context
);

typedef Thread_Control *( *Thread_queue_First_operation )(
  const Thread_queue_Heads *heads
);

struct Thread_queue_Operations {
  Thread_queue_Priority_actions_operation priority_actions;

  Thread_queue_Enqueue_operation enqueue;

  Thread_queue_Extract_operation extract;

  Thread_queue_Surrender_operation surrender;

  Thread_queue_First_operation first;
};

typedef struct {
#if defined(RTEMS_SMP)
#if defined(RTEMS_DEBUG)
  uint32_t owner;
#endif
 
#if defined(RTEMS_PROFILING)
  SMP_lock_Stats Lock_stats;
#endif
#endif

  Thread_queue_Queue Queue;
} Thread_queue_Control;

 
#ifdef __cplusplus
}
#endif
 
#endif
/* end of include file */