aboutsummaryrefslogtreecommitdiff
path: root/sys/netlink/netlink_module.c
blob: ddae4488987b4154c0834d8fdad091bfc47d6aec (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 2021 Ng Peng Nam Sean
 * Copyright (c) 2022 Alexander V. Chernikov <melifaro@FreeBSD.org>
 *
 * 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.
 */

#include <sys/param.h>
#include <sys/kernel.h>
#include <sys/malloc.h>
#include <sys/module.h>

#include <sys/lock.h>
#include <sys/rmlock.h>
#include <sys/ck.h>
#include <sys/syslog.h>

#include <netlink/netlink.h>
#include <netlink/netlink_ctl.h>
#include <netlink/netlink_var.h>
#include <netlink/route/route_var.h>

#include <machine/atomic.h>

FEATURE(netlink, "Netlink support");

#define	DEBUG_MOD_NAME	nl_mod
#define	DEBUG_MAX_LEVEL	LOG_DEBUG3
#include <netlink/netlink_debug.h>
_DECLARE_DEBUG(LOG_INFO);


#define NL_MAX_HANDLERS	20
struct nl_proto_handler _nl_handlers[NL_MAX_HANDLERS];
struct nl_proto_handler *nl_handlers = _nl_handlers;

CK_LIST_HEAD(nl_control_head, nl_control);
static struct nl_control_head vnets_head = CK_LIST_HEAD_INITIALIZER();

VNET_DEFINE(struct nl_control *, nl_ctl) = NULL;

struct mtx nl_global_mtx;
MTX_SYSINIT(nl_global_mtx, &nl_global_mtx, "global netlink lock", MTX_DEF);

#define NL_GLOBAL_LOCK()	mtx_lock(&nl_global_mtx)
#define NL_GLOBAL_UNLOCK()	mtx_unlock(&nl_global_mtx)

int netlink_unloading = 0;

static void
free_nl_ctl(struct nl_control *ctl)
{
	rm_destroy(&ctl->ctl_lock);
	free(ctl, M_NETLINK);
}

struct nl_control *
vnet_nl_ctl_init(void)
{
	struct nl_control *ctl;

	ctl = malloc(sizeof(struct nl_control), M_NETLINK, M_WAITOK | M_ZERO);
	rm_init(&ctl->ctl_lock, "netlink lock");
	CK_LIST_INIT(&ctl->ctl_port_head);
	CK_LIST_INIT(&ctl->ctl_pcb_head);

	NL_GLOBAL_LOCK();

	struct nl_control *tmp = atomic_load_ptr(&V_nl_ctl);

	if (tmp == NULL) {
		atomic_store_ptr(&V_nl_ctl, ctl);
		CK_LIST_INSERT_HEAD(&vnets_head, ctl, ctl_next);
		NL_LOG(LOG_DEBUG2, "VNET %p init done, inserted %p into global list",
		    curvnet, ctl);
	} else {
		NL_LOG(LOG_DEBUG, "per-VNET init clash, dropping this instance");
		free_nl_ctl(ctl);
		ctl = tmp;
	}

	NL_GLOBAL_UNLOCK();

	return (ctl);
}

static void
vnet_nl_ctl_destroy(const void *unused __unused)
{
	struct nl_control *ctl;

	/* Assume at the time all of the processes / sockets are dead */

	NL_GLOBAL_LOCK();
	ctl = atomic_load_ptr(&V_nl_ctl);
	atomic_store_ptr(&V_nl_ctl, NULL);
	if (ctl != NULL) {
		NL_LOG(LOG_DEBUG2, "Removing %p from global list", ctl);
		CK_LIST_REMOVE(ctl, ctl_next);
	}
	NL_GLOBAL_UNLOCK();

	if (ctl != NULL)
		free_nl_ctl(ctl);
}
VNET_SYSUNINIT(vnet_nl_ctl_destroy, SI_SUB_PROTO_IF, SI_ORDER_ANY,
    vnet_nl_ctl_destroy, NULL);

int
nl_verify_proto(int proto)
{
	if (proto < 0 || proto >= NL_MAX_HANDLERS) {
		return (EINVAL);
	}
	int handler_defined = nl_handlers[proto].cb != NULL;
	return (handler_defined ? 0 : EPROTONOSUPPORT);
}

const char *
nl_get_proto_name(int proto)
{
	return (nl_handlers[proto].proto_name);
}

bool
netlink_register_proto(int proto, const char *proto_name, nl_handler_f handler)
{
	if ((proto < 0) || (proto >= NL_MAX_HANDLERS))
		return (false);
	NL_GLOBAL_LOCK();
	KASSERT((nl_handlers[proto].cb == NULL), ("netlink handler %d is already set", proto));
	nl_handlers[proto].cb = handler;
	nl_handlers[proto].proto_name = proto_name;
	NL_GLOBAL_UNLOCK();
	NL_LOG(LOG_DEBUG2, "Registered netlink %s(%d) handler", proto_name, proto);
	return (true);
}

bool
netlink_unregister_proto(int proto)
{
	if ((proto < 0) || (proto >= NL_MAX_HANDLERS))
		return (false);
	NL_GLOBAL_LOCK();
	KASSERT((nl_handlers[proto].cb != NULL), ("netlink handler %d is not set", proto));
	nl_handlers[proto].cb = NULL;
	nl_handlers[proto].proto_name = NULL;
	NL_GLOBAL_UNLOCK();
	NL_LOG(LOG_DEBUG2, "Unregistered netlink proto %d handler", proto);
	return (true);
}

#if !defined(NETLINK) && defined(NETLINK_MODULE)
/* Non-stub function provider */
const static struct nl_function_wrapper nl_module = {
	.nlmsg_add = _nlmsg_add,
	.nlmsg_refill_buffer = _nlmsg_refill_buffer,
	.nlmsg_flush = _nlmsg_flush,
	.nlmsg_end = _nlmsg_end,
	.nlmsg_abort = _nlmsg_abort,
	.nlmsg_get_unicast_writer = _nlmsg_get_unicast_writer,
	.nlmsg_get_group_writer = _nlmsg_get_group_writer,
	.nlmsg_end_dump = _nlmsg_end_dump,
	.nl_modify_ifp_generic = _nl_modify_ifp_generic,
	.nl_store_ifp_cookie = _nl_store_ifp_cookie,
	.nl_get_thread_nlp = _nl_get_thread_nlp,
};
#endif

static bool
can_unload(void)
{
	struct nl_control *ctl;
	bool result = true;

	NL_GLOBAL_LOCK();

	CK_LIST_FOREACH(ctl, &vnets_head, ctl_next) {
		NL_LOG(LOG_DEBUG2, "Iterating VNET head %p", ctl);
		if (!CK_LIST_EMPTY(&ctl->ctl_pcb_head)) {
			NL_LOG(LOG_NOTICE, "non-empty socket list in ctl %p", ctl);
			result = false;
			break;
		}
	}

	NL_GLOBAL_UNLOCK();

	return (result);
}

static int
netlink_modevent(module_t mod __unused, int what, void *priv __unused)
{
	int ret = 0;

	switch (what) {
	case MOD_LOAD:
		NL_LOG(LOG_DEBUG2, "Loading");
		nl_osd_register();
#if !defined(NETLINK) && defined(NETLINK_MODULE)
		nl_set_functions(&nl_module);
#endif
		break;

	case MOD_UNLOAD:
		NL_LOG(LOG_DEBUG2, "Unload called");
		if (can_unload()) {
			NL_LOG(LOG_WARNING, "unloading");
			netlink_unloading = 1;
#if !defined(NETLINK) && defined(NETLINK_MODULE)
			nl_set_functions(NULL);
#endif
			nl_osd_unregister();
		} else
			ret = EBUSY;
		break;

	default:
		ret = EOPNOTSUPP;
		break;
	}

	return (ret);
}
static moduledata_t netlink_mod = { "netlink", netlink_modevent, NULL };

DECLARE_MODULE(netlink, netlink_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
MODULE_VERSION(netlink, 1);