rtems/confdefs/objectsposix.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSImplApplConfig
0007  *
0008  * @brief This header file evaluates configuration options related to the POSIX
0009  *   API objects configuration.
0010  *
0011  * For the POSIX thread objects configuration see <rtems/confdefs/threads.h>.
0012  */
0013
0014 /*
0015  * Copyright (C) 2020 embedded brains GmbH & Co. KG
0016  *
0017  * Redistribution and use in source and binary forms, with or without
0018  * modification, are permitted provided that the following conditions
0019  * are met:
0020  * 1. Redistributions of source code must retain the above copyright
0021  *    notice, this list of conditions and the following disclaimer.
0022  * 2. Redistributions in binary form must reproduce the above copyright
0023  *    notice, this list of conditions and the following disclaimer in the
0024  *    documentation and/or other materials provided with the distribution.
0025  *
0026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0027  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0028  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0029  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0030  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0031  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0032  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0033  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0034  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0035  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0036  * POSSIBILITY OF SUCH DAMAGE.
0037  */
0038
0039 #ifndef _RTEMS_CONFDEFS_OBJECTSPOSIX_H
0040 #define _RTEMS_CONFDEFS_OBJECTSPOSIX_H
0041
0042 #ifndef __CONFIGURATION_TEMPLATE_h
0043 #error "Do not include this file directly, use <rtems/confdefs.h> instead"
0044 #endif
0045
0046 #ifdef CONFIGURE_INIT
0047
0048 #include <rtems/confdefs/threads.h>
0049 #include <rtems/confdefs/wkspacesupport.h>
0050 #include <rtems/config.h>
0051
0052 #include <limits.h>
0053
0054 #define _Configure_Memory_for_named_objects( _number, _size ) \
0055   ( rtems_resource_maximum_per_allocation( _number ) \
0056     * _Configure_From_workspace( _POSIX_PATH_MAX + 1 ) )
0057
0058 #ifndef CONFIGURE_MAXIMUM_POSIX_KEYS
0059   #define CONFIGURE_MAXIMUM_POSIX_KEYS 0
0060 #endif
0061
0062 #ifndef CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS
0063   #define CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS \
0064     ( CONFIGURE_MAXIMUM_POSIX_KEYS * \
0065      ( CONFIGURE_MAXIMUM_POSIX_THREADS + CONFIGURE_MAXIMUM_TASKS ) )
0066 #endif
0067
0068 #if CONFIGURE_MAXIMUM_POSIX_KEYS > 0 \
0069   && CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS < CONFIGURE_MAXIMUM_POSIX_KEYS
0070   #error "CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS must be greater than or equal to CONFIGURE_MAXIMUM_POSIX_KEYS"
0071 #endif
0072
0073 #if CONFIGURE_MAXIMUM_POSIX_KEYS == 0 \
0074   && CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS > 0
0075   #warning "If CONFIGURE_MAXIMUM_POSIX_KEYS is zero, then CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS should be zero as well"
0076 #endif
0077
0078 #if CONFIGURE_MAXIMUM_POSIX_KEYS > 0 || CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS > 0
0079   #include <rtems/posix/key.h>
0080 #endif
0081
0082 #if CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES > 0
0083   #include <rtems/posix/mqueue.h>
0084 #endif
0085
0086 #if CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS > 0
0087   #include <rtems/posix/psignal.h>
0088 #endif
0089
0090 #if CONFIGURE_MAXIMUM_POSIX_SEMAPHORES > 0
0091   #include <rtems/posix/semaphore.h>
0092 #endif
0093
0094 #if CONFIGURE_MAXIMUM_POSIX_SHMS > 0
0095   #include <rtems/posix/shm.h>
0096 #endif
0097
0098 #if CONFIGURE_MAXIMUM_POSIX_TIMERS > 0
0099   #include <rtems/posix/timer.h>
0100 #endif
0101
0102 #ifdef __cplusplus
0103 extern "C" {
0104 #endif
0105
0106 #if CONFIGURE_MAXIMUM_POSIX_KEYS > 0
0107   POSIX_KEYS_INFORMATION_DEFINE( CONFIGURE_MAXIMUM_POSIX_KEYS );
0108 #endif
0109
0110 #if CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS > 0
0111   POSIX_Keys_Key_value_pair _POSIX_Keys_Key_value_pairs[
0112     rtems_resource_maximum_per_allocation(
0113       CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS
0114     )
0115   ];
0116
0117   const uint32_t _POSIX_Keys_Key_value_pair_maximum =
0118     CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS;
0119 #endif
0120
0121 #if CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES > 0
0122   POSIX_MESSAGE_QUEUE_INFORMATION_DEFINE(
0123     CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES
0124   );
0125
0126   #define _CONFIGURE_MEMORY_FOR_POSIX_MESSAGE_QUEUES \
0127     _Configure_Memory_for_named_objects( \
0128        CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES, \
0129        sizeof( POSIX_Message_queue_Control ) \
0130      )
0131 #else
0132   #define _CONFIGURE_MEMORY_FOR_POSIX_MESSAGE_QUEUES 0
0133 #endif
0134
0135 #if CONFIGURE_MAXIMUM_POSIX_SEMAPHORES > 0
0136   POSIX_SEMAPHORE_INFORMATION_DEFINE( CONFIGURE_MAXIMUM_POSIX_SEMAPHORES );
0137
0138   #define _CONFIGURE_MEMORY_FOR_POSIX_SEMAPHORES \
0139     _Configure_Memory_for_named_objects( \
0140        CONFIGURE_MAXIMUM_POSIX_SEMAPHORES, \
0141        sizeof( POSIX_Semaphore_Control ) \
0142      )
0143 #else
0144   #define _CONFIGURE_MEMORY_FOR_POSIX_SEMAPHORES 0
0145 #endif
0146
0147 #if CONFIGURE_MAXIMUM_POSIX_SHMS > 0
0148   POSIX_SHM_INFORMATION_DEFINE( CONFIGURE_MAXIMUM_POSIX_SHMS );
0149
0150   #define _CONFIGURE_MEMORY_FOR_POSIX_SHMS \
0151     _Configure_Memory_for_named_objects( \
0152        CONFIGURE_MAXIMUM_POSIX_SHMS, \
0153        sizeof( POSIX_Shm_Control ) \
0154      )
0155 #else
0156   #define _CONFIGURE_MEMORY_FOR_POSIX_SHMS 0
0157 #endif
0158
0159 #if CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS > 0
0160   #ifndef RTEMS_POSIX_API
0161     #error "CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS must be zero if POSIX API is disabled"
0162   #endif
0163
0164   const uint32_t _POSIX_signals_Maximum_queued_signals =
0165     CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS;
0166
0167   POSIX_signals_Siginfo_node _POSIX_signals_Siginfo_nodes[
0168     CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS
0169   ];
0170
0171   #define _CONFIGURE_MEMORY_FOR_POSIX_QUEUED_SIGNALS \
0172     _Configure_From_workspace( CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS \
0173       * sizeof( POSIX_signals_Siginfo_node ) )
0174 #else
0175   #define _CONFIGURE_MEMORY_FOR_POSIX_QUEUED_SIGNALS 0
0176 #endif
0177
0178 #if CONFIGURE_MAXIMUM_POSIX_TIMERS > 0
0179   #ifndef RTEMS_POSIX_API
0180     #error "CONFIGURE_MAXIMUM_POSIX_TIMERS must be zero if POSIX API is disabled"
0181   #endif
0182
0183   POSIX_TIMER_INFORMATION_DEFINE( CONFIGURE_MAXIMUM_POSIX_TIMERS );
0184 #endif
0185
0186 #ifdef __cplusplus
0187 }
0188 #endif
0189
0190 #define _CONFIGURE_MEMORY_FOR_POSIX_OBJECTS \
0191   ( _CONFIGURE_MEMORY_FOR_POSIX_MESSAGE_QUEUES \
0192     + _CONFIGURE_MEMORY_FOR_POSIX_QUEUED_SIGNALS \
0193     + _CONFIGURE_MEMORY_FOR_POSIX_SEMAPHORES \
0194     + _CONFIGURE_MEMORY_FOR_POSIX_SHMS )
0195
0196 #endif /* CONFIGURE_INIT */
0197
0198 #endif /* _RTEMS_CONFDEFS_OBJECTSPOSIX_H */