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>
13 #include <linux/uidgid.h>
16 #include <net/netns/core.h>
17 #include <net/netns/mib.h>
18 #include <net/netns/unix.h>
19 #include <net/netns/packet.h>
20 #include <net/netns/ipv4.h>
21 #include <net/netns/ipv6.h>
22 #include <net/netns/nexthop.h>
23 #include <net/netns/ieee802154_6lowpan.h>
24 #include <net/netns/sctp.h>
25 #include <net/netns/dccp.h>
26 #include <net/netns/netfilter.h>
27 #include <net/netns/x_tables.h>
28 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
29 #include <net/netns/conntrack.h>
31 #include <net/netns/nftables.h>
32 #include <net/netns/xfrm.h>
33 #include <net/netns/mpls.h>
34 #include <net/netns/can.h>
35 #include <net/netns/xdp.h>
36 #include <linux/ns_common.h>
37 #include <linux/idr.h>
38 #include <linux/skbuff.h>
40 struct user_namespace;
41 struct proc_dir_entry;
44 struct ctl_table_header;
51 #define NETDEV_HASHBITS 8
52 #define NETDEV_HASHENTRIES (1 << NETDEV_HASHBITS)
55 refcount_t passive; /* To decided when the network
56 * namespace should be freed.
58 refcount_t count; /* To decided when the network
59 * namespace should be shut down.
61 spinlock_t rules_mod_lock;
64 atomic64_t cookie_gen;
66 struct list_head list; /* list of network namespaces */
67 struct list_head exit_list; /* To linked to call pernet exit
68 * methods on dead net (
69 * pernet_ops_rwsem read locked),
70 * or to unregister pernet ops
71 * (pernet_ops_rwsem write locked).
73 struct llist_node cleanup_list; /* namespaces on death row */
76 struct key_tag *key_domain; /* Key domain of operation tag */
78 struct user_namespace *user_ns; /* Owning user namespace */
79 struct ucounts *ucounts;
85 struct proc_dir_entry *proc_net;
86 struct proc_dir_entry *proc_net_stat;
89 struct ctl_table_set sysctls;
92 struct sock *rtnl; /* rtnetlink socket */
93 struct sock *genl_sock;
95 struct uevent_sock *uevent_sock; /* uevent socket */
97 struct list_head dev_base_head;
98 struct hlist_head *dev_name_head;
99 struct hlist_head *dev_index_head;
100 unsigned int dev_base_seq; /* protected by rtnl_mutex */
102 unsigned int dev_unreg_count;
105 struct list_head rules_ops;
107 struct list_head fib_notifier_ops; /* Populated by
108 * register_pernet_subsys()
110 struct net_device *loopback_dev; /* The loopback */
111 struct netns_core core;
112 struct netns_mib mib;
113 struct netns_packet packet;
114 struct netns_unix unx;
115 struct netns_nexthop nexthop;
116 struct netns_ipv4 ipv4;
117 #if IS_ENABLED(CONFIG_IPV6)
118 struct netns_ipv6 ipv6;
120 #if IS_ENABLED(CONFIG_IEEE802154_6LOWPAN)
121 struct netns_ieee802154_lowpan ieee802154_lowpan;
123 #if defined(CONFIG_IP_SCTP) || defined(CONFIG_IP_SCTP_MODULE)
124 struct netns_sctp sctp;
126 #if defined(CONFIG_IP_DCCP) || defined(CONFIG_IP_DCCP_MODULE)
127 struct netns_dccp dccp;
129 #ifdef CONFIG_NETFILTER
132 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
135 #if defined(CONFIG_NF_TABLES) || defined(CONFIG_NF_TABLES_MODULE)
136 struct netns_nftables nft;
138 #if IS_ENABLED(CONFIG_NF_DEFRAG_IPV6)
139 struct netns_nf_frag nf_frag;
140 struct ctl_table_header *nf_frag_frags_hdr;
143 struct sock *nfnl_stash;
144 #if IS_ENABLED(CONFIG_NETFILTER_NETLINK_ACCT)
145 struct list_head nfnl_acct_list;
147 #if IS_ENABLED(CONFIG_NF_CT_NETLINK_TIMEOUT)
148 struct list_head nfct_timeout_list;
151 #ifdef CONFIG_WEXT_CORE
152 struct sk_buff_head wext_nlevents;
154 struct net_generic __rcu *gen;
156 struct bpf_prog __rcu *flow_dissector_prog;
158 /* Note : following structs are cache line aligned */
160 struct netns_xfrm xfrm;
162 #if IS_ENABLED(CONFIG_IP_VS)
163 struct netns_ipvs *ipvs;
165 #if IS_ENABLED(CONFIG_MPLS)
166 struct netns_mpls mpls;
168 #if IS_ENABLED(CONFIG_CAN)
169 struct netns_can can;
171 #ifdef CONFIG_XDP_SOCKETS
172 struct netns_xdp xdp;
174 struct sock *diag_nlsk;
176 } __randomize_layout;
178 #include <linux/seq_file_net.h>
180 /* Init's network namespace */
181 extern struct net init_net;
184 struct net *copy_net_ns(unsigned long flags, struct user_namespace *user_ns,
185 struct net *old_net);
187 void net_ns_get_ownership(const struct net *net, kuid_t *uid, kgid_t *gid);
189 void net_ns_barrier(void);
190 #else /* CONFIG_NET_NS */
191 #include <linux/sched.h>
192 #include <linux/nsproxy.h>
193 static inline struct net *copy_net_ns(unsigned long flags,
194 struct user_namespace *user_ns, struct net *old_net)
196 if (flags & CLONE_NEWNET)
197 return ERR_PTR(-EINVAL);
201 static inline void net_ns_get_ownership(const struct net *net,
202 kuid_t *uid, kgid_t *gid)
204 *uid = GLOBAL_ROOT_UID;
205 *gid = GLOBAL_ROOT_GID;
208 static inline void net_ns_barrier(void) {}
209 #endif /* CONFIG_NET_NS */
212 extern struct list_head net_namespace_list;
214 struct net *get_net_ns_by_pid(pid_t pid);
215 struct net *get_net_ns_by_fd(int fd);
218 void ipx_register_sysctl(void);
219 void ipx_unregister_sysctl(void);
221 #define ipx_register_sysctl()
222 #define ipx_unregister_sysctl()
226 void __put_net(struct net *net);
228 static inline struct net *get_net(struct net *net)
230 refcount_inc(&net->count);
234 static inline struct net *maybe_get_net(struct net *net)
236 /* Used when we know struct net exists but we
237 * aren't guaranteed a previous reference count
238 * exists. If the reference count is zero this
239 * function fails and returns NULL.
241 if (!refcount_inc_not_zero(&net->count))
246 static inline void put_net(struct net *net)
248 if (refcount_dec_and_test(&net->count))
253 int net_eq(const struct net *net1, const struct net *net2)
258 static inline int check_net(const struct net *net)
260 return refcount_read(&net->count) != 0;
263 void net_drop_ns(void *);
267 static inline struct net *get_net(struct net *net)
272 static inline void put_net(struct net *net)
276 static inline struct net *maybe_get_net(struct net *net)
282 int net_eq(const struct net *net1, const struct net *net2)
287 static inline int check_net(const struct net *net)
292 #define net_drop_ns NULL
302 static inline void write_pnet(possible_net_t *pnet, struct net *net)
309 static inline struct net *read_pnet(const possible_net_t *pnet)
318 /* Protected by net_rwsem */
319 #define for_each_net(VAR) \
320 list_for_each_entry(VAR, &net_namespace_list, list)
322 #define for_each_net_rcu(VAR) \
323 list_for_each_entry_rcu(VAR, &net_namespace_list, list)
328 #define __net_initdata
329 #define __net_initconst
331 #define __net_init __init
332 #define __net_exit __ref
333 #define __net_initdata __initdata
334 #define __net_initconst __initconst
337 int peernet2id_alloc(struct net *net, struct net *peer);
338 int peernet2id(struct net *net, struct net *peer);
339 bool peernet_has_id(struct net *net, struct net *peer);
340 struct net *get_net_ns_by_id(struct net *net, int id);
342 struct pernet_operations {
343 struct list_head list;
345 * Below methods are called without any exclusive locks.
346 * More than one net may be constructed and destructed
347 * in parallel on several cpus. Every pernet_operations
348 * have to keep in mind all other pernet_operations and
349 * to introduce a locking, if they share common resources.
351 * The only time they are called with exclusive lock is
352 * from register_pernet_subsys(), unregister_pernet_subsys()
353 * register_pernet_device() and unregister_pernet_device().
355 * Exit methods using blocking RCU primitives, such as
356 * synchronize_rcu(), should be implemented via exit_batch.
357 * Then, destruction of a group of net requires single
358 * synchronize_rcu() related to these pernet_operations,
359 * instead of separate synchronize_rcu() for every net.
360 * Please, avoid synchronize_rcu() at all, where it's possible.
362 * Note that a combination of pre_exit() and exit() can
363 * be used, since a synchronize_rcu() is guaranteed between
366 int (*init)(struct net *net);
367 void (*pre_exit)(struct net *net);
368 void (*exit)(struct net *net);
369 void (*exit_batch)(struct list_head *net_exit_list);
375 * Use these carefully. If you implement a network device and it
376 * needs per network namespace operations use device pernet operations,
377 * otherwise use pernet subsys operations.
379 * Network interfaces need to be removed from a dying netns _before_
380 * subsys notifiers can be called, as most of the network code cleanup
381 * (which is done from subsys notifiers) runs with the assumption that
382 * dev_remove_pack has been called so no new packets will arrive during
383 * and after the cleanup functions have been called. dev_remove_pack
384 * is not per namespace so instead the guarantee of no more packets
385 * arriving in a network namespace is provided by ensuring that all
386 * network devices and all sockets have left the network namespace
387 * before the cleanup methods are called.
389 * For the longest time the ipv4 icmp code was registered as a pernet
390 * device which caused kernel oops, and panics during network
391 * namespace cleanup. So please don't get this wrong.
393 int register_pernet_subsys(struct pernet_operations *);
394 void unregister_pernet_subsys(struct pernet_operations *);
395 int register_pernet_device(struct pernet_operations *);
396 void unregister_pernet_device(struct pernet_operations *);
399 struct ctl_table_header;
402 int net_sysctl_init(void);
403 struct ctl_table_header *register_net_sysctl(struct net *net, const char *path,
404 struct ctl_table *table);
405 void unregister_net_sysctl_table(struct ctl_table_header *header);
407 static inline int net_sysctl_init(void) { return 0; }
408 static inline struct ctl_table_header *register_net_sysctl(struct net *net,
409 const char *path, struct ctl_table *table)
413 static inline void unregister_net_sysctl_table(struct ctl_table_header *header)
418 static inline int rt_genid_ipv4(struct net *net)
420 return atomic_read(&net->ipv4.rt_genid);
423 static inline void rt_genid_bump_ipv4(struct net *net)
425 atomic_inc(&net->ipv4.rt_genid);
428 extern void (*__fib6_flush_trees)(struct net *net);
429 static inline void rt_genid_bump_ipv6(struct net *net)
431 if (__fib6_flush_trees)
432 __fib6_flush_trees(net);
435 #if IS_ENABLED(CONFIG_IEEE802154_6LOWPAN)
436 static inline struct netns_ieee802154_lowpan *
437 net_ieee802154_lowpan(struct net *net)
439 return &net->ieee802154_lowpan;
443 /* For callers who don't really care about whether it's IPv4 or IPv6 */
444 static inline void rt_genid_bump_all(struct net *net)
446 rt_genid_bump_ipv4(net);
447 rt_genid_bump_ipv6(net);
450 static inline int fnhe_genid(struct net *net)
452 return atomic_read(&net->fnhe_genid);
455 static inline void fnhe_genid_bump(struct net *net)
457 atomic_inc(&net->fnhe_genid);
460 #endif /* __NET_NET_NAMESPACE_H */