simple.h 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. /*
  2. * Simple trace backend
  3. *
  4. * Copyright IBM, Corp. 2010
  5. *
  6. * This work is licensed under the terms of the GNU GPL, version 2. See
  7. * the COPYING file in the top-level directory.
  8. *
  9. */
  10. #ifndef TRACE_SIMPLE_H
  11. #define TRACE_SIMPLE_H
  12. #include <stdint.h>
  13. #include <stdbool.h>
  14. #include <stdio.h>
  15. #include "trace/generated-events.h"
  16. void st_print_trace_file_status(FILE *stream, fprintf_function stream_printf);
  17. void st_set_trace_file_enabled(bool enable);
  18. bool st_set_trace_file(const char *file);
  19. void st_flush_trace_buffer(void);
  20. typedef struct {
  21. unsigned int tbuf_idx;
  22. unsigned int rec_off;
  23. } TraceBufferRecord;
  24. /* Note for hackers: Make sure MAX_TRACE_LEN < sizeof(uint32_t) */
  25. #define MAX_TRACE_STRLEN 512
  26. /**
  27. * Initialize a trace record and claim space for it in the buffer
  28. *
  29. * @arglen number of bytes required for arguments
  30. */
  31. int trace_record_start(TraceBufferRecord *rec, TraceEventID id, size_t arglen);
  32. /**
  33. * Append a 64-bit argument to a trace record
  34. */
  35. void trace_record_write_u64(TraceBufferRecord *rec, uint64_t val);
  36. /**
  37. * Append a string argument to a trace record
  38. */
  39. void trace_record_write_str(TraceBufferRecord *rec, const char *s, uint32_t slen);
  40. /**
  41. * Mark a trace record completed
  42. *
  43. * Don't append any more arguments to the trace record after calling this.
  44. */
  45. void trace_record_finish(TraceBufferRecord *rec);
  46. #endif /* TRACE_SIMPLE_H */