include/sysemu/char.h

   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
  20 typedef enum {
  21     CHR_EVENT_BREAK, /* serial break char */
  22     CHR_EVENT_OPENED, /* new connection established */
  23     CHR_EVENT_MUX_IN, /* mux-focus was set to this terminal */
  24     CHR_EVENT_MUX_OUT, /* mux-focus will move on */
  25     CHR_EVENT_CLOSED /* connection closed */
  26 } QEMUChrEvent;
  27
  28 #define CHR_READ_BUF_LEN 4096
  29
  30 #define CHR_IOCTL_SERIAL_SET_PARAMS   1
  31 typedef struct {
  32     int speed;
  33     int parity;
  34     int data_bits;
  35     int stop_bits;
  36 } QEMUSerialSetParams;
  37
  38 #define CHR_IOCTL_SERIAL_SET_BREAK    2
  39
  40 #define CHR_IOCTL_PP_READ_DATA        3
  41 #define CHR_IOCTL_PP_WRITE_DATA       4
  42 #define CHR_IOCTL_PP_READ_CONTROL     5
  43 #define CHR_IOCTL_PP_WRITE_CONTROL    6
  44 #define CHR_IOCTL_PP_READ_STATUS      7
  45 #define CHR_IOCTL_PP_EPP_READ_ADDR    8
  46 #define CHR_IOCTL_PP_EPP_READ         9
  47 #define CHR_IOCTL_PP_EPP_WRITE_ADDR  10
  48 #define CHR_IOCTL_PP_EPP_WRITE       11
  49 #define CHR_IOCTL_PP_DATA_DIR        12
  50
  51 struct ParallelIOArg {
  52     void *buffer;
  53     int count;
  54 };
  55
  56 #define CHR_IOCTL_SERIAL_SET_TIOCM   13
  57 #define CHR_IOCTL_SERIAL_GET_TIOCM   14
  58
  59 #define CHR_TIOCM_CTS   0x020
  60 #define CHR_TIOCM_CAR   0x040
  61 #define CHR_TIOCM_DSR   0x100
  62 #define CHR_TIOCM_RI    0x080
  63 #define CHR_TIOCM_DTR   0x002
  64 #define CHR_TIOCM_RTS   0x004
  65
  66 typedef void IOEventHandler(void *opaque, int event);
  67
  68 typedef enum {
  69     /* Whether the chardev peer is able to close and
  70      * reopen the data channel, thus requiring support
  71      * for qemu_chr_wait_connected() to wait for a
  72      * valid connection */
  73     QEMU_CHAR_FEATURE_RECONNECTABLE,
  74     /* Whether it is possible to send/recv file descriptors
  75      * over the data channel */
  76     QEMU_CHAR_FEATURE_FD_PASS,
  77     /* Whether replay or record mode is enabled */
  78     QEMU_CHAR_FEATURE_REPLAY,
  79
  80     QEMU_CHAR_FEATURE_LAST,
  81 } ChardevFeature;
  82
  83 /* This is the backend as seen by frontend, the actual backend is
  84  * Chardev */
  85 typedef struct CharBackend {
  86     Chardev *chr;
  87     IOEventHandler *chr_event;
  88     IOCanReadHandler *chr_can_read;
  89     IOReadHandler *chr_read;
  90     void *opaque;
  91     int tag;
  92     int fe_open;
  93 } CharBackend;
  94
  95 struct Chardev {
  96     Object parent_obj;
  97
  98     QemuMutex chr_write_lock;
  99     CharBackend *be;
 100     char *label;
 101     char *filename;
 102     int logfd;
 103     int be_open;
 104     guint fd_in_tag;
 105     DECLARE_BITMAP(features, QEMU_CHAR_FEATURE_LAST);
 106     QTAILQ_ENTRY(Chardev) next;
 107 };
 108
 109 /**
 110  * @qemu_chr_new_from_opts:
 111  *
 112  * Create a new character backend from a QemuOpts list.
 113  *
 114  * @opts see qemu-config.c for a list of valid options
 115  *
 116  * Returns: a new character backend
 117  */
 118 Chardev *qemu_chr_new_from_opts(QemuOpts *opts,
 119                                 Error **errp);
 120
 121 /**
 122  * @qemu_chr_parse_common:
 123  *
 124  * Parse the common options available to all character backends.
 125  *
 126  * @opts the options that still need parsing
 127  * @backend a new backend
 128  */
 129 void qemu_chr_parse_common(QemuOpts *opts, ChardevCommon *backend);
 130
 131 /**
 132  * @qemu_chr_new:
 133  *
 134  * Create a new character backend from a URI.
 135  *
 136  * @label the name of the backend
 137  * @filename the URI
 138  *
 139  * Returns: a new character backend
 140  */
 141 Chardev *qemu_chr_new(const char *label, const char *filename);
 142
 143
 144 /**
 145  * @qemu_chr_fe_disconnect:
 146  *
 147  * Close a fd accpeted by character backend.
 148  * Without associated Chardev, do nothing.
 149  */
 150 void qemu_chr_fe_disconnect(CharBackend *be);
 151
 152 /**
 153  * @qemu_chr_cleanup:
 154  *
 155  * Delete all chardevs (when leaving qemu)
 156  */
 157 void qemu_chr_cleanup(void);
 158
 159 /**
 160  * @qemu_chr_fe_wait_connected:
 161  *
 162  * Wait for characted backend to be connected, return < 0 on error or
 163  * if no assicated Chardev.
 164  */
 165 int qemu_chr_fe_wait_connected(CharBackend *be, Error **errp);
 166
 167 /**
 168  * @qemu_chr_new_noreplay:
 169  *
 170  * Create a new character backend from a URI.
 171  * Character device communications are not written
 172  * into the replay log.
 173  *
 174  * @label the name of the backend
 175  * @filename the URI
 176  *
 177  * Returns: a new character backend
 178  */
 179 Chardev *qemu_chr_new_noreplay(const char *label, const char *filename);
 180
 181 /**
 182  * @qemu_chr_delete:
 183  *
 184  * Destroy a character backend and remove it from the list of
 185  * identified character backends.
 186  */
 187 void qemu_chr_delete(Chardev *chr);
 188
 189 /**
 190  * @qemu_chr_fe_set_echo:
 191  *
 192  * Ask the backend to override its normal echo setting.  This only really
 193  * applies to the stdio backend and is used by the QMP server such that you
 194  * can see what you type if you try to type QMP commands.
 195  * Without associated Chardev, do nothing.
 196  *
 197  * @echo true to enable echo, false to disable echo
 198  */
 199 void qemu_chr_fe_set_echo(CharBackend *be, bool echo);
 200
 201 /**
 202  * @qemu_chr_fe_set_open:
 203  *
 204  * Set character frontend open status.  This is an indication that the
 205  * front end is ready (or not) to begin doing I/O.
 206  * Without associated Chardev, do nothing.
 207  */
 208 void qemu_chr_fe_set_open(CharBackend *be, int fe_open);
 209
 210 /**
 211  * @qemu_chr_fe_printf:
 212  *
 213  * Write to a character backend using a printf style interface.  This
 214  * function is thread-safe. It does nothing without associated
 215  * Chardev.
 216  *
 217  * @fmt see #printf
 218  */
 219 void qemu_chr_fe_printf(CharBackend *be, const char *fmt, ...)
 220     GCC_FMT_ATTR(2, 3);
 221
 222 /**
 223  * @qemu_chr_fe_add_watch:
 224  *
 225  * If the backend is connected, create and add a #GSource that fires
 226  * when the given condition (typically G_IO_OUT|G_IO_HUP or G_IO_HUP)
 227  * is active; return the #GSource's tag.  If it is disconnected,
 228  * or without associated Chardev, return 0.
 229  *
 230  * @cond the condition to poll for
 231  * @func the function to call when the condition happens
 232  * @user_data the opaque pointer to pass to @func
 233  *
 234  * Returns: the source tag
 235  */
 236 guint qemu_chr_fe_add_watch(CharBackend *be, GIOCondition cond,
 237                             GIOFunc func, void *user_data);
 238
 239 /**
 240  * @qemu_chr_fe_write:
 241  *
 242  * Write data to a character backend from the front end.  This function
 243  * will send data from the front end to the back end.  This function
 244  * is thread-safe.
 245  *
 246  * @buf the data
 247  * @len the number of bytes to send
 248  *
 249  * Returns: the number of bytes consumed (0 if no assicated Chardev)
 250  */
 251 int qemu_chr_fe_write(CharBackend *be, const uint8_t *buf, int len);
 252
 253 /**
 254  * @qemu_chr_fe_write_all:
 255  *
 256  * Write data to a character backend from the front end.  This function will
 257  * send data from the front end to the back end.  Unlike @qemu_chr_fe_write,
 258  * this function will block if the back end cannot consume all of the data
 259  * attempted to be written.  This function is thread-safe.
 260  *
 261  * @buf the data
 262  * @len the number of bytes to send
 263  *
 264  * Returns: the number of bytes consumed (0 if no assicated Chardev)
 265  */
 266 int qemu_chr_fe_write_all(CharBackend *be, const uint8_t *buf, int len);
 267
 268 /**
 269  * @qemu_chr_fe_read_all:
 270  *
 271  * Read data to a buffer from the back end.
 272  *
 273  * @buf the data buffer
 274  * @len the number of bytes to read
 275  *
 276  * Returns: the number of bytes read (0 if no assicated Chardev)
 277  */
 278 int qemu_chr_fe_read_all(CharBackend *be, uint8_t *buf, int len);
 279
 280 /**
 281  * @qemu_chr_fe_ioctl:
 282  *
 283  * Issue a device specific ioctl to a backend.  This function is thread-safe.
 284  *
 285  * @cmd see CHR_IOCTL_*
 286  * @arg the data associated with @cmd
 287  *
 288  * Returns: if @cmd is not supported by the backend or there is no
 289  *          associated Chardev, -ENOTSUP, otherwise the return
 290  *          value depends on the semantics of @cmd
 291  */
 292 int qemu_chr_fe_ioctl(CharBackend *be, int cmd, void *arg);
 293
 294 /**
 295  * @qemu_chr_fe_get_msgfd:
 296  *
 297  * For backends capable of fd passing, return the latest file descriptor passed
 298  * by a client.
 299  *
 300  * Returns: -1 if fd passing isn't supported or there is no pending file
 301  *          descriptor.  If a file descriptor is returned, subsequent calls to
 302  *          this function will return -1 until a client sends a new file
 303  *          descriptor.
 304  */
 305 int qemu_chr_fe_get_msgfd(CharBackend *be);
 306
 307 /**
 308  * @qemu_chr_fe_get_msgfds:
 309  *
 310  * For backends capable of fd passing, return the number of file received
 311  * descriptors and fills the fds array up to num elements
 312  *
 313  * Returns: -1 if fd passing isn't supported or there are no pending file
 314  *          descriptors.  If file descriptors are returned, subsequent calls to
 315  *          this function will return -1 until a client sends a new set of file
 316  *          descriptors.
 317  */
 318 int qemu_chr_fe_get_msgfds(CharBackend *be, int *fds, int num);
 319
 320 /**
 321  * @qemu_chr_fe_set_msgfds:
 322  *
 323  * For backends capable of fd passing, set an array of fds to be passed with
 324  * the next send operation.
 325  * A subsequent call to this function before calling a write function will
 326  * result in overwriting the fd array with the new value without being send.
 327  * Upon writing the message the fd array is freed.
 328  *
 329  * Returns: -1 if fd passing isn't supported or no associated Chardev.
 330  */
 331 int qemu_chr_fe_set_msgfds(CharBackend *be, int *fds, int num);
 332
 333 /**
 334  * @qemu_chr_be_can_write:
 335  *
 336  * Determine how much data the front end can currently accept.  This function
 337  * returns the number of bytes the front end can accept.  If it returns 0, the
 338  * front end cannot receive data at the moment.  The function must be polled
 339  * to determine when data can be received.
 340  *
 341  * Returns: the number of bytes the front end can receive via @qemu_chr_be_write
 342  */
 343 int qemu_chr_be_can_write(Chardev *s);
 344
 345 /**
 346  * @qemu_chr_be_write:
 347  *
 348  * Write data from the back end to the front end.  Before issuing this call,
 349  * the caller should call @qemu_chr_be_can_write to determine how much data
 350  * the front end can currently accept.
 351  *
 352  * @buf a buffer to receive data from the front end
 353  * @len the number of bytes to receive from the front end
 354  */
 355 void qemu_chr_be_write(Chardev *s, uint8_t *buf, int len);
 356
 357 /**
 358  * @qemu_chr_be_write_impl:
 359  *
 360  * Implementation of back end writing. Used by replay module.
 361  *
 362  * @buf a buffer to receive data from the front end
 363  * @len the number of bytes to receive from the front end
 364  */
 365 void qemu_chr_be_write_impl(Chardev *s, uint8_t *buf, int len);
 366
 367 /**
 368  * @qemu_chr_be_event:
 369  *
 370  * Send an event from the back end to the front end.
 371  *
 372  * @event the event to send
 373  */
 374 void qemu_chr_be_event(Chardev *s, int event);
 375
 376 /**
 377  * @qemu_chr_fe_init:
 378  *
 379  * Initializes a front end for the given CharBackend and
 380  * Chardev. Call qemu_chr_fe_deinit() to remove the association and
 381  * release the driver.
 382  *
 383  * Returns: false on error.
 384  */
 385 bool qemu_chr_fe_init(CharBackend *b, Chardev *s, Error **errp);
 386
 387 /**
 388  * @qemu_chr_fe_get_driver:
 389  *
 390  * Returns the driver associated with a CharBackend or NULL if no
 391  * associated Chardev.
 392  */
 393 Chardev *qemu_chr_fe_get_driver(CharBackend *be);
 394
 395 /**
 396  * @qemu_chr_fe_deinit:
 397  *
 398  * Dissociate the CharBackend from the Chardev.
 399  *
 400  * Safe to call without associated Chardev.
 401  */
 402 void qemu_chr_fe_deinit(CharBackend *b);
 403
 404 /**
 405  * @qemu_chr_fe_set_handlers:
 406  * @b: a CharBackend
 407  * @fd_can_read: callback to get the amount of data the frontend may
 408  *               receive
 409  * @fd_read: callback to receive data from char
 410  * @fd_event: event callback
 411  * @opaque: an opaque pointer for the callbacks
 412  * @context: a main loop context or NULL for the default
 413  * @set_open: whether to call qemu_chr_fe_set_open() implicitely when
 414  * any of the handler is non-NULL
 415  *
 416  * Set the front end char handlers. The front end takes the focus if
 417  * any of the handler is non-NULL.
 418  *
 419  * Without associated Chardev, nothing is changed.
 420  */
 421 void qemu_chr_fe_set_handlers(CharBackend *b,
 422                               IOCanReadHandler *fd_can_read,
 423                               IOReadHandler *fd_read,
 424                               IOEventHandler *fd_event,
 425                               void *opaque,
 426                               GMainContext *context,
 427                               bool set_open);
 428
 429 /**
 430  * @qemu_chr_fe_take_focus:
 431  *
 432  * Take the focus (if the front end is muxed).
 433  *
 434  * Without associated Chardev, nothing is changed.
 435  */
 436 void qemu_chr_fe_take_focus(CharBackend *b);
 437
 438 void qemu_chr_be_generic_open(Chardev *s);
 439 void qemu_chr_fe_accept_input(CharBackend *be);
 440 int qemu_chr_add_client(Chardev *s, int fd);
 441 Chardev *qemu_chr_find(const char *name);
 442
 443 bool qemu_chr_has_feature(Chardev *chr,
 444                           ChardevFeature feature);
 445 void qemu_chr_set_feature(Chardev *chr,
 446                           ChardevFeature feature);
 447 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename);
 448 int qemu_chr_write_all(Chardev *s, const uint8_t *buf, int len);
 449 int qemu_chr_wait_connected(Chardev *chr, Error **errp);
 450
 451 #define TYPE_CHARDEV "chardev"
 452 #define CHARDEV(obj) OBJECT_CHECK(Chardev, (obj), TYPE_CHARDEV)
 453 #define CHARDEV_CLASS(klass) \
 454     OBJECT_CLASS_CHECK(ChardevClass, (klass), TYPE_CHARDEV)
 455 #define CHARDEV_GET_CLASS(obj) \
 456     OBJECT_GET_CLASS(ChardevClass, (obj), TYPE_CHARDEV)
 457
 458 #define TYPE_CHARDEV_NULL "chardev-null"
 459 #define TYPE_CHARDEV_MUX "chardev-mux"
 460 #define TYPE_CHARDEV_RINGBUF "chardev-ringbuf"
 461 #define TYPE_CHARDEV_PTY "chardev-pty"
 462 #define TYPE_CHARDEV_CONSOLE "chardev-console"
 463 #define TYPE_CHARDEV_STDIO "chardev-stdio"
 464 #define TYPE_CHARDEV_PIPE "chardev-pipe"
 465 #define TYPE_CHARDEV_MEMORY "chardev-memory"
 466 #define TYPE_CHARDEV_PARALLEL "chardev-parallel"
 467 #define TYPE_CHARDEV_FILE "chardev-file"
 468 #define TYPE_CHARDEV_SERIAL "chardev-serial"
 469 #define TYPE_CHARDEV_SOCKET "chardev-socket"
 470 #define TYPE_CHARDEV_UDP "chardev-udp"
 471
 472 #define CHARDEV_IS_RINGBUF(chr) \
 473     object_dynamic_cast(OBJECT(chr), TYPE_CHARDEV_RINGBUF)
 474 #define CHARDEV_IS_PTY(chr) \
 475     object_dynamic_cast(OBJECT(chr), TYPE_CHARDEV_PTY)
 476
 477 typedef struct ChardevClass {
 478     ObjectClass parent_class;
 479
 480     bool internal; /* TODO: eventually use TYPE_USER_CREATABLE */
 481     void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp);
 482
 483     void (*open)(Chardev *chr, ChardevBackend *backend,
 484                  bool *be_opened, Error **errp);
 485
 486     int (*chr_write)(Chardev *s, const uint8_t *buf, int len);
 487     int (*chr_sync_read)(Chardev *s, const uint8_t *buf, int len);
 488     GSource *(*chr_add_watch)(Chardev *s, GIOCondition cond);
 489     void (*chr_update_read_handler)(Chardev *s, GMainContext *context);
 490     int (*chr_ioctl)(Chardev *s, int cmd, void *arg);
 491     int (*get_msgfds)(Chardev *s, int* fds, int num);
 492     int (*set_msgfds)(Chardev *s, int *fds, int num);
 493     int (*chr_add_client)(Chardev *chr, int fd);
 494     int (*chr_wait_connected)(Chardev *chr, Error **errp);
 495     void (*chr_disconnect)(Chardev *chr);
 496     void (*chr_accept_input)(Chardev *chr);
 497     void (*chr_set_echo)(Chardev *chr, bool echo);
 498     void (*chr_set_fe_open)(Chardev *chr, int fe_open);
 499 } ChardevClass;
 500
 501 Chardev *qemu_chardev_new(const char *id, const char *typename,
 502                           ChardevBackend *backend, Error **errp);
 503
 504 extern int term_escape_char;
 505
 506 /* console.c */
 507 void qemu_chr_parse_vc(QemuOpts *opts, ChardevBackend *backend, Error **errp);
 508
 509 #endif