Statistics
| Branch: | Revision:

root / trace / simple.h @ dc1c13d9

History | View | Annotate | Download (1.4 kB)

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