Commit 777357d7 authored by Marc-André Lureau's avatar Marc-André Lureau Committed by Paolo Bonzini
Browse files

chardev: qom-ify 



Turn Chardev into Object.

qemu_chr_alloc() is replaced by the qemu_chardev_new() constructor. It
will call qemu_char_open() to open/intialize the chardev with the
ChardevCommon *backend settings.

The CharDriver::create() callback is turned into a ChardevClass::open()
which is called from the newly introduced qemu_chardev_open().

"chardev-gdb" and "chardev-hci" are internal chardev and aren't
creatable directly with -chardev. Use a new internal flag to disable
them. We may want to use TYPE_USER_CREATABLE interface instead, or
perhaps allow -chardev usage.

Although in general we keep typename and macros private, unless the type
is being used by some other file, in this patch, all types and common
helper macros for qemu-char.c are in char.h. This is to help transition
now (some types must be declared early, while some aren't shared) and
when splitting in several units. This is to be improved later.

Signed-off-by: default avatarMarc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: default avatarEric Blake <eblake@redhat.com>
Signed-off-by: default avatarPaolo Bonzini <pbonzini@redhat.com>
parent 5bf5adae

backends/baum.c

+33 −33
Original line number Diff line number Diff line
@@ -100,6 +100,9 @@ typedef struct { 
    QEMUTimer *cellCount_timer;

} BaumChardev;



#define TYPE_CHARDEV_BRAILLE "chardev-braille"

#define BAUM_CHARDEV(obj) OBJECT_CHECK(BaumChardev, (obj), TYPE_CHARDEV_BRAILLE)



/* Let's assume NABCC by default */

enum way {

    DOTS2ASCII,
@@ -255,7 +258,7 @@ static int baum_deferred_init(BaumChardev *baum) 
/* The serial port can receive more of our data */

static void baum_chr_accept_input(struct Chardev *chr)

{

    BaumChardev *baum = (BaumChardev *)chr;

    BaumChardev *baum = BAUM_CHARDEV(chr);

    int room, first;



    if (!baum->out_buf_used)
@@ -281,7 +284,7 @@ static void baum_chr_accept_input(struct Chardev *chr) 
/* We want to send a packet */

static void baum_write_packet(BaumChardev *baum, const uint8_t *buf, int len)

{

    Chardev *chr = (Chardev *)baum;

    Chardev *chr = CHARDEV(baum);

    uint8_t io_buf[1 + 2 * len], *cur = io_buf;

    int room;

    *cur++ = ESC;
@@ -322,7 +325,7 @@ static void baum_write_packet(BaumChardev *baum, const uint8_t *buf, int len) 
/* Called when the other end seems to have a wrong idea of our display size */

static void baum_cellCount_timer_cb(void *opaque)

{

    BaumChardev *baum = opaque;

    BaumChardev *baum = BAUM_CHARDEV(opaque);

    uint8_t cell_count[] = { BAUM_RSP_CellCount, baum->x * baum->y };

    DPRINTF("Timeout waiting for DisplayData, sending cell count\n");

    baum_write_packet(baum, cell_count, sizeof(cell_count));
@@ -472,7 +475,7 @@ static int baum_eat_packet(BaumChardev *baum, const uint8_t *buf, int len) 
/* The other end is writing some data.  Store it and try to interpret */

static int baum_chr_write(Chardev *chr, const uint8_t *buf, int len)

{

    BaumChardev *baum = (BaumChardev *)chr;

    BaumChardev *baum = BAUM_CHARDEV(chr);

    int tocopy, cur, eaten, orig_len = len;



    if (!len)
@@ -529,7 +532,7 @@ static void baum_send_key2(BaumChardev *baum, uint8_t type, uint8_t value, 
/* We got some data on the BrlAPI socket */

static void baum_chr_read(void *opaque)

{

    BaumChardev *baum = opaque;

    BaumChardev *baum = BAUM_CHARDEV(opaque);

    brlapi_keyCode_t code;

    int ret;

    if (!baum->brlapi)
@@ -613,9 +616,9 @@ static void baum_chr_read(void *opaque) 
    }

}



static void baum_chr_free(struct Chardev *chr)

static void baum_chr_free(Chardev *chr)

{

    BaumChardev *baum = (BaumChardev *)chr;

    BaumChardev *baum = BAUM_CHARDEV(chr);



    timer_free(baum->cellCount_timer);

    if (baum->brlapi) {
@@ -624,24 +627,14 @@ static void baum_chr_free(struct Chardev *chr) 
    }

}



static Chardev *baum_chr_init(const CharDriver *driver,

                              const char *id,

static void baum_chr_open(Chardev *chr,

                          ChardevBackend *backend,

                              ChardevReturn *ret,

                          bool *be_opened,

                          Error **errp)

{

    ChardevCommon *common = backend->u.braille.data;

    BaumChardev *baum;

    Chardev *chr;

    BaumChardev *baum = BAUM_CHARDEV(chr);

    brlapi_handle_t *handle;



    chr = qemu_chr_alloc(driver, common, errp);

    if (!chr) {

        return NULL;

    }

    baum = (BaumChardev *)chr;



    handle = g_malloc0(brlapi_getHandleSize());

    baum->brlapi = handle;
@@ -649,34 +642,41 @@ static Chardev *baum_chr_init(const CharDriver *driver, 
    if (baum->brlapi_fd == -1) {

        error_setg(errp, "brlapi__openConnection: %s",

                   brlapi_strerror(brlapi_error_location()));

        goto fail_handle;

        g_free(handle);

        return;

    }

    baum->deferred_init = 0;



    baum->cellCount_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL, baum_cellCount_timer_cb, baum);



    qemu_set_fd_handler(baum->brlapi_fd, baum_chr_read, NULL, baum);

}



    return chr;

static void char_braille_class_init(ObjectClass *oc, void *data)

{

    ChardevClass *cc = CHARDEV_CLASS(oc);



fail_handle:

    g_free(handle);

    g_free(chr);

    return NULL;

    cc->open = baum_chr_open;

    cc->chr_write = baum_chr_write;

    cc->chr_accept_input = baum_chr_accept_input;

    cc->chr_free = baum_chr_free;

}



static const TypeInfo char_braille_type_info = {

    .name = TYPE_CHARDEV_BRAILLE,

    .parent = TYPE_CHARDEV,

    .instance_size = sizeof(BaumChardev),

    .class_init = char_braille_class_init,

};



static void register_types(void)

{

    static const CharDriver driver = {

        .instance_size = sizeof(BaumChardev),

        .kind = CHARDEV_BACKEND_KIND_BRAILLE,

        .create = baum_chr_init,

        .chr_write = baum_chr_write,

        .chr_accept_input = baum_chr_accept_input,

        .chr_free = baum_chr_free,

    };



    register_char_driver(&driver);

    type_register_static(&char_braille_type_info);

}



type_init(register_types);

backends/msmouse.c

+31 −26
Original line number Diff line number Diff line
@@ -41,9 +41,13 @@ typedef struct { 
    int outlen;

} MouseChardev;



#define TYPE_CHARDEV_MSMOUSE "chardev-msmouse"

#define MOUSE_CHARDEV(obj)                                      \

    OBJECT_CHECK(MouseChardev, (obj), TYPE_CHARDEV_MSMOUSE)



static void msmouse_chr_accept_input(Chardev *chr)

{

    MouseChardev *mouse = (MouseChardev *)chr;

    MouseChardev *mouse = MOUSE_CHARDEV(chr);

    int len;



    len = qemu_chr_be_can_write(chr);
@@ -98,7 +102,7 @@ static void msmouse_queue_event(MouseChardev *mouse) 
static void msmouse_input_event(DeviceState *dev, QemuConsole *src,

                                InputEvent *evt)

{

    MouseChardev *mouse = (MouseChardev *)dev;

    MouseChardev *mouse = MOUSE_CHARDEV(dev);

    InputMoveEvent *move;

    InputBtnEvent *btn;
@@ -122,8 +126,8 @@ static void msmouse_input_event(DeviceState *dev, QemuConsole *src, 


static void msmouse_input_sync(DeviceState *dev)

{

    MouseChardev *mouse = (MouseChardev *)dev;

    Chardev *chr = (Chardev *)dev;

    MouseChardev *mouse = MOUSE_CHARDEV(dev);

    Chardev *chr = CHARDEV(dev);



    msmouse_queue_event(mouse);

    msmouse_chr_accept_input(chr);
@@ -137,7 +141,7 @@ static int msmouse_chr_write(struct Chardev *s, const uint8_t *buf, int len) 


static void msmouse_chr_free(struct Chardev *chr)

{

    MouseChardev *mouse = (MouseChardev *)chr;

    MouseChardev *mouse = MOUSE_CHARDEV(chr);



    qemu_input_handler_unregister(mouse->hs);

}
@@ -149,42 +153,43 @@ static QemuInputHandler msmouse_handler = { 
    .sync  = msmouse_input_sync,

};



static Chardev *qemu_chr_open_msmouse(const CharDriver *driver,

                                      const char *id,

static void msmouse_chr_open(Chardev *chr,

                             ChardevBackend *backend,

                                      ChardevReturn *ret,

                             bool *be_opened,

                             Error **errp)

{

    ChardevCommon *common = backend->u.msmouse.data;

    MouseChardev *mouse;

    Chardev *chr;

    MouseChardev *mouse = MOUSE_CHARDEV(chr);



    chr = qemu_chr_alloc(driver, common, errp);

    if (!chr) {

        return NULL;

    }

    *be_opened = false;



    mouse = (MouseChardev *)chr;

    mouse->hs = qemu_input_handler_register((DeviceState *)mouse,

                                            &msmouse_handler);

}



static void char_msmouse_class_init(ObjectClass *oc, void *data)

{

    ChardevClass *cc = CHARDEV_CLASS(oc);



    return chr;

    cc->open = msmouse_chr_open;

    cc->chr_write = msmouse_chr_write;

    cc->chr_accept_input = msmouse_chr_accept_input;

    cc->chr_free = msmouse_chr_free;

}



static const TypeInfo char_msmouse_type_info = {

    .name = TYPE_CHARDEV_MSMOUSE,

    .parent = TYPE_CHARDEV,

    .instance_size = sizeof(MouseChardev),

    .class_init = char_msmouse_class_init,

};



static void register_types(void)

{

    static const CharDriver driver = {

        .instance_size = sizeof(MouseChardev),

        .kind = CHARDEV_BACKEND_KIND_MSMOUSE,

        .create = qemu_chr_open_msmouse,

        .chr_write = msmouse_chr_write,

        .chr_accept_input = msmouse_chr_accept_input,

        .chr_free = msmouse_chr_free,

    };



    register_char_driver(&driver);

    type_register_static(&char_msmouse_type_info);

}



type_init(register_types);

backends/testdev.c

+18 −16
Original line number Diff line number Diff line
@@ -36,6 +36,10 @@ typedef struct { 
    int in_buf_used;

} TestdevChardev;



#define TYPE_CHARDEV_TESTDEV "chardev-testdev"

#define TESTDEV_CHARDEV(obj)                                    \

    OBJECT_CHECK(TestdevChardev, (obj), TYPE_CHARDEV_TESTDEV)



/* Try to interpret a whole incoming packet */

static int testdev_eat_packet(TestdevChardev *testdev)

{
@@ -78,9 +82,9 @@ static int testdev_eat_packet(TestdevChardev *testdev) 
}



/* The other end is writing some data.  Store it and try to interpret */

static int testdev_write(Chardev *chr, const uint8_t *buf, int len)

static int testdev_chr_write(Chardev *chr, const uint8_t *buf, int len)

{

    TestdevChardev *testdev = (TestdevChardev *)chr;

    TestdevChardev *testdev = TESTDEV_CHARDEV(chr);

    int tocopy, eaten, orig_len = len;



    while (len) {
@@ -103,30 +107,28 @@ static int testdev_write(Chardev *chr, const uint8_t *buf, int len) 
    return orig_len;

}



static Chardev *chr_testdev_init(const CharDriver *driver,

                                 const char *id,

                                 ChardevBackend *backend,

                                 ChardevReturn *ret,

                                 bool *be_opened,

                                 Error **errp)

static void char_testdev_class_init(ObjectClass *oc, void *data)

{

    TestdevChardev *testdev = g_new0(TestdevChardev, 1);;

    Chardev *chr = (Chardev *)testdev;



    chr->driver = driver;

    ChardevClass *cc = CHARDEV_CLASS(oc);



    return chr;

    cc->chr_write = testdev_chr_write;

}



static const TypeInfo char_testdev_type_info = {

    .name = TYPE_CHARDEV_TESTDEV,

    .parent = TYPE_CHARDEV,

    .instance_size = sizeof(TestdevChardev),

    .class_init = char_testdev_class_init,

};



static void register_types(void)

{

    static const CharDriver driver = {

        .instance_size = sizeof(TestdevChardev),

        .kind = CHARDEV_BACKEND_KIND_TESTDEV,

        .create = chr_testdev_init,

        .chr_write = testdev_write,

    };



    register_char_driver(&driver);

    type_register_static(&char_testdev_type_info);

}



type_init(register_types);

gdbstub.c

+32 −7
Original line number Diff line number Diff line
@@ -1725,18 +1725,35 @@ static void gdb_sigterm_handler(int signal) 
}

#endif



static void gdb_monitor_open(Chardev *chr, ChardevBackend *backend,

                             bool *be_opened, Error **errp)

{

    *be_opened = false;

}



static void char_gdb_class_init(ObjectClass *oc, void *data)

{

    ChardevClass *cc = CHARDEV_CLASS(oc);



    cc->internal = true;

    cc->open = gdb_monitor_open;

    cc->chr_write = gdb_monitor_write;

}



#define TYPE_CHARDEV_GDB "chardev-gdb"



static const TypeInfo char_gdb_type_info = {

    .name = TYPE_CHARDEV_GDB,

    .parent = TYPE_CHARDEV,

    .class_init = char_gdb_class_init,

};



int gdbserver_start(const char *device)

{

    GDBState *s;

    char gdbstub_device_name[128];

    Chardev *chr = NULL;

    Chardev *mon_chr;

    ChardevCommon common = { 0 };

    static const CharDriver driver = {

        .instance_size = sizeof(Chardev),

        .kind = -1,

        .chr_write = gdb_monitor_write,

    };



    if (!first_cpu) {

        error_report("gdbstub: meaningless to attach gdb to a "
@@ -1775,7 +1792,8 @@ int gdbserver_start(const char *device) 
        qemu_add_vm_change_state_handler(gdb_vm_state_change, NULL);



        /* Initialize a monitor terminal for gdb */

        mon_chr = qemu_chr_alloc(&driver, &common, &error_abort);

        mon_chr = qemu_chardev_new(NULL, TYPE_CHARDEV_GDB,

                                   NULL, &error_abort);

        monitor_init(mon_chr, 0);

    } else {

        if (qemu_chr_fe_get_driver(&s->chr)) {
@@ -1798,4 +1816,11 @@ int gdbserver_start(const char *device) 


    return 0;

}



static void register_types(void)

{

    type_register_static(&char_gdb_type_info);

}



type_init(register_types);

#endif

hw/bt/hci-csr.c

+38 −17
Original line number Diff line number Diff line
@@ -55,6 +55,9 @@ struct csrhci_s { 
    struct HCIInfo *hci;

};



#define TYPE_CHARDEV_HCI "chardev-hci"

#define HCI_CHARDEV(obj) OBJECT_CHECK(struct csrhci_s, (obj), TYPE_CHARDEV_HCI)



/* H4+ packet types */

enum {

    H4_CMD_PKT   = 1,
@@ -462,23 +465,12 @@ qemu_irq *csrhci_pins_get(Chardev *chr) 
    return s->pins;

}



Chardev *uart_hci_init(void)

static void csrhci_open(Chardev *chr,

                        ChardevBackend *backend,

                        bool *be_opened,

                        Error **errp)

{

    static const CharDriver hci_driver = {

        .instance_size = sizeof(struct csrhci_s),

        .kind = -1,

        .chr_write = csrhci_write,

        .chr_ioctl = csrhci_ioctl,

    };

    Error *err = NULL;

    ChardevCommon common = { 0, };

    Chardev *chr = qemu_chr_alloc(&hci_driver, &common, &err);

    struct csrhci_s *s = (struct csrhci_s *)chr;



    if (err) {

        error_report_err(err);

        return NULL;

    }

    struct csrhci_s *s = HCI_CHARDEV(chr);



    s->hci = qemu_next_hci();

    s->hci->opaque = s;
@@ -488,6 +480,35 @@ Chardev *uart_hci_init(void) 
    s->out_tm = timer_new_ns(QEMU_CLOCK_VIRTUAL, csrhci_out_tick, s);

    s->pins = qemu_allocate_irqs(csrhci_pins, s, __csrhci_pins);

    csrhci_reset(s);

    *be_opened = false;

}



    return chr;

static void char_hci_class_init(ObjectClass *oc, void *data)

{

    ChardevClass *cc = CHARDEV_CLASS(oc);



    cc->internal = true;

    cc->open = csrhci_open;

    cc->chr_write = csrhci_write;

    cc->chr_ioctl = csrhci_ioctl;

}



static const TypeInfo char_hci_type_info = {

    .name = TYPE_CHARDEV_HCI,

    .parent = TYPE_CHARDEV,

    .instance_size = sizeof(struct csrhci_s),

    .class_init = char_hci_class_init,

};



Chardev *uart_hci_init(void)

{

    return qemu_chardev_new(NULL, TYPE_CHARDEV_HCI,

                            NULL, &error_abort);

}



static void register_types(void)

{

    type_register_static(&char_hci_type_info);

}



type_init(register_types);