all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Arthur Bied-Charreton <a.bied-charreton@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH pve-manager v2 09/17] api: Add endpoint querying available CPU flags cluster-wide
Date: Wed,  1 Apr 2026 10:00:20 +0200	[thread overview]
Message-ID: <20260401080028.62513-10-a.bied-charreton@proxmox.com> (raw)
In-Reply-To: <20260401080028.62513-1-a.bied-charreton@proxmox.com>

Add endpoint at `/cluster/qemu/cpu-flags` allowing to query the CPU
flags available on the whole cluster, filtered by acceleration type
(kvm/tcg).

For each flag, a list of nodes supporting it is returned. This gives an
accurate picture of which flags will actually be accepted by QEMU when
starting a VM.

Currently only return available flags for x86_64, see documentation of
query_available_cpu_flags.

Signed-off-by: Arthur Bied-Charreton <a.bied-charreton@proxmox.com>
---
 PVE/API2/Cluster.pm               |  7 ++++
 PVE/API2/Cluster/Makefile         |  4 +-
 PVE/API2/Cluster/Qemu.pm          | 41 +++++++++++++++++++
 PVE/API2/Cluster/Qemu/CPUFlags.pm | 68 +++++++++++++++++++++++++++++++
 PVE/API2/Cluster/Qemu/Makefile    | 17 ++++++++
 5 files changed, 136 insertions(+), 1 deletion(-)
 create mode 100644 PVE/API2/Cluster/Qemu.pm
 create mode 100644 PVE/API2/Cluster/Qemu/CPUFlags.pm
 create mode 100644 PVE/API2/Cluster/Qemu/Makefile

diff --git a/PVE/API2/Cluster.pm b/PVE/API2/Cluster.pm
index cc8279ca..4e641a2d 100644
--- a/PVE/API2/Cluster.pm
+++ b/PVE/API2/Cluster.pm
@@ -27,6 +27,7 @@ use PVE::API2::Backup;
 use PVE::API2::Cluster::BackupInfo;
 use PVE::API2::Cluster::BulkAction;
 use PVE::API2::Cluster::Ceph;
+use PVE::API2::Cluster::Qemu;
 use PVE::API2::Cluster::Mapping;
 use PVE::API2::Cluster::Jobs;
 use PVE::API2::Cluster::MetricServer;
@@ -59,6 +60,11 @@ __PACKAGE__->register_method({
     path => 'notifications',
 });
 
