blob: ee547c1498108ad17e25f46a339ff8eb5e49e663 [file] [log] [blame]
Eric W. Biederman5f256be2007-09-12 11:50:50 +02001/*
2 * Operations on the network namespace
3 */
4#ifndef __NET_NET_NAMESPACE_H
5#define __NET_NET_NAMESPACE_H
6
Arun Sharma60063492011-07-26 16:09:06 -07007#include <linux/atomic.h>
Eric W. Biederman5f256be2007-09-12 11:50:50 +02008#include <linux/workqueue.h>
9#include <linux/list.h>
David S. Millerbee95252011-05-26 16:40:37 -040010#include <linux/sysctl.h>
Eric W. Biederman5f256be2007-09-12 11:50:50 +020011
Pavel Emelyanov8efa6e92008-03-31 19:41:14 -070012#include <net/netns/core.h>
Pavel Emelyanov852566f2008-07-18 04:01:24 -070013#include <net/netns/mib.h>
Denis V. Luneva0a53c82007-12-11 04:19:17 -080014#include <net/netns/unix.h>
Denis V. Lunev2aaef4e2007-12-11 04:19:54 -080015#include <net/netns/packet.h>
Pavel Emelyanov8afd3512007-12-16 13:29:36 -080016#include <net/netns/ipv4.h>
Daniel Lezcanob0f159d2008-01-10 02:49:06 -080017#include <net/netns/ipv6.h>
Pavel Emelyanov67019cc2008-04-13 22:28:42 -070018#include <net/netns/dccp.h>
Alexey Dobriyan8d870052008-01-31 04:02:13 -080019#include <net/netns/x_tables.h>
Alexey Dobriyandfdb8d72008-10-08 11:35:02 +020020#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
21#include <net/netns/conntrack.h>
22#endif
Alexey Dobriyand62ddc22008-11-25 17:14:31 -080023#include <net/netns/xfrm.h>
Denis V. Luneva0a53c82007-12-11 04:19:17 -080024
Eric W. Biederman457c4cb2007-09-12 12:01:34 +020025struct proc_dir_entry;
Eric W. Biederman2774c7a2007-09-26 22:10:56 -070026struct net_device;
Denis V. Lunev97c53ca2007-11-19 22:26:51 -080027struct sock;
Pavel Emelyanov1597fbc2007-12-01 23:51:01 +110028struct ctl_table_header;
Pavel Emelyanovdec827d2008-04-15 00:36:08 -070029struct net_generic;
Johannes Berg134e6372009-07-10 09:51:34 +000030struct sock;
Julian Anastasov2553d062011-03-04 12:18:07 +020031struct netns_ipvs;
Pavel Emelyanov1597fbc2007-12-01 23:51:01 +110032
Eric Dumazet7c28bd02009-10-24 06:13:17 -070033
34#define NETDEV_HASHBITS 8
35#define NETDEV_HASHENTRIES (1 << NETDEV_HASHBITS)
36
Eric W. Biederman5f256be2007-09-12 11:50:50 +020037struct net {
Al Viroa685e082011-06-08 21:13:01 -040038 atomic_t passive; /* To decided when the network
39 * namespace should be freed.
40 */
Eric W. Biederman5f256be2007-09-12 11:50:50 +020041 atomic_t count; /* To decided when the network
Al Viroa685e082011-06-08 21:13:01 -040042 * namespace should be shut down.
Eric W. Biederman5f256be2007-09-12 11:50:50 +020043 */
Denis V. Lunev5d1e4462008-04-16 01:58:04 -070044#ifdef NETNS_REFCNT_DEBUG
Eric W. Biederman5f256be2007-09-12 11:50:50 +020045 atomic_t use_count; /* To track references we
46 * destroy on demand
47 */
Denis V. Lunev5d1e4462008-04-16 01:58:04 -070048#endif
Eric Dumazet8e602ce2010-10-14 05:56:18 +000049 spinlock_t rules_mod_lock;
50
Eric W. Biederman5f256be2007-09-12 11:50:50 +020051 struct list_head list; /* list of network namespaces */
Eric W. Biederman2b035b32009-11-29 22:25:27 +000052 struct list_head cleanup_list; /* namespaces on death row */
Eric W. Biederman72ad9372009-12-03 02:29:03 +000053 struct list_head exit_list; /* Use only net_mutex */
Eric W. Biederman457c4cb2007-09-12 12:01:34 +020054
55 struct proc_dir_entry *proc_net;
56 struct proc_dir_entry *proc_net_stat;
Eric W. Biederman881d9662007-09-17 11:56:21 -070057
Al Viro73455092008-07-14 21:22:20 -040058#ifdef CONFIG_SYSCTL
59 struct ctl_table_set sysctls;
60#endif
Eric W. Biederman95bdfcc2007-11-30 23:55:42 +110061
Eric Dumazet8e602ce2010-10-14 05:56:18 +000062 struct sock *rtnl; /* rtnetlink socket */
63 struct sock *genl_sock;
Eric W. Biederman2774c7a2007-09-26 22:10:56 -070064
Eric W. Biederman881d9662007-09-17 11:56:21 -070065 struct list_head dev_base_head;
66 struct hlist_head *dev_name_head;
67 struct hlist_head *dev_index_head;
Thomas Graf4e985ad2011-06-21 03:11:20 +000068 unsigned int dev_base_seq; /* protected by rtnl_mutex */
Denis V. Lunev97c53ca2007-11-19 22:26:51 -080069
Denis V. Lunev5fd30ee2008-01-10 03:20:28 -080070 /* core fib_rules */
71 struct list_head rules_ops;
Denis V. Lunev5fd30ee2008-01-10 03:20:28 -080072
Denis V. Lunevd12d01d2007-11-19 22:28:35 -080073
Eric Dumazet8e602ce2010-10-14 05:56:18 +000074 struct net_device *loopback_dev; /* The loopback */
Pavel Emelyanov8efa6e92008-03-31 19:41:14 -070075 struct netns_core core;
Pavel Emelyanov852566f2008-07-18 04:01:24 -070076 struct netns_mib mib;
Denis V. Lunev2aaef4e2007-12-11 04:19:54 -080077 struct netns_packet packet;
Denis V. Luneva0a53c82007-12-11 04:19:17 -080078 struct netns_unix unx;
Pavel Emelyanov8afd3512007-12-16 13:29:36 -080079 struct netns_ipv4 ipv4;
Eric Dumazetdfd56b82011-12-10 09:48:31 +000080#if IS_ENABLED(CONFIG_IPV6)
Daniel Lezcanob0f159d2008-01-10 02:49:06 -080081 struct netns_ipv6 ipv6;
82#endif
Pavel Emelyanov67019cc2008-04-13 22:28:42 -070083#if defined(CONFIG_IP_DCCP) || defined(CONFIG_IP_DCCP_MODULE)
84 struct netns_dccp dccp;
85#endif
Alexey Dobriyan8d870052008-01-31 04:02:13 -080086#ifdef CONFIG_NETFILTER
87 struct netns_xt xt;
Alexey Dobriyandfdb8d72008-10-08 11:35:02 +020088#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
89 struct netns_ct ct;
90#endif
Alexey Dobriyancd8c20b2010-01-13 16:02:14 +010091 struct sock *nfnl;
92 struct sock *nfnl_stash;
Alexey Dobriyan8d870052008-01-31 04:02:13 -080093#endif
Johannes Berg3d23e342009-09-29 23:27:28 +020094#ifdef CONFIG_WEXT_CORE
Johannes Bergb333b3d222009-06-24 01:34:48 +000095 struct sk_buff_head wext_nlevents;
96#endif
Eric Dumazet1c877332010-10-25 03:20:11 +000097 struct net_generic __rcu *gen;
Eric Dumazet8e602ce2010-10-14 05:56:18 +000098
99 /* Note : following structs are cache line aligned */
100#ifdef CONFIG_XFRM
101 struct netns_xfrm xfrm;
102#endif
Hans Schillstrom61b1ab42011-01-03 14:44:42 +0100103 struct netns_ipvs *ipvs;
Eric W. Biederman5f256be2007-09-12 11:50:50 +0200104};
105
Denis V. Lunev225c0a02008-04-02 00:09:29 -0700106
Denis V. Lunevc0f39322008-04-02 00:10:28 -0700107#include <linux/seq_file_net.h>
108
Daniel Lezcano4fabcd72007-09-13 09:16:29 +0200109/* Init's network namespace */
Eric W. Biederman5f256be2007-09-12 11:50:50 +0200110extern struct net init_net;
Denis V. Luneva4aa8342008-04-03 13:04:33 -0700111
112#ifdef CONFIG_NET
Eric W. Biederman9dd776b2007-09-26 22:04:26 -0700113extern struct net *copy_net_ns(unsigned long flags, struct net *net_ns);
Denis V. Lunev225c0a02008-04-02 00:09:29 -0700114
115#else /* CONFIG_NET */
Eric W. Biederman9dd776b2007-09-26 22:04:26 -0700116static inline struct net *copy_net_ns(unsigned long flags, struct net *net_ns)
117{
118 /* There is nothing to copy so this is a noop */
119 return net_ns;
120}
Denis V. Lunev225c0a02008-04-02 00:09:29 -0700121#endif /* CONFIG_NET */
122
123
124extern struct list_head net_namespace_list;
Eric W. Biederman9dd776b2007-09-26 22:04:26 -0700125
Johannes Berg30ffee82009-07-10 09:51:35 +0000126extern struct net *get_net_ns_by_pid(pid_t pid);
Eric W. Biedermanf0630522011-05-04 17:51:50 -0700127extern struct net *get_net_ns_by_fd(int pid);
Johannes Berg30ffee82009-07-10 09:51:35 +0000128
Pavel Emelyanovd4655792007-11-01 00:43:49 -0700129#ifdef CONFIG_NET_NS
Eric W. Biederman5f256be2007-09-12 11:50:50 +0200130extern void __put_net(struct net *net);
131
132static inline struct net *get_net(struct net *net)
133{
134 atomic_inc(&net->count);
135 return net;
136}
137
Eric W. Biederman077130c2007-09-13 09:18:57 +0200138static inline struct net *maybe_get_net(struct net *net)
139{
140 /* Used when we know struct net exists but we
141 * aren't guaranteed a previous reference count
142 * exists. If the reference count is zero this
143 * function fails and returns NULL.
144 */
145 if (!atomic_inc_not_zero(&net->count))
146 net = NULL;
147 return net;
148}
149
Eric W. Biederman5f256be2007-09-12 11:50:50 +0200150static inline void put_net(struct net *net)
151{
152 if (atomic_dec_and_test(&net->count))
153 __put_net(net);
154}
155
YOSHIFUJI Hideaki878628f2008-03-26 03:57:35 +0900156static inline
157int net_eq(const struct net *net1, const struct net *net2)
158{
159 return net1 == net2;
160}
Al Viroa685e082011-06-08 21:13:01 -0400161
162extern void net_drop_ns(void *);
163
Pavel Emelyanovd4655792007-11-01 00:43:49 -0700164#else
Eric W. Biedermanb9f75f42008-06-20 22:16:51 -0700165
Pavel Emelyanovd4655792007-11-01 00:43:49 -0700166static inline struct net *get_net(struct net *net)
167{
168 return net;
169}
170
171static inline void put_net(struct net *net)
172{
173}
174
Pavel Emelyanovd4655792007-11-01 00:43:49 -0700175static inline struct net *maybe_get_net(struct net *net)
176{
177 return net;
178}
YOSHIFUJI Hideaki878628f2008-03-26 03:57:35 +0900179
180static inline
181int net_eq(const struct net *net1, const struct net *net2)
182{
183 return 1;
184}
Al Viroa685e082011-06-08 21:13:01 -0400185
186#define net_drop_ns NULL
Pavel Emelyanovd4655792007-11-01 00:43:49 -0700187#endif
Eric W. Biederman5f256be2007-09-12 11:50:50 +0200188
Denis V. Lunev5d1e4462008-04-16 01:58:04 -0700189
190#ifdef NETNS_REFCNT_DEBUG
191static inline struct net *hold_net(struct net *net)
192{
193 if (net)
194 atomic_inc(&net->use_count);
195 return net;
196}
197
198static inline void release_net(struct net *net)
199{
200 if (net)
201 atomic_dec(&net->use_count);
202}
203#else
204static inline struct net *hold_net(struct net *net)
205{
206 return net;
207}
208
209static inline void release_net(struct net *net)
210{
211}
212#endif
213
Eric Dumazet8f424b52008-11-12 00:53:30 -0800214#ifdef CONFIG_NET_NS
215
216static inline void write_pnet(struct net **pnet, struct net *net)
217{
218 *pnet = net;
219}
220
221static inline struct net *read_pnet(struct net * const *pnet)
222{
223 return *pnet;
224}
225
226#else
227
228#define write_pnet(pnet, net) do { (void)(net);} while (0)
229#define read_pnet(pnet) (&init_net)
230
231#endif
Denis V. Lunev5d1e4462008-04-16 01:58:04 -0700232
Eric W. Biederman5f256be2007-09-12 11:50:50 +0200233#define for_each_net(VAR) \
234 list_for_each_entry(VAR, &net_namespace_list, list)
235
Johannes Berg11a28d32009-07-10 09:51:33 +0000236#define for_each_net_rcu(VAR) \
237 list_for_each_entry_rcu(VAR, &net_namespace_list, list)
238
Pavel Emelyanov46650792007-10-08 20:38:39 -0700239#ifdef CONFIG_NET_NS
240#define __net_init
241#define __net_exit
Denis V. Lunev022cbae2007-11-13 03:23:50 -0800242#define __net_initdata
Pavel Emelyanov46650792007-10-08 20:38:39 -0700243#else
244#define __net_init __init
245#define __net_exit __exit_refok
Denis V. Lunev022cbae2007-11-13 03:23:50 -0800246#define __net_initdata __initdata
Pavel Emelyanov46650792007-10-08 20:38:39 -0700247#endif
Eric W. Biederman5f256be2007-09-12 11:50:50 +0200248
249struct pernet_operations {
250 struct list_head list;
251 int (*init)(struct net *net);
252 void (*exit)(struct net *net);
Eric W. Biederman72ad9372009-12-03 02:29:03 +0000253 void (*exit_batch)(struct list_head *net_exit_list);
Eric W. Biedermanf875bae2009-11-29 22:25:28 +0000254 int *id;
255 size_t size;
Eric W. Biederman5f256be2007-09-12 11:50:50 +0200256};
257
Eric W. Biederman17edde52009-02-22 00:11:09 -0800258/*
259 * Use these carefully. If you implement a network device and it
260 * needs per network namespace operations use device pernet operations,
261 * otherwise use pernet subsys operations.
262 *
Johannes Berg4edf5472009-07-15 06:16:34 +0000263 * Network interfaces need to be removed from a dying netns _before_
264 * subsys notifiers can be called, as most of the network code cleanup
265 * (which is done from subsys notifiers) runs with the assumption that
266 * dev_remove_pack has been called so no new packets will arrive during
267 * and after the cleanup functions have been called. dev_remove_pack
268 * is not per namespace so instead the guarantee of no more packets
269 * arriving in a network namespace is provided by ensuring that all
270 * network devices and all sockets have left the network namespace
271 * before the cleanup methods are called.
Eric W. Biederman17edde52009-02-22 00:11:09 -0800272 *
273 * For the longest time the ipv4 icmp code was registered as a pernet
274 * device which caused kernel oops, and panics during network
275 * namespace cleanup. So please don't get this wrong.
276 */
Eric W. Biederman5f256be2007-09-12 11:50:50 +0200277extern int register_pernet_subsys(struct pernet_operations *);
278extern void unregister_pernet_subsys(struct pernet_operations *);
279extern int register_pernet_device(struct pernet_operations *);
280extern void unregister_pernet_device(struct pernet_operations *);
Eric W. Biedermanf875bae2009-11-29 22:25:28 +0000281
Eric W. Biederman95bdfcc2007-11-30 23:55:42 +1100282struct ctl_path;
283struct ctl_table;
284struct ctl_table_header;
Pavel Emelyanovd62c6122008-05-19 13:45:33 -0700285
Eric W. Biederman95bdfcc2007-11-30 23:55:42 +1100286extern struct ctl_table_header *register_net_sysctl_table(struct net *net,
287 const struct ctl_path *path, struct ctl_table *table);
Pavel Emelyanovd62c6122008-05-19 13:45:33 -0700288extern struct ctl_table_header *register_net_sysctl_rotable(
289 const struct ctl_path *path, struct ctl_table *table);
Eric W. Biederman95bdfcc2007-11-30 23:55:42 +1100290extern void unregister_net_sysctl_table(struct ctl_table_header *header);
291
Eric W. Biederman5f256be2007-09-12 11:50:50 +0200292#endif /* __NET_NET_NAMESPACE_H */