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 /* character device */ 19 typedef struct CharBackend CharBackend; 20 21 typedef enum { 22 CHR_EVENT_BREAK, /* serial break char */ 23 CHR_EVENT_OPENED, /* new connection established */ 24 CHR_EVENT_MUX_IN, /* mux-focus was set to this terminal */ 25 CHR_EVENT_MUX_OUT, /* mux-focus will move on */ 26 CHR_EVENT_CLOSED /* connection closed */ 27 } QEMUChrEvent; 28 29 #define CHR_READ_BUF_LEN 4096 30 31 typedef enum { 32 /* Whether the chardev peer is able to close and 33 * reopen the data channel, thus requiring support 34 * for qemu_chr_wait_connected() to wait for a 35 * valid connection */ 36 QEMU_CHAR_FEATURE_RECONNECTABLE, 37 /* Whether it is possible to send/recv file descriptors 38 * over the data channel */ 39 QEMU_CHAR_FEATURE_FD_PASS, 40 /* Whether replay or record mode is enabled */ 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 48 struct 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 * @qemu_chr_new_from_opts: 63 * 64 * Create a new character backend from a QemuOpts list. 65 * 66 * @opts see qemu-config.c for a list of valid options 67 * 68 * Returns: a new character backend 69 */ 70 Chardev *qemu_chr_new_from_opts(QemuOpts *opts, 71 Error **errp); 72 73 /** 74 * @qemu_chr_parse_common: 75 * 76 * Parse the common options available to all character backends. 77 * 78 * @opts the options that still need parsing 79 * @backend a new backend 80 */ 81 void qemu_chr_parse_common(QemuOpts *opts, ChardevCommon *backend); 82 83 /** 84 * @qemu_chr_new: 85 * 86 * Create a new character backend from a URI. 87 * 88 * @label the name of the backend 89 * @filename the URI 90 * 91 * Returns: a new character backend 92 */ 93 Chardev *qemu_chr_new(const char *label, const char *filename); 94 95 /** 96 * @qemu_chr_cleanup: 97 * 98 * Delete all chardevs (when leaving qemu) 99 */ 100 void qemu_chr_cleanup(void); 101 102 /** 103 * @qemu_chr_new_noreplay: 104 * 105 * Create a new character backend from a URI. 106 * Character device communications are not written 107 * into the replay log. 108 * 109 * @label the name of the backend 110 * @filename the URI 111 * 112 * Returns: a new character backend 113 */ 114 Chardev *qemu_chr_new_noreplay(const char *label, const char *filename); 115 116 /** 117 * @qemu_chr_be_can_write: 118 * 119 * Determine how much data the front end can currently accept. This function 120 * returns the number of bytes the front end can accept. If it returns 0, the 121 * front end cannot receive data at the moment. The function must be polled 122 * to determine when data can be received. 123 * 124 * Returns: the number of bytes the front end can receive via @qemu_chr_be_write 125 */ 126 int qemu_chr_be_can_write(Chardev *s); 127 128 /** 129 * @qemu_chr_be_write: 130 * 131 * Write data from the back end to the front end. Before issuing this call, 132 * the caller should call @qemu_chr_be_can_write to determine how much data 133 * the front end can currently accept. 134 * 135 * @buf a buffer to receive data from the front end 136 * @len the number of bytes to receive from the front end 137 */ 138 void qemu_chr_be_write(Chardev *s, uint8_t *buf, int len); 139 140 /** 141 * @qemu_chr_be_write_impl: 142 * 143 * Implementation of back end writing. Used by replay module. 144 * 145 * @buf a buffer to receive data from the front end 146 * @len the number of bytes to receive from the front end 147 */ 148 void qemu_chr_be_write_impl(Chardev *s, uint8_t *buf, int len); 149 150 /** 151 * @qemu_chr_be_event: 152 * 153 * Send an event from the back end to the front end. 154 * 155 * @event the event to send 156 */ 157 void qemu_chr_be_event(Chardev *s, int event); 158 159 int qemu_chr_add_client(Chardev *s, int fd); 160 Chardev *qemu_chr_find(const char *name); 161 162 bool qemu_chr_has_feature(Chardev *chr, 163 ChardevFeature feature); 164 void qemu_chr_set_feature(Chardev *chr, 165 ChardevFeature feature); 166 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename); 167 int qemu_chr_write(Chardev *s, const uint8_t *buf, int len, bool write_all); 168 #define qemu_chr_write_all(s, buf, len) qemu_chr_write(s, buf, len, true) 169 int qemu_chr_wait_connected(Chardev *chr, Error **errp); 170 171 #define TYPE_CHARDEV "chardev" 172 #define CHARDEV(obj) OBJECT_CHECK(Chardev, (obj), TYPE_CHARDEV) 173 #define CHARDEV_CLASS(klass) \ 174 OBJECT_CLASS_CHECK(ChardevClass, (klass), TYPE_CHARDEV) 175 #define CHARDEV_GET_CLASS(obj) \ 176 OBJECT_GET_CLASS(ChardevClass, (obj), TYPE_CHARDEV) 177 178 #define TYPE_CHARDEV_NULL "chardev-null" 179 #define TYPE_CHARDEV_MUX "chardev-mux" 180 #define TYPE_CHARDEV_RINGBUF "chardev-ringbuf" 181 #define TYPE_CHARDEV_PTY "chardev-pty" 182 #define TYPE_CHARDEV_CONSOLE "chardev-console" 183 #define TYPE_CHARDEV_STDIO "chardev-stdio" 184 #define TYPE_CHARDEV_PIPE "chardev-pipe" 185 #define TYPE_CHARDEV_MEMORY "chardev-memory" 186 #define TYPE_CHARDEV_PARALLEL "chardev-parallel" 187 #define TYPE_CHARDEV_FILE "chardev-file" 188 #define TYPE_CHARDEV_SERIAL "chardev-serial" 189 #define TYPE_CHARDEV_SOCKET "chardev-socket" 190 #define TYPE_CHARDEV_UDP "chardev-udp" 191 192 #define CHARDEV_IS_RINGBUF(chr) \ 193 object_dynamic_cast(OBJECT(chr), TYPE_CHARDEV_RINGBUF) 194 #define CHARDEV_IS_PTY(chr) \ 195 object_dynamic_cast(OBJECT(chr), TYPE_CHARDEV_PTY) 196 197 typedef struct ChardevClass { 198 ObjectClass parent_class; 199 200 bool internal; /* TODO: eventually use TYPE_USER_CREATABLE */ 201 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp); 202 203 void (*open)(Chardev *chr, ChardevBackend *backend, 204 bool *be_opened, Error **errp); 205 206 int (*chr_write)(Chardev *s, const uint8_t *buf, int len); 207 int (*chr_sync_read)(Chardev *s, const uint8_t *buf, int len); 208 GSource *(*chr_add_watch)(Chardev *s, GIOCondition cond); 209 void (*chr_update_read_handler)(Chardev *s, GMainContext *context); 210 int (*chr_ioctl)(Chardev *s, int cmd, void *arg); 211 int (*get_msgfds)(Chardev *s, int* fds, int num); 212 int (*set_msgfds)(Chardev *s, int *fds, int num); 213 int (*chr_add_client)(Chardev *chr, int fd); 214 int (*chr_wait_connected)(Chardev *chr, Error **errp); 215 void (*chr_disconnect)(Chardev *chr); 216 void (*chr_accept_input)(Chardev *chr); 217 void (*chr_set_echo)(Chardev *chr, bool echo); 218 void (*chr_set_fe_open)(Chardev *chr, int fe_open); 219 } ChardevClass; 220 221 Chardev *qemu_chardev_new(const char *id, const char *typename, 222 ChardevBackend *backend, Error **errp); 223 224 extern int term_escape_char; 225 226 /* console.c */ 227 void qemu_chr_parse_vc(QemuOpts *opts, ChardevBackend *backend, Error **errp); 228 229 #endif 230