summaryrefslogtreecommitdiffstats
path: root/src/spdk/lib/net/interface.c
blob: 5102695b720599809af16d9a34053affeef27524 (plain)
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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
/*-
 *   BSD LICENSE
 *
 *   Copyright (c) Intel Corporation.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
 *   OWNER 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 "net_internal.h"

#include "spdk/stdinc.h"
#include "spdk/string.h"

#include "spdk/log.h"
#include "spdk/net.h"

#ifdef __linux__ /* Interface management is Linux-specific */

#include <linux/netlink.h>
#include <linux/rtnetlink.h>

static TAILQ_HEAD(, spdk_interface) g_interface_head;

static pthread_mutex_t interface_lock = PTHREAD_MUTEX_INITIALIZER;

static int spdk_get_ifc_ipv4(void)
{
	int ret;
	int rtattrlen;
	int netlink_fd;
	uint32_t ipv4_addr;

	struct {
		struct nlmsghdr n;
		struct ifaddrmsg r;
		struct rtattr rta;
	} req;
	char buf[16384];
	struct nlmsghdr *nlmp;
	struct ifaddrmsg *rtmp;
	struct rtattr *rtatp;
	struct spdk_interface *ifc;

	netlink_fd = socket(PF_NETLINK, SOCK_DGRAM, NETLINK_ROUTE);
	if (netlink_fd < 0) {
		SPDK_ERRLOG("socket failed!\n");
		return 1;
	}

	/*
	 * Prepare a message structure
	 */
	memset(&req, 0, sizeof(req));
	req.n.nlmsg_len = NLMSG_LENGTH(sizeof(struct ifaddrmsg));
	req.n.nlmsg_flags = NLM_F_REQUEST | NLM_F_ROOT;
	req.n.nlmsg_type = RTM_GETADDR;

	/* IPv4 only */
	req.r.ifa_family = AF_INET;

	/*
	 * Fill up all the attributes for the rtnetlink header.
	 */
	assert(&req.rta == (struct rtattr *)(((char *)&req) + NLMSG_ALIGN(req.n.nlmsg_len)));
	req.rta.rta_len = RTA_LENGTH(16);

	/* Send and recv the message from kernel */
	ret = send(netlink_fd, &req, req.n.nlmsg_len, 0);
	if (ret < 0) {
		SPDK_ERRLOG("netlink send failed: %s\n", spdk_strerror(errno));
		ret = 1;
		goto exit;
	}

	ret = recv(netlink_fd, buf, sizeof(buf), 0);
	if (ret <= 0) {
		SPDK_ERRLOG("netlink recv failed: %s\n", spdk_strerror(errno));
		ret = 1;
		goto exit;
	}

	for (nlmp = (struct nlmsghdr *)buf; ret > (int)sizeof(*nlmp);) {
		int len = nlmp->nlmsg_len;
		int req_len = len - sizeof(*nlmp);

		if (req_len < 0 || len > ret) {
			SPDK_ERRLOG("error\n");
			ret = 1;
			goto exit;
		}

		if (!NLMSG_OK(nlmp, (uint32_t)ret)) {
			SPDK_ERRLOG("NLMSG not OK\n");
			ret = 1;
			goto exit;
		}

		rtmp = (struct ifaddrmsg *)NLMSG_DATA(nlmp);
		rtatp = (struct rtattr *)IFA_RTA(rtmp);

		rtattrlen = IFA_PAYLOAD(nlmp);

		for (; RTA_OK(rtatp, rtattrlen); rtatp = RTA_NEXT(rtatp, rtattrlen)) {
			if (rtatp->rta_type == IFA_LOCAL) {
				memcpy(&ipv4_addr, (struct in_addr *)RTA_DATA(rtatp),
				       sizeof(struct in_addr));
				TAILQ_FOREACH(ifc, &g_interface_head, tailq) {
					if (ifc->index == rtmp->ifa_index) {
						/* add a new IP address to interface */
						if (ifc->num_ip_addresses >= SPDK_MAX_IP_PER_IFC) {
							SPDK_ERRLOG("SPDK: number of IP addresses supported for %s excceded. limit=%d\n",
								    ifc->name,
								    SPDK_MAX_IP_PER_IFC);
							break;
						}
						ifc->ip_address[ifc->num_ip_addresses] = ipv4_addr;
						ifc->num_ip_addresses++;
						break;
					}
				}
			}
		}
		ret -= NLMSG_ALIGN(len);
		nlmp = (struct nlmsghdr *)((char *)nlmp + NLMSG_ALIGN(len));
	}
	ret = 0;

exit:
	close(netlink_fd);
	return ret;
}


