objects: Introduce the 'CPUAllocationPolicy.MIXED' enum

huaqiangwang · huaqiangwang · commit ba3388d666ad · 2020-07-15T00:39:46.000+08:00
Introduce a 'mixed' instance CPU allocation policy and will be worked with upcoming patches, for purpose of creating an instance combined shared CPUs with dedicated or realtime CPUs. In an instance mixed with different type of CPUs, the shared CPU shared CPU time slots with other instances, and also might be a CPU with less or un-guaranteed hardware resources, which implies to have no guarantee for the behavior of the workload running on it. If we call the shared CPU as 'low priority' CPU, then the realtime or dedicated CPU could be called as 'high priority' CPU, user could assign more hardware CPU resources or place some guaranteed resource to it to let the workload to entail high performance or stable service quality. Based on https://review.opendev.org/714704 Part of blueprint use-pcpu-and-vcpu-in-one-instance Change-Id: I99cfee14bb105a8792651129426c0c5a3749796d Signed-off-by: Wang Huaqiang <huaqiang.wang@intel.com>
diff --git a/doc/notification_samples/common_payloads/ImageMetaPropsPayload.json b/doc/notification_samples/common_payloads/ImageMetaPropsPayload.json
@@ -4,5 +4,5 @@
         "hw_architecture": "x86_64"
     },
     "nova_object.name": "ImageMetaPropsPayload",
-    "nova_object.version": "1.3"
+    "nova_object.version": "1.4"
 }
diff --git a/doc/notification_samples/common_payloads/InstanceNUMACellPayload.json b/doc/notification_samples/common_payloads/InstanceNUMACellPayload.json
@@ -1,5 +1,5 @@
 {
-    "nova_object.version": "1.1",
+    "nova_object.version": "1.2",
     "nova_object.namespace": "nova",
     "nova_object.name": "InstanceNUMACellPayload",
     "nova_object.data": {
diff --git a/nova/api/openstack/compute/servers.py b/nova/api/openstack/compute/servers.py
@@ -87,6 +87,8 @@
     exception.PciRequestAliasNotDefined,
     exception.RealtimeConfigurationInvalid,
     exception.RealtimeMaskNotFoundOrInvalid,
+    exception.RequiredMixedInstancePolicy,
+    exception.RequiredMixedOrRealtimeCPUMask,
 )
 
 MIN_COMPUTE_MOVE_BANDWIDTH = 39
diff --git a/nova/api/validation/extra_specs/hw.py b/nova/api/validation/extra_specs/hw.py
@@ -63,14 +63,17 @@
             'CPUs can run on. If ``shared`` (default), guest CPUs can be '
             'overallocated but cannot float across host cores. If '
             '``dedicated``, guest CPUs cannot be overallocated but are '
-            'individually pinned to their own host core.'
+            'individually pinned to their own host core. ``mixed`` is a '
+            'policy with which the guest is mixing the overallocated and '
+            'pinned guest CPUs.'
         ),
         value={
             'type': str,
             'description': 'The CPU policy.',
             'enum': [
                 'dedicated',
-                'shared'
+                'shared',
+                'mixed',
             ],
         },
     ),
diff --git a/nova/exception.py b/nova/exception.py
@@ -2314,3 +2314,14 @@ class AcceleratorRequestOpFailed(NovaException):
 
 class InvalidLibvirtGPUConfig(NovaException):
     msg_fmt = _('Invalid configuration for GPU devices: %(reason)s')
+
+
+class RequiredMixedInstancePolicy(Invalid):
+    msg_fmt = _("Cannot specify 'hw:cpu_dedicated_mask' without the "
+                "'mixed' policy.")
+
+
+class RequiredMixedOrRealtimeCPUMask(Invalid):
+    msg_fmt = _("Must specify either 'hw:cpu_dedicated_mask' or "
+                "'hw:cpu_realtime_mask' when using 'mixed' CPU policy"
+                " instance.")
diff --git a/nova/notifications/objects/image.py b/nova/notifications/objects/image.py
@@ -120,7 +120,8 @@ class ImageMetaPropsPayload(base.NotificationPayloadBase):
     # Version 1.1: Added 'gop', 'virtio' and  'none' to hw_video_model field
     # Version 1.2: Added hw_pci_numa_affinity_policy field
     # Version 1.3: Added hw_mem_encryption, hw_pmu and hw_time_hpet fields
-    VERSION = '1.3'
+    # Version 1.4: Added 'mixed' to hw_cpu_policy field
+    VERSION = '1.4'
 
     SCHEMA = {
         k: ('image_meta_props', k) for k in image_meta.ImageMetaProps.fields}
diff --git a/nova/notifications/objects/request_spec.py b/nova/notifications/objects/request_spec.py
@@ -144,7 +144,8 @@ def __init__(self, numa_topology):
 class InstanceNUMACellPayload(base.NotificationPayloadBase):
     # Version 1.0: Initial version
     # Version 1.1: Added pcpuset field
