cpukit, testsuite: Add rtems_printf and rtems_printer support.

This change adds rtems_printf and related functions and wraps the
RTEMS print plugin support into a user API. All references to the
plugin are removed and replaced with the rtems_printer interface.

Printk and related functions are made to return a valid number of
characters formatted and output.

The function attribute to check printf functions has been added
to rtems_printf and printk. No changes to remove warrnings are part
of this patch set.

The testsuite has been moved over to the rtems_printer. The testsuite
has a mix of rtems_printer access and direct print control via the
tmacros.h header file. The support for begink/endk has been removed
as it served no purpose and only confused the code base. The testsuite
has not been refactored to use rtems_printf. This is future work.

3 files changed, 43 insertions, 62 deletions

diff --git a/cpukit/libmisc/testsupport/test.h b/cpukit/libmisc/testsupport/test.h
index 497c4b679b..980ab666a6 100644
--- a/cpukit/libmisc/testsupport/test.h
+++ b/cpukit/libmisc/testsupport/test.h
@@ -16,7 +16,7 @@
 #define _RTEMS_TEST_H
 
 #include <rtems.h>
-#include <rtems/bspIo.h>
+#include <rtems/print.h>
 #include <rtems/score/atomic.h>
 #include <rtems/score/smpbarrier.h>
 
@@ -38,6 +38,11 @@ extern "C" {
 extern const char rtems_test_name[];
 
 /**
+ * @brief Each test must define a printer.
+ */
+extern rtems_printer rtems_test_printer;
+
+/**
  * @brief Fatal extension for tests.
  */
 void rtems_test_fatal_extension(
@@ -53,70 +58,35 @@ void rtems_test_fatal_extension(
   { NULL, NULL, NULL, NULL, NULL, NULL, NULL, rtems_test_fatal_extension }
 
 /**
- * @brief Prints a begin of test message.
- *
- * @param[in] printf_func The formatted output function.
- * @param[in, out] printf_arg The formatted output function argument.
- *
- * @returns As specified by printf().
- */
-int rtems_test_begin_with_plugin(
-  rtems_printk_plugin_t printf_func,
-  void *printf_arg
-);
-
-/**
- * @brief Prints a begin of test message using printf().
- *
- * @returns As specified by printf().
+ * @brief Begin of test message format string.
  */
-static inline int rtems_test_begin(void)
-{
-  return rtems_test_begin_with_plugin(rtems_printf_plugin, NULL);
-}
+#define TEST_BEGIN_STRING "\n\n*** BEGIN OF TEST %s ***\n", rtems_test_name
 
 /**
- * @brief Prints a begin of test message using printk().
- *
- * @returns As specified by printf().
+ * @brief End of test message format string.
  */
-static inline int rtems_test_begink(void)
-{
-  return rtems_test_begin_with_plugin(printk_plugin, NULL);
-}
+#define TEST_END_STRING "*** END OF TEST %s ***\n", rtems_test_name
 
 /**
- * @brief Prints an end of test message.
- *
- * @param[in] printf_func The formatted output function.
- * @param[in, out] printf_arg The formatted output function argument.
+ * @brief Prints a begin of test message using printf().
  *
  * @returns As specified by printf().
  */
-int rtems_test_end_with_plugin(
-  rtems_printk_plugin_t printf_func,
-  void *printf_arg
-);
+int rtems_test_begin(void);
 
 /**
  * @brief Prints an end of test message using printf().
  *
  * @returns As specified by printf().
  */
-static inline int rtems_test_end(void)
-{
-  return rtems_test_end_with_plugin(rtems_printf_plugin, NULL);
-}
+int rtems_test_end(void);
 
 /**
- * @brief Prints an end of test message using printk().
+ * @brief Prints via the RTEMS printer.
  *
  * @returns As specified by printf().
  */
-static inline int rtems_test_endk(void)
-{
-  return rtems_test_end_with_plugin(printk_plugin, NULL);
-}
+int rtems_test_print(const char* format, ...) RTEMS_PRINTF_ATTRIBUTE(1, 2);
 
 /**
  * @brief Internal context for parallel job execution.
diff --git a/cpukit/libmisc/testsupport/testbeginend.c b/cpukit/libmisc/testsupport/testbeginend.c
index 6383b33a78..6bfc400e1e 100644
--- a/cpukit/libmisc/testsupport/testbeginend.c
+++ b/cpukit/libmisc/testsupport/testbeginend.c
@@ -18,26 +18,35 @@
 
 #include <rtems/test.h>
 
-int rtems_test_begin_with_plugin(
-  rtems_printk_plugin_t printf_func,
-  void *printf_arg
-)
+int rtems_test_begin(void)
+{
+  return rtems_printf(
+    &rtems_test_printer,
+    TEST_BEGIN_STRING
+  );
+}
+
+int rtems_test_end(void)
 {
-  return (*printf_func)(
-    printf_arg,
-    "\n\n*** BEGIN OF TEST %s ***\n",
-    rtems_test_name
+  return rtems_printf(
+    &rtems_test_printer,
+    TEST_END_STRING
   );
 }
 
-int rtems_test_end_with_plugin(
-  rtems_printk_plugin_t printf_func,
-  void *printf_arg
+int rtems_test_print(
+  const char* format,
+  ...
 )
 {
-  return (*printf_func)(
-    printf_arg,
-    "*** END OF TEST %s ***\n",
-    rtems_test_name
+  va_list ap;
+  int len;
+  va_start(ap, format);
+  len = rtems_vprintf(
+    &rtems_test_printer,
+    format,
+    ap
   );
+  va_end(ap);
+  return len;
 }
diff --git a/cpukit/libmisc/testsupport/testextension.c b/cpukit/libmisc/testsupport/testextension.c
index a689e66792..43f79bc114 100644
--- a/cpukit/libmisc/testsupport/testextension.c
+++ b/cpukit/libmisc/testsupport/testextension.c
@@ -33,6 +33,9 @@ void rtems_test_fatal_extension(
 {
 #if defined(RTEMS_PROFILING)
   rtems_interrupt_lock_context lock_context;
+  rtems_printer printer;
+
+  rtems_print_printer_printk( &printer );
 
   /*
    * Ensures to report only once on SMP machines and ensures that the report is
@@ -50,8 +53,7 @@ void rtems_test_fatal_extension(
 
     rtems_profiling_report_xml(
       rtems_test_name,
-      printk_plugin,
-      NULL,
+      &printer,
       1,
       "  "
     );