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 34482580a6SMarc-André Lureau# 35482580a6SMarc-André Lureau# Since: 4.0 36482580a6SMarc-André Lureau## 37482580a6SMarc-André Lureau{ 38482580a6SMarc-André Lureau 'enum': 'VHostUserBackendType', 39482580a6SMarc-André Lureau 'data': [ 40482580a6SMarc-André Lureau '9p', 41482580a6SMarc-André Lureau 'balloon', 42482580a6SMarc-André Lureau 'block', 43482580a6SMarc-André Lureau 'caif', 44482580a6SMarc-André Lureau 'console', 45482580a6SMarc-André Lureau 'crypto', 46482580a6SMarc-André Lureau 'gpu', 47482580a6SMarc-André Lureau 'input', 48482580a6SMarc-André Lureau 'net', 49482580a6SMarc-André Lureau 'rng', 50482580a6SMarc-André Lureau 'rpmsg', 51482580a6SMarc-André Lureau 'rproc-serial', 52482580a6SMarc-André Lureau 'scsi', 53482580a6SMarc-André Lureau 'vsock' 54482580a6SMarc-André Lureau ] 55482580a6SMarc-André Lureau} 56482580a6SMarc-André Lureau 57482580a6SMarc-André Lureau## 58*6620801fSMicky Yun Chan# @VHostUserBackendBlockFeature: 59*6620801fSMicky Yun Chan# 60*6620801fSMicky Yun Chan# List of vhost user "block" features. 61*6620801fSMicky Yun Chan# 62*6620801fSMicky Yun Chan# @read-only: The --read-only command line option is supported. 63*6620801fSMicky Yun Chan# @blk-file: The --blk-file command line option is supported. 64*6620801fSMicky Yun Chan# 65*6620801fSMicky Yun Chan# Since: 5.0 66*6620801fSMicky Yun Chan## 67*6620801fSMicky Yun Chan{ 68*6620801fSMicky Yun Chan 'enum': 'VHostUserBackendBlockFeature', 69*6620801fSMicky Yun Chan 'data': [ 'read-only', 'blk-file' ] 70*6620801fSMicky Yun Chan} 71*6620801fSMicky Yun Chan 72*6620801fSMicky Yun Chan## 73*6620801fSMicky Yun Chan# @VHostUserBackendCapabilitiesBlock: 74*6620801fSMicky Yun Chan# 75*6620801fSMicky Yun Chan# Capabilities reported by vhost user "block" backends 76*6620801fSMicky Yun Chan# 77*6620801fSMicky Yun Chan# @features: list of supported features. 78*6620801fSMicky Yun Chan# 79*6620801fSMicky Yun Chan# Since: 5.0 80*6620801fSMicky Yun Chan## 81*6620801fSMicky Yun Chan{ 82*6620801fSMicky Yun Chan 'struct': 'VHostUserBackendCapabilitiesBlock', 83*6620801fSMicky Yun Chan 'data': { 84*6620801fSMicky Yun Chan 'features': [ 'VHostUserBackendBlockFeature' ] 85*6620801fSMicky Yun Chan } 86*6620801fSMicky Yun Chan} 87*6620801fSMicky Yun Chan 88*6620801fSMicky Yun Chan## 89482580a6SMarc-André Lureau# @VHostUserBackendInputFeature: 90482580a6SMarc-André Lureau# 91482580a6SMarc-André Lureau# List of vhost user "input" features. 92482580a6SMarc-André Lureau# 93482580a6SMarc-André Lureau# @evdev-path: The --evdev-path command line option is supported. 94482580a6SMarc-André Lureau# @no-grab: The --no-grab command line option is supported. 95482580a6SMarc-André Lureau# 96482580a6SMarc-André Lureau# Since: 4.0 97482580a6SMarc-André Lureau## 98482580a6SMarc-André Lureau{ 99482580a6SMarc-André Lureau 'enum': 'VHostUserBackendInputFeature', 100482580a6SMarc-André Lureau 'data': [ 'evdev-path', 'no-grab' ] 101482580a6SMarc-André Lureau} 102482580a6SMarc-André Lureau 103482580a6SMarc-André Lureau## 104482580a6SMarc-André Lureau# @VHostUserBackendCapabilitiesInput: 105482580a6SMarc-André Lureau# 106482580a6SMarc-André Lureau# Capabilities reported by vhost user "input" backends 107482580a6SMarc-André Lureau# 108482580a6SMarc-André Lureau# @features: list of supported features. 109482580a6SMarc-André Lureau# 110482580a6SMarc-André Lureau# Since: 4.0 111482580a6SMarc-André Lureau## 112482580a6SMarc-André Lureau{ 113482580a6SMarc-André Lureau 'struct': 'VHostUserBackendCapabilitiesInput', 114482580a6SMarc-André Lureau 'data': { 115482580a6SMarc-André Lureau 'features': [ 'VHostUserBackendInputFeature' ] 116482580a6SMarc-André Lureau } 117482580a6SMarc-André Lureau} 118482580a6SMarc-André Lureau 119482580a6SMarc-André Lureau## 120482580a6SMarc-André Lureau# @VHostUserBackendGPUFeature: 121482580a6SMarc-André Lureau# 122482580a6SMarc-André Lureau# List of vhost user "gpu" features. 123482580a6SMarc-André Lureau# 124482580a6SMarc-André Lureau# @render-node: The --render-node command line option is supported. 125482580a6SMarc-André Lureau# @virgl: The --virgl command line option is supported. 126482580a6SMarc-André Lureau# 127482580a6SMarc-André Lureau# Since: 4.0 128482580a6SMarc-André Lureau## 129482580a6SMarc-André Lureau{ 130482580a6SMarc-André Lureau 'enum': 'VHostUserBackendGPUFeature', 131482580a6SMarc-André Lureau 'data': [ 'render-node', 'virgl' ] 132482580a6SMarc-André Lureau} 133482580a6SMarc-André Lureau 134482580a6SMarc-André Lureau## 135482580a6SMarc-André Lureau# @VHostUserBackendCapabilitiesGPU: 136482580a6SMarc-André Lureau# 137482580a6SMarc-André Lureau# Capabilities reported by vhost user "gpu" backends. 138482580a6SMarc-André Lureau# 139482580a6SMarc-André Lureau# @features: list of supported features. 140482580a6SMarc-André Lureau# 141482580a6SMarc-André Lureau# Since: 4.0 142482580a6SMarc-André Lureau## 143482580a6SMarc-André Lureau{ 144482580a6SMarc-André Lureau 'struct': 'VHostUserBackendCapabilitiesGPU', 145482580a6SMarc-André Lureau 'data': { 146482580a6SMarc-André Lureau 'features': [ 'VHostUserBackendGPUFeature' ] 147482580a6SMarc-André Lureau } 148482580a6SMarc-André Lureau} 149482580a6SMarc-André Lureau 150482580a6SMarc-André Lureau## 151482580a6SMarc-André Lureau# @VHostUserBackendCapabilities: 152482580a6SMarc-André Lureau# 153482580a6SMarc-André Lureau# Capabilities reported by vhost user backends. 154482580a6SMarc-André Lureau# 155482580a6SMarc-André Lureau# @type: The vhost user backend type. 156482580a6SMarc-André Lureau# 157482580a6SMarc-André Lureau# Since: 4.0 158482580a6SMarc-André Lureau## 159482580a6SMarc-André Lureau{ 160482580a6SMarc-André Lureau 'union': 'VHostUserBackendCapabilities', 161482580a6SMarc-André Lureau 'base': { 'type': 'VHostUserBackendType' }, 162482580a6SMarc-André Lureau 'discriminator': 'type', 163482580a6SMarc-André Lureau 'data': { 164482580a6SMarc-André Lureau 'input': 'VHostUserBackendCapabilitiesInput', 165482580a6SMarc-André Lureau 'gpu': 'VHostUserBackendCapabilitiesGPU' 166482580a6SMarc-André Lureau } 167482580a6SMarc-André Lureau} 168482580a6SMarc-André Lureau 169482580a6SMarc-André Lureau## 170482580a6SMarc-André Lureau# @VhostUserBackend: 171482580a6SMarc-André Lureau# 172482580a6SMarc-André Lureau# Describes a vhost user backend to management software. 173482580a6SMarc-André Lureau# 174482580a6SMarc-André Lureau# It is possible for multiple @VhostUserBackend elements to match the 175482580a6SMarc-André Lureau# search criteria of management software. Applications thus need rules 176482580a6SMarc-André Lureau# to pick one of the many matches, and users need the ability to 177482580a6SMarc-André Lureau# override distro defaults. 178482580a6SMarc-André Lureau# 179482580a6SMarc-André Lureau# It is recommended to create vhost user backend JSON files (each 180482580a6SMarc-André Lureau# containing a single @VhostUserBackend root element) with a 181482580a6SMarc-André Lureau# double-digit prefix, for example "50-qemu-gpu.json", 182482580a6SMarc-André Lureau# "50-crosvm-gpu.json", etc, so they can be sorted in predictable 183482580a6SMarc-André Lureau# order. The backend JSON files should be searched for in three 184482580a6SMarc-André Lureau# directories: 185482580a6SMarc-André Lureau# 186482580a6SMarc-André Lureau# - /usr/share/qemu/vhost-user -- populated by distro-provided 187482580a6SMarc-André Lureau# packages (XDG_DATA_DIRS covers 188482580a6SMarc-André Lureau# /usr/share by default), 189482580a6SMarc-André Lureau# 190482580a6SMarc-André Lureau# - /etc/qemu/vhost-user -- exclusively for sysadmins' local additions, 191482580a6SMarc-André Lureau# 192482580a6SMarc-André Lureau# - $XDG_CONFIG_HOME/qemu/vhost-user -- exclusively for per-user local 193482580a6SMarc-André Lureau# additions (XDG_CONFIG_HOME 194482580a6SMarc-André Lureau# defaults to $HOME/.config). 195482580a6SMarc-André Lureau# 196482580a6SMarc-André Lureau# Top-down, the list of directories goes from general to specific. 197482580a6SMarc-André Lureau# 198482580a6SMarc-André Lureau# Management software should build a list of files from all three 199482580a6SMarc-André Lureau# locations, then sort the list by filename (i.e., basename 200482580a6SMarc-André Lureau# component). Management software should choose the first JSON file on 201482580a6SMarc-André Lureau# the sorted list that matches the search criteria. If a more specific 202482580a6SMarc-André Lureau# directory has a file with same name as a less specific directory, 203482580a6SMarc-André Lureau# then the file in the more specific directory takes effect. If the 204482580a6SMarc-André Lureau# more specific file is zero length, it hides the less specific one. 205482580a6SMarc-André Lureau# 206482580a6SMarc-André Lureau# For example, if a distro ships 207482580a6SMarc-André Lureau# 208482580a6SMarc-André Lureau# - /usr/share/qemu/vhost-user/50-qemu-gpu.json 209482580a6SMarc-André Lureau# 210482580a6SMarc-André Lureau# - /usr/share/qemu/vhost-user/50-crosvm-gpu.json 211482580a6SMarc-André Lureau# 21200ab8cb1SMarc-André Lureau# then the sysadmin can prevent the default QEMU GPU being used at all with 213482580a6SMarc-André Lureau# 214482580a6SMarc-André Lureau# $ touch /etc/qemu/vhost-user/50-qemu-gpu.json 215482580a6SMarc-André Lureau# 21600ab8cb1SMarc-André Lureau# The sysadmin can replace/alter the distro default QEMU GPU with 217482580a6SMarc-André Lureau# 218482580a6SMarc-André Lureau# $ vim /etc/qemu/vhost-user/50-qemu-gpu.json 219482580a6SMarc-André Lureau# 220482580a6SMarc-André Lureau# or they can provide a parallel QEMU GPU with higher priority 221482580a6SMarc-André Lureau# 222482580a6SMarc-André Lureau# $ vim /etc/qemu/vhost-user/10-qemu-gpu.json 223482580a6SMarc-André Lureau# 22400ab8cb1SMarc-André Lureau# or they can provide a parallel QEMU GPU with lower priority 225482580a6SMarc-André Lureau# 226482580a6SMarc-André Lureau# $ vim /etc/qemu/vhost-user/99-qemu-gpu.json 227482580a6SMarc-André Lureau# 228482580a6SMarc-André Lureau# @type: The vhost user backend type. 229482580a6SMarc-André Lureau# 230482580a6SMarc-André Lureau# @description: Provides a human-readable description of the backend. 231482580a6SMarc-André Lureau# Management software may or may not display @description. 232482580a6SMarc-André Lureau# 233482580a6SMarc-André Lureau# @binary: Absolute path to the backend binary. 234482580a6SMarc-André Lureau# 235482580a6SMarc-André Lureau# @tags: An optional list of auxiliary strings associated with the 236482580a6SMarc-André Lureau# backend for which @description is not appropriate, due to the 237482580a6SMarc-André Lureau# latter's possible exposure to the end-user. @tags serves 238482580a6SMarc-André Lureau# development and debugging purposes only, and management 239482580a6SMarc-André Lureau# software shall explicitly ignore it. 240482580a6SMarc-André Lureau# 241482580a6SMarc-André Lureau# Since: 4.0 242482580a6SMarc-André Lureau# 243482580a6SMarc-André Lureau# Example: 244482580a6SMarc-André Lureau# 245482580a6SMarc-André Lureau# { 246482580a6SMarc-André Lureau# "description": "QEMU vhost-user-gpu", 247482580a6SMarc-André Lureau# "type": "gpu", 248482580a6SMarc-André Lureau# "binary": "/usr/libexec/qemu/vhost-user-gpu", 249482580a6SMarc-André Lureau# "tags": [ 250482580a6SMarc-André Lureau# "CONFIG_OPENGL_DMABUF=y" 251482580a6SMarc-André Lureau# ] 252482580a6SMarc-André Lureau# } 253482580a6SMarc-André Lureau# 254482580a6SMarc-André Lureau## 255482580a6SMarc-André Lureau{ 256482580a6SMarc-André Lureau 'struct' : 'VhostUserBackend', 257482580a6SMarc-André Lureau 'data' : { 258482580a6SMarc-André Lureau 'description': 'str', 259482580a6SMarc-André Lureau 'type': 'VHostUserBackendType', 260482580a6SMarc-André Lureau 'binary': 'str', 261482580a6SMarc-André Lureau '*tags': [ 'str' ] 262482580a6SMarc-André Lureau } 263482580a6SMarc-André Lureau} 264