chardev/char.c

   1 /*
   2  * QEMU System Emulator
   3  *
   4  * Copyright (c) 2003-2008 Fabrice Bellard
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 #include "qemu/osdep.h"
  26 #include "qemu/cutils.h"
  27 #include "monitor/monitor.h"
  28 #include "sysemu/sysemu.h"
  29 #include "qemu/config-file.h"
  30 #include "qemu/error-report.h"
  31 #include "qemu/qemu-print.h"
  32 #include "chardev/char.h"
  33 #include "qapi/error.h"
  34 #include "qapi/qapi-commands-char.h"
  35 #include "qapi/qmp/qerror.h"
  36 #include "sysemu/replay.h"
  37 #include "qemu/help_option.h"
  38 #include "qemu/module.h"
  39 #include "qemu/option.h"
  40 #include "qemu/id.h"
  41 #include "qemu/coroutine.h"
  42
  43 #include "chardev/char-mux.h"
  44
  45 /***********************************************************/
  46 /* character device */
  47
  48 static Object *get_chardevs_root(void)
  49 {
  50     return container_get(object_get_root(), "/chardevs");
  51 }
  52
  53 static void chr_be_event(Chardev *s, QEMUChrEvent event)
  54 {
  55     CharBackend *be = s->be;
  56
  57     if (!be || !be->chr_event) {
  58         return;
  59     }
  60
  61     be->chr_event(be->opaque, event);
  62 }
  63
  64 void qemu_chr_be_event(Chardev *s, QEMUChrEvent event)
  65 {
  66     /* Keep track if the char device is open */
  67     switch (event) {
  68         case CHR_EVENT_OPENED:
  69             s->be_open = 1;
  70             break;
  71         case CHR_EVENT_CLOSED:
  72             s->be_open = 0;
  73             break;
  74     case CHR_EVENT_BREAK:
  75     case CHR_EVENT_MUX_IN:
  76     case CHR_EVENT_MUX_OUT:
  77         /* Ignore */
  78         break;
  79     }
  80
  81     CHARDEV_GET_CLASS(s)->chr_be_event(s, event);
  82 }
  83
  84 /* Not reporting errors from writing to logfile, as logs are
  85  * defined to be "best effort" only */
  86 static void qemu_chr_write_log(Chardev *s, const uint8_t *buf, size_t len)
  87 {
  88     size_t done = 0;
  89     ssize_t ret;
  90
  91     if (s->logfd < 0) {
  92         return;
  93     }
  94
  95     while (done < len) {
  96     retry:
  97         ret = write(s->logfd, buf + done, len - done);
  98         if (ret == -1 && errno == EAGAIN) {
  99             g_usleep(100);
 100             goto retry;
 101         }
 102
 103         if (ret <= 0) {
 104             return;
 105         }
 106         done += ret;
 107     }
 108 }
 109
 110 static int qemu_chr_write_buffer(Chardev *s,
 111                                  const uint8_t *buf, int len,
 112                                  int *offset, bool write_all)
 113 {
 114     ChardevClass *cc = CHARDEV_GET_CLASS(s);
 115     int res = 0;
 116     *offset = 0;
 117
 118     qemu_mutex_lock(&s->chr_write_lock);
 119     while (*offset < len) {
 120     retry:
 121         res = cc->chr_write(s, buf + *offset, len - *offset);
 122         if (res < 0 && errno == EAGAIN && write_all) {
 123             if (qemu_in_coroutine()) {
 124                 qemu_co_sleep_ns(QEMU_CLOCK_REALTIME, 100000);
 125             } else {
 126                 g_usleep(100);
 127             }
 128             goto retry;
 129         }
 130
 131         if (res <= 0) {
 132             break;
 133         }
 134
 135         *offset += res;
 136         if (!write_all) {
 137             break;
 138         }
 139     }
 140     if (*offset > 0) {
 141         qemu_chr_write_log(s, buf, *offset);
 142     }
 143     qemu_mutex_unlock(&s->chr_write_lock);
 144
 145     return res;
 146 }
 147
 148 int qemu_chr_write(Chardev *s, const uint8_t *buf, int len, bool write_all)
 149 {
 150     int offset = 0;
 151     int res;
 152
 153     if (qemu_chr_replay(s) && replay_mode == REPLAY_MODE_PLAY) {
 154         replay_char_write_event_load(&res, &offset);
 155         assert(offset <= len);
 156         qemu_chr_write_buffer(s, buf, offset, &offset, true);
 157         return res;
 158     }
 159
 160     res = qemu_chr_write_buffer(s, buf, len, &offset, write_all);
 161
 162     if (qemu_chr_replay(s) && replay_mode == REPLAY_MODE_RECORD) {
 163         replay_char_write_event_save(res, offset);
 164     }
 165
 166     if (res < 0) {
 167         return res;
 168     }
 169     return offset;
 170 }
 171
 172 int qemu_chr_be_can_write(Chardev *s)
 173 {
 174     CharBackend *be = s->be;
 175
 176     if (!be || !be->chr_can_read) {
 177         return 0;
 178     }
 179
 180     return be->chr_can_read(be->opaque);
 181 }
 182
 183 void qemu_chr_be_write_impl(Chardev *s, uint8_t *buf, int len)
 184 {
 185     CharBackend *be = s->be;
 186
 187     if (be && be->chr_read) {
 188         be->chr_read(be->opaque, buf, len);
 189     }
 190 }
 191
 192 void qemu_chr_be_write(Chardev *s, uint8_t *buf, int len)
 193 {
 194     if (qemu_chr_replay(s)) {
 195         if (replay_mode == REPLAY_MODE_PLAY) {
 196             return;
 197         }
 198         replay_chr_be_write(s, buf, len);
 199     } else {
 200         qemu_chr_be_write_impl(s, buf, len);
 201     }
 202 }
 203
 204 void qemu_chr_be_update_read_handlers(Chardev *s,
 205                                       GMainContext *context)
 206 {
 207     ChardevClass *cc = CHARDEV_GET_CLASS(s);
 208
 209     assert(qemu_chr_has_feature(s, QEMU_CHAR_FEATURE_GCONTEXT)
 210            || !context);
 211     s->gcontext = context;
 212     if (cc->chr_update_read_handler) {
 213         cc->chr_update_read_handler(s);
 214     }
 215 }
 216
 217 int qemu_chr_add_client(Chardev *s, int fd)
 218 {
 219     return CHARDEV_GET_CLASS(s)->chr_add_client ?
 220         CHARDEV_GET_CLASS(s)->chr_add_client(s, fd) : -1;
 221 }
 222
 223 static void qemu_char_open(Chardev *chr, ChardevBackend *backend,
 224                            bool *be_opened, Error **errp)
 225 {
 226     ChardevClass *cc = CHARDEV_GET_CLASS(chr);
 227     /* Any ChardevCommon member would work */
 228     ChardevCommon *common = backend ? backend->u.null.data : NULL;
 229
 230     if (common && common->has_logfile) {
 231         int flags = O_WRONLY | O_CREAT;
 232         if (common->has_logappend &&
 233             common->logappend) {
 234             flags |= O_APPEND;
 235         } else {
 236             flags |= O_TRUNC;
 237         }
 238         chr->logfd = qemu_open(common->logfile, flags, 0666);
 239         if (chr->logfd < 0) {
 240             error_setg_errno(errp, errno,
 241                              "Unable to open logfile %s",
 242                              common->logfile);
 243             return;
 244         }
 245     }
 246
 247     if (cc->open) {
 248         cc->open(chr, backend, be_opened, errp);
 249     }
 250 }
 251
 252 static void char_init(Object *obj)
 253 {
 254     Chardev *chr = CHARDEV(obj);
 255
 256     chr->logfd = -1;
 257     qemu_mutex_init(&chr->chr_write_lock);
 258
 259     /*
 260      * Assume if chr_update_read_handler is implemented it will
 261      * take the updated gcontext into account.
 262      */
 263     if (CHARDEV_GET_CLASS(chr)->chr_update_read_handler) {
 264         qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_GCONTEXT);
 265     }
 266
 267 }
 268
 269 static int null_chr_write(Chardev *chr, const uint8_t *buf, int len)
 270 {
 271     return len;
 272 }
 273
 274 static void char_class_init(ObjectClass *oc, void *data)
 275 {
 276     ChardevClass *cc = CHARDEV_CLASS(oc);
 277
 278     cc->chr_write = null_chr_write;
 279     cc->chr_be_event = chr_be_event;
 280 }
 281
 282 static void char_finalize(Object *obj)
 283 {
 284     Chardev *chr = CHARDEV(obj);
 285
 286     if (chr->be) {
 287         chr->be->chr = NULL;
 288     }
 289     g_free(chr->filename);
 290     g_free(chr->label);
 291     if (chr->logfd != -1) {
 292         close(chr->logfd);
 293     }
 294     qemu_mutex_destroy(&chr->chr_write_lock);
 295 }
 296
 297 static const TypeInfo char_type_info = {
 298     .name = TYPE_CHARDEV,
 299     .parent = TYPE_OBJECT,
 300     .instance_size = sizeof(Chardev),
 301     .instance_init = char_init,
 302     .instance_finalize = char_finalize,
 303     .abstract = true,
 304     .class_size = sizeof(ChardevClass),
 305     .class_init = char_class_init,
 306 };
 307
 308 static int chardev_machine_done_notify_one(Object *child, void *opaque)
 309 {
 310     Chardev *chr = (Chardev *)child;
 311     ChardevClass *class = CHARDEV_GET_CLASS(chr);
 312
 313     if (class->chr_machine_done) {
 314         return class->chr_machine_done(chr);
 315     }
 316
 317     return 0;
 318 }
 319
 320 static void chardev_machine_done_hook(Notifier *notifier, void *unused)
 321 {
 322     int ret = object_child_foreach(get_chardevs_root(),
 323                                    chardev_machine_done_notify_one, NULL);
 324
 325     if (ret) {
 326         error_report("Failed to call chardev machine_done hooks");
 327         exit(1);
 328     }
 329 }
 330
 331 static Notifier chardev_machine_done_notify = {
 332     .notify = chardev_machine_done_hook,
 333 };
 334
 335 static bool qemu_chr_is_busy(Chardev *s)
 336 {
 337     if (CHARDEV_IS_MUX(s)) {
 338         MuxChardev *d = MUX_CHARDEV(s);
 339         return d->mux_cnt >= 0;
 340     } else {
 341         return s->be != NULL;
 342     }
 343 }
 344
 345 int qemu_chr_wait_connected(Chardev *chr, Error **errp)
 346 {
 347     ChardevClass *cc = CHARDEV_GET_CLASS(chr);
 348
 349     if (cc->chr_wait_connected) {
 350         return cc->chr_wait_connected(chr, errp);
 351     }
 352
 353     return 0;
 354 }
 355
 356 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename,
 357                                 bool permit_mux_mon)
 358 {
 359     char host[65], port[33], width[8], height[8];
 360     int pos;
 361     const char *p;
 362     QemuOpts *opts;
 363     Error *local_err = NULL;
 364
 365     opts = qemu_opts_create(qemu_find_opts("chardev"), label, 1, &local_err);
 366     if (local_err) {
 367         error_report_err(local_err);
 368         return NULL;
 369     }
 370
 371     if (strstart(filename, "mon:", &p)) {
 372         if (!permit_mux_mon) {
 373             error_report("mon: isn't supported in this context");
 374             return NULL;
 375         }
 376         filename = p;
 377         qemu_opt_set(opts, "mux", "on", &error_abort);
 378         if (strcmp(filename, "stdio") == 0) {
 379             /* Monitor is muxed to stdio: do not exit on Ctrl+C by default
 380              * but pass it to the guest.  Handle this only for compat syntax,
 381              * for -chardev syntax we have special option for this.
 382              * This is what -nographic did, redirecting+muxing serial+monitor
 383              * to stdio causing Ctrl+C to be passed to guest. */
 384             qemu_opt_set(opts, "signal", "off", &error_abort);
 385         }
 386     }
 387
 388     if (strcmp(filename, "null")    == 0 ||
 389         strcmp(filename, "pty")     == 0 ||
 390         strcmp(filename, "msmouse") == 0 ||
 391         strcmp(filename, "wctablet") == 0 ||
 392         strcmp(filename, "braille") == 0 ||
 393         strcmp(filename, "testdev") == 0 ||
 394         strcmp(filename, "stdio")   == 0) {
 395         qemu_opt_set(opts, "backend", filename, &error_abort);
 396         return opts;
 397     }
 398     if (strstart(filename, "vc", &p)) {
 399         qemu_opt_set(opts, "backend", "vc", &error_abort);
 400         if (*p == ':') {
 401             if (sscanf(p+1, "%7[0-9]x%7[0-9]", width, height) == 2) {
 402                 /* pixels */
 403                 qemu_opt_set(opts, "width", width, &error_abort);
 404                 qemu_opt_set(opts, "height", height, &error_abort);
 405             } else if (sscanf(p+1, "%7[0-9]Cx%7[0-9]C", width, height) == 2) {
 406                 /* chars */
 407                 qemu_opt_set(opts, "cols", width, &error_abort);
 408                 qemu_opt_set(opts, "rows", height, &error_abort);
 409             } else {
 410                 goto fail;
 411             }
 412         }
 413         return opts;
 414     }
 415     if (strcmp(filename, "con:") == 0) {
 416         qemu_opt_set(opts, "backend", "console", &error_abort);
 417         return opts;
 418     }
 419     if (strstart(filename, "COM", NULL)) {
 420         qemu_opt_set(opts, "backend", "serial", &error_abort);
 421         qemu_opt_set(opts, "path", filename, &error_abort);
 422         return opts;
 423     }
 424     if (strstart(filename, "file:", &p)) {
 425         qemu_opt_set(opts, "backend", "file", &error_abort);
 426         qemu_opt_set(opts, "path", p, &error_abort);
 427         return opts;
 428     }
 429     if (strstart(filename, "pipe:", &p)) {
 430         qemu_opt_set(opts, "backend", "pipe", &error_abort);
 431         qemu_opt_set(opts, "path", p, &error_abort);
 432         return opts;
 433     }
 434     if (strstart(filename, "tcp:", &p) ||
 435         strstart(filename, "telnet:", &p) ||
 436         strstart(filename, "tn3270:", &p) ||
 437         strstart(filename, "websocket:", &p)) {
 438         if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
 439             host[0] = 0;
 440             if (sscanf(p, ":%32[^,]%n", port, &pos) < 1)
 441                 goto fail;
 442         }
 443         qemu_opt_set(opts, "backend", "socket", &error_abort);
 444         qemu_opt_set(opts, "host", host, &error_abort);
 445         qemu_opt_set(opts, "port", port, &error_abort);
 446         if (p[pos] == ',') {
 447             if (!qemu_opts_do_parse(opts, p + pos + 1, NULL, &local_err)) {
 448                 error_report_err(local_err);
 449                 goto fail;
 450             }
 451         }
 452         if (strstart(filename, "telnet:", &p)) {
 453             qemu_opt_set(opts, "telnet", "on", &error_abort);
 454         } else if (strstart(filename, "tn3270:", &p)) {
 455             qemu_opt_set(opts, "tn3270", "on", &error_abort);
 456         } else if (strstart(filename, "websocket:", &p)) {
 457             qemu_opt_set(opts, "websocket", "on", &error_abort);
 458         }
 459         return opts;
 460     }
 461     if (strstart(filename, "udp:", &p)) {
 462         qemu_opt_set(opts, "backend", "udp", &error_abort);
 463         if (sscanf(p, "%64[^:]:%32[^@,]%n", host, port, &pos) < 2) {
 464             host[0] = 0;
 465             if (sscanf(p, ":%32[^@,]%n", port, &pos) < 1) {
 466                 goto fail;
 467             }
 468         }
 469         qemu_opt_set(opts, "host", host, &error_abort);
 470         qemu_opt_set(opts, "port", port, &error_abort);
 471         if (p[pos] == '@') {
 472             p += pos + 1;
 473             if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
 474                 host[0] = 0;
 475                 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1) {
 476                     goto fail;
 477                 }
 478             }
 479             qemu_opt_set(opts, "localaddr", host, &error_abort);
 480             qemu_opt_set(opts, "localport", port, &error_abort);
 481         }
 482         return opts;
 483     }
 484     if (strstart(filename, "unix:", &p)) {
 485         qemu_opt_set(opts, "backend", "socket", &error_abort);
 486         if (!qemu_opts_do_parse(opts, p, "path", &local_err)) {
 487             error_report_err(local_err);
 488             goto fail;
 489         }
 490         return opts;
 491     }
 492     if (strstart(filename, "/dev/parport", NULL) ||
 493         strstart(filename, "/dev/ppi", NULL)) {
 494         qemu_opt_set(opts, "backend", "parallel", &error_abort);
 495         qemu_opt_set(opts, "path", filename, &error_abort);
 496         return opts;
 497     }
 498     if (strstart(filename, "/dev/", NULL)) {
 499         qemu_opt_set(opts, "backend", "serial", &error_abort);
 500         qemu_opt_set(opts, "path", filename, &error_abort);
 501         return opts;
 502     }
 503
 504     error_report("'%s' is not a valid char driver", filename);
 505
 506 fail:
 507     qemu_opts_del(opts);
 508     return NULL;
 509 }
 510
 511 void qemu_chr_parse_common(QemuOpts *opts, ChardevCommon *backend)
 512 {
 513     const char *logfile = qemu_opt_get(opts, "logfile");
 514
 515     backend->has_logfile = logfile != NULL;
 516     backend->logfile = g_strdup(logfile);
 517
 518     backend->has_logappend = true;
 519     backend->logappend = qemu_opt_get_bool(opts, "logappend", false);
 520 }
 521
 522 static const ChardevClass *char_get_class(const char *driver, Error **errp)
 523 {
 524     ObjectClass *oc;
 525     const ChardevClass *cc;
 526     char *typename = g_strdup_printf("chardev-%s", driver);
 527
 528     oc = module_object_class_by_name(typename);
 529     g_free(typename);
 530
 531     if (!object_class_dynamic_cast(oc, TYPE_CHARDEV)) {
 532         error_setg(errp, "'%s' is not a valid char driver name", driver);
 533         return NULL;
 534     }
 535
 536     if (object_class_is_abstract(oc)) {
 537         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
 538                    "abstract device type");
 539         return NULL;
 540     }
 541
 542     cc = CHARDEV_CLASS(oc);
 543     if (cc->internal) {
 544         error_setg(errp, "'%s' is not a valid char driver name", driver);
 545         return NULL;
 546     }
 547
 548     return cc;
 549 }
 550
 551 static const struct ChardevAlias {
 552     const char *typename;
 553     const char *alias;
 554 } chardev_alias_table[] = {
 555 #ifdef HAVE_CHARDEV_PARPORT
 556     { "parallel", "parport" },
 557 #endif
 558 #ifdef HAVE_CHARDEV_SERIAL
 559     { "serial", "tty" },
 560 #endif
 561 };
 562
 563 typedef struct ChadevClassFE {
 564     void (*fn)(const char *name, void *opaque);
 565     void *opaque;
 566 } ChadevClassFE;
 567
 568 static void
 569 chardev_class_foreach(ObjectClass *klass, void *opaque)
 570 {
 571     ChadevClassFE *fe = opaque;
 572
 573     assert(g_str_has_prefix(object_class_get_name(klass), "chardev-"));
 574     if (CHARDEV_CLASS(klass)->internal) {
 575         return;
 576     }
 577
 578     fe->fn(object_class_get_name(klass) + 8, fe->opaque);
 579 }
 580
 581 static void
 582 chardev_name_foreach(void (*fn)(const char *name, void *opaque), void *opaque)
 583 {
 584     ChadevClassFE fe = { .fn = fn, .opaque = opaque };
 585     int i;
 586
 587     object_class_foreach(chardev_class_foreach, TYPE_CHARDEV, false, &fe);
 588
 589     for (i = 0; i < (int)ARRAY_SIZE(chardev_alias_table); i++) {
 590         fn(chardev_alias_table[i].alias, opaque);
 591     }
 592 }
 593
 594 static void
 595 help_string_append(const char *name, void *opaque)
 596 {
 597     GString *str = opaque;
 598
 599     g_string_append_printf(str, "\n  %s", name);
 600 }
 601
 602 static const char *chardev_alias_translate(const char *name)
 603 {
 604     int i;
 605     for (i = 0; i < (int)ARRAY_SIZE(chardev_alias_table); i++) {
 606         if (g_strcmp0(chardev_alias_table[i].alias, name) == 0) {
 607             return chardev_alias_table[i].typename;
 608         }
 609     }
 610     return name;
 611 }
 612
 613 ChardevBackend *qemu_chr_parse_opts(QemuOpts *opts, Error **errp)
 614 {
 615     Error *local_err = NULL;
 616     const ChardevClass *cc;
 617     ChardevBackend *backend = NULL;
 618     const char *name = chardev_alias_translate(qemu_opt_get(opts, "backend"));
 619
 620     if (name == NULL) {
 621         error_setg(errp, "chardev: \"%s\" missing backend",
 622                    qemu_opts_id(opts));
 623         return NULL;
 624     }
 625
 626     cc = char_get_class(name, errp);
 627     if (cc == NULL) {
 628         return NULL;
 629     }
 630
 631     backend = g_new0(ChardevBackend, 1);
 632     backend->type = CHARDEV_BACKEND_KIND_NULL;
 633
 634     if (cc->parse) {
 635         cc->parse(opts, backend, &local_err);
 636         if (local_err) {
 637             error_propagate(errp, local_err);
 638             qapi_free_ChardevBackend(backend);
 639             return NULL;
 640         }
 641     } else {
 642         ChardevCommon *ccom = g_new0(ChardevCommon, 1);
 643         qemu_chr_parse_common(opts, ccom);
 644         backend->u.null.data = ccom; /* Any ChardevCommon member would work */
 645     }
 646
 647     return backend;
 648 }
 649
 650 Chardev *qemu_chr_new_from_opts(QemuOpts *opts, GMainContext *context,
 651                                 Error **errp)
 652 {
 653     const ChardevClass *cc;
 654     Chardev *chr = NULL;
 655     ChardevBackend *backend = NULL;
 656     const char *name = chardev_alias_translate(qemu_opt_get(opts, "backend"));
 657     const char *id = qemu_opts_id(opts);
 658     char *bid = NULL;
 659
 660     if (name && is_help_option(name)) {
 661         GString *str = g_string_new("");
 662
 663         chardev_name_foreach(help_string_append, str);
 664
 665         qemu_printf("Available chardev backend types: %s\n", str->str);
 666         g_string_free(str, true);
 667         return NULL;
 668     }
 669
 670     if (id == NULL) {
 671         error_setg(errp, "chardev: no id specified");
 672         return NULL;
 673     }
 674
 675     backend = qemu_chr_parse_opts(opts, errp);
 676     if (backend == NULL) {
 677         return NULL;
 678     }
 679
 680     cc = char_get_class(name, errp);
 681     if (cc == NULL) {
 682         goto out;
 683     }
 684
 685     if (qemu_opt_get_bool(opts, "mux", 0)) {
 686         bid = g_strdup_printf("%s-base", id);
 687     }
 688
 689     chr = qemu_chardev_new(bid ? bid : id,
 690                            object_class_get_name(OBJECT_CLASS(cc)),
 691                            backend, context, errp);
 692
 693     if (chr == NULL) {
 694         goto out;
 695     }
 696
 697     if (bid) {
 698         Chardev *mux;
 699         qapi_free_ChardevBackend(backend);
 700         backend = g_new0(ChardevBackend, 1);
 701         backend->type = CHARDEV_BACKEND_KIND_MUX;
 702         backend->u.mux.data = g_new0(ChardevMux, 1);
 703         backend->u.mux.data->chardev = g_strdup(bid);
 704         mux = qemu_chardev_new(id, TYPE_CHARDEV_MUX, backend, context, errp);
 705         if (mux == NULL) {
 706             object_unparent(OBJECT(chr));
 707             chr = NULL;
 708             goto out;
 709         }
 710         chr = mux;
 711     }
 712
 713 out:
 714     qapi_free_ChardevBackend(backend);
 715     g_free(bid);
 716     return chr;
 717 }
 718
 719 Chardev *qemu_chr_new_noreplay(const char *label, const char *filename,
 720                                bool permit_mux_mon, GMainContext *context)
 721 {
 722     const char *p;
 723     Chardev *chr;
 724     QemuOpts *opts;
 725     Error *err = NULL;
 726
 727     if (strstart(filename, "chardev:", &p)) {
 728         return qemu_chr_find(p);
 729     }
 730
 731     opts = qemu_chr_parse_compat(label, filename, permit_mux_mon);
 732     if (!opts)
 733         return NULL;
 734
 735     chr = qemu_chr_new_from_opts(opts, context, &err);
 736     if (!chr) {
 737         error_report_err(err);
 738         goto out;
 739     }
 740
 741     if (qemu_opt_get_bool(opts, "mux", 0)) {
 742         assert(permit_mux_mon);
 743         monitor_init_hmp(chr, true, &err);
 744         if (err) {
 745             error_report_err(err);
 746             object_unparent(OBJECT(chr));
 747             chr = NULL;
 748             goto out;
 749         }
 750     }
 751
 752 out:
 753     qemu_opts_del(opts);
 754     return chr;
 755 }
 756
 757 static Chardev *qemu_chr_new_permit_mux_mon(const char *label,
 758                                           const char *filename,
 759                                           bool permit_mux_mon,
 760                                           GMainContext *context)
 761 {
 762     Chardev *chr;
 763     chr = qemu_chr_new_noreplay(label, filename, permit_mux_mon, context);
 764     if (chr) {
 765         if (replay_mode != REPLAY_MODE_NONE) {
 766             qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_REPLAY);
 767         }
 768         if (qemu_chr_replay(chr) && CHARDEV_GET_CLASS(chr)->chr_ioctl) {
 769             error_report("Replay: ioctl is not supported "
 770                          "for serial devices yet");
 771         }
 772         replay_register_char_driver(chr);
 773     }
 774     return chr;
 775 }
 776
 777 Chardev *qemu_chr_new(const char *label, const char *filename,
 778                       GMainContext *context)
 779 {
 780     return qemu_chr_new_permit_mux_mon(label, filename, false, context);
 781 }
 782
 783 Chardev *qemu_chr_new_mux_mon(const char *label, const char *filename,
 784                               GMainContext *context)
 785 {
 786     return qemu_chr_new_permit_mux_mon(label, filename, true, context);
 787 }
 788
 789 static int qmp_query_chardev_foreach(Object *obj, void *data)
 790 {
 791     Chardev *chr = CHARDEV(obj);
 792     ChardevInfoList **list = data;
 793     ChardevInfoList *info = g_malloc0(sizeof(*info));
 794
 795     info->value = g_malloc0(sizeof(*info->value));
 796     info->value->label = g_strdup(chr->label);
 797     info->value->filename = g_strdup(chr->filename);
 798     info->value->frontend_open = chr->be && chr->be->fe_open;
 799
 800     info->next = *list;
 801     *list = info;
 802
 803     return 0;
 804 }
 805
 806 ChardevInfoList *qmp_query_chardev(Error **errp)
 807 {
 808     ChardevInfoList *chr_list = NULL;
 809
 810     object_child_foreach(get_chardevs_root(),
 811                          qmp_query_chardev_foreach, &chr_list);
 812
 813     return chr_list;
 814 }
 815
 816 static void
 817 qmp_prepend_backend(const char *name, void *opaque)
 818 {
 819     ChardevBackendInfoList **list = opaque;
 820     ChardevBackendInfoList *info = g_malloc0(sizeof(*info));
 821
 822     info->value = g_malloc0(sizeof(*info->value));
 823     info->value->name = g_strdup(name);
 824     info->next = *list;
 825     *list = info;
 826 }
 827
 828 ChardevBackendInfoList *qmp_query_chardev_backends(Error **errp)
 829 {
 830     ChardevBackendInfoList *backend_list = NULL;
 831
 832     chardev_name_foreach(qmp_prepend_backend, &backend_list);
 833
 834     return backend_list;
 835 }
 836
 837 Chardev *qemu_chr_find(const char *name)
 838 {
 839     Object *obj = object_resolve_path_component(get_chardevs_root(), name);
 840
 841     return obj ? CHARDEV(obj) : NULL;
 842 }
 843
 844 QemuOptsList qemu_chardev_opts = {
 845     .name = "chardev",
 846     .implied_opt_name = "backend",
 847     .head = QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts.head),
 848     .desc = {
 849         {
 850             .name = "backend",
 851             .type = QEMU_OPT_STRING,
 852         },{
 853             .name = "path",
 854             .type = QEMU_OPT_STRING,
 855         },{
 856             .name = "host",
 857             .type = QEMU_OPT_STRING,
 858         },{
 859             .name = "port",
 860             .type = QEMU_OPT_STRING,
 861         },{
 862             .name = "fd",
 863             .type = QEMU_OPT_STRING,
 864         },{
 865             .name = "localaddr",
 866             .type = QEMU_OPT_STRING,
 867         },{
 868             .name = "localport",
 869             .type = QEMU_OPT_STRING,
 870         },{
 871             .name = "to",
 872             .type = QEMU_OPT_NUMBER,
 873         },{
 874             .name = "ipv4",
 875             .type = QEMU_OPT_BOOL,
 876         },{
 877             .name = "ipv6",
 878             .type = QEMU_OPT_BOOL,
 879         },{
 880             .name = "wait",
 881             .type = QEMU_OPT_BOOL,
 882         },{
 883             .name = "server",
 884             .type = QEMU_OPT_BOOL,
 885         },{
 886             .name = "delay",
 887             .type = QEMU_OPT_BOOL,
 888         },{
 889             .name = "reconnect",
 890             .type = QEMU_OPT_NUMBER,
 891         },{
 892             .name = "telnet",
 893             .type = QEMU_OPT_BOOL,
 894         },{
 895             .name = "tn3270",
 896             .type = QEMU_OPT_BOOL,
 897         },{
 898             .name = "tls-creds",
 899             .type = QEMU_OPT_STRING,
 900         },{
 901             .name = "tls-authz",
 902             .type = QEMU_OPT_STRING,
 903         },{
 904             .name = "websocket",
 905             .type = QEMU_OPT_BOOL,
 906         },{
 907             .name = "width",
 908             .type = QEMU_OPT_NUMBER,
 909         },{
 910             .name = "height",
 911             .type = QEMU_OPT_NUMBER,
 912         },{
 913             .name = "cols",
 914             .type = QEMU_OPT_NUMBER,
 915         },{
 916             .name = "rows",
 917             .type = QEMU_OPT_NUMBER,
 918         },{
 919             .name = "mux",
 920             .type = QEMU_OPT_BOOL,
 921         },{
 922             .name = "signal",
 923             .type = QEMU_OPT_BOOL,
 924         },{
 925             .name = "name",
 926             .type = QEMU_OPT_STRING,
 927         },{
 928             .name = "debug",
 929             .type = QEMU_OPT_NUMBER,
 930         },{
 931             .name = "size",
 932             .type = QEMU_OPT_SIZE,
 933         },{
 934             .name = "chardev",
 935             .type = QEMU_OPT_STRING,
 936         },{
 937             .name = "append",
 938             .type = QEMU_OPT_BOOL,
 939         },{
 940             .name = "logfile",
 941             .type = QEMU_OPT_STRING,
 942         },{
 943             .name = "logappend",
 944             .type = QEMU_OPT_BOOL,
 945         },{
 946             .name = "tight",
 947             .type = QEMU_OPT_BOOL,
 948             .def_value_str = "on",
 949         },{
 950             .name = "abstract",
 951             .type = QEMU_OPT_BOOL,
 952         },
 953         { /* end of list */ }
 954     },
 955 };
 956
 957 bool qemu_chr_has_feature(Chardev *chr,
 958                           ChardevFeature feature)
 959 {
 960     return test_bit(feature, chr->features);
 961 }
 962
 963 void qemu_chr_set_feature(Chardev *chr,
 964                            ChardevFeature feature)
 965 {
 966     return set_bit(feature, chr->features);
 967 }
 968
 969 static Chardev *chardev_new(const char *id, const char *typename,
 970                             ChardevBackend *backend,
 971                             GMainContext *gcontext,
 972                             Error **errp)
 973 {
 974     Object *obj;
 975     Chardev *chr = NULL;
 976     Error *local_err = NULL;
 977     bool be_opened = true;
 978
 979     assert(g_str_has_prefix(typename, "chardev-"));
 980
 981     obj = object_new(typename);
 982     chr = CHARDEV(obj);
 983     chr->label = g_strdup(id);
 984     chr->gcontext = gcontext;
 985
 986     qemu_char_open(chr, backend, &be_opened, &local_err);
 987     if (local_err) {
 988         goto end;
 989     }
 990
 991     if (!chr->filename) {
 992         chr->filename = g_strdup(typename + 8);
 993     }
 994     if (be_opened) {
 995         qemu_chr_be_event(chr, CHR_EVENT_OPENED);
 996     }
 997
 998     if (id) {
 999         object_property_add_child(get_chardevs_root(), id, obj);
1000         object_unref(obj);
1001     }
1002
1003 end:
1004     if (local_err) {
1005         error_propagate(errp, local_err);
1006         object_unref(obj);
1007         return NULL;
1008     }
1009
1010     return chr;
1011 }
1012
1013 Chardev *qemu_chardev_new(const char *id, const char *typename,
1014                           ChardevBackend *backend,
1015                           GMainContext *gcontext,
1016                           Error **errp)
1017 {
1018     g_autofree char *genid = NULL;
1019
1020     if (!id) {
1021         genid = id_generate(ID_CHR);
1022         id = genid;
1023     }
1024
1025     return chardev_new(id, typename, backend, gcontext, errp);
1026 }
1027
1028 ChardevReturn *qmp_chardev_add(const char *id, ChardevBackend *backend,
1029                                Error **errp)
1030 {
1031     const ChardevClass *cc;
1032     ChardevReturn *ret;
1033     Chardev *chr;
1034
1035     cc = char_get_class(ChardevBackendKind_str(backend->type), errp);
1036     if (!cc) {
1037         return NULL;
1038     }
1039
1040     chr = chardev_new(id, object_class_get_name(OBJECT_CLASS(cc)),
1041                       backend, NULL, errp);
1042     if (!chr) {
1043         return NULL;
1044     }
1045
1046     ret = g_new0(ChardevReturn, 1);
1047     if (CHARDEV_IS_PTY(chr)) {
1048         ret->pty = g_strdup(chr->filename + 4);
1049         ret->has_pty = true;
1050     }
1051
1052     return ret;
1053 }
1054
1055 ChardevReturn *qmp_chardev_change(const char *id, ChardevBackend *backend,
1056                                   Error **errp)
1057 {
1058     CharBackend *be;
1059     const ChardevClass *cc;
1060     Chardev *chr, *chr_new;
1061     bool closed_sent = false;
1062     ChardevReturn *ret;
1063
1064     chr = qemu_chr_find(id);
1065     if (!chr) {
1066         error_setg(errp, "Chardev '%s' does not exist", id);
1067         return NULL;
1068     }
1069
1070     if (CHARDEV_IS_MUX(chr)) {
1071         error_setg(errp, "Mux device hotswap not supported yet");
1072         return NULL;
1073     }
1074
1075     if (qemu_chr_replay(chr)) {
1076         error_setg(errp,
1077             "Chardev '%s' cannot be changed in record/replay mode", id);
1078         return NULL;
1079     }
1080
1081     be = chr->be;
1082     if (!be) {
1083         /* easy case */
1084         object_unparent(OBJECT(chr));
1085         return qmp_chardev_add(id, backend, errp);
1086     }
1087
1088     if (!be->chr_be_change) {
1089         error_setg(errp, "Chardev user does not support chardev hotswap");
1090         return NULL;
1091     }
1092
1093     cc = char_get_class(ChardevBackendKind_str(backend->type), errp);
1094     if (!cc) {
1095         return NULL;
1096     }
1097
1098     chr_new = chardev_new(NULL, object_class_get_name(OBJECT_CLASS(cc)),
1099                           backend, chr->gcontext, errp);
1100     if (!chr_new) {
1101         return NULL;
1102     }
1103     chr_new->label = g_strdup(id);
1104
1105     if (chr->be_open && !chr_new->be_open) {
1106         qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1107         closed_sent = true;
1108     }
1109
1110     chr->be = NULL;
1111     qemu_chr_fe_init(be, chr_new, &error_abort);
1112
1113     if (be->chr_be_change(be->opaque) < 0) {
1114         error_setg(errp, "Chardev '%s' change failed", chr_new->label);
1115         chr_new->be = NULL;
1116         qemu_chr_fe_init(be, chr, &error_abort);
1117         if (closed_sent) {
1118             qemu_chr_be_event(chr, CHR_EVENT_OPENED);
1119         }
1120         object_unref(OBJECT(chr_new));
1121         return NULL;
1122     }
1123
1124     object_unparent(OBJECT(chr));
1125     object_property_add_child(get_chardevs_root(), chr_new->label,
1126                               OBJECT(chr_new));
1127     object_unref(OBJECT(chr_new));
1128
1129     ret = g_new0(ChardevReturn, 1);
1130     if (CHARDEV_IS_PTY(chr_new)) {
1131         ret->pty = g_strdup(chr_new->filename + 4);
1132         ret->has_pty = true;
1133     }
1134
1135     return ret;
1136 }
1137
1138 void qmp_chardev_remove(const char *id, Error **errp)
1139 {
1140     Chardev *chr;
1141
1142     chr = qemu_chr_find(id);
1143     if (chr == NULL) {
1144         error_setg(errp, "Chardev '%s' not found", id);
1145         return;
1146     }
1147     if (qemu_chr_is_busy(chr)) {
1148         error_setg(errp, "Chardev '%s' is busy", id);
1149         return;
1150     }
1151     if (qemu_chr_replay(chr)) {
1152         error_setg(errp,
1153             "Chardev '%s' cannot be unplugged in record/replay mode", id);
1154         return;
1155     }
1156     object_unparent(OBJECT(chr));
1157 }
1158
1159 void qmp_chardev_send_break(const char *id, Error **errp)
1160 {
1161     Chardev *chr;
1162
1163     chr = qemu_chr_find(id);
1164     if (chr == NULL) {
1165         error_setg(errp, "Chardev '%s' not found", id);
1166         return;
1167     }
1168     qemu_chr_be_event(chr, CHR_EVENT_BREAK);
1169 }
1170
1171 /*
1172  * Add a timeout callback for the chardev (in milliseconds), return
1173  * the GSource object created. Please use this to add timeout hook for
1174  * chardev instead of g_timeout_add() and g_timeout_add_seconds(), to
1175  * make sure the gcontext that the task bound to is correct.
1176  */
1177 GSource *qemu_chr_timeout_add_ms(Chardev *chr, guint ms,
1178                                  GSourceFunc func, void *private)
1179 {
1180     GSource *source = g_timeout_source_new(ms);
1181
1182     assert(func);
1183     g_source_set_callback(source, func, private, NULL);
1184     g_source_attach(source, chr->gcontext);
1185
1186     return source;
1187 }
1188
1189 void qemu_chr_cleanup(void)
1190 {
1191     object_unparent(get_chardevs_root());
1192 }
1193
1194 static void register_types(void)
1195 {
1196     type_register_static(&char_type_info);
1197
1198     /* this must be done after machine init, since we register FEs with muxes
1199      * as part of realize functions like serial_isa_realizefn when -nographic
1200      * is specified
1201      */
1202     qemu_add_machine_init_done_notifier(&chardev_machine_done_notify);
1203 }
1204
1205 type_init(register_types);