xref: /openbmc/linux/drivers/net/loopback.c (revision e2c75e76)
1 /*
2  * INET		An implementation of the TCP/IP protocol suite for the LINUX
3  *		operating system.  INET is implemented using the  BSD Socket
4  *		interface as the means of communication with the user level.
5  *
6  *		Pseudo-driver for the loopback interface.
7  *
8  * Version:	@(#)loopback.c	1.0.4b	08/16/93
9  *
10  * Authors:	Ross Biro
11  *		Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
12  *		Donald Becker, <becker@scyld.com>
13  *
14  *		Alan Cox	:	Fixed oddments for NET3.014
15  *		Alan Cox	:	Rejig for NET3.029 snap #3
16  *		Alan Cox	:	Fixed NET3.029 bugs and sped up
17  *		Larry McVoy	:	Tiny tweak to double performance
18  *		Alan Cox	:	Backed out LMV's tweak - the linux mm
19  *					can't take it...
20  *              Michael Griffith:       Don't bother computing the checksums
21  *                                      on packets received on the loopback
22  *                                      interface.
23  *		Alexey Kuznetsov:	Potential hang under some extreme
24  *					cases removed.
25  *
26  *		This program is free software; you can redistribute it and/or
27  *		modify it under the terms of the GNU General Public License
28  *		as published by the Free Software Foundation; either version
29  *		2 of the License, or (at your option) any later version.
30  */
31 #include <linux/kernel.h>
32 #include <linux/jiffies.h>
33 #include <linux/module.h>
34 #include <linux/interrupt.h>
35 #include <linux/fs.h>
36 #include <linux/types.h>
37 #include <linux/string.h>
38 #include <linux/socket.h>
39 #include <linux/errno.h>
40 #include <linux/fcntl.h>
41 #include <linux/in.h>
42 
43 #include <linux/uaccess.h>
44 #include <linux/io.h>
45 
46 #include <linux/inet.h>
47 #include <linux/netdevice.h>
48 #include <linux/etherdevice.h>
49 #include <linux/skbuff.h>
50 #include <linux/ethtool.h>
51 #include <net/sock.h>
52 #include <net/checksum.h>
53 #include <linux/if_ether.h>	/* For the statistics structure. */
54 #include <linux/if_arp.h>	/* For ARPHRD_ETHER */
55 #include <linux/ip.h>
56 #include <linux/tcp.h>
57 #include <linux/percpu.h>
58 #include <linux/net_tstamp.h>
59 #include <net/net_namespace.h>
60 #include <linux/u64_stats_sync.h>
61 
62 struct pcpu_lstats {
63 	u64			packets;
64 	u64			bytes;
65 	struct u64_stats_sync	syncp;
66 };
67 
68 /* The higher levels take care of making this non-reentrant (it's
69  * called with bh's disabled).
70  */
71 static netdev_tx_t loopback_xmit(struct sk_buff *skb,
72 				 struct net_device *dev)
73 {
74 	struct pcpu_lstats *lb_stats;
75 	int len;
76 
77 	skb_tx_timestamp(skb);
78 	skb_orphan(skb);
79 
80 	/* Before queueing this packet to netif_rx(),
81 	 * make sure dst is refcounted.
82 	 */
83 	skb_dst_force(skb);
84 
85 	skb->protocol = eth_type_trans(skb, dev);
86 
87 	/* it's OK to use per_cpu_ptr() because BHs are off */
88 	lb_stats = this_cpu_ptr(dev->lstats);
89 
90 	len = skb->len;
91 	if (likely(netif_rx(skb) == NET_RX_SUCCESS)) {
92 		u64_stats_update_begin(&lb_stats->syncp);
93 		lb_stats->bytes += len;
94 		lb_stats->packets++;
95 		u64_stats_update_end(&lb_stats->syncp);
96 	}
97 
98 	return NETDEV_TX_OK;
99 }
100 
101 static void loopback_get_stats64(struct net_device *dev,
102 				 struct rtnl_link_stats64 *stats)
103 {
104 	u64 bytes = 0;
105 	u64 packets = 0;
106 	int i;
107 
108 	for_each_possible_cpu(i) {
109 		const struct pcpu_lstats *lb_stats;
110 		u64 tbytes, tpackets;
111 		unsigned int start;
112 
113 		lb_stats = per_cpu_ptr(dev->lstats, i);
114 		do {
115 			start = u64_stats_fetch_begin_irq(&lb_stats->syncp);
116 			tbytes = lb_stats->bytes;
117 			tpackets = lb_stats->packets;
118 		} while (u64_stats_fetch_retry_irq(&lb_stats->syncp, start));
119 		bytes   += tbytes;
120 		packets += tpackets;
121 	}
122 	stats->rx_packets = packets;
123 	stats->tx_packets = packets;
124 	stats->rx_bytes   = bytes;
125 	stats->tx_bytes   = bytes;
126 }
127 
128 static u32 always_on(struct net_device *dev)
129 {
130 	return 1;
131 }
132 
133 static int loopback_get_ts_info(struct net_device *netdev,
134 				struct ethtool_ts_info *ts_info)
135 {
136 	ts_info->so_timestamping = SOF_TIMESTAMPING_TX_SOFTWARE |
137 				   SOF_TIMESTAMPING_RX_SOFTWARE |
138 				   SOF_TIMESTAMPING_SOFTWARE;
139 
140 	ts_info->phc_index = -1;
141 
142 	return 0;
143 };
144 
145 static const struct ethtool_ops loopback_ethtool_ops = {
146 	.get_link		= always_on,
147 	.get_ts_info		= loopback_get_ts_info,
148 };
149 
150 static int loopback_dev_init(struct net_device *dev)
151 {
152 	dev->lstats = netdev_alloc_pcpu_stats(struct pcpu_lstats);
153 	if (!dev->lstats)
154 		return -ENOMEM;
155 	return 0;
156 }
157 
158 static void loopback_dev_free(struct net_device *dev)
159 {
160 	dev_net(dev)->loopback_dev = NULL;
161 	free_percpu(dev->lstats);
162 }
163 
164 static const struct net_device_ops loopback_ops = {
165 	.ndo_init        = loopback_dev_init,
166 	.ndo_start_xmit  = loopback_xmit,
167 	.ndo_get_stats64 = loopback_get_stats64,
168 	.ndo_set_mac_address = eth_mac_addr,
169 };
170 
171 /* The loopback device is special. There is only one instance
172  * per network namespace.
173  */
174 static void loopback_setup(struct net_device *dev)
175 {
176 	dev->mtu		= 64 * 1024;
177 	dev->hard_header_len	= ETH_HLEN;	/* 14	*/
178 	dev->min_header_len	= ETH_HLEN;	/* 14	*/
179 	dev->addr_len		= ETH_ALEN;	/* 6	*/
180 	dev->type		= ARPHRD_LOOPBACK;	/* 0x0001*/
181 	dev->flags		= IFF_LOOPBACK;
182 	dev->priv_flags		|= IFF_LIVE_ADDR_CHANGE | IFF_NO_QUEUE;
183 	netif_keep_dst(dev);
184 	dev->hw_features	= NETIF_F_GSO_SOFTWARE;
185 	dev->features		= NETIF_F_SG | NETIF_F_FRAGLIST
186 		| NETIF_F_GSO_SOFTWARE
187 		| NETIF_F_HW_CSUM
188 		| NETIF_F_RXCSUM
189 		| NETIF_F_SCTP_CRC
190 		| NETIF_F_HIGHDMA
191 		| NETIF_F_LLTX
192 		| NETIF_F_NETNS_LOCAL
193 		| NETIF_F_VLAN_CHALLENGED
194 		| NETIF_F_LOOPBACK;
195 	dev->ethtool_ops	= &loopback_ethtool_ops;
196 	dev->header_ops		= &eth_header_ops;
197 	dev->netdev_ops		= &loopback_ops;
198 	dev->needs_free_netdev	= true;
199 	dev->priv_destructor	= loopback_dev_free;
200 }
201 
202 /* Setup and register the loopback device. */
203 static __net_init int loopback_net_init(struct net *net)
204 {
205 	struct net_device *dev;
206 	int err;
207 
208 	err = -ENOMEM;
209 	dev = alloc_netdev(0, "lo", NET_NAME_UNKNOWN, loopback_setup);
210 	if (!dev)
211 		goto out;
212 
213 	dev_net_set(dev, net);
214 	err = register_netdev(dev);
215 	if (err)
216 		goto out_free_netdev;
217 
218 	BUG_ON(dev->ifindex != LOOPBACK_IFINDEX);
219 	net->loopback_dev = dev;
220 	return 0;
221 
222 out_free_netdev:
223 	free_netdev(dev);
224 out:
225 	if (net_eq(net, &init_net))
226 		panic("loopback: Failed to register netdevice: %d\n", err);
227 	return err;
228 }
229 
230 /* Registered in net/core/dev.c */
231 struct pernet_operations __net_initdata loopback_net_ops = {
232 	.init = loopback_net_init,
233 };
234