Differential D36002 Diff 109100 sys/netlink/netlink_ctl.h

Changeset View

Standalone View

sys/netlink/netlink_ctl.h

This file was added.

				/*-
				* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
				*
				* Copyright (c) 2021 Ng Peng Nam Sean
				Lint: Possible Spelling Mistake Inline Actions Possible spelling error. You wrote 'nam', but did you mean 'name'? Lint: Possible Spelling Mistake: Possible spelling error. You wrote 'nam', but did you mean 'name'?
				* Copyright (c) 2022 Alexander V. Chernikov
				*
				* Redistribution and use in source and binary forms, with or without
				* modification, are permitted provided that the following conditions
				* are met:
				* 1. Redistributions of source code must retain the above copyright
				* notice, this list of conditions and the following disclaimer.
				* 2. Redistributions in binary form must reproduce the above copyright
				* notice, this list of conditions and the following disclaimer in the
				* documentation and/or other materials provided with the distribution.
				*
				* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
				* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
				* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
				* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
				* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
				* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
				* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
				* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
				* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
				* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
				* SUCH DAMAGE.
				*/


				#ifndef _NETLINK_NETLINK_CTL_H_
				#define _NETLINK_NETLINK_CTL_H_

				#ifdef _KERNEL

				/*
				* This file provides headers for the public KPI of the netlink
				* subsystem
				* */

				/*
				* Messages and attributes (netlink_message.c)
				*/
				#define _roundup2(x, y) (((x)+((y)-1))&(~((y)-1)))

				#define NETLINK_ALIGN_SIZE sizeof(uint32_t)
				#define NETLINK_ALIGN(_len) _roundup2(_len, NETLINK_ALIGN_SIZE)

				#define NLA_ALIGN_SIZE sizeof(uint32_t)
				#define NLA_ALIGN(_len) _roundup2(_len, NLA_ALIGN_SIZE)

				#define NLA_NEXT(_attr) (struct nlattr )((char )_attr + NLA_ALIGN(_attr->nla_len))
				#define NLA_FOREACH(_attr, _start, _len) \
				for (_attr = (_start); ((char )NLA_NEXT(_attr) - (char )(_start)) <= (_len); _attr = NLA_NEXT(_attr))

				struct mbuf;
				struct nlmsg_state;
				typedef bool nlmsg_state_cb(struct nlmsg_state ns, char buf, int buflen);

				struct nlmsg_state {
				int alloc_len;
				int offset;
				struct nlmsghdr *hdr;
				char *data; // pointer to contig storage
				union {
				struct mbuf *_m;
				char *_buf;
				};
				nlmsg_state_cb *cb;
				void *arg;
				int malloc_flag; // M_WAITOK \| M_NOWAIT
				uint8_t writer_type;
				uint8_t writer_target;
				};
				#define NS_WRITER_TARGET_SOCKET 0
				#define NS_WRITER_TARGET_GROUP 1
				#define NS_WRITER_TARGET_CHAIN 2

				#define NS_WRITER_TYPE_MBUF 0
				#define NS_WRITER_TYPE_BUF 1
				#define NS_WRITER_TYPE_LBUF 2
				#define NS_WRITER_TYPE_MBUFC 3


				#define NLMSG_SMALL 128
				#define NLMSG_LARGE 2048

				struct nlpcb;
				bool nlmsg_get_socket_writer(int size, struct nlpcb nlp, struct nlmsg_state ns);
				bool nlmsg_get_group_writer(int size, uint32_t group_mask, struct nlmsg_state *ns);
				bool nlmsg_get_chain_writer(int size, struct mbuf *pm, struct nlmsg_state ns);
				void nlmsg_free(struct nlmsg_state *ns);
				bool nlmsg_add(struct nlmsg_state *ns, uint32_t portid, uint32_t seq, uint16_t type,
				uint16_t flags, uint32_t len);
				void nlmsg_reserve_data_raw(struct nlmsg_state ns, size_t sz);
				void nlmsg_end(struct nlmsg_state *ns);
				void nlmsg_abort(struct nlmsg_state *ns);
				bool nlmsg_flush(struct nlmsg_state *ns);

				#define nlmsg_data(_hdr) ((void *)((_hdr) + 1))

				#define nlmsg_reserve_object(_ns, _t) ((_t *)nlmsg_reserve_data_raw(_ns, NLA_ALIGN(sizeof(_t))))
				#define nlmsg_reserve_data(_ns, _sz, _t) ((_t *)nlmsg_reserve_data_raw(_ns, _sz))

				/* Attributes */
				bool nlattr_add_handle_oom(struct nlmsg_state *ns, int attr_type, int attr_len,
				const void *data);

				static inline bool
				nlattr_add_noerror(struct nlmsg_state *ns, int attr_type, int attr_len,
				const void *data)
				{
				int required_len = NLA_ALIGN(attr_len + sizeof(struct nlattr));
				struct nlattr nla = (struct nlattr )(&ns->data[ns->offset]);

				nla->nla_len = attr_len + sizeof(struct nlattr);
				nla->nla_type = attr_type;
				if (attr_len > 0) {
				memcpy((nla + 1), data, attr_len);
				}
				ns->offset += required_len;
				return (true);
				}

				static inline bool
				nlattr_add(struct nlmsg_state ns, int attr_type, int attr_len, const void data)
				{
				int required_len = NLA_ALIGN(attr_len + sizeof(struct nlattr));

				if (__predict_false(ns->offset + required_len > ns->alloc_len)) {
				if (!nlattr_add_handle_oom(ns, attr_type, attr_len, data))
				return (false);
				}

				return (nlattr_add_noerror(ns, attr_type, attr_len, data));
				}

				static inline bool
				nlattr_add_u8(struct nlmsg_state *ns, int attrtype, uint8_t value)
				{
				return (nlattr_add(ns, attrtype, sizeof(uint8_t), &value));
				}

				static inline bool
				nlattr_add_u16(struct nlmsg_state *ns, int attrtype, uint16_t value)
				{
				return (nlattr_add(ns, attrtype, sizeof(uint16_t), &value));
				}

				static inline bool
				nlattr_add_u32(struct nlmsg_state *ns, int attrtype, uint32_t value)
				{
				return (nlattr_add(ns, attrtype, sizeof(uint32_t), &value));
				}

				static inline bool
				nlattr_add_u64(struct nlmsg_state *ns, int attrtype, uint64_t value)
				{
				return (nlattr_add(ns, attrtype, sizeof(uint64_t), &value));
				}

				static inline bool
				nlattr_add_s8(struct nlmsg_state *ns, int attrtype, int8_t value)
				{
				return (nlattr_add(ns, attrtype, sizeof(int8_t), &value));
				}

				static inline bool
				nlattr_add_s16(struct nlmsg_state *ns, int attrtype, int16_t value)
				{
				return (nlattr_add(ns, attrtype, sizeof(int16_t), &value));
				}

				static inline bool
				nlattr_add_s32(struct nlmsg_state *ns, int attrtype, int32_t value)
				{
				return (nlattr_add(ns, attrtype, sizeof(int32_t), &value));
				}

				static inline bool
				nlattr_add_s64(struct nlmsg_state *ns, int attrtype, int64_t value)
				{
				return (nlattr_add(ns, attrtype, sizeof(int64_t), &value));
				}

				static inline bool
				nlattr_add_flag(struct nlmsg_state *ns, int attrtype)
				{
				return (nlattr_add(ns, attrtype, 0, NULL));
				}

				static inline bool
				nlattr_add_string(struct nlmsg_state ns, int attrtype, const char str)
				{
				return (nlattr_add(ns, attrtype, strlen(str) + 1, str));
				}

				/* Protocol handlers */
				struct netlink_parse_tracker;
				typedef int (nl_handler)(struct nlmsghdr hdr, struct netlink_parse_tracker *npt);

				bool netlink_register_proto(int proto, nl_handler handle);
				bool netlink_unregister_proto(int proto);


				#endif


				#endif