Trace macro to clear all component trace buffers.

Change-Id: I938d142b40cce23aae0d6408c915a58cdd47d83e
Reviewed-on: http://gfw160.austin.ibm.com:8080/gerrit/631
Tested-by: Jenkins Server
Reviewed-by: MIKE J. JONES <mjjones@us.ibm.com>
Reviewed-by: Mark W. Wenning <wenning@us.ibm.com>
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>

1 files changed, 15 insertions, 3 deletions

diff --git a/src/include/usr/trace/interface.H b/src/include/usr/trace/interface.H
index 7b610931e..eb9ec184e 100644
--- a/src/include/usr/trace/interface.H
+++ b/src/include/usr/trace/interface.H
@@ -277,16 +277,28 @@ tracepp replaces trace_adal_hash() with hash value and reduced format string
  * descriptor which is used by the trace calls to find the correct
  * buffer to write to.
  *
- * @param des This is assigned by this function.
+ * @param des       A trac_desc_t * initialized to null by the using code.
  * @param comp_name This is the 15 character name of the component requesting
- *                  the trace buffer.
+ *                  the trace buffer. Will be stored internally in upper case.
  * @param bufferSize Requested length of the buffer, if 0 is entered the user will
- *                   get default buffer size.
+ *                   get default buffer size. Subject to maximum allowable size.
  * @return void
 */
 #define TRAC_INIT_BUFFER(des,comp_name, bufferSize) \
         TRACE::Trace::getTheInstance().initBuffer((des), (comp_name), (bufferSize))
 
+
+#ifdef __HIDDEN_TRACEIF_CLEARBUFFER
+/**
+ * @fn void TRAC_CLEAR_BUFFERS()
+ * @brief For all in-use component trace buffers, clear their contents.
+ *
+ * @return void
+*/
+#define TRAC_CLEAR_BUFFERS() TRACE::Trace::getTheInstance().clearAllBuffers()
+#endif 
+
+
 /*******************************************************************************
   TRAC_INIT: Class for creating trace descriptor object.