source: rtems/cpukit/include/rtems/rtems/dpmemimpl.h @ 2afb22b

Last change on this file since 2afb22b was 2afb22b, checked in by Chris Johns <chrisj@…>, on Dec 23, 2017 at 7:18:56 AM

Remove make preinstall

A speciality of the RTEMS build system was the make preinstall step. It
copied header files from arbitrary locations into the build tree. The
header files were included via the -Bsome/build/tree/path GCC command
line option.

This has at least seven problems:

  • The make preinstall step itself needs time and disk space.
  • Errors in header files show up in the build tree copy. This makes it hard for editors to open the right file to fix the error.
  • There is no clear relationship between source and build tree header files. This makes an audit of the build process difficult.
  • The visibility of all header files in the build tree makes it difficult to enforce API barriers. For example it is discouraged to use BSP-specifics in the cpukit.
  • An introduction of a new build system is difficult.
  • Include paths specified by the -B option are system headers. This may suppress warnings.
  • The parallel build had sporadic failures on some hosts.

This patch removes the make preinstall step. All installed header
files are moved to dedicated include directories in the source tree.
Let @RTEMS_CPU@ be the target architecture, e.g. arm, powerpc, sparc,
etc. Let @RTEMS_BSP_FAMILIY@ be a BSP family base directory, e.g.
erc32, imx, qoriq, etc.

The new cpukit include directories are:

  • cpukit/include
  • cpukit/score/cpu/@RTEMS_CPU@/include
  • cpukit/libnetworking

The new BSP include directories are:

  • bsps/include
  • bsps/@RTEMS_CPU@/include
  • bsps/@RTEMS_CPU@/@RTEMS_BSP_FAMILIY@/include

There are build tree include directories for generated files.

The include directory order favours the most general header file, e.g.
it is not possible to override general header files via the include path
order.

The "bootstrap -p" option was removed. The new "bootstrap -H" option
should be used to regenerate the "headers.am" files.

Update #3254.

  • Property mode set to 100644
File size: 1.9 KB
Line 
1/**
2 * @file
3 *
4 * @ingroup ClassicDPMEMImpl
5 *
6 * @brief Dual Ported Memory Manager Implementation
7 */
8
9/*  COPYRIGHT (c) 1989-2008.
10 *  On-Line Applications Research Corporation (OAR).
11 *
12 *  The license and distribution terms for this file may be
13 *  found in the file LICENSE in this distribution or at
14 *  http://www.rtems.org/license/LICENSE.
15 */
16
17#ifndef _RTEMS_RTEMS_DPMEM_INL
18#define _RTEMS_RTEMS_DPMEM_INL
19
20#include <rtems/rtems/dpmem.h>
21#include <rtems/score/objectimpl.h>
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
27/**
28 * @defgroup ClassicDPMEMImpl Dual Ported Memory Manager Implementation
29 *
30 * @ingroup ClassicDPMEM
31 *
32 * @{
33 */
34
35/**
36 *  @brief Define the internal Dual Ported Memory information
37 *  The following define the internal Dual Ported Memory information.
38 */
39extern Objects_Information _Dual_ported_memory_Information;
40
41/**
42 *  @brief Allocates a port control block from the inactive chain
43 *  of free port control blocks.
44 *
45 *  This routine allocates a port control block from the inactive chain
46 *  of free port control blocks.
47 */
48RTEMS_INLINE_ROUTINE Dual_ported_memory_Control
49   *_Dual_ported_memory_Allocate ( void )
50{
51  return (Dual_ported_memory_Control *)
52     _Objects_Allocate( &_Dual_ported_memory_Information );
53}
54
55/**
56 *  @brief Frees a port control block to the inactive chain
57 *  of free port control blocks.
58 *
59 *  This routine frees a port control block to the inactive chain
60 *  of free port control blocks.
61 */
62RTEMS_INLINE_ROUTINE void _Dual_ported_memory_Free (
63   Dual_ported_memory_Control *the_port
64)
65{
66  _Objects_Free( &_Dual_ported_memory_Information, &the_port->Object );
67}
68
69RTEMS_INLINE_ROUTINE Dual_ported_memory_Control *_Dual_ported_memory_Get(
70  Objects_Id        id,
71  ISR_lock_Context *lock_context
72)
73{
74  return (Dual_ported_memory_Control *)
75    _Objects_Get( id, lock_context, &_Dual_ported_memory_Information );
76}
77
78/**@}*/
79
80#ifdef __cplusplus
81}
82#endif
83
84#endif /* _RTEMS_RTEMS_DPMEM_INL */
85/* end of include file */
Note: See TracBrowser for help on using the repository browser.