blob: dbbde99e39eb7a0189e01bae6c0b5d1bc903efe5 [file] [log] [blame]
Vladimir Sementsov-Ogievskiyaaaa20b2020-09-24 21:54:11 +03001#! /usr/bin/env python3
2"""Generate coroutine wrappers for block subsystem.
3
4The program parses one or several concatenated c files from stdin,
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -05005searches for functions with the 'co_wrapper' specifier
Vladimir Sementsov-Ogievskiyaaaa20b2020-09-24 21:54:11 +03006and generates corresponding wrappers on stdout.
7
8Usage: block-coroutine-wrapper.py generated-file.c FILE.[ch]...
9
10Copyright (c) 2020 Virtuozzo International GmbH.
11
12This program is free software; you can redistribute it and/or modify
13it under the terms of the GNU General Public License as published by
14the Free Software Foundation; either version 2 of the License, or
15(at your option) any later version.
16
17This program is distributed in the hope that it will be useful,
18but WITHOUT ANY WARRANTY; without even the implied warranty of
19MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20GNU General Public License for more details.
21
22You should have received a copy of the GNU General Public License
23along with this program. If not, see <http://www.gnu.org/licenses/>.
24"""
25
26import sys
27import re
28from typing import Iterator
29
30
31def gen_header():
32 copyright = re.sub('^.*Copyright', 'Copyright', __doc__, flags=re.DOTALL)
33 copyright = re.sub('^(?=.)', ' * ', copyright.strip(), flags=re.MULTILINE)
34 copyright = re.sub('^$', ' *', copyright, flags=re.MULTILINE)
35 return f"""\
36/*
37 * File is generated by scripts/block-coroutine-wrapper.py
38 *
39{copyright}
40 */
41
42#include "qemu/osdep.h"
43#include "block/coroutines.h"
44#include "block/block-gen.h"
Markus Armbrustere2c1c342022-12-21 14:35:49 +010045#include "block/block_int.h"
46#include "block/dirty-bitmap.h"
Vladimir Sementsov-Ogievskiyaaaa20b2020-09-24 21:54:11 +030047"""
48
49
50class ParamDecl:
51 param_re = re.compile(r'(?P<decl>'
52 r'(?P<type>.*[ *])'
53 r'(?P<name>[a-z][a-z0-9_]*)'
54 r')')
55
56 def __init__(self, param_decl: str) -> None:
57 m = self.param_re.match(param_decl.strip())
58 if m is None:
59 raise ValueError(f'Wrong parameter declaration: "{param_decl}"')
60 self.decl = m.group('decl')
61 self.type = m.group('type')
62 self.name = m.group('name')
63
64
65class FuncDecl:
Kevin Wolfd6ee2e32023-01-26 18:24:20 +010066 def __init__(self, wrapper_type: str, return_type: str, name: str,
67 args: str, variant: str) -> None:
Vladimir Sementsov-Ogievskiyaaaa20b2020-09-24 21:54:11 +030068 self.return_type = return_type.strip()
69 self.name = name.strip()
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -050070 self.struct_name = snake_to_camel(self.name)
Vladimir Sementsov-Ogievskiyaaaa20b2020-09-24 21:54:11 +030071 self.args = [ParamDecl(arg.strip()) for arg in args.split(',')]
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -050072 self.create_only_co = 'mixed' not in variant
Emanuele Giuseppe Espositoe6d3f7a2022-12-07 14:18:36 +010073 self.graph_rdlock = 'bdrv_rdlock' in variant
Kevin Wolfde903292023-09-11 11:46:05 +020074 self.graph_wrlock = 'bdrv_wrlock' in variant
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -050075
Kevin Wolfd6ee2e32023-01-26 18:24:20 +010076 self.wrapper_type = wrapper_type
77
78 if wrapper_type == 'co':
Kevin Wolfde903292023-09-11 11:46:05 +020079 if self.graph_wrlock:
80 raise ValueError(f"co function can't be wrlock: {self.name}")
Kevin Wolfd6ee2e32023-01-26 18:24:20 +010081 subsystem, subname = self.name.split('_', 1)
82 self.target_name = f'{subsystem}_co_{subname}'
83 else:
84 assert wrapper_type == 'no_co'
85 subsystem, co_infix, subname = self.name.split('_', 2)
86 if co_infix != 'co':
87 raise ValueError(f"Invalid no_co function name: {self.name}")
88 if not self.create_only_co:
89 raise ValueError(f"no_co function can't be mixed: {self.name}")
Kevin Wolfe84c07b2023-09-29 16:51:37 +020090 if self.graph_rdlock and self.graph_wrlock:
91 raise ValueError("function can't be both rdlock and wrlock: "
92 f"{self.name}")
Kevin Wolfd6ee2e32023-01-26 18:24:20 +010093 self.target_name = f'{subsystem}_{subname}'
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -050094
Emanuele Giuseppe Esposito5b317b82023-01-13 21:41:59 +010095 self.get_result = 's->ret = '
96 self.ret = 'return s.ret;'
97 self.co_ret = 'return '
98 self.return_field = self.return_type + " ret;"
99 if self.return_type == 'void':
100 self.get_result = ''
101 self.ret = ''
102 self.co_ret = ''
103 self.return_field = ''
104
Kevin Wolfdea97c12023-05-25 14:47:02 +0200105 def gen_ctx(self, prefix: str = '') -> str:
106 t = self.args[0].type
Kevin Wolfd2184342023-09-11 11:46:06 +0200107 name = self.args[0].name
Kevin Wolfdea97c12023-05-25 14:47:02 +0200108 if t == 'BlockDriverState *':
Kevin Wolfd2184342023-09-11 11:46:06 +0200109 return f'bdrv_get_aio_context({prefix}{name})'
Kevin Wolfdea97c12023-05-25 14:47:02 +0200110 elif t == 'BdrvChild *':
Kevin Wolfd2184342023-09-11 11:46:06 +0200111 return f'bdrv_get_aio_context({prefix}{name}->bs)'
Kevin Wolfdea97c12023-05-25 14:47:02 +0200112 elif t == 'BlockBackend *':
Kevin Wolfd2184342023-09-11 11:46:06 +0200113 return f'blk_get_aio_context({prefix}{name})'
Kevin Wolfdea97c12023-05-25 14:47:02 +0200114 else:
115 return 'qemu_get_aio_context()'
116
Vladimir Sementsov-Ogievskiyaaaa20b2020-09-24 21:54:11 +0300117 def gen_list(self, format: str) -> str:
118 return ', '.join(format.format_map(arg.__dict__) for arg in self.args)
119
120 def gen_block(self, format: str) -> str:
121 return '\n'.join(format.format_map(arg.__dict__) for arg in self.args)
122
123
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500124# Match wrappers declared with a co_wrapper mark
Emanuele Giuseppe Esposito6700dfb2022-11-28 09:23:35 -0500125func_decl_re = re.compile(r'^(?P<return_type>[a-zA-Z][a-zA-Z0-9_]* [\*]?)'
Kevin Wolfd6ee2e32023-01-26 18:24:20 +0100126 r'(\s*coroutine_fn)?'
127 r'\s*(?P<wrapper_type>(no_)?co)_wrapper'
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500128 r'(?P<variant>(_[a-z][a-z0-9_]*)?)\s*'
Vladimir Sementsov-Ogievskiyaaaa20b2020-09-24 21:54:11 +0300129 r'(?P<wrapper_name>[a-z][a-z0-9_]*)'
130 r'\((?P<args>[^)]*)\);$', re.MULTILINE)
131
132
133def func_decl_iter(text: str) -> Iterator:
134 for m in func_decl_re.finditer(text):
Kevin Wolfd6ee2e32023-01-26 18:24:20 +0100135 yield FuncDecl(wrapper_type=m.group('wrapper_type'),
136 return_type=m.group('return_type'),
Vladimir Sementsov-Ogievskiyaaaa20b2020-09-24 21:54:11 +0300137 name=m.group('wrapper_name'),
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500138 args=m.group('args'),
139 variant=m.group('variant'))
Vladimir Sementsov-Ogievskiyaaaa20b2020-09-24 21:54:11 +0300140
141
142def snake_to_camel(func_name: str) -> str:
143 """
144 Convert underscore names like 'some_function_name' to camel-case like
145 'SomeFunctionName'
146 """
147 words = func_name.split('_')
148 words = [w[0].upper() + w[1:] for w in words]
149 return ''.join(words)
150
151
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500152def create_mixed_wrapper(func: FuncDecl) -> str:
153 """
154 Checks if we are already in coroutine
155 """
Kevin Wolfd6ee2e32023-01-26 18:24:20 +0100156 name = func.target_name
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500157 struct_name = func.struct_name
Emanuele Giuseppe Espositoe6d3f7a2022-12-07 14:18:36 +0100158 graph_assume_lock = 'assume_graph_lock();' if func.graph_rdlock else ''
159
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500160 return f"""\
Emanuele Giuseppe Esposito6700dfb2022-11-28 09:23:35 -0500161{func.return_type} {func.name}({ func.gen_list('{decl}') })
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500162{{
163 if (qemu_in_coroutine()) {{
Emanuele Giuseppe Espositoe6d3f7a2022-12-07 14:18:36 +0100164 {graph_assume_lock}
Emanuele Giuseppe Esposito5b317b82023-01-13 21:41:59 +0100165 {func.co_ret}{name}({ func.gen_list('{name}') });
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500166 }} else {{
167 {struct_name} s = {{
Stefan Hajnoczic12887e2023-09-12 19:10:37 -0400168 .poll_state.ctx = qemu_get_current_aio_context(),
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500169 .poll_state.in_progress = true,
170
171{ func.gen_block(' .{name} = {name},') }
172 }};
173
174 s.poll_state.co = qemu_coroutine_create({name}_entry, &s);
175
Emanuele Giuseppe Esposito6700dfb2022-11-28 09:23:35 -0500176 bdrv_poll_co(&s.poll_state);
Emanuele Giuseppe Esposito5b317b82023-01-13 21:41:59 +0100177 {func.ret}
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500178 }}
179}}"""
180
181
182def create_co_wrapper(func: FuncDecl) -> str:
183 """
184 Assumes we are not in coroutine, and creates one
185 """
Kevin Wolfd6ee2e32023-01-26 18:24:20 +0100186 name = func.target_name
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500187 struct_name = func.struct_name
188 return f"""\
Emanuele Giuseppe Esposito6700dfb2022-11-28 09:23:35 -0500189{func.return_type} {func.name}({ func.gen_list('{decl}') })
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500190{{
191 {struct_name} s = {{
Stefan Hajnoczic12887e2023-09-12 19:10:37 -0400192 .poll_state.ctx = qemu_get_current_aio_context(),
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500193 .poll_state.in_progress = true,
194
195{ func.gen_block(' .{name} = {name},') }
196 }};
197 assert(!qemu_in_coroutine());
198
199 s.poll_state.co = qemu_coroutine_create({name}_entry, &s);
200
Emanuele Giuseppe Esposito6700dfb2022-11-28 09:23:35 -0500201 bdrv_poll_co(&s.poll_state);
Emanuele Giuseppe Esposito5b317b82023-01-13 21:41:59 +0100202 {func.ret}
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500203}}"""
204
205
Kevin Wolfd6ee2e32023-01-26 18:24:20 +0100206def gen_co_wrapper(func: FuncDecl) -> str:
Vladimir Sementsov-Ogievskiybb436942021-06-10 13:07:57 +0300207 assert not '_co_' in func.name
Kevin Wolfd6ee2e32023-01-26 18:24:20 +0100208 assert func.wrapper_type == 'co'
Vladimir Sementsov-Ogievskiyaaaa20b2020-09-24 21:54:11 +0300209
Kevin Wolfd6ee2e32023-01-26 18:24:20 +0100210 name = func.target_name
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500211 struct_name = func.struct_name
Vladimir Sementsov-Ogievskiybb436942021-06-10 13:07:57 +0300212
Emanuele Giuseppe Espositoe6d3f7a2022-12-07 14:18:36 +0100213 graph_lock=''
214 graph_unlock=''
215 if func.graph_rdlock:
216 graph_lock=' bdrv_graph_co_rdlock();'
217 graph_unlock=' bdrv_graph_co_rdunlock();'
218
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500219 creation_function = create_mixed_wrapper
220 if func.create_only_co:
221 creation_function = create_co_wrapper
Vladimir Sementsov-Ogievskiyaaaa20b2020-09-24 21:54:11 +0300222
223 return f"""\
224/*
225 * Wrappers for {name}
226 */
227
228typedef struct {struct_name} {{
229 BdrvPollCo poll_state;
Emanuele Giuseppe Esposito5b317b82023-01-13 21:41:59 +0100230 {func.return_field}
Vladimir Sementsov-Ogievskiyaaaa20b2020-09-24 21:54:11 +0300231{ func.gen_block(' {decl};') }
232}} {struct_name};
233
234static void coroutine_fn {name}_entry(void *opaque)
235{{
236 {struct_name} *s = opaque;
237
Emanuele Giuseppe Espositoe6d3f7a2022-12-07 14:18:36 +0100238{graph_lock}
Emanuele Giuseppe Esposito5b317b82023-01-13 21:41:59 +0100239 {func.get_result}{name}({ func.gen_list('s->{name}') });
Emanuele Giuseppe Espositoe6d3f7a2022-12-07 14:18:36 +0100240{graph_unlock}
Vladimir Sementsov-Ogievskiyaaaa20b2020-09-24 21:54:11 +0300241 s->poll_state.in_progress = false;
242
243 aio_wait_kick();
244}}
245
Emanuele Giuseppe Esposito76a2f552022-11-28 09:23:33 -0500246{creation_function(func)}"""
Vladimir Sementsov-Ogievskiyaaaa20b2020-09-24 21:54:11 +0300247
248
Kevin Wolfd6ee2e32023-01-26 18:24:20 +0100249def gen_no_co_wrapper(func: FuncDecl) -> str:
250 assert '_co_' in func.name
251 assert func.wrapper_type == 'no_co'
252
253 name = func.target_name
254 struct_name = func.struct_name
255
Kevin Wolfde903292023-09-11 11:46:05 +0200256 graph_lock=''
257 graph_unlock=''
Kevin Wolfe84c07b2023-09-29 16:51:37 +0200258 if func.graph_rdlock:
259 graph_lock=' bdrv_graph_rdlock_main_loop();'
260 graph_unlock=' bdrv_graph_rdunlock_main_loop();'
261 elif func.graph_wrlock:
Stefan Hajnoczi6bc30f12023-12-05 13:20:02 -0500262 graph_lock=' bdrv_graph_wrlock();'
263 graph_unlock=' bdrv_graph_wrunlock();'
Kevin Wolfde903292023-09-11 11:46:05 +0200264
Kevin Wolfd6ee2e32023-01-26 18:24:20 +0100265 return f"""\
266/*
267 * Wrappers for {name}
268 */
269
270typedef struct {struct_name} {{
271 Coroutine *co;
272 {func.return_field}
273{ func.gen_block(' {decl};') }
274}} {struct_name};
275
276static void {name}_bh(void *opaque)
277{{
278 {struct_name} *s = opaque;
279
Kevin Wolfde903292023-09-11 11:46:05 +0200280{graph_lock}
Kevin Wolfd6ee2e32023-01-26 18:24:20 +0100281 {func.get_result}{name}({ func.gen_list('s->{name}') });
Kevin Wolfde903292023-09-11 11:46:05 +0200282{graph_unlock}
Kevin Wolfd6ee2e32023-01-26 18:24:20 +0100283
284 aio_co_wake(s->co);
285}}
286
287{func.return_type} coroutine_fn {func.name}({ func.gen_list('{decl}') })
288{{
289 {struct_name} s = {{
290 .co = qemu_coroutine_self(),
291{ func.gen_block(' .{name} = {name},') }
292 }};
293 assert(qemu_in_coroutine());
294
295 aio_bh_schedule_oneshot(qemu_get_aio_context(), {name}_bh, &s);
296 qemu_coroutine_yield();
297
298 {func.ret}
299}}"""
300
301
Vladimir Sementsov-Ogievskiyaaaa20b2020-09-24 21:54:11 +0300302def gen_wrappers(input_code: str) -> str:
303 res = ''
304 for func in func_decl_iter(input_code):
305 res += '\n\n\n'
Kevin Wolfd6ee2e32023-01-26 18:24:20 +0100306 if func.wrapper_type == 'co':
307 res += gen_co_wrapper(func)
308 else:
309 res += gen_no_co_wrapper(func)
Vladimir Sementsov-Ogievskiyaaaa20b2020-09-24 21:54:11 +0300310
311 return res
312
313
314if __name__ == '__main__':
315 if len(sys.argv) < 3:
316 exit(f'Usage: {sys.argv[0]} OUT_FILE.c IN_FILE.[ch]...')
317
318 with open(sys.argv[1], 'w', encoding='utf-8') as f_out:
319 f_out.write(gen_header())
320 for fname in sys.argv[2:]:
321 with open(fname, encoding='utf-8') as f_in:
322 f_out.write(gen_wrappers(f_in.read()))
323 f_out.write('\n')