Store allocated RP in InstancePCIRequest

After the scheduler selected a target host and allocated an allocation
candidate that is passed the filters nova need to make sure that PCI
claim will allocate the real PCI devices from the RP which is allocated
in placement. Placement returns the request group - provider mapping for
each allocation candidate so nova can map which InstancePCIRequest was
fulfilled from which RP in the selected allocation candidate. This
mapping is then recorded in the InstancePCIRequest object and used
during the PCI claim to filter for PCI pools that can be used to claim
PCI devices from.

blueprint: pci-device-tracking-in-placement
Change-Id: I18bb31e23cc014411db68c31317ed983886d1a8e

6 files changed, 164 insertions, 32 deletions

diff --git a/nova/tests/unit/compute/test_compute.py b/nova/tests/unit/compute/test_compute.py
index 314c29f583..8eeb5f8f58 100644
--- a/nova/tests/unit/compute/test_compute.py
+++ b/nova/tests/unit/compute/test_compute.py
@@ -10843,7 +10843,7 @@ class ComputeAPITestCase(BaseTestCase):
                 'add_resources_to_instance_allocation'),
             mock.patch(
                 'nova.compute.utils.'
-                'update_pci_request_spec_with_allocated_interface_name'),
+                'update_pci_request_with_placement_allocations'),
         ) as (
             mock_get_nodename, mock_get_alloc_candidates, mock_add_res,
             mock_update_pci
@@ -10913,7 +10913,7 @@ class ComputeAPITestCase(BaseTestCase):
                 new=mock.NonCallableMock()),
             mock.patch(
                 'nova.compute.utils.'
-                'update_pci_request_spec_with_allocated_interface_name',
+                'update_pci_request_with_placement_allocations',
                 new=mock.NonCallableMock()),
         ) as (
             mock_get_nodename, mock_get_alloc_candidates, mock_add_res,
@@ -10958,7 +10958,7 @@ class ComputeAPITestCase(BaseTestCase):
                 'add_resources_to_instance_allocation'),
             mock.patch(
                 'nova.compute.utils.'
-                'update_pci_request_spec_with_allocated_interface_name',
+                'update_pci_request_with_placement_allocations',
                 new=mock.NonCallableMock()),
         ) as (
             mock_get_nodename, mock_get_alloc_candidates, mock_add_res,
@@ -11025,7 +11025,7 @@ class ComputeAPITestCase(BaseTestCase):
                 'add_resources_to_instance_allocation'),
             mock.patch(
                 'nova.compute.utils.'
-                'update_pci_request_spec_with_allocated_interface_name'),
+                'update_pci_request_with_placement_allocations'),
             mock.patch(
                 'nova.scheduler.client.report.SchedulerReportClient.'
                 'remove_resources_from_instance_allocation'),
@@ -13520,7 +13520,7 @@ class EvacuateHostTestCase(BaseTestCase):
             return_value=mock.sentinel.mapping)
         @mock.patch(
             'nova.compute.utils.'
-            'update_pci_request_spec_with_allocated_interface_name')
+            'update_pci_request_with_placement_allocations')
         @mock.patch('nova.compute.utils.notify_about_instance_action')
         @mock.patch('nova.compute.utils.notify_about_instance_rebuild')
         @mock.patch.object(network_api, 'setup_networks_on_host')
diff --git a/nova/tests/unit/compute/test_compute_mgr.py b/nova/tests/unit/compute/test_compute_mgr.py
index b8eef08d60..c3ccb221c3 100644
--- a/nova/tests/unit/compute/test_compute_mgr.py
+++ b/nova/tests/unit/compute/test_compute_mgr.py
@@ -8487,11 +8487,17 @@ class ComputeManagerBuildInstanceTestCase(test.NoDBTestCase):
         # resource request and therefore no matching request group exists in
         # the request spec.
         self.instance.pci_requests = objects.InstancePCIRequests(requests=[
-            objects.InstancePCIRequest(),
             objects.InstancePCIRequest(
+                request_id=uuids.req0,
+            ),
+            objects.InstancePCIRequest(
+                request_id=uuids.req1,
                 requester_id=uuids.port1,
                 spec=[{'vendor_id': '1377', 'product_id': '0047'}]),
-            objects.InstancePCIRequest(requester_id=uuids.port2),
+            objects.InstancePCIRequest(
+                request_id=uuids.req2,
+                requester_id=uuids.port2,
+            ),
         ])
         with test.nested(
                 mock.patch.object(self.compute.driver, 'spawn'),
@@ -8536,8 +8542,13 @@ class ComputeManagerBuildInstanceTestCase(test.NoDBTestCase):
                     requester_id=uuids.port1,
                     provider_uuids=[uuids.rp1])])
 
