1a2ff5a48SMarkus Armbruster# -*- Mode: Python -*- 2f7160f32SAndrea Bolognani# vim: filetype=python 3a2ff5a48SMarkus Armbruster 4a2ff5a48SMarkus Armbruster## 5a2ff5a48SMarkus Armbruster# = Socket data types 6a2ff5a48SMarkus Armbruster## 7a2ff5a48SMarkus Armbruster 8a2ff5a48SMarkus Armbruster{ 'include': 'common.json' } 9a2ff5a48SMarkus Armbruster 10a2ff5a48SMarkus Armbruster## 11a2ff5a48SMarkus Armbruster# @NetworkAddressFamily: 12a2ff5a48SMarkus Armbruster# 13a2ff5a48SMarkus Armbruster# The network address family 14a2ff5a48SMarkus Armbruster# 15a2ff5a48SMarkus Armbruster# @ipv4: IPV4 family 16a2ff5a48SMarkus Armbruster# 17a2ff5a48SMarkus Armbruster# @ipv6: IPV6 family 18a2ff5a48SMarkus Armbruster# 19a2ff5a48SMarkus Armbruster# @unix: unix socket 20a2ff5a48SMarkus Armbruster# 21a2ff5a48SMarkus Armbruster# @vsock: vsock family (since 2.8) 22a2ff5a48SMarkus Armbruster# 23a2ff5a48SMarkus Armbruster# @unknown: otherwise 24a2ff5a48SMarkus Armbruster# 25a2ff5a48SMarkus Armbruster# Since: 2.1 26a2ff5a48SMarkus Armbruster## 27a2ff5a48SMarkus Armbruster{ 'enum': 'NetworkAddressFamily', 28a2ff5a48SMarkus Armbruster 'data': [ 'ipv4', 'ipv6', 'unix', 'vsock', 'unknown' ] } 29a2ff5a48SMarkus Armbruster 30a2ff5a48SMarkus Armbruster## 31a2ff5a48SMarkus Armbruster# @InetSocketAddressBase: 32a2ff5a48SMarkus Armbruster# 33a2ff5a48SMarkus Armbruster# @host: host part of the address 34a2ff5a48SMarkus Armbruster# @port: port part of the address 35a2ff5a48SMarkus Armbruster## 36a2ff5a48SMarkus Armbruster{ 'struct': 'InetSocketAddressBase', 37a2ff5a48SMarkus Armbruster 'data': { 38a2ff5a48SMarkus Armbruster 'host': 'str', 39a2ff5a48SMarkus Armbruster 'port': 'str' } } 40a2ff5a48SMarkus Armbruster 41a2ff5a48SMarkus Armbruster## 42a2ff5a48SMarkus Armbruster# @InetSocketAddress: 43a2ff5a48SMarkus Armbruster# 44*a937b6aaSMarkus Armbruster# Captures a socket address or address range in the Internet 45*a937b6aaSMarkus Armbruster# namespace. 46a2ff5a48SMarkus Armbruster# 47*a937b6aaSMarkus Armbruster# @numeric: true if the host/port are guaranteed to be numeric, false 48*a937b6aaSMarkus Armbruster# if name resolution should be attempted. Defaults to false. 49a2ff5a48SMarkus Armbruster# (Since 2.9) 50a2ff5a48SMarkus Armbruster# 51a2ff5a48SMarkus Armbruster# @to: If present, this is range of possible addresses, with port 52a2ff5a48SMarkus Armbruster# between @port and @to. 53a2ff5a48SMarkus Armbruster# 54*a937b6aaSMarkus Armbruster# @ipv4: whether to accept IPv4 addresses, default try both IPv4 and 55*a937b6aaSMarkus Armbruster# IPv6 56a2ff5a48SMarkus Armbruster# 57*a937b6aaSMarkus Armbruster# @ipv6: whether to accept IPv6 addresses, default try both IPv4 and 58*a937b6aaSMarkus Armbruster# IPv6 59a2ff5a48SMarkus Armbruster# 60*a937b6aaSMarkus Armbruster# @keep-alive: enable keep-alive when connecting to this socket. Not 61*a937b6aaSMarkus Armbruster# supported for passive sockets. (Since 4.2) 62aec21d31SVladimir Sementsov-Ogievskiy# 638bd1078aSDr. David Alan Gilbert# @mptcp: enable multi-path TCP. (Since 6.1) 648bd1078aSDr. David Alan Gilbert# 65a2ff5a48SMarkus Armbruster# Since: 1.3 66a2ff5a48SMarkus Armbruster## 67a2ff5a48SMarkus Armbruster{ 'struct': 'InetSocketAddress', 68a2ff5a48SMarkus Armbruster 'base': 'InetSocketAddressBase', 69a2ff5a48SMarkus Armbruster 'data': { 70a2ff5a48SMarkus Armbruster '*numeric': 'bool', 71a2ff5a48SMarkus Armbruster '*to': 'uint16', 72a2ff5a48SMarkus Armbruster '*ipv4': 'bool', 73aec21d31SVladimir Sementsov-Ogievskiy '*ipv6': 'bool', 748bd1078aSDr. David Alan Gilbert '*keep-alive': 'bool', 75653163fcSMarc-André Lureau '*mptcp': { 'type': 'bool', 'if': 'HAVE_IPPROTO_MPTCP' } } } 76a2ff5a48SMarkus Armbruster 77a2ff5a48SMarkus Armbruster## 78a2ff5a48SMarkus Armbruster# @UnixSocketAddress: 79a2ff5a48SMarkus Armbruster# 80a2ff5a48SMarkus Armbruster# Captures a socket address in the local ("Unix socket") namespace. 81a2ff5a48SMarkus Armbruster# 82a2ff5a48SMarkus Armbruster# @path: filesystem path to use 83*a937b6aaSMarkus Armbruster# 848acefc79SMarkus Armbruster# @abstract: if true, this is a Linux abstract socket address. @path 85*a937b6aaSMarkus Armbruster# will be prefixed by a null byte, and optionally padded with null 86*a937b6aaSMarkus Armbruster# bytes. Defaults to false. (Since 5.1) 87*a937b6aaSMarkus Armbruster# 888acefc79SMarkus Armbruster# @tight: if false, pad an abstract socket address with enough null 898acefc79SMarkus Armbruster# bytes to make it fill struct sockaddr_un member sun_path. 908acefc79SMarkus Armbruster# Defaults to true. (Since 5.1) 91a2ff5a48SMarkus Armbruster# 92a2ff5a48SMarkus Armbruster# Since: 1.3 93a2ff5a48SMarkus Armbruster## 94a2ff5a48SMarkus Armbruster{ 'struct': 'UnixSocketAddress', 95a2ff5a48SMarkus Armbruster 'data': { 96776b97d3Sxiaoqiang zhao 'path': 'str', 978a9f1e1dSMarc-André Lureau '*abstract': { 'type': 'bool', 'if': 'CONFIG_LINUX' }, 988a9f1e1dSMarc-André Lureau '*tight': { 'type': 'bool', 'if': 'CONFIG_LINUX' } } } 99a2ff5a48SMarkus Armbruster 100a2ff5a48SMarkus Armbruster## 101a2ff5a48SMarkus Armbruster# @VsockSocketAddress: 102a2ff5a48SMarkus Armbruster# 103a2ff5a48SMarkus Armbruster# Captures a socket address in the vsock namespace. 104a2ff5a48SMarkus Armbruster# 105a2ff5a48SMarkus Armbruster# @cid: unique host identifier 106*a937b6aaSMarkus Armbruster# 107a2ff5a48SMarkus Armbruster# @port: port 108a2ff5a48SMarkus Armbruster# 109a2ff5a48SMarkus Armbruster# Note: string types are used to allow for possible future hostname or 110a2ff5a48SMarkus Armbruster# service resolution support. 111a2ff5a48SMarkus Armbruster# 112a2ff5a48SMarkus Armbruster# Since: 2.8 113a2ff5a48SMarkus Armbruster## 114a2ff5a48SMarkus Armbruster{ 'struct': 'VsockSocketAddress', 115a2ff5a48SMarkus Armbruster 'data': { 116a2ff5a48SMarkus Armbruster 'cid': 'str', 117a2ff5a48SMarkus Armbruster 'port': 'str' } } 118a2ff5a48SMarkus Armbruster 119a2ff5a48SMarkus Armbruster## 120935a867cSMarkus Armbruster# @InetSocketAddressWrapper: 121935a867cSMarkus Armbruster# 122935a867cSMarkus Armbruster# Since: 1.3 123935a867cSMarkus Armbruster## 124935a867cSMarkus Armbruster{ 'struct': 'InetSocketAddressWrapper', 125935a867cSMarkus Armbruster 'data': { 'data': 'InetSocketAddress' } } 126935a867cSMarkus Armbruster 127935a867cSMarkus Armbruster## 128935a867cSMarkus Armbruster# @UnixSocketAddressWrapper: 129935a867cSMarkus Armbruster# 130935a867cSMarkus Armbruster# Since: 1.3 131935a867cSMarkus Armbruster## 132935a867cSMarkus Armbruster{ 'struct': 'UnixSocketAddressWrapper', 133935a867cSMarkus Armbruster 'data': { 'data': 'UnixSocketAddress' } } 134935a867cSMarkus Armbruster 135935a867cSMarkus Armbruster## 136935a867cSMarkus Armbruster# @VsockSocketAddressWrapper: 137935a867cSMarkus Armbruster# 138935a867cSMarkus Armbruster# Since: 2.8 139935a867cSMarkus Armbruster## 140935a867cSMarkus Armbruster{ 'struct': 'VsockSocketAddressWrapper', 141935a867cSMarkus Armbruster 'data': { 'data': 'VsockSocketAddress' } } 142935a867cSMarkus Armbruster 143935a867cSMarkus Armbruster## 144935a867cSMarkus Armbruster# @StringWrapper: 145935a867cSMarkus Armbruster# 146935a867cSMarkus Armbruster# Since: 1.3 147935a867cSMarkus Armbruster## 148935a867cSMarkus Armbruster{ 'struct': 'StringWrapper', 149935a867cSMarkus Armbruster 'data': { 'data': 'String' } } 150935a867cSMarkus Armbruster 151935a867cSMarkus Armbruster## 152a2ff5a48SMarkus Armbruster# @SocketAddressLegacy: 153a2ff5a48SMarkus Armbruster# 154*a937b6aaSMarkus Armbruster# Captures the address of a socket, which could also be a named file 155*a937b6aaSMarkus Armbruster# descriptor 156a2ff5a48SMarkus Armbruster# 157a2ff5a48SMarkus Armbruster# Note: This type is deprecated in favor of SocketAddress. The 158*a937b6aaSMarkus Armbruster# difference between SocketAddressLegacy and SocketAddress is that 159*a937b6aaSMarkus Armbruster# the latter has fewer {} on the wire. 160a2ff5a48SMarkus Armbruster# 161a2ff5a48SMarkus Armbruster# Since: 1.3 162a2ff5a48SMarkus Armbruster## 163a2ff5a48SMarkus Armbruster{ 'union': 'SocketAddressLegacy', 164935a867cSMarkus Armbruster 'base': { 'type': 'SocketAddressType' }, 165935a867cSMarkus Armbruster 'discriminator': 'type', 166a2ff5a48SMarkus Armbruster 'data': { 167935a867cSMarkus Armbruster 'inet': 'InetSocketAddressWrapper', 168935a867cSMarkus Armbruster 'unix': 'UnixSocketAddressWrapper', 169935a867cSMarkus Armbruster 'vsock': 'VsockSocketAddressWrapper', 170935a867cSMarkus Armbruster 'fd': 'StringWrapper' } } 171a2ff5a48SMarkus Armbruster 172a2ff5a48SMarkus Armbruster## 173a2ff5a48SMarkus Armbruster# @SocketAddressType: 174a2ff5a48SMarkus Armbruster# 175a2ff5a48SMarkus Armbruster# Available SocketAddress types 176a2ff5a48SMarkus Armbruster# 177a2ff5a48SMarkus Armbruster# @inet: Internet address 178a2ff5a48SMarkus Armbruster# 179a2ff5a48SMarkus Armbruster# @unix: Unix domain socket 180a2ff5a48SMarkus Armbruster# 1811723d6b1SDaniel P. Berrange# @vsock: VMCI address 1821723d6b1SDaniel P. Berrange# 183*a937b6aaSMarkus Armbruster# @fd: decimal is for file descriptor number, otherwise a file 184*a937b6aaSMarkus Armbruster# descriptor name. Named file descriptors are permitted in 185*a937b6aaSMarkus Armbruster# monitor commands, in combination with the 'getfd' command. 186*a937b6aaSMarkus Armbruster# Decimal file descriptors are permitted at startup or other 187*a937b6aaSMarkus Armbruster# contexts where no monitor context is active. 1881723d6b1SDaniel P. Berrange# 189a2ff5a48SMarkus Armbruster# Since: 2.9 190a2ff5a48SMarkus Armbruster## 191a2ff5a48SMarkus Armbruster{ 'enum': 'SocketAddressType', 192a2ff5a48SMarkus Armbruster 'data': [ 'inet', 'unix', 'vsock', 'fd' ] } 193a2ff5a48SMarkus Armbruster 194a2ff5a48SMarkus Armbruster## 195a2ff5a48SMarkus Armbruster# @SocketAddress: 196a2ff5a48SMarkus Armbruster# 197a2ff5a48SMarkus Armbruster# Captures the address of a socket, which could also be a named file 198a2ff5a48SMarkus Armbruster# descriptor 199a2ff5a48SMarkus Armbruster# 200a2ff5a48SMarkus Armbruster# @type: Transport type 201a2ff5a48SMarkus Armbruster# 202a2ff5a48SMarkus Armbruster# Since: 2.9 203a2ff5a48SMarkus Armbruster## 204a2ff5a48SMarkus Armbruster{ 'union': 'SocketAddress', 205a2ff5a48SMarkus Armbruster 'base': { 'type': 'SocketAddressType' }, 206a2ff5a48SMarkus Armbruster 'discriminator': 'type', 207a2ff5a48SMarkus Armbruster 'data': { 'inet': 'InetSocketAddress', 208a2ff5a48SMarkus Armbruster 'unix': 'UnixSocketAddress', 209a2ff5a48SMarkus Armbruster 'vsock': 'VsockSocketAddress', 210a2ff5a48SMarkus Armbruster 'fd': 'String' } } 211