-    VERSION = '1.1'
+    # Version 1.2: Added 'mixed' to cpu_policy field
+    VERSION = '1.2'
 
     SCHEMA = {
         'id': ('numa_cell', 'id'),
diff --git a/nova/objects/fields.py b/nova/objects/fields.py
@@ -272,8 +272,9 @@ class CPUAllocationPolicy(BaseNovaEnum):
 
     DEDICATED = "dedicated"
     SHARED = "shared"
+    MIXED = "mixed"
 
-    ALL = (DEDICATED, SHARED)
+    ALL = (DEDICATED, SHARED, MIXED)
 
 
 class CPUThreadAllocationPolicy(BaseNovaEnum):
diff --git a/nova/objects/image_meta.py b/nova/objects/image_meta.py
@@ -175,14 +175,22 @@ class ImageMetaProps(base.NovaObject):
     # Version 1.23: Added 'hw_pmu' field
     # Version 1.24: Added 'hw_mem_encryption' field
     # Version 1.25: Added 'hw_pci_numa_affinity_policy' field
+    # Version 1.26: Added 'mixed' to 'hw_cpu_policy' field
     # NOTE(efried): When bumping this version, the version of
     # ImageMetaPropsPayload must also be bumped. See its docstring for details.
-    VERSION = '1.25'
+    VERSION = '1.26'
 
     def obj_make_compatible(self, primitive, target_version):
         super(ImageMetaProps, self).obj_make_compatible(primitive,
                                                         target_version)
         target_version = versionutils.convert_version_to_tuple(target_version)
+        if target_version < (1, 26):
+            policy = primitive.get('hw_cpu_policy', None)
+            if policy == fields.CPUAllocationPolicy.MIXED:
+                raise exception.ObjectActionError(
+                    action='obj_make_compatible',
+                    reason='hw_cpu_policy=%s not supported in version %s' %
+                           (policy, target_version))
         if target_version < (1, 25):
             primitive.pop('hw_pci_numa_affinity_policy', None)
         if target_version < (1, 24):
diff --git a/nova/objects/instance_numa.py b/nova/objects/instance_numa.py
@@ -19,6 +19,7 @@
 
 from nova.db import api as db
 from nova import exception
+from nova.i18n import _
 from nova.objects import base
 from nova.objects import fields as obj_fields
 from nova.virt import hardware
@@ -34,12 +35,22 @@ class InstanceNUMACell(base.NovaEphemeralObject,
     # Version 1.3: Add cpu_policy and cpu_thread_policy fields
     # Version 1.4: Add cpuset_reserved field
     # Version 1.5: Add pcpuset field
-    VERSION = '1.5'
+    # Version 1.6: Add 'mixed' to cpu_policy field
+    VERSION = '1.6'
 
     def obj_make_compatible(self, primitive, target_version):
         super(InstanceNUMACell, self).obj_make_compatible(primitive,
                                                           target_version)
         target_version = versionutils.convert_version_to_tuple(target_version)
+        # Instance with a 'mixed' CPU policy could not provide a backward
+        # compatibility.
+        if target_version < (1, 6):
+            if primitive['cpu_policy'] == obj_fields.CPUAllocationPolicy.MIXED:
+                raise exception.ObjectActionError(
+                    action='obj_make_compatible',
+                    reason=_('mixed instance is not supported in version %s') %
+                           target_version)
+
         # NOTE(huaqiang): Since version 1.5, 'cpuset' is modified to track the
         # unpinned CPUs only, with pinned CPUs tracked via 'pcpuset' instead.
         # For a backward compatibility, move the 'dedicated' instance CPU list
diff --git a/nova/tests/functional/notification_sample_tests/test_instance.py b/nova/tests/functional/notification_sample_tests/test_instance.py
@@ -1249,7 +1249,7 @@ def test_rebuild_server(self):
                     'nova_object.data': {},
                     'nova_object.name': 'ImageMetaPropsPayload',
                     'nova_object.namespace': 'nova',
-                    'nova_object.version': u'1.3'},
+                    'nova_object.version': u'1.4'},
                 'image.size': 58145823,
                 'image.tags': [],
                 'scheduler_hints': {'_nova_check_type': ['rebuild']},
@@ -1344,7 +1344,7 @@ def test_rebuild_server_with_trusted_cert(self):
                     'nova_object.data': {},
                     'nova_object.name': 'ImageMetaPropsPayload',
                     'nova_object.namespace': 'nova',
-                    'nova_object.version': u'1.3'},
+                    'nova_object.version': u'1.4'},
                 'image.size': 58145823,
                 'image.tags': [],
                 'scheduler_hints': {'_nova_check_type': ['rebuild']},
