summaryrefslogtreecommitdiffstats
path: root/cpukit/libmisc/stackchk
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-12-23 18:18:56 +1100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2018-01-25 08:45:26 +0100
commit2afb22b7e1ebcbe40373ff7e0efae7d207c655a9 (patch)
tree44759efe9374f13200a97e96d91bd9a2b7e5ce2a /cpukit/libmisc/stackchk
parentMAINTAINERS: Add myself to Write After Approval. (diff)
downloadrtems-2afb22b7e1ebcbe40373ff7e0efae7d207c655a9.tar.bz2
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.
Diffstat (limited to 'cpukit/libmisc/stackchk')
-rw-r--r--cpukit/libmisc/stackchk/stackchk.h139
1 files changed, 0 insertions, 139 deletions
diff --git a/cpukit/libmisc/stackchk/stackchk.h b/cpukit/libmisc/stackchk/stackchk.h
deleted file mode 100644
index 16fc4f9b9d..0000000000
--- a/cpukit/libmisc/stackchk/stackchk.h
+++ /dev/null
@@ -1,139 +0,0 @@
-/**
- * @file rtems/stackchk.h
- *
- * @defgroup libmisc_stackchk Stack Checker Mechanism
- *
- * @ingroup libmisc
- * @brief Stack Checker Information
- *
- * This include file contains information necessary to utilize
- * and install the stack checker mechanism.
- */
-
-/*
- * COPYRIGHT (c) 1989-2009.
- * 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_STACKCHK_H
-#define _RTEMS_STACKCHK_H
-
-#include <stdbool.h> /* bool */
-
-#include <rtems/score/thread.h> /* Thread_Control */
-#include <rtems/print.h>
-
-/**
- * @defgroup libmisc_stackchk Stack Checker Mechanism
- *
- * @ingroup libmisc
- */
-/**@{*/
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/**
- * @brief Checks if current task is blown its stack.
- *
- * This method is used to determine if the current stack pointer
- * of the currently executing task is within bounds.
- *
- * @retval This method returns true if the currently executing task
- * has blown its stack.
- *
- */
-bool rtems_stack_checker_is_blown( void );
-
-/**
- * @brief Print the stack usage report using printk.
- *
- * This method prints a stack usage report for the curently executing
- * task.
- *
- * @note It uses printk to print the report.
- */
-void rtems_stack_checker_report_usage( void );
-
-/**
- * @brief Print the stack usage report using caller's routine.
- *
- * This method prints a stack usage report for the curently executing
- * task.
- *
- * @param[in] context is the context to pass to the print handler
- * @param[in] print is the print handler
- *
- * @note It uses the caller's routine to print the report.
- */
-void rtems_stack_checker_report_usage_with_plugin(
- const rtems_printer *printer
-);
-
-/*************************************************************
- *************************************************************
- ** Prototyped only so the user extension can be installed **
- *************************************************************
- *************************************************************/
-
-/**
- * @brief Stack Checker Task Create Extension
- *
- * This method is the task create extension for the stack checker.
- *
- * @param[in] running points to the currently executing task
- * @param[in] the_thread points to the newly created task
- *
- * @note If this this the first task created, the stack checker
- * will automatically intialize itself.
- */
-bool rtems_stack_checker_create_extension(
- Thread_Control *running,
- Thread_Control *the_thread
-);
-
-/**
- * @brief Stack Checker Task Context Switch Extension
- *
- * This method is the task context switch extension for the stack checker.
- *
- * @param[in] running points to the currently executing task which
- * is being context switched out
- * @param[in] running points to the heir task which we are switching to
- *
- * @note This is called from the internal method _Thread_Dispatch.
- */
-void rtems_stack_checker_switch_extension(
- Thread_Control *running,
- Thread_Control *heir
-);
-
-/**
- * @brief Stack Checker Extension Set Definition
- *
- * This macro defines the user extension handler set for the stack
- * checker. This macro is normally only used by confdefs.h.
- */
-#define RTEMS_STACK_CHECKER_EXTENSION \
-{ \
- rtems_stack_checker_create_extension, /* rtems_task_create */ \
- 0, /* rtems_task_start */ \
- 0, /* rtems_task_restart */ \
- 0, /* rtems_task_delete */ \
- rtems_stack_checker_switch_extension, /* task_switch */ \
- 0, /* task_begin */ \
- 0, /* task_exitted */ \
- 0 /* rtems_stack_checker_fatal_extension */, /* fatal */ \
- 0, /* terminate */ \
-}
-
-#ifdef __cplusplus
-}
-#endif
-/**@}*/
-#endif
-/* end of include file */