HALF ECHO LEARN / REFERENCE COLLECTION

v262.2

src/fundamental/iovec-util.h

2,358 bytesGit mode 100644Download original fileLGPL-2.1-or-later

Git blob: 7d8f65db43d2ba81fa9f5b4b0e00336af040a20b

Lines 1–71 of 71

/* SPDX-License-Identifier: LGPL-2.1-or-later */
#pragma once
 
#if !SD_BOOT
#include <sys/uio.h>
#endif
 
#include "assert-util.h"         /* IWYU pragma: keep */
#include "macro.h"
 
#if SD_BOOT
/* struct iovec is a POSIX userspace construct. Let's introduce it also in EFI mode, it's just so useful */
struct iovec {
        void *iov_base;
        size_t iov_len;
};
#endif
 
/* This accepts both const and non-const pointers */
#define IOVEC_MAKE(base, len)                                           \
        (struct iovec) {                                                \
                .iov_base = (void*) (base),                             \
                .iov_len = (len),                                       \
        }
 
static inline struct iovec* iovec_shift(const struct iovec *iovec, size_t shift, struct iovec *ret) {
        assert(iovec);
        assert(ret);
 
        /* This returns an empty iovec when 'shift' is larger or equals to the input iovec length.
         * The 'iovec' and 'ret' can point to the same object. */
 
        *ret = IOVEC_MAKE(iovec->iov_len > shift ? (uint8_t*) iovec->iov_base + shift : NULL,
                          LESS_BY(iovec->iov_len, shift));
        return ret;
}
 
#define IOVEC_SHIFT(iov, shift)                         \
        *iovec_shift(iov, shift, &(struct iovec){})
 
static inline struct iovec* iovec_inc(struct iovec *iovec, size_t shift) {
        return iovec_shift(iovec, shift, iovec);
}
 
static inline void iovec_done(struct iovec *iovec) {
        /* A _cleanup_() helper that frees the iov_base in the iovec */
        assert(iovec);
 
        iovec->iov_base = mfree(iovec->iov_base);
        iovec->iov_len = 0;
}
 
static inline void iovec_done_many_and_free(struct iovec *iovec, size_t n) {
        if (n > 0) {
                assert(iovec);
                FOREACH_ARRAY(j, iovec, n)
                        iovec_done(j);
        }
        free(iovec);
}
 
static inline bool iovec_is_set(const struct iovec *iovec) {
        /* Checks if the iovec points to a non-empty chunk of memory */
        return iovec && iovec->iov_len > 0 && iovec->iov_base;
}
 
static inline bool iovec_is_valid(const struct iovec *iovec) {
        /* Checks if the iovec is either NULL, empty or points to a valid bit of memory */
        return !iovec || iovec->iov_base || iovec->iov_len == 0;
}