blob: b1a8c144e073ba9c5f5d085fa864b5bfb99892fa [file] [log] [blame]
Jeff Hostetleree4512e2019-02-22 14:25:01 -08001#ifndef TR2_DST_H
2#define TR2_DST_H
3
4struct strbuf;
Jeff Hostetlerbce9db62019-04-15 13:39:47 -07005#include "trace2/tr2_sysenv.h"
Jeff Hostetleree4512e2019-02-22 14:25:01 -08006
7struct tr2_dst {
Jeff Hostetlerbce9db62019-04-15 13:39:47 -07008 enum tr2_sysenv_variable sysenv_var;
Jeff Hostetleree4512e2019-02-22 14:25:01 -08009 int fd;
10 unsigned int initialized : 1;
11 unsigned int need_close : 1;
Josh Steadmon87db61a2019-10-04 15:08:21 -070012 unsigned int too_many_files : 1;
Jeff Hostetleree4512e2019-02-22 14:25:01 -080013};
14
15/*
16 * Disable TRACE2 on the destination. In TRACE2 a destination (DST)
17 * wraps a file descriptor; it is associated with a TARGET which
18 * defines the formatting.
19 */
20void tr2_dst_trace_disable(struct tr2_dst *dst);
21
22/*
23 * Return the file descriptor for the DST.
24 * If 0, the dst is closed or disabled.
25 */
26int tr2_dst_get_trace_fd(struct tr2_dst *dst);
27
28/*
29 * Return true if the DST is opened for writing.
30 */
31int tr2_dst_trace_want(struct tr2_dst *dst);
32
33/*
34 * Write a single line/message to the trace file.
35 */
36void tr2_dst_write_line(struct tr2_dst *dst, struct strbuf *buf_line);
37
38#endif /* TR2_DST_H */