blob: 621315452555f9c6db98a98877fae02ace586871 [file] [log] [blame]
Markus Armbrustera2ff5a42017-08-24 21:13:56 +02001# -*- Mode: Python -*-
Andrea Bolognanif7160f32020-07-29 20:50:24 +02002# vim: filetype=python
Markus Armbrustera2ff5a42017-08-24 21:13:56 +02003
4##
5# = Socket data types
6##
7
8{ 'include': 'common.json' }
9
10##
11# @NetworkAddressFamily:
12#
13# The network address family
14#
15# @ipv4: IPV4 family
16#
17# @ipv6: IPV6 family
18#
19# @unix: unix socket
20#
21# @vsock: vsock family (since 2.8)
22#
23# @unknown: otherwise
24#
25# Since: 2.1
26##
27{ 'enum': 'NetworkAddressFamily',
28 'data': [ 'ipv4', 'ipv6', 'unix', 'vsock', 'unknown' ] }
29
30##
31# @InetSocketAddressBase:
32#
33# @host: host part of the address
34# @port: port part of the address
35##
36{ 'struct': 'InetSocketAddressBase',
37 'data': {
38 'host': 'str',
39 'port': 'str' } }
40
41##
42# @InetSocketAddress:
43#
Markus Armbrustera937b6a2023-04-28 12:54:29 +020044# Captures a socket address or address range in the Internet
45# namespace.
Markus Armbrustera2ff5a42017-08-24 21:13:56 +020046#
Markus Armbrustera937b6a2023-04-28 12:54:29 +020047# @numeric: true if the host/port are guaranteed to be numeric, false
48# if name resolution should be attempted. Defaults to false.
49# (Since 2.9)
Markus Armbrustera2ff5a42017-08-24 21:13:56 +020050#
51# @to: If present, this is range of possible addresses, with port
Markus Armbrustera937b6a2023-04-28 12:54:29 +020052# between @port and @to.
Markus Armbrustera2ff5a42017-08-24 21:13:56 +020053#
Markus Armbrustera937b6a2023-04-28 12:54:29 +020054# @ipv4: whether to accept IPv4 addresses, default try both IPv4 and
55# IPv6
Markus Armbrustera2ff5a42017-08-24 21:13:56 +020056#
Markus Armbrustera937b6a2023-04-28 12:54:29 +020057# @ipv6: whether to accept IPv6 addresses, default try both IPv4 and
58# IPv6
Markus Armbrustera2ff5a42017-08-24 21:13:56 +020059#
Markus Armbrustera937b6a2023-04-28 12:54:29 +020060# @keep-alive: enable keep-alive when connecting to this socket. Not
61# supported for passive sockets. (Since 4.2)
Vladimir Sementsov-Ogievskiyaec21d32019-07-25 12:49:37 +030062#
Dr. David Alan Gilbert8bd10782021-04-21 12:28:34 +010063# @mptcp: enable multi-path TCP. (Since 6.1)
64#
Markus Armbrustera2ff5a42017-08-24 21:13:56 +020065# Since: 1.3
66##
67{ 'struct': 'InetSocketAddress',
68 'base': 'InetSocketAddressBase',
69 'data': {
70 '*numeric': 'bool',
71 '*to': 'uint16',
72 '*ipv4': 'bool',
Vladimir Sementsov-Ogievskiyaec21d32019-07-25 12:49:37 +030073 '*ipv6': 'bool',
Dr. David Alan Gilbert8bd10782021-04-21 12:28:34 +010074 '*keep-alive': 'bool',
Marc-André Lureau653163f2021-09-07 16:19:13 +040075 '*mptcp': { 'type': 'bool', 'if': 'HAVE_IPPROTO_MPTCP' } } }
Markus Armbrustera2ff5a42017-08-24 21:13:56 +020076
77##
78# @UnixSocketAddress:
79#
80# Captures a socket address in the local ("Unix socket") namespace.
81#
82# @path: filesystem path to use
Markus Armbrustera937b6a2023-04-28 12:54:29 +020083#
Markus Armbruster8acefc72020-11-02 10:44:22 +010084# @abstract: if true, this is a Linux abstract socket address. @path
Markus Armbrustera937b6a2023-04-28 12:54:29 +020085# will be prefixed by a null byte, and optionally padded with null
86# bytes. Defaults to false. (Since 5.1)
87#
Markus Armbruster8acefc72020-11-02 10:44:22 +010088# @tight: if false, pad an abstract socket address with enough null
Markus Armbrustera937b6a2023-04-28 12:54:29 +020089# bytes to make it fill struct sockaddr_un member sun_path.
90# Defaults to true. (Since 5.1)
Markus Armbrustera2ff5a42017-08-24 21:13:56 +020091#
92# Since: 1.3
93##
94{ 'struct': 'UnixSocketAddress',
95 'data': {
xiaoqiang zhao776b97d2020-05-16 11:13:25 +080096 'path': 'str',
Marc-André Lureau8a9f1e12021-08-04 12:31:05 +040097 '*abstract': { 'type': 'bool', 'if': 'CONFIG_LINUX' },
98 '*tight': { 'type': 'bool', 'if': 'CONFIG_LINUX' } } }
Markus Armbrustera2ff5a42017-08-24 21:13:56 +020099
100##
101# @VsockSocketAddress:
102#
103# Captures a socket address in the vsock namespace.
104#
105# @cid: unique host identifier
Markus Armbrustera937b6a2023-04-28 12:54:29 +0200106#
Markus Armbrustera2ff5a42017-08-24 21:13:56 +0200107# @port: port
108#
109# Note: string types are used to allow for possible future hostname or
Markus Armbrustera937b6a2023-04-28 12:54:29 +0200110# service resolution support.
Markus Armbrustera2ff5a42017-08-24 21:13:56 +0200111#
112# Since: 2.8
113##
114{ 'struct': 'VsockSocketAddress',
115 'data': {
116 'cid': 'str',
117 'port': 'str' } }
118
119##
Markus Armbruster935a8672021-09-17 16:31:19 +0200120# @InetSocketAddressWrapper:
121#
122# Since: 1.3
123##
124{ 'struct': 'InetSocketAddressWrapper',
125 'data': { 'data': 'InetSocketAddress' } }
126
127##
128# @UnixSocketAddressWrapper:
129#
130# Since: 1.3
131##
132{ 'struct': 'UnixSocketAddressWrapper',
133 'data': { 'data': 'UnixSocketAddress' } }
134
135##
136# @VsockSocketAddressWrapper:
137#
138# Since: 2.8
139##
140{ 'struct': 'VsockSocketAddressWrapper',
141 'data': { 'data': 'VsockSocketAddress' } }
142
143##
144# @StringWrapper:
145#
146# Since: 1.3
147##
148{ 'struct': 'StringWrapper',
149 'data': { 'data': 'String' } }
150
151##
Markus Armbrustera2ff5a42017-08-24 21:13:56 +0200152# @SocketAddressLegacy:
153#
Markus Armbrustera937b6a2023-04-28 12:54:29 +0200154# Captures the address of a socket, which could also be a named file
155# descriptor
Markus Armbrustera2ff5a42017-08-24 21:13:56 +0200156#
157# Note: This type is deprecated in favor of SocketAddress. The
Markus Armbrustera937b6a2023-04-28 12:54:29 +0200158# difference between SocketAddressLegacy and SocketAddress is that
159# the latter has fewer {} on the wire.
Markus Armbrustera2ff5a42017-08-24 21:13:56 +0200160#
161# Since: 1.3
162##
163{ 'union': 'SocketAddressLegacy',
Markus Armbruster935a8672021-09-17 16:31:19 +0200164 'base': { 'type': 'SocketAddressType' },
165 'discriminator': 'type',
Markus Armbrustera2ff5a42017-08-24 21:13:56 +0200166 'data': {
Markus Armbruster935a8672021-09-17 16:31:19 +0200167 'inet': 'InetSocketAddressWrapper',
168 'unix': 'UnixSocketAddressWrapper',
169 'vsock': 'VsockSocketAddressWrapper',
170 'fd': 'StringWrapper' } }
Markus Armbrustera2ff5a42017-08-24 21:13:56 +0200171
172##
173# @SocketAddressType:
174#
175# Available SocketAddress types
176#
Andrea Bolognanic0ac5332022-05-03 09:37:36 +0200177# @inet: Internet address
Markus Armbrustera2ff5a42017-08-24 21:13:56 +0200178#
Andrea Bolognanic0ac5332022-05-03 09:37:36 +0200179# @unix: Unix domain socket
Markus Armbrustera2ff5a42017-08-24 21:13:56 +0200180#
Daniel P. Berrange1723d6b2017-12-22 11:04:30 +0000181# @vsock: VMCI address
182#
Markus Armbrustera937b6a2023-04-28 12:54:29 +0200183# @fd: decimal is for file descriptor number, otherwise a file
184# descriptor name. Named file descriptors are permitted in
185# monitor commands, in combination with the 'getfd' command.
186# Decimal file descriptors are permitted at startup or other
187# contexts where no monitor context is active.
Daniel P. Berrange1723d6b2017-12-22 11:04:30 +0000188#
Markus Armbrustera2ff5a42017-08-24 21:13:56 +0200189# Since: 2.9
190##
191{ 'enum': 'SocketAddressType',
192 'data': [ 'inet', 'unix', 'vsock', 'fd' ] }
193
194##
195# @SocketAddress:
196#
197# Captures the address of a socket, which could also be a named file
198# descriptor
199#
Andrea Bolognani23e46452022-05-03 09:37:35 +0200200# @type: Transport type
Markus Armbrustera2ff5a42017-08-24 21:13:56 +0200201#
202# Since: 2.9
203##
204{ 'union': 'SocketAddress',
205 'base': { 'type': 'SocketAddressType' },
206 'discriminator': 'type',
207 'data': { 'inet': 'InetSocketAddress',
208 'unix': 'UnixSocketAddress',
209 'vsock': 'VsockSocketAddress',
210 'fd': 'String' } }