static int spdk_process_new_interface_msg(struct nlmsghdr *h)
{
	int len;
	struct spdk_interface *ifc;
	struct ifinfomsg *iface;
	struct rtattr *attribute;

	iface = (struct ifinfomsg *)NLMSG_DATA(h);

	ifc = (struct spdk_interface *) malloc(sizeof(*ifc));
	if (ifc == NULL) {
		SPDK_ERRLOG("%s: Malloc failed\n", __func__);
		return 1;
	}

	memset(ifc, 0, sizeof(*ifc));

	/* Set interface index */
	ifc->index = iface->ifi_index;

	len = h->nlmsg_len - NLMSG_LENGTH(sizeof(*iface));

	/* Loop over all attributes for the NEWLINK message */
	for (attribute = IFLA_RTA(iface); RTA_OK(attribute, len); attribute = RTA_NEXT(attribute, len)) {
		switch (attribute->rta_type) {
		case IFLA_IFNAME:
			if (if_indextoname(iface->ifi_index, ifc->name) == NULL) {
				SPDK_ERRLOG("Indextoname failed!\n");
				free(ifc);
				return 2;
			}
			break;
		default:
			break;
		}
	}
	TAILQ_INSERT_TAIL(&g_interface_head, ifc, tailq);
	return 0;
}

static int spdk_prepare_ifc_list(void)
{
	int ret = 0;
	struct nl_req_s {
		struct nlmsghdr hdr;
		struct rtgenmsg gen;
		struct ifinfomsg ifi;
	};
	int netlink_fd;
	struct sockaddr_nl local;	/* Our local (user space) side of the communication */
	struct sockaddr_nl kernel;	/* The remote (kernel space) side of the communication */

	struct msghdr rtnl_msg;		/* Generic msghdr struct for use with sendmsg */
	struct iovec io;		/* IO vector for sendmsg */

	struct nl_req_s req;		/* Structure that describes the rtnetlink packet itself */
	char reply[16384];		/* a large buffer to receive lots of link information */

	pid_t pid = getpid();		/* Our process ID to build the correct netlink address */
	int end = 0;			/* some flag to end loop parsing */

	/*
	 * Prepare netlink socket for kernel/user space communication
	 */
	netlink_fd = socket(AF_NETLINK, SOCK_RAW, NETLINK_ROUTE);
	if (netlink_fd < 0) {
		SPDK_ERRLOG("socket failed!\n");
		return 1;
	}

	memset(&local, 0, sizeof(local)); /* Fill-in local address information */
	local.nl_family = AF_NETLINK;
	local.nl_pid = pid;
	local.nl_groups = 0;

	/* RTNL socket is ready to use, prepare and send L2 request. */
	memset(&rtnl_msg, 0, sizeof(rtnl_msg));
	memset(&kernel, 0, sizeof(kernel));
	memset(&req, 0, sizeof(req));

	kernel.nl_family = AF_NETLINK; /* Fill-in kernel address (destination of our message) */

	req.hdr.nlmsg_len = NLMSG_LENGTH(sizeof(struct rtgenmsg));
	req.hdr.nlmsg_type = RTM_GETLINK;
	req.hdr.nlmsg_flags = NLM_F_REQUEST | NLM_F_DUMP;
	req.hdr.nlmsg_seq = 1;
	req.hdr.nlmsg_pid = pid;

	req.ifi.ifi_family = AF_UNSPEC;
	req.ifi.ifi_type = 1;

	io.iov_base = &req;
	io.iov_len = req.hdr.nlmsg_len;
	rtnl_msg.msg_iov = &io;
	rtnl_msg.msg_iovlen = 1;
	rtnl_msg.msg_name = &kernel;
	rtnl_msg.msg_namelen = sizeof(kernel);

	if (sendmsg(netlink_fd, &rtnl_msg, 0) == -1) {
		SPDK_ERRLOG("Sendmsg failed!\n");
		ret = 1;
		goto exit;
	}

	/* Parse reply */
	while (!end) {
		int len;
		struct nlmsghdr *msg_ptr;	/* Pointer to current message part */

		struct msghdr rtnl_reply;	/* Generic msghdr structure for use with recvmsg */
		struct iovec io_reply;

		memset(&io_reply, 0, sizeof(io_reply));
		memset(&rtnl_reply, 0, sizeof(rtnl_reply));

		io.iov_base = reply;
		io.iov_len = 8192;
		rtnl_reply.msg_iov = &io;
		rtnl_reply.msg_iovlen = 1;
		rtnl_reply.msg_name = &kernel;
		rtnl_reply.msg_namelen = sizeof(kernel);

		/* Read as much data as fits in the receive buffer */
		len = recvmsg(netlink_fd, &rtnl_reply, 0);
		if (len) {
			for (msg_ptr = (struct nlmsghdr *) reply; NLMSG_OK(msg_ptr, (uint32_t)len);
			     msg_ptr = NLMSG_NEXT(msg_ptr, len)) {
				switch (msg_ptr->nlmsg_type) {
				case NLMSG_DONE:		/* This is the special meaning NLMSG_DONE message we asked for by using NLM_F_DUMP flag */
					end++;
					break;
				case RTM_NEWLINK:	/* This is a RTM_NEWLINK message, which contains lots of information about a link */
					ret = spdk_process_new_interface_msg(msg_ptr);
					if (ret != 0) {
						goto exit;
					}
					break;
				default:
					break;
				}
			}
		}
	}
exit:
	close(netlink_fd);
	return ret;
}

