source: rtems/cpukit/include/rtems/rtl/rtl-trace.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.5 KB
Line 
1/*
2 *  COPYRIGHT (c) 2012-2014 Chris Johns <chrisj@rtems.org>
3 *
4 *  The license and distribution terms for this file may be
5 *  found in the file LICENSE in this distribution or at
6 *  http://www.rtems.org/license/LICENSE.
7 */
8/**
9 * @file
10 *
11 * @ingroup rtems_rtl
12 *
13 * @brief RTEMS Run-Time Linker ELF Trace Support.
14 */
15
16#if !defined (_RTEMS_RTL_TRACE_H_)
17#define _RTEMS_RTL_TRACE_H_
18
19#ifdef __cplusplus
20extern "C" {
21#endif /* __cplusplus */
22
23#include <stdbool.h>
24#include <stdint.h>
25
26/**
27 * Set to 1 to build trace support in to the RTL code.
28 */
29#define RTEMS_RTL_TRACE 1
30
31/**
32 * The type of the mask.
33 */
34typedef uint32_t rtems_rtl_trace_mask;
35
36/**
37 * List of tracing bits for the various parts of the link editor.
38 */
39#define RTEMS_RTL_TRACE_DETAIL                 (1UL << 0)
40#define RTEMS_RTL_TRACE_WARNING                (1UL << 1)
41#define RTEMS_RTL_TRACE_LOAD                   (1UL << 2)
42#define RTEMS_RTL_TRACE_UNLOAD                 (1UL << 3)
43#define RTEMS_RTL_TRACE_SECTION                (1UL << 4)
44#define RTEMS_RTL_TRACE_SYMBOL                 (1UL << 5)
45#define RTEMS_RTL_TRACE_RELOC                  (1UL << 6)
46#define RTEMS_RTL_TRACE_GLOBAL_SYM             (1UL << 7)
47#define RTEMS_RTL_TRACE_LOAD_SECT              (1UL << 8)
48#define RTEMS_RTL_TRACE_ALLOCATOR              (1UL << 9)
49#define RTEMS_RTL_TRACE_UNRESOLVED             (1UL << 10)
50#define RTEMS_RTL_TRACE_CACHE                  (1UL << 11)
51#define RTEMS_RTL_TRACE_ALL                    (0xffffffffUL & ~(RTEMS_RTL_TRACE_CACHE))
52
53/**
54 * Call to check if this part is bring traced. If RTEMS_RTL_TRACE is defined to
55 * 0 the code is dead code elminiated when built with -Os, -O2, or higher.
56 *
57 * @param mask The part of the API to trace.
58 * @retval true Tracing is active for the mask.
59 * @retval false Do not trace.
60 */
61#if RTEMS_RTL_TRACE
62bool rtems_rtl_trace (rtems_rtl_trace_mask mask);
63#else
64#define rtems_rtl_trace(_m) (0)
65#endif
66
67/**
68 * Set the mask.
69 *
70 * @param mask The mask bits to set.
71 * @return The previous mask.
72 */
73#if RTEMS_RTL_TRACE
74rtems_rtl_trace_mask rtems_rtl_trace_set_mask (rtems_rtl_trace_mask mask);
75#else
76#define rtems_rtl_trace_set_mask(_m)
77#endif
78
79/**
80 * Clear the mask.
81 *
82 * @param mask The mask bits to clear.
83 * @return The previous mask.
84 */
85#if RTEMS_RTL_TRACE
86rtems_rtl_trace_mask rtems_rtl_trace_clear_mask (rtems_rtl_trace_mask mask);
87#else
88#define rtems_rtl_trace_clear_mask(_m)
89#endif
90
91/**
92 * Add shell trace shell command.
93 */
94#if RTEMS_RTL_TRACE
95int rtems_rtl_trace_shell_command (int argc, char *argv[]);
96#endif
97
98#ifdef __cplusplus
99}
100#endif /* __cplusplus */
101
102#endif
Note: See TracBrowser for help on using the repository browser.