From fe81e932ec0d25157abbe5e7ebcb50493e61a4d6 Mon Sep 17 00:00:00 2001 From: "Daniel P. Berrange" Date: Wed, 3 Feb 2016 13:47:36 +0000 Subject: io: improve docs for QIOChannelSocket async functions In the docs for qio_channel_socket_connect_async, qio_channel_socket_listen_async and qio_channel_socket_dgram_async, mention that the SocketAddress parameters are copied, so can be freed immediately. Reviewed-by: "Dr. David Alan Gilbert" Signed-off-by: Daniel P. Berrange --- include/io/channel-socket.h | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/include/io/channel-socket.h b/include/io/channel-socket.h index 810537ef6f..70d06b40d9 100644 --- a/include/io/channel-socket.h +++ b/include/io/channel-socket.h @@ -105,7 +105,9 @@ int qio_channel_socket_connect_sync(QIOChannelSocket *ioc, * Attempt to connect to the address @addr. This method * will run in the background so the caller will regain * execution control immediately. The function @callback - * will be invoked on completion or failure. + * will be invoked on completion or failure. The @addr + * parameter will be copied, so may be freed as soon + * as this function returns without waiting for completion. */ void qio_channel_socket_connect_async(QIOChannelSocket *ioc, SocketAddress *addr, @@ -140,7 +142,9 @@ int qio_channel_socket_listen_sync(QIOChannelSocket *ioc, * Attempt to listen to the address @addr. This method * will run in the background so the caller will regain * execution control immediately. The function @callback - * will be invoked on completion or failure. + * will be invoked on completion or failure. The @addr + * parameter will be copied, so may be freed as soon + * as this function returns without waiting for completion. */ void qio_channel_socket_listen_async(QIOChannelSocket *ioc, SocketAddress *addr, @@ -181,6 +185,9 @@ int qio_channel_socket_dgram_sync(QIOChannelSocket *ioc, * This method will run in the background so the caller * will regain execution control immediately. The function * @callback will be invoked on completion or failure. + * The @localAddr and @remoteAddr parameters will be copied, + * so may be freed as soon as this function returns without + * waiting for completion. */ void qio_channel_socket_dgram_async(QIOChannelSocket *ioc, SocketAddress *localAddr, -- cgit v1.2.3 From c767ae62b9efb2c9b2a757984ff1b14f89b49249 Mon Sep 17 00:00:00 2001 From: "Daniel P. Berrange" Date: Wed, 3 Feb 2016 14:00:28 +0000 Subject: io: introduce helper for creating channels from file descriptors Depending on what object a file descriptor refers to a different type of IO channel will be needed - either a QIOChannelFile or a QIOChannelSocket. Introduce a qio_channel_new_fd() method which will return the appropriate channel implementation. Reviewed-by: Eric Blake Signed-off-by: Daniel P. Berrange --- include/io/channel-util.h | 52 ++++++++++++++++++++++++++++++++++++++++++ io/Makefile.objs | 1 + io/channel-util.c | 50 ++++++++++++++++++++++++++++++++++++++++ tests/test-io-channel-file.c | 22 ++++++++++++++++++ tests/test-io-channel-socket.c | 21 +++++++++++++++++ 5 files changed, 146 insertions(+) create mode 100644 include/io/channel-util.h create mode 100644 io/channel-util.c diff --git a/include/io/channel-util.h b/include/io/channel-util.h new file mode 100644 index 0000000000..c93af82884 --- /dev/null +++ b/include/io/channel-util.h @@ -0,0 +1,52 @@ +/* + * QEMU I/O channels utility APIs + * + * Copyright (c) 2016 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, see . + * + */ + +#ifndef QIO_CHANNEL_UTIL_H__ +#define QIO_CHANNEL_UTIL_H__ + +#include "io/channel.h" + +/* + * This module provides helper functions that are useful when dealing + * with QIOChannel objects + */ + + +/** + * qio_channel_new_fd: + * @fd: the file descriptor + * @errp: pointer to a NULL-initialized error object + * + * Create a channel for performing I/O on the file + * descriptor @fd. The particular subclass of QIOChannel + * that is returned will depend on what underlying object + * the file descriptor is associated with. It may be either + * a QIOChannelSocket or a QIOChannelFile instance. Upon + * success, the returned QIOChannel instance will own + * the @fd file descriptor, and take responsibility for + * closing it when no longer required. On failure, the + * caller is responsible for closing @fd. + * + * Returns: the channel object, or NULL on error + */ +QIOChannel *qio_channel_new_fd(int fd, + Error **errp); + +#endif /* QIO_CHANNEL_UTIL_H__ */ diff --git a/io/Makefile.objs b/io/Makefile.objs index 0e3de31a5a..9d8337d89a 100644 --- a/io/Makefile.objs +++ b/io/Makefile.objs @@ -6,4 +6,5 @@ io-obj-y += channel-socket.o io-obj-y += channel-tls.o io-obj-y += channel-watch.o io-obj-y += channel-websock.o +io-obj-y += channel-util.o io-obj-y += task.o diff --git a/io/channel-util.c b/io/channel-util.c new file mode 100644 index 0000000000..f96907cb5c --- /dev/null +++ b/io/channel-util.c @@ -0,0 +1,50 @@ +/* + * QEMU I/O channels utility APIs + * + * Copyright (c) 2016 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, see . + * + */ + +#include "io/channel-util.h" +#include "io/channel-file.h" +#include "io/channel-socket.h" + + +static bool fd_is_socket(int fd) +{ + int optval; + socklen_t optlen; + optlen = sizeof(optval); + return qemu_getsockopt(fd, + SOL_SOCKET, + SO_TYPE, + (char *)&optval, + &optlen) == 0; +} + + +QIOChannel *qio_channel_new_fd(int fd, + Error **errp) +{ + QIOChannel *ioc; + + if (fd_is_socket(fd)) { + ioc = QIO_CHANNEL(qio_channel_socket_new_fd(fd, errp)); + } else { + ioc = QIO_CHANNEL(qio_channel_file_new_fd(fd)); + } + return ioc; +} diff --git a/tests/test-io-channel-file.c b/tests/test-io-channel-file.c index f276a32de0..45e699044c 100644 --- a/tests/test-io-channel-file.c +++ b/tests/test-io-channel-file.c @@ -19,6 +19,7 @@ */ #include "io/channel-file.h" +#include "io/channel-util.h" #include "io-channel-helpers.h" @@ -49,6 +50,26 @@ static void test_io_channel_file(void) } +static void test_io_channel_fd(void) +{ + QIOChannel *ioc; + int fd = -1; + +#define TEST_FILE "tests/test-io-channel-file.txt" + fd = open(TEST_FILE, O_CREAT | O_TRUNC | O_WRONLY, 0600); + g_assert_cmpint(fd, >, -1); + + ioc = qio_channel_new_fd(fd, &error_abort); + + g_assert_cmpstr(object_get_typename(OBJECT(ioc)), + ==, + TYPE_QIO_CHANNEL_FILE); + + unlink(TEST_FILE); + object_unref(OBJECT(ioc)); +} + + #ifndef _WIN32 static void test_io_channel_pipe(bool async) { @@ -92,6 +113,7 @@ int main(int argc, char **argv) g_test_init(&argc, &argv, NULL); g_test_add_func("/io/channel/file", test_io_channel_file); + g_test_add_func("/io/channel/file/fd", test_io_channel_fd); #ifndef _WIN32 g_test_add_func("/io/channel/pipe/sync", test_io_channel_pipe_sync); g_test_add_func("/io/channel/pipe/async", test_io_channel_pipe_async); diff --git a/tests/test-io-channel-socket.c b/tests/test-io-channel-socket.c index 1a36a3c696..e28e40fd94 100644 --- a/tests/test-io-channel-socket.c +++ b/tests/test-io-channel-socket.c @@ -19,6 +19,7 @@ */ #include "io/channel-socket.h" +#include "io/channel-util.h" #include "io-channel-helpers.h" #ifdef HAVE_IFADDRS_H #include @@ -473,6 +474,24 @@ static void test_io_channel_unix_fd_pass(void) #endif /* _WIN32 */ +static void test_io_channel_ipv4_fd(void) +{ + QIOChannel *ioc; + int fd = -1; + + fd = socket(AF_INET, SOCK_STREAM, 0); + g_assert_cmpint(fd, >, -1); + + ioc = qio_channel_new_fd(fd, &error_abort); + + g_assert_cmpstr(object_get_typename(OBJECT(ioc)), + ==, + TYPE_QIO_CHANNEL_SOCKET); + + object_unref(OBJECT(ioc)); +} + + int main(int argc, char **argv) { bool has_ipv4, has_ipv6; @@ -495,6 +514,8 @@ int main(int argc, char **argv) test_io_channel_ipv4_sync); g_test_add_func("/io/channel/socket/ipv4-async", test_io_channel_ipv4_async); + g_test_add_func("/io/channel/socket/ipv4-fd", + test_io_channel_ipv4_fd); } if (has_ipv6) { g_test_add_func("/io/channel/socket/ipv6-sync", -- cgit v1.2.3 From e8f117f3b3eb41a766d38e0b765f89ec79c6a9ff Mon Sep 17 00:00:00 2001 From: "Daniel P. Berrange" Date: Fri, 12 Feb 2016 16:45:31 +0000 Subject: io: convert QIOChannelBuffer to use uint8_t instead of char The QIOChannelBuffer struct uses a 'char *' for its data buffer. It will give simpler type compatibility with the migration APIs if it uses 'uint8_t *' instead, avoiding several casts. Signed-off-by: Daniel P. Berrange --- include/io/channel-buffer.h | 2 +- io/channel-buffer.c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/include/io/channel-buffer.h b/include/io/channel-buffer.h index 91a52b3373..65c498b2c2 100644 --- a/include/io/channel-buffer.h +++ b/include/io/channel-buffer.h @@ -42,7 +42,7 @@ struct QIOChannelBuffer { size_t capacity; /* Total allocated memory */ size_t usage; /* Current size of data */ size_t offset; /* Offset for future I/O ops */ - char *data; + uint8_t *data; }; diff --git a/io/channel-buffer.c b/io/channel-buffer.c index 0f7c5671fe..3e5117bf28 100644 --- a/io/channel-buffer.c +++ b/io/channel-buffer.c @@ -32,7 +32,7 @@ qio_channel_buffer_new(size_t capacity) ioc = QIO_CHANNEL_BUFFER(object_new(TYPE_QIO_CHANNEL_BUFFER)); if (capacity) { - ioc->data = g_new0(char, capacity); + ioc->data = g_new0(uint8_t, capacity); ioc->capacity = capacity; } -- cgit v1.2.3