schedulernode.h

Go to the documentation of this file.

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

 
/*
 * Copyright (C) 2014, 2016 embedded brains GmbH & Co. KG
 *
 * 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_SCHEDULERNODE_H
#define _RTEMS_SCORE_SCHEDULERNODE_H
 
#include <rtems/score/basedefs.h>
#include <rtems/score/chain.h>
#include <rtems/score/priority.h>
#include <rtems/score/isrlock.h>

 
struct _Thread_Control;
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#if defined(RTEMS_SMP)
typedef enum {
  SCHEDULER_NODE_REQUEST_NOT_PENDING,

  SCHEDULER_NODE_REQUEST_ADD,

  SCHEDULER_NODE_REQUEST_REMOVE,

  SCHEDULER_NODE_REQUEST_NOTHING,
 
} Scheduler_Node_request;
#endif
 
typedef struct Scheduler_Node Scheduler_Node;

struct Scheduler_Node {
#if defined(RTEMS_SMP)
  union {
    Chain_Node Chain;
    RBTree_Node RBTree;
  } Node;

  int sticky_level;

  struct _Thread_Control *user;

  struct _Thread_Control *idle;
#endif

  struct _Thread_Control *owner;
 
#if defined(RTEMS_SMP)
  struct {
    Chain_Node Wait_node;

    union {
      Chain_Node Chain;

      Scheduler_Node *next;
    } Scheduler_node;

    Scheduler_Node *next_request;

    Scheduler_Node_request request;
  } Thread;
#endif

  struct {
    Priority_Aggregation Priority;
  } Wait;

  struct {
#if defined(RTEMS_SMP) && CPU_SIZEOF_POINTER == 8
    Atomic_Ulong value;
#else
    Priority_Control value;
#endif
 
#if defined(RTEMS_SMP) && CPU_SIZEOF_POINTER != 8
    ISR_lock_Control Lock;
#endif
  } Priority;
};
 
#if defined(RTEMS_SMP)
extern const size_t _Scheduler_Node_size;
#endif
 
#if defined(RTEMS_SMP)
#define SCHEDULER_NODE_OF_THREAD_WAIT_NODE( node ) \
  RTEMS_CONTAINER_OF( node, Scheduler_Node, Thread.Wait_node )
 
#define SCHEDULER_NODE_OF_THREAD_SCHEDULER_NODE( node ) \
  RTEMS_CONTAINER_OF( node, Scheduler_Node, Thread.Scheduler_node.Chain )
#endif
 
#ifdef __cplusplus
}
#endif /* __cplusplus */

 
#endif /* _RTEMS_SCORE_SCHEDULERNODE_H */