summaryrefslogtreecommitdiffstats
path: root/cpukit/libmisc/redirector
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/redirector
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/redirector')
-rw-r--r--cpukit/libmisc/redirector/stdio-redirect.h115
1 files changed, 0 insertions, 115 deletions
diff --git a/cpukit/libmisc/redirector/stdio-redirect.h b/cpukit/libmisc/redirector/stdio-redirect.h
deleted file mode 100644
index 6f1d4cdd98..0000000000
--- a/cpukit/libmisc/redirector/stdio-redirect.h
+++ /dev/null
@@ -1,115 +0,0 @@
-/*
- * Copyright (C) 2014 Chris Johns (chrisj@rtems.org)
- *
- * The license and distribution terms for this file may be
- * found in the file LICENSE in this distribution.
- *
- * This software with is provided ``as is'' and with NO WARRANTY.
- */
-
-/*
- * @brief Redirect an stdio file decriptor.
- *
- * The is a helper module of code design to redirect an stdio file
- * descriptor. You can optionally have the data buffered and/or you can provide
- * a handler function that is called when data arrives.
- *
- * The module uses standard POSIX calls to implement the redirection and if the
- * threading was POSIX based the code would be portable. Currently the code
- * uses RTEMS threads.
- *
- * Redirecting stderr and stdout is useful in embedded system because you can
- * transport the output off your device or create a web interface that can
- * display the output. This can be a very powerful diagnostic and support tool.
- *
- * The implementation does:
- *
- * 1. Duplicate the file descriptor (fd) to redirect using the dup call. The
- * duplicated desciptor is used to echo the output out the existing path.
- *
- * 2. Create a pipe using the pipe call.
- *
- * 3. Duplicate the pipe's writer file descriptor to user's file
- * descriptor. This results in any writes to the user's fd being written to
- * the pipe.
- *
- * 4. Create a reader task that blocks on the pipe. It optionally calls a
- * handler and if configured buffers the data.
- */
-
-#if !defined(RTEMS_STDIO_REDIRECT_H)
-#define RTEMS_STDIO_REDIRECT_H
-
-#include <stdbool.h>
-#include <rtems.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
-
-/*
- * Handler called whenever redirected data arrives.
- *
- * @param buffer The data.
- * @param length The amount of data in the buffer.
- */
-typedef void (*rtems_stdio_redirect_handler)(const char* buffer,
- ssize_t length);
-
-/*
- * Redirector data.
- */
-typedef struct
-{
- volatile uint32_t state; /**< The state. */
- rtems_id reader; /**< The reader thread. */
- rtems_id lock; /**< Lock for this struct. */
- int fd; /**< The file descriptor to redirect. */
- int fd_dup; /**< Duplicated fd to write to. */
- int pipe[2]; /**< The pipe to the reader thread. */
- char* input; /**< The input buffer the reader uses. */
- ssize_t input_size; /**< The input buffer size. */
- char* buffer; /**< Captured redirected data. */
- ssize_t buffer_size; /**< Capture buffer size. */
- ssize_t in; /**< Buffer in index. */
- bool full; /**< The buffer is full. */
- bool echo; /**< Echo the data out the existing path. */
- rtems_stdio_redirect_handler handler; /**< Redirected data handler. */
-} rtems_stdio_redirect;
-
-/*
- * Open a redirector returning the handle to it.
- *
- * @param fd The file descriptor to redirect.
- * @param priority The priority of the reader thread.
- */
-rtems_stdio_redirect* rtems_stdio_redirect_open(int fd,
- rtems_task_priority priority,
- size_t stack_size,
- ssize_t input_size,
- ssize_t buffer_size,
- bool echo,
- rtems_stdio_redirect_handler handler);
-
-/*
- * Close the redirector.
- */
-void rtems_stdio_redirect_close(rtems_stdio_redirect* sr);
-
-/*
- * Get data from the capture buffer. Data read is removed from the buffer.
- *
- * @param sr The stdio redirection handle.
- * @param buffer The buffer data is written into.
- * @param length The size of the buffer.
- * @return ssize_t The amount of data written and -1 or an error.
- */
-ssize_t rtems_stdio_redirect_read(rtems_stdio_redirect* sr,
- char* buffer,
- ssize_t length);
-
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
-
-#endif