xref: /freebsd/sbin/ifconfig/ifvlan.c (revision 9247238cc4b8835892a47701136b0fd073f8d67c)
1 /*-
2  * SPDX-License-Identifier: BSD-4-Clause
3  *
4  * Copyright (c) 1999 Bill Paul <wpaul@ctr.columbia.edu>
5  * Copyright (c) 2012 ADARA Networks, Inc.
6  * All rights reserved.
7   *
8  * Portions of this software were developed by Robert N. M. Watson under
9  * contract to ADARA Networks, Inc.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by Bill Paul.
22  * 4. Neither the name of the author nor the names of any co-contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
36  * THE POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 #include <sys/param.h>
40 #include <sys/ioctl.h>
41 #include <sys/socket.h>
42 #include <sys/sockio.h>
43 
44 #include <stdlib.h>
45 #include <unistd.h>
46 
47 #include <net/ethernet.h>
48 #include <net/if.h>
49 #include <net/if_vlan_var.h>
50 #include <net/route.h>
51 
52 #include <ctype.h>
53 #include <stdio.h>
54 #include <string.h>
55 #include <stdlib.h>
56 #include <unistd.h>
57 #include <err.h>
58 #include <errno.h>
59 
60 #include "ifconfig.h"
61 
62 #ifndef lint
63 static const char rcsid[] =
64   "$FreeBSD$";
65 #endif
66 
67 #define	NOTAG	((u_short) -1)
68 
69 static const char proto_8021Q[]  = "802.1q";
70 static const char proto_8021ad[] = "802.1ad";
71 static const char proto_qinq[] = "qinq";
72 
73 static 	struct vlanreq params = {
74 	.vlr_tag	= NOTAG,
75 	.vlr_proto	= ETHERTYPE_VLAN,
76 };
77 
78 static int
79 getvlan(int s, struct ifreq *ifr, struct vlanreq *vreq)
80 {
81 	bzero((char *)vreq, sizeof(*vreq));
82 	ifr->ifr_data = (caddr_t)vreq;
83 
84 	return ioctl(s, SIOCGETVLAN, (caddr_t)ifr);
85 }
86 
87 static void
88 vlan_status(if_ctx *ctx)
89 {
90 	struct vlanreq		vreq;
91 
92 	if (getvlan(ctx->io_s, &ifr, &vreq) == -1)
93 		return;
94 	printf("\tvlan: %d", vreq.vlr_tag);
95 	printf(" vlanproto: ");
96 	switch (vreq.vlr_proto) {
97 		case ETHERTYPE_VLAN:
98 			printf(proto_8021Q);
99 			break;
100 		case ETHERTYPE_QINQ:
101 			printf(proto_8021ad);
102 			break;
103 		default:
104 			printf("0x%04x", vreq.vlr_proto);
105 	}
106 	if (ioctl_ctx(ctx, SIOCGVLANPCP, (caddr_t)&ifr) != -1)
107 		printf(" vlanpcp: %u", ifr.ifr_vlan_pcp);
108 	printf(" parent interface: %s", vreq.vlr_parent[0] == '\0' ?
109 	    "<none>" : vreq.vlr_parent);
110 	printf("\n");
111 }
112 
113 static int
114 vlan_match_ethervid(const char *name)
115 {
116 	return (strchr(name, '.') != NULL);
117 }
118 
119 static void
120 vlan_parse_ethervid(const char *name)
121 {
122 	char ifname[IFNAMSIZ];
123 	char *cp;
124 	unsigned int vid;
125 
126 	strlcpy(ifname, name, IFNAMSIZ);
127 	if ((cp = strrchr(ifname, '.')) == NULL)
128 		return;
129 	/*
130 	 * Derive params from interface name: "parent.vid".
131 	 */
132 	*cp++ = '\0';
133 	if ((*cp < '1') || (*cp > '9'))
134 		errx(1, "invalid vlan tag");
135 
136 	vid = *cp++ - '0';
137 	while ((*cp >= '0') && (*cp <= '9')) {
138 		vid = (vid * 10) + (*cp++ - '0');
139 		if (vid >= 0xFFF)
140 			errx(1, "invalid vlan tag");
141 	}
142 	if (*cp != '\0')
143 		errx(1, "invalid vlan tag");
144 
145 	/*
146 	 * allow "devX.Y vlandev devX vlan Y" syntax
147 	 */
148 	if (params.vlr_tag == NOTAG || params.vlr_tag == vid)
149 		params.vlr_tag = vid;
150 	else
151 		errx(1, "ambiguous vlan specification");
152 
153 	/* Restrict overriding interface name */
154 	if (params.vlr_parent[0] == '\0' || !strcmp(params.vlr_parent, ifname))
155 		strlcpy(params.vlr_parent, ifname, IFNAMSIZ);
156 	else
157 		errx(1, "ambiguous vlan specification");
158 }
159 
160 static void
161 vlan_create(if_ctx *ctx, struct ifreq *ifr)
162 {
163 	vlan_parse_ethervid(ifr->ifr_name);
164 
165 	if (params.vlr_tag != NOTAG || params.vlr_parent[0] != '\0') {
166 		/*
167 		 * One or both parameters were specified, make sure both.
168 		 */
169 		if (params.vlr_tag == NOTAG)
170 			errx(1, "must specify a tag for vlan create");
171 		if (params.vlr_parent[0] == '\0')
172 			errx(1, "must specify a parent device for vlan create");
173 		ifr->ifr_data = (caddr_t) &params;
174 	}
175 	ifcreate_ioctl(ctx, ifr);
176 }
177 
178 static void
179 vlan_cb(if_ctx *ctx __unused, void *arg __unused)
180 {
181 	if ((params.vlr_tag != NOTAG) ^ (params.vlr_parent[0] != '\0'))
182 		errx(1, "both vlan and vlandev must be specified");
183 }
184 
185 static void
186 vlan_set(int s, struct ifreq *ifr)
187 {
188 	if (params.vlr_tag != NOTAG && params.vlr_parent[0] != '\0') {
189 		ifr->ifr_data = (caddr_t) &params;
190 		if (ioctl(s, SIOCSETVLAN, (caddr_t)ifr) == -1)
191 			err(1, "SIOCSETVLAN");
192 	}
193 }
194 
195 static void
196 setvlantag(if_ctx *ctx, const char *val, int dummy __unused)
197 {
198 	struct vlanreq vreq;
199 	u_long ul;
200 	char *endp;
201 
202 	ul = strtoul(val, &endp, 0);
203 	if (*endp != '\0')
204 		errx(1, "invalid value for vlan");
205 	params.vlr_tag = ul;
206 	/* check if the value can be represented in vlr_tag */
207 	if (params.vlr_tag != ul)
208 		errx(1, "value for vlan out of range");
209 
210 	if (getvlan(ctx->io_s, &ifr, &vreq) != -1) {
211 		vreq.vlr_tag = params.vlr_tag;
212 		memcpy(&params, &vreq, sizeof(params));
213 		vlan_set(ctx->io_s, &ifr);
214 	}
215 }
216 
217 static void
218 setvlandev(if_ctx *ctx, const char *val, int dummy __unused)
219 {
220 	struct vlanreq vreq;
221 
222 	strlcpy(params.vlr_parent, val, sizeof(params.vlr_parent));
223 
224 	if (getvlan(ctx->io_s, &ifr, &vreq) != -1)
225 		vlan_set(ctx->io_s, &ifr);
226 }
227 
228 static void
229 setvlanproto(if_ctx *ctx, const char *val, int dummy __unused)
230 {
231 	struct vlanreq vreq;
232 
233 	if (strncasecmp(proto_8021Q, val,
234 	    strlen(proto_8021Q)) == 0) {
235 		params.vlr_proto = ETHERTYPE_VLAN;
236 	} else if ((strncasecmp(proto_8021ad, val, strlen(proto_8021ad)) == 0)
237 	    || (strncasecmp(proto_qinq, val, strlen(proto_qinq)) == 0)) {
238 		params.vlr_proto = ETHERTYPE_QINQ;
239 	} else
240 		errx(1, "invalid value for vlanproto");
241 
242 	if (getvlan(ctx->io_s, &ifr, &vreq) != -1) {
243 		vreq.vlr_proto = params.vlr_proto;
244 		memcpy(&params, &vreq, sizeof(params));
245 		vlan_set(ctx->io_s, &ifr);
246 	}
247 }
248 
249 static void
250 setvlanpcp(if_ctx *ctx, const char *val, int dummy __unused)
251 {
252 	u_long ul;
253 	char *endp;
254 
255 	ul = strtoul(val, &endp, 0);
256 	if (*endp != '\0')
257 		errx(1, "invalid value for vlanpcp");
258 	if (ul > 7)
259 		errx(1, "value for vlanpcp out of range");
260 	ifr.ifr_vlan_pcp = ul;
261 	if (ioctl(ctx->io_s, SIOCSVLANPCP, (caddr_t)&ifr) == -1)
262 		err(1, "SIOCSVLANPCP");
263 }
264 
265 static void
266 unsetvlandev(if_ctx *ctx, const char *val __unused, int dummy __unused)
267 {
268 	struct vlanreq		vreq;
269 
270 	bzero((char *)&vreq, sizeof(struct vlanreq));
271 	ifr.ifr_data = (caddr_t)&vreq;
272 
273 	if (ioctl(ctx->io_s, SIOCGETVLAN, (caddr_t)&ifr) == -1)
274 		err(1, "SIOCGETVLAN");
275 
276 	bzero((char *)&vreq.vlr_parent, sizeof(vreq.vlr_parent));
277 	vreq.vlr_tag = 0;
278 
279 	if (ioctl(ctx->io_s, SIOCSETVLAN, (caddr_t)&ifr) == -1)
280 		err(1, "SIOCSETVLAN");
281 }
282 
283 static struct cmd vlan_cmds[] = {
284 	DEF_CLONE_CMD_ARG("vlan",			setvlantag),
285 	DEF_CLONE_CMD_ARG("vlandev",			setvlandev),
286 	DEF_CLONE_CMD_ARG("vlanproto",			setvlanproto),
287 	DEF_CMD_ARG("vlanpcp",				setvlanpcp),
288 	/* NB: non-clone cmds */
289 	DEF_CMD_ARG("vlan",				setvlantag),
290 	DEF_CMD_ARG("vlandev",				setvlandev),
291 	DEF_CMD_ARG("vlanproto",			setvlanproto),
292 	/* XXX For compatibility.  Should become DEF_CMD() some day. */
293 	DEF_CMD_OPTARG("-vlandev",			unsetvlandev),
294 	DEF_CMD("vlanmtu",	IFCAP_VLAN_MTU,		setifcap),
295 	DEF_CMD("-vlanmtu",	-IFCAP_VLAN_MTU,	setifcap),
296 	DEF_CMD("vlanhwtag",	IFCAP_VLAN_HWTAGGING,	setifcap),
297 	DEF_CMD("-vlanhwtag",	-IFCAP_VLAN_HWTAGGING,	setifcap),
298 	DEF_CMD("vlanhwfilter",	IFCAP_VLAN_HWFILTER,	setifcap),
299 	DEF_CMD("-vlanhwfilter", -IFCAP_VLAN_HWFILTER,	setifcap),
300 	DEF_CMD("-vlanhwtso",	-IFCAP_VLAN_HWTSO,	setifcap),
301 	DEF_CMD("vlanhwtso",	IFCAP_VLAN_HWTSO,	setifcap),
302 	DEF_CMD("vlanhwcsum",	IFCAP_VLAN_HWCSUM,	setifcap),
303 	DEF_CMD("-vlanhwcsum",	-IFCAP_VLAN_HWCSUM,	setifcap),
304 };
305 static struct afswtch af_vlan = {
306 	.af_name	= "af_vlan",
307 	.af_af		= AF_UNSPEC,
308 	.af_other_status = vlan_status,
309 };
310 
311 static __constructor void
312 vlan_ctor(void)
313 {
314 	size_t i;
315 
316 	for (i = 0; i < nitems(vlan_cmds);  i++)
317 		cmd_register(&vlan_cmds[i]);
318 	af_register(&af_vlan);
319 	callback_register(vlan_cb, NULL);
320 	clone_setdefcallback_prefix("vlan", vlan_create);
321 	clone_setdefcallback_filter(vlan_match_ethervid, vlan_create);
322 }
323