static int spdk_interface_available(uint32_t ifc_index)
{
	struct spdk_interface *ifc_entry;

	pthread_mutex_lock(&interface_lock);
	TAILQ_FOREACH(ifc_entry, &g_interface_head, tailq) {
		if (ifc_entry->index == ifc_index) {
			pthread_mutex_unlock(&interface_lock);
			return 0;
		}
	}
	pthread_mutex_unlock(&interface_lock);

	return -1;
}

static int netlink_addr_msg(uint32_t ifc_idx, uint32_t ip_address, uint32_t create)
{
	int fd;
	struct sockaddr_nl la;
	struct sockaddr_nl pa;
	struct msghdr msg;
	struct iovec iov;
	int ifal;
	struct {
		struct nlmsghdr n;
		struct ifaddrmsg r;
		char buf[16384];
	} req;
	struct rtattr *rta;

	if (spdk_interface_available(ifc_idx)) {
		return -1;
	}

	fd = socket(AF_NETLINK, SOCK_RAW, NETLINK_ROUTE);
	if (fd < 0) {
		SPDK_ERRLOG("socket failed!\n");
		return -1;
	}

	/* setup local address & bind using this address. */
	bzero(&la, sizeof(la));
	la.nl_family = AF_NETLINK;
	la.nl_pid = getpid();
	bind(fd, (struct sockaddr *) &la, sizeof(la));

	/* initialize RTNETLINK request buffer. */
	bzero(&req, sizeof(req));

	/* compute the initial length of the service request. */
	ifal = sizeof(struct ifaddrmsg);

	/* add first attrib: set IP addr and RTNETLINK buffer size. */
	rta = (struct rtattr *) req.buf;
	rta->rta_type = IFA_ADDRESS;
	rta->rta_len = sizeof(struct rtattr) + 4;
	memcpy(((char *)rta) + sizeof(struct rtattr), &ip_address, sizeof(ip_address));
	ifal += rta->rta_len;

	/* add second attrib. */
	rta = (struct rtattr *)(((char *)rta) + rta->rta_len);
	rta->rta_type = IFA_LOCAL;
	rta->rta_len = sizeof(struct rtattr) + 4;
	memcpy(((char *)rta) + sizeof(struct rtattr), &ip_address, sizeof(ip_address));
	ifal += rta->rta_len;

	/* setup the NETLINK header. */
	req.n.nlmsg_len = NLMSG_LENGTH(ifal);
	if (create) {
		req.n.nlmsg_flags = NLM_F_REQUEST | NLM_F_CREATE | NLM_F_APPEND;
		req.n.nlmsg_type = RTM_NEWADDR;
	} else {
		req.n.nlmsg_flags = NLM_F_REQUEST;
		req.n.nlmsg_type = RTM_DELADDR;
	}

	/* setup the service header (struct rtmsg). */
	req.r.ifa_family = AF_INET;
	req.r.ifa_prefixlen = 32; /* hardcoded */
	req.r.ifa_flags = IFA_F_PERMANENT | IFA_F_SECONDARY;
	req.r.ifa_index = ifc_idx;
	req.r.ifa_scope = 0;

	/* create the remote address to communicate. */
	bzero(&pa, sizeof(pa));
	pa.nl_family = AF_NETLINK;

	/* initialize & create the struct msghdr supplied to the sendmsg() function. */
	bzero(&msg, sizeof(msg));
	msg.msg_name = (void *) &pa;
	msg.msg_namelen = sizeof(pa);

	/* place the pointer & size of the RTNETLINK message in the struct msghdr. */
	iov.iov_base = (void *) &req.n;
	iov.iov_len = req.n.nlmsg_len;
	msg.msg_iov = &iov;
	msg.msg_iovlen = 1;
	/* send the RTNETLINK message to kernel. */
	sendmsg(fd, &msg, 0);
	close(fd);
	return 0;
}

