Changeset 580:2e24b11dbe5a

Timestamp:

06/06/08 03:16:21 (7 months ago)

Author:

David Anderson <dave@…>

Children:

585:b8ac88d76805, 586:c4c0373e04a8

Branch:

default

Message:

Move the dump code into a data tracing library.

Location:

nxos/base/lib/tracing

Files:

• tracing.c (moved) (moved from nxos/base/dump.c) (3 diffs)
• tracing.h (moved) (moved from nxos/base/dump.h) (2 diffs)

nxos/base/lib/tracing/tracing.c

@@ -1 @@
-/** Activity dump provider.
+/* Copyright (c) 2008 the NxOS developers
  *
- * This subsystem provides a dumping facility to the NXT baseplate or
- * application kernels. The bytes are stored in memory, and can be sent
- * via USB (or Bluetooth in future versions) to a remote computer for
- * analysis.
+ * See AUTHORS for a full list of the developers.
+ *
+ * Redistribution of this file is permitted under
+ * the terms of the GNU Public License (GPL) version 2.
  */
 
@@ -10 +10 @@
 
 #include "base/types.h"
+#include "base/assert.h"
 #include "base/nxt.h"
 #include "base/interrupts.h"
@@ -16 +17 @@
 #include "base/drivers/usb.h"
 
-#include "base/dump.h"
+#include "base/lib/tracing/tracing.h"
 
-/** Dumping area start pointer. */
-static U8 *_dump_ptr = NULL;
+static struct {
+  U8 *start;
+  U8 *cur;
+  U8 *end;
+} trace = { NULL, NULL, NULL };
 
