1482580a6SMarc-André Lureau# -*- Mode: Python -*- 2482580a6SMarc-André Lureau# 3482580a6SMarc-André Lureau# Copyright (C) 2018 Red Hat, Inc. 4482580a6SMarc-André Lureau# 5482580a6SMarc-André Lureau# Authors: 6482580a6SMarc-André Lureau# Marc-André Lureau <marcandre.lureau@redhat.com> 7482580a6SMarc-André Lureau# 8482580a6SMarc-André Lureau# This work is licensed under the terms of the GNU GPL, version 2 or 9482580a6SMarc-André Lureau# later. See the COPYING file in the top-level directory. 10482580a6SMarc-André Lureau 11482580a6SMarc-André Lureau## 12482580a6SMarc-André Lureau# = vhost user backend discovery & capabilities 13482580a6SMarc-André Lureau## 14482580a6SMarc-André Lureau 15482580a6SMarc-André Lureau## 16482580a6SMarc-André Lureau# @VHostUserBackendType: 17482580a6SMarc-André Lureau# 18482580a6SMarc-André Lureau# List the various vhost user backend types. 19482580a6SMarc-André Lureau# 20482580a6SMarc-André Lureau# @9p: 9p virtio console 21482580a6SMarc-André Lureau# @balloon: virtio balloon 22482580a6SMarc-André Lureau# @block: virtio block 23482580a6SMarc-André Lureau# @caif: virtio caif 24482580a6SMarc-André Lureau# @console: virtio console 25482580a6SMarc-André Lureau# @crypto: virtio crypto 26482580a6SMarc-André Lureau# @gpu: virtio gpu 27482580a6SMarc-André Lureau# @input: virtio input 28482580a6SMarc-André Lureau# @net: virtio net 29482580a6SMarc-André Lureau# @rng: virtio rng 30482580a6SMarc-André Lureau# @rpmsg: virtio remote processor messaging 31482580a6SMarc-André Lureau# @rproc-serial: virtio remoteproc serial link 32482580a6SMarc-André Lureau# @scsi: virtio scsi 33482580a6SMarc-André Lureau# @vsock: virtio vsock transport 34*45018fbbSStefan Hajnoczi# @fs: virtio fs (since 4.2) 35482580a6SMarc-André Lureau# 36482580a6SMarc-André Lureau# Since: 4.0 37482580a6SMarc-André Lureau## 38482580a6SMarc-André Lureau{ 39482580a6SMarc-André Lureau 'enum': 'VHostUserBackendType', 40482580a6SMarc-André Lureau 'data': [ 41482580a6SMarc-André Lureau '9p', 42482580a6SMarc-André Lureau 'balloon', 43482580a6SMarc-André Lureau 'block', 44482580a6SMarc-André Lureau 'caif', 45482580a6SMarc-André Lureau 'console', 46482580a6SMarc-André Lureau 'crypto', 47482580a6SMarc-André Lureau 'gpu', 48482580a6SMarc-André Lureau 'input', 49482580a6SMarc-André Lureau 'net', 50482580a6SMarc-André Lureau 'rng', 51482580a6SMarc-André Lureau 'rpmsg', 52482580a6SMarc-André Lureau 'rproc-serial', 53482580a6SMarc-André Lureau 'scsi', 54*45018fbbSStefan Hajnoczi 'vsock', 55*45018fbbSStefan Hajnoczi 'fs' 56482580a6SMarc-André Lureau ] 57482580a6SMarc-André Lureau} 58482580a6SMarc-André Lureau 59482580a6SMarc-André Lureau## 606620801fSMicky Yun Chan# @VHostUserBackendBlockFeature: 616620801fSMicky Yun Chan# 626620801fSMicky Yun Chan# List of vhost user "block" features. 636620801fSMicky Yun Chan# 646620801fSMicky Yun Chan# @read-only: The --read-only command line option is supported. 656620801fSMicky Yun Chan# @blk-file: The --blk-file command line option is supported. 666620801fSMicky Yun Chan# 676620801fSMicky Yun Chan# Since: 5.0 686620801fSMicky Yun Chan## 696620801fSMicky Yun Chan{ 706620801fSMicky Yun Chan 'enum': 'VHostUserBackendBlockFeature', 716620801fSMicky Yun Chan 'data': [ 'read-only', 'blk-file' ] 726620801fSMicky Yun Chan} 736620801fSMicky Yun Chan 746620801fSMicky Yun Chan## 756620801fSMicky Yun Chan# @VHostUserBackendCapabilitiesBlock: 766620801fSMicky Yun Chan# 776620801fSMicky Yun Chan# Capabilities reported by vhost user "block" backends 786620801fSMicky Yun Chan# 796620801fSMicky Yun Chan# @features: list of supported features. 806620801fSMicky Yun Chan# 816620801fSMicky Yun Chan# Since: 5.0 826620801fSMicky Yun Chan## 836620801fSMicky Yun Chan{ 846620801fSMicky Yun Chan 'struct': 'VHostUserBackendCapabilitiesBlock', 856620801fSMicky Yun Chan 'data': { 866620801fSMicky Yun Chan 'features': [ 'VHostUserBackendBlockFeature' ] 876620801fSMicky Yun Chan } 886620801fSMicky Yun Chan} 896620801fSMicky Yun Chan 906620801fSMicky Yun Chan## 91482580a6SMarc-André Lureau# @VHostUserBackendInputFeature: 92482580a6SMarc-André Lureau# 93482580a6SMarc-André Lureau# List of vhost user "input" features. 94482580a6SMarc-André Lureau# 95482580a6SMarc-André Lureau# @evdev-path: The --evdev-path command line option is supported. 96482580a6SMarc-André Lureau# @no-grab: The --no-grab command line option is supported. 97482580a6SMarc-André Lureau# 98482580a6SMarc-André Lureau# Since: 4.0 99482580a6SMarc-André Lureau## 100482580a6SMarc-André Lureau{ 101482580a6SMarc-André Lureau 'enum': 'VHostUserBackendInputFeature', 102482580a6SMarc-André Lureau 'data': [ 'evdev-path', 'no-grab' ] 103482580a6SMarc-André Lureau} 104482580a6SMarc-André Lureau 105482580a6SMarc-André Lureau## 106482580a6SMarc-André Lureau# @VHostUserBackendCapabilitiesInput: 107482580a6SMarc-André Lureau# 108482580a6SMarc-André Lureau# Capabilities reported by vhost user "input" backends 109482580a6SMarc-André Lureau# 110482580a6SMarc-André Lureau# @features: list of supported features. 111482580a6SMarc-André Lureau# 112482580a6SMarc-André Lureau# Since: 4.0 113482580a6SMarc-André Lureau## 114482580a6SMarc-André Lureau{ 115482580a6SMarc-André Lureau 'struct': 'VHostUserBackendCapabilitiesInput', 116482580a6SMarc-André Lureau 'data': { 117482580a6SMarc-André Lureau 'features': [ 'VHostUserBackendInputFeature' ] 118482580a6SMarc-André Lureau } 119482580a6SMarc-André Lureau} 120482580a6SMarc-André Lureau 121482580a6SMarc-André Lureau## 122482580a6SMarc-André Lureau# @VHostUserBackendGPUFeature: 123482580a6SMarc-André Lureau# 124482580a6SMarc-André Lureau# List of vhost user "gpu" features. 125482580a6SMarc-André Lureau# 126482580a6SMarc-André Lureau# @render-node: The --render-node command line option is supported. 127482580a6SMarc-André Lureau# @virgl: The --virgl command line option is supported. 128482580a6SMarc-André Lureau# 129482580a6SMarc-André Lureau# Since: 4.0 130482580a6SMarc-André Lureau## 131482580a6SMarc-André Lureau{ 132482580a6SMarc-André Lureau 'enum': 'VHostUserBackendGPUFeature', 133482580a6SMarc-André Lureau 'data': [ 'render-node', 'virgl' ] 134482580a6SMarc-André Lureau} 135482580a6SMarc-André Lureau 136482580a6SMarc-André Lureau## 137482580a6SMarc-André Lureau# @VHostUserBackendCapabilitiesGPU: 138482580a6SMarc-André Lureau# 139482580a6SMarc-André Lureau# Capabilities reported by vhost user "gpu" backends. 140482580a6SMarc-André Lureau# 141482580a6SMarc-André Lureau# @features: list of supported features. 142482580a6SMarc-André Lureau# 143482580a6SMarc-André Lureau# Since: 4.0 144482580a6SMarc-André Lureau## 145482580a6SMarc-André Lureau{ 146482580a6SMarc-André Lureau 'struct': 'VHostUserBackendCapabilitiesGPU', 147482580a6SMarc-André Lureau 'data': { 148482580a6SMarc-André Lureau 'features': [ 'VHostUserBackendGPUFeature' ] 149482580a6SMarc-André Lureau } 150482580a6SMarc-André Lureau} 151482580a6SMarc-André Lureau 152482580a6SMarc-André Lureau## 153482580a6SMarc-André Lureau# @VHostUserBackendCapabilities: 154482580a6SMarc-André Lureau# 155482580a6SMarc-André Lureau# Capabilities reported by vhost user backends. 156482580a6SMarc-André Lureau# 157482580a6SMarc-André Lureau# @type: The vhost user backend type. 158482580a6SMarc-André Lureau# 159482580a6SMarc-André Lureau# Since: 4.0 160482580a6SMarc-André Lureau## 161482580a6SMarc-André Lureau{ 162482580a6SMarc-André Lureau 'union': 'VHostUserBackendCapabilities', 163482580a6SMarc-André Lureau 'base': { 'type': 'VHostUserBackendType' }, 164482580a6SMarc-André Lureau 'discriminator': 'type', 165482580a6SMarc-André Lureau 'data': { 166482580a6SMarc-André Lureau 'input': 'VHostUserBackendCapabilitiesInput', 167482580a6SMarc-André Lureau 'gpu': 'VHostUserBackendCapabilitiesGPU' 168482580a6SMarc-André Lureau } 169482580a6SMarc-André Lureau} 170482580a6SMarc-André Lureau 171482580a6SMarc-André Lureau## 172482580a6SMarc-André Lureau# @VhostUserBackend: 173482580a6SMarc-André Lureau# 174482580a6SMarc-André Lureau# Describes a vhost user backend to management software. 175482580a6SMarc-André Lureau# 176482580a6SMarc-André Lureau# It is possible for multiple @VhostUserBackend elements to match the 177482580a6SMarc-André Lureau# search criteria of management software. Applications thus need rules 178482580a6SMarc-André Lureau# to pick one of the many matches, and users need the ability to 179482580a6SMarc-André Lureau# override distro defaults. 180482580a6SMarc-André Lureau# 181482580a6SMarc-André Lureau# It is recommended to create vhost user backend JSON files (each 182482580a6SMarc-André Lureau# containing a single @VhostUserBackend root element) with a 183482580a6SMarc-André Lureau# double-digit prefix, for example "50-qemu-gpu.json", 184482580a6SMarc-André Lureau# "50-crosvm-gpu.json", etc, so they can be sorted in predictable 185482580a6SMarc-André Lureau# order. The backend JSON files should be searched for in three 186482580a6SMarc-André Lureau# directories: 187482580a6SMarc-André Lureau# 188482580a6SMarc-André Lureau# - /usr/share/qemu/vhost-user -- populated by distro-provided 189482580a6SMarc-André Lureau# packages (XDG_DATA_DIRS covers 190482580a6SMarc-André Lureau# /usr/share by default), 191482580a6SMarc-André Lureau# 192482580a6SMarc-André Lureau# - /etc/qemu/vhost-user -- exclusively for sysadmins' local additions, 193482580a6SMarc-André Lureau# 194482580a6SMarc-André Lureau# - $XDG_CONFIG_HOME/qemu/vhost-user -- exclusively for per-user local 195482580a6SMarc-André Lureau# additions (XDG_CONFIG_HOME 196482580a6SMarc-André Lureau# defaults to $HOME/.config). 197482580a6SMarc-André Lureau# 198482580a6SMarc-André Lureau# Top-down, the list of directories goes from general to specific. 199482580a6SMarc-André Lureau# 200482580a6SMarc-André Lureau# Management software should build a list of files from all three 201482580a6SMarc-André Lureau# locations, then sort the list by filename (i.e., basename 202482580a6SMarc-André Lureau# component). Management software should choose the first JSON file on 203482580a6SMarc-André Lureau# the sorted list that matches the search criteria. If a more specific 204482580a6SMarc-André Lureau# directory has a file with same name as a less specific directory, 205482580a6SMarc-André Lureau# then the file in the more specific directory takes effect. If the 206482580a6SMarc-André Lureau# more specific file is zero length, it hides the less specific one. 207482580a6SMarc-André Lureau# 208482580a6SMarc-André Lureau# For example, if a distro ships 209482580a6SMarc-André Lureau# 210482580a6SMarc-André Lureau# - /usr/share/qemu/vhost-user/50-qemu-gpu.json 211482580a6SMarc-André Lureau# 212482580a6SMarc-André Lureau# - /usr/share/qemu/vhost-user/50-crosvm-gpu.json 213482580a6SMarc-André Lureau# 21400ab8cb1SMarc-André Lureau# then the sysadmin can prevent the default QEMU GPU being used at all with 215482580a6SMarc-André Lureau# 216482580a6SMarc-André Lureau# $ touch /etc/qemu/vhost-user/50-qemu-gpu.json 217482580a6SMarc-André Lureau# 21800ab8cb1SMarc-André Lureau# The sysadmin can replace/alter the distro default QEMU GPU with 219482580a6SMarc-André Lureau# 220482580a6SMarc-André Lureau# $ vim /etc/qemu/vhost-user/50-qemu-gpu.json 221482580a6SMarc-André Lureau# 222482580a6SMarc-André Lureau# or they can provide a parallel QEMU GPU with higher priority 223482580a6SMarc-André Lureau# 224482580a6SMarc-André Lureau# $ vim /etc/qemu/vhost-user/10-qemu-gpu.json 225482580a6SMarc-André Lureau# 22600ab8cb1SMarc-André Lureau# or they can provide a parallel QEMU GPU with lower priority 227482580a6SMarc-André Lureau# 228482580a6SMarc-André Lureau# $ vim /etc/qemu/vhost-user/99-qemu-gpu.json 229482580a6SMarc-André Lureau# 230482580a6SMarc-André Lureau# @type: The vhost user backend type. 231482580a6SMarc-André Lureau# 232482580a6SMarc-André Lureau# @description: Provides a human-readable description of the backend. 233482580a6SMarc-André Lureau# Management software may or may not display @description. 234482580a6SMarc-André Lureau# 235482580a6SMarc-André Lureau# @binary: Absolute path to the backend binary. 236482580a6SMarc-André Lureau# 237482580a6SMarc-André Lureau# @tags: An optional list of auxiliary strings associated with the 238482580a6SMarc-André Lureau# backend for which @description is not appropriate, due to the 239482580a6SMarc-André Lureau# latter's possible exposure to the end-user. @tags serves 240482580a6SMarc-André Lureau# development and debugging purposes only, and management 241482580a6SMarc-André Lureau# software shall explicitly ignore it. 242482580a6SMarc-André Lureau# 243482580a6SMarc-André Lureau# Since: 4.0 244482580a6SMarc-André Lureau# 245482580a6SMarc-André Lureau# Example: 246482580a6SMarc-André Lureau# 247482580a6SMarc-André Lureau# { 248482580a6SMarc-André Lureau# "description": "QEMU vhost-user-gpu", 249482580a6SMarc-André Lureau# "type": "gpu", 250482580a6SMarc-André Lureau# "binary": "/usr/libexec/qemu/vhost-user-gpu", 251482580a6SMarc-André Lureau# "tags": [ 252482580a6SMarc-André Lureau# "CONFIG_OPENGL_DMABUF=y" 253482580a6SMarc-André Lureau# ] 254482580a6SMarc-André Lureau# } 255482580a6SMarc-André Lureau# 256482580a6SMarc-André Lureau## 257482580a6SMarc-André Lureau{ 258482580a6SMarc-André Lureau 'struct' : 'VhostUserBackend', 259482580a6SMarc-André Lureau 'data' : { 260482580a6SMarc-André Lureau 'description': 'str', 261482580a6SMarc-André Lureau 'type': 'VHostUserBackendType', 262482580a6SMarc-André Lureau 'binary': 'str', 263482580a6SMarc-André Lureau '*tags': [ 'str' ] 264482580a6SMarc-André Lureau } 265482580a6SMarc-André Lureau} 266