+__PACKAGE__->register_method({
+    subclass => "PVE::API2::Cluster::Qemu",
+    path => 'qemu',
+});
+
 __PACKAGE__->register_method({
     subclass => "PVE::API2::ClusterConfig",
     path => 'config',
@@ -157,6 +163,7 @@ __PACKAGE__->register_method({
             { name => 'bulk-action' },
             { name => 'ceph' },
             { name => 'config' },
+            { name => 'qemu' },
             { name => 'firewall' },
             { name => 'ha' },
             { name => 'jobs' },
diff --git a/PVE/API2/Cluster/Makefile b/PVE/API2/Cluster/Makefile
index 6cffe4c9..fd33e31d 100644
--- a/PVE/API2/Cluster/Makefile
+++ b/PVE/API2/Cluster/Makefile
@@ -1,13 +1,15 @@
 include ../../../defines.mk
 
 SUBDIRS=Mapping		\
-	BulkAction
+	BulkAction 		\
+	Qemu
 
 # for node independent, cluster-wide applicable, API endpoints
 # ensure we do not conflict with files shipped by pve-cluster!!
 PERLSOURCE= 			\
 	BackupInfo.pm		\
 	BulkAction.pm		\
+	Qemu.pm		\
 	MetricServer.pm		\
 	Mapping.pm		\
 	Notifications.pm		\
diff --git a/PVE/API2/Cluster/Qemu.pm b/PVE/API2/Cluster/Qemu.pm
new file mode 100644
index 00000000..ed37fd20
--- /dev/null
+++ b/PVE/API2/Cluster/Qemu.pm
@@ -0,0 +1,41 @@
+package PVE::API2::Cluster::Qemu;
+
+use v5.36;
+
+use PVE::API2::Cluster::Qemu::CPUFlags;
+
+use base qw(PVE::RESTHandler);
+
+__PACKAGE__->register_method({
+    subclass => "PVE::API2::Cluster::Qemu::CPUFlags",
+    path => "cpu-flags",
+});
+
+__PACKAGE__->register_method({
+    name => 'index',
+    path => '',
+    method => 'GET',
+    description => "Cluster index.",
+    permissions => { user => 'all' },
+    parameters => {
+        additionalProperties => 0,
+        properties => {},
+    },
+    returns => {
+        type => 'array',
+        items => {
+            type => "object",
+            properties => {},
+        },
+        links => [{ rel => 'child', href => "{name}" }],
+    },
+    code => sub {
+        my ($param) = @_;
+
+        return [
+            { name => 'cpu-flags' },
+        ];
+    },
+});
+
+1;
diff --git a/PVE/API2/Cluster/Qemu/CPUFlags.pm b/PVE/API2/Cluster/Qemu/CPUFlags.pm
new file mode 100644
index 00000000..a3328e85
--- /dev/null
+++ b/PVE/API2/Cluster/Qemu/CPUFlags.pm
@@ -0,0 +1,68 @@
+package PVE::API2::Cluster::Qemu::CPUFlags;
+
+use v5.36;
+
+use PVE::JSONSchema qw(get_standard_option);
+use PVE::RESTHandler;
+use PVE::Tools qw(extract_param);
+
+use PVE::QemuServer::Helpers;
+use PVE::QemuServer::CPUFlags;
+
+use base qw(PVE::RESTHandler);
+
+__PACKAGE__->register_method({
+    name => 'index',
+    path => '',
+    method => 'GET',
+    description => "List of available CPU flags. Returns an empty list for 'aarch64', "
+        . "PVE does not currently ship a flags list for it.",
+    permissions => { user => 'all' },
+    parameters => {
+        additionalProperties => 0,
+        properties => {
+            arch => get_standard_option('pve-qm-cpu-arch', { optional => 1 }),
+            accel => {
+                description => 'Acceleration type to check node compatibility for.',
+                type => 'string',
+                enum => [qw(kvm tcg)],
+                optional => 1,
+                default => 'kvm',
+            },
+        },
+    },
+    returns => {
+        type => 'array',
+        items => {
+            type => 'object',
+            properties => {
+                name => {
+                    type => 'string',
+                    description => "Name of the CPU flag.",
+                },
+                description => {
+                    type => 'string',
+                    description => "Description of the CPU flag.",
+                    optional => 1,
+                },
+                'supported-on' => {
+                    description =>
+                        'List of nodes supporting the flag with the selected acceleration type ("accel").',
+                    type => 'array',
+                    items => get_standard_option('pve-node'),
+                    optional => 1,
+                },
+            },
+        },
+    },
+    code => sub {
+        my ($param) = @_;
+
+        my $arch = extract_param($param, 'arch') // PVE::QemuServer::Helpers::get_host_arch();
+        my $accel = extract_param($param, 'accel') // 'kvm';
+
+        return PVE::QemuServer::CPUFlags::query_available_cpu_flags($accel, 0, $arch);
+    },
+});
+
+1;
diff --git a/PVE/API2/Cluster/Qemu/Makefile b/PVE/API2/Cluster/Qemu/Makefile
new file mode 100644
index 00000000..2ab3e0b1
--- /dev/null
+++ b/PVE/API2/Cluster/Qemu/Makefile
@@ -0,0 +1,17 @@
+include ../../../../defines.mk
+
+# for node independent, cluster-wide applicable, API endpoints
+# ensure we do not conflict with files shipped by pve-cluster!!
+PERLSOURCE= 	\
+	CPUFlags.pm
+
+all:
+
+.PHONY: clean
+clean:
+	rm -rf *~
+
+.PHONY: install
+install: ${PERLSOURCE}
+	install -d ${PERLLIBDIR}/PVE/API2/Cluster/Qemu
+	install -m 0644 ${PERLSOURCE} ${PERLLIBDIR}/PVE/API2/Cluster/Qemu
-- 
2.47.3




  parent reply	other threads:[~2026-04-01  8:01 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-04-01  8:00 [PATCH docs/manager/qemu-server v2 00/17] Add API and UI for custom CPU models Arthur Bied-Charreton
2026-04-01  8:00 ` [PATCH pve-docs v2 01/17] qm: Add anchor to "CPU Type" section Arthur Bied-Charreton
2026-04-01  8:00 ` [PATCH qemu-server v2 02/17] cpu config: Rename CPU models config path variable Arthur Bied-Charreton
2026-04-01  8:00 ` [PATCH qemu-server v2 03/17] cpu flags: Create CPUFlags module Arthur Bied-Charreton
2026-04-01  8:00 ` [PATCH qemu-server v2 04/17] cpu flags: Add query_available_cpu_flags helper Arthur Bied-Charreton
2026-04-01  8:00 ` [PATCH qemu-server v2 05/17] cpu config: Add helpers to lock and write config Arthur Bied-Charreton
2026-04-01  8:00 ` [PATCH qemu-server v2 06/17] cpu: Register standard option for CPU format Arthur Bied-Charreton
2026-04-01  8:00 ` [PATCH qemu-server v2 07/17] cpu config: Set 'type' field before writing Arthur Bied-Charreton
2026-04-01  8:00 ` [PATCH qemu-server v2 08/17] cpu flags: Improve flags list returned by endpoint Arthur Bied-Charreton
2026-04-01  8:00 ` Arthur Bied-Charreton [this message]
2026-04-01  8:00 ` [PATCH pve-manager v2 10/17] api: Add CRUD handlers for custom CPU models Arthur Bied-Charreton
2026-04-01  8:00 ` [PATCH pve-manager v2 11/17] ui: CPUModelSelector: Allow filtering out custom models Arthur Bied-Charreton
2026-04-01  8:00 ` [PATCH pve-manager v2 12/17] ui: Add basic custom CPU model editor Arthur Bied-Charreton
2026-04-01  8:00 ` [PATCH pve-manager v2 13/17] ui: VMCPUFlagSelector: Add CPU flag editor for custom models Arthur Bied-Charreton
2026-04-01  8:00 ` [PATCH pve-manager v2 14/17] ui: VMCPUFlagSelector: Fix buffered rendering error Arthur Bied-Charreton
2026-04-01  8:00 ` [PATCH pve-manager v2 15/17] ui: VMCPUFlagSelector: Allow filtering out flags supported on 0 nodes Arthur Bied-Charreton
2026-04-01  8:00 ` [PATCH pve-manager v2 16/17] ui: VMCPUFlagSelector: Add search bar for large lists of flags Arthur Bied-Charreton
2026-04-01  8:00 ` [PATCH pve-manager v2 17/17] RFC: ui: Group custom CPU with resource mappings Arthur Bied-Charreton

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260401080028.62513-10-a.bied-charreton@proxmox.com \
    --to=a.bied-charreton@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal