include/net/net_namespace.h

   1 /*
   2  * Operations on the network namespace
   3  */
   4 #ifndef __NET_NET_NAMESPACE_H
   5 #define __NET_NET_NAMESPACE_H
   6
   7 #include <linux/atomic.h>
   8 #include <linux/workqueue.h>
   9 #include <linux/list.h>
  10 #include <linux/sysctl.h>
  11
  12 #include <net/flow.h>
  13 #include <net/netns/core.h>
  14 #include <net/netns/mib.h>
  15 #include <net/netns/unix.h>
  16 #include <net/netns/packet.h>
  17 #include <net/netns/ipv4.h>
  18 #include <net/netns/ipv6.h>
  19 #include <net/netns/ieee802154_6lowpan.h>
  20 #include <net/netns/sctp.h>
  21 #include <net/netns/dccp.h>
  22 #include <net/netns/netfilter.h>
  23 #include <net/netns/x_tables.h>
  24 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
  25 #include <net/netns/conntrack.h>
  26 #endif
  27 #include <net/netns/nftables.h>
  28 #include <net/netns/xfrm.h>
  29 #include <net/netns/mpls.h>
  30 #include <linux/ns_common.h>
  31
  32 struct user_namespace;
  33 struct proc_dir_entry;
  34 struct net_device;
  35 struct sock;
  36 struct ctl_table_header;
  37 struct net_generic;
  38 struct sock;
  39 struct netns_ipvs;
  40
  41
  42 #define NETDEV_HASHBITS    8
  43 #define NETDEV_HASHENTRIES (1 << NETDEV_HASHBITS)
  44
  45 struct net {
  46         atomic_t                passive;        /* To decided when the network
  47                                                  * namespace should be freed.
  48                                                  */
  49         atomic_t                count;          /* To decided when the network
  50                                                  *  namespace should be shut down.
  51                                                  */
  52 #ifdef NETNS_REFCNT_DEBUG
  53         atomic_t                use_count;      /* To track references we
  54                                                  * destroy on demand
  55                                                  */
  56 #endif
  57         spinlock_t              rules_mod_lock;
  58
  59         atomic64_t              cookie_gen;
  60
  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 */
  64
  65         struct user_namespace   *user_ns;       /* Owning user namespace */
  66         struct idr              netns_ids;
  67
  68         struct ns_common        ns;
  69
  70         struct proc_dir_entry   *proc_net;
  71         struct proc_dir_entry   *proc_net_stat;
  72
  73 #ifdef CONFIG_SYSCTL
  74         struct ctl_table_set    sysctls;
  75 #endif
  76
  77         struct sock             *rtnl;                  /* rtnetlink socket */
  78         struct sock             *genl_sock;
  79
  80         struct list_head        dev_base_head;
  81         struct hlist_head       *dev_name_head;
  82         struct hlist_head       *dev_index_head;
  83         unsigned int            dev_base_seq;   /* protected by rtnl_mutex */
  84         int                     ifindex;
  85         unsigned int            dev_unreg_count;
  86
  87         /* core fib_rules */
  88         struct list_head        rules_ops;
  89
  90
  91         struct net_device       *loopback_dev;          /* The loopback */
  92         struct netns_core       core;
  93         struct netns_mib        mib;
  94         struct netns_packet     packet;
  95         struct netns_unix       unx;
  96         struct netns_ipv4       ipv4;
  97 #if IS_ENABLED(CONFIG_IPV6)
  98         struct netns_ipv6       ipv6;
  99 #endif
 100 #if IS_ENABLED(CONFIG_IEEE802154_6LOWPAN)
 101         struct netns_ieee802154_lowpan  ieee802154_lowpan;
 102 #endif
 103 #if defined(CONFIG_IP_SCTP) || defined(CONFIG_IP_SCTP_MODULE)
 104         struct netns_sctp       sctp;
 105 #endif
 106 #if defined(CONFIG_IP_DCCP) || defined(CONFIG_IP_DCCP_MODULE)
 107         struct netns_dccp       dccp;
 108 #endif
 109 #ifdef CONFIG_NETFILTER
 110         struct netns_nf         nf;
 111         struct netns_xt         xt;
 112 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
 113         struct netns_ct         ct;
 114 #endif
 115 #if defined(CONFIG_NF_TABLES) || defined(CONFIG_NF_TABLES_MODULE)
 116         struct netns_nftables   nft;
 117 #endif
 118 #if IS_ENABLED(CONFIG_NF_DEFRAG_IPV6)
 119         struct netns_nf_frag    nf_frag;
 120 #endif
 121         struct sock             *nfnl;
 122         struct sock             *nfnl_stash;
 123 #endif
 124 #ifdef CONFIG_WEXT_CORE
 125         struct sk_buff_head     wext_nlevents;
 126 #endif
 127         struct net_generic __rcu        *gen;
 128
 129         /* Note : following structs are cache line aligned */
 130 #ifdef CONFIG_XFRM
 131         struct netns_xfrm       xfrm;
 132 #endif
 133 #if IS_ENABLED(CONFIG_IP_VS)
 134         struct netns_ipvs       *ipvs;
 135 #endif
 136 #if IS_ENABLED(CONFIG_MPLS)
 137         struct netns_mpls       mpls;
 138 #endif
 139         struct sock             *diag_nlsk;
 140         atomic_t                fnhe_genid;
 141 };
 142
 143 #include <linux/seq_file_net.h>
 144
 145 /* Init's network namespace */
 146 extern struct net init_net;
 147
 148 #ifdef CONFIG_NET_NS
 149 struct net *copy_net_ns(unsigned long flags, struct user_namespace *user_ns,
 150                         struct net *old_net);
 151
 152 #else /* CONFIG_NET_NS */
 153 #include <linux/sched.h>
 154 #include <linux/nsproxy.h>
 155 static inline struct net *copy_net_ns(unsigned long flags,
 156         struct user_namespace *user_ns, struct net *old_net)
 157 {
 158         if (flags & CLONE_NEWNET)
 159                 return ERR_PTR(-EINVAL);
 160         return old_net;
 161 }
 162 #endif /* CONFIG_NET_NS */
 163
 164
 165 extern struct list_head net_namespace_list;
 166
 167 struct net *get_net_ns_by_pid(pid_t pid);
 168 struct net *get_net_ns_by_fd(int pid);
 169
 170 #ifdef CONFIG_SYSCTL
 171 void ipx_register_sysctl(void);
 172 void ipx_unregister_sysctl(void);
 173 #else
 174 #define ipx_register_sysctl()
 175 #define ipx_unregister_sysctl()
 176 #endif
 177
 178 #ifdef CONFIG_NET_NS
 179 void __put_net(struct net *net);
 180
 181 static inline struct net *get_net(struct net *net)
 182 {
 183         atomic_inc(&net->count);
 184         return net;
 185 }
 186
 187 static inline struct net *maybe_get_net(struct net *net)
 188 {
 189         /* Used when we know struct net exists but we
 190          * aren't guaranteed a previous reference count
 191          * exists.  If the reference count is zero this
 192          * function fails and returns NULL.
 193          */
 194         if (!atomic_inc_not_zero(&net->count))
 195                 net = NULL;
 196         return net;
 197 }
 198
 199 static inline void put_net(struct net *net)
 200 {
 201         if (atomic_dec_and_test(&net->count))
 202                 __put_net(net);
 203 }
 204
 205 static inline
 206 int net_eq(const struct net *net1, const struct net *net2)
 207 {
 208         return net1 == net2;
 209 }
 210
 211 void net_drop_ns(void *);
 212
 213 #else
 214
 215 static inline struct net *get_net(struct net *net)
 216 {
 217         return net;
 218 }
 219
 220 static inline void put_net(struct net *net)
 221 {
 222 }
 223
 224 static inline struct net *maybe_get_net(struct net *net)
 225 {
 226         return net;
 227 }
 228
 229 static inline
 230 int net_eq(const struct net *net1, const struct net *net2)
 231 {
 232         return 1;
 233 }
 234
 235 #define net_drop_ns NULL
 236 #endif
 237
 238
 239 #ifdef NETNS_REFCNT_DEBUG
 240 static inline struct net *hold_net(struct net *net)
 241 {
 242         if (net)
 243                 atomic_inc(&net->use_count);
 244         return net;
 245 }
 246
 247 static inline void release_net(struct net *net)
 248 {
 249         if (net)
 250                 atomic_dec(&net->use_count);
 251 }
 252 #else
 253 static inline struct net *hold_net(struct net *net)
 254 {
 255         return net;
 256 }
 257
 258 static inline void release_net(struct net *net)
 259 {
 260 }
 261 #endif
 262
 263 #ifdef CONFIG_NET_NS
 264
 265 static inline void write_pnet(struct net **pnet, struct net *net)
 266 {
 267         *pnet = net;
 268 }
 269
 270 static inline struct net *read_pnet(struct net * const *pnet)
 271 {
 272         return *pnet;
 273 }
 274
 275 #else
 276
 277 #define write_pnet(pnet, net)   do { (void)(net);} while (0)
 278 #define read_pnet(pnet)         (&init_net)
 279
 280 #endif
 281
 282 #define for_each_net(VAR)                               \
 283         list_for_each_entry(VAR, &net_namespace_list, list)
 284
 285 #define for_each_net_rcu(VAR)                           \
 286         list_for_each_entry_rcu(VAR, &net_namespace_list, list)
 287
 288 #ifdef CONFIG_NET_NS
 289 #define __net_init
 290 #define __net_exit
 291 #define __net_initdata
 292 #define __net_initconst
 293 #else
 294 #define __net_init      __init
 295 #define __net_exit      __exit_refok
 296 #define __net_initdata  __initdata
 297 #define __net_initconst __initconst
 298 #endif
 299
 300 int peernet2id(struct net *net, struct net *peer);
 301 struct net *get_net_ns_by_id(struct net *net, int id);
 302
 303 struct pernet_operations {
 304         struct list_head list;
 305         int (*init)(struct net *net);
 306         void (*exit)(struct net *net);
 307         void (*exit_batch)(struct list_head *net_exit_list);
 308         int *id;
 309         size_t size;
 310 };
 311
 312 /*
 313  * Use these carefully.  If you implement a network device and it
 314  * needs per network namespace operations use device pernet operations,
 315  * otherwise use pernet subsys operations.
 316  *
 317  * Network interfaces need to be removed from a dying netns _before_
 318  * subsys notifiers can be called, as most of the network code cleanup
 319  * (which is done from subsys notifiers) runs with the assumption that
 320  * dev_remove_pack has been called so no new packets will arrive during
 321  * and after the cleanup functions have been called.  dev_remove_pack
 322  * is not per namespace so instead the guarantee of no more packets
 323  * arriving in a network namespace is provided by ensuring that all
 324  * network devices and all sockets have left the network namespace
 325  * before the cleanup methods are called.
 326  *
 327  * For the longest time the ipv4 icmp code was registered as a pernet
 328  * device which caused kernel oops, and panics during network
 329  * namespace cleanup.   So please don't get this wrong.
 330  */
 331 int register_pernet_subsys(struct pernet_operations *);
 332 void unregister_pernet_subsys(struct pernet_operations *);
 333 int register_pernet_device(struct pernet_operations *);
 334 void unregister_pernet_device(struct pernet_operations *);
 335
 336 struct ctl_table;
 337 struct ctl_table_header;
 338
 339 #ifdef CONFIG_SYSCTL
 340 int net_sysctl_init(void);
 341 struct ctl_table_header *register_net_sysctl(struct net *net, const char *path,
 342                                              struct ctl_table *table);
 343 void unregister_net_sysctl_table(struct ctl_table_header *header);
 344 #else
 345 static inline int net_sysctl_init(void) { return 0; }
 346 static inline struct ctl_table_header *register_net_sysctl(struct net *net,
 347         const char *path, struct ctl_table *table)
 348 {
 349         return NULL;
 350 }
 351 static inline void unregister_net_sysctl_table(struct ctl_table_header *header)
 352 {
 353 }
 354 #endif
 355
 356 static inline int rt_genid_ipv4(struct net *net)
 357 {
 358         return atomic_read(&net->ipv4.rt_genid);
 359 }
 360
 361 static inline void rt_genid_bump_ipv4(struct net *net)
 362 {
 363         atomic_inc(&net->ipv4.rt_genid);
 364 }
 365
 366 extern void (*__fib6_flush_trees)(struct net *net);
 367 static inline void rt_genid_bump_ipv6(struct net *net)
 368 {
 369         if (__fib6_flush_trees)
 370                 __fib6_flush_trees(net);
 371 }
 372
 373 #if IS_ENABLED(CONFIG_IEEE802154_6LOWPAN)
 374 static inline struct netns_ieee802154_lowpan *
 375 net_ieee802154_lowpan(struct net *net)
 376 {
 377         return &net->ieee802154_lowpan;
 378 }
 379 #endif
 380
 381 /* For callers who don't really care about whether it's IPv4 or IPv6 */
 382 static inline void rt_genid_bump_all(struct net *net)
 383 {
 384         rt_genid_bump_ipv4(net);
 385         rt_genid_bump_ipv6(net);
 386 }
 387
 388 static inline int fnhe_genid(struct net *net)
 389 {
 390         return atomic_read(&net->fnhe_genid);
 391 }
 392
 393 static inline void fnhe_genid_bump(struct net *net)
 394 {
 395         atomic_inc(&net->fnhe_genid);
 396 }
 397
 398 #endif /* __NET_NET_NAMESPACE_H */