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;
133 struct sock *nfnl_stash;
134 #if IS_ENABLED(CONFIG_NETFILTER_NETLINK_ACCT)
135 struct list_head nfnl_acct_list;
137 #if IS_ENABLED(CONFIG_NF_CT_NETLINK_TIMEOUT)
138 struct list_head nfct_timeout_list;
141 #ifdef CONFIG_WEXT_CORE
142 struct sk_buff_head wext_nlevents;
144 struct net_generic __rcu *gen;
146 /* Note : following structs are cache line aligned */
148 struct netns_xfrm xfrm;
150 #if IS_ENABLED(CONFIG_IP_VS)
151 struct netns_ipvs *ipvs;
153 #if IS_ENABLED(CONFIG_MPLS)
154 struct netns_mpls mpls;
156 #if IS_ENABLED(CONFIG_CAN)
157 struct netns_can can;
159 struct sock *diag_nlsk;
161 } __randomize_layout;
163 #include <linux/seq_file_net.h>
165 /* Init's network namespace */
166 extern struct net init_net;
169 struct net *copy_net_ns(unsigned long flags, struct user_namespace *user_ns,
170 struct net *old_net);
172 void net_ns_barrier(void);
173 #else /* CONFIG_NET_NS */
174 #include <linux/sched.h>
175 #include <linux/nsproxy.h>
176 static inline struct net *copy_net_ns(unsigned long flags,
177 struct user_namespace *user_ns, struct net *old_net)
179 if (flags & CLONE_NEWNET)
180 return ERR_PTR(-EINVAL);
184 static inline void net_ns_barrier(void) {}
185 #endif /* CONFIG_NET_NS */
188 extern struct list_head net_namespace_list;
190 struct net *get_net_ns_by_pid(pid_t pid);
191 struct net *get_net_ns_by_fd(int fd);
194 void ipx_register_sysctl(void);
195 void ipx_unregister_sysctl(void);
197 #define ipx_register_sysctl()
198 #define ipx_unregister_sysctl()
202 void __put_net(struct net *net);
204 static inline struct net *get_net(struct net *net)
206 refcount_inc(&net->count);
210 static inline struct net *maybe_get_net(struct net *net)
212 /* Used when we know struct net exists but we
213 * aren't guaranteed a previous reference count
214 * exists. If the reference count is zero this
215 * function fails and returns NULL.
217 if (!refcount_inc_not_zero(&net->count))
222 static inline void put_net(struct net *net)
224 if (refcount_dec_and_test(&net->count))
229 int net_eq(const struct net *net1, const struct net *net2)
234 static inline int check_net(const struct net *net)
236 return refcount_read(&net->count) != 0;
239 void net_drop_ns(void *);
243 static inline struct net *get_net(struct net *net)
248 static inline void put_net(struct net *net)
252 static inline struct net *maybe_get_net(struct net *net)
258 int net_eq(const struct net *net1, const struct net *net2)
263 static inline int check_net(const struct net *net)
268 #define net_drop_ns NULL
278 static inline void write_pnet(possible_net_t *pnet, struct net *net)
285 static inline struct net *read_pnet(const possible_net_t *pnet)
294 #define for_each_net(VAR) \
295 list_for_each_entry(VAR, &net_namespace_list, list)
297 #define for_each_net_rcu(VAR) \
298 list_for_each_entry_rcu(VAR, &net_namespace_list, list)
303 #define __net_initdata
304 #define __net_initconst
306 #define __net_init __init
307 #define __net_exit __ref
308 #define __net_initdata __initdata
309 #define __net_initconst __initconst
312 int peernet2id_alloc(struct net *net, struct net *peer);
313 int peernet2id(struct net *net, struct net *peer);
314 bool peernet_has_id(struct net *net, struct net *peer);
315 struct net *get_net_ns_by_id(struct net *net, int id);
317 struct pernet_operations {
318 struct list_head list;
320 * Below methods are called without any exclusive locks.
321 * More than one net may be constructed and destructed
322 * in parallel on several cpus. Every pernet_operations
323 * have to keep in mind all other pernet_operations and
324 * to introduce a locking, if they share common resources.
326 * The only time they are called with exclusive lock is
327 * from register_pernet_subsys(), unregister_pernet_subsys()
328 * register_pernet_device() and unregister_pernet_device().
330 * Exit methods using blocking RCU primitives, such as
331 * synchronize_rcu(), should be implemented via exit_batch.
332 * Then, destruction of a group of net requires single
333 * synchronize_rcu() related to these pernet_operations,
334 * instead of separate synchronize_rcu() for every net.
335 * Please, avoid synchronize_rcu() at all, where it's possible.
337 int (*init)(struct net *net);
338 void (*exit)(struct net *net);
339 void (*exit_batch)(struct list_head *net_exit_list);
345 * Use these carefully. If you implement a network device and it
346 * needs per network namespace operations use device pernet operations,
347 * otherwise use pernet subsys operations.
349 * Network interfaces need to be removed from a dying netns _before_
350 * subsys notifiers can be called, as most of the network code cleanup
351 * (which is done from subsys notifiers) runs with the assumption that
352 * dev_remove_pack has been called so no new packets will arrive during
353 * and after the cleanup functions have been called. dev_remove_pack
354 * is not per namespace so instead the guarantee of no more packets
355 * arriving in a network namespace is provided by ensuring that all
356 * network devices and all sockets have left the network namespace
357 * before the cleanup methods are called.
359 * For the longest time the ipv4 icmp code was registered as a pernet
360 * device which caused kernel oops, and panics during network
361 * namespace cleanup. So please don't get this wrong.
363 int register_pernet_subsys(struct pernet_operations *);
364 void unregister_pernet_subsys(struct pernet_operations *);
365 int register_pernet_device(struct pernet_operations *);
366 void unregister_pernet_device(struct pernet_operations *);
369 struct ctl_table_header;
372 int net_sysctl_init(void);
373 struct ctl_table_header *register_net_sysctl(struct net *net, const char *path,
374 struct ctl_table *table);
375 void unregister_net_sysctl_table(struct ctl_table_header *header);
377 static inline int net_sysctl_init(void) { return 0; }
378 static inline struct ctl_table_header *register_net_sysctl(struct net *net,
379 const char *path, struct ctl_table *table)
383 static inline void unregister_net_sysctl_table(struct ctl_table_header *header)
388 static inline int rt_genid_ipv4(struct net *net)
390 return atomic_read(&net->ipv4.rt_genid);
393 static inline void rt_genid_bump_ipv4(struct net *net)
395 atomic_inc(&net->ipv4.rt_genid);
398 extern void (*__fib6_flush_trees)(struct net *net);
399 static inline void rt_genid_bump_ipv6(struct net *net)
401 if (__fib6_flush_trees)
402 __fib6_flush_trees(net);
405 #if IS_ENABLED(CONFIG_IEEE802154_6LOWPAN)
406 static inline struct netns_ieee802154_lowpan *
407 net_ieee802154_lowpan(struct net *net)
409 return &net->ieee802154_lowpan;
413 /* For callers who don't really care about whether it's IPv4 or IPv6 */
414 static inline void rt_genid_bump_all(struct net *net)
416 rt_genid_bump_ipv4(net);
417 rt_genid_bump_ipv6(net);
420 static inline int fnhe_genid(struct net *net)
422 return atomic_read(&net->fnhe_genid);
425 static inline void fnhe_genid_bump(struct net *net)
427 atomic_inc(&net->fnhe_genid);
430 #endif /* __NET_NET_NAMESPACE_H */