xref: /freebsd/sbin/ifconfig/ifvlan.c (revision cd8537910406e68d4719136a5b0cf6d23bb1b23b)
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 
72 static 	struct vlanreq params = {
73 	.vlr_tag	= NOTAG,
74 	.vlr_proto	= ETHERTYPE_VLAN,
75 };
76 
77 static int
78 getvlan(int s, struct ifreq *ifr, struct vlanreq *vreq)
79 {
80 	bzero((char *)vreq, sizeof(*vreq));
81 	ifr->ifr_data = (caddr_t)vreq;
82 
83 	return ioctl(s, SIOCGETVLAN, (caddr_t)ifr);
84 }
85 
86 static void
87 vlan_status(int s)
88 {
89 	struct vlanreq		vreq;
90 
91 	if (getvlan(s, &ifr, &vreq) == -1)
92 		return;
93 	printf("\tvlan: %d", vreq.vlr_tag);
94 	printf(" vlanproto: ");
95 	switch (vreq.vlr_proto) {
96 		case ETHERTYPE_VLAN:
97 			printf(proto_8021Q);
98 			break;
99 		case ETHERTYPE_QINQ:
100 			printf(proto_8021ad);
101 			break;
102 		default:
103 			printf("0x%04x", vreq.vlr_proto);
104 	}
105 	if (ioctl(s, SIOCGVLANPCP, (caddr_t)&ifr) != -1)
106 		printf(" vlanpcp: %u", ifr.ifr_vlan_pcp);
107 	printf(" parent interface: %s", vreq.vlr_parent[0] == '\0' ?
108 	    "<none>" : vreq.vlr_parent);
109 	printf("\n");
110 }
111 
112 static int
113 vlan_match_ethervid(const char *name)
114 {
115 	return (strchr(name, '.') != NULL);
116 }
117 
118 static void
119 vlan_parse_ethervid(const char *name)
120 {
121 	char ifname[IFNAMSIZ];
122 	char *cp;
123 	int vid;
124 
125 	strlcpy(ifname, name, IFNAMSIZ);
126 	if ((cp = strrchr(ifname, '.')) == NULL)
127 		return;
128 	/*
129 	 * Don't mix vlan/vlandev parameters with dot notation.
130 	 */
131 	if (params.vlr_tag != NOTAG || params.vlr_parent[0] != '\0')
132 		errx(1, "ambiguous vlan specification");
133 	/*
134 	 * Derive params from interface name: "parent.vid".
135 	 */
136 	*cp++ = '\0';
137 	if ((*cp < '1') || (*cp > '9'))
138 		errx(1, "invalid vlan tag");
139 
140 	vid = *cp++ - '0';
141 	while ((*cp >= '0') && (*cp <= '9'))
142 		vid = (vid * 10) + (*cp++ - '0');
143 	if ((*cp != '\0') || (vid & ~0xFFF))
144 		errx(1, "invalid vlan tag");
145 
146 	strlcpy(params.vlr_parent, ifname, IFNAMSIZ);
147 	params.vlr_tag = (vid & 0xFFF);
148 }
149 
150 static void
151 vlan_create(int s, struct ifreq *ifr)
152 {
153 	vlan_parse_ethervid(ifr->ifr_name);
154 
155 	if (params.vlr_tag != NOTAG || params.vlr_parent[0] != '\0') {
156 		/*
157 		 * One or both parameters were specified, make sure both.
158 		 */
159 		if (params.vlr_tag == NOTAG)
160 			errx(1, "must specify a tag for vlan create");
161 		if (params.vlr_parent[0] == '\0')
162 			errx(1, "must specify a parent device for vlan create");
163 		ifr->ifr_data = (caddr_t) &params;
164 	}
165 	ioctl_ifcreate(s, ifr);
166 }
167 
168 static void
169 vlan_cb(int s, void *arg)
170 {
171 	if ((params.vlr_tag != NOTAG) ^ (params.vlr_parent[0] != '\0'))
172 		errx(1, "both vlan and vlandev must be specified");
173 }
174 
175 static void
176 vlan_set(int s, struct ifreq *ifr)
177 {
178 	if (params.vlr_tag != NOTAG && params.vlr_parent[0] != '\0') {
179 		ifr->ifr_data = (caddr_t) &params;
180 		if (ioctl(s, SIOCSETVLAN, (caddr_t)ifr) == -1)
181 			err(1, "SIOCSETVLAN");
182 	}
183 }
184 
185 static
186 DECL_CMD_FUNC(setvlantag, val, d)
187 {
188 	struct vlanreq vreq;
189 	u_long ul;
190 	char *endp;
191 
192 	ul = strtoul(val, &endp, 0);
193 	if (*endp != '\0')
194 		errx(1, "invalid value for vlan");
195 	params.vlr_tag = ul;
196 	/* check if the value can be represented in vlr_tag */
197 	if (params.vlr_tag != ul)
198 		errx(1, "value for vlan out of range");
199 
200 	if (getvlan(s, &ifr, &vreq) != -1)
201 		vlan_set(s, &ifr);
202 }
203 
204 static
205 DECL_CMD_FUNC(setvlandev, val, d)
206 {
207 	struct vlanreq vreq;
208 
209 	strlcpy(params.vlr_parent, val, sizeof(params.vlr_parent));
210 
211 	if (getvlan(s, &ifr, &vreq) != -1)
212 		vlan_set(s, &ifr);
213 }
214 
215 static
216 DECL_CMD_FUNC(setvlanproto, val, d)
217 {
218 	struct vlanreq vreq;
219 
220 	if (strncasecmp(proto_8021Q, val,
221 	    strlen(proto_8021Q)) == 0) {
222 		params.vlr_proto = ETHERTYPE_VLAN;
223 	} else if (strncasecmp(proto_8021ad, val,
224 	           strlen(proto_8021ad)) == 0) {
225 		params.vlr_proto = ETHERTYPE_QINQ;
226 	} else
227 		errx(1, "invalid value for vlanproto");
228 
229 	if (getvlan(s, &ifr, &vreq) != -1)
230 		vlan_set(s, &ifr);
231 }
232 
233 static
234 DECL_CMD_FUNC(setvlanpcp, val, d)
235 {
236 	u_long ul;
237 	char *endp;
238 
239 	ul = strtoul(val, &endp, 0);
240 	if (*endp != '\0')
241 		errx(1, "invalid value for vlanpcp");
242 	if (ul > 7)
243 		errx(1, "value for vlanpcp out of range");
244 	ifr.ifr_vlan_pcp = ul;
245 	if (ioctl(s, SIOCSVLANPCP, (caddr_t)&ifr) == -1)
246 		err(1, "SIOCSVLANPCP");
247 }
248 
249 static
250 DECL_CMD_FUNC(unsetvlandev, val, d)
251 {
252 	struct vlanreq		vreq;
253 
254 	bzero((char *)&vreq, sizeof(struct vlanreq));
255 	ifr.ifr_data = (caddr_t)&vreq;
256 
257 	if (ioctl(s, SIOCGETVLAN, (caddr_t)&ifr) == -1)
258 		err(1, "SIOCGETVLAN");
259 
260 	bzero((char *)&vreq.vlr_parent, sizeof(vreq.vlr_parent));
261 	vreq.vlr_tag = 0;
262 
263 	if (ioctl(s, SIOCSETVLAN, (caddr_t)&ifr) == -1)
264 		err(1, "SIOCSETVLAN");
265 }
266 
267 static struct cmd vlan_cmds[] = {
268 	DEF_CLONE_CMD_ARG("vlan",			setvlantag),
269 	DEF_CLONE_CMD_ARG("vlandev",			setvlandev),
270 	DEF_CLONE_CMD_ARG("vlanproto",			setvlanproto),
271 	DEF_CMD_ARG("vlanpcp",				setvlanpcp),
272 	/* NB: non-clone cmds */
273 	DEF_CMD_ARG("vlan",				setvlantag),
274 	DEF_CMD_ARG("vlandev",				setvlandev),
275 	DEF_CMD_ARG("vlanproto",			setvlanproto),
276 	/* XXX For compatibility.  Should become DEF_CMD() some day. */
277 	DEF_CMD_OPTARG("-vlandev",			unsetvlandev),
278 	DEF_CMD("vlanmtu",	IFCAP_VLAN_MTU,		setifcap),
279 	DEF_CMD("-vlanmtu",	-IFCAP_VLAN_MTU,	setifcap),
280 	DEF_CMD("vlanhwtag",	IFCAP_VLAN_HWTAGGING,	setifcap),
281 	DEF_CMD("-vlanhwtag",	-IFCAP_VLAN_HWTAGGING,	setifcap),
282 	DEF_CMD("vlanhwfilter",	IFCAP_VLAN_HWFILTER,	setifcap),
283 	DEF_CMD("-vlanhwfilter", -IFCAP_VLAN_HWFILTER,	setifcap),
284 	DEF_CMD("-vlanhwtso",	-IFCAP_VLAN_HWTSO,	setifcap),
285 	DEF_CMD("vlanhwtso",	IFCAP_VLAN_HWTSO,	setifcap),
286 	DEF_CMD("vlanhwcsum",	IFCAP_VLAN_HWCSUM,	setifcap),
287 	DEF_CMD("-vlanhwcsum",	-IFCAP_VLAN_HWCSUM,	setifcap),
288 };
289 static struct afswtch af_vlan = {
290 	.af_name	= "af_vlan",
291 	.af_af		= AF_UNSPEC,
292 	.af_other_status = vlan_status,
293 };
294 
295 static __constructor void
296 vlan_ctor(void)
297 {
298 	size_t i;
299 
300 	for (i = 0; i < nitems(vlan_cmds);  i++)
301 		cmd_register(&vlan_cmds[i]);
302 	af_register(&af_vlan);
303 	callback_register(vlan_cb, NULL);
304 	clone_setdefcallback_prefix("vlan", vlan_create);
305 	clone_setdefcallback_filter(vlan_match_ethervid, vlan_create);
306 }
307