xref: /linux/net/8021q/vlanproc.c (revision e21f9e2e862e9eb3dd64eaddb6256b3e5098660f)
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 static int vlan_seq_open(struct inode *inode, struct file *file)
77 {
78 	return seq_open_net(inode, file, &vlan_seq_ops,
79 			sizeof(struct seq_net_private));
80 }
81 
82 static const struct file_operations vlan_fops = {
83 	.open    = vlan_seq_open,
84 	.read    = seq_read,
85 	.llseek  = seq_lseek,
86 	.release = seq_release_net,
87 };
88 
89 /*
90  *	/proc/net/vlan/<device> file and inode operations
91  */
92 
93 static int vlandev_seq_open(struct inode *inode, struct file *file)
94 {
95 	return single_open(file, vlandev_seq_show, PDE_DATA(inode));
96 }
97 
98 static const struct file_operations vlandev_fops = {
99 	.open    = vlandev_seq_open,
100 	.read    = seq_read,
101 	.llseek  = seq_lseek,
102 	.release = single_release,
103 };
104 
105 /*
106  * Proc filesystem directory entries.
107  */
108 
109 /* Strings */
110 static const char *const vlan_name_type_str[VLAN_NAME_TYPE_HIGHEST] = {
111     [VLAN_NAME_TYPE_RAW_PLUS_VID]        = "VLAN_NAME_TYPE_RAW_PLUS_VID",
112     [VLAN_NAME_TYPE_PLUS_VID_NO_PAD]	 = "VLAN_NAME_TYPE_PLUS_VID_NO_PAD",
113     [VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD] = "VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD",
114     [VLAN_NAME_TYPE_PLUS_VID]		 = "VLAN_NAME_TYPE_PLUS_VID",
115 };
116 /*
117  *	Interface functions
118  */
119 
120 /*
121  *	Clean up /proc/net/vlan entries
122  */
123 
124 void vlan_proc_cleanup(struct net *net)
125 {
126 	struct vlan_net *vn = net_generic(net, vlan_net_id);
127 
128 	if (vn->proc_vlan_conf)
129 		remove_proc_entry(name_conf, vn->proc_vlan_dir);
130 
131 	if (vn->proc_vlan_dir)
132 		remove_proc_entry(name_root, net->proc_net);
133 
134 	/* Dynamically added entries should be cleaned up as their vlan_device
135 	 * is removed, so we should not have to take care of it here...
136 	 */
137 }
138 
139 /*
140  *	Create /proc/net/vlan entries
141  */
142 
143 int __net_init vlan_proc_init(struct net *net)
144 {
145 	struct vlan_net *vn = net_generic(net, vlan_net_id);
146 
147 	vn->proc_vlan_dir = proc_net_mkdir(net, name_root, net->proc_net);
148 	if (!vn->proc_vlan_dir)
149 		goto err;
150 
151 	vn->proc_vlan_conf = proc_create(name_conf, S_IFREG | 0600,
152 					 vn->proc_vlan_dir, &vlan_fops);
153 	if (!vn->proc_vlan_conf)
154 		goto err;
155 	return 0;
156 
157 err:
158 	pr_err("can't create entry in proc filesystem!\n");
159 	vlan_proc_cleanup(net);
160 	return -ENOBUFS;
161 }
162 
163 /*
164  *	Add directory entry for VLAN device.
165  */
166 
167 int vlan_proc_add_dev(struct net_device *vlandev)
168 {
169 	struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
170 	struct vlan_net *vn = net_generic(dev_net(vlandev), vlan_net_id);
171 
172 	if (!strcmp(vlandev->name, name_conf))
173 		return -EINVAL;
174 	vlan->dent =
175 		proc_create_data(vlandev->name, S_IFREG | 0600,
176 				 vn->proc_vlan_dir, &vlandev_fops, vlandev);
177 	if (!vlan->dent)
178 		return -ENOBUFS;
179 	return 0;
180 }
181 
182 /*
183  *	Delete directory entry for VLAN device.
184  */
185 void vlan_proc_rem_dev(struct net_device *vlandev)
186 {
187 	/** NOTE:  This will consume the memory pointed to by dent, it seems. */
188 	proc_remove(vlan_dev_priv(vlandev)->dent);
189 	vlan_dev_priv(vlandev)->dent = NULL;
190 }
191 
192 /****** Proc filesystem entry points ****************************************/
193 
194 /*
195  * The following few functions build the content of /proc/net/vlan/config
196  */
197 
198 /* start read of /proc/net/vlan/config */
199 static void *vlan_seq_start(struct seq_file *seq, loff_t *pos)
200 	__acquires(rcu)
201 {
202 	struct net_device *dev;
203 	struct net *net = seq_file_net(seq);
204 	loff_t i = 1;
205 
206 	rcu_read_lock();
207 	if (*pos == 0)
208 		return SEQ_START_TOKEN;
209 
210 	for_each_netdev_rcu(net, dev) {
211 		if (!is_vlan_dev(dev))
212 			continue;
213 
214 		if (i++ == *pos)
215 			return dev;
216 	}
217 
218 	return  NULL;
219 }
220 
221 static void *vlan_seq_next(struct seq_file *seq, void *v, loff_t *pos)
222 {
223 	struct net_device *dev;
224 	struct net *net = seq_file_net(seq);
225 
226 	++*pos;
227 
228 	dev = v;
229 	if (v == SEQ_START_TOKEN)
230 		dev = net_device_entry(&net->dev_base_head);
231 
232 	for_each_netdev_continue_rcu(net, dev) {
233 		if (!is_vlan_dev(dev))
234 			continue;
235 
236 		return dev;
237 	}
238 
239 	return NULL;
240 }
241 
242 static void vlan_seq_stop(struct seq_file *seq, void *v)
243 	__releases(rcu)
244 {
245 	rcu_read_unlock();
246 }
247 
248 static int vlan_seq_show(struct seq_file *seq, void *v)
249 {
250 	struct net *net = seq_file_net(seq);
251 	struct vlan_net *vn = net_generic(net, vlan_net_id);
252 
253 	if (v == SEQ_START_TOKEN) {
254 		const char *nmtype = NULL;
255 
256 		seq_puts(seq, "VLAN Dev name	 | VLAN ID\n");
257 
258 		if (vn->name_type < ARRAY_SIZE(vlan_name_type_str))
259 		    nmtype =  vlan_name_type_str[vn->name_type];
260 
261 		seq_printf(seq, "Name-Type: %s\n",
262 			   nmtype ? nmtype :  "UNKNOWN");
263 	} else {
264 		const struct net_device *vlandev = v;
265 		const struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
266 
267 		seq_printf(seq, "%-15s| %d  | %s\n",  vlandev->name,
268 			   vlan->vlan_id,    vlan->real_dev->name);
269 	}
270 	return 0;
271 }
272 
273 static int vlandev_seq_show(struct seq_file *seq, void *offset)
274 {
275 	struct net_device *vlandev = (struct net_device *) seq->private;
276 	const struct vlan_dev_priv *vlan = vlan_dev_priv(vlandev);
277 	struct rtnl_link_stats64 temp;
278 	const struct rtnl_link_stats64 *stats;
279 	static const char fmt64[] = "%30s %12llu\n";
280 	int i;
281 
282 	if (!is_vlan_dev(vlandev))
283 		return 0;
284 
285 	stats = dev_get_stats(vlandev, &temp);
286 	seq_printf(seq,
287 		   "%s  VID: %d	 REORDER_HDR: %i  dev->priv_flags: %hx\n",
288 		   vlandev->name, vlan->vlan_id,
289 		   (int)(vlan->flags & 1), vlandev->priv_flags);
290 
291 	seq_printf(seq, fmt64, "total frames received", stats->rx_packets);
292 	seq_printf(seq, fmt64, "total bytes received", stats->rx_bytes);
293 	seq_printf(seq, fmt64, "Broadcast/Multicast Rcvd", stats->multicast);
294 	seq_puts(seq, "\n");
295 	seq_printf(seq, fmt64, "total frames transmitted", stats->tx_packets);
296 	seq_printf(seq, fmt64, "total bytes transmitted", stats->tx_bytes);
297 	seq_printf(seq, "Device: %s", vlan->real_dev->name);
298 	/* now show all PRIORITY mappings relating to this VLAN */
299 	seq_printf(seq, "\nINGRESS priority mappings: "
300 			"0:%u  1:%u  2:%u  3:%u  4:%u  5:%u  6:%u 7:%u\n",
301 		   vlan->ingress_priority_map[0],
302 		   vlan->ingress_priority_map[1],
303 		   vlan->ingress_priority_map[2],
304 		   vlan->ingress_priority_map[3],
305 		   vlan->ingress_priority_map[4],
306 		   vlan->ingress_priority_map[5],
307 		   vlan->ingress_priority_map[6],
308 		   vlan->ingress_priority_map[7]);
309 
310 	seq_printf(seq, " EGRESS priority mappings: ");
311 	for (i = 0; i < 16; i++) {
312 		const struct vlan_priority_tci_mapping *mp
313 			= vlan->egress_priority_map[i];
314 		while (mp) {
315 			seq_printf(seq, "%u:%hu ",
316 				   mp->priority, ((mp->vlan_qos >> 13) & 0x7));
317 			mp = mp->next;
318 		}
319 	}
320 	seq_puts(seq, "\n");
321 
322 	return 0;
323 }
324