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 #include <linux/idr.h>
  32 #include <linux/skbuff.h>
  33
  34 struct user_namespace;
  35 struct proc_dir_entry;
  36 struct net_device;
  37 struct sock;
  38 struct ctl_table_header;
  39 struct net_generic;
  40 struct sock;
  41 struct netns_ipvs;
  42
  43
  44 #define NETDEV_HASHBITS    8
  45 #define NETDEV_HASHENTRIES (1 << NETDEV_HASHBITS)
  46
  47 struct net {
  48         atomic_t                passive;        /* To decided when the network
  49                                                  * namespace should be freed.
  50                                                  */
  51         atomic_t                count;          /* To decided when the network
  52                                                  *  namespace should be shut down.
  53                                                  */
  54         spinlock_t              rules_mod_lock;
  55
  56         u32                     hash_mix;
  57         atomic64_t              cookie_gen;
  58
  59         struct list_head        list;           /* list of network namespaces */
  60         struct list_head        cleanup_list;   /* namespaces on death row */
  61         struct list_head        exit_list;      /* Use only net_mutex */
  62
  63         struct user_namespace   *user_ns;       /* Owning user namespace */
  64         struct ucounts          *ucounts;
  65         spinlock_t              nsid_lock;
  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         struct ctl_table_header *nf_frag_frags_hdr;
 121 #endif
 122         struct sock             *nfnl;
 123         struct sock             *nfnl_stash;
 124 #if IS_ENABLED(CONFIG_NETFILTER_NETLINK_ACCT)
 125         struct list_head        nfnl_acct_list;
 126 #endif
 127 #if IS_ENABLED(CONFIG_NF_CT_NETLINK_TIMEOUT)
 128         struct list_head        nfct_timeout_list;
 129 #endif
 130 #endif
 131 #ifdef CONFIG_WEXT_CORE
 132         struct sk_buff_head     wext_nlevents;
 133 #endif
 134         struct net_generic __rcu        *gen;
 135
 136         /* Note : following structs are cache line aligned */
 137 #ifdef CONFIG_XFRM
 138         struct netns_xfrm       xfrm;
 139 #endif
 140 #if IS_ENABLED(CONFIG_IP_VS)
 141         struct netns_ipvs       *ipvs;
 142 #endif
 143 #if IS_ENABLED(CONFIG_MPLS)
 144         struct netns_mpls       mpls;
 145 #endif
 146         struct sock             *diag_nlsk;
 147         atomic_t                fnhe_genid;
 148 };
 149
 150 #include <linux/seq_file_net.h>
 151
 152 /* Init's network namespace */
 153 extern struct net init_net;
 154
 155 #ifdef CONFIG_NET_NS
 156 struct net *copy_net_ns(unsigned long flags, struct user_namespace *user_ns,
 157                         struct net *old_net);
 158
 159 #else /* CONFIG_NET_NS */
 160 #include <linux/sched.h>
 161 #include <linux/nsproxy.h>
 162 static inline struct net *copy_net_ns(unsigned long flags,
 163         struct user_namespace *user_ns, struct net *old_net)
 164 {
 165         if (flags & CLONE_NEWNET)
 166                 return ERR_PTR(-EINVAL);
 167         return old_net;
 168 }
 169 #endif /* CONFIG_NET_NS */
 170
 171
 172 extern struct list_head net_namespace_list;
 173
 174 struct net *get_net_ns_by_pid(pid_t pid);
 175 struct net *get_net_ns_by_fd(int fd);
 176
 177 #ifdef CONFIG_SYSCTL
 178 void ipx_register_sysctl(void);
 179 void ipx_unregister_sysctl(void);
 180 #else
 181 #define ipx_register_sysctl()
 182 #define ipx_unregister_sysctl()
 183 #endif
 184
 185 #ifdef CONFIG_NET_NS
 186 void __put_net(struct net *net);
 187
 188 static inline struct net *get_net(struct net *net)
 189 {
 190         atomic_inc(&net->count);
 191         return net;
 192 }
 193
 194 static inline struct net *maybe_get_net(struct net *net)
 195 {
 196         /* Used when we know struct net exists but we
 197          * aren't guaranteed a previous reference count
 198          * exists.  If the reference count is zero this
 199          * function fails and returns NULL.
 200          */
 201         if (!atomic_inc_not_zero(&net->count))
 202                 net = NULL;
 203         return net;
 204 }
 205
 206 static inline void put_net(struct net *net)
 207 {
 208         if (atomic_dec_and_test(&net->count))
 209                 __put_net(net);
 210 }
 211
 212 static inline
 213 int net_eq(const struct net *net1, const struct net *net2)
 214 {
 215         return net1 == net2;
 216 }
 217
 218 static inline int check_net(const struct net *net)
 219 {
 220         return atomic_read(&net->count) != 0;
 221 }
 222
 223 void net_drop_ns(void *);
 224
 225 #else
 226
 227 static inline struct net *get_net(struct net *net)
 228 {
 229         return net;
 230 }
 231
 232 static inline void put_net(struct net *net)
 233 {
 234 }
 235
 236 static inline struct net *maybe_get_net(struct net *net)
 237 {
 238         return net;
 239 }
 240
 241 static inline
 242 int net_eq(const struct net *net1, const struct net *net2)
 243 {
 244         return 1;
 245 }
 246
 247 static inline int check_net(const struct net *net)
 248 {
 249         return 1;
 250 }
 251
 252 #define net_drop_ns NULL
 253 #endif
 254
 255
 256 typedef struct {
 257 #ifdef CONFIG_NET_NS
 258         struct net *net;
 259 #endif
 260 } possible_net_t;
 261
 262 static inline void write_pnet(possible_net_t *pnet, struct net *net)
 263 {
 264 #ifdef CONFIG_NET_NS
 265         pnet->net = net;
 266 #endif
 267 }
 268
 269 static inline struct net *read_pnet(const possible_net_t *pnet)
 270 {
 271 #ifdef CONFIG_NET_NS
 272         return pnet->net;
 273 #else
 274         return &init_net;
 275 #endif
 276 }
 277
 278 #define for_each_net(VAR)                               \
 279         list_for_each_entry(VAR, &net_namespace_list, list)
 280
 281 #define for_each_net_rcu(VAR)                           \
 282         list_for_each_entry_rcu(VAR, &net_namespace_list, list)
 283
 284 #ifdef CONFIG_NET_NS
 285 #define __net_init
 286 #define __net_exit
 287 #define __net_initdata
 288 #define __net_initconst
 289 #else
 290 #define __net_init      __init
 291 #define __net_exit      __ref
 292 #define __net_initdata  __initdata
 293 #define __net_initconst __initconst
 294 #endif
 295
 296 int peernet2id_alloc(struct net *net, struct net *peer);
 297 int peernet2id(struct net *net, struct net *peer);
 298 bool peernet_has_id(struct net *net, struct net *peer);
 299 struct net *get_net_ns_by_id(struct net *net, int id);
 300
 301 struct pernet_operations {
 302         struct list_head list;
 303         int (*init)(struct net *net);
 304         void (*exit)(struct net *net);
 305         void (*exit_batch)(struct list_head *net_exit_list);
 306         int *id;
 307         size_t size;
 308 };
 309
 310 /*
 311  * Use these carefully.  If you implement a network device and it
 312  * needs per network namespace operations use device pernet operations,
 313  * otherwise use pernet subsys operations.
 314  *
 315  * Network interfaces need to be removed from a dying netns _before_
 316  * subsys notifiers can be called, as most of the network code cleanup
 317  * (which is done from subsys notifiers) runs with the assumption that
 318  * dev_remove_pack has been called so no new packets will arrive during
 319  * and after the cleanup functions have been called.  dev_remove_pack
 320  * is not per namespace so instead the guarantee of no more packets
 321  * arriving in a network namespace is provided by ensuring that all
 322  * network devices and all sockets have left the network namespace
 323  * before the cleanup methods are called.
 324  *
 325  * For the longest time the ipv4 icmp code was registered as a pernet
 326  * device which caused kernel oops, and panics during network
 327  * namespace cleanup.   So please don't get this wrong.
 328  */
 329 int register_pernet_subsys(struct pernet_operations *);
 330 void unregister_pernet_subsys(struct pernet_operations *);
 331 int register_pernet_device(struct pernet_operations *);
 332 void unregister_pernet_device(struct pernet_operations *);
 333
 334 struct ctl_table;
 335 struct ctl_table_header;
 336
 337 #ifdef CONFIG_SYSCTL
 338 int net_sysctl_init(void);
 339 struct ctl_table_header *register_net_sysctl(struct net *net, const char *path,
 340                                              struct ctl_table *table);
 341 void unregister_net_sysctl_table(struct ctl_table_header *header);
 342 #else
 343 static inline int net_sysctl_init(void) { return 0; }
 344 static inline struct ctl_table_header *register_net_sysctl(struct net *net,
 345         const char *path, struct ctl_table *table)
 346 {
 347         return NULL;
 348 }
 349 static inline void unregister_net_sysctl_table(struct ctl_table_header *header)
 350 {
 351 }
 352 #endif
 353
 354 static inline int rt_genid_ipv4(struct net *net)
 355 {
 356         return atomic_read(&net->ipv4.rt_genid);
 357 }
 358
 359 static inline void rt_genid_bump_ipv4(struct net *net)
 360 {
 361         atomic_inc(&net->ipv4.rt_genid);
 362 }
 363
 364 extern void (*__fib6_flush_trees)(struct net *net);
 365 static inline void rt_genid_bump_ipv6(struct net *net)
 366 {
 367         if (__fib6_flush_trees)
 368                 __fib6_flush_trees(net);
 369 }
 370
 371 #if IS_ENABLED(CONFIG_IEEE802154_6LOWPAN)
 372 static inline struct netns_ieee802154_lowpan *
 373 net_ieee802154_lowpan(struct net *net)
 374 {
 375         return &net->ieee802154_lowpan;
 376 }
 377 #endif
 378
 379 /* For callers who don't really care about whether it's IPv4 or IPv6 */
 380 static inline void rt_genid_bump_all(struct net *net)
 381 {
 382         rt_genid_bump_ipv4(net);
 383         rt_genid_bump_ipv6(net);
 384 }
 385
 386 static inline int fnhe_genid(struct net *net)
 387 {
 388         return atomic_read(&net->fnhe_genid);
 389 }
 390
 391 static inline void fnhe_genid_bump(struct net *net)
 392 {
 393         atomic_inc(&net->fnhe_genid);
 394 }
 395
 396 #endif /* __NET_NET_NAMESPACE_H */