diff --git a/nova/tests/unit/api/validation/extra_specs/test_validators.py b/nova/tests/unit/api/validation/extra_specs/test_validators.py
@@ -69,6 +69,7 @@ def test_value__str(self):
             ('hw:cpu_thread_policy', 'prefer'),
             ('hw:emulator_threads_policy', 'isolate'),
             ('hw:pci_numa_affinity_policy', 'legacy'),
+            ('hw:cpu_policy', 'mixed'),
         )
         for key, value in valid_specs:
             validators.validate(key, value)
diff --git a/nova/tests/unit/compute/test_compute.py b/nova/tests/unit/compute/test_compute.py
@@ -13352,10 +13352,17 @@ def test_image_blockdevicemapping_min_disk(self):
                           self.context, image['id'],
                           image, self.instance_type, root_bdm)
 
-    def test_cpu_policy(self):
+    @mock.patch('nova.virt.hardware.get_dedicated_cpu_constraint')
+    def test_cpu_policy(self, dedicated_cpu_mock):
         image = {'id': uuids.image_id, 'status': 'active'}
         for v in obj_fields.CPUAllocationPolicy.ALL:
             image['properties'] = {'hw_cpu_policy': v}
+            # 'mixed' policy requires a definition of 'cpu_dedicated_mask'
+            if v == obj_fields.CPUAllocationPolicy.MIXED:
+                dedicated_cpu_mock.return_value = set([0])
+            else:
+                dedicated_cpu_mock.return_value = None
+
             self.compute_api._validate_flavor_image(
                 self.context, image['id'], image, self.instance_type, None)
         image['properties'] = {'hw_cpu_policy': 'bar'}
diff --git a/nova/tests/unit/notifications/objects/test_notification.py b/nova/tests/unit/notifications/objects/test_notification.py
@@ -387,7 +387,7 @@ def test_payload_is_not_generated_if_notification_format_is_unversioned(
     # ImageMetaProps, so when you see a fail here for that reason, you must
     # *also* bump the version of ImageMetaPropsPayload. See its docstring for
     # more information.
-    'ImageMetaPropsPayload': '1.3-9c200c895932163a4e14e6bb385fa1e0',
+    'ImageMetaPropsPayload': '1.4-036c794843b95a3a39ee70830f5f6557',
     'InstanceActionNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
     'InstanceActionPayload': '1.8-4fa3da9cbf0761f1f700ae578f36dc2f',
     'InstanceActionRebuildNotification':
@@ -411,7 +411,7 @@ def test_payload_is_not_generated_if_notification_format_is_unversioned(
     'InstanceActionSnapshotPayload': '1.9-c3e0bbaaefafdfa2f8e6e504c2c9b12c',
     'InstanceExistsNotification': '1.0-a73147b93b520ff0061865849d3dfa56',
     'InstanceExistsPayload': '1.2-e082c02438ee57164829afaeee3bf7f8',
-    'InstanceNUMACellPayload': '1.1-2a24ab42bf5e8dfa98291402725bf278',
+    'InstanceNUMACellPayload': '1.2-a367add3378c71c21c817ab2b23db3bf',
     'InstanceNUMATopologyPayload': '1.0-247361b152047c18ae9ad1da2544a3c9',
     'InstancePCIRequestPayload': '1.0-12d0d61baf183daaafd93cbeeed2956f',
     'InstancePCIRequestsPayload': '1.0-6751cffe0c0fabd212aad624f672429a',
diff --git a/nova/tests/unit/objects/test_objects.py b/nova/tests/unit/objects/test_objects.py
@@ -1077,7 +1077,7 @@ def obj_name(cls):
     'HyperVLiveMigrateData': '1.4-e265780e6acfa631476c8170e8d6fce0',
     'IDEDeviceBus': '1.0-29d4c9f27ac44197f01b6ac1b7e16502',
     'ImageMeta': '1.8-642d1b2eb3e880a367f37d72dd76162d',
-    'ImageMetaProps': '1.25-66fc973af215eb5701ed4034bb6f0685',
+    'ImageMetaProps': '1.26-b9f136cd10a2b5ffb3ae44332f2f687d',
     'Instance': '2.7-d187aec68cad2e4d8b8a03a68e4739ce',
     'InstanceAction': '1.2-9a5abc87fdd3af46f45731960651efb5',
     'InstanceActionEvent': '1.4-5b1f361bd81989f8bb2c20bb7e8a4cb4',
@@ -1093,7 +1093,7 @@ def obj_name(cls):
     'InstanceList': '2.6-238f125650c25d6d12722340d726f723',
     'InstanceMapping': '1.2-3bd375e65c8eb9c45498d2f87b882e03',
     'InstanceMappingList': '1.3-d34b6ebb076d542ae0f8b440534118da',
-    'InstanceNUMACell': '1.5-d6f884326eba8cae60930e06047fc7d9',
+    'InstanceNUMACell': '1.6-25d9120d83a18356f4146f2a6fe2cc8d',
     'InstanceNUMATopology': '1.3-ec0030cb0402a49c96da7051c037082a',
     'InstancePCIRequest': '1.3-f6d324f1c337fad4f34892ed5f484c9a',
     'InstancePCIRequests': '1.1-65e38083177726d806684cb1cc0136d2',
diff --git a/nova/tests/unit/virt/test_hardware.py b/nova/tests/unit/virt/test_hardware.py
@@ -932,10 +932,75 @@ def test_cpu_policy_constraint(self):
                 ),
                 "image": {
                     "properties": {
+                        "hw_cpu_policy": "shared"
                     }
                 },
                 "expect": fields.CPUAllocationPolicy.DEDICATED
             },