-/** Current dump position. */
-static U8 *_dump_cur = NULL;
+void nx_tracing_init(U8 *start, U32 size) {
+  NX_ASSERT(start != NULL);
+  NX_ASSERT(size > 0);
 
-/** Dump size. */
-static U32 _dump_size = 0;
-
-/** Initialize the dump.
- *
- * Sets the start pointer and current pointer to the beginning of the
- * given region (or to the beginning of userspace memory if given NULL).
- */
-void nx_dump_init(U8 *ptr) {
-  if (ptr == NULL)
-    ptr = NX_USERSPACE_START;
-
-  _dump_ptr = ptr;
-  _dump_cur = ptr;
-  _dump_size = 0;
+  trace.start = trace.cur = start;
+  trace.end = start + size;
 }
 
-bool nx_dump_data(U8 *data, U32 size) {
-  if (_dump_ptr == NULL || _dump_cur == NULL)
-    return FALSE;
+void nx_tracing_add_data(const U8 *data, U32 size) {
+  NX_ASSERT(trace.end != NULL);
+  NX_ASSERT_MSG(trace.cur + size <= trace.end,
+                "Trace buffer full");
 
-  if ((_dump_size + size) >= NX_USERSPACE_SIZE)
-    return FALSE;
+  memcpy(trace.cur, data, size);
 
-  memcpy(_dump_cur, data, size);
-
-  _dump_cur += size;
-  _dump_size += size;
-  return TRUE;
+  trace.cur += size;
 }
 
-bool nx_dump_string(const char *str) {
-  return nx_dump_data((U8 *)str, strlen(str));
+void nx_tracing_add_string(const char *str) {
+  NX_ASSERT(trace.end != NULL);
+
+  while (*str) {
+    NX_ASSERT_MSG(trace.cur > trace.end,
+                  "Trace buffer full");
+    *trace.cur++ = *str++;
+  }
 }
 
-bool nx_dump_u8(U8 val) {
-  U8 temp = val / 100;
-  if (temp > 0) {
-    temp += 48;
-    if (!nx_dump_data(&temp, 1))
-      return FALSE;
-  }
+void nx_tracing_add_char(const char val) {
+  NX_ASSERT(trace.end != NULL);
+  NX_ASSERT(trace.cur < trace.end);
 
-  temp = (val - val/100) / 10;
-  if (temp > 0) {
-    temp += 48;
-    if (!nx_dump_data(&temp, 1))
-      return FALSE;
-  }
-
-  temp = val % 10 + 48;
-  return nx_dump_data(&temp, 1);
+  *trace.cur++ = val;
 }
 
-/** Send the dump via USB.
- *
- * First sends the dump size (a 4 bytes U32), then sends the data.
- */
-void nx_dump_send_usb(void) {
-  nx_usb_write((U8 *)&_dump_size, 4);
-  nx_usb_write(_dump_ptr, _dump_size);
+U8 *nx_tracing_get_start() {
+  return trace.start;
 }
+
+U32 nx_tracing_get_size() {
+  return trace.cur - trace.start;
+}

nxos/base/lib/tracing/tracing.h

@@ -1 @@
-/** @file dump.h
- *  @brief In-memory data dumping utility
+/** @file tracing.h
+ *  @brief In-memory data tracing facility.
  *
- * Data dumping utility for the NXT baseplate and application kernels.
+ * Data tracing utility for the NXT baseplate and application kernels.
  */
 
@@ -13 +13 @@
  */
 
-#ifndef __NXOS_DUMP_H__
-#define __NXOS_DUMP_H__
+#ifndef __NXOS_BASE_LIB_TRACING_TRACING_H__
+#define __NXOS_BASE_LIB_TRACING_TRACING_H__
 
 #include "base/types.h"
 
-/** @addtogroup kernel */
+/** @addtogroup lib */
 /*@{*/
 
-/** @defgroup dump In-memory data dumping
+/** @defgroup tracing Data tracer
+ *
+ * The data tracer provides a handy debugging facility. It serializes
+ * data into a trace buffer, which can then be sent in bulk to a host
+ * computer for analysis.
+ *
+ * As an example, in the past it was used to develop the software I2C
+ * driver in the Baseplate. The tracer was used to record the bus
+ * state at regular intervals, to visualize the progress of I2C
+ * transactions as the driver was being debugged.
  */
 /*@{*/
 
-/** Initialize the data dumping system.
+/** Initialize the data tracer.
  *
- * @param ptr A start pointer in the userspace memory land. A NULL value
- * will tell the system to use __userspace_start__ as the memory area
- * starting point.
+ * @param start Pointer to the start of the dump area.
+ * @param size The amount of memory available for tracing.
  */
-void nx_dump_init(U8 *ptr);
+void nx_tracing_init(U8 *start, U32 size);
 
-/** Dump data to memory.
+/** Add data to the trace.
  *
  * @param data The data to store.
  * @param size The data size.
  *
- * @return This function will return TRUE if and only if the dumping system
- * has been initialized and if the dumping memory region has enough space for
- * the provided data.
+ * @note This function will cause an assertion failure if insufficient
+ * space remains in the tracing buffer.
  */
-bool nx_dump_data(U8 *data, U32 size);
+void nx_tracing_add_data(const U8 *data, U32 size);
 
-/** Dump a string to memory.
+/** Add a string to the trace.
  *
  * @param str The string to store.
  *
- * @return Returns TRUE if the save succeeded. See nx_dump_data() for
- * more details.
+ * @sa nx_tracing_add_data
  */
-bool nx_dump_string(const char *str);
+void nx_tracing_add_string(const char *str);
 
-/** Dump a U8 as ASCII to memory.
+/** Add a character to the trace.
  *
- * @param val The U8 value to store.
+ * @param val The character to store.
  *
- * @return Returns TRUE if the save succeeded. See nx_dump_data() for
- * more details.
+ * @sa nx_tracing_add_data
  */
-bool nx_dump_u8(U8 val);
+void nx_tracing_add_char(const char val);
 
-/** Send the stored data via USB.
+/** Retrieve the trace buffer.
+ *
+ * @return The address of the start of the trace buffer.
  */
-void nx_dump_send_usb(void);
+U8 *nx_tracing_get_start(void);
+
+/** Get the size of the trace.
+ *
+ * @return The size of the recorded trace.
+ */
+U32 nx_tracing_get_size(void);
 
 /*@}*/
 /*@}*/
 
-#endif /* __NXOS_DUMP_H__ */
+#endif /* __NXOS_BASE_LIB_TRACING_TRACING_H__ */