Differential D36002 Diff 109100 sys/netlink/netlink_var.h

Changeset View

Standalone View

sys/netlink/netlink_var.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_VAR_H_
				#define _NETLINK_NETLINK_VAR_H_

				#include <sys/epoch.h>
				#include <sys/sysctl.h>
				#include <sys/taskqueue.h>
				#include <net/vnet.h>

				MALLOC_DECLARE(M_NETLINK);

				#define NLSNDQ 65536 /* Default socket sendspace */
				#define NLRCVQ 65536 /* Default socket recvspace */

				struct nlpcb {
				struct socket *nl_socket;
				uint32_t nl_port;
				uint32_t nl_groups;
				uint32_t nl_flags;
				uint32_t nl_process_id;
				int nl_proto;
				bool nl_active;
				bool nl_task_pending;
				bool nl_linux; /* true if running under compat */
				struct mbuf *nl_queue_head;
				struct mbuf *nl_queue_last;
				int64_t nl_queue_length;
				struct taskqueue *nl_taskqueue;
				struct task nl_task;
				CK_LIST_ENTRY(nlpcb) nl_next;
				CK_LIST_ENTRY(nlpcb) nl_port_next;
				volatile u_int nl_refcount;
				struct mtx nl_lock;
				struct epoch_context nl_epoch_ctx;
				};
				#define sotonlpcb(so) ((struct nlpcb *)(so)->so_pcb)

				#define NLP_LOCK_INIT(_nlp) mtx_init(&((_nlp)->nl_lock), "nlp mtx", NULL, MTX_DEF)
				#define NLP_LOCK_DESTROY(_nlp) mtx_destroy(&((_nlp)->nl_lock))
				#define NLP_LOCK(_nlp) mtx_lock(&((_nlp)->nl_lock))
				#define NLP_UNLOCK(_nlp) mtx_unlock(&((_nlp)->nl_lock))

				#define ALIGNED_NL_SZ(_data) roundup2((((struct nlmsghdr *)(_data))->nlmsg_len), 16)

				#define NLF_CAP_ACK 0x01 /* Do not send message body with errmsg */
				#define NLF_EXT_ACK 0x02 /* Allow including extended TLVs in ack */

				#define NETISR_NETLINK 15 // XXX hack, must be unused and < 16


				SYSCTL_DECL(_net_netlink);

				struct nl_io {
				struct callout callout;
				struct mbuf *head;
				struct mbuf *last;
				int64_t length;
				};


				struct nl_control {
				CK_LIST_HEAD(nl_pid_head, nlpcb) ctl_port_head;
				CK_LIST_HEAD(nlpcb_head, nlpcb) ctl_pcb_head;
				CK_LIST_ENTRY(nl_control) ctl_next;
				struct nl_io ctl_io;
				struct rmlock ctl_lock;
				};
				VNET_DECLARE(struct nl_control *, nl_ctl);
				#define V_nl_ctl VNET(nl_ctl)


				/* locking */
				#define CTL_TRACKER struct rm_priotracker nl_tracker
				#define CTL_RLOCK() rm_rlock(&V_nl_ctl->ctl_lock, &nl_tracker)
				#define CTL_RUNLOCK() rm_runlock(&V_nl_ctl->ctl_lock, &nl_tracker)

				#define CTL_WLOCK() rm_wlock(&V_nl_ctl->ctl_lock)
				#define CTL_WUNLOCK() rm_wunlock(&V_nl_ctl->ctl_lock)

				struct sockaddr_nl;
				struct sockaddr;
				struct nlmsghdr;

				/* Parsing state */

				struct linear_buffer {
				char base; / Base allocated memory pointer */
				uint32_t offset; /* Currently used offset */
				uint32_t size; /* Total buffer size */
				};

				static inline void *
				lb_alloc(struct linear_buffer *lb, int len)
				{
				len = roundup2(len, sizeof(uint64_t));
				if (lb->offset + len > lb->size)
				return (NULL);
				void data = (void )(lb->base + lb->offset);
				lb->offset += len;
				return (data);
				}

				static inline void
				lb_clear(struct linear_buffer *lb)
				{
				memset(lb->base, 0, lb->size);
				lb->offset = 0;
				}

				#define SCRATCH_BUFFER_SIZE 1024
				struct netlink_parse_tracker {
				struct linear_buffer lb; /* Per-message scratch buffer */
				struct nlpcb nlp; / Originator */
				struct nlmsghdr hdr; / Current message being parsed */
				int error; /* last operation error */
				};

				static inline void *
				npt_alloc(struct netlink_parse_tracker *npt, int len)
				{
				return (lb_alloc(&npt->lb, len));
				}
				#define npt_alloc_sockaddr(_npt, _len) ((struct sockaddr *)(npt_alloc(_npt, _len)))

				/* netlink_netisr.c */
				void netlink_netisr_init(void);
				void netlink_netisr_destroy(void);
				void netlink_netisr_vnet_init(void);
				void netlink_netisr_vnet_destroy(void);
				int nl_send_msg(struct mbuf *m, uint32_t group_mask);
				void nl_msg_from_netlink(struct mbuf *m);

				extern struct netisr_handler nlsock_nh;

				/* netlink_io.c */
				void nl_taskqueue_handler(void *_arg, int pending);
				int nl_receive_async(struct mbuf m, struct socket so);
				void nl_process_receive_locked(struct nlpcb *nlp);

				/* netlink_iface.c */
				struct rt_addrinfo;
				int rtnl_handle_getlink(struct nlmsghdr hdr, struct nlpcb nlp,
				struct netlink_parse_tracker *npt);
				int rtnl_handle_getaddr(struct nlmsghdr hdr, struct nlpcb nlp,
				struct netlink_parse_tracker *npt);
				void rtnl_ifaces_init(void);
				void rtnl_ifaces_destroy(void);

				/* netlink_module.c */
				void vnet_nl_ctl_init(void);

				int nl_verify_proto(int proto);

				extern int netlink_unloading;

				#define NL_MAX_HANDLERS 100
				extern nl_handler nl_handlers[NL_MAX_HANDLERS];

				/* netlink_nhop.c */
				int rtnl_handle_newnhop(struct nlmsghdr hdr, struct nlpcb nlp,
				struct netlink_parse_tracker *npt);

				/* netlink_io.c */
				void nl_send_group(struct mbuf *m, uint32_t group_mask);
				bool nl_send_one(struct mbuf m, struct nlpcb nlp);
				void nlmsg_ack(struct nlpcb nlp, int error, struct nlmsghdr nlmsg);

				/* Linux compat */
				struct nlmsghdr nlmsg_from_linux(struct nlmsghdr hdr,
				struct netlink_parse_tracker *npt);
				struct mbuf nlmsgs_to_linux(char buf, int buflen, struct nlpcb *nlp);
				struct mbuf mbufs_to_linux(struct mbuf m, struct nlpcb *nlp);

				#endif