+            {
+                "flavor": objects.Flavor(
+                    extra_specs={
+                        "hw:cpu_policy": "dedicated"
+                    }
+                ),
+                "image": {
+                    "properties": {
+                    }
+                },
+                "expect": fields.CPUAllocationPolicy.DEDICATED
+            },
+            {
+
+                "flavor": objects.Flavor(
+                    extra_specs={
+                        "hw:cpu_policy": "mixed"
+                    }
+                ),
+                "image": {
+                    "properties": {
+                        "hw_cpu_policy": "dedicated"
+                    }
+                },
+                "expect": exception.ImageCPUPinningForbidden
+            },
+            {
+                "flavor": objects.Flavor(
+                    extra_specs={
+                        "hw:cpu_policy": "mixed"
+                    }
+                ),
+                "image": {
+                    "properties": {
+                        "hw_cpu_policy": "mixed"
+                    }
+                },
+                "expect": fields.CPUAllocationPolicy.MIXED
+            },
+            {
+                "flavor": objects.Flavor(
+                    extra_specs={
+                        "hw:cpu_policy": "mixed"
+                    }
+                ),
+                "image": {
+                    "properties": {
+                        "hw_cpu_policy": "shared"
+                    }
+                },
+                "expect": fields.CPUAllocationPolicy.MIXED
+            },
+            {
+                "flavor": objects.Flavor(
+                    extra_specs={
+                        "hw:cpu_policy": "mixed"
+                    }
+                ),
+                "image": {
+                    "properties": {
+                    }
+                },
+                "expect": fields.CPUAllocationPolicy.MIXED
+            },
             {
                 "flavor": objects.Flavor(
                     extra_specs={
@@ -949,6 +1014,19 @@ def test_cpu_policy_constraint(self):
                 },
                 "expect": exception.ImageCPUPinningForbidden
             },
+            {
+                "flavor": objects.Flavor(
+                    extra_specs={
+                        "hw:cpu_policy": "shared"
+                    }
+                ),
+                "image": {
+                    "properties": {
+                        "hw_cpu_policy": "mixed"
+                    }
+                },
+                "expect": exception.ImageCPUPinningForbidden
+            },
             {
                 "flavor": objects.Flavor(
                     extra_specs={
@@ -983,6 +1061,15 @@ def test_cpu_policy_constraint(self):
                 },
                 "expect": fields.CPUAllocationPolicy.DEDICATED
             },
+            {
+                "flavor": objects.Flavor(),
+                "image": {
+                    "properties": {
+                        "hw_cpu_policy": "mixed"
+                    }
+                },
+                "expect": fields.CPUAllocationPolicy.MIXED
+            },
             {
                 "flavor": objects.Flavor(),
                 "image": {
diff --git a/nova/virt/hardware.py b/nova/virt/hardware.py

Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,5 @@`
`4`	`4`	`"hw_architecture": "x86_64"`
`5`	`5`	`},`
`6`	`6`	`"nova_object.name": "ImageMetaPropsPayload",`
`7`		`- "nova_object.version": "1.3"`
	`7`	`+ "nova_object.version": "1.4"`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "nova_object.version": "1.1",`
	`2`	`+ "nova_object.version": "1.2",`
`3`	`3`	`"nova_object.namespace": "nova",`
`4`	`4`	`"nova_object.name": "InstanceNUMACellPayload",`
`5`	`5`	`"nova_object.data": {`
Original file line number	Diff line number	Diff line change
`@@ -87,6 +87,8 @@`
`87`	`87`	`exception.PciRequestAliasNotDefined,`
`88`	`88`	`exception.RealtimeConfigurationInvalid,`
`89`	`89`	`exception.RealtimeMaskNotFoundOrInvalid,`
	`90`	`+ exception.RequiredMixedInstancePolicy,`
	`91`	`+ exception.RequiredMixedOrRealtimeCPUMask,`
`90`	`92`	`)`
`91`	`93`
`92`	`94`	`MIN_COMPUTE_MOVE_BANDWIDTH = 39`