xref: /openbmc/qemu/trace/simple.h (revision 5e05c40ced78ed9a3c25a82ec1f144bb7baffe3f)
1edb47ec4SLluís /*
2edb47ec4SLluís  * Simple trace backend
3edb47ec4SLluís  *
4edb47ec4SLluís  * Copyright IBM, Corp. 2010
5edb47ec4SLluís  *
6edb47ec4SLluís  * This work is licensed under the terms of the GNU GPL, version 2.  See
7edb47ec4SLluís  * the COPYING file in the top-level directory.
8edb47ec4SLluís  *
9edb47ec4SLluís  */
10edb47ec4SLluís 
11edb47ec4SLluís #ifndef TRACE_SIMPLE_H
12edb47ec4SLluís #define TRACE_SIMPLE_H
13edb47ec4SLluís 
14ba4912cbSMarkus Armbruster void st_print_trace_file_status(void);
15db25d56cSMarkus Armbruster bool st_set_trace_file_enabled(bool enable);
1641fc57e4SPaolo Bonzini void st_set_trace_file(const char *file);
1741fc57e4SPaolo Bonzini bool st_init(void);
18*263b6e96SGerd Hoffmann void st_init_group(size_t group);
19edb47ec4SLluís void st_flush_trace_buffer(void);
20edb47ec4SLluís 
2162bab732SHarsh Prateek Bora typedef struct {
2262bab732SHarsh Prateek Bora     unsigned int tbuf_idx;
2362bab732SHarsh Prateek Bora     unsigned int rec_off;
2462bab732SHarsh Prateek Bora } TraceBufferRecord;
2562bab732SHarsh Prateek Bora 
2662bab732SHarsh Prateek Bora /* Note for hackers: Make sure MAX_TRACE_LEN < sizeof(uint32_t) */
2762bab732SHarsh Prateek Bora #define MAX_TRACE_STRLEN 512
2862bab732SHarsh Prateek Bora /**
2962bab732SHarsh Prateek Bora  * Initialize a trace record and claim space for it in the buffer
3062bab732SHarsh Prateek Bora  *
3162bab732SHarsh Prateek Bora  * @arglen  number of bytes required for arguments
3262bab732SHarsh Prateek Bora  */
33ef4c9fc8SDaniel P. Berrange int trace_record_start(TraceBufferRecord *rec, uint32_t id, size_t arglen);
3462bab732SHarsh Prateek Bora 
3562bab732SHarsh Prateek Bora /**
3662bab732SHarsh Prateek Bora  * Append a 64-bit argument to a trace record
3762bab732SHarsh Prateek Bora  */
3862bab732SHarsh Prateek Bora void trace_record_write_u64(TraceBufferRecord *rec, uint64_t val);
3962bab732SHarsh Prateek Bora 
4062bab732SHarsh Prateek Bora /**
4162bab732SHarsh Prateek Bora  * Append a string argument to a trace record
4262bab732SHarsh Prateek Bora  */
4362bab732SHarsh Prateek Bora void trace_record_write_str(TraceBufferRecord *rec, const char *s, uint32_t slen);
4462bab732SHarsh Prateek Bora 
4562bab732SHarsh Prateek Bora /**
4662bab732SHarsh Prateek Bora  * Mark a trace record completed
4762bab732SHarsh Prateek Bora  *
4862bab732SHarsh Prateek Bora  * Don't append any more arguments to the trace record after calling this.
4962bab732SHarsh Prateek Bora  */
5062bab732SHarsh Prateek Bora void trace_record_finish(TraceBufferRecord *rec);
5162bab732SHarsh Prateek Bora 
52edb47ec4SLluís #endif /* TRACE_SIMPLE_H */
53