{"id":2230559,"url":"http://patchwork.ozlabs.org/api/1.1/patches/2230559/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20260430-qemu-vnc-v3-16-be96757428d0@redhat.com/","project":{"id":14,"url":"http://patchwork.ozlabs.org/api/1.1/projects/14/?format=json","name":"QEMU Development","link_name":"qemu-devel","list_id":"qemu-devel.nongnu.org","list_email":"qemu-devel@nongnu.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20260430-qemu-vnc-v3-16-be96757428d0@redhat.com>","date":"2026-04-29T21:02:49","name":"[v3,16/26] ui/vnc: merge vnc_display_init() and vnc_display_open()","commit_ref":null,"pull_url":null,"state":"new","archived":false,"hash":"9c6b73b3879b800c80c9879f27677b2e05ba545c","submitter":{"id":66774,"url":"http://patchwork.ozlabs.org/api/1.1/people/66774/?format=json","name":"Marc-André Lureau","email":"marcandre.lureau@redhat.com"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20260430-qemu-vnc-v3-16-be96757428d0@redhat.com/mbox/","series":[{"id":502150,"url":"http://patchwork.ozlabs.org/api/1.1/series/502150/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/list/?series=502150","date":"2026-04-29T21:02:34","name":"ui: add standalone VNC server over D-Bus","version":3,"mbox":"http://patchwork.ozlabs.org/series/502150/mbox/"}],"comments":"http://patchwork.ozlabs.org/api/patches/2230559/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/2230559/checks/","tags":{},"headers":{"Return-Path":"","X-Original-To":"incoming@patchwork.ozlabs.org","Delivered-To":"patchwork-incoming@legolas.ozlabs.org","Authentication-Results":["legolas.ozlabs.org;\n\tdkim=pass (1024-bit key;\n unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256\n header.s=mimecast20190719 header.b=GVwfRPvA;\n\tdkim-atps=neutral","legolas.ozlabs.org;\n spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org\n (client-ip=209.51.188.17; helo=lists1p.gnu.org;\n envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org;\n receiver=patchwork.ozlabs.org)"],"Received":["from lists1p.gnu.org (lists1p.gnu.org [209.51.188.17])\n\t(using TLSv1.2 with cipher ECDHE-ECDSA-AES256-GCM-SHA384 (256/256 bits))\n\t(No client certificate requested)\n\tby legolas.ozlabs.org (Postfix) with ESMTPS id 4g5VHV2sR0z1yHv\n\tfor ; Thu, 30 Apr 2026 07:07:18 +1000 (AEST)","from localhost ([::1] helo=lists1p.gnu.org)\n\tby lists1p.gnu.org with esmtp (Exim 4.90_1)\n\t(envelope-from )\n\tid 1wIC6g-0007fc-M2; Wed, 29 Apr 2026 17:06:07 -0400","from eggs.gnu.org ([2001:470:142:3::10])\n by lists1p.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)\n (Exim 4.90_1) (envelope-from )\n id 1wIC5V-0006KU-8K\n for qemu-devel@nongnu.org; Wed, 29 Apr 2026 17:04:59 -0400","from us-smtp-delivery-124.mimecast.com ([170.10.133.124])\n by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)\n (Exim 4.90_1) (envelope-from )\n id 1wIC5T-0003Ul-BC\n for qemu-devel@nongnu.org; Wed, 29 Apr 2026 17:04:52 -0400","from mx-prod-mc-01.mail-002.prod.us-west-2.aws.redhat.com\n (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by\n relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3,\n cipher=TLS_AES_256_GCM_SHA384) id us-mta-218-t9bKILbeMEmv2oUSyE91cQ-1; Wed,\n 29 Apr 2026 17:04:48 -0400","from mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com\n (mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.4])\n (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest\n SHA256)\n (No client certificate requested)\n by mx-prod-mc-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS\n id 87F93195608E\n for ; Wed, 29 Apr 2026 21:04:47 +0000 (UTC)","from localhost (unknown [10.44.22.2])\n by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP\n id 7C014300019F; Wed, 29 Apr 2026 21:04:45 +0000 (UTC)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n s=mimecast20190719; t=1777496690;\n h=from:from:reply-to:subject:subject:date:date:message-id:message-id:\n to:to:cc:cc:mime-version:mime-version:content-type:content-type:\n content-transfer-encoding:content-transfer-encoding:\n in-reply-to:in-reply-to:references:references;\n bh=cYb9CzXbF1iD7gvA2lK+zB+4NthlyQweiyV38R9QicQ=;\n b=GVwfRPvASlHdj6g2ufoxOvaJaExkr2sMbBwSR8oVMSQFU0/TrfmA/oXq2YDzoQO5bIRs8v\n BoZfzsBVq9xLnI4L0bTS7pNlKJfmPHOeDcaGz4aeM/xvT+FzvYx46fffcE0Qx1hsOKZvKR\n n+4jDFk8sJ88aEC37jV8P7yiSJcAXQk=","X-MC-Unique":"t9bKILbeMEmv2oUSyE91cQ-1","X-Mimecast-MFC-AGG-ID":"t9bKILbeMEmv2oUSyE91cQ_1777496687","From":"=?utf-8?q?Marc-Andr=C3=A9_Lureau?= ","Date":"Thu, 30 Apr 2026 01:02:49 +0400","Subject":"[PATCH v3 16/26] ui/vnc: merge vnc_display_init() and\n vnc_display_open()","MIME-Version":"1.0","Content-Type":"text/plain; charset=\"utf-8\"","Content-Transfer-Encoding":"8bit","Message-Id":"<20260430-qemu-vnc-v3-16-be96757428d0@redhat.com>","References":"<20260430-qemu-vnc-v3-0-be96757428d0@redhat.com>","In-Reply-To":"<20260430-qemu-vnc-v3-0-be96757428d0@redhat.com>","To":"qemu-devel@nongnu.org","Cc":"=?utf-8?q?Marc-Andr=C3=A9_Lureau?= ","X-Developer-Signature":"v=1; a=openpgp-sha256; l=10282;\n i=marcandre.lureau@redhat.com; h=from:subject:message-id;\n bh=O83CBYLyXPof+xTeYZA3ffs8FHHZIOfJ5nmRzw9+tcY=;\n b=owEBbQKS/ZANAwAKAdro4Ql1lpzlAcsmYgBp8nIMFPBUNqRKt1F/wmXGWJmdWRs8ixlCmes72\n Dc7MwiGol+JAjMEAAEKAB0WIQSHqb2TP4fGBtJ29i3a6OEJdZac5QUCafJyDAAKCRDa6OEJdZac\n 5RYtD/9dtAMaq/p1NSmtvAVUIkXwgA1aiVYOCwklEYsgeS5082YQPG6eSd7aDTOQZhQOXh9EDeu\n NL15U+2tQg5nSkapdJ18XSbcSUeWlRlGdorv3Mvy2j3eLkjF73ddCt4qg/Wyb+D/Hw+mFxTqQTq\n vymHQ4Nl9fG7eVDVS4/+AmjNhMaQwTLSKay6iUfXd27qaThfHHJ5tkDshdG+sJEeeTyjML4IC7K\n FvkgAdnDB10BciOMsv7g0rhX6OfRhV4vlcfI+T0h9eZRff+RqCYJ3xtEUljVRjyvPDuQ9IwVuzq\n WKJUqaSoZvN7VuJJlGb5Uco0O1ZQGcewnKUDemQGJNnCT9BK8KK/K60JsBYdYxfjEAoUh+SRJv5\n b+x1BQ2MbdCSoOH2nMACBW+jezeNVm8Nh/fddkuQKUwsl1ivQFuN7aTX9WelXEPn4dotYgs7H6F\n nlw5aJiTO2u8GzgKwSEntQnv3TtLIZ/eN8waS82rgt9xd+YskuNdkKTo1A8tHYIOdHVXU//AkpI\n c07gyq0xTj4wntb1WDlaYHI79HE9IojM+u5xKEgbxvFvHU1En68czLHwnEZ+Z3Xp9RmEqpBkyX8\n LSaWRBZyQKK8cTlLvZI0kPGdjIiiNrq/bpv2lYNHVX12Y1Job1XCl7feffSzOqGb5xHXlGXs771\n Kpo1mdBwm/bEFhQ==","X-Developer-Key":"i=marcandre.lureau@redhat.com; a=openpgp;\n fpr=87A9BD933F87C606D276F62DDAE8E10975969CE5","X-Scanned-By":"MIMEDefang 3.4.1 on 10.30.177.4","Received-SPF":"pass client-ip=170.10.133.124;\n envelope-from=marcandre.lureau@redhat.com;\n helo=us-smtp-delivery-124.mimecast.com","X-Spam_score_int":"12","X-Spam_score":"1.2","X-Spam_bar":"+","X-Spam_report":"(1.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001,\n DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,\n RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H5=0.001, RCVD_IN_MSPIKE_WL=0.001,\n RCVD_IN_SBL_CSS=3.335, SPF_HELO_PASS=-0.001,\n SPF_PASS=-0.001 autolearn=no autolearn_force=no","X-Spam_action":"no action","X-BeenThere":"qemu-devel@nongnu.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"qemu development ","List-Unsubscribe":",\n ","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n ","Errors-To":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org","Sender":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org"},"content":"Combine the two-step vnc_display_init()/vnc_display_open() sequence\ninto a single vnc_display_new() function that returns VncDisplay*.\nThis simplifies the API by making vnc_display_open() an\ninternal detail and will allow further code simplification.\n\nvnc_display_new() is moved to vnc.h, since it returns VncDisplay* now.\nAdd vnc_display_free() for consistency, and it will be later used.\n\nSigned-off-by: Marc-André Lureau \n---\n include/ui/console.h | 2 --\n ui/vnc.h | 3 ++\n ui/vnc.c | 79 ++++++++++++++++++++++------------------------------\n 3 files changed, 36 insertions(+), 48 deletions(-)","diff":"diff --git a/include/ui/console.h b/include/ui/console.h\nindex 7224b8142f3..550a5e08e46 100644\n--- a/include/ui/console.h\n+++ b/include/ui/console.h\n@@ -438,8 +438,6 @@ const char *qemu_display_get_vc(DisplayOptions *opts);\n void qemu_display_help(void);\n \n /* vnc.c */\n-bool vnc_display_init(const char *id, Error **errp);\n-bool vnc_display_open(const char *id, Error **errp);\n void vnc_display_add_client(const char *id, int csock, bool skipauth);\n int vnc_display_password(const char *id, const char *password, Error **errp);\n int vnc_display_pw_expire(const char *id, time_t expires);\ndiff --git a/ui/vnc.h b/ui/vnc.h\nindex 780fd39469f..d2ebb0f7f45 100644\n--- a/ui/vnc.h\n+++ b/ui/vnc.h\n@@ -549,6 +549,9 @@ enum VncFeatures {\n #define VNC_CLIPBOARD_NOTIFY (1 << 27)\n #define VNC_CLIPBOARD_PROVIDE (1 << 28)\n \n+VncDisplay *vnc_display_new(const char *id, Error **errp);\n+void vnc_display_free(VncDisplay *vd);\n+\n /*****************************************************************************\n *\n * Internal APIs\ndiff --git a/ui/vnc.c b/ui/vnc.c\nindex 067f534cf08..1c649e7bccf 100644\n--- a/ui/vnc.c\n+++ b/ui/vnc.c\n@@ -3423,17 +3423,15 @@ static void vmstate_change_handler(void *opaque, bool running, RunState state)\n update_displaychangelistener(&vd->dcl, VNC_REFRESH_INTERVAL_BASE);\n }\n \n-static void vnc_display_free(VncDisplay *vd);\n+static bool vnc_display_open(VncDisplay *vd, Error **errp);\n \n-bool vnc_display_init(const char *id, Error **errp)\n+VncDisplay *vnc_display_new(const char *id, Error **errp)\n {\n VncDisplay *vd;\n \n- if (vnc_display_find(id) != NULL) {\n- return true;\n- }\n- vd = g_malloc0(sizeof(*vd));\n+ assert(!vnc_display_find(id));\n \n+ vd = g_new0(VncDisplay, 1);\n qemu_mutex_init(&vd->mutex);\n vd->id = g_strdup(id);\n vd->dcl.ops = &dcl_ops;\n@@ -3451,7 +3449,7 @@ bool vnc_display_init(const char *id, Error **errp)\n \n if (!vd->kbd_layout) {\n vnc_display_free(vd);\n- return false;\n+ return NULL;\n }\n \n vd->share_policy = VNC_SHARE_POLICY_ALLOW_EXCLUSIVE;\n@@ -3464,8 +3462,13 @@ bool vnc_display_init(const char *id, Error **errp)\n vd->vmstate_handler_entry = qemu_add_vm_change_state_handler(\n &vmstate_change_handler, vd);\n \n+ if (!vnc_display_open(vd, errp)) {\n+ vnc_display_free(vd);\n+ return NULL;\n+ }\n+\n QTAILQ_INSERT_TAIL(&vnc_displays, vd, next);\n- return true;\n+ return vd;\n }\n \n static void vnc_display_close(VncDisplay *vd)\n@@ -3506,7 +3509,7 @@ static void vnc_display_close(VncDisplay *vd)\n #endif\n }\n \n-static void vnc_display_free(VncDisplay *vd)\n+void vnc_display_free(VncDisplay *vd)\n {\n if (!vd) {\n return;\n@@ -3528,7 +3531,6 @@ static void vnc_display_free(VncDisplay *vd)\n g_free(vd);\n }\n \n-\n int vnc_display_password(const char *id, const char *password, Error **errp)\n {\n VncDisplay *vd = vnc_display_find(id);\n@@ -4071,10 +4073,9 @@ bool vnc_display_update(DisplayUpdateOptionsVNC *arg, Error **errp)\n return true;\n }\n \n-bool vnc_display_open(const char *id, Error **errp)\n+static bool vnc_display_open(VncDisplay *vd, Error **errp)\n {\n- VncDisplay *vd = vnc_display_find(id);\n- QemuOpts *opts = qemu_opts_find(&qemu_vnc_opts, id);\n+ QemuOpts *opts = qemu_opts_find(&qemu_vnc_opts, vd->id);\n g_autoptr(SocketAddressList) saddr_list = NULL;\n g_autoptr(SocketAddressList) wsaddr_list = NULL;\n const char *share, *device_id;\n@@ -4093,26 +4094,23 @@ bool vnc_display_open(const char *id, Error **errp)\n assert(vd);\n assert(opts);\n \n- vnc_display_close(vd);\n-\n reverse = qemu_opt_get_bool(opts, \"reverse\", false);\n if (vnc_display_get_addresses(opts, reverse, &saddr_list, &wsaddr_list,\n errp) < 0) {\n- goto fail;\n+ return false;\n }\n \n-\n passwordSecret = qemu_opt_get(opts, \"password-secret\");\n if (passwordSecret) {\n if (qemu_opt_get(opts, \"password\")) {\n error_setg(errp,\n \"'password' flag is redundant with 'password-secret'\");\n- goto fail;\n+ return false;\n }\n vd->password = qcrypto_secret_lookup_as_utf8(passwordSecret,\n errp);\n if (!vd->password) {\n- goto fail;\n+ return false;\n }\n password = true;\n } else {\n@@ -4123,7 +4121,7 @@ bool vnc_display_open(const char *id, Error **errp)\n QCRYPTO_CIPHER_ALGO_DES, QCRYPTO_CIPHER_MODE_ECB)) {\n error_setg(errp,\n \"Cipher backend does not support DES algorithm\");\n- goto fail;\n+ return false;\n }\n }\n \n@@ -4133,7 +4131,7 @@ bool vnc_display_open(const char *id, Error **errp)\n #ifndef CONFIG_VNC_SASL\n if (sasl) {\n error_setg(errp, \"VNC SASL auth requires cyrus-sasl support\");\n- goto fail;\n+ return false;\n }\n #endif /* CONFIG_VNC_SASL */\n credid = qemu_opt_get(opts, \"tls-creds\");\n@@ -4144,7 +4142,7 @@ bool vnc_display_open(const char *id, Error **errp)\n if (!creds) {\n error_setg(errp, \"No TLS credentials with id '%s'\",\n credid);\n- goto fail;\n+ return false;\n }\n vd->tlscreds = (QCryptoTLSCreds *)\n object_dynamic_cast(creds,\n@@ -4152,26 +4150,26 @@ bool vnc_display_open(const char *id, Error **errp)\n if (!vd->tlscreds) {\n error_setg(errp, \"Object with id '%s' is not TLS credentials\",\n credid);\n- goto fail;\n+ return false;\n }\n object_ref(OBJECT(vd->tlscreds));\n \n if (!qcrypto_tls_creds_check_endpoint(vd->tlscreds,\n QCRYPTO_TLS_CREDS_ENDPOINT_SERVER,\n errp)) {\n- goto fail;\n+ return false;\n }\n }\n tlsauthz = qemu_opt_get(opts, \"tls-authz\");\n if (tlsauthz && !vd->tlscreds) {\n error_setg(errp, \"'tls-authz' provided but TLS is not enabled\");\n- goto fail;\n+ return false;\n }\n \n saslauthz = qemu_opt_get(opts, \"sasl-authz\");\n if (saslauthz && !sasl) {\n error_setg(errp, \"'sasl-authz' provided but SASL auth is not enabled\");\n- goto fail;\n+ return false;\n }\n \n share = qemu_opt_get(opts, \"share\");\n@@ -4184,7 +4182,7 @@ bool vnc_display_open(const char *id, Error **errp)\n vd->share_policy = VNC_SHARE_POLICY_FORCE_SHARED;\n } else {\n error_setg(errp, \"unknown vnc share= option\");\n- goto fail;\n+ return false;\n }\n } else {\n vd->share_policy = VNC_SHARE_POLICY_ALLOW_EXCLUSIVE;\n@@ -4218,20 +4216,20 @@ bool vnc_display_open(const char *id, Error **errp)\n if (vnc_display_setup_auth(&vd->auth, &vd->subauth,\n vd->tlscreds, password,\n sasl, false, errp) < 0) {\n- goto fail;\n+ return false;\n }\n trace_vnc_auth_init(vd, 0, vd->auth, vd->subauth);\n \n if (vnc_display_setup_auth(&vd->ws_auth, &vd->ws_subauth,\n vd->tlscreds, password,\n sasl, true, errp) < 0) {\n- goto fail;\n+ return false;\n }\n trace_vnc_auth_init(vd, 1, vd->ws_auth, vd->ws_subauth);\n \n #ifdef CONFIG_VNC_SASL\n if (sasl && !vnc_sasl_server_init(errp)) {\n- goto fail;\n+ return false;\n }\n #endif\n vd->lock_key_sync = lock_key_sync;\n@@ -4244,7 +4242,7 @@ bool vnc_display_open(const char *id, Error **errp)\n if (audiodev) {\n vd->audio_be = audio_be_by_name(audiodev, errp);\n if (!vd->audio_be) {\n- goto fail;\n+ return false;\n }\n } else {\n vd->audio_be = audio_get_default_audio_be(NULL);\n@@ -4258,7 +4256,7 @@ bool vnc_display_open(const char *id, Error **errp)\n con = qemu_console_lookup_by_device_name(device_id, head, &err);\n if (err) {\n error_propagate(errp, err);\n- goto fail;\n+ return false;\n }\n } else {\n con = qemu_console_lookup_default();\n@@ -4279,11 +4277,11 @@ bool vnc_display_open(const char *id, Error **errp)\n \n if (reverse) {\n if (vnc_display_connect(vd, saddr_list, wsaddr_list, errp) < 0) {\n- goto fail;\n+ return false;\n }\n } else {\n if (vnc_display_listen(vd, saddr_list, wsaddr_list, errp) < 0) {\n- goto fail;\n+ return false;\n }\n }\n \n@@ -4291,12 +4289,7 @@ bool vnc_display_open(const char *id, Error **errp)\n vnc_display_print_local_addr(vd);\n }\n \n- /* Success */\n return true;\n-\n-fail:\n- vnc_display_close(vd);\n- return false;\n }\n \n void vnc_display_add_client(const char *id, int csock, bool skipauth)\n@@ -4352,13 +4345,7 @@ int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp)\n id = vnc_auto_assign_id(opts);\n }\n \n- if (!vnc_display_init(id, errp)) {\n- return -1;\n- }\n- if (!vnc_display_open(id, errp)) {\n- return -1;\n- }\n- return 0;\n+ return vnc_display_new(id, errp) != NULL ? 0 : -1;\n }\n \n static void vnc_register_config(void)\n","prefixes":["v3","16/26"]}