io_uring_prep_tee(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | NOTES | SEE ALSO | COLOPHON

io_uring_prep_tee(3)         liburing Manual         io_uring_prep_tee(3)

NAME         top

       io_uring_prep_tee - prepare a tee request

SYNOPSIS         top

       #include <fcntl.h>
       #include <liburing.h>

       void io_uring_prep_tee(struct io_uring_sqe *sqe,
                              int fd_in,
                              int fd_out,
                              unsigned int nbytes,
                              unsigned int splice_flags);

DESCRIPTION         top

       The io_uring_prep_tee(3) function prepares a tee request. The
       submission queue entry sqe is setup to use as input the file
       descriptor fd_in and as output the file descriptor fd_out
       duplicating up to nbytes bytes worth of data.  splice_flags are
       modifier flags for the operation. See tee(2) for the generic
       splice flags.

       If fd_out is a direct descriptor, IOSQE_FIXED_FILE can be set in
       the SQE to indicate that. For the input file, the io_uring
       specific SPLICE_F_FD_IN_FIXED can be set and fd_in given as a
       registered file descriptor offset.

       This function prepares an async tee(2) request. See that man page
       for details.

RETURN VALUE         top

       None

ERRORS         top

       The CQE res field will contain the result of the operation. See
       the related man page for details on possible values. Note that
       where synchronous system calls will return -1 on failure and set
       errno to the actual error value, io_uring never uses errno.
       Instead it returns the negated errno directly in the CQE res
       field.

NOTES         top

       Despite accepting an unsigned number of bytes, this function can
       transfer at most INT_MAX bytes per call (the maximum for the
       underlying syscall interface).  In practice, limits as low as
       65536 have been observed (just like with tee(2) itself).

SEE ALSO         top

       io_uring_get_sqe(3), io_uring_submit(3), io_uring_register(2),
       splice(2), tee(2)

COLOPHON         top

       This page is part of the liburing (A library for io_uring)
       project.  Information about the project can be found at 
       ⟨https://github.com/axboe/liburing⟩.  If you have a bug report for
       this manual page, send it to io-uring@vger.kernel.org.  This page
       was obtained from the project's upstream Git repository
       ⟨https://github.com/axboe/liburing⟩ on 2026-05-24.  (At that time,
       the date of the most recent commit that was found in the
       repository was 2026-05-18.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there is
       a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

liburing-2.2                  March 13, 2022         io_uring_prep_tee(3)

Pages that refer to this page: io_uring_prep_tee(3)