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, 346 insertions, 0 deletions

diff --git a/cpukit/include/rtems/score/schedulercbs.h b/cpukit/include/rtems/score/schedulercbs.h
new file mode 100644
index 0000000000..635abce125
--- /dev/null
+++ b/cpukit/include/rtems/score/schedulercbs.h
@@ -0,0 +1,346 @@
+/**
+ *  @file  rtems/score/schedulercbs.h
+ *
+ *  @brief Thread manipulation for the CBS scheduler
+ *
+ *  This include file contains all the constants and structures associated
+ *  with the manipulation of threads for the CBS scheduler.
+ */
+
+/*
+ *  Copryight (c) 2011 Petr Benes.
+ *  Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
+ *
+ *  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_SCORE_SCHEDULERCBS_H
+#define _RTEMS_SCORE_SCHEDULERCBS_H
+
+#include <rtems/score/chain.h>
+#include <rtems/score/priority.h>
+#include <rtems/score/scheduler.h>
+#include <rtems/score/rbtree.h>
+#include <rtems/score/scheduleredf.h>
+#include <rtems/rtems/signal.h>
+#include <rtems/rtems/timer.h>
+#include <rtems/score/thread.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ *  @defgroup ScoreSchedulerCBS CBS Scheduler
+ *
+ *  @ingroup ScoreScheduler
+ */
+/**@{*/
+
+#define SCHEDULER_CBS_MAXIMUM_PRIORITY SCHEDULER_EDF_MAXIMUM_PRIORITY
+
+/**
+ *  Entry points for the Constant Bandwidth Server Scheduler.
+ *
+ *  @note: The CBS scheduler is an enhancement of EDF scheduler,
+ *         therefor some routines are similar.
+ */
+#define SCHEDULER_CBS_ENTRY_POINTS \
+  { \
+    _Scheduler_EDF_Initialize,       /* initialize entry point */ \
+    _Scheduler_EDF_Schedule,         /* schedule entry point */ \
+    _Scheduler_EDF_Yield,            /* yield entry point */ \
+    _Scheduler_EDF_Block,            /* block entry point */ \
+    _Scheduler_CBS_Unblock,          /* unblock entry point */ \
+    _Scheduler_EDF_Update_priority,  /* update priority entry point */ \
+    _Scheduler_EDF_Map_priority,     /* map priority entry point */ \
+    _Scheduler_EDF_Unmap_priority,   /* unmap priority entry point */ \
+    SCHEDULER_OPERATION_DEFAULT_ASK_FOR_HELP \
+    _Scheduler_CBS_Node_initialize,  /* node initialize entry point */ \
+    _Scheduler_default_Node_destroy, /* node destroy entry point */ \
+    _Scheduler_CBS_Release_job,      /* new period of task */ \
+    _Scheduler_CBS_Cancel_job,       /* cancel period of task */ \
+    _Scheduler_default_Tick,         /* tick entry point */ \
+    _Scheduler_default_Start_idle    /* start idle entry point */ \
+    SCHEDULER_OPERATION_DEFAULT_GET_SET_AFFINITY \
+  }
+
+/* Return values for CBS server. */
+#define SCHEDULER_CBS_OK                        0
+#define SCHEDULER_CBS_ERROR_GENERIC            -16
+#define SCHEDULER_CBS_ERROR_NO_MEMORY          -17
+#define SCHEDULER_CBS_ERROR_INVALID_PARAMETER  -18
+#define SCHEDULER_CBS_ERROR_UNAUTHORIZED       -19
+#define SCHEDULER_CBS_ERROR_UNIMPLEMENTED      -20
+#define SCHEDULER_CBS_ERROR_MISSING_COMPONENT  -21
+#define SCHEDULER_CBS_ERROR_INCONSISTENT_STATE -22
+#define SCHEDULER_CBS_ERROR_SYSTEM_OVERLOAD    -23
+#define SCHEDULER_CBS_ERROR_INTERNAL_ERROR     -24
+#define SCHEDULER_CBS_ERROR_NOT_FOUND          -25
+#define SCHEDULER_CBS_ERROR_FULL               -26
+#define SCHEDULER_CBS_ERROR_EMPTY              -27
+#define SCHEDULER_CBS_ERROR_NOSERVER           SCHEDULER_CBS_ERROR_NOT_FOUND
+
+/** Maximum number of simultaneous servers. */
+extern const uint32_t _Scheduler_CBS_Maximum_servers;
+
+/** Server id. */
+typedef uint32_t Scheduler_CBS_Server_id;
+
+/** Callback function invoked when a budget overrun of a task occurs. */
+typedef void (*Scheduler_CBS_Budget_overrun)(
+    Scheduler_CBS_Server_id server_id
+);
+
+/**
+ * This structure handles server parameters.
+ */
+typedef struct {
+  /** Relative deadline of the server. */
+  time_t deadline;
+  /** Budget (computation time) of the server. */
+  time_t budget;
+} Scheduler_CBS_Parameters;
+
+/**
+ * This structure represents a time server.
+ */
+typedef struct {
+  /**
+   * Task id.
+   *
+   * @note: The current implementation of CBS handles only one task per server.
+   */
+  rtems_id                 task_id;
+  /** Server paramenters. */
+  Scheduler_CBS_Parameters parameters;
+  /** Callback function invoked when a budget overrun occurs. */
+  Scheduler_CBS_Budget_overrun  cbs_budget_overrun;
+
+  /**
+   * @brief Indicates if this CBS server is initialized.
+   *
+   * @see _Scheduler_CBS_Create_server() and _Scheduler_CBS_Destroy_server().
+   */
+  bool initialized;
+} Scheduler_CBS_Server;
+
+/**
+ * This structure handles CBS specific data of a thread.
+ */
+typedef struct {
+  /** EDF scheduler specific data of a task. */
+  Scheduler_EDF_Node            Base;
+  /** CBS server specific data of a task. */
+  Scheduler_CBS_Server         *cbs_server;
+
+  Priority_Node                *deadline_node;
+} Scheduler_CBS_Node;
+
+
+/**
+ * List of servers. The @a Scheduler_CBS_Server is the index to the array
+ * of pointers to @a _Scheduler_CBS_Server_list.
+ */
+extern Scheduler_CBS_Server _Scheduler_CBS_Server_list[];
+
+void _Scheduler_CBS_Unblock(
+  const Scheduler_Control *scheduler,
+  Thread_Control          *the_thread,
+  Scheduler_Node          *node
+);
+
+void _Scheduler_CBS_Release_job(
+  const Scheduler_Control *scheduler,
+  Thread_Control          *the_thread,
+  Priority_Node           *priority_node,
+  uint64_t                 deadline,
+  Thread_queue_Context    *queue_context
+);
+
+void _Scheduler_CBS_Cancel_job(
+  const Scheduler_Control *scheduler,
+  Thread_Control          *the_thread,
+  Priority_Node           *priority_node,
+  Thread_queue_Context    *queue_context
+);
+
+/**
+ *  @brief _Scheduler_CBS_Initialize
+ *
+ *  Initializes the CBS library.
+ *
+ *  @retval status code.
+ */
+int _Scheduler_CBS_Initialize(void);
+
+/**
+ *  @brief Attach a task to an already existing server.
+ *
+ *  Attach a task to an already existing server.
+ *
+ *  @retval status code.
+ */
+int _Scheduler_CBS_Attach_thread (
+  Scheduler_CBS_Server_id server_id,
+  rtems_id                task_id
+);
+
+/**
+ *  @brief Detach from the CBS Server.
+ *
+ *  Detach from the CBS Server.
+ *
+ *  @retval status code.
+ */
+int _Scheduler_CBS_Detach_thread (
+  Scheduler_CBS_Server_id server_id,
+  rtems_id                task_id
+);
+
+/**
+ *  @brief Cleanup resources associated to the CBS Library.
+ *
+ *  Cleanup resources associated to the CBS Library.
+ *
+ *  @retval status code.
+ */
+int _Scheduler_CBS_Cleanup (void);
+
+/**
+ *  @brief Create a new server with specified parameters.
+ *
+ *  Create a new server with specified parameters.
+ *
+ *  @retval status code.
+ */
+int _Scheduler_CBS_Create_server (
+  Scheduler_CBS_Parameters     *params,
+  Scheduler_CBS_Budget_overrun  budget_overrun_callback,
+  rtems_id                     *server_id
+);
+
+/**
+ *  @brief Detach all tasks from a server and destroy it.
+ *
+ *  Detach all tasks from a server and destroy it.
+ *
+ *  @param[in] server_id is the ID of the server
+ *
+ *  @retval status code.
+ */
+int _Scheduler_CBS_Destroy_server (
+  Scheduler_CBS_Server_id server_id
+);
+
+/**
+ *  @brief Retrieve the approved budget.
+ *
+ *  Retrieve the budget that has been approved for the subsequent
+ *  server instances.
+ *
+ *  @retval status code.
+ */
+int _Scheduler_CBS_Get_approved_budget (
+  Scheduler_CBS_Server_id  server_id,
+  time_t                  *approved_budget
+);
+
+/**
+ *  @brief Retrieve remaining budget for the current server instance.
+ *
+ *  Retrieve remaining budget for the current server instance.
+ *
+ *  @retval status code.
+ */
+int _Scheduler_CBS_Get_remaining_budget (
+  Scheduler_CBS_Server_id  server_id,
+  time_t                  *remaining_budget
+);
+
+/**
+ *  @brief Get relative time info.
+ *
+ *  Retrieve time info relative to @a server_id. The server status code is returned.
+ *
+ *  @param[in] server_id is the server to get the status code from.
+ *  @param[in] exec_time is the execution time.
+ *  @param[in] abs_time is not apparently used.
+ *
+ *  @retval status code.
+ */
+int _Scheduler_CBS_Get_execution_time (
+  Scheduler_CBS_Server_id   server_id,
+  time_t                   *exec_time,
+  time_t                   *abs_time
+);
+
+/**
+ *  @brief Retrieve CBS scheduling parameters.
+ *
+ *  Retrieve CBS scheduling parameters.
+ *
+ *  @retval status code.
+ */
+int _Scheduler_CBS_Get_parameters (
+  Scheduler_CBS_Server_id   server_id,
+  Scheduler_CBS_Parameters *params
+);
+
+/**
+ *  @brief Get a thread server id.
+ *
+ *  Get a thread server id, or SCHEDULER_CBS_ERROR_NOT_FOUND if it is not
+ *  attached to any server.
+ *
+ *  @retval status code.
+ */
+int _Scheduler_CBS_Get_server_id (
+  rtems_id                 task_id,
+  Scheduler_CBS_Server_id *server_id
+);
+
+/**
+ *  @brief Set parameters for CBS scheduling.
+ *
+ *  Change CBS scheduling parameters.
+ *
+ *  @param[in] server_id is the ID of the server.
+ *  @param[in] parameters are the parameters to set.
+ *
+ *  @retval status code.
+ */
+int _Scheduler_CBS_Set_parameters (
+  Scheduler_CBS_Server_id   server_id,
+  Scheduler_CBS_Parameters *parameters
+);
+
+/**
+ *  @brief Invoked when a limited time quantum is exceeded.
+ *
+ *  This routine is invoked when a limited time quantum is exceeded.
+ */
+void _Scheduler_CBS_Budget_callout(
+  Thread_Control *the_thread
+);
+
+/**
+ *  @brief Initializes a CBS specific scheduler node of @a the_thread.
+ */
+void _Scheduler_CBS_Node_initialize(
+  const Scheduler_Control *scheduler,
+  Scheduler_Node          *node,
+  Thread_Control          *the_thread,
+  Priority_Control         priority
+);
+
+#ifdef __cplusplus
+}
+#endif
+
+/**@}*/
+
+#endif
+/* end of include file */