qemu/include/sysemu/accel-blocker.h
Emanuele Giuseppe Esposito bd688fc931 accel: introduce accelerator blocker API
This API allows the accelerators to prevent vcpus from issuing
new ioctls while execting a critical section marked with the
accel_ioctl_inhibit_begin/end functions.

Note that all functions submitting ioctls must mark where the
ioctl is being called with accel_{cpu_}ioctl_begin/end().

This API requires the caller to always hold the BQL.
API documentation is in sysemu/accel-blocker.h

Internally, it uses a QemuLockCnt together with a per-CPU QemuLockCnt
(to minimize cache line bouncing) to keep avoid that new ioctls
run when the critical section starts, and a QemuEvent to wait
that all running ioctls finish.

Signed-off-by: Emanuele Giuseppe Esposito <eesposit@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Message-Id: <20221111154758.1372674-2-eesposit@redhat.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2023-01-11 09:59:39 +01:00

57 lines
1.7 KiB
C

/*
* Accelerator blocking API, to prevent new ioctls from starting and wait the
* running ones finish.
* This mechanism differs from pause/resume_all_vcpus() in that it does not
* release the BQL.
*
* Copyright (c) 2022 Red Hat Inc.
*
* Author: Emanuele Giuseppe Esposito <eesposit@redhat.com>
*
* This work is licensed under the terms of the GNU GPL, version 2 or later.
* See the COPYING file in the top-level directory.
*/
#ifndef ACCEL_BLOCKER_H
#define ACCEL_BLOCKER_H
#include "qemu/osdep.h"
#include "sysemu/cpus.h"
extern void accel_blocker_init(void);
/*
* accel_{cpu_}ioctl_begin/end:
* Mark when ioctl is about to run or just finished.
*
* accel_{cpu_}ioctl_begin will block after accel_ioctl_inhibit_begin() is
* called, preventing new ioctls to run. They will continue only after
* accel_ioctl_inibith_end().
*/
extern void accel_ioctl_begin(void);
extern void accel_ioctl_end(void);
extern void accel_cpu_ioctl_begin(CPUState *cpu);
extern void accel_cpu_ioctl_end(CPUState *cpu);
/*
* accel_ioctl_inhibit_begin: start critical section
*
* This function makes sure that:
* 1) incoming accel_{cpu_}ioctl_begin() calls block
* 2) wait that all ioctls that were already running reach
* accel_{cpu_}ioctl_end(), kicking vcpus if necessary.
*
* This allows the caller to access shared data or perform operations without
* worrying of concurrent vcpus accesses.
*/
extern void accel_ioctl_inhibit_begin(void);
/*
* accel_ioctl_inhibit_end: end critical section started by
* accel_ioctl_inhibit_begin()
*
* This function allows blocked accel_{cpu_}ioctl_begin() to continue.
*/
extern void accel_ioctl_inhibit_end(void);
#endif /* ACCEL_BLOCKER_H */