rtems/src/partreturnbuffer.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSImplClassicPartition
0007  *
0008  * @brief This source file contains the implementation of
0009  *   rtems_partition_return_buffer().
0010  */
0011
0012 /*
0013  *  COPYRIGHT (c) 1989-2014.
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/rtems/partimpl.h>
0043 #include <rtems/score/address.h>
0044 #include <rtems/score/chainimpl.h>
0045
0046 static bool _Partition_Is_address_on_buffer_boundary(
0047   const Partition_Control *the_partition,
0048   const void              *the_buffer
0049 )
0050 {
0051   intptr_t offset;
0052
0053   offset = _Addresses_Subtract(
0054     the_buffer,
0055     the_partition->base_address
0056   );
0057
0058   return ( offset % the_partition->buffer_size ) == 0;
0059 }
0060
0061 static bool _Partition_Is_address_a_buffer_begin(
0062    const Partition_Control *the_partition,
0063    const void              *the_buffer
0064 )
0065 {
0066   const void *base;
0067   const void *limit;
0068
0069   base = the_partition->base_address;
0070   limit = the_partition->limit_address;
0071
0072   if ( !_Addresses_Is_in_range( the_buffer, base, limit ) ) {
0073     return false;
0074   }
0075
0076   return _Partition_Is_address_on_buffer_boundary( the_partition, the_buffer );
0077 }
0078
0079 static void _Partition_Free_buffer(
0080   Partition_Control *the_partition,
0081   void              *the_buffer
0082 )
0083 {
0084   _Chain_Append_unprotected( &the_partition->Memory, the_buffer );
0085 }
0086
0087 rtems_status_code rtems_partition_return_buffer(
0088   rtems_id  id,
0089   void     *buffer
0090 )
0091 {
0092   Partition_Control *the_partition;
0093   ISR_lock_Context   lock_context;
0094
0095   the_partition = _Partition_Get( id, &lock_context );
0096
0097   if ( the_partition == NULL ) {
0098 #if defined(RTEMS_MULTIPROCESSING)
0099     return _Partition_MP_Return_buffer( id, buffer );
0100 #else
0101     return RTEMS_INVALID_ID;
0102 #endif
0103   }
0104
0105   _Partition_Acquire_critical( the_partition, &lock_context );
0106
0107   if ( !_Partition_Is_address_a_buffer_begin( the_partition, buffer ) ) {
0108     _Partition_Release( the_partition, &lock_context );
0109     return RTEMS_INVALID_ADDRESS;
0110   }
0111
0112   _Partition_Free_buffer( the_partition, buffer );
0113   the_partition->number_of_used_blocks -= 1;
0114   _Partition_Release( the_partition, &lock_context );
0115   return RTEMS_SUCCESSFUL;
0116 }