io\_uring\_prep\_send\_zc(3) liburing Manual io\_uring\_prep\_send\_zc(3)

# [NAME](#NAME)

io\_uring\_prep\_send\_zc - prepare a zerocopy send request

# [SYNOPSIS](#SYNOPSIS)

```
#include <liburing.h>
```

```
void io_uring_prep_send_zc(struct io_uring_sqe *sqe,
                           int sockfd,
                           const void *buf,
                           size_t len,
                           int flags,
                           unsigned zc_flags);
```

```
void io_uring_prep_send_zc_fixed(struct io_uring_sqe *sqe,
                                 int sockfd,
                                 const void *buf,
                                 size_t len,
                                 int flags,
                                 unsigned zc_flags);
                                 unsigned buf_index);
```

# [DESCRIPTION](#DESCRIPTION)

The [**io\_uring\_prep\_send\_zc**(3)](/man/os/liburing/io_uring_prep_send_zc.3) function prepares a zerocopy send request. The submission queue entry *sqe* is setup to use the file descriptor *sockfd* to start sending the data from *buf* of size *len* bytes with send modifier flags *flags* and zerocopy modifier flags *zc\_flags*.

The [**io\_uring\_prep\_send\_zc\_fixed**(3)](/man/os/liburing/io_uring_prep_send_zc_fixed.3) works just like [**io\_uring\_prep\_send\_zc**(3)](/man/os/liburing/io_uring_prep_send_zc.3) except it requires the use of buffers that have been registered with [**io\_uring\_register\_buffers**(3)](/man/os/liburing/io_uring_register_buffers.3). The *buf* and *len* arguments must fall within a region specified by *buf\_index* in the previously registered buffer. The buffer need not be aligned with the start of the registered buffer.

See [**io\_uring\_prep\_send**(3)](/man/os/liburing/io_uring_prep_send.3) for a description of flags that can be set in the SQE *ioprio* field. In addition to those, the zero-copy send also supports setting **IORING\_SEND\_ZC\_REPORT\_USAGE .** If set, the notification CQE *res* field will report the number of bytes that were copied rather than sent with zero copy. A value of **0** indicates success. If the value is **IORING\_NOTIF\_USAGE\_ZC\_COPIED ,** then data was copied.

As opposed to non-zerocopy send requests, a zerocopy send will usually generate two CQEs. The first CQE holds the result of the send operation itself, and if that CQE has **IORING\_CQE\_F\_MORE** set in the CQE *flags* field, then a second notification CQE will be posted for the operation. This second notification tells the application that the memory associated with the send is safe to get reused. The second CQE will have **IORING\_CQE\_F\_NOTIF** set in the CQE *flags* field. Also see the [**io\_uring\_enter**(2)](/man/os/liburing/io_uring_enter.2) man page for a fuller description of the notification CQE.

Note that using **IOSQE\_IO\_LINK** with this request type requires the setting of **MSG\_WAITALL** in the *flags* argument, as a short send isn't considered an error condition without that being set.

These functions prepare an async zerocopy [**send**(2)](/man/os/liburing/send.2) request. See that man page for details. For details on the zerocopy nature of it, see [**io\_uring\_enter**(2)](/man/os/liburing/io_uring_enter.2)**.**

# [RETURN VALUE](#RETURN_VALUE)

None

# [ERRORS](#ERRORS)

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. Some common error cases are:

[**-ENOMEM**](#ENOMEM)

The [**ulimit**(1)](/man/os/liburing/ulimit.1) -l setting is too low to support the size of the attempted zero copy send. Increasing the limit may help

[**-ENOMEM**](#ENOMEM~2)

The kernel ran out of memory.

# [NOTES](#NOTES)

Despite accepting a size\_t number of bytes, these functions can transfer at most INT\_MAX bytes per call (the maximum for the underlying syscall interface).

# [SEE ALSO](#SEE_ALSO)

[**io\_uring\_get\_sqe**(3)](/man/os/liburing/io_uring_get_sqe.3), [**io\_uring\_submit**(3)](/man/os/liburing/io_uring_submit.3), [**io\_uring\_prep\_send**(3)](/man/os/liburing/io_uring_prep_send.3), [**io\_uring\_enter**(2)](/man/os/liburing/io_uring_enter.2), [**send**(2)](/man/os/liburing/send.2)

September 6, 2022 liburing-2.3

---

Document: io_uring_prep_send_zc(3) from liburing 2.15-r5 (Chainguard OS)
Source: https://github.com/axboe/liburing.git