source: rtems/bsps/include/bsp/stackalloc.h @ 2afb22b

5
Last change on this file since 2afb22b was 2afb22b, checked in by Chris Johns <chrisj@…>, on 12/23/17 at 07:18:56

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: 2.0 KB
Line 
1/**
2 * @file
3 *
4 * @ingroup bsp_stack
5 *
6 * @brief Task stack initialization, allocation and free functions.
7 */
8
9/*
10 * Copyright (c) 2009-2012 embedded brains GmbH.  All rights reserved.
11 *
12 *  embedded brains GmbH
13 *  Obere Lagerstr. 30
14 *  82178 Puchheim
15 *  Germany
16 *  <rtems@embedded-brains.de>
17 *
18 * The license and distribution terms for this file may be
19 * found in the file LICENSE in this distribution or at
20 * http://www.rtems.org/license/LICENSE.
21 */
22
23#ifndef LIBBSP_SHARED_STACK_ALLOC_H
24#define LIBBSP_SHARED_STACK_ALLOC_H
25
26#include <stddef.h>
27#include <stdint.h>
28
29#ifdef __cplusplus
30extern "C" {
31#endif /* __cplusplus */
32
33/**
34 * @defgroup bsp_stack Task Stack Allocator
35 *
36 * @ingroup bsp_shared
37 *
38 * @brief Task stack initialization, allocation and free functions.
39 *
40 * Initialize the task stack allocator with bsp_stack_initialize().  To enable
41 * the task stack allocator use the following in the system configuration:
42 *
43 * @code
44 * #include <bsp/stackalloc.h>
45 *
46 * #define CONFIGURE_INIT
47 *
48 * #include <confdefs.h>
49 * @endcode
50 *
51 * @{
52 */
53
54/**
55 * @brief Task stack allocator initialization for
56 * @ref CONFIGURE_TASK_STACK_ALLOCATOR_INIT.
57 */
58void bsp_stack_allocate_init(size_t stack_space_size);
59
60/**
61 * @brief Task stack allocator for @ref CONFIGURE_TASK_STACK_ALLOCATOR.
62 *
63 * In case the designated task stack space from bsp_stack_initialize() is
64 * completely in use the work space will be used to allocate the stack.
65 */
66void *bsp_stack_allocate(size_t size);
67
68/**
69 * @brief Task stack free function for @ref CONFIGURE_TASK_STACK_DEALLOCATOR.
70 */
71void bsp_stack_free(void *stack);
72
73/**
74 * @brief Task stack allocator initialization configuration option.
75 */
76#define CONFIGURE_TASK_STACK_ALLOCATOR_INIT bsp_stack_allocate_init
77
78/**
79 * @brief Task stack allocator configuration option.
80 */
81#define CONFIGURE_TASK_STACK_ALLOCATOR bsp_stack_allocate
82
83/**
84 * @brief Task stack deallocator configuration option.
85 */
86#define CONFIGURE_TASK_STACK_DEALLOCATOR bsp_stack_free
87
88/** @} */
89
90#ifdef __cplusplus
91}
92#endif /* __cplusplus */
93
94#endif /* LIBBSP_SHARED_STACK_ALLOC_H */
Note: See TracBrowser for help on using the repository browser.