Mdev-GPU - Revision history

Arthur at 00:28, 2 March 2023

2023-03-02T00:28:44Z

← Older revision		Revision as of 00:28, 2 March 2023
Line 7:		Line 7:
	Mdev-GPU's source code can be found [https://github.com/Arc-Compute/Mdev-GPU here].		Mdev-GPU's source code can be found [https://github.com/Arc-Compute/Mdev-GPU here].

	Module docs can be found [https://docs.linux-gvm.org/mdev-gpu/ here].		Module docs can be found [https://docs.linux-gvm.org/mdev-gpu/ here].<blockquote>An absence of critical technical documentation has historically slowed growth and adoption of developer ecosystems for GPU virtualization.

			This [https://creativecommons.org/licenses/by/4.0/ CC-BY-4.0] licensed content can either be used with attribution, or used as inspiration for new documentation, created by GPU vendors for public commercial distribution as developer documentation.

			Where possible, this documentation will clearly label dates and versions of observed-but-not-guaranteed behaviour vs. vendor-documented stable interfaces/behaviour with guarantees of forward or backward compatibility.</blockquote>

	=== Compilation ===		=== Compilation ===

Arthur: /* fbRes */

2022-08-24T19:48:11Z

fbRes

← Older revision		Revision as of 19:48, 24 August 2022
Line 123:		Line 123:
	<sup>[required]</sup>		<sup>[required]</sup>

	fbRes is the framebuffer reserved by the hypervisor (in megabytes). In most circumstances this value should ~~not be less than 1Gb for larger fbLen sizes but in~~ the ~~case~~ of ~~very small Mdev devices (vGPUs) it may be appropriate to set this~~ value ~~to a smaller size~~.		fbRes is the framebuffer reserved by the hypervisor (in megabytes). In most circumstances this value should scale to around 1/7th the size of your chosen fbLen value.

	===== mapVideoSize =====		===== mapVideoSize =====

Arthur: /* mapVideoSize */

2022-08-04T17:33:17Z

mapVideoSize

← Older revision		Revision as of 17:33, 4 August 2022
Line 128:		Line 128:
	<sup>[optional]</sup>		<sup>[optional]</sup>

	Mappable video size in MBs, 24 by default		Mappable video size in MBs, 24 by default.

	===== encCap =====		===== encCap =====

Arthur: /* fbLen */

2022-08-04T17:32:48Z

fbLen

← Older revision		Revision as of 17:32, 4 August 2022
Line 118:		Line 118:
	<sup>[required]</sup>		<sup>[required]</sup>

	fbLen is the framebuffer length.		fbLen is the framebuffer length (in megabytes).

	===== fbRes =====		===== fbRes =====
	<sup>[required]</sup>		<sup>[required]</sup>

	fbRes is the framebuffer reserved by the hypervisor. In most circumstances this value should not be less than 1Gb for larger fbLen sizes but in the case of very small Mdev devices (vGPUs) it may be appropriate to set this value to a smaller size.		fbRes is the framebuffer reserved by the hypervisor (in megabytes). In most circumstances this value should not be less than 1Gb for larger fbLen sizes but in the case of very small Mdev devices (vGPUs) it may be appropriate to set this value to a smaller size.

	===== mapVideoSize =====		===== mapVideoSize =====

Arthur: /* mdev-post.service */

2022-08-04T17:20:21Z

mdev-post.service

← Older revision		Revision as of 17:20, 4 August 2022
Line 39:		Line 39:

	==== Mdev-CLI ====		==== Mdev-CLI ====
	Configuration for Mdev-GPU can be found in the path '''<code>/etc/gvm/mdev-gpu/</code>'''. This path will by default contain several vendor-specific folders which may include configuration examples for various devices/architectures as well as the file <code>'''generate-vgpu-types.yaml'''</code> which you can configure to specify your desired Virtual GPU (vGPU) / VFIO-Mdev topologies as they are presented in the sysfsdev mdev_bus path and as seen by tools such as [https://github.com/mdevctl/mdevctl mdevctl]. Once you have configured the available types your liking you can refresh the supported types registered with the [https://openmdev.io/index.php/Virtual_IO_Internals#Mediated_Core Mediated Core] by restarting ~~the~~ '''mdev-post.service''' or by ~~manually~~ invoking '''mdev-cli'''.		Configuration for Mdev-GPU can be found in the path '''<code>/etc/gvm/mdev-gpu/</code>'''. This path will by default contain several vendor-specific folders which may include configuration examples for various devices/architectures as well as the file <code>'''generate-vgpu-types.yaml'''</code> which you can configure to specify your desired Virtual GPU (vGPU) / VFIO-Mdev topologies as they are presented in the sysfsdev mdev_bus path and as seen by tools such as [https://github.com/mdevctl/mdevctl mdevctl]. Once you have configured the available types your liking you can refresh the supported types registered with the [https://openmdev.io/index.php/Virtual_IO_Internals#Mediated_Core Mediated Core] by rebooting your machine or reloading the vendor driver kernel module then restarting '''mdev-post.service''' or by invoking '''mdev-cli'''.

Arthur: /* Configuration */

2022-08-02T20:52:42Z

Configuration

← Older revision		Revision as of 20:52, 2 August 2022
Line 25:		Line 25:
	The binaries compiled on your local machine by Stack in the <code>~/.local/bin/</code> path or downloaded from [https://github.com/Arc-Compute/Mdev-GPU/releases Releases on GitHub] should be copied to <code>/usr/bin/</code>. This can be accomplished both via install script (currently testing in LibVF.IO) or via management layer-agnostic package.		The binaries compiled on your local machine by Stack in the <code>~/.local/bin/</code> path or downloaded from [https://github.com/Arc-Compute/Mdev-GPU/releases Releases on GitHub] should be copied to <code>/usr/bin/</code>. This can be accomplished both via install script (currently testing in LibVF.IO) or via management layer-agnostic package.

	=== Configuration ===		=== Mdev-GPU Configuration ===
	The Mdev-GPU repository provides Systemd service and example ~~configuration~~ in the [https://github.com/Arc-Compute/Mdev-GPU/tree/master/etc /etc/ folder]. On installation the directories & files contained in the repository's /etc/ folder should be copied to the absolute path <code>/etc/</code> on the user's computer.		The Mdev-GPU repository provides Systemd service and example configurations for Mdev-CLI in the [https://github.com/Arc-Compute/Mdev-GPU/tree/master/etc /etc/ folder]. On installation the directories & files contained in the repository's /etc/ folder should be copied to the absolute path <code>/etc/</code> on the user's computer.

	==== Systemd ====		==== Systemd ====
Line 38:		Line 38:
	As the name would suggest '''[https://github.com/Arc-Compute/Mdev-GPU/blob/master/etc/systemd/system/mdev-post.service mdev-post.service]''' posts the GPU(s) in a state where they are ready to be virtualized. When the service is invoked the mdev-cli util registers Mdev callbacks and supported mediated device (Mdev) types with the Mediated Core according to the user's specified configuration at '''<code>/etc/gvm/mdev-gpu/generate-vgpu-types.yaml</code>'''. If you'd like to place your configuration file elsewhere and still have your configuration invoked on boot you can edit the systemd service [https://github.com/Arc-Compute/Mdev-GPU/blob/9993fd0781ddddfcca2cb9bee6455ea2c024cc23/etc/systemd/system/mdev-post.service#L10 ExecStart= line] to specify an alternative path.		As the name would suggest '''[https://github.com/Arc-Compute/Mdev-GPU/blob/master/etc/systemd/system/mdev-post.service mdev-post.service]''' posts the GPU(s) in a state where they are ready to be virtualized. When the service is invoked the mdev-cli util registers Mdev callbacks and supported mediated device (Mdev) types with the Mediated Core according to the user's specified configuration at '''<code>/etc/gvm/mdev-gpu/generate-vgpu-types.yaml</code>'''. If you'd like to place your configuration file elsewhere and still have your configuration invoked on boot you can edit the systemd service [https://github.com/Arc-Compute/Mdev-GPU/blob/9993fd0781ddddfcca2cb9bee6455ea2c024cc23/etc/systemd/system/mdev-post.service#L10 ExecStart= line] to specify an alternative path.

	==== Mdev-~~GPU~~ ====		==== Mdev-CLI ====
	Configuration for Mdev-GPU can be found in the path '''<code>/etc/gvm/mdev-gpu/</code>'''. This path will by default contain several vendor-specific folders which may include configuration examples for various devices/architectures as well as the file <code>'''generate-vgpu-types.yaml'''</code> which you can configure to specify your desired Virtual GPU (vGPU) / VFIO-Mdev topologies as they are presented in the sysfsdev mdev_bus path and as seen by tools such as [https://github.com/mdevctl/mdevctl mdevctl]. Once you have configured the available types your liking you can refresh the supported types registered with the [https://openmdev.io/index.php/Virtual_IO_Internals#Mediated_Core Mediated Core] by restarting the '''mdev-post.service''' or by manually invoking '''mdev-cli'''.		Configuration for Mdev-GPU can be found in the path '''<code>/etc/gvm/mdev-gpu/</code>'''. This path will by default contain several vendor-specific folders which may include configuration examples for various devices/architectures as well as the file <code>'''generate-vgpu-types.yaml'''</code> which you can configure to specify your desired Virtual GPU (vGPU) / VFIO-Mdev topologies as they are presented in the sysfsdev mdev_bus path and as seen by tools such as [https://github.com/mdevctl/mdevctl mdevctl]. Once you have configured the available types your liking you can refresh the supported types registered with the [https://openmdev.io/index.php/Virtual_IO_Internals#Mediated_Core Mediated Core] by restarting the '''mdev-post.service''' or by manually invoking '''mdev-cli'''.

Arthur: /* GVM/Mdev-GPU */

2022-08-02T20:40:16Z

GVM/Mdev-GPU

← Older revision		Revision as of 20:40, 2 August 2022
Line 38:		Line 38:
	As the name would suggest '''[https://github.com/Arc-Compute/Mdev-GPU/blob/master/etc/systemd/system/mdev-post.service mdev-post.service]''' posts the GPU(s) in a state where they are ready to be virtualized. When the service is invoked the mdev-cli util registers Mdev callbacks and supported mediated device (Mdev) types with the Mediated Core according to the user's specified configuration at '''<code>/etc/gvm/mdev-gpu/generate-vgpu-types.yaml</code>'''. If you'd like to place your configuration file elsewhere and still have your configuration invoked on boot you can edit the systemd service [https://github.com/Arc-Compute/Mdev-GPU/blob/9993fd0781ddddfcca2cb9bee6455ea2c024cc23/etc/systemd/system/mdev-post.service#L10 ExecStart= line] to specify an alternative path.		As the name would suggest '''[https://github.com/Arc-Compute/Mdev-GPU/blob/master/etc/systemd/system/mdev-post.service mdev-post.service]''' posts the GPU(s) in a state where they are ready to be virtualized. When the service is invoked the mdev-cli util registers Mdev callbacks and supported mediated device (Mdev) types with the Mediated Core according to the user's specified configuration at '''<code>/etc/gvm/mdev-gpu/generate-vgpu-types.yaml</code>'''. If you'd like to place your configuration file elsewhere and still have your configuration invoked on boot you can edit the systemd service [https://github.com/Arc-Compute/Mdev-GPU/blob/9993fd0781ddddfcca2cb9bee6455ea2c024cc23/etc/systemd/system/mdev-post.service#L10 ExecStart= line] to specify an alternative path.

	==== ~~GVM/~~Mdev-GPU ====		==== Mdev-GPU ====
	Configuration for Mdev-GPU can be found in the path '''<code>/etc/gvm/mdev-gpu/</code>'''. This path will by default contain several vendor-specific folders which may include configuration examples for various devices/architectures as well as the file <code>'''generate-vgpu-types.yaml'''</code> which you can configure to specify your desired Virtual GPU (vGPU) / VFIO-Mdev topologies as they are presented in the sysfsdev mdev_bus path and as seen by tools such as [https://github.com/mdevctl/mdevctl mdevctl]. Once you have configured the available types your liking you can refresh the supported types registered with the [https://openmdev.io/index.php/Virtual_IO_Internals#Mediated_Core Mediated Core] by restarting the '''mdev-post.service''' or by manually invoking '''mdev-cli'''.		Configuration for Mdev-GPU can be found in the path '''<code>/etc/gvm/mdev-gpu/</code>'''. This path will by default contain several vendor-specific folders which may include configuration examples for various devices/architectures as well as the file <code>'''generate-vgpu-types.yaml'''</code> which you can configure to specify your desired Virtual GPU (vGPU) / VFIO-Mdev topologies as they are presented in the sysfsdev mdev_bus path and as seen by tools such as [https://github.com/mdevctl/mdevctl mdevctl]. Once you have configured the available types your liking you can refresh the supported types registered with the [https://openmdev.io/index.php/Virtual_IO_Internals#Mediated_Core Mediated Core] by restarting the '''mdev-post.service''' or by manually invoking '''mdev-cli'''.

Arthur: /* GVM/Mdev-GPU */

2022-08-02T20:33:14Z

GVM/Mdev-GPU

← Older revision		Revision as of 20:33, 2 August 2022
Line 39:		Line 39:

	==== GVM/Mdev-GPU ====		==== GVM/Mdev-GPU ====
	Configuration for Mdev-GPU can be found in the path '''<code>/etc/gvm/mdev-gpu/</code>'''. This path will by default contain the file <code>'''generate-vgpu-types.yaml'''</code> which you can configure to specify your desired Virtual GPU (vGPU) / VFIO-Mdev topologies as they are presented in the sysfsdev mdev_bus path and as seen by tools such as [https://github.com/mdevctl/mdevctl mdevctl]. Once you have configured the available types your liking you can refresh the supported types registered with the [https://openmdev.io/index.php/Virtual_IO_Internals#Mediated_Core Mediated Core] by restarting the '''mdev-post.service''' or by manually invoking mdev-cli.		Configuration for Mdev-GPU can be found in the path '''<code>/etc/gvm/mdev-gpu/</code>'''. This path will by default contain several vendor-specific folders which may include configuration examples for various devices/architectures as well as the file <code>'''generate-vgpu-types.yaml'''</code> which you can configure to specify your desired Virtual GPU (vGPU) / VFIO-Mdev topologies as they are presented in the sysfsdev mdev_bus path and as seen by tools such as [https://github.com/mdevctl/mdevctl mdevctl]. Once you have configured the available types your liking you can refresh the supported types registered with the [https://openmdev.io/index.php/Virtual_IO_Internals#Mediated_Core Mediated Core] by restarting the '''mdev-post.service''' or by manually invoking '''mdev-cli'''.

Arthur at 20:15, 2 August 2022

2022-08-02T20:15:55Z

← Older revision		Revision as of 20:15, 2 August 2022
Line 1:		Line 1:
	This page makes use of terms that are defined in the [https://openmdev.io/index.php/Glossary ''OpenMdev Glossary''].		This page makes use of terms that are defined in the [https://openmdev.io/index.php/Glossary ''OpenMdev Glossary'']. If you're curious what a given term means you can check there for a definition.

	If you're curious what a given term means you can check there for a definition.

Arthur at 20:15, 2 August 2022

2022-08-02T20:15:27Z

← Older revision		Revision as of 20:15, 2 August 2022
Line 5:		Line 5:


	This page will be used to document ~~the internals of~~ the '''Mdev-GPU''' ~~package.~~		This page will be used to document the '''Mdev-GPU API''' as well as provide an overview of the internals of the Mdev-GPU package.

	~~Currently~~ Mdev-GPU ~~supports registering mediated callbacks with the Mediated Core and the creation of arbitrary mdev devices~~.

	Mdev-GPU's source code can be found [https://github.com/Arc-Compute/Mdev-GPU here].		Mdev-GPU's source code can be found [https://github.com/Arc-Compute/Mdev-GPU here].