1#ifndef QEMU_CHAR_H
2#define QEMU_CHAR_H
3
4#include "qemu-common.h"
5#include "qemu/option.h"
6#include "qemu/main-loop.h"
7#include "qemu/bitmap.h"
8#include "qom/object.h"
9
10#define IAC_EOR 239
11#define IAC_SE 240
12#define IAC_NOP 241
13#define IAC_BREAK 243
14#define IAC_IP 244
15#define IAC_SB 250
16#define IAC 255
17
18
19typedef struct CharBackend CharBackend;
20
21typedef enum {
22 CHR_EVENT_BREAK,
23 CHR_EVENT_OPENED,
24 CHR_EVENT_MUX_IN,
25 CHR_EVENT_MUX_OUT,
26 CHR_EVENT_CLOSED
27} QEMUChrEvent;
28
29#define CHR_READ_BUF_LEN 4096
30
31typedef enum {
32
33
34
35
36 QEMU_CHAR_FEATURE_RECONNECTABLE,
37
38
39 QEMU_CHAR_FEATURE_FD_PASS,
40
41 QEMU_CHAR_FEATURE_REPLAY,
42
43 QEMU_CHAR_FEATURE_LAST,
44} ChardevFeature;
45
46#define qemu_chr_replay(chr) qemu_chr_has_feature(chr, QEMU_CHAR_FEATURE_REPLAY)
47
48struct Chardev {
49 Object parent_obj;
50
51 QemuMutex chr_write_lock;
52 CharBackend *be;
53 char *label;
54 char *filename;
55 int logfd;
56 int be_open;
57 GSource *gsource;
58 DECLARE_BITMAP(features, QEMU_CHAR_FEATURE_LAST);
59};
60
61
62
63
64
65
66
67
68
69
70
71
72Chardev *qemu_chr_new_from_opts(QemuOpts *opts,
73 Error **errp);
74
75
76
77
78
79
80
81
82
83void qemu_chr_parse_common(QemuOpts *opts, ChardevCommon *backend);
84
85
86
87
88
89
90
91
92ChardevBackend *qemu_chr_parse_opts(QemuOpts *opts,
93 Error **errp);
94
95
96
97
98
99
100
101
102
103
104
105Chardev *qemu_chr_new(const char *label, const char *filename);
106
107
108
109
110
111
112
113
114void qemu_chr_change(QemuOpts *opts, Error **errp);
115
116
117
118
119
120
121void qemu_chr_cleanup(void);
122
123
124
125
126
127
128
129
130
131
132
133
134
135Chardev *qemu_chr_new_noreplay(const char *label, const char *filename);
136
137
138
139
140
141
142
143
144
145
146
147int qemu_chr_be_can_write(Chardev *s);
148
149
150
151
152
153
154
155
156
157
158
159void qemu_chr_be_write(Chardev *s, uint8_t *buf, int len);
160
161
162
163
164
165
166
167
168
169void qemu_chr_be_write_impl(Chardev *s, uint8_t *buf, int len);
170
171
172
173
174
175
176
177
178void qemu_chr_be_event(Chardev *s, int event);
179
180int qemu_chr_add_client(Chardev *s, int fd);
181Chardev *qemu_chr_find(const char *name);
182
183bool qemu_chr_has_feature(Chardev *chr,
184 ChardevFeature feature);
185void qemu_chr_set_feature(Chardev *chr,
186 ChardevFeature feature);
187QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename);
188int qemu_chr_write(Chardev *s, const uint8_t *buf, int len, bool write_all);
189#define qemu_chr_write_all(s, buf, len) qemu_chr_write(s, buf, len, true)
190int qemu_chr_wait_connected(Chardev *chr, Error **errp);
191
192#define TYPE_CHARDEV "chardev"
193#define CHARDEV(obj) OBJECT_CHECK(Chardev, (obj), TYPE_CHARDEV)
194#define CHARDEV_CLASS(klass) \
195 OBJECT_CLASS_CHECK(ChardevClass, (klass), TYPE_CHARDEV)
196#define CHARDEV_GET_CLASS(obj) \
197 OBJECT_GET_CLASS(ChardevClass, (obj), TYPE_CHARDEV)
198
199#define TYPE_CHARDEV_NULL "chardev-null"
200#define TYPE_CHARDEV_MUX "chardev-mux"
201#define TYPE_CHARDEV_RINGBUF "chardev-ringbuf"
202#define TYPE_CHARDEV_PTY "chardev-pty"
203#define TYPE_CHARDEV_CONSOLE "chardev-console"
204#define TYPE_CHARDEV_STDIO "chardev-stdio"
205#define TYPE_CHARDEV_PIPE "chardev-pipe"
206#define TYPE_CHARDEV_MEMORY "chardev-memory"
207#define TYPE_CHARDEV_PARALLEL "chardev-parallel"
208#define TYPE_CHARDEV_FILE "chardev-file"
209#define TYPE_CHARDEV_SERIAL "chardev-serial"
210#define TYPE_CHARDEV_SOCKET "chardev-socket"
211#define TYPE_CHARDEV_UDP "chardev-udp"
212
213#define CHARDEV_IS_RINGBUF(chr) \
214 object_dynamic_cast(OBJECT(chr), TYPE_CHARDEV_RINGBUF)
215#define CHARDEV_IS_PTY(chr) \
216 object_dynamic_cast(OBJECT(chr), TYPE_CHARDEV_PTY)
217
218typedef struct ChardevClass {
219 ObjectClass parent_class;
220
221 bool internal;
222 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp);
223
224 void (*open)(Chardev *chr, ChardevBackend *backend,
225 bool *be_opened, Error **errp);
226
227 int (*chr_write)(Chardev *s, const uint8_t *buf, int len);
228 int (*chr_sync_read)(Chardev *s, const uint8_t *buf, int len);
229 GSource *(*chr_add_watch)(Chardev *s, GIOCondition cond);
230 void (*chr_update_read_handler)(Chardev *s, GMainContext *context);
231 int (*chr_ioctl)(Chardev *s, int cmd, void *arg);
232 int (*get_msgfds)(Chardev *s, int* fds, int num);
233 int (*set_msgfds)(Chardev *s, int *fds, int num);
234 int (*chr_add_client)(Chardev *chr, int fd);
235 int (*chr_wait_connected)(Chardev *chr, Error **errp);
236 void (*chr_disconnect)(Chardev *chr);
237 void (*chr_accept_input)(Chardev *chr);
238 void (*chr_set_echo)(Chardev *chr, bool echo);
239 void (*chr_set_fe_open)(Chardev *chr, int fe_open);
240} ChardevClass;
241
242Chardev *qemu_chardev_new(const char *id, const char *typename,
243 ChardevBackend *backend, Error **errp);
244
245extern int term_escape_char;
246
247
248void qemu_chr_parse_vc(QemuOpts *opts, ChardevBackend *backend, Error **errp);
249
250#endif
251