From patchwork Wed Feb 3 14:55:27 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= X-Patchwork-Id: 8203891 Return-Path: X-Original-To: patchwork-qemu-devel@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork2.web.kernel.org (Postfix) with ESMTP id 28BE3BEEE5 for ; Wed, 3 Feb 2016 14:55:56 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 2121320212 for ; Wed, 3 Feb 2016 14:55:55 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 7C0AC201F5 for ; Wed, 3 Feb 2016 14:55:53 +0000 (UTC) Received: from localhost ([::1]:35454 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aQyqW-0004cY-Ty for patchwork-qemu-devel@patchwork.kernel.org; Wed, 03 Feb 2016 09:55:52 -0500 Received: from eggs.gnu.org ([2001:4830:134:3::10]:45414) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aQyqK-0004aq-4L for qemu-devel@nongnu.org; Wed, 03 Feb 2016 09:55:42 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1aQyqF-00054a-DX for qemu-devel@nongnu.org; Wed, 03 Feb 2016 09:55:39 -0500 Received: from mx1.redhat.com ([209.132.183.28]:56818) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aQyqF-00054H-0u for qemu-devel@nongnu.org; Wed, 03 Feb 2016 09:55:35 -0500 Received: from int-mx14.intmail.prod.int.phx2.redhat.com (int-mx14.intmail.prod.int.phx2.redhat.com [10.5.11.27]) by mx1.redhat.com (Postfix) with ESMTPS id 7704A3C88DF for ; Wed, 3 Feb 2016 14:55:34 +0000 (UTC) Received: from t530wlan.home.berrange.com.com (vpn1-5-58.ams2.redhat.com [10.36.5.58]) by int-mx14.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id u13EtWXI020051; Wed, 3 Feb 2016 09:55:33 -0500 From: "Daniel P. Berrange" To: qemu-devel@nongnu.org Date: Wed, 3 Feb 2016 14:55:27 +0000 Message-Id: <1454511327-4812-1-git-send-email-berrange@redhat.com> X-Scanned-By: MIMEDefang 2.68 on 10.5.11.27 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 209.132.183.28 Cc: "Dr. David Alan Gilbert" Subject: [Qemu-devel] [PATCH] io: introduce helper for creating channels from file descriptors X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org X-Spam-Status: No, score=-6.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP 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. Signed-off-by: Daniel P. Berrange Reviewed-by: Eric Blake --- Suggested during review of migration TLS patch series https://lists.gnu.org/archive/html/qemu-devel/2016-02/msg00607.html and will be used by next posting of it. 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 0000000..6fb2baf --- /dev/null +++ b/include/io/channel-util.h @@ -0,0 +1,52 @@ +/* + * QEMU I/O channels utility APIs + * + * Copyright (c) 2015 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 0e3de31..9d8337d 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 0000000..0cbfef6 --- /dev/null +++ b/io/channel-util.c @@ -0,0 +1,50 @@ +/* + * QEMU I/O channels utility APIs + * + * Copyright (c) 2015 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 f276a32..45e6990 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 1a36a3c..e28e40f 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",