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 refcount_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 exit_list; /* To linked to call pernet exit
63 * methods on dead net (
64 * pernet_ops_rwsem read locked),
65 * or to unregister pernet ops
66 * (pernet_ops_rwsem write locked).
68 struct llist_node cleanup_list; /* namespaces on death row */
70 struct user_namespace *user_ns; /* Owning user namespace */
71 struct ucounts *ucounts;
77 struct proc_dir_entry *proc_net;
78 struct proc_dir_entry *proc_net_stat;
81 struct ctl_table_set sysctls;
84 struct sock *rtnl; /* rtnetlink socket */
85 struct sock *genl_sock;
87 struct uevent_sock *uevent_sock; /* uevent socket */
89 struct list_head dev_base_head;
90 struct hlist_head *dev_name_head;
91 struct hlist_head *dev_index_head;
92 unsigned int dev_base_seq; /* protected by rtnl_mutex */
94 unsigned int dev_unreg_count;
97 struct list_head rules_ops;
99 struct list_head fib_notifier_ops; /* Populated by
100 * register_pernet_subsys()
102 struct net_device *loopback_dev; /* The loopback */
103 struct netns_core core;
104 struct netns_mib mib;
105 struct netns_packet packet;
106 struct netns_unix unx;
107 struct netns_ipv4 ipv4;
108 #if IS_ENABLED(CONFIG_IPV6)
109 struct netns_ipv6 ipv6;
111 #if IS_ENABLED(CONFIG_IEEE802154_6LOWPAN)
112 struct netns_ieee802154_lowpan ieee802154_lowpan;
114 #if defined(CONFIG_IP_SCTP) || defined(CONFIG_IP_SCTP_MODULE)
115 struct netns_sctp sctp;
117 #if defined(CONFIG_IP_DCCP) || defined(CONFIG_IP_DCCP_MODULE)
118 struct netns_dccp dccp;
120 #ifdef CONFIG_NETFILTER
123 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
126 #if defined(CONFIG_NF_TABLES) || defined(CONFIG_NF_TABLES_MODULE)
127 struct netns_nftables nft;
129 #if IS_ENABLED(CONFIG_NF_DEFRAG_IPV6)
130 struct netns_nf_frag nf_frag;
131 struct ctl_table_header *nf_frag_frags_hdr;
134 struct sock *nfnl_stash;
135 #if IS_ENABLED(CONFIG_NETFILTER_NETLINK_ACCT)
136 struct list_head nfnl_acct_list;
138 #if IS_ENABLED(CONFIG_NF_CT_NETLINK_TIMEOUT)
139 struct list_head nfct_timeout_list;
142 #ifdef CONFIG_WEXT_CORE
143 struct sk_buff_head wext_nlevents;
145 struct net_generic __rcu *gen;
147 /* Note : following structs are cache line aligned */
149 struct netns_xfrm xfrm;
151 #if IS_ENABLED(CONFIG_IP_VS)
152 struct netns_ipvs *ipvs;
154 #if IS_ENABLED(CONFIG_MPLS)
155 struct netns_mpls mpls;
157 #if IS_ENABLED(CONFIG_CAN)
158 struct netns_can can;
160 struct sock *diag_nlsk;
162 } __randomize_layout;
164 #include <linux/seq_file_net.h>
166 /* Init's network namespace */
167 extern struct net init_net;
170 struct net *copy_net_ns(unsigned long flags, struct user_namespace *user_ns,
171 struct net *old_net);
173 void net_ns_barrier(void);
174 #else /* CONFIG_NET_NS */
175 #include <linux/sched.h>
176 #include <linux/nsproxy.h>
177 static inline struct net *copy_net_ns(unsigned long flags,
178 struct user_namespace *user_ns, struct net *old_net)
180 if (flags & CLONE_NEWNET)
181 return ERR_PTR(-EINVAL);
185 static inline void net_ns_barrier(void) {}
186 #endif /* CONFIG_NET_NS */
189 extern struct list_head net_namespace_list;
191 struct net *get_net_ns_by_pid(pid_t pid);
192 struct net *get_net_ns_by_fd(int fd);
195 void ipx_register_sysctl(void);
196 void ipx_unregister_sysctl(void);
198 #define ipx_register_sysctl()
199 #define ipx_unregister_sysctl()
203 void __put_net(struct net *net);
205 static inline struct net *get_net(struct net *net)
207 refcount_inc(&net->count);
211 static inline struct net *maybe_get_net(struct net *net)
213 /* Used when we know struct net exists but we
214 * aren't guaranteed a previous reference count
215 * exists. If the reference count is zero this
216 * function fails and returns NULL.
218 if (!refcount_inc_not_zero(&net->count))
223 static inline void put_net(struct net *net)
225 if (refcount_dec_and_test(&net->count))
230 int net_eq(const struct net *net1, const struct net *net2)
235 static inline int check_net(const struct net *net)
237 return refcount_read(&net->count) != 0;
240 void net_drop_ns(void *);
244 static inline struct net *get_net(struct net *net)
249 static inline void put_net(struct net *net)
253 static inline struct net *maybe_get_net(struct net *net)
259 int net_eq(const struct net *net1, const struct net *net2)
264 static inline int check_net(const struct net *net)
269 #define net_drop_ns NULL
279 static inline void write_pnet(possible_net_t *pnet, struct net *net)
286 static inline struct net *read_pnet(const possible_net_t *pnet)
295 /* Protected by net_rwsem */
296 #define for_each_net(VAR) \
297 list_for_each_entry(VAR, &net_namespace_list, list)
299 #define for_each_net_rcu(VAR) \
300 list_for_each_entry_rcu(VAR, &net_namespace_list, list)
305 #define __net_initdata
306 #define __net_initconst
308 #define __net_init __init
309 #define __net_exit __ref
310 #define __net_initdata __initdata
311 #define __net_initconst __initconst
314 int peernet2id_alloc(struct net *net, struct net *peer);
315 int peernet2id(struct net *net, struct net *peer);
316 bool peernet_has_id(struct net *net, struct net *peer);
317 struct net *get_net_ns_by_id(struct net *net, int id);
319 struct pernet_operations {
320 struct list_head list;
322 * Below methods are called without any exclusive locks.
323 * More than one net may be constructed and destructed
324 * in parallel on several cpus. Every pernet_operations
325 * have to keep in mind all other pernet_operations and
326 * to introduce a locking, if they share common resources.
328 * The only time they are called with exclusive lock is
329 * from register_pernet_subsys(), unregister_pernet_subsys()
330 * register_pernet_device() and unregister_pernet_device().
332 * Exit methods using blocking RCU primitives, such as
333 * synchronize_rcu(), should be implemented via exit_batch.
334 * Then, destruction of a group of net requires single
335 * synchronize_rcu() related to these pernet_operations,
336 * instead of separate synchronize_rcu() for every net.
337 * Please, avoid synchronize_rcu() at all, where it's possible.
339 int (*init)(struct net *net);
340 void (*exit)(struct net *net);
341 void (*exit_batch)(struct list_head *net_exit_list);
347 * Use these carefully. If you implement a network device and it
348 * needs per network namespace operations use device pernet operations,
349 * otherwise use pernet subsys operations.
351 * Network interfaces need to be removed from a dying netns _before_
352 * subsys notifiers can be called, as most of the network code cleanup
353 * (which is done from subsys notifiers) runs with the assumption that
354 * dev_remove_pack has been called so no new packets will arrive during
355 * and after the cleanup functions have been called. dev_remove_pack
356 * is not per namespace so instead the guarantee of no more packets
357 * arriving in a network namespace is provided by ensuring that all
358 * network devices and all sockets have left the network namespace
359 * before the cleanup methods are called.
361 * For the longest time the ipv4 icmp code was registered as a pernet
362 * device which caused kernel oops, and panics during network
363 * namespace cleanup. So please don't get this wrong.
365 int register_pernet_subsys(struct pernet_operations *);
366 void unregister_pernet_subsys(struct pernet_operations *);
367 int register_pernet_device(struct pernet_operations *);
368 void unregister_pernet_device(struct pernet_operations *);
371 struct ctl_table_header;
374 int net_sysctl_init(void);
375 struct ctl_table_header *register_net_sysctl(struct net *net, const char *path,
376 struct ctl_table *table);
377 void unregister_net_sysctl_table(struct ctl_table_header *header);
379 static inline int net_sysctl_init(void) { return 0; }
380 static inline struct ctl_table_header *register_net_sysctl(struct net *net,
381 const char *path, struct ctl_table *table)
385 static inline void unregister_net_sysctl_table(struct ctl_table_header *header)
390 static inline int rt_genid_ipv4(struct net *net)
392 return atomic_read(&net->ipv4.rt_genid);
395 static inline void rt_genid_bump_ipv4(struct net *net)
397 atomic_inc(&net->ipv4.rt_genid);
400 extern void (*__fib6_flush_trees)(struct net *net);
401 static inline void rt_genid_bump_ipv6(struct net *net)
403 if (__fib6_flush_trees)
404 __fib6_flush_trees(net);
407 #if IS_ENABLED(CONFIG_IEEE802154_6LOWPAN)
408 static inline struct netns_ieee802154_lowpan *
409 net_ieee802154_lowpan(struct net *net)
411 return &net->ieee802154_lowpan;
415 /* For callers who don't really care about whether it's IPv4 or IPv6 */
416 static inline void rt_genid_bump_all(struct net *net)
418 rt_genid_bump_ipv4(net);
419 rt_genid_bump_ipv6(net);
422 static inline int fnhe_genid(struct net *net)
424 return atomic_read(&net->fnhe_genid);
427 static inline void fnhe_genid_bump(struct net *net)
429 atomic_inc(&net->fnhe_genid);
432 #endif /* __NET_NET_NAMESPACE_H */