1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Operations on the network namespace
5 #ifndef __NET_NET_NAMESPACE_H
6 #define __NET_NET_NAMESPACE_H
8 #include <linux/atomic.h>
9 #include <linux/refcount.h>
10 #include <linux/workqueue.h>
11 #include <linux/list.h>
12 #include <linux/sysctl.h>
15 #include <net/netns/core.h>
16 #include <net/netns/mib.h>
17 #include <net/netns/unix.h>
18 #include <net/netns/packet.h>
19 #include <net/netns/ipv4.h>
20 #include <net/netns/ipv6.h>
21 #include <net/netns/ieee802154_6lowpan.h>
22 #include <net/netns/sctp.h>
23 #include <net/netns/dccp.h>
24 #include <net/netns/netfilter.h>
25 #include <net/netns/x_tables.h>
26 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
27 #include <net/netns/conntrack.h>
29 #include <net/netns/nftables.h>
30 #include <net/netns/xfrm.h>
31 #include <net/netns/mpls.h>
32 #include <net/netns/can.h>
33 #include <linux/ns_common.h>
34 #include <linux/idr.h>
35 #include <linux/skbuff.h>
37 struct user_namespace;
38 struct proc_dir_entry;
41 struct ctl_table_header;
47 #define NETDEV_HASHBITS 8
48 #define NETDEV_HASHENTRIES (1 << NETDEV_HASHBITS)
51 refcount_t passive; /* To decided when the network
52 * namespace should be freed.
54 atomic_t count; /* To decided when the network
55 * namespace should be shut down.
57 spinlock_t rules_mod_lock;
59 atomic64_t cookie_gen;
61 struct list_head list; /* list of network namespaces */
62 struct list_head cleanup_list; /* namespaces on death row */
63 struct list_head exit_list; /* Use only net_mutex */
65 struct user_namespace *user_ns; /* Owning user namespace */
66 struct ucounts *ucounts;
72 struct proc_dir_entry *proc_net;
73 struct proc_dir_entry *proc_net_stat;
76 struct ctl_table_set sysctls;
79 struct sock *rtnl; /* rtnetlink socket */
80 struct sock *genl_sock;
82 struct list_head dev_base_head;
83 struct hlist_head *dev_name_head;
84 struct hlist_head *dev_index_head;
85 unsigned int dev_base_seq; /* protected by rtnl_mutex */
87 unsigned int dev_unreg_count;
90 struct list_head rules_ops;
92 struct list_head fib_notifier_ops; /* protected by net_mutex */
94 struct net_device *loopback_dev; /* The loopback */
95 struct netns_core core;
97 struct netns_packet packet;
98 struct netns_unix unx;
99 struct netns_ipv4 ipv4;
100 #if IS_ENABLED(CONFIG_IPV6)
101 struct netns_ipv6 ipv6;
103 #if IS_ENABLED(CONFIG_IEEE802154_6LOWPAN)
104 struct netns_ieee802154_lowpan ieee802154_lowpan;
106 #if defined(CONFIG_IP_SCTP) || defined(CONFIG_IP_SCTP_MODULE)
107 struct netns_sctp sctp;
109 #if defined(CONFIG_IP_DCCP) || defined(CONFIG_IP_DCCP_MODULE)
110 struct netns_dccp dccp;
112 #ifdef CONFIG_NETFILTER
115 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
118 #if defined(CONFIG_NF_TABLES) || defined(CONFIG_NF_TABLES_MODULE)
119 struct netns_nftables nft;
121 #if IS_ENABLED(CONFIG_NF_DEFRAG_IPV6)
122 struct netns_nf_frag nf_frag;
125 struct sock *nfnl_stash;
126 #if IS_ENABLED(CONFIG_NETFILTER_NETLINK_ACCT)
127 struct list_head nfnl_acct_list;
129 #if IS_ENABLED(CONFIG_NF_CT_NETLINK_TIMEOUT)
130 struct list_head nfct_timeout_list;
133 #ifdef CONFIG_WEXT_CORE
134 struct sk_buff_head wext_nlevents;
136 struct net_generic __rcu *gen;
138 /* Note : following structs are cache line aligned */
140 struct netns_xfrm xfrm;
142 #if IS_ENABLED(CONFIG_IP_VS)
143 struct netns_ipvs *ipvs;
145 #if IS_ENABLED(CONFIG_MPLS)
146 struct netns_mpls mpls;
148 #if IS_ENABLED(CONFIG_CAN)
149 struct netns_can can;
151 struct sock *diag_nlsk;
153 } __randomize_layout;
155 #include <linux/seq_file_net.h>
157 /* Init's network namespace */
158 extern struct net init_net;
161 struct net *copy_net_ns(unsigned long flags, struct user_namespace *user_ns,
162 struct net *old_net);
164 void net_ns_barrier(void);
165 #else /* CONFIG_NET_NS */
166 #include <linux/sched.h>
167 #include <linux/nsproxy.h>
168 static inline struct net *copy_net_ns(unsigned long flags,
169 struct user_namespace *user_ns, struct net *old_net)
171 if (flags & CLONE_NEWNET)
172 return ERR_PTR(-EINVAL);
176 static inline void net_ns_barrier(void) {}
177 #endif /* CONFIG_NET_NS */
180 extern struct list_head net_namespace_list;
182 struct net *get_net_ns_by_pid(pid_t pid);
183 struct net *get_net_ns_by_fd(int fd);
186 void ipx_register_sysctl(void);
187 void ipx_unregister_sysctl(void);
189 #define ipx_register_sysctl()
190 #define ipx_unregister_sysctl()
194 void __put_net(struct net *net);
196 static inline struct net *get_net(struct net *net)
198 atomic_inc(&net->count);
202 static inline struct net *maybe_get_net(struct net *net)
204 /* Used when we know struct net exists but we
205 * aren't guaranteed a previous reference count
206 * exists. If the reference count is zero this
207 * function fails and returns NULL.
209 if (!atomic_inc_not_zero(&net->count))
214 static inline void put_net(struct net *net)
216 if (atomic_dec_and_test(&net->count))
221 int net_eq(const struct net *net1, const struct net *net2)
226 void net_drop_ns(void *);
230 static inline struct net *get_net(struct net *net)
235 static inline void put_net(struct net *net)
239 static inline struct net *maybe_get_net(struct net *net)
245 int net_eq(const struct net *net1, const struct net *net2)
250 #define net_drop_ns NULL
260 static inline void write_pnet(possible_net_t *pnet, struct net *net)
267 static inline struct net *read_pnet(const possible_net_t *pnet)
276 #define for_each_net(VAR) \
277 list_for_each_entry(VAR, &net_namespace_list, list)
279 #define for_each_net_rcu(VAR) \
280 list_for_each_entry_rcu(VAR, &net_namespace_list, list)
285 #define __net_initdata
286 #define __net_initconst
288 #define __net_init __init
289 #define __net_exit __ref
290 #define __net_initdata __initdata
291 #define __net_initconst __initconst
294 int peernet2id_alloc(struct net *net, struct net *peer);
295 int peernet2id(struct net *net, struct net *peer);
296 bool peernet_has_id(struct net *net, struct net *peer);
297 struct net *get_net_ns_by_id(struct net *net, int id);
299 struct pernet_operations {
300 struct list_head list;
301 int (*init)(struct net *net);
302 void (*exit)(struct net *net);
303 void (*exit_batch)(struct list_head *net_exit_list);
309 * Use these carefully. If you implement a network device and it
310 * needs per network namespace operations use device pernet operations,
311 * otherwise use pernet subsys operations.
313 * Network interfaces need to be removed from a dying netns _before_
314 * subsys notifiers can be called, as most of the network code cleanup
315 * (which is done from subsys notifiers) runs with the assumption that
316 * dev_remove_pack has been called so no new packets will arrive during
317 * and after the cleanup functions have been called. dev_remove_pack
318 * is not per namespace so instead the guarantee of no more packets
319 * arriving in a network namespace is provided by ensuring that all
320 * network devices and all sockets have left the network namespace
321 * before the cleanup methods are called.
323 * For the longest time the ipv4 icmp code was registered as a pernet
324 * device which caused kernel oops, and panics during network
325 * namespace cleanup. So please don't get this wrong.
327 int register_pernet_subsys(struct pernet_operations *);
328 void unregister_pernet_subsys(struct pernet_operations *);
329 int register_pernet_device(struct pernet_operations *);
330 void unregister_pernet_device(struct pernet_operations *);
333 struct ctl_table_header;
336 int net_sysctl_init(void);
337 struct ctl_table_header *register_net_sysctl(struct net *net, const char *path,
338 struct ctl_table *table);
339 void unregister_net_sysctl_table(struct ctl_table_header *header);
341 static inline int net_sysctl_init(void) { return 0; }
342 static inline struct ctl_table_header *register_net_sysctl(struct net *net,
343 const char *path, struct ctl_table *table)
347 static inline void unregister_net_sysctl_table(struct ctl_table_header *header)
352 static inline int rt_genid_ipv4(struct net *net)
354 return atomic_read(&net->ipv4.rt_genid);
357 static inline void rt_genid_bump_ipv4(struct net *net)
359 atomic_inc(&net->ipv4.rt_genid);
362 extern void (*__fib6_flush_trees)(struct net *net);
363 static inline void rt_genid_bump_ipv6(struct net *net)
365 if (__fib6_flush_trees)
366 __fib6_flush_trees(net);
369 #if IS_ENABLED(CONFIG_IEEE802154_6LOWPAN)
370 static inline struct netns_ieee802154_lowpan *
371 net_ieee802154_lowpan(struct net *net)
373 return &net->ieee802154_lowpan;
377 /* For callers who don't really care about whether it's IPv4 or IPv6 */
378 static inline void rt_genid_bump_all(struct net *net)
380 rt_genid_bump_ipv4(net);
381 rt_genid_bump_ipv6(net);
384 static inline int fnhe_genid(struct net *net)
386 return atomic_read(&net->fnhe_genid);
389 static inline void fnhe_genid_bump(struct net *net)
391 atomic_inc(&net->fnhe_genid);
394 #endif /* __NET_NET_NAMESPACE_H */