xref: /openbmc/qemu/include/io/channel-util.h (revision 06e0f098d612df79597de58121dadf6f5f375d04)
1 c767ae62SDaniel P. Berrange /*
2 c767ae62SDaniel P. Berrange  * QEMU I/O channels utility APIs
3 c767ae62SDaniel P. Berrange  *
4 c767ae62SDaniel P. Berrange  * Copyright (c) 2016 Red Hat, Inc.
5 c767ae62SDaniel P. Berrange  *
6 c767ae62SDaniel P. Berrange  * This library is free software; you can redistribute it and/or
7 c767ae62SDaniel P. Berrange  * modify it under the terms of the GNU Lesser General Public
8 c767ae62SDaniel P. Berrange  * License as published by the Free Software Foundation; either
9 c8198bd5SChetan Pant  * version 2.1 of the License, or (at your option) any later version.
10 c767ae62SDaniel P. Berrange  *
11 c767ae62SDaniel P. Berrange  * This library is distributed in the hope that it will be useful,
12 c767ae62SDaniel P. Berrange  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 c767ae62SDaniel P. Berrange  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 c767ae62SDaniel P. Berrange  * Lesser General Public License for more details.
15 c767ae62SDaniel P. Berrange  *
16 c767ae62SDaniel P. Berrange  * You should have received a copy of the GNU Lesser General Public
17 c767ae62SDaniel P. Berrange  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 c767ae62SDaniel P. Berrange  *
19 c767ae62SDaniel P. Berrange  */
20 c767ae62SDaniel P. Berrange 
21 2a6a4076SMarkus Armbruster #ifndef QIO_CHANNEL_UTIL_H
22 2a6a4076SMarkus Armbruster #define QIO_CHANNEL_UTIL_H
23 c767ae62SDaniel P. Berrange 
24 c767ae62SDaniel P. Berrange #include "io/channel.h"
25 c767ae62SDaniel P. Berrange 
26 c767ae62SDaniel P. Berrange /*
27 c767ae62SDaniel P. Berrange  * This module provides helper functions that are useful when dealing
28 c767ae62SDaniel P. Berrange  * with QIOChannel objects
29 c767ae62SDaniel P. Berrange  */
30 c767ae62SDaniel P. Berrange 
31 c767ae62SDaniel P. Berrange 
32 c767ae62SDaniel P. Berrange /**
33 c767ae62SDaniel P. Berrange  * qio_channel_new_fd:
34 c767ae62SDaniel P. Berrange  * @fd: the file descriptor
35 c767ae62SDaniel P. Berrange  * @errp: pointer to a NULL-initialized error object
36 c767ae62SDaniel P. Berrange  *
37 c767ae62SDaniel P. Berrange  * Create a channel for performing I/O on the file
38 c767ae62SDaniel P. Berrange  * descriptor @fd. The particular subclass of QIOChannel
39 c767ae62SDaniel P. Berrange  * that is returned will depend on what underlying object
40 c767ae62SDaniel P. Berrange  * the file descriptor is associated with. It may be either
41 c767ae62SDaniel P. Berrange  * a QIOChannelSocket or a QIOChannelFile instance. Upon
42 c767ae62SDaniel P. Berrange  * success, the returned QIOChannel instance will own
43 c767ae62SDaniel P. Berrange  * the @fd file descriptor, and take responsibility for
44 c767ae62SDaniel P. Berrange  * closing it when no longer required. On failure, the
45 c767ae62SDaniel P. Berrange  * caller is responsible for closing @fd.
46 c767ae62SDaniel P. Berrange  *
47 c767ae62SDaniel P. Berrange  * Returns: the channel object, or NULL on error
48 c767ae62SDaniel P. Berrange  */
49 c767ae62SDaniel P. Berrange QIOChannel *qio_channel_new_fd(int fd,
50 c767ae62SDaniel P. Berrange                                Error **errp);
51 c767ae62SDaniel P. Berrange 
52 *06e0f098SStefan Hajnoczi /**
53 *06e0f098SStefan Hajnoczi  * qio_channel_util_set_aio_fd_handler:
54 *06e0f098SStefan Hajnoczi  * @read_fd: the file descriptor for the read handler
55 *06e0f098SStefan Hajnoczi  * @read_ctx: the AioContext for the read handler
56 *06e0f098SStefan Hajnoczi  * @io_read: the read handler
57 *06e0f098SStefan Hajnoczi  * @write_fd: the file descriptor for the write handler
58 *06e0f098SStefan Hajnoczi  * @write_ctx: the AioContext for the write handler
59 *06e0f098SStefan Hajnoczi  * @io_write: the write handler
60 *06e0f098SStefan Hajnoczi  * @opaque: the opaque argument to the read and write handler
61 *06e0f098SStefan Hajnoczi  *
62 *06e0f098SStefan Hajnoczi  * Set the read and write handlers when @read_ctx and @write_ctx are non-NULL,
63 *06e0f098SStefan Hajnoczi  * respectively. To leave a handler in its current state, pass a NULL
64 *06e0f098SStefan Hajnoczi  * AioContext. To clear a handler, pass a non-NULL AioContext and a NULL
65 *06e0f098SStefan Hajnoczi  * handler.
66 *06e0f098SStefan Hajnoczi  */
67 *06e0f098SStefan Hajnoczi void qio_channel_util_set_aio_fd_handler(int read_fd,
68 *06e0f098SStefan Hajnoczi                                          AioContext *read_ctx,
69 *06e0f098SStefan Hajnoczi                                          IOHandler *io_read,
70 *06e0f098SStefan Hajnoczi                                          int write_fd,
71 *06e0f098SStefan Hajnoczi                                          AioContext *write_ctx,
72 *06e0f098SStefan Hajnoczi                                          IOHandler *io_write,
73 *06e0f098SStefan Hajnoczi                                          void *opaque);
74 *06e0f098SStefan Hajnoczi 
75 2a6a4076SMarkus Armbruster #endif /* QIO_CHANNEL_UTIL_H */
76