source: rtems/cpukit/include/rtems/cpuuse.h @ e97806a

5
Last change on this file since e97806a 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: 1.5 KB
Line 
1/**
2 * @file rtems/cpuuse.h
3 *
4 * @defgroup libmisc_cpuuse CPU Usage
5 *
6 * @ingroup libmisc
7 * @brief CPU Usage Report
8 *
9 * This include file contains information necessary to utilize
10 * and install the cpu usage reporting mechanism.
11 */
12
13/*
14 * COPYRIGHT (c) 1989-2011.
15 * On-Line Applications Research Corporation (OAR).
16 *
17 * The license and distribution terms for this file may be
18 * found in the file LICENSE in this distribution or at
19 * http://www.rtems.org/license/LICENSE.
20 */
21
22#ifndef __RTEMS_CPUUSE_h
23#define __RTEMS_CPUUSE_h
24
25#include <rtems.h>
26#include <rtems/print.h>
27
28/**
29 *  @defgroup libmisc_cpuuse CPU Usage
30 *
31 *  @ingroup libmisc
32 */
33/**@{*/
34#ifdef __cplusplus
35extern "C" {
36#endif
37
38/*
39 * rtems_cpu_usage_report_with_handler
40 */
41
42void rtems_cpu_usage_report_with_plugin( const rtems_printer *printer );
43
44/**
45 *  @brief Report CPU usage.
46 *
47 *  CPU Usage Reporter
48 */
49
50void rtems_cpu_usage_report( void );
51
52/**
53 *   @brief CPU usage Top plugin
54 *
55 *   Report CPU Usage in top format to
56 *   to a print plugin.
57 */
58void rtems_cpu_usage_top_with_plugin( const rtems_printer *printer );
59
60/**
61 *  @brief CPU usage top.
62 *
63 *  CPU Usage top
64 */
65
66void rtems_cpu_usage_top( void );
67
68/**
69 *  @brief Reset CPU usage.
70 *
71 *  CPU Usage Reporter
72 */
73
74void rtems_cpu_usage_reset( void );
75
76/**
77 * @brief Reports per-processor information.
78 *
79 * @return The number of characters printed.
80 */
81int rtems_cpu_info_report( const rtems_printer *printer );
82
83#ifdef __cplusplus
84}
85#endif
86/**@}*/
87#endif
88/* end of include file */
Note: See TracBrowser for help on using the repository browser.