score/src/coremsg.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSScoreMessageQueue
0007  *
0008  * @brief This source file contains the implementation of
0009  *   _CORE_message_queue_Initialize().
0010  */
0011
0012 /*
0013  *  COPYRIGHT (c) 1989-2009.
0014  *  On-Line Applications Research Corporation (OAR).
0015  *
0016  * Redistribution and use in source and binary forms, with or without
0017  * modification, are permitted provided that the following conditions
0018  * are met:
0019  * 1. Redistributions of source code must retain the above copyright
0020  *    notice, this list of conditions and the following disclaimer.
0021  * 2. Redistributions in binary form must reproduce the above copyright
0022  *    notice, this list of conditions and the following disclaimer in the
0023  *    documentation and/or other materials provided with the distribution.
0024  *
0025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0026  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0027  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0028  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0029  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0030  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0031  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0032  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0033  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0034  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0035  * POSSIBILITY OF SUCH DAMAGE.
0036  */
0037
0038 #ifdef HAVE_CONFIG_H
0039 #include "config.h"
0040 #endif
0041
0042 #include <rtems/score/coremsgimpl.h>
0043 #include <rtems/score/assert.h>
0044
0045 #define MESSAGE_SIZE_LIMIT \
0046   ( SIZE_MAX - sizeof( uintptr_t ) + 1 - sizeof( CORE_message_queue_Buffer ) )
0047
0048 RTEMS_STATIC_ASSERT(
0049   offsetof( CORE_message_queue_Buffer, buffer )
0050     == sizeof( CORE_message_queue_Buffer ),
0051   CORE_MESSAGE_QUEUE_BUFFER_OFFSET
0052 );
0053
0054 Status_Control _CORE_message_queue_Initialize(
0055   CORE_message_queue_Control          *the_message_queue,
0056   CORE_message_queue_Disciplines       discipline,
0057   uint32_t                             maximum_pending_messages,
0058   size_t                               maximum_message_size,
0059   CORE_message_queue_Allocate_buffers  allocate_buffers,
0060   const void                          *arg
0061 )
0062 {
0063   size_t buffer_size;
0064
0065   /* Make sure the message size computation does not overflow */
0066   if ( maximum_message_size > MESSAGE_SIZE_LIMIT ) {
0067     return STATUS_MESSAGE_QUEUE_INVALID_SIZE;
0068   }
0069
0070   buffer_size = RTEMS_ALIGN_UP( maximum_message_size, sizeof( uintptr_t ) );
0071   _Assert( buffer_size >= maximum_message_size );
0072
0073   buffer_size += sizeof( CORE_message_queue_Buffer );
0074   _Assert( buffer_size >= sizeof( CORE_message_queue_Buffer ) );
0075
0076   /* Make sure the memory allocation size computation does not overflow */
0077   if ( maximum_pending_messages > SIZE_MAX / buffer_size ) {
0078     return STATUS_MESSAGE_QUEUE_INVALID_NUMBER;
0079   }
0080
0081   the_message_queue->message_buffers = ( *allocate_buffers )(
0082     the_message_queue,
0083     (size_t) maximum_pending_messages * buffer_size,
0084     arg
0085   );
0086
0087   if ( the_message_queue->message_buffers == NULL ) {
0088     return STATUS_MESSAGE_QUEUE_NO_MEMORY;
0089   }
0090
0091   the_message_queue->maximum_pending_messages   = maximum_pending_messages;
0092   the_message_queue->number_of_pending_messages = 0;
0093   the_message_queue->maximum_message_size       = maximum_message_size;
0094
0095   _CORE_message_queue_Set_notify( the_message_queue, NULL );
0096   _Chain_Initialize_empty( &the_message_queue->Pending_messages );
0097   _Thread_queue_Object_initialize( &the_message_queue->Wait_queue );
0098
0099   if ( discipline == CORE_MESSAGE_QUEUE_DISCIPLINES_PRIORITY ) {
0100     the_message_queue->operations = &_Thread_queue_Operations_priority;
0101   } else {
0102     the_message_queue->operations = &_Thread_queue_Operations_FIFO;
0103   }
0104
0105   _Chain_Initialize (
0106     &the_message_queue->Inactive_messages,
0107     the_message_queue->message_buffers,
0108     (size_t) maximum_pending_messages,
0109     buffer_size
0110   );
0111
0112   return STATUS_SUCCESSFUL;
0113 }