xref: /linux/net/8021q/vlanproc.c (revision 680e6ffa15103ab610c0fc1241d2f98c801b13e2)
1 /******************************************************************************
2  * vlanproc.c	VLAN Module. /proc filesystem interface.
3  *
4  *		This module is completely hardware-independent and provides
5  *		access to the router using Linux /proc filesystem.
6  *
7  * Author:	Ben Greear, <greearb@candelatech.com> coppied from wanproc.c
8  *               by: Gene Kozin	<genek@compuserve.com>
9  *
10  * Copyright:	(c) 1998 Ben Greear
11  *
12  *		This program is free software; you can redistribute it and/or
13  *		modify it under the terms of the GNU General Public License
14  *		as published by the Free Software Foundation; either version
15  *		2 of the License, or (at your option) any later version.
16  * ============================================================================
17  * Jan 20, 1998        Ben Greear     Initial Version
18  *****************************************************************************/
19 
20 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
21 
22 #include <linux/module.h>
23 #include <linux/errno.h>
24 #include <linux/kernel.h>
25 #include <linux/string.h>
26 #include <linux/proc_fs.h>
27 #include <linux/seq_file.h>
28 #include <linux/fs.h>
29 #include <linux/netdevice.h>
30 #include <linux/if_vlan.h>
31 #include <net/net_namespace.h>
32 #include <net/netns/generic.h>
33 #include "vlanproc.h"
34 #include "vlan.h"
35 
36 /****** Function Prototypes *************************************************/
37 
38 /* Methods for preparing data for reading proc entries */
39 static int vlan_seq_show(struct seq_file *seq, void *v);
40 static void *vlan_seq_start(struct seq_file *seq, loff_t *pos);
41 static void *vlan_seq_next(struct seq_file *seq, void *v, loff_t *pos);
42 static void vlan_seq_stop(struct seq_file *seq, void *);
43 static int vlandev_seq_show(struct seq_file *seq, void *v);
44 
45 /*
46  *	Global Data
47  */
48 
49 
50 /*
51  *	Names of the proc directory entries
52  */
53 
54 static const char name_root[]	 = "vlan";
55 static const char name_conf[]	 = "config";
56 
57 /*
58  *	Structures for interfacing with the /proc filesystem.
59  *	VLAN creates its own directory /proc/net/vlan with the following
60  *	entries:
61  *	config		device status/configuration
62  *	<device>	entry for each  device
63  */
64 
65 /*
66  *	Generic /proc/net/vlan/<file> file and inode operations
67  */
68 
69 static const struct seq_operations vlan_seq_ops = {
70 	.start = vlan_seq_start,
71 	.next = vlan_seq_next,
72 	.stop = vlan_seq_stop,
73 	.show = vlan_seq_show,
74 };
75 
76 /*
77  * Proc filesystem directory entries.
78  */
79 
80 /* Strings */
81 static const char *const vlan_name_type_str[VLAN_NAME_TYPE_HIGHEST] = {
82     [VLAN_NAME_TYPE_RAW_PLUS_VID]        = "VLAN_NAME_TYPE_RAW_PLUS_VID",
83     [VLAN_NAME_TYPE_PLUS_VID_NO_PAD]	 = "VLAN_NAME_TYPE_PLUS_VID_NO_PAD",
84     [VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD] = "VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD",
85     [VLAN_NAME_TYPE_PLUS_VID]		 = "VLAN_NAME_TYPE_PLUS_VID",
86 };
87 /*
88  *	Interface functions
89  */
90 
91 /*
92  *	Clean up /proc/net/vlan entries
93  */
94 
95 void vlan_proc_cleanup(struct net *net)
96 {
97 	struct vlan_net *vn = net_generic(net, vlan_net_id);
98 
99 	if (vn->proc_vlan_conf)
100 		remove_proc_entry(name_conf, vn->proc_vlan_dir);
101 
102 	if (vn->proc_vlan_dir)
103 		remove_proc_entry(name_root, net->proc_net);
104 
105 	/* Dynamically added entries should be cleaned up as their vlan_device
106 	 * is removed, so we should not have to take care of it here...
107 	 */
108 }
109 
110 /*
111  *	Create /proc/net/vlan entries
112  */
113 
114 int __net_init vlan_proc_init(struct net *net)
115 {
116 	struct vlan_net *vn = net_generic(net, vlan_net_id);
117 
118 	vn->proc_vlan_dir = proc_net_mkdir(net, name_root, net->proc_net);
119 	if (!vn->proc_vlan_dir)
120 		goto err;
121 
122 	vn->proc_vlan_conf = proc_create_net(name_conf, S_IFREG | 0600,
123 			vn->proc_vlan_dir, &vlan_seq_ops,
124 			sizeof(struct seq_net_private));
125 	if (!vn->proc_vlan_conf)
126 		goto err;
127 	return 0;
128 
129 err:
130 	pr_err("can't create entry in proc filesystem!\n");
131 	vlan_proc_cleanup(net);
132 	return -ENOBUFS;
133 }
134 
135 /*
136  *	Add directory entry for VLAN device.
137  */
138 
139 int vlan_proc_add_dev(struct net_device *vlandev)
140 {
141 	struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
142 	struct vlan_net *vn = net_generic(dev_net(vlandev), vlan_net_id);
143 
144 	if (!strcmp(vlandev->name, name_conf))
145 		return -EINVAL;
146 	vlan->dent = proc_create_single_data(vlandev->name, S_IFREG | 0600,
147 			vn->proc_vlan_dir, vlandev_seq_show, vlandev);
148 	if (!vlan->dent)
149 		return -ENOBUFS;
150 	return 0;
151 }
152 
153 /*
154  *	Delete directory entry for VLAN device.
155  */
156 void vlan_proc_rem_dev(struct net_device *vlandev)
157 {
158 	/** NOTE:  This will consume the memory pointed to by dent, it seems. */
159 	proc_remove(vlan_dev_priv(vlandev)->dent);
160 	vlan_dev_priv(vlandev)->dent = NULL;
161 }
162 
163 /****** Proc filesystem entry points ****************************************/
164 
165 /*
166  * The following few functions build the content of /proc/net/vlan/config
167  */
168 
169 /* start read of /proc/net/vlan/config */
170 static void *vlan_seq_start(struct seq_file *seq, loff_t *pos)
171 	__acquires(rcu)
172 {
173 	struct net_device *dev;
174 	struct net *net = seq_file_net(seq);
175 	loff_t i = 1;
176 
177 	rcu_read_lock();
178 	if (*pos == 0)
179 		return SEQ_START_TOKEN;
180 
181 	for_each_netdev_rcu(net, dev) {
182 		if (!is_vlan_dev(dev))
183 			continue;
184 
185 		if (i++ == *pos)
186 			return dev;
187 	}
188 
189 	return  NULL;
190 }
191 
192 static void *vlan_seq_next(struct seq_file *seq, void *v, loff_t *pos)
193 {
194 	struct net_device *dev;
195 	struct net *net = seq_file_net(seq);
196 
197 	++*pos;
198 
199 	dev = v;
200 	if (v == SEQ_START_TOKEN)
201 		dev = net_device_entry(&net->dev_base_head);
202 
203 	for_each_netdev_continue_rcu(net, dev) {
204 		if (!is_vlan_dev(dev))
205 			continue;
206 
207 		return dev;
208 	}
209 
210 	return NULL;
211 }
212 
213 static void vlan_seq_stop(struct seq_file *seq, void *v)
214 	__releases(rcu)
215 {
216 	rcu_read_unlock();
217 }
218 
219 static int vlan_seq_show(struct seq_file *seq, void *v)
220 {
221 	struct net *net = seq_file_net(seq);
222 	struct vlan_net *vn = net_generic(net, vlan_net_id);
223 
224 	if (v == SEQ_START_TOKEN) {
225 		const char *nmtype = NULL;
226 
227 		seq_puts(seq, "VLAN Dev name	 | VLAN ID\n");
228 
229 		if (vn->name_type < ARRAY_SIZE(vlan_name_type_str))
230 		    nmtype =  vlan_name_type_str[vn->name_type];
231 
232 		seq_printf(seq, "Name-Type: %s\n",
233 			   nmtype ? nmtype :  "UNKNOWN");
234 	} else {
235 		const struct net_device *vlandev = v;
236 		const struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
237 
238 		seq_printf(seq, "%-15s| %d  | %s\n",  vlandev->name,
239 			   vlan->vlan_id,    vlan->real_dev->name);
240 	}
241 	return 0;
242 }
243 
244 static int vlandev_seq_show(struct seq_file *seq, void *offset)
245 {
246 	struct net_device *vlandev = (struct net_device *) seq->private;
247 	const struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
248 	struct rtnl_link_stats64 temp;
249 	const struct rtnl_link_stats64 *stats;
250 	static const char fmt64[] = "%30s %12llu\n";
251 	int i;
252 
253 	if (!is_vlan_dev(vlandev))
254 		return 0;
255 
256 	stats = dev_get_stats(vlandev, &temp);
257 	seq_printf(seq,
258 		   "%s  VID: %d	 REORDER_HDR: %i  dev->priv_flags: %hx\n",
259 		   vlandev->name, vlan->vlan_id,
260 		   (int)(vlan->flags & 1), vlandev->priv_flags);
261 
262 	seq_printf(seq, fmt64, "total frames received", stats->rx_packets);
263 	seq_printf(seq, fmt64, "total bytes received", stats->rx_bytes);
264 	seq_printf(seq, fmt64, "Broadcast/Multicast Rcvd", stats->multicast);
265 	seq_puts(seq, "\n");
266 	seq_printf(seq, fmt64, "total frames transmitted", stats->tx_packets);
267 	seq_printf(seq, fmt64, "total bytes transmitted", stats->tx_bytes);
268 	seq_printf(seq, "Device: %s", vlan->real_dev->name);
269 	/* now show all PRIORITY mappings relating to this VLAN */
270 	seq_printf(seq, "\nINGRESS priority mappings: "
271 			"0:%u  1:%u  2:%u  3:%u  4:%u  5:%u  6:%u 7:%u\n",
272 		   vlan->ingress_priority_map[0],
273 		   vlan->ingress_priority_map[1],
274 		   vlan->ingress_priority_map[2],
275 		   vlan->ingress_priority_map[3],
276 		   vlan->ingress_priority_map[4],
277 		   vlan->ingress_priority_map[5],
278 		   vlan->ingress_priority_map[6],
279 		   vlan->ingress_priority_map[7]);
280 
281 	seq_printf(seq, " EGRESS priority mappings: ");
282 	for (i = 0; i < 16; i++) {
283 		const struct vlan_priority_tci_mapping *mp
284 			= vlan->egress_priority_map[i];
285 		while (mp) {
286 			seq_printf(seq, "%u:%hu ",
287 				   mp->priority, ((mp->vlan_qos >> 13) & 0x7));
288 			mp = mp->next;
289 		}
290 	}
291 	seq_puts(seq, "\n");
292 
293 	return 0;
294 }
295