[PATCH v3 3/3] drm/xe/configfs: Add attribute to disable engines

Lucas De Marchi lucas.demarchi at intel.com
Tue May 27 14:11:50 UTC 2025


On Mon, May 26, 2025 at 12:45:01PM +0300, Jani Nikula wrote:
>On Fri, 23 May 2025, Lucas De Marchi <lucas.demarchi at intel.com> wrote:
>> Add the userspace interface to load the driver with fewer engines.
>> The syntax is to just echo the engine names to a file in configfs, like
>> below:
>>
>> 	echo 'rcs0,bcs0' > /sys/kernel/config/xe/<bdf>/engine_allowed
>>
>> With that engines other than rcs0 and bcs0 will not be enabled. To
>> enable all instances from a class, a '*' can be used.
>
>Only nitpicks inline! ;D
>
>Do what you want with them, ignoring is fine.
>
>> Signed-off-by: Lucas De Marchi <lucas.demarchi at intel.com>
>> ---
>>  drivers/gpu/drm/xe/xe_configfs.c | 137 ++++++++++++++++++++++++++++++++++++++-
>>  1 file changed, 135 insertions(+), 2 deletions(-)
>>
>> diff --git a/drivers/gpu/drm/xe/xe_configfs.c b/drivers/gpu/drm/xe/xe_configfs.c
>> index 11ca36f194bfc..b27bbe203eb46 100644
>> --- a/drivers/gpu/drm/xe/xe_configfs.c
>> +++ b/drivers/gpu/drm/xe/xe_configfs.c
>> @@ -3,14 +3,19 @@
>>   * Copyright © 2025 Intel Corporation
>>   */
>>
>> +#include <linux/bitops.h>
>>  #include <linux/configfs.h>
>> +#include <linux/find.h>
>>  #include <linux/init.h>
>>  #include <linux/module.h>
>>  #include <linux/pci.h>
>> +#include <linux/string.h>
>>
>>  #include "xe_configfs.h"
>>  #include "xe_module.h"
>>
>> +#include "xe_hw_engine_types.h"
>> +
>>  /**
>>   * DOC: Xe Configfs
>>   *
>> @@ -48,6 +53,23 @@
>>   *	# echo 1 > /sys/kernel/config/xe/0000:03:00.0/survivability_mode
>>   *	# echo 0000:03:00.0 > /sys/bus/pci/drivers/xe/bind  (Enters survivability mode if supported)
>>   *
>> + * Allowed engine:
>> + * ---------------
>> + *
>> + * Allow only a set of engine(s) to be available - this is the equivalent of
>> + * fusing engines off in software. Examples:
>> + *
>> + * Allow only one render and one copy engines, nothing else::
>> + *
>> + *	# echo 'rcs0,bcs0' > /sys/kernel/config/xe/0000:03:00.0/engine_allowed
>> + *
>> + * Allow only compute engines and first copy engine::
>> + *
>> + *	# echo 'ccs*,bcs0' > /sys/kernel/config/xe/0000:03:00.0/engine_allowed
>> + *
>> + * The requested configuration may not be supported by the platform and driver
>> + * may fail to probe - intended for debugging purposes.
>> + *
>>   * Remove devices
>>   * ==============
>>   *
>> @@ -60,11 +82,26 @@ struct xe_config_device {
>>  	struct config_group group;
>>
>>  	bool survivability_mode;
>> +	u64 engine_allowed;
>>
>>  	/* protects attributes */
>>  	struct mutex lock;
>>  };
>>
>> +struct engine_info {
>> +	const char *cls;
>> +	u64 mask;
>> +};
>> +
>> +static const struct engine_info engine_info[] = {
>> +	{ .cls = "rcs", .mask = XE_HW_ENGINE_RCS_MASK },
>> +	{ .cls = "bcs", .mask = XE_HW_ENGINE_BCS_MASK },
>> +	{ .cls = "vcs", .mask = XE_HW_ENGINE_VCS_MASK },
>> +	{ .cls = "vecs", .mask = XE_HW_ENGINE_VECS_MASK },
>> +	{ .cls = "ccs", .mask = XE_HW_ENGINE_CCS_MASK },
>> +	{ .cls = "gsccs", .mask = XE_HW_ENGINE_GSCCS_MASK },
>> +};
>> +
>>  static struct xe_config_device *to_xe_config_device(struct config_item *item)
>>  {
>>  	return container_of(to_config_group(item), struct xe_config_device, group);
>> @@ -94,10 +131,95 @@ static ssize_t survivability_mode_store(struct config_item *item, const char *pa
>>  	return len;
>>  }
>>
>> +static ssize_t engine_allowed_show(struct config_item *item, char *page)
>> +{
>> +	struct xe_config_device *dev = to_xe_config_device(item);
>> +	char *p = page;
>> +
>> +	for (size_t i = 0; i < ARRAY_SIZE(engine_info); i++) {
>> +		u64 mask = engine_info[i].mask;
>> +
>> +		if ((dev->engine_allowed & mask) == mask) {
>> +			p += sprintf(p, "%s*\n", engine_info[i].cls);
>> +		} else if (mask & dev->engine_allowed) {
>> +			u16 bit0 = __ffs64(mask), bit;
>> +
>> +			mask &= dev->engine_allowed;
>> +
>> +			for_each_set_bit(bit, (const unsigned long *)&mask, 64)
>> +				p += sprintf(p, "%s%u\n", engine_info[i].cls,
>> +					     bit - bit0);
>> +		}
>> +	}
>> +
>> +	return p - page;
>> +}
>> +
>> +static bool lookup_engine_mask(const char *name, size_t namelen, u64 *mask)
>
>Arguably s/name/pattern/ would be easier to grasp.
>
>I would pass in a single NUL terminated pattern instead of pattern and
>length. Following comments are based on that idea. Everything becomes
>easier.
>
>> +{
>> +	for (size_t i = 0; i < ARRAY_SIZE(engine_info); i++) {
>> +		size_t clslen = strlen(engine_info[i].cls);
>> +		size_t numlen = namelen - clslen;
>> +		char instancestr[4];
>
>None of the above locals are needed.
>
>> +		u8 instance;
>> +		u16 bit;
>> +
>> +		if (namelen <= clslen || strncmp(name, engine_info[i].cls, clslen))
>> +			continue;
>> +
>
>		if (!str_has_prefix(pattern, engine_info[i].cls))
>			continue;
>
>		pattern += strlen(engine_info[i].cls);
>
>> +		if (name[clslen] == '*' && numlen == 1) {
>
>		if (!strcmp(pattern, "*"))
>
>> +			*mask = engine_info[i].mask;
>> +			return true;
>> +		}
>> +
>> +		if (numlen > sizeof(instancestr) - 1)
>> +			return false;
>
>Not needed.
>
>> +
>> +		memcpy(instancestr, name + clslen, numlen);
>> +		instancestr[numlen] = '\0';
>
>Not needed.

kstrto* api doesn't accept strings containing other chars, it must be
just the number. Looking around in other places they either duplicate
the buffer or already have a non-const one that they can simply add the
\0.

As a refactor in future I'd want to have a length-based kstrto* or at
least return the number of chars parsed.

Here in order to copy to a local buffer we need to know the number of
chars as user could have passed e.g. rcs012345678910,ccs0.

>
>> +
>> +		if (kstrtou8(instancestr, 10, &instance))

see above

>
>		if (kstrtou8(pattern, 10, &instance))
>
>> +			return false;
>> +
>> +		bit = __ffs64(engine_info[i].mask) + instance;
>> +		if (bit > fls64(engine_info[i].mask))
>> +			return false;
>> +
>> +		*mask = BIT_ULL(bit);
>
>Arguably this would benefit from a function:
>
>static u64 match(const struct engine_info *info, const char *pattern)
>
>> +		return true;
>> +	}
>> +
>> +	return false;
>> +}
>> +
>> +static ssize_t engine_allowed_store(struct config_item *item, const char *page,
>> +				    size_t len)
>> +{
>> +	struct xe_config_device *dev = to_xe_config_device(item);
>> +	size_t namelen, p;
>> +	u64 mask, val = 0;
>> +
>> +	for (p = 0; p < len; p += namelen + 1) {
>> +		namelen = strcspn(page + p, ",\n");
>
>lookup_engine_mask() would become a whole lot easier and simpler if this
>part here copied the string to a local buffer, and passed a NUL
>terminated string as pattern instead. You need the local buf anyway, so
>why not here, where it's the most beneficial?

humn... and copy the entire name. That's a good option indeed. I will
take a look at incorporating this on next rev, thanks.

Lucas De Marchi

>
>BR,
>Jani.
>
>> +		if (!lookup_engine_mask(page + p, namelen, &mask))
>> +			return -EINVAL;
>> +
>> +		val |= mask;
>> +	}
>> +
>> +	mutex_lock(&dev->lock);
>> +	dev->engine_allowed = val;
>> +	mutex_unlock(&dev->lock);
>> +
>> +	return len;
>> +}
>> +
>>  CONFIGFS_ATTR(, survivability_mode);
>> +CONFIGFS_ATTR(, engine_allowed);
>>
>>  static struct configfs_attribute *xe_config_device_attrs[] = {
>>  	&attr_survivability_mode,
>> +	&attr_engine_allowed,
>>  	NULL,
>>  };
>>
>> @@ -139,6 +261,9 @@ static struct config_group *xe_config_make_device_group(struct config_group *gro
>>  	if (!dev)
>>  		return ERR_PTR(-ENOMEM);
>>
>> +	/* Default values */
>> +	dev->engine_allowed = U64_MAX;
>> +
>>  	config_group_init_type_name(&dev->group, name, &xe_config_device_type);
>>
>>  	mutex_init(&dev->lock);
>> @@ -237,8 +362,16 @@ void xe_configfs_clear_survivability_mode(struct pci_dev *pdev)
>>   */
>>  u64 xe_configfs_get_engine_allowed(struct pci_dev *pdev)
>>  {
>> -	/* dummy implementation */
>> -	return U64_MAX;
>> +	struct xe_config_device *dev = configfs_find_group(pdev);
>> +	u64 engine_allowed;
>> +
>> +	if (!dev)
>> +		return U64_MAX;
>> +
>> +	engine_allowed = dev->engine_allowed;
>> +	config_item_put(&dev->group.cg_item);
>> +
>> +	return engine_allowed;
>>  }
>>
>>  int __init xe_configfs_init(void)
>
>-- 
>Jani Nikula, Intel


More information about the Intel-xe mailing list