static void spdk_interface_ip_update(void)
{
	struct spdk_interface *ifc_entry;

	pthread_mutex_lock(&interface_lock);
	TAILQ_FOREACH(ifc_entry, &g_interface_head, tailq) {
		ifc_entry->num_ip_addresses = 0;
		memset(ifc_entry->ip_address, 0, sizeof(ifc_entry->ip_address));
	}
	spdk_get_ifc_ipv4();
	pthread_mutex_unlock(&interface_lock);
}

int
spdk_interface_init(void)
{
	int rc = 0;

	TAILQ_INIT(&g_interface_head);
	rc = spdk_prepare_ifc_list();
	if (!rc) {
		rc = spdk_get_ifc_ipv4();
	}

	return rc;
}

void
spdk_interface_destroy(void)
{
	struct spdk_interface *ifc_entry;

	while (!TAILQ_EMPTY(&g_interface_head)) {
		ifc_entry = TAILQ_FIRST(&g_interface_head);
		TAILQ_REMOVE(&g_interface_head, ifc_entry, tailq);
		free(ifc_entry);
	}
}

int
spdk_interface_add_ip_address(int ifc_index, char *ip_addr)
{
	uint32_t addr;

	addr = inet_addr(ip_addr);
	return netlink_addr_msg(ifc_index, addr, 1);
}

int
spdk_interface_delete_ip_address(int ifc_index, char *ip_addr)
{
	uint32_t addr;

	addr = inet_addr(ip_addr);
	return netlink_addr_msg(ifc_index, addr, 0);
}

void *spdk_interface_get_list(void)
{
	spdk_interface_ip_update();
	return &g_interface_head;
}

#else /* Not Linux */

int
spdk_interface_init(void)
{
	return 0;
}

void
spdk_interface_destroy(void)
{
}

int
spdk_interface_add_ip_address(int ifc_index, char *ip_addr)
{
	return -1;
}

int
spdk_interface_delete_ip_address(int ifc_index, char *ip_addr)
{
	return -1;
}

void *
spdk_interface_get_list(void)
{
	return NULL;
}

#endif