class InstanceNUMATopologyPayload(base.NotificationPayloadBase):
# Version 1.0: Initial version
VERSION = '1.0'
SCHEMA = {
'instance_uuid': ('numa_topology', 'instance_uuid'),
'emulator_threads_policy': ('numa_topology',
'emulator_threads_policy')
}
fields = {
'instance_uuid': fields.UUIDField(),
'cells': fields.ListOfObjectsField('InstanceNUMACellPayload'),
'emulator_threads_policy': fields.CPUEmulatorThreadsPolicyField(
nullable=True)
}
def __init__(self, numa_topology):
super(InstanceNUMATopologyPayload, self).__init__()
self.cells = InstanceNUMACellPayload.from_numa_cell_list_obj(
numa_topology.cells)
self.populate_schema(numa_topology=numa_topology)
class InstanceNUMATopology(base.NovaObject, base.NovaObjectDictCompat):
# Version 1.0: Initial version
# Version 1.1: Takes into account pagesize
# Version 1.2: InstanceNUMACell 1.2
# Version 1.3: Add emulator threads policy
VERSION = '1.3'
def obj_make_compatible(self, primitive, target_version):
super(InstanceNUMATopology,
self).obj_make_compatible(primitive, target_version)
target_version = versionutils.convert_version_to_tuple(target_version)
if target_version < (1, 3):
primitive.pop('emulator_threads_policy', None)
fields = {
# NOTE(danms): The 'id' field is no longer used and should be
# removed in the future when convenient
'id':
obj_fields.IntegerField(),
'instance_uuid':
obj_fields.UUIDField(),
'cells':
obj_fields.ListOfObjectsField('InstanceNUMACell'),
'emulator_threads_policy':
(obj_fields.CPUEmulatorThreadsPolicyField(nullable=True)),
}
@classmethod
def obj_from_primitive(cls, primitive, context=None):
if 'nova_object.name' in primitive:
obj_topology = super(InstanceNUMATopology,
cls).obj_from_primitive(primitive,
context=None)
else:
# NOTE(sahid): This compatibility code needs to stay until we can
# guarantee that there are no cases of the old format stored in
# the database (or forever, if we can never guarantee that).
obj_topology = InstanceNUMATopology._from_dict(primitive)
obj_topology.id = 0
return obj_topology
@classmethod
def obj_from_db_obj(cls, instance_uuid, db_obj):
primitive = jsonutils.loads(db_obj)
obj_topology = cls.obj_from_primitive(primitive)
if 'nova_object.name' not in db_obj:
obj_topology.instance_uuid = instance_uuid
# No benefit to store a list of changed fields
obj_topology.obj_reset_changes()
return obj_topology
# TODO(ndipanov) Remove this method on the major version bump to 2.0
@base.remotable
def create(self):
values = {'numa_topology': self._to_json()}
db.instance_extra_update_by_uuid(self._context, self.instance_uuid,
values)
self.obj_reset_changes()
@base.remotable_classmethod
def get_by_instance_uuid(cls, context, instance_uuid):
db_extra = db.instance_extra_get_by_instance_uuid(
context, instance_uuid, columns=['numa_topology'])
if not db_extra:
raise exception.NumaTopologyNotFound(instance_uuid=instance_uuid)
if db_extra['numa_topology'] is None:
return None
return cls.obj_from_db_obj(instance_uuid, db_extra['numa_topology'])
def _to_json(self):
return jsonutils.dumps(self.obj_to_primitive())
def __len__(self):
"""Defined so that boolean testing works the same as for lists."""
return len(self.cells)
def _to_dict(self):
# NOTE(sahid): Used as legacy, could be renamed in _legacy_to_dict_
# in the future to avoid confusing.
return {'cells': [cell._to_dict() for cell in self.cells]}
@classmethod
def _from_dict(cls, data_dict):
# NOTE(sahid): Used as legacy, could be renamed in _legacy_from_dict_
# in the future to avoid confusing.
return cls(cells=[
InstanceNUMACell._from_dict(cell_dict)
for cell_dict in data_dict.get('cells', [])
])
@property
def cpu_pinning_requested(self):
return all(cell.cpu_pinning_requested for cell in self.cells)
def clear_host_pinning(self):
"""Clear any data related to how instance is pinned to the host.
Needed for aborting claims as we do not want to keep stale data around.
"""
for cell in self.cells:
cell.clear_host_pinning()
return self
@property
def emulator_threads_isolated(self):
"""Determines whether emulator threads should be isolated"""
return (self.obj_attr_is_set('emulator_threads_policy')
and (self.emulator_threads_policy
== obj_fields.CPUEmulatorThreadsPolicy.ISOLATE))
class InstanceNUMATopology(base.NovaObject, base.NovaObjectDictCompat):
# Version 1.0: Initial version
# Version 1.1: Takes into account pagesize
# Version 1.2: InstanceNUMACell 1.2
# Version 1.3: Add emulator threads policy
VERSION = '1.3'
def obj_make_compatible(self, primitive, target_version):
super(InstanceNUMATopology,
self).obj_make_compatible(primitive, target_version)
target_version = versionutils.convert_version_to_tuple(target_version)
if target_version < (1, 3):
primitive.pop('emulator_threads_policy', None)
fields = {
# NOTE(danms): The 'id' field is no longer used and should be
# removed in the future when convenient
'id':
obj_fields.IntegerField(),
'instance_uuid':
obj_fields.UUIDField(),
'cells':
obj_fields.ListOfObjectsField('InstanceNUMACell'),
'emulator_threads_policy':
(obj_fields.CPUEmulatorThreadsPolicyField(nullable=True)),
}
@classmethod
def obj_from_db_obj(cls, context, instance_uuid, db_obj):
primitive = jsonutils.loads(db_obj)
if 'nova_object.name' in primitive:
obj = cls.obj_from_primitive(primitive)
updated = cls._migrate_legacy_dedicated_instance_cpuset(obj)
if updated:
cls._save_migrated_cpuset_to_instance_extra(
context, obj, instance_uuid)
else:
obj = cls._migrate_legacy_object(context, instance_uuid, primitive)
return obj
# TODO(huaqiang): Remove after Wallaby once we are sure these objects have
# been loaded at least once.
@classmethod
def _migrate_legacy_dedicated_instance_cpuset(cls, obj):
# NOTE(huaqiang): We may meet some topology object with the old version
# 'InstanceNUMACell' cells, in that case, the 'dedicated' CPU is kept
# in 'InstanceNUMACell.cpuset' field, but it should be kept in
# 'InstanceNUMACell.pcpuset' field since Victoria. Making an upgrade
# here but letting the caller persist the result if needed as we
# don't know which table the InstanceNUMACell is coming from. It can
# come from instance_extra or request_spec too.
update_db = False
for cell in obj.cells:
if len(cell.cpuset) == 0:
continue
if cell.cpu_policy != obj_fields.CPUAllocationPolicy.DEDICATED:
continue
cell.pcpuset = cell.cpuset
cell.cpuset = set()
update_db = True
return update_db
# TODO(huaqiang): Remove after Yoga once we are sure these objects have
# been loaded at least once.
@classmethod
def _save_migrated_cpuset_to_instance_extra(cls, context, obj,
instance_uuid):
db_obj = jsonutils.dumps(obj.obj_to_primitive())
values = {
'numa_topology': db_obj,
}
db.instance_extra_update_by_uuid(context, instance_uuid, values)
# TODO(stephenfin): Remove in X or later, once this has bedded in
@classmethod
def _migrate_legacy_object(cls, context, instance_uuid, primitive):
"""Convert a pre-Liberty object to a real o.vo.
Handle an unversioned object created prior to Liberty, by transforming
to a versioned object and saving back the serialized version of this.
:param context: RequestContext
:param instance_uuid: The UUID of the instance this topology is
associated with.
:param primitive: A serialized representation of the legacy object.
:returns: A serialized representation of the updated object.
"""
obj = cls(
instance_uuid=instance_uuid,
cells=[
InstanceNUMACell(
id=cell.get('id'),
cpuset=hardware.parse_cpu_spec(cell.get('cpus', '')),
pcpuset=set(),
memory=cell.get('mem', {}).get('total', 0),
pagesize=cell.get('pagesize'),
) for cell in primitive.get('cells', [])
],
)
db_obj = jsonutils.dumps(obj.obj_to_primitive())
values = {
'numa_topology': db_obj,
}
db.instance_extra_update_by_uuid(context, instance_uuid, values)
return obj
# TODO(ndipanov) Remove this method on the major version bump to 2.0
@base.remotable
def create(self):
values = {'numa_topology': self._to_json()}
db.instance_extra_update_by_uuid(self._context, self.instance_uuid,
values)
self.obj_reset_changes()
@base.remotable_classmethod
def get_by_instance_uuid(cls, context, instance_uuid):
db_extra = db.instance_extra_get_by_instance_uuid(
context, instance_uuid, columns=['numa_topology'])
if not db_extra:
raise exception.NumaTopologyNotFound(instance_uuid=instance_uuid)
if db_extra['numa_topology'] is None:
return None
return cls.obj_from_db_obj(context, instance_uuid,
db_extra['numa_topology'])
def _to_json(self):
return jsonutils.dumps(self.obj_to_primitive())
def __len__(self):
"""Defined so that boolean testing works the same as for lists."""
return len(self.cells)
# TODO(stephenfin): We should add a real 'cpu_policy' field on this object
# and deprecate the one found on the cell
@property
def cpu_policy(self):
cpu_policy = set(cell.cpu_policy for cell in self.cells)
if len(cpu_policy) > 1:
# NOTE(stephenfin): This should never happen in real life; it's to
# prevent programmer error.
raise exception.InternalError(
'Instance NUMA cells must have the same CPU policy.')
return cpu_policy.pop()
@property
def cpu_pinning(self):
"""Return a set of all host CPUs this NUMATopology is pinned to."""
return set(
itertools.chain.from_iterable([
cell.cpu_pinning.values() for cell in self.cells
if cell.cpu_pinning
]))
def clear_host_pinning(self):
"""Clear any data related to how instance is pinned to the host.
Needed for aborting claims as we do not want to keep stale data around.
"""
for cell in self.cells:
cell.clear_host_pinning()
return self
@property
def emulator_threads_isolated(self):
"""Determines whether emulator threads should be isolated"""
return (self.obj_attr_is_set('emulator_threads_policy')
and (self.emulator_threads_policy
== obj_fields.CPUEmulatorThreadsPolicy.ISOLATE))
class InstanceNUMATopology(base.NovaObject, base.NovaObjectDictCompat):
# Version 1.0: Initial version
# Version 1.1: Takes into account pagesize
# Version 1.2: InstanceNUMACell 1.2
# Version 1.3: Add emulator threads policy
VERSION = '1.3'
def obj_make_compatible(self, primitive, target_version):
super(InstanceNUMATopology,
self).obj_make_compatible(primitive, target_version)
target_version = versionutils.convert_version_to_tuple(target_version)
if target_version < (1, 3):
primitive.pop('emulator_threads_policy', None)
fields = {
# NOTE(danms): The 'id' field is no longer used and should be
# removed in the future when convenient
'id':
obj_fields.IntegerField(),
'instance_uuid':
obj_fields.UUIDField(),
'cells':
obj_fields.ListOfObjectsField('InstanceNUMACell'),
'emulator_threads_policy':
(obj_fields.CPUEmulatorThreadsPolicyField(nullable=True)),
}
@classmethod
def obj_from_db_obj(cls, context, instance_uuid, db_obj):
primitive = jsonutils.loads(db_obj)
if 'nova_object.name' in primitive:
obj = cls.obj_from_primitive(primitive)
else:
obj = cls._migrate_legacy_object(context, instance_uuid, primitive)
return obj
# TODO(stephenfin): Remove in X or later, once this has bedded in
@classmethod
def _migrate_legacy_object(cls, context, instance_uuid, primitive):
"""Convert a pre-Liberty object to a real o.vo.
Handle an unversioned object created prior to Liberty, by transforming
to a versioned object and saving back the serialized version of this.
:param context: RequestContext
:param instance_uuid: The UUID of the instance this topology is
associated with.
:param primitive: A serialized representation of the legacy object.
:returns: A serialized representation of the updated object.
"""
obj = cls(
instance_uuid=instance_uuid,
cells=[
InstanceNUMACell(
id=cell.get('id'),
cpuset=hardware.parse_cpu_spec(cell.get('cpus', '')),
memory=cell.get('mem', {}).get('total', 0),
pagesize=cell.get('pagesize'),
) for cell in primitive.get('cells', [])
],
)
db_obj = jsonutils.dumps(obj.obj_to_primitive())
values = {
'numa_topology': db_obj,
}
db.instance_extra_update_by_uuid(context, instance_uuid, values)
return obj
# TODO(ndipanov) Remove this method on the major version bump to 2.0
@base.remotable
def create(self):
values = {'numa_topology': self._to_json()}
db.instance_extra_update_by_uuid(self._context, self.instance_uuid,
values)
self.obj_reset_changes()
@base.remotable_classmethod
def get_by_instance_uuid(cls, context, instance_uuid):
db_extra = db.instance_extra_get_by_instance_uuid(
context, instance_uuid, columns=['numa_topology'])
if not db_extra:
raise exception.NumaTopologyNotFound(instance_uuid=instance_uuid)
if db_extra['numa_topology'] is None:
return None
return cls.obj_from_db_obj(context, instance_uuid,
db_extra['numa_topology'])
def _to_json(self):
return jsonutils.dumps(self.obj_to_primitive())
def __len__(self):
"""Defined so that boolean testing works the same as for lists."""
return len(self.cells)
@property
def cpu_pinning(self):
"""Return a set of all host CPUs this NUMATopology is pinned to."""
return set(
itertools.chain.from_iterable([
cell.cpu_pinning.values() for cell in self.cells
if cell.cpu_pinning
]))
@property
def cpu_pinning_requested(self):
return all(cell.cpu_pinning_requested for cell in self.cells)
def clear_host_pinning(self):
"""Clear any data related to how instance is pinned to the host.
Needed for aborting claims as we do not want to keep stale data around.
"""
for cell in self.cells:
cell.clear_host_pinning()
return self
@property
def emulator_threads_isolated(self):
"""Determines whether emulator threads should be isolated"""
return (self.obj_attr_is_set('emulator_threads_policy')
and (self.emulator_threads_policy
== obj_fields.CPUEmulatorThreadsPolicy.ISOLATE))