-        self.instance.pci_requests = objects.InstancePCIRequests(requests=[
-            objects.InstancePCIRequest(requester_id=uuids.port1)])
+        self.instance.pci_requests = objects.InstancePCIRequests(
+            requests=[
+                objects.InstancePCIRequest(
+                    requester_id=uuids.port1, request_id=uuids.req1
+                )
+            ]
+        )
         with mock.patch('nova.scheduler.client.report.SchedulerReportClient.'
                          '_get_resource_provider') as (mock_get_rp):
             mock_get_rp.return_value = None
@@ -8559,8 +8570,13 @@ class ComputeManagerBuildInstanceTestCase(test.NoDBTestCase):
                     requester_id=uuids.port1,
                     provider_uuids=[uuids.rp1])])
 
-        self.instance.pci_requests = objects.InstancePCIRequests(requests=[
-            objects.InstancePCIRequest(requester_id=uuids.port1)])
+        self.instance.pci_requests = objects.InstancePCIRequests(
+            requests=[
+                objects.InstancePCIRequest(
+                    requester_id=uuids.port1, request_id=uuids.req1
+                )
+            ]
+        )
         with mock.patch('nova.scheduler.client.report.SchedulerReportClient.'
                          '_get_resource_provider') as (mock_get_rp):
             mock_get_rp.return_value = {
@@ -8584,8 +8600,13 @@ class ComputeManagerBuildInstanceTestCase(test.NoDBTestCase):
                     requester_id=uuids.port1,
                     provider_uuids=[uuids.rp1, uuids.rp2])])
 
-        self.instance.pci_requests = objects.InstancePCIRequests(requests=[
-            objects.InstancePCIRequest(requester_id=uuids.port1)])
+        self.instance.pci_requests = objects.InstancePCIRequests(
+            requests=[
+                objects.InstancePCIRequest(
+                    requester_id=uuids.port1, request_id=uuids.req1
+                )
+            ]
+        )
 
         self.assertRaises(
             exception.BuildAbortException,
@@ -11040,7 +11061,7 @@ class ComputeManagerMigrationTestCase(test.NoDBTestCase,
     @mock.patch('nova.compute.resource_tracker.ResourceTracker.resize_claim')
     @mock.patch('nova.objects.Instance.save')
     @mock.patch('nova.compute.utils.'
-                'update_pci_request_spec_with_allocated_interface_name')
+                'update_pci_request_with_placement_allocations')
     @mock.patch('nova.compute.utils.notify_usage_exists')
     @mock.patch('nova.compute.manager.ComputeManager.'
                 '_notify_about_instance_usage')
@@ -11074,7 +11095,7 @@ class ComputeManagerMigrationTestCase(test.NoDBTestCase,
     @mock.patch('nova.compute.resource_tracker.ResourceTracker.resize_claim')
     @mock.patch('nova.objects.Instance.save')
     @mock.patch('nova.compute.utils.'
-                'update_pci_request_spec_with_allocated_interface_name')
+                'update_pci_request_with_placement_allocations')
     @mock.patch('nova.compute.utils.notify_usage_exists')
     @mock.patch('nova.compute.manager.ComputeManager.'
                 '_notify_about_instance_usage')
diff --git a/nova/tests/unit/compute/test_shelve.py b/nova/tests/unit/compute/test_shelve.py
index c939b927f1..f95a722ced 100644
--- a/nova/tests/unit/compute/test_shelve.py
+++ b/nova/tests/unit/compute/test_shelve.py
@@ -281,7 +281,7 @@ class ShelveComputeManagerTestCase(test_compute.BaseTestCase):
         return instance
 
     @mock.patch('nova.compute.utils.'
-                'update_pci_request_spec_with_allocated_interface_name',
+                'update_pci_request_with_placement_allocations',
                 new=mock.NonCallableMock())
     @mock.patch('nova.objects.BlockDeviceMappingList.get_by_instance_uuid')
     @mock.patch('nova.compute.utils.notify_about_instance_action')
@@ -631,7 +631,7 @@ class ShelveComputeManagerTestCase(test_compute.BaseTestCase):
 
     @mock.patch('nova.network.neutron.API.setup_instance_network_on_host')
     @mock.patch('nova.compute.utils.'
-                'update_pci_request_spec_with_allocated_interface_name')
+                'update_pci_request_with_placement_allocations')
     def test_unshelve_with_resource_request(
             self, mock_update_pci, mock_setup_network):
         requested_res = [objects.RequestGroup(
@@ -655,7 +655,7 @@ class ShelveComputeManagerTestCase(test_compute.BaseTestCase):
     @mock.patch('nova.network.neutron.API.setup_instance_network_on_host',
                 new=mock.NonCallableMock())
     @mock.patch('nova.compute.utils.'
-                'update_pci_request_spec_with_allocated_interface_name')
+                'update_pci_request_with_placement_allocations')
     def test_unshelve_with_resource_request_update_raises(
             self, mock_update_pci):
         requested_res = [objects.RequestGroup(
diff --git a/nova/tests/unit/compute/test_utils.py b/nova/tests/unit/compute/test_utils.py
index 848050d769..c77e39ceac 100644
--- a/nova/tests/unit/compute/test_utils.py
+++ b/nova/tests/unit/compute/test_utils.py
@@ -1558,47 +1558,86 @@ class PciRequestUpdateTestCase(test.NoDBTestCase):
     def test_no_pci_request(self):
         provider_mapping = {}
 
-        compute_utils.update_pci_request_spec_with_allocated_interface_name(
+        compute_utils.update_pci_request_with_placement_allocations(
             self.context, mock.sentinel.report_client, [], provider_mapping)
 
-    def test_pci_request_from_flavor(self):
-        pci_requests = [objects.InstancePCIRequest(requester_id=None)]
+    def test_pci_request_from_flavor_no_mapping(self):
+        req = objects.InstancePCIRequest(
+            requester_id=None,
+            request_id=uuids.req1,
+            alias_name="a-dev",
+            spec=[{}],
+        )
+        pci_requests = [req]
+
         provider_mapping = {}
 
-        compute_utils.update_pci_request_spec_with_allocated_interface_name(
+        compute_utils.update_pci_request_with_placement_allocations(
+            self.context, mock.sentinel.report_client, pci_requests,
+            provider_mapping)
+
+        self.assertNotIn('rp_uuids', req.spec[0])
+
+    def test_pci_request_from_flavor_with_mapping(self):
+        req = objects.InstancePCIRequest(
+            requester_id=None,
+            request_id=uuids.req1,
+            alias_name="a-dev",
+            spec=[{}],
+        )
+        pci_requests = [req]
+
+        provider_mapping = {
+            f"{uuids.req1}-0": [uuids.rp1],
+            f"{uuids.req1}-1": [uuids.rp2],
+        }
+
+        compute_utils.update_pci_request_with_placement_allocations(
             self.context, mock.sentinel.report_client, pci_requests,
             provider_mapping)
 
+        self.assertEqual(
+            ",".join({uuids.rp1, uuids.rp2}), req.spec[0]["rp_uuids"]
+        )
+
     def test_pci_request_has_no_mapping(self):
         pci_requests = [objects.InstancePCIRequest(requester_id=uuids.port_1)]
         provider_mapping = {}
 
-        compute_utils.update_pci_request_spec_with_allocated_interface_name(
+        compute_utils.update_pci_request_with_placement_allocations(
             self.context, mock.sentinel.report_client, pci_requests,
             provider_mapping)
 
     def test_pci_request_ambiguous_mapping(self):
-        pci_requests = [objects.InstancePCIRequest(requester_id=uuids.port_1)]
+        pci_requests = [
+            objects.InstancePCIRequest(
+                requester_id=uuids.port_1, request_id=uuids.req1
+            )
+        ]
         provider_mapping = {uuids.port_1: [uuids.rp1, uuids.rp2]}
 
         self.assertRaises(
             exception.AmbiguousResourceProviderForPCIRequest,
             (compute_utils.
-             update_pci_request_spec_with_allocated_interface_name),
+             update_pci_request_with_placement_allocations),
             self.context, mock.sentinel.report_client, pci_requests,
             provider_mapping)
 
     def test_unexpected_provider_name(self):
         report_client = mock.Mock(spec=report.SchedulerReportClient)
         report_client.get_resource_provider_name.return_value = 'unexpected'
-        pci_requests = [objects.InstancePCIRequest(
-            requester_id=uuids.port_1, spec=[{}])]
+        pci_requests = [
+            objects.InstancePCIRequest(
+                requester_id=uuids.port_1, spec=[{}], request_id=uuids.req1
+            )
+        ]
+
         provider_mapping = {uuids.port_1: [uuids.rp1]}
 
         self.assertRaises(
             exception.UnexpectedResourceProviderNameForPCIRequest,
             (compute_utils.
-             update_pci_request_spec_with_allocated_interface_name),
+             update_pci_request_with_placement_allocations),
             self.context, report_client, pci_requests,
             provider_mapping)
 
@@ -1610,11 +1649,14 @@ class PciRequestUpdateTestCase(test.NoDBTestCase):
         report_client = mock.Mock(spec=report.SchedulerReportClient)
         report_client.get_resource_provider_name.return_value = (
             'host:agent:enp0s31f6')
-        pci_requests = [objects.InstancePCIRequest(
-            requester_id=uuids.port_1, spec=[{}],)]
+        pci_requests = [
+            objects.InstancePCIRequest(
+                requester_id=uuids.port_1, spec=[{}], request_id=uuids.req1
+            )
+        ]
         provider_mapping = {uuids.port_1: [uuids.rp1]}
 
-        compute_utils.update_pci_request_spec_with_allocated_interface_name(
+        compute_utils.update_pci_request_with_placement_allocations(
             self.context, report_client, pci_requests, provider_mapping)
 
         report_client.get_resource_provider_name.assert_called_once_with(
diff --git a/nova/tests/unit/conductor/tasks/test_live_migrate.py b/nova/tests/unit/conductor/tasks/test_live_migrate.py
index de15be28bd..4e888139f6 100644
--- a/nova/tests/unit/conductor/tasks/test_live_migrate.py
+++ b/nova/tests/unit/conductor/tasks/test_live_migrate.py
@@ -761,7 +761,7 @@ class LiveMigrationTaskTestCase(test.NoDBTestCase):
 
     @mock.patch(
         'nova.compute.utils.'
-        'update_pci_request_spec_with_allocated_interface_name')
+        'update_pci_request_with_placement_allocations')
     @mock.patch('nova.scheduler.utils.fill_provider_mapping')
     @mock.patch.object(live_migrate.LiveMigrationTask,
                        '_call_livem_checks_on_host')
diff --git a/nova/tests/unit/pci/test_stats.py b/nova/tests/unit/pci/test_stats.py
index b76309092a..2d48513e0e 100644
--- a/nova/tests/unit/pci/test_stats.py
+++ b/nova/tests/unit/pci/test_stats.py
@@ -1349,6 +1349,75 @@ class PciDeviceStatsProviderMappingTestCase(test.NoDBTestCase):
             {pool['rp_uuid'] for pool in self.pci_stats.pools},
         )
 
+    def test_apply_gets_requested_uuids_from_pci_req(self):
+        pf_req = objects.InstancePCIRequest(
+            count=1,
+            alias_name='a-dev',
+            request_id=uuids.req1,
+            spec=[
+                {
+                    "vendor_id": "dead",
+                    "product_id": "beef",
+                    "dev_type": "type-PF",
+                    # Simulate that the scheduler already allocate a candidate
+                    # and the mapping is stored in the request.
+                    # The allocation restricts that we can only consume from
+                    # PF3
+                    "rp_uuids": ",".join([uuids.pf3])
+                }
+            ],
+        )
+
+        # call apply with None mapping signalling that the allocation is
+        # already done and the resulted mapping is stored in the request
+        self.pci_stats.apply_requests([pf_req], provider_mapping=None)
+
+        # assert that the right device is consumed
+        self.assertEqual(self.num_pools - 1, len(self.pci_stats.pools))
+        self.assertEqual(
+            self.num_devs - 1,
+            sum(pool["count"] for pool in self.pci_stats.pools),
+        )
+        # pf3 is not available in the pools anymore
+        self.assertEqual(
+            {uuids.pf1, uuids.pf2, uuids.pci1},
+            {pool['rp_uuid'] for pool in self.pci_stats.pools},
+        )
+
+    def test_consume_restricted_by_allocation(self):
+        pf_req = objects.InstancePCIRequest(
+            count=1,
+            alias_name='a-dev',
+            request_id=uuids.req1,
+            spec=[
+                {
+                    "vendor_id": "dead",
+                    "product_id": "beef",
+                    "dev_type": "type-PF",
+                    # Simulate that the scheduler already allocate a candidate
+                    # and the mapping is stored in the request.
+                    # The allocation restricts that we can only consume from
+                    # PF3
+                    "rp_uuids": ",".join([uuids.pf3])
+                }
+            ],
+        )
+
+        # Call consume. It always expects the allocated mapping to be stores
+        # the in PCI request as it is always called from the compute side.
+        consumed_devs = self.pci_stats.consume_requests([pf_req])
+        # assert that the right device is consumed
+        self.assertEqual([self.pf3], consumed_devs)
+        # pf3 is not available in the pools anymore
+        self.assertEqual(
+            {uuids.pf1, uuids.pf2, uuids.pci1},
+            {
+                pool["rp_uuid"]
+                for pool in self.pci_stats.pools
+                if pool["count"] > 0
+            },
+        )
+
 
 class PciDeviceVFPFStatsTestCase(test.NoDBTestCase):