1 files changed, 121 insertions, 0 deletions
diff --git a/src/usr/trace/daemon/daemon.H b/src/usr/trace/daemon/daemon.H
new file mode 100644
index 000000000..e6d2f5606
--- /dev/null
+++ b/src/usr/trace/daemon/daemon.H
@@ -0,0 +1,121 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/usr/trace/daemon/daemon.H $                               */
+/*                                                                        */
+/* IBM CONFIDENTIAL                                                       */
+/*                                                                        */
+/* COPYRIGHT International Business Machines Corp. 2012                   */
+/*                                                                        */
+/* p1                                                                     */
+/*                                                                        */
+/* Object Code Only (OCO) source materials                                */
+/* Licensed Internal Code Source Materials                                */
+/* IBM HostBoot Licensed Internal Code                                    */
+/*                                                                        */
+/* The source code for this program is not published or otherwise         */
+/* divested of its trade secrets, irrespective of what has been           */
+/* deposited with the U.S. Copyright Office.                              */
+/*                                                                        */
+/* Origin: 30                                                             */
+/*                                                                        */
+/* IBM_PROLOG_END_TAG                                                     */
+#ifndef __TRACE_DAEMON_DAEMON_H
+#define __TRACE_DAEMON_DAEMON_H
+
+/** @file daemon.H
+ *  Declarations for the daemon class.
+ */
+
+#include <stdint.h>
+#include "../service.H"
+
+    // Forward declarations.
+namespace TRACE
+{
+    class BufferPage;
+    class Entry;
+}
+
+namespace TRACEDAEMON
+{
+    /** @class Daemon
+     *
+     *  @brief Class to handle trace background ops and mailbox messages.
+     */
+    class Daemon
+    {
+        public:
+            /** Default constructor.
+             *
+             *  Initializes class.
+             *
+             */
+            Daemon();
+            /** Destructor.
+             *
+             *  Not currently supported, asserts.
+             */
+            ~Daemon();
+
+            /** @fn start
+             *
+             *  Thread entry-point for daemon.  Calls 'execute'.
+             */
+            static void* start(void*);
+
+        private:
+
+            /** @fn execute
+             *
+             *  Performs daemon work.
+             */
+            void execute();
+
+            /** Gather trace pages from client-side buffers. */
+            void collectTracePages();
+            /** Send continuous trace buffer to SP. */
+            void sendContBuffer(void* i_buffer, size_t i_size);
+            /** Reduce component trace buffers if exceeded max size. */
+            void pruneTraceEntries();
+            /** Combine trace buffer pages to remove pruned entries. */
+            void coalescePages();
+
+            /** Locklessly move a trace entry from one location to another. */
+            void replaceEntry(TRACE::Entry* from, TRACE::Entry* to);
+
+            /** Write mailbox scratch register to a value. */
+            void writeScratchReg(uint64_t i_value);
+            /** Read mailbox scratch register. */
+            uint64_t readScratchReg();
+
+                /** Client-service object. */
+            TRACE::Service* iv_service;
+
+                /** First (oldest) combined-buffer page. */
+            TRACE::BufferPage* iv_first;
+                /** Last (newested) combined-buffer page. */
+            TRACE::BufferPage* iv_last;
+
+            // These are kept as class variables rather than function variables
+            // so that they can be extraced by the debug tools, since we might
+            // be in the middle of the 'collectTracePages' function when the
+            // debug tools try to extract the trace.
+                /** Intermediate pages
+                 *      After collection from client-side, before combining. */
+            TRACE::BufferPage* iv_curPages[TRACE::BUFFER_COUNT];
+                /** Current offset into intermediate page. */
+            size_t iv_curOffset[TRACE::BUFFER_COUNT];
+
+                /** Current size of trace entries pruned. */
+            size_t iv_totalPruned;
+
+                /** Address of scratch register. */
+            static const uint32_t MB_SCRATCH_REGISTER_1 = 0x00050038;
+
+    };
+
+
+}
+
+#endif