Commit | Line | Data |
---|---|---|
09c434b8 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
1da177e4 LT |
2 | /* dummy.c: a dummy net driver |
3 | ||
4 | The purpose of this driver is to provide a device to point a | |
5 | route through, but not to actually transmit packets. | |
6 | ||
7 | Why? If you have a machine whose only connection is an occasional | |
8 | PPP/SLIP/PLIP link, you can only connect to your own hostname | |
9 | when the link is up. Otherwise you have to use localhost. | |
10 | This isn't very consistent. | |
11 | ||
12 | One solution is to set up a dummy link using PPP/SLIP/PLIP, | |
13 | but this seems (to me) too much overhead for too little gain. | |
14 | This driver provides a small alternative. Thus you can do | |
6aa20a22 | 15 | |
1da177e4 LT |
16 | [when not running slip] |
17 | ifconfig dummy slip.addr.ess.here up | |
18 | [to go to slip] | |
19 | ifconfig dummy down | |
20 | dip whatever | |
21 | ||
22 | This was written by looking at Donald Becker's skeleton driver | |
23 | and the loopback driver. I then threw away anything that didn't | |
24 | apply! Thanks to Alan Cox for the key clue on what to do with | |
25 | misguided packets. | |
26 | ||
27 | Nick Holloway, 27th May 1994 | |
28 | [I tweaked this explanation a little but that's all] | |
29 | Alan Cox, 30th May 1994 | |
30 | */ | |
31 | ||
1da177e4 LT |
32 | #include <linux/module.h> |
33 | #include <linux/kernel.h> | |
34 | #include <linux/netdevice.h> | |
35 | #include <linux/etherdevice.h> | |
abe9fd57 | 36 | #include <linux/ethtool.h> |
1da177e4 LT |
37 | #include <linux/init.h> |
38 | #include <linux/moduleparam.h> | |
206c9fb2 | 39 | #include <linux/rtnetlink.h> |
6df014cf | 40 | #include <linux/net_tstamp.h> |
5d5cb173 | 41 | #include <net/rtnetlink.h> |
6d81f41c | 42 | #include <linux/u64_stats_sync.h> |
206c9fb2 | 43 | |
c19be735 | 44 | #define DRV_NAME "dummy" |
c19be735 | 45 | |
1da177e4 LT |
46 | static int numdummies = 1; |
47 | ||
1da177e4 LT |
48 | /* fake multicast ability */ |
49 | static void set_multicast_list(struct net_device *dev) | |
50 | { | |
51 | } | |
52 | ||
bc1f4470 | 53 | static void dummy_get_stats64(struct net_device *dev, |
54 | struct rtnl_link_stats64 *stats) | |
6d81f41c | 55 | { |
4a43b1f9 | 56 | dev_lstats_read(dev, &stats->tx_packets, &stats->tx_bytes); |
6d81f41c | 57 | } |
424efe9c SH |
58 | |
59 | static netdev_tx_t dummy_xmit(struct sk_buff *skb, struct net_device *dev) | |
60 | { | |
4a43b1f9 | 61 | dev_lstats_add(dev, skb->len); |
424efe9c | 62 | |
6df014cf | 63 | skb_tx_timestamp(skb); |
424efe9c SH |
64 | dev_kfree_skb(skb); |
65 | return NETDEV_TX_OK; | |
66 | } | |
67 | ||
6d81f41c ED |
68 | static int dummy_dev_init(struct net_device *dev) |
69 | { | |
4a43b1f9 ED |
70 | dev->lstats = netdev_alloc_pcpu_stats(struct pcpu_lstats); |
71 | if (!dev->lstats) | |
6d81f41c ED |
72 | return -ENOMEM; |
73 | ||
74 | return 0; | |
75 | } | |
76 | ||
890fdf2a | 77 | static void dummy_dev_uninit(struct net_device *dev) |
6d81f41c | 78 | { |
4a43b1f9 | 79 | free_percpu(dev->lstats); |
6d81f41c ED |
80 | } |
81 | ||
210ab665 JP |
82 | static int dummy_change_carrier(struct net_device *dev, bool new_carrier) |
83 | { | |
84 | if (new_carrier) | |
85 | netif_carrier_on(dev); | |
86 | else | |
87 | netif_carrier_off(dev); | |
88 | return 0; | |
89 | } | |
90 | ||
aa18e9e8 | 91 | static const struct net_device_ops dummy_netdev_ops = { |
6d81f41c | 92 | .ndo_init = dummy_dev_init, |
890fdf2a | 93 | .ndo_uninit = dummy_dev_uninit, |
aa18e9e8 SH |
94 | .ndo_start_xmit = dummy_xmit, |
95 | .ndo_validate_addr = eth_validate_addr, | |
afc4b13d | 96 | .ndo_set_rx_mode = set_multicast_list, |
0d1632b4 | 97 | .ndo_set_mac_address = eth_mac_addr, |
6d81f41c | 98 | .ndo_get_stats64 = dummy_get_stats64, |
210ab665 | 99 | .ndo_change_carrier = dummy_change_carrier, |
aa18e9e8 SH |
100 | }; |
101 | ||
c19be735 | 102 | static const struct ethtool_ops dummy_ethtool_ops = { |
abe9fd57 | 103 | .get_ts_info = ethtool_op_get_ts_info, |
c19be735 FL |
104 | }; |
105 | ||
5d5cb173 | 106 | static void dummy_setup(struct net_device *dev) |
1da177e4 | 107 | { |
aa18e9e8 SH |
108 | ether_setup(dev); |
109 | ||
1da177e4 | 110 | /* Initialize the device structure. */ |
aa18e9e8 | 111 | dev->netdev_ops = &dummy_netdev_ops; |
c19be735 | 112 | dev->ethtool_ops = &dummy_ethtool_ops; |
cf124db5 | 113 | dev->needs_free_netdev = true; |
1da177e4 LT |
114 | |
115 | /* Fill in device structure with ethernet-generic values. */ | |
1da177e4 LT |
116 | dev->flags |= IFF_NOARP; |
117 | dev->flags &= ~IFF_MULTICAST; | |
ff42c02c | 118 | dev->priv_flags |= IFF_LIVE_ADDR_CHANGE | IFF_NO_QUEUE; |
8f3af277 | 119 | dev->features |= NETIF_F_SG | NETIF_F_FRAGLIST; |
ecb8fed4 | 120 | dev->features |= NETIF_F_GSO_SOFTWARE; |
34324dc2 | 121 | dev->features |= NETIF_F_HW_CSUM | NETIF_F_HIGHDMA | NETIF_F_LLTX; |
8f3af277 ED |
122 | dev->features |= NETIF_F_GSO_ENCAP_ALL; |
123 | dev->hw_features |= dev->features; | |
124 | dev->hw_enc_features |= dev->features; | |
7ce5d222 | 125 | eth_hw_addr_random(dev); |
25e3e84b ZS |
126 | |
127 | dev->min_mtu = 0; | |
e94cd811 | 128 | dev->max_mtu = 0; |
1da177e4 | 129 | } |
6d81f41c | 130 | |
a8b8a889 MS |
131 | static int dummy_validate(struct nlattr *tb[], struct nlattr *data[], |
132 | struct netlink_ext_ack *extack) | |
0e06877c PM |
133 | { |
134 | if (tb[IFLA_ADDRESS]) { | |
135 | if (nla_len(tb[IFLA_ADDRESS]) != ETH_ALEN) | |
136 | return -EINVAL; | |
137 | if (!is_valid_ether_addr(nla_data(tb[IFLA_ADDRESS]))) | |
138 | return -EADDRNOTAVAIL; | |
139 | } | |
140 | return 0; | |
141 | } | |
142 | ||
5d5cb173 | 143 | static struct rtnl_link_ops dummy_link_ops __read_mostly = { |
c19be735 | 144 | .kind = DRV_NAME, |
5d5cb173 | 145 | .setup = dummy_setup, |
0e06877c | 146 | .validate = dummy_validate, |
5d5cb173 PM |
147 | }; |
148 | ||
1da177e4 LT |
149 | /* Number of dummy devices to be set up by this module. */ |
150 | module_param(numdummies, int, 0); | |
151 | MODULE_PARM_DESC(numdummies, "Number of dummy pseudo devices"); | |
152 | ||
206c9fb2 | 153 | static int __init dummy_init_one(void) |
1da177e4 LT |
154 | { |
155 | struct net_device *dev_dummy; | |
156 | int err; | |
157 | ||
c3361610 | 158 | dev_dummy = alloc_netdev(0, "dummy%d", NET_NAME_ENUM, dummy_setup); |
1da177e4 LT |
159 | if (!dev_dummy) |
160 | return -ENOMEM; | |
161 | ||
5d5cb173 PM |
162 | dev_dummy->rtnl_link_ops = &dummy_link_ops; |
163 | err = register_netdevice(dev_dummy); | |
164 | if (err < 0) | |
165 | goto err; | |
5d5cb173 | 166 | return 0; |
206c9fb2 | 167 | |
5d5cb173 PM |
168 | err: |
169 | free_netdev(dev_dummy); | |
170 | return err; | |
6aa20a22 | 171 | } |
1da177e4 LT |
172 | |
173 | static int __init dummy_init_module(void) | |
6aa20a22 | 174 | { |
1da177e4 | 175 | int i, err = 0; |
206c9fb2 | 176 | |
554873e5 | 177 | down_write(&pernet_ops_rwsem); |
5d5cb173 PM |
178 | rtnl_lock(); |
179 | err = __rtnl_link_register(&dummy_link_ops); | |
2c8a0189 | 180 | if (err < 0) |
181 | goto out; | |
5d5cb173 | 182 | |
16b0dc29 | 183 | for (i = 0; i < numdummies && !err; i++) { |
206c9fb2 | 184 | err = dummy_init_one(); |
16b0dc29 ED |
185 | cond_resched(); |
186 | } | |
2d85cba2 | 187 | if (err < 0) |
5d5cb173 | 188 | __rtnl_link_unregister(&dummy_link_ops); |
2c8a0189 | 189 | |
190 | out: | |
5d5cb173 | 191 | rtnl_unlock(); |
554873e5 | 192 | up_write(&pernet_ops_rwsem); |
5d5cb173 | 193 | |
1da177e4 | 194 | return err; |
6aa20a22 | 195 | } |
1da177e4 LT |
196 | |
197 | static void __exit dummy_cleanup_module(void) | |
198 | { | |
2d85cba2 | 199 | rtnl_link_unregister(&dummy_link_ops); |
1da177e4 LT |
200 | } |
201 | ||
202 | module_init(dummy_init_module); | |
203 | module_exit(dummy_cleanup_module); | |
204 | MODULE_LICENSE("GPL"); | |
c19be735 | 205 | MODULE_ALIAS_RTNL_LINK(DRV_NAME); |