schedulernodeimpl.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * Copyright (C) 2014, 2017 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_SCHEDULERNODEIMPL_H
#define _RTEMS_SCORE_SCHEDULERNODEIMPL_H
 
#include <rtems/score/schedulernode.h>
#include <rtems/score/priorityimpl.h>
 
struct _Scheduler_Control;
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define SCHEDULER_NODE_OF_WAIT_PRIORITY_NODE( node ) \
  RTEMS_CONTAINER_OF( node, Scheduler_Node, Wait.Priority.Node.Node.Chain )
 
#define SCHEDULER_NODE_OF_WAIT_PRIORITY( node ) \
  RTEMS_CONTAINER_OF( node, Scheduler_Node, Wait.Priority )
 
#define SCHEDULER_PRIORITY_MAP( priority ) ( ( priority ) << 1 )
 
#define SCHEDULER_PRIORITY_UNMAP( priority ) ( ( priority ) >> 1 )
 
#define SCHEDULER_PRIORITY_PURIFY( priority )  \
  ( ( priority ) & ~( (Priority_Control) PRIORITY_GROUP_LAST ) )
 
#define SCHEDULER_PRIORITY_APPEND( priority )  \
  ( ( priority ) | ( (Priority_Control) PRIORITY_GROUP_LAST ) )
 
#define SCHEDULER_PRIORITY_IS_APPEND( priority ) \
  ( ( ( priority ) & ( (Priority_Control) PRIORITY_GROUP_LAST ) ) != 0 )
 
static inline void _Scheduler_Node_do_initialize(
  const struct _Scheduler_Control *scheduler,
  Scheduler_Node                  *node,
  Thread_Control                  *the_thread,
  Priority_Control                 priority
)
{
  node->owner = the_thread;
 
  node->Priority.value = priority;
 
#if defined(RTEMS_SMP)
  _Chain_Initialize_node( &node->Thread.Wait_node );
  node->Wait.Priority.scheduler = scheduler;
  node->user = the_thread;
  node->idle = NULL;
#if CPU_SIZEOF_POINTER != 8
  _ISR_lock_Initialize( &node->Priority.Lock, "Scheduler Node Priority" );
#endif
#else
  (void) scheduler;
  (void) the_thread;
#endif
}
 
static inline void _Scheduler_Node_do_destroy(
  const struct _Scheduler_Control *scheduler,
  Scheduler_Node                  *node
)
{
  (void) scheduler;
 
#if defined(RTEMS_SMP) && CPU_SIZEOF_POINTER != 8
  _ISR_lock_Destroy( &node->Priority.Lock );
#else
  (void) node;
#endif
}
 
static inline const Scheduler_Control *_Scheduler_Node_get_scheduler(
  const Scheduler_Node *node
)
{
  return _Priority_Get_scheduler( &node->Wait.Priority );
}
 
static inline Thread_Control *_Scheduler_Node_get_owner(
  const Scheduler_Node *node
)
{
  return node->owner;
}
 
static inline Priority_Control _Scheduler_Node_get_priority(
  Scheduler_Node *node
)
{
  Priority_Control priority;
 
#if defined(RTEMS_SMP) && CPU_SIZEOF_POINTER == 8
  priority = _Atomic_Fetch_add_ulong(
    &node->Priority.value,
    0,
    ATOMIC_ORDER_RELAXED
  );
#else
  ISR_lock_Context lock_context;
 
  _ISR_lock_Acquire( &node->Priority.Lock, &lock_context );
  priority = node->Priority.value;
  _ISR_lock_Release( &node->Priority.Lock, &lock_context );
#endif
 
  return priority;
}
 
static inline void _Scheduler_Node_set_priority(
  Scheduler_Node      *node,
  Priority_Control     new_priority,
  Priority_Group_order group_order
)
{
#if defined(RTEMS_SMP) && CPU_SIZEOF_POINTER == 8
  _Atomic_Store_ulong(
    &node->Priority.value,
    new_priority | (Priority_Control) group_order,
    ATOMIC_ORDER_RELAXED
  );
#else
  ISR_lock_Context lock_context;
 
  _ISR_lock_Acquire( &node->Priority.Lock, &lock_context );
  node->Priority.value = new_priority | ( (Priority_Control) group_order );
  _ISR_lock_Release( &node->Priority.Lock, &lock_context );
#endif
}
 
#if defined(RTEMS_SMP)
static inline Thread_Control *_Scheduler_Node_get_user(
  const Scheduler_Node *node
)
{
  return node->user;
}
 
static inline void _Scheduler_Node_set_user(
  Scheduler_Node *node,
  Thread_Control *user
)
{
  node->user = user;
}
 
static inline Thread_Control *_Scheduler_Node_get_idle(
  const Scheduler_Node *node
)
{
  return node->idle;
}
 
static inline void _Scheduler_Node_set_idle_user(
  Scheduler_Node *node,
  Thread_Control *idle
)
{
  _Assert( _Scheduler_Node_get_idle( node ) == NULL );
  _Assert(
    _Scheduler_Node_get_owner( node ) == _Scheduler_Node_get_user( node )
  );
 
  _Scheduler_Node_set_user( node, idle );
  node->idle = idle;
}
#endif
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* _RTEMS_SCORE_SCHEDULERNODEIMPL_H */