xref: /qemu/trace/simple.h (revision ba4912cb0d6035192d58fbb4b901e8f39cfd0948)
126f7227bSStefan Hajnoczi /*
226f7227bSStefan Hajnoczi  * Simple trace backend
326f7227bSStefan Hajnoczi  *
426f7227bSStefan Hajnoczi  * Copyright IBM, Corp. 2010
526f7227bSStefan Hajnoczi  *
626f7227bSStefan Hajnoczi  * This work is licensed under the terms of the GNU GPL, version 2.  See
726f7227bSStefan Hajnoczi  * the COPYING file in the top-level directory.
826f7227bSStefan Hajnoczi  *
926f7227bSStefan Hajnoczi  */
1026f7227bSStefan Hajnoczi 
11edb47ec4SLluís #ifndef TRACE_SIMPLE_H
12edb47ec4SLluís #define TRACE_SIMPLE_H
1326f7227bSStefan Hajnoczi 
14*ba4912cbSMarkus Armbruster void st_print_trace_file_status(void);
15c5ceb523SStefan Hajnoczi void st_set_trace_file_enabled(bool enable);
1641fc57e4SPaolo Bonzini void st_set_trace_file(const char *file);
1741fc57e4SPaolo Bonzini bool st_init(void);
18c5ceb523SStefan Hajnoczi void st_flush_trace_buffer(void);
1926f7227bSStefan Hajnoczi 
2062bab732SHarsh Prateek Bora typedef struct {
2162bab732SHarsh Prateek Bora     unsigned int tbuf_idx;
2262bab732SHarsh Prateek Bora     unsigned int rec_off;
2362bab732SHarsh Prateek Bora } TraceBufferRecord;
2462bab732SHarsh Prateek Bora 
2562bab732SHarsh Prateek Bora /* Note for hackers: Make sure MAX_TRACE_LEN < sizeof(uint32_t) */
2662bab732SHarsh Prateek Bora #define MAX_TRACE_STRLEN 512
2762bab732SHarsh Prateek Bora /**
2862bab732SHarsh Prateek Bora  * Initialize a trace record and claim space for it in the buffer
2962bab732SHarsh Prateek Bora  *
3062bab732SHarsh Prateek Bora  * @arglen  number of bytes required for arguments
3162bab732SHarsh Prateek Bora  */
32ef4c9fc8SDaniel P. Berrange int trace_record_start(TraceBufferRecord *rec, uint32_t id, size_t arglen);
3362bab732SHarsh Prateek Bora 
3462bab732SHarsh Prateek Bora /**
3562bab732SHarsh Prateek Bora  * Append a 64-bit argument to a trace record
3662bab732SHarsh Prateek Bora  */
3762bab732SHarsh Prateek Bora void trace_record_write_u64(TraceBufferRecord *rec, uint64_t val);
3862bab732SHarsh Prateek Bora 
3962bab732SHarsh Prateek Bora /**
4062bab732SHarsh Prateek Bora  * Append a string argument to a trace record
4162bab732SHarsh Prateek Bora  */
4262bab732SHarsh Prateek Bora void trace_record_write_str(TraceBufferRecord *rec, const char *s, uint32_t slen);
4362bab732SHarsh Prateek Bora 
4462bab732SHarsh Prateek Bora /**
4562bab732SHarsh Prateek Bora  * Mark a trace record completed
4662bab732SHarsh Prateek Bora  *
4762bab732SHarsh Prateek Bora  * Don't append any more arguments to the trace record after calling this.
4862bab732SHarsh Prateek Bora  */
4962bab732SHarsh Prateek Bora void trace_record_finish(TraceBufferRecord *rec);
5062bab732SHarsh Prateek Bora 
51edb47ec4SLluís #endif /* TRACE_SIMPLE_H */
52