[pve-devel] [PATCH manager v4 2/2] api: add resource map api endpoints for PCI and USB
Dominik Csapak
d.csapak at proxmox.com
Thu May 25 12:17:53 CEST 2023
this adds the typical section config crud API calls for
USB and PCI resource mapping to /cluster/resource/{TYPE}
the only special thing that this series does is the list call
for both has a special 'check-node' parameter that uses the
'proxyto_callback' to reroute the api call to the given node
so that it can check the validity of the mapping for that node
in the future when we e.g. broadcast the lspci output via pmxcfs
we drop the proxyto_callback and directly use the info from
pmxcfs (or we drop the parameter and always check all nodes)
Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
---
PVE/API2/Cluster.pm | 8 +
PVE/API2/Cluster/Makefile | 5 +
PVE/API2/Cluster/Resource.pm | 53 +++++
PVE/API2/Cluster/Resource/Makefile | 18 ++
PVE/API2/Cluster/Resource/PCI.pm | 297 +++++++++++++++++++++++++++++
PVE/API2/Cluster/Resource/USB.pm | 262 +++++++++++++++++++++++++
PVE/API2/Hardware.pm | 1 -
PVE/API2/Nodes.pm | 1 +
8 files changed, 644 insertions(+), 1 deletion(-)
create mode 100644 PVE/API2/Cluster/Resource.pm
create mode 100644 PVE/API2/Cluster/Resource/Makefile
create mode 100644 PVE/API2/Cluster/Resource/PCI.pm
create mode 100644 PVE/API2/Cluster/Resource/USB.pm
diff --git a/PVE/API2/Cluster.pm b/PVE/API2/Cluster.pm
index 2e9423685..60e1f5563 100644
--- a/PVE/API2/Cluster.pm
+++ b/PVE/API2/Cluster.pm
@@ -26,6 +26,7 @@ use PVE::API2::ACMEPlugin;
use PVE::API2::Backup;
use PVE::API2::Cluster::BackupInfo;
use PVE::API2::Cluster::Ceph;
+use PVE::API2::Cluster::Resource;
use PVE::API2::Cluster::Jobs;
use PVE::API2::Cluster::MetricServer;
use PVE::API2::ClusterConfig;
@@ -90,6 +91,12 @@ __PACKAGE__->register_method ({
subclass => "PVE::API2::Cluster::Jobs",
path => 'jobs',
});
+
+__PACKAGE__->register_method ({
+ subclass => "PVE::API2::Cluster::Resource",
+ path => 'resource',
+});
+
if ($have_sdn) {
__PACKAGE__->register_method ({
subclass => "PVE::API2::Network::SDN",
@@ -145,6 +152,7 @@ __PACKAGE__->register_method ({
{ name => 'options' },
{ name => 'replication' },
{ name => 'resources' },
+ { name => 'resource' },
{ name => 'status' },
{ name => 'tasks' },
];
diff --git a/PVE/API2/Cluster/Makefile b/PVE/API2/Cluster/Makefile
index 8d3065078..56b37a0d7 100644
--- a/PVE/API2/Cluster/Makefile
+++ b/PVE/API2/Cluster/Makefile
@@ -1,10 +1,13 @@
include ../../../defines.mk
+SUBDIRS=Resource
+
# for node independent, cluster-wide applicable, API endpoints
# ensure we do not conflict with files shipped by pve-cluster!!
PERLSOURCE= \
BackupInfo.pm \
MetricServer.pm \
+ Resource.pm \
Jobs.pm \
Ceph.pm
@@ -13,8 +16,10 @@ all:
.PHONY: clean
clean:
rm -rf *~
+ set -e && for i in ${SUBDIRS}; do ${MAKE} -C $$i $@; done
.PHONY: install
install: ${PERLSOURCE}
install -d ${PERLLIBDIR}/PVE/API2/Cluster
install -m 0644 ${PERLSOURCE} ${PERLLIBDIR}/PVE/API2/Cluster
+ set -e && for i in ${SUBDIRS}; do ${MAKE} -C $$i $@; done
diff --git a/PVE/API2/Cluster/Resource.pm b/PVE/API2/Cluster/Resource.pm
new file mode 100644
index 000000000..2c288d8f5
--- /dev/null
+++ b/PVE/API2/Cluster/Resource.pm
@@ -0,0 +1,53 @@
+package PVE::API2::Cluster::Resource;
+
+use strict;
+use warnings;
+
+use PVE::RESTHandler;
+
+use PVE::API2::Cluster::Resource::PCI;
+use PVE::API2::Cluster::Resource::USB;
+
+use base qw(PVE::RESTHandler);
+
+__PACKAGE__->register_method ({
+ subclass => "PVE::API2::Cluster::Resource::PCI",
+ path => 'pci',
+});
+
+__PACKAGE__->register_method ({
+ subclass => "PVE::API2::Cluster::Resource::USB",
+ path => 'usb',
+});
+
+__PACKAGE__->register_method ({
+ name => 'index',
+ path => '',
+ method => 'GET',
+ description => "List resource types.",
+ permissions => {
+ user => 'all',
+ },
+ parameters => {
+ additionalProperties => 0,
+ properties => {},
+ },
+ returns => {
+ type => 'array',
+ items => {
+ type => "object",
+ },
+ links => [ { rel => 'child', href => "{name}" } ],
+ },
+ code => sub {
+ my ($param) = @_;
+
+ my $result = [
+ { name => 'pci' },
+ { name => 'usb' },
+ ];
+
+ return $result;
+ }});
+
+1;
diff --git a/PVE/API2/Cluster/Resource/Makefile b/PVE/API2/Cluster/Resource/Makefile
new file mode 100644
index 000000000..720e91549
--- /dev/null
+++ b/PVE/API2/Cluster/Resource/Makefile
@@ -0,0 +1,18 @@
+include ../../../../defines.mk
+
+# for node independent, cluster-wide applicable, API endpoints
+# ensure we do not conflict with files shipped by pve-cluster!!
+PERLSOURCE= \
+ PCI.pm \
+ USB.pm
+
+all:
+
+.PHONY: clean
+clean:
+ rm -rf *~
+
+.PHONY: install
+install: ${PERLSOURCE}
+ install -d ${PERLLIBDIR}/PVE/API2/Cluster/Resource
+ install -m 0644 ${PERLSOURCE} ${PERLLIBDIR}/PVE/API2/Cluster/Resource
diff --git a/PVE/API2/Cluster/Resource/PCI.pm b/PVE/API2/Cluster/Resource/PCI.pm
new file mode 100644
index 000000000..cb641cc4d
--- /dev/null
+++ b/PVE/API2/Cluster/Resource/PCI.pm
@@ -0,0 +1,297 @@
+package PVE::API2::Cluster::Resource::PCI;
+
+use strict;
+use warnings;
+
+use Storable qw(dclone);
+
+use PVE::Cluster qw(cfs_lock_file);
+use PVE::Resource::PCI;
+use PVE::JSONSchema qw(get_standard_option);
+use PVE::Tools qw(extract_param);
+
+use PVE::RESTHandler;
+
+use base qw(PVE::RESTHandler);
+
+__PACKAGE__->register_method ({
+ name => 'index',
+ path => '',
+ method => 'GET',
+ # only proxy if we give the 'check-node' parameter
+ proxyto_callback => sub {
+ my ($rpcenv, $proxyto, $param) = @_;
+ return $param->{'check-node'} // 'localhost';
+ },
+ description => "PCI Hardware Mapping",
+ permissions => {
+ description => "Only lists entries where you have 'Resource.Modify', 'Resource.Use' ".
+ "permissions on '/resource/pci/<name>'.",
+ user => 'all',
+ },
+ parameters => {
+ additionalProperties => 0,
+ properties => {
+ 'check-node' => get_standard_option('pve-node', {
+ description => "If given, checks the configurations on the given node for ".
+ "correctness, and adds relevant errors to the devices.",
+ optional => 1,
+ }),
+ },
+ },
+ returns => {
+ type => 'array',
+ items => {
+ type => "object",
+ properties => {
+ id => {
+ type => 'string',
+ description => "The logical ID of the resource."
+ },
+ map => {
+ type => 'array',
+ description => "The node mappings for the resource.",
+ items => {
+ type => 'string',
+ description => "A mapping for a node.",
+ },
+ },
+ description => {
+ type => 'string',
+ description => "A description of the logical resource.",
+ },
+ error => {
+ properties => {
+ severity => {
+ type => "string",
+ description => "The severity of the error",
+ },
+ message => {
+ type => "string",
+ description => "The message of the error",
+ },
+ },
+ },
+ },
+ },
+ links => [ { rel => 'child', href => "{name}" } ],
+ },
+ code => sub {
+ my ($param) = @_;
+
+ my $rpcenv = PVE::RPCEnvironment::get();
+ my $authuser = $rpcenv->get_user();
+ my $node = $param->{'check-node'};
+
+ die "Wrong node to check\n" if defined($node) && $node ne PVE::INotify::nodename();
+
+ my $cfg = PVE::Resource::PCI::config();
+
+ my $res = [];
+
+ my $privs = ['Resource.Modify', 'Resource.Use'];
+
+ for my $id (keys $cfg->{ids}->%*) {
+ next if !$rpcenv->check_full($authuser, "/resource/pci/$id", $privs, 1, 1);
+ next if !$cfg->{ids}->{$id};
+
+ my $entry = dclone($cfg->{ids}->{$id});
+ $entry->{id} = $id;
+
+ if (defined($node)) {
+ $entry->{errors} = [];
+ if (my $mappings = PVE::Resource::PCI::get_node_mapping($cfg, $id, $node)) {
+ if (!scalar($mappings->@*)) {
+ push $entry->{errors}->@*, {
+ severity => 'warning',
+ message => "No mapping for node $node.",
+ };
+ }
+ for my $mapping ($mappings->@*) {
+ eval {
+ PVE::Resource::PCI::assert_valid($id, $mapping);
+ };
+ if (my $err = $@) {
+ push $entry->{errors}->@*, {
+ severity => 'error',
+ message => "Invalid configuration: $err",
+ };
+ }
+ }
+ }
+ }
+
+ push @$res, $entry;
+ }
+
+ return $res;
+ },
+});
+
+__PACKAGE__->register_method ({
+ name => 'get',
+ protected => 1,
+ path => '{id}',
+ method => 'GET',
+ description => "GET PCI Resource.",
+ permissions => {
+ check =>['or',
+ ['perm', '/resource/pci/{name}', ['Resource.Use']],
+ ['perm', '/resource/pci/{name}', ['Resource.Modify']],
+ ],
+ },
+ parameters => {
+ additionalProperties => 0,
+ properties => {
+ id => {
+ type => 'string',
+ format => 'pve-configid',
+ },
+ }
+ },
+ returns => { type => 'object' },
+ code => sub {
+ my ($param) = @_;
+
+ my $cfg = PVE::Resource::PCI::config();
+ my $name = $param->{id};
+
+ die "mapping '$param->{name}' not found\n" if !defined($cfg->{ids}->{$name});
+
+ my $data = dclone($cfg->{ids}->{$name});
+
+ $data->{digest} = $cfg->{digest};
+
+ return $data;
+ }});
+
+__PACKAGE__->register_method ({
+ name => 'create',
+ protected => 1,
+ path => '',
+ method => 'POST',
+ description => "Create a new hardware mapping.",
+ permissions => {
+ check => ['perm', '/resource/pci/{name}', ['Resource.Modify']],
+ },
+ # todo parameters
+ parameters => PVE::Resource::PCI->createSchema(1),
+ returns => {
+ type => 'null',
+ },
+ code => sub {
+ my ($param) = @_;
+
+ my $id = extract_param($param, 'id');
+
+ $param->{map} = [$param->{map}] if defined($param->{map}) && !ref($param->{map});
+
+ my $plugin = PVE::Resource::PCI->lookup('pci');
+ my $opts = $plugin->check_config($id, $param, 1, 1);
+
+ PVE::Resource::PCI::lock_pci_config(sub {
+ my $cfg = PVE::Resource::PCI::config();
+
+ die "pci ID '$id' already defined\n" if defined($cfg->{ids}->{$id});
+
+ $cfg->{ids}->{$id} = $opts;
+
+ PVE::Resource::PCI::write_pci_config($cfg);
+
+ }, "create hardware mapping failed");
+
+ return;
+ },
+});
+
+__PACKAGE__->register_method ({
+ name => 'update',
+ protected => 1,
+ path => '{id}',
+ method => 'PUT',
+ description => "Update a hardware mapping.",
+ permissions => {
+ check => ['perm', '/resource/pci/{id}', ['Resource.Modify']],
+ },
+ parameters => PVE::Resource::PCI->updateSchema(),
+ returns => {
+ type => 'null',
+ },
+ code => sub {
+ my ($param) = @_;
+
+ my $digest = extract_param($param, 'digest');
+ my $delete = extract_param($param, 'delete');
+ my $id = extract_param($param, 'id');
+
+ if ($delete) {
+ $delete = [ PVE::Tools::split_list($delete) ];
+ }
+
+ $param->{map} = [$param->{map}] if defined($param->{map}) && !ref($param->{map});
+
+ PVE::Resource::PCI::lock_pci_config(sub {
+ my $cfg = PVE::Resource::PCI::config();
+
+ PVE::Tools::assert_if_modified($cfg->{digest}, $digest) if defined($digest);
+
+ die "pci ID '$id' does not exist\n" if !defined($cfg->{ids}->{$id});
+
+ my $plugin = PVE::Resource::PCI->lookup('pci');
+ my $opts = $plugin->check_config($id, $param, 1, 1);
+
+ my $data = $cfg->{ids}->{$id};
+
+ my $options = $plugin->private()->{options}->{pci};
+ PVE::SectionConfig::delete_from_config($data, $options, $opts, $delete);
+
+ $data->{$_} = $opts->{$_} for keys $opts->%*;
+
+ PVE::Resource::PCI::write_pci_config($cfg);
+
+ }, "update hardware mapping failed");
+
+ return;
+ },
+});
+
+__PACKAGE__->register_method ({
+ name => 'delete',
+ protected => 1,
+ path => '{id}',
+ method => 'DELETE',
+ description => "Remove Hardware Mapping.",
+ permissions => {
+ check => [ 'perm', '/resource/pci/{id}', ['Resource.Modify']],
+ },
+ parameters => {
+ additionalProperties => 0,
+ properties => {
+ id => {
+ type => 'string',
+ format => 'pve-configid',
+ },
+ }
+ },
+ returns => { type => 'null' },
+ code => sub {
+ my ($param) = @_;
+
+ my $id = $param->{id};
+
+ PVE::Resource::PCI::lock_pci_config(sub {
+ my $cfg = PVE::Resource::PCI::config();
+
+ if ($cfg->{ids}->{$id}) {
+ delete $cfg->{ids}->{$id};
+ }
+
+ PVE::Resource::PCI::write_pci_config($cfg);
+
+ }, "delete pci mapping failed");
+
+ return;
+ }
+});
+
+1;
diff --git a/PVE/API2/Cluster/Resource/USB.pm b/PVE/API2/Cluster/Resource/USB.pm
new file mode 100644
index 000000000..c47066b69
--- /dev/null
+++ b/PVE/API2/Cluster/Resource/USB.pm
@@ -0,0 +1,262 @@
+package PVE::API2::Cluster::Resource::USB;
+
+use strict;
+use warnings;
+
+use Storable qw(dclone);
+
+use PVE::Cluster qw(cfs_lock_file);
+use PVE::Resource::USB;
+use PVE::JSONSchema qw(get_standard_option);
+use PVE::Tools qw(extract_param);
+
+use PVE::RESTHandler;
+
+use base qw(PVE::RESTHandler);
+
+__PACKAGE__->register_method ({
+ name => 'index',
+ path => '',
+ method => 'GET',
+ description => "USB Hardware Mapping",
+ permissions => {
+ description => "Only lists entries where you have 'Resource.Modify', 'Resource.Use' permissions on '/resource/usb/<name>'.",
+ user => 'all',
+ },
+ parameters => {
+ additionalProperties => 0,
+ properties => {
+ 'check-node' => get_standard_option('pve-node', {
+ description => "If given, checks the configurations on the given node for ".
+ "correctness, and adds relevant errors to the devices.",
+ optional => 1,
+ }),
+ },
+ },
+ returns => {
+ type => 'array',
+ items => {
+ type => "object",
+ properties => { name => { type => 'string'} },
+ },
+ links => [ { rel => 'child', href => "{name}" } ],
+ },
+ code => sub {
+ my ($param) = @_;
+
+ my $rpcenv = PVE::RPCEnvironment::get();
+ my $authuser = $rpcenv->get_user();
+ my $node = $param->{'check-node'};
+
+ die "Wrong node to check\n" if defined($node) && $node ne PVE::INotify::nodename();
+
+ my $cfg = PVE::Resource::USB::config();
+
+ my $res = [];
+
+ my $privs = ['Resource.Modify', 'Resource.Use'];
+
+ for my $id (keys $cfg->{ids}->%*) {
+ next if !$rpcenv->check_full($authuser, "/resource/usb/$id", $privs, 1, 1);
+ next if !$cfg->{ids}->{$id};
+
+ my $entry = dclone($cfg->{ids}->{$id});
+ $entry->{name} = $id;
+
+ if (defined($node)) {
+ $entry->{errors} = [];
+ if (my $mappings = PVE::Resource::USB::get_node_mapping($cfg, $id, $node)) {
+ if (!scalar($mappings->@*)) {
+ push $entry->{errors}->@*, {
+ severity => 'warning',
+ message => "No mapping for node $node.",
+ };
+ }
+ for my $mapping ($mappings->@*) {
+ eval {
+ PVE::Resource::USB::assert_valid($id, $mapping);
+ };
+ if (my $err = $@) {
+ push $entry->{errors}->@*, {
+ severity => 'error',
+ message => "Invalid configuration: $err",
+ };
+ }
+ }
+ }
+ }
+
+ push @$res, $entry;
+ }
+
+ return $res;
+ },
+});
+
+__PACKAGE__->register_method ({
+ name => 'get',
+ protected => 1,
+ path => '{id}',
+ method => 'GET',
+ description => "GET USB Resource.",
+ permissions => {
+ check =>['or',
+ ['perm', '/resource/usb/{name}', ['Resource.Use']],
+ ['perm', '/resource/usb/{name}', ['Resource.Modify']],
+ ],
+ },
+ parameters => {
+ additionalProperties => 0,
+ properties => {
+ id => {
+ type => 'string',
+ format => 'pve-configid',
+ },
+ }
+ },
+ returns => { type => 'object' },
+ code => sub {
+ my ($param) = @_;
+
+ my $cfg = PVE::Resource::USB::config();
+ my $name = $param->{id};
+
+ die "mapping '$param->{name}' not found\n" if !defined($cfg->{ids}->{$name});
+
+ my $data = dclone($cfg->{ids}->{$name});
+
+ $data->{digest} = $cfg->{digest};
+
+ return $data;
+ }});
+
+__PACKAGE__->register_method ({
+ name => 'create',
+ protected => 1,
+ path => '',
+ method => 'POST',
+ description => "Create a new hardware mapping.",
+ permissions => {
+ check => ['perm', '/resource/usb/{name}', ['Resource.Modify']],
+ },
+ # todo parameters
+ parameters => PVE::Resource::USB->createSchema(1),
+ returns => {
+ type => 'null',
+ },
+ code => sub {
+ my ($param) = @_;
+
+ my $id = extract_param($param, 'id');
+
+ $param->{map} = [$param->{map}] if defined($param->{map}) && !ref($param->{map});
+
+ my $plugin = PVE::Resource::USB->lookup('usb');
+ my $opts = $plugin->check_config($id, $param, 1, 1);
+
+ PVE::Resource::USB::lock_usb_config(sub {
+ my $cfg = PVE::Resource::USB::config();
+
+ die "usb ID '$id' already defined\n" if defined($cfg->{ids}->{$id});
+
+ $cfg->{ids}->{$id} = $opts;
+
+ PVE::Resource::USB::write_usb_config($cfg);
+
+ }, "create hardware mapping failed");
+
+ return;
+ },
+});
+
+__PACKAGE__->register_method ({
+ name => 'update',
+ protected => 1,
+ path => '{id}',
+ method => 'PUT',
+ description => "Update a hardware mapping.",
+ permissions => {
+ check => ['perm', '/resource/usb/{id}', ['Resource.Modify']],
+ },
+ parameters => PVE::Resource::USB->updateSchema(),
+ returns => {
+ type => 'null',
+ },
+ code => sub {
+ my ($param) = @_;
+
+ my $digest = extract_param($param, 'digest');
+ my $delete = extract_param($param, 'delete');
+ my $id = extract_param($param, 'id');
+
+ if ($delete) {
+ $delete = [ PVE::Tools::split_list($delete) ];
+ }
+
+ $param->{map} = [$param->{map}] if defined($param->{map}) && !ref($param->{map});
+
+ PVE::Resource::USB::lock_usb_config(sub {
+ my $cfg = PVE::Resource::USB::config();
+
+ PVE::Tools::assert_if_modified($cfg->{digest}, $digest) if defined($digest);
+
+ die "usb ID '$id' does not exist\n" if !defined($cfg->{ids}->{$id});
+
+ my $plugin = PVE::Resource::USB->lookup('usb');
+ my $opts = $plugin->check_config($id, $param, 1, 1);
+
+ my $data = $cfg->{ids}->{$id};
+
+ my $options = $plugin->private()->{options}->{usb};
+ PVE::SectionConfig::delete_from_config($data, $options, $opts, $delete);
+
+ $data->{$_} = $opts->{$_} for keys $opts->%*;
+
+ PVE::Resource::USB::write_usb_config($cfg);
+
+ }, "update hardware mapping failed");
+
+ return;
+ },
+});
+
+__PACKAGE__->register_method ({
+ name => 'delete',
+ protected => 1,
+ path => '{id}',
+ method => 'DELETE',
+ description => "Remove Hardware Mapping.",
+ permissions => {
+ check => [ 'perm', '/resource/usb/{id}', ['Resource.Modify']],
+ },
+ parameters => {
+ additionalProperties => 0,
+ properties => {
+ id => {
+ type => 'string',
+ format => 'pve-configid',
+ },
+ }
+ },
+ returns => { type => 'null' },
+ code => sub {
+ my ($param) = @_;
+
+ my $id = $param->{id};
+
+ PVE::Resource::USB::lock_usb_config(sub {
+ my $cfg = PVE::Resource::USB::config();
+
+ if ($cfg->{ids}->{$id}) {
+ delete $cfg->{ids}->{$id};
+ }
+
+ PVE::Resource::USB::write_usb_config($cfg);
+
+ }, "delete usb mapping failed");
+
+ return;
+ }
+});
+
+1;
diff --git a/PVE/API2/Hardware.pm b/PVE/API2/Hardware.pm
index f59bfbe0e..1c6fd8f5c 100644
--- a/PVE/API2/Hardware.pm
+++ b/PVE/API2/Hardware.pm
@@ -21,7 +21,6 @@ __PACKAGE__->register_method ({
path => 'usb',
});
-
__PACKAGE__->register_method ({
name => 'index',
path => '',
diff --git a/PVE/API2/Nodes.pm b/PVE/API2/Nodes.pm
index bfe5c40a1..bf498bedf 100644
--- a/PVE/API2/Nodes.pm
+++ b/PVE/API2/Nodes.pm
@@ -278,6 +278,7 @@ __PACKAGE__->register_method ({
{ name => 'query-url-metadata' },
{ name => 'replication' },
{ name => 'report' },
+ { name => 'resource-map' },
{ name => 'rrd' }, # fixme: remove?
{ name => 'rrddata' },# fixme: remove?
{ name => 'scan' },
--
2.30.2
More information about the pve-devel
mailing list