score: Delete Thread_Wait_information::id

This field was only by the monitor in non-multiprocessing
configurations.  Add new field Thread_Wait_information::remote_id in
multiprocessing configurations and use it for the remote procedure call
thread queue.

Add _Thread_Wait_get_id() to obtain the object identifier for debug and
system information tools.  Ensure the object layout via static asserts.
Add test cases to sptests/spthreadq01.

cpukit/libmisc/monitor/mon-task.c

@@ -14,26 +14,46 @@
 #include <stdio.h>
 #include <string.h>    /* memcpy() */
 
+static void
+rtems_monitor_task_wait_info(
+    rtems_monitor_task_t *canonical_task,
+    Thread_Control       *rtems_thread
+)
+{
+    ISR_lock_Context  lock_context;
+    void             *lock;
+
+    lock = _Thread_Lock_acquire( rtems_thread, &lock_context );
+
+    canonical_task->state = rtems_thread->current_state;
+    canonical_task->wait_id = _Thread_Wait_get_id( rtems_thread );
+    canonical_task->wait_queue = rtems_thread->Wait.queue;
+    canonical_task->wait_operations = rtems_thread->Wait.operations;
+
+    _Thread_Lock_release( lock, &lock_context );
+}
+
 void
 rtems_monitor_task_canonical(
     rtems_monitor_task_t  *canonical_task,
     const void            *thread_void
 )
 {
-    const Thread_Control *rtems_thread = (const Thread_Control *) thread_void;
-    RTEMS_API_Control    *api;
+    Thread_Control    *rtems_thread;
+    RTEMS_API_Control *api;
+
+    rtems_thread =
+      RTEMS_DECONST( Thread_Control *, (const Thread_Control *) thread_void );
 
     api = rtems_thread->API_Extensions[ THREAD_API_RTEMS ];
 
+    rtems_monitor_task_wait_info( canonical_task, rtems_thread );
+
     canonical_task->entry = rtems_thread->Start.Entry;
     canonical_task->stack = rtems_thread->Start.Initial_stack.area;
     canonical_task->stack_size = rtems_thread->Start.Initial_stack.size;
     canonical_task->cpu = _Per_CPU_Get_index( _Thread_Get_CPU( rtems_thread ) );
     canonical_task->priority = rtems_thread->current_priority;
-    canonical_task->state = rtems_thread->current_state;
-    canonical_task->wait_id = rtems_thread->Wait.id;
-    canonical_task->wait_queue = rtems_thread->Wait.queue;
-    canonical_task->wait_operations = rtems_thread->Wait.operations;
     canonical_task->events = api->Event.pending_events;
     /*
      * FIXME: make this optionally cpu_time_executed

cpukit/posix/include/rtems/posix/cond.h

@@ -42,9 +42,9 @@ extern "C" {
 
 typedef struct {
    Objects_Control       Object;
+   Thread_queue_Control  Wait_queue;
    int                   process_shared;
    pthread_mutex_t       Mutex;
-   Thread_queue_Control  Wait_queue;
 }  POSIX_Condition_variables_Control;
 
 #ifdef __cplusplus

cpukit/posix/include/rtems/posix/mqueue.h

@@ -54,11 +54,11 @@ extern "C" {
 
 typedef struct {
    Objects_Control             Object;
+   CORE_message_queue_Control  Message_queue;
    int                         process_shared;
    bool                        named;
    bool                        linked;
    uint32_t                    open_count;
-   CORE_message_queue_Control  Message_queue;
    struct sigevent             notification;
 }  POSIX_Message_queue_Control;
 

cpukit/posix/include/rtems/posix/mutex.h

@@ -42,8 +42,8 @@ extern "C" {
 
 typedef struct {
    Objects_Control     Object;
-   int                 process_shared;
    CORE_mutex_Control  Mutex;
+   int                 process_shared;
 }  POSIX_Mutex_Control;
 
 /** @} */

cpukit/posix/include/rtems/posix/semaphore.h

@@ -42,11 +42,11 @@ extern "C" {
 
 typedef struct {
    Objects_Control         Object;
+   CORE_semaphore_Control  Semaphore;
    int                     process_shared;
    bool                    named;
    bool                    linked;
    uint32_t                open_count;
-   CORE_semaphore_Control  Semaphore;
    /*
     *  sem_t is 32-bit.  If Object_Id is 16-bit, then they are not
     *  interchangeable.  We have to be able to return a pointer to

cpukit/posix/src/condwaitsupp.c

@@ -24,9 +24,15 @@
 #include <rtems/system.h>
 #include <rtems/score/watchdog.h>
 #include <rtems/score/statesimpl.h>
+#include <rtems/score/threadimpl.h>
 #include <rtems/posix/condimpl.h>
 #include <rtems/posix/muteximpl.h>
 
+THREAD_WAIT_QUEUE_OBJECT_ASSERT(
+  POSIX_Condition_variables_Control,
+  Wait_queue
+);
+
 int _POSIX_Condition_variables_Wait_support(
   pthread_cond_t            *cond,
   pthread_mutex_t           *mutex,
@@ -75,7 +81,6 @@ int _POSIX_Condition_variables_Wait_support(
 
         executing = _Thread_Executing;
         executing->Wait.return_code = 0;
-        executing->Wait.id          = *cond;
 
         _Thread_queue_Enqueue(
           &the_cond->Wait_queue,

cpukit/posix/src/mqueuerecvsupp.c

@@ -28,9 +28,15 @@
 
 #include <rtems/system.h>
 #include <rtems/score/watchdog.h>
+#include <rtems/score/threadimpl.h>
 #include <rtems/seterr.h>
 #include <rtems/posix/mqueueimpl.h>
 
+THREAD_WAIT_QUEUE_OBJECT_ASSERT(
+  POSIX_Message_queue_Control,
+  Message_queue.Wait_queue
+);
+
 /*
  *  _POSIX_Message_queue_Receive_support
  *

cpukit/posix/src/mutexlocksupp.c

@@ -24,9 +24,12 @@
 #include <rtems/system.h>
 #include <rtems/score/coremuteximpl.h>
 #include <rtems/score/watchdog.h>
+#include <rtems/score/threadimpl.h>
 #include <rtems/posix/muteximpl.h>
 #include <rtems/posix/priorityimpl.h>
 
+THREAD_WAIT_QUEUE_OBJECT_ASSERT( POSIX_Mutex_Control, Mutex.Wait_queue );
+
 /*
  *  _POSIX_Mutex_Lock_support
  *

cpukit/posix/src/pbarrierwait.c

@@ -22,7 +22,9 @@
 #include <errno.h>
 
 #include <rtems/posix/barrierimpl.h>
-#include <rtems/score/thread.h>
+#include <rtems/score/threadimpl.h>
+
+THREAD_WAIT_QUEUE_OBJECT_ASSERT( POSIX_Barrier_Control, Barrier.Wait_queue );
 
 /**
  * This directive allows a thread to wait at a barrier.

cpukit/posix/src/prwlockwrlock.c

@@ -24,7 +24,9 @@
 #include <errno.h>
 
 #include <rtems/posix/rwlockimpl.h>
-#include <rtems/score/thread.h>
+#include <rtems/score/threadimpl.h>
+
+THREAD_WAIT_QUEUE_OBJECT_ASSERT( POSIX_RWLock_Control, RWLock.Wait_queue );
 
 /*
  *  pthread_rwlock_wrlock

cpukit/posix/src/semaphorewaitsupp.c

@@ -27,9 +27,15 @@
 #include <limits.h>
 
 #include <rtems/system.h>
+#include <rtems/score/threadimpl.h>
 #include <rtems/posix/semaphoreimpl.h>
 #include <rtems/seterr.h>
 
+THREAD_WAIT_QUEUE_OBJECT_ASSERT(
+  POSIX_Semaphore_Control,
+  Semaphore.Wait_queue
+);
+
 int _POSIX_Semaphore_Wait_support(
   sem_t             *sem,
   bool               blocking,

cpukit/rtems/include/rtems/rtems/barrier.h

@@ -55,10 +55,10 @@ extern "C" {
 typedef struct {
   /** This is used to manage a barrier as an object. */
   Objects_Control          Object;
-  /** This is used to specify the attributes of a barrier. */
-  rtems_attribute          attribute_set;
   /** This is used to implement the barrier. */
   CORE_barrier_Control     Barrier;
+  /** This is used to specify the attributes of a barrier. */
+  rtems_attribute          attribute_set;
 }   Barrier_Control;
 
 /**

cpukit/rtems/include/rtems/rtems/message.h

@@ -53,10 +53,10 @@ extern "C" {
 typedef struct {
   /** This field is the inherited object characteristics. */
   Objects_Control             Object;
-  /** This field is the attribute set as defined by the API. */
-  rtems_attribute             attribute_set;
   /** This field is the instance of the SuperCore Message Queue. */
   CORE_message_queue_Control  message_queue;
+  /** This field is the attribute set as defined by the API. */
+  rtems_attribute             attribute_set;
 }   Message_queue_Control;
 
 /**

cpukit/rtems/include/rtems/rtems/sem.h

@@ -64,13 +64,6 @@ typedef struct {
   /** This field is the object management portion of a Semaphore instance. */
   Objects_Control          Object;
 
-  /**
-   *  This is the Classic API attribute provided to the create directive.
-   *  It is translated into behavioral attributes on the SuperCore Semaphore
-   *  or Mutex instance.
-   */
-  rtems_attribute          attribute_set;
-
   /**
    *  This contains the memory associated with the SuperCore Semaphore or
    *  Mutex instance that provides the primary functionality of each
@@ -97,6 +90,13 @@ typedef struct {
     MRSP_Control mrsp;
 #endif
   } Core_control;
+
+  /**
+   *  This is the Classic API attribute provided to the create directive.
+   *  It is translated into behavioral attributes on the SuperCore Semaphore
+   *  or Mutex instance.
+   */
+  rtems_attribute          attribute_set;
 }   Semaphore_Control;
 
 /**

cpukit/rtems/src/barrierwait.c

@@ -22,7 +22,9 @@
 #include <rtems/rtems/status.h>
 #include <rtems/rtems/support.h>
 #include <rtems/rtems/barrierimpl.h>
-#include <rtems/score/thread.h>
+#include <rtems/score/threadimpl.h>
+
+THREAD_WAIT_QUEUE_OBJECT_ASSERT( Barrier_Control, Barrier.Wait_queue );
 
 rtems_status_code rtems_barrier_wait(
   rtems_id        id,

cpukit/rtems/src/msgqreceive.c

@@ -22,7 +22,7 @@
 #include <rtems/score/chain.h>
 #include <rtems/score/isr.h>
 #include <rtems/score/coremsgimpl.h>
-#include <rtems/score/thread.h>
+#include <rtems/score/threadimpl.h>
 #include <rtems/score/wkspace.h>
 #include <rtems/rtems/status.h>
 #include <rtems/rtems/attrimpl.h>
@@ -30,6 +30,11 @@
 #include <rtems/rtems/optionsimpl.h>
 #include <rtems/rtems/support.h>
 
+THREAD_WAIT_QUEUE_OBJECT_ASSERT(
+  Message_queue_Control,
+  message_queue.Wait_queue
+);
+
 rtems_status_code rtems_message_queue_receive(
   rtems_id        id,
   void           *buffer,

cpukit/rtems/src/regiongetsegment.c

@@ -75,7 +75,6 @@ rtems_status_code rtems_region_get_segment(
             _Thread_Disable_dispatch();
             _RTEMS_Unlock_allocator();
 
-            executing->Wait.id              = id;
             executing->Wait.count           = size;
             executing->Wait.return_argument = segment;
 

cpukit/rtems/src/semobtain.c

@@ -27,10 +27,20 @@
 #include <rtems/rtems/semimpl.h>
 #include <rtems/score/coremuteximpl.h>
 #include <rtems/score/coresemimpl.h>
-#include <rtems/score/thread.h>
+#include <rtems/score/threadimpl.h>
 
 #include <rtems/score/interr.h>
 
+THREAD_WAIT_QUEUE_OBJECT_ASSERT(
+  Semaphore_Control,
+  Core_control.mutex.Wait_queue
+);
+
+THREAD_WAIT_QUEUE_OBJECT_ASSERT(
+  Semaphore_Control,
+  Core_control.semaphore.Wait_queue
+);
+
 rtems_status_code rtems_semaphore_obtain(
   rtems_id        id,
   rtems_option    option_set,

cpukit/score/Makefile.am

@@ -308,6 +308,7 @@ libscore_a_SOURCES += src/threadentryadaptorpointer.c
 libscore_a_SOURCES += src/threadgetcputimeused.c
 libscore_a_SOURCES += src/threadglobalconstruction.c
 libscore_a_SOURCES += src/threadtimeout.c
+libscore_a_SOURCES += src/threadwaitgetid.c
 libscore_a_SOURCES += src/threadyield.c
 
 if HAS_SMP

cpukit/score/include/rtems/score/coremuteximpl.h

@@ -265,7 +265,6 @@ RTEMS_INLINE_ROUTINE void _CORE_mutex_Seize_body(
       executing->Wait.return_code =
         CORE_MUTEX_STATUS_UNSATISFIED_NOWAIT;
     } else {
-      executing->Wait.id = id;
       _CORE_mutex_Seize_interrupt_blocking(
         the_mutex,
         executing,

cpukit/score/include/rtems/score/coresemimpl.h

@@ -251,7 +251,6 @@ RTEMS_INLINE_ROUTINE void _CORE_semaphore_Seize(
     return;
   }
 
-  executing->Wait.id = id;
   _Thread_queue_Enqueue_critical(
     &the_semaphore->Wait_queue.Queue,
     the_semaphore->operations,

cpukit/score/include/rtems/score/thread.h

@@ -291,8 +291,13 @@ typedef struct {
     RBTree_Node RBTree;
   } Node;
 
-  /** This field is the Id of the object this thread is waiting upon. */
-  Objects_Id            id;
+#if defined(RTEMS_MULTIPROCESSING)
+  /*
+   * @brief This field is the identifier of the remote object this thread is
+   * waiting upon.
+   */
+  Objects_Id            remote_id;
+#endif
   /** This field is used to return an integer while when blocked. */
   uint32_t              count;
   /** This field is for a pointer to a user return argument. */

cpukit/score/include/rtems/score/threadimpl.h

@@ -1448,6 +1448,42 @@ RTEMS_INLINE_ROUTINE void _Thread_Wait_set_timeout_code(
   the_thread->Wait.timeout_code = timeout_code;
 }
 
+/**
+ * @brief Helper structure to ensure that all objects containing a thread queue
+ * have the right layout.
+ *
+ * @see _Thread_Wait_get_id() and THREAD_WAIT_QUEUE_OBJECT_ASSERT().
+ */
+typedef struct {
+  Objects_Control      Object;
+  Thread_queue_Control Wait_queue;
+} Thread_Wait_queue_object;
+
+#define THREAD_WAIT_QUEUE_OBJECT_ASSERT( object_type, wait_queue_member ) \
+  RTEMS_STATIC_ASSERT( \
+    offsetof( object_type, wait_queue_member ) \
+      == offsetof( Thread_Wait_queue_object, Wait_queue ) \
+    && ( &( ( (object_type *) 0 )->wait_queue_member ) \
+      == ( &( (Thread_Wait_queue_object *) 0 )->Wait_queue ) ), \
+    object_type \
+  )
+
+/**
+ * @brief Returns the object identifier of the object containing the current
+ * thread wait queue.
+ *
+ * This function may be used for debug and system information purposes.  The
+ * caller must be the owner of the thread lock.
+ *
+ * @retval 0 The thread waits on no thread queue currently, the thread wait
+ *   queue is not contained in an object, or the current thread state provides
+ *   insufficient information, e.g. the thread is in the middle of a blocking
+ *   operation.
+ * @retval other The object identifier of the object containing the thread wait
+ *   queue.
+ */
+Objects_Id _Thread_Wait_get_id( const Thread_Control *the_thread );
+
 /**
  * @brief General purpose thread wait timeout.
  *

cpukit/score/src/corebarrierwait.c

@@ -47,8 +47,6 @@ void _CORE_barrier_Wait(
     }
   }
 
-  executing->Wait.id = id;
-
   _Thread_queue_Enqueue_critical(
     &the_barrier->Wait_queue.Queue,
     CORE_BARRIER_TQ_OPERATIONS,

cpukit/score/src/coremsgseize.c

@@ -127,7 +127,6 @@ void _CORE_message_queue_Seize(
     return;
   }
 
-  executing->Wait.id = id;
   executing->Wait.return_argument_second.mutable_object = buffer;
   executing->Wait.return_argument = size_p;
   /* Wait.count will be filled in with the message priority */

cpukit/score/src/coremsgsubmit.c

@@ -126,7 +126,6 @@ CORE_message_queue_Status _CORE_message_queue_Submit(
      *  it as a variable.  Doing this emphasizes how dangerous it
      *  would be to use this variable prior to here.
      */
-    executing->Wait.id = id;
     executing->Wait.return_argument_second.immutable_object = buffer;
     executing->Wait.option = (uint32_t) size;
     executing->Wait.count = submit_type;

cpukit/score/src/corerwlockobtainread.c

@@ -81,7 +81,6 @@ void _CORE_RWLock_Obtain_for_reading(
      *  We need to wait to enter this critical section
      */
 
-    executing->Wait.id          = id;
     executing->Wait.option      = CORE_RWLOCK_THREAD_WAITING_FOR_READ;
     executing->Wait.return_code = CORE_RWLOCK_SUCCESSFUL;
 

cpukit/score/src/corerwlockobtainwrite.c

@@ -68,7 +68,6 @@ void _CORE_RWLock_Obtain_for_writing(
      *  We need to wait to enter this critical section
      */
 
-    executing->Wait.id          = id;
     executing->Wait.option      = CORE_RWLOCK_THREAD_WAITING_FOR_WRITE;
     executing->Wait.return_code = CORE_RWLOCK_SUCCESSFUL;
 

cpukit/score/src/mpci.c

@@ -242,7 +242,7 @@ uint32_t   _MPCI_Send_request_packet (
     the_packet->to_convert =
        ( the_packet->to_convert - sizeof(MP_packet_Prefix) ) / sizeof(uint32_t);
 
-    executing->Wait.id = the_packet->id;
+    executing->Wait.remote_id = the_packet->id;
 
     (*_MPCI_table->send_packet)( destination, the_packet );
 

cpukit/score/src/threadmp.c

@@ -95,7 +95,6 @@ Thread_Control *_Thread_MP_Allocate_proxy (
 
     the_proxy->current_state = _States_Set( STATES_DORMANT, the_state );
 
-    the_proxy->Wait.id                      = executing->Wait.id;
     the_proxy->Wait.count                   = executing->Wait.count;
     the_proxy->Wait.return_argument         = executing->Wait.return_argument;
     the_proxy->Wait.return_argument_second  = executing->Wait.return_argument_second;

cpukit/score/src/threadqextractwithproxy.c

@@ -41,7 +41,7 @@ void _Thread_queue_Extract_with_proxy(
       Objects_Information                  *the_information;
       Objects_Thread_queue_Extract_callout  proxy_extract_callout;
 
-      id = the_thread->Wait.id;
+      id = the_thread->Wait.remote_id;
       the_information = _Objects_Get_information_id( id );
       proxy_extract_callout = the_information->extract;
 

cpukit/score/src/threadwaitgetid.c

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) 2016 embedded brains GmbH.  All rights reserved.
+ *
+ *  embedded brains GmbH
+ *  Dornierstr. 4
+ *  82178 Puchheim
+ *  Germany
+ *  <rtems@embedded-brains.de>
+ *
+ * The license and distribution terms for this file may be
+ * found in the file LICENSE in this distribution or at
+ * http://www.rtems.org/license/LICENSE.
+ */
+
+#if HAVE_CONFIG_H
+  #include "config.h"
+#endif
+
+#include <rtems/score/threadimpl.h>
+
+#define THREAD_WAIT_QUEUE_OBJECT_STATES \
+  ( STATES_WAITING_FOR_BARRIER \
+    | STATES_WAITING_FOR_CONDITION_VARIABLE \
+    | STATES_WAITING_FOR_MESSAGE \
+    | STATES_WAITING_FOR_MUTEX \
+    | STATES_WAITING_FOR_RWLOCK \
+    | STATES_WAITING_FOR_SEMAPHORE )
+
+Objects_Id _Thread_Wait_get_id( const Thread_Control *the_thread )
+{
+  States_Control current_state;
+
+  current_state = the_thread->current_state;
+
+#if defined(RTEMS_MULTIPROCESSING)
+  if ( ( current_state & STATES_WAITING_FOR_RPC_REPLY ) != 0 ) {
+    return the_thread->Wait.remote_id;
+  }
+#endif
+
+  if ( ( current_state & THREAD_WAIT_QUEUE_OBJECT_STATES ) != 0 ) {
+    const Thread_Wait_queue_object *queue_object;
+
+    queue_object = RTEMS_CONTAINER_OF(
+      the_thread->Wait.queue,
+      Thread_Wait_queue_object,
+      Wait_queue.Queue
+    );
+
+    return queue_object->Object.id;
+  }
+
+  return 0;
+}

testsuites/sptests/spthreadq01/spthreadq01.doc

@@ -12,9 +12,15 @@ test set name:  spthreadq01
 
 directives:
 
-  _Threadq_Extract
+  - THREAD_QUEUE_INITIALIZER()
+  - _Thread_queue_Extract()
+  - _Thread_Wait_get_id()
 
 concepts:
 
-+ Ensure that when an attempt is made to extract a thread which is not blocked
-  on a thread queue, that the behavior is as expected.
+ - Ensure that the thread queue initializer correctly initializes the thread
+   queue.
+ - Ensure that when an attempt is made to extract a thread which is not blocked
+   on a thread queue, that the behavior is as expected.
+ - Ensure that _Thread_Wait_get_id() returns the right object identifier for
+   various high-level objects.