sys/netlink/netlink_message_writer.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2021 Ng Peng Nam Sean
   5  * Copyright (c) 2022 Alexander V. Chernikov <melifaro@FreeBSD.org>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #ifndef _NETLINK_NETLINK_MESSAGE_WRITER_H_
  30 #define _NETLINK_NETLINK_MESSAGE_WRITER_H_
  31
  32 /*
  33  * It is not meant to be included directly
  34  */
  35
  36 struct mbuf;
  37 struct nl_writer;
  38 typedef bool nl_writer_cb(struct nl_writer *nw, void *buf, int buflen, int cnt);
  39
  40 struct nl_writer {
  41         int                     alloc_len;      /* allocated buffer length */
  42         int                     offset;         /* offset from the start of the buffer */
  43         struct nlmsghdr         *hdr;           /* Pointer to the currently-filled msg */
  44         char                    *data;          /* pointer to the contiguous storage */
  45         void                    *_storage;      /* Underlying storage pointer */
  46         nl_writer_cb            *cb;            /* Callback to flush data */
  47         union {
  48                 void            *arg_ptr;       /* Callback argument as pointer */
  49                 uint64_t        arg_uint;       /* Callback argument as int */
  50         };
  51         int                     num_messages;   /* Number of messages in the buffer */
  52         int                     malloc_flag;    /* M_WAITOK or M_NOWAIT */
  53         uint8_t                 writer_type;    /* NS_WRITER_TYPE_* */
  54         uint8_t                 writer_target;  /* NS_WRITER_TARGET_*  */
  55         bool                    ignore_limit;   /* If true, ignores RCVBUF limit */
  56         bool                    enomem;         /* True if ENOMEM occured */
  57 };
  58 #define NS_WRITER_TARGET_SOCKET 0
  59 #define NS_WRITER_TARGET_GROUP  1
  60 #define NS_WRITER_TARGET_CHAIN  2
  61
  62 #define NS_WRITER_TYPE_MBUF     0
  63 #define NS_WRITER_TYPE_BUF      1
  64 #define NS_WRITER_TYPE_LBUF     2
  65 #define NS_WRITER_TYPE_MBUFC    3
  66
  67
  68 #define NLMSG_SMALL     128
  69 #define NLMSG_LARGE     2048
  70
  71 /* Message and attribute writing */
  72
  73 struct nlpcb;
  74 bool nlmsg_get_unicast_writer(struct nl_writer *nw, int expected_size, struct nlpcb *nlp);
  75 bool nlmsg_get_group_writer(struct nl_writer *nw, int expected_size, int proto, int group_id);
  76 bool nlmsg_get_chain_writer(struct nl_writer *nw, int expected_size, struct mbuf **pm);
  77 bool nlmsg_flush(struct nl_writer *nw);
  78 void nlmsg_ignore_limit(struct nl_writer *nw);
  79
  80 bool nlmsg_refill_buffer(struct nl_writer *nw, int required_size);
  81 bool nlmsg_add(struct nl_writer *nw, uint32_t portid, uint32_t seq, uint16_t type,
  82     uint16_t flags, uint32_t len);
  83 bool nlmsg_end(struct nl_writer *nw);
  84 void nlmsg_abort(struct nl_writer *nw);
  85
  86 bool nlmsg_end_dump(struct nl_writer *nw, int error, struct nlmsghdr *hdr);
  87
  88 static inline bool
  89 nlmsg_reply(struct nl_writer *nw, const struct nlmsghdr *hdr, int payload_len)
  90 {
  91         return (nlmsg_add(nw, hdr->nlmsg_pid, hdr->nlmsg_seq, hdr->nlmsg_type,
  92             hdr->nlmsg_flags, payload_len));
  93 }
  94
  95 #define nlmsg_data(_hdr)        ((void *)((_hdr) + 1))
  96
  97 /*
  98  * KPI similar to mtodo():
  99  * current (uncompleted) header is guaranteed to be contiguous,
 100  *  but can be reallocated, thus pointers may need to be readjusted.
 101  */
 102 static inline int
 103 nlattr_save_offset(const struct nl_writer *nw)
 104 {
 105         return (nw->offset - ((char *)nw->hdr - nw->data));
 106 }
 107
 108 static inline void *
 109 _nlattr_restore_offset(const struct nl_writer *nw, int off)
 110 {
 111         return ((void *)((char *)nw->hdr + off));
 112 }
 113 #define nlattr_restore_offset(_ns, _off, _t)    ((_t *)_nlattr_restore_offset(_ns, _off))
 114
 115 static inline void
 116 nlattr_set_len(const struct nl_writer *nw, int off)
 117 {
 118         struct nlattr *nla = nlattr_restore_offset(nw, off, struct nlattr);
 119         nla->nla_len = nlattr_save_offset(nw) - off;
 120 }
 121
 122 static inline void *
 123 nlmsg_reserve_data_raw(struct nl_writer *nw, size_t sz)
 124 {
 125         if (__predict_false(nw->offset + NETLINK_ALIGN(sz) > nw->alloc_len)) {
 126                 if (!nlmsg_refill_buffer(nw, NETLINK_ALIGN(sz)))
 127                         return (NULL);
 128         }
 129
 130         void *data_ptr = &nw->data[nw->offset];
 131         nw->offset += NLMSG_ALIGN(sz);
 132
 133         return (data_ptr);
 134 }
 135 #define nlmsg_reserve_object(_ns, _t)   ((_t *)nlmsg_reserve_data_raw(_ns, NLA_ALIGN(sizeof(_t))))
 136 #define nlmsg_reserve_data(_ns, _sz, _t)        ((_t *)nlmsg_reserve_data_raw(_ns, _sz))
 137
 138 static inline int
 139 nlattr_add_nested(struct nl_writer *nw, uint16_t nla_type)
 140 {
 141         int off = nlattr_save_offset(nw);
 142         struct nlattr *nla = nlmsg_reserve_data(nw, sizeof(struct nlattr), struct nlattr);
 143         if (__predict_false(nla == NULL))
 144                 return (0);
 145         nla->nla_type = nla_type;
 146         return (off);
 147 }
 148
 149 static inline void *
 150 _nlmsg_reserve_attr(struct nl_writer *nw, uint16_t nla_type, uint16_t sz)
 151 {
 152         sz += sizeof(struct nlattr);
 153
 154         struct nlattr *nla = nlmsg_reserve_data(nw, sz, struct nlattr);
 155         if (__predict_false(nla == NULL))
 156                 return (NULL);
 157         nla->nla_type = nla_type;
 158         nla->nla_len = sz;
 159
 160         return ((void *)(nla + 1));
 161 }
 162 #define nlmsg_reserve_attr(_ns, _at, _t)        ((_t *)_nlmsg_reserve_attr(_ns, _at, NLA_ALIGN(sizeof(_t))))
 163
 164 static inline bool
 165 nlattr_add(struct nl_writer *nw, int attr_type, int attr_len, const void *data)
 166 {
 167         int required_len = NLA_ALIGN(attr_len + sizeof(struct nlattr));
 168
 169         if (__predict_false(nw->offset + required_len > nw->alloc_len)) {
 170                 if (!nlmsg_refill_buffer(nw, required_len))
 171                         return (false);
 172         }
 173
 174         struct nlattr *nla = (struct nlattr *)(&nw->data[nw->offset]);
 175
 176         nla->nla_len = attr_len + sizeof(struct nlattr);
 177         nla->nla_type = attr_type;
 178         if (attr_len > 0) {
 179                 if ((attr_len % 4) != 0) {
 180                         /* clear padding bytes */
 181                         bzero((char *)nla + required_len - 4, 4);
 182                 }
 183                 memcpy((nla + 1), data, attr_len);
 184         }
 185         nw->offset += required_len;
 186         return (true);
 187 }
 188
 189 static inline bool
 190 nlattr_add_u8(struct nl_writer *nw, int attrtype, uint8_t value)
 191 {
 192         return (nlattr_add(nw, attrtype, sizeof(uint8_t), &value));
 193 }
 194
 195 static inline bool
 196 nlattr_add_u16(struct nl_writer *nw, int attrtype, uint16_t value)
 197 {
 198         return (nlattr_add(nw, attrtype, sizeof(uint16_t), &value));
 199 }
 200
 201 static inline bool
 202 nlattr_add_u32(struct nl_writer *nw, int attrtype, uint32_t value)
 203 {
 204         return (nlattr_add(nw, attrtype, sizeof(uint32_t), &value));
 205 }
 206
 207 static inline bool
 208 nlattr_add_u64(struct nl_writer *nw, int attrtype, uint64_t value)
 209 {
 210         return (nlattr_add(nw, attrtype, sizeof(uint64_t), &value));
 211 }
 212
 213 static inline bool
 214 nlattr_add_s8(struct nl_writer *nw, int attrtype, int8_t value)
 215 {
 216         return (nlattr_add(nw, attrtype, sizeof(int8_t), &value));
 217 }
 218
 219 static inline bool
 220 nlattr_add_s16(struct nl_writer *nw, int attrtype, int16_t value)
 221 {
 222         return (nlattr_add(nw, attrtype, sizeof(int16_t), &value));
 223 }
 224
 225 static inline bool
 226 nlattr_add_s32(struct nl_writer *nw, int attrtype, int32_t value)
 227 {
 228         return (nlattr_add(nw, attrtype, sizeof(int32_t), &value));
 229 }
 230
 231 static inline bool
 232 nlattr_add_s64(struct nl_writer *nw, int attrtype, int64_t value)
 233 {
 234         return (nlattr_add(nw, attrtype, sizeof(int64_t), &value));
 235 }
 236
 237 static inline bool
 238 nlattr_add_flag(struct nl_writer *nw, int attrtype)
 239 {
 240         return (nlattr_add(nw, attrtype, 0, NULL));
 241 }
 242
 243 static inline bool
 244 nlattr_add_string(struct nl_writer *nw, int attrtype, const char *str)
 245 {
 246         return (nlattr_add(nw, attrtype, strlen(str) + 1, str));
 247 }
 248
 249
 250 #endif