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.

1 files changed, 430 insertions, 0 deletions

diff --git a/cpukit/include/rtems/rtems/ratemon.h b/cpukit/include/rtems/rtems/ratemon.h
new file mode 100644
index 0000000000..ca48a92983
--- /dev/null
+++ b/cpukit/include/rtems/rtems/ratemon.h
@@ -0,0 +1,430 @@
+/**
+ * @file rtems/rtems/ratemon.h
+ *
+ * @defgroup ClassicRateMon Rate Monotonic Scheduler
+ *
+ * @ingroup ClassicRTEMS
+ * @brief Classic API Rate Monotonic Manager.
+ *
+ * This include file contains all the constants, structures, and
+ * prototypes associated with the Rate Monotonic Manager. This manager
+ * provides facilities to implement threads which execute in a periodic
+ * fashion.
+ *
+ * Directives provided are:
+ *
+ * - create a rate monotonic timer
+ * - cancel a period
+ * - delete a rate monotonic timer
+ * - conclude current and start the next period
+ * - obtain status information on a period
+ * - obtain the number of postponed jobs
+ */
+
+/* COPYRIGHT (c) 1989-2009, 2016.
+ * On-Line Applications Research Corporation (OAR).
+ * COPYRIGHT (c) 2016-2017 Kuan-Hsun Chen.
+ *
+ * The license and distribution terms for this file may be
+ * found in the file LICENSE in this distribution or at
+ * http://www.rtems.org/license/LICENSE.
+ */
+
+#ifndef _RTEMS_RTEMS_RATEMON_H
+#define _RTEMS_RTEMS_RATEMON_H
+
+#include <rtems/rtems/types.h>
+#include <rtems/rtems/status.h>
+#include <rtems/score/thread.h>
+#include <rtems/score/watchdog.h>
+
+struct rtems_printer;
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ *  @defgroup ClassicRateMon Rate Monotonic Scheduler
+ *
+ *  @ingroup ClassicRTEMS
+ *
+ *  This encapsulates functionality related to the Classic API Rate
+ *  Monotonic Manager.
+ *
+ *  Statistics are kept for each period and can be obtained or printed via
+ *  API calls.  The statistics kept include minimum, maximum and average times
+ *  for both cpu usage and wall time.  The statistics indicate the execution
+ *  and wall time used by the owning thread between successive calls to
+ *  rtems_rate_monotonic_period.
+ */
+/**@{*/
+
+/**
+ *  This is the public type used for the rate monotonic timing
+ *  statistics.
+ */
+#include <rtems/score/timespec.h>
+
+typedef struct timespec rtems_rate_monotonic_period_time_t;
+
+/**
+ *  This is the internal type used for the rate monotonic timing
+ *  statistics.
+ */
+#include <rtems/score/timestamp.h>
+
+/**
+ *  The following enumerated type defines the states in which a
+ *  period may be.
+ */
+typedef enum {
+  /**
+   * This value indicates the period is off the watchdog chain,
+   * and has never been initialized.
+   */
+  RATE_MONOTONIC_INACTIVE,
+
+  /**
+   * This value indicates the period is on the watchdog chain, and
+   * running.  The owner should be executed or blocked waiting on
+   * another object.
+   */
+  RATE_MONOTONIC_ACTIVE,
+
+  /**
+   * This value indicates the period is off the watchdog chain, and
+   * has expired.  The owner is still executing and has taken too much
+   * all time to complete this iteration of the period.
+   */
+  RATE_MONOTONIC_EXPIRED
+}   rtems_rate_monotonic_period_states;
+
+/**
+ *  The following constant is the interval passed to the rate_monontonic_period
+ *  directive to obtain status information.
+ */
+#define RTEMS_PERIOD_STATUS       WATCHDOG_NO_TIMEOUT
+
+/**
+ *  The following defines the PUBLIC data structure that has the
+ *  statistics kept on each period instance.
+ *
+ *  @note The public structure uses struct timespec while the
+ *        internal one uses Timestamp_Control.
+ */
+typedef struct {
+  /** This field contains the number of periods executed. */
+  uint32_t     count;
+  /** This field contains the number of periods missed. */
+  uint32_t     missed_count;
+
+  /** This field contains the least amount of CPU time used in a period. */
+  rtems_thread_cpu_usage_t             min_cpu_time;
+  /** This field contains the highest amount of CPU time used in a period. */
+  rtems_thread_cpu_usage_t             max_cpu_time;
+  /** This field contains the total amount of wall time used in a period. */
+  rtems_thread_cpu_usage_t             total_cpu_time;
+
+  /** This field contains the least amount of wall time used in a period. */
+  rtems_rate_monotonic_period_time_t   min_wall_time;
+  /** This field contains the highest amount of wall time used in a period. */
+  rtems_rate_monotonic_period_time_t   max_wall_time;
+  /** This field contains the total amount of CPU time used in a period. */
+  rtems_rate_monotonic_period_time_t   total_wall_time;
+}  rtems_rate_monotonic_period_statistics;
+
+/**
+ *  The following defines the INTERNAL data structure that has the
+ *  statistics kept on each period instance.
+ */
+typedef struct {
+  /** This field contains the number of periods executed. */
+  uint32_t     count;
+  /** This field contains the number of periods missed. */
+  uint32_t     missed_count;
+
+  /** This field contains the least amount of CPU time used in a period. */
+  Timestamp_Control min_cpu_time;
+  /** This field contains the highest amount of CPU time used in a period. */
+  Timestamp_Control max_cpu_time;
+  /** This field contains the total amount of wall time used in a period. */
+  Timestamp_Control total_cpu_time;
+
+  /** This field contains the least amount of wall time used in a period. */
+  Timestamp_Control min_wall_time;
+  /** This field contains the highest amount of wall time used in a period. */
+  Timestamp_Control max_wall_time;
+  /** This field contains the total amount of CPU time used in a period. */
+  Timestamp_Control total_wall_time;
+}  Rate_monotonic_Statistics;
+
+/**
+ *  The following defines the period status structure.
+ */
+typedef struct {
+  /** This is the Id of the thread using this period. */
+  rtems_id                             owner;
+
+  /** This is the current state of this period. */
+  rtems_rate_monotonic_period_states   state;
+
+  /**
+   *  This is the length of wall time that has passed since this period
+   *  was last initiated.  If the period is expired or has not been initiated,
+   *  then this field has no meaning.
+   */
+  rtems_rate_monotonic_period_time_t   since_last_period;
+
+  /**
+   *  This is the amount of CPU time that has been used since this period
+   *  was last initiated.  If the period is expired or has not been initiated,
+   *  then this field has no meaning.
+   */
+  rtems_thread_cpu_usage_t             executed_since_last_period;
+
+  /** This is the count of postponed jobs of this period. */
+  uint32_t                             postponed_jobs_count;
+}  rtems_rate_monotonic_period_status;
+
+/**
+ * @brief The following structure defines the control block used to manage each
+ * period.
+ *
+ * State changes are protected by the default thread lock of the owner thread.
+ * The owner thread is the thread that created the period object.  The owner
+ * thread field is immutable after object creation.
+ */
+typedef struct {
+  /** This field is the object management portion of a Period instance. */
+  Objects_Control                         Object;
+
+  /**
+   * @brief Protects the rate monotonic period state.
+   */
+  ISR_LOCK_MEMBER(                        Lock )
+
+  /** This is the timer used to provide the unblocking mechanism. */
+  Watchdog_Control                        Timer;
+
+  /** This field indicates the current state of the period. */
+  rtems_rate_monotonic_period_states      state;
+
+  /**
+   * @brief A priority node for use by the scheduler job release and cancel
+   * operations.
+   */
+  Priority_Node                           Priority;
+
+  /**
+   * This field contains the length of the next period to be
+   * executed.
+   */
+  uint32_t                                next_length;
+
+  /**
+   * This field contains a pointer to the TCB for the thread
+   * which owns and uses this period instance.
+   */
+  Thread_Control                         *owner;
+
+  /**
+   * This field contains the cpu usage value of the owning thread when
+   * the period was initiated.  It is used to compute the period's
+   * statistics.
+   */
+  Timestamp_Control                       cpu_usage_period_initiated;
+
+  /**
+   * This field contains the wall time value when the period
+   * was initiated.  It is used to compute the period's statistics.
+   */
+  Timestamp_Control                       time_period_initiated;
+
+  /**
+   * This field contains the statistics maintained for the period.
+   */
+  Rate_monotonic_Statistics               Statistics;
+
+  /**
+   * This field contains the number of postponed jobs.
+   * When the watchdog timeout, this variable will be increased immediately.
+   */
+  uint32_t                                postponed_jobs;
+
+  /**
+   *  This field contains the tick of the latest deadline decided by the period
+   *  watchdog.
+  */
+  uint64_t                                latest_deadline;
+}   Rate_monotonic_Control;
+
+/**
+ *  @brief Create a Period
+ *
+ *  Rate Monotonic Manager
+ *
+ *  This routine implements the rate_monotonic_create directive.  The
+ *  period will have the name name.  It returns the id of the
+ *  created period in ID.
+ */
+rtems_status_code rtems_rate_monotonic_create(
+  rtems_name    name,
+  rtems_id     *id
+);
+
+/**
+ * @brief RTEMS Rate Monotonic Name to Id
+ *
+ * This routine implements the rtems_rate_monotonic_ident directive.
+ * It returns the period ID associated with name. If more than one period
+ * is named name, then the period to which the ID belongs is arbitrary.
+ *
+ * @param[in] name is the user defined period name
+ * @param[in] id is the pointer to period id
+ *
+ * @retval This method returns RTEMS_SUCCESSFUL if there was not an
+ *         error. Otherwise, a status code is returned indicating the
+ *         source of the error. If successful, the id will
+ *         be filled in with the region id.
+ */
+rtems_status_code rtems_rate_monotonic_ident(
+  rtems_name    name,
+  rtems_id     *id
+);
+
+/**
+ * @brief RTEMS Rate Monotonic Cancel
+ *
+ * This routine implements the rtems_rate_monotonic_cancel directive. This
+ * directive stops the period associated with ID from continuing to
+ * run.
+ *
+ * @param[in] id is the rate monotonic id
+ *
+ * @retval RTEMS_SUCCESSFUL if successful and caller is not the owning thread
+ * or error code if unsuccessful
+ *
+ */
+rtems_status_code rtems_rate_monotonic_cancel(
+  rtems_id   id
+);
+
+/**
+ * @brief RTEMS Delete Rate Monotonic
+ *
+ * This routine implements the rtems_rate_monotonic_delete directive. The
+ * period indicated by ID is deleted.
+ *
+ * @param[in] id is the rate monotonic id
+ *
+ * @retval This method returns RTEMS_SUCCESSFUL if there was not an
+ *         error. Otherwise, a status code is returned indicating the
+ *         source of the error.
+ */
+rtems_status_code rtems_rate_monotonic_delete(
+  rtems_id   id
+);
+
+/**
+ * @brief RTEMS Rate Monotonic Get Status
+ *
+ * This routine implements the rtems_rate_monotonic_get_status directive.
+ * Information about the period indicated by ID is returned.
+ *
+ * @param[in] id is the rate monotonic id
+ * @param[in] status is the pointer to status control block
+ *
+ * @retval This method returns RTEMS_SUCCESSFUL if there was not an
+ *         error. Otherwise, a status code is returned indicating the
+ *         source of the error.
+ *
+ */
+rtems_status_code rtems_rate_monotonic_get_status(
+  rtems_id                             id,
+  rtems_rate_monotonic_period_status  *status
+);
+
+/**
+ * @brief RTEMS Rate Monotonic Get Statistics
+ *
+ * This routine implements the rtems_rate_monotonic_get_statistics directive.
+ * Statistics gathered from the use of this period are returned.
+ *
+ * @param[in] id is the rate monotonic id
+ * @param[in] statistics is the pointer to statistics control block
+ *
+ * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
+ */
+rtems_status_code rtems_rate_monotonic_get_statistics(
+  rtems_id                                id,
+  rtems_rate_monotonic_period_statistics *statistics
+);
+
+/**
+ *  @brief RTEMS Rate Monotonic Reset Statistics
+ *
+ *  Rate Monotonic Manager -- Reset Statistics
+ *
+ *  This routine allows a thread to reset the statistics information
+ *  on a specific period instance.
+ */
+rtems_status_code rtems_rate_monotonic_reset_statistics(
+  rtems_id                                 id
+);
+
+/**
+ *  @brief rtems_rate_monotonic_reset_all_statistics
+ *
+ *  This routine allows a thread to reset the statistics information
+ *  on ALL period instances.
+ */
+void rtems_rate_monotonic_reset_all_statistics( void );
+
+/**
+ *  @brief RTEMS Report Rate Monotonic Statistics
+ *
+ *  This routine allows a thread to print the statistics information
+ *  on ALL period instances which have non-zero counts using the RTEMS
+ *  printer. The implementation of this directive straddles the fence
+ *  between inside and outside of RTEMS.  It is presented as part of
+ *  the Manager but actually uses other services of the Manager.
+ */
+void rtems_rate_monotonic_report_statistics_with_plugin(
+  const struct rtems_printer *printer
+);
+
+/**
+ *  @brief RTEMS Report Rate Monotonic Statistics
+ *
+ *  This routine allows a thread to print the statistics information
+ *  on ALL period instances which have non-zero counts using printk.
+ */
+void rtems_rate_monotonic_report_statistics( void );
+
+/**
+ * @brief RTEMS Rate Monotonic Period
+ *
+ * This routine implements the rtems_rate_monotonic_period directive. When
+ * length is non-zero, this directive initiates the period associated with
+ * ID from continuing for a period of length. If length is zero, then
+ * result is set to indicate the current state of the period.
+ *
+ * @param[in] id is the rate monotonic id
+ * @param[in] length is the length of period (in ticks)
+ *
+ * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
+ */
+rtems_status_code rtems_rate_monotonic_period(
+  rtems_id        id,
+  rtems_interval  length
+);
+
+/**@}*/
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
+/* end of include file */