remove socket_scm_helper
cover remove socket_scm_helper
GitLab: https://gitlab.com/jsnow/qemu/-/commits/python-socket-scm-helper
CI: https://gitlab.com/jsnow/qemu/-/pipelines/338595177
19 insertions(+)
208 deletions(-)
Seems good to me ...?
--js
John Snow (2):
python/qmp: add send_fd_scm directly to QEMUMonitorProtocol python, iotests: remove socket_scm_helper
tests/qemu-iotests/socket_scm_helper.c | 136 ------------------------- python/qemu/machine/machine.py | 47 ++------- python/qemu/machine/qtest.py | 2 - python/qemu/qmp/__init__.py | 21 ++-- tests/Makefile.include | 1 - tests/meson.build | 4 - tests/qemu-iotests/iotests.py | 3 - tests/qemu-iotests/meson.build | 5 - tests/qemu-iotests/testenv.py | 8 +- 9 files changed, 19 insertions(+), 208 deletions(-) delete mode 100644 tests/qemu-iotests/socket_scm_helper.c delete mode 100644 tests/qemu-iotests/meson.build
Signature · 1 line
2.31.1
PATCH 1/2 python/qmp: add send_fd_scm directly to QEMUMonitorProtocol
It turns out you can do this directly from Python ... and because of this, you don't need to worry about setting the fds, or spawning another process.
Doing this is helpful because it allows QEMUMonitorProtocol to keep its file descriptor and socket object as private implementation details, which allows me to construct a different implementation -- a Synchronous wrapper around my Async QMP library.
--- python/qemu/machine/machine.py | 44 +++++++--------------------------- python/qemu/qmp/__init__.py | 21 +++++++--------- 2 files changed, 18 insertions(+), 47 deletions(-)
python/qemu/machine/machine.py +9 -35
@@ -205,48 +205,22 @@ def add_fd(self, fd: int, fdset: int, def send_fd_scm(self, fd: Optional[int] = None, file_path: Optional[str] = None) -> int: """ - Send an fd or file_path to socket_scm_helper. + Send an fd or file_path to the remote via SCM_RIGHTS. - Exactly one of fd and file_path must be given. - If it is file_path, the helper will open that file and pass its own fd. + Exactly one of fd and file_path must be given. If it is + file_path, the file will be opened read-only and the new file + descriptor will be sent to the remote. """ - # In iotest.py, the qmp should always use unix socket. - assert self._qmp.is_scm_available() - if self._socket_scm_helper is None: - raise QEMUMachineError("No path to socket_scm_helper set") - if not os.path.exists(self._socket_scm_helper): - raise QEMUMachineError("%s does not exist" % - self._socket_scm_helper) - - # This did not exist before 3.4, but since then it is - # mandatory for our purpose - if hasattr(os, 'set_inheritable'): - os.set_inheritable(self._qmp.get_sock_fd(), True) - if fd is not None: - os.set_inheritable(fd, True) - - fd_param = ["%s" % self._socket_scm_helper, - "%d" % self._qmp.get_sock_fd()] - if file_path is not None: assert fd is None - fd_param.append(file_path) + with open(file_path, "rb") as passfile: + fd = passfile.fileno() + self._qmp.send_fd_scm(fd) else: assert fd is not None - fd_param.append(str(fd)) + self._qmp.send_fd_scm(fd) - proc = subprocess.run( - fd_param, - stdin=subprocess.DEVNULL, - stdout=subprocess.PIPE, - stderr=subprocess.STDOUT, - check=False, - close_fds=False, - ) - if proc.stdout: - LOG.debug(proc.stdout) - - return proc.returncode + return 0 @staticmethod def _remove_if_exists(path: str) -> None:
python/qemu/qmp/__init__.py +9 -12
@@ -21,6 +21,7 @@ import json import logging import socket +import struct from types import TracebackType from typing import ( Any,
@@ -406,18 +407,14 @@ def settimeout(self, timeout: Optional[float]) -> None: raise ValueError(msg) self.__sock.settimeout(timeout) - def get_sock_fd(self) -> int: + def send_fd_scm(self, fd: int) -> None: """ - Get the socket file descriptor. - - @return The file descriptor number. - """ - return self.__sock.fileno() - - def is_scm_available(self) -> bool: + Send a file descriptor to the remote via SCM_RIGHTS. """ - Check if the socket allows for SCM_RIGHTS. + if self.__sock.family != socket.AF_UNIX: + raise RuntimeError("Can't use SCM_RIGHTS on non-AF_UNIX socket.") - @return True if SCM_RIGHTS is available, otherwise False. - """ - return self.__sock.family == socket.AF_UNIX + self.__sock.sendmsg( + [b' '], + [(socket.SOL_SOCKET, socket.SCM_RIGHTS, struct.pack('@i', fd))] + )
Signature · 1 line
2.31.1
PATCH 2/2 python, iotests: remove socket_scm_helper
In reply to John SnowIt's not used anymore, now.
--- tests/qemu-iotests/socket_scm_helper.c | 136 ------------------------- python/qemu/machine/machine.py | 3 - python/qemu/machine/qtest.py | 2 - tests/Makefile.include | 1 - tests/meson.build | 4 - tests/qemu-iotests/iotests.py | 3 - tests/qemu-iotests/meson.build | 5 - tests/qemu-iotests/testenv.py | 8 +- 8 files changed, 1 insertion(+), 161 deletions(-) delete mode 100644 tests/qemu-iotests/socket_scm_helper.c delete mode 100644 tests/qemu-iotests/meson.build
tests/qemu-iotests/socket_scm_helper.c deleted +0 -136
@@ -1,136 +0,0 @@ -/* -* SCM_RIGHTS with unix socket help program for test -* -* Copyright IBM, Inc. 2013 -* -* Authors: -* Wenchao Xia <[email protected]> -* -* This work is licensed under the terms of the GNU LGPL, version 2 or later. -* See the COPYING.LIB file in the top-level directory. -*/ - -#include "qemu/osdep.h" -#include <sys/socket.h> -#include <sys/un.h> - -/* #define SOCKET_SCM_DEBUG */ - -/* -* @fd and @fd_to_send will not be checked for validation in this function, -* a blank will be sent as iov data to notify qemu. -*/ -static int send_fd (int fd,int fd_to_send) -{ -struct msghdr msg; -struct iovec iov[1 ]; -int ret; -char control[CMSG_SPACE (sizeof (int ))]; -struct cmsghdr *cmsg; - -memset (&msg,0 ,sizeof (msg)); -memset (control,0 ,sizeof (control)); - -/* Send a blank to notify qemu */ - iov[0 ].iov_base = (void *)" " ; - iov[0 ].iov_len =1 ; - - msg.msg_iov = iov; - msg.msg_iovlen =1 ; - - msg.msg_control = control; - msg.msg_controllen =sizeof (control); - - cmsg =CMSG_FIRSTHDR (&msg); - - cmsg->cmsg_len =CMSG_LEN (sizeof (int )); - cmsg->cmsg_level =SOL_SOCKET ; - cmsg->cmsg_type =SCM_RIGHTS ; -memcpy (CMSG_DATA (cmsg), &fd_to_send,sizeof (int )); - -do { - ret =sendmsg (fd, &msg,0 ); - }while (ret <0 && errno ==EINTR ); - -if (ret <0 ) { -fprintf (stderr,"Failed to send msg, reason: %s\n" ,strerror (errno)); - } - -return ret; -} - -/* Convert string to fd number. */ -static int get_fd_num (const char *fd_str,bool silent) -{ -int sock; -char *err; - - errno =0 ; - sock =strtol (fd_str, &err,10 ); -if (errno) { -if (!silent) { -fprintf (stderr,"Failed in strtol for socket fd, reason: %s\n" , -strerror (errno)); - } -return -1 ; - } -if (!*fd_str || *err || sock <0 ) { -if (!silent) { -fprintf (stderr,"bad numerical value for socket fd '%s'\n" , fd_str); - } -return -1 ; - } - -return sock; -} - -/* -* To make things simple, the caller needs to specify: -* 1. socket fd. -* 2. path of the file to be sent. -*/ -int main (int argc,char **argv,char **envp) -{ -int sock, fd, ret; - -#ifdef SOCKET_SCM_DEBUG -int i; -for (i =0 ; i < argc; i++) { -fprintf (stderr,"Parameter %d: %s\n" , i, argv[i]); - } -#endif - -if (argc !=3 ) { -fprintf (stderr, -"Usage: %s < socket-fd > < file-path >\n" , - argv[0 ]); -return EXIT_FAILURE ; - } - - - sock =get_fd_num (argv[1 ], false); -if (sock <0 ) { -return EXIT_FAILURE ; - } - - fd =get_fd_num (argv[2 ], true); -if (fd <0 ) { -/* Now only open a file in readonly mode for test purpose. If more -precise control is needed, use python script in file operation, which -is supposed to fork and exec this program. */ - fd =open (argv[2 ],O_RDONLY ); -if (fd <0 ) { -fprintf (stderr,"Failed to open file '%s'\n" , argv[2 ]); -return EXIT_FAILURE ; - } - } - - ret =send_fd (sock, fd); -if (ret <0 ) { -close (fd); -return EXIT_FAILURE ; - } - -close (fd); -return EXIT_SUCCESS ; -}
python/qemu/machine/machine.py +0 -3
@@ -93,7 +93,6 @@ def __init__(self, name: Optional[str] = None, base_temp_dir: str = "/var/tmp", monitor_address: Optional[SocketAddrT] = None, - socket_scm_helper: Optional[str] = None, sock_dir: Optional[str] = None, drain_console: bool = False, console_log: Optional[str] = None,
@@ -107,7 +106,6 @@ def __init__(self, @param name: prefix for socket and log file names (default: qemu-PID) @param base_temp_dir: default location where temp files are created @param monitor_address: address for QMP monitor - @param socket_scm_helper: helper program, required for send_fd_scm() @param sock_dir: where to create socket (defaults to base_temp_dir) @param drain_console: (optional) True to drain console socket to buffer @param console_log: (optional) path to console log file
@@ -126,7 +124,6 @@ def __init__(self, self._base_temp_dir = base_temp_dir self._sock_dir = sock_dir or self._base_temp_dir self._log_dir = log_dir - self._socket_scm_helper = socket_scm_helper if monitor_address is not None: self._monitor_address = monitor_address
python/qemu/machine/qtest.py +0 -2
@@ -114,7 +114,6 @@ def __init__(self, args: Sequence[str] = (), name: Optional[str] = None, base_temp_dir: str = "/var/tmp", - socket_scm_helper: Optional[str] = None, sock_dir: Optional[str] = None): # pylint: disable=too-many-arguments
@@ -123,7 +122,6 @@ def __init__(self, if sock_dir is None: sock_dir = base_temp_dir super().__init__(binary, args, name=name, base_temp_dir=base_temp_dir, - socket_scm_helper=socket_scm_helper, sock_dir=sock_dir) self._qtest: Optional[QEMUQtestProtocol] = None self._qtest_path = os.path.join(sock_dir, name + "-qtest.sock")
tests/Makefile.include +0 -1
@@ -139,7 +139,6 @@ check-acceptance: check-venv $(TESTS_RESULTS_DIR) get-vm-images check: ifeq ($(CONFIG_TOOLS)$(CONFIG_POSIX),yy) -QEMU_IOTESTS_HELPERS-$(CONFIG_LINUX) = tests/qemu-iotests/socket_scm_helper$(EXESUF) check: check-block export PYTHON check-block: $(SRC_PATH)/tests/check-block.sh qemu-img$(EXESUF) \
tests/meson.build +0 -4
@@ -67,10 +67,6 @@ if have_tools and 'CONFIG_VHOST_USER' in config_host and 'CONFIG_LINUX' in confi dependencies: [qemuutil, vhost_user]) endif -if have_system and 'CONFIG_POSIX' in config_host - subdir('qemu-iotests') -endif - test('decodetree', sh, args: [ files('decode/check.sh'), config_host['PYTHON'], files('../scripts/decodetree.py') ], workdir: meson.current_source_dir() / 'decode',
tests/qemu-iotests/iotests.py +0 -3
@@ -91,8 +91,6 @@ sys.stderr.write('Please run this test via the "check" script\n') sys.exit(os.EX_USAGE) -socket_scm_helper = os.environ.get('SOCKET_SCM_HELPER', 'socket_scm_helper') - luks_default_secret_object = 'secret,id=keysec0,data=' + \ os.environ.get('IMGKEYSECRET', '') luks_default_key_secret_opt = 'key-secret=keysec0'
@@ -572,7 +570,6 @@ def __init__(self, path_suffix=''): name = "qemu%s-%d" % (path_suffix, os.getpid()) super().__init__(qemu_prog, qemu_opts, name=name, base_temp_dir=test_dir, - socket_scm_helper=socket_scm_helper, sock_dir=sock_dir) self._num_drives = 0
tests/qemu-iotests/meson.build deleted +0 -5
@@ -1,5 +0,0 @@ -if 'CONFIG_LINUX' in config_host - socket_scm_helper = executable('socket_scm_helper', 'socket_scm_helper.c') -else - socket_scm_helper = [] -endif
tests/qemu-iotests/testenv.py +1 -7
@@ -67,7 +67,7 @@ class TestEnv(ContextManager['TestEnv']): env_variables = ['PYTHONPATH', 'TEST_DIR', 'SOCK_DIR', 'SAMPLE_IMG_DIR', 'OUTPUT_DIR', 'PYTHON', 'QEMU_PROG', 'QEMU_IMG_PROG', 'QEMU_IO_PROG', 'QEMU_NBD_PROG', 'QSD_PROG', - 'SOCKET_SCM_HELPER', 'QEMU_OPTIONS', 'QEMU_IMG_OPTIONS', + 'QEMU_OPTIONS', 'QEMU_IMG_OPTIONS', 'QEMU_IO_OPTIONS', 'QEMU_IO_OPTIONS_NO_FMT', 'QEMU_NBD_OPTIONS', 'IMGOPTS', 'IMGFMT', 'IMGPROTO', 'AIOMODE', 'CACHEMODE', 'VALGRIND_QEMU',
@@ -135,7 +135,6 @@ def init_binaries(self) -> None: """Init binary path variables: PYTHON (for bash tests) QEMU_PROG, QEMU_IMG_PROG, QEMU_IO_PROG, QEMU_NBD_PROG, QSD_PROG - SOCKET_SCM_HELPER """ self.python = sys.executable
@@ -169,10 +168,6 @@ def root(*names: str) -> str: if not isxfile(b): sys.exit('Not executable: ' + b) - helper_path = os.path.join(self.build_iotests, 'socket_scm_helper') - if isxfile(helper_path): - self.socket_scm_helper = helper_path # SOCKET_SCM_HELPER - def __init__(self, imgfmt: str, imgproto: str, aiomode: str, cachemode: Optional[str] = None, imgopts: Optional[str] = None,
@@ -284,7 +279,6 @@ def print_env(self) -> None: PLATFORM -- {platform} TEST_DIR -- {TEST_DIR} SOCK_DIR -- {SOCK_DIR} -SOCKET_SCM_HELPER -- {SOCKET_SCM_HELPER} """ args = collections.defaultdict(str, self.get_env())
Signature · 1